[SCSI] mpt2sas: Hold Controller reset when another reset is in progress
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / mpt2sas / mpt2sas_base.h
blob6032cbf31c7ec6bc4153d7a4e3aac5d8d851387c
1 /*
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.
19 * NO WARRANTY
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,
42 * USA.
45 #ifndef MPT2SAS_BASE_H_INCLUDED
46 #define MPT2SAS_BASE_H_INCLUDED
48 #include "mpi/mpi2_type.h"
49 #include "mpi/mpi2.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 "05.100.00.03"
73 #define MPT2SAS_MAJOR_VERSION 05
74 #define MPT2SAS_MINOR_VERSION 100
75 #define MPT2SAS_BUILD_VERSION 00
76 #define MPT2SAS_RELEASE_VERSION 03
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
86 #else
87 #define MPT2SAS_SG_DEPTH CONFIG_SCSI_MPT2SAS_MAX_SGE
88 #endif
89 #else
90 #define MPT2SAS_SG_DEPTH 128 /* MAX_HW_SEGMENTS */
91 #endif
95 * Generic Defines
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
106 #define CAN_SLEEP 1
107 #define NO_SLEEP 0
109 #define INTERNAL_CMDS_COUNT 10 /* reserved cmds */
111 #define MPI2_HIM_MASK 0xFFFFFFFF /* mask every bit*/
113 #define MPT2SAS_INVALID_DEVICE_HANDLE 0xFFFF
117 * reset phases
119 #define MPT2_IOC_PRE_RESET 1 /* prior to host reset */
120 #define MPT2_IOC_AFTER_RESET 2 /* just after host reset */
121 #define MPT2_IOC_DONE_RESET 3 /* links re-initialized */
124 * logging format
126 #define MPT2SAS_FMT "%s: "
127 #define MPT2SAS_DEBUG_FMT KERN_DEBUG MPT2SAS_FMT
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
134 * Dell HBA branding
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"
147 * Dell HBA SSDIDs
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
158 * per target private data
160 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
161 #define MPT_TARGET_FLAGS_VOLUME 0x02
162 #define MPT_TARGET_FLAGS_DELETED 0x04
165 * struct MPT2SAS_TARGET - starget private hostdata
166 * @starget: starget object
167 * @sas_address: target sas address
168 * @handle: device handle
169 * @num_luns: number luns
170 * @flags: MPT_TARGET_FLAGS_XXX flags
171 * @deleted: target flaged for deletion
172 * @tm_busy: target is busy with TM request.
174 struct MPT2SAS_TARGET {
175 struct scsi_target *starget;
176 u64 sas_address;
177 u16 handle;
178 int num_luns;
179 u32 flags;
180 u8 deleted;
181 u8 tm_busy;
185 * per device private data
187 #define MPT_DEVICE_FLAGS_INIT 0x01
188 #define MPT_DEVICE_TLR_ON 0x02
191 * struct MPT2SAS_DEVICE - sdev private hostdata
192 * @sas_target: starget private hostdata
193 * @lun: lun number
194 * @flags: MPT_DEVICE_XXX flags
195 * @configured_lun: lun is configured
196 * @block: device is in SDEV_BLOCK state
197 * @tlr_snoop_check: flag used in determining whether to disable TLR
200 /* OEM Identifiers */
201 #define MFG10_OEM_ID_INVALID (0x00000000)
202 #define MFG10_OEM_ID_DELL (0x00000001)
203 #define MFG10_OEM_ID_FSC (0x00000002)
204 #define MFG10_OEM_ID_SUN (0x00000003)
205 #define MFG10_OEM_ID_IBM (0x00000004)
207 /* GENERIC Flags 0*/
208 #define MFG10_GF0_OCE_DISABLED (0x00000001)
209 #define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)
210 #define MFG10_GF0_R10_DISPLAY (0x00000004)
211 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)
212 #define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)
214 /* OEM Specific Flags will come from OEM specific header files */
215 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
216 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */
217 U8 OEMIdentifier; /* 04h */
218 U8 Reserved1; /* 05h */
219 U16 Reserved2; /* 08h */
220 U32 Reserved3; /* 0Ch */
221 U32 GenericFlags0; /* 10h */
222 U32 GenericFlags1; /* 14h */
223 U32 Reserved4; /* 18h */
224 U32 OEMSpecificFlags0; /* 1Ch */
225 U32 OEMSpecificFlags1; /* 20h */
226 U32 Reserved5[18]; /* 24h-60h*/
227 } MPI2_CONFIG_PAGE_MAN_10,
228 MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
229 Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
231 struct MPT2SAS_DEVICE {
232 struct MPT2SAS_TARGET *sas_target;
233 unsigned int lun;
234 u32 flags;
235 u8 configured_lun;
236 u8 block;
237 u8 tlr_snoop_check;
240 #define MPT2_CMD_NOT_USED 0x8000 /* free */
241 #define MPT2_CMD_COMPLETE 0x0001 /* completed */
242 #define MPT2_CMD_PENDING 0x0002 /* pending */
243 #define MPT2_CMD_REPLY_VALID 0x0004 /* reply is valid */
244 #define MPT2_CMD_RESET 0x0008 /* host reset dropped the command */
247 * struct _internal_cmd - internal commands struct
248 * @mutex: mutex
249 * @done: completion
250 * @reply: reply message pointer
251 * @status: MPT2_CMD_XXX status
252 * @smid: system message id
254 struct _internal_cmd {
255 struct mutex mutex;
256 struct completion done;
257 void *reply;
258 u16 status;
259 u16 smid;
264 * struct _sas_device - attached device information
265 * @list: sas device list
266 * @starget: starget object
267 * @sas_address: device sas address
268 * @device_name: retrieved from the SAS IDENTIFY frame.
269 * @handle: device handle
270 * @sas_address_parent: sas address of parent expander or sas host
271 * @enclosure_handle: enclosure handle
272 * @enclosure_logical_id: enclosure logical identifier
273 * @volume_handle: volume handle (valid when hidden raid member)
274 * @volume_wwid: volume unique identifier
275 * @device_info: bitfield provides detailed info about the device
276 * @id: target id
277 * @channel: target channel
278 * @slot: number number
279 * @hidden_raid_component: set to 1 when this is a raid member
280 * @responding: used in _scsih_sas_device_mark_responding
282 struct _sas_device {
283 struct list_head list;
284 struct scsi_target *starget;
285 u64 sas_address;
286 u64 device_name;
287 u16 handle;
288 u64 sas_address_parent;
289 u16 enclosure_handle;
290 u64 enclosure_logical_id;
291 u16 volume_handle;
292 u64 volume_wwid;
293 u32 device_info;
294 int id;
295 int channel;
296 u16 slot;
297 u8 hidden_raid_component;
298 u8 responding;
302 * struct _raid_device - raid volume link list
303 * @list: sas device list
304 * @starget: starget object
305 * @sdev: scsi device struct (volumes are single lun)
306 * @wwid: unique identifier for the volume
307 * @handle: device handle
308 * @id: target id
309 * @channel: target channel
310 * @volume_type: the raid level
311 * @device_info: bitfield provides detailed info about the hidden components
312 * @num_pds: number of hidden raid components
313 * @responding: used in _scsih_raid_device_mark_responding
314 * @percent_complete: resync percent complete
316 struct _raid_device {
317 struct list_head list;
318 struct scsi_target *starget;
319 struct scsi_device *sdev;
320 u64 wwid;
321 u16 handle;
322 int id;
323 int channel;
324 u8 volume_type;
325 u32 device_info;
326 u8 num_pds;
327 u8 responding;
328 u8 percent_complete;
332 * struct _boot_device - boot device info
333 * @is_raid: flag to indicate whether this is volume
334 * @device: holds pointer for either struct _sas_device or
335 * struct _raid_device
337 struct _boot_device {
338 u8 is_raid;
339 void *device;
343 * struct _sas_port - wide/narrow sas port information
344 * @port_list: list of ports belonging to expander
345 * @num_phys: number of phys belonging to this port
346 * @remote_identify: attached device identification
347 * @rphy: sas transport rphy object
348 * @port: sas transport wide/narrow port object
349 * @phy_list: _sas_phy list objects belonging to this port
351 struct _sas_port {
352 struct list_head port_list;
353 u8 num_phys;
354 struct sas_identify remote_identify;
355 struct sas_rphy *rphy;
356 struct sas_port *port;
357 struct list_head phy_list;
361 * struct _sas_phy - phy information
362 * @port_siblings: list of phys belonging to a port
363 * @identify: phy identification
364 * @remote_identify: attached device identification
365 * @phy: sas transport phy object
366 * @phy_id: unique phy id
367 * @handle: device handle for this phy
368 * @attached_handle: device handle for attached device
369 * @phy_belongs_to_port: port has been created for this phy
371 struct _sas_phy {
372 struct list_head port_siblings;
373 struct sas_identify identify;
374 struct sas_identify remote_identify;
375 struct sas_phy *phy;
376 u8 phy_id;
377 u16 handle;
378 u16 attached_handle;
379 u8 phy_belongs_to_port;
383 * struct _sas_node - sas_host/expander information
384 * @list: list of expanders
385 * @parent_dev: parent device class
386 * @num_phys: number phys belonging to this sas_host/expander
387 * @sas_address: sas address of this sas_host/expander
388 * @handle: handle for this sas_host/expander
389 * @sas_address_parent: sas address of parent expander or sas host
390 * @enclosure_handle: handle for this a member of an enclosure
391 * @device_info: bitwise defining capabilities of this sas_host/expander
392 * @responding: used in _scsih_expander_device_mark_responding
393 * @phy: a list of phys that make up this sas_host/expander
394 * @sas_port_list: list of ports attached to this sas_host/expander
396 struct _sas_node {
397 struct list_head list;
398 struct device *parent_dev;
399 u8 num_phys;
400 u64 sas_address;
401 u16 handle;
402 u64 sas_address_parent;
403 u16 enclosure_handle;
404 u64 enclosure_logical_id;
405 u8 responding;
406 struct _sas_phy *phy;
407 struct list_head sas_port_list;
411 * enum reset_type - reset state
412 * @FORCE_BIG_HAMMER: issue diagnostic reset
413 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
415 enum reset_type {
416 FORCE_BIG_HAMMER,
417 SOFT_RESET,
421 * struct request_tracker - firmware request tracker
422 * @smid: system message id
423 * @scmd: scsi request pointer
424 * @cb_idx: callback index
425 * @chain_list: list of chains associated to this IO
426 * @tracker_list: list of free request (ioc->free_list)
428 struct request_tracker {
429 u16 smid;
430 struct scsi_cmnd *scmd;
431 u8 cb_idx;
432 struct list_head tracker_list;
436 * struct _tr_list - target reset list
437 * @handle: device handle
438 * @state: state machine
440 struct _tr_list {
441 struct list_head list;
442 u16 handle;
443 u16 state;
446 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
449 * struct MPT2SAS_ADAPTER - per adapter struct
450 * @list: ioc_list
451 * @shost: shost object
452 * @id: unique adapter id
453 * @pci_irq: irq number
454 * @name: generic ioc string
455 * @tmp_string: tmp string used for logging
456 * @pdev: pci pdev object
457 * @chip: memory mapped register space
458 * @chip_phys: physical addrss prior to mapping
459 * @logging_level: see mpt2sas_debug.h
460 * @fwfault_debug: debuging FW timeouts
461 * @ir_firmware: IR firmware present
462 * @bars: bitmask of BAR's that must be configured
463 * @mask_interrupts: ignore interrupt
464 * @fault_reset_work_q_name: fw fault work queue
465 * @fault_reset_work_q: ""
466 * @fault_reset_work: ""
467 * @firmware_event_name: fw event work queue
468 * @firmware_event_thread: ""
469 * @fw_events_off: flag to turn off fw event handling
470 * @fw_event_lock:
471 * @fw_event_list: list of fw events
472 * @aen_event_read_flag: event log was read
473 * @broadcast_aen_busy: broadcast aen waiting to be serviced
474 * @shost_recovery: host reset in progress
475 * @ioc_reset_in_progress_lock:
476 * @ioc_link_reset_in_progress: phy/hard reset in progress
477 * @ignore_loginfos: ignore loginfos during task managment
478 * @remove_host: flag for when driver unloads, to avoid sending dev resets
479 * @wait_for_port_enable_to_complete:
480 * @msix_enable: flag indicating msix is enabled
481 * @msix_vector_count: number msix vectors
482 * @msix_table: virt address to the msix table
483 * @msix_table_backup: backup msix table
484 * @scsi_io_cb_idx: shost generated commands
485 * @tm_cb_idx: task management commands
486 * @scsih_cb_idx: scsih internal commands
487 * @transport_cb_idx: transport internal commands
488 * @ctl_cb_idx: clt internal commands
489 * @base_cb_idx: base internal commands
490 * @config_cb_idx: base internal commands
491 * @base_cmds:
492 * @transport_cmds:
493 * @scsih_cmds:
494 * @tm_cmds:
495 * @ctl_cmds:
496 * @config_cmds:
497 * @base_add_sg_single: handler for either 32/64 bit sgl's
498 * @event_type: bits indicating which events to log
499 * @event_context: unique id for each logged event
500 * @event_log: event log pointer
501 * @event_masks: events that are masked
502 * @facts: static facts data
503 * @pfacts: static port facts data
504 * @manu_pg0: static manufacturing page 0
505 * @manu_pg10: static manufacturing page 10
506 * @bios_pg2: static bios page 2
507 * @bios_pg3: static bios page 3
508 * @ioc_pg8: static ioc page 8
509 * @iounit_pg0: static iounit page 0
510 * @iounit_pg1: static iounit page 1
511 * @sas_hba: sas host object
512 * @sas_expander_list: expander object list
513 * @sas_node_lock:
514 * @sas_device_list: sas device object list
515 * @sas_device_init_list: sas device object list (used only at init time)
516 * @sas_device_lock:
517 * @io_missing_delay: time for IO completed by fw when PDR enabled
518 * @device_missing_delay: time for device missing by fw when PDR enabled
519 * @config_page_sz: config page size
520 * @config_page: reserve memory for config page payload
521 * @config_page_dma:
522 * @hba_queue_depth: hba request queue depth
523 * @sge_size: sg element size for either 32/64 bit
524 * @scsiio_depth: SCSI_IO queue depth
525 * @request_sz: per request frame size
526 * @request: pool of request frames
527 * @request_dma:
528 * @request_dma_sz:
529 * @scsi_lookup: firmware request tracker list
530 * @scsi_lookup_lock:
531 * @free_list: free list of request
532 * @chain: pool of chains
533 * @pending_io_count:
534 * @reset_wq:
535 * @chain_dma:
536 * @max_sges_in_main_message: number sg elements in main message
537 * @max_sges_in_chain_message: number sg elements per chain
538 * @chains_needed_per_io: max chains per io
539 * @chain_offset_value_for_main_message: location 1st sg in main
540 * @chain_depth: total chains allocated
541 * @hi_priority_smid:
542 * @hi_priority:
543 * @hi_priority_dma:
544 * @hi_priority_depth:
545 * @hpr_lookup:
546 * @hpr_free_list:
547 * @internal_smid:
548 * @internal:
549 * @internal_dma:
550 * @internal_depth:
551 * @internal_lookup:
552 * @internal_free_list:
553 * @sense: pool of sense
554 * @sense_dma:
555 * @sense_dma_pool:
556 * @reply_depth: hba reply queue depth:
557 * @reply_sz: per reply frame size:
558 * @reply: pool of replys:
559 * @reply_dma:
560 * @reply_dma_pool:
561 * @reply_free_queue_depth: reply free depth
562 * @reply_free: pool for reply free queue (32 bit addr)
563 * @reply_free_dma:
564 * @reply_free_dma_pool:
565 * @reply_free_host_index: tail index in pool to insert free replys
566 * @reply_post_queue_depth: reply post queue depth
567 * @reply_post_free: pool for reply post (64bit descriptor)
568 * @reply_post_free_dma:
569 * @reply_post_free_dma_pool:
570 * @reply_post_host_index: head index in the pool where FW completes IO
572 struct MPT2SAS_ADAPTER {
573 struct list_head list;
574 struct Scsi_Host *shost;
575 u8 id;
576 u32 pci_irq;
577 char name[MPT_NAME_LENGTH];
578 char tmp_string[MPT_STRING_LENGTH];
579 struct pci_dev *pdev;
580 Mpi2SystemInterfaceRegs_t __iomem *chip;
581 resource_size_t chip_phys;
582 int logging_level;
583 int fwfault_debug;
584 u8 ir_firmware;
585 int bars;
586 u8 mask_interrupts;
588 /* fw fault handler */
589 char fault_reset_work_q_name[20];
590 struct workqueue_struct *fault_reset_work_q;
591 struct delayed_work fault_reset_work;
593 /* fw event handler */
594 char firmware_event_name[20];
595 struct workqueue_struct *firmware_event_thread;
596 spinlock_t fw_event_lock;
597 struct list_head fw_event_list;
599 /* misc flags */
600 int aen_event_read_flag;
601 u8 broadcast_aen_busy;
602 u8 shost_recovery;
604 struct mutex reset_in_progress_mutex;
605 struct completion shost_recovery_done;
606 spinlock_t ioc_reset_in_progress_lock;
607 u8 ioc_link_reset_in_progress;
608 int ioc_reset_in_progress_status;
610 u8 ignore_loginfos;
611 u8 remove_host;
612 u8 wait_for_port_enable_to_complete;
614 u8 msix_enable;
615 u16 msix_vector_count;
616 u32 *msix_table;
617 u32 *msix_table_backup;
619 /* internal commands, callback index */
620 u8 scsi_io_cb_idx;
621 u8 tm_cb_idx;
622 u8 transport_cb_idx;
623 u8 scsih_cb_idx;
624 u8 ctl_cb_idx;
625 u8 base_cb_idx;
626 u8 config_cb_idx;
627 u8 tm_tr_cb_idx;
628 u8 tm_sas_control_cb_idx;
629 struct _internal_cmd base_cmds;
630 struct _internal_cmd transport_cmds;
631 struct _internal_cmd scsih_cmds;
632 struct _internal_cmd tm_cmds;
633 struct _internal_cmd ctl_cmds;
634 struct _internal_cmd config_cmds;
636 MPT_ADD_SGE base_add_sg_single;
638 /* event log */
639 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
640 u32 event_context;
641 void *event_log;
642 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
644 /* static config pages */
645 Mpi2IOCFactsReply_t facts;
646 Mpi2PortFactsReply_t *pfacts;
647 Mpi2ManufacturingPage0_t manu_pg0;
648 Mpi2BiosPage2_t bios_pg2;
649 Mpi2BiosPage3_t bios_pg3;
650 Mpi2IOCPage8_t ioc_pg8;
651 Mpi2IOUnitPage0_t iounit_pg0;
652 Mpi2IOUnitPage1_t iounit_pg1;
654 struct _boot_device req_boot_device;
655 struct _boot_device req_alt_boot_device;
656 struct _boot_device current_boot_device;
658 /* sas hba, expander, and device list */
659 struct _sas_node sas_hba;
660 struct list_head sas_expander_list;
661 spinlock_t sas_node_lock;
662 struct list_head sas_device_list;
663 struct list_head sas_device_init_list;
664 spinlock_t sas_device_lock;
665 struct list_head raid_device_list;
666 spinlock_t raid_device_lock;
667 u8 io_missing_delay;
668 u16 device_missing_delay;
669 int sas_id;
671 /* config page */
672 u16 config_page_sz;
673 void *config_page;
674 dma_addr_t config_page_dma;
676 /* scsiio request */
677 u16 hba_queue_depth;
678 u16 sge_size;
679 u16 scsiio_depth;
680 u16 request_sz;
681 u8 *request;
682 dma_addr_t request_dma;
683 u32 request_dma_sz;
684 struct request_tracker *scsi_lookup;
685 ulong scsi_lookup_pages;
686 spinlock_t scsi_lookup_lock;
687 struct list_head free_list;
688 int pending_io_count;
689 wait_queue_head_t reset_wq;
691 /* chain */
692 u8 *chain;
693 dma_addr_t chain_dma;
694 u16 max_sges_in_main_message;
695 u16 max_sges_in_chain_message;
696 u16 chains_needed_per_io;
697 u16 chain_offset_value_for_main_message;
698 u32 chain_depth;
700 /* hi-priority queue */
701 u16 hi_priority_smid;
702 u8 *hi_priority;
703 dma_addr_t hi_priority_dma;
704 u16 hi_priority_depth;
705 struct request_tracker *hpr_lookup;
706 struct list_head hpr_free_list;
708 /* internal queue */
709 u16 internal_smid;
710 u8 *internal;
711 dma_addr_t internal_dma;
712 u16 internal_depth;
713 struct request_tracker *internal_lookup;
714 struct list_head internal_free_list;
716 /* sense */
717 u8 *sense;
718 dma_addr_t sense_dma;
719 struct dma_pool *sense_dma_pool;
721 /* reply */
722 u16 reply_sz;
723 u8 *reply;
724 dma_addr_t reply_dma;
725 struct dma_pool *reply_dma_pool;
727 /* reply free queue */
728 u16 reply_free_queue_depth;
729 u32 *reply_free;
730 dma_addr_t reply_free_dma;
731 struct dma_pool *reply_free_dma_pool;
732 u32 reply_free_host_index;
734 /* reply post queue */
735 u16 reply_post_queue_depth;
736 Mpi2ReplyDescriptorsUnion_t *reply_post_free;
737 dma_addr_t reply_post_free_dma;
738 struct dma_pool *reply_post_free_dma_pool;
739 u32 reply_post_host_index;
741 struct list_head delayed_tr_list;
743 /* diag buffer support */
744 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
745 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
746 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
747 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
748 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
749 Mpi2ManufacturingPage10_t manu_pg10;
750 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
751 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
754 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
755 u32 reply);
758 /* base shared API */
759 extern struct list_head mpt2sas_ioc_list;
760 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
761 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
763 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
764 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
765 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
766 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
767 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
768 enum reset_type type);
770 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
771 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
772 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
773 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
774 u16 smid);
776 /* hi-priority queue */
777 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
778 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
779 struct scsi_cmnd *scmd);
781 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
782 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
783 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
784 u16 handle);
785 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
786 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
787 u16 io_index);
788 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
789 void mpt2sas_base_initialize_callback_handler(void);
790 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
791 void mpt2sas_base_release_callback_handler(u8 cb_idx);
793 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
794 u32 reply);
795 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
797 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
799 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
800 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
801 Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
802 *mpi_request);
803 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
804 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
805 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
807 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
809 /* scsih shared API */
810 u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
811 u32 reply);
812 int mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle,
813 uint channel, uint id, uint lun, u8 type, u16 smid_task,
814 ulong timeout, struct scsi_cmnd *scmd);
815 void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
816 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
817 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
818 u16 handle);
819 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
820 *ioc, u64 sas_address);
821 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
822 struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
824 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
826 /* config shared API */
827 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
828 u32 reply);
829 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
830 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
831 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
832 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
833 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
834 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
835 *mpi_reply, Mpi2BiosPage2_t *config_page);
836 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
837 *mpi_reply, Mpi2BiosPage3_t *config_page);
838 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
839 *mpi_reply, Mpi2IOUnitPage0_t *config_page);
840 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
841 *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
842 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
843 *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
844 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
845 *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
846 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
847 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
848 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
849 *mpi_reply, Mpi2IOUnitPage1_t *config_page);
850 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
851 *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
852 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
853 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
854 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
855 *mpi_reply, Mpi2IOCPage8_t *config_page);
856 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
857 *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
858 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
859 *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
860 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
861 *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
862 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
863 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
864 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
865 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
866 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
867 *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
868 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
869 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
870 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
871 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
872 *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
873 u32 form_specific);
874 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
875 u16 *volume_handle);
876 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
877 u64 *wwid);
878 /* ctl shared API */
879 extern struct device_attribute *mpt2sas_host_attrs[];
880 extern struct device_attribute *mpt2sas_dev_attrs[];
881 void mpt2sas_ctl_init(void);
882 void mpt2sas_ctl_exit(void);
883 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
884 u32 reply);
885 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
886 u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
887 u32 reply);
888 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
889 Mpi2EventNotificationReply_t *mpi_reply);
891 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
892 u8 bits_to_regsiter);
894 /* transport shared API */
895 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
896 u32 reply);
897 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
898 u16 handle, u64 sas_address);
899 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
900 u64 sas_address_parent);
901 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
902 *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
903 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
904 *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
905 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
906 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
907 extern struct sas_function_template mpt2sas_transport_functions;
908 extern struct scsi_transport_template *mpt2sas_transport_template;
909 extern int scsi_internal_device_block(struct scsi_device *sdev);
910 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
911 u8 msix_index, u32 reply);
912 extern int scsi_internal_device_unblock(struct scsi_device *sdev);
914 #endif /* MPT2SAS_BASE_H_INCLUDED */