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