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-2010 LSI Corporation
7 * (mailto:DL-MPTFusionLinux@lsi.com)
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
21 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
22 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
23 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
24 * solely responsible for determining the appropriateness of using and
25 * distributing the Program and assumes all risks associated with its
26 * exercise of rights under this Agreement, including but not limited to
27 * the risks and costs of program errors, damage to or loss of data,
28 * programs or equipment, and unavailability or interruption of operations.
30 * DISCLAIMER OF LIABILITY
31 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
32 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
34 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
35 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
36 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
37 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
45 #ifndef 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"
70 #define MPT2SAS_AUTHOR "LSI Corporation <DL-MPTFusionLinux@lsi.com>"
71 #define MPT2SAS_DESCRIPTION "LSI MPT Fusion SAS 2.0 Device Driver"
72 #define MPT2SAS_DRIVER_VERSION "09.100.00.00"
73 #define MPT2SAS_MAJOR_VERSION 09
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_RMS2LL080_BRANDING \
161 "Intel Integrated RAID Module RMS2LL080"
162 #define MPT2SAS_INTEL_RMS2LL040_BRANDING \
163 "Intel Integrated RAID Module RMS2LL040"
164 #define MPT2SAS_INTEL_RS25GB008_BRANDING \
165 "Intel(R) RAID Controller RS25GB008"
170 #define MPT2SAS_INTEL_RMS2LL080_SSDID 0x350E
171 #define MPT2SAS_INTEL_RMS2LL040_SSDID 0x350F
172 #define MPT2SAS_INTEL_RS25GB008_SSDID 0x3000
178 #define MPT2SAS_HP_3PAR_SSVID 0x1590
179 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING "HP H220 Host Bus Adapter"
180 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING "HP H221 Host Bus Adapter"
181 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING "HP H222 Host Bus Adapter"
182 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING "HP H220i Host Bus Adapter"
183 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING "HP H210i Host Bus Adapter"
188 #define MPT2SAS_HP_2_4_INTERNAL_SSDID 0x0041
189 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID 0x0042
190 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID 0x0043
191 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID 0x0044
192 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID 0x0046
195 * WarpDrive Specific Log codes
198 #define MPT2_WARPDRIVE_LOGENTRY (0x8002)
199 #define MPT2_WARPDRIVE_LC_SSDT (0x41)
200 #define MPT2_WARPDRIVE_LC_SSDLW (0x43)
201 #define MPT2_WARPDRIVE_LC_SSDLF (0x44)
202 #define MPT2_WARPDRIVE_LC_BRMF (0x4D)
205 * per target private data
207 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
208 #define MPT_TARGET_FLAGS_VOLUME 0x02
209 #define MPT_TARGET_FLAGS_DELETED 0x04
212 * struct MPT2SAS_TARGET - starget private hostdata
213 * @starget: starget object
214 * @sas_address: target sas address
215 * @raid_device: raid_device pointer to access volume data
216 * @handle: device handle
217 * @num_luns: number luns
218 * @flags: MPT_TARGET_FLAGS_XXX flags
219 * @deleted: target flaged for deletion
220 * @tm_busy: target is busy with TM request.
222 struct MPT2SAS_TARGET {
223 struct scsi_target *starget;
225 struct _raid_device *raid_device;
235 * per device private data
237 #define MPT_DEVICE_FLAGS_INIT 0x01
238 #define MPT_DEVICE_TLR_ON 0x02
241 * struct MPT2SAS_DEVICE - sdev private hostdata
242 * @sas_target: starget private hostdata
244 * @flags: MPT_DEVICE_XXX flags
245 * @configured_lun: lun is configured
246 * @block: device is in SDEV_BLOCK state
247 * @tlr_snoop_check: flag used in determining whether to disable TLR
250 /* OEM Identifiers */
251 #define MFG10_OEM_ID_INVALID (0x00000000)
252 #define MFG10_OEM_ID_DELL (0x00000001)
253 #define MFG10_OEM_ID_FSC (0x00000002)
254 #define MFG10_OEM_ID_SUN (0x00000003)
255 #define MFG10_OEM_ID_IBM (0x00000004)
258 #define MFG10_GF0_OCE_DISABLED (0x00000001)
259 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
260 #define MFG10_GF0_R10_DISPLAY (0x00000004)
261 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
262 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
264 /* OEM Specific Flags will come from OEM specific header files */
265 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
266 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
267 U8 OEMIdentifier; /* 04h */
268 U8 Reserved1; /* 05h */
269 U16 Reserved2; /* 08h */
270 U32 Reserved3; /* 0Ch */
271 U32 GenericFlags0; /* 10h */
272 U32 GenericFlags1; /* 14h */
273 U32 Reserved4; /* 18h */
274 U32 OEMSpecificFlags0; /* 1Ch */
275 U32 OEMSpecificFlags1; /* 20h */
276 U32 Reserved5[18]; /* 24h-60h*/
277 } MPI2_CONFIG_PAGE_MAN_10,
278 MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
279 Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
281 #define MFG_PAGE10_HIDE_SSDS_MASK (0x00000003)
282 #define MFG_PAGE10_HIDE_ALL_DISKS (0x00)
283 #define MFG_PAGE10_EXPOSE_ALL_DISKS (0x01)
284 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT (0x02)
287 struct MPT2SAS_DEVICE {
288 struct MPT2SAS_TARGET *sas_target;
296 #define MPT2_CMD_NOT_USED 0x8000 /* free */
297 #define MPT2_CMD_COMPLETE 0x0001 /* completed */
298 #define MPT2_CMD_PENDING 0x0002 /* pending */
299 #define MPT2_CMD_REPLY_VALID 0x0004 /* reply is valid */
300 #define MPT2_CMD_RESET 0x0008 /* host reset dropped the command */
303 * struct _internal_cmd - internal commands struct
306 * @reply: reply message pointer
308 * @status: MPT2_CMD_XXX status
309 * @smid: system message id
311 struct _internal_cmd {
313 struct completion done;
322 * struct _sas_device - attached device information
323 * @list: sas device list
324 * @starget: starget object
325 * @sas_address: device sas address
326 * @device_name: retrieved from the SAS IDENTIFY frame.
327 * @handle: device handle
328 * @sas_address_parent: sas address of parent expander or sas host
329 * @enclosure_handle: enclosure handle
330 * @enclosure_logical_id: enclosure logical identifier
331 * @volume_handle: volume handle (valid when hidden raid member)
332 * @volume_wwid: volume unique identifier
333 * @device_info: bitfield provides detailed info about the device
335 * @channel: target channel
336 * @slot: number number
337 * @phy: phy identifier provided in sas device page 0
338 * @responding: used in _scsih_sas_device_mark_responding
341 struct list_head list;
342 struct scsi_target *starget;
346 u64 sas_address_parent;
347 u16 enclosure_handle;
348 u64 enclosure_logical_id;
360 * struct _raid_device - raid volume link list
361 * @list: sas device list
362 * @starget: starget object
363 * @sdev: scsi device struct (volumes are single lun)
364 * @wwid: unique identifier for the volume
365 * @handle: device handle
366 * @block_size: Block size of the volume
368 * @channel: target channel
369 * @volume_type: the raid level
370 * @device_info: bitfield provides detailed info about the hidden components
371 * @num_pds: number of hidden raid components
372 * @responding: used in _scsih_raid_device_mark_responding
373 * @percent_complete: resync percent complete
374 * @direct_io_enabled: Whether direct io to PDs are allowed or not
375 * @stripe_exponent: X where 2powX is the stripe sz in blocks
376 * @max_lba: Maximum number of LBA in the volume
377 * @stripe_sz: Stripe Size of the volume
378 * @device_info: Device info of the volume member disk
379 * @pd_handle: Array of handles of the physical drives for direct I/O in le16
381 #define MPT_MAX_WARPDRIVE_PDS 8
382 struct _raid_device {
383 struct list_head list;
384 struct scsi_target *starget;
385 struct scsi_device *sdev;
395 u8 direct_io_enabled;
400 u16 pd_handle[MPT_MAX_WARPDRIVE_PDS];
404 * struct _boot_device - boot device info
405 * @is_raid: flag to indicate whether this is volume
406 * @device: holds pointer for either struct _sas_device or
407 * struct _raid_device
409 struct _boot_device {
415 * struct _sas_port - wide/narrow sas port information
416 * @port_list: list of ports belonging to expander
417 * @num_phys: number of phys belonging to this port
418 * @remote_identify: attached device identification
419 * @rphy: sas transport rphy object
420 * @port: sas transport wide/narrow port object
421 * @phy_list: _sas_phy list objects belonging to this port
424 struct list_head port_list;
426 struct sas_identify remote_identify;
427 struct sas_rphy *rphy;
428 struct sas_port *port;
429 struct list_head phy_list;
433 * struct _sas_phy - phy information
434 * @port_siblings: list of phys belonging to a port
435 * @identify: phy identification
436 * @remote_identify: attached device identification
437 * @phy: sas transport phy object
438 * @phy_id: unique phy id
439 * @handle: device handle for this phy
440 * @attached_handle: device handle for attached device
441 * @phy_belongs_to_port: port has been created for this phy
444 struct list_head port_siblings;
445 struct sas_identify identify;
446 struct sas_identify remote_identify;
451 u8 phy_belongs_to_port;
455 * struct _sas_node - sas_host/expander information
456 * @list: list of expanders
457 * @parent_dev: parent device class
458 * @num_phys: number phys belonging to this sas_host/expander
459 * @sas_address: sas address of this sas_host/expander
460 * @handle: handle for this sas_host/expander
461 * @sas_address_parent: sas address of parent expander or sas host
462 * @enclosure_handle: handle for this a member of an enclosure
463 * @device_info: bitwise defining capabilities of this sas_host/expander
464 * @responding: used in _scsih_expander_device_mark_responding
465 * @phy: a list of phys that make up this sas_host/expander
466 * @sas_port_list: list of ports attached to this sas_host/expander
469 struct list_head list;
470 struct device *parent_dev;
474 u64 sas_address_parent;
475 u16 enclosure_handle;
476 u64 enclosure_logical_id;
478 struct _sas_phy *phy;
479 struct list_head sas_port_list;
483 * enum reset_type - reset state
484 * @FORCE_BIG_HAMMER: issue diagnostic reset
485 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
493 * struct chain_tracker - firmware chain tracker
494 * @chain_buffer: chain buffer
495 * @chain_buffer_dma: physical address
496 * @tracker_list: list of free request (ioc->free_chain_list)
498 struct chain_tracker {
500 dma_addr_t chain_buffer_dma;
501 struct list_head tracker_list;
505 * struct scsiio_tracker - scsi mf request tracker
506 * @smid: system message id
507 * @scmd: scsi request pointer
508 * @cb_idx: callback index
509 * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
510 * @chain_list: list of chains associated to this IO
511 * @tracker_list: list of free request (ioc->free_list)
513 struct scsiio_tracker {
515 struct scsi_cmnd *scmd;
518 struct list_head chain_list;
519 struct list_head tracker_list;
523 * struct request_tracker - firmware request tracker
524 * @smid: system message id
525 * @cb_idx: callback index
526 * @tracker_list: list of free request (ioc->free_list)
528 struct request_tracker {
531 struct list_head tracker_list;
535 * struct _tr_list - target reset list
536 * @handle: device handle
537 * @state: state machine
540 struct list_head list;
545 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
547 /* IOC Facts and Port Facts converted from little endian to cpu */
548 union mpi2_version_union {
549 MPI2_VERSION_STRUCT Struct;
553 struct mpt2sas_facts {
569 union mpi2_version_union FWVersion;
570 u16 IOCRequestFrameSize;
577 u16 HighPriorityCredit;
578 u16 MaxReplyDescriptorPostQueueDepth;
582 u16 MaxPersistentEntries;
586 struct mpt2sas_port_facts {
591 u16 MaxPostedCmdBuffers;
595 * enum mutex_type - task management mutex type
596 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
597 * @TM_MUTEX_ON: mutex is required
605 * struct MPT2SAS_ADAPTER - per adapter struct
607 * @shost: shost object
608 * @id: unique adapter id
609 * @pci_irq: irq number
610 * @name: generic ioc string
611 * @tmp_string: tmp string used for logging
612 * @pdev: pci pdev object
613 * @chip: memory mapped register space
614 * @chip_phys: physical addrss prior to mapping
615 * @logging_level: see mpt2sas_debug.h
616 * @fwfault_debug: debuging FW timeouts
617 * @ir_firmware: IR firmware present
618 * @bars: bitmask of BAR's that must be configured
619 * @mask_interrupts: ignore interrupt
620 * @fault_reset_work_q_name: fw fault work queue
621 * @fault_reset_work_q: ""
622 * @fault_reset_work: ""
623 * @firmware_event_name: fw event work queue
624 * @firmware_event_thread: ""
625 * @fw_events_off: flag to turn off fw event handling
627 * @fw_event_list: list of fw events
628 * @aen_event_read_flag: event log was read
629 * @broadcast_aen_busy: broadcast aen waiting to be serviced
630 * @shost_recovery: host reset in progress
631 * @ioc_reset_in_progress_lock:
632 * @ioc_link_reset_in_progress: phy/hard reset in progress
633 * @ignore_loginfos: ignore loginfos during task management
634 * @remove_host: flag for when driver unloads, to avoid sending dev resets
635 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
636 * @wait_for_port_enable_to_complete:
637 * @msix_enable: flag indicating msix is enabled
638 * @msix_vector_count: number msix vectors
639 * @msix_table: virt address to the msix table
640 * @msix_table_backup: backup msix table
641 * @scsi_io_cb_idx: shost generated commands
642 * @tm_cb_idx: task management commands
643 * @scsih_cb_idx: scsih internal commands
644 * @transport_cb_idx: transport internal commands
645 * @ctl_cb_idx: clt internal commands
646 * @base_cb_idx: base internal commands
647 * @config_cb_idx: base internal commands
648 * @tm_tr_cb_idx : device removal target reset handshake
649 * @tm_tr_volume_cb_idx : volume removal target reset
656 * @base_add_sg_single: handler for either 32/64 bit sgl's
657 * @event_type: bits indicating which events to log
658 * @event_context: unique id for each logged event
659 * @event_log: event log pointer
660 * @event_masks: events that are masked
661 * @facts: static facts data
662 * @pfacts: static port facts data
663 * @manu_pg0: static manufacturing page 0
664 * @manu_pg10: static manufacturing page 10
665 * @bios_pg2: static bios page 2
666 * @bios_pg3: static bios page 3
667 * @ioc_pg8: static ioc page 8
668 * @iounit_pg0: static iounit page 0
669 * @iounit_pg1: static iounit page 1
670 * @sas_hba: sas host object
671 * @sas_expander_list: expander object list
673 * @sas_device_list: sas device object list
674 * @sas_device_init_list: sas device object list (used only at init time)
676 * @io_missing_delay: time for IO completed by fw when PDR enabled
677 * @device_missing_delay: time for device missing by fw when PDR enabled
678 * @sas_id : used for setting volume target IDs
679 * @pd_handles : bitmask for PD handles
680 * @pd_handles_sz : size of pd_handle bitmask
681 * @config_page_sz: config page size
682 * @config_page: reserve memory for config page payload
684 * @hba_queue_depth: hba request queue depth
685 * @sge_size: sg element size for either 32/64 bit
686 * @scsiio_depth: SCSI_IO queue depth
687 * @request_sz: per request frame size
688 * @request: pool of request frames
691 * @scsi_lookup: firmware request tracker list
693 * @free_list: free list of request
694 * @chain: pool of chains
698 * @max_sges_in_main_message: number sg elements in main message
699 * @max_sges_in_chain_message: number sg elements per chain
700 * @chains_needed_per_io: max chains per io
701 * @chain_offset_value_for_main_message: location 1st sg in main
702 * @chain_depth: total chains allocated
706 * @hi_priority_depth:
714 * @internal_free_list:
715 * @sense: pool of sense
718 * @reply_depth: hba reply queue depth:
719 * @reply_sz: per reply frame size:
720 * @reply: pool of replys:
723 * @reply_free_queue_depth: reply free depth
724 * @reply_free: pool for reply free queue (32 bit addr)
726 * @reply_free_dma_pool:
727 * @reply_free_host_index: tail index in pool to insert free replys
728 * @reply_post_queue_depth: reply post queue depth
729 * @reply_post_free: pool for reply post (64bit descriptor)
730 * @reply_post_free_dma:
731 * @reply_post_free_dma_pool:
732 * @reply_post_host_index: head index in the pool where FW completes IO
733 * @delayed_tr_list: target reset link list
734 * @delayed_tr_volume_list: volume target reset link list
736 struct MPT2SAS_ADAPTER {
737 struct list_head list;
738 struct Scsi_Host *shost;
741 char name[MPT_NAME_LENGTH];
742 char tmp_string[MPT_STRING_LENGTH];
743 struct pci_dev *pdev;
744 Mpi2SystemInterfaceRegs_t __iomem *chip;
745 resource_size_t chip_phys;
752 /* fw fault handler */
753 char fault_reset_work_q_name[20];
754 struct workqueue_struct *fault_reset_work_q;
755 struct delayed_work fault_reset_work;
757 /* fw event handler */
758 char firmware_event_name[20];
759 struct workqueue_struct *firmware_event_thread;
760 spinlock_t fw_event_lock;
761 struct list_head fw_event_list;
764 int aen_event_read_flag;
765 u8 broadcast_aen_busy;
766 u16 broadcast_aen_pending;
769 struct mutex reset_in_progress_mutex;
770 struct completion shost_recovery_done;
771 spinlock_t ioc_reset_in_progress_lock;
772 u8 ioc_link_reset_in_progress;
773 int ioc_reset_in_progress_status;
777 u8 pci_error_recovery;
778 u8 wait_for_port_enable_to_complete;
781 u16 msix_vector_count;
783 u32 *msix_table_backup;
786 /* internal commands, callback index */
795 u8 tm_tr_volume_cb_idx;
796 u8 tm_sas_control_cb_idx;
797 struct _internal_cmd base_cmds;
798 struct _internal_cmd transport_cmds;
799 struct _internal_cmd scsih_cmds;
800 struct _internal_cmd tm_cmds;
801 struct _internal_cmd ctl_cmds;
802 struct _internal_cmd config_cmds;
804 MPT_ADD_SGE base_add_sg_single;
807 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
810 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
812 /* static config pages */
813 struct mpt2sas_facts facts;
814 struct mpt2sas_port_facts *pfacts;
815 Mpi2ManufacturingPage0_t manu_pg0;
816 Mpi2BiosPage2_t bios_pg2;
817 Mpi2BiosPage3_t bios_pg3;
818 Mpi2IOCPage8_t ioc_pg8;
819 Mpi2IOUnitPage0_t iounit_pg0;
820 Mpi2IOUnitPage1_t iounit_pg1;
822 struct _boot_device req_boot_device;
823 struct _boot_device req_alt_boot_device;
824 struct _boot_device current_boot_device;
826 /* sas hba, expander, and device list */
827 struct _sas_node sas_hba;
828 struct list_head sas_expander_list;
829 spinlock_t sas_node_lock;
830 struct list_head sas_device_list;
831 struct list_head sas_device_init_list;
832 spinlock_t sas_device_lock;
833 struct list_head raid_device_list;
834 spinlock_t raid_device_lock;
836 u16 device_missing_delay;
845 dma_addr_t config_page_dma;
853 dma_addr_t request_dma;
855 struct scsiio_tracker *scsi_lookup;
856 ulong scsi_lookup_pages;
857 spinlock_t scsi_lookup_lock;
858 struct list_head free_list;
859 int pending_io_count;
860 wait_queue_head_t reset_wq;
863 struct chain_tracker *chain_lookup;
864 struct list_head free_chain_list;
865 struct dma_pool *chain_dma_pool;
867 u16 max_sges_in_main_message;
868 u16 max_sges_in_chain_message;
869 u16 chains_needed_per_io;
870 u16 chain_offset_value_for_main_message;
873 /* hi-priority queue */
874 u16 hi_priority_smid;
876 dma_addr_t hi_priority_dma;
877 u16 hi_priority_depth;
878 struct request_tracker *hpr_lookup;
879 struct list_head hpr_free_list;
884 dma_addr_t internal_dma;
886 struct request_tracker *internal_lookup;
887 struct list_head internal_free_list;
891 dma_addr_t sense_dma;
892 struct dma_pool *sense_dma_pool;
897 dma_addr_t reply_dma;
898 u32 reply_dma_max_address;
899 u32 reply_dma_min_address;
900 struct dma_pool *reply_dma_pool;
902 /* reply free queue */
903 u16 reply_free_queue_depth;
905 dma_addr_t reply_free_dma;
906 struct dma_pool *reply_free_dma_pool;
907 u32 reply_free_host_index;
909 /* reply post queue */
910 u16 reply_post_queue_depth;
911 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
912 dma_addr_t reply_post_free_dma;
913 struct dma_pool *reply_post_free_dma_pool;
914 u32 reply_post_host_index;
916 struct list_head delayed_tr_list;
917 struct list_head delayed_tr_volume_list;
919 /* diag buffer support */
920 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
921 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
922 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
923 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
924 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
925 Mpi2ManufacturingPage10_t manu_pg10;
926 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
927 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
928 u32 ring_buffer_offset;
932 u8 mfg_pg10_hide_flag;
937 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
941 /* base shared API */
942 extern struct list_head mpt2sas_ioc_list;
943 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
944 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
946 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
947 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
948 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
949 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
950 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
951 enum reset_type type);
953 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
954 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
955 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
956 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
959 /* hi-priority queue */
960 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
961 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
962 struct scsi_cmnd *scmd);
964 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
965 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
966 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
968 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
969 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
971 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
972 void mpt2sas_base_initialize_callback_handler(void);
973 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
974 void mpt2sas_base_release_callback_handler(u8 cb_idx);
976 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
978 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
980 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
982 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
983 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
984 Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
986 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
987 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
988 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
990 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
992 /* scsih shared API */
993 u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
995 int mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle,
996 uint channel, uint id, uint lun, u8 type, u16 smid_task,
997 ulong timeout, unsigned long serial_number, enum mutex_type m_type);
998 void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
999 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1000 void mpt2sas_expander_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1001 void mpt2sas_device_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1002 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
1004 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
1005 *ioc, u64 sas_address);
1006 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
1007 struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1009 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1011 /* config shared API */
1012 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1014 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
1015 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
1016 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1017 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
1018 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
1019 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1020 *mpi_reply, Mpi2BiosPage2_t *config_page);
1021 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1022 *mpi_reply, Mpi2BiosPage3_t *config_page);
1023 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1024 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1025 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1026 *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
1027 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1028 *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
1029 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1030 *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
1031 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1032 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1033 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1034 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1035 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1036 *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1037 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
1038 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1039 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1040 *mpi_reply, Mpi2IOCPage8_t *config_page);
1041 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1042 *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
1043 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1044 *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
1045 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1046 *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
1047 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1048 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1049 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1050 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1051 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1052 *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
1053 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
1054 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1055 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
1056 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1057 *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
1059 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
1060 u16 *volume_handle);
1061 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
1063 /* ctl shared API */
1064 extern struct device_attribute *mpt2sas_host_attrs[];
1065 extern struct device_attribute *mpt2sas_dev_attrs[];
1066 void mpt2sas_ctl_init(void);
1067 void mpt2sas_ctl_exit(void);
1068 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1070 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1071 u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1073 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
1074 Mpi2EventNotificationReply_t *mpi_reply);
1076 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
1077 u8 bits_to_regsiter);
1079 /* transport shared API */
1080 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1082 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
1083 u16 handle, u64 sas_address);
1084 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
1085 u64 sas_address_parent);
1086 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1087 *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1088 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1089 *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
1090 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
1091 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1092 extern struct sas_function_template mpt2sas_transport_functions;
1093 extern struct scsi_transport_template *mpt2sas_transport_template;
1094 extern int scsi_internal_device_block(struct scsi_device *sdev);
1095 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
1096 u8 msix_index, u32 reply);
1097 extern int scsi_internal_device_unblock(struct scsi_device *sdev);
1099 #endif /* MPT2SAS_BASE_H_INCLUDED */