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