1 /*
2  * This is the Fusion MPT base driver providing common API layer interface
3  * for access to MPT (Message Passing Technology) firmware.
4  *
5  * This code is based on drivers/scsi/mpt3sas/mpt3sas_base.h
6  * Copyright (C) 2012-2014  LSI Corporation
7  * Copyright (C) 2013-2014 Avago Technologies
8  *  (mailto: MPT-FusionLinux.pdl@avagotech.com)
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * NO WARRANTY
21  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
22  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
23  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
24  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
25  * solely responsible for determining the appropriateness of using and
26  * distributing the Program and assumes all risks associated with its
27  * exercise of rights under this Agreement, including but not limited to
28  * the risks and costs of program errors, damage to or loss of data,
29  * programs or equipment, and unavailability or interruption of operations.
30 
31  * DISCLAIMER OF LIABILITY
32  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
33  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
35  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
38  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
39 
40  * You should have received a copy of the GNU General Public License
41  * along with this program; if not, write to the Free Software
42  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
43  * USA.
44  */
45 
46 #ifndef MPT3SAS_BASE_H_INCLUDED
47 #define MPT3SAS_BASE_H_INCLUDED
48 
49 #include "mpi/mpi2_type.h"
50 #include "mpi/mpi2.h"
51 #include "mpi/mpi2_ioc.h"
52 #include "mpi/mpi2_cnfg.h"
53 #include "mpi/mpi2_init.h"
54 #include "mpi/mpi2_raid.h"
55 #include "mpi/mpi2_tool.h"
56 #include "mpi/mpi2_sas.h"
57 
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_device.h>
61 #include <scsi/scsi_host.h>
62 #include <scsi/scsi_tcq.h>
63 #include <scsi/scsi_transport_sas.h>
64 #include <scsi/scsi_dbg.h>
65 #include <scsi/scsi_eh.h>
66 
67 #include "mpt3sas_debug.h"
68 #include "mpt3sas_trigger_diag.h"
69 
70 /* driver versioning info */
71 #define MPT3SAS_DRIVER_NAME		"mpt3sas"
72 #define MPT3SAS_AUTHOR "Avago Technologies <MPT-FusionLinux.pdl@avagotech.com>"
73 #define MPT3SAS_DESCRIPTION	"LSI MPT Fusion SAS 3.0 Device Driver"
74 #define MPT3SAS_DRIVER_VERSION		"04.100.00.00"
75 #define MPT3SAS_MAJOR_VERSION		4
76 #define MPT3SAS_MINOR_VERSION		100
77 #define MPT3SAS_BUILD_VERSION		0
78 #define MPT3SAS_RELEASE_VERSION	00
79 
80 /*
81  * Set MPT3SAS_SG_DEPTH value based on user input.
82  */
83 #define MPT3SAS_MAX_PHYS_SEGMENTS	SCSI_MAX_SG_SEGMENTS
84 #define MPT3SAS_MIN_PHYS_SEGMENTS	16
85 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
86 #define MPT3SAS_SG_DEPTH		CONFIG_SCSI_MPT3SAS_MAX_SGE
87 #else
88 #define MPT3SAS_SG_DEPTH		MPT3SAS_MAX_PHYS_SEGMENTS
89 #endif
90 
91 
92 /*
93  * Generic Defines
94  */
95 #define MPT3SAS_SATA_QUEUE_DEPTH	32
96 #define MPT3SAS_SAS_QUEUE_DEPTH		254
97 #define MPT3SAS_RAID_QUEUE_DEPTH	128
98 
99 #define MPT_NAME_LENGTH			32	/* generic length of strings */
100 #define MPT_STRING_LENGTH		64
101 
102 #define MPT_MAX_CALLBACKS		32
103 
104 
105 #define	 CAN_SLEEP			1
106 #define  NO_SLEEP			0
107 
108 #define INTERNAL_CMDS_COUNT		10	/* reserved cmds */
109 
110 #define MPI3_HIM_MASK			0xFFFFFFFF /* mask every bit*/
111 
112 #define MPT3SAS_INVALID_DEVICE_HANDLE	0xFFFF
113 
114 /*
115  * reset phases
116  */
117 #define MPT3_IOC_PRE_RESET		1 /* prior to host reset */
118 #define MPT3_IOC_AFTER_RESET		2 /* just after host reset */
119 #define MPT3_IOC_DONE_RESET		3 /* links re-initialized */
120 
121 /*
122  * logging format
123  */
124 #define MPT3SAS_FMT			"%s: "
125 
126 /*
127  * per target private data
128  */
129 #define MPT_TARGET_FLAGS_RAID_COMPONENT	0x01
130 #define MPT_TARGET_FLAGS_VOLUME		0x02
131 #define MPT_TARGET_FLAGS_DELETED	0x04
132 #define MPT_TARGET_FASTPATH_IO		0x08
133 
134 /*
135  * Intel HBA branding
136  */
137 #define MPT3SAS_INTEL_RMS3JC080_BRANDING       \
138 	"Intel(R) Integrated RAID Module RMS3JC080"
139 #define MPT3SAS_INTEL_RS3GC008_BRANDING       \
140 	"Intel(R) RAID Controller RS3GC008"
141 #define MPT3SAS_INTEL_RS3FC044_BRANDING       \
142 	"Intel(R) RAID Controller RS3FC044"
143 #define MPT3SAS_INTEL_RS3UC080_BRANDING       \
144 	"Intel(R) RAID Controller RS3UC080"
145 
146 /*
147  * Intel HBA SSDIDs
148  */
149 #define MPT3SAS_INTEL_RMS3JC080_SSDID	0x3521
150 #define MPT3SAS_INTEL_RS3GC008_SSDID	0x3522
151 #define MPT3SAS_INTEL_RS3FC044_SSDID	0x3523
152 #define MPT3SAS_INTEL_RS3UC080_SSDID    0x3524
153 
154 /*
155  * status bits for ioc->diag_buffer_status
156  */
157 #define MPT3_DIAG_BUFFER_IS_REGISTERED	(0x01)
158 #define MPT3_DIAG_BUFFER_IS_RELEASED	(0x02)
159 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET	(0x04)
160 
161 
162 /* OEM Identifiers */
163 #define MFG10_OEM_ID_INVALID                   (0x00000000)
164 #define MFG10_OEM_ID_DELL                      (0x00000001)
165 #define MFG10_OEM_ID_FSC                       (0x00000002)
166 #define MFG10_OEM_ID_SUN                       (0x00000003)
167 #define MFG10_OEM_ID_IBM                       (0x00000004)
168 
169 /* GENERIC Flags 0*/
170 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
171 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
172 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
173 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
174 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
175 
176 /* OEM Specific Flags will come from OEM specific header files */
177 struct Mpi2ManufacturingPage10_t {
178 	MPI2_CONFIG_PAGE_HEADER	Header;		/* 00h */
179 	U8	OEMIdentifier;			/* 04h */
180 	U8	Reserved1;			/* 05h */
181 	U16	Reserved2;			/* 08h */
182 	U32	Reserved3;			/* 0Ch */
183 	U32	GenericFlags0;			/* 10h */
184 	U32	GenericFlags1;			/* 14h */
185 	U32	Reserved4;			/* 18h */
186 	U32	OEMSpecificFlags0;		/* 1Ch */
187 	U32	OEMSpecificFlags1;		/* 20h */
188 	U32	Reserved5[18];			/* 24h - 60h*/
189 };
190 
191 
192 /* Miscellaneous options */
193 struct Mpi2ManufacturingPage11_t {
194 	MPI2_CONFIG_PAGE_HEADER Header;		/* 00h */
195 	__le32	Reserved1;			/* 04h */
196 	u8	Reserved2;			/* 08h */
197 	u8	EEDPTagMode;			/* 09h */
198 	u8	Reserved3;			/* 0Ah */
199 	u8	Reserved4;			/* 0Bh */
200 	__le32	Reserved5[23];			/* 0Ch-60h*/
201 };
202 
203 /**
204  * struct MPT3SAS_TARGET - starget private hostdata
205  * @starget: starget object
206  * @sas_address: target sas address
207  * @handle: device handle
208  * @num_luns: number luns
209  * @flags: MPT_TARGET_FLAGS_XXX flags
210  * @deleted: target flaged for deletion
211  * @tm_busy: target is busy with TM request.
212  */
213 struct MPT3SAS_TARGET {
214 	struct scsi_target *starget;
215 	u64	sas_address;
216 	u16	handle;
217 	int	num_luns;
218 	u32	flags;
219 	u8	deleted;
220 	u8	tm_busy;
221 };
222 
223 
224 /*
225  * per device private data
226  */
227 #define MPT_DEVICE_FLAGS_INIT		0x01
228 #define MPT_DEVICE_TLR_ON		0x02
229 
230 /**
231  * struct MPT3SAS_DEVICE - sdev private hostdata
232  * @sas_target: starget private hostdata
233  * @lun: lun number
234  * @flags: MPT_DEVICE_XXX flags
235  * @configured_lun: lun is configured
236  * @block: device is in SDEV_BLOCK state
237  * @tlr_snoop_check: flag used in determining whether to disable TLR
238  * @eedp_enable: eedp support enable bit
239  * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
240  * @eedp_block_length: block size
241  */
242 struct MPT3SAS_DEVICE {
243 	struct MPT3SAS_TARGET *sas_target;
244 	unsigned int	lun;
245 	u32	flags;
246 	u8	configured_lun;
247 	u8	block;
248 	u8	tlr_snoop_check;
249 };
250 
251 #define MPT3_CMD_NOT_USED	0x8000	/* free */
252 #define MPT3_CMD_COMPLETE	0x0001	/* completed */
253 #define MPT3_CMD_PENDING	0x0002	/* pending */
254 #define MPT3_CMD_REPLY_VALID	0x0004	/* reply is valid */
255 #define MPT3_CMD_RESET		0x0008	/* host reset dropped the command */
256 
257 /**
258  * struct _internal_cmd - internal commands struct
259  * @mutex: mutex
260  * @done: completion
261  * @reply: reply message pointer
262  * @sense: sense data
263  * @status: MPT3_CMD_XXX status
264  * @smid: system message id
265  */
266 struct _internal_cmd {
267 	struct mutex mutex;
268 	struct completion done;
269 	void	*reply;
270 	void	*sense;
271 	u16	status;
272 	u16	smid;
273 };
274 
275 
276 
277 /**
278  * struct _sas_device - attached device information
279  * @list: sas device list
280  * @starget: starget object
281  * @sas_address: device sas address
282  * @device_name: retrieved from the SAS IDENTIFY frame.
283  * @handle: device handle
284  * @sas_address_parent: sas address of parent expander or sas host
285  * @enclosure_handle: enclosure handle
286  * @enclosure_logical_id: enclosure logical identifier
287  * @volume_handle: volume handle (valid when hidden raid member)
288  * @volume_wwid: volume unique identifier
289  * @device_info: bitfield provides detailed info about the device
290  * @id: target id
291  * @channel: target channel
292  * @slot: number number
293  * @phy: phy identifier provided in sas device page 0
294  * @responding: used in _scsih_sas_device_mark_responding
295  * @fast_path: fast path feature enable bit
296  * @pfa_led_on: flag for PFA LED status
297  *
298  */
299 struct _sas_device {
300 	struct list_head list;
301 	struct scsi_target *starget;
302 	u64	sas_address;
303 	u64	device_name;
304 	u16	handle;
305 	u64	sas_address_parent;
306 	u16	enclosure_handle;
307 	u64	enclosure_logical_id;
308 	u16	volume_handle;
309 	u64	volume_wwid;
310 	u32	device_info;
311 	int	id;
312 	int	channel;
313 	u16	slot;
314 	u8	phy;
315 	u8	responding;
316 	u8	fast_path;
317 	u8	pfa_led_on;
318 };
319 
320 /**
321  * struct _raid_device - raid volume link list
322  * @list: sas device list
323  * @starget: starget object
324  * @sdev: scsi device struct (volumes are single lun)
325  * @wwid: unique identifier for the volume
326  * @handle: device handle
327  * @id: target id
328  * @channel: target channel
329  * @volume_type: the raid level
330  * @device_info: bitfield provides detailed info about the hidden components
331  * @num_pds: number of hidden raid components
332  * @responding: used in _scsih_raid_device_mark_responding
333  * @percent_complete: resync percent complete
334  */
335 #define MPT_MAX_WARPDRIVE_PDS		8
336 struct _raid_device {
337 	struct list_head list;
338 	struct scsi_target *starget;
339 	struct scsi_device *sdev;
340 	u64	wwid;
341 	u16	handle;
342 	int	id;
343 	int	channel;
344 	u8	volume_type;
345 	u8	num_pds;
346 	u8	responding;
347 	u8	percent_complete;
348 	u32	device_info;
349 };
350 
351 /**
352  * struct _boot_device - boot device info
353  * @is_raid: flag to indicate whether this is volume
354  * @device: holds pointer for either struct _sas_device or
355  *     struct _raid_device
356  */
357 struct _boot_device {
358 	u8 is_raid;
359 	void *device;
360 };
361 
362 /**
363  * struct _sas_port - wide/narrow sas port information
364  * @port_list: list of ports belonging to expander
365  * @num_phys: number of phys belonging to this port
366  * @remote_identify: attached device identification
367  * @rphy: sas transport rphy object
368  * @port: sas transport wide/narrow port object
369  * @phy_list: _sas_phy list objects belonging to this port
370  */
371 struct _sas_port {
372 	struct list_head port_list;
373 	u8	num_phys;
374 	struct sas_identify remote_identify;
375 	struct sas_rphy *rphy;
376 	struct sas_port *port;
377 	struct list_head phy_list;
378 };
379 
380 /**
381  * struct _sas_phy - phy information
382  * @port_siblings: list of phys belonging to a port
383  * @identify: phy identification
384  * @remote_identify: attached device identification
385  * @phy: sas transport phy object
386  * @phy_id: unique phy id
387  * @handle: device handle for this phy
388  * @attached_handle: device handle for attached device
389  * @phy_belongs_to_port: port has been created for this phy
390  */
391 struct _sas_phy {
392 	struct list_head port_siblings;
393 	struct sas_identify identify;
394 	struct sas_identify remote_identify;
395 	struct sas_phy *phy;
396 	u8	phy_id;
397 	u16	handle;
398 	u16	attached_handle;
399 	u8	phy_belongs_to_port;
400 };
401 
402 /**
403  * struct _sas_node - sas_host/expander information
404  * @list: list of expanders
405  * @parent_dev: parent device class
406  * @num_phys: number phys belonging to this sas_host/expander
407  * @sas_address: sas address of this sas_host/expander
408  * @handle: handle for this sas_host/expander
409  * @sas_address_parent: sas address of parent expander or sas host
410  * @enclosure_handle: handle for this a member of an enclosure
411  * @device_info: bitwise defining capabilities of this sas_host/expander
412  * @responding: used in _scsih_expander_device_mark_responding
413  * @phy: a list of phys that make up this sas_host/expander
414  * @sas_port_list: list of ports attached to this sas_host/expander
415  */
416 struct _sas_node {
417 	struct list_head list;
418 	struct device *parent_dev;
419 	u8	num_phys;
420 	u64	sas_address;
421 	u16	handle;
422 	u64	sas_address_parent;
423 	u16	enclosure_handle;
424 	u64	enclosure_logical_id;
425 	u8	responding;
426 	struct	_sas_phy *phy;
427 	struct list_head sas_port_list;
428 };
429 
430 /**
431  * enum reset_type - reset state
432  * @FORCE_BIG_HAMMER: issue diagnostic reset
433  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
434  */
435 enum reset_type {
436 	FORCE_BIG_HAMMER,
437 	SOFT_RESET,
438 };
439 
440 /**
441  * struct chain_tracker - firmware chain tracker
442  * @chain_buffer: chain buffer
443  * @chain_buffer_dma: physical address
444  * @tracker_list: list of free request (ioc->free_chain_list)
445  */
446 struct chain_tracker {
447 	void *chain_buffer;
448 	dma_addr_t chain_buffer_dma;
449 	struct list_head tracker_list;
450 };
451 
452 /**
453  * struct scsiio_tracker - scsi mf request tracker
454  * @smid: system message id
455  * @scmd: scsi request pointer
456  * @cb_idx: callback index
457  * @tracker_list: list of free request (ioc->free_list)
458  */
459 struct scsiio_tracker {
460 	u16	smid;
461 	struct scsi_cmnd *scmd;
462 	u8	cb_idx;
463 	struct list_head chain_list;
464 	struct list_head tracker_list;
465 };
466 
467 /**
468  * struct request_tracker - firmware request tracker
469  * @smid: system message id
470  * @cb_idx: callback index
471  * @tracker_list: list of free request (ioc->free_list)
472  */
473 struct request_tracker {
474 	u16	smid;
475 	u8	cb_idx;
476 	struct list_head tracker_list;
477 };
478 
479 /**
480  * struct _tr_list - target reset list
481  * @handle: device handle
482  * @state: state machine
483  */
484 struct _tr_list {
485 	struct list_head list;
486 	u16	handle;
487 	u16	state;
488 };
489 
490 
491 /**
492  * struct adapter_reply_queue - the reply queue struct
493  * @ioc: per adapter object
494  * @msix_index: msix index into vector table
495  * @vector: irq vector
496  * @reply_post_host_index: head index in the pool where FW completes IO
497  * @reply_post_free: reply post base virt address
498  * @name: the name registered to request_irq()
499  * @busy: isr is actively processing replies on another cpu
500  * @list: this list
501 */
502 struct adapter_reply_queue {
503 	struct MPT3SAS_ADAPTER	*ioc;
504 	u8			msix_index;
505 	unsigned int		vector;
506 	u32			reply_post_host_index;
507 	Mpi2ReplyDescriptorsUnion_t *reply_post_free;
508 	char			name[MPT_NAME_LENGTH];
509 	atomic_t		busy;
510 	cpumask_var_t		affinity_hint;
511 	struct list_head	list;
512 };
513 
514 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
515 
516 /* SAS3.0 support */
517 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
518 		struct scsi_cmnd *scmd, u16 smid);
519 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
520 		dma_addr_t data_out_dma, size_t data_out_sz,
521 		dma_addr_t data_in_dma, size_t data_in_sz);
522 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
523 		void *paddr);
524 
525 
526 
527 /* IOC Facts and Port Facts converted from little endian to cpu */
528 union mpi3_version_union {
529 	MPI2_VERSION_STRUCT		Struct;
530 	u32				Word;
531 };
532 
533 struct mpt3sas_facts {
534 	u16			MsgVersion;
535 	u16			HeaderVersion;
536 	u8			IOCNumber;
537 	u8			VP_ID;
538 	u8			VF_ID;
539 	u16			IOCExceptions;
540 	u16			IOCStatus;
541 	u32			IOCLogInfo;
542 	u8			MaxChainDepth;
543 	u8			WhoInit;
544 	u8			NumberOfPorts;
545 	u8			MaxMSIxVectors;
546 	u16			RequestCredit;
547 	u16			ProductID;
548 	u32			IOCCapabilities;
549 	union mpi3_version_union	FWVersion;
550 	u16			IOCRequestFrameSize;
551 	u16			Reserved3;
552 	u16			MaxInitiators;
553 	u16			MaxTargets;
554 	u16			MaxSasExpanders;
555 	u16			MaxEnclosures;
556 	u16			ProtocolFlags;
557 	u16			HighPriorityCredit;
558 	u16			MaxReplyDescriptorPostQueueDepth;
559 	u8			ReplyFrameSize;
560 	u8			MaxVolumes;
561 	u16			MaxDevHandle;
562 	u16			MaxPersistentEntries;
563 	u16			MinDevHandle;
564 };
565 
566 struct mpt3sas_port_facts {
567 	u8			PortNumber;
568 	u8			VP_ID;
569 	u8			VF_ID;
570 	u8			PortType;
571 	u16			MaxPostedCmdBuffers;
572 };
573 
574 struct reply_post_struct {
575 	Mpi2ReplyDescriptorsUnion_t	*reply_post_free;
576 	dma_addr_t			reply_post_free_dma;
577 };
578 
579 /**
580  * enum mutex_type - task management mutex type
581  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
582  * @TM_MUTEX_ON: mutex is required
583  */
584 enum mutex_type {
585 	TM_MUTEX_OFF = 0,
586 	TM_MUTEX_ON = 1,
587 };
588 
589 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
590 /**
591  * struct MPT3SAS_ADAPTER - per adapter struct
592  * @list: ioc_list
593  * @shost: shost object
594  * @id: unique adapter id
595  * @cpu_count: number online cpus
596  * @name: generic ioc string
597  * @tmp_string: tmp string used for logging
598  * @pdev: pci pdev object
599  * @pio_chip: physical io register space
600  * @chip: memory mapped register space
601  * @chip_phys: physical addrss prior to mapping
602  * @logging_level: see mpt3sas_debug.h
603  * @fwfault_debug: debuging FW timeouts
604  * @ir_firmware: IR firmware present
605  * @bars: bitmask of BAR's that must be configured
606  * @mask_interrupts: ignore interrupt
607  * @dma_mask: used to set the consistent dma mask
608  * @fault_reset_work_q_name: fw fault work queue
609  * @fault_reset_work_q: ""
610  * @fault_reset_work: ""
611  * @firmware_event_name: fw event work queue
612  * @firmware_event_thread: ""
613  * @fw_event_lock:
614  * @fw_event_list: list of fw events
615  * @aen_event_read_flag: event log was read
616  * @broadcast_aen_busy: broadcast aen waiting to be serviced
617  * @shost_recovery: host reset in progress
618  * @ioc_reset_in_progress_lock:
619  * @ioc_link_reset_in_progress: phy/hard reset in progress
620  * @ignore_loginfos: ignore loginfos during task management
621  * @remove_host: flag for when driver unloads, to avoid sending dev resets
622  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
623  * @wait_for_discovery_to_complete: flag set at driver load time when
624  *                                               waiting on reporting devices
625  * @is_driver_loading: flag set at driver load time
626  * @port_enable_failed: flag set when port enable has failed
627  * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
628  * @start_scan_failed: means port enable failed, return's the ioc_status
629  * @msix_enable: flag indicating msix is enabled
630  * @msix_vector_count: number msix vectors
631  * @cpu_msix_table: table for mapping cpus to msix index
632  * @cpu_msix_table_sz: table size
633  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
634  * @scsi_io_cb_idx: shost generated commands
635  * @tm_cb_idx: task management commands
636  * @scsih_cb_idx: scsih internal commands
637  * @transport_cb_idx: transport internal commands
638  * @ctl_cb_idx: clt internal commands
639  * @base_cb_idx: base internal commands
640  * @config_cb_idx: base internal commands
641  * @tm_tr_cb_idx : device removal target reset handshake
642  * @tm_tr_volume_cb_idx : volume removal target reset
643  * @base_cmds:
644  * @transport_cmds:
645  * @scsih_cmds:
646  * @tm_cmds:
647  * @ctl_cmds:
648  * @config_cmds:
649  * @base_add_sg_single: handler for either 32/64 bit sgl's
650  * @event_type: bits indicating which events to log
651  * @event_context: unique id for each logged event
652  * @event_log: event log pointer
653  * @event_masks: events that are masked
654  * @facts: static facts data
655  * @pfacts: static port facts data
656  * @manu_pg0: static manufacturing page 0
657  * @manu_pg10: static manufacturing page 10
658  * @manu_pg11: static manufacturing page 11
659  * @bios_pg2: static bios page 2
660  * @bios_pg3: static bios page 3
661  * @ioc_pg8: static ioc page 8
662  * @iounit_pg0: static iounit page 0
663  * @iounit_pg1: static iounit page 1
664  * @iounit_pg8: static iounit page 8
665  * @sas_hba: sas host object
666  * @sas_expander_list: expander object list
667  * @sas_node_lock:
668  * @sas_device_list: sas device object list
669  * @sas_device_init_list: sas device object list (used only at init time)
670  * @sas_device_lock:
671  * @io_missing_delay: time for IO completed by fw when PDR enabled
672  * @device_missing_delay: time for device missing by fw when PDR enabled
673  * @sas_id : used for setting volume target IDs
674  * @blocking_handles: bitmask used to identify which devices need blocking
675  * @pd_handles : bitmask for PD handles
676  * @pd_handles_sz : size of pd_handle bitmask
677  * @config_page_sz: config page size
678  * @config_page: reserve memory for config page payload
679  * @config_page_dma:
680  * @hba_queue_depth: hba request queue depth
681  * @sge_size: sg element size for either 32/64 bit
682  * @scsiio_depth: SCSI_IO queue depth
683  * @request_sz: per request frame size
684  * @request: pool of request frames
685  * @request_dma:
686  * @request_dma_sz:
687  * @scsi_lookup: firmware request tracker list
688  * @scsi_lookup_lock:
689  * @free_list: free list of request
690  * @pending_io_count:
691  * @reset_wq:
692  * @chain: pool of chains
693  * @chain_dma:
694  * @max_sges_in_main_message: number sg elements in main message
695  * @max_sges_in_chain_message: number sg elements per chain
696  * @chains_needed_per_io: max chains per io
697  * @chain_depth: total chains allocated
698  * @hi_priority_smid:
699  * @hi_priority:
700  * @hi_priority_dma:
701  * @hi_priority_depth:
702  * @hpr_lookup:
703  * @hpr_free_list:
704  * @internal_smid:
705  * @internal:
706  * @internal_dma:
707  * @internal_depth:
708  * @internal_lookup:
709  * @internal_free_list:
710  * @sense: pool of sense
711  * @sense_dma:
712  * @sense_dma_pool:
713  * @reply_depth: hba reply queue depth:
714  * @reply_sz: per reply frame size:
715  * @reply: pool of replys:
716  * @reply_dma:
717  * @reply_dma_pool:
718  * @reply_free_queue_depth: reply free depth
719  * @reply_free: pool for reply free queue (32 bit addr)
720  * @reply_free_dma:
721  * @reply_free_dma_pool:
722  * @reply_free_host_index: tail index in pool to insert free replys
723  * @reply_post_queue_depth: reply post queue depth
724  * @reply_post_struct: struct for reply_post_free physical & virt address
725  * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
726  * @rdpq_array_enable: rdpq_array support is enabled in the driver
727  * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
728  *				is assigned only ones
729  * @reply_queue_count: number of reply queue's
730  * @reply_queue_list: link list contaning the reply queue info
731  * @reply_post_host_index: head index in the pool where FW completes IO
732  * @delayed_tr_list: target reset link list
733  * @delayed_tr_volume_list: volume target reset link list
734  * @@temp_sensors_count: flag to carry the number of temperature sensors
735  */
736 struct MPT3SAS_ADAPTER {
737 	struct list_head list;
738 	struct Scsi_Host *shost;
739 	u8		id;
740 	int		cpu_count;
741 	char		name[MPT_NAME_LENGTH];
742 	char		tmp_string[MPT_STRING_LENGTH];
743 	struct pci_dev	*pdev;
744 	Mpi2SystemInterfaceRegs_t __iomem *chip;
745 	resource_size_t	chip_phys;
746 	int		logging_level;
747 	int		fwfault_debug;
748 	u8		ir_firmware;
749 	int		bars;
750 	u8		mask_interrupts;
751 	int		dma_mask;
752 
753 	/* fw fault handler */
754 	char		fault_reset_work_q_name[20];
755 	struct workqueue_struct *fault_reset_work_q;
756 	struct delayed_work fault_reset_work;
757 
758 	/* fw event handler */
759 	char		firmware_event_name[20];
760 	struct workqueue_struct	*firmware_event_thread;
761 	spinlock_t	fw_event_lock;
762 	struct list_head fw_event_list;
763 
764 	 /* misc flags */
765 	int		aen_event_read_flag;
766 	u8		broadcast_aen_busy;
767 	u16		broadcast_aen_pending;
768 	u8		shost_recovery;
769 
770 	struct mutex	reset_in_progress_mutex;
771 	spinlock_t	ioc_reset_in_progress_lock;
772 	u8		ioc_link_reset_in_progress;
773 	u8		ioc_reset_in_progress_status;
774 
775 	u8		ignore_loginfos;
776 	u8		remove_host;
777 	u8		pci_error_recovery;
778 	u8		wait_for_discovery_to_complete;
779 	u8		is_driver_loading;
780 	u8		port_enable_failed;
781 	u8		start_scan;
782 	u16		start_scan_failed;
783 
784 	u8		msix_enable;
785 	u16		msix_vector_count;
786 	u8		*cpu_msix_table;
787 	u16		cpu_msix_table_sz;
788 	u32		ioc_reset_count;
789 	MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
790 
791 	/* internal commands, callback index */
792 	u8		scsi_io_cb_idx;
793 	u8		tm_cb_idx;
794 	u8		transport_cb_idx;
795 	u8		scsih_cb_idx;
796 	u8		ctl_cb_idx;
797 	u8		base_cb_idx;
798 	u8		port_enable_cb_idx;
799 	u8		config_cb_idx;
800 	u8		tm_tr_cb_idx;
801 	u8		tm_tr_volume_cb_idx;
802 	u8		tm_sas_control_cb_idx;
803 	struct _internal_cmd base_cmds;
804 	struct _internal_cmd port_enable_cmds;
805 	struct _internal_cmd transport_cmds;
806 	struct _internal_cmd scsih_cmds;
807 	struct _internal_cmd tm_cmds;
808 	struct _internal_cmd ctl_cmds;
809 	struct _internal_cmd config_cmds;
810 
811 	MPT_ADD_SGE	base_add_sg_single;
812 
813 	/* function ptr for either IEEE or MPI sg elements */
814 	MPT_BUILD_SG_SCMD build_sg_scmd;
815 	MPT_BUILD_SG    build_sg;
816 	MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
817 	u8              mpi25;
818 	u16             sge_size_ieee;
819 
820 	/* function ptr for MPI sg elements only */
821 	MPT_BUILD_SG    build_sg_mpi;
822 	MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
823 
824 	/* event log */
825 	u32		event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
826 	u32		event_context;
827 	void		*event_log;
828 	u32		event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
829 
830 	/* static config pages */
831 	struct mpt3sas_facts facts;
832 	struct mpt3sas_port_facts *pfacts;
833 	Mpi2ManufacturingPage0_t manu_pg0;
834 	struct Mpi2ManufacturingPage10_t manu_pg10;
835 	struct Mpi2ManufacturingPage11_t manu_pg11;
836 	Mpi2BiosPage2_t	bios_pg2;
837 	Mpi2BiosPage3_t	bios_pg3;
838 	Mpi2IOCPage8_t ioc_pg8;
839 	Mpi2IOUnitPage0_t iounit_pg0;
840 	Mpi2IOUnitPage1_t iounit_pg1;
841 	Mpi2IOUnitPage8_t iounit_pg8;
842 
843 	struct _boot_device req_boot_device;
844 	struct _boot_device req_alt_boot_device;
845 	struct _boot_device current_boot_device;
846 
847 	/* sas hba, expander, and device list */
848 	struct _sas_node sas_hba;
849 	struct list_head sas_expander_list;
850 	spinlock_t	sas_node_lock;
851 	struct list_head sas_device_list;
852 	struct list_head sas_device_init_list;
853 	spinlock_t	sas_device_lock;
854 	struct list_head raid_device_list;
855 	spinlock_t	raid_device_lock;
856 	u8		io_missing_delay;
857 	u16		device_missing_delay;
858 	int		sas_id;
859 
860 	void		*blocking_handles;
861 	void		*pd_handles;
862 	u16		pd_handles_sz;
863 
864 	/* config page */
865 	u16		config_page_sz;
866 	void		*config_page;
867 	dma_addr_t	config_page_dma;
868 
869 	/* scsiio request */
870 	u16		hba_queue_depth;
871 	u16		sge_size;
872 	u16		scsiio_depth;
873 	u16		request_sz;
874 	u8		*request;
875 	dma_addr_t	request_dma;
876 	u32		request_dma_sz;
877 	struct scsiio_tracker *scsi_lookup;
878 	ulong		scsi_lookup_pages;
879 	spinlock_t	scsi_lookup_lock;
880 	struct list_head free_list;
881 	int		pending_io_count;
882 	wait_queue_head_t reset_wq;
883 
884 	/* chain */
885 	struct chain_tracker *chain_lookup;
886 	struct list_head free_chain_list;
887 	struct dma_pool *chain_dma_pool;
888 	ulong		chain_pages;
889 	u16		max_sges_in_main_message;
890 	u16		max_sges_in_chain_message;
891 	u16		chains_needed_per_io;
892 	u32		chain_depth;
893 
894 	/* hi-priority queue */
895 	u16		hi_priority_smid;
896 	u8		*hi_priority;
897 	dma_addr_t	hi_priority_dma;
898 	u16		hi_priority_depth;
899 	struct request_tracker *hpr_lookup;
900 	struct list_head hpr_free_list;
901 
902 	/* internal queue */
903 	u16		internal_smid;
904 	u8		*internal;
905 	dma_addr_t	internal_dma;
906 	u16		internal_depth;
907 	struct request_tracker *internal_lookup;
908 	struct list_head internal_free_list;
909 
910 	/* sense */
911 	u8		*sense;
912 	dma_addr_t	sense_dma;
913 	struct dma_pool *sense_dma_pool;
914 
915 	/* reply */
916 	u16		reply_sz;
917 	u8		*reply;
918 	dma_addr_t	reply_dma;
919 	u32		reply_dma_max_address;
920 	u32		reply_dma_min_address;
921 	struct dma_pool *reply_dma_pool;
922 
923 	/* reply free queue */
924 	u16		reply_free_queue_depth;
925 	__le32		*reply_free;
926 	dma_addr_t	reply_free_dma;
927 	struct dma_pool *reply_free_dma_pool;
928 	u32		reply_free_host_index;
929 
930 	/* reply post queue */
931 	u16		reply_post_queue_depth;
932 	struct reply_post_struct *reply_post;
933 	u8		rdpq_array_capable;
934 	u8		rdpq_array_enable;
935 	u8		rdpq_array_enable_assigned;
936 	struct dma_pool *reply_post_free_dma_pool;
937 	u8		reply_queue_count;
938 	struct list_head reply_queue_list;
939 
940 	struct list_head delayed_tr_list;
941 	struct list_head delayed_tr_volume_list;
942 	u8		temp_sensors_count;
943 
944 	/* diag buffer support */
945 	u8		*diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
946 	u32		diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
947 	dma_addr_t	diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
948 	u8		diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
949 	u32		unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
950 	u32		product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
951 	u32		diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
952 	u32		ring_buffer_offset;
953 	u32		ring_buffer_sz;
954 	spinlock_t	diag_trigger_lock;
955 	u8		diag_trigger_active;
956 	struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
957 	struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
958 	struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
959 	struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
960 };
961 
962 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
963 	u32 reply);
964 
965 
966 /* base shared API */
967 extern struct list_head mpt3sas_ioc_list;
968 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
969 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
970 
971 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
972 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
973 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
974 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
975 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
976 	enum reset_type type);
977 
978 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
979 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
980 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
981 	u16 smid);
982 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
983 
984 /* hi-priority queue */
985 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
986 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
987 	struct scsi_cmnd *scmd);
988 
989 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
990 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
991 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
992 	u16 handle);
993 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
994 	u16 handle);
995 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid);
996 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
997 void mpt3sas_base_initialize_callback_handler(void);
998 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
999 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1000 
1001 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1002 	u32 reply);
1003 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1004 	u8 msix_index, u32 reply);
1005 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1006 	u32 phys_addr);
1007 
1008 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1009 
1010 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1011 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1012 	Mpi2SasIoUnitControlReply_t *mpi_reply,
1013 	Mpi2SasIoUnitControlRequest_t *mpi_request);
1014 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1015 	Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1016 
1017 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1018 	u32 *event_type);
1019 
1020 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1021 
1022 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1023 	u16 device_missing_delay, u8 io_missing_delay);
1024 
1025 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1026 
1027 
1028 /* scsih shared API */
1029 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1030 	u32 reply);
1031 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1032 
1033 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1034 	uint channel, uint id, uint lun, u8 type, u16 smid_task,
1035 	ulong timeout, enum mutex_type m_type);
1036 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1037 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1038 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1039 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1040 	u64 sas_address);
1041 
1042 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1043 	struct MPT3SAS_ADAPTER *ioc, u16 handle);
1044 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1045 	struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1046 struct _sas_device *mpt3sas_scsih_sas_device_find_by_sas_address(
1047 	struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1048 
1049 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1050 
1051 /* config shared API */
1052 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1053 	u32 reply);
1054 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1055 	u8 *num_phys);
1056 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1057 	Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1058 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1059 	Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1060 	u16 sz);
1061 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1062 	Mpi2ConfigReply_t *mpi_reply,
1063 	struct Mpi2ManufacturingPage10_t *config_page);
1064 
1065 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1066 	Mpi2ConfigReply_t *mpi_reply,
1067 	struct Mpi2ManufacturingPage11_t  *config_page);
1068 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1069 	Mpi2ConfigReply_t *mpi_reply,
1070 	struct Mpi2ManufacturingPage11_t *config_page);
1071 
1072 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1073 	*mpi_reply, Mpi2BiosPage2_t *config_page);
1074 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1075 	*mpi_reply, Mpi2BiosPage3_t *config_page);
1076 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1077 	*mpi_reply, Mpi2IOUnitPage0_t *config_page);
1078 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1079 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1080 	u32 form, u32 handle);
1081 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1082 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1083 	u32 form, u32 handle);
1084 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1085 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1086 	u16 sz);
1087 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1088 	*mpi_reply, Mpi2IOUnitPage1_t *config_page);
1089 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1090 	*mpi_reply, Mpi2IOUnitPage1_t *config_page);
1091 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1092 	*mpi_reply, Mpi2IOUnitPage8_t *config_page);
1093 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1094 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1095 	u16 sz);
1096 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1097 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1098 	u16 sz);
1099 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1100 	*mpi_reply, Mpi2IOCPage8_t *config_page);
1101 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1102 	Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1103 	u32 form, u32 handle);
1104 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1105 	Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1106 	u32 phy_number, u16 handle);
1107 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1108 	Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1109 	u32 form, u32 handle);
1110 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1111 	*mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1112 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1113 	*mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1114 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1115 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1116 	u32 handle);
1117 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1118 	u8 *num_pds);
1119 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1120 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1121 	u32 handle, u16 sz);
1122 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1123 	Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1124 	u32 form, u32 form_specific);
1125 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1126 	u16 *volume_handle);
1127 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1128 	u16 volume_handle, u64 *wwid);
1129 
1130 /* ctl shared API */
1131 extern struct device_attribute *mpt3sas_host_attrs[];
1132 extern struct device_attribute *mpt3sas_dev_attrs[];
1133 void mpt3sas_ctl_init(void);
1134 void mpt3sas_ctl_exit(void);
1135 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1136 	u32 reply);
1137 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1138 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1139 	u8 msix_index, u32 reply);
1140 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1141 	Mpi2EventNotificationReply_t *mpi_reply);
1142 
1143 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1144 	u8 bits_to_regsiter);
1145 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1146 	u8 *issue_reset);
1147 
1148 /* transport shared API */
1149 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1150 	u32 reply);
1151 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1152 	u16 handle, u64 sas_address);
1153 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1154 	u64 sas_address_parent);
1155 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1156 	*mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1157 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1158 	struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1159 	struct device *parent_dev);
1160 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1161 	u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1162 extern struct sas_function_template mpt3sas_transport_functions;
1163 extern struct scsi_transport_template *mpt3sas_transport_template;
1164 extern int scsi_internal_device_block(struct scsi_device *sdev);
1165 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1166 				enum scsi_device_state new_state);
1167 /* trigger data externs */
1168 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1169 	struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1170 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1171 	struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1172 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1173 	u32 tigger_bitmask);
1174 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1175 	u16 log_entry_qualifier);
1176 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1177 	u8 asc, u8 ascq);
1178 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1179 	u32 loginfo);
1180 #endif /* MPT3SAS_BASE_H_INCLUDED */
1181