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 "09.100.00.00"
75 #define MPT3SAS_MAJOR_VERSION 9
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_8E_HBA_BRANDING \
169 "Cisco 9300-8E 12G SAS HBA"
170 #define MPT3SAS_CISCO_12G_8I_HBA_BRANDING \
171 "Cisco 9300-8i 12G SAS HBA"
172 #define MPT3SAS_CISCO_12G_AVILA_HBA_BRANDING \
173 "Cisco 12G Modular SAS Pass through Controller"
174 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_BRANDING \
175 "UCS C3X60 12G SAS Pass through Controller"
179 #define MPT3SAS_CISCO_12G_8E_HBA_SSDID 0x14C
180 #define MPT3SAS_CISCO_12G_8I_HBA_SSDID 0x154
181 #define MPT3SAS_CISCO_12G_AVILA_HBA_SSDID 0x155
182 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_SSDID 0x156
185 * status bits for ioc->diag_buffer_status
187 #define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)
188 #define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)
189 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)
192 * Combined Reply Queue constants,
193 * There are twelve Supplemental Reply Post Host Index Registers
194 * and each register is at offset 0x10 bytes from the previous one.
196 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
197 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
199 /* OEM Identifiers */
200 #define MFG10_OEM_ID_INVALID (0x00000000)
201 #define MFG10_OEM_ID_DELL (0x00000001)
202 #define MFG10_OEM_ID_FSC (0x00000002)
203 #define MFG10_OEM_ID_SUN (0x00000003)
204 #define MFG10_OEM_ID_IBM (0x00000004)
207 #define MFG10_GF0_OCE_DISABLED (0x00000001)
208 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
209 #define MFG10_GF0_R10_DISPLAY (0x00000004)
210 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
211 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
213 #define VIRTUAL_IO_FAILED_RETRY (0x32010081)
215 /* OEM Specific Flags will come from OEM specific header files */
216 struct Mpi2ManufacturingPage10_t {
217 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
218 U8 OEMIdentifier; /* 04h */
219 U8 Reserved1; /* 05h */
220 U16 Reserved2; /* 08h */
221 U32 Reserved3; /* 0Ch */
222 U32 GenericFlags0; /* 10h */
223 U32 GenericFlags1; /* 14h */
224 U32 Reserved4; /* 18h */
225 U32 OEMSpecificFlags0; /* 1Ch */
226 U32 OEMSpecificFlags1; /* 20h */
227 U32 Reserved5[18]; /* 24h - 60h*/
231 /* Miscellaneous options */
232 struct Mpi2ManufacturingPage11_t {
233 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
234 __le32 Reserved1; /* 04h */
235 u8 Reserved2; /* 08h */
236 u8 EEDPTagMode; /* 09h */
237 u8 Reserved3; /* 0Ah */
238 u8 Reserved4; /* 0Bh */
239 __le32 Reserved5[23]; /* 0Ch-60h*/
243 * struct MPT3SAS_TARGET - starget private hostdata
244 * @starget: starget object
245 * @sas_address: target sas address
246 * @handle: device handle
247 * @num_luns: number luns
248 * @flags: MPT_TARGET_FLAGS_XXX flags
249 * @deleted: target flaged for deletion
250 * @tm_busy: target is busy with TM request.
252 struct MPT3SAS_TARGET {
253 struct scsi_target *starget;
264 * per device private data
266 #define MPT_DEVICE_FLAGS_INIT 0x01
267 #define MPT_DEVICE_TLR_ON 0x02
270 * struct MPT3SAS_DEVICE - sdev private hostdata
271 * @sas_target: starget private hostdata
273 * @flags: MPT_DEVICE_XXX flags
274 * @configured_lun: lun is configured
275 * @block: device is in SDEV_BLOCK state
276 * @tlr_snoop_check: flag used in determining whether to disable TLR
277 * @eedp_enable: eedp support enable bit
278 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
279 * @eedp_block_length: block size
281 struct MPT3SAS_DEVICE {
282 struct MPT3SAS_TARGET *sas_target;
290 #define MPT3_CMD_NOT_USED 0x8000 /* free */
291 #define MPT3_CMD_COMPLETE 0x0001 /* completed */
292 #define MPT3_CMD_PENDING 0x0002 /* pending */
293 #define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */
294 #define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */
297 * struct _internal_cmd - internal commands struct
300 * @reply: reply message pointer
302 * @status: MPT3_CMD_XXX status
303 * @smid: system message id
305 struct _internal_cmd {
307 struct completion done;
317 * struct _sas_device - attached device information
318 * @list: sas device list
319 * @starget: starget object
320 * @sas_address: device sas address
321 * @device_name: retrieved from the SAS IDENTIFY frame.
322 * @handle: device handle
323 * @sas_address_parent: sas address of parent expander or sas host
324 * @enclosure_handle: enclosure handle
325 * @enclosure_logical_id: enclosure logical identifier
326 * @volume_handle: volume handle (valid when hidden raid member)
327 * @volume_wwid: volume unique identifier
328 * @device_info: bitfield provides detailed info about the device
330 * @channel: target channel
331 * @slot: number number
332 * @phy: phy identifier provided in sas device page 0
333 * @responding: used in _scsih_sas_device_mark_responding
334 * @fast_path: fast path feature enable bit
335 * @pfa_led_on: flag for PFA LED status
336 * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
340 struct list_head list;
341 struct scsi_target *starget;
345 u64 sas_address_parent;
346 u16 enclosure_handle;
347 u64 enclosure_logical_id;
358 u8 pend_sas_rphy_add;
360 u8 connector_name[4];
364 * struct _raid_device - raid volume link list
365 * @list: sas device list
366 * @starget: starget object
367 * @sdev: scsi device struct (volumes are single lun)
368 * @wwid: unique identifier for the volume
369 * @handle: device handle
371 * @channel: target channel
372 * @volume_type: the raid level
373 * @device_info: bitfield provides detailed info about the hidden components
374 * @num_pds: number of hidden raid components
375 * @responding: used in _scsih_raid_device_mark_responding
376 * @percent_complete: resync percent complete
378 #define MPT_MAX_WARPDRIVE_PDS 8
379 struct _raid_device {
380 struct list_head list;
381 struct scsi_target *starget;
382 struct scsi_device *sdev;
395 * struct _boot_device - boot device info
396 * @is_raid: flag to indicate whether this is volume
397 * @device: holds pointer for either struct _sas_device or
398 * struct _raid_device
400 struct _boot_device {
406 * struct _sas_port - wide/narrow sas port information
407 * @port_list: list of ports belonging to expander
408 * @num_phys: number of phys belonging to this port
409 * @remote_identify: attached device identification
410 * @rphy: sas transport rphy object
411 * @port: sas transport wide/narrow port object
412 * @phy_list: _sas_phy list objects belonging to this port
415 struct list_head port_list;
417 struct sas_identify remote_identify;
418 struct sas_rphy *rphy;
419 struct sas_port *port;
420 struct list_head phy_list;
424 * struct _sas_phy - phy information
425 * @port_siblings: list of phys belonging to a port
426 * @identify: phy identification
427 * @remote_identify: attached device identification
428 * @phy: sas transport phy object
429 * @phy_id: unique phy id
430 * @handle: device handle for this phy
431 * @attached_handle: device handle for attached device
432 * @phy_belongs_to_port: port has been created for this phy
435 struct list_head port_siblings;
436 struct sas_identify identify;
437 struct sas_identify remote_identify;
442 u8 phy_belongs_to_port;
446 * struct _sas_node - sas_host/expander information
447 * @list: list of expanders
448 * @parent_dev: parent device class
449 * @num_phys: number phys belonging to this sas_host/expander
450 * @sas_address: sas address of this sas_host/expander
451 * @handle: handle for this sas_host/expander
452 * @sas_address_parent: sas address of parent expander or sas host
453 * @enclosure_handle: handle for this a member of an enclosure
454 * @device_info: bitwise defining capabilities of this sas_host/expander
455 * @responding: used in _scsih_expander_device_mark_responding
456 * @phy: a list of phys that make up this sas_host/expander
457 * @sas_port_list: list of ports attached to this sas_host/expander
460 struct list_head list;
461 struct device *parent_dev;
465 u64 sas_address_parent;
466 u16 enclosure_handle;
467 u64 enclosure_logical_id;
469 struct _sas_phy *phy;
470 struct list_head sas_port_list;
474 * enum reset_type - reset state
475 * @FORCE_BIG_HAMMER: issue diagnostic reset
476 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
484 * struct chain_tracker - firmware chain tracker
485 * @chain_buffer: chain buffer
486 * @chain_buffer_dma: physical address
487 * @tracker_list: list of free request (ioc->free_chain_list)
489 struct chain_tracker {
491 dma_addr_t chain_buffer_dma;
492 struct list_head tracker_list;
496 * struct scsiio_tracker - scsi mf request tracker
497 * @smid: system message id
498 * @scmd: scsi request pointer
499 * @cb_idx: callback index
500 * @tracker_list: list of free request (ioc->free_list)
502 struct scsiio_tracker {
504 struct scsi_cmnd *scmd;
506 struct list_head chain_list;
507 struct list_head tracker_list;
511 * struct request_tracker - firmware request tracker
512 * @smid: system message id
513 * @cb_idx: callback index
514 * @tracker_list: list of free request (ioc->free_list)
516 struct request_tracker {
519 struct list_head tracker_list;
523 * struct _tr_list - target reset list
524 * @handle: device handle
525 * @state: state machine
528 struct list_head list;
535 * struct adapter_reply_queue - the reply queue struct
536 * @ioc: per adapter object
537 * @msix_index: msix index into vector table
538 * @vector: irq vector
539 * @reply_post_host_index: head index in the pool where FW completes IO
540 * @reply_post_free: reply post base virt address
541 * @name: the name registered to request_irq()
542 * @busy: isr is actively processing replies on another cpu
545 struct adapter_reply_queue {
546 struct MPT3SAS_ADAPTER *ioc;
549 u32 reply_post_host_index;
550 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
551 char name[MPT_NAME_LENGTH];
553 cpumask_var_t affinity_hint;
554 struct list_head list;
557 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
560 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
561 struct scsi_cmnd *scmd, u16 smid);
562 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
563 dma_addr_t data_out_dma, size_t data_out_sz,
564 dma_addr_t data_in_dma, size_t data_in_sz);
565 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
570 /* IOC Facts and Port Facts converted from little endian to cpu */
571 union mpi3_version_union {
572 MPI2_VERSION_STRUCT Struct;
576 struct mpt3sas_facts {
592 union mpi3_version_union FWVersion;
593 u16 IOCRequestFrameSize;
600 u16 HighPriorityCredit;
601 u16 MaxReplyDescriptorPostQueueDepth;
605 u16 MaxPersistentEntries;
609 struct mpt3sas_port_facts {
614 u16 MaxPostedCmdBuffers;
617 struct reply_post_struct {
618 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
619 dma_addr_t reply_post_free_dma;
623 * enum mutex_type - task management mutex type
624 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
625 * @TM_MUTEX_ON: mutex is required
632 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
634 * struct MPT3SAS_ADAPTER - per adapter struct
636 * @shost: shost object
637 * @id: unique adapter id
638 * @cpu_count: number online cpus
639 * @name: generic ioc string
640 * @tmp_string: tmp string used for logging
641 * @pdev: pci pdev object
642 * @pio_chip: physical io register space
643 * @chip: memory mapped register space
644 * @chip_phys: physical addrss prior to mapping
645 * @logging_level: see mpt3sas_debug.h
646 * @fwfault_debug: debuging FW timeouts
647 * @ir_firmware: IR firmware present
648 * @bars: bitmask of BAR's that must be configured
649 * @mask_interrupts: ignore interrupt
650 * @dma_mask: used to set the consistent dma mask
651 * @fault_reset_work_q_name: fw fault work queue
652 * @fault_reset_work_q: ""
653 * @fault_reset_work: ""
654 * @firmware_event_name: fw event work queue
655 * @firmware_event_thread: ""
657 * @fw_event_list: list of fw events
658 * @aen_event_read_flag: event log was read
659 * @broadcast_aen_busy: broadcast aen waiting to be serviced
660 * @shost_recovery: host reset in progress
661 * @ioc_reset_in_progress_lock:
662 * @ioc_link_reset_in_progress: phy/hard reset in progress
663 * @ignore_loginfos: ignore loginfos during task management
664 * @remove_host: flag for when driver unloads, to avoid sending dev resets
665 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
666 * @wait_for_discovery_to_complete: flag set at driver load time when
667 * waiting on reporting devices
668 * @is_driver_loading: flag set at driver load time
669 * @port_enable_failed: flag set when port enable has failed
670 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
671 * @start_scan_failed: means port enable failed, return's the ioc_status
672 * @msix_enable: flag indicating msix is enabled
673 * @msix_vector_count: number msix vectors
674 * @cpu_msix_table: table for mapping cpus to msix index
675 * @cpu_msix_table_sz: table size
676 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
677 * @scsi_io_cb_idx: shost generated commands
678 * @tm_cb_idx: task management commands
679 * @scsih_cb_idx: scsih internal commands
680 * @transport_cb_idx: transport internal commands
681 * @ctl_cb_idx: clt internal commands
682 * @base_cb_idx: base internal commands
683 * @config_cb_idx: base internal commands
684 * @tm_tr_cb_idx : device removal target reset handshake
685 * @tm_tr_volume_cb_idx : volume removal target reset
692 * @base_add_sg_single: handler for either 32/64 bit sgl's
693 * @event_type: bits indicating which events to log
694 * @event_context: unique id for each logged event
695 * @event_log: event log pointer
696 * @event_masks: events that are masked
697 * @facts: static facts data
698 * @pfacts: static port facts data
699 * @manu_pg0: static manufacturing page 0
700 * @manu_pg10: static manufacturing page 10
701 * @manu_pg11: static manufacturing page 11
702 * @bios_pg2: static bios page 2
703 * @bios_pg3: static bios page 3
704 * @ioc_pg8: static ioc page 8
705 * @iounit_pg0: static iounit page 0
706 * @iounit_pg1: static iounit page 1
707 * @iounit_pg8: static iounit page 8
708 * @sas_hba: sas host object
709 * @sas_expander_list: expander object list
711 * @sas_device_list: sas device object list
712 * @sas_device_init_list: sas device object list (used only at init time)
714 * @io_missing_delay: time for IO completed by fw when PDR enabled
715 * @device_missing_delay: time for device missing by fw when PDR enabled
716 * @sas_id : used for setting volume target IDs
717 * @blocking_handles: bitmask used to identify which devices need blocking
718 * @pd_handles : bitmask for PD handles
719 * @pd_handles_sz : size of pd_handle bitmask
720 * @config_page_sz: config page size
721 * @config_page: reserve memory for config page payload
723 * @hba_queue_depth: hba request queue depth
724 * @sge_size: sg element size for either 32/64 bit
725 * @scsiio_depth: SCSI_IO queue depth
726 * @request_sz: per request frame size
727 * @request: pool of request frames
730 * @scsi_lookup: firmware request tracker list
732 * @free_list: free list of request
735 * @chain: pool of chains
737 * @max_sges_in_main_message: number sg elements in main message
738 * @max_sges_in_chain_message: number sg elements per chain
739 * @chains_needed_per_io: max chains per io
740 * @chain_depth: total chains allocated
744 * @hi_priority_depth:
752 * @internal_free_list:
753 * @sense: pool of sense
756 * @reply_depth: hba reply queue depth:
757 * @reply_sz: per reply frame size:
758 * @reply: pool of replys:
761 * @reply_free_queue_depth: reply free depth
762 * @reply_free: pool for reply free queue (32 bit addr)
764 * @reply_free_dma_pool:
765 * @reply_free_host_index: tail index in pool to insert free replys
766 * @reply_post_queue_depth: reply post queue depth
767 * @reply_post_struct: struct for reply_post_free physical & virt address
768 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
769 * @rdpq_array_enable: rdpq_array support is enabled in the driver
770 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
771 * is assigned only ones
772 * @reply_queue_count: number of reply queue's
773 * @reply_queue_list: link list contaning the reply queue info
774 * @msix96_vector: 96 MSI-X vector support
775 * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
776 * @delayed_tr_list: target reset link list
777 * @delayed_tr_volume_list: volume target reset link list
778 * @@temp_sensors_count: flag to carry the number of temperature sensors
780 struct MPT3SAS_ADAPTER {
781 struct list_head list;
782 struct Scsi_Host *shost;
785 char name[MPT_NAME_LENGTH];
786 char tmp_string[MPT_STRING_LENGTH];
787 struct pci_dev *pdev;
788 Mpi2SystemInterfaceRegs_t __iomem *chip;
789 resource_size_t chip_phys;
797 /* fw fault handler */
798 char fault_reset_work_q_name[20];
799 struct workqueue_struct *fault_reset_work_q;
800 struct delayed_work fault_reset_work;
802 /* fw event handler */
803 char firmware_event_name[20];
804 struct workqueue_struct *firmware_event_thread;
805 spinlock_t fw_event_lock;
806 struct list_head fw_event_list;
809 int aen_event_read_flag;
810 u8 broadcast_aen_busy;
811 u16 broadcast_aen_pending;
814 struct mutex reset_in_progress_mutex;
815 spinlock_t ioc_reset_in_progress_lock;
816 u8 ioc_link_reset_in_progress;
817 u8 ioc_reset_in_progress_status;
821 u8 pci_error_recovery;
822 u8 wait_for_discovery_to_complete;
823 u8 is_driver_loading;
824 u8 port_enable_failed;
826 u16 start_scan_failed;
829 u16 msix_vector_count;
831 u16 cpu_msix_table_sz;
833 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
835 /* internal commands, callback index */
842 u8 port_enable_cb_idx;
845 u8 tm_tr_volume_cb_idx;
846 u8 tm_sas_control_cb_idx;
847 struct _internal_cmd base_cmds;
848 struct _internal_cmd port_enable_cmds;
849 struct _internal_cmd transport_cmds;
850 struct _internal_cmd scsih_cmds;
851 struct _internal_cmd tm_cmds;
852 struct _internal_cmd ctl_cmds;
853 struct _internal_cmd config_cmds;
855 MPT_ADD_SGE base_add_sg_single;
857 /* function ptr for either IEEE or MPI sg elements */
858 MPT_BUILD_SG_SCMD build_sg_scmd;
859 MPT_BUILD_SG build_sg;
860 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
863 /* function ptr for MPI sg elements only */
864 MPT_BUILD_SG build_sg_mpi;
865 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
868 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
871 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
873 /* static config pages */
874 struct mpt3sas_facts facts;
875 struct mpt3sas_port_facts *pfacts;
876 Mpi2ManufacturingPage0_t manu_pg0;
877 struct Mpi2ManufacturingPage10_t manu_pg10;
878 struct Mpi2ManufacturingPage11_t manu_pg11;
879 Mpi2BiosPage2_t bios_pg2;
880 Mpi2BiosPage3_t bios_pg3;
881 Mpi2IOCPage8_t ioc_pg8;
882 Mpi2IOUnitPage0_t iounit_pg0;
883 Mpi2IOUnitPage1_t iounit_pg1;
884 Mpi2IOUnitPage8_t iounit_pg8;
886 struct _boot_device req_boot_device;
887 struct _boot_device req_alt_boot_device;
888 struct _boot_device current_boot_device;
890 /* sas hba, expander, and device list */
891 struct _sas_node sas_hba;
892 struct list_head sas_expander_list;
893 spinlock_t sas_node_lock;
894 struct list_head sas_device_list;
895 struct list_head sas_device_init_list;
896 spinlock_t sas_device_lock;
897 struct list_head raid_device_list;
898 spinlock_t raid_device_lock;
900 u16 device_missing_delay;
903 void *blocking_handles;
910 dma_addr_t config_page_dma;
918 dma_addr_t request_dma;
920 struct scsiio_tracker *scsi_lookup;
921 ulong scsi_lookup_pages;
922 spinlock_t scsi_lookup_lock;
923 struct list_head free_list;
924 int pending_io_count;
925 wait_queue_head_t reset_wq;
928 struct chain_tracker *chain_lookup;
929 struct list_head free_chain_list;
930 struct dma_pool *chain_dma_pool;
932 u16 max_sges_in_main_message;
933 u16 max_sges_in_chain_message;
934 u16 chains_needed_per_io;
937 /* hi-priority queue */
938 u16 hi_priority_smid;
940 dma_addr_t hi_priority_dma;
941 u16 hi_priority_depth;
942 struct request_tracker *hpr_lookup;
943 struct list_head hpr_free_list;
948 dma_addr_t internal_dma;
950 struct request_tracker *internal_lookup;
951 struct list_head internal_free_list;
955 dma_addr_t sense_dma;
956 struct dma_pool *sense_dma_pool;
961 dma_addr_t reply_dma;
962 u32 reply_dma_max_address;
963 u32 reply_dma_min_address;
964 struct dma_pool *reply_dma_pool;
966 /* reply free queue */
967 u16 reply_free_queue_depth;
969 dma_addr_t reply_free_dma;
970 struct dma_pool *reply_free_dma_pool;
971 u32 reply_free_host_index;
973 /* reply post queue */
974 u16 reply_post_queue_depth;
975 struct reply_post_struct *reply_post;
976 u8 rdpq_array_capable;
977 u8 rdpq_array_enable;
978 u8 rdpq_array_enable_assigned;
979 struct dma_pool *reply_post_free_dma_pool;
980 u8 reply_queue_count;
981 struct list_head reply_queue_list;
984 /* reply post register index */
985 resource_size_t **replyPostRegisterIndex;
987 struct list_head delayed_tr_list;
988 struct list_head delayed_tr_volume_list;
989 u8 temp_sensors_count;
991 /* diag buffer support */
992 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
993 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
994 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
995 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
996 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
997 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
998 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
999 u32 ring_buffer_offset;
1001 spinlock_t diag_trigger_lock;
1002 u8 diag_trigger_active;
1003 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
1004 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
1005 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
1006 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
1009 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1013 /* base shared API */
1014 extern struct list_head mpt3sas_ioc_list;
1015 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
1016 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
1018 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
1019 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
1020 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1021 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1022 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1023 enum reset_type type);
1025 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1026 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1027 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1029 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1031 /* hi-priority queue */
1032 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1033 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1034 struct scsi_cmnd *scmd);
1036 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1037 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1038 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1040 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1042 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1043 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1044 void mpt3sas_base_initialize_callback_handler(void);
1045 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1046 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1048 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1050 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1051 u8 msix_index, u32 reply);
1052 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1055 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1057 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1058 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1059 Mpi2SasIoUnitControlReply_t *mpi_reply,
1060 Mpi2SasIoUnitControlRequest_t *mpi_request);
1061 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1062 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1064 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1067 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1069 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1070 u16 device_missing_delay, u8 io_missing_delay);
1072 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1075 /* scsih shared API */
1076 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1078 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1080 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1081 uint channel, uint id, uint lun, u8 type, u16 smid_task,
1082 ulong timeout, enum mutex_type m_type);
1083 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1084 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1085 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1086 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1089 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1090 struct MPT3SAS_ADAPTER *ioc, u16 handle);
1091 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1092 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1093 struct _sas_device *mpt3sas_scsih_sas_device_find_by_sas_address(
1094 struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1096 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1098 /* config shared API */
1099 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1101 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1103 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1104 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1105 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1106 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1108 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1109 Mpi2ConfigReply_t *mpi_reply,
1110 struct Mpi2ManufacturingPage10_t *config_page);
1112 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1113 Mpi2ConfigReply_t *mpi_reply,
1114 struct Mpi2ManufacturingPage11_t *config_page);
1115 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1116 Mpi2ConfigReply_t *mpi_reply,
1117 struct Mpi2ManufacturingPage11_t *config_page);
1119 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1120 *mpi_reply, Mpi2BiosPage2_t *config_page);
1121 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1122 *mpi_reply, Mpi2BiosPage3_t *config_page);
1123 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1124 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1125 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1126 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1127 u32 form, u32 handle);
1128 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1129 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1130 u32 form, u32 handle);
1131 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1132 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1134 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1135 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1136 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1137 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1138 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1139 *mpi_reply, Mpi2IOUnitPage8_t *config_page);
1140 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1141 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1143 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1144 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1146 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1147 *mpi_reply, Mpi2IOCPage8_t *config_page);
1148 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1149 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1150 u32 form, u32 handle);
1151 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1152 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1153 u32 phy_number, u16 handle);
1154 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1155 Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1156 u32 form, u32 handle);
1157 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1158 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1159 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1160 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1161 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1162 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1164 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1166 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1167 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1168 u32 handle, u16 sz);
1169 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1170 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1171 u32 form, u32 form_specific);
1172 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1173 u16 *volume_handle);
1174 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1175 u16 volume_handle, u64 *wwid);
1177 /* ctl shared API */
1178 extern struct device_attribute *mpt3sas_host_attrs[];
1179 extern struct device_attribute *mpt3sas_dev_attrs[];
1180 void mpt3sas_ctl_init(void);
1181 void mpt3sas_ctl_exit(void);
1182 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1184 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1185 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1186 u8 msix_index, u32 reply);
1187 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1188 Mpi2EventNotificationReply_t *mpi_reply);
1190 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1191 u8 bits_to_regsiter);
1192 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1195 /* transport shared API */
1196 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1198 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1199 u16 handle, u64 sas_address);
1200 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1201 u64 sas_address_parent);
1202 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1203 *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1204 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1205 struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1206 struct device *parent_dev);
1207 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1208 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1209 extern struct sas_function_template mpt3sas_transport_functions;
1210 extern struct scsi_transport_template *mpt3sas_transport_template;
1211 extern int scsi_internal_device_block(struct scsi_device *sdev);
1212 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1213 enum scsi_device_state new_state);
1214 /* trigger data externs */
1215 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1216 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1217 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1218 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1219 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1220 u32 tigger_bitmask);
1221 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1222 u16 log_entry_qualifier);
1223 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1225 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1227 #endif /* MPT3SAS_BASE_H_INCLUDED */