2 * This is the Fusion MPT base driver providing common API layer interface
3 * for access to MPT (Message Passing Technology) firmware.
5 * This code is based on drivers/scsi/mpt3sas/mpt3sas_base.h
6 * Copyright (C) 2012-2013 LSI Corporation
7 * (mailto:DL-MPTFusionLinux@lsi.com)
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.
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.
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.
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
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,
45 #ifndef MPT3SAS_BASE_H_INCLUDED
46 #define MPT3SAS_BASE_H_INCLUDED
48 #include "mpi/mpi2_type.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"
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>
66 #include "mpt3sas_debug.h"
67 #include "mpt3sas_trigger_diag.h"
69 /* driver versioning info */
70 #define MPT3SAS_DRIVER_NAME "mpt3sas"
71 #define MPT3SAS_AUTHOR "LSI Corporation <DL-MPTFusionLinux@lsi.com>"
72 #define MPT3SAS_DESCRIPTION "LSI MPT Fusion SAS 3.0 Device Driver"
73 #define MPT3SAS_DRIVER_VERSION "02.100.00.00"
74 #define MPT3SAS_MAJOR_VERSION 2
75 #define MPT3SAS_MINOR_VERSION 100
76 #define MPT3SAS_BUILD_VERSION 0
77 #define MPT3SAS_RELEASE_VERSION 00
80 * Set MPT3SAS_SG_DEPTH value based on user input.
82 #define MPT3SAS_MAX_PHYS_SEGMENTS SCSI_MAX_SG_SEGMENTS
83 #define MPT3SAS_MIN_PHYS_SEGMENTS 16
84 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
85 #define MPT3SAS_SG_DEPTH CONFIG_SCSI_MPT3SAS_MAX_SGE
87 #define MPT3SAS_SG_DEPTH MPT3SAS_MAX_PHYS_SEGMENTS
94 #define MPT3SAS_SATA_QUEUE_DEPTH 32
95 #define MPT3SAS_SAS_QUEUE_DEPTH 254
96 #define MPT3SAS_RAID_QUEUE_DEPTH 128
98 #define MPT_NAME_LENGTH 32 /* generic length of strings */
99 #define MPT_STRING_LENGTH 64
101 #define MPT_MAX_CALLBACKS 32
107 #define INTERNAL_CMDS_COUNT 10 /* reserved cmds */
109 #define MPI3_HIM_MASK 0xFFFFFFFF /* mask every bit*/
111 #define MPT3SAS_INVALID_DEVICE_HANDLE 0xFFFF
116 #define MPT3_IOC_PRE_RESET 1 /* prior to host reset */
117 #define MPT3_IOC_AFTER_RESET 2 /* just after host reset */
118 #define MPT3_IOC_DONE_RESET 3 /* links re-initialized */
123 #define MPT3SAS_FMT "%s: "
126 * per target private data
128 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
129 #define MPT_TARGET_FLAGS_VOLUME 0x02
130 #define MPT_TARGET_FLAGS_DELETED 0x04
131 #define MPT_TARGET_FASTPATH_IO 0x08
136 * status bits for ioc->diag_buffer_status
138 #define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)
139 #define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)
140 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)
143 /* OEM Identifiers */
144 #define MFG10_OEM_ID_INVALID (0x00000000)
145 #define MFG10_OEM_ID_DELL (0x00000001)
146 #define MFG10_OEM_ID_FSC (0x00000002)
147 #define MFG10_OEM_ID_SUN (0x00000003)
148 #define MFG10_OEM_ID_IBM (0x00000004)
151 #define MFG10_GF0_OCE_DISABLED (0x00000001)
152 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
153 #define MFG10_GF0_R10_DISPLAY (0x00000004)
154 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
155 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
157 /* OEM Specific Flags will come from OEM specific header files */
158 struct Mpi2ManufacturingPage10_t
{
159 MPI2_CONFIG_PAGE_HEADER Header
; /* 00h */
160 U8 OEMIdentifier
; /* 04h */
161 U8 Reserved1
; /* 05h */
162 U16 Reserved2
; /* 08h */
163 U32 Reserved3
; /* 0Ch */
164 U32 GenericFlags0
; /* 10h */
165 U32 GenericFlags1
; /* 14h */
166 U32 Reserved4
; /* 18h */
167 U32 OEMSpecificFlags0
; /* 1Ch */
168 U32 OEMSpecificFlags1
; /* 20h */
169 U32 Reserved5
[18]; /* 24h - 60h*/
173 /* Miscellaneous options */
174 struct Mpi2ManufacturingPage11_t
{
175 MPI2_CONFIG_PAGE_HEADER Header
; /* 00h */
176 __le32 Reserved1
; /* 04h */
177 u8 Reserved2
; /* 08h */
178 u8 EEDPTagMode
; /* 09h */
179 u8 Reserved3
; /* 0Ah */
180 u8 Reserved4
; /* 0Bh */
181 __le32 Reserved5
[23]; /* 0Ch-60h*/
185 * struct MPT3SAS_TARGET - starget private hostdata
186 * @starget: starget object
187 * @sas_address: target sas address
188 * @handle: device handle
189 * @num_luns: number luns
190 * @flags: MPT_TARGET_FLAGS_XXX flags
191 * @deleted: target flaged for deletion
192 * @tm_busy: target is busy with TM request.
194 struct MPT3SAS_TARGET
{
195 struct scsi_target
*starget
;
206 * per device private data
208 #define MPT_DEVICE_FLAGS_INIT 0x01
209 #define MPT_DEVICE_TLR_ON 0x02
212 * struct MPT3SAS_DEVICE - sdev private hostdata
213 * @sas_target: starget private hostdata
215 * @flags: MPT_DEVICE_XXX flags
216 * @configured_lun: lun is configured
217 * @block: device is in SDEV_BLOCK state
218 * @tlr_snoop_check: flag used in determining whether to disable TLR
219 * @eedp_enable: eedp support enable bit
220 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
221 * @eedp_block_length: block size
223 struct MPT3SAS_DEVICE
{
224 struct MPT3SAS_TARGET
*sas_target
;
232 #define MPT3_CMD_NOT_USED 0x8000 /* free */
233 #define MPT3_CMD_COMPLETE 0x0001 /* completed */
234 #define MPT3_CMD_PENDING 0x0002 /* pending */
235 #define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */
236 #define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */
239 * struct _internal_cmd - internal commands struct
242 * @reply: reply message pointer
244 * @status: MPT3_CMD_XXX status
245 * @smid: system message id
247 struct _internal_cmd
{
249 struct completion done
;
259 * struct _sas_device - attached device information
260 * @list: sas device list
261 * @starget: starget object
262 * @sas_address: device sas address
263 * @device_name: retrieved from the SAS IDENTIFY frame.
264 * @handle: device handle
265 * @sas_address_parent: sas address of parent expander or sas host
266 * @enclosure_handle: enclosure handle
267 * @enclosure_logical_id: enclosure logical identifier
268 * @volume_handle: volume handle (valid when hidden raid member)
269 * @volume_wwid: volume unique identifier
270 * @device_info: bitfield provides detailed info about the device
272 * @channel: target channel
273 * @slot: number number
274 * @phy: phy identifier provided in sas device page 0
275 * @fast_path: fast path feature enable bit
276 * @responding: used in _scsih_sas_device_mark_responding
279 struct list_head list
;
280 struct scsi_target
*starget
;
284 u64 sas_address_parent
;
285 u16 enclosure_handle
;
286 u64 enclosure_logical_id
;
299 * struct _raid_device - raid volume link list
300 * @list: sas device list
301 * @starget: starget object
302 * @sdev: scsi device struct (volumes are single lun)
303 * @wwid: unique identifier for the volume
304 * @handle: device handle
306 * @channel: target channel
307 * @volume_type: the raid level
308 * @device_info: bitfield provides detailed info about the hidden components
309 * @num_pds: number of hidden raid components
310 * @responding: used in _scsih_raid_device_mark_responding
311 * @percent_complete: resync percent complete
313 #define MPT_MAX_WARPDRIVE_PDS 8
314 struct _raid_device
{
315 struct list_head list
;
316 struct scsi_target
*starget
;
317 struct scsi_device
*sdev
;
330 * struct _boot_device - boot device info
331 * @is_raid: flag to indicate whether this is volume
332 * @device: holds pointer for either struct _sas_device or
333 * struct _raid_device
335 struct _boot_device
{
341 * struct _sas_port - wide/narrow sas port information
342 * @port_list: list of ports belonging to expander
343 * @num_phys: number of phys belonging to this port
344 * @remote_identify: attached device identification
345 * @rphy: sas transport rphy object
346 * @port: sas transport wide/narrow port object
347 * @phy_list: _sas_phy list objects belonging to this port
350 struct list_head port_list
;
352 struct sas_identify remote_identify
;
353 struct sas_rphy
*rphy
;
354 struct sas_port
*port
;
355 struct list_head phy_list
;
359 * struct _sas_phy - phy information
360 * @port_siblings: list of phys belonging to a port
361 * @identify: phy identification
362 * @remote_identify: attached device identification
363 * @phy: sas transport phy object
364 * @phy_id: unique phy id
365 * @handle: device handle for this phy
366 * @attached_handle: device handle for attached device
367 * @phy_belongs_to_port: port has been created for this phy
370 struct list_head port_siblings
;
371 struct sas_identify identify
;
372 struct sas_identify remote_identify
;
377 u8 phy_belongs_to_port
;
381 * struct _sas_node - sas_host/expander information
382 * @list: list of expanders
383 * @parent_dev: parent device class
384 * @num_phys: number phys belonging to this sas_host/expander
385 * @sas_address: sas address of this sas_host/expander
386 * @handle: handle for this sas_host/expander
387 * @sas_address_parent: sas address of parent expander or sas host
388 * @enclosure_handle: handle for this a member of an enclosure
389 * @device_info: bitwise defining capabilities of this sas_host/expander
390 * @responding: used in _scsih_expander_device_mark_responding
391 * @phy: a list of phys that make up this sas_host/expander
392 * @sas_port_list: list of ports attached to this sas_host/expander
395 struct list_head list
;
396 struct device
*parent_dev
;
400 u64 sas_address_parent
;
401 u16 enclosure_handle
;
402 u64 enclosure_logical_id
;
404 struct _sas_phy
*phy
;
405 struct list_head sas_port_list
;
409 * enum reset_type - reset state
410 * @FORCE_BIG_HAMMER: issue diagnostic reset
411 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
419 * struct chain_tracker - firmware chain tracker
420 * @chain_buffer: chain buffer
421 * @chain_buffer_dma: physical address
422 * @tracker_list: list of free request (ioc->free_chain_list)
424 struct chain_tracker
{
426 dma_addr_t chain_buffer_dma
;
427 struct list_head tracker_list
;
431 * struct scsiio_tracker - scsi mf request tracker
432 * @smid: system message id
433 * @scmd: scsi request pointer
434 * @cb_idx: callback index
435 * @tracker_list: list of free request (ioc->free_list)
437 struct scsiio_tracker
{
439 struct scsi_cmnd
*scmd
;
441 struct list_head chain_list
;
442 struct list_head tracker_list
;
446 * struct request_tracker - firmware request tracker
447 * @smid: system message id
448 * @cb_idx: callback index
449 * @tracker_list: list of free request (ioc->free_list)
451 struct request_tracker
{
454 struct list_head tracker_list
;
458 * struct _tr_list - target reset list
459 * @handle: device handle
460 * @state: state machine
463 struct list_head list
;
470 * struct adapter_reply_queue - the reply queue struct
471 * @ioc: per adapter object
472 * @msix_index: msix index into vector table
473 * @vector: irq vector
474 * @reply_post_host_index: head index in the pool where FW completes IO
475 * @reply_post_free: reply post base virt address
476 * @name: the name registered to request_irq()
477 * @busy: isr is actively processing replies on another cpu
480 struct adapter_reply_queue
{
481 struct MPT3SAS_ADAPTER
*ioc
;
484 u32 reply_post_host_index
;
485 Mpi2ReplyDescriptorsUnion_t
*reply_post_free
;
486 char name
[MPT_NAME_LENGTH
];
488 struct list_head list
;
491 typedef void (*MPT_ADD_SGE
)(void *paddr
, u32 flags_length
, dma_addr_t dma_addr
);
494 typedef int (*MPT_BUILD_SG_SCMD
)(struct MPT3SAS_ADAPTER
*ioc
,
495 struct scsi_cmnd
*scmd
, u16 smid
);
496 typedef void (*MPT_BUILD_SG
)(struct MPT3SAS_ADAPTER
*ioc
, void *psge
,
497 dma_addr_t data_out_dma
, size_t data_out_sz
,
498 dma_addr_t data_in_dma
, size_t data_in_sz
);
499 typedef void (*MPT_BUILD_ZERO_LEN_SGE
)(struct MPT3SAS_ADAPTER
*ioc
,
504 /* IOC Facts and Port Facts converted from little endian to cpu */
505 union mpi3_version_union
{
506 MPI2_VERSION_STRUCT Struct
;
510 struct mpt3sas_facts
{
526 union mpi3_version_union FWVersion
;
527 u16 IOCRequestFrameSize
;
534 u16 HighPriorityCredit
;
535 u16 MaxReplyDescriptorPostQueueDepth
;
539 u16 MaxPersistentEntries
;
543 struct mpt3sas_port_facts
{
548 u16 MaxPostedCmdBuffers
;
552 * enum mutex_type - task management mutex type
553 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
554 * @TM_MUTEX_ON: mutex is required
561 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS
)(struct MPT3SAS_ADAPTER
*ioc
);
563 * struct MPT3SAS_ADAPTER - per adapter struct
565 * @shost: shost object
566 * @id: unique adapter id
567 * @cpu_count: number online cpus
568 * @name: generic ioc string
569 * @tmp_string: tmp string used for logging
570 * @pdev: pci pdev object
571 * @pio_chip: physical io register space
572 * @chip: memory mapped register space
573 * @chip_phys: physical addrss prior to mapping
574 * @logging_level: see mpt3sas_debug.h
575 * @fwfault_debug: debuging FW timeouts
576 * @ir_firmware: IR firmware present
577 * @bars: bitmask of BAR's that must be configured
578 * @mask_interrupts: ignore interrupt
579 * @fault_reset_work_q_name: fw fault work queue
580 * @fault_reset_work_q: ""
581 * @fault_reset_work: ""
582 * @firmware_event_name: fw event work queue
583 * @firmware_event_thread: ""
585 * @fw_event_list: list of fw events
586 * @aen_event_read_flag: event log was read
587 * @broadcast_aen_busy: broadcast aen waiting to be serviced
588 * @shost_recovery: host reset in progress
589 * @ioc_reset_in_progress_lock:
590 * @ioc_link_reset_in_progress: phy/hard reset in progress
591 * @ignore_loginfos: ignore loginfos during task management
592 * @remove_host: flag for when driver unloads, to avoid sending dev resets
593 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
594 * @wait_for_discovery_to_complete: flag set at driver load time when
595 * waiting on reporting devices
596 * @is_driver_loading: flag set at driver load time
597 * @port_enable_failed: flag set when port enable has failed
598 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
599 * @start_scan_failed: means port enable failed, return's the ioc_status
600 * @msix_enable: flag indicating msix is enabled
601 * @msix_vector_count: number msix vectors
602 * @cpu_msix_table: table for mapping cpus to msix index
603 * @cpu_msix_table_sz: table size
604 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
605 * @scsi_io_cb_idx: shost generated commands
606 * @tm_cb_idx: task management commands
607 * @scsih_cb_idx: scsih internal commands
608 * @transport_cb_idx: transport internal commands
609 * @ctl_cb_idx: clt internal commands
610 * @base_cb_idx: base internal commands
611 * @config_cb_idx: base internal commands
612 * @tm_tr_cb_idx : device removal target reset handshake
613 * @tm_tr_volume_cb_idx : volume removal target reset
620 * @base_add_sg_single: handler for either 32/64 bit sgl's
621 * @event_type: bits indicating which events to log
622 * @event_context: unique id for each logged event
623 * @event_log: event log pointer
624 * @event_masks: events that are masked
625 * @facts: static facts data
626 * @pfacts: static port facts data
627 * @manu_pg0: static manufacturing page 0
628 * @manu_pg10: static manufacturing page 10
629 * @manu_pg11: static manufacturing page 11
630 * @bios_pg2: static bios page 2
631 * @bios_pg3: static bios page 3
632 * @ioc_pg8: static ioc page 8
633 * @iounit_pg0: static iounit page 0
634 * @iounit_pg1: static iounit page 1
635 * @sas_hba: sas host object
636 * @sas_expander_list: expander object list
638 * @sas_device_list: sas device object list
639 * @sas_device_init_list: sas device object list (used only at init time)
641 * @io_missing_delay: time for IO completed by fw when PDR enabled
642 * @device_missing_delay: time for device missing by fw when PDR enabled
643 * @sas_id : used for setting volume target IDs
644 * @blocking_handles: bitmask used to identify which devices need blocking
645 * @pd_handles : bitmask for PD handles
646 * @pd_handles_sz : size of pd_handle bitmask
647 * @config_page_sz: config page size
648 * @config_page: reserve memory for config page payload
650 * @hba_queue_depth: hba request queue depth
651 * @sge_size: sg element size for either 32/64 bit
652 * @scsiio_depth: SCSI_IO queue depth
653 * @request_sz: per request frame size
654 * @request: pool of request frames
657 * @scsi_lookup: firmware request tracker list
659 * @free_list: free list of request
662 * @chain: pool of chains
664 * @max_sges_in_main_message: number sg elements in main message
665 * @max_sges_in_chain_message: number sg elements per chain
666 * @chains_needed_per_io: max chains per io
667 * @chain_depth: total chains allocated
671 * @hi_priority_depth:
679 * @internal_free_list:
680 * @sense: pool of sense
683 * @reply_depth: hba reply queue depth:
684 * @reply_sz: per reply frame size:
685 * @reply: pool of replys:
688 * @reply_free_queue_depth: reply free depth
689 * @reply_free: pool for reply free queue (32 bit addr)
691 * @reply_free_dma_pool:
692 * @reply_free_host_index: tail index in pool to insert free replys
693 * @reply_post_queue_depth: reply post queue depth
694 * @reply_post_free: pool for reply post (64bit descriptor)
695 * @reply_post_free_dma:
696 * @reply_queue_count: number of reply queue's
697 * @reply_queue_list: link list contaning the reply queue info
698 * @reply_post_host_index: head index in the pool where FW completes IO
699 * @delayed_tr_list: target reset link list
700 * @delayed_tr_volume_list: volume target reset link list
702 struct MPT3SAS_ADAPTER
{
703 struct list_head list
;
704 struct Scsi_Host
*shost
;
707 char name
[MPT_NAME_LENGTH
];
708 char tmp_string
[MPT_STRING_LENGTH
];
709 struct pci_dev
*pdev
;
710 Mpi2SystemInterfaceRegs_t __iomem
*chip
;
711 resource_size_t chip_phys
;
718 /* fw fault handler */
719 char fault_reset_work_q_name
[20];
720 struct workqueue_struct
*fault_reset_work_q
;
721 struct delayed_work fault_reset_work
;
723 /* fw event handler */
724 char firmware_event_name
[20];
725 struct workqueue_struct
*firmware_event_thread
;
726 spinlock_t fw_event_lock
;
727 struct list_head fw_event_list
;
730 int aen_event_read_flag
;
731 u8 broadcast_aen_busy
;
732 u16 broadcast_aen_pending
;
735 struct mutex reset_in_progress_mutex
;
736 spinlock_t ioc_reset_in_progress_lock
;
737 u8 ioc_link_reset_in_progress
;
738 u8 ioc_reset_in_progress_status
;
742 u8 pci_error_recovery
;
743 u8 wait_for_discovery_to_complete
;
744 u8 is_driver_loading
;
745 u8 port_enable_failed
;
747 u16 start_scan_failed
;
750 u16 msix_vector_count
;
752 u16 cpu_msix_table_sz
;
754 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds
;
756 /* internal commands, callback index */
763 u8 port_enable_cb_idx
;
766 u8 tm_tr_volume_cb_idx
;
767 u8 tm_sas_control_cb_idx
;
768 struct _internal_cmd base_cmds
;
769 struct _internal_cmd port_enable_cmds
;
770 struct _internal_cmd transport_cmds
;
771 struct _internal_cmd scsih_cmds
;
772 struct _internal_cmd tm_cmds
;
773 struct _internal_cmd ctl_cmds
;
774 struct _internal_cmd config_cmds
;
776 MPT_ADD_SGE base_add_sg_single
;
778 /* function ptr for either IEEE or MPI sg elements */
779 MPT_BUILD_SG_SCMD build_sg_scmd
;
780 MPT_BUILD_SG build_sg
;
781 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge
;
785 /* function ptr for MPI sg elements only */
786 MPT_BUILD_SG build_sg_mpi
;
787 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi
;
790 u32 event_type
[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS
];
793 u32 event_masks
[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS
];
795 /* static config pages */
796 struct mpt3sas_facts facts
;
797 struct mpt3sas_port_facts
*pfacts
;
798 Mpi2ManufacturingPage0_t manu_pg0
;
799 struct Mpi2ManufacturingPage10_t manu_pg10
;
800 struct Mpi2ManufacturingPage11_t manu_pg11
;
801 Mpi2BiosPage2_t bios_pg2
;
802 Mpi2BiosPage3_t bios_pg3
;
803 Mpi2IOCPage8_t ioc_pg8
;
804 Mpi2IOUnitPage0_t iounit_pg0
;
805 Mpi2IOUnitPage1_t iounit_pg1
;
807 struct _boot_device req_boot_device
;
808 struct _boot_device req_alt_boot_device
;
809 struct _boot_device current_boot_device
;
811 /* sas hba, expander, and device list */
812 struct _sas_node sas_hba
;
813 struct list_head sas_expander_list
;
814 spinlock_t sas_node_lock
;
815 struct list_head sas_device_list
;
816 struct list_head sas_device_init_list
;
817 spinlock_t sas_device_lock
;
818 struct list_head raid_device_list
;
819 spinlock_t raid_device_lock
;
821 u16 device_missing_delay
;
824 void *blocking_handles
;
831 dma_addr_t config_page_dma
;
839 dma_addr_t request_dma
;
841 struct scsiio_tracker
*scsi_lookup
;
842 ulong scsi_lookup_pages
;
843 spinlock_t scsi_lookup_lock
;
844 struct list_head free_list
;
845 int pending_io_count
;
846 wait_queue_head_t reset_wq
;
849 struct chain_tracker
*chain_lookup
;
850 struct list_head free_chain_list
;
851 struct dma_pool
*chain_dma_pool
;
853 u16 max_sges_in_main_message
;
854 u16 max_sges_in_chain_message
;
855 u16 chains_needed_per_io
;
858 /* hi-priority queue */
859 u16 hi_priority_smid
;
861 dma_addr_t hi_priority_dma
;
862 u16 hi_priority_depth
;
863 struct request_tracker
*hpr_lookup
;
864 struct list_head hpr_free_list
;
869 dma_addr_t internal_dma
;
871 struct request_tracker
*internal_lookup
;
872 struct list_head internal_free_list
;
876 dma_addr_t sense_dma
;
877 struct dma_pool
*sense_dma_pool
;
882 dma_addr_t reply_dma
;
883 u32 reply_dma_max_address
;
884 u32 reply_dma_min_address
;
885 struct dma_pool
*reply_dma_pool
;
887 /* reply free queue */
888 u16 reply_free_queue_depth
;
890 dma_addr_t reply_free_dma
;
891 struct dma_pool
*reply_free_dma_pool
;
892 u32 reply_free_host_index
;
894 /* reply post queue */
895 u16 reply_post_queue_depth
;
896 Mpi2ReplyDescriptorsUnion_t
*reply_post_free
;
897 dma_addr_t reply_post_free_dma
;
898 struct dma_pool
*reply_post_free_dma_pool
;
899 u8 reply_queue_count
;
900 struct list_head reply_queue_list
;
902 struct list_head delayed_tr_list
;
903 struct list_head delayed_tr_volume_list
;
905 /* diag buffer support */
906 u8
*diag_buffer
[MPI2_DIAG_BUF_TYPE_COUNT
];
907 u32 diag_buffer_sz
[MPI2_DIAG_BUF_TYPE_COUNT
];
908 dma_addr_t diag_buffer_dma
[MPI2_DIAG_BUF_TYPE_COUNT
];
909 u8 diag_buffer_status
[MPI2_DIAG_BUF_TYPE_COUNT
];
910 u32 unique_id
[MPI2_DIAG_BUF_TYPE_COUNT
];
911 u32 product_specific
[MPI2_DIAG_BUF_TYPE_COUNT
][23];
912 u32 diagnostic_flags
[MPI2_DIAG_BUF_TYPE_COUNT
];
913 u32 ring_buffer_offset
;
915 spinlock_t diag_trigger_lock
;
916 u8 diag_trigger_active
;
917 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master
;
918 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event
;
919 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi
;
920 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi
;
923 typedef u8 (*MPT_CALLBACK
)(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
927 /* base shared API */
928 extern struct list_head mpt3sas_ioc_list
;
929 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER
*ioc
);
930 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER
*ioc
);
932 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER
*ioc
);
933 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER
*ioc
);
934 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER
*ioc
);
935 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER
*ioc
);
936 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int sleep_flag
,
937 enum reset_type type
);
939 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
940 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
941 __le32
mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER
*ioc
,
943 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER
*ioc
);
945 /* hi-priority queue */
946 u16
mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
);
947 u16
mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
,
948 struct scsi_cmnd
*scmd
);
950 u16
mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
);
951 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
952 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
954 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
956 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
957 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
958 void mpt3sas_base_initialize_callback_handler(void);
959 u8
mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func
);
960 void mpt3sas_base_release_callback_handler(u8 cb_idx
);
962 u8
mpt3sas_base_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
964 u8
mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
965 u8 msix_index
, u32 reply
);
966 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER
*ioc
,
969 u32
mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER
*ioc
, int cooked
);
971 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER
*ioc
, u16 fault_code
);
972 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER
*ioc
,
973 Mpi2SasIoUnitControlReply_t
*mpi_reply
,
974 Mpi2SasIoUnitControlRequest_t
*mpi_request
);
975 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER
*ioc
,
976 Mpi2SepReply_t
*mpi_reply
, Mpi2SepRequest_t
*mpi_request
);
978 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER
*ioc
,
981 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER
*ioc
);
983 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER
*ioc
,
984 u16 device_missing_delay
, u8 io_missing_delay
);
986 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER
*ioc
);
989 /* scsih shared API */
990 u8
mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER
*ioc
, u8 msix_index
,
992 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int reset_phase
);
994 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
,
995 uint channel
, uint id
, uint lun
, u8 type
, u16 smid_task
,
996 ulong timeout
, unsigned long serial_number
, enum mutex_type m_type
);
997 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
998 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
999 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1000 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER
*ioc
,
1003 struct _sas_node
*mpt3sas_scsih_expander_find_by_handle(
1004 struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
1005 struct _sas_node
*mpt3sas_scsih_expander_find_by_sas_address(
1006 struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1007 struct _sas_device
*mpt3sas_scsih_sas_device_find_by_sas_address(
1008 struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1010 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER
*ioc
);
1012 /* config shared API */
1013 u8
mpt3sas_config_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1015 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER
*ioc
,
1017 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1018 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ManufacturingPage0_t
*config_page
);
1019 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER
*ioc
,
1020 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ManufacturingPage7_t
*config_page
,
1022 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER
*ioc
,
1023 Mpi2ConfigReply_t
*mpi_reply
,
1024 struct Mpi2ManufacturingPage10_t
*config_page
);
1026 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER
*ioc
,
1027 Mpi2ConfigReply_t
*mpi_reply
,
1028 struct Mpi2ManufacturingPage11_t
*config_page
);
1029 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER
*ioc
,
1030 Mpi2ConfigReply_t
*mpi_reply
,
1031 struct Mpi2ManufacturingPage11_t
*config_page
);
1033 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1034 *mpi_reply
, Mpi2BiosPage2_t
*config_page
);
1035 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1036 *mpi_reply
, Mpi2BiosPage3_t
*config_page
);
1037 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1038 *mpi_reply
, Mpi2IOUnitPage0_t
*config_page
);
1039 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1040 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasDevicePage0_t
*config_page
,
1041 u32 form
, u32 handle
);
1042 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1043 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasDevicePage1_t
*config_page
,
1044 u32 form
, u32 handle
);
1045 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1046 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage0_t
*config_page
,
1048 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1049 *mpi_reply
, Mpi2IOUnitPage1_t
*config_page
);
1050 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1051 *mpi_reply
, Mpi2IOUnitPage1_t
*config_page
);
1052 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1053 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage1_t
*config_page
,
1055 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1056 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage1_t
*config_page
,
1058 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1059 *mpi_reply
, Mpi2IOCPage8_t
*config_page
);
1060 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1061 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ExpanderPage0_t
*config_page
,
1062 u32 form
, u32 handle
);
1063 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1064 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ExpanderPage1_t
*config_page
,
1065 u32 phy_number
, u16 handle
);
1066 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1067 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasEnclosurePage0_t
*config_page
,
1068 u32 form
, u32 handle
);
1069 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1070 *mpi_reply
, Mpi2SasPhyPage0_t
*config_page
, u32 phy_number
);
1071 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1072 *mpi_reply
, Mpi2SasPhyPage1_t
*config_page
, u32 phy_number
);
1073 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1074 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidVolPage1_t
*config_page
, u32 form
,
1076 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
,
1078 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1079 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidVolPage0_t
*config_page
, u32 form
,
1080 u32 handle
, u16 sz
);
1081 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1082 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidPhysDiskPage0_t
*config_page
,
1083 u32 form
, u32 form_specific
);
1084 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER
*ioc
, u16 pd_handle
,
1085 u16
*volume_handle
);
1086 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER
*ioc
,
1087 u16 volume_handle
, u64
*wwid
);
1089 /* ctl shared API */
1090 extern struct device_attribute
*mpt3sas_host_attrs
[];
1091 extern struct device_attribute
*mpt3sas_dev_attrs
[];
1092 void mpt3sas_ctl_init(void);
1093 void mpt3sas_ctl_exit(void);
1094 u8
mpt3sas_ctl_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1096 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int reset_phase
);
1097 u8
mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER
*ioc
,
1098 u8 msix_index
, u32 reply
);
1099 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER
*ioc
,
1100 Mpi2EventNotificationReply_t
*mpi_reply
);
1102 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER
*ioc
,
1103 u8 bits_to_regsiter
);
1104 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER
*ioc
, u8 buffer_type
,
1107 /* transport shared API */
1108 u8
mpt3sas_transport_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1110 struct _sas_port
*mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER
*ioc
,
1111 u16 handle
, u64 sas_address
);
1112 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
,
1113 u64 sas_address_parent
);
1114 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER
*ioc
, struct _sas_phy
1115 *mpt3sas_phy
, Mpi2SasPhyPage0_t phy_pg0
, struct device
*parent_dev
);
1116 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER
*ioc
,
1117 struct _sas_phy
*mpt3sas_phy
, Mpi2ExpanderPage1_t expander_pg1
,
1118 struct device
*parent_dev
);
1119 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER
*ioc
,
1120 u64 sas_address
, u16 handle
, u8 phy_number
, u8 link_rate
);
1121 extern struct sas_function_template mpt3sas_transport_functions
;
1122 extern struct scsi_transport_template
*mpt3sas_transport_template
;
1123 extern int scsi_internal_device_block(struct scsi_device
*sdev
);
1124 extern int scsi_internal_device_unblock(struct scsi_device
*sdev
,
1125 enum scsi_device_state new_state
);
1126 /* trigger data externs */
1127 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER
*ioc
,
1128 struct SL_WH_TRIGGERS_EVENT_DATA_T
*event_data
);
1129 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER
*ioc
,
1130 struct SL_WH_TRIGGERS_EVENT_DATA_T
*event_data
);
1131 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER
*ioc
,
1132 u32 tigger_bitmask
);
1133 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER
*ioc
, u16 event
,
1134 u16 log_entry_qualifier
);
1135 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER
*ioc
, u8 sense_key
,
1137 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER
*ioc
, u16 ioc_status
,
1139 #endif /* MPT3SAS_BASE_H_INCLUDED */