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