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/kernel.h>
53 #include <linux/pci.h>
55 #include "lsi/mpi_type.h"
56 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
57 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
58 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
59 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
60 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
61 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
63 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
64 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
65 #include "lsi/mpi_tool.h" /* Tools support */
66 #include "lsi/mpi_sas.h" /* SAS support */
68 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
71 #define MODULEAUTHOR "LSI Logic Corporation"
75 #define COPYRIGHT "Copyright (c) 1999-2005 " MODULEAUTHOR
78 #define MPT_LINUX_VERSION_COMMON "3.04.00"
79 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.04.00"
80 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
82 #define show_mptmod_ver(s,ver) \
83 printk(KERN_INFO "%s %s\n", s, ver);
85 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
87 * Fusion MPT(linux) driver configurable stuff...
89 #define MPT_MAX_ADAPTERS 18
90 #define MPT_MAX_PROTOCOL_DRIVERS 16
91 #define MPT_MAX_BUS 1 /* Do not change */
92 #define MPT_MAX_FC_DEVICES 255
93 #define MPT_MAX_SCSI_DEVICES 16
94 #define MPT_LAST_LUN 255
95 #define MPT_SENSE_BUFFER_ALLOC 64
96 /* allow for 256 max sense alloc, but only 255 max request */
97 #if MPT_SENSE_BUFFER_ALLOC >= 256
98 # undef MPT_SENSE_BUFFER_ALLOC
99 # define MPT_SENSE_BUFFER_ALLOC 256
100 # define MPT_SENSE_BUFFER_SIZE 255
102 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
105 #define MPT_NAME_LENGTH 32
107 #define MPT_PROCFS_MPTBASEDIR "mpt"
108 /* chg it to "driver/fusion" ? */
109 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
110 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
111 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
113 #define MPT_MAX_REQ_DEPTH 1023
114 #define MPT_DEFAULT_REQ_DEPTH 256
115 #define MPT_MIN_REQ_DEPTH 128
117 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
118 #define MPT_DEFAULT_REPLY_DEPTH 128
119 #define MPT_MIN_REPLY_DEPTH 8
120 #define MPT_MAX_REPLIES_PER_ISR 32
122 #define MPT_MAX_FRAME_SIZE 128
123 #define MPT_DEFAULT_FRAME_SIZE 128
125 #define MPT_REPLY_FRAME_SIZE 0x50 /* Must be a multiple of 8 */
127 #define MPT_SG_REQ_128_SCALE 1
128 #define MPT_SG_REQ_96_SCALE 2
129 #define MPT_SG_REQ_64_SCALE 4
134 #define MPT_COALESCING_TIMEOUT 0x10
137 * SCSI transfer rate defines.
139 #define MPT_ULTRA320 0x08
140 #define MPT_ULTRA160 0x09
141 #define MPT_ULTRA2 0x0A
142 #define MPT_ULTRA 0x0C
143 #define MPT_FAST 0x19
144 #define MPT_SCSI 0x32
145 #define MPT_ASYNC 0xFF
155 * Try to keep these at 2^N-1
157 #define MPT_FC_CAN_QUEUE 127
158 #define MPT_SCSI_CAN_QUEUE 127
161 * Set the MAX_SGE value based on user input.
163 #ifdef CONFIG_FUSION_MAX_SGE
164 #if CONFIG_FUSION_MAX_SGE < 16
165 #define MPT_SCSI_SG_DEPTH 16
166 #elif CONFIG_FUSION_MAX_SGE > 128
167 #define MPT_SCSI_SG_DEPTH 128
169 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
172 #define MPT_SCSI_SG_DEPTH 40
175 #ifdef __KERNEL__ /* { */
176 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
178 #include <linux/proc_fs.h>
180 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
182 * Attempt semi-consistent error & warning msgs across
183 * MPT drivers. NOTE: Users of these macro defs must
184 * themselves define their own MYNAM.
186 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
187 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
188 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
189 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
191 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
193 * MPT protocol driver defs...
196 MPTBASE_DRIVER, /* MPT base class */
197 MPTCTL_DRIVER, /* MPT ioctl class */
198 MPTSPI_DRIVER, /* MPT SPI host class */
199 MPTFC_DRIVER, /* MPT FC host class */
200 MPTSAS_DRIVER, /* MPT SAS host class */
201 MPTLAN_DRIVER, /* MPT LAN class */
202 MPTSTM_DRIVER, /* MPT SCSI target mode class */
206 struct mpt_pci_driver{
207 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
208 void (*remove) (struct pci_dev *dev);
212 * MPT adapter / port / bus / device info structures...
215 typedef union _MPT_FRAME_TRACKER {
217 struct list_head list;
223 * NOTE: When request frames are free, on the linkage structure
224 * contets are valid. All other values are invalid.
225 * In particular, do NOT reply on offset [2]
226 * (in words) being the * message context.
227 * The message context must be reset (computed via base address
228 * + an offset) prior to issuing any command.
230 * NOTE2: On non-32-bit systems, where pointers are LARGE,
231 * using the linkage pointers destroys our sacred MsgContext
232 * field contents. But we don't care anymore because these
233 * are now reset in mpt_put_msg_frame() just prior to sending
234 * a request off to the IOC.
239 * The following _MUST_ match the location of the
240 * MsgContext field in the MPT message headers.
245 u16 req_idx; /* Request index */
246 u8 cb_idx; /* callback function index */
252 * Remark: 32 bit identifier:
254 * 23-16: call back index
255 * 15-0 : request index
260 * We might want to view/access a frame as:
261 * 1) generic request header
267 typedef struct _MPT_FRAME_HDR {
270 SCSIIORequest_t scsireq;
271 SCSIIOReply_t sreply;
272 ConfigReply_t configreply;
273 MPIDefaultReply_t reply;
274 MPT_FRAME_TRACKER frame;
278 #define MPT_REQ_MSGFLAGS_DROPME 0x80
280 typedef struct _MPT_SGL_HDR {
281 SGESimple32_t sge[1];
284 typedef struct _MPT_SGL64_HDR {
285 SGESimple64_t sge[1];
289 * System interface register set
292 typedef struct _SYSIF_REGS
294 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
295 u32 WriteSequence; /* 04 Write Sequence register */
296 u32 Diagnostic; /* 08 Diagnostic register */
297 u32 TestBase; /* 0C Test Base Address */
298 u32 DiagRwData; /* 10 Read Write Data (fw download) */
299 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
300 u32 Reserved1[6]; /* 18-2F reserved for future use */
301 u32 IntStatus; /* 30 Interrupt Status */
302 u32 IntMask; /* 34 Interrupt Mask */
303 u32 Reserved2[2]; /* 38-3F reserved for future use */
304 u32 RequestFifo; /* 40 Request Post/Free FIFO */
305 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
306 u32 Reserved3[2]; /* 48-4F reserved for future use */
307 u32 HostIndex; /* 50 Host Index register */
308 u32 Reserved4[15]; /* 54-8F */
309 u32 Fubar; /* 90 For Fubar usage */
310 u32 Reserved5[1050];/* 94-10F8 */
311 u32 Reset_1078; /* 10FC Reset 1078 */
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 */
345 u8 deleted; /* target in process of being removed */
347 u32 luns[8]; /* Max LUNs is 256 */
350 typedef struct _VirtDevice {
357 * Fibre Channel (SCSI) target device and associated defines...
359 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
360 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
361 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
362 #define MPT_TARGET_FLAGS_Q_YES 0x08
363 #define MPT_TARGET_FLAGS_VALID_56 0x10
364 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
365 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x40
368 * /proc/mpt interface
374 read_proc_t *read_proc;
375 write_proc_t *write_proc;
378 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
381 if (len < request) { \
387 *start = buf + offset; \
393 * IOCTL structure and associated defines
396 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
397 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
398 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
399 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
400 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
401 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
402 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
404 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
406 typedef struct _MPT_IOCTL {
407 struct _MPT_ADAPTER *ioc;
408 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
409 u8 sense[MPT_SENSE_BUFFER_ALLOC];
410 int wait_done; /* wake-up value for this ioc */
412 u8 status; /* current command status */
413 u8 reset; /* 1 if bus reset allowed */
414 u8 target; /* target for reset */
415 struct mutex ioctl_mutex;
418 #define MPT_SAS_MGMT_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
419 #define MPT_SAS_MGMT_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
420 #define MPT_SAS_MGMT_STATUS_TM_FAILED 0x40 /* User TM request failed */
422 typedef struct _MPT_SAS_MGMT {
424 struct completion done;
425 u8 reply[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
426 u8 status; /* current command status */
430 * Event Structure and define
432 #define MPTCTL_EVENT_LOG_SIZE (0x000000032)
433 typedef struct _mpt_ioctl_events {
434 u32 event; /* Specified by define above */
435 u32 eventContext; /* Index or counter */
436 int data[2]; /* First 8 bytes of Event Data */
440 * CONFIGPARM status defines
442 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
443 #define MPT_CONFIG_ERROR 0x002F
446 * Substructure to store SCSI specific configuration page data
448 /* dvStatus defines: */
449 #define MPT_SCSICFG_USE_NVRAM 0x01 /* WriteSDP1 using NVRAM */
450 #define MPT_SCSICFG_ALL_IDS 0x02 /* WriteSDP1 to all IDS */
451 /* #define MPT_SCSICFG_BLK_NEGO 0x10 WriteSDP1 with WDTR and SDTR disabled */
453 typedef struct _SpiCfgData {
455 int *nvram; /* table of device NVRAM values */
456 IOCPage4_t *pIocPg4; /* SEP devices addressing */
457 dma_addr_t IocPg4_dma; /* Phys Addr of IOCPage4 data */
458 int IocPg4Sz; /* IOCPage4 size */
459 u8 minSyncFactor; /* 0xFF if async */
460 u8 maxSyncOffset; /* 0 if async */
461 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
462 u8 busType; /* SE, LVD, HD */
463 u8 sdp1version; /* SDP1 version */
464 u8 sdp1length; /* SDP1 length */
465 u8 sdp0version; /* SDP0 version */
466 u8 sdp0length; /* SDP0 length */
467 u8 dvScheduled; /* 1 if scheduled */
468 u8 noQas; /* Disable QAS for this adapter */
469 u8 Saf_Te; /* 1 to force all Processors as
470 * SAF-TE if Inquiry data length
471 * is too short to check for SAF-TE
473 u8 bus_reset; /* 1 to allow bus reset */
477 typedef struct _SasCfgData {
478 u8 ptClear; /* 1 to automatically clear the
481 * automatic clearing.
485 typedef struct _RaidCfgData {
486 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
487 IOCPage3_t *pIocPg3; /* table of physical disks */
488 int isRaid; /* bit field, 1 if RAID */
491 typedef struct _FcCfgData {
492 /* will ultimately hold fc_port_page0 also */
500 #define MPT_RPORT_INFO_FLAGS_REGISTERED 0x01 /* rport registered */
501 #define MPT_RPORT_INFO_FLAGS_MISSING 0x02 /* missing from DevPage0 scan */
504 * data allocated for each fc rport device
506 struct mptfc_rport_info
508 struct list_head list;
509 struct fc_rport *rport;
510 struct scsi_target *starget;
516 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
518 typedef struct _MPT_ADAPTER
520 int id; /* Unique adapter id N {0,1,2,...} */
521 int pci_irq; /* This irq */
522 char name[MPT_NAME_LENGTH]; /* "iocN" */
523 char *prod_name; /* "LSIFC9x9" */
524 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
525 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
527 u32 mem_phys; /* == f4020000 (mmap) */
528 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
529 int mem_size; /* mmap memory size */
533 u8 *alloc; /* frames alloc ptr */
534 dma_addr_t alloc_dma;
536 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
537 u32 reply_frames_low_dma;
538 int reply_depth; /* Num Allocated reply frames */
539 int reply_sz; /* Reply frame size */
540 int num_chain; /* Number of chain buffers */
541 /* Pool of buffers for chaining. ReqToChain
542 * and ChainToChain track index of chain buffers.
543 * ChainBuffer (DMA) virt/phys addresses.
544 * FreeChainQ (lock) locking mechanisms.
550 dma_addr_t ChainBufferDMA;
551 struct list_head FreeChainQ;
552 spinlock_t FreeChainQlock;
553 /* We (host driver) get to manage our own RequestQueue! */
554 dma_addr_t req_frames_dma;
555 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
556 u32 req_frames_low_dma;
557 int req_depth; /* Number of request frames */
558 int req_sz; /* Request frame size (bytes) */
559 spinlock_t FreeQlock;
560 struct list_head FreeQ;
561 /* Pool of SCSI sense buffers for commands coming from
562 * the SCSI mid-layer. We have one 256 byte sense buffer
563 * for each REQ entry.
566 dma_addr_t sense_buf_pool_dma;
567 u32 sense_buf_low_dma;
568 u8 *HostPageBuffer; /* SAS - host page buffer support */
569 u32 HostPageBuffer_sz;
570 dma_addr_t HostPageBuffer_dma;
572 struct pci_dev *pcidev; /* struct pci_dev pointer */
573 u8 __iomem *memmap; /* mmap address */
574 struct Scsi_Host *sh; /* Scsi Host pointer */
575 SpiCfgData spi_data; /* Scsi config. data */
576 RaidCfgData raid_data; /* Raid config. data */
577 SasCfgData sas_data; /* Sas config. data */
578 FcCfgData fc_data; /* Fc config. data */
579 MPT_IOCTL *ioctl; /* ioctl data pointer */
580 struct proc_dir_entry *ioc_dentry;
581 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
582 spinlock_t diagLock; /* diagnostic reset lock */
584 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
585 int eventTypes; /* Event logging parameters */
586 int eventContext; /* Next event context */
587 int eventLogSize; /* Max number of cached events */
588 struct _mpt_ioctl_events *events; /* pointer to event log */
589 u8 *cached_fw; /* Pointer to FW */
590 dma_addr_t cached_fw_dma;
591 struct list_head configQ; /* linked list of config. requests */
598 u32 NB_for_64_byte_frame;
599 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
600 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
601 IOCFactsReply_t facts;
602 PortFactsReply_t pfacts[2];
603 FCPortPage0_t fc_port_page0[2];
604 struct timer_list persist_timer; /* persist table timer */
605 int persist_wait_done; /* persist completion flag */
606 u8 persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
607 LANPage0_t lan_cnfg_page0;
608 LANPage1_t lan_cnfg_page1;
610 * Description: errata_flag_1064
611 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
612 * a split completion for a read data, an internal address pointer incorrectly
613 * increments by 32 bytes
615 int errata_flag_1064;
616 int aen_event_read_flag; /* flag to indicate event log was read*/
618 u8 upload_fw; /* If set, do a fw upload */
619 u8 reload_fw; /* Force a FW Reload on next reset */
620 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
625 spinlock_t initializing_hba_lock;
626 int initializing_hba_lock_flag;
627 struct list_head list;
628 struct net_device *netdev;
629 struct list_head sas_topology;
630 struct mutex sas_topology_mutex;
631 struct mutex sas_discovery_mutex;
632 u8 sas_discovery_runtime;
633 u8 sas_discovery_ignore_events;
635 int sas_index; /* index refrencing */
636 MPT_SAS_MGMT sas_mgmt;
638 struct work_struct sas_persist_task;
640 struct work_struct fc_setup_reset_work;
641 struct list_head fc_rports;
642 spinlock_t fc_rescan_work_lock;
643 int fc_rescan_work_count;
644 struct work_struct fc_rescan_work;
645 char fc_rescan_work_q_name[KOBJ_NAME_LEN];
646 struct workqueue_struct *fc_rescan_work_q;
647 u8 port_serial_number;
651 * New return value convention:
652 * 1 = Ok to free associated request frame
655 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
656 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
657 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
658 /* reset_phase defs */
659 #define MPT_IOC_PRE_RESET 0
660 #define MPT_IOC_POST_RESET 1
661 #define MPT_IOC_SETUP_RESET 2
664 * Invent MPT host event (super-set of MPI Events)
665 * Fitted to 1030's 64-byte [max] request frame size
667 typedef struct _MPT_HOST_EVENT {
668 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
673 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
674 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
676 /* Define the generic types based on the size
677 * of the dma_addr_t type.
679 typedef struct _mpt_sge {
684 #define mpt_addr_size() \
685 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
686 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
688 #define mpt_msg_flags() \
689 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
690 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
692 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
694 * Funky (private) macros...
697 #define dprintk(x) printk x
702 #ifdef MPT_DEBUG_INIT
703 #define dinitprintk(x) printk x
704 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
706 u32 *m = (u32 *)(mfp); \
707 printk(KERN_INFO " "); \
708 for (i=0; i<n; i++) \
709 printk(" %08x", le32_to_cpu(m[i])); \
713 #define dinitprintk(x)
714 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
717 #ifdef MPT_DEBUG_EXIT
718 #define dexitprintk(x) printk x
720 #define dexitprintk(x)
723 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
724 #define dfailprintk(x) printk x
726 #define dfailprintk(x)
729 #ifdef MPT_DEBUG_HANDSHAKE
730 #define dhsprintk(x) printk x
735 #if defined(MPT_DEBUG_EVENTS) || defined(MPT_DEBUG_VERBOSE_EVENTS)
736 #define devtprintk(x) printk x
738 #define devtprintk(x)
741 #ifdef MPT_DEBUG_VERBOSE_EVENTS
742 #define devtverboseprintk(x) printk x
744 #define devtverboseprintk(x)
747 #ifdef MPT_DEBUG_RESET
748 #define drsprintk(x) printk x
753 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
754 #if defined(MPT_DEBUG_MSG_FRAME)
755 #define dmfprintk(x) printk x
756 #define DBG_DUMP_REQUEST_FRAME(mfp) \
758 u32 *m = (u32 *)(mfp); \
759 for (i=0; i<n; i++) { \
760 if (i && ((i%8)==0)) \
762 printk("%08x ", le32_to_cpu(m[i])); \
768 #define DBG_DUMP_REQUEST_FRAME(mfp)
772 #define dirqprintk(x) printk x
774 #define dirqprintk(x)
778 #define dsgprintk(x) printk x
783 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
784 #define ddlprintk(x) printk x
790 #define ddvprintk(x) printk x
795 #ifdef MPT_DEBUG_NEGO
796 #define dnegoprintk(x) printk x
798 #define dnegoprintk(x)
801 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
802 #define ddvtprintk(x) printk x
804 #define ddvtprintk(x)
807 #ifdef MPT_DEBUG_IOCTL
808 #define dctlprintk(x) printk x
810 #define dctlprintk(x)
813 #ifdef MPT_DEBUG_REPLY
814 #define dreplyprintk(x) printk x
816 #define dreplyprintk(x)
820 #define dfcprintk(x) printk x
826 #define dtmprintk(x) printk x
827 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
828 { u32 *m = (u32 *)(mfp); \
830 printk("TM_REQUEST:\n"); \
831 for (i=0; i<n; i++) { \
832 if (i && ((i%8)==0)) \
834 printk("%08x ", le32_to_cpu(m[i])); \
838 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
839 { u32 *m = (u32 *)(mfp); \
840 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
841 printk("TM_REPLY MessageLength=%d:\n", n); \
842 for (i=0; i<n; i++) { \
843 if (i && ((i%8)==0)) \
845 printk(" %08x", le32_to_cpu(m[i])); \
851 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
852 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
855 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
856 #define dcprintk(x) printk x
861 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
862 #define dsprintk(x) printk x
868 #define MPT_INDEX_2_MFPTR(ioc,idx) \
869 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
871 #define MFPTR_2_MPT_INDEX(ioc,mf) \
872 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
874 #define MPT_INDEX_2_RFPTR(ioc,idx) \
875 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
877 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
878 #define DBG_DUMP_REPLY_FRAME(mfp) \
879 { u32 *m = (u32 *)(mfp); \
880 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
881 printk(KERN_INFO " "); \
882 for (i=0; i<n; i++) \
883 printk(" %08x", le32_to_cpu(m[i])); \
886 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
888 u32 *m = (u32 *)(mfp); \
889 printk(KERN_INFO " "); \
890 for (i=0; i<n; i++) \
891 printk(" %08x", le32_to_cpu(m[i])); \
895 #define DBG_DUMP_REPLY_FRAME(mfp)
896 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
899 // debug sas wide ports
900 #ifdef MPT_DEBUG_SAS_WIDE
901 #define dsaswideprintk(x) printk x
903 #define dsaswideprintk(x)
907 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
909 #define SCSI_STD_SENSE_BYTES 18
910 #define SCSI_STD_INQUIRY_BYTES 36
911 #define SCSI_MAX_INQUIRY_BYTES 96
914 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
915 * Private to the driver.
917 /* LOCAL structure and fields used when processing
918 * internally generated commands. These include:
919 * bus scan, dv and config requests.
921 typedef struct _MPT_LOCAL_REPLY {
922 ConfigPageHeader_t header;
924 u8 sense[SCSI_STD_SENSE_BYTES];
930 #define MPT_HOST_BUS_UNKNOWN (0xFF)
931 #define MPT_HOST_TOO_MANY_TM (0x05)
932 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
933 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
934 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
935 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
936 #define MPT_NVRAM_SYNC_SHIFT (8)
937 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
938 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
939 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
940 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
941 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
942 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
944 /* The TM_STATE variable is used to provide strict single threading of TM
945 * requests as well as communicate TM error conditions.
947 #define TM_STATE_NONE (0)
948 #define TM_STATE_IN_PROGRESS (1)
949 #define TM_STATE_ERROR (2)
957 typedef struct _MPT_SCSI_HOST {
961 struct scsi_cmnd **ScsiLookup;
962 VirtTarget **Targets;
963 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
964 struct timer_list timer;
965 /* Pool of memory for holding SCpnts before doing
966 * OS callbacks. freeQ is the free pool.
970 u8 negoNvram; /* DV disabled, nego NVRAM */
974 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
975 struct scsi_cmnd *abortSCpnt;
976 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
977 unsigned long hard_resets; /* driver forced bus resets count */
978 unsigned long soft_resets; /* fw/external bus resets count */
979 unsigned long timeouts; /* cmd timeouts */
980 ushort sel_timeout[MPT_MAX_FC_DEVICES];
982 wait_queue_head_t scandv_waitq;
983 int scandv_wait_done;
984 long last_queue_full;
988 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
990 * More Dynamic Multi-Pathing stuff...
993 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
996 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
998 * Generic structure passed to the base mpt_config function.
1000 typedef struct _x_config_parms {
1001 struct list_head linkage; /* linked list */
1002 struct timer_list timer; /* timer function for this request */
1004 ConfigExtendedPageHeader_t *ehdr;
1005 ConfigPageHeader_t *hdr;
1007 dma_addr_t physAddr;
1008 int wait_done; /* wait for this request */
1009 u32 pageAddr; /* properly formatted */
1012 u8 timeout; /* seconds */
1018 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1020 * Public entry points...
1022 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
1023 extern void mpt_detach(struct pci_dev *pdev);
1025 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state);
1026 extern int mpt_resume(struct pci_dev *pdev);
1028 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
1029 extern void mpt_deregister(int cb_idx);
1030 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
1031 extern void mpt_event_deregister(int cb_idx);
1032 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
1033 extern void mpt_reset_deregister(int cb_idx);
1034 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
1035 extern void mpt_device_driver_deregister(int cb_idx);
1036 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
1037 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1038 extern void mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
1039 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
1041 extern int mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
1042 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
1043 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
1044 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
1045 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
1046 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
1047 extern void mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
1048 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
1049 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
1050 extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
1053 * Public data decl's...
1055 extern struct list_head ioc_list;
1056 extern struct proc_dir_entry *mpt_proc_root_dir;
1058 extern int mpt_lan_index; /* needed by mptlan.c */
1059 extern int mpt_stm_index; /* needed by mptstm.c */
1061 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1062 #endif /* } __KERNEL__ */
1064 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1065 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
1066 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
1068 #define CAST_U32_TO_PTR(x) ((void *)x)
1069 #define CAST_PTR_TO_U32(x) ((u32)x)
1072 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1073 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
1074 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
1075 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
1076 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
1079 * Shifted SGE Defines - Use in SGE with FlagsLength member.
1080 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1081 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1083 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1084 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1085 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1086 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1087 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1088 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1089 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1090 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1092 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1093 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1094 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1095 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1097 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1098 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1099 MPT_SGE_FLAGS_END_OF_BUFFER | \
1100 MPT_SGE_FLAGS_END_OF_LIST | \
1101 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1102 MPT_SGE_FLAGS_ADDRESSING | \
1103 MPT_TRANSFER_IOC_TO_HOST)
1104 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1105 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1106 MPT_SGE_FLAGS_END_OF_BUFFER | \
1107 MPT_SGE_FLAGS_END_OF_LIST | \
1108 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1109 MPT_SGE_FLAGS_ADDRESSING | \
1110 MPT_TRANSFER_HOST_TO_IOC)
1112 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/