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.08"
80 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.04.08"
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
108 #define MPT_PROCFS_MPTBASEDIR "mpt"
109 /* chg it to "driver/fusion" ? */
110 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
111 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
112 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
114 #define MPT_MAX_REQ_DEPTH 1023
115 #define MPT_DEFAULT_REQ_DEPTH 256
116 #define MPT_MIN_REQ_DEPTH 128
118 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
119 #define MPT_DEFAULT_REPLY_DEPTH 128
120 #define MPT_MIN_REPLY_DEPTH 8
121 #define MPT_MAX_REPLIES_PER_ISR 32
123 #define MPT_MAX_FRAME_SIZE 128
124 #define MPT_DEFAULT_FRAME_SIZE 128
126 #define MPT_REPLY_FRAME_SIZE 0x50 /* Must be a multiple of 8 */
128 #define MPT_SG_REQ_128_SCALE 1
129 #define MPT_SG_REQ_96_SCALE 2
130 #define MPT_SG_REQ_64_SCALE 4
135 #define MPT_COALESCING_TIMEOUT 0x10
139 * SCSI transfer rate defines.
141 #define MPT_ULTRA320 0x08
142 #define MPT_ULTRA160 0x09
143 #define MPT_ULTRA2 0x0A
144 #define MPT_ULTRA 0x0C
145 #define MPT_FAST 0x19
146 #define MPT_SCSI 0x32
147 #define MPT_ASYNC 0xFF
157 * Try to keep these at 2^N-1
159 #define MPT_FC_CAN_QUEUE 127
160 #define MPT_SCSI_CAN_QUEUE 127
163 * Set the MAX_SGE value based on user input.
165 #ifdef CONFIG_FUSION_MAX_SGE
166 #if CONFIG_FUSION_MAX_SGE < 16
167 #define MPT_SCSI_SG_DEPTH 16
168 #elif CONFIG_FUSION_MAX_SGE > 128
169 #define MPT_SCSI_SG_DEPTH 128
171 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
174 #define MPT_SCSI_SG_DEPTH 40
177 /* debug print string length used for events and iocstatus */
178 # define EVENT_DESCR_STR_SZ 100
180 #define MPT_POLLING_INTERVAL 1000 /* in milliseconds */
182 #ifdef __KERNEL__ /* { */
183 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
185 #include <linux/proc_fs.h>
187 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
189 * Attempt semi-consistent error & warning msgs across
190 * MPT drivers. NOTE: Users of these macro defs must
191 * themselves define their own MYNAM.
193 #define MYIOC_s_FMT MYNAM ": %s: "
194 #define MYIOC_s_DEBUG_FMT KERN_DEBUG MYNAM ": %s: "
195 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
196 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
197 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
198 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
200 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
202 * ATTO UL4D associated structures and defines
204 #define ATTOFLAG_DISC 0x0001
205 #define ATTOFLAG_TAGGED 0x0002
206 #define ATTOFLAG_WIDE_ENB 0x0008
207 #define ATTOFLAG_ID_ENB 0x0010
208 #define ATTOFLAG_LUN_ENB 0x0060
210 typedef struct _ATTO_DEVICE_INFO
214 u16 ATTOFlags; /* 02h */
215 } ATTO_DEVICE_INFO, MPI_POINTER PTR_ATTO_DEVICE_INFO,
216 ATTODeviceInfo_t, MPI_POINTER pATTODeviceInfo_t;
218 typedef struct _ATTO_CONFIG_PAGE_SCSI_PORT_2
220 CONFIG_PAGE_HEADER Header; /* 00h */
221 u16 PortFlags; /* 04h */
222 u16 Unused1; /* 06h */
223 u32 Unused2; /* 08h */
224 ATTO_DEVICE_INFO DeviceSettings[16]; /* 0Ch */
225 } fATTO_CONFIG_PAGE_SCSI_PORT_2, MPI_POINTER PTR_ATTO_CONFIG_PAGE_SCSI_PORT_2,
226 ATTO_SCSIPortPage2_t, MPI_POINTER pATTO_SCSIPortPage2_t;
229 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
231 * MPT protocol driver defs...
234 MPTBASE_DRIVER, /* MPT base class */
235 MPTCTL_DRIVER, /* MPT ioctl class */
236 MPTSPI_DRIVER, /* MPT SPI host class */
237 MPTFC_DRIVER, /* MPT FC host class */
238 MPTSAS_DRIVER, /* MPT SAS host class */
239 MPTLAN_DRIVER, /* MPT LAN class */
240 MPTSTM_DRIVER, /* MPT SCSI target mode class */
244 struct mpt_pci_driver{
245 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
246 void (*remove) (struct pci_dev *dev);
250 * MPT adapter / port / bus / device info structures...
253 typedef union _MPT_FRAME_TRACKER {
255 struct list_head list;
261 * NOTE: When request frames are free, on the linkage structure
262 * contets are valid. All other values are invalid.
263 * In particular, do NOT reply on offset [2]
264 * (in words) being the * message context.
265 * The message context must be reset (computed via base address
266 * + an offset) prior to issuing any command.
268 * NOTE2: On non-32-bit systems, where pointers are LARGE,
269 * using the linkage pointers destroys our sacred MsgContext
270 * field contents. But we don't care anymore because these
271 * are now reset in mpt_put_msg_frame() just prior to sending
272 * a request off to the IOC.
277 * The following _MUST_ match the location of the
278 * MsgContext field in the MPT message headers.
283 u16 req_idx; /* Request index */
284 u8 cb_idx; /* callback function index */
290 * Remark: 32 bit identifier:
292 * 23-16: call back index
293 * 15-0 : request index
298 * We might want to view/access a frame as:
299 * 1) generic request header
305 typedef struct _MPT_FRAME_HDR {
308 SCSIIORequest_t scsireq;
309 SCSIIOReply_t sreply;
310 ConfigReply_t configreply;
311 MPIDefaultReply_t reply;
312 MPT_FRAME_TRACKER frame;
316 #define MPT_REQ_MSGFLAGS_DROPME 0x80
318 typedef struct _MPT_SGL_HDR {
319 SGESimple32_t sge[1];
322 typedef struct _MPT_SGL64_HDR {
323 SGESimple64_t sge[1];
327 * System interface register set
330 typedef struct _SYSIF_REGS
332 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
333 u32 WriteSequence; /* 04 Write Sequence register */
334 u32 Diagnostic; /* 08 Diagnostic register */
335 u32 TestBase; /* 0C Test Base Address */
336 u32 DiagRwData; /* 10 Read Write Data (fw download) */
337 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
338 u32 Reserved1[6]; /* 18-2F reserved for future use */
339 u32 IntStatus; /* 30 Interrupt Status */
340 u32 IntMask; /* 34 Interrupt Mask */
341 u32 Reserved2[2]; /* 38-3F reserved for future use */
342 u32 RequestFifo; /* 40 Request Post/Free FIFO */
343 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
344 u32 RequestHiPriFifo; /* 48 Hi Priority Request FIFO */
345 u32 Reserved3; /* 4C-4F reserved for future use */
346 u32 HostIndex; /* 50 Host Index register */
347 u32 Reserved4[15]; /* 54-8F */
348 u32 Fubar; /* 90 For Fubar usage */
349 u32 Reserved5[1050];/* 94-10F8 */
350 u32 Reset_1078; /* 10FC Reset 1078 */
354 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
355 * in conjunction with SYSIF_REGS accesses!
360 * Dynamic Multi-Pathing specific stuff...
363 /* VirtTarget negoFlags field */
364 #define MPT_TARGET_NO_NEGO_WIDE 0x01
365 #define MPT_TARGET_NO_NEGO_SYNC 0x02
366 #define MPT_TARGET_NO_NEGO_QAS 0x04
367 #define MPT_TAPE_NEGO_IDP 0x08
370 * VirtDevice - FC LUN device or SCSI target device
372 typedef struct _VirtTarget {
373 struct scsi_target *starget;
378 u8 minSyncFactor; /* 0xFF is async */
379 u8 maxOffset; /* 0 if async */
380 u8 maxWidth; /* 0 if narrow, 1 if wide */
381 u8 negoFlags; /* bit field, see above */
382 u8 raidVolume; /* set, if RAID Volume */
383 u8 type; /* byte 0 of Inquiry data */
384 u8 deleted; /* target in process of being removed */
388 typedef struct _VirtDevice {
395 * Fibre Channel (SCSI) target device and associated defines...
397 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
398 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
399 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
400 #define MPT_TARGET_FLAGS_Q_YES 0x08
401 #define MPT_TARGET_FLAGS_VALID_56 0x10
402 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
403 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
404 #define MPT_TARGET_FLAGS_LED_ON 0x80
407 * /proc/mpt interface
413 read_proc_t *read_proc;
414 write_proc_t *write_proc;
417 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
420 if (len < request) { \
426 *start = buf + offset; \
432 * IOCTL structure and associated defines
435 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
437 typedef struct _MPT_IOCTL {
438 struct _MPT_ADAPTER *ioc;
439 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
440 u8 sense[MPT_SENSE_BUFFER_ALLOC];
441 int wait_done; /* wake-up value for this ioc */
443 u8 status; /* current command status */
444 u8 reset; /* 1 if bus reset allowed */
445 u8 id; /* target for reset */
446 struct mutex ioctl_mutex;
449 #define MPT_MGMT_STATUS_RF_VALID 0x01 /* The Reply Frame is VALID */
450 #define MPT_MGMT_STATUS_COMMAND_GOOD 0x02 /* Command Status GOOD */
451 #define MPT_MGMT_STATUS_PENDING 0x04 /* command is pending */
452 #define MPT_MGMT_STATUS_DID_IOCRESET 0x08 /* IOC Reset occurred
454 #define MPT_MGMT_STATUS_SENSE_VALID 0x10 /* valid sense info */
455 #define MPT_MGMT_STATUS_TIMER_ACTIVE 0x20 /* obsolete */
456 #define MPT_MGMT_STATUS_FREE_MF 0x40 /* free the mf from
459 #define INITIALIZE_MGMT_STATUS(status) \
460 status = MPT_MGMT_STATUS_PENDING;
461 #define CLEAR_MGMT_STATUS(status) \
464 typedef struct _MPT_MGMT {
466 struct completion done;
467 u8 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
468 u8 sense[MPT_SENSE_BUFFER_ALLOC];
469 u8 status; /* current command status */
474 * Event Structure and define
476 #define MPTCTL_EVENT_LOG_SIZE (0x000000032)
477 typedef struct _mpt_ioctl_events {
478 u32 event; /* Specified by define above */
479 u32 eventContext; /* Index or counter */
480 u32 data[2]; /* First 8 bytes of Event Data */
484 * CONFIGPARM status defines
486 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
487 #define MPT_CONFIG_ERROR 0x002F
490 * Substructure to store SCSI specific configuration page data
492 /* dvStatus defines: */
493 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
494 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
495 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
497 typedef struct _SpiCfgData {
499 int *nvram; /* table of device NVRAM values */
500 IOCPage4_t *pIocPg4; /* SEP devices addressing */
501 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
502 int IocPg4Sz; /* IOCPage4 size */
503 u8 minSyncFactor; /* 0xFF if async */
504 u8 maxSyncOffset; /* 0 if async */
505 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
506 u8 busType; /* SE, LVD, HD */
507 u8 sdp1version; /* SDP1 version */
508 u8 sdp1length; /* SDP1 length */
509 u8 sdp0version; /* SDP0 version */
510 u8 sdp0length; /* SDP0 length */
511 u8 dvScheduled; /* 1 if scheduled */
512 u8 noQas; /* Disable QAS for this adapter */
513 u8 Saf_Te; /* 1 to force all Processors as
514 * SAF-TE if Inquiry data length
515 * is too short to check for SAF-TE
517 u8 bus_reset; /* 1 to allow bus reset */
521 typedef struct _SasCfgData {
522 u8 ptClear; /* 1 to automatically clear the
525 * automatic clearing.
530 * Inactive volume link list of raid component data
533 struct inactive_raid_component_info {
534 struct list_head list;
535 u8 volumeID; /* volume target id */
536 u8 volumeBus; /* volume channel */
537 IOC_3_PHYS_DISK d; /* phys disk info */
540 typedef struct _RaidCfgData {
541 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
542 IOCPage3_t *pIocPg3; /* table of physical disks */
543 struct mutex inactive_list_mutex;
544 struct list_head inactive_list; /* link list for physical
549 typedef struct _FcCfgData {
550 /* will ultimately hold fc_port_page0 also */
558 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01 /* rport registered */
559 #define MPT_RPORT_INFO_FLAGS_MISSING 0x02 /* missing from DevPage0 scan */
562 * data allocated for each fc rport device
564 struct mptfc_rport_info
566 struct list_head list;
567 struct fc_rport *rport;
568 struct scsi_target *starget;
573 typedef void (*MPT_ADD_SGE)(void *pAddr, u32 flagslength, dma_addr_t dma_addr);
574 typedef void (*MPT_ADD_CHAIN)(void *pAddr, u8 next, u16 length,
575 dma_addr_t dma_addr);
578 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
580 typedef struct _MPT_ADAPTER
582 int id; /* Unique adapter id N {0,1,2,...} */
583 int pci_irq; /* This irq */
584 char name[MPT_NAME_LENGTH]; /* "iocN" */
585 char prod_name[MPT_NAME_LENGTH]; /* "LSIFC9x9" */
587 char board_assembly[16];
588 char board_tracer[16];
589 u16 nvdata_version_persistent;
590 u16 nvdata_version_default;
593 u8 device_missing_delay;
594 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
595 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
597 u32 mem_phys; /* == f4020000 (mmap) */
598 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
599 int mem_size; /* mmap memory size */
605 u8 *alloc; /* frames alloc ptr */
606 dma_addr_t alloc_dma;
608 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
609 u32 reply_frames_low_dma;
610 int reply_depth; /* Num Allocated reply frames */
611 int reply_sz; /* Reply frame size */
612 int num_chain; /* Number of chain buffers */
613 MPT_ADD_SGE add_sge; /* Pointer to add_sge
615 MPT_ADD_CHAIN add_chain; /* Pointer to add_chain
617 /* Pool of buffers for chaining. ReqToChain
618 * and ChainToChain track index of chain buffers.
619 * ChainBuffer (DMA) virt/phys addresses.
620 * FreeChainQ (lock) locking mechanisms.
626 dma_addr_t ChainBufferDMA;
627 struct list_head FreeChainQ;
628 spinlock_t FreeChainQlock;
629 /* We (host driver) get to manage our own RequestQueue! */
630 dma_addr_t req_frames_dma;
631 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
632 u32 req_frames_low_dma;
633 int req_depth; /* Number of request frames */
634 int req_sz; /* Request frame size (bytes) */
635 spinlock_t FreeQlock;
636 struct list_head FreeQ;
637 /* Pool of SCSI sense buffers for commands coming from
638 * the SCSI mid-layer. We have one 256 byte sense buffer
639 * for each REQ entry.
642 dma_addr_t sense_buf_pool_dma;
643 u32 sense_buf_low_dma;
644 u8 *HostPageBuffer; /* SAS - host page buffer support */
645 u32 HostPageBuffer_sz;
646 dma_addr_t HostPageBuffer_dma;
648 struct pci_dev *pcidev; /* struct pci_dev pointer */
649 int bars; /* bitmask of BAR's that must be configured */
651 u8 __iomem *memmap; /* mmap address */
652 struct Scsi_Host *sh; /* Scsi Host pointer */
653 SpiCfgData spi_data; /* Scsi config. data */
654 RaidCfgData raid_data; /* Raid config. data */
655 SasCfgData sas_data; /* Sas config. data */
656 FcCfgData fc_data; /* Fc config. data */
657 MPT_IOCTL *ioctl; /* ioctl data pointer */
658 struct proc_dir_entry *ioc_dentry;
659 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
660 spinlock_t diagLock; /* diagnostic reset lock */
662 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
663 int eventTypes; /* Event logging parameters */
664 int eventContext; /* Next event context */
665 int eventLogSize; /* Max number of cached events */
666 struct _mpt_ioctl_events *events; /* pointer to event log */
667 u8 *cached_fw; /* Pointer to FW */
668 dma_addr_t cached_fw_dma;
675 u32 NB_for_64_byte_frame;
676 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
677 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
678 IOCFactsReply_t facts;
679 PortFactsReply_t pfacts[2];
680 FCPortPage0_t fc_port_page0[2];
681 LANPage0_t lan_cnfg_page0;
682 LANPage1_t lan_cnfg_page1;
684 u8 ir_firmware; /* =1 if IR firmware detected */
686 * Description: errata_flag_1064
687 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
688 * a split completion for a read data, an internal address pointer incorrectly
689 * increments by 32 bytes
691 int errata_flag_1064;
692 int aen_event_read_flag; /* flag to indicate event log was read*/
694 u8 upload_fw; /* If set, do a fw upload */
695 u8 reload_fw; /* Force a FW Reload on next reset */
696 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
701 spinlock_t initializing_hba_lock;
702 int initializing_hba_lock_flag;
703 struct list_head list;
704 struct net_device *netdev;
705 struct list_head sas_topology;
706 struct mutex sas_topology_mutex;
707 struct mutex sas_discovery_mutex;
708 u8 sas_discovery_runtime;
709 u8 sas_discovery_ignore_events;
710 u8 sas_discovery_quiesce_io;
711 int sas_index; /* index refrencing */
713 MPT_MGMT mptbase_cmds; /* for sending config pages */
714 MPT_MGMT internal_cmds;
715 struct work_struct sas_persist_task;
717 struct work_struct fc_setup_reset_work;
718 struct list_head fc_rports;
719 struct work_struct fc_lsc_work;
721 spinlock_t fc_rescan_work_lock;
722 struct work_struct fc_rescan_work;
723 char fc_rescan_work_q_name[20];
724 struct workqueue_struct *fc_rescan_work_q;
725 struct scsi_cmnd **ScsiLookup;
726 spinlock_t scsi_lookup_lock;
728 char reset_work_q_name[20];
729 struct workqueue_struct *reset_work_q;
730 struct delayed_work fault_reset_work;
731 spinlock_t fault_reset_work_lock;
739 * New return value convention:
740 * 1 = Ok to free associated request frame
743 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
744 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
745 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
746 /* reset_phase defs */
747 #define MPT_IOC_PRE_RESET 0
748 #define MPT_IOC_POST_RESET 1
749 #define MPT_IOC_SETUP_RESET 2
752 * Invent MPT host event (super-set of MPI Events)
753 * Fitted to 1030's 64-byte [max] request frame size
755 typedef struct _MPT_HOST_EVENT {
756 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
761 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
762 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
764 /* Define the generic types based on the size
765 * of the dma_addr_t type.
767 typedef struct _mpt_sge {
773 #define mpt_msg_flags(ioc) \
774 (ioc->sg_addr_size == sizeof(u64)) ? \
775 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
776 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32
778 #define MPT_SGE_FLAGS_64_BIT_ADDRESSING \
779 (MPI_SGE_FLAGS_64_BIT_ADDRESSING << MPI_SGE_FLAGS_SHIFT)
781 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
783 * Funky (private) macros...
785 #include "mptdebug.h"
787 #define MPT_INDEX_2_MFPTR(ioc,idx) \
788 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
790 #define MFPTR_2_MPT_INDEX(ioc,mf) \
791 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
793 #define MPT_INDEX_2_RFPTR(ioc,idx) \
794 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
796 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
798 #define SCSI_STD_SENSE_BYTES 18
799 #define SCSI_STD_INQUIRY_BYTES 36
800 #define SCSI_MAX_INQUIRY_BYTES 96
803 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
804 * Private to the driver.
806 /* LOCAL structure and fields used when processing
807 * internally generated commands. These include:
808 * bus scan, dv and config requests.
810 typedef struct _MPT_LOCAL_REPLY {
811 ConfigPageHeader_t header;
813 u8 sense[SCSI_STD_SENSE_BYTES];
819 #define MPT_HOST_BUS_UNKNOWN (0xFF)
820 #define MPT_HOST_TOO_MANY_TM (0x05)
821 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
822 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
823 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
824 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
825 #define MPT_NVRAM_SYNC_SHIFT (8)
826 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
827 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
828 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
829 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
830 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
831 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
833 /* The TM_STATE variable is used to provide strict single threading of TM
834 * requests as well as communicate TM error conditions.
836 #define TM_STATE_NONE (0)
837 #define TM_STATE_IN_PROGRESS (1)
838 #define TM_STATE_ERROR (2)
846 typedef struct _MPT_SCSI_HOST {
850 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
851 struct timer_list timer;
852 /* Pool of memory for holding SCpnts before doing
853 * OS callbacks. freeQ is the free pool.
857 u8 negoNvram; /* DV disabled, nego NVRAM */
861 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
862 struct scsi_cmnd *abortSCpnt;
863 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
864 unsigned long hard_resets; /* driver forced bus resets count */
865 unsigned long soft_resets; /* fw/external bus resets count */
866 unsigned long timeouts; /* cmd timeouts */
867 ushort sel_timeout[MPT_MAX_FC_DEVICES];
869 long last_queue_full;
872 struct list_head target_reset_list;
875 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
877 * More Dynamic Multi-Pathing stuff...
880 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
883 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
885 * Generic structure passed to the base mpt_config function.
887 typedef struct _x_config_parms {
889 ConfigExtendedPageHeader_t *ehdr;
890 ConfigPageHeader_t *hdr;
893 u32 pageAddr; /* properly formatted */
897 u8 timeout; /* seconds */
900 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
902 * Public entry points...
904 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
905 extern void mpt_detach(struct pci_dev *pdev);
907 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state);
908 extern int mpt_resume(struct pci_dev *pdev);
910 extern u8 mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
911 extern void mpt_deregister(u8 cb_idx);
912 extern int mpt_event_register(u8 cb_idx, MPT_EVHANDLER ev_cbfunc);
913 extern void mpt_event_deregister(u8 cb_idx);
914 extern int mpt_reset_register(u8 cb_idx, MPT_RESETHANDLER reset_func);
915 extern void mpt_reset_deregister(u8 cb_idx);
916 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, u8 cb_idx);
917 extern void mpt_device_driver_deregister(u8 cb_idx);
918 extern MPT_FRAME_HDR *mpt_get_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc);
919 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
920 extern void mpt_put_msg_frame(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
921 extern void mpt_put_msg_frame_hi_pri(u8 cb_idx, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
923 extern int mpt_send_handshake_request(u8 cb_idx, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
924 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
925 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
926 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
927 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
928 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
929 extern int mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
930 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
931 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
932 extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
933 extern int mpt_raid_phys_disk_pg0(MPT_ADAPTER *ioc, u8 phys_disk_num, pRaidPhysDiskPage0_t phys_disk);
934 extern void mpt_halt_firmware(MPT_ADAPTER *ioc);
938 * Public data decl's...
940 extern struct list_head ioc_list;
941 extern int mpt_fwfault_debug;
943 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
944 #endif /* } __KERNEL__ */
947 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
948 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
950 #define CAST_U32_TO_PTR(x) ((void *)x)
951 #define CAST_PTR_TO_U32(x) ((u32)x)
954 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
955 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
956 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
957 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
958 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
961 * Shifted SGE Defines - Use in SGE with FlagsLength member.
962 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
963 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
965 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
966 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
967 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
968 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
969 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
970 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
971 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
973 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
974 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
975 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
976 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
978 #define MPT_SGE_FLAGS_SSIMPLE_READ \
979 (MPT_SGE_FLAGS_LAST_ELEMENT | \
980 MPT_SGE_FLAGS_END_OF_BUFFER | \
981 MPT_SGE_FLAGS_END_OF_LIST | \
982 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
983 MPT_TRANSFER_IOC_TO_HOST)
984 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
985 (MPT_SGE_FLAGS_LAST_ELEMENT | \
986 MPT_SGE_FLAGS_END_OF_BUFFER | \
987 MPT_SGE_FLAGS_END_OF_LIST | \
988 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
989 MPT_TRANSFER_HOST_TO_IOC)
991 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/