1 /*
2  * This is the Fusion MPT base driver providing common API layer interface
3  * for access to MPT (Message Passing Technology) firmware.
4  *
5  * This code is based on drivers/scsi/mpt3sas/mpt3sas_base.h
6  * Copyright (C) 2012-2014  LSI Corporation
7  * Copyright (C) 2013-2014 Avago Technologies
8  *  (mailto: MPT-FusionLinux.pdl@avagotech.com)
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * NO WARRANTY
21  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
22  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
23  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
24  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
25  * solely responsible for determining the appropriateness of using and
26  * distributing the Program and assumes all risks associated with its
27  * exercise of rights under this Agreement, including but not limited to
28  * the risks and costs of program errors, damage to or loss of data,
29  * programs or equipment, and unavailability or interruption of operations.
30 
31  * DISCLAIMER OF LIABILITY
32  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
33  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
35  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
38  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
39 
40  * You should have received a copy of the GNU General Public License
41  * along with this program; if not, write to the Free Software
42  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
43  * USA.
44  */
45 
46 #ifndef MPT3SAS_BASE_H_INCLUDED
47 #define MPT3SAS_BASE_H_INCLUDED
48 
49 #include "mpi/mpi2_type.h"
50 #include "mpi/mpi2.h"
51 #include "mpi/mpi2_ioc.h"
52 #include "mpi/mpi2_cnfg.h"
53 #include "mpi/mpi2_init.h"
54 #include "mpi/mpi2_raid.h"
55 #include "mpi/mpi2_tool.h"
56 #include "mpi/mpi2_sas.h"
57 
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_device.h>
61 #include <scsi/scsi_host.h>
62 #include <scsi/scsi_tcq.h>
63 #include <scsi/scsi_transport_sas.h>
64 #include <scsi/scsi_dbg.h>
65 #include <scsi/scsi_eh.h>
66 #include <linux/pci.h>
67 #include <linux/poll.h>
68 
69 #include "mpt3sas_debug.h"
70 #include "mpt3sas_trigger_diag.h"
71 
72 /* driver versioning info */
73 #define MPT3SAS_DRIVER_NAME		"mpt3sas"
74 #define MPT3SAS_AUTHOR "Avago Technologies <MPT-FusionLinux.pdl@avagotech.com>"
75 #define MPT3SAS_DESCRIPTION	"LSI MPT Fusion SAS 3.0 Device Driver"
76 #define MPT3SAS_DRIVER_VERSION		"12.100.00.00"
77 #define MPT3SAS_MAJOR_VERSION		12
78 #define MPT3SAS_MINOR_VERSION		100
79 #define MPT3SAS_BUILD_VERSION		0
80 #define MPT3SAS_RELEASE_VERSION	00
81 
82 #define MPT2SAS_DRIVER_NAME		"mpt2sas"
83 #define MPT2SAS_DESCRIPTION	"LSI MPT Fusion SAS 2.0 Device Driver"
84 #define MPT2SAS_DRIVER_VERSION		"20.102.00.00"
85 #define MPT2SAS_MAJOR_VERSION		20
86 #define MPT2SAS_MINOR_VERSION		102
87 #define MPT2SAS_BUILD_VERSION		0
88 #define MPT2SAS_RELEASE_VERSION	00
89 
90 /*
91  * Set MPT3SAS_SG_DEPTH value based on user input.
92  */
93 #define MPT_MAX_PHYS_SEGMENTS	SCSI_MAX_SG_SEGMENTS
94 #define MPT_MIN_PHYS_SEGMENTS	16
95 
96 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
97 #define MPT3SAS_SG_DEPTH		CONFIG_SCSI_MPT3SAS_MAX_SGE
98 #else
99 #define MPT3SAS_SG_DEPTH		MPT_MAX_PHYS_SEGMENTS
100 #endif
101 
102 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
103 #define MPT2SAS_SG_DEPTH		CONFIG_SCSI_MPT2SAS_MAX_SGE
104 #else
105 #define MPT2SAS_SG_DEPTH		MPT_MAX_PHYS_SEGMENTS
106 #endif
107 
108 /*
109  * Generic Defines
110  */
111 #define MPT3SAS_SATA_QUEUE_DEPTH	32
112 #define MPT3SAS_SAS_QUEUE_DEPTH		254
113 #define MPT3SAS_RAID_QUEUE_DEPTH	128
114 
115 #define MPT_NAME_LENGTH			32	/* generic length of strings */
116 #define MPT_STRING_LENGTH		64
117 
118 #define MPT_MAX_CALLBACKS		32
119 
120 
121 #define	 CAN_SLEEP			1
122 #define  NO_SLEEP			0
123 
124 #define INTERNAL_CMDS_COUNT		10	/* reserved cmds */
125 /* reserved for issuing internally framed scsi io cmds */
126 #define INTERNAL_SCSIIO_CMDS_COUNT	3
127 
128 #define MPI3_HIM_MASK			0xFFFFFFFF /* mask every bit*/
129 
130 #define MPT3SAS_INVALID_DEVICE_HANDLE	0xFFFF
131 
132 #define MAX_CHAIN_ELEMT_SZ		16
133 #define DEFAULT_NUM_FWCHAIN_ELEMTS	8
134 
135 /*
136  * reset phases
137  */
138 #define MPT3_IOC_PRE_RESET		1 /* prior to host reset */
139 #define MPT3_IOC_AFTER_RESET		2 /* just after host reset */
140 #define MPT3_IOC_DONE_RESET		3 /* links re-initialized */
141 
142 /*
143  * logging format
144  */
145 #define MPT3SAS_FMT			"%s: "
146 
147 /*
148  *  WarpDrive Specific Log codes
149  */
150 
151 #define MPT2_WARPDRIVE_LOGENTRY		(0x8002)
152 #define MPT2_WARPDRIVE_LC_SSDT			(0x41)
153 #define MPT2_WARPDRIVE_LC_SSDLW		(0x43)
154 #define MPT2_WARPDRIVE_LC_SSDLF		(0x44)
155 #define MPT2_WARPDRIVE_LC_BRMF			(0x4D)
156 
157 /*
158  * per target private data
159  */
160 #define MPT_TARGET_FLAGS_RAID_COMPONENT	0x01
161 #define MPT_TARGET_FLAGS_VOLUME		0x02
162 #define MPT_TARGET_FLAGS_DELETED	0x04
163 #define MPT_TARGET_FASTPATH_IO		0x08
164 
165 #define SAS2_PCI_DEVICE_B0_REVISION	(0x01)
166 #define SAS3_PCI_DEVICE_C0_REVISION	(0x02)
167 
168 /*
169  * Intel HBA branding
170  */
171 #define MPT2SAS_INTEL_RMS25JB080_BRANDING    \
172 	"Intel(R) Integrated RAID Module RMS25JB080"
173 #define MPT2SAS_INTEL_RMS25JB040_BRANDING    \
174 	"Intel(R) Integrated RAID Module RMS25JB040"
175 #define MPT2SAS_INTEL_RMS25KB080_BRANDING    \
176 	"Intel(R) Integrated RAID Module RMS25KB080"
177 #define MPT2SAS_INTEL_RMS25KB040_BRANDING    \
178 	"Intel(R) Integrated RAID Module RMS25KB040"
179 #define MPT2SAS_INTEL_RMS25LB040_BRANDING	\
180 	"Intel(R) Integrated RAID Module RMS25LB040"
181 #define MPT2SAS_INTEL_RMS25LB080_BRANDING	\
182 	"Intel(R) Integrated RAID Module RMS25LB080"
183 #define MPT2SAS_INTEL_RMS2LL080_BRANDING	\
184 	"Intel Integrated RAID Module RMS2LL080"
185 #define MPT2SAS_INTEL_RMS2LL040_BRANDING	\
186 	"Intel Integrated RAID Module RMS2LL040"
187 #define MPT2SAS_INTEL_RS25GB008_BRANDING       \
188 	"Intel(R) RAID Controller RS25GB008"
189 #define MPT2SAS_INTEL_SSD910_BRANDING          \
190 	"Intel(R) SSD 910 Series"
191 
192 #define MPT3SAS_INTEL_RMS3JC080_BRANDING       \
193 	"Intel(R) Integrated RAID Module RMS3JC080"
194 #define MPT3SAS_INTEL_RS3GC008_BRANDING       \
195 	"Intel(R) RAID Controller RS3GC008"
196 #define MPT3SAS_INTEL_RS3FC044_BRANDING       \
197 	"Intel(R) RAID Controller RS3FC044"
198 #define MPT3SAS_INTEL_RS3UC080_BRANDING       \
199 	"Intel(R) RAID Controller RS3UC080"
200 
201 /*
202  * Intel HBA SSDIDs
203  */
204 #define MPT2SAS_INTEL_RMS25JB080_SSDID		0x3516
205 #define MPT2SAS_INTEL_RMS25JB040_SSDID		0x3517
206 #define MPT2SAS_INTEL_RMS25KB080_SSDID		0x3518
207 #define MPT2SAS_INTEL_RMS25KB040_SSDID		0x3519
208 #define MPT2SAS_INTEL_RMS25LB040_SSDID		0x351A
209 #define MPT2SAS_INTEL_RMS25LB080_SSDID		0x351B
210 #define MPT2SAS_INTEL_RMS2LL080_SSDID		0x350E
211 #define MPT2SAS_INTEL_RMS2LL040_SSDID		0x350F
212 #define MPT2SAS_INTEL_RS25GB008_SSDID		0x3000
213 #define MPT2SAS_INTEL_SSD910_SSDID		0x3700
214 
215 #define MPT3SAS_INTEL_RMS3JC080_SSDID		0x3521
216 #define MPT3SAS_INTEL_RS3GC008_SSDID		0x3522
217 #define MPT3SAS_INTEL_RS3FC044_SSDID		0x3523
218 #define MPT3SAS_INTEL_RS3UC080_SSDID		0x3524
219 
220 /*
221  * Dell HBA branding
222  */
223 #define MPT2SAS_DELL_BRANDING_SIZE                 32
224 
225 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
226 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
227 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
228 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
229 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
230 #define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
231 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
232 
233 #define MPT3SAS_DELL_12G_HBA_BRANDING       \
234 	"Dell 12Gbps HBA"
235 
236 /*
237  * Dell HBA SSDIDs
238  */
239 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID	0x1F1C
240 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID	0x1F1D
241 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID	0x1F1E
242 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID	0x1F1F
243 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID	0x1F20
244 #define MPT2SAS_DELL_PERC_H200_SSDID		0x1F21
245 #define MPT2SAS_DELL_6GBPS_SAS_SSDID		0x1F22
246 
247 #define MPT3SAS_DELL_12G_HBA_SSDID		0x1F46
248 
249 /*
250  * Cisco HBA branding
251  */
252 #define MPT3SAS_CISCO_12G_8E_HBA_BRANDING		\
253 	"Cisco 9300-8E 12G SAS HBA"
254 #define MPT3SAS_CISCO_12G_8I_HBA_BRANDING		\
255 	"Cisco 9300-8i 12G SAS HBA"
256 #define MPT3SAS_CISCO_12G_AVILA_HBA_BRANDING	\
257 	"Cisco 12G Modular SAS Pass through Controller"
258 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_BRANDING		\
259 	"UCS C3X60 12G SAS Pass through Controller"
260 /*
261  * Cisco HBA SSSDIDs
262  */
263 #define MPT3SAS_CISCO_12G_8E_HBA_SSDID  0x14C
264 #define MPT3SAS_CISCO_12G_8I_HBA_SSDID  0x154
265 #define MPT3SAS_CISCO_12G_AVILA_HBA_SSDID  0x155
266 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_SSDID  0x156
267 
268 /*
269  * status bits for ioc->diag_buffer_status
270  */
271 #define MPT3_DIAG_BUFFER_IS_REGISTERED	(0x01)
272 #define MPT3_DIAG_BUFFER_IS_RELEASED	(0x02)
273 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET	(0x04)
274 
275 /*
276  * HP HBA branding
277  */
278 #define MPT2SAS_HP_3PAR_SSVID                0x1590
279 
280 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING	\
281 	"HP H220 Host Bus Adapter"
282 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING	\
283 	"HP H221 Host Bus Adapter"
284 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING	\
285 	"HP H222 Host Bus Adapter"
286 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING	\
287 	"HP H220i Host Bus Adapter"
288 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING	\
289 	"HP H210i Host Bus Adapter"
290 
291 /*
292  * HO HBA SSDIDs
293  */
294 #define MPT2SAS_HP_2_4_INTERNAL_SSDID			0x0041
295 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID			0x0042
296 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID	0x0043
297 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID		0x0044
298 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID		0x0046
299 
300 /*
301  * Combined Reply Queue constants,
302  * There are twelve Supplemental Reply Post Host Index Registers
303  * and each register is at offset 0x10 bytes from the previous one.
304  */
305 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
306 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
307 
308 /* OEM Identifiers */
309 #define MFG10_OEM_ID_INVALID                   (0x00000000)
310 #define MFG10_OEM_ID_DELL                      (0x00000001)
311 #define MFG10_OEM_ID_FSC                       (0x00000002)
312 #define MFG10_OEM_ID_SUN                       (0x00000003)
313 #define MFG10_OEM_ID_IBM                       (0x00000004)
314 
315 /* GENERIC Flags 0*/
316 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
317 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
318 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
319 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
320 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
321 
322 #define VIRTUAL_IO_FAILED_RETRY			(0x32010081)
323 
324 /* OEM Specific Flags will come from OEM specific header files */
325 struct Mpi2ManufacturingPage10_t {
326 	MPI2_CONFIG_PAGE_HEADER	Header;		/* 00h */
327 	U8	OEMIdentifier;			/* 04h */
328 	U8	Reserved1;			/* 05h */
329 	U16	Reserved2;			/* 08h */
330 	U32	Reserved3;			/* 0Ch */
331 	U32	GenericFlags0;			/* 10h */
332 	U32	GenericFlags1;			/* 14h */
333 	U32	Reserved4;			/* 18h */
334 	U32	OEMSpecificFlags0;		/* 1Ch */
335 	U32	OEMSpecificFlags1;		/* 20h */
336 	U32	Reserved5[18];			/* 24h - 60h*/
337 };
338 
339 
340 /* Miscellaneous options */
341 struct Mpi2ManufacturingPage11_t {
342 	MPI2_CONFIG_PAGE_HEADER Header;		/* 00h */
343 	__le32	Reserved1;			/* 04h */
344 	u8	Reserved2;			/* 08h */
345 	u8	EEDPTagMode;			/* 09h */
346 	u8	Reserved3;			/* 0Ah */
347 	u8	Reserved4;			/* 0Bh */
348 	__le32	Reserved5[23];			/* 0Ch-60h*/
349 };
350 
351 /**
352  * struct MPT3SAS_TARGET - starget private hostdata
353  * @starget: starget object
354  * @sas_address: target sas address
355  * @raid_device: raid_device pointer to access volume data
356  * @handle: device handle
357  * @num_luns: number luns
358  * @flags: MPT_TARGET_FLAGS_XXX flags
359  * @deleted: target flaged for deletion
360  * @tm_busy: target is busy with TM request.
361  * @sdev: The sas_device associated with this target
362  */
363 struct MPT3SAS_TARGET {
364 	struct scsi_target *starget;
365 	u64	sas_address;
366 	struct _raid_device *raid_device;
367 	u16	handle;
368 	int	num_luns;
369 	u32	flags;
370 	u8	deleted;
371 	u8	tm_busy;
372 	struct _sas_device *sdev;
373 };
374 
375 
376 /*
377  * per device private data
378  */
379 #define MPT_DEVICE_FLAGS_INIT		0x01
380 #define MPT_DEVICE_TLR_ON		0x02
381 
382 #define MFG_PAGE10_HIDE_SSDS_MASK	(0x00000003)
383 #define MFG_PAGE10_HIDE_ALL_DISKS	(0x00)
384 #define MFG_PAGE10_EXPOSE_ALL_DISKS	(0x01)
385 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT	(0x02)
386 
387 /**
388  * struct MPT3SAS_DEVICE - sdev private hostdata
389  * @sas_target: starget private hostdata
390  * @lun: lun number
391  * @flags: MPT_DEVICE_XXX flags
392  * @configured_lun: lun is configured
393  * @block: device is in SDEV_BLOCK state
394  * @tlr_snoop_check: flag used in determining whether to disable TLR
395  * @eedp_enable: eedp support enable bit
396  * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
397  * @eedp_block_length: block size
398  */
399 struct MPT3SAS_DEVICE {
400 	struct MPT3SAS_TARGET *sas_target;
401 	unsigned int	lun;
402 	u32	flags;
403 	u8	configured_lun;
404 	u8	block;
405 	u8	tlr_snoop_check;
406 	u8	ignore_delay_remove;
407 };
408 
409 #define MPT3_CMD_NOT_USED	0x8000	/* free */
410 #define MPT3_CMD_COMPLETE	0x0001	/* completed */
411 #define MPT3_CMD_PENDING	0x0002	/* pending */
412 #define MPT3_CMD_REPLY_VALID	0x0004	/* reply is valid */
413 #define MPT3_CMD_RESET		0x0008	/* host reset dropped the command */
414 
415 /**
416  * struct _internal_cmd - internal commands struct
417  * @mutex: mutex
418  * @done: completion
419  * @reply: reply message pointer
420  * @sense: sense data
421  * @status: MPT3_CMD_XXX status
422  * @smid: system message id
423  */
424 struct _internal_cmd {
425 	struct mutex mutex;
426 	struct completion done;
427 	void	*reply;
428 	void	*sense;
429 	u16	status;
430 	u16	smid;
431 };
432 
433 
434 
435 /**
436  * struct _sas_device - attached device information
437  * @list: sas device list
438  * @starget: starget object
439  * @sas_address: device sas address
440  * @device_name: retrieved from the SAS IDENTIFY frame.
441  * @handle: device handle
442  * @sas_address_parent: sas address of parent expander or sas host
443  * @enclosure_handle: enclosure handle
444  * @enclosure_logical_id: enclosure logical identifier
445  * @volume_handle: volume handle (valid when hidden raid member)
446  * @volume_wwid: volume unique identifier
447  * @device_info: bitfield provides detailed info about the device
448  * @id: target id
449  * @channel: target channel
450  * @slot: number number
451  * @phy: phy identifier provided in sas device page 0
452  * @responding: used in _scsih_sas_device_mark_responding
453  * @fast_path: fast path feature enable bit
454  * @pfa_led_on: flag for PFA LED status
455  * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
456  *	addition routine.
457  */
458 struct _sas_device {
459 	struct list_head list;
460 	struct scsi_target *starget;
461 	u64	sas_address;
462 	u64	device_name;
463 	u16	handle;
464 	u64	sas_address_parent;
465 	u16	enclosure_handle;
466 	u64	enclosure_logical_id;
467 	u16	volume_handle;
468 	u64	volume_wwid;
469 	u32	device_info;
470 	int	id;
471 	int	channel;
472 	u16	slot;
473 	u8	phy;
474 	u8	responding;
475 	u8	fast_path;
476 	u8	pfa_led_on;
477 	u8	pend_sas_rphy_add;
478 	u8	enclosure_level;
479 	u8	connector_name[4];
480 	struct kref refcount;
481 };
482 
483 static inline void sas_device_get(struct _sas_device *s)
484 {
485 	kref_get(&s->refcount);
486 }
487 
488 static inline void sas_device_free(struct kref *r)
489 {
490 	kfree(container_of(r, struct _sas_device, refcount));
491 }
492 
493 static inline void sas_device_put(struct _sas_device *s)
494 {
495 	kref_put(&s->refcount, sas_device_free);
496 }
497 
498 /**
499  * struct _raid_device - raid volume link list
500  * @list: sas device list
501  * @starget: starget object
502  * @sdev: scsi device struct (volumes are single lun)
503  * @wwid: unique identifier for the volume
504  * @handle: device handle
505  * @block_size: Block size of the volume
506  * @id: target id
507  * @channel: target channel
508  * @volume_type: the raid level
509  * @device_info: bitfield provides detailed info about the hidden components
510  * @num_pds: number of hidden raid components
511  * @responding: used in _scsih_raid_device_mark_responding
512  * @percent_complete: resync percent complete
513  * @direct_io_enabled: Whether direct io to PDs are allowed or not
514  * @stripe_exponent: X where 2powX is the stripe sz in blocks
515  * @block_exponent: X where 2powX is the block sz in bytes
516  * @max_lba: Maximum number of LBA in the volume
517  * @stripe_sz: Stripe Size of the volume
518  * @device_info: Device info of the volume member disk
519  * @pd_handle: Array of handles of the physical drives for direct I/O in le16
520  */
521 #define MPT_MAX_WARPDRIVE_PDS		8
522 struct _raid_device {
523 	struct list_head list;
524 	struct scsi_target *starget;
525 	struct scsi_device *sdev;
526 	u64	wwid;
527 	u16	handle;
528 	u16	block_sz;
529 	int	id;
530 	int	channel;
531 	u8	volume_type;
532 	u8	num_pds;
533 	u8	responding;
534 	u8	percent_complete;
535 	u8	direct_io_enabled;
536 	u8	stripe_exponent;
537 	u8	block_exponent;
538 	u64	max_lba;
539 	u32	stripe_sz;
540 	u32	device_info;
541 	u16	pd_handle[MPT_MAX_WARPDRIVE_PDS];
542 };
543 
544 /**
545  * struct _boot_device - boot device info
546  * @is_raid: flag to indicate whether this is volume
547  * @device: holds pointer for either struct _sas_device or
548  *     struct _raid_device
549  */
550 struct _boot_device {
551 	u8 is_raid;
552 	void *device;
553 };
554 
555 /**
556  * struct _sas_port - wide/narrow sas port information
557  * @port_list: list of ports belonging to expander
558  * @num_phys: number of phys belonging to this port
559  * @remote_identify: attached device identification
560  * @rphy: sas transport rphy object
561  * @port: sas transport wide/narrow port object
562  * @phy_list: _sas_phy list objects belonging to this port
563  */
564 struct _sas_port {
565 	struct list_head port_list;
566 	u8	num_phys;
567 	struct sas_identify remote_identify;
568 	struct sas_rphy *rphy;
569 	struct sas_port *port;
570 	struct list_head phy_list;
571 };
572 
573 /**
574  * struct _sas_phy - phy information
575  * @port_siblings: list of phys belonging to a port
576  * @identify: phy identification
577  * @remote_identify: attached device identification
578  * @phy: sas transport phy object
579  * @phy_id: unique phy id
580  * @handle: device handle for this phy
581  * @attached_handle: device handle for attached device
582  * @phy_belongs_to_port: port has been created for this phy
583  */
584 struct _sas_phy {
585 	struct list_head port_siblings;
586 	struct sas_identify identify;
587 	struct sas_identify remote_identify;
588 	struct sas_phy *phy;
589 	u8	phy_id;
590 	u16	handle;
591 	u16	attached_handle;
592 	u8	phy_belongs_to_port;
593 };
594 
595 /**
596  * struct _sas_node - sas_host/expander information
597  * @list: list of expanders
598  * @parent_dev: parent device class
599  * @num_phys: number phys belonging to this sas_host/expander
600  * @sas_address: sas address of this sas_host/expander
601  * @handle: handle for this sas_host/expander
602  * @sas_address_parent: sas address of parent expander or sas host
603  * @enclosure_handle: handle for this a member of an enclosure
604  * @device_info: bitwise defining capabilities of this sas_host/expander
605  * @responding: used in _scsih_expander_device_mark_responding
606  * @phy: a list of phys that make up this sas_host/expander
607  * @sas_port_list: list of ports attached to this sas_host/expander
608  */
609 struct _sas_node {
610 	struct list_head list;
611 	struct device *parent_dev;
612 	u8	num_phys;
613 	u64	sas_address;
614 	u16	handle;
615 	u64	sas_address_parent;
616 	u16	enclosure_handle;
617 	u64	enclosure_logical_id;
618 	u8	responding;
619 	struct	_sas_phy *phy;
620 	struct list_head sas_port_list;
621 };
622 
623 /**
624  * enum reset_type - reset state
625  * @FORCE_BIG_HAMMER: issue diagnostic reset
626  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
627  */
628 enum reset_type {
629 	FORCE_BIG_HAMMER,
630 	SOFT_RESET,
631 };
632 
633 /**
634  * struct chain_tracker - firmware chain tracker
635  * @chain_buffer: chain buffer
636  * @chain_buffer_dma: physical address
637  * @tracker_list: list of free request (ioc->free_chain_list)
638  */
639 struct chain_tracker {
640 	void *chain_buffer;
641 	dma_addr_t chain_buffer_dma;
642 	struct list_head tracker_list;
643 };
644 
645 /**
646  * struct scsiio_tracker - scsi mf request tracker
647  * @smid: system message id
648  * @scmd: scsi request pointer
649  * @cb_idx: callback index
650  * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
651  * @tracker_list: list of free request (ioc->free_list)
652  * @msix_io: IO's msix
653  */
654 struct scsiio_tracker {
655 	u16	smid;
656 	struct scsi_cmnd *scmd;
657 	u8	cb_idx;
658 	u8	direct_io;
659 	struct list_head chain_list;
660 	struct list_head tracker_list;
661 	u16     msix_io;
662 };
663 
664 /**
665  * struct request_tracker - firmware request tracker
666  * @smid: system message id
667  * @cb_idx: callback index
668  * @tracker_list: list of free request (ioc->free_list)
669  */
670 struct request_tracker {
671 	u16	smid;
672 	u8	cb_idx;
673 	struct list_head tracker_list;
674 };
675 
676 /**
677  * struct _tr_list - target reset list
678  * @handle: device handle
679  * @state: state machine
680  */
681 struct _tr_list {
682 	struct list_head list;
683 	u16	handle;
684 	u16	state;
685 };
686 
687 /**
688  * struct _sc_list - delayed SAS_IO_UNIT_CONTROL message list
689  * @handle: device handle
690  */
691 struct _sc_list {
692 	struct list_head list;
693 	u16     handle;
694 };
695 
696 /**
697  * struct _event_ack_list - delayed event acknowledgment list
698  * @Event: Event ID
699  * @EventContext: used to track the event uniquely
700  */
701 struct _event_ack_list {
702 	struct list_head list;
703 	u16     Event;
704 	u32     EventContext;
705 };
706 
707 /**
708  * struct adapter_reply_queue - the reply queue struct
709  * @ioc: per adapter object
710  * @msix_index: msix index into vector table
711  * @vector: irq vector
712  * @reply_post_host_index: head index in the pool where FW completes IO
713  * @reply_post_free: reply post base virt address
714  * @name: the name registered to request_irq()
715  * @busy: isr is actively processing replies on another cpu
716  * @list: this list
717 */
718 struct adapter_reply_queue {
719 	struct MPT3SAS_ADAPTER	*ioc;
720 	u8			msix_index;
721 	unsigned int		vector;
722 	u32			reply_post_host_index;
723 	Mpi2ReplyDescriptorsUnion_t *reply_post_free;
724 	char			name[MPT_NAME_LENGTH];
725 	atomic_t		busy;
726 	cpumask_var_t		affinity_hint;
727 	struct list_head	list;
728 };
729 
730 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
731 
732 /* SAS3.0 support */
733 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
734 		struct scsi_cmnd *scmd, u16 smid);
735 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
736 		dma_addr_t data_out_dma, size_t data_out_sz,
737 		dma_addr_t data_in_dma, size_t data_in_sz);
738 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
739 		void *paddr);
740 
741 
742 
743 /* IOC Facts and Port Facts converted from little endian to cpu */
744 union mpi3_version_union {
745 	MPI2_VERSION_STRUCT		Struct;
746 	u32				Word;
747 };
748 
749 struct mpt3sas_facts {
750 	u16			MsgVersion;
751 	u16			HeaderVersion;
752 	u8			IOCNumber;
753 	u8			VP_ID;
754 	u8			VF_ID;
755 	u16			IOCExceptions;
756 	u16			IOCStatus;
757 	u32			IOCLogInfo;
758 	u8			MaxChainDepth;
759 	u8			WhoInit;
760 	u8			NumberOfPorts;
761 	u8			MaxMSIxVectors;
762 	u16			RequestCredit;
763 	u16			ProductID;
764 	u32			IOCCapabilities;
765 	union mpi3_version_union	FWVersion;
766 	u16			IOCRequestFrameSize;
767 	u16			IOCMaxChainSegmentSize;
768 	u16			MaxInitiators;
769 	u16			MaxTargets;
770 	u16			MaxSasExpanders;
771 	u16			MaxEnclosures;
772 	u16			ProtocolFlags;
773 	u16			HighPriorityCredit;
774 	u16			MaxReplyDescriptorPostQueueDepth;
775 	u8			ReplyFrameSize;
776 	u8			MaxVolumes;
777 	u16			MaxDevHandle;
778 	u16			MaxPersistentEntries;
779 	u16			MinDevHandle;
780 };
781 
782 struct mpt3sas_port_facts {
783 	u8			PortNumber;
784 	u8			VP_ID;
785 	u8			VF_ID;
786 	u8			PortType;
787 	u16			MaxPostedCmdBuffers;
788 };
789 
790 struct reply_post_struct {
791 	Mpi2ReplyDescriptorsUnion_t	*reply_post_free;
792 	dma_addr_t			reply_post_free_dma;
793 };
794 
795 /**
796  * enum mutex_type - task management mutex type
797  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
798  * @TM_MUTEX_ON: mutex is required
799  */
800 enum mutex_type {
801 	TM_MUTEX_OFF = 0,
802 	TM_MUTEX_ON = 1,
803 };
804 
805 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
806 /**
807  * struct MPT3SAS_ADAPTER - per adapter struct
808  * @list: ioc_list
809  * @shost: shost object
810  * @id: unique adapter id
811  * @cpu_count: number online cpus
812  * @name: generic ioc string
813  * @tmp_string: tmp string used for logging
814  * @pdev: pci pdev object
815  * @pio_chip: physical io register space
816  * @chip: memory mapped register space
817  * @chip_phys: physical addrss prior to mapping
818  * @logging_level: see mpt3sas_debug.h
819  * @fwfault_debug: debuging FW timeouts
820  * @ir_firmware: IR firmware present
821  * @bars: bitmask of BAR's that must be configured
822  * @mask_interrupts: ignore interrupt
823  * @dma_mask: used to set the consistent dma mask
824  * @fault_reset_work_q_name: fw fault work queue
825  * @fault_reset_work_q: ""
826  * @fault_reset_work: ""
827  * @firmware_event_name: fw event work queue
828  * @firmware_event_thread: ""
829  * @fw_event_lock:
830  * @fw_event_list: list of fw events
831  * @aen_event_read_flag: event log was read
832  * @broadcast_aen_busy: broadcast aen waiting to be serviced
833  * @shost_recovery: host reset in progress
834  * @ioc_reset_in_progress_lock:
835  * @ioc_link_reset_in_progress: phy/hard reset in progress
836  * @ignore_loginfos: ignore loginfos during task management
837  * @remove_host: flag for when driver unloads, to avoid sending dev resets
838  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
839  * @wait_for_discovery_to_complete: flag set at driver load time when
840  *                                               waiting on reporting devices
841  * @is_driver_loading: flag set at driver load time
842  * @port_enable_failed: flag set when port enable has failed
843  * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
844  * @start_scan_failed: means port enable failed, return's the ioc_status
845  * @msix_enable: flag indicating msix is enabled
846  * @msix_vector_count: number msix vectors
847  * @cpu_msix_table: table for mapping cpus to msix index
848  * @cpu_msix_table_sz: table size
849  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
850  * @scsi_io_cb_idx: shost generated commands
851  * @tm_cb_idx: task management commands
852  * @scsih_cb_idx: scsih internal commands
853  * @transport_cb_idx: transport internal commands
854  * @ctl_cb_idx: clt internal commands
855  * @base_cb_idx: base internal commands
856  * @config_cb_idx: base internal commands
857  * @tm_tr_cb_idx : device removal target reset handshake
858  * @tm_tr_volume_cb_idx : volume removal target reset
859  * @base_cmds:
860  * @transport_cmds:
861  * @scsih_cmds:
862  * @tm_cmds:
863  * @ctl_cmds:
864  * @config_cmds:
865  * @base_add_sg_single: handler for either 32/64 bit sgl's
866  * @event_type: bits indicating which events to log
867  * @event_context: unique id for each logged event
868  * @event_log: event log pointer
869  * @event_masks: events that are masked
870  * @facts: static facts data
871  * @pfacts: static port facts data
872  * @manu_pg0: static manufacturing page 0
873  * @manu_pg10: static manufacturing page 10
874  * @manu_pg11: static manufacturing page 11
875  * @bios_pg2: static bios page 2
876  * @bios_pg3: static bios page 3
877  * @ioc_pg8: static ioc page 8
878  * @iounit_pg0: static iounit page 0
879  * @iounit_pg1: static iounit page 1
880  * @iounit_pg8: static iounit page 8
881  * @sas_hba: sas host object
882  * @sas_expander_list: expander object list
883  * @sas_node_lock:
884  * @sas_device_list: sas device object list
885  * @sas_device_init_list: sas device object list (used only at init time)
886  * @sas_device_lock:
887  * @io_missing_delay: time for IO completed by fw when PDR enabled
888  * @device_missing_delay: time for device missing by fw when PDR enabled
889  * @sas_id : used for setting volume target IDs
890  * @blocking_handles: bitmask used to identify which devices need blocking
891  * @pd_handles : bitmask for PD handles
892  * @pd_handles_sz : size of pd_handle bitmask
893  * @config_page_sz: config page size
894  * @config_page: reserve memory for config page payload
895  * @config_page_dma:
896  * @hba_queue_depth: hba request queue depth
897  * @sge_size: sg element size for either 32/64 bit
898  * @scsiio_depth: SCSI_IO queue depth
899  * @request_sz: per request frame size
900  * @request: pool of request frames
901  * @request_dma:
902  * @request_dma_sz:
903  * @scsi_lookup: firmware request tracker list
904  * @scsi_lookup_lock:
905  * @free_list: free list of request
906  * @pending_io_count:
907  * @reset_wq:
908  * @chain: pool of chains
909  * @chain_dma:
910  * @max_sges_in_main_message: number sg elements in main message
911  * @max_sges_in_chain_message: number sg elements per chain
912  * @chains_needed_per_io: max chains per io
913  * @chain_depth: total chains allocated
914  * @chain_segment_sz: gives the max number of
915  *			SGEs accommodate on single chain buffer
916  * @hi_priority_smid:
917  * @hi_priority:
918  * @hi_priority_dma:
919  * @hi_priority_depth:
920  * @hpr_lookup:
921  * @hpr_free_list:
922  * @internal_smid:
923  * @internal:
924  * @internal_dma:
925  * @internal_depth:
926  * @internal_lookup:
927  * @internal_free_list:
928  * @sense: pool of sense
929  * @sense_dma:
930  * @sense_dma_pool:
931  * @reply_depth: hba reply queue depth:
932  * @reply_sz: per reply frame size:
933  * @reply: pool of replys:
934  * @reply_dma:
935  * @reply_dma_pool:
936  * @reply_free_queue_depth: reply free depth
937  * @reply_free: pool for reply free queue (32 bit addr)
938  * @reply_free_dma:
939  * @reply_free_dma_pool:
940  * @reply_free_host_index: tail index in pool to insert free replys
941  * @reply_post_queue_depth: reply post queue depth
942  * @reply_post_struct: struct for reply_post_free physical & virt address
943  * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
944  * @rdpq_array_enable: rdpq_array support is enabled in the driver
945  * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
946  *				is assigned only ones
947  * @reply_queue_count: number of reply queue's
948  * @reply_queue_list: link list contaning the reply queue info
949  * @msix96_vector: 96 MSI-X vector support
950  * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
951  * @delayed_tr_list: target reset link list
952  * @delayed_tr_volume_list: volume target reset link list
953  * @delayed_sc_list:
954  * @delayed_event_ack_list:
955  * @temp_sensors_count: flag to carry the number of temperature sensors
956  * @pci_access_mutex: Mutex to synchronize ioctl,sysfs show path and
957  *	pci resource handling. PCI resource freeing will lead to free
958  *	vital hardware/memory resource, which might be in use by cli/sysfs
959  *	path functions resulting in Null pointer reference followed by kernel
960  *	crash. To avoid the above race condition we use mutex syncrhonization
961  *	which ensures the syncrhonization between cli/sysfs_show path.
962  */
963 struct MPT3SAS_ADAPTER {
964 	struct list_head list;
965 	struct Scsi_Host *shost;
966 	u8		id;
967 	int		cpu_count;
968 	char		name[MPT_NAME_LENGTH];
969 	char		driver_name[MPT_NAME_LENGTH];
970 	char		tmp_string[MPT_STRING_LENGTH];
971 	struct pci_dev	*pdev;
972 	Mpi2SystemInterfaceRegs_t __iomem *chip;
973 	resource_size_t	chip_phys;
974 	int		logging_level;
975 	int		fwfault_debug;
976 	u8		ir_firmware;
977 	int		bars;
978 	u8		mask_interrupts;
979 	int		dma_mask;
980 
981 	/* fw fault handler */
982 	char		fault_reset_work_q_name[20];
983 	struct workqueue_struct *fault_reset_work_q;
984 	struct delayed_work fault_reset_work;
985 
986 	/* fw event handler */
987 	char		firmware_event_name[20];
988 	struct workqueue_struct	*firmware_event_thread;
989 	spinlock_t	fw_event_lock;
990 	struct list_head fw_event_list;
991 
992 	 /* misc flags */
993 	int		aen_event_read_flag;
994 	u8		broadcast_aen_busy;
995 	u16		broadcast_aen_pending;
996 	u8		shost_recovery;
997 
998 	struct mutex	reset_in_progress_mutex;
999 	spinlock_t	ioc_reset_in_progress_lock;
1000 	u8		ioc_link_reset_in_progress;
1001 	u8		ioc_reset_in_progress_status;
1002 
1003 	u8		ignore_loginfos;
1004 	u8		remove_host;
1005 	u8		pci_error_recovery;
1006 	u8		wait_for_discovery_to_complete;
1007 	u8		is_driver_loading;
1008 	u8		port_enable_failed;
1009 	u8		start_scan;
1010 	u16		start_scan_failed;
1011 
1012 	u8		msix_enable;
1013 	u16		msix_vector_count;
1014 	u8		*cpu_msix_table;
1015 	u16		cpu_msix_table_sz;
1016 	resource_size_t __iomem **reply_post_host_index;
1017 	u32		ioc_reset_count;
1018 	MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
1019 	u32             non_operational_loop;
1020 
1021 	/* internal commands, callback index */
1022 	u8		scsi_io_cb_idx;
1023 	u8		tm_cb_idx;
1024 	u8		transport_cb_idx;
1025 	u8		scsih_cb_idx;
1026 	u8		ctl_cb_idx;
1027 	u8		base_cb_idx;
1028 	u8		port_enable_cb_idx;
1029 	u8		config_cb_idx;
1030 	u8		tm_tr_cb_idx;
1031 	u8		tm_tr_volume_cb_idx;
1032 	u8		tm_sas_control_cb_idx;
1033 	struct _internal_cmd base_cmds;
1034 	struct _internal_cmd port_enable_cmds;
1035 	struct _internal_cmd transport_cmds;
1036 	struct _internal_cmd scsih_cmds;
1037 	struct _internal_cmd tm_cmds;
1038 	struct _internal_cmd ctl_cmds;
1039 	struct _internal_cmd config_cmds;
1040 
1041 	MPT_ADD_SGE	base_add_sg_single;
1042 
1043 	/* function ptr for either IEEE or MPI sg elements */
1044 	MPT_BUILD_SG_SCMD build_sg_scmd;
1045 	MPT_BUILD_SG    build_sg;
1046 	MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
1047 	u16             sge_size_ieee;
1048 	u16		hba_mpi_version_belonged;
1049 
1050 	/* function ptr for MPI sg elements only */
1051 	MPT_BUILD_SG    build_sg_mpi;
1052 	MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
1053 
1054 	/* event log */
1055 	u32		event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
1056 	u32		event_context;
1057 	void		*event_log;
1058 	u32		event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
1059 
1060 	/* static config pages */
1061 	struct mpt3sas_facts facts;
1062 	struct mpt3sas_port_facts *pfacts;
1063 	Mpi2ManufacturingPage0_t manu_pg0;
1064 	struct Mpi2ManufacturingPage10_t manu_pg10;
1065 	struct Mpi2ManufacturingPage11_t manu_pg11;
1066 	Mpi2BiosPage2_t	bios_pg2;
1067 	Mpi2BiosPage3_t	bios_pg3;
1068 	Mpi2IOCPage8_t ioc_pg8;
1069 	Mpi2IOUnitPage0_t iounit_pg0;
1070 	Mpi2IOUnitPage1_t iounit_pg1;
1071 	Mpi2IOUnitPage8_t iounit_pg8;
1072 
1073 	struct _boot_device req_boot_device;
1074 	struct _boot_device req_alt_boot_device;
1075 	struct _boot_device current_boot_device;
1076 
1077 	/* sas hba, expander, and device list */
1078 	struct _sas_node sas_hba;
1079 	struct list_head sas_expander_list;
1080 	spinlock_t	sas_node_lock;
1081 	struct list_head sas_device_list;
1082 	struct list_head sas_device_init_list;
1083 	spinlock_t	sas_device_lock;
1084 	struct list_head raid_device_list;
1085 	spinlock_t	raid_device_lock;
1086 	u8		io_missing_delay;
1087 	u16		device_missing_delay;
1088 	int		sas_id;
1089 
1090 	void		*blocking_handles;
1091 	void		*pd_handles;
1092 	u16		pd_handles_sz;
1093 
1094 	/* config page */
1095 	u16		config_page_sz;
1096 	void		*config_page;
1097 	dma_addr_t	config_page_dma;
1098 
1099 	/* scsiio request */
1100 	u16		hba_queue_depth;
1101 	u16		sge_size;
1102 	u16		scsiio_depth;
1103 	u16		request_sz;
1104 	u8		*request;
1105 	dma_addr_t	request_dma;
1106 	u32		request_dma_sz;
1107 	struct scsiio_tracker *scsi_lookup;
1108 	ulong		scsi_lookup_pages;
1109 	spinlock_t	scsi_lookup_lock;
1110 	struct list_head free_list;
1111 	int		pending_io_count;
1112 	wait_queue_head_t reset_wq;
1113 
1114 	/* chain */
1115 	struct chain_tracker *chain_lookup;
1116 	struct list_head free_chain_list;
1117 	struct dma_pool *chain_dma_pool;
1118 	ulong		chain_pages;
1119 	u16		max_sges_in_main_message;
1120 	u16		max_sges_in_chain_message;
1121 	u16		chains_needed_per_io;
1122 	u32		chain_depth;
1123 	u16		chain_segment_sz;
1124 
1125 	/* hi-priority queue */
1126 	u16		hi_priority_smid;
1127 	u8		*hi_priority;
1128 	dma_addr_t	hi_priority_dma;
1129 	u16		hi_priority_depth;
1130 	struct request_tracker *hpr_lookup;
1131 	struct list_head hpr_free_list;
1132 
1133 	/* internal queue */
1134 	u16		internal_smid;
1135 	u8		*internal;
1136 	dma_addr_t	internal_dma;
1137 	u16		internal_depth;
1138 	struct request_tracker *internal_lookup;
1139 	struct list_head internal_free_list;
1140 
1141 	/* sense */
1142 	u8		*sense;
1143 	dma_addr_t	sense_dma;
1144 	struct dma_pool *sense_dma_pool;
1145 
1146 	/* reply */
1147 	u16		reply_sz;
1148 	u8		*reply;
1149 	dma_addr_t	reply_dma;
1150 	u32		reply_dma_max_address;
1151 	u32		reply_dma_min_address;
1152 	struct dma_pool *reply_dma_pool;
1153 
1154 	/* reply free queue */
1155 	u16		reply_free_queue_depth;
1156 	__le32		*reply_free;
1157 	dma_addr_t	reply_free_dma;
1158 	struct dma_pool *reply_free_dma_pool;
1159 	u32		reply_free_host_index;
1160 
1161 	/* reply post queue */
1162 	u16		reply_post_queue_depth;
1163 	struct reply_post_struct *reply_post;
1164 	u8		rdpq_array_capable;
1165 	u8		rdpq_array_enable;
1166 	u8		rdpq_array_enable_assigned;
1167 	struct dma_pool *reply_post_free_dma_pool;
1168 	u8		reply_queue_count;
1169 	struct list_head reply_queue_list;
1170 
1171 	u8		msix96_vector;
1172 	/* reply post register index */
1173 	resource_size_t	**replyPostRegisterIndex;
1174 
1175 	struct list_head delayed_tr_list;
1176 	struct list_head delayed_tr_volume_list;
1177 	struct list_head delayed_sc_list;
1178 	struct list_head delayed_event_ack_list;
1179 	u8		temp_sensors_count;
1180 	struct mutex pci_access_mutex;
1181 
1182 	/* diag buffer support */
1183 	u8		*diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
1184 	u32		diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
1185 	dma_addr_t	diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
1186 	u8		diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
1187 	u32		unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
1188 	u32		product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
1189 	u32		diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
1190 	u32		ring_buffer_offset;
1191 	u32		ring_buffer_sz;
1192 	u8		is_warpdrive;
1193 	u8		hide_ir_msg;
1194 	u8		mfg_pg10_hide_flag;
1195 	u8		hide_drives;
1196 	spinlock_t	diag_trigger_lock;
1197 	u8		diag_trigger_active;
1198 	struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
1199 	struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
1200 	struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
1201 	struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
1202 };
1203 
1204 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1205 	u32 reply);
1206 
1207 
1208 /* base shared API */
1209 extern struct list_head mpt3sas_ioc_list;
1210 extern char    driver_name[MPT_NAME_LENGTH];
1211 /* spinlock on list operations over IOCs
1212  * Case: when multiple warpdrive cards(IOCs) are in use
1213  * Each IOC will added to the ioc list structure on initialization.
1214  * Watchdog threads run at regular intervals to check IOC for any
1215  * fault conditions which will trigger the dead_ioc thread to
1216  * deallocate pci resource, resulting deleting the IOC netry from list,
1217  * this deletion need to protected by spinlock to enusre that
1218  * ioc removal is syncrhonized, if not synchronized it might lead to
1219  * list_del corruption as the ioc list is traversed in cli path.
1220  */
1221 extern spinlock_t gioc_lock;
1222 
1223 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
1224 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
1225 
1226 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
1227 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
1228 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1229 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1230 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1231 	enum reset_type type);
1232 
1233 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1234 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1235 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1236 	u16 smid);
1237 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1238 
1239 /* hi-priority queue */
1240 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1241 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1242 	struct scsi_cmnd *scmd);
1243 
1244 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1245 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1246 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1247 	u16 handle);
1248 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1249 	u16 handle);
1250 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc,
1251 	u16 smid, u16 msix_task);
1252 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1253 void mpt3sas_base_initialize_callback_handler(void);
1254 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1255 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1256 
1257 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1258 	u32 reply);
1259 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1260 	u8 msix_index, u32 reply);
1261 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1262 	u32 phys_addr);
1263 
1264 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1265 
1266 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1267 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1268 	Mpi2SasIoUnitControlReply_t *mpi_reply,
1269 	Mpi2SasIoUnitControlRequest_t *mpi_request);
1270 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1271 	Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1272 
1273 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1274 	u32 *event_type);
1275 
1276 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1277 
1278 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1279 	u16 device_missing_delay, u8 io_missing_delay);
1280 
1281 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1282 
1283 
1284 /* scsih shared API */
1285 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1286 	u32 reply);
1287 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1288 
1289 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1290 	uint channel, uint id, uint lun, u8 type, u16 smid_task,
1291 	ulong timeout, enum mutex_type m_type);
1292 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1293 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1294 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1295 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1296 	u64 sas_address);
1297 u8 mpt3sas_check_for_pending_internal_cmds(struct MPT3SAS_ADAPTER *ioc,
1298 	u16 smid);
1299 
1300 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1301 	struct MPT3SAS_ADAPTER *ioc, u16 handle);
1302 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1303 	struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1304 struct _sas_device *mpt3sas_get_sdev_by_addr(
1305 	 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1306 struct _sas_device *__mpt3sas_get_sdev_by_addr(
1307 	 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1308 
1309 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1310 struct _raid_device *
1311 mpt3sas_raid_device_find_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1312 
1313 /* config shared API */
1314 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1315 	u32 reply);
1316 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1317 	u8 *num_phys);
1318 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1319 	Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1320 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1321 	Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1322 	u16 sz);
1323 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1324 	Mpi2ConfigReply_t *mpi_reply,
1325 	struct Mpi2ManufacturingPage10_t *config_page);
1326 
1327 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1328 	Mpi2ConfigReply_t *mpi_reply,
1329 	struct Mpi2ManufacturingPage11_t  *config_page);
1330 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1331 	Mpi2ConfigReply_t *mpi_reply,
1332 	struct Mpi2ManufacturingPage11_t *config_page);
1333 
1334 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1335 	*mpi_reply, Mpi2BiosPage2_t *config_page);
1336 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1337 	*mpi_reply, Mpi2BiosPage3_t *config_page);
1338 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1339 	*mpi_reply, Mpi2IOUnitPage0_t *config_page);
1340 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1341 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1342 	u32 form, u32 handle);
1343 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1344 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1345 	u32 form, u32 handle);
1346 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1347 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1348 	u16 sz);
1349 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1350 	*mpi_reply, Mpi2IOUnitPage1_t *config_page);
1351 int mpt3sas_config_get_iounit_pg3(struct MPT3SAS_ADAPTER *ioc,
1352 	Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage3_t *config_page, u16 sz);
1353 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1354 	*mpi_reply, Mpi2IOUnitPage1_t *config_page);
1355 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1356 	*mpi_reply, Mpi2IOUnitPage8_t *config_page);
1357 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1358 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1359 	u16 sz);
1360 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1361 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1362 	u16 sz);
1363 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1364 	*mpi_reply, Mpi2IOCPage8_t *config_page);
1365 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1366 	Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1367 	u32 form, u32 handle);
1368 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1369 	Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1370 	u32 phy_number, u16 handle);
1371 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1372 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1373 	u32 form, u32 handle);
1374 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1375 	*mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1376 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1377 	*mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1378 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1379 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1380 	u32 handle);
1381 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1382 	u8 *num_pds);
1383 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1384 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1385 	u32 handle, u16 sz);
1386 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1387 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1388 	u32 form, u32 form_specific);
1389 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1390 	u16 *volume_handle);
1391 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1392 	u16 volume_handle, u64 *wwid);
1393 
1394 /* ctl shared API */
1395 extern struct device_attribute *mpt3sas_host_attrs[];
1396 extern struct device_attribute *mpt3sas_dev_attrs[];
1397 void mpt3sas_ctl_init(ushort hbas_to_enumerate);
1398 void mpt3sas_ctl_exit(ushort hbas_to_enumerate);
1399 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1400 	u32 reply);
1401 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1402 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1403 	u8 msix_index, u32 reply);
1404 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1405 	Mpi2EventNotificationReply_t *mpi_reply);
1406 
1407 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1408 	u8 bits_to_regsiter);
1409 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1410 	u8 *issue_reset);
1411 
1412 /* transport shared API */
1413 extern struct scsi_transport_template *mpt3sas_transport_template;
1414 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1415 	u32 reply);
1416 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1417 	u16 handle, u64 sas_address);
1418 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1419 	u64 sas_address_parent);
1420 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1421 	*mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1422 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1423 	struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1424 	struct device *parent_dev);
1425 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1426 	u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1427 extern struct sas_function_template mpt3sas_transport_functions;
1428 extern struct scsi_transport_template *mpt3sas_transport_template;
1429 extern int scsi_internal_device_block(struct scsi_device *sdev);
1430 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1431 				enum scsi_device_state new_state);
1432 /* trigger data externs */
1433 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1434 	struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1435 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1436 	struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1437 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1438 	u32 tigger_bitmask);
1439 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1440 	u16 log_entry_qualifier);
1441 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1442 	u8 asc, u8 ascq);
1443 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1444 	u32 loginfo);
1445 
1446 /* warpdrive APIs */
1447 u8 mpt3sas_get_num_volumes(struct MPT3SAS_ADAPTER *ioc);
1448 void mpt3sas_init_warpdrive_properties(struct MPT3SAS_ADAPTER *ioc,
1449 	struct _raid_device *raid_device);
1450 u8
1451 mpt3sas_scsi_direct_io_get(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1452 void
1453 mpt3sas_scsi_direct_io_set(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 direct_io);
1454 void
1455 mpt3sas_setup_direct_io(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd *scmd,
1456 	struct _raid_device *raid_device, Mpi2SCSIIORequest_t *mpi_request,
1457 	u16 smid);
1458 
1459 #endif /* MPT3SAS_BASE_H_INCLUDED */
1460