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/mpt2sas/mpt2_base.h
6  * Copyright (C) 2007-2010  LSI Corporation
7  *  (mailto:DL-MPTFusionLinux@lsi.com)
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * NO WARRANTY
20  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
21  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
22  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
23  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
24  * solely responsible for determining the appropriateness of using and
25  * distributing the Program and assumes all risks associated with its
26  * exercise of rights under this Agreement, including but not limited to
27  * the risks and costs of program errors, damage to or loss of data,
28  * programs or equipment, and unavailability or interruption of operations.
29 
30  * DISCLAIMER OF LIABILITY
31  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
32  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
34  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
35  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
36  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
37  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
38 
39  * You should have received a copy of the GNU General Public License
40  * along with this program; if not, write to the Free Software
41  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
42  * USA.
43  */
44 
45 #ifndef MPT2SAS_BASE_H_INCLUDED
46 #define MPT2SAS_BASE_H_INCLUDED
47 
48 #include "mpi/mpi2_type.h"
49 #include "mpi/mpi2.h"
50 #include "mpi/mpi2_ioc.h"
51 #include "mpi/mpi2_cnfg.h"
52 #include "mpi/mpi2_init.h"
53 #include "mpi/mpi2_raid.h"
54 #include "mpi/mpi2_tool.h"
55 #include "mpi/mpi2_sas.h"
56 
57 #include <scsi/scsi.h>
58 #include <scsi/scsi_cmnd.h>
59 #include <scsi/scsi_device.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_tcq.h>
62 #include <scsi/scsi_transport_sas.h>
63 #include <scsi/scsi_dbg.h>
64 #include <scsi/scsi_eh.h>
65 
66 #include "mpt2sas_debug.h"
67 
68 /* driver versioning info */
69 #define MPT2SAS_DRIVER_NAME		"mpt2sas"
70 #define MPT2SAS_AUTHOR	"LSI Corporation <DL-MPTFusionLinux@lsi.com>"
71 #define MPT2SAS_DESCRIPTION	"LSI MPT Fusion SAS 2.0 Device Driver"
72 #define MPT2SAS_DRIVER_VERSION		"12.100.00.00"
73 #define MPT2SAS_MAJOR_VERSION		12
74 #define MPT2SAS_MINOR_VERSION		100
75 #define MPT2SAS_BUILD_VERSION		00
76 #define MPT2SAS_RELEASE_VERSION		00
77 
78 /*
79  * Set MPT2SAS_SG_DEPTH value based on user input.
80  */
81 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
82 #if     CONFIG_SCSI_MPT2SAS_MAX_SGE  < 16
83 #define MPT2SAS_SG_DEPTH       16
84 #elif CONFIG_SCSI_MPT2SAS_MAX_SGE  > 128
85 #define MPT2SAS_SG_DEPTH       128
86 #else
87 #define MPT2SAS_SG_DEPTH       CONFIG_SCSI_MPT2SAS_MAX_SGE
88 #endif
89 #else
90 #define MPT2SAS_SG_DEPTH       128 /* MAX_HW_SEGMENTS */
91 #endif
92 
93 
94 /*
95  * Generic Defines
96  */
97 #define MPT2SAS_SATA_QUEUE_DEPTH	32
98 #define MPT2SAS_SAS_QUEUE_DEPTH		254
99 #define MPT2SAS_RAID_QUEUE_DEPTH	128
100 
101 #define MPT_NAME_LENGTH			32	/* generic length of strings */
102 #define MPT_STRING_LENGTH		64
103 
104 #define MPT_MAX_CALLBACKS		16
105 
106 
107 #define	 CAN_SLEEP			1
108 #define  NO_SLEEP			0
109 
110 #define INTERNAL_CMDS_COUNT		10	/* reserved cmds */
111 
112 #define MPI2_HIM_MASK			0xFFFFFFFF /* mask every bit*/
113 
114 #define MPT2SAS_INVALID_DEVICE_HANDLE	0xFFFF
115 
116 
117 /*
118  * reset phases
119  */
120 #define MPT2_IOC_PRE_RESET		1 /* prior to host reset */
121 #define MPT2_IOC_AFTER_RESET		2 /* just after host reset */
122 #define MPT2_IOC_DONE_RESET		3 /* links re-initialized */
123 
124 /*
125  * logging format
126  */
127 #define MPT2SAS_FMT			"%s: "
128 #define MPT2SAS_INFO_FMT		KERN_INFO MPT2SAS_FMT
129 #define MPT2SAS_NOTE_FMT		KERN_NOTICE MPT2SAS_FMT
130 #define MPT2SAS_WARN_FMT		KERN_WARNING MPT2SAS_FMT
131 #define MPT2SAS_ERR_FMT			KERN_ERR MPT2SAS_FMT
132 
133 /*
134  * Dell HBA branding
135  */
136 #define MPT2SAS_DELL_BRANDING_SIZE                 32
137 
138 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
139 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
140 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
141 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
142 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
143 #define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
144 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
145 
146 /*
147  * Dell HBA SSDIDs
148  */
149 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID           0x1F1C
150 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID       0x1F1D
151 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID    0x1F1E
152 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID       0x1F1F
153 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID      0x1F20
154 #define MPT2SAS_DELL_PERC_H200_SSDID               0x1F21
155 #define MPT2SAS_DELL_6GBPS_SAS_SSDID               0x1F22
156 
157 /*
158  * Intel HBA branding
159  */
160 #define MPT2SAS_INTEL_RMS25JB080_BRANDING    \
161 				"Intel(R) Integrated RAID Module RMS25JB080"
162 #define MPT2SAS_INTEL_RMS25JB040_BRANDING    \
163 				"Intel(R) Integrated RAID Module RMS25JB040"
164 #define MPT2SAS_INTEL_RMS25KB080_BRANDING    \
165 				"Intel(R) Integrated RAID Module RMS25KB080"
166 #define MPT2SAS_INTEL_RMS25KB040_BRANDING    \
167 				"Intel(R) Integrated RAID Module RMS25KB040"
168 #define MPT2SAS_INTEL_RMS2LL080_BRANDING	\
169 				"Intel Integrated RAID Module RMS2LL080"
170 #define MPT2SAS_INTEL_RMS2LL040_BRANDING	\
171 				"Intel Integrated RAID Module RMS2LL040"
172 #define MPT2SAS_INTEL_RS25GB008_BRANDING       \
173 				"Intel(R) RAID Controller RS25GB008"
174 #define MPT2SAS_INTEL_RAMSDALE_BRANDING        \
175 				"Intel 720 Series SSD"
176 /*
177  * Intel HBA SSDIDs
178  */
179 #define MPT2SAS_INTEL_RMS25JB080_SSDID         0x3516
180 #define MPT2SAS_INTEL_RMS25JB040_SSDID         0x3517
181 #define MPT2SAS_INTEL_RMS25KB080_SSDID         0x3518
182 #define MPT2SAS_INTEL_RMS25KB040_SSDID         0x3519
183 #define MPT2SAS_INTEL_RMS2LL080_SSDID          0x350E
184 #define MPT2SAS_INTEL_RMS2LL040_SSDID          0x350F
185 #define MPT2SAS_INTEL_RS25GB008_SSDID          0x3000
186 #define MPT2SAS_INTEL_RAMSDALE_SSDID           0x3700
187 
188 /*
189  * HP HBA branding
190  */
191 #define MPT2SAS_HP_3PAR_SSVID                0x1590
192 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING        "HP H220 Host Bus Adapter"
193 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING        "HP H221 Host Bus Adapter"
194 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING "HP H222 Host Bus Adapter"
195 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING    "HP H220i Host Bus Adapter"
196 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING    "HP H210i Host Bus Adapter"
197 
198 /*
199  * HO HBA SSDIDs
200  */
201 #define MPT2SAS_HP_2_4_INTERNAL_SSDID            0x0041
202 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID            0x0042
203 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID    0x0043
204 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID        0x0044
205 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID        0x0046
206 
207 /*
208  *  WarpDrive Specific Log codes
209  */
210 
211 #define MPT2_WARPDRIVE_LOGENTRY		(0x8002)
212 #define MPT2_WARPDRIVE_LC_SSDT		(0x41)
213 #define MPT2_WARPDRIVE_LC_SSDLW		(0x43)
214 #define MPT2_WARPDRIVE_LC_SSDLF		(0x44)
215 #define MPT2_WARPDRIVE_LC_BRMF		(0x4D)
216 
217 /*
218  * per target private data
219  */
220 #define MPT_TARGET_FLAGS_RAID_COMPONENT	0x01
221 #define MPT_TARGET_FLAGS_VOLUME		0x02
222 #define MPT_TARGET_FLAGS_DELETED	0x04
223 
224 /**
225  * struct MPT2SAS_TARGET - starget private hostdata
226  * @starget: starget object
227  * @sas_address: target sas address
228  * @raid_device: raid_device pointer to access volume data
229  * @handle: device handle
230  * @num_luns: number luns
231  * @flags: MPT_TARGET_FLAGS_XXX flags
232  * @deleted: target flaged for deletion
233  * @tm_busy: target is busy with TM request.
234  */
235 struct MPT2SAS_TARGET {
236 	struct scsi_target *starget;
237 	u64	sas_address;
238 	struct _raid_device *raid_device;
239 	u16	handle;
240 	int	num_luns;
241 	u32	flags;
242 	u8	deleted;
243 	u8	tm_busy;
244 };
245 
246 
247 /*
248  * per device private data
249  */
250 #define MPT_DEVICE_FLAGS_INIT		0x01
251 #define MPT_DEVICE_TLR_ON		0x02
252 
253 /**
254  * struct MPT2SAS_DEVICE - sdev private hostdata
255  * @sas_target: starget private hostdata
256  * @lun: lun number
257  * @flags: MPT_DEVICE_XXX flags
258  * @configured_lun: lun is configured
259  * @block: device is in SDEV_BLOCK state
260  * @tlr_snoop_check: flag used in determining whether to disable TLR
261  */
262 
263 /* OEM Identifiers */
264 #define MFG10_OEM_ID_INVALID                   (0x00000000)
265 #define MFG10_OEM_ID_DELL                      (0x00000001)
266 #define MFG10_OEM_ID_FSC                       (0x00000002)
267 #define MFG10_OEM_ID_SUN                       (0x00000003)
268 #define MFG10_OEM_ID_IBM                       (0x00000004)
269 
270 /* GENERIC Flags 0*/
271 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
272 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
273 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
274 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
275 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
276 
277 /* OEM Specific Flags will come from OEM specific header files */
278 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
279     MPI2_CONFIG_PAGE_HEADER Header;                                 /* 00h */
280     U8                      OEMIdentifier;                          /* 04h */
281     U8                      Reserved1;                              /* 05h */
282     U16                     Reserved2;                              /* 08h */
283     U32                     Reserved3;                              /* 0Ch */
284     U32                     GenericFlags0;                          /* 10h */
285     U32                     GenericFlags1;                          /* 14h */
286     U32                     Reserved4;                              /* 18h */
287     U32                     OEMSpecificFlags0;                      /* 1Ch */
288     U32                     OEMSpecificFlags1;                      /* 20h */
289     U32                     Reserved5[18];                          /* 24h-60h*/
290 } MPI2_CONFIG_PAGE_MAN_10,
291   MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
292   Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
293 
294 #define MFG_PAGE10_HIDE_SSDS_MASK	(0x00000003)
295 #define MFG_PAGE10_HIDE_ALL_DISKS	(0x00)
296 #define MFG_PAGE10_EXPOSE_ALL_DISKS	(0x01)
297 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT	(0x02)
298 
299 
300 struct MPT2SAS_DEVICE {
301 	struct MPT2SAS_TARGET *sas_target;
302 	unsigned int	lun;
303 	u32	flags;
304 	u8	configured_lun;
305 	u8	block;
306 	u8	tlr_snoop_check;
307 };
308 
309 #define MPT2_CMD_NOT_USED	0x8000	/* free */
310 #define MPT2_CMD_COMPLETE	0x0001	/* completed */
311 #define MPT2_CMD_PENDING	0x0002	/* pending */
312 #define MPT2_CMD_REPLY_VALID	0x0004	/* reply is valid */
313 #define MPT2_CMD_RESET		0x0008	/* host reset dropped the command */
314 
315 /**
316  * struct _internal_cmd - internal commands struct
317  * @mutex: mutex
318  * @done: completion
319  * @reply: reply message pointer
320  * @sense: sense data
321  * @status: MPT2_CMD_XXX status
322  * @smid: system message id
323  */
324 struct _internal_cmd {
325 	struct mutex mutex;
326 	struct completion done;
327 	void 	*reply;
328 	void	*sense;
329 	u16	status;
330 	u16	smid;
331 };
332 
333 
334 /**
335  * struct _sas_device - attached device information
336  * @list: sas device list
337  * @starget: starget object
338  * @sas_address: device sas address
339  * @device_name: retrieved from the SAS IDENTIFY frame.
340  * @handle: device handle
341  * @sas_address_parent: sas address of parent expander or sas host
342  * @enclosure_handle: enclosure handle
343  * @enclosure_logical_id: enclosure logical identifier
344  * @volume_handle: volume handle (valid when hidden raid member)
345  * @volume_wwid: volume unique identifier
346  * @device_info: bitfield provides detailed info about the device
347  * @id: target id
348  * @channel: target channel
349  * @slot: number number
350  * @phy: phy identifier provided in sas device page 0
351  * @responding: used in _scsih_sas_device_mark_responding
352  */
353 struct _sas_device {
354 	struct list_head list;
355 	struct scsi_target *starget;
356 	u64	sas_address;
357 	u64	device_name;
358 	u16	handle;
359 	u64	sas_address_parent;
360 	u16	enclosure_handle;
361 	u64	enclosure_logical_id;
362 	u16	volume_handle;
363 	u64	volume_wwid;
364 	u32	device_info;
365 	int	id;
366 	int	channel;
367 	u16	slot;
368 	u8	phy;
369 	u8	responding;
370 };
371 
372 /**
373  * struct _raid_device - raid volume link list
374  * @list: sas device list
375  * @starget: starget object
376  * @sdev: scsi device struct (volumes are single lun)
377  * @wwid: unique identifier for the volume
378  * @handle: device handle
379  * @block_size: Block size of the volume
380  * @id: target id
381  * @channel: target channel
382  * @volume_type: the raid level
383  * @device_info: bitfield provides detailed info about the hidden components
384  * @num_pds: number of hidden raid components
385  * @responding: used in _scsih_raid_device_mark_responding
386  * @percent_complete: resync percent complete
387  * @direct_io_enabled: Whether direct io to PDs are allowed or not
388  * @stripe_exponent: X where 2powX is the stripe sz in blocks
389  * @block_exponent: X where 2powX is the block sz in bytes
390  * @max_lba: Maximum number of LBA in the volume
391  * @stripe_sz: Stripe Size of the volume
392  * @device_info: Device info of the volume member disk
393  * @pd_handle: Array of handles of the physical drives for direct I/O in le16
394  */
395 #define MPT_MAX_WARPDRIVE_PDS		8
396 struct _raid_device {
397 	struct list_head list;
398 	struct scsi_target *starget;
399 	struct scsi_device *sdev;
400 	u64	wwid;
401 	u16	handle;
402 	u16	block_sz;
403 	int	id;
404 	int	channel;
405 	u8	volume_type;
406 	u8	num_pds;
407 	u8	responding;
408 	u8	percent_complete;
409 	u8	direct_io_enabled;
410 	u8	stripe_exponent;
411 	u8	block_exponent;
412 	u64	max_lba;
413 	u32	stripe_sz;
414 	u32	device_info;
415 	u16	pd_handle[MPT_MAX_WARPDRIVE_PDS];
416 };
417 
418 /**
419  * struct _boot_device - boot device info
420  * @is_raid: flag to indicate whether this is volume
421  * @device: holds pointer for either struct _sas_device or
422  *     struct _raid_device
423  */
424 struct _boot_device {
425 	u8 is_raid;
426 	void *device;
427 };
428 
429 /**
430  * struct _sas_port - wide/narrow sas port information
431  * @port_list: list of ports belonging to expander
432  * @num_phys: number of phys belonging to this port
433  * @remote_identify: attached device identification
434  * @rphy: sas transport rphy object
435  * @port: sas transport wide/narrow port object
436  * @phy_list: _sas_phy list objects belonging to this port
437  */
438 struct _sas_port {
439 	struct list_head port_list;
440 	u8	num_phys;
441 	struct sas_identify remote_identify;
442 	struct sas_rphy *rphy;
443 	struct sas_port *port;
444 	struct list_head phy_list;
445 };
446 
447 /**
448  * struct _sas_phy - phy information
449  * @port_siblings: list of phys belonging to a port
450  * @identify: phy identification
451  * @remote_identify: attached device identification
452  * @phy: sas transport phy object
453  * @phy_id: unique phy id
454  * @handle: device handle for this phy
455  * @attached_handle: device handle for attached device
456  * @phy_belongs_to_port: port has been created for this phy
457  */
458 struct _sas_phy {
459 	struct list_head port_siblings;
460 	struct sas_identify identify;
461 	struct sas_identify remote_identify;
462 	struct sas_phy *phy;
463 	u8	phy_id;
464 	u16	handle;
465 	u16	attached_handle;
466 	u8	phy_belongs_to_port;
467 };
468 
469 /**
470  * struct _sas_node - sas_host/expander information
471  * @list: list of expanders
472  * @parent_dev: parent device class
473  * @num_phys: number phys belonging to this sas_host/expander
474  * @sas_address: sas address of this sas_host/expander
475  * @handle: handle for this sas_host/expander
476  * @sas_address_parent: sas address of parent expander or sas host
477  * @enclosure_handle: handle for this a member of an enclosure
478  * @device_info: bitwise defining capabilities of this sas_host/expander
479  * @responding: used in _scsih_expander_device_mark_responding
480  * @phy: a list of phys that make up this sas_host/expander
481  * @sas_port_list: list of ports attached to this sas_host/expander
482  */
483 struct _sas_node {
484 	struct list_head list;
485 	struct device *parent_dev;
486 	u8	num_phys;
487 	u64	sas_address;
488 	u16	handle;
489 	u64	sas_address_parent;
490 	u16	enclosure_handle;
491 	u64	enclosure_logical_id;
492 	u8	responding;
493 	struct	_sas_phy *phy;
494 	struct list_head sas_port_list;
495 };
496 
497 /**
498  * enum reset_type - reset state
499  * @FORCE_BIG_HAMMER: issue diagnostic reset
500  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
501  */
502 enum reset_type {
503 	FORCE_BIG_HAMMER,
504 	SOFT_RESET,
505 };
506 
507 /**
508  * struct chain_tracker - firmware chain tracker
509  * @chain_buffer: chain buffer
510  * @chain_buffer_dma: physical address
511  * @tracker_list: list of free request (ioc->free_chain_list)
512  */
513 struct chain_tracker {
514 	void *chain_buffer;
515 	dma_addr_t chain_buffer_dma;
516 	struct list_head tracker_list;
517 };
518 
519 /**
520  * struct scsiio_tracker - scsi mf request tracker
521  * @smid: system message id
522  * @scmd: scsi request pointer
523  * @cb_idx: callback index
524  * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
525  * @chain_list: list of chains associated to this IO
526  * @tracker_list: list of free request (ioc->free_list)
527  */
528 struct scsiio_tracker {
529 	u16	smid;
530 	struct scsi_cmnd *scmd;
531 	u8	cb_idx;
532 	u8	direct_io;
533 	struct list_head chain_list;
534 	struct list_head tracker_list;
535 };
536 
537 /**
538  * struct request_tracker - firmware request tracker
539  * @smid: system message id
540  * @cb_idx: callback index
541  * @tracker_list: list of free request (ioc->free_list)
542  */
543 struct request_tracker {
544 	u16	smid;
545 	u8	cb_idx;
546 	struct list_head tracker_list;
547 };
548 
549 /**
550  * struct _tr_list - target reset list
551  * @handle: device handle
552  * @state: state machine
553  */
554 struct _tr_list {
555 	struct list_head list;
556 	u16	handle;
557 	u16	state;
558 };
559 
560 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
561 
562 /**
563  * struct adapter_reply_queue - the reply queue struct
564  * @ioc: per adapter object
565  * @msix_index: msix index into vector table
566  * @vector: irq vector
567  * @reply_post_host_index: head index in the pool where FW completes IO
568  * @reply_post_free: reply post base virt address
569  * @name: the name registered to request_irq()
570  * @busy: isr is actively processing replies on another cpu
571  * @list: this list
572 */
573 struct adapter_reply_queue {
574 	struct MPT2SAS_ADAPTER	*ioc;
575 	u8			msix_index;
576 	unsigned int		vector;
577 	u32			reply_post_host_index;
578 	Mpi2ReplyDescriptorsUnion_t *reply_post_free;
579 	char			name[MPT_NAME_LENGTH];
580 	atomic_t		busy;
581 	struct list_head	list;
582 };
583 
584 /* IOC Facts and Port Facts converted from little endian to cpu */
585 union mpi2_version_union {
586 	MPI2_VERSION_STRUCT		Struct;
587 	u32				Word;
588 };
589 
590 struct mpt2sas_facts {
591 	u16			MsgVersion;
592 	u16			HeaderVersion;
593 	u8			IOCNumber;
594 	u8			VP_ID;
595 	u8			VF_ID;
596 	u16			IOCExceptions;
597 	u16			IOCStatus;
598 	u32			IOCLogInfo;
599 	u8			MaxChainDepth;
600 	u8			WhoInit;
601 	u8			NumberOfPorts;
602 	u8			MaxMSIxVectors;
603 	u16			RequestCredit;
604 	u16			ProductID;
605 	u32			IOCCapabilities;
606 	union mpi2_version_union	FWVersion;
607 	u16			IOCRequestFrameSize;
608 	u16			Reserved3;
609 	u16			MaxInitiators;
610 	u16			MaxTargets;
611 	u16			MaxSasExpanders;
612 	u16			MaxEnclosures;
613 	u16			ProtocolFlags;
614 	u16			HighPriorityCredit;
615 	u16			MaxReplyDescriptorPostQueueDepth;
616 	u8			ReplyFrameSize;
617 	u8			MaxVolumes;
618 	u16			MaxDevHandle;
619 	u16			MaxPersistentEntries;
620 	u16			MinDevHandle;
621 };
622 
623 struct mpt2sas_port_facts {
624 	u8			PortNumber;
625 	u8			VP_ID;
626 	u8			VF_ID;
627 	u8			PortType;
628 	u16			MaxPostedCmdBuffers;
629 };
630 
631 /**
632  * enum mutex_type - task management mutex type
633  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
634  * @TM_MUTEX_ON: mutex is required
635  */
636 enum mutex_type {
637 	TM_MUTEX_OFF = 0,
638 	TM_MUTEX_ON = 1,
639 };
640 
641 typedef void (*MPT2SAS_FLUSH_RUNNING_CMDS)(struct MPT2SAS_ADAPTER *ioc);
642 /**
643  * struct MPT2SAS_ADAPTER - per adapter struct
644  * @list: ioc_list
645  * @shost: shost object
646  * @id: unique adapter id
647  * @cpu_count: number online cpus
648  * @name: generic ioc string
649  * @tmp_string: tmp string used for logging
650  * @pdev: pci pdev object
651  * @chip: memory mapped register space
652  * @chip_phys: physical addrss prior to mapping
653  * @logging_level: see mpt2sas_debug.h
654  * @fwfault_debug: debuging FW timeouts
655  * @ir_firmware: IR firmware present
656  * @bars: bitmask of BAR's that must be configured
657  * @mask_interrupts: ignore interrupt
658  * @fault_reset_work_q_name: fw fault work queue
659  * @fault_reset_work_q: ""
660  * @fault_reset_work: ""
661  * @firmware_event_name: fw event work queue
662  * @firmware_event_thread: ""
663  * @fw_events_off: flag to turn off fw event handling
664  * @fw_event_lock:
665  * @fw_event_list: list of fw events
666  * @aen_event_read_flag: event log was read
667  * @broadcast_aen_busy: broadcast aen waiting to be serviced
668  * @shost_recovery: host reset in progress
669  * @ioc_reset_in_progress_lock:
670  * @ioc_link_reset_in_progress: phy/hard reset in progress
671  * @ignore_loginfos: ignore loginfos during task management
672  * @remove_host: flag for when driver unloads, to avoid sending dev resets
673  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
674  * @wait_for_discovery_to_complete: flag set at driver load time when
675  *                                               waiting on reporting devices
676  * @is_driver_loading: flag set at driver load time
677  * @port_enable_failed: flag set when port enable has failed
678  * @start_scan: flag set from scan_start callback, cleared from _mpt2sas_fw_work
679  * @start_scan_failed: means port enable failed, return's the ioc_status
680  * @msix_enable: flag indicating msix is enabled
681  * @msix_vector_count: number msix vectors
682  * @cpu_msix_table: table for mapping cpus to msix index
683  * @cpu_msix_table_sz: table size
684  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
685  * @scsi_io_cb_idx: shost generated commands
686  * @tm_cb_idx: task management commands
687  * @scsih_cb_idx: scsih internal commands
688  * @transport_cb_idx: transport internal commands
689  * @ctl_cb_idx: clt internal commands
690  * @base_cb_idx: base internal commands
691  * @config_cb_idx: base internal commands
692  * @tm_tr_cb_idx : device removal target reset handshake
693  * @tm_tr_volume_cb_idx : volume removal target reset
694  * @base_cmds:
695  * @transport_cmds:
696  * @scsih_cmds:
697  * @tm_cmds:
698  * @ctl_cmds:
699  * @config_cmds:
700  * @base_add_sg_single: handler for either 32/64 bit sgl's
701  * @event_type: bits indicating which events to log
702  * @event_context: unique id for each logged event
703  * @event_log: event log pointer
704  * @event_masks: events that are masked
705  * @facts: static facts data
706  * @pfacts: static port facts data
707  * @manu_pg0: static manufacturing page 0
708  * @manu_pg10: static manufacturing page 10
709  * @bios_pg2: static bios page 2
710  * @bios_pg3: static bios page 3
711  * @ioc_pg8: static ioc page 8
712  * @iounit_pg0: static iounit page 0
713  * @iounit_pg1: static iounit page 1
714  * @sas_hba: sas host object
715  * @sas_expander_list: expander object list
716  * @sas_node_lock:
717  * @sas_device_list: sas device object list
718  * @sas_device_init_list: sas device object list (used only at init time)
719  * @sas_device_lock:
720  * @io_missing_delay: time for IO completed by fw when PDR enabled
721  * @device_missing_delay: time for device missing by fw when PDR enabled
722  * @sas_id : used for setting volume target IDs
723  * @pd_handles : bitmask for PD handles
724  * @pd_handles_sz : size of pd_handle bitmask
725  * @config_page_sz: config page size
726  * @config_page: reserve memory for config page payload
727  * @config_page_dma:
728  * @hba_queue_depth: hba request queue depth
729  * @sge_size: sg element size for either 32/64 bit
730  * @scsiio_depth: SCSI_IO queue depth
731  * @request_sz: per request frame size
732  * @request: pool of request frames
733  * @request_dma:
734  * @request_dma_sz:
735  * @scsi_lookup: firmware request tracker list
736  * @scsi_lookup_lock:
737  * @free_list: free list of request
738  * @chain: pool of chains
739  * @pending_io_count:
740  * @reset_wq:
741  * @chain_dma:
742  * @max_sges_in_main_message: number sg elements in main message
743  * @max_sges_in_chain_message: number sg elements per chain
744  * @chains_needed_per_io: max chains per io
745  * @chain_offset_value_for_main_message: location 1st sg in main
746  * @chain_depth: total chains allocated
747  * @hi_priority_smid:
748  * @hi_priority:
749  * @hi_priority_dma:
750  * @hi_priority_depth:
751  * @hpr_lookup:
752  * @hpr_free_list:
753  * @internal_smid:
754  * @internal:
755  * @internal_dma:
756  * @internal_depth:
757  * @internal_lookup:
758  * @internal_free_list:
759  * @sense: pool of sense
760  * @sense_dma:
761  * @sense_dma_pool:
762  * @reply_depth: hba reply queue depth:
763  * @reply_sz: per reply frame size:
764  * @reply: pool of replys:
765  * @reply_dma:
766  * @reply_dma_pool:
767  * @reply_free_queue_depth: reply free depth
768  * @reply_free: pool for reply free queue (32 bit addr)
769  * @reply_free_dma:
770  * @reply_free_dma_pool:
771  * @reply_free_host_index: tail index in pool to insert free replys
772  * @reply_post_queue_depth: reply post queue depth
773  * @reply_post_free: pool for reply post (64bit descriptor)
774  * @reply_post_free_dma:
775  * @reply_queue_count: number of reply queue's
776  * @reply_queue_list: link list contaning the reply queue info
777  * @reply_post_host_index: head index in the pool where FW completes IO
778  * @delayed_tr_list: target reset link list
779  * @delayed_tr_volume_list: volume target reset link list
780  */
781 struct MPT2SAS_ADAPTER {
782 	struct list_head list;
783 	struct Scsi_Host *shost;
784 	u8		id;
785 	int		cpu_count;
786 	char		name[MPT_NAME_LENGTH];
787 	char		tmp_string[MPT_STRING_LENGTH];
788 	struct pci_dev	*pdev;
789 	Mpi2SystemInterfaceRegs_t __iomem *chip;
790 	resource_size_t	chip_phys;
791 	int		logging_level;
792 	int		fwfault_debug;
793 	u8		ir_firmware;
794 	int		bars;
795 	u8		mask_interrupts;
796 
797 	/* fw fault handler */
798 	char		fault_reset_work_q_name[20];
799 	struct workqueue_struct *fault_reset_work_q;
800 	struct delayed_work fault_reset_work;
801 
802 	/* fw event handler */
803 	char		firmware_event_name[20];
804 	struct workqueue_struct	*firmware_event_thread;
805 	spinlock_t	fw_event_lock;
806 	struct list_head fw_event_list;
807 
808 	 /* misc flags */
809 	int		aen_event_read_flag;
810 	u8		broadcast_aen_busy;
811 	u16		broadcast_aen_pending;
812 	u8		shost_recovery;
813 
814 	struct mutex	reset_in_progress_mutex;
815 	spinlock_t 	ioc_reset_in_progress_lock;
816 	u8		ioc_link_reset_in_progress;
817 	u8		ioc_reset_in_progress_status;
818 
819 	u8		ignore_loginfos;
820 	u8		remove_host;
821 	u8		pci_error_recovery;
822 	u8		wait_for_discovery_to_complete;
823 	struct completion	port_enable_done;
824 	u8		is_driver_loading;
825 	u8		port_enable_failed;
826 
827 	u8		start_scan;
828 	u16		start_scan_failed;
829 
830 	u8		msix_enable;
831 	u16		msix_vector_count;
832 	u8		*cpu_msix_table;
833 	resource_size_t	**reply_post_host_index;
834 	u16		cpu_msix_table_sz;
835 	u32		ioc_reset_count;
836 	MPT2SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
837 
838 	/* internal commands, callback index */
839 	u8		scsi_io_cb_idx;
840 	u8		tm_cb_idx;
841 	u8		transport_cb_idx;
842 	u8		scsih_cb_idx;
843 	u8		ctl_cb_idx;
844 	u8		base_cb_idx;
845 	u8		port_enable_cb_idx;
846 	u8		config_cb_idx;
847 	u8		tm_tr_cb_idx;
848 	u8		tm_tr_volume_cb_idx;
849 	u8		tm_sas_control_cb_idx;
850 	struct _internal_cmd base_cmds;
851 	struct _internal_cmd port_enable_cmds;
852 	struct _internal_cmd transport_cmds;
853 	struct _internal_cmd scsih_cmds;
854 	struct _internal_cmd tm_cmds;
855 	struct _internal_cmd ctl_cmds;
856 	struct _internal_cmd config_cmds;
857 
858 	MPT_ADD_SGE	base_add_sg_single;
859 
860 	/* event log */
861 	u32		event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
862 	u32		event_context;
863 	void		*event_log;
864 	u32		event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
865 
866 	/* static config pages */
867 	struct mpt2sas_facts facts;
868 	struct mpt2sas_port_facts *pfacts;
869 	Mpi2ManufacturingPage0_t manu_pg0;
870 	Mpi2BiosPage2_t	bios_pg2;
871 	Mpi2BiosPage3_t	bios_pg3;
872 	Mpi2IOCPage8_t ioc_pg8;
873 	Mpi2IOUnitPage0_t iounit_pg0;
874 	Mpi2IOUnitPage1_t iounit_pg1;
875 
876 	struct _boot_device req_boot_device;
877 	struct _boot_device req_alt_boot_device;
878 	struct _boot_device current_boot_device;
879 
880 	/* sas hba, expander, and device list */
881 	struct _sas_node sas_hba;
882 	struct list_head sas_expander_list;
883 	spinlock_t	sas_node_lock;
884 	struct list_head sas_device_list;
885 	struct list_head sas_device_init_list;
886 	spinlock_t	sas_device_lock;
887 	struct list_head raid_device_list;
888 	spinlock_t	raid_device_lock;
889 	u8		io_missing_delay;
890 	u16		device_missing_delay;
891 	int		sas_id;
892 
893 	void		*pd_handles;
894 	u16		pd_handles_sz;
895 
896 	/* config page */
897 	u16		config_page_sz;
898 	void 		*config_page;
899 	dma_addr_t	config_page_dma;
900 
901 	/* scsiio request */
902 	u16		hba_queue_depth;
903 	u16		sge_size;
904 	u16 		scsiio_depth;
905 	u16		request_sz;
906 	u8		*request;
907 	dma_addr_t	request_dma;
908 	u32		request_dma_sz;
909 	struct scsiio_tracker *scsi_lookup;
910 	ulong		scsi_lookup_pages;
911 	spinlock_t 	scsi_lookup_lock;
912 	struct list_head free_list;
913 	int		pending_io_count;
914 	wait_queue_head_t reset_wq;
915 
916 	/* chain */
917 	struct chain_tracker *chain_lookup;
918 	struct list_head free_chain_list;
919 	struct dma_pool *chain_dma_pool;
920 	ulong		chain_pages;
921 	u16 		max_sges_in_main_message;
922 	u16		max_sges_in_chain_message;
923 	u16		chains_needed_per_io;
924 	u16		chain_offset_value_for_main_message;
925 	u32		chain_depth;
926 
927 	/* hi-priority queue */
928 	u16		hi_priority_smid;
929 	u8		*hi_priority;
930 	dma_addr_t	hi_priority_dma;
931 	u16		hi_priority_depth;
932 	struct request_tracker *hpr_lookup;
933 	struct list_head hpr_free_list;
934 
935 	/* internal queue */
936 	u16		internal_smid;
937 	u8		*internal;
938 	dma_addr_t	internal_dma;
939 	u16		internal_depth;
940 	struct request_tracker *internal_lookup;
941 	struct list_head internal_free_list;
942 
943 	/* sense */
944 	u8		*sense;
945 	dma_addr_t	sense_dma;
946 	struct dma_pool *sense_dma_pool;
947 
948 	/* reply */
949 	u16		reply_sz;
950 	u8		*reply;
951 	dma_addr_t	reply_dma;
952 	u32		reply_dma_max_address;
953 	u32		reply_dma_min_address;
954 	struct dma_pool *reply_dma_pool;
955 
956 	/* reply free queue */
957 	u16 		reply_free_queue_depth;
958 	__le32		*reply_free;
959 	dma_addr_t	reply_free_dma;
960 	struct dma_pool *reply_free_dma_pool;
961 	u32		reply_free_host_index;
962 
963 	/* reply post queue */
964 	u16 		reply_post_queue_depth;
965 	Mpi2ReplyDescriptorsUnion_t *reply_post_free;
966 	dma_addr_t	reply_post_free_dma;
967 	struct dma_pool *reply_post_free_dma_pool;
968 	u8		reply_queue_count;
969 	struct list_head reply_queue_list;
970 
971 	struct list_head delayed_tr_list;
972 	struct list_head delayed_tr_volume_list;
973 
974 	/* diag buffer support */
975 	u8		*diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
976 	u32		diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
977 	dma_addr_t	diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
978 	u8		diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
979 	u32		unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
980 	Mpi2ManufacturingPage10_t manu_pg10;
981 	u32		product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
982 	u32		diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
983 	u32		ring_buffer_offset;
984 	u32		ring_buffer_sz;
985 	u8		is_warpdrive;
986 	u8		hide_ir_msg;
987 	u8		mfg_pg10_hide_flag;
988 	u8		hide_drives;
989 
990 };
991 
992 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
993     u32 reply);
994 
995 
996 /* base shared API */
997 extern struct list_head mpt2sas_ioc_list;
998 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
999 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
1000 
1001 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
1002 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
1003 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
1004 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
1005 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
1006     enum reset_type type);
1007 
1008 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1009 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1010 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
1011 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
1012     u16 smid);
1013 void mpt2sas_base_flush_reply_queues(struct MPT2SAS_ADAPTER *ioc);
1014 
1015 /* hi-priority queue */
1016 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1017 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
1018     struct scsi_cmnd *scmd);
1019 
1020 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1021 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1022 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1023     u16 handle);
1024 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1025 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1026     u16 io_index);
1027 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1028 void mpt2sas_base_initialize_callback_handler(void);
1029 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1030 void mpt2sas_base_release_callback_handler(u8 cb_idx);
1031 
1032 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1033     u32 reply);
1034 u8 mpt2sas_port_enable_done(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1035 	u8 msix_index,	u32 reply);
1036 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
1037 
1038 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
1039 
1040 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
1041 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
1042     Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
1043     *mpi_request);
1044 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
1045     Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1046 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
1047 
1048 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
1049 
1050 void mpt2sas_base_update_missing_delay(struct MPT2SAS_ADAPTER *ioc,
1051 	u16 device_missing_delay, u8 io_missing_delay);
1052 
1053 int mpt2sas_port_enable(struct MPT2SAS_ADAPTER *ioc);
1054 
1055 /* scsih shared API */
1056 u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1057     u32 reply);
1058 int mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle,
1059 	uint channel, uint id, uint lun, u8 type, u16 smid_task,
1060 	ulong timeout, unsigned long serial_number, enum mutex_type m_type);
1061 void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1062 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1063 void mpt2sas_expander_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1064 void mpt2sas_device_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1065 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
1066     u16 handle);
1067 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
1068     *ioc, u64 sas_address);
1069 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
1070     struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1071 
1072 void mpt2sas_port_enable_complete(struct MPT2SAS_ADAPTER *ioc);
1073 
1074 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1075 
1076 /* config shared API */
1077 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1078     u32 reply);
1079 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
1080 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
1081     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1082 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
1083     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
1084 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1085     *mpi_reply, Mpi2BiosPage2_t *config_page);
1086 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1087     *mpi_reply, Mpi2BiosPage3_t *config_page);
1088 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1089     *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1090 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1091     *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
1092 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1093     *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
1094 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1095     *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
1096 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1097     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1098 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1099     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1100 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1101     *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1102 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
1103     Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1104 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1105     *mpi_reply, Mpi2IOCPage8_t *config_page);
1106 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1107     *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
1108 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1109     *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
1110 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1111     *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
1112 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1113     *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1114 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1115     *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1116 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1117     *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
1118 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
1119 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1120     *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
1121 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1122     *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
1123     u32 form_specific);
1124 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
1125     u16 *volume_handle);
1126 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
1127     u64 *wwid);
1128 /* ctl shared API */
1129 extern struct device_attribute *mpt2sas_host_attrs[];
1130 extern struct device_attribute *mpt2sas_dev_attrs[];
1131 void mpt2sas_ctl_init(void);
1132 void mpt2sas_ctl_exit(void);
1133 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1134     u32 reply);
1135 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1136 u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1137     u32 reply);
1138 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
1139     Mpi2EventNotificationReply_t *mpi_reply);
1140 
1141 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
1142 	u8 bits_to_regsiter);
1143 
1144 /* transport shared API */
1145 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1146     u32 reply);
1147 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
1148      u16 handle, u64 sas_address);
1149 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
1150      u64 sas_address_parent);
1151 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1152     *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1153 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1154     *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
1155 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
1156      u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1157 extern struct sas_function_template mpt2sas_transport_functions;
1158 extern struct scsi_transport_template *mpt2sas_transport_template;
1159 extern int scsi_internal_device_block(struct scsi_device *sdev);
1160 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
1161     u8 msix_index, u32 reply);
1162 extern int scsi_internal_device_unblock(struct scsi_device *sdev);
1163 
1164 #endif /* MPT2SAS_BASE_H_INCLUDED */
1165