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 Logic Fusion MPT (Message Passing Technology) firmware.
11 * Copyright (c) 1999-2004 LSI Logic Corporation
12 * Originally By: Steven J. Ralston
13 * (mailto:sjralston1@netscape.net)
14 * (mailto:mpt_linux_developer@lsil.com)
16 * $Id: mptbase.h,v 1.144 2003/01/28 21:31:56 pdelaney Exp $
18 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
20 This program is free software; you can redistribute it and/or modify
21 it under the terms of the GNU General Public License as published by
22 the Free Software Foundation; version 2 of the License.
24 This program is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 GNU General Public License for more details.
30 THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
31 CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
32 LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
33 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
34 solely responsible for determining the appropriateness of using and
35 distributing the Program and assumes all risks associated with its
36 exercise of rights under this Agreement, including but not limited to
37 the risks and costs of program errors, damage to or loss of data,
38 programs or equipment, and unavailability or interruption of operations.
40 DISCLAIMER OF LIABILITY
41 NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
42 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
43 DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
44 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
45 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
46 USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
47 HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
49 You should have received a copy of the GNU General Public License
50 along with this program; if not, write to the Free Software
51 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
54 #ifndef MPTBASE_H_INCLUDED
55 #define MPTBASE_H_INCLUDED
56 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
58 #include "linux_compat.h" /* linux-2.2.x (vs. -2.4.x) tweaks */
59 #include "scsi3.h" /* SCSI defines */
61 #include "lsi/mpi_type.h"
62 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
63 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
64 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
65 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
66 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
67 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
69 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
70 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
71 #include "lsi/mpi_tool.h" /* Tools support */
72 #include "lsi/fc_log.h"
74 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
77 #define MODULEAUTHOR "LSI Logic Corporation"
81 #define COPYRIGHT "Copyright (c) 1999-2004 " MODULEAUTHOR
84 #define MPT_LINUX_VERSION_COMMON "3.01.06"
85 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.01.06"
86 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
88 #define show_mptmod_ver(s,ver) \
89 printk(KERN_INFO "%s %s\n", s, ver);
91 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
93 * Fusion MPT(linux) driver configurable stuff...
95 #define MPT_MAX_ADAPTERS 18
96 #define MPT_MAX_PROTOCOL_DRIVERS 16
97 #define MPT_MAX_BUS 1 /* Do not change */
98 #define MPT_MAX_FC_DEVICES 255
99 #define MPT_MAX_SCSI_DEVICES 16
100 #define MPT_LAST_LUN 255
101 #define MPT_SENSE_BUFFER_ALLOC 64
102 /* allow for 256 max sense alloc, but only 255 max request */
103 #if MPT_SENSE_BUFFER_ALLOC >= 256
104 # undef MPT_SENSE_BUFFER_ALLOC
105 # define MPT_SENSE_BUFFER_ALLOC 256
106 # define MPT_SENSE_BUFFER_SIZE 255
108 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
111 #define MPT_NAME_LENGTH 32
113 #define MPT_PROCFS_MPTBASEDIR "mpt"
114 /* chg it to "driver/fusion" ? */
115 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
116 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
117 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
119 #define MPT_MAX_REQ_DEPTH 1023
120 #define MPT_DEFAULT_REQ_DEPTH 256
121 #define MPT_MIN_REQ_DEPTH 128
123 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
124 #define MPT_DEFAULT_REPLY_DEPTH 128
125 #define MPT_MIN_REPLY_DEPTH 8
126 #define MPT_MAX_REPLIES_PER_ISR 32
128 #define MPT_MAX_FRAME_SIZE 128
129 #define MPT_DEFAULT_FRAME_SIZE 128
131 #define MPT_REPLY_FRAME_SIZE 0x40 /* Must be a multiple of 8 */
133 #define MPT_SG_REQ_128_SCALE 1
134 #define MPT_SG_REQ_96_SCALE 2
135 #define MPT_SG_REQ_64_SCALE 4
140 #define MPT_COALESCING_TIMEOUT 0x10
143 * SCSI transfer rate defines.
145 #define MPT_ULTRA320 0x08
146 #define MPT_ULTRA160 0x09
147 #define MPT_ULTRA2 0x0A
148 #define MPT_ULTRA 0x0C
149 #define MPT_FAST 0x19
150 #define MPT_SCSI 0x32
151 #define MPT_ASYNC 0xFF
161 * Try to keep these at 2^N-1
163 #define MPT_FC_CAN_QUEUE 127
164 #define MPT_SCSI_CAN_QUEUE 127
167 * Set the MAX_SGE value based on user input.
169 #ifdef CONFIG_FUSION_MAX_SGE
170 #if CONFIG_FUSION_MAX_SGE < 16
171 #define MPT_SCSI_SG_DEPTH 16
172 #elif CONFIG_FUSION_MAX_SGE > 128
173 #define MPT_SCSI_SG_DEPTH 128
175 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
178 #define MPT_SCSI_SG_DEPTH 40
181 #ifdef __KERNEL__ /* { */
182 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
184 #include <linux/proc_fs.h>
186 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
188 * Attempt semi-consistent error & warning msgs across
189 * MPT drivers. NOTE: Users of these macro defs must
190 * themselves define their own MYNAM.
192 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
193 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
194 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
195 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
197 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
199 * MPT protocol driver defs...
202 MPTBASE_DRIVER, /* MPT base class */
203 MPTCTL_DRIVER, /* MPT ioctl class */
204 MPTSCSIH_DRIVER, /* MPT SCSI host (initiator) class */
205 MPTLAN_DRIVER, /* MPT LAN class */
206 MPTSTM_DRIVER, /* MPT SCSI target mode class */
207 MPTDMP_DRIVER, /* MPT Dynamic Multi-pathing class */
211 struct mpt_pci_driver{
212 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
213 void (*remove) (struct pci_dev *dev);
214 void (*shutdown) (struct device * dev);
216 int (*resume) (struct pci_dev *dev);
217 int (*suspend) (struct pci_dev *dev, u32 state);
222 * MPT adapter / port / bus / device info structures...
225 typedef union _MPT_FRAME_TRACKER {
227 struct _MPT_FRAME_HDR *forw;
228 struct _MPT_FRAME_HDR *back;
234 * NOTE: When request frames are free, on the linkage structure
235 * contets are valid. All other values are invalid.
236 * In particular, do NOT reply on offset [2]
237 * (in words) being the * message context.
238 * The message context must be reset (computed via base address
239 * + an offset) prior to issuing any command.
241 * NOTE2: On non-32-bit systems, where pointers are LARGE,
242 * using the linkage pointers destroys our sacred MsgContext
243 * field contents. But we don't care anymore because these
244 * are now reset in mpt_put_msg_frame() just prior to sending
245 * a request off to the IOC.
250 * The following _MUST_ match the location of the
251 * MsgContext field in the MPT message headers.
256 u16 req_idx; /* Request index */
257 u8 cb_idx; /* callback function index */
263 * Remark: 32 bit identifier:
265 * 23-16: call back index
266 * 15-0 : request index
271 * We might want to view/access a frame as:
272 * 1) generic request header
278 typedef struct _MPT_FRAME_HDR {
281 SCSIIORequest_t scsireq;
282 SCSIIOReply_t sreply;
283 ConfigReply_t configreply;
284 MPIDefaultReply_t reply;
285 MPT_FRAME_TRACKER frame;
289 #define MPT_REQ_MSGFLAGS_DROPME 0x80
291 /* Used for tracking the free request frames
292 * and free reply frames.
294 typedef struct _MPT_Q_TRACKER {
300 typedef struct _MPT_SGL_HDR {
301 SGESimple32_t sge[1];
304 typedef struct _MPT_SGL64_HDR {
305 SGESimple64_t sge[1];
309 typedef struct _Q_ITEM {
310 struct _Q_ITEM *forw;
311 struct _Q_ITEM *back;
314 typedef struct _Q_TRACKER {
315 struct _Q_ITEM *head;
316 struct _Q_ITEM *tail;
319 typedef struct _MPT_DONE_Q {
320 struct _MPT_DONE_Q *forw;
321 struct _MPT_DONE_Q *back;
325 typedef struct _DONE_Q_TRACKER {
331 * Chip-specific stuff... FC929 delineates break between
332 * FC and Parallel SCSI parts. Do NOT re-order.
347 * System interface register set
350 typedef struct _SYSIF_REGS
352 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
353 u32 WriteSequence; /* 04 Write Sequence register */
354 u32 Diagnostic; /* 08 Diagnostic register */
355 u32 TestBase; /* 0C Test Base Address */
356 u32 DiagRwData; /* 10 Read Write Data (fw download) */
357 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
358 u32 Reserved1[6]; /* 18-2F reserved for future use */
359 u32 IntStatus; /* 30 Interrupt Status */
360 u32 IntMask; /* 34 Interrupt Mask */
361 u32 Reserved2[2]; /* 38-3F reserved for future use */
362 u32 RequestFifo; /* 40 Request Post/Free FIFO */
363 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
364 u32 Reserved3[2]; /* 48-4F reserved for future use */
365 u32 HostIndex; /* 50 Host Index register */
366 u32 Reserved4[15]; /* 54-8F */
367 u32 Fubar; /* 90 For Fubar usage */
368 u32 Reserved5[27]; /* 94-FF */
372 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
373 * in conjunction with SYSIF_REGS accesses!
378 * Dynamic Multi-Pathing specific stuff...
380 #define DMP_MAX_PATHS 8
382 typedef struct _PathInfo {
389 #define PATHINFO_FLAGS_OWNED 0x01
390 #define PATHINFO_FLAGS_EXISTS 0x02
391 #define PATHINFO_FLAGS_AVAILABLE 0x04
392 #define PATHINFO_FLAGS_SECONDARY 0x08
394 #define PFLAGS_EXISTS_AND_AVAIL (PATHINFO_FLAGS_EXISTS|PATHINFO_FLAGS_AVAILABLE)
395 #define PFLAGS_AVAIL_AND_OWNED (PATHINFO_FLAGS_AVAILABLE|PATHINFO_FLAGS_OWNED)
397 typedef struct _ScsiCmndTracker {
404 * VirtDevice - FC LUN device or SCSI target device
405 * (used to be FCSCSI_TARGET)
407 typedef struct _VirtDevice {
408 struct _VirtDevice *forw;
409 struct _VirtDevice *back;
410 struct scsi_device *device;
417 u8 minSyncFactor; /* 0xFF is async */
418 u8 maxOffset; /* 0 if async */
419 u8 maxWidth; /* 0 if narrow, 1 if wide*/
420 u8 negoFlags; /* bit field, 0 if WDTR/SDTR/QAS allowed */
421 u8 raidVolume; /* set, if RAID Volume */
422 u8 type; /* byte 0 of Inquiry data */
423 u8 cflags; /* controller flags */
429 PathInfo path[DMP_MAX_PATHS];
430 struct timer_list stall_timer;
431 struct timer_list retry_timer;
432 struct timer_list gone_timer;
433 ScsiCmndTracker WaitQ;
434 ScsiCmndTracker SentQ;
435 ScsiCmndTracker DoneQ;
437 u32 luns[8]; /* Max LUNs is 256 */
440 /* IEEE Registered Extended Identifier
441 obtained via INQUIRY VPD page 0x83 */
442 /* NOTE: Do not separate uniq_prepad and uniq_data
443 as they are treateed as a single entity in the code */
450 * Fibre Channel (SCSI) target device and associated defines...
452 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
453 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
454 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
455 #define MPT_TARGET_FLAGS_Q_YES 0x08
456 #define MPT_TARGET_FLAGS_VALID_56 0x10
457 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
459 #define MPT_TARGET_NO_NEGO_WIDE 0x01
460 #define MPT_TARGET_NO_NEGO_SYNC 0x02
461 #define MPT_TARGET_NO_NEGO_QAS 0x04
463 typedef struct _VirtDevTracker {
464 struct _VirtDevice *head;
465 struct _VirtDevice *tail;
472 * /proc/mpt interface
478 read_proc_t *read_proc;
479 write_proc_t *write_proc;
482 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
485 if (len < request) { \
491 *start = buf + offset; \
497 * IOCTL structure and associated defines
500 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
501 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
502 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
503 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
504 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
505 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
506 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
508 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
510 typedef struct _MPT_IOCTL {
511 struct _MPT_ADAPTER *ioc;
512 struct timer_list timer; /* timer function for this adapter */
513 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
514 u8 sense[MPT_SENSE_BUFFER_ALLOC];
515 int wait_done; /* wake-up value for this ioc */
517 u8 status; /* current command status */
518 u8 reset; /* 1 if bus reset allowed */
519 u8 target; /* target for reset */
521 struct timer_list TMtimer; /* timer function for this adapter */
525 * Event Structure and define
527 #define MPTCTL_EVENT_LOG_SIZE (0x0000000A)
528 typedef struct _mpt_ioctl_events {
529 u32 event; /* Specified by define above */
530 u32 eventContext; /* Index or counter */
531 int data[2]; /* First 8 bytes of Event Data */
535 * CONFIGPARM status defines
537 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
538 #define MPT_CONFIG_ERROR 0x002F
541 * Substructure to store SCSI specific configuration page data
543 /* dvStatus defines: */
544 #define MPT_SCSICFG_NEGOTIATE 0x01 /* Negotiate on next IO */
545 #define MPT_SCSICFG_NEED_DV 0x02 /* Schedule DV */
546 #define MPT_SCSICFG_DV_PENDING 0x04 /* DV on this physical id pending */
547 #define MPT_SCSICFG_DV_NOT_DONE 0x08 /* DV has not been performed */
548 #define MPT_SCSICFG_BLK_NEGO 0x10 /* WriteSDP1 with WDTR and SDTR disabled */
549 #define MPT_SCSICFG_RELOAD_IOC_PG3 0x20 /* IOC Pg 3 data is obsolete */
550 /* Args passed to writeSDP1: */
551 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
552 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
553 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
555 typedef struct _ScsiCfgData {
557 int *nvram; /* table of device NVRAM values */
558 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
559 IOCPage3_t *pIocPg3; /* table of physical disks */
560 IOCPage4_t *pIocPg4; /* SEP devices addressing */
561 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
562 int IocPg4Sz; /* IOCPage4 size */
563 u8 dvStatus[MPT_MAX_SCSI_DEVICES];
564 int isRaid; /* bit field, 1 if RAID */
565 u8 minSyncFactor; /* 0xFF if async */
566 u8 maxSyncOffset; /* 0 if async */
567 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
568 u8 busType; /* SE, LVD, HD */
569 u8 sdp1version; /* SDP1 version */
570 u8 sdp1length; /* SDP1 length */
571 u8 sdp0version; /* SDP0 version */
572 u8 sdp0length; /* SDP0 length */
573 u8 dvScheduled; /* 1 if scheduled */
574 u8 forceDv; /* 1 to force DV scheduling */
575 u8 noQas; /* Disable QAS for this adapter */
576 u8 Saf_Te; /* 1 to force all Processors as SAF-TE if Inquiry data length is too short to check for SAF-TE */
580 typedef struct _fw_image {
588 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
590 typedef struct _MPT_ADAPTER
592 struct _MPT_ADAPTER *forw;
593 struct _MPT_ADAPTER *back;
594 int id; /* Unique adapter id N {0,1,2,...} */
595 int pci_irq; /* This irq */
596 char name[MPT_NAME_LENGTH]; /* "iocN" */
597 char *prod_name; /* "LSIFC9x9" */
598 volatile SYSIF_REGS *chip; /* == c8817000 (mmap) */
599 volatile SYSIF_REGS *pio_chip; /* Programmed IO (downloadboot) */
600 u32 mem_phys; /* == f4020000 (mmap) */
601 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
602 int mem_size; /* mmap memory size */
606 u8 *fifo_pool; /* dma pool for fifo's */
607 dma_addr_t fifo_pool_dma;
608 int fifo_pool_sz; /* allocated size */
609 u8 *chain_alloc; /* chain buffer alloc ptr */
610 dma_addr_t chain_alloc_dma;
612 u8 *reply_alloc; /* Reply frames alloc ptr */
613 dma_addr_t reply_alloc_dma;
614 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
615 dma_addr_t reply_frames_dma;
616 u32 reply_frames_low_dma;
617 int reply_depth; /* Num Allocated reply frames */
618 int reply_sz; /* Reply frame size */
620 /* We (host driver) get to manage our own RequestQueue! */
621 u8 *req_alloc; /* Request frames alloc ptr */
622 dma_addr_t req_alloc_dma;
623 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
624 dma_addr_t req_frames_dma;
625 u32 req_frames_low_dma;
626 int req_depth; /* Number of request frames */
627 int req_sz; /* Request frame size (bytes) */
628 spinlock_t FreeQlock;
630 /* Pool of SCSI sense buffers for commands coming from
631 * the SCSI mid-layer. We have one 256 byte sense buffer
632 * for each REQ entry.
635 dma_addr_t sense_buf_pool_dma;
636 u32 sense_buf_low_dma;
638 struct pci_dev *pcidev; /* struct pci_dev pointer */
639 u8 *memmap; /* mmap address */
640 struct Scsi_Host *sh; /* Scsi Host pointer */
641 ScsiCfgData spi_data; /* Scsi config. data */
642 MPT_IOCTL *ioctl; /* ioctl data pointer */
643 struct proc_dir_entry *ioc_dentry;
644 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
645 spinlock_t diagLock; /* diagnostic reset lock */
647 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
648 int eventTypes; /* Event logging parameters */
649 int eventContext; /* Next event context */
650 int eventLogSize; /* Max number of cached events */
651 #ifdef MPTSCSIH_DBG_TIMEOUT
657 struct _mpt_ioctl_events *events; /* pointer to event log */
658 fw_image_t **cached_fw; /* Pointer to FW SG List */
659 Q_TRACKER configQ; /* linked list of config. requests */
660 int num_fw_frags; /* Number of SGE in FW SG List */
667 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
668 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
669 IOCFactsReply_t facts;
670 PortFactsReply_t pfacts[2];
671 FCPortPage0_t fc_port_page0[2];
672 LANPage0_t lan_cnfg_page0;
673 LANPage1_t lan_cnfg_page1;
675 u32 PciState[64]; /* save PCI state to this area */
678 u8 upload_fw; /* If set, do a fw upload */
679 u8 reload_fw; /* Force a FW Reload on next reset */
684 typedef struct _MPT_ADAPTER_TRACKER {
687 } MPT_ADAPTER_TRACKER;
690 * New return value convention:
691 * 1 = Ok to free associated request frame
694 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
695 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
696 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
697 /* reset_phase defs */
698 #define MPT_IOC_PRE_RESET 0
699 #define MPT_IOC_POST_RESET 1
700 #define MPT_IOC_SETUP_RESET 2
703 * Invent MPT host event (super-set of MPI Events)
704 * Fitted to 1030's 64-byte [max] request frame size
706 typedef struct _MPT_HOST_EVENT {
707 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
712 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
713 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
715 /* Define the generic types based on the size
716 * of the dma_addr_t type.
718 typedef struct _mpt_sge {
723 #define mpt_addr_size() \
724 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
725 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
727 #define mpt_msg_flags() \
728 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
729 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
731 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
733 * Funky (private) macros...
736 #define dprintk(x) printk x
741 #ifdef MPT_DEBUG_HANDSHAKE
742 #define dhsprintk(x) printk x
747 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
748 #if defined(MPT_DEBUG_MSG_FRAME)
749 #define dmfprintk(x) printk x
755 #define dirqprintk(x) printk x
757 #define dirqprintk(x)
761 #define dsgprintk(x) printk x
766 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
767 #define ddlprintk(x) printk x
774 #define ddvprintk(x) printk x
779 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
780 #define ddvtprintk(x) printk x
782 #define ddvtprintk(x)
785 #ifdef MPT_DEBUG_IOCTL
786 #define dctlprintk(x) printk x
788 #define dctlprintk(x)
791 #ifdef MPT_DEBUG_RESET
792 #define dtmprintk(x) printk x
798 #define nehprintk(x) printk x
803 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
804 #define dcprintk(x) printk x
809 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
810 #define dsprintk(x) printk x
816 #define MPT_INDEX_2_MFPTR(ioc,idx) \
817 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
819 #define MFPTR_2_MPT_INDEX(ioc,mf) \
820 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
822 #define MPT_INDEX_2_RFPTR(ioc,idx) \
823 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
825 #define Q_INIT(q,type) (q)->head = (q)->tail = (type*)(q)
826 #define Q_IS_EMPTY(q) ((Q_ITEM*)(q)->head == (Q_ITEM*)(q))
828 #define Q_ADD_TAIL(qt,i,type) { \
829 Q_TRACKER *_qt = (Q_TRACKER*)(qt); \
830 Q_ITEM *oldTail = _qt->tail; \
831 (i)->forw = (type*)_qt; \
832 (i)->back = (type*)oldTail; \
833 oldTail->forw = (Q_ITEM*)(i); \
834 _qt->tail = (Q_ITEM*)(i); \
837 #define Q_ADD_HEAD(qt,i,type) { \
838 Q_TRACKER *_qt = (Q_TRACKER*)(qt); \
839 Q_ITEM *oldHead = _qt->head; \
840 (i)->forw = (type*)oldHead; \
841 (i)->back = (type*)_qt; \
842 oldHead->back = (Q_ITEM*)(i); \
843 _qt->head = (Q_ITEM*)(i); \
846 #define Q_DEL_ITEM(i) { \
847 Q_ITEM *_forw = (Q_ITEM*)(i)->forw; \
848 Q_ITEM *_back = (Q_ITEM*)(i)->back; \
849 _back->forw = _forw; \
850 _forw->back = _back; \
853 #define SWAB4(value) \
854 (u32)( (((value) & 0x000000ff) << 24) \
855 | (((value) & 0x0000ff00) << 8) \
856 | (((value) & 0x00ff0000) >> 8) \
857 | (((value) & 0xff000000) >> 24) )
860 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
861 #define DBG_DUMP_REPLY_FRAME(mfp) \
862 { u32 *m = (u32 *)(mfp); \
863 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
864 printk(KERN_INFO " "); \
865 for (i=0; i<n; i++) \
866 printk(" %08x", le32_to_cpu(m[i])); \
869 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
871 u32 *m = (u32 *)(mfp); \
872 printk(KERN_INFO " "); \
873 for (i=0; i<n; i++) \
874 printk(" %08x", le32_to_cpu(m[i])); \
878 #define DBG_DUMP_REPLY_FRAME(mfp)
879 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
883 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
886 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
887 * Private to the driver.
889 /* LOCAL structure and fields used when processing
890 * internally generated commands. These include:
891 * bus scan, dv and config requests.
893 typedef struct _MPT_LOCAL_REPLY {
894 ConfigPageHeader_t header;
896 u8 sense[SCSI_STD_SENSE_BYTES];
902 #define MPT_HOST_BUS_UNKNOWN (0xFF)
903 #define MPT_HOST_TOO_MANY_TM (0x05)
904 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
905 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
906 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
907 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
908 #define MPT_NVRAM_SYNC_SHIFT (8)
909 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
910 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
911 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
912 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
913 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
914 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
916 /* The TM_STATE variable is used to provide strict single threading of TM
917 * requests as well as communicate TM error conditions.
919 #define TM_STATE_NONE (0)
920 #define TM_STATE_IN_PROGRESS (1)
921 #define TM_STATE_ERROR (2)
923 typedef struct _MPT_SCSI_HOST {
927 struct scsi_cmnd **ScsiLookup;
928 /* Pool of buffers for chaining. ReqToChain
929 * and ChainToChain track index of chain buffers.
930 * ChainBuffer (DMA) virt/phys addresses.
931 * FreeChainQ (lock) locking mechanisms.
936 dma_addr_t ChainBufferDMA;
937 MPT_Q_TRACKER FreeChainQ;
938 spinlock_t FreeChainQlock;
940 VirtDevice **Targets;
941 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
942 struct timer_list timer;
943 struct timer_list TMtimer; /* Timer for TM commands ONLY */
944 /* Pool of memory for holding SCpnts before doing
945 * OS callbacks. freeQ is the free pool.
948 DONE_Q_TRACKER freeQ;
949 DONE_Q_TRACKER doneQ; /* Holds Linux formmatted requests */
950 DONE_Q_TRACKER pendingQ; /* Holds MPI formmatted requests */
951 MPT_Q_TRACKER taskQ; /* TM request Q */
952 spinlock_t freedoneQlock;
954 int num_chain; /* Number of chain buffers */
955 int max_sge; /* Max No of SGE*/
959 u8 is_spi; /* Parallel SCSI i/f */
960 u8 negoNvram; /* DV disabled, nego NVRAM */
961 u8 is_multipath; /* Multi-path compatible */
964 MPT_FRAME_HDR *tmPtr; /* Ptr to TM request*/
965 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
966 struct scsi_cmnd *abortSCpnt;
967 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
968 unsigned long hard_resets; /* driver forced bus resets count */
969 unsigned long soft_resets; /* fw/external bus resets count */
970 unsigned long timeouts; /* cmd timeouts */
971 ushort sel_timeout[MPT_MAX_FC_DEVICES];
975 * Structure for overlaying onto scsi_cmnd->SCp area
976 * NOTE: SCp area is 36 bytes min, 44 bytes max?
978 typedef struct _scPrivate {
979 struct scsi_cmnd *forw;
980 struct scsi_cmnd *back;
983 u8 io_path_id; /* DMP */
987 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
989 * More Dynamic Multi-Pathing stuff...
992 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
996 * DMP service layer structure / API interface
998 typedef struct _DmpServices {
999 VirtDevTracker VdevList;
1000 struct semaphore *Daemon;
1001 int (*ScsiPathSelect)
1002 (struct scsi_cmnd *, MPT_SCSI_HOST **hd, int *target, int *lun);
1004 (MPT_SCSI_HOST *, struct scsi_cmnd *,
1007 void (*mptscsih_scanVlist)
1008 (MPT_SCSI_HOST *, int portnum);
1010 (struct scsi_cmnd *);
1012 (struct scsi_cmnd *);
1015 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1017 * Generic structure passed to the base mpt_config function.
1019 typedef struct _x_config_parms {
1020 Q_ITEM linkage; /* linked list */
1021 struct timer_list timer; /* timer function for this request */
1022 ConfigPageHeader_t *hdr;
1023 dma_addr_t physAddr;
1024 int wait_done; /* wait for this request */
1025 u32 pageAddr; /* properly formatted */
1028 u8 timeout; /* seconds */
1034 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1036 * Public entry points...
1038 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1039 extern void mpt_deregister(int cb_idx);
1040 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1041 extern void mpt_event_deregister(int cb_idx);
1042 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1043 extern void mpt_reset_deregister(int cb_idx);
1044 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1045 extern void mpt_device_driver_deregister(int cb_idx);
1046 extern int mpt_register_ascqops_strings(void *ascqTable, int ascqtbl_sz, const char **opsTable);
1047 extern void mpt_deregister_ascqops_strings(void);
1048 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, int iocid);
1049 extern void mpt_free_msg_frame(int handle, int iocid, MPT_FRAME_HDR *mf);
1050 extern void mpt_put_msg_frame(int handle, int iocid, MPT_FRAME_HDR *mf);
1051 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1052 extern void mpt_add_chain(char *pAddr, u8 next, u16 length, dma_addr_t dma_addr);
1054 extern int mpt_send_handshake_request(int handle, int iocid, int reqBytes, u32 *req, int sleepFlag);
1055 extern int mpt_handshake_req_reply_wait(MPT_ADAPTER *ioc, int reqBytes, u32 *req, int replyBytes, u16 *u16reply, int maxwait, int sleepFlag);
1056 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1057 extern MPT_ADAPTER *mpt_adapter_find_first(void);
1058 extern MPT_ADAPTER *mpt_adapter_find_next(MPT_ADAPTER *prev);
1059 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1060 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1061 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1062 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1063 extern int mpt_toolbox(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1064 extern void *mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size, int *frags, int *alloc_sz);
1065 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc, fw_image_t **alt_img);
1066 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
1067 extern int mpt_read_ioc_pg_3(MPT_ADAPTER *ioc);
1070 * Public data decl's...
1072 extern MPT_ADAPTER *mpt_adapters[MPT_MAX_ADAPTERS];
1073 extern struct proc_dir_entry *mpt_proc_root_dir;
1074 extern DmpServices_t *DmpService;
1076 extern int mpt_lan_index; /* needed by mptlan.c */
1077 extern int mpt_stm_index; /* needed by mptstm.c */
1079 extern void *mpt_v_ASCQ_TablePtr;
1080 extern const char **mpt_ScsiOpcodesPtr;
1081 extern int mpt_ASCQ_TableSz;
1083 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1084 #endif /* } __KERNEL__ */
1087 * More (public) macros...
1090 #define offsetof(t, m) ((size_t) (&((t *)0)->m))
1093 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1094 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
1095 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
1097 #define CAST_U32_TO_PTR(x) ((void *)x)
1098 #define CAST_PTR_TO_U32(x) ((u32)x)
1101 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1102 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
1103 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
1104 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
1105 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
1108 * Shifted SGE Defines - Use in SGE with FlagsLength member.
1109 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1110 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1112 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1113 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1114 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1115 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1116 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1117 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1118 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1119 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1121 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1122 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1123 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1124 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1126 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1127 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1128 MPT_SGE_FLAGS_END_OF_BUFFER | \
1129 MPT_SGE_FLAGS_END_OF_LIST | \
1130 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1131 MPT_SGE_FLAGS_ADDRESSING | \
1132 MPT_TRANSFER_IOC_TO_HOST)
1133 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1134 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1135 MPT_SGE_FLAGS_END_OF_BUFFER | \
1136 MPT_SGE_FLAGS_END_OF_LIST | \
1137 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1138 MPT_SGE_FLAGS_ADDRESSING | \
1139 MPT_TRANSFER_HOST_TO_IOC)
1141 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/