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 "05.100.00.00"
75 #define MPT3SAS_MAJOR_VERSION 5
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
166 * status bits for ioc->diag_buffer_status
168 #define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)
169 #define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)
170 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)
173 * Combined Reply Queue constants,
174 * There are twelve Supplemental Reply Post Host Index Registers
175 * and each register is at offset 0x10 bytes from the previous one.
177 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
178 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
180 /* OEM Identifiers */
181 #define MFG10_OEM_ID_INVALID (0x00000000)
182 #define MFG10_OEM_ID_DELL (0x00000001)
183 #define MFG10_OEM_ID_FSC (0x00000002)
184 #define MFG10_OEM_ID_SUN (0x00000003)
185 #define MFG10_OEM_ID_IBM (0x00000004)
188 #define MFG10_GF0_OCE_DISABLED (0x00000001)
189 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
190 #define MFG10_GF0_R10_DISPLAY (0x00000004)
191 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
192 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
194 /* OEM Specific Flags will come from OEM specific header files */
195 struct Mpi2ManufacturingPage10_t {
196 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
197 U8 OEMIdentifier; /* 04h */
198 U8 Reserved1; /* 05h */
199 U16 Reserved2; /* 08h */
200 U32 Reserved3; /* 0Ch */
201 U32 GenericFlags0; /* 10h */
202 U32 GenericFlags1; /* 14h */
203 U32 Reserved4; /* 18h */
204 U32 OEMSpecificFlags0; /* 1Ch */
205 U32 OEMSpecificFlags1; /* 20h */
206 U32 Reserved5[18]; /* 24h - 60h*/
210 /* Miscellaneous options */
211 struct Mpi2ManufacturingPage11_t {
212 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
213 __le32 Reserved1; /* 04h */
214 u8 Reserved2; /* 08h */
215 u8 EEDPTagMode; /* 09h */
216 u8 Reserved3; /* 0Ah */
217 u8 Reserved4; /* 0Bh */
218 __le32 Reserved5[23]; /* 0Ch-60h*/
222 * struct MPT3SAS_TARGET - starget private hostdata
223 * @starget: starget object
224 * @sas_address: target sas address
225 * @handle: device handle
226 * @num_luns: number luns
227 * @flags: MPT_TARGET_FLAGS_XXX flags
228 * @deleted: target flaged for deletion
229 * @tm_busy: target is busy with TM request.
231 struct MPT3SAS_TARGET {
232 struct scsi_target *starget;
243 * per device private data
245 #define MPT_DEVICE_FLAGS_INIT 0x01
246 #define MPT_DEVICE_TLR_ON 0x02
249 * struct MPT3SAS_DEVICE - sdev private hostdata
250 * @sas_target: starget private hostdata
252 * @flags: MPT_DEVICE_XXX flags
253 * @configured_lun: lun is configured
254 * @block: device is in SDEV_BLOCK state
255 * @tlr_snoop_check: flag used in determining whether to disable TLR
256 * @eedp_enable: eedp support enable bit
257 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
258 * @eedp_block_length: block size
260 struct MPT3SAS_DEVICE {
261 struct MPT3SAS_TARGET *sas_target;
269 #define MPT3_CMD_NOT_USED 0x8000 /* free */
270 #define MPT3_CMD_COMPLETE 0x0001 /* completed */
271 #define MPT3_CMD_PENDING 0x0002 /* pending */
272 #define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */
273 #define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */
276 * struct _internal_cmd - internal commands struct
279 * @reply: reply message pointer
281 * @status: MPT3_CMD_XXX status
282 * @smid: system message id
284 struct _internal_cmd {
286 struct completion done;
296 * struct _sas_device - attached device information
297 * @list: sas device list
298 * @starget: starget object
299 * @sas_address: device sas address
300 * @device_name: retrieved from the SAS IDENTIFY frame.
301 * @handle: device handle
302 * @sas_address_parent: sas address of parent expander or sas host
303 * @enclosure_handle: enclosure handle
304 * @enclosure_logical_id: enclosure logical identifier
305 * @volume_handle: volume handle (valid when hidden raid member)
306 * @volume_wwid: volume unique identifier
307 * @device_info: bitfield provides detailed info about the device
309 * @channel: target channel
310 * @slot: number number
311 * @phy: phy identifier provided in sas device page 0
312 * @responding: used in _scsih_sas_device_mark_responding
313 * @fast_path: fast path feature enable bit
314 * @pfa_led_on: flag for PFA LED status
315 * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
319 struct list_head list;
320 struct scsi_target *starget;
324 u64 sas_address_parent;
325 u16 enclosure_handle;
326 u64 enclosure_logical_id;
337 u8 pend_sas_rphy_add;
339 u8 connector_name[4];
343 * struct _raid_device - raid volume link list
344 * @list: sas device list
345 * @starget: starget object
346 * @sdev: scsi device struct (volumes are single lun)
347 * @wwid: unique identifier for the volume
348 * @handle: device handle
350 * @channel: target channel
351 * @volume_type: the raid level
352 * @device_info: bitfield provides detailed info about the hidden components
353 * @num_pds: number of hidden raid components
354 * @responding: used in _scsih_raid_device_mark_responding
355 * @percent_complete: resync percent complete
357 #define MPT_MAX_WARPDRIVE_PDS 8
358 struct _raid_device {
359 struct list_head list;
360 struct scsi_target *starget;
361 struct scsi_device *sdev;
374 * struct _boot_device - boot device info
375 * @is_raid: flag to indicate whether this is volume
376 * @device: holds pointer for either struct _sas_device or
377 * struct _raid_device
379 struct _boot_device {
385 * struct _sas_port - wide/narrow sas port information
386 * @port_list: list of ports belonging to expander
387 * @num_phys: number of phys belonging to this port
388 * @remote_identify: attached device identification
389 * @rphy: sas transport rphy object
390 * @port: sas transport wide/narrow port object
391 * @phy_list: _sas_phy list objects belonging to this port
394 struct list_head port_list;
396 struct sas_identify remote_identify;
397 struct sas_rphy *rphy;
398 struct sas_port *port;
399 struct list_head phy_list;
403 * struct _sas_phy - phy information
404 * @port_siblings: list of phys belonging to a port
405 * @identify: phy identification
406 * @remote_identify: attached device identification
407 * @phy: sas transport phy object
408 * @phy_id: unique phy id
409 * @handle: device handle for this phy
410 * @attached_handle: device handle for attached device
411 * @phy_belongs_to_port: port has been created for this phy
414 struct list_head port_siblings;
415 struct sas_identify identify;
416 struct sas_identify remote_identify;
421 u8 phy_belongs_to_port;
425 * struct _sas_node - sas_host/expander information
426 * @list: list of expanders
427 * @parent_dev: parent device class
428 * @num_phys: number phys belonging to this sas_host/expander
429 * @sas_address: sas address of this sas_host/expander
430 * @handle: handle for this sas_host/expander
431 * @sas_address_parent: sas address of parent expander or sas host
432 * @enclosure_handle: handle for this a member of an enclosure
433 * @device_info: bitwise defining capabilities of this sas_host/expander
434 * @responding: used in _scsih_expander_device_mark_responding
435 * @phy: a list of phys that make up this sas_host/expander
436 * @sas_port_list: list of ports attached to this sas_host/expander
439 struct list_head list;
440 struct device *parent_dev;
444 u64 sas_address_parent;
445 u16 enclosure_handle;
446 u64 enclosure_logical_id;
448 struct _sas_phy *phy;
449 struct list_head sas_port_list;
453 * enum reset_type - reset state
454 * @FORCE_BIG_HAMMER: issue diagnostic reset
455 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
463 * struct chain_tracker - firmware chain tracker
464 * @chain_buffer: chain buffer
465 * @chain_buffer_dma: physical address
466 * @tracker_list: list of free request (ioc->free_chain_list)
468 struct chain_tracker {
470 dma_addr_t chain_buffer_dma;
471 struct list_head tracker_list;
475 * struct scsiio_tracker - scsi mf request tracker
476 * @smid: system message id
477 * @scmd: scsi request pointer
478 * @cb_idx: callback index
479 * @tracker_list: list of free request (ioc->free_list)
481 struct scsiio_tracker {
483 struct scsi_cmnd *scmd;
485 struct list_head chain_list;
486 struct list_head tracker_list;
490 * struct request_tracker - firmware request tracker
491 * @smid: system message id
492 * @cb_idx: callback index
493 * @tracker_list: list of free request (ioc->free_list)
495 struct request_tracker {
498 struct list_head tracker_list;
502 * struct _tr_list - target reset list
503 * @handle: device handle
504 * @state: state machine
507 struct list_head list;
514 * struct adapter_reply_queue - the reply queue struct
515 * @ioc: per adapter object
516 * @msix_index: msix index into vector table
517 * @vector: irq vector
518 * @reply_post_host_index: head index in the pool where FW completes IO
519 * @reply_post_free: reply post base virt address
520 * @name: the name registered to request_irq()
521 * @busy: isr is actively processing replies on another cpu
524 struct adapter_reply_queue {
525 struct MPT3SAS_ADAPTER *ioc;
528 u32 reply_post_host_index;
529 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
530 char name[MPT_NAME_LENGTH];
532 cpumask_var_t affinity_hint;
533 struct list_head list;
536 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
539 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
540 struct scsi_cmnd *scmd, u16 smid);
541 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
542 dma_addr_t data_out_dma, size_t data_out_sz,
543 dma_addr_t data_in_dma, size_t data_in_sz);
544 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
549 /* IOC Facts and Port Facts converted from little endian to cpu */
550 union mpi3_version_union {
551 MPI2_VERSION_STRUCT Struct;
555 struct mpt3sas_facts {
571 union mpi3_version_union FWVersion;
572 u16 IOCRequestFrameSize;
579 u16 HighPriorityCredit;
580 u16 MaxReplyDescriptorPostQueueDepth;
584 u16 MaxPersistentEntries;
588 struct mpt3sas_port_facts {
593 u16 MaxPostedCmdBuffers;
596 struct reply_post_struct {
597 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
598 dma_addr_t reply_post_free_dma;
602 * enum mutex_type - task management mutex type
603 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
604 * @TM_MUTEX_ON: mutex is required
611 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
613 * struct MPT3SAS_ADAPTER - per adapter struct
615 * @shost: shost object
616 * @id: unique adapter id
617 * @cpu_count: number online cpus
618 * @name: generic ioc string
619 * @tmp_string: tmp string used for logging
620 * @pdev: pci pdev object
621 * @pio_chip: physical io register space
622 * @chip: memory mapped register space
623 * @chip_phys: physical addrss prior to mapping
624 * @logging_level: see mpt3sas_debug.h
625 * @fwfault_debug: debuging FW timeouts
626 * @ir_firmware: IR firmware present
627 * @bars: bitmask of BAR's that must be configured
628 * @mask_interrupts: ignore interrupt
629 * @dma_mask: used to set the consistent dma mask
630 * @fault_reset_work_q_name: fw fault work queue
631 * @fault_reset_work_q: ""
632 * @fault_reset_work: ""
633 * @firmware_event_name: fw event work queue
634 * @firmware_event_thread: ""
636 * @fw_event_list: list of fw events
637 * @aen_event_read_flag: event log was read
638 * @broadcast_aen_busy: broadcast aen waiting to be serviced
639 * @shost_recovery: host reset in progress
640 * @ioc_reset_in_progress_lock:
641 * @ioc_link_reset_in_progress: phy/hard reset in progress
642 * @ignore_loginfos: ignore loginfos during task management
643 * @remove_host: flag for when driver unloads, to avoid sending dev resets
644 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
645 * @wait_for_discovery_to_complete: flag set at driver load time when
646 * waiting on reporting devices
647 * @is_driver_loading: flag set at driver load time
648 * @port_enable_failed: flag set when port enable has failed
649 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
650 * @start_scan_failed: means port enable failed, return's the ioc_status
651 * @msix_enable: flag indicating msix is enabled
652 * @msix_vector_count: number msix vectors
653 * @cpu_msix_table: table for mapping cpus to msix index
654 * @cpu_msix_table_sz: table size
655 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
656 * @scsi_io_cb_idx: shost generated commands
657 * @tm_cb_idx: task management commands
658 * @scsih_cb_idx: scsih internal commands
659 * @transport_cb_idx: transport internal commands
660 * @ctl_cb_idx: clt internal commands
661 * @base_cb_idx: base internal commands
662 * @config_cb_idx: base internal commands
663 * @tm_tr_cb_idx : device removal target reset handshake
664 * @tm_tr_volume_cb_idx : volume removal target reset
671 * @base_add_sg_single: handler for either 32/64 bit sgl's
672 * @event_type: bits indicating which events to log
673 * @event_context: unique id for each logged event
674 * @event_log: event log pointer
675 * @event_masks: events that are masked
676 * @facts: static facts data
677 * @pfacts: static port facts data
678 * @manu_pg0: static manufacturing page 0
679 * @manu_pg10: static manufacturing page 10
680 * @manu_pg11: static manufacturing page 11
681 * @bios_pg2: static bios page 2
682 * @bios_pg3: static bios page 3
683 * @ioc_pg8: static ioc page 8
684 * @iounit_pg0: static iounit page 0
685 * @iounit_pg1: static iounit page 1
686 * @iounit_pg8: static iounit page 8
687 * @sas_hba: sas host object
688 * @sas_expander_list: expander object list
690 * @sas_device_list: sas device object list
691 * @sas_device_init_list: sas device object list (used only at init time)
693 * @io_missing_delay: time for IO completed by fw when PDR enabled
694 * @device_missing_delay: time for device missing by fw when PDR enabled
695 * @sas_id : used for setting volume target IDs
696 * @blocking_handles: bitmask used to identify which devices need blocking
697 * @pd_handles : bitmask for PD handles
698 * @pd_handles_sz : size of pd_handle bitmask
699 * @config_page_sz: config page size
700 * @config_page: reserve memory for config page payload
702 * @hba_queue_depth: hba request queue depth
703 * @sge_size: sg element size for either 32/64 bit
704 * @scsiio_depth: SCSI_IO queue depth
705 * @request_sz: per request frame size
706 * @request: pool of request frames
709 * @scsi_lookup: firmware request tracker list
711 * @free_list: free list of request
714 * @chain: pool of chains
716 * @max_sges_in_main_message: number sg elements in main message
717 * @max_sges_in_chain_message: number sg elements per chain
718 * @chains_needed_per_io: max chains per io
719 * @chain_depth: total chains allocated
723 * @hi_priority_depth:
731 * @internal_free_list:
732 * @sense: pool of sense
735 * @reply_depth: hba reply queue depth:
736 * @reply_sz: per reply frame size:
737 * @reply: pool of replys:
740 * @reply_free_queue_depth: reply free depth
741 * @reply_free: pool for reply free queue (32 bit addr)
743 * @reply_free_dma_pool:
744 * @reply_free_host_index: tail index in pool to insert free replys
745 * @reply_post_queue_depth: reply post queue depth
746 * @reply_post_struct: struct for reply_post_free physical & virt address
747 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
748 * @rdpq_array_enable: rdpq_array support is enabled in the driver
749 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
750 * is assigned only ones
751 * @reply_queue_count: number of reply queue's
752 * @reply_queue_list: link list contaning the reply queue info
753 * @msix96_vector: 96 MSI-X vector support
754 * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
755 * @delayed_tr_list: target reset link list
756 * @delayed_tr_volume_list: volume target reset link list
757 * @@temp_sensors_count: flag to carry the number of temperature sensors
759 struct MPT3SAS_ADAPTER {
760 struct list_head list;
761 struct Scsi_Host *shost;
764 char name[MPT_NAME_LENGTH];
765 char tmp_string[MPT_STRING_LENGTH];
766 struct pci_dev *pdev;
767 Mpi2SystemInterfaceRegs_t __iomem *chip;
768 resource_size_t chip_phys;
776 /* fw fault handler */
777 char fault_reset_work_q_name[20];
778 struct workqueue_struct *fault_reset_work_q;
779 struct delayed_work fault_reset_work;
781 /* fw event handler */
782 char firmware_event_name[20];
783 struct workqueue_struct *firmware_event_thread;
784 spinlock_t fw_event_lock;
785 struct list_head fw_event_list;
788 int aen_event_read_flag;
789 u8 broadcast_aen_busy;
790 u16 broadcast_aen_pending;
793 struct mutex reset_in_progress_mutex;
794 spinlock_t ioc_reset_in_progress_lock;
795 u8 ioc_link_reset_in_progress;
796 u8 ioc_reset_in_progress_status;
800 u8 pci_error_recovery;
801 u8 wait_for_discovery_to_complete;
802 u8 is_driver_loading;
803 u8 port_enable_failed;
805 u16 start_scan_failed;
808 u16 msix_vector_count;
810 u16 cpu_msix_table_sz;
812 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
814 /* internal commands, callback index */
821 u8 port_enable_cb_idx;
824 u8 tm_tr_volume_cb_idx;
825 u8 tm_sas_control_cb_idx;
826 struct _internal_cmd base_cmds;
827 struct _internal_cmd port_enable_cmds;
828 struct _internal_cmd transport_cmds;
829 struct _internal_cmd scsih_cmds;
830 struct _internal_cmd tm_cmds;
831 struct _internal_cmd ctl_cmds;
832 struct _internal_cmd config_cmds;
834 MPT_ADD_SGE base_add_sg_single;
836 /* function ptr for either IEEE or MPI sg elements */
837 MPT_BUILD_SG_SCMD build_sg_scmd;
838 MPT_BUILD_SG build_sg;
839 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
842 /* function ptr for MPI sg elements only */
843 MPT_BUILD_SG build_sg_mpi;
844 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
847 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
850 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
852 /* static config pages */
853 struct mpt3sas_facts facts;
854 struct mpt3sas_port_facts *pfacts;
855 Mpi2ManufacturingPage0_t manu_pg0;
856 struct Mpi2ManufacturingPage10_t manu_pg10;
857 struct Mpi2ManufacturingPage11_t manu_pg11;
858 Mpi2BiosPage2_t bios_pg2;
859 Mpi2BiosPage3_t bios_pg3;
860 Mpi2IOCPage8_t ioc_pg8;
861 Mpi2IOUnitPage0_t iounit_pg0;
862 Mpi2IOUnitPage1_t iounit_pg1;
863 Mpi2IOUnitPage8_t iounit_pg8;
865 struct _boot_device req_boot_device;
866 struct _boot_device req_alt_boot_device;
867 struct _boot_device current_boot_device;
869 /* sas hba, expander, and device list */
870 struct _sas_node sas_hba;
871 struct list_head sas_expander_list;
872 spinlock_t sas_node_lock;
873 struct list_head sas_device_list;
874 struct list_head sas_device_init_list;
875 spinlock_t sas_device_lock;
876 struct list_head raid_device_list;
877 spinlock_t raid_device_lock;
879 u16 device_missing_delay;
882 void *blocking_handles;
889 dma_addr_t config_page_dma;
897 dma_addr_t request_dma;
899 struct scsiio_tracker *scsi_lookup;
900 ulong scsi_lookup_pages;
901 spinlock_t scsi_lookup_lock;
902 struct list_head free_list;
903 int pending_io_count;
904 wait_queue_head_t reset_wq;
907 struct chain_tracker *chain_lookup;
908 struct list_head free_chain_list;
909 struct dma_pool *chain_dma_pool;
911 u16 max_sges_in_main_message;
912 u16 max_sges_in_chain_message;
913 u16 chains_needed_per_io;
916 /* hi-priority queue */
917 u16 hi_priority_smid;
919 dma_addr_t hi_priority_dma;
920 u16 hi_priority_depth;
921 struct request_tracker *hpr_lookup;
922 struct list_head hpr_free_list;
927 dma_addr_t internal_dma;
929 struct request_tracker *internal_lookup;
930 struct list_head internal_free_list;
934 dma_addr_t sense_dma;
935 struct dma_pool *sense_dma_pool;
940 dma_addr_t reply_dma;
941 u32 reply_dma_max_address;
942 u32 reply_dma_min_address;
943 struct dma_pool *reply_dma_pool;
945 /* reply free queue */
946 u16 reply_free_queue_depth;
948 dma_addr_t reply_free_dma;
949 struct dma_pool *reply_free_dma_pool;
950 u32 reply_free_host_index;
952 /* reply post queue */
953 u16 reply_post_queue_depth;
954 struct reply_post_struct *reply_post;
955 u8 rdpq_array_capable;
956 u8 rdpq_array_enable;
957 u8 rdpq_array_enable_assigned;
958 struct dma_pool *reply_post_free_dma_pool;
959 u8 reply_queue_count;
960 struct list_head reply_queue_list;
963 /* reply post register index */
964 resource_size_t **replyPostRegisterIndex;
966 struct list_head delayed_tr_list;
967 struct list_head delayed_tr_volume_list;
968 u8 temp_sensors_count;
970 /* diag buffer support */
971 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
972 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
973 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
974 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
975 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
976 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
977 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
978 u32 ring_buffer_offset;
980 spinlock_t diag_trigger_lock;
981 u8 diag_trigger_active;
982 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
983 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
984 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
985 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
988 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
992 /* base shared API */
993 extern struct list_head mpt3sas_ioc_list;
994 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
995 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
997 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
998 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
999 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1000 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1001 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1002 enum reset_type type);
1004 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1005 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1006 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1008 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1010 /* hi-priority queue */
1011 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1012 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1013 struct scsi_cmnd *scmd);
1015 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1016 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1017 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1019 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1021 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1022 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1023 void mpt3sas_base_initialize_callback_handler(void);
1024 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1025 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1027 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1029 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1030 u8 msix_index, u32 reply);
1031 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1034 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1036 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1037 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1038 Mpi2SasIoUnitControlReply_t *mpi_reply,
1039 Mpi2SasIoUnitControlRequest_t *mpi_request);
1040 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1041 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1043 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1046 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1048 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1049 u16 device_missing_delay, u8 io_missing_delay);
1051 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1054 /* scsih shared API */
1055 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1057 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1059 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1060 uint channel, uint id, uint lun, u8 type, u16 smid_task,
1061 ulong timeout, enum mutex_type m_type);
1062 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1063 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1064 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1065 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1068 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1069 struct MPT3SAS_ADAPTER *ioc, u16 handle);
1070 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1071 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1072 struct _sas_device *mpt3sas_scsih_sas_device_find_by_sas_address(
1073 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1075 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1077 /* config shared API */
1078 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1080 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1082 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1083 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1084 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1085 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1087 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1088 Mpi2ConfigReply_t *mpi_reply,
1089 struct Mpi2ManufacturingPage10_t *config_page);
1091 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1092 Mpi2ConfigReply_t *mpi_reply,
1093 struct Mpi2ManufacturingPage11_t *config_page);
1094 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1095 Mpi2ConfigReply_t *mpi_reply,
1096 struct Mpi2ManufacturingPage11_t *config_page);
1098 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1099 *mpi_reply, Mpi2BiosPage2_t *config_page);
1100 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1101 *mpi_reply, Mpi2BiosPage3_t *config_page);
1102 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1103 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1104 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1105 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1106 u32 form, u32 handle);
1107 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1108 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1109 u32 form, u32 handle);
1110 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1111 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1113 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1114 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1115 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1116 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1117 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1118 *mpi_reply, Mpi2IOUnitPage8_t *config_page);
1119 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1120 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1122 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1123 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1125 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1126 *mpi_reply, Mpi2IOCPage8_t *config_page);
1127 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1128 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1129 u32 form, u32 handle);
1130 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1131 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1132 u32 phy_number, u16 handle);
1133 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1134 Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1135 u32 form, u32 handle);
1136 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1137 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1138 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1139 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1140 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1141 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1143 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1145 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1146 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1147 u32 handle, u16 sz);
1148 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1149 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1150 u32 form, u32 form_specific);
1151 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1152 u16 *volume_handle);
1153 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1154 u16 volume_handle, u64 *wwid);
1156 /* ctl shared API */
1157 extern struct device_attribute *mpt3sas_host_attrs[];
1158 extern struct device_attribute *mpt3sas_dev_attrs[];
1159 void mpt3sas_ctl_init(void);
1160 void mpt3sas_ctl_exit(void);
1161 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1163 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1164 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1165 u8 msix_index, u32 reply);
1166 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1167 Mpi2EventNotificationReply_t *mpi_reply);
1169 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1170 u8 bits_to_regsiter);
1171 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1174 /* transport shared API */
1175 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1177 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1178 u16 handle, u64 sas_address);
1179 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1180 u64 sas_address_parent);
1181 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1182 *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1183 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1184 struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1185 struct device *parent_dev);
1186 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1187 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1188 extern struct sas_function_template mpt3sas_transport_functions;
1189 extern struct scsi_transport_template *mpt3sas_transport_template;
1190 extern int scsi_internal_device_block(struct scsi_device *sdev);
1191 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1192 enum scsi_device_state new_state);
1193 /* trigger data externs */
1194 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1195 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1196 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1197 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1198 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1199 u32 tigger_bitmask);
1200 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1201 u16 log_entry_qualifier);
1202 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1204 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1206 #endif /* MPT3SAS_BASE_H_INCLUDED */