2 * linux/drivers/message/fusion/mptbase.h
3 * High performance SCSI + LAN / Fibre Channel device drivers.
4 * For use with PCI chip/adapter(s):
5 * LSIFC9xx/LSI409xx Fibre Channel
6 * running LSI Fusion MPT (Message Passing Technology) firmware.
8 * Copyright (c) 1999-2008 LSI Corporation
9 * (mailto:DL-MPTFusionLinux@lsi.com)
12 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; version 2 of the License.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
24 THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
25 CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
26 LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
27 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
28 solely responsible for determining the appropriateness of using and
29 distributing the Program and assumes all risks associated with its
30 exercise of rights under this Agreement, including but not limited to
31 the risks and costs of program errors, damage to or loss of data,
32 programs or equipment, and unavailability or interruption of operations.
34 DISCLAIMER OF LIABILITY
35 NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
36 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
38 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
39 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
40 USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
41 HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
43 You should have received a copy of the GNU General Public License
44 along with this program; if not, write to the Free Software
45 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
48 #ifndef MPTBASE_H_INCLUDED
49 #define MPTBASE_H_INCLUDED
50 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
52 #include <linux/kernel.h>
53 #include <linux/pci.h>
54 #include <linux/mutex.h>
56 #include "lsi/mpi_type.h"
57 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
58 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
59 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
60 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
61 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
62 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
64 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
65 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
66 #include "lsi/mpi_tool.h" /* Tools support */
67 #include "lsi/mpi_sas.h" /* SAS support */
69 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
72 #define MODULEAUTHOR "LSI Corporation"
76 #define COPYRIGHT "Copyright (c) 1999-2008 " MODULEAUTHOR
79 #define MPT_LINUX_VERSION_COMMON "3.04.10"
80 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.04.09"
81 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
83 #define show_mptmod_ver(s,ver) \
84 printk(KERN_INFO "%s %s\n", s, ver);
86 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
88 * Fusion MPT(linux) driver configurable stuff...
90 #define MPT_MAX_ADAPTERS 18
91 #define MPT_MAX_PROTOCOL_DRIVERS 16
92 #define MPT_MAX_BUS 1 /* Do not change */
93 #define MPT_MAX_FC_DEVICES 255
94 #define MPT_MAX_SCSI_DEVICES 16
95 #define MPT_LAST_LUN 255
96 #define MPT_SENSE_BUFFER_ALLOC 64
97 /* allow for 256 max sense alloc, but only 255 max request */
98 #if MPT_SENSE_BUFFER_ALLOC >= 256
99 # undef MPT_SENSE_BUFFER_ALLOC
100 # define MPT_SENSE_BUFFER_ALLOC 256
101 # define MPT_SENSE_BUFFER_SIZE 255
103 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
106 #define MPT_NAME_LENGTH 32
107 #define MPT_KOBJ_NAME_LEN 20
109 #define MPT_PROCFS_MPTBASEDIR "mpt"
110 /* chg it to "driver/fusion" ? */
111 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
112 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
113 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
115 #define MPT_MAX_REQ_DEPTH 1023
116 #define MPT_DEFAULT_REQ_DEPTH 256
117 #define MPT_MIN_REQ_DEPTH 128
119 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
120 #define MPT_DEFAULT_REPLY_DEPTH 128
121 #define MPT_MIN_REPLY_DEPTH 8
122 #define MPT_MAX_REPLIES_PER_ISR 32
124 #define MPT_MAX_FRAME_SIZE 128
125 #define MPT_DEFAULT_FRAME_SIZE 128
127 #define MPT_REPLY_FRAME_SIZE 0x50 /* Must be a multiple of 8 */
129 #define MPT_SG_REQ_128_SCALE 1
130 #define MPT_SG_REQ_96_SCALE 2
131 #define MPT_SG_REQ_64_SCALE 4
136 #define MPT_COALESCING_TIMEOUT 0x10
140 * SCSI transfer rate defines.
142 #define MPT_ULTRA320 0x08
143 #define MPT_ULTRA160 0x09
144 #define MPT_ULTRA2 0x0A
145 #define MPT_ULTRA 0x0C
146 #define MPT_FAST 0x19
147 #define MPT_SCSI 0x32
148 #define MPT_ASYNC 0xFF
158 * Try to keep these at 2^N-1
160 #define MPT_FC_CAN_QUEUE 127
161 #define MPT_SCSI_CAN_QUEUE 127
164 * Set the MAX_SGE value based on user input.
166 #ifdef CONFIG_FUSION_MAX_SGE
167 #if CONFIG_FUSION_MAX_SGE < 16
168 #define MPT_SCSI_SG_DEPTH 16
169 #elif CONFIG_FUSION_MAX_SGE > 128
170 #define MPT_SCSI_SG_DEPTH 128
172 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
175 #define MPT_SCSI_SG_DEPTH 40
178 #ifdef CONFIG_FUSION_MAX_FC_SGE
179 #if CONFIG_FUSION_MAX_FC_SGE < 16
180 #define MPT_SCSI_FC_SG_DEPTH 16
181 #elif CONFIG_FUSION_MAX_FC_SGE > 256
182 #define MPT_SCSI_FC_SG_DEPTH 256
184 #define MPT_SCSI_FC_SG_DEPTH CONFIG_FUSION_MAX_FC_SGE
187 #define MPT_SCSI_FC_SG_DEPTH 40
190 /* debug print string length used for events and iocstatus */
191 # define EVENT_DESCR_STR_SZ 100
193 #define MPT_POLLING_INTERVAL 1000 /* in milliseconds */
195 #ifdef __KERNEL__ /* { */
196 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
198 #include <linux/proc_fs.h>
200 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
202 * Attempt semi-consistent error & warning msgs across
203 * MPT drivers. NOTE: Users of these macro defs must
204 * themselves define their own MYNAM.
206 #define MYIOC_s_FMT MYNAM ": %s: "
207 #define MYIOC_s_DEBUG_FMT KERN_DEBUG MYNAM ": %s: "
208 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
209 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
210 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
211 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
213 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
215 * ATTO UL4D associated structures and defines
217 #define ATTOFLAG_DISC 0x0001
218 #define ATTOFLAG_TAGGED 0x0002
219 #define ATTOFLAG_WIDE_ENB 0x0008
220 #define ATTOFLAG_ID_ENB 0x0010
221 #define ATTOFLAG_LUN_ENB 0x0060
223 typedef struct _ATTO_DEVICE_INFO
227 u16 ATTOFlags; /* 02h */
228 } ATTO_DEVICE_INFO, MPI_POINTER PTR_ATTO_DEVICE_INFO,
229 ATTODeviceInfo_t, MPI_POINTER pATTODeviceInfo_t;
231 typedef struct _ATTO_CONFIG_PAGE_SCSI_PORT_2
233 CONFIG_PAGE_HEADER Header; /* 00h */
234 u16 PortFlags; /* 04h */
235 u16 Unused1; /* 06h */
236 u32 Unused2; /* 08h */
237 ATTO_DEVICE_INFO DeviceSettings[16]; /* 0Ch */
238 } fATTO_CONFIG_PAGE_SCSI_PORT_2, MPI_POINTER PTR_ATTO_CONFIG_PAGE_SCSI_PORT_2,
239 ATTO_SCSIPortPage2_t, MPI_POINTER pATTO_SCSIPortPage2_t;
242 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
244 * MPT protocol driver defs...
247 MPTBASE_DRIVER, /* MPT base class */
248 MPTCTL_DRIVER, /* MPT ioctl class */
249 MPTSPI_DRIVER, /* MPT SPI host class */
250 MPTFC_DRIVER, /* MPT FC host class */
251 MPTSAS_DRIVER, /* MPT SAS host class */
252 MPTLAN_DRIVER, /* MPT LAN class */
253 MPTSTM_DRIVER, /* MPT SCSI target mode class */
257 struct mpt_pci_driver{
258 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
259 void (*remove) (struct pci_dev *dev);
263 * MPT adapter / port / bus / device info structures...
266 typedef union _MPT_FRAME_TRACKER {
268 struct list_head list;
274 * NOTE: When request frames are free, on the linkage structure
275 * contets are valid. All other values are invalid.
276 * In particular, do NOT reply on offset [2]
277 * (in words) being the * message context.
278 * The message context must be reset (computed via base address
279 * + an offset) prior to issuing any command.
281 * NOTE2: On non-32-bit systems, where pointers are LARGE,
282 * using the linkage pointers destroys our sacred MsgContext
283 * field contents. But we don't care anymore because these
284 * are now reset in mpt_put_msg_frame() just prior to sending
285 * a request off to the IOC.
290 * The following _MUST_ match the location of the
291 * MsgContext field in the MPT message headers.
296 u16 req_idx; /* Request index */
297 u8 cb_idx; /* callback function index */
303 * Remark: 32 bit identifier:
305 * 23-16: call back index
306 * 15-0 : request index
311 * We might want to view/access a frame as:
312 * 1) generic request header
318 typedef struct _MPT_FRAME_HDR {
321 SCSIIORequest_t scsireq;
322 SCSIIOReply_t sreply;
323 ConfigReply_t configreply;
324 MPIDefaultReply_t reply;
325 MPT_FRAME_TRACKER frame;
329 #define MPT_REQ_MSGFLAGS_DROPME 0x80
331 typedef struct _MPT_SGL_HDR {
332 SGESimple32_t sge[1];
335 typedef struct _MPT_SGL64_HDR {
336 SGESimple64_t sge[1];
340 * System interface register set
343 typedef struct _SYSIF_REGS
345 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
346 u32 WriteSequence; /* 04 Write Sequence register */
347 u32 Diagnostic; /* 08 Diagnostic register */
348 u32 TestBase; /* 0C Test Base Address */
349 u32 DiagRwData; /* 10 Read Write Data (fw download) */
350 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
351 u32 Reserved1[6]; /* 18-2F reserved for future use */
352 u32 IntStatus; /* 30 Interrupt Status */
353 u32 IntMask; /* 34 Interrupt Mask */
354 u32 Reserved2[2]; /* 38-3F reserved for future use */
355 u32 RequestFifo; /* 40 Request Post/Free FIFO */
356 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
357 u32 RequestHiPriFifo; /* 48 Hi Priority Request FIFO */
358 u32 Reserved3; /* 4C-4F reserved for future use */
359 u32 HostIndex; /* 50 Host Index register */
360 u32 Reserved4[15]; /* 54-8F */
361 u32 Fubar; /* 90 For Fubar usage */
362 u32 Reserved5[1050];/* 94-10F8 */
363 u32 Reset_1078; /* 10FC Reset 1078 */
367 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
368 * in conjunction with SYSIF_REGS accesses!
373 * Dynamic Multi-Pathing specific stuff...
376 /* VirtTarget negoFlags field */
377 #define MPT_TARGET_NO_NEGO_WIDE 0x01
378 #define MPT_TARGET_NO_NEGO_SYNC 0x02
379 #define MPT_TARGET_NO_NEGO_QAS 0x04
380 #define MPT_TAPE_NEGO_IDP 0x08
383 * VirtDevice - FC LUN device or SCSI target device
385 typedef struct _VirtTarget {
386 struct scsi_target *starget;
391 u8 minSyncFactor; /* 0xFF is async */
392 u8 maxOffset; /* 0 if async */
393 u8 maxWidth; /* 0 if narrow, 1 if wide */
394 u8 negoFlags; /* bit field, see above */
395 u8 raidVolume; /* set, if RAID Volume */
396 u8 type; /* byte 0 of Inquiry data */
397 u8 deleted; /* target in process of being removed */
401 typedef struct _VirtDevice {
408 * Fibre Channel (SCSI) target device and associated defines...
410 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
411 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
412 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
413 #define MPT_TARGET_FLAGS_Q_YES 0x08
414 #define MPT_TARGET_FLAGS_VALID_56 0x10
415 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
416 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
417 #define MPT_TARGET_FLAGS_LED_ON 0x80
420 * /proc/mpt interface
426 read_proc_t *read_proc;
427 write_proc_t *write_proc;
430 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
433 if (len < request) { \
439 *start = buf + offset; \
445 * IOCTL structure and associated defines
448 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
450 #define MPT_MGMT_STATUS_RF_VALID 0x01 /* The Reply Frame is VALID */
451 #define MPT_MGMT_STATUS_COMMAND_GOOD 0x02 /* Command Status GOOD */
452 #define MPT_MGMT_STATUS_PENDING 0x04 /* command is pending */
453 #define MPT_MGMT_STATUS_DID_IOCRESET 0x08 /* IOC Reset occurred
455 #define MPT_MGMT_STATUS_SENSE_VALID 0x10 /* valid sense info */
456 #define MPT_MGMT_STATUS_TIMER_ACTIVE 0x20 /* obsolete */
457 #define MPT_MGMT_STATUS_FREE_MF 0x40 /* free the mf from
460 #define INITIALIZE_MGMT_STATUS(status) \
461 status = MPT_MGMT_STATUS_PENDING;
462 #define CLEAR_MGMT_STATUS(status) \
464 #define CLEAR_MGMT_PENDING_STATUS(status) \
465 status &= ~MPT_MGMT_STATUS_PENDING;
466 #define SET_MGMT_MSG_CONTEXT(msg_context, value) \
469 typedef struct _MPT_MGMT {
471 struct completion done;
472 u8 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
473 u8 sense[MPT_SENSE_BUFFER_ALLOC];
474 u8 status; /* current command status */
480 * Event Structure and define
482 #define MPTCTL_EVENT_LOG_SIZE (0x000000032)
483 typedef struct _mpt_ioctl_events {
484 u32 event; /* Specified by define above */
485 u32 eventContext; /* Index or counter */
486 u32 data[2]; /* First 8 bytes of Event Data */
490 * CONFIGPARM status defines
492 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
493 #define MPT_CONFIG_ERROR 0x002F
496 * Substructure to store SCSI specific configuration page data
498 /* dvStatus defines: */
499 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
500 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
501 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
503 typedef struct _SpiCfgData {
505 int *nvram; /* table of device NVRAM values */
506 IOCPage4_t *pIocPg4; /* SEP devices addressing */
507 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
508 int IocPg4Sz; /* IOCPage4 size */
509 u8 minSyncFactor; /* 0xFF if async */
510 u8 maxSyncOffset; /* 0 if async */
511 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
512 u8 busType; /* SE, LVD, HD */
513 u8 sdp1version; /* SDP1 version */
514 u8 sdp1length; /* SDP1 length */
515 u8 sdp0version; /* SDP0 version */
516 u8 sdp0length; /* SDP0 length */
517 u8 dvScheduled; /* 1 if scheduled */
518 u8 noQas; /* Disable QAS for this adapter */
519 u8 Saf_Te; /* 1 to force all Processors as
520 * SAF-TE if Inquiry data length
521 * is too short to check for SAF-TE
523 u8 bus_reset; /* 1 to allow bus reset */
527 typedef struct _SasCfgData {
528 u8 ptClear; /* 1 to automatically clear the
531 * automatic clearing.
536 * Inactive volume link list of raid component data
539 struct inactive_raid_component_info {
540 struct list_head list;
541 u8 volumeID; /* volume target id */
542 u8 volumeBus; /* volume channel */
543 IOC_3_PHYS_DISK d; /* phys disk info */
546 typedef struct _RaidCfgData {
547 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
548 IOCPage3_t *pIocPg3; /* table of physical disks */
549 struct mutex inactive_list_mutex;
550 struct list_head inactive_list; /* link list for physical
555 typedef struct _FcCfgData {
556 /* will ultimately hold fc_port_page0 also */
564 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01 /* rport registered */
565 #define MPT_RPORT_INFO_FLAGS_MISSING 0x02 /* missing from DevPage0 scan */
568 * data allocated for each fc rport device
570 struct mptfc_rport_info
572 struct list_head list;
573 struct fc_rport *rport;
574 struct scsi_target *starget;
579 typedef void (*MPT_ADD_SGE)(void *pAddr, u32 flagslength, dma_addr_t dma_addr);
580 typedef void (*MPT_ADD_CHAIN)(void *pAddr, u8 next, u16 length,
581 dma_addr_t dma_addr);
584 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
586 typedef struct _MPT_ADAPTER
588 int id; /* Unique adapter id N {0,1,2,...} */
589 int pci_irq; /* This irq */
590 char name[MPT_NAME_LENGTH]; /* "iocN" */
591 char prod_name[MPT_NAME_LENGTH]; /* "LSIFC9x9" */
592 #ifdef CONFIG_FUSION_LOGGING
593 /* used in mpt_display_event_info */
594 char evStr[EVENT_DESCR_STR_SZ];
597 char board_assembly[16];
598 char board_tracer[16];
599 u16 nvdata_version_persistent;
600 u16 nvdata_version_default;
603 u8 device_missing_delay;
604 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
605 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
607 u32 mem_phys; /* == f4020000 (mmap) */
608 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
609 int mem_size; /* mmap memory size */
615 u8 *alloc; /* frames alloc ptr */
616 dma_addr_t alloc_dma;
618 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
619 u32 reply_frames_low_dma;
620 int reply_depth; /* Num Allocated reply frames */
621 int reply_sz; /* Reply frame size */
622 int num_chain; /* Number of chain buffers */
623 MPT_ADD_SGE add_sge; /* Pointer to add_sge
625 MPT_ADD_CHAIN add_chain; /* Pointer to add_chain
627 /* Pool of buffers for chaining. ReqToChain
628 * and ChainToChain track index of chain buffers.
629 * ChainBuffer (DMA) virt/phys addresses.
630 * FreeChainQ (lock) locking mechanisms.
636 dma_addr_t ChainBufferDMA;
637 struct list_head FreeChainQ;
638 spinlock_t FreeChainQlock;
639 /* We (host driver) get to manage our own RequestQueue! */
640 dma_addr_t req_frames_dma;
641 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
642 u32 req_frames_low_dma;
643 int req_depth; /* Number of request frames */
644 int req_sz; /* Request frame size (bytes) */
645 spinlock_t FreeQlock;
646 struct list_head FreeQ;
647 /* Pool of SCSI sense buffers for commands coming from
648 * the SCSI mid-layer. We have one 256 byte sense buffer
649 * for each REQ entry.
652 dma_addr_t sense_buf_pool_dma;
653 u32 sense_buf_low_dma;
654 u8 *HostPageBuffer; /* SAS - host page buffer support */
655 u32 HostPageBuffer_sz;
656 dma_addr_t HostPageBuffer_dma;
658 struct pci_dev *pcidev; /* struct pci_dev pointer */
659 int bars; /* bitmask of BAR's that must be configured */
661 u8 __iomem *memmap; /* mmap address */
662 struct Scsi_Host *sh; /* Scsi Host pointer */
663 SpiCfgData spi_data; /* Scsi config. data */
664 RaidCfgData raid_data; /* Raid config. data */
665 SasCfgData sas_data; /* Sas config. data */
666 FcCfgData fc_data; /* Fc config. data */
667 struct proc_dir_entry *ioc_dentry;
668 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
669 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
670 int eventTypes; /* Event logging parameters */
671 int eventContext; /* Next event context */
672 int eventLogSize; /* Max number of cached events */
673 struct _mpt_ioctl_events *events; /* pointer to event log */
674 u8 *cached_fw; /* Pointer to FW */
675 dma_addr_t cached_fw_dma;
682 u32 NB_for_64_byte_frame;
683 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
684 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
685 IOCFactsReply_t facts;
686 PortFactsReply_t pfacts[2];
687 FCPortPage0_t fc_port_page0[2];
688 LANPage0_t lan_cnfg_page0;
689 LANPage1_t lan_cnfg_page1;
691 u8 ir_firmware; /* =1 if IR firmware detected */
693 * Description: errata_flag_1064
694 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
695 * a split completion for a read data, an internal address pointer incorrectly
696 * increments by 32 bytes
698 int errata_flag_1064;
699 int aen_event_read_flag; /* flag to indicate event log was read*/
701 u8 upload_fw; /* If set, do a fw upload */
702 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
707 struct list_head list;
708 struct net_device *netdev;
709 struct list_head sas_topology;
710 struct mutex sas_topology_mutex;
712 struct workqueue_struct *fw_event_q;
713 struct list_head fw_event_list;
714 spinlock_t fw_event_lock;
715 u8 fw_events_off; /* if '1', then ignore events */
716 char fw_event_q_name[MPT_KOBJ_NAME_LEN];
718 struct mutex sas_discovery_mutex;
719 u8 sas_discovery_runtime;
720 u8 sas_discovery_ignore_events;
722 /* port_info object for the host */
723 struct mptsas_portinfo *hba_port_info;
724 u64 hba_port_sas_addr;
725 u16 hba_port_num_phy;
726 struct list_head sas_device_info_list;
727 struct mutex sas_device_info_mutex;
728 u8 old_sas_discovery_protocal;
729 u8 sas_discovery_quiesce_io;
730 int sas_index; /* index refrencing */
732 MPT_MGMT mptbase_cmds; /* for sending config pages */
733 MPT_MGMT internal_cmds;
734 MPT_MGMT taskmgmt_cmds;
736 spinlock_t taskmgmt_lock; /* diagnostic reset lock */
737 int taskmgmt_in_progress;
738 u8 taskmgmt_quiesce_io;
739 u8 ioc_reset_in_progress;
740 struct work_struct sas_persist_task;
742 struct work_struct fc_setup_reset_work;
743 struct list_head fc_rports;
744 struct work_struct fc_lsc_work;
746 spinlock_t fc_rescan_work_lock;
747 struct work_struct fc_rescan_work;
748 char fc_rescan_work_q_name[MPT_KOBJ_NAME_LEN];
749 struct workqueue_struct *fc_rescan_work_q;
751 /* driver forced bus resets count */
752 unsigned long hard_resets;
753 /* fw/external bus resets count */
754 unsigned long soft_resets;
756 unsigned long timeouts;
758 struct scsi_cmnd **ScsiLookup;
759 spinlock_t scsi_lookup_lock;
761 u32 broadcast_aen_busy;
762 char reset_work_q_name[MPT_KOBJ_NAME_LEN];
763 struct workqueue_struct *reset_work_q;
764 struct delayed_work fault_reset_work;
773 * New return value convention:
774 * 1 = Ok to free associated request frame
777 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
778 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
779 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
780 /* reset_phase defs */
781 #define MPT_IOC_PRE_RESET 0
782 #define MPT_IOC_POST_RESET 1
783 #define MPT_IOC_SETUP_RESET 2
786 * Invent MPT host event (super-set of MPI Events)
787 * Fitted to 1030's 64-byte [max] request frame size
789 typedef struct _MPT_HOST_EVENT {
790 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
795 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
796 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
798 /* Define the generic types based on the size
799 * of the dma_addr_t type.
801 typedef struct _mpt_sge {
807 #define mpt_msg_flags(ioc) \
808 (ioc->sg_addr_size == sizeof(u64)) ? \
809 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
810 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32
812 #define MPT_SGE_FLAGS_64_BIT_ADDRESSING \
813 (MPI_SGE_FLAGS_64_BIT_ADDRESSING << MPI_SGE_FLAGS_SHIFT)
815 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
817 * Funky (private) macros...
819 #include "mptdebug.h"
821 #define MPT_INDEX_2_MFPTR(ioc,idx) \
822 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
824 #define MFPTR_2_MPT_INDEX(ioc,mf) \
825 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
827 #define MPT_INDEX_2_RFPTR(ioc,idx) \
828 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
830 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
832 #define SCSI_STD_SENSE_BYTES 18
833 #define SCSI_STD_INQUIRY_BYTES 36
834 #define SCSI_MAX_INQUIRY_BYTES 96
837 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
838 * Private to the driver.
840 /* LOCAL structure and fields used when processing
841 * internally generated commands. These include:
842 * bus scan, dv and config requests.
844 typedef struct _MPT_LOCAL_REPLY {
845 ConfigPageHeader_t header;
847 u8 sense[SCSI_STD_SENSE_BYTES];
853 #define MPT_HOST_BUS_UNKNOWN (0xFF)
854 #define MPT_HOST_TOO_MANY_TM (0x05)
855 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
856 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
857 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
858 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
859 #define MPT_NVRAM_SYNC_SHIFT (8)
860 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
861 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
862 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
863 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
864 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
865 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
867 /* The TM_STATE variable is used to provide strict single threading of TM
868 * requests as well as communicate TM error conditions.
870 #define TM_STATE_NONE (0)
871 #define TM_STATE_IN_PROGRESS (1)
872 #define TM_STATE_ERROR (2)
880 typedef struct _MPT_SCSI_HOST {
884 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
885 struct timer_list timer;
886 /* Pool of memory for holding SCpnts before doing
887 * OS callbacks. freeQ is the free pool.
889 u8 negoNvram; /* DV disabled, nego NVRAM */
892 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
893 struct scsi_cmnd *abortSCpnt;
894 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
895 ushort sel_timeout[MPT_MAX_FC_DEVICES];
897 long last_queue_full;
900 struct list_head target_reset_list;
903 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
905 * More Dynamic Multi-Pathing stuff...
908 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
911 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
913 * Generic structure passed to the base mpt_config function.
915 typedef struct _x_config_parms {
917 ConfigExtendedPageHeader_t *ehdr;
918 ConfigPageHeader_t *hdr;
921 u32 pageAddr; /* properly formatted */
925 u8 timeout; /* seconds */
928 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
930 * Public entry points...
932 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
933 extern void mpt_detach(struct pci_dev *pdev);
935 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state);
936 extern int mpt_resume(struct pci_dev *pdev);
938 extern u8 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
939 extern void mpt_deregister(u8 cb_idx);
940 extern int mpt_event_register(u8 cb_idx, MPT_EVHANDLER ev_cbfunc);
941 extern void mpt_event_deregister(u8 cb_idx);
942 extern int mpt_reset_register(u8 cb_idx, MPT_RESETHANDLER reset_func);
943 extern void mpt_reset_deregister(u8 cb_idx);
944 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, u8 cb_idx);
945 extern void mpt_device_driver_deregister(u8 cb_idx);
946 extern MPT_FRAME_HDR *mpt_get_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc);
947 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
948 extern void mpt_put_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
949 extern void mpt_put_msg_frame_hi_pri(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
951 extern int mpt_send_handshake_request(u8 cb_idx, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
952 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
953 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
954 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
955 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
956 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
957 extern int mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
958 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
959 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
960 extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
961 extern int mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk);
962 extern int mpt_raid_phys_disk_pg1(MPT_ADAPTER *ioc, u8 phys_disk_num,
963 pRaidPhysDiskPage1_t phys_disk);
964 extern int mpt_raid_phys_disk_get_num_paths(MPT_ADAPTER *ioc,
966 extern int mpt_set_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);
967 extern void mpt_clear_taskmgmt_in_progress_flag(MPT_ADAPTER *ioc);
968 extern void mpt_halt_firmware(MPT_ADAPTER *ioc);
972 * Public data decl's...
974 extern struct list_head ioc_list;
975 extern int mpt_fwfault_debug;
977 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
978 #endif /* } __KERNEL__ */
981 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
982 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
984 #define CAST_U32_TO_PTR(x) ((void *)x)
985 #define CAST_PTR_TO_U32(x) ((u32)x)
988 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
989 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
990 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
991 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
992 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
995 * Shifted SGE Defines - Use in SGE with FlagsLength member.
996 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
997 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
999 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1000 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1001 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1002 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1003 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1004 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1005 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1007 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1008 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1009 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1010 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1012 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1013 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1014 MPT_SGE_FLAGS_END_OF_BUFFER | \
1015 MPT_SGE_FLAGS_END_OF_LIST | \
1016 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1017 MPT_TRANSFER_IOC_TO_HOST)
1018 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1019 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1020 MPT_SGE_FLAGS_END_OF_BUFFER | \
1021 MPT_SGE_FLAGS_END_OF_LIST | \
1022 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1023 MPT_TRANSFER_HOST_TO_IOC)
1025 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/