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-2014 LSI Corporation
7 * Copyright (C) 2013-2014 Avago Technologies
8 * (mailto: MPT-FusionLinux.pdl@avagotech.com)
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.
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.
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.
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
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,
46 #ifndef MPT3SAS_BASE_H_INCLUDED
47 #define MPT3SAS_BASE_H_INCLUDED
49 #include "mpi/mpi2_type.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"
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>
67 #include "mpt3sas_debug.h"
68 #include "mpt3sas_trigger_diag.h"
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 "06.100.00.00"
75 #define MPT3SAS_MAJOR_VERSION 6
76 #define MPT3SAS_MINOR_VERSION 100
77 #define MPT3SAS_BUILD_VERSION 0
78 #define MPT3SAS_RELEASE_VERSION 00
81 * Set MPT3SAS_SG_DEPTH value based on user input.
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
88 #define MPT3SAS_SG_DEPTH MPT3SAS_MAX_PHYS_SEGMENTS
95 #define MPT3SAS_SATA_QUEUE_DEPTH 32
96 #define MPT3SAS_SAS_QUEUE_DEPTH 254
97 #define MPT3SAS_RAID_QUEUE_DEPTH 128
99 #define MPT_NAME_LENGTH 32 /* generic length of strings */
100 #define MPT_STRING_LENGTH 64
102 #define MPT_MAX_CALLBACKS 32
108 #define INTERNAL_CMDS_COUNT 10 /* reserved cmds */
110 #define MPI3_HIM_MASK 0xFFFFFFFF /* mask every bit*/
112 #define MPT3SAS_INVALID_DEVICE_HANDLE 0xFFFF
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 */
124 #define MPT3SAS_FMT "%s: "
127 * per target private data
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
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"
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
157 #define MPT3SAS_DELL_12G_HBA_BRANDING \
163 #define MPT3SAS_DELL_12G_HBA_SSDID 0x1F46
168 #define MPT3SAS_CISCO_12G_HBA_BRANDING \
169 "Cisco 9300-8E 12G SAS HBA"
174 #define MPT3SAS_CISCO_12G_HBA_SSDID 0x14C
177 * status bits for ioc->diag_buffer_status
179 #define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)
180 #define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)
181 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)
184 * Combined Reply Queue constants,
185 * There are twelve Supplemental Reply Post Host Index Registers
186 * and each register is at offset 0x10 bytes from the previous one.
188 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
189 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
191 /* OEM Identifiers */
192 #define MFG10_OEM_ID_INVALID (0x00000000)
193 #define MFG10_OEM_ID_DELL (0x00000001)
194 #define MFG10_OEM_ID_FSC (0x00000002)
195 #define MFG10_OEM_ID_SUN (0x00000003)
196 #define MFG10_OEM_ID_IBM (0x00000004)
199 #define MFG10_GF0_OCE_DISABLED (0x00000001)
200 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
201 #define MFG10_GF0_R10_DISPLAY (0x00000004)
202 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
203 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
205 /* OEM Specific Flags will come from OEM specific header files */
206 struct Mpi2ManufacturingPage10_t {
207 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
208 U8 OEMIdentifier; /* 04h */
209 U8 Reserved1; /* 05h */
210 U16 Reserved2; /* 08h */
211 U32 Reserved3; /* 0Ch */
212 U32 GenericFlags0; /* 10h */
213 U32 GenericFlags1; /* 14h */
214 U32 Reserved4; /* 18h */
215 U32 OEMSpecificFlags0; /* 1Ch */
216 U32 OEMSpecificFlags1; /* 20h */
217 U32 Reserved5[18]; /* 24h - 60h*/
221 /* Miscellaneous options */
222 struct Mpi2ManufacturingPage11_t {
223 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
224 __le32 Reserved1; /* 04h */
225 u8 Reserved2; /* 08h */
226 u8 EEDPTagMode; /* 09h */
227 u8 Reserved3; /* 0Ah */
228 u8 Reserved4; /* 0Bh */
229 __le32 Reserved5[23]; /* 0Ch-60h*/
233 * struct MPT3SAS_TARGET - starget private hostdata
234 * @starget: starget object
235 * @sas_address: target sas address
236 * @handle: device handle
237 * @num_luns: number luns
238 * @flags: MPT_TARGET_FLAGS_XXX flags
239 * @deleted: target flaged for deletion
240 * @tm_busy: target is busy with TM request.
242 struct MPT3SAS_TARGET {
243 struct scsi_target *starget;
254 * per device private data
256 #define MPT_DEVICE_FLAGS_INIT 0x01
257 #define MPT_DEVICE_TLR_ON 0x02
260 * struct MPT3SAS_DEVICE - sdev private hostdata
261 * @sas_target: starget private hostdata
263 * @flags: MPT_DEVICE_XXX flags
264 * @configured_lun: lun is configured
265 * @block: device is in SDEV_BLOCK state
266 * @tlr_snoop_check: flag used in determining whether to disable TLR
267 * @eedp_enable: eedp support enable bit
268 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
269 * @eedp_block_length: block size
271 struct MPT3SAS_DEVICE {
272 struct MPT3SAS_TARGET *sas_target;
280 #define MPT3_CMD_NOT_USED 0x8000 /* free */
281 #define MPT3_CMD_COMPLETE 0x0001 /* completed */
282 #define MPT3_CMD_PENDING 0x0002 /* pending */
283 #define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */
284 #define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */
287 * struct _internal_cmd - internal commands struct
290 * @reply: reply message pointer
292 * @status: MPT3_CMD_XXX status
293 * @smid: system message id
295 struct _internal_cmd {
297 struct completion done;
307 * struct _sas_device - attached device information
308 * @list: sas device list
309 * @starget: starget object
310 * @sas_address: device sas address
311 * @device_name: retrieved from the SAS IDENTIFY frame.
312 * @handle: device handle
313 * @sas_address_parent: sas address of parent expander or sas host
314 * @enclosure_handle: enclosure handle
315 * @enclosure_logical_id: enclosure logical identifier
316 * @volume_handle: volume handle (valid when hidden raid member)
317 * @volume_wwid: volume unique identifier
318 * @device_info: bitfield provides detailed info about the device
320 * @channel: target channel
321 * @slot: number number
322 * @phy: phy identifier provided in sas device page 0
323 * @responding: used in _scsih_sas_device_mark_responding
324 * @fast_path: fast path feature enable bit
325 * @pfa_led_on: flag for PFA LED status
326 * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
330 struct list_head list;
331 struct scsi_target *starget;
335 u64 sas_address_parent;
336 u16 enclosure_handle;
337 u64 enclosure_logical_id;
348 u8 pend_sas_rphy_add;
350 u8 connector_name[4];
354 * struct _raid_device - raid volume link list
355 * @list: sas device list
356 * @starget: starget object
357 * @sdev: scsi device struct (volumes are single lun)
358 * @wwid: unique identifier for the volume
359 * @handle: device handle
361 * @channel: target channel
362 * @volume_type: the raid level
363 * @device_info: bitfield provides detailed info about the hidden components
364 * @num_pds: number of hidden raid components
365 * @responding: used in _scsih_raid_device_mark_responding
366 * @percent_complete: resync percent complete
368 #define MPT_MAX_WARPDRIVE_PDS 8
369 struct _raid_device {
370 struct list_head list;
371 struct scsi_target *starget;
372 struct scsi_device *sdev;
385 * struct _boot_device - boot device info
386 * @is_raid: flag to indicate whether this is volume
387 * @device: holds pointer for either struct _sas_device or
388 * struct _raid_device
390 struct _boot_device {
396 * struct _sas_port - wide/narrow sas port information
397 * @port_list: list of ports belonging to expander
398 * @num_phys: number of phys belonging to this port
399 * @remote_identify: attached device identification
400 * @rphy: sas transport rphy object
401 * @port: sas transport wide/narrow port object
402 * @phy_list: _sas_phy list objects belonging to this port
405 struct list_head port_list;
407 struct sas_identify remote_identify;
408 struct sas_rphy *rphy;
409 struct sas_port *port;
410 struct list_head phy_list;
414 * struct _sas_phy - phy information
415 * @port_siblings: list of phys belonging to a port
416 * @identify: phy identification
417 * @remote_identify: attached device identification
418 * @phy: sas transport phy object
419 * @phy_id: unique phy id
420 * @handle: device handle for this phy
421 * @attached_handle: device handle for attached device
422 * @phy_belongs_to_port: port has been created for this phy
425 struct list_head port_siblings;
426 struct sas_identify identify;
427 struct sas_identify remote_identify;
432 u8 phy_belongs_to_port;
436 * struct _sas_node - sas_host/expander information
437 * @list: list of expanders
438 * @parent_dev: parent device class
439 * @num_phys: number phys belonging to this sas_host/expander
440 * @sas_address: sas address of this sas_host/expander
441 * @handle: handle for this sas_host/expander
442 * @sas_address_parent: sas address of parent expander or sas host
443 * @enclosure_handle: handle for this a member of an enclosure
444 * @device_info: bitwise defining capabilities of this sas_host/expander
445 * @responding: used in _scsih_expander_device_mark_responding
446 * @phy: a list of phys that make up this sas_host/expander
447 * @sas_port_list: list of ports attached to this sas_host/expander
450 struct list_head list;
451 struct device *parent_dev;
455 u64 sas_address_parent;
456 u16 enclosure_handle;
457 u64 enclosure_logical_id;
459 struct _sas_phy *phy;
460 struct list_head sas_port_list;
464 * enum reset_type - reset state
465 * @FORCE_BIG_HAMMER: issue diagnostic reset
466 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
474 * struct chain_tracker - firmware chain tracker
475 * @chain_buffer: chain buffer
476 * @chain_buffer_dma: physical address
477 * @tracker_list: list of free request (ioc->free_chain_list)
479 struct chain_tracker {
481 dma_addr_t chain_buffer_dma;
482 struct list_head tracker_list;
486 * struct scsiio_tracker - scsi mf request tracker
487 * @smid: system message id
488 * @scmd: scsi request pointer
489 * @cb_idx: callback index
490 * @tracker_list: list of free request (ioc->free_list)
492 struct scsiio_tracker {
494 struct scsi_cmnd *scmd;
496 struct list_head chain_list;
497 struct list_head tracker_list;
501 * struct request_tracker - firmware request tracker
502 * @smid: system message id
503 * @cb_idx: callback index
504 * @tracker_list: list of free request (ioc->free_list)
506 struct request_tracker {
509 struct list_head tracker_list;
513 * struct _tr_list - target reset list
514 * @handle: device handle
515 * @state: state machine
518 struct list_head list;
525 * struct adapter_reply_queue - the reply queue struct
526 * @ioc: per adapter object
527 * @msix_index: msix index into vector table
528 * @vector: irq vector
529 * @reply_post_host_index: head index in the pool where FW completes IO
530 * @reply_post_free: reply post base virt address
531 * @name: the name registered to request_irq()
532 * @busy: isr is actively processing replies on another cpu
535 struct adapter_reply_queue {
536 struct MPT3SAS_ADAPTER *ioc;
539 u32 reply_post_host_index;
540 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
541 char name[MPT_NAME_LENGTH];
543 cpumask_var_t affinity_hint;
544 struct list_head list;
547 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
550 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
551 struct scsi_cmnd *scmd, u16 smid);
552 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
553 dma_addr_t data_out_dma, size_t data_out_sz,
554 dma_addr_t data_in_dma, size_t data_in_sz);
555 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
560 /* IOC Facts and Port Facts converted from little endian to cpu */
561 union mpi3_version_union {
562 MPI2_VERSION_STRUCT Struct;
566 struct mpt3sas_facts {
582 union mpi3_version_union FWVersion;
583 u16 IOCRequestFrameSize;
590 u16 HighPriorityCredit;
591 u16 MaxReplyDescriptorPostQueueDepth;
595 u16 MaxPersistentEntries;
599 struct mpt3sas_port_facts {
604 u16 MaxPostedCmdBuffers;
607 struct reply_post_struct {
608 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
609 dma_addr_t reply_post_free_dma;
613 * enum mutex_type - task management mutex type
614 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
615 * @TM_MUTEX_ON: mutex is required
622 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
624 * struct MPT3SAS_ADAPTER - per adapter struct
626 * @shost: shost object
627 * @id: unique adapter id
628 * @cpu_count: number online cpus
629 * @name: generic ioc string
630 * @tmp_string: tmp string used for logging
631 * @pdev: pci pdev object
632 * @pio_chip: physical io register space
633 * @chip: memory mapped register space
634 * @chip_phys: physical addrss prior to mapping
635 * @logging_level: see mpt3sas_debug.h
636 * @fwfault_debug: debuging FW timeouts
637 * @ir_firmware: IR firmware present
638 * @bars: bitmask of BAR's that must be configured
639 * @mask_interrupts: ignore interrupt
640 * @dma_mask: used to set the consistent dma mask
641 * @fault_reset_work_q_name: fw fault work queue
642 * @fault_reset_work_q: ""
643 * @fault_reset_work: ""
644 * @firmware_event_name: fw event work queue
645 * @firmware_event_thread: ""
647 * @fw_event_list: list of fw events
648 * @aen_event_read_flag: event log was read
649 * @broadcast_aen_busy: broadcast aen waiting to be serviced
650 * @shost_recovery: host reset in progress
651 * @ioc_reset_in_progress_lock:
652 * @ioc_link_reset_in_progress: phy/hard reset in progress
653 * @ignore_loginfos: ignore loginfos during task management
654 * @remove_host: flag for when driver unloads, to avoid sending dev resets
655 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
656 * @wait_for_discovery_to_complete: flag set at driver load time when
657 * waiting on reporting devices
658 * @is_driver_loading: flag set at driver load time
659 * @port_enable_failed: flag set when port enable has failed
660 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
661 * @start_scan_failed: means port enable failed, return's the ioc_status
662 * @msix_enable: flag indicating msix is enabled
663 * @msix_vector_count: number msix vectors
664 * @cpu_msix_table: table for mapping cpus to msix index
665 * @cpu_msix_table_sz: table size
666 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
667 * @scsi_io_cb_idx: shost generated commands
668 * @tm_cb_idx: task management commands
669 * @scsih_cb_idx: scsih internal commands
670 * @transport_cb_idx: transport internal commands
671 * @ctl_cb_idx: clt internal commands
672 * @base_cb_idx: base internal commands
673 * @config_cb_idx: base internal commands
674 * @tm_tr_cb_idx : device removal target reset handshake
675 * @tm_tr_volume_cb_idx : volume removal target reset
682 * @base_add_sg_single: handler for either 32/64 bit sgl's
683 * @event_type: bits indicating which events to log
684 * @event_context: unique id for each logged event
685 * @event_log: event log pointer
686 * @event_masks: events that are masked
687 * @facts: static facts data
688 * @pfacts: static port facts data
689 * @manu_pg0: static manufacturing page 0
690 * @manu_pg10: static manufacturing page 10
691 * @manu_pg11: static manufacturing page 11
692 * @bios_pg2: static bios page 2
693 * @bios_pg3: static bios page 3
694 * @ioc_pg8: static ioc page 8
695 * @iounit_pg0: static iounit page 0
696 * @iounit_pg1: static iounit page 1
697 * @iounit_pg8: static iounit page 8
698 * @sas_hba: sas host object
699 * @sas_expander_list: expander object list
701 * @sas_device_list: sas device object list
702 * @sas_device_init_list: sas device object list (used only at init time)
704 * @io_missing_delay: time for IO completed by fw when PDR enabled
705 * @device_missing_delay: time for device missing by fw when PDR enabled
706 * @sas_id : used for setting volume target IDs
707 * @blocking_handles: bitmask used to identify which devices need blocking
708 * @pd_handles : bitmask for PD handles
709 * @pd_handles_sz : size of pd_handle bitmask
710 * @config_page_sz: config page size
711 * @config_page: reserve memory for config page payload
713 * @hba_queue_depth: hba request queue depth
714 * @sge_size: sg element size for either 32/64 bit
715 * @scsiio_depth: SCSI_IO queue depth
716 * @request_sz: per request frame size
717 * @request: pool of request frames
720 * @scsi_lookup: firmware request tracker list
722 * @free_list: free list of request
725 * @chain: pool of chains
727 * @max_sges_in_main_message: number sg elements in main message
728 * @max_sges_in_chain_message: number sg elements per chain
729 * @chains_needed_per_io: max chains per io
730 * @chain_depth: total chains allocated
734 * @hi_priority_depth:
742 * @internal_free_list:
743 * @sense: pool of sense
746 * @reply_depth: hba reply queue depth:
747 * @reply_sz: per reply frame size:
748 * @reply: pool of replys:
751 * @reply_free_queue_depth: reply free depth
752 * @reply_free: pool for reply free queue (32 bit addr)
754 * @reply_free_dma_pool:
755 * @reply_free_host_index: tail index in pool to insert free replys
756 * @reply_post_queue_depth: reply post queue depth
757 * @reply_post_struct: struct for reply_post_free physical & virt address
758 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
759 * @rdpq_array_enable: rdpq_array support is enabled in the driver
760 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
761 * is assigned only ones
762 * @reply_queue_count: number of reply queue's
763 * @reply_queue_list: link list contaning the reply queue info
764 * @msix96_vector: 96 MSI-X vector support
765 * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
766 * @delayed_tr_list: target reset link list
767 * @delayed_tr_volume_list: volume target reset link list
768 * @@temp_sensors_count: flag to carry the number of temperature sensors
770 struct MPT3SAS_ADAPTER {
771 struct list_head list;
772 struct Scsi_Host *shost;
775 char name[MPT_NAME_LENGTH];
776 char tmp_string[MPT_STRING_LENGTH];
777 struct pci_dev *pdev;
778 Mpi2SystemInterfaceRegs_t __iomem *chip;
779 resource_size_t chip_phys;
787 /* fw fault handler */
788 char fault_reset_work_q_name[20];
789 struct workqueue_struct *fault_reset_work_q;
790 struct delayed_work fault_reset_work;
792 /* fw event handler */
793 char firmware_event_name[20];
794 struct workqueue_struct *firmware_event_thread;
795 spinlock_t fw_event_lock;
796 struct list_head fw_event_list;
799 int aen_event_read_flag;
800 u8 broadcast_aen_busy;
801 u16 broadcast_aen_pending;
804 struct mutex reset_in_progress_mutex;
805 spinlock_t ioc_reset_in_progress_lock;
806 u8 ioc_link_reset_in_progress;
807 u8 ioc_reset_in_progress_status;
811 u8 pci_error_recovery;
812 u8 wait_for_discovery_to_complete;
813 u8 is_driver_loading;
814 u8 port_enable_failed;
816 u16 start_scan_failed;
819 u16 msix_vector_count;
821 u16 cpu_msix_table_sz;
823 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
825 /* internal commands, callback index */
832 u8 port_enable_cb_idx;
835 u8 tm_tr_volume_cb_idx;
836 u8 tm_sas_control_cb_idx;
837 struct _internal_cmd base_cmds;
838 struct _internal_cmd port_enable_cmds;
839 struct _internal_cmd transport_cmds;
840 struct _internal_cmd scsih_cmds;
841 struct _internal_cmd tm_cmds;
842 struct _internal_cmd ctl_cmds;
843 struct _internal_cmd config_cmds;
845 MPT_ADD_SGE base_add_sg_single;
847 /* function ptr for either IEEE or MPI sg elements */
848 MPT_BUILD_SG_SCMD build_sg_scmd;
849 MPT_BUILD_SG build_sg;
850 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
853 /* function ptr for MPI sg elements only */
854 MPT_BUILD_SG build_sg_mpi;
855 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
858 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
861 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
863 /* static config pages */
864 struct mpt3sas_facts facts;
865 struct mpt3sas_port_facts *pfacts;
866 Mpi2ManufacturingPage0_t manu_pg0;
867 struct Mpi2ManufacturingPage10_t manu_pg10;
868 struct Mpi2ManufacturingPage11_t manu_pg11;
869 Mpi2BiosPage2_t bios_pg2;
870 Mpi2BiosPage3_t bios_pg3;
871 Mpi2IOCPage8_t ioc_pg8;
872 Mpi2IOUnitPage0_t iounit_pg0;
873 Mpi2IOUnitPage1_t iounit_pg1;
874 Mpi2IOUnitPage8_t iounit_pg8;
876 struct _boot_device req_boot_device;
877 struct _boot_device req_alt_boot_device;
878 struct _boot_device current_boot_device;
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;
890 u16 device_missing_delay;
893 void *blocking_handles;
900 dma_addr_t config_page_dma;
908 dma_addr_t request_dma;
910 struct scsiio_tracker *scsi_lookup;
911 ulong scsi_lookup_pages;
912 spinlock_t scsi_lookup_lock;
913 struct list_head free_list;
914 int pending_io_count;
915 wait_queue_head_t reset_wq;
918 struct chain_tracker *chain_lookup;
919 struct list_head free_chain_list;
920 struct dma_pool *chain_dma_pool;
922 u16 max_sges_in_main_message;
923 u16 max_sges_in_chain_message;
924 u16 chains_needed_per_io;
927 /* hi-priority queue */
928 u16 hi_priority_smid;
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;
938 dma_addr_t internal_dma;
940 struct request_tracker *internal_lookup;
941 struct list_head internal_free_list;
945 dma_addr_t sense_dma;
946 struct dma_pool *sense_dma_pool;
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;
956 /* reply free queue */
957 u16 reply_free_queue_depth;
959 dma_addr_t reply_free_dma;
960 struct dma_pool *reply_free_dma_pool;
961 u32 reply_free_host_index;
963 /* reply post queue */
964 u16 reply_post_queue_depth;
965 struct reply_post_struct *reply_post;
966 u8 rdpq_array_capable;
967 u8 rdpq_array_enable;
968 u8 rdpq_array_enable_assigned;
969 struct dma_pool *reply_post_free_dma_pool;
970 u8 reply_queue_count;
971 struct list_head reply_queue_list;
974 /* reply post register index */
975 resource_size_t **replyPostRegisterIndex;
977 struct list_head delayed_tr_list;
978 struct list_head delayed_tr_volume_list;
979 u8 temp_sensors_count;
981 /* diag buffer support */
982 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
983 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
984 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
985 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
986 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
987 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
988 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
989 u32 ring_buffer_offset;
991 spinlock_t diag_trigger_lock;
992 u8 diag_trigger_active;
993 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
994 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
995 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
996 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
999 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1003 /* base shared API */
1004 extern struct list_head mpt3sas_ioc_list;
1005 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
1006 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
1008 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
1009 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
1010 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1011 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1012 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1013 enum reset_type type);
1015 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1016 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1017 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1019 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1021 /* hi-priority queue */
1022 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1023 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1024 struct scsi_cmnd *scmd);
1026 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1027 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1028 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1030 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1032 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1033 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1034 void mpt3sas_base_initialize_callback_handler(void);
1035 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1036 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1038 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1040 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1041 u8 msix_index, u32 reply);
1042 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1045 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1047 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1048 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1049 Mpi2SasIoUnitControlReply_t *mpi_reply,
1050 Mpi2SasIoUnitControlRequest_t *mpi_request);
1051 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1052 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1054 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1057 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1059 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1060 u16 device_missing_delay, u8 io_missing_delay);
1062 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1065 /* scsih shared API */
1066 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1068 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1070 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1071 uint channel, uint id, uint lun, u8 type, u16 smid_task,
1072 ulong timeout, enum mutex_type m_type);
1073 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1074 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1075 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1076 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1079 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1080 struct MPT3SAS_ADAPTER *ioc, u16 handle);
1081 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1082 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1083 struct _sas_device *mpt3sas_scsih_sas_device_find_by_sas_address(
1084 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1086 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1088 /* config shared API */
1089 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1091 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1093 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1094 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1095 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1096 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1098 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1099 Mpi2ConfigReply_t *mpi_reply,
1100 struct Mpi2ManufacturingPage10_t *config_page);
1102 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1103 Mpi2ConfigReply_t *mpi_reply,
1104 struct Mpi2ManufacturingPage11_t *config_page);
1105 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1106 Mpi2ConfigReply_t *mpi_reply,
1107 struct Mpi2ManufacturingPage11_t *config_page);
1109 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1110 *mpi_reply, Mpi2BiosPage2_t *config_page);
1111 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1112 *mpi_reply, Mpi2BiosPage3_t *config_page);
1113 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1114 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1115 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1116 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1117 u32 form, u32 handle);
1118 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1119 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1120 u32 form, u32 handle);
1121 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1122 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1124 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1125 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1126 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1127 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1128 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1129 *mpi_reply, Mpi2IOUnitPage8_t *config_page);
1130 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1131 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1133 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1134 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1136 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1137 *mpi_reply, Mpi2IOCPage8_t *config_page);
1138 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1139 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1140 u32 form, u32 handle);
1141 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1142 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1143 u32 phy_number, u16 handle);
1144 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1145 Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1146 u32 form, u32 handle);
1147 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1148 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1149 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1150 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1151 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1152 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1154 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1156 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1157 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1158 u32 handle, u16 sz);
1159 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1160 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1161 u32 form, u32 form_specific);
1162 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1163 u16 *volume_handle);
1164 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1165 u16 volume_handle, u64 *wwid);
1167 /* ctl shared API */
1168 extern struct device_attribute *mpt3sas_host_attrs[];
1169 extern struct device_attribute *mpt3sas_dev_attrs[];
1170 void mpt3sas_ctl_init(void);
1171 void mpt3sas_ctl_exit(void);
1172 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1174 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1175 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1176 u8 msix_index, u32 reply);
1177 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1178 Mpi2EventNotificationReply_t *mpi_reply);
1180 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1181 u8 bits_to_regsiter);
1182 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1185 /* transport shared API */
1186 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1188 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1189 u16 handle, u64 sas_address);
1190 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1191 u64 sas_address_parent);
1192 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1193 *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1194 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1195 struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1196 struct device *parent_dev);
1197 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1198 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1199 extern struct sas_function_template mpt3sas_transport_functions;
1200 extern struct scsi_transport_template *mpt3sas_transport_template;
1201 extern int scsi_internal_device_block(struct scsi_device *sdev);
1202 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1203 enum scsi_device_state new_state);
1204 /* trigger data externs */
1205 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1206 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1207 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1208 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1209 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1210 u32 tigger_bitmask);
1211 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1212 u16 log_entry_qualifier);
1213 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1215 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1217 #endif /* MPT3SAS_BASE_H_INCLUDED */