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