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