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.16"
87 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.01.16"
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 */
209 MPTDMP_DRIVER
, /* MPT Dynamic Multi-pathing class */
213 struct mpt_pci_driver
{
214 int (*probe
) (struct pci_dev
*dev
, const struct pci_device_id
*id
);
215 void (*remove
) (struct pci_dev
*dev
);
216 void (*shutdown
) (struct device
* dev
);
218 int (*resume
) (struct pci_dev
*dev
);
219 int (*suspend
) (struct pci_dev
*dev
, u32 state
);
224 * MPT adapter / port / bus / device info structures...
227 typedef union _MPT_FRAME_TRACKER
{
229 struct _MPT_FRAME_HDR
*forw
;
230 struct _MPT_FRAME_HDR
*back
;
236 * NOTE: When request frames are free, on the linkage structure
237 * contets are valid. All other values are invalid.
238 * In particular, do NOT reply on offset [2]
239 * (in words) being the * message context.
240 * The message context must be reset (computed via base address
241 * + an offset) prior to issuing any command.
243 * NOTE2: On non-32-bit systems, where pointers are LARGE,
244 * using the linkage pointers destroys our sacred MsgContext
245 * field contents. But we don't care anymore because these
246 * are now reset in mpt_put_msg_frame() just prior to sending
247 * a request off to the IOC.
252 * The following _MUST_ match the location of the
253 * MsgContext field in the MPT message headers.
258 u16 req_idx
; /* Request index */
259 u8 cb_idx
; /* callback function index */
265 * Remark: 32 bit identifier:
267 * 23-16: call back index
268 * 15-0 : request index
273 * We might want to view/access a frame as:
274 * 1) generic request header
280 typedef struct _MPT_FRAME_HDR
{
283 SCSIIORequest_t scsireq
;
284 SCSIIOReply_t sreply
;
285 ConfigReply_t configreply
;
286 MPIDefaultReply_t reply
;
287 MPT_FRAME_TRACKER frame
;
291 #define MPT_REQ_MSGFLAGS_DROPME 0x80
293 /* Used for tracking the free request frames
294 * and free reply frames.
296 typedef struct _MPT_Q_TRACKER
{
302 typedef struct _MPT_SGL_HDR
{
303 SGESimple32_t sge
[1];
306 typedef struct _MPT_SGL64_HDR
{
307 SGESimple64_t sge
[1];
311 typedef struct _Q_ITEM
{
312 struct _Q_ITEM
*forw
;
313 struct _Q_ITEM
*back
;
316 typedef struct _Q_TRACKER
{
317 struct _Q_ITEM
*head
;
318 struct _Q_ITEM
*tail
;
322 * Chip-specific stuff... FC929 delineates break between
323 * FC and Parallel SCSI parts. Do NOT re-order.
338 * System interface register set
341 typedef struct _SYSIF_REGS
343 u32 Doorbell
; /* 00 System<->IOC Doorbell reg */
344 u32 WriteSequence
; /* 04 Write Sequence register */
345 u32 Diagnostic
; /* 08 Diagnostic register */
346 u32 TestBase
; /* 0C Test Base Address */
347 u32 DiagRwData
; /* 10 Read Write Data (fw download) */
348 u32 DiagRwAddress
; /* 14 Read Write Address (fw download)*/
349 u32 Reserved1
[6]; /* 18-2F reserved for future use */
350 u32 IntStatus
; /* 30 Interrupt Status */
351 u32 IntMask
; /* 34 Interrupt Mask */
352 u32 Reserved2
[2]; /* 38-3F reserved for future use */
353 u32 RequestFifo
; /* 40 Request Post/Free FIFO */
354 u32 ReplyFifo
; /* 44 Reply Post/Free FIFO */
355 u32 Reserved3
[2]; /* 48-4F reserved for future use */
356 u32 HostIndex
; /* 50 Host Index register */
357 u32 Reserved4
[15]; /* 54-8F */
358 u32 Fubar
; /* 90 For Fubar usage */
359 u32 Reserved5
[27]; /* 94-FF */
363 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
364 * in conjunction with SYSIF_REGS accesses!
369 * Dynamic Multi-Pathing specific stuff...
371 #define DMP_MAX_PATHS 8
373 typedef struct _PathInfo
{
380 #define PATHINFO_FLAGS_OWNED 0x01
381 #define PATHINFO_FLAGS_EXISTS 0x02
382 #define PATHINFO_FLAGS_AVAILABLE 0x04
383 #define PATHINFO_FLAGS_SECONDARY 0x08
385 #define PFLAGS_EXISTS_AND_AVAIL (PATHINFO_FLAGS_EXISTS|PATHINFO_FLAGS_AVAILABLE)
386 #define PFLAGS_AVAIL_AND_OWNED (PATHINFO_FLAGS_AVAILABLE|PATHINFO_FLAGS_OWNED)
388 typedef struct _ScsiCmndTracker
{
393 /* VirtDevice negoFlags field */
394 #define MPT_TARGET_NO_NEGO_WIDE 0x01
395 #define MPT_TARGET_NO_NEGO_SYNC 0x02
396 #define MPT_TARGET_NO_NEGO_QAS 0x04
397 #define MPT_TAPE_NEGO_IDP 0x08
400 * VirtDevice - FC LUN device or SCSI target device
401 * (used to be FCSCSI_TARGET)
403 typedef struct _VirtDevice
{
404 struct _VirtDevice
*forw
;
405 struct _VirtDevice
*back
;
406 struct scsi_device
*device
;
413 u8 minSyncFactor
; /* 0xFF is async */
414 u8 maxOffset
; /* 0 if async */
415 u8 maxWidth
; /* 0 if narrow, 1 if wide */
416 u8 negoFlags
; /* bit field, see above */
417 u8 raidVolume
; /* set, if RAID Volume */
418 u8 type
; /* byte 0 of Inquiry data */
419 u8 cflags
; /* controller flags */
425 PathInfo path
[DMP_MAX_PATHS
];
426 struct timer_list stall_timer
;
427 struct timer_list retry_timer
;
428 struct timer_list gone_timer
;
429 ScsiCmndTracker WaitQ
;
430 ScsiCmndTracker SentQ
;
431 ScsiCmndTracker DoneQ
;
433 u32 luns
[8]; /* Max LUNs is 256 */
436 /* IEEE Registered Extended Identifier
437 obtained via INQUIRY VPD page 0x83 */
438 /* NOTE: Do not separate uniq_prepad and uniq_data
439 as they are treateed as a single entity in the code */
446 * Fibre Channel (SCSI) target device and associated defines...
448 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
449 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
450 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
451 #define MPT_TARGET_FLAGS_Q_YES 0x08
452 #define MPT_TARGET_FLAGS_VALID_56 0x10
453 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
455 typedef struct _VirtDevTracker
{
456 struct _VirtDevice
*head
;
457 struct _VirtDevice
*tail
;
464 * /proc/mpt interface
470 read_proc_t
*read_proc
;
471 write_proc_t
*write_proc
;
474 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
477 if (len < request) { \
483 *start = buf + offset; \
489 * IOCTL structure and associated defines
492 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
493 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
494 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
495 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
496 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
497 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
498 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
500 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
502 typedef struct _MPT_IOCTL
{
503 struct _MPT_ADAPTER
*ioc
;
504 struct timer_list timer
; /* timer function for this adapter */
505 u8 ReplyFrame
[MPT_DEFAULT_FRAME_SIZE
]; /* reply frame data */
506 u8 sense
[MPT_SENSE_BUFFER_ALLOC
];
507 int wait_done
; /* wake-up value for this ioc */
509 u8 status
; /* current command status */
510 u8 reset
; /* 1 if bus reset allowed */
511 u8 target
; /* target for reset */
513 struct timer_list TMtimer
; /* timer function for this adapter */
514 struct semaphore sem_ioc
;
518 * Event Structure and define
520 #define MPTCTL_EVENT_LOG_SIZE (0x0000000A)
521 typedef struct _mpt_ioctl_events
{
522 u32 event
; /* Specified by define above */
523 u32 eventContext
; /* Index or counter */
524 int data
[2]; /* First 8 bytes of Event Data */
528 * CONFIGPARM status defines
530 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
531 #define MPT_CONFIG_ERROR 0x002F
534 * Substructure to store SCSI specific configuration page data
536 /* dvStatus defines: */
537 #define MPT_SCSICFG_NEGOTIATE 0x01 /* Negotiate on next IO */
538 #define MPT_SCSICFG_NEED_DV 0x02 /* Schedule DV */
539 #define MPT_SCSICFG_DV_PENDING 0x04 /* DV on this physical id pending */
540 #define MPT_SCSICFG_DV_NOT_DONE 0x08 /* DV has not been performed */
541 #define MPT_SCSICFG_BLK_NEGO 0x10 /* WriteSDP1 with WDTR and SDTR disabled */
542 #define MPT_SCSICFG_RELOAD_IOC_PG3 0x20 /* IOC Pg 3 data is obsolete */
543 /* Args passed to writeSDP1: */
544 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
545 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
546 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
548 typedef struct _ScsiCfgData
{
550 int *nvram
; /* table of device NVRAM values */
551 IOCPage2_t
*pIocPg2
; /* table of Raid Volumes */
552 IOCPage3_t
*pIocPg3
; /* table of physical disks */
553 IOCPage4_t
*pIocPg4
; /* SEP devices addressing */
554 dma_addr_t IocPg4_dma
; /* Phys Addr of IOCPage4 data */
555 int IocPg4Sz
; /* IOCPage4 size */
556 u8 dvStatus
[MPT_MAX_SCSI_DEVICES
];
557 int isRaid
; /* bit field, 1 if RAID */
558 u8 minSyncFactor
; /* 0xFF if async */
559 u8 maxSyncOffset
; /* 0 if async */
560 u8 maxBusWidth
; /* 0 if narrow, 1 if wide */
561 u8 busType
; /* SE, LVD, HD */
562 u8 sdp1version
; /* SDP1 version */
563 u8 sdp1length
; /* SDP1 length */
564 u8 sdp0version
; /* SDP0 version */
565 u8 sdp0length
; /* SDP0 length */
566 u8 dvScheduled
; /* 1 if scheduled */
567 u8 forceDv
; /* 1 to force DV scheduling */
568 u8 noQas
; /* Disable QAS for this adapter */
569 u8 Saf_Te
; /* 1 to force all Processors as SAF-TE if Inquiry data length is too short to check for SAF-TE */
574 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
576 typedef struct _MPT_ADAPTER
578 struct _MPT_ADAPTER
*forw
;
579 struct _MPT_ADAPTER
*back
;
580 int id
; /* Unique adapter id N {0,1,2,...} */
581 int pci_irq
; /* This irq */
582 char name
[MPT_NAME_LENGTH
]; /* "iocN" */
583 char *prod_name
; /* "LSIFC9x9" */
584 SYSIF_REGS __iomem
*chip
; /* == c8817000 (mmap) */
585 SYSIF_REGS __iomem
*pio_chip
; /* Programmed IO (downloadboot) */
586 u32 mem_phys
; /* == f4020000 (mmap) */
587 u32 pio_mem_phys
; /* Programmed IO (downloadboot) */
588 int mem_size
; /* mmap memory size */
592 u8
*alloc
; /* frames alloc ptr */
593 dma_addr_t alloc_dma
;
595 MPT_FRAME_HDR
*reply_frames
; /* Reply msg frames - rounded up! */
596 u32 reply_frames_low_dma
;
597 int reply_depth
; /* Num Allocated reply frames */
598 int reply_sz
; /* Reply frame size */
599 int num_chain
; /* Number of chain buffers */
600 /* Pool of buffers for chaining. ReqToChain
601 * and ChainToChain track index of chain buffers.
602 * ChainBuffer (DMA) virt/phys addresses.
603 * FreeChainQ (lock) locking mechanisms.
609 dma_addr_t ChainBufferDMA
;
610 MPT_Q_TRACKER FreeChainQ
;
611 spinlock_t FreeChainQlock
;
613 /* We (host driver) get to manage our own RequestQueue! */
614 dma_addr_t req_frames_dma
;
615 MPT_FRAME_HDR
*req_frames
; /* Request msg frames - rounded up! */
616 u32 req_frames_low_dma
;
617 int req_depth
; /* Number of request frames */
618 int req_sz
; /* Request frame size (bytes) */
619 spinlock_t FreeQlock
;
621 /* Pool of SCSI sense buffers for commands coming from
622 * the SCSI mid-layer. We have one 256 byte sense buffer
623 * for each REQ entry.
626 dma_addr_t sense_buf_pool_dma
;
627 u32 sense_buf_low_dma
;
629 struct pci_dev
*pcidev
; /* struct pci_dev pointer */
630 u8
*memmap
; /* mmap address */
631 struct Scsi_Host
*sh
; /* Scsi Host pointer */
632 ScsiCfgData spi_data
; /* Scsi config. data */
633 MPT_IOCTL
*ioctl
; /* ioctl data pointer */
634 struct proc_dir_entry
*ioc_dentry
;
635 struct _MPT_ADAPTER
*alt_ioc
; /* ptr to 929 bound adapter port */
636 spinlock_t diagLock
; /* diagnostic reset lock */
638 u32 biosVersion
; /* BIOS version from IO Unit Page 2 */
639 int eventTypes
; /* Event logging parameters */
640 int eventContext
; /* Next event context */
641 int eventLogSize
; /* Max number of cached events */
642 #ifdef MPTSCSIH_DBG_TIMEOUT
648 struct _mpt_ioctl_events
*events
; /* pointer to event log */
649 u8
*cached_fw
; /* Pointer to FW */
650 dma_addr_t cached_fw_dma
;
651 Q_TRACKER configQ
; /* linked list of config. requests */
658 u32 NB_for_64_byte_frame
;
659 u32 hs_req
[MPT_MAX_FRAME_SIZE
/sizeof(u32
)];
660 u16 hs_reply
[MPT_MAX_FRAME_SIZE
/sizeof(u16
)];
661 IOCFactsReply_t facts
;
662 PortFactsReply_t pfacts
[2];
663 FCPortPage0_t fc_port_page0
[2];
664 LANPage0_t lan_cnfg_page0
;
665 LANPage1_t lan_cnfg_page1
;
667 u32 PciState
[64]; /* save PCI state to this area */
670 u8 upload_fw
; /* If set, do a fw upload */
671 u8 reload_fw
; /* Force a FW Reload on next reset */
672 u8 NBShiftFactor
; /* NB Shift Factor based on Block Size (Facts) */
674 struct list_head list
;
675 struct net_device
*netdev
;
679 typedef struct _MPT_ADAPTER_TRACKER
{
682 } MPT_ADAPTER_TRACKER
;
685 * New return value convention:
686 * 1 = Ok to free associated request frame
689 typedef int (*MPT_CALLBACK
)(MPT_ADAPTER
*ioc
, MPT_FRAME_HDR
*req
, MPT_FRAME_HDR
*reply
);
690 typedef int (*MPT_EVHANDLER
)(MPT_ADAPTER
*ioc
, EventNotificationReply_t
*evReply
);
691 typedef int (*MPT_RESETHANDLER
)(MPT_ADAPTER
*ioc
, int reset_phase
);
692 /* reset_phase defs */
693 #define MPT_IOC_PRE_RESET 0
694 #define MPT_IOC_POST_RESET 1
695 #define MPT_IOC_SETUP_RESET 2
698 * Invent MPT host event (super-set of MPI Events)
699 * Fitted to 1030's 64-byte [max] request frame size
701 typedef struct _MPT_HOST_EVENT
{
702 EventNotificationReply_t MpiEvent
; /* 8 32-bit words! */
707 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
708 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
710 /* Define the generic types based on the size
711 * of the dma_addr_t type.
713 typedef struct _mpt_sge
{
718 #define mpt_addr_size() \
719 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
720 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
722 #define mpt_msg_flags() \
723 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
724 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
726 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
728 * Funky (private) macros...
731 #define dprintk(x) printk x
736 #ifdef MPT_DEBUG_INIT
737 #define dinitprintk(x) printk x
738 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
740 u32 *m = (u32 *)(mfp); \
741 printk(KERN_INFO " "); \
742 for (i=0; i<n; i++) \
743 printk(" %08x", le32_to_cpu(m[i])); \
747 #define dinitprintk(x)
748 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
751 #ifdef MPT_DEBUG_EXIT
752 #define dexitprintk(x) printk x
754 #define dexitprintk(x)
757 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
758 #define dfailprintk(x) printk x
760 #define dfailprintk(x)
763 #ifdef MPT_DEBUG_HANDSHAKE
764 #define dhsprintk(x) printk x
769 #ifdef MPT_DEBUG_EVENTS
770 #define devtprintk(x) printk x
772 #define devtprintk(x)
775 #ifdef MPT_DEBUG_RESET
776 #define drsprintk(x) printk x
781 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
782 #if defined(MPT_DEBUG_MSG_FRAME)
783 #define dmfprintk(x) printk x
784 #define DBG_DUMP_REQUEST_FRAME(mfp) \
786 u32 *m = (u32 *)(mfp); \
787 for (i=0; i<n; i++) { \
788 if (i && ((i%8)==0)) \
790 printk("%08x ", le32_to_cpu(m[i])); \
796 #define DBG_DUMP_REQUEST_FRAME(mfp)
800 #define dirqprintk(x) printk x
802 #define dirqprintk(x)
806 #define dsgprintk(x) printk x
811 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
812 #define ddlprintk(x) printk x
818 #define ddvprintk(x) printk x
823 #ifdef MPT_DEBUG_NEGO
824 #define dnegoprintk(x) printk x
826 #define dnegoprintk(x)
829 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
830 #define ddvtprintk(x) printk x
832 #define ddvtprintk(x)
835 #ifdef MPT_DEBUG_IOCTL
836 #define dctlprintk(x) printk x
838 #define dctlprintk(x)
841 #ifdef MPT_DEBUG_REPLY
842 #define dreplyprintk(x) printk x
844 #define dreplyprintk(x)
848 #define dtmprintk(x) printk x
849 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
850 { u32 *m = (u32 *)(mfp); \
852 printk("TM_REQUEST:\n"); \
853 for (i=0; i<n; i++) { \
854 if (i && ((i%8)==0)) \
856 printk("%08x ", le32_to_cpu(m[i])); \
860 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
861 { u32 *m = (u32 *)(mfp); \
862 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
863 printk("TM_REPLY MessageLength=%d:\n", n); \
864 for (i=0; i<n; i++) { \
865 if (i && ((i%8)==0)) \
867 printk(" %08x", le32_to_cpu(m[i])); \
873 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
874 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
878 #define nehprintk(x) printk x
883 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
884 #define dcprintk(x) printk x
889 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
890 #define dsprintk(x) printk x
896 #define MPT_INDEX_2_MFPTR(ioc,idx) \
897 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
899 #define MFPTR_2_MPT_INDEX(ioc,mf) \
900 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
902 #define MPT_INDEX_2_RFPTR(ioc,idx) \
903 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
905 #define Q_INIT(q,type) (q)->head = (q)->tail = (type*)(q)
906 #define Q_IS_EMPTY(q) ((Q_ITEM*)(q)->head == (Q_ITEM*)(q))
908 #define Q_ADD_TAIL(qt,i,type) { \
909 Q_TRACKER *_qt = (Q_TRACKER*)(qt); \
910 Q_ITEM *oldTail = _qt->tail; \
911 (i)->forw = (type*)_qt; \
912 (i)->back = (type*)oldTail; \
913 oldTail->forw = (Q_ITEM*)(i); \
914 _qt->tail = (Q_ITEM*)(i); \
917 #define Q_ADD_HEAD(qt,i,type) { \
918 Q_TRACKER *_qt = (Q_TRACKER*)(qt); \
919 Q_ITEM *oldHead = _qt->head; \
920 (i)->forw = (type*)oldHead; \
921 (i)->back = (type*)_qt; \
922 oldHead->back = (Q_ITEM*)(i); \
923 _qt->head = (Q_ITEM*)(i); \
926 #define Q_DEL_ITEM(i) { \
927 Q_ITEM *_forw = (Q_ITEM*)(i)->forw; \
928 Q_ITEM *_back = (Q_ITEM*)(i)->back; \
929 _back->forw = _forw; \
930 _forw->back = _back; \
933 #define SWAB4(value) \
934 (u32)( (((value) & 0x000000ff) << 24) \
935 | (((value) & 0x0000ff00) << 8) \
936 | (((value) & 0x00ff0000) >> 8) \
937 | (((value) & 0xff000000) >> 24) )
940 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
941 #define DBG_DUMP_REPLY_FRAME(mfp) \
942 { u32 *m = (u32 *)(mfp); \
943 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
944 printk(KERN_INFO " "); \
945 for (i=0; i<n; i++) \
946 printk(" %08x", le32_to_cpu(m[i])); \
949 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
951 u32 *m = (u32 *)(mfp); \
952 printk(KERN_INFO " "); \
953 for (i=0; i<n; i++) \
954 printk(" %08x", le32_to_cpu(m[i])); \
958 #define DBG_DUMP_REPLY_FRAME(mfp)
959 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
963 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
965 #define SCSI_STD_SENSE_BYTES 18
966 #define SCSI_STD_INQUIRY_BYTES 36
967 #define SCSI_MAX_INQUIRY_BYTES 96
970 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
971 * Private to the driver.
973 /* LOCAL structure and fields used when processing
974 * internally generated commands. These include:
975 * bus scan, dv and config requests.
977 typedef struct _MPT_LOCAL_REPLY
{
978 ConfigPageHeader_t header
;
980 u8 sense
[SCSI_STD_SENSE_BYTES
];
986 #define MPT_HOST_BUS_UNKNOWN (0xFF)
987 #define MPT_HOST_TOO_MANY_TM (0x05)
988 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
989 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
990 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
991 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
992 #define MPT_NVRAM_SYNC_SHIFT (8)
993 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
994 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
995 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
996 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
997 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
998 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
1000 /* The TM_STATE variable is used to provide strict single threading of TM
1001 * requests as well as communicate TM error conditions.
1003 #define TM_STATE_NONE (0)
1004 #define TM_STATE_IN_PROGRESS (1)
1005 #define TM_STATE_ERROR (2)
1007 typedef struct _MPT_SCSI_HOST
{
1011 struct scsi_cmnd
**ScsiLookup
;
1013 VirtDevice
**Targets
;
1014 MPT_LOCAL_REPLY
*pLocal
; /* used for internal commands */
1015 struct timer_list timer
;
1016 struct timer_list TMtimer
; /* Timer for TM commands ONLY */
1017 /* Pool of memory for holding SCpnts before doing
1018 * OS callbacks. freeQ is the free pool.
1020 MPT_Q_TRACKER taskQ
; /* TM request Q */
1024 u8 is_spi
; /* Parallel SCSI i/f */
1025 u8 negoNvram
; /* DV disabled, nego NVRAM */
1026 u8 is_multipath
; /* Multi-path compatible */
1029 MPT_FRAME_HDR
*tmPtr
; /* Ptr to TM request*/
1030 MPT_FRAME_HDR
*cmdPtr
; /* Ptr to nonOS request */
1031 struct scsi_cmnd
*abortSCpnt
;
1032 MPT_LOCAL_REPLY localReply
; /* internal cmd reply struct */
1033 unsigned long hard_resets
; /* driver forced bus resets count */
1034 unsigned long soft_resets
; /* fw/external bus resets count */
1035 unsigned long timeouts
; /* cmd timeouts */
1036 ushort sel_timeout
[MPT_MAX_FC_DEVICES
];
1039 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1041 * More Dynamic Multi-Pathing stuff...
1044 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
1048 * DMP service layer structure / API interface
1050 typedef struct _DmpServices
{
1051 VirtDevTracker VdevList
;
1052 struct semaphore
*Daemon
;
1053 int (*ScsiPathSelect
)
1054 (struct scsi_cmnd
*, MPT_SCSI_HOST
**hd
, int *target
, int *lun
);
1056 (MPT_SCSI_HOST
*, struct scsi_cmnd
*,
1059 void (*mptscsih_scanVlist
)
1060 (MPT_SCSI_HOST
*, int portnum
);
1062 (struct scsi_cmnd
*);
1064 (struct scsi_cmnd
*);
1067 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1069 * Generic structure passed to the base mpt_config function.
1071 typedef struct _x_config_parms
{
1072 Q_ITEM linkage
; /* linked list */
1073 struct timer_list timer
; /* timer function for this request */
1074 ConfigPageHeader_t
*hdr
;
1075 dma_addr_t physAddr
;
1076 int wait_done
; /* wait for this request */
1077 u32 pageAddr
; /* properly formatted */
1080 u8 timeout
; /* seconds */
1086 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1088 * Public entry points...
1090 extern int mpt_register(MPT_CALLBACK cbfunc
, MPT_DRIVER_CLASS dclass
);
1091 extern void mpt_deregister(int cb_idx
);
1092 extern int mpt_event_register(int cb_idx
, MPT_EVHANDLER ev_cbfunc
);
1093 extern void mpt_event_deregister(int cb_idx
);
1094 extern int mpt_reset_register(int cb_idx
, MPT_RESETHANDLER reset_func
);
1095 extern void mpt_reset_deregister(int cb_idx
);
1096 extern int mpt_device_driver_register(struct mpt_pci_driver
* dd_cbfunc
, int cb_idx
);
1097 extern void mpt_device_driver_deregister(int cb_idx
);
1098 extern MPT_FRAME_HDR
*mpt_get_msg_frame(int handle
, MPT_ADAPTER
*ioc
);
1099 extern void mpt_free_msg_frame(MPT_ADAPTER
*ioc
, MPT_FRAME_HDR
*mf
);
1100 extern void mpt_put_msg_frame(int handle
, MPT_ADAPTER
*ioc
, MPT_FRAME_HDR
*mf
);
1101 extern void mpt_add_sge(char *pAddr
, u32 flagslength
, dma_addr_t dma_addr
);
1102 extern void mpt_add_chain(char *pAddr
, u8 next
, u16 length
, dma_addr_t dma_addr
);
1104 extern int mpt_send_handshake_request(int handle
, MPT_ADAPTER
*ioc
, int reqBytes
, u32
*req
, int sleepFlag
);
1105 extern int mpt_handshake_req_reply_wait(MPT_ADAPTER
*ioc
, int reqBytes
, u32
*req
, int replyBytes
, u16
*u16reply
, int maxwait
, int sleepFlag
);
1106 extern int mpt_verify_adapter(int iocid
, MPT_ADAPTER
**iocpp
);
1107 extern u32
mpt_GetIocState(MPT_ADAPTER
*ioc
, int cooked
);
1108 extern void mpt_print_ioc_summary(MPT_ADAPTER
*ioc
, char *buf
, int *size
, int len
, int showlan
);
1109 extern int mpt_HardResetHandler(MPT_ADAPTER
*ioc
, int sleepFlag
);
1110 extern int mpt_config(MPT_ADAPTER
*ioc
, CONFIGPARMS
*cfg
);
1111 extern int mpt_toolbox(MPT_ADAPTER
*ioc
, CONFIGPARMS
*cfg
);
1112 extern void mpt_alloc_fw_memory(MPT_ADAPTER
*ioc
, int size
);
1113 extern void mpt_free_fw_memory(MPT_ADAPTER
*ioc
);
1114 extern int mpt_findImVolumes(MPT_ADAPTER
*ioc
);
1115 extern int mpt_read_ioc_pg_3(MPT_ADAPTER
*ioc
);
1118 * Public data decl's...
1120 extern struct list_head ioc_list
;
1121 extern struct proc_dir_entry
*mpt_proc_root_dir
;
1122 extern DmpServices_t
*DmpService
;
1124 extern int mpt_lan_index
; /* needed by mptlan.c */
1125 extern int mpt_stm_index
; /* needed by mptstm.c */
1127 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1128 #endif /* } __KERNEL__ */
1131 * More (public) macros...
1134 #define offsetof(t, m) ((size_t) (&((t *)0)->m))
1137 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1138 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
1139 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
1141 #define CAST_U32_TO_PTR(x) ((void *)x)
1142 #define CAST_PTR_TO_U32(x) ((u32)x)
1145 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1146 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
1147 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
1148 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
1149 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
1152 * Shifted SGE Defines - Use in SGE with FlagsLength member.
1153 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1154 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1156 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1157 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1158 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1159 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1160 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1161 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1162 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1163 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1165 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1166 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1167 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1168 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1170 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1171 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1172 MPT_SGE_FLAGS_END_OF_BUFFER | \
1173 MPT_SGE_FLAGS_END_OF_LIST | \
1174 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1175 MPT_SGE_FLAGS_ADDRESSING | \
1176 MPT_TRANSFER_IOC_TO_HOST)
1177 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1178 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1179 MPT_SGE_FLAGS_END_OF_BUFFER | \
1180 MPT_SGE_FLAGS_END_OF_LIST | \
1181 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1182 MPT_SGE_FLAGS_ADDRESSING | \
1183 MPT_TRANSFER_HOST_TO_IOC)
1185 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/