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 * (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 MPT3SAS_BASE_H_INCLUDED
46 #define MPT3SAS_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 "mpt3sas_debug.h"
67 #include "mpt3sas_trigger_diag.h"
69 /* driver versioning info */
70 #define MPT3SAS_DRIVER_NAME "mpt3sas"
71 #define MPT3SAS_AUTHOR "LSI Corporation <DL-MPTFusionLinux@lsi.com>"
72 #define MPT3SAS_DESCRIPTION "LSI MPT Fusion SAS 3.0 Device Driver"
73 #define MPT3SAS_DRIVER_VERSION "04.100.00.00"
74 #define MPT3SAS_MAJOR_VERSION 4
75 #define MPT3SAS_MINOR_VERSION 100
76 #define MPT3SAS_BUILD_VERSION 0
77 #define MPT3SAS_RELEASE_VERSION 00
80 * Set MPT3SAS_SG_DEPTH value based on user input.
82 #define MPT3SAS_MAX_PHYS_SEGMENTS SCSI_MAX_SG_SEGMENTS
83 #define MPT3SAS_MIN_PHYS_SEGMENTS 16
84 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
85 #define MPT3SAS_SG_DEPTH CONFIG_SCSI_MPT3SAS_MAX_SGE
87 #define MPT3SAS_SG_DEPTH MPT3SAS_MAX_PHYS_SEGMENTS
94 #define MPT3SAS_SATA_QUEUE_DEPTH 32
95 #define MPT3SAS_SAS_QUEUE_DEPTH 254
96 #define MPT3SAS_RAID_QUEUE_DEPTH 128
98 #define MPT_NAME_LENGTH 32 /* generic length of strings */
99 #define MPT_STRING_LENGTH 64
101 #define MPT_MAX_CALLBACKS 32
107 #define INTERNAL_CMDS_COUNT 10 /* reserved cmds */
109 #define MPI3_HIM_MASK 0xFFFFFFFF /* mask every bit*/
111 #define MPT3SAS_INVALID_DEVICE_HANDLE 0xFFFF
116 #define MPT3_IOC_PRE_RESET 1 /* prior to host reset */
117 #define MPT3_IOC_AFTER_RESET 2 /* just after host reset */
118 #define MPT3_IOC_DONE_RESET 3 /* links re-initialized */
123 #define MPT3SAS_FMT "%s: "
126 * per target private data
128 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
129 #define MPT_TARGET_FLAGS_VOLUME 0x02
130 #define MPT_TARGET_FLAGS_DELETED 0x04
131 #define MPT_TARGET_FASTPATH_IO 0x08
136 #define MPT3SAS_INTEL_RMS3JC080_BRANDING \
137 "Intel(R) Integrated RAID Module RMS3JC080"
138 #define MPT3SAS_INTEL_RS3GC008_BRANDING \
139 "Intel(R) RAID Controller RS3GC008"
140 #define MPT3SAS_INTEL_RS3FC044_BRANDING \
141 "Intel(R) RAID Controller RS3FC044"
142 #define MPT3SAS_INTEL_RS3UC080_BRANDING \
143 "Intel(R) RAID Controller RS3UC080"
148 #define MPT3SAS_INTEL_RMS3JC080_SSDID 0x3521
149 #define MPT3SAS_INTEL_RS3GC008_SSDID 0x3522
150 #define MPT3SAS_INTEL_RS3FC044_SSDID 0x3523
151 #define MPT3SAS_INTEL_RS3UC080_SSDID 0x3524
154 * status bits for ioc->diag_buffer_status
156 #define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)
157 #define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)
158 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)
161 /* OEM Identifiers */
162 #define MFG10_OEM_ID_INVALID (0x00000000)
163 #define MFG10_OEM_ID_DELL (0x00000001)
164 #define MFG10_OEM_ID_FSC (0x00000002)
165 #define MFG10_OEM_ID_SUN (0x00000003)
166 #define MFG10_OEM_ID_IBM (0x00000004)
169 #define MFG10_GF0_OCE_DISABLED (0x00000001)
170 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
171 #define MFG10_GF0_R10_DISPLAY (0x00000004)
172 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
173 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
175 /* OEM Specific Flags will come from OEM specific header files */
176 struct Mpi2ManufacturingPage10_t
{
177 MPI2_CONFIG_PAGE_HEADER Header
; /* 00h */
178 U8 OEMIdentifier
; /* 04h */
179 U8 Reserved1
; /* 05h */
180 U16 Reserved2
; /* 08h */
181 U32 Reserved3
; /* 0Ch */
182 U32 GenericFlags0
; /* 10h */
183 U32 GenericFlags1
; /* 14h */
184 U32 Reserved4
; /* 18h */
185 U32 OEMSpecificFlags0
; /* 1Ch */
186 U32 OEMSpecificFlags1
; /* 20h */
187 U32 Reserved5
[18]; /* 24h - 60h*/
191 /* Miscellaneous options */
192 struct Mpi2ManufacturingPage11_t
{
193 MPI2_CONFIG_PAGE_HEADER Header
; /* 00h */
194 __le32 Reserved1
; /* 04h */
195 u8 Reserved2
; /* 08h */
196 u8 EEDPTagMode
; /* 09h */
197 u8 Reserved3
; /* 0Ah */
198 u8 Reserved4
; /* 0Bh */
199 __le32 Reserved5
[23]; /* 0Ch-60h*/
203 * struct MPT3SAS_TARGET - starget private hostdata
204 * @starget: starget object
205 * @sas_address: target sas address
206 * @handle: device handle
207 * @num_luns: number luns
208 * @flags: MPT_TARGET_FLAGS_XXX flags
209 * @deleted: target flaged for deletion
210 * @tm_busy: target is busy with TM request.
212 struct MPT3SAS_TARGET
{
213 struct scsi_target
*starget
;
224 * per device private data
226 #define MPT_DEVICE_FLAGS_INIT 0x01
227 #define MPT_DEVICE_TLR_ON 0x02
230 * struct MPT3SAS_DEVICE - sdev private hostdata
231 * @sas_target: starget private hostdata
233 * @flags: MPT_DEVICE_XXX flags
234 * @configured_lun: lun is configured
235 * @block: device is in SDEV_BLOCK state
236 * @tlr_snoop_check: flag used in determining whether to disable TLR
237 * @eedp_enable: eedp support enable bit
238 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
239 * @eedp_block_length: block size
241 struct MPT3SAS_DEVICE
{
242 struct MPT3SAS_TARGET
*sas_target
;
250 #define MPT3_CMD_NOT_USED 0x8000 /* free */
251 #define MPT3_CMD_COMPLETE 0x0001 /* completed */
252 #define MPT3_CMD_PENDING 0x0002 /* pending */
253 #define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */
254 #define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */
257 * struct _internal_cmd - internal commands struct
260 * @reply: reply message pointer
262 * @status: MPT3_CMD_XXX status
263 * @smid: system message id
265 struct _internal_cmd
{
267 struct completion done
;
277 * struct _sas_device - attached device information
278 * @list: sas device list
279 * @starget: starget object
280 * @sas_address: device sas address
281 * @device_name: retrieved from the SAS IDENTIFY frame.
282 * @handle: device handle
283 * @sas_address_parent: sas address of parent expander or sas host
284 * @enclosure_handle: enclosure handle
285 * @enclosure_logical_id: enclosure logical identifier
286 * @volume_handle: volume handle (valid when hidden raid member)
287 * @volume_wwid: volume unique identifier
288 * @device_info: bitfield provides detailed info about the device
290 * @channel: target channel
291 * @slot: number number
292 * @phy: phy identifier provided in sas device page 0
293 * @responding: used in _scsih_sas_device_mark_responding
294 * @fast_path: fast path feature enable bit
295 * @pfa_led_on: flag for PFA LED status
299 struct list_head list
;
300 struct scsi_target
*starget
;
304 u64 sas_address_parent
;
305 u16 enclosure_handle
;
306 u64 enclosure_logical_id
;
320 * struct _raid_device - raid volume link list
321 * @list: sas device list
322 * @starget: starget object
323 * @sdev: scsi device struct (volumes are single lun)
324 * @wwid: unique identifier for the volume
325 * @handle: device handle
327 * @channel: target channel
328 * @volume_type: the raid level
329 * @device_info: bitfield provides detailed info about the hidden components
330 * @num_pds: number of hidden raid components
331 * @responding: used in _scsih_raid_device_mark_responding
332 * @percent_complete: resync percent complete
334 #define MPT_MAX_WARPDRIVE_PDS 8
335 struct _raid_device
{
336 struct list_head list
;
337 struct scsi_target
*starget
;
338 struct scsi_device
*sdev
;
351 * struct _boot_device - boot device info
352 * @is_raid: flag to indicate whether this is volume
353 * @device: holds pointer for either struct _sas_device or
354 * struct _raid_device
356 struct _boot_device
{
362 * struct _sas_port - wide/narrow sas port information
363 * @port_list: list of ports belonging to expander
364 * @num_phys: number of phys belonging to this port
365 * @remote_identify: attached device identification
366 * @rphy: sas transport rphy object
367 * @port: sas transport wide/narrow port object
368 * @phy_list: _sas_phy list objects belonging to this port
371 struct list_head port_list
;
373 struct sas_identify remote_identify
;
374 struct sas_rphy
*rphy
;
375 struct sas_port
*port
;
376 struct list_head phy_list
;
380 * struct _sas_phy - phy information
381 * @port_siblings: list of phys belonging to a port
382 * @identify: phy identification
383 * @remote_identify: attached device identification
384 * @phy: sas transport phy object
385 * @phy_id: unique phy id
386 * @handle: device handle for this phy
387 * @attached_handle: device handle for attached device
388 * @phy_belongs_to_port: port has been created for this phy
391 struct list_head port_siblings
;
392 struct sas_identify identify
;
393 struct sas_identify remote_identify
;
398 u8 phy_belongs_to_port
;
402 * struct _sas_node - sas_host/expander information
403 * @list: list of expanders
404 * @parent_dev: parent device class
405 * @num_phys: number phys belonging to this sas_host/expander
406 * @sas_address: sas address of this sas_host/expander
407 * @handle: handle for this sas_host/expander
408 * @sas_address_parent: sas address of parent expander or sas host
409 * @enclosure_handle: handle for this a member of an enclosure
410 * @device_info: bitwise defining capabilities of this sas_host/expander
411 * @responding: used in _scsih_expander_device_mark_responding
412 * @phy: a list of phys that make up this sas_host/expander
413 * @sas_port_list: list of ports attached to this sas_host/expander
416 struct list_head list
;
417 struct device
*parent_dev
;
421 u64 sas_address_parent
;
422 u16 enclosure_handle
;
423 u64 enclosure_logical_id
;
425 struct _sas_phy
*phy
;
426 struct list_head sas_port_list
;
430 * enum reset_type - reset state
431 * @FORCE_BIG_HAMMER: issue diagnostic reset
432 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
440 * struct chain_tracker - firmware chain tracker
441 * @chain_buffer: chain buffer
442 * @chain_buffer_dma: physical address
443 * @tracker_list: list of free request (ioc->free_chain_list)
445 struct chain_tracker
{
447 dma_addr_t chain_buffer_dma
;
448 struct list_head tracker_list
;
452 * struct scsiio_tracker - scsi mf request tracker
453 * @smid: system message id
454 * @scmd: scsi request pointer
455 * @cb_idx: callback index
456 * @tracker_list: list of free request (ioc->free_list)
458 struct scsiio_tracker
{
460 struct scsi_cmnd
*scmd
;
462 struct list_head chain_list
;
463 struct list_head tracker_list
;
467 * struct request_tracker - firmware request tracker
468 * @smid: system message id
469 * @cb_idx: callback index
470 * @tracker_list: list of free request (ioc->free_list)
472 struct request_tracker
{
475 struct list_head tracker_list
;
479 * struct _tr_list - target reset list
480 * @handle: device handle
481 * @state: state machine
484 struct list_head list
;
491 * struct adapter_reply_queue - the reply queue struct
492 * @ioc: per adapter object
493 * @msix_index: msix index into vector table
494 * @vector: irq vector
495 * @reply_post_host_index: head index in the pool where FW completes IO
496 * @reply_post_free: reply post base virt address
497 * @name: the name registered to request_irq()
498 * @busy: isr is actively processing replies on another cpu
501 struct adapter_reply_queue
{
502 struct MPT3SAS_ADAPTER
*ioc
;
505 u32 reply_post_host_index
;
506 Mpi2ReplyDescriptorsUnion_t
*reply_post_free
;
507 char name
[MPT_NAME_LENGTH
];
509 struct list_head list
;
512 typedef void (*MPT_ADD_SGE
)(void *paddr
, u32 flags_length
, dma_addr_t dma_addr
);
515 typedef int (*MPT_BUILD_SG_SCMD
)(struct MPT3SAS_ADAPTER
*ioc
,
516 struct scsi_cmnd
*scmd
, u16 smid
);
517 typedef void (*MPT_BUILD_SG
)(struct MPT3SAS_ADAPTER
*ioc
, void *psge
,
518 dma_addr_t data_out_dma
, size_t data_out_sz
,
519 dma_addr_t data_in_dma
, size_t data_in_sz
);
520 typedef void (*MPT_BUILD_ZERO_LEN_SGE
)(struct MPT3SAS_ADAPTER
*ioc
,
525 /* IOC Facts and Port Facts converted from little endian to cpu */
526 union mpi3_version_union
{
527 MPI2_VERSION_STRUCT Struct
;
531 struct mpt3sas_facts
{
547 union mpi3_version_union FWVersion
;
548 u16 IOCRequestFrameSize
;
555 u16 HighPriorityCredit
;
556 u16 MaxReplyDescriptorPostQueueDepth
;
560 u16 MaxPersistentEntries
;
564 struct mpt3sas_port_facts
{
569 u16 MaxPostedCmdBuffers
;
572 struct reply_post_struct
{
573 Mpi2ReplyDescriptorsUnion_t
*reply_post_free
;
574 dma_addr_t reply_post_free_dma
;
578 * enum mutex_type - task management mutex type
579 * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
580 * @TM_MUTEX_ON: mutex is required
587 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS
)(struct MPT3SAS_ADAPTER
*ioc
);
589 * struct MPT3SAS_ADAPTER - per adapter struct
591 * @shost: shost object
592 * @id: unique adapter id
593 * @cpu_count: number online cpus
594 * @name: generic ioc string
595 * @tmp_string: tmp string used for logging
596 * @pdev: pci pdev object
597 * @pio_chip: physical io register space
598 * @chip: memory mapped register space
599 * @chip_phys: physical addrss prior to mapping
600 * @logging_level: see mpt3sas_debug.h
601 * @fwfault_debug: debuging FW timeouts
602 * @ir_firmware: IR firmware present
603 * @bars: bitmask of BAR's that must be configured
604 * @mask_interrupts: ignore interrupt
605 * @dma_mask: used to set the consistent dma mask
606 * @fault_reset_work_q_name: fw fault work queue
607 * @fault_reset_work_q: ""
608 * @fault_reset_work: ""
609 * @firmware_event_name: fw event work queue
610 * @firmware_event_thread: ""
612 * @fw_event_list: list of fw events
613 * @aen_event_read_flag: event log was read
614 * @broadcast_aen_busy: broadcast aen waiting to be serviced
615 * @shost_recovery: host reset in progress
616 * @ioc_reset_in_progress_lock:
617 * @ioc_link_reset_in_progress: phy/hard reset in progress
618 * @ignore_loginfos: ignore loginfos during task management
619 * @remove_host: flag for when driver unloads, to avoid sending dev resets
620 * @pci_error_recovery: flag to prevent ioc access until slot reset completes
621 * @wait_for_discovery_to_complete: flag set at driver load time when
622 * waiting on reporting devices
623 * @is_driver_loading: flag set at driver load time
624 * @port_enable_failed: flag set when port enable has failed
625 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
626 * @start_scan_failed: means port enable failed, return's the ioc_status
627 * @msix_enable: flag indicating msix is enabled
628 * @msix_vector_count: number msix vectors
629 * @cpu_msix_table: table for mapping cpus to msix index
630 * @cpu_msix_table_sz: table size
631 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
632 * @scsi_io_cb_idx: shost generated commands
633 * @tm_cb_idx: task management commands
634 * @scsih_cb_idx: scsih internal commands
635 * @transport_cb_idx: transport internal commands
636 * @ctl_cb_idx: clt internal commands
637 * @base_cb_idx: base internal commands
638 * @config_cb_idx: base internal commands
639 * @tm_tr_cb_idx : device removal target reset handshake
640 * @tm_tr_volume_cb_idx : volume removal target reset
647 * @base_add_sg_single: handler for either 32/64 bit sgl's
648 * @event_type: bits indicating which events to log
649 * @event_context: unique id for each logged event
650 * @event_log: event log pointer
651 * @event_masks: events that are masked
652 * @facts: static facts data
653 * @pfacts: static port facts data
654 * @manu_pg0: static manufacturing page 0
655 * @manu_pg10: static manufacturing page 10
656 * @manu_pg11: static manufacturing page 11
657 * @bios_pg2: static bios page 2
658 * @bios_pg3: static bios page 3
659 * @ioc_pg8: static ioc page 8
660 * @iounit_pg0: static iounit page 0
661 * @iounit_pg1: static iounit page 1
662 * @sas_hba: sas host object
663 * @sas_expander_list: expander object list
665 * @sas_device_list: sas device object list
666 * @sas_device_init_list: sas device object list (used only at init time)
668 * @io_missing_delay: time for IO completed by fw when PDR enabled
669 * @device_missing_delay: time for device missing by fw when PDR enabled
670 * @sas_id : used for setting volume target IDs
671 * @blocking_handles: bitmask used to identify which devices need blocking
672 * @pd_handles : bitmask for PD handles
673 * @pd_handles_sz : size of pd_handle bitmask
674 * @config_page_sz: config page size
675 * @config_page: reserve memory for config page payload
677 * @hba_queue_depth: hba request queue depth
678 * @sge_size: sg element size for either 32/64 bit
679 * @scsiio_depth: SCSI_IO queue depth
680 * @request_sz: per request frame size
681 * @request: pool of request frames
684 * @scsi_lookup: firmware request tracker list
686 * @free_list: free list of request
689 * @chain: pool of chains
691 * @max_sges_in_main_message: number sg elements in main message
692 * @max_sges_in_chain_message: number sg elements per chain
693 * @chains_needed_per_io: max chains per io
694 * @chain_depth: total chains allocated
698 * @hi_priority_depth:
706 * @internal_free_list:
707 * @sense: pool of sense
710 * @reply_depth: hba reply queue depth:
711 * @reply_sz: per reply frame size:
712 * @reply: pool of replys:
715 * @reply_free_queue_depth: reply free depth
716 * @reply_free: pool for reply free queue (32 bit addr)
718 * @reply_free_dma_pool:
719 * @reply_free_host_index: tail index in pool to insert free replys
720 * @reply_post_queue_depth: reply post queue depth
721 * @reply_post_struct: struct for reply_post_free physical & virt address
722 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
723 * @rdpq_array_enable: rdpq_array support is enabled in the driver
724 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
725 * is assigned only ones
726 * @reply_queue_count: number of reply queue's
727 * @reply_queue_list: link list contaning the reply queue info
728 * @reply_post_host_index: head index in the pool where FW completes IO
729 * @delayed_tr_list: target reset link list
730 * @delayed_tr_volume_list: volume target reset link list
732 struct MPT3SAS_ADAPTER
{
733 struct list_head list
;
734 struct Scsi_Host
*shost
;
737 char name
[MPT_NAME_LENGTH
];
738 char tmp_string
[MPT_STRING_LENGTH
];
739 struct pci_dev
*pdev
;
740 Mpi2SystemInterfaceRegs_t __iomem
*chip
;
741 resource_size_t chip_phys
;
749 /* fw fault handler */
750 char fault_reset_work_q_name
[20];
751 struct workqueue_struct
*fault_reset_work_q
;
752 struct delayed_work fault_reset_work
;
754 /* fw event handler */
755 char firmware_event_name
[20];
756 struct workqueue_struct
*firmware_event_thread
;
757 spinlock_t fw_event_lock
;
758 struct list_head fw_event_list
;
761 int aen_event_read_flag
;
762 u8 broadcast_aen_busy
;
763 u16 broadcast_aen_pending
;
766 struct mutex reset_in_progress_mutex
;
767 spinlock_t ioc_reset_in_progress_lock
;
768 u8 ioc_link_reset_in_progress
;
769 u8 ioc_reset_in_progress_status
;
773 u8 pci_error_recovery
;
774 u8 wait_for_discovery_to_complete
;
775 u8 is_driver_loading
;
776 u8 port_enable_failed
;
778 u16 start_scan_failed
;
781 u16 msix_vector_count
;
783 u16 cpu_msix_table_sz
;
785 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds
;
787 /* internal commands, callback index */
794 u8 port_enable_cb_idx
;
797 u8 tm_tr_volume_cb_idx
;
798 u8 tm_sas_control_cb_idx
;
799 struct _internal_cmd base_cmds
;
800 struct _internal_cmd port_enable_cmds
;
801 struct _internal_cmd transport_cmds
;
802 struct _internal_cmd scsih_cmds
;
803 struct _internal_cmd tm_cmds
;
804 struct _internal_cmd ctl_cmds
;
805 struct _internal_cmd config_cmds
;
807 MPT_ADD_SGE base_add_sg_single
;
809 /* function ptr for either IEEE or MPI sg elements */
810 MPT_BUILD_SG_SCMD build_sg_scmd
;
811 MPT_BUILD_SG build_sg
;
812 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge
;
816 /* function ptr for MPI sg elements only */
817 MPT_BUILD_SG build_sg_mpi
;
818 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi
;
821 u32 event_type
[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS
];
824 u32 event_masks
[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS
];
826 /* static config pages */
827 struct mpt3sas_facts facts
;
828 struct mpt3sas_port_facts
*pfacts
;
829 Mpi2ManufacturingPage0_t manu_pg0
;
830 struct Mpi2ManufacturingPage10_t manu_pg10
;
831 struct Mpi2ManufacturingPage11_t manu_pg11
;
832 Mpi2BiosPage2_t bios_pg2
;
833 Mpi2BiosPage3_t bios_pg3
;
834 Mpi2IOCPage8_t ioc_pg8
;
835 Mpi2IOUnitPage0_t iounit_pg0
;
836 Mpi2IOUnitPage1_t iounit_pg1
;
838 struct _boot_device req_boot_device
;
839 struct _boot_device req_alt_boot_device
;
840 struct _boot_device current_boot_device
;
842 /* sas hba, expander, and device list */
843 struct _sas_node sas_hba
;
844 struct list_head sas_expander_list
;
845 spinlock_t sas_node_lock
;
846 struct list_head sas_device_list
;
847 struct list_head sas_device_init_list
;
848 spinlock_t sas_device_lock
;
849 struct list_head raid_device_list
;
850 spinlock_t raid_device_lock
;
852 u16 device_missing_delay
;
855 void *blocking_handles
;
862 dma_addr_t config_page_dma
;
870 dma_addr_t request_dma
;
872 struct scsiio_tracker
*scsi_lookup
;
873 ulong scsi_lookup_pages
;
874 spinlock_t scsi_lookup_lock
;
875 struct list_head free_list
;
876 int pending_io_count
;
877 wait_queue_head_t reset_wq
;
880 struct chain_tracker
*chain_lookup
;
881 struct list_head free_chain_list
;
882 struct dma_pool
*chain_dma_pool
;
884 u16 max_sges_in_main_message
;
885 u16 max_sges_in_chain_message
;
886 u16 chains_needed_per_io
;
889 /* hi-priority queue */
890 u16 hi_priority_smid
;
892 dma_addr_t hi_priority_dma
;
893 u16 hi_priority_depth
;
894 struct request_tracker
*hpr_lookup
;
895 struct list_head hpr_free_list
;
900 dma_addr_t internal_dma
;
902 struct request_tracker
*internal_lookup
;
903 struct list_head internal_free_list
;
907 dma_addr_t sense_dma
;
908 struct dma_pool
*sense_dma_pool
;
913 dma_addr_t reply_dma
;
914 u32 reply_dma_max_address
;
915 u32 reply_dma_min_address
;
916 struct dma_pool
*reply_dma_pool
;
918 /* reply free queue */
919 u16 reply_free_queue_depth
;
921 dma_addr_t reply_free_dma
;
922 struct dma_pool
*reply_free_dma_pool
;
923 u32 reply_free_host_index
;
925 /* reply post queue */
926 u16 reply_post_queue_depth
;
927 struct reply_post_struct
*reply_post
;
928 u8 rdpq_array_capable
;
929 u8 rdpq_array_enable
;
930 u8 rdpq_array_enable_assigned
;
931 struct dma_pool
*reply_post_free_dma_pool
;
932 u8 reply_queue_count
;
933 struct list_head reply_queue_list
;
935 struct list_head delayed_tr_list
;
936 struct list_head delayed_tr_volume_list
;
938 /* diag buffer support */
939 u8
*diag_buffer
[MPI2_DIAG_BUF_TYPE_COUNT
];
940 u32 diag_buffer_sz
[MPI2_DIAG_BUF_TYPE_COUNT
];
941 dma_addr_t diag_buffer_dma
[MPI2_DIAG_BUF_TYPE_COUNT
];
942 u8 diag_buffer_status
[MPI2_DIAG_BUF_TYPE_COUNT
];
943 u32 unique_id
[MPI2_DIAG_BUF_TYPE_COUNT
];
944 u32 product_specific
[MPI2_DIAG_BUF_TYPE_COUNT
][23];
945 u32 diagnostic_flags
[MPI2_DIAG_BUF_TYPE_COUNT
];
946 u32 ring_buffer_offset
;
948 spinlock_t diag_trigger_lock
;
949 u8 diag_trigger_active
;
950 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master
;
951 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event
;
952 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi
;
953 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi
;
956 typedef u8 (*MPT_CALLBACK
)(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
960 /* base shared API */
961 extern struct list_head mpt3sas_ioc_list
;
962 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER
*ioc
);
963 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER
*ioc
);
965 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER
*ioc
);
966 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER
*ioc
);
967 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER
*ioc
);
968 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER
*ioc
);
969 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int sleep_flag
,
970 enum reset_type type
);
972 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
973 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
974 __le32
mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER
*ioc
,
976 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER
*ioc
);
978 /* hi-priority queue */
979 u16
mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
);
980 u16
mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
,
981 struct scsi_cmnd
*scmd
);
983 u16
mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER
*ioc
, u8 cb_idx
);
984 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
985 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
987 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
989 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
990 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
);
991 void mpt3sas_base_initialize_callback_handler(void);
992 u8
mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func
);
993 void mpt3sas_base_release_callback_handler(u8 cb_idx
);
995 u8
mpt3sas_base_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
997 u8
mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
,
998 u8 msix_index
, u32 reply
);
999 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER
*ioc
,
1002 u32
mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER
*ioc
, int cooked
);
1004 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER
*ioc
, u16 fault_code
);
1005 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER
*ioc
,
1006 Mpi2SasIoUnitControlReply_t
*mpi_reply
,
1007 Mpi2SasIoUnitControlRequest_t
*mpi_request
);
1008 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER
*ioc
,
1009 Mpi2SepReply_t
*mpi_reply
, Mpi2SepRequest_t
*mpi_request
);
1011 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER
*ioc
,
1014 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER
*ioc
);
1016 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER
*ioc
,
1017 u16 device_missing_delay
, u8 io_missing_delay
);
1019 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER
*ioc
);
1022 /* scsih shared API */
1023 u8
mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER
*ioc
, u8 msix_index
,
1025 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int reset_phase
);
1027 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
,
1028 uint channel
, uint id
, uint lun
, u8 type
, u16 smid_task
,
1029 ulong timeout
, enum mutex_type m_type
);
1030 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
1031 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
1032 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1033 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER
*ioc
,
1036 struct _sas_node
*mpt3sas_scsih_expander_find_by_handle(
1037 struct MPT3SAS_ADAPTER
*ioc
, u16 handle
);
1038 struct _sas_node
*mpt3sas_scsih_expander_find_by_sas_address(
1039 struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1040 struct _sas_device
*mpt3sas_scsih_sas_device_find_by_sas_address(
1041 struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
);
1043 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER
*ioc
);
1045 /* config shared API */
1046 u8
mpt3sas_config_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1048 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER
*ioc
,
1050 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1051 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ManufacturingPage0_t
*config_page
);
1052 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER
*ioc
,
1053 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ManufacturingPage7_t
*config_page
,
1055 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER
*ioc
,
1056 Mpi2ConfigReply_t
*mpi_reply
,
1057 struct Mpi2ManufacturingPage10_t
*config_page
);
1059 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER
*ioc
,
1060 Mpi2ConfigReply_t
*mpi_reply
,
1061 struct Mpi2ManufacturingPage11_t
*config_page
);
1062 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER
*ioc
,
1063 Mpi2ConfigReply_t
*mpi_reply
,
1064 struct Mpi2ManufacturingPage11_t
*config_page
);
1066 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1067 *mpi_reply
, Mpi2BiosPage2_t
*config_page
);
1068 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1069 *mpi_reply
, Mpi2BiosPage3_t
*config_page
);
1070 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1071 *mpi_reply
, Mpi2IOUnitPage0_t
*config_page
);
1072 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1073 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasDevicePage0_t
*config_page
,
1074 u32 form
, u32 handle
);
1075 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1076 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasDevicePage1_t
*config_page
,
1077 u32 form
, u32 handle
);
1078 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1079 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage0_t
*config_page
,
1081 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1082 *mpi_reply
, Mpi2IOUnitPage1_t
*config_page
);
1083 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1084 *mpi_reply
, Mpi2IOUnitPage1_t
*config_page
);
1085 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1086 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage1_t
*config_page
,
1088 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1089 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasIOUnitPage1_t
*config_page
,
1091 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1092 *mpi_reply
, Mpi2IOCPage8_t
*config_page
);
1093 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1094 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ExpanderPage0_t
*config_page
,
1095 u32 form
, u32 handle
);
1096 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1097 Mpi2ConfigReply_t
*mpi_reply
, Mpi2ExpanderPage1_t
*config_page
,
1098 u32 phy_number
, u16 handle
);
1099 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1100 Mpi2ConfigReply_t
*mpi_reply
, Mpi2SasEnclosurePage0_t
*config_page
,
1101 u32 form
, u32 handle
);
1102 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1103 *mpi_reply
, Mpi2SasPhyPage0_t
*config_page
, u32 phy_number
);
1104 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER
*ioc
, Mpi2ConfigReply_t
1105 *mpi_reply
, Mpi2SasPhyPage1_t
*config_page
, u32 phy_number
);
1106 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER
*ioc
,
1107 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidVolPage1_t
*config_page
, u32 form
,
1109 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER
*ioc
, u16 handle
,
1111 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1112 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidVolPage0_t
*config_page
, u32 form
,
1113 u32 handle
, u16 sz
);
1114 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER
*ioc
,
1115 Mpi2ConfigReply_t
*mpi_reply
, Mpi2RaidPhysDiskPage0_t
*config_page
,
1116 u32 form
, u32 form_specific
);
1117 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER
*ioc
, u16 pd_handle
,
1118 u16
*volume_handle
);
1119 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER
*ioc
,
1120 u16 volume_handle
, u64
*wwid
);
1122 /* ctl shared API */
1123 extern struct device_attribute
*mpt3sas_host_attrs
[];
1124 extern struct device_attribute
*mpt3sas_dev_attrs
[];
1125 void mpt3sas_ctl_init(void);
1126 void mpt3sas_ctl_exit(void);
1127 u8
mpt3sas_ctl_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1129 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER
*ioc
, int reset_phase
);
1130 u8
mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER
*ioc
,
1131 u8 msix_index
, u32 reply
);
1132 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER
*ioc
,
1133 Mpi2EventNotificationReply_t
*mpi_reply
);
1135 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER
*ioc
,
1136 u8 bits_to_regsiter
);
1137 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER
*ioc
, u8 buffer_type
,
1140 /* transport shared API */
1141 u8
mpt3sas_transport_done(struct MPT3SAS_ADAPTER
*ioc
, u16 smid
, u8 msix_index
,
1143 struct _sas_port
*mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER
*ioc
,
1144 u16 handle
, u64 sas_address
);
1145 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER
*ioc
, u64 sas_address
,
1146 u64 sas_address_parent
);
1147 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER
*ioc
, struct _sas_phy
1148 *mpt3sas_phy
, Mpi2SasPhyPage0_t phy_pg0
, struct device
*parent_dev
);
1149 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER
*ioc
,
1150 struct _sas_phy
*mpt3sas_phy
, Mpi2ExpanderPage1_t expander_pg1
,
1151 struct device
*parent_dev
);
1152 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER
*ioc
,
1153 u64 sas_address
, u16 handle
, u8 phy_number
, u8 link_rate
);
1154 extern struct sas_function_template mpt3sas_transport_functions
;
1155 extern struct scsi_transport_template
*mpt3sas_transport_template
;
1156 extern int scsi_internal_device_block(struct scsi_device
*sdev
);
1157 extern int scsi_internal_device_unblock(struct scsi_device
*sdev
,
1158 enum scsi_device_state new_state
);
1159 /* trigger data externs */
1160 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER
*ioc
,
1161 struct SL_WH_TRIGGERS_EVENT_DATA_T
*event_data
);
1162 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER
*ioc
,
1163 struct SL_WH_TRIGGERS_EVENT_DATA_T
*event_data
);
1164 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER
*ioc
,
1165 u32 tigger_bitmask
);
1166 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER
*ioc
, u16 event
,
1167 u16 log_entry_qualifier
);
1168 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER
*ioc
, u8 sense_key
,
1170 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER
*ioc
, u16 ioc_status
,
1172 #endif /* MPT3SAS_BASE_H_INCLUDED */