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.
8 * Copyright (c) 1999-2005 LSI Logic Corporation
9 * (mailto:mpt_linux_developer@lsil.com)
12 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; version 2 of the License.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
24 THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
25 CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
26 LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
27 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
28 solely responsible for determining the appropriateness of using and
29 distributing the Program and assumes all risks associated with its
30 exercise of rights under this Agreement, including but not limited to
31 the risks and costs of program errors, damage to or loss of data,
32 programs or equipment, and unavailability or interruption of operations.
34 DISCLAIMER OF LIABILITY
35 NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
36 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
38 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
39 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
40 USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
41 HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
43 You should have received a copy of the GNU General Public License
44 along with this program; if not, write to the Free Software
45 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
48 #ifndef MPTBASE_H_INCLUDED
49 #define MPTBASE_H_INCLUDED
50 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
52 #include <linux/config.h>
53 #include <linux/kernel.h>
54 #include <linux/pci.h>
56 #include "lsi/mpi_type.h"
57 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
58 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
59 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
60 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
61 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
62 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
64 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
65 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
66 #include "lsi/mpi_tool.h" /* Tools support */
67 #include "lsi/mpi_sas.h" /* SAS support */
69 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
72 #define MODULEAUTHOR "LSI Logic Corporation"
76 #define COPYRIGHT "Copyright (c) 1999-2005 " MODULEAUTHOR
79 #define MPT_LINUX_VERSION_COMMON "3.03.07"
80 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.03.07"
81 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
83 #define show_mptmod_ver(s,ver) \
84 printk(KERN_INFO "%s %s\n", s, ver);
86 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
88 * Fusion MPT(linux) driver configurable stuff...
90 #define MPT_MAX_ADAPTERS 18
91 #define MPT_MAX_PROTOCOL_DRIVERS 16
92 #define MPT_MAX_BUS 1 /* Do not change */
93 #define MPT_MAX_FC_DEVICES 255
94 #define MPT_MAX_SCSI_DEVICES 16
95 #define MPT_LAST_LUN 255
96 #define MPT_SENSE_BUFFER_ALLOC 64
97 /* allow for 256 max sense alloc, but only 255 max request */
98 #if MPT_SENSE_BUFFER_ALLOC >= 256
99 # undef MPT_SENSE_BUFFER_ALLOC
100 # define MPT_SENSE_BUFFER_ALLOC 256
101 # define MPT_SENSE_BUFFER_SIZE 255
103 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
106 #define MPT_NAME_LENGTH 32
108 #define MPT_PROCFS_MPTBASEDIR "mpt"
109 /* chg it to "driver/fusion" ? */
110 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
111 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
112 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
114 #define MPT_MAX_REQ_DEPTH 1023
115 #define MPT_DEFAULT_REQ_DEPTH 256
116 #define MPT_MIN_REQ_DEPTH 128
118 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
119 #define MPT_DEFAULT_REPLY_DEPTH 128
120 #define MPT_MIN_REPLY_DEPTH 8
121 #define MPT_MAX_REPLIES_PER_ISR 32
123 #define MPT_MAX_FRAME_SIZE 128
124 #define MPT_DEFAULT_FRAME_SIZE 128
126 #define MPT_REPLY_FRAME_SIZE 0x50 /* Must be a multiple of 8 */
128 #define MPT_SG_REQ_128_SCALE 1
129 #define MPT_SG_REQ_96_SCALE 2
130 #define MPT_SG_REQ_64_SCALE 4
135 #define MPT_COALESCING_TIMEOUT 0x10
138 * SCSI transfer rate defines.
140 #define MPT_ULTRA320 0x08
141 #define MPT_ULTRA160 0x09
142 #define MPT_ULTRA2 0x0A
143 #define MPT_ULTRA 0x0C
144 #define MPT_FAST 0x19
145 #define MPT_SCSI 0x32
146 #define MPT_ASYNC 0xFF
156 * Try to keep these at 2^N-1
158 #define MPT_FC_CAN_QUEUE 127
159 #define MPT_SCSI_CAN_QUEUE 127
162 * Set the MAX_SGE value based on user input.
164 #ifdef CONFIG_FUSION_MAX_SGE
165 #if CONFIG_FUSION_MAX_SGE < 16
166 #define MPT_SCSI_SG_DEPTH 16
167 #elif CONFIG_FUSION_MAX_SGE > 128
168 #define MPT_SCSI_SG_DEPTH 128
170 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
173 #define MPT_SCSI_SG_DEPTH 40
176 #ifdef __KERNEL__ /* { */
177 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
179 #include <linux/proc_fs.h>
181 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
183 * Attempt semi-consistent error & warning msgs across
184 * MPT drivers. NOTE: Users of these macro defs must
185 * themselves define their own MYNAM.
187 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
188 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
189 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
190 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
192 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
194 * MPT protocol driver defs...
197 MPTBASE_DRIVER, /* MPT base class */
198 MPTCTL_DRIVER, /* MPT ioctl class */
199 MPTSPI_DRIVER, /* MPT SPI host class */
200 MPTFC_DRIVER, /* MPT FC host class */
201 MPTSAS_DRIVER, /* MPT SAS host class */
202 MPTLAN_DRIVER, /* MPT LAN class */
203 MPTSTM_DRIVER, /* MPT SCSI target mode class */
207 struct mpt_pci_driver{
208 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
209 void (*remove) (struct pci_dev *dev);
213 * MPT adapter / port / bus / device info structures...
216 typedef union _MPT_FRAME_TRACKER {
218 struct list_head list;
224 * NOTE: When request frames are free, on the linkage structure
225 * contets are valid. All other values are invalid.
226 * In particular, do NOT reply on offset [2]
227 * (in words) being the * message context.
228 * The message context must be reset (computed via base address
229 * + an offset) prior to issuing any command.
231 * NOTE2: On non-32-bit systems, where pointers are LARGE,
232 * using the linkage pointers destroys our sacred MsgContext
233 * field contents. But we don't care anymore because these
234 * are now reset in mpt_put_msg_frame() just prior to sending
235 * a request off to the IOC.
240 * The following _MUST_ match the location of the
241 * MsgContext field in the MPT message headers.
246 u16 req_idx; /* Request index */
247 u8 cb_idx; /* callback function index */
253 * Remark: 32 bit identifier:
255 * 23-16: call back index
256 * 15-0 : request index
261 * We might want to view/access a frame as:
262 * 1) generic request header
268 typedef struct _MPT_FRAME_HDR {
271 SCSIIORequest_t scsireq;
272 SCSIIOReply_t sreply;
273 ConfigReply_t configreply;
274 MPIDefaultReply_t reply;
275 MPT_FRAME_TRACKER frame;
279 #define MPT_REQ_MSGFLAGS_DROPME 0x80
281 typedef struct _MPT_SGL_HDR {
282 SGESimple32_t sge[1];
285 typedef struct _MPT_SGL64_HDR {
286 SGESimple64_t sge[1];
290 * System interface register set
293 typedef struct _SYSIF_REGS
295 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
296 u32 WriteSequence; /* 04 Write Sequence register */
297 u32 Diagnostic; /* 08 Diagnostic register */
298 u32 TestBase; /* 0C Test Base Address */
299 u32 DiagRwData; /* 10 Read Write Data (fw download) */
300 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
301 u32 Reserved1[6]; /* 18-2F reserved for future use */
302 u32 IntStatus; /* 30 Interrupt Status */
303 u32 IntMask; /* 34 Interrupt Mask */
304 u32 Reserved2[2]; /* 38-3F reserved for future use */
305 u32 RequestFifo; /* 40 Request Post/Free FIFO */
306 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
307 u32 Reserved3[2]; /* 48-4F reserved for future use */
308 u32 HostIndex; /* 50 Host Index register */
309 u32 Reserved4[15]; /* 54-8F */
310 u32 Fubar; /* 90 For Fubar usage */
311 u32 Reserved5[27]; /* 94-FF */
315 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
316 * in conjunction with SYSIF_REGS accesses!
321 * Dynamic Multi-Pathing specific stuff...
324 /* VirtTarget negoFlags field */
325 #define MPT_TARGET_NO_NEGO_WIDE 0x01
326 #define MPT_TARGET_NO_NEGO_SYNC 0x02
327 #define MPT_TARGET_NO_NEGO_QAS 0x04
328 #define MPT_TAPE_NEGO_IDP 0x08
331 * VirtDevice - FC LUN device or SCSI target device
333 typedef struct _VirtTarget {
334 struct scsi_target *starget;
339 u8 minSyncFactor; /* 0xFF is async */
340 u8 maxOffset; /* 0 if async */
341 u8 maxWidth; /* 0 if narrow, 1 if wide */
342 u8 negoFlags; /* bit field, see above */
343 u8 raidVolume; /* set, if RAID Volume */
344 u8 type; /* byte 0 of Inquiry data */
346 u32 luns[8]; /* Max LUNs is 256 */
349 typedef struct _VirtDevice {
359 * Fibre Channel (SCSI) target device and associated defines...
361 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
362 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
363 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
364 #define MPT_TARGET_FLAGS_Q_YES 0x08
365 #define MPT_TARGET_FLAGS_VALID_56 0x10
366 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
367 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
370 * /proc/mpt interface
376 read_proc_t *read_proc;
377 write_proc_t *write_proc;
380 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
383 if (len < request) { \
389 *start = buf + offset; \
395 * IOCTL structure and associated defines
398 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
399 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
400 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
401 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
402 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
403 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
404 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
406 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
408 typedef struct _MPT_IOCTL {
409 struct _MPT_ADAPTER *ioc;
410 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
411 u8 sense[MPT_SENSE_BUFFER_ALLOC];
412 int wait_done; /* wake-up value for this ioc */
414 u8 status; /* current command status */
415 u8 reset; /* 1 if bus reset allowed */
416 u8 target; /* target for reset */
417 struct mutex ioctl_mutex;
420 #define MPT_SAS_MGMT_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
421 #define MPT_SAS_MGMT_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
422 #define MPT_SAS_MGMT_STATUS_TM_FAILED 0x40 /* User TM request failed */
424 typedef struct _MPT_SAS_MGMT {
426 struct completion done;
427 u8 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
428 u8 status; /* current command status */
432 * Event Structure and define
434 #define MPTCTL_EVENT_LOG_SIZE (0x000000032)
435 typedef struct _mpt_ioctl_events {
436 u32 event; /* Specified by define above */
437 u32 eventContext; /* Index or counter */
438 int data[2]; /* First 8 bytes of Event Data */
442 * CONFIGPARM status defines
444 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
445 #define MPT_CONFIG_ERROR 0x002F
448 * Substructure to store SCSI specific configuration page data
450 /* dvStatus defines: */
451 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
452 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
453 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
455 typedef struct _SpiCfgData {
457 int *nvram; /* table of device NVRAM values */
458 IOCPage4_t *pIocPg4; /* SEP devices addressing */
459 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
460 int IocPg4Sz; /* IOCPage4 size */
461 u8 minSyncFactor; /* 0xFF if async */
462 u8 maxSyncOffset; /* 0 if async */
463 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
464 u8 busType; /* SE, LVD, HD */
465 u8 sdp1version; /* SDP1 version */
466 u8 sdp1length; /* SDP1 length */
467 u8 sdp0version; /* SDP0 version */
468 u8 sdp0length; /* SDP0 length */
469 u8 dvScheduled; /* 1 if scheduled */
470 u8 noQas; /* Disable QAS for this adapter */
471 u8 Saf_Te; /* 1 to force all Processors as
472 * SAF-TE if Inquiry data length
473 * is too short to check for SAF-TE
475 u8 bus_reset; /* 1 to allow bus reset */
479 typedef struct _SasCfgData {
480 u8 ptClear; /* 1 to automatically clear the
483 * automatic clearing.
487 typedef struct _RaidCfgData {
488 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
489 IOCPage3_t *pIocPg3; /* table of physical disks */
490 int isRaid; /* bit field, 1 if RAID */
493 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01 /* rport registered */
494 #define MPT_RPORT_INFO_FLAGS_MISSING 0x02 /* missing from DevPage0 scan */
495 #define MPT_RPORT_INFO_FLAGS_MAPPED_VDEV 0x04 /* target mapped in vdev */
498 * data allocated for each fc rport device
500 struct mptfc_rport_info
502 struct list_head list;
503 struct fc_rport *rport;
504 struct scsi_target *starget;
511 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
513 typedef struct _MPT_ADAPTER
515 int id; /* Unique adapter id N {0,1,2,...} */
516 int pci_irq; /* This irq */
517 char name[MPT_NAME_LENGTH]; /* "iocN" */
518 char *prod_name; /* "LSIFC9x9" */
519 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
520 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
522 u32 mem_phys; /* == f4020000 (mmap) */
523 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
524 int mem_size; /* mmap memory size */
528 u8 *alloc; /* frames alloc ptr */
529 dma_addr_t alloc_dma;
531 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
532 u32 reply_frames_low_dma;
533 int reply_depth; /* Num Allocated reply frames */
534 int reply_sz; /* Reply frame size */
535 int num_chain; /* Number of chain buffers */
536 /* Pool of buffers for chaining. ReqToChain
537 * and ChainToChain track index of chain buffers.
538 * ChainBuffer (DMA) virt/phys addresses.
539 * FreeChainQ (lock) locking mechanisms.
545 dma_addr_t ChainBufferDMA;
546 struct list_head FreeChainQ;
547 spinlock_t FreeChainQlock;
548 /* We (host driver) get to manage our own RequestQueue! */
549 dma_addr_t req_frames_dma;
550 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
551 u32 req_frames_low_dma;
552 int req_depth; /* Number of request frames */
553 int req_sz; /* Request frame size (bytes) */
554 spinlock_t FreeQlock;
555 struct list_head FreeQ;
556 /* Pool of SCSI sense buffers for commands coming from
557 * the SCSI mid-layer. We have one 256 byte sense buffer
558 * for each REQ entry.
561 dma_addr_t sense_buf_pool_dma;
562 u32 sense_buf_low_dma;
563 u8 *HostPageBuffer; /* SAS - host page buffer support */
564 u32 HostPageBuffer_sz;
565 dma_addr_t HostPageBuffer_dma;
567 struct pci_dev *pcidev; /* struct pci_dev pointer */
568 u8 __iomem *memmap; /* mmap address */
569 struct Scsi_Host *sh; /* Scsi Host pointer */
570 SpiCfgData spi_data; /* Scsi config. data */
571 RaidCfgData raid_data; /* Raid config. data */
572 SasCfgData sas_data; /* Sas config. data */
573 MPT_IOCTL *ioctl; /* ioctl data pointer */
574 struct proc_dir_entry *ioc_dentry;
575 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
576 spinlock_t diagLock; /* diagnostic reset lock */
578 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
579 int eventTypes; /* Event logging parameters */
580 int eventContext; /* Next event context */
581 int eventLogSize; /* Max number of cached events */
582 struct _mpt_ioctl_events *events; /* pointer to event log */
583 u8 *cached_fw; /* Pointer to FW */
584 dma_addr_t cached_fw_dma;
585 struct list_head configQ; /* linked list of config. requests */
592 u32 NB_for_64_byte_frame;
593 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
594 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
595 IOCFactsReply_t facts;
596 PortFactsReply_t pfacts[2];
597 FCPortPage0_t fc_port_page0[2];
598 struct timer_list persist_timer; /* persist table timer */
599 int persist_wait_done; /* persist completion flag */
600 u8 persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
601 LANPage0_t lan_cnfg_page0;
602 LANPage1_t lan_cnfg_page1;
604 * Description: errata_flag_1064
605 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
606 * a split completion for a read data, an internal address pointer incorrectly
607 * increments by 32 bytes
609 int errata_flag_1064;
610 int aen_event_read_flag; /* flag to indicate event log was read*/
612 u8 upload_fw; /* If set, do a fw upload */
613 u8 reload_fw; /* Force a FW Reload on next reset */
614 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
619 spinlock_t initializing_hba_lock;
620 int initializing_hba_lock_flag;
621 struct list_head list;
622 struct net_device *netdev;
623 struct list_head sas_topology;
624 struct mutex sas_topology_mutex;
625 MPT_SAS_MGMT sas_mgmt;
627 struct work_struct mptscsih_persistTask;
629 struct list_head fc_rports;
630 spinlock_t fc_rport_lock; /* list and ri flags */
631 spinlock_t fc_rescan_work_lock;
632 int fc_rescan_work_count;
633 struct work_struct fc_rescan_work;
638 * New return value convention:
639 * 1 = Ok to free associated request frame
642 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
643 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
644 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
645 /* reset_phase defs */
646 #define MPT_IOC_PRE_RESET 0
647 #define MPT_IOC_POST_RESET 1
648 #define MPT_IOC_SETUP_RESET 2
651 * Invent MPT host event (super-set of MPI Events)
652 * Fitted to 1030's 64-byte [max] request frame size
654 typedef struct _MPT_HOST_EVENT {
655 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
660 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
661 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
663 /* Define the generic types based on the size
664 * of the dma_addr_t type.
666 typedef struct _mpt_sge {
671 #define mpt_addr_size() \
672 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
673 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
675 #define mpt_msg_flags() \
676 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
677 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
679 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
681 * Funky (private) macros...
684 #define dprintk(x) printk x
689 #ifdef MPT_DEBUG_INIT
690 #define dinitprintk(x) printk x
691 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
693 u32 *m = (u32 *)(mfp); \
694 printk(KERN_INFO " "); \
695 for (i=0; i<n; i++) \
696 printk(" %08x", le32_to_cpu(m[i])); \
700 #define dinitprintk(x)
701 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
704 #ifdef MPT_DEBUG_EXIT
705 #define dexitprintk(x) printk x
707 #define dexitprintk(x)
710 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
711 #define dfailprintk(x) printk x
713 #define dfailprintk(x)
716 #ifdef MPT_DEBUG_HANDSHAKE
717 #define dhsprintk(x) printk x
722 #ifdef MPT_DEBUG_EVENTS
723 #define devtprintk(x) printk x
725 #define devtprintk(x)
728 #ifdef MPT_DEBUG_RESET
729 #define drsprintk(x) printk x
734 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
735 #if defined(MPT_DEBUG_MSG_FRAME)
736 #define dmfprintk(x) printk x
737 #define DBG_DUMP_REQUEST_FRAME(mfp) \
739 u32 *m = (u32 *)(mfp); \
740 for (i=0; i<n; i++) { \
741 if (i && ((i%8)==0)) \
743 printk("%08x ", le32_to_cpu(m[i])); \
749 #define DBG_DUMP_REQUEST_FRAME(mfp)
753 #define dirqprintk(x) printk x
755 #define dirqprintk(x)
759 #define dsgprintk(x) printk x
764 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
765 #define ddlprintk(x) printk x
771 #define ddvprintk(x) printk x
776 #ifdef MPT_DEBUG_NEGO
777 #define dnegoprintk(x) printk x
779 #define dnegoprintk(x)
782 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
783 #define ddvtprintk(x) printk x
785 #define ddvtprintk(x)
788 #ifdef MPT_DEBUG_IOCTL
789 #define dctlprintk(x) printk x
791 #define dctlprintk(x)
794 #ifdef MPT_DEBUG_REPLY
795 #define dreplyprintk(x) printk x
797 #define dreplyprintk(x)
801 #define dfcprintk(x) printk x
807 #define dtmprintk(x) printk x
808 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
809 { u32 *m = (u32 *)(mfp); \
811 printk("TM_REQUEST:\n"); \
812 for (i=0; i<n; i++) { \
813 if (i && ((i%8)==0)) \
815 printk("%08x ", le32_to_cpu(m[i])); \
819 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
820 { u32 *m = (u32 *)(mfp); \
821 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
822 printk("TM_REPLY MessageLength=%d:\n", n); \
823 for (i=0; i<n; i++) { \
824 if (i && ((i%8)==0)) \
826 printk(" %08x", le32_to_cpu(m[i])); \
832 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
833 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
836 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
837 #define dcprintk(x) printk x
842 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
843 #define dsprintk(x) printk x
849 #define MPT_INDEX_2_MFPTR(ioc,idx) \
850 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
852 #define MFPTR_2_MPT_INDEX(ioc,mf) \
853 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
855 #define MPT_INDEX_2_RFPTR(ioc,idx) \
856 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
858 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
859 #define DBG_DUMP_REPLY_FRAME(mfp) \
860 { u32 *m = (u32 *)(mfp); \
861 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
862 printk(KERN_INFO " "); \
863 for (i=0; i<n; i++) \
864 printk(" %08x", le32_to_cpu(m[i])); \
867 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
869 u32 *m = (u32 *)(mfp); \
870 printk(KERN_INFO " "); \
871 for (i=0; i<n; i++) \
872 printk(" %08x", le32_to_cpu(m[i])); \
876 #define DBG_DUMP_REPLY_FRAME(mfp)
877 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
881 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
883 #define SCSI_STD_SENSE_BYTES 18
884 #define SCSI_STD_INQUIRY_BYTES 36
885 #define SCSI_MAX_INQUIRY_BYTES 96
888 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
889 * Private to the driver.
891 /* LOCAL structure and fields used when processing
892 * internally generated commands. These include:
893 * bus scan, dv and config requests.
895 typedef struct _MPT_LOCAL_REPLY {
896 ConfigPageHeader_t header;
898 u8 sense[SCSI_STD_SENSE_BYTES];
904 #define MPT_HOST_BUS_UNKNOWN (0xFF)
905 #define MPT_HOST_TOO_MANY_TM (0x05)
906 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
907 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
908 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
909 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
910 #define MPT_NVRAM_SYNC_SHIFT (8)
911 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
912 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
913 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
914 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
915 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
916 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
918 /* The TM_STATE variable is used to provide strict single threading of TM
919 * requests as well as communicate TM error conditions.
921 #define TM_STATE_NONE (0)
922 #define TM_STATE_IN_PROGRESS (1)
923 #define TM_STATE_ERROR (2)
931 typedef struct _MPT_SCSI_HOST {
935 struct scsi_cmnd **ScsiLookup;
936 VirtTarget **Targets;
937 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
938 struct timer_list timer;
939 /* Pool of memory for holding SCpnts before doing
940 * OS callbacks. freeQ is the free pool.
944 u8 negoNvram; /* DV disabled, nego NVRAM */
948 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
949 struct scsi_cmnd *abortSCpnt;
950 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
951 unsigned long hard_resets; /* driver forced bus resets count */
952 unsigned long soft_resets; /* fw/external bus resets count */
953 unsigned long timeouts; /* cmd timeouts */
954 ushort sel_timeout[MPT_MAX_FC_DEVICES];
956 wait_queue_head_t scandv_waitq;
957 int scandv_wait_done;
958 long last_queue_full;
962 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
964 * More Dynamic Multi-Pathing stuff...
967 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
970 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
972 * Generic structure passed to the base mpt_config function.
974 typedef struct _x_config_parms {
975 struct list_head linkage; /* linked list */
976 struct timer_list timer; /* timer function for this request */
978 ConfigExtendedPageHeader_t *ehdr;
979 ConfigPageHeader_t *hdr;
982 int wait_done; /* wait for this request */
983 u32 pageAddr; /* properly formatted */
986 u8 timeout; /* seconds */
992 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
994 * Public entry points...
996 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
997 extern void mpt_detach(struct pci_dev *pdev);
999 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state);
1000 extern int mpt_resume(struct pci_dev *pdev);
1002 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1003 extern void mpt_deregister(int cb_idx);
1004 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1005 extern void mpt_event_deregister(int cb_idx);
1006 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1007 extern void mpt_reset_deregister(int cb_idx);
1008 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1009 extern void mpt_device_driver_deregister(int cb_idx);
1010 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
1011 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1012 extern void mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1013 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1015 extern int mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
1016 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1017 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1018 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1019 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1020 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1021 extern void mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
1022 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
1023 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
1024 extern int mpt_read_ioc_pg_3(MPT_ADAPTER *ioc);
1025 extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
1026 extern int mptbase_GetFcPortPage0(MPT_ADAPTER *ioc, int portnum);
1029 * Public data decl's...
1031 extern struct list_head ioc_list;
1032 extern struct proc_dir_entry *mpt_proc_root_dir;
1034 extern int mpt_lan_index; /* needed by mptlan.c */
1035 extern int mpt_stm_index; /* needed by mptstm.c */
1037 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1038 #endif /* } __KERNEL__ */
1040 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1041 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
1042 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
1044 #define CAST_U32_TO_PTR(x) ((void *)x)
1045 #define CAST_PTR_TO_U32(x) ((u32)x)
1048 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1049 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
1050 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
1051 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
1052 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
1055 * Shifted SGE Defines - Use in SGE with FlagsLength member.
1056 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1057 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1059 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1060 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1061 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1062 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1063 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1064 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1065 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1066 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1068 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1069 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1070 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1071 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1073 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1074 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1075 MPT_SGE_FLAGS_END_OF_BUFFER | \
1076 MPT_SGE_FLAGS_END_OF_LIST | \
1077 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1078 MPT_SGE_FLAGS_ADDRESSING | \
1079 MPT_TRANSFER_IOC_TO_HOST)
1080 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1081 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1082 MPT_SGE_FLAGS_END_OF_BUFFER | \
1083 MPT_SGE_FLAGS_END_OF_LIST | \
1084 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1085 MPT_SGE_FLAGS_ADDRESSING | \
1086 MPT_TRANSFER_HOST_TO_IOC)
1088 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/