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/version.h>
59 #include <linux/config.h>
60 #include <linux/kernel.h>
61 #include <linux/pci.h>
63 #include "lsi/mpi_type.h"
64 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
65 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
66 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
67 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
68 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
69 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
71 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
72 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
73 #include "lsi/mpi_tool.h" /* Tools support */
74 #include "lsi/fc_log.h"
76 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
79 #define MODULEAUTHOR "LSI Logic Corporation"
83 #define COPYRIGHT "Copyright (c) 1999-2004 " MODULEAUTHOR
86 #define MPT_LINUX_VERSION_COMMON "3.01.18"
87 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.01.18"
88 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
90 #define show_mptmod_ver(s,ver) \
91 printk(KERN_INFO "%s %s\n", s, ver);
93 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
95 * Fusion MPT(linux) driver configurable stuff...
97 #define MPT_MAX_ADAPTERS 18
98 #define MPT_MAX_PROTOCOL_DRIVERS 16
99 #define MPT_MAX_BUS 1 /* Do not change */
100 #define MPT_MAX_FC_DEVICES 255
101 #define MPT_MAX_SCSI_DEVICES 16
102 #define MPT_LAST_LUN 255
103 #define MPT_SENSE_BUFFER_ALLOC 64
104 /* allow for 256 max sense alloc, but only 255 max request */
105 #if MPT_SENSE_BUFFER_ALLOC >= 256
106 # undef MPT_SENSE_BUFFER_ALLOC
107 # define MPT_SENSE_BUFFER_ALLOC 256
108 # define MPT_SENSE_BUFFER_SIZE 255
110 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
113 #define MPT_NAME_LENGTH 32
115 #define MPT_PROCFS_MPTBASEDIR "mpt"
116 /* chg it to "driver/fusion" ? */
117 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
118 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
119 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
121 #define MPT_MAX_REQ_DEPTH 1023
122 #define MPT_DEFAULT_REQ_DEPTH 256
123 #define MPT_MIN_REQ_DEPTH 128
125 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
126 #define MPT_DEFAULT_REPLY_DEPTH 128
127 #define MPT_MIN_REPLY_DEPTH 8
128 #define MPT_MAX_REPLIES_PER_ISR 32
130 #define MPT_MAX_FRAME_SIZE 128
131 #define MPT_DEFAULT_FRAME_SIZE 128
133 #define MPT_REPLY_FRAME_SIZE 0x40 /* Must be a multiple of 8 */
135 #define MPT_SG_REQ_128_SCALE 1
136 #define MPT_SG_REQ_96_SCALE 2
137 #define MPT_SG_REQ_64_SCALE 4
142 #define MPT_COALESCING_TIMEOUT 0x10
145 * SCSI transfer rate defines.
147 #define MPT_ULTRA320 0x08
148 #define MPT_ULTRA160 0x09
149 #define MPT_ULTRA2 0x0A
150 #define MPT_ULTRA 0x0C
151 #define MPT_FAST 0x19
152 #define MPT_SCSI 0x32
153 #define MPT_ASYNC 0xFF
163 * Try to keep these at 2^N-1
165 #define MPT_FC_CAN_QUEUE 127
166 #define MPT_SCSI_CAN_QUEUE 127
169 * Set the MAX_SGE value based on user input.
171 #ifdef CONFIG_FUSION_MAX_SGE
172 #if CONFIG_FUSION_MAX_SGE < 16
173 #define MPT_SCSI_SG_DEPTH 16
174 #elif CONFIG_FUSION_MAX_SGE > 128
175 #define MPT_SCSI_SG_DEPTH 128
177 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
180 #define MPT_SCSI_SG_DEPTH 40
183 #ifdef __KERNEL__ /* { */
184 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
186 #include <linux/proc_fs.h>
188 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
190 * Attempt semi-consistent error & warning msgs across
191 * MPT drivers. NOTE: Users of these macro defs must
192 * themselves define their own MYNAM.
194 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
195 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
196 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
197 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
199 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
201 * MPT protocol driver defs...
204 MPTBASE_DRIVER, /* MPT base class */
205 MPTCTL_DRIVER, /* MPT ioctl class */
206 MPTSCSIH_DRIVER, /* MPT SCSI host (initiator) class */
207 MPTLAN_DRIVER, /* MPT LAN class */
208 MPTSTM_DRIVER, /* MPT SCSI target mode class */
212 struct mpt_pci_driver{
213 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
214 void (*remove) (struct pci_dev *dev);
215 void (*shutdown) (struct device * dev);
217 int (*resume) (struct pci_dev *dev);
218 int (*suspend) (struct pci_dev *dev, u32 state);
223 * MPT adapter / port / bus / device info structures...
226 typedef union _MPT_FRAME_TRACKER {
228 struct list_head list;
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 typedef struct _MPT_SGL_HDR {
292 SGESimple32_t sge[1];
295 typedef struct _MPT_SGL64_HDR {
296 SGESimple64_t sge[1];
300 * System interface register set
303 typedef struct _SYSIF_REGS
305 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
306 u32 WriteSequence; /* 04 Write Sequence register */
307 u32 Diagnostic; /* 08 Diagnostic register */
308 u32 TestBase; /* 0C Test Base Address */
309 u32 DiagRwData; /* 10 Read Write Data (fw download) */
310 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
311 u32 Reserved1[6]; /* 18-2F reserved for future use */
312 u32 IntStatus; /* 30 Interrupt Status */
313 u32 IntMask; /* 34 Interrupt Mask */
314 u32 Reserved2[2]; /* 38-3F reserved for future use */
315 u32 RequestFifo; /* 40 Request Post/Free FIFO */
316 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
317 u32 Reserved3[2]; /* 48-4F reserved for future use */
318 u32 HostIndex; /* 50 Host Index register */
319 u32 Reserved4[15]; /* 54-8F */
320 u32 Fubar; /* 90 For Fubar usage */
321 u32 Reserved5[27]; /* 94-FF */
325 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
326 * in conjunction with SYSIF_REGS accesses!
331 * Dynamic Multi-Pathing specific stuff...
334 /* VirtDevice negoFlags field */
335 #define MPT_TARGET_NO_NEGO_WIDE 0x01
336 #define MPT_TARGET_NO_NEGO_SYNC 0x02
337 #define MPT_TARGET_NO_NEGO_QAS 0x04
338 #define MPT_TAPE_NEGO_IDP 0x08
341 * VirtDevice - FC LUN device or SCSI target device
343 typedef struct _VirtDevice {
344 struct scsi_device *device;
349 u8 minSyncFactor; /* 0xFF is async */
350 u8 maxOffset; /* 0 if async */
351 u8 maxWidth; /* 0 if narrow, 1 if wide */
352 u8 negoFlags; /* bit field, see above */
353 u8 raidVolume; /* set, if RAID Volume */
354 u8 type; /* byte 0 of Inquiry data */
355 u8 cflags; /* controller flags */
360 u32 luns[8]; /* Max LUNs is 256 */
363 /* IEEE Registered Extended Identifier
364 obtained via INQUIRY VPD page 0x83 */
365 /* NOTE: Do not separate uniq_prepad and uniq_data
366 as they are treateed as a single entity in the code */
373 * Fibre Channel (SCSI) target device and associated defines...
375 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
376 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
377 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
378 #define MPT_TARGET_FLAGS_Q_YES 0x08
379 #define MPT_TARGET_FLAGS_VALID_56 0x10
380 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
383 * /proc/mpt interface
389 read_proc_t *read_proc;
390 write_proc_t *write_proc;
393 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
396 if (len < request) { \
402 *start = buf + offset; \
408 * IOCTL structure and associated defines
411 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
412 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
413 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
414 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
415 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
416 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
417 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
419 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
421 typedef struct _MPT_IOCTL {
422 struct _MPT_ADAPTER *ioc;
423 struct timer_list timer; /* timer function for this adapter */
424 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
425 u8 sense[MPT_SENSE_BUFFER_ALLOC];
426 int wait_done; /* wake-up value for this ioc */
428 u8 status; /* current command status */
429 u8 reset; /* 1 if bus reset allowed */
430 u8 target; /* target for reset */
432 struct timer_list TMtimer; /* timer function for this adapter */
433 struct semaphore sem_ioc;
437 * Event Structure and define
439 #define MPTCTL_EVENT_LOG_SIZE (0x0000000A)
440 typedef struct _mpt_ioctl_events {
441 u32 event; /* Specified by define above */
442 u32 eventContext; /* Index or counter */
443 int data[2]; /* First 8 bytes of Event Data */
447 * CONFIGPARM status defines
449 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
450 #define MPT_CONFIG_ERROR 0x002F
453 * Substructure to store SCSI specific configuration page data
455 /* dvStatus defines: */
456 #define MPT_SCSICFG_NEGOTIATE 0x01 /* Negotiate on next IO */
457 #define MPT_SCSICFG_NEED_DV 0x02 /* Schedule DV */
458 #define MPT_SCSICFG_DV_PENDING 0x04 /* DV on this physical id pending */
459 #define MPT_SCSICFG_DV_NOT_DONE 0x08 /* DV has not been performed */
460 #define MPT_SCSICFG_BLK_NEGO 0x10 /* WriteSDP1 with WDTR and SDTR disabled */
461 #define MPT_SCSICFG_RELOAD_IOC_PG3 0x20 /* IOC Pg 3 data is obsolete */
462 /* Args passed to writeSDP1: */
463 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
464 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
465 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
467 typedef struct _ScsiCfgData {
469 int *nvram; /* table of device NVRAM values */
470 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
471 IOCPage3_t *pIocPg3; /* table of physical disks */
472 IOCPage4_t *pIocPg4; /* SEP devices addressing */
473 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
474 int IocPg4Sz; /* IOCPage4 size */
475 u8 dvStatus[MPT_MAX_SCSI_DEVICES];
476 int isRaid; /* bit field, 1 if RAID */
477 u8 minSyncFactor; /* 0xFF if async */
478 u8 maxSyncOffset; /* 0 if async */
479 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
480 u8 busType; /* SE, LVD, HD */
481 u8 sdp1version; /* SDP1 version */
482 u8 sdp1length; /* SDP1 length */
483 u8 sdp0version; /* SDP0 version */
484 u8 sdp0length; /* SDP0 length */
485 u8 dvScheduled; /* 1 if scheduled */
486 u8 forceDv; /* 1 to force DV scheduling */
487 u8 noQas; /* Disable QAS for this adapter */
488 u8 Saf_Te; /* 1 to force all Processors as SAF-TE if Inquiry data length is too short to check for SAF-TE */
493 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
495 typedef struct _MPT_ADAPTER
497 int id; /* Unique adapter id N {0,1,2,...} */
498 int pci_irq; /* This irq */
499 char name[MPT_NAME_LENGTH]; /* "iocN" */
500 char *prod_name; /* "LSIFC9x9" */
501 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
502 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
504 u32 mem_phys; /* == f4020000 (mmap) */
505 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
506 int mem_size; /* mmap memory size */
510 u8 *alloc; /* frames alloc ptr */
511 dma_addr_t alloc_dma;
513 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
514 u32 reply_frames_low_dma;
515 int reply_depth; /* Num Allocated reply frames */
516 int reply_sz; /* Reply frame size */
517 int num_chain; /* Number of chain buffers */
518 /* Pool of buffers for chaining. ReqToChain
519 * and ChainToChain track index of chain buffers.
520 * ChainBuffer (DMA) virt/phys addresses.
521 * FreeChainQ (lock) locking mechanisms.
527 dma_addr_t ChainBufferDMA;
528 struct list_head FreeChainQ;
529 spinlock_t FreeChainQlock;
530 /* We (host driver) get to manage our own RequestQueue! */
531 dma_addr_t req_frames_dma;
532 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
533 u32 req_frames_low_dma;
534 int req_depth; /* Number of request frames */
535 int req_sz; /* Request frame size (bytes) */
536 spinlock_t FreeQlock;
537 struct list_head FreeQ;
538 /* Pool of SCSI sense buffers for commands coming from
539 * the SCSI mid-layer. We have one 256 byte sense buffer
540 * for each REQ entry.
543 dma_addr_t sense_buf_pool_dma;
544 u32 sense_buf_low_dma;
546 struct pci_dev *pcidev; /* struct pci_dev pointer */
547 u8 __iomem *memmap; /* mmap address */
548 struct Scsi_Host *sh; /* Scsi Host pointer */
549 ScsiCfgData spi_data; /* Scsi config. data */
550 MPT_IOCTL *ioctl; /* ioctl data pointer */
551 struct proc_dir_entry *ioc_dentry;
552 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
553 spinlock_t diagLock; /* diagnostic reset lock */
555 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
556 int eventTypes; /* Event logging parameters */
557 int eventContext; /* Next event context */
558 int eventLogSize; /* Max number of cached events */
559 struct _mpt_ioctl_events *events; /* pointer to event log */
560 u8 *cached_fw; /* Pointer to FW */
561 dma_addr_t cached_fw_dma;
562 struct list_head configQ; /* linked list of config. requests */
569 u32 NB_for_64_byte_frame;
570 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
571 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
572 IOCFactsReply_t facts;
573 PortFactsReply_t pfacts[2];
574 FCPortPage0_t fc_port_page0[2];
575 LANPage0_t lan_cnfg_page0;
576 LANPage1_t lan_cnfg_page1;
578 u8 upload_fw; /* If set, do a fw upload */
579 u8 reload_fw; /* Force a FW Reload on next reset */
580 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
582 struct list_head list;
583 struct net_device *netdev;
587 * New return value convention:
588 * 1 = Ok to free associated request frame
591 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
592 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
593 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
594 /* reset_phase defs */
595 #define MPT_IOC_PRE_RESET 0
596 #define MPT_IOC_POST_RESET 1
597 #define MPT_IOC_SETUP_RESET 2
600 * Invent MPT host event (super-set of MPI Events)
601 * Fitted to 1030's 64-byte [max] request frame size
603 typedef struct _MPT_HOST_EVENT {
604 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
609 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
610 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
612 /* Define the generic types based on the size
613 * of the dma_addr_t type.
615 typedef struct _mpt_sge {
620 #define mpt_addr_size() \
621 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
622 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
624 #define mpt_msg_flags() \
625 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
626 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
628 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
630 * Funky (private) macros...
633 #define dprintk(x) printk x
638 #ifdef MPT_DEBUG_INIT
639 #define dinitprintk(x) printk x
640 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
642 u32 *m = (u32 *)(mfp); \
643 printk(KERN_INFO " "); \
644 for (i=0; i<n; i++) \
645 printk(" %08x", le32_to_cpu(m[i])); \
649 #define dinitprintk(x)
650 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
653 #ifdef MPT_DEBUG_EXIT
654 #define dexitprintk(x) printk x
656 #define dexitprintk(x)
659 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
660 #define dfailprintk(x) printk x
662 #define dfailprintk(x)
665 #ifdef MPT_DEBUG_HANDSHAKE
666 #define dhsprintk(x) printk x
671 #ifdef MPT_DEBUG_EVENTS
672 #define devtprintk(x) printk x
674 #define devtprintk(x)
677 #ifdef MPT_DEBUG_RESET
678 #define drsprintk(x) printk x
683 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
684 #if defined(MPT_DEBUG_MSG_FRAME)
685 #define dmfprintk(x) printk x
686 #define DBG_DUMP_REQUEST_FRAME(mfp) \
688 u32 *m = (u32 *)(mfp); \
689 for (i=0; i<n; i++) { \
690 if (i && ((i%8)==0)) \
692 printk("%08x ", le32_to_cpu(m[i])); \
698 #define DBG_DUMP_REQUEST_FRAME(mfp)
702 #define dirqprintk(x) printk x
704 #define dirqprintk(x)
708 #define dsgprintk(x) printk x
713 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
714 #define ddlprintk(x) printk x
720 #define ddvprintk(x) printk x
725 #ifdef MPT_DEBUG_NEGO
726 #define dnegoprintk(x) printk x
728 #define dnegoprintk(x)
731 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
732 #define ddvtprintk(x) printk x
734 #define ddvtprintk(x)
737 #ifdef MPT_DEBUG_IOCTL
738 #define dctlprintk(x) printk x
740 #define dctlprintk(x)
743 #ifdef MPT_DEBUG_REPLY
744 #define dreplyprintk(x) printk x
746 #define dreplyprintk(x)
750 #define dtmprintk(x) printk x
751 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
752 { u32 *m = (u32 *)(mfp); \
754 printk("TM_REQUEST:\n"); \
755 for (i=0; i<n; i++) { \
756 if (i && ((i%8)==0)) \
758 printk("%08x ", le32_to_cpu(m[i])); \
762 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
763 { u32 *m = (u32 *)(mfp); \
764 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
765 printk("TM_REPLY MessageLength=%d:\n", n); \
766 for (i=0; i<n; i++) { \
767 if (i && ((i%8)==0)) \
769 printk(" %08x", le32_to_cpu(m[i])); \
775 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
776 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
780 #define nehprintk(x) printk x
785 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
786 #define dcprintk(x) printk x
791 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
792 #define dsprintk(x) printk x
798 #define MPT_INDEX_2_MFPTR(ioc,idx) \
799 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
801 #define MFPTR_2_MPT_INDEX(ioc,mf) \
802 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
804 #define MPT_INDEX_2_RFPTR(ioc,idx) \
805 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
807 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
808 #define DBG_DUMP_REPLY_FRAME(mfp) \
809 { u32 *m = (u32 *)(mfp); \
810 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
811 printk(KERN_INFO " "); \
812 for (i=0; i<n; i++) \
813 printk(" %08x", le32_to_cpu(m[i])); \
816 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
818 u32 *m = (u32 *)(mfp); \
819 printk(KERN_INFO " "); \
820 for (i=0; i<n; i++) \
821 printk(" %08x", le32_to_cpu(m[i])); \
825 #define DBG_DUMP_REPLY_FRAME(mfp)
826 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
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 struct scsi_cmnd **ScsiLookup;
886 VirtDevice **Targets;
887 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
888 struct timer_list timer;
889 struct timer_list TMtimer; /* Timer for TM commands ONLY */
890 /* Pool of memory for holding SCpnts before doing
891 * OS callbacks. freeQ is the free pool.
895 u8 negoNvram; /* DV disabled, nego NVRAM */
899 MPT_FRAME_HDR *tmPtr; /* Ptr to TM request*/
900 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
901 struct scsi_cmnd *abortSCpnt;
902 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
903 unsigned long hard_resets; /* driver forced bus resets count */
904 unsigned long soft_resets; /* fw/external bus resets count */
905 unsigned long timeouts; /* cmd timeouts */
906 ushort sel_timeout[MPT_MAX_FC_DEVICES];
909 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
911 * More Dynamic Multi-Pathing stuff...
914 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
917 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
919 * Generic structure passed to the base mpt_config function.
921 typedef struct _x_config_parms {
922 struct list_head linkage; /* linked list */
923 struct timer_list timer; /* timer function for this request */
924 ConfigPageHeader_t *hdr;
926 int wait_done; /* wait for this request */
927 u32 pageAddr; /* properly formatted */
930 u8 timeout; /* seconds */
936 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
938 * Public entry points...
940 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
941 extern void mpt_deregister(int cb_idx);
942 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
943 extern void mpt_event_deregister(int cb_idx);
944 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
945 extern void mpt_reset_deregister(int cb_idx);
946 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
947 extern void mpt_device_driver_deregister(int cb_idx);
948 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
949 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
950 extern void mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
951 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
953 extern int mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
954 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
955 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
956 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
957 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
958 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
959 extern int mpt_toolbox(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
960 extern void mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
961 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
962 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
963 extern int mpt_read_ioc_pg_3(MPT_ADAPTER *ioc);
966 * Public data decl's...
968 extern struct list_head ioc_list;
969 extern struct proc_dir_entry *mpt_proc_root_dir;
971 extern int mpt_lan_index; /* needed by mptlan.c */
972 extern int mpt_stm_index; /* needed by mptstm.c */
974 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
975 #endif /* } __KERNEL__ */
977 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
978 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
979 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
981 #define CAST_U32_TO_PTR(x) ((void *)x)
982 #define CAST_PTR_TO_U32(x) ((u32)x)
985 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
986 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
987 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
988 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
989 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
992 * Shifted SGE Defines - Use in SGE with FlagsLength member.
993 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
994 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
996 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
997 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
998 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
999 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1000 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1001 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1002 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1003 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1005 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1006 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1007 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1008 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1010 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1011 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1012 MPT_SGE_FLAGS_END_OF_BUFFER | \
1013 MPT_SGE_FLAGS_END_OF_LIST | \
1014 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1015 MPT_SGE_FLAGS_ADDRESSING | \
1016 MPT_TRANSFER_IOC_TO_HOST)
1017 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1018 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1019 MPT_SGE_FLAGS_END_OF_BUFFER | \
1020 MPT_SGE_FLAGS_END_OF_LIST | \
1021 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1022 MPT_SGE_FLAGS_ADDRESSING | \
1023 MPT_TRANSFER_HOST_TO_IOC)
1025 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/