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/mpt2sas/mpt2_base.h
6 * Copyright (C) 2007-2014 LSI Corporation
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
21 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
22 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
23 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
24 * solely responsible for determining the appropriateness of using and
25 * distributing the Program and assumes all risks associated with its
26 * exercise of rights under this Agreement, including but not limited to
27 * the risks and costs of program errors, damage to or loss of data,
28 * programs or equipment, and unavailability or interruption of operations.
30 * DISCLAIMER OF LIABILITY
31 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
32 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
34 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
35 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
36 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
37 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
45 #ifndef MPT2SAS_BASE_H_INCLUDED
46 #define MPT2SAS_BASE_H_INCLUDED
48 #include "mpi/mpi2_type.h"
50 #include "mpi/mpi2_ioc.h"
51 #include "mpi/mpi2_cnfg.h"
52 #include "mpi/mpi2_init.h"
53 #include "mpi/mpi2_raid.h"
54 #include "mpi/mpi2_tool.h"
55 #include "mpi/mpi2_sas.h"
57 #include <scsi/scsi.h>
58 #include <scsi/scsi_cmnd.h>
59 #include <scsi/scsi_device.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_tcq.h>
62 #include <scsi/scsi_transport_sas.h>
63 #include <scsi/scsi_dbg.h>
64 #include <scsi/scsi_eh.h>
66 #include "mpt2sas_debug.h"
68 /* driver versioning info */
69 #define MPT2SAS_DRIVER_NAME "mpt2sas"
71 #define MPT2SAS_DESCRIPTION "LSI MPT Fusion SAS 2.0 Device Driver"
72 #define MPT2SAS_DRIVER_VERSION "18.100.00.00"
73 #define MPT2SAS_MAJOR_VERSION 18
74 #define MPT2SAS_MINOR_VERSION 100
75 #define MPT2SAS_BUILD_VERSION 00
76 #define MPT2SAS_RELEASE_VERSION 00
79 * Set MPT2SAS_SG_DEPTH value based on user input.
81 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
82 #if CONFIG_SCSI_MPT2SAS_MAX_SGE < 16
83 #define MPT2SAS_SG_DEPTH 16
84 #elif CONFIG_SCSI_MPT2SAS_MAX_SGE > 128
85 #define MPT2SAS_SG_DEPTH 128
87 #define MPT2SAS_SG_DEPTH CONFIG_SCSI_MPT2SAS_MAX_SGE
90 #define MPT2SAS_SG_DEPTH 128 /* MAX_HW_SEGMENTS */
97 #define MPT2SAS_SATA_QUEUE_DEPTH 32
98 #define MPT2SAS_SAS_QUEUE_DEPTH 254
99 #define MPT2SAS_RAID_QUEUE_DEPTH 128
101 #define MPT_NAME_LENGTH 32 /* generic length of strings */
102 #define MPT_STRING_LENGTH 64
104 #define MPT_MAX_CALLBACKS 16
110 #define INTERNAL_CMDS_COUNT 10 /* reserved cmds */
112 #define MPI2_HIM_MASK 0xFFFFFFFF /* mask every bit*/
114 #define MPT2SAS_INVALID_DEVICE_HANDLE 0xFFFF
120 #define MPT2_IOC_PRE_RESET 1 /* prior to host reset */
121 #define MPT2_IOC_AFTER_RESET 2 /* just after host reset */
122 #define MPT2_IOC_DONE_RESET 3 /* links re-initialized */
127 #define MPT2SAS_FMT "%s: "
128 #define MPT2SAS_INFO_FMT KERN_INFO MPT2SAS_FMT
129 #define MPT2SAS_NOTE_FMT KERN_NOTICE MPT2SAS_FMT
130 #define MPT2SAS_WARN_FMT KERN_WARNING MPT2SAS_FMT
131 #define MPT2SAS_ERR_FMT KERN_ERR MPT2SAS_FMT
136 #define MPT2SAS_DELL_BRANDING_SIZE 32
138 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING "Dell 6Gbps SAS HBA"
139 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING "Dell PERC H200 Adapter"
140 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
141 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING "Dell PERC H200 Modular"
142 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING "Dell PERC H200 Embedded"
143 #define MPT2SAS_DELL_PERC_H200_BRANDING "Dell PERC H200"
144 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING "Dell 6Gbps SAS"
149 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID 0x1F1C
150 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID 0x1F1D
151 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID 0x1F1E
152 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID 0x1F1F
153 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID 0x1F20
154 #define MPT2SAS_DELL_PERC_H200_SSDID 0x1F21
155 #define MPT2SAS_DELL_6GBPS_SAS_SSDID 0x1F22
160 #define MPT2SAS_INTEL_RMS25JB080_BRANDING \
161 "Intel(R) Integrated RAID Module RMS25JB080"
162 #define MPT2SAS_INTEL_RMS25JB040_BRANDING \
163 "Intel(R) Integrated RAID Module RMS25JB040"
164 #define MPT2SAS_INTEL_RMS25KB080_BRANDING \
165 "Intel(R) Integrated RAID Module RMS25KB080"
166 #define MPT2SAS_INTEL_RMS25KB040_BRANDING \
167 "Intel(R) Integrated RAID Module RMS25KB040"
168 #define MPT2SAS_INTEL_RMS25LB040_BRANDING \
169 "Intel(R) Integrated RAID Module RMS25LB040"
170 #define MPT2SAS_INTEL_RMS25LB080_BRANDING \
171 "Intel(R) Integrated RAID Module RMS25LB080"
172 #define MPT2SAS_INTEL_RMS2LL080_BRANDING \
173 "Intel Integrated RAID Module RMS2LL080"
174 #define MPT2SAS_INTEL_RMS2LL040_BRANDING \
175 "Intel Integrated RAID Module RMS2LL040"
176 #define MPT2SAS_INTEL_RS25GB008_BRANDING \
177 "Intel(R) RAID Controller RS25GB008"
178 #define MPT2SAS_INTEL_SSD910_BRANDING \
179 "Intel(R) SSD 910 Series"
183 #define MPT2SAS_INTEL_RMS25JB080_SSDID 0x3516
184 #define MPT2SAS_INTEL_RMS25JB040_SSDID 0x3517
185 #define MPT2SAS_INTEL_RMS25KB080_SSDID 0x3518
186 #define MPT2SAS_INTEL_RMS25KB040_SSDID 0x3519
187 #define MPT2SAS_INTEL_RMS25LB040_SSDID 0x351A
188 #define MPT2SAS_INTEL_RMS25LB080_SSDID 0x351B
189 #define MPT2SAS_INTEL_RMS2LL080_SSDID 0x350E
190 #define MPT2SAS_INTEL_RMS2LL040_SSDID 0x350F
191 #define MPT2SAS_INTEL_RS25GB008_SSDID 0x3000
192 #define MPT2SAS_INTEL_SSD910_SSDID 0x3700
197 #define MPT2SAS_HP_3PAR_SSVID 0x1590
198 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING "HP H220 Host Bus Adapter"
199 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING "HP H221 Host Bus Adapter"
200 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING "HP H222 Host Bus Adapter"
201 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING "HP H220i Host Bus Adapter"
202 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING "HP H210i Host Bus Adapter"
207 #define MPT2SAS_HP_2_4_INTERNAL_SSDID 0x0041
208 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID 0x0042
209 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID 0x0043
210 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID 0x0044
211 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID 0x0046
214 * WarpDrive Specific Log codes
217 #define MPT2_WARPDRIVE_LOGENTRY (0x8002)
218 #define MPT2_WARPDRIVE_LC_SSDT (0x41)
219 #define MPT2_WARPDRIVE_LC_SSDLW (0x43)
220 #define MPT2_WARPDRIVE_LC_SSDLF (0x44)
221 #define MPT2_WARPDRIVE_LC_BRMF (0x4D)
224 * per target private data
226 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
227 #define MPT_TARGET_FLAGS_VOLUME 0x02
228 #define MPT_TARGET_FLAGS_DELETED 0x04
231 * struct MPT2SAS_TARGET - starget private hostdata
232 * @starget: starget object
233 * @sas_address: target sas address
234 * @raid_device: raid_device pointer to access volume data
235 * @handle: device handle
236 * @num_luns: number luns
237 * @flags: MPT_TARGET_FLAGS_XXX flags
238 * @deleted: target flaged for deletion
239 * @tm_busy: target is busy with TM request.
241 struct MPT2SAS_TARGET {
242 struct scsi_target *starget;
244 struct _raid_device *raid_device;
254 * per device private data
256 #define MPT_DEVICE_FLAGS_INIT 0x01
257 #define MPT_DEVICE_TLR_ON 0x02
260 * struct MPT2SAS_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
269 /* OEM Identifiers */
270 #define MFG10_OEM_ID_INVALID (0x00000000)
271 #define MFG10_OEM_ID_DELL (0x00000001)
272 #define MFG10_OEM_ID_FSC (0x00000002)
273 #define MFG10_OEM_ID_SUN (0x00000003)
274 #define MFG10_OEM_ID_IBM (0x00000004)
277 #define MFG10_GF0_OCE_DISABLED (0x00000001)
278 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
279 #define MFG10_GF0_R10_DISPLAY (0x00000004)
280 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
281 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
283 /* OEM Specific Flags will come from OEM specific header files */
284 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
285 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
286 U8 OEMIdentifier; /* 04h */
287 U8 Reserved1; /* 05h */
288 U16 Reserved2; /* 08h */
289 U32 Reserved3; /* 0Ch */
290 U32 GenericFlags0; /* 10h */
291 U32 GenericFlags1; /* 14h */
292 U32 Reserved4; /* 18h */
293 U32 OEMSpecificFlags0; /* 1Ch */
294 U32 OEMSpecificFlags1; /* 20h */
295 U32 Reserved5[18]; /* 24h-60h*/
296 } MPI2_CONFIG_PAGE_MAN_10,
297 MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
298 Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
300 #define MFG_PAGE10_HIDE_SSDS_MASK (0x00000003)
301 #define MFG_PAGE10_HIDE_ALL_DISKS (0x00)
302 #define MFG_PAGE10_EXPOSE_ALL_DISKS (0x01)
303 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT (0x02)
306 struct MPT2SAS_DEVICE {
307 struct MPT2SAS_TARGET *sas_target;
315 #define MPT2_CMD_NOT_USED 0x8000 /* free */
316 #define MPT2_CMD_COMPLETE 0x0001 /* completed */
317 #define MPT2_CMD_PENDING 0x0002 /* pending */
318 #define MPT2_CMD_REPLY_VALID 0x0004 /* reply is valid */
319 #define MPT2_CMD_RESET 0x0008 /* host reset dropped the command */
322 * struct _internal_cmd - internal commands struct
325 * @reply: reply message pointer
327 * @status: MPT2_CMD_XXX status
328 * @smid: system message id
330 struct _internal_cmd {
332 struct completion done;
341 * struct _sas_device - attached device information
342 * @list: sas device list
343 * @starget: starget object
344 * @sas_address: device sas address
345 * @device_name: retrieved from the SAS IDENTIFY frame.
346 * @handle: device handle
347 * @sas_address_parent: sas address of parent expander or sas host
348 * @enclosure_handle: enclosure handle
349 * @enclosure_logical_id: enclosure logical identifier
350 * @volume_handle: volume handle (valid when hidden raid member)
351 * @volume_wwid: volume unique identifier
352 * @device_info: bitfield provides detailed info about the device
354 * @channel: target channel
355 * @slot: number number
356 * @phy: phy identifier provided in sas device page 0
357 * @responding: used in _scsih_sas_device_mark_responding
358 * @pfa_led_on: flag for PFA LED status
361 struct list_head list;
362 struct scsi_target *starget;
366 u64 sas_address_parent;
367 u16 enclosure_handle;
368 u64 enclosure_logical_id;
381 * struct _raid_device - raid volume link list
382 * @list: sas device list
383 * @starget: starget object
384 * @sdev: scsi device struct (volumes are single lun)
385 * @wwid: unique identifier for the volume
386 * @handle: device handle
387 * @block_size: Block size of the volume
389 * @channel: target channel
390 * @volume_type: the raid level
391 * @device_info: bitfield provides detailed info about the hidden components
392 * @num_pds: number of hidden raid components
393 * @responding: used in _scsih_raid_device_mark_responding
394 * @percent_complete: resync percent complete
395 * @direct_io_enabled: Whether direct io to PDs are allowed or not
396 * @stripe_exponent: X where 2powX is the stripe sz in blocks
397 * @block_exponent: X where 2powX is the block sz in bytes
398 * @max_lba: Maximum number of LBA in the volume
399 * @stripe_sz: Stripe Size of the volume
400 * @device_info: Device info of the volume member disk
401 * @pd_handle: Array of handles of the physical drives for direct I/O in le16
403 #define MPT_MAX_WARPDRIVE_PDS 8
404 struct _raid_device {
405 struct list_head list;
406 struct scsi_target *starget;
407 struct scsi_device *sdev;
417 u8 direct_io_enabled;
423 u16 pd_handle[MPT_MAX_WARPDRIVE_PDS];
427 * struct _boot_device - boot device info
428 * @is_raid: flag to indicate whether this is volume
429 * @device: holds pointer for either struct _sas_device or
430 * struct _raid_device
432 struct _boot_device {
438 * struct _sas_port - wide/narrow sas port information
439 * @port_list: list of ports belonging to expander
440 * @num_phys: number of phys belonging to this port
441 * @remote_identify: attached device identification
442 * @rphy: sas transport rphy object
443 * @port: sas transport wide/narrow port object
444 * @phy_list: _sas_phy list objects belonging to this port
447 struct list_head port_list;
449 struct sas_identify remote_identify;
450 struct sas_rphy *rphy;
451 struct sas_port *port;
452 struct list_head phy_list;
456 * struct _sas_phy - phy information
457 * @port_siblings: list of phys belonging to a port
458 * @identify: phy identification
459 * @remote_identify: attached device identification
460 * @phy: sas transport phy object
461 * @phy_id: unique phy id
462 * @handle: device handle for this phy
463 * @attached_handle: device handle for attached device
464 * @phy_belongs_to_port: port has been created for this phy
467 struct list_head port_siblings;
468 struct sas_identify identify;
469 struct sas_identify remote_identify;
474 u8 phy_belongs_to_port;
478 * struct _sas_node - sas_host/expander information
479 * @list: list of expanders
480 * @parent_dev: parent device class
481 * @num_phys: number phys belonging to this sas_host/expander
482 * @sas_address: sas address of this sas_host/expander
483 * @handle: handle for this sas_host/expander
484 * @sas_address_parent: sas address of parent expander or sas host
485 * @enclosure_handle: handle for this a member of an enclosure
486 * @device_info: bitwise defining capabilities of this sas_host/expander
487 * @responding: used in _scsih_expander_device_mark_responding
488 * @phy: a list of phys that make up this sas_host/expander
489 * @sas_port_list: list of ports attached to this sas_host/expander
492 struct list_head list;
493 struct device *parent_dev;
497 u64 sas_address_parent;
498 u16 enclosure_handle;
499 u64 enclosure_logical_id;
501 struct _sas_phy *phy;
502 struct list_head sas_port_list;
506 * enum reset_type - reset state
507 * @FORCE_BIG_HAMMER: issue diagnostic reset
508 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
516 * struct chain_tracker - firmware chain tracker
517 * @chain_buffer: chain buffer
518 * @chain_buffer_dma: physical address
519 * @tracker_list: list of free request (ioc->free_chain_list)
521 struct chain_tracker {
523 dma_addr_t chain_buffer_dma;
524 struct list_head tracker_list;
528 * struct scsiio_tracker - scsi mf request tracker
529 * @smid: system message id
530 * @scmd: scsi request pointer
531 * @cb_idx: callback index
532 * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
533 * @chain_list: list of chains associated to this IO
534 * @tracker_list: list of free request (ioc->free_list)
536 struct scsiio_tracker {
538 struct scsi_cmnd *scmd;
541 struct list_head chain_list;
542 struct list_head tracker_list;
546 * struct request_tracker - firmware request tracker
547 * @smid: system message id
548 * @cb_idx: callback index
549 * @tracker_list: list of free request (ioc->free_list)
551 struct request_tracker {
554 struct list_head tracker_list;
558 * struct _tr_list - target reset list
559 * @handle: device handle
560 * @state: state machine
563 struct list_head list;
568 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
571 * struct adapter_reply_queue - the reply queue struct
572 * @ioc: per adapter object
573 * @msix_index: msix index into vector table
574 * @vector: irq vector
575 * @reply_post_host_index: head index in the pool where FW completes IO
576 * @reply_post_free: reply post base virt address
577 * @name: the name registered to request_irq()
578 * @busy: isr is actively processing replies on another cpu
581 struct adapter_reply_queue {
582 struct MPT2SAS_ADAPTER *ioc;
585 u32 reply_post_host_index;
586 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
587 char name[MPT_NAME_LENGTH];
589 struct list_head list;
592 /* IOC Facts and Port Facts converted from little endian to cpu */
593 union mpi2_version_union {
594 MPI2_VERSION_STRUCT Struct;
598 struct mpt2sas_facts {
614 union mpi2_version_union FWVersion;
615 u16 IOCRequestFrameSize;
622 u16 HighPriorityCredit;
623 u16 MaxReplyDescriptorPostQueueDepth;
627 u16 MaxPersistentEntries;
631 struct mpt2sas_port_facts {
636 u16 MaxPostedCmdBuffers;
639 struct reply_post_struct {
640 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
641 dma_addr_t reply_post_free_dma;
645 * enum mutex_type - task management mutex type
646 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
647 * @TM_MUTEX_ON: mutex is required
654 typedef void (*MPT2SAS_FLUSH_RUNNING_CMDS)(struct MPT2SAS_ADAPTER *ioc);
656 * struct MPT2SAS_ADAPTER - per adapter struct
658 * @shost: shost object
659 * @id: unique adapter id
660 * @cpu_count: number online cpus
661 * @name: generic ioc string
662 * @tmp_string: tmp string used for logging
663 * @pdev: pci pdev object
664 * @chip: memory mapped register space
665 * @chip_phys: physical addrss prior to mapping
666 * @logging_level: see mpt2sas_debug.h
667 * @fwfault_debug: debuging FW timeouts
668 * @ir_firmware: IR firmware present
669 * @bars: bitmask of BAR's that must be configured
670 * @mask_interrupts: ignore interrupt
671 * @dma_mask: used to set the consistent dma mask
672 * @fault_reset_work_q_name: fw fault work queue
673 * @fault_reset_work_q: ""
674 * @fault_reset_work: ""
675 * @firmware_event_name: fw event work queue
676 * @firmware_event_thread: ""
677 * @fw_events_off: flag to turn off fw event handling
679 * @fw_event_list: list of fw events
680 * @aen_event_read_flag: event log was read
681 * @broadcast_aen_busy: broadcast aen waiting to be serviced
682 * @shost_recovery: host reset in progress
683 * @ioc_reset_in_progress_lock:
684 * @ioc_link_reset_in_progress: phy/hard reset in progress
685 * @ignore_loginfos: ignore loginfos during task management
686 * @remove_host: flag for when driver unloads, to avoid sending dev resets
687 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
688 * @wait_for_discovery_to_complete: flag set at driver load time when
689 * waiting on reporting devices
690 * @is_driver_loading: flag set at driver load time
691 * @port_enable_failed: flag set when port enable has failed
692 * @start_scan: flag set from scan_start callback, cleared from _mpt2sas_fw_work
693 * @start_scan_failed: means port enable failed, return's the ioc_status
694 * @msix_enable: flag indicating msix is enabled
695 * @msix_vector_count: number msix vectors
696 * @cpu_msix_table: table for mapping cpus to msix index
697 * @cpu_msix_table_sz: table size
698 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
699 * @scsi_io_cb_idx: shost generated commands
700 * @tm_cb_idx: task management commands
701 * @scsih_cb_idx: scsih internal commands
702 * @transport_cb_idx: transport internal commands
703 * @ctl_cb_idx: clt internal commands
704 * @base_cb_idx: base internal commands
705 * @config_cb_idx: base internal commands
706 * @tm_tr_cb_idx : device removal target reset handshake
707 * @tm_tr_volume_cb_idx : volume removal target reset
714 * @base_add_sg_single: handler for either 32/64 bit sgl's
715 * @event_type: bits indicating which events to log
716 * @event_context: unique id for each logged event
717 * @event_log: event log pointer
718 * @event_masks: events that are masked
719 * @facts: static facts data
720 * @pfacts: static port facts data
721 * @manu_pg0: static manufacturing page 0
722 * @manu_pg10: static manufacturing page 10
723 * @bios_pg2: static bios page 2
724 * @bios_pg3: static bios page 3
725 * @ioc_pg8: static ioc page 8
726 * @iounit_pg0: static iounit page 0
727 * @iounit_pg1: static iounit page 1
728 * @sas_hba: sas host object
729 * @sas_expander_list: expander object list
731 * @sas_device_list: sas device object list
732 * @sas_device_init_list: sas device object list (used only at init time)
734 * @io_missing_delay: time for IO completed by fw when PDR enabled
735 * @device_missing_delay: time for device missing by fw when PDR enabled
736 * @sas_id : used for setting volume target IDs
737 * @blocking_handles: bitmask used to identify which devices need blocking
738 * @pd_handles : bitmask for PD handles
739 * @pd_handles_sz : size of pd_handle bitmask
740 * @config_page_sz: config page size
741 * @config_page: reserve memory for config page payload
743 * @hba_queue_depth: hba request queue depth
744 * @sge_size: sg element size for either 32/64 bit
745 * @scsiio_depth: SCSI_IO queue depth
746 * @request_sz: per request frame size
747 * @request: pool of request frames
750 * @scsi_lookup: firmware request tracker list
752 * @free_list: free list of request
753 * @chain: pool of chains
757 * @max_sges_in_main_message: number sg elements in main message
758 * @max_sges_in_chain_message: number sg elements per chain
759 * @chains_needed_per_io: max chains per io
760 * @chain_offset_value_for_main_message: location 1st sg in main
761 * @chain_depth: total chains allocated
765 * @hi_priority_depth:
773 * @internal_free_list:
774 * @sense: pool of sense
777 * @reply_depth: hba reply queue depth:
778 * @reply_sz: per reply frame size:
779 * @reply: pool of replys:
782 * @reply_free_queue_depth: reply free depth
783 * @reply_free: pool for reply free queue (32 bit addr)
785 * @reply_free_dma_pool:
786 * @reply_free_host_index: tail index in pool to insert free replys
787 * @reply_post_queue_depth: reply post queue depth
788 * @reply_post_struct: struct for reply_post_free physical & virt address
789 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
790 * @rdpq_array_enable: rdpq_array support is enabled in the driver
791 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
792 * is assigned only ones
793 * @reply_queue_count: number of reply queue's
794 * @reply_queue_list: link list contaning the reply queue info
795 * @reply_post_host_index: head index in the pool where FW completes IO
796 * @delayed_tr_list: target reset link list
797 * @delayed_tr_volume_list: volume target reset link list
799 struct MPT2SAS_ADAPTER {
800 struct list_head list;
801 struct Scsi_Host *shost;
804 char name[MPT_NAME_LENGTH];
805 char tmp_string[MPT_STRING_LENGTH];
806 struct pci_dev *pdev;
807 Mpi2SystemInterfaceRegs_t __iomem *chip;
808 resource_size_t chip_phys;
816 /* fw fault handler */
817 char fault_reset_work_q_name[20];
818 struct workqueue_struct *fault_reset_work_q;
819 struct delayed_work fault_reset_work;
821 /* fw event handler */
822 char firmware_event_name[20];
823 struct workqueue_struct *firmware_event_thread;
824 spinlock_t fw_event_lock;
825 struct list_head fw_event_list;
828 int aen_event_read_flag;
829 u8 broadcast_aen_busy;
830 u16 broadcast_aen_pending;
833 struct mutex reset_in_progress_mutex;
834 spinlock_t ioc_reset_in_progress_lock;
835 u8 ioc_link_reset_in_progress;
836 u8 ioc_reset_in_progress_status;
840 u8 pci_error_recovery;
841 u8 wait_for_discovery_to_complete;
842 struct completion port_enable_done;
843 u8 is_driver_loading;
844 u8 port_enable_failed;
847 u16 start_scan_failed;
850 u16 msix_vector_count;
852 resource_size_t __iomem **reply_post_host_index;
853 u16 cpu_msix_table_sz;
855 MPT2SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
856 u32 non_operational_loop;
858 /* internal commands, callback index */
865 u8 port_enable_cb_idx;
868 u8 tm_tr_volume_cb_idx;
869 u8 tm_sas_control_cb_idx;
870 struct _internal_cmd base_cmds;
871 struct _internal_cmd port_enable_cmds;
872 struct _internal_cmd transport_cmds;
873 struct _internal_cmd scsih_cmds;
874 struct _internal_cmd tm_cmds;
875 struct _internal_cmd ctl_cmds;
876 struct _internal_cmd config_cmds;
878 MPT_ADD_SGE base_add_sg_single;
881 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
884 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
886 /* static config pages */
887 struct mpt2sas_facts facts;
888 struct mpt2sas_port_facts *pfacts;
889 Mpi2ManufacturingPage0_t manu_pg0;
890 Mpi2BiosPage2_t bios_pg2;
891 Mpi2BiosPage3_t bios_pg3;
892 Mpi2IOCPage8_t ioc_pg8;
893 Mpi2IOUnitPage0_t iounit_pg0;
894 Mpi2IOUnitPage1_t iounit_pg1;
896 struct _boot_device req_boot_device;
897 struct _boot_device req_alt_boot_device;
898 struct _boot_device current_boot_device;
900 /* sas hba, expander, and device list */
901 struct _sas_node sas_hba;
902 struct list_head sas_expander_list;
903 spinlock_t sas_node_lock;
904 struct list_head sas_device_list;
905 struct list_head sas_device_init_list;
906 spinlock_t sas_device_lock;
907 struct list_head raid_device_list;
908 spinlock_t raid_device_lock;
910 u16 device_missing_delay;
912 void *blocking_handles;
919 dma_addr_t config_page_dma;
927 dma_addr_t request_dma;
929 struct scsiio_tracker *scsi_lookup;
930 ulong scsi_lookup_pages;
931 spinlock_t scsi_lookup_lock;
932 struct list_head free_list;
933 int pending_io_count;
934 wait_queue_head_t reset_wq;
937 struct chain_tracker *chain_lookup;
938 struct list_head free_chain_list;
939 struct dma_pool *chain_dma_pool;
941 u16 max_sges_in_main_message;
942 u16 max_sges_in_chain_message;
943 u16 chains_needed_per_io;
944 u16 chain_offset_value_for_main_message;
947 /* hi-priority queue */
948 u16 hi_priority_smid;
950 dma_addr_t hi_priority_dma;
951 u16 hi_priority_depth;
952 struct request_tracker *hpr_lookup;
953 struct list_head hpr_free_list;
958 dma_addr_t internal_dma;
960 struct request_tracker *internal_lookup;
961 struct list_head internal_free_list;
965 dma_addr_t sense_dma;
966 struct dma_pool *sense_dma_pool;
971 dma_addr_t reply_dma;
972 u32 reply_dma_max_address;
973 u32 reply_dma_min_address;
974 struct dma_pool *reply_dma_pool;
976 /* reply free queue */
977 u16 reply_free_queue_depth;
979 dma_addr_t reply_free_dma;
980 struct dma_pool *reply_free_dma_pool;
981 u32 reply_free_host_index;
983 /* reply post queue */
984 u16 reply_post_queue_depth;
985 struct reply_post_struct *reply_post;
986 u8 rdpq_array_capable;
987 u8 rdpq_array_enable;
988 u8 rdpq_array_enable_assigned;
989 struct dma_pool *reply_post_free_dma_pool;
990 u8 reply_queue_count;
991 struct list_head reply_queue_list;
993 struct list_head delayed_tr_list;
994 struct list_head delayed_tr_volume_list;
996 /* diag buffer support */
997 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
998 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
999 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
1000 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
1001 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
1002 Mpi2ManufacturingPage10_t manu_pg10;
1003 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
1004 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
1005 u32 ring_buffer_offset;
1009 u8 mfg_pg10_hide_flag;
1014 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1018 /* base shared API */
1019 extern struct list_head mpt2sas_ioc_list;
1020 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
1021 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
1023 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
1024 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
1025 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
1026 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
1027 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
1028 enum reset_type type);
1030 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1031 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1032 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
1033 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
1035 void mpt2sas_base_flush_reply_queues(struct MPT2SAS_ADAPTER *ioc);
1037 /* hi-priority queue */
1038 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1039 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
1040 struct scsi_cmnd *scmd);
1042 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1043 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1044 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1046 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1047 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1049 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1050 void mpt2sas_base_initialize_callback_handler(void);
1051 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1052 void mpt2sas_base_release_callback_handler(u8 cb_idx);
1054 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1056 u8 mpt2sas_port_enable_done(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1057 u8 msix_index, u32 reply);
1058 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
1060 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
1062 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
1063 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
1064 Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
1066 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
1067 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1068 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
1070 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
1072 void mpt2sas_base_update_missing_delay(struct MPT2SAS_ADAPTER *ioc,
1073 u16 device_missing_delay, u8 io_missing_delay);
1075 int mpt2sas_port_enable(struct MPT2SAS_ADAPTER *ioc);
1077 /* scsih shared API */
1078 void mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1080 int mpt2sas_scsih_issue_tm(struct MPT2SAS_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 mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1084 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1085 void mpt2sas_expander_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1086 void mpt2sas_device_remove_by_sas_address(struct MPT2SAS_ADAPTER *ioc,
1088 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
1090 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
1091 *ioc, u64 sas_address);
1092 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
1093 struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1095 void mpt2sas_port_enable_complete(struct MPT2SAS_ADAPTER *ioc);
1097 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1099 /* config shared API */
1100 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1102 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
1103 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
1104 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1105 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
1106 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
1107 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1108 *mpi_reply, Mpi2BiosPage2_t *config_page);
1109 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1110 *mpi_reply, Mpi2BiosPage3_t *config_page);
1111 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1112 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1113 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1114 *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
1115 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1116 *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
1117 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1118 *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
1119 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1120 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1121 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1122 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1123 int mpt2sas_config_get_iounit_pg3(struct MPT2SAS_ADAPTER *ioc,
1124 Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage3_t *config_page, u16 sz);
1125 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1126 *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1127 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
1128 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1129 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1130 *mpi_reply, Mpi2IOCPage8_t *config_page);
1131 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1132 *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
1133 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1134 *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
1135 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1136 *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
1137 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1138 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1139 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1140 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1141 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1142 *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
1143 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
1144 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1145 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
1146 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1147 *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
1149 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
1150 u16 *volume_handle);
1151 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
1153 /* ctl shared API */
1154 extern struct device_attribute *mpt2sas_host_attrs[];
1155 extern struct device_attribute *mpt2sas_dev_attrs[];
1156 void mpt2sas_ctl_init(void);
1157 void mpt2sas_ctl_exit(void);
1158 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1160 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1161 void mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1163 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
1164 Mpi2EventNotificationReply_t *mpi_reply);
1166 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
1167 u8 bits_to_regsiter);
1169 /* transport shared API */
1170 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1172 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
1173 u16 handle, u64 sas_address);
1174 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
1175 u64 sas_address_parent);
1176 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1177 *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1178 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1179 *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
1180 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
1181 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1182 extern struct sas_function_template mpt2sas_transport_functions;
1183 extern struct scsi_transport_template *mpt2sas_transport_template;
1184 extern int scsi_internal_device_block(struct scsi_device *sdev);
1185 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
1186 u8 msix_index, u32 reply);
1187 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1188 enum scsi_device_state new_state);
1190 #endif /* MPT2SAS_BASE_H_INCLUDED */