[PATCH] usbcore: Improve endpoint sysfs file handling
[linux/fpc-iii.git] / drivers / message / fusion / mptbase.h
blob75105277e22f1606113a73c160775e3ec9444e88
1 /*
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.
23 NO WARRANTY
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/version.h>
53 #include <linux/config.h>
54 #include <linux/kernel.h>
55 #include <linux/pci.h>
57 #include "lsi/mpi_type.h"
58 #include "lsi/mpi.h" /* Fusion MPI(nterface) basic defs */
59 #include "lsi/mpi_ioc.h" /* Fusion MPT IOC(ontroller) defs */
60 #include "lsi/mpi_cnfg.h" /* IOC configuration support */
61 #include "lsi/mpi_init.h" /* SCSI Host (initiator) protocol support */
62 #include "lsi/mpi_lan.h" /* LAN over FC protocol support */
63 #include "lsi/mpi_raid.h" /* Integrated Mirroring support */
65 #include "lsi/mpi_fc.h" /* Fibre Channel (lowlevel) support */
66 #include "lsi/mpi_targ.h" /* SCSI/FCP Target protcol support */
67 #include "lsi/mpi_tool.h" /* Tools support */
68 #include "lsi/mpi_sas.h" /* SAS support */
70 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
72 #ifndef MODULEAUTHOR
73 #define MODULEAUTHOR "LSI Logic Corporation"
74 #endif
76 #ifndef COPYRIGHT
77 #define COPYRIGHT "Copyright (c) 1999-2005 " MODULEAUTHOR
78 #endif
80 #define MPT_LINUX_VERSION_COMMON "3.03.03"
81 #define MPT_LINUX_PACKAGE_NAME "@(#)mptlinux-3.03.03"
82 #define WHAT_MAGIC_STRING "@" "(" "#" ")"
84 #define show_mptmod_ver(s,ver) \
85 printk(KERN_INFO "%s %s\n", s, ver);
87 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
89 * Fusion MPT(linux) driver configurable stuff...
91 #define MPT_MAX_ADAPTERS 18
92 #define MPT_MAX_PROTOCOL_DRIVERS 16
93 #define MPT_MAX_BUS 1 /* Do not change */
94 #define MPT_MAX_FC_DEVICES 255
95 #define MPT_MAX_SCSI_DEVICES 16
96 #define MPT_LAST_LUN 255
97 #define MPT_SENSE_BUFFER_ALLOC 64
98 /* allow for 256 max sense alloc, but only 255 max request */
99 #if MPT_SENSE_BUFFER_ALLOC >= 256
100 # undef MPT_SENSE_BUFFER_ALLOC
101 # define MPT_SENSE_BUFFER_ALLOC 256
102 # define MPT_SENSE_BUFFER_SIZE 255
103 #else
104 # define MPT_SENSE_BUFFER_SIZE MPT_SENSE_BUFFER_ALLOC
105 #endif
107 #define MPT_NAME_LENGTH 32
109 #define MPT_PROCFS_MPTBASEDIR "mpt"
110 /* chg it to "driver/fusion" ? */
111 #define MPT_PROCFS_SUMMARY_ALL_NODE MPT_PROCFS_MPTBASEDIR "/summary"
112 #define MPT_PROCFS_SUMMARY_ALL_PATHNAME "/proc/" MPT_PROCFS_SUMMARY_ALL_NODE
113 #define MPT_FW_REV_MAGIC_ID_STRING "FwRev="
115 #define MPT_MAX_REQ_DEPTH 1023
116 #define MPT_DEFAULT_REQ_DEPTH 256
117 #define MPT_MIN_REQ_DEPTH 128
119 #define MPT_MAX_REPLY_DEPTH MPT_MAX_REQ_DEPTH
120 #define MPT_DEFAULT_REPLY_DEPTH 128
121 #define MPT_MIN_REPLY_DEPTH 8
122 #define MPT_MAX_REPLIES_PER_ISR 32
124 #define MPT_MAX_FRAME_SIZE 128
125 #define MPT_DEFAULT_FRAME_SIZE 128
127 #define MPT_REPLY_FRAME_SIZE 0x40 /* Must be a multiple of 8 */
129 #define MPT_SG_REQ_128_SCALE 1
130 #define MPT_SG_REQ_96_SCALE 2
131 #define MPT_SG_REQ_64_SCALE 4
133 #define CAN_SLEEP 1
134 #define NO_SLEEP 0
136 #define MPT_COALESCING_TIMEOUT 0x10
139 * SCSI transfer rate defines.
141 #define MPT_ULTRA320 0x08
142 #define MPT_ULTRA160 0x09
143 #define MPT_ULTRA2 0x0A
144 #define MPT_ULTRA 0x0C
145 #define MPT_FAST 0x19
146 #define MPT_SCSI 0x32
147 #define MPT_ASYNC 0xFF
149 #define MPT_NARROW 0
150 #define MPT_WIDE 1
152 #define C0_1030 0x08
153 #define XL_929 0x01
157 * Try to keep these at 2^N-1
159 #define MPT_FC_CAN_QUEUE 127
160 #define MPT_SCSI_CAN_QUEUE 127
163 * Set the MAX_SGE value based on user input.
165 #ifdef CONFIG_FUSION_MAX_SGE
166 #if CONFIG_FUSION_MAX_SGE < 16
167 #define MPT_SCSI_SG_DEPTH 16
168 #elif CONFIG_FUSION_MAX_SGE > 128
169 #define MPT_SCSI_SG_DEPTH 128
170 #else
171 #define MPT_SCSI_SG_DEPTH CONFIG_FUSION_MAX_SGE
172 #endif
173 #else
174 #define MPT_SCSI_SG_DEPTH 40
175 #endif
177 #ifdef __KERNEL__ /* { */
178 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
180 #include <linux/proc_fs.h>
182 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
184 * Attempt semi-consistent error & warning msgs across
185 * MPT drivers. NOTE: Users of these macro defs must
186 * themselves define their own MYNAM.
188 #define MYIOC_s_INFO_FMT KERN_INFO MYNAM ": %s: "
189 #define MYIOC_s_NOTE_FMT KERN_NOTICE MYNAM ": %s: "
190 #define MYIOC_s_WARN_FMT KERN_WARNING MYNAM ": %s: WARNING - "
191 #define MYIOC_s_ERR_FMT KERN_ERR MYNAM ": %s: ERROR - "
193 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
195 * MPT protocol driver defs...
197 typedef enum {
198 MPTBASE_DRIVER, /* MPT base class */
199 MPTCTL_DRIVER, /* MPT ioctl class */
200 MPTSPI_DRIVER, /* MPT SPI host class */
201 MPTFC_DRIVER, /* MPT FC host class */
202 MPTSAS_DRIVER, /* MPT SAS host class */
203 MPTLAN_DRIVER, /* MPT LAN class */
204 MPTSTM_DRIVER, /* MPT SCSI target mode class */
205 MPTUNKNOWN_DRIVER
206 } MPT_DRIVER_CLASS;
208 struct mpt_pci_driver{
209 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id);
210 void (*remove) (struct pci_dev *dev);
214 * MPT adapter / port / bus / device info structures...
217 typedef union _MPT_FRAME_TRACKER {
218 struct {
219 struct list_head list;
220 u32 arg1;
221 u32 pad;
222 void *argp1;
223 } linkage;
225 * NOTE: When request frames are free, on the linkage structure
226 * contets are valid. All other values are invalid.
227 * In particular, do NOT reply on offset [2]
228 * (in words) being the * message context.
229 * The message context must be reset (computed via base address
230 * + an offset) prior to issuing any command.
232 * NOTE2: On non-32-bit systems, where pointers are LARGE,
233 * using the linkage pointers destroys our sacred MsgContext
234 * field contents. But we don't care anymore because these
235 * are now reset in mpt_put_msg_frame() just prior to sending
236 * a request off to the IOC.
238 struct {
239 u32 __hdr[2];
241 * The following _MUST_ match the location of the
242 * MsgContext field in the MPT message headers.
244 union {
245 u32 MsgContext;
246 struct {
247 u16 req_idx; /* Request index */
248 u8 cb_idx; /* callback function index */
249 u8 rsvd;
250 } fld;
251 } msgctxu;
252 } hwhdr;
254 * Remark: 32 bit identifier:
255 * 31-24: reserved
256 * 23-16: call back index
257 * 15-0 : request index
259 } MPT_FRAME_TRACKER;
262 * We might want to view/access a frame as:
263 * 1) generic request header
264 * 2) SCSIIORequest
265 * 3) SCSIIOReply
266 * 4) MPIDefaultReply
267 * 5) frame tracker
269 typedef struct _MPT_FRAME_HDR {
270 union {
271 MPIHeader_t hdr;
272 SCSIIORequest_t scsireq;
273 SCSIIOReply_t sreply;
274 ConfigReply_t configreply;
275 MPIDefaultReply_t reply;
276 MPT_FRAME_TRACKER frame;
277 } u;
278 } MPT_FRAME_HDR;
280 #define MPT_REQ_MSGFLAGS_DROPME 0x80
282 typedef struct _MPT_SGL_HDR {
283 SGESimple32_t sge[1];
284 } MPT_SGL_HDR;
286 typedef struct _MPT_SGL64_HDR {
287 SGESimple64_t sge[1];
288 } MPT_SGL64_HDR;
291 * System interface register set
294 typedef struct _SYSIF_REGS
296 u32 Doorbell; /* 00 System<->IOC Doorbell reg */
297 u32 WriteSequence; /* 04 Write Sequence register */
298 u32 Diagnostic; /* 08 Diagnostic register */
299 u32 TestBase; /* 0C Test Base Address */
300 u32 DiagRwData; /* 10 Read Write Data (fw download) */
301 u32 DiagRwAddress; /* 14 Read Write Address (fw download)*/
302 u32 Reserved1[6]; /* 18-2F reserved for future use */
303 u32 IntStatus; /* 30 Interrupt Status */
304 u32 IntMask; /* 34 Interrupt Mask */
305 u32 Reserved2[2]; /* 38-3F reserved for future use */
306 u32 RequestFifo; /* 40 Request Post/Free FIFO */
307 u32 ReplyFifo; /* 44 Reply Post/Free FIFO */
308 u32 Reserved3[2]; /* 48-4F reserved for future use */
309 u32 HostIndex; /* 50 Host Index register */
310 u32 Reserved4[15]; /* 54-8F */
311 u32 Fubar; /* 90 For Fubar usage */
312 u32 Reserved5[27]; /* 94-FF */
313 } SYSIF_REGS;
316 * NOTE: Use MPI_{DOORBELL,WRITESEQ,DIAG}_xxx defs in lsi/mpi.h
317 * in conjunction with SYSIF_REGS accesses!
322 * Dynamic Multi-Pathing specific stuff...
325 /* VirtDevice negoFlags field */
326 #define MPT_TARGET_NO_NEGO_WIDE 0x01
327 #define MPT_TARGET_NO_NEGO_SYNC 0x02
328 #define MPT_TARGET_NO_NEGO_QAS 0x04
329 #define MPT_TAPE_NEGO_IDP 0x08
332 * VirtDevice - FC LUN device or SCSI target device
334 typedef struct _VirtDevice {
335 struct scsi_device *device;
336 u8 tflags;
337 u8 ioc_id;
338 u8 target_id;
339 u8 bus_id;
340 u8 minSyncFactor; /* 0xFF is async */
341 u8 maxOffset; /* 0 if async */
342 u8 maxWidth; /* 0 if narrow, 1 if wide */
343 u8 negoFlags; /* bit field, see above */
344 u8 raidVolume; /* set, if RAID Volume */
345 u8 type; /* byte 0 of Inquiry data */
346 u8 cflags; /* controller flags */
347 u8 rsvd1raid;
348 u16 fc_phys_lun;
349 u16 fc_xlat_lun;
350 u32 num_luns;
351 u32 luns[8]; /* Max LUNs is 256 */
352 u8 pad[4];
353 u8 inq_data[8];
354 /* IEEE Registered Extended Identifier
355 obtained via INQUIRY VPD page 0x83 */
356 /* NOTE: Do not separate uniq_prepad and uniq_data
357 as they are treateed as a single entity in the code */
358 u8 uniq_prepad[8];
359 u8 uniq_data[20];
360 u8 pad2[4];
361 } VirtDevice;
364 * Fibre Channel (SCSI) target device and associated defines...
366 #define MPT_TARGET_DEFAULT_DV_STATUS 0x00
367 #define MPT_TARGET_FLAGS_VALID_NEGO 0x01
368 #define MPT_TARGET_FLAGS_VALID_INQUIRY 0x02
369 #define MPT_TARGET_FLAGS_Q_YES 0x08
370 #define MPT_TARGET_FLAGS_VALID_56 0x10
371 #define MPT_TARGET_FLAGS_SAF_TE_ISSUED 0x20
374 * /proc/mpt interface
376 typedef struct {
377 const char *name;
378 mode_t mode;
379 int pad;
380 read_proc_t *read_proc;
381 write_proc_t *write_proc;
382 } mpt_proc_entry_t;
384 #define MPT_PROC_READ_RETURN(buf,start,offset,request,eof,len) \
385 do { \
386 len -= offset; \
387 if (len < request) { \
388 *eof = 1; \
389 if (len <= 0) \
390 return 0; \
391 } else \
392 len = request; \
393 *start = buf + offset; \
394 return len; \
395 } while (0)
399 * IOCTL structure and associated defines
402 #define MPT_IOCTL_STATUS_DID_IOCRESET 0x01 /* IOC Reset occurred on the current*/
403 #define MPT_IOCTL_STATUS_RF_VALID 0x02 /* The Reply Frame is VALID */
404 #define MPT_IOCTL_STATUS_TIMER_ACTIVE 0x04 /* The timer is running */
405 #define MPT_IOCTL_STATUS_SENSE_VALID 0x08 /* Sense data is valid */
406 #define MPT_IOCTL_STATUS_COMMAND_GOOD 0x10 /* Command Status GOOD */
407 #define MPT_IOCTL_STATUS_TMTIMER_ACTIVE 0x20 /* The TM timer is running */
408 #define MPT_IOCTL_STATUS_TM_FAILED 0x40 /* User TM request failed */
410 #define MPTCTL_RESET_OK 0x01 /* Issue Bus Reset */
412 typedef struct _MPT_IOCTL {
413 struct _MPT_ADAPTER *ioc;
414 u8 ReplyFrame[MPT_DEFAULT_FRAME_SIZE]; /* reply frame data */
415 u8 sense[MPT_SENSE_BUFFER_ALLOC];
416 int wait_done; /* wake-up value for this ioc */
417 u8 rsvd;
418 u8 status; /* current command status */
419 u8 reset; /* 1 if bus reset allowed */
420 u8 target; /* target for reset */
421 struct semaphore sem_ioc;
422 } MPT_IOCTL;
425 * Event Structure and define
427 #define MPTCTL_EVENT_LOG_SIZE (0x000000032)
428 typedef struct _mpt_ioctl_events {
429 u32 event; /* Specified by define above */
430 u32 eventContext; /* Index or counter */
431 int data[2]; /* First 8 bytes of Event Data */
432 } MPT_IOCTL_EVENTS;
435 * CONFIGPARM status defines
437 #define MPT_CONFIG_GOOD MPI_IOCSTATUS_SUCCESS
438 #define MPT_CONFIG_ERROR 0x002F
441 * Substructure to store SCSI specific configuration page data
443 /* dvStatus defines: */
444 #define MPT_SCSICFG_NEGOTIATE 0x01 /* Negotiate on next IO */
445 #define MPT_SCSICFG_NEED_DV 0x02 /* Schedule DV */
446 #define MPT_SCSICFG_DV_PENDING 0x04 /* DV on this physical id pending */
447 #define MPT_SCSICFG_DV_NOT_DONE 0x08 /* DV has not been performed */
448 #define MPT_SCSICFG_BLK_NEGO 0x10 /* WriteSDP1 with WDTR and SDTR disabled */
449 #define MPT_SCSICFG_RELOAD_IOC_PG3 0x20 /* IOC Pg 3 data is obsolete */
450 /* Args passed to writeSDP1: */
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 {
456 u32 PortFlags;
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 dvStatus[MPT_MAX_SCSI_DEVICES];
462 u8 minSyncFactor; /* 0xFF if async */
463 u8 maxSyncOffset; /* 0 if async */
464 u8 maxBusWidth; /* 0 if narrow, 1 if wide */
465 u8 busType; /* SE, LVD, HD */
466 u8 sdp1version; /* SDP1 version */
467 u8 sdp1length; /* SDP1 length */
468 u8 sdp0version; /* SDP0 version */
469 u8 sdp0length; /* SDP0 length */
470 u8 dvScheduled; /* 1 if scheduled */
471 u8 forceDv; /* 1 to force DV scheduling */
472 u8 noQas; /* Disable QAS for this adapter */
473 u8 Saf_Te; /* 1 to force all Processors as
474 * SAF-TE if Inquiry data length
475 * is too short to check for SAF-TE
477 u8 mpt_dv; /* command line option: enhanced=1, basic=0 */
478 u8 bus_reset; /* 1 to allow bus reset */
479 u8 rsvd[1];
480 }SpiCfgData;
482 typedef struct _SasCfgData {
483 u8 ptClear; /* 1 to automatically clear the
484 * persistent table.
485 * 0 to disable
486 * automatic clearing.
488 }SasCfgData;
490 typedef struct _RaidCfgData {
491 IOCPage2_t *pIocPg2; /* table of Raid Volumes */
492 IOCPage3_t *pIocPg3; /* table of physical disks */
493 int isRaid; /* bit field, 1 if RAID */
494 }RaidCfgData;
497 * Adapter Structure - pci_dev specific. Maximum: MPT_MAX_ADAPTERS
499 typedef struct _MPT_ADAPTER
501 int id; /* Unique adapter id N {0,1,2,...} */
502 int pci_irq; /* This irq */
503 char name[MPT_NAME_LENGTH]; /* "iocN" */
504 char *prod_name; /* "LSIFC9x9" */
505 SYSIF_REGS __iomem *chip; /* == c8817000 (mmap) */
506 SYSIF_REGS __iomem *pio_chip; /* Programmed IO (downloadboot) */
507 u8 bus_type;
508 u32 mem_phys; /* == f4020000 (mmap) */
509 u32 pio_mem_phys; /* Programmed IO (downloadboot) */
510 int mem_size; /* mmap memory size */
511 int alloc_total;
512 u32 last_state;
513 int active;
514 u8 *alloc; /* frames alloc ptr */
515 dma_addr_t alloc_dma;
516 u32 alloc_sz;
517 MPT_FRAME_HDR *reply_frames; /* Reply msg frames - rounded up! */
518 u32 reply_frames_low_dma;
519 int reply_depth; /* Num Allocated reply frames */
520 int reply_sz; /* Reply frame size */
521 int num_chain; /* Number of chain buffers */
522 /* Pool of buffers for chaining. ReqToChain
523 * and ChainToChain track index of chain buffers.
524 * ChainBuffer (DMA) virt/phys addresses.
525 * FreeChainQ (lock) locking mechanisms.
527 int *ReqToChain;
528 int *RequestNB;
529 int *ChainToChain;
530 u8 *ChainBuffer;
531 dma_addr_t ChainBufferDMA;
532 struct list_head FreeChainQ;
533 spinlock_t FreeChainQlock;
534 /* We (host driver) get to manage our own RequestQueue! */
535 dma_addr_t req_frames_dma;
536 MPT_FRAME_HDR *req_frames; /* Request msg frames - rounded up! */
537 u32 req_frames_low_dma;
538 int req_depth; /* Number of request frames */
539 int req_sz; /* Request frame size (bytes) */
540 spinlock_t FreeQlock;
541 struct list_head FreeQ;
542 /* Pool of SCSI sense buffers for commands coming from
543 * the SCSI mid-layer. We have one 256 byte sense buffer
544 * for each REQ entry.
546 u8 *sense_buf_pool;
547 dma_addr_t sense_buf_pool_dma;
548 u32 sense_buf_low_dma;
549 u8 *HostPageBuffer; /* SAS - host page buffer support */
550 u32 HostPageBuffer_sz;
551 dma_addr_t HostPageBuffer_dma;
552 int mtrr_reg;
553 struct pci_dev *pcidev; /* struct pci_dev pointer */
554 u8 __iomem *memmap; /* mmap address */
555 struct Scsi_Host *sh; /* Scsi Host pointer */
556 SpiCfgData spi_data; /* Scsi config. data */
557 RaidCfgData raid_data; /* Raid config. data */
558 SasCfgData sas_data; /* Sas config. data */
559 MPT_IOCTL *ioctl; /* ioctl data pointer */
560 struct proc_dir_entry *ioc_dentry;
561 struct _MPT_ADAPTER *alt_ioc; /* ptr to 929 bound adapter port */
562 spinlock_t diagLock; /* diagnostic reset lock */
563 int diagPending;
564 u32 biosVersion; /* BIOS version from IO Unit Page 2 */
565 int eventTypes; /* Event logging parameters */
566 int eventContext; /* Next event context */
567 int eventLogSize; /* Max number of cached events */
568 struct _mpt_ioctl_events *events; /* pointer to event log */
569 u8 *cached_fw; /* Pointer to FW */
570 dma_addr_t cached_fw_dma;
571 struct list_head configQ; /* linked list of config. requests */
572 int hs_reply_idx;
573 #ifndef MFCNT
574 u32 pad0;
575 #else
576 u32 mfcnt;
577 #endif
578 u32 NB_for_64_byte_frame;
579 u32 hs_req[MPT_MAX_FRAME_SIZE/sizeof(u32)];
580 u16 hs_reply[MPT_MAX_FRAME_SIZE/sizeof(u16)];
581 IOCFactsReply_t facts;
582 PortFactsReply_t pfacts[2];
583 FCPortPage0_t fc_port_page0[2];
584 struct timer_list persist_timer; /* persist table timer */
585 int persist_wait_done; /* persist completion flag */
586 u8 persist_reply_frame[MPT_DEFAULT_FRAME_SIZE]; /* persist reply */
587 LANPage0_t lan_cnfg_page0;
588 LANPage1_t lan_cnfg_page1;
590 * Description: errata_flag_1064
591 * If a PCIX read occurs within 1 or 2 cycles after the chip receives
592 * a split completion for a read data, an internal address pointer incorrectly
593 * increments by 32 bytes
595 int errata_flag_1064;
596 u8 FirstWhoInit;
597 u8 upload_fw; /* If set, do a fw upload */
598 u8 reload_fw; /* Force a FW Reload on next reset */
599 u8 NBShiftFactor; /* NB Shift Factor based on Block Size (Facts) */
600 u8 pad1[4];
601 int DoneCtx;
602 int TaskCtx;
603 int InternalCtx;
604 struct list_head list;
605 struct net_device *netdev;
606 struct list_head sas_topology;
607 } MPT_ADAPTER;
610 * New return value convention:
611 * 1 = Ok to free associated request frame
612 * 0 = not Ok ...
614 typedef int (*MPT_CALLBACK)(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, MPT_FRAME_HDR *reply);
615 typedef int (*MPT_EVHANDLER)(MPT_ADAPTER *ioc, EventNotificationReply_t *evReply);
616 typedef int (*MPT_RESETHANDLER)(MPT_ADAPTER *ioc, int reset_phase);
617 /* reset_phase defs */
618 #define MPT_IOC_PRE_RESET 0
619 #define MPT_IOC_POST_RESET 1
620 #define MPT_IOC_SETUP_RESET 2
623 * Invent MPT host event (super-set of MPI Events)
624 * Fitted to 1030's 64-byte [max] request frame size
626 typedef struct _MPT_HOST_EVENT {
627 EventNotificationReply_t MpiEvent; /* 8 32-bit words! */
628 u32 pad[6];
629 void *next;
630 } MPT_HOST_EVENT;
632 #define MPT_HOSTEVENT_IOC_BRINGUP 0x91
633 #define MPT_HOSTEVENT_IOC_RECOVER 0x92
635 /* Define the generic types based on the size
636 * of the dma_addr_t type.
638 typedef struct _mpt_sge {
639 u32 FlagsLength;
640 dma_addr_t Address;
641 } MptSge_t;
643 #define mpt_addr_size() \
644 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SGE_FLAGS_64_BIT_ADDRESSING : \
645 MPI_SGE_FLAGS_32_BIT_ADDRESSING)
647 #define mpt_msg_flags() \
648 ((sizeof(dma_addr_t) == sizeof(u64)) ? MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_64 : \
649 MPI_SCSIIO_MSGFLGS_SENSE_WIDTH_32)
651 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
653 * Funky (private) macros...
655 #ifdef MPT_DEBUG
656 #define dprintk(x) printk x
657 #else
658 #define dprintk(x)
659 #endif
661 #ifdef MPT_DEBUG_INIT
662 #define dinitprintk(x) printk x
663 #define DBG_DUMP_FW_REQUEST_FRAME(mfp) \
664 { int i, n = 10; \
665 u32 *m = (u32 *)(mfp); \
666 printk(KERN_INFO " "); \
667 for (i=0; i<n; i++) \
668 printk(" %08x", le32_to_cpu(m[i])); \
669 printk("\n"); \
671 #else
672 #define dinitprintk(x)
673 #define DBG_DUMP_FW_REQUEST_FRAME(mfp)
674 #endif
676 #ifdef MPT_DEBUG_EXIT
677 #define dexitprintk(x) printk x
678 #else
679 #define dexitprintk(x)
680 #endif
682 #if defined MPT_DEBUG_FAIL || defined (MPT_DEBUG_SG)
683 #define dfailprintk(x) printk x
684 #else
685 #define dfailprintk(x)
686 #endif
688 #ifdef MPT_DEBUG_HANDSHAKE
689 #define dhsprintk(x) printk x
690 #else
691 #define dhsprintk(x)
692 #endif
694 #ifdef MPT_DEBUG_EVENTS
695 #define devtprintk(x) printk x
696 #else
697 #define devtprintk(x)
698 #endif
700 #ifdef MPT_DEBUG_RESET
701 #define drsprintk(x) printk x
702 #else
703 #define drsprintk(x)
704 #endif
706 //#if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
707 #if defined(MPT_DEBUG_MSG_FRAME)
708 #define dmfprintk(x) printk x
709 #define DBG_DUMP_REQUEST_FRAME(mfp) \
710 { int i, n = 24; \
711 u32 *m = (u32 *)(mfp); \
712 for (i=0; i<n; i++) { \
713 if (i && ((i%8)==0)) \
714 printk("\n"); \
715 printk("%08x ", le32_to_cpu(m[i])); \
717 printk("\n"); \
719 #else
720 #define dmfprintk(x)
721 #define DBG_DUMP_REQUEST_FRAME(mfp)
722 #endif
724 #ifdef MPT_DEBUG_IRQ
725 #define dirqprintk(x) printk x
726 #else
727 #define dirqprintk(x)
728 #endif
730 #ifdef MPT_DEBUG_SG
731 #define dsgprintk(x) printk x
732 #else
733 #define dsgprintk(x)
734 #endif
736 #if defined(MPT_DEBUG_DL) || defined(MPT_DEBUG)
737 #define ddlprintk(x) printk x
738 #else
739 #define ddlprintk(x)
740 #endif
742 #ifdef MPT_DEBUG_DV
743 #define ddvprintk(x) printk x
744 #else
745 #define ddvprintk(x)
746 #endif
748 #ifdef MPT_DEBUG_NEGO
749 #define dnegoprintk(x) printk x
750 #else
751 #define dnegoprintk(x)
752 #endif
754 #if defined(MPT_DEBUG_DV) || defined(MPT_DEBUG_DV_TINY)
755 #define ddvtprintk(x) printk x
756 #else
757 #define ddvtprintk(x)
758 #endif
760 #ifdef MPT_DEBUG_IOCTL
761 #define dctlprintk(x) printk x
762 #else
763 #define dctlprintk(x)
764 #endif
766 #ifdef MPT_DEBUG_REPLY
767 #define dreplyprintk(x) printk x
768 #else
769 #define dreplyprintk(x)
770 #endif
772 #ifdef MPT_DEBUG_TM
773 #define dtmprintk(x) printk x
774 #define DBG_DUMP_TM_REQUEST_FRAME(mfp) \
775 { u32 *m = (u32 *)(mfp); \
776 int i, n = 13; \
777 printk("TM_REQUEST:\n"); \
778 for (i=0; i<n; i++) { \
779 if (i && ((i%8)==0)) \
780 printk("\n"); \
781 printk("%08x ", le32_to_cpu(m[i])); \
783 printk("\n"); \
785 #define DBG_DUMP_TM_REPLY_FRAME(mfp) \
786 { u32 *m = (u32 *)(mfp); \
787 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
788 printk("TM_REPLY MessageLength=%d:\n", n); \
789 for (i=0; i<n; i++) { \
790 if (i && ((i%8)==0)) \
791 printk("\n"); \
792 printk(" %08x", le32_to_cpu(m[i])); \
794 printk("\n"); \
796 #else
797 #define dtmprintk(x)
798 #define DBG_DUMP_TM_REQUEST_FRAME(mfp)
799 #define DBG_DUMP_TM_REPLY_FRAME(mfp)
800 #endif
802 #if defined(MPT_DEBUG_CONFIG) || defined(MPT_DEBUG)
803 #define dcprintk(x) printk x
804 #else
805 #define dcprintk(x)
806 #endif
808 #if defined(MPT_DEBUG_SCSI) || defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
809 #define dsprintk(x) printk x
810 #else
811 #define dsprintk(x)
812 #endif
815 #define MPT_INDEX_2_MFPTR(ioc,idx) \
816 (MPT_FRAME_HDR*)( (u8*)(ioc)->req_frames + (ioc)->req_sz * (idx) )
818 #define MFPTR_2_MPT_INDEX(ioc,mf) \
819 (int)( ((u8*)mf - (u8*)(ioc)->req_frames) / (ioc)->req_sz )
821 #define MPT_INDEX_2_RFPTR(ioc,idx) \
822 (MPT_FRAME_HDR*)( (u8*)(ioc)->reply_frames + (ioc)->req_sz * (idx) )
824 #if defined(MPT_DEBUG) || defined(MPT_DEBUG_MSG_FRAME)
825 #define DBG_DUMP_REPLY_FRAME(mfp) \
826 { u32 *m = (u32 *)(mfp); \
827 int i, n = (le32_to_cpu(m[0]) & 0x00FF0000) >> 16; \
828 printk(KERN_INFO " "); \
829 for (i=0; i<n; i++) \
830 printk(" %08x", le32_to_cpu(m[i])); \
831 printk("\n"); \
833 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp) \
834 { int i, n = 3; \
835 u32 *m = (u32 *)(mfp); \
836 printk(KERN_INFO " "); \
837 for (i=0; i<n; i++) \
838 printk(" %08x", le32_to_cpu(m[i])); \
839 printk("\n"); \
841 #else
842 #define DBG_DUMP_REPLY_FRAME(mfp)
843 #define DBG_DUMP_REQUEST_FRAME_HDR(mfp)
844 #endif
847 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
849 #define SCSI_STD_SENSE_BYTES 18
850 #define SCSI_STD_INQUIRY_BYTES 36
851 #define SCSI_MAX_INQUIRY_BYTES 96
854 * MPT_SCSI_HOST defines - Used by the IOCTL and the SCSI drivers
855 * Private to the driver.
857 /* LOCAL structure and fields used when processing
858 * internally generated commands. These include:
859 * bus scan, dv and config requests.
861 typedef struct _MPT_LOCAL_REPLY {
862 ConfigPageHeader_t header;
863 int completion;
864 u8 sense[SCSI_STD_SENSE_BYTES];
865 u8 scsiStatus;
866 u8 skip;
867 u32 pad;
868 } MPT_LOCAL_REPLY;
870 #define MPT_HOST_BUS_UNKNOWN (0xFF)
871 #define MPT_HOST_TOO_MANY_TM (0x05)
872 #define MPT_HOST_NVRAM_INVALID (0xFFFFFFFF)
873 #define MPT_HOST_NO_CHAIN (0xFFFFFFFF)
874 #define MPT_NVRAM_MASK_TIMEOUT (0x000000FF)
875 #define MPT_NVRAM_SYNC_MASK (0x0000FF00)
876 #define MPT_NVRAM_SYNC_SHIFT (8)
877 #define MPT_NVRAM_DISCONNECT_ENABLE (0x00010000)
878 #define MPT_NVRAM_ID_SCAN_ENABLE (0x00020000)
879 #define MPT_NVRAM_LUN_SCAN_ENABLE (0x00040000)
880 #define MPT_NVRAM_TAG_QUEUE_ENABLE (0x00080000)
881 #define MPT_NVRAM_WIDE_DISABLE (0x00100000)
882 #define MPT_NVRAM_BOOT_CHOICE (0x00200000)
884 /* The TM_STATE variable is used to provide strict single threading of TM
885 * requests as well as communicate TM error conditions.
887 #define TM_STATE_NONE (0)
888 #define TM_STATE_IN_PROGRESS (1)
889 #define TM_STATE_ERROR (2)
891 typedef enum {
893 SCSI,
895 } BUS_TYPE;
897 typedef struct _MPT_SCSI_HOST {
898 MPT_ADAPTER *ioc;
899 int port;
900 u32 pad0;
901 struct scsi_cmnd **ScsiLookup;
902 VirtDevice **Targets;
903 MPT_LOCAL_REPLY *pLocal; /* used for internal commands */
904 struct timer_list timer;
905 /* Pool of memory for holding SCpnts before doing
906 * OS callbacks. freeQ is the free pool.
908 u8 tmPending;
909 u8 resetPending;
910 u8 negoNvram; /* DV disabled, nego NVRAM */
911 u8 pad1;
912 u8 tmState;
913 u8 rsvd[2];
914 MPT_FRAME_HDR *cmdPtr; /* Ptr to nonOS request */
915 struct scsi_cmnd *abortSCpnt;
916 MPT_LOCAL_REPLY localReply; /* internal cmd reply struct */
917 unsigned long hard_resets; /* driver forced bus resets count */
918 unsigned long soft_resets; /* fw/external bus resets count */
919 unsigned long timeouts; /* cmd timeouts */
920 ushort sel_timeout[MPT_MAX_FC_DEVICES];
921 char *info_kbuf;
922 wait_queue_head_t scandv_waitq;
923 int scandv_wait_done;
924 long last_queue_full;
925 u8 mpt_pq_filter;
926 } MPT_SCSI_HOST;
928 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
930 * More Dynamic Multi-Pathing stuff...
933 /* Forward decl, a strange C thing, to prevent gcc compiler warnings */
934 struct scsi_cmnd;
936 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
938 * Generic structure passed to the base mpt_config function.
940 typedef struct _x_config_parms {
941 struct list_head linkage; /* linked list */
942 struct timer_list timer; /* timer function for this request */
943 union {
944 ConfigExtendedPageHeader_t *ehdr;
945 ConfigPageHeader_t *hdr;
946 } cfghdr;
947 dma_addr_t physAddr;
948 int wait_done; /* wait for this request */
949 u32 pageAddr; /* properly formatted */
950 u8 action;
951 u8 dir;
952 u8 timeout; /* seconds */
953 u8 pad1;
954 u16 status;
955 u16 pad2;
956 } CONFIGPARMS;
958 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
960 * Public entry points...
962 extern int mpt_attach(struct pci_dev *pdev, const struct pci_device_id *id);
963 extern void mpt_detach(struct pci_dev *pdev);
964 #ifdef CONFIG_PM
965 extern int mpt_suspend(struct pci_dev *pdev, pm_message_t state);
966 extern int mpt_resume(struct pci_dev *pdev);
967 #endif
968 extern int mpt_register(MPT_CALLBACK cbfunc, MPT_DRIVER_CLASS dclass);
969 extern void mpt_deregister(int cb_idx);
970 extern int mpt_event_register(int cb_idx, MPT_EVHANDLER ev_cbfunc);
971 extern void mpt_event_deregister(int cb_idx);
972 extern int mpt_reset_register(int cb_idx, MPT_RESETHANDLER reset_func);
973 extern void mpt_reset_deregister(int cb_idx);
974 extern int mpt_device_driver_register(struct mpt_pci_driver * dd_cbfunc, int cb_idx);
975 extern void mpt_device_driver_deregister(int cb_idx);
976 extern MPT_FRAME_HDR *mpt_get_msg_frame(int handle, MPT_ADAPTER *ioc);
977 extern void mpt_free_msg_frame(MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
978 extern void mpt_put_msg_frame(int handle, MPT_ADAPTER *ioc, MPT_FRAME_HDR *mf);
979 extern void mpt_add_sge(char *pAddr, u32 flagslength, dma_addr_t dma_addr);
981 extern int mpt_send_handshake_request(int handle, MPT_ADAPTER *ioc, int reqBytes, u32 *req, int sleepFlag);
982 extern int mpt_verify_adapter(int iocid, MPT_ADAPTER **iocpp);
983 extern u32 mpt_GetIocState(MPT_ADAPTER *ioc, int cooked);
984 extern void mpt_print_ioc_summary(MPT_ADAPTER *ioc, char *buf, int *size, int len, int showlan);
985 extern int mpt_HardResetHandler(MPT_ADAPTER *ioc, int sleepFlag);
986 extern int mpt_config(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
987 extern int mpt_toolbox(MPT_ADAPTER *ioc, CONFIGPARMS *cfg);
988 extern void mpt_alloc_fw_memory(MPT_ADAPTER *ioc, int size);
989 extern void mpt_free_fw_memory(MPT_ADAPTER *ioc);
990 extern int mpt_findImVolumes(MPT_ADAPTER *ioc);
991 extern int mpt_read_ioc_pg_3(MPT_ADAPTER *ioc);
992 extern int mptbase_sas_persist_operation(MPT_ADAPTER *ioc, u8 persist_opcode);
995 * Public data decl's...
997 extern struct list_head ioc_list;
998 extern struct proc_dir_entry *mpt_proc_root_dir;
1000 extern int mpt_lan_index; /* needed by mptlan.c */
1001 extern int mpt_stm_index; /* needed by mptstm.c */
1003 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1004 #endif /* } __KERNEL__ */
1006 #if defined(__alpha__) || defined(__sparc_v9__) || defined(__ia64__) || defined(__x86_64__)
1007 #define CAST_U32_TO_PTR(x) ((void *)(u64)x)
1008 #define CAST_PTR_TO_U32(x) ((u32)(u64)x)
1009 #else
1010 #define CAST_U32_TO_PTR(x) ((void *)x)
1011 #define CAST_PTR_TO_U32(x) ((u32)x)
1012 #endif
1014 #define MPT_PROTOCOL_FLAGS_c_c_c_c(pflags) \
1015 ((pflags) & MPI_PORTFACTS_PROTOCOL_INITIATOR) ? 'I' : 'i', \
1016 ((pflags) & MPI_PORTFACTS_PROTOCOL_TARGET) ? 'T' : 't', \
1017 ((pflags) & MPI_PORTFACTS_PROTOCOL_LAN) ? 'L' : 'l', \
1018 ((pflags) & MPI_PORTFACTS_PROTOCOL_LOGBUSADDR) ? 'B' : 'b'
1021 * Shifted SGE Defines - Use in SGE with FlagsLength member.
1022 * Otherwise, use MPI_xxx defines (refer to "lsi/mpi.h" header).
1023 * Defaults: 32 bit SGE, SYSTEM_ADDRESS if direction bit is 0, read
1025 #define MPT_TRANSFER_IOC_TO_HOST (0x00000000)
1026 #define MPT_TRANSFER_HOST_TO_IOC (0x04000000)
1027 #define MPT_SGE_FLAGS_LAST_ELEMENT (0x80000000)
1028 #define MPT_SGE_FLAGS_END_OF_BUFFER (0x40000000)
1029 #define MPT_SGE_FLAGS_LOCAL_ADDRESS (0x08000000)
1030 #define MPT_SGE_FLAGS_DIRECTION (0x04000000)
1031 #define MPT_SGE_FLAGS_ADDRESSING (mpt_addr_size() << MPI_SGE_FLAGS_SHIFT)
1032 #define MPT_SGE_FLAGS_END_OF_LIST (0x01000000)
1034 #define MPT_SGE_FLAGS_TRANSACTION_ELEMENT (0x00000000)
1035 #define MPT_SGE_FLAGS_SIMPLE_ELEMENT (0x10000000)
1036 #define MPT_SGE_FLAGS_CHAIN_ELEMENT (0x30000000)
1037 #define MPT_SGE_FLAGS_ELEMENT_MASK (0x30000000)
1039 #define MPT_SGE_FLAGS_SSIMPLE_READ \
1040 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1041 MPT_SGE_FLAGS_END_OF_BUFFER | \
1042 MPT_SGE_FLAGS_END_OF_LIST | \
1043 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1044 MPT_SGE_FLAGS_ADDRESSING | \
1045 MPT_TRANSFER_IOC_TO_HOST)
1046 #define MPT_SGE_FLAGS_SSIMPLE_WRITE \
1047 (MPT_SGE_FLAGS_LAST_ELEMENT | \
1048 MPT_SGE_FLAGS_END_OF_BUFFER | \
1049 MPT_SGE_FLAGS_END_OF_LIST | \
1050 MPT_SGE_FLAGS_SIMPLE_ELEMENT | \
1051 MPT_SGE_FLAGS_ADDRESSING | \
1052 MPT_TRANSFER_HOST_TO_IOC)
1054 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
1055 #endif