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