Linux 2.6.26-rc5
[linux-2.6/openmoko-kernel/knife-kernel.git] / drivers / scsi / aacraid / aacraid.h
blob73916adb8f80f21d587cf1fbe499a14252c042fb
1 #ifndef dprintk
2 # define dprintk(x)
3 #endif
4 /* eg: if (nblank(dprintk(x))) */
5 #define _nblank(x) #x
6 #define nblank(x) _nblank(x)[0]
8 #include <linux/interrupt.h>
10 /*------------------------------------------------------------------------------
11 * D E F I N E S
12 *----------------------------------------------------------------------------*/
14 #ifndef AAC_DRIVER_BUILD
15 # define AAC_DRIVER_BUILD 2456
16 # define AAC_DRIVER_BRANCH "-ms"
17 #endif
18 #define MAXIMUM_NUM_CONTAINERS 32
20 #define AAC_NUM_MGT_FIB 8
21 #define AAC_NUM_IO_FIB (512 - AAC_NUM_MGT_FIB)
22 #define AAC_NUM_FIB (AAC_NUM_IO_FIB + AAC_NUM_MGT_FIB)
24 #define AAC_MAX_LUN (8)
26 #define AAC_MAX_HOSTPHYSMEMPAGES (0xfffff)
27 #define AAC_MAX_32BIT_SGBCOUNT ((unsigned short)256)
30 * These macros convert from physical channels to virtual channels
32 #define CONTAINER_CHANNEL (0)
33 #define CONTAINER_TO_CHANNEL(cont) (CONTAINER_CHANNEL)
34 #define CONTAINER_TO_ID(cont) (cont)
35 #define CONTAINER_TO_LUN(cont) (0)
37 #define aac_phys_to_logical(x) ((x)+1)
38 #define aac_logical_to_phys(x) ((x)?(x)-1:0)
40 /* #define AAC_DETAILED_STATUS_INFO */
42 struct diskparm
44 int heads;
45 int sectors;
46 int cylinders;
51 * Firmware constants
54 #define CT_NONE 0
55 #define CT_OK 218
56 #define FT_FILESYS 8 /* ADAPTEC's "FSA"(tm) filesystem */
57 #define FT_DRIVE 9 /* physical disk - addressable in scsi by bus/id/lun */
60 * Host side memory scatter gather list
61 * Used by the adapter for read, write, and readdirplus operations
62 * We have separate 32 and 64 bit version because even
63 * on 64 bit systems not all cards support the 64 bit version
65 struct sgentry {
66 __le32 addr; /* 32-bit address. */
67 __le32 count; /* Length. */
70 struct user_sgentry {
71 u32 addr; /* 32-bit address. */
72 u32 count; /* Length. */
75 struct sgentry64 {
76 __le32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
77 __le32 count; /* Length. */
80 struct user_sgentry64 {
81 u32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
82 u32 count; /* Length. */
85 struct sgentryraw {
86 __le32 next; /* reserved for F/W use */
87 __le32 prev; /* reserved for F/W use */
88 __le32 addr[2];
89 __le32 count;
90 __le32 flags; /* reserved for F/W use */
93 struct user_sgentryraw {
94 u32 next; /* reserved for F/W use */
95 u32 prev; /* reserved for F/W use */
96 u32 addr[2];
97 u32 count;
98 u32 flags; /* reserved for F/W use */
102 * SGMAP
104 * This is the SGMAP structure for all commands that use
105 * 32-bit addressing.
108 struct sgmap {
109 __le32 count;
110 struct sgentry sg[1];
113 struct user_sgmap {
114 u32 count;
115 struct user_sgentry sg[1];
118 struct sgmap64 {
119 __le32 count;
120 struct sgentry64 sg[1];
123 struct user_sgmap64 {
124 u32 count;
125 struct user_sgentry64 sg[1];
128 struct sgmapraw {
129 __le32 count;
130 struct sgentryraw sg[1];
133 struct user_sgmapraw {
134 u32 count;
135 struct user_sgentryraw sg[1];
138 struct creation_info
140 u8 buildnum; /* e.g., 588 */
141 u8 usec; /* e.g., 588 */
142 u8 via; /* e.g., 1 = FSU,
143 * 2 = API
145 u8 year; /* e.g., 1997 = 97 */
146 __le32 date; /*
147 * unsigned Month :4; // 1 - 12
148 * unsigned Day :6; // 1 - 32
149 * unsigned Hour :6; // 0 - 23
150 * unsigned Minute :6; // 0 - 60
151 * unsigned Second :6; // 0 - 60
153 __le32 serial[2]; /* e.g., 0x1DEADB0BFAFAF001 */
158 * Define all the constants needed for the communication interface
162 * Define how many queue entries each queue will have and the total
163 * number of entries for the entire communication interface. Also define
164 * how many queues we support.
166 * This has to match the controller
169 #define NUMBER_OF_COMM_QUEUES 8 // 4 command; 4 response
170 #define HOST_HIGH_CMD_ENTRIES 4
171 #define HOST_NORM_CMD_ENTRIES 8
172 #define ADAP_HIGH_CMD_ENTRIES 4
173 #define ADAP_NORM_CMD_ENTRIES 512
174 #define HOST_HIGH_RESP_ENTRIES 4
175 #define HOST_NORM_RESP_ENTRIES 512
176 #define ADAP_HIGH_RESP_ENTRIES 4
177 #define ADAP_NORM_RESP_ENTRIES 8
179 #define TOTAL_QUEUE_ENTRIES \
180 (HOST_NORM_CMD_ENTRIES + HOST_HIGH_CMD_ENTRIES + ADAP_NORM_CMD_ENTRIES + ADAP_HIGH_CMD_ENTRIES + \
181 HOST_NORM_RESP_ENTRIES + HOST_HIGH_RESP_ENTRIES + ADAP_NORM_RESP_ENTRIES + ADAP_HIGH_RESP_ENTRIES)
185 * Set the queues on a 16 byte alignment
188 #define QUEUE_ALIGNMENT 16
191 * The queue headers define the Communication Region queues. These
192 * are physically contiguous and accessible by both the adapter and the
193 * host. Even though all queue headers are in the same contiguous block
194 * they will be represented as individual units in the data structures.
197 struct aac_entry {
198 __le32 size; /* Size in bytes of Fib which this QE points to */
199 __le32 addr; /* Receiver address of the FIB */
203 * The adapter assumes the ProducerIndex and ConsumerIndex are grouped
204 * adjacently and in that order.
207 struct aac_qhdr {
208 __le64 header_addr;/* Address to hand the adapter to access
209 to this queue head */
210 __le32 *producer; /* The producer index for this queue (host address) */
211 __le32 *consumer; /* The consumer index for this queue (host address) */
215 * Define all the events which the adapter would like to notify
216 * the host of.
219 #define HostNormCmdQue 1 /* Change in host normal priority command queue */
220 #define HostHighCmdQue 2 /* Change in host high priority command queue */
221 #define HostNormRespQue 3 /* Change in host normal priority response queue */
222 #define HostHighRespQue 4 /* Change in host high priority response queue */
223 #define AdapNormRespNotFull 5
224 #define AdapHighRespNotFull 6
225 #define AdapNormCmdNotFull 7
226 #define AdapHighCmdNotFull 8
227 #define SynchCommandComplete 9
228 #define AdapInternalError 0xfe /* The adapter detected an internal error shutting down */
231 * Define all the events the host wishes to notify the
232 * adapter of. The first four values much match the Qid the
233 * corresponding queue.
236 #define AdapNormCmdQue 2
237 #define AdapHighCmdQue 3
238 #define AdapNormRespQue 6
239 #define AdapHighRespQue 7
240 #define HostShutdown 8
241 #define HostPowerFail 9
242 #define FatalCommError 10
243 #define HostNormRespNotFull 11
244 #define HostHighRespNotFull 12
245 #define HostNormCmdNotFull 13
246 #define HostHighCmdNotFull 14
247 #define FastIo 15
248 #define AdapPrintfDone 16
251 * Define all the queues that the adapter and host use to communicate
252 * Number them to match the physical queue layout.
255 enum aac_queue_types {
256 HostNormCmdQueue = 0, /* Adapter to host normal priority command traffic */
257 HostHighCmdQueue, /* Adapter to host high priority command traffic */
258 AdapNormCmdQueue, /* Host to adapter normal priority command traffic */
259 AdapHighCmdQueue, /* Host to adapter high priority command traffic */
260 HostNormRespQueue, /* Adapter to host normal priority response traffic */
261 HostHighRespQueue, /* Adapter to host high priority response traffic */
262 AdapNormRespQueue, /* Host to adapter normal priority response traffic */
263 AdapHighRespQueue /* Host to adapter high priority response traffic */
267 * Assign type values to the FSA communication data structures
270 #define FIB_MAGIC 0x0001
273 * Define the priority levels the FSA communication routines support.
276 #define FsaNormal 1
279 * Define the FIB. The FIB is the where all the requested data and
280 * command information are put to the application on the FSA adapter.
283 struct aac_fibhdr {
284 __le32 XferState; /* Current transfer state for this CCB */
285 __le16 Command; /* Routing information for the destination */
286 u8 StructType; /* Type FIB */
287 u8 Flags; /* Flags for FIB */
288 __le16 Size; /* Size of this FIB in bytes */
289 __le16 SenderSize; /* Size of the FIB in the sender
290 (for response sizing) */
291 __le32 SenderFibAddress; /* Host defined data in the FIB */
292 __le32 ReceiverFibAddress;/* Logical address of this FIB for
293 the adapter */
294 u32 SenderData; /* Place holder for the sender to store data */
295 union {
296 struct {
297 __le32 _ReceiverTimeStart; /* Timestamp for
298 receipt of fib */
299 __le32 _ReceiverTimeDone; /* Timestamp for
300 completion of fib */
301 } _s;
302 } _u;
305 struct hw_fib {
306 struct aac_fibhdr header;
307 u8 data[512-sizeof(struct aac_fibhdr)]; // Command specific data
311 * FIB commands
314 #define TestCommandResponse 1
315 #define TestAdapterCommand 2
317 * Lowlevel and comm commands
319 #define LastTestCommand 100
320 #define ReinitHostNormCommandQueue 101
321 #define ReinitHostHighCommandQueue 102
322 #define ReinitHostHighRespQueue 103
323 #define ReinitHostNormRespQueue 104
324 #define ReinitAdapNormCommandQueue 105
325 #define ReinitAdapHighCommandQueue 107
326 #define ReinitAdapHighRespQueue 108
327 #define ReinitAdapNormRespQueue 109
328 #define InterfaceShutdown 110
329 #define DmaCommandFib 120
330 #define StartProfile 121
331 #define TermProfile 122
332 #define SpeedTest 123
333 #define TakeABreakPt 124
334 #define RequestPerfData 125
335 #define SetInterruptDefTimer 126
336 #define SetInterruptDefCount 127
337 #define GetInterruptDefStatus 128
338 #define LastCommCommand 129
340 * Filesystem commands
342 #define NuFileSystem 300
343 #define UFS 301
344 #define HostFileSystem 302
345 #define LastFileSystemCommand 303
347 * Container Commands
349 #define ContainerCommand 500
350 #define ContainerCommand64 501
351 #define ContainerRawIo 502
353 * Scsi Port commands (scsi passthrough)
355 #define ScsiPortCommand 600
356 #define ScsiPortCommand64 601
358 * Misc house keeping and generic adapter initiated commands
360 #define AifRequest 700
361 #define CheckRevision 701
362 #define FsaHostShutdown 702
363 #define RequestAdapterInfo 703
364 #define IsAdapterPaused 704
365 #define SendHostTime 705
366 #define RequestSupplementAdapterInfo 706
367 #define LastMiscCommand 707
370 * Commands that will target the failover level on the FSA adapter
373 enum fib_xfer_state {
374 HostOwned = (1<<0),
375 AdapterOwned = (1<<1),
376 FibInitialized = (1<<2),
377 FibEmpty = (1<<3),
378 AllocatedFromPool = (1<<4),
379 SentFromHost = (1<<5),
380 SentFromAdapter = (1<<6),
381 ResponseExpected = (1<<7),
382 NoResponseExpected = (1<<8),
383 AdapterProcessed = (1<<9),
384 HostProcessed = (1<<10),
385 HighPriority = (1<<11),
386 NormalPriority = (1<<12),
387 Async = (1<<13),
388 AsyncIo = (1<<13), // rpbfix: remove with new regime
389 PageFileIo = (1<<14), // rpbfix: remove with new regime
390 ShutdownRequest = (1<<15),
391 LazyWrite = (1<<16), // rpbfix: remove with new regime
392 AdapterMicroFib = (1<<17),
393 BIOSFibPath = (1<<18),
394 FastResponseCapable = (1<<19),
395 ApiFib = (1<<20) // Its an API Fib.
399 * The following defines needs to be updated any time there is an
400 * incompatible change made to the aac_init structure.
403 #define ADAPTER_INIT_STRUCT_REVISION 3
404 #define ADAPTER_INIT_STRUCT_REVISION_4 4 // rocket science
406 struct aac_init
408 __le32 InitStructRevision;
409 __le32 MiniPortRevision;
410 __le32 fsrev;
411 __le32 CommHeaderAddress;
412 __le32 FastIoCommAreaAddress;
413 __le32 AdapterFibsPhysicalAddress;
414 __le32 AdapterFibsVirtualAddress;
415 __le32 AdapterFibsSize;
416 __le32 AdapterFibAlign;
417 __le32 printfbuf;
418 __le32 printfbufsiz;
419 __le32 HostPhysMemPages; /* number of 4k pages of host
420 physical memory */
421 __le32 HostElapsedSeconds; /* number of seconds since 1970. */
423 * ADAPTER_INIT_STRUCT_REVISION_4 begins here
425 __le32 InitFlags; /* flags for supported features */
426 #define INITFLAGS_NEW_COMM_SUPPORTED 0x00000001
427 #define INITFLAGS_DRIVER_USES_UTC_TIME 0x00000010
428 #define INITFLAGS_DRIVER_SUPPORTS_PM 0x00000020
429 __le32 MaxIoCommands; /* max outstanding commands */
430 __le32 MaxIoSize; /* largest I/O command */
431 __le32 MaxFibSize; /* largest FIB to adapter */
434 enum aac_log_level {
435 LOG_AAC_INIT = 10,
436 LOG_AAC_INFORMATIONAL = 20,
437 LOG_AAC_WARNING = 30,
438 LOG_AAC_LOW_ERROR = 40,
439 LOG_AAC_MEDIUM_ERROR = 50,
440 LOG_AAC_HIGH_ERROR = 60,
441 LOG_AAC_PANIC = 70,
442 LOG_AAC_DEBUG = 80,
443 LOG_AAC_WINDBG_PRINT = 90
446 #define FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT 0x030b
447 #define FSAFS_NTC_FIB_CONTEXT 0x030c
449 struct aac_dev;
450 struct fib;
451 struct scsi_cmnd;
453 struct adapter_ops
455 /* Low level operations */
456 void (*adapter_interrupt)(struct aac_dev *dev);
457 void (*adapter_notify)(struct aac_dev *dev, u32 event);
458 void (*adapter_disable_int)(struct aac_dev *dev);
459 void (*adapter_enable_int)(struct aac_dev *dev);
460 int (*adapter_sync_cmd)(struct aac_dev *dev, u32 command, u32 p1, u32 p2, u32 p3, u32 p4, u32 p5, u32 p6, u32 *status, u32 *r1, u32 *r2, u32 *r3, u32 *r4);
461 int (*adapter_check_health)(struct aac_dev *dev);
462 int (*adapter_restart)(struct aac_dev *dev, int bled);
463 /* Transport operations */
464 int (*adapter_ioremap)(struct aac_dev * dev, u32 size);
465 irq_handler_t adapter_intr;
466 /* Packet operations */
467 int (*adapter_deliver)(struct fib * fib);
468 int (*adapter_bounds)(struct aac_dev * dev, struct scsi_cmnd * cmd, u64 lba);
469 int (*adapter_read)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count);
470 int (*adapter_write)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count, int fua);
471 int (*adapter_scsi)(struct fib * fib, struct scsi_cmnd * cmd);
472 /* Administrative operations */
473 int (*adapter_comm)(struct aac_dev * dev, int comm);
477 * Define which interrupt handler needs to be installed
480 struct aac_driver_ident
482 int (*init)(struct aac_dev *dev);
483 char * name;
484 char * vname;
485 char * model;
486 u16 channels;
487 int quirks;
490 * Some adapter firmware needs communication memory
491 * below 2gig. This tells the init function to set the
492 * dma mask such that fib memory will be allocated where the
493 * adapter firmware can get to it.
495 #define AAC_QUIRK_31BIT 0x0001
498 * Some adapter firmware, when the raid card's cache is turned off, can not
499 * split up scatter gathers in order to deal with the limits of the
500 * underlying CHIM. This limit is 34 scatter gather elements.
502 #define AAC_QUIRK_34SG 0x0002
505 * This adapter is a slave (no Firmware)
507 #define AAC_QUIRK_SLAVE 0x0004
510 * This adapter is a master.
512 #define AAC_QUIRK_MASTER 0x0008
515 * Some adapter firmware perform poorly when it must split up scatter gathers
516 * in order to deal with the limits of the underlying CHIM. This limit in this
517 * class of adapters is 17 scatter gather elements.
519 #define AAC_QUIRK_17SG 0x0010
522 * Some adapter firmware does not support 64 bit scsi passthrough
523 * commands.
525 #define AAC_QUIRK_SCSI_32 0x0020
528 * The adapter interface specs all queues to be located in the same
529 * physically contigous block. The host structure that defines the
530 * commuication queues will assume they are each a separate physically
531 * contigous memory region that will support them all being one big
532 * contigous block.
533 * There is a command and response queue for each level and direction of
534 * commuication. These regions are accessed by both the host and adapter.
537 struct aac_queue {
538 u64 logical; /*address we give the adapter */
539 struct aac_entry *base; /*system virtual address */
540 struct aac_qhdr headers; /*producer,consumer q headers*/
541 u32 entries; /*Number of queue entries */
542 wait_queue_head_t qfull; /*Event to wait on if q full */
543 wait_queue_head_t cmdready; /*Cmd ready from the adapter */
544 /* This is only valid for adapter to host command queues. */
545 spinlock_t *lock; /* Spinlock for this queue must take this lock before accessing the lock */
546 spinlock_t lockdata; /* Actual lock (used only on one side of the lock) */
547 struct list_head cmdq; /* A queue of FIBs which need to be prcessed by the FS thread. This is */
548 /* only valid for command queues which receive entries from the adapter. */
549 u32 numpending; /* Number of entries on outstanding queue. */
550 struct aac_dev * dev; /* Back pointer to adapter structure */
554 * Message queues. The order here is important, see also the
555 * queue type ordering
558 struct aac_queue_block
560 struct aac_queue queue[8];
564 * SaP1 Message Unit Registers
567 struct sa_drawbridge_CSR {
568 /* Offset | Name */
569 __le32 reserved[10]; /* 00h-27h | Reserved */
570 u8 LUT_Offset; /* 28h | Lookup Table Offset */
571 u8 reserved1[3]; /* 29h-2bh | Reserved */
572 __le32 LUT_Data; /* 2ch | Looup Table Data */
573 __le32 reserved2[26]; /* 30h-97h | Reserved */
574 __le16 PRICLEARIRQ; /* 98h | Primary Clear Irq */
575 __le16 SECCLEARIRQ; /* 9ah | Secondary Clear Irq */
576 __le16 PRISETIRQ; /* 9ch | Primary Set Irq */
577 __le16 SECSETIRQ; /* 9eh | Secondary Set Irq */
578 __le16 PRICLEARIRQMASK;/* a0h | Primary Clear Irq Mask */
579 __le16 SECCLEARIRQMASK;/* a2h | Secondary Clear Irq Mask */
580 __le16 PRISETIRQMASK; /* a4h | Primary Set Irq Mask */
581 __le16 SECSETIRQMASK; /* a6h | Secondary Set Irq Mask */
582 __le32 MAILBOX0; /* a8h | Scratchpad 0 */
583 __le32 MAILBOX1; /* ach | Scratchpad 1 */
584 __le32 MAILBOX2; /* b0h | Scratchpad 2 */
585 __le32 MAILBOX3; /* b4h | Scratchpad 3 */
586 __le32 MAILBOX4; /* b8h | Scratchpad 4 */
587 __le32 MAILBOX5; /* bch | Scratchpad 5 */
588 __le32 MAILBOX6; /* c0h | Scratchpad 6 */
589 __le32 MAILBOX7; /* c4h | Scratchpad 7 */
590 __le32 ROM_Setup_Data; /* c8h | Rom Setup and Data */
591 __le32 ROM_Control_Addr;/* cch | Rom Control and Address */
592 __le32 reserved3[12]; /* d0h-ffh | reserved */
593 __le32 LUT[64]; /* 100h-1ffh | Lookup Table Entries */
596 #define Mailbox0 SaDbCSR.MAILBOX0
597 #define Mailbox1 SaDbCSR.MAILBOX1
598 #define Mailbox2 SaDbCSR.MAILBOX2
599 #define Mailbox3 SaDbCSR.MAILBOX3
600 #define Mailbox4 SaDbCSR.MAILBOX4
601 #define Mailbox5 SaDbCSR.MAILBOX5
602 #define Mailbox6 SaDbCSR.MAILBOX6
603 #define Mailbox7 SaDbCSR.MAILBOX7
605 #define DoorbellReg_p SaDbCSR.PRISETIRQ
606 #define DoorbellReg_s SaDbCSR.SECSETIRQ
607 #define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ
610 #define DOORBELL_0 0x0001
611 #define DOORBELL_1 0x0002
612 #define DOORBELL_2 0x0004
613 #define DOORBELL_3 0x0008
614 #define DOORBELL_4 0x0010
615 #define DOORBELL_5 0x0020
616 #define DOORBELL_6 0x0040
619 #define PrintfReady DOORBELL_5
620 #define PrintfDone DOORBELL_5
622 struct sa_registers {
623 struct sa_drawbridge_CSR SaDbCSR; /* 98h - c4h */
627 #define Sa_MINIPORT_REVISION 1
629 #define sa_readw(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
630 #define sa_readl(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
631 #define sa_writew(AEP, CSR, value) writew(value, &((AEP)->regs.sa->CSR))
632 #define sa_writel(AEP, CSR, value) writel(value, &((AEP)->regs.sa->CSR))
635 * Rx Message Unit Registers
638 struct rx_mu_registers {
639 /* Local | PCI*| Name */
640 __le32 ARSR; /* 1300h | 00h | APIC Register Select Register */
641 __le32 reserved0; /* 1304h | 04h | Reserved */
642 __le32 AWR; /* 1308h | 08h | APIC Window Register */
643 __le32 reserved1; /* 130Ch | 0Ch | Reserved */
644 __le32 IMRx[2]; /* 1310h | 10h | Inbound Message Registers */
645 __le32 OMRx[2]; /* 1318h | 18h | Outbound Message Registers */
646 __le32 IDR; /* 1320h | 20h | Inbound Doorbell Register */
647 __le32 IISR; /* 1324h | 24h | Inbound Interrupt
648 Status Register */
649 __le32 IIMR; /* 1328h | 28h | Inbound Interrupt
650 Mask Register */
651 __le32 ODR; /* 132Ch | 2Ch | Outbound Doorbell Register */
652 __le32 OISR; /* 1330h | 30h | Outbound Interrupt
653 Status Register */
654 __le32 OIMR; /* 1334h | 34h | Outbound Interrupt
655 Mask Register */
656 __le32 reserved2; /* 1338h | 38h | Reserved */
657 __le32 reserved3; /* 133Ch | 3Ch | Reserved */
658 __le32 InboundQueue;/* 1340h | 40h | Inbound Queue Port relative to firmware */
659 __le32 OutboundQueue;/*1344h | 44h | Outbound Queue Port relative to firmware */
660 /* * Must access through ATU Inbound
661 Translation Window */
664 struct rx_inbound {
665 __le32 Mailbox[8];
668 #define INBOUNDDOORBELL_0 0x00000001
669 #define INBOUNDDOORBELL_1 0x00000002
670 #define INBOUNDDOORBELL_2 0x00000004
671 #define INBOUNDDOORBELL_3 0x00000008
672 #define INBOUNDDOORBELL_4 0x00000010
673 #define INBOUNDDOORBELL_5 0x00000020
674 #define INBOUNDDOORBELL_6 0x00000040
676 #define OUTBOUNDDOORBELL_0 0x00000001
677 #define OUTBOUNDDOORBELL_1 0x00000002
678 #define OUTBOUNDDOORBELL_2 0x00000004
679 #define OUTBOUNDDOORBELL_3 0x00000008
680 #define OUTBOUNDDOORBELL_4 0x00000010
682 #define InboundDoorbellReg MUnit.IDR
683 #define OutboundDoorbellReg MUnit.ODR
685 struct rx_registers {
686 struct rx_mu_registers MUnit; /* 1300h - 1344h */
687 __le32 reserved1[2]; /* 1348h - 134ch */
688 struct rx_inbound IndexRegs;
691 #define rx_readb(AEP, CSR) readb(&((AEP)->regs.rx->CSR))
692 #define rx_readl(AEP, CSR) readl(&((AEP)->regs.rx->CSR))
693 #define rx_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rx->CSR))
694 #define rx_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rx->CSR))
697 * Rkt Message Unit Registers (same as Rx, except a larger reserve region)
700 #define rkt_mu_registers rx_mu_registers
701 #define rkt_inbound rx_inbound
703 struct rkt_registers {
704 struct rkt_mu_registers MUnit; /* 1300h - 1344h */
705 __le32 reserved1[1006]; /* 1348h - 22fch */
706 struct rkt_inbound IndexRegs; /* 2300h - */
709 #define rkt_readb(AEP, CSR) readb(&((AEP)->regs.rkt->CSR))
710 #define rkt_readl(AEP, CSR) readl(&((AEP)->regs.rkt->CSR))
711 #define rkt_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rkt->CSR))
712 #define rkt_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rkt->CSR))
714 typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
716 struct aac_fib_context {
717 s16 type; // used for verification of structure
718 s16 size;
719 u32 unique; // unique value representing this context
720 ulong jiffies; // used for cleanup - dmb changed to ulong
721 struct list_head next; // used to link context's into a linked list
722 struct semaphore wait_sem; // this is used to wait for the next fib to arrive.
723 int wait; // Set to true when thread is in WaitForSingleObject
724 unsigned long count; // total number of FIBs on FibList
725 struct list_head fib_list; // this holds fibs and their attachd hw_fibs
728 struct sense_data {
729 u8 error_code; /* 70h (current errors), 71h(deferred errors) */
730 u8 valid:1; /* A valid bit of one indicates that the information */
731 /* field contains valid information as defined in the
732 * SCSI-2 Standard.
734 u8 segment_number; /* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
735 u8 sense_key:4; /* Sense Key */
736 u8 reserved:1;
737 u8 ILI:1; /* Incorrect Length Indicator */
738 u8 EOM:1; /* End Of Medium - reserved for random access devices */
739 u8 filemark:1; /* Filemark - reserved for random access devices */
741 u8 information[4]; /* for direct-access devices, contains the unsigned
742 * logical block address or residue associated with
743 * the sense key
745 u8 add_sense_len; /* number of additional sense bytes to follow this field */
746 u8 cmnd_info[4]; /* not used */
747 u8 ASC; /* Additional Sense Code */
748 u8 ASCQ; /* Additional Sense Code Qualifier */
749 u8 FRUC; /* Field Replaceable Unit Code - not used */
750 u8 bit_ptr:3; /* indicates which byte of the CDB or parameter data
751 * was in error
753 u8 BPV:1; /* bit pointer valid (BPV): 1- indicates that
754 * the bit_ptr field has valid value
756 u8 reserved2:2;
757 u8 CD:1; /* command data bit: 1- illegal parameter in CDB.
758 * 0- illegal parameter in data.
760 u8 SKSV:1;
761 u8 field_ptr[2]; /* byte of the CDB or parameter data in error */
764 struct fsa_dev_info {
765 u64 last;
766 u64 size;
767 u32 type;
768 u32 config_waiting_on;
769 unsigned long config_waiting_stamp;
770 u16 queue_depth;
771 u8 config_needed;
772 u8 valid;
773 u8 ro;
774 u8 locked;
775 u8 deleted;
776 char devname[8];
777 struct sense_data sense_data;
780 struct fib {
781 void *next; /* this is used by the allocator */
782 s16 type;
783 s16 size;
785 * The Adapter that this I/O is destined for.
787 struct aac_dev *dev;
789 * This is the event the sendfib routine will wait on if the
790 * caller did not pass one and this is synch io.
792 struct semaphore event_wait;
793 spinlock_t event_lock;
795 u32 done; /* gets set to 1 when fib is complete */
796 fib_callback callback;
797 void *callback_data;
798 u32 flags; // u32 dmb was ulong
800 * And for the internal issue/reply queues (we may be able
801 * to merge these two)
803 struct list_head fiblink;
804 void *data;
805 struct hw_fib *hw_fib_va; /* Actual shared object */
806 dma_addr_t hw_fib_pa; /* physical address of hw_fib*/
810 * Adapter Information Block
812 * This is returned by the RequestAdapterInfo block
815 struct aac_adapter_info
817 __le32 platform;
818 __le32 cpu;
819 __le32 subcpu;
820 __le32 clock;
821 __le32 execmem;
822 __le32 buffermem;
823 __le32 totalmem;
824 __le32 kernelrev;
825 __le32 kernelbuild;
826 __le32 monitorrev;
827 __le32 monitorbuild;
828 __le32 hwrev;
829 __le32 hwbuild;
830 __le32 biosrev;
831 __le32 biosbuild;
832 __le32 cluster;
833 __le32 clusterchannelmask;
834 __le32 serial[2];
835 __le32 battery;
836 __le32 options;
837 __le32 OEM;
840 struct aac_supplement_adapter_info
842 u8 AdapterTypeText[17+1];
843 u8 Pad[2];
844 __le32 FlashMemoryByteSize;
845 __le32 FlashImageId;
846 __le32 MaxNumberPorts;
847 __le32 Version;
848 __le32 FeatureBits;
849 u8 SlotNumber;
850 u8 ReservedPad0[3];
851 u8 BuildDate[12];
852 __le32 CurrentNumberPorts;
853 struct {
854 u8 AssemblyPn[8];
855 u8 FruPn[8];
856 u8 BatteryFruPn[8];
857 u8 EcVersionString[8];
858 u8 Tsid[12];
859 } VpdInfo;
860 __le32 FlashFirmwareRevision;
861 __le32 FlashFirmwareBuild;
862 __le32 RaidTypeMorphOptions;
863 __le32 FlashFirmwareBootRevision;
864 __le32 FlashFirmwareBootBuild;
865 u8 MfgPcbaSerialNo[12];
866 u8 MfgWWNName[8];
867 __le32 SupportedOptions2;
868 __le32 ReservedGrowth[1];
870 #define AAC_FEATURE_FALCON cpu_to_le32(0x00000010)
871 #define AAC_FEATURE_JBOD cpu_to_le32(0x08000000)
872 /* SupportedOptions2 */
873 #define AAC_OPTION_MU_RESET cpu_to_le32(0x00000001)
874 #define AAC_OPTION_IGNORE_RESET cpu_to_le32(0x00000002)
875 #define AAC_OPTION_POWER_MANAGEMENT cpu_to_le32(0x00000004)
876 #define AAC_SIS_VERSION_V3 3
877 #define AAC_SIS_SLOT_UNKNOWN 0xFF
879 #define GetBusInfo 0x00000009
880 struct aac_bus_info {
881 __le32 Command; /* VM_Ioctl */
882 __le32 ObjType; /* FT_DRIVE */
883 __le32 MethodId; /* 1 = SCSI Layer */
884 __le32 ObjectId; /* Handle */
885 __le32 CtlCmd; /* GetBusInfo */
888 struct aac_bus_info_response {
889 __le32 Status; /* ST_OK */
890 __le32 ObjType;
891 __le32 MethodId; /* unused */
892 __le32 ObjectId; /* unused */
893 __le32 CtlCmd; /* unused */
894 __le32 ProbeComplete;
895 __le32 BusCount;
896 __le32 TargetsPerBus;
897 u8 InitiatorBusId[10];
898 u8 BusValid[10];
902 * Battery platforms
904 #define AAC_BAT_REQ_PRESENT (1)
905 #define AAC_BAT_REQ_NOTPRESENT (2)
906 #define AAC_BAT_OPT_PRESENT (3)
907 #define AAC_BAT_OPT_NOTPRESENT (4)
908 #define AAC_BAT_NOT_SUPPORTED (5)
910 * cpu types
912 #define AAC_CPU_SIMULATOR (1)
913 #define AAC_CPU_I960 (2)
914 #define AAC_CPU_STRONGARM (3)
917 * Supported Options
919 #define AAC_OPT_SNAPSHOT cpu_to_le32(1)
920 #define AAC_OPT_CLUSTERS cpu_to_le32(1<<1)
921 #define AAC_OPT_WRITE_CACHE cpu_to_le32(1<<2)
922 #define AAC_OPT_64BIT_DATA cpu_to_le32(1<<3)
923 #define AAC_OPT_HOST_TIME_FIB cpu_to_le32(1<<4)
924 #define AAC_OPT_RAID50 cpu_to_le32(1<<5)
925 #define AAC_OPT_4GB_WINDOW cpu_to_le32(1<<6)
926 #define AAC_OPT_SCSI_UPGRADEABLE cpu_to_le32(1<<7)
927 #define AAC_OPT_SOFT_ERR_REPORT cpu_to_le32(1<<8)
928 #define AAC_OPT_SUPPORTED_RECONDITION cpu_to_le32(1<<9)
929 #define AAC_OPT_SGMAP_HOST64 cpu_to_le32(1<<10)
930 #define AAC_OPT_ALARM cpu_to_le32(1<<11)
931 #define AAC_OPT_NONDASD cpu_to_le32(1<<12)
932 #define AAC_OPT_SCSI_MANAGED cpu_to_le32(1<<13)
933 #define AAC_OPT_RAID_SCSI_MODE cpu_to_le32(1<<14)
934 #define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
935 #define AAC_OPT_NEW_COMM cpu_to_le32(1<<17)
936 #define AAC_OPT_NEW_COMM_64 cpu_to_le32(1<<18)
938 struct aac_dev
940 struct list_head entry;
941 const char *name;
942 int id;
945 * negotiated FIB settings
947 unsigned max_fib_size;
948 unsigned sg_tablesize;
951 * Map for 128 fib objects (64k)
953 dma_addr_t hw_fib_pa;
954 struct hw_fib *hw_fib_va;
955 struct hw_fib *aif_base_va;
957 * Fib Headers
959 struct fib *fibs;
961 struct fib *free_fib;
962 spinlock_t fib_lock;
964 struct aac_queue_block *queues;
966 * The user API will use an IOCTL to register itself to receive
967 * FIBs from the adapter. The following list is used to keep
968 * track of all the threads that have requested these FIBs. The
969 * mutex is used to synchronize access to all data associated
970 * with the adapter fibs.
972 struct list_head fib_list;
974 struct adapter_ops a_ops;
975 unsigned long fsrev; /* Main driver's revision number */
977 unsigned base_size; /* Size of mapped in region */
978 struct aac_init *init; /* Holds initialization info to communicate with adapter */
979 dma_addr_t init_pa; /* Holds physical address of the init struct */
981 struct pci_dev *pdev; /* Our PCI interface */
982 void * printfbuf; /* pointer to buffer used for printf's from the adapter */
983 void * comm_addr; /* Base address of Comm area */
984 dma_addr_t comm_phys; /* Physical Address of Comm area */
985 size_t comm_size;
987 struct Scsi_Host *scsi_host_ptr;
988 int maximum_num_containers;
989 int maximum_num_physicals;
990 int maximum_num_channels;
991 struct fsa_dev_info *fsa_dev;
992 struct task_struct *thread;
993 int cardtype;
996 * The following is the device specific extension.
998 #ifndef AAC_MIN_FOOTPRINT_SIZE
999 # define AAC_MIN_FOOTPRINT_SIZE 8192
1000 #endif
1001 union
1003 struct sa_registers __iomem *sa;
1004 struct rx_registers __iomem *rx;
1005 struct rkt_registers __iomem *rkt;
1006 } regs;
1007 volatile void __iomem *base;
1008 volatile struct rx_inbound __iomem *IndexRegs;
1009 u32 OIMR; /* Mask Register Cache */
1011 * AIF thread states
1013 u32 aif_thread;
1014 struct aac_adapter_info adapter_info;
1015 struct aac_supplement_adapter_info supplement_adapter_info;
1016 /* These are in adapter info but they are in the io flow so
1017 * lets break them out so we don't have to do an AND to check them
1019 u8 nondasd_support;
1020 u8 jbod;
1021 u8 cache_protected;
1022 u8 dac_support;
1023 u8 raid_scsi_mode;
1024 u8 comm_interface;
1025 # define AAC_COMM_PRODUCER 0
1026 # define AAC_COMM_MESSAGE 1
1027 /* macro side-effects BEWARE */
1028 # define raw_io_interface \
1029 init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1030 u8 raw_io_64;
1031 u8 printf_enabled;
1032 u8 in_reset;
1033 u8 msi;
1036 #define aac_adapter_interrupt(dev) \
1037 (dev)->a_ops.adapter_interrupt(dev)
1039 #define aac_adapter_notify(dev, event) \
1040 (dev)->a_ops.adapter_notify(dev, event)
1042 #define aac_adapter_disable_int(dev) \
1043 (dev)->a_ops.adapter_disable_int(dev)
1045 #define aac_adapter_enable_int(dev) \
1046 (dev)->a_ops.adapter_enable_int(dev)
1048 #define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1049 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1051 #define aac_adapter_check_health(dev) \
1052 (dev)->a_ops.adapter_check_health(dev)
1054 #define aac_adapter_restart(dev,bled) \
1055 (dev)->a_ops.adapter_restart(dev,bled)
1057 #define aac_adapter_ioremap(dev, size) \
1058 (dev)->a_ops.adapter_ioremap(dev, size)
1060 #define aac_adapter_deliver(fib) \
1061 ((fib)->dev)->a_ops.adapter_deliver(fib)
1063 #define aac_adapter_bounds(dev,cmd,lba) \
1064 dev->a_ops.adapter_bounds(dev,cmd,lba)
1066 #define aac_adapter_read(fib,cmd,lba,count) \
1067 ((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)
1069 #define aac_adapter_write(fib,cmd,lba,count,fua) \
1070 ((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count,fua)
1072 #define aac_adapter_scsi(fib,cmd) \
1073 ((fib)->dev)->a_ops.adapter_scsi(fib,cmd)
1075 #define aac_adapter_comm(dev,comm) \
1076 (dev)->a_ops.adapter_comm(dev, comm)
1078 #define FIB_CONTEXT_FLAG_TIMED_OUT (0x00000001)
1079 #define FIB_CONTEXT_FLAG (0x00000002)
1082 * Define the command values
1085 #define Null 0
1086 #define GetAttributes 1
1087 #define SetAttributes 2
1088 #define Lookup 3
1089 #define ReadLink 4
1090 #define Read 5
1091 #define Write 6
1092 #define Create 7
1093 #define MakeDirectory 8
1094 #define SymbolicLink 9
1095 #define MakeNode 10
1096 #define Removex 11
1097 #define RemoveDirectoryx 12
1098 #define Rename 13
1099 #define Link 14
1100 #define ReadDirectory 15
1101 #define ReadDirectoryPlus 16
1102 #define FileSystemStatus 17
1103 #define FileSystemInfo 18
1104 #define PathConfigure 19
1105 #define Commit 20
1106 #define Mount 21
1107 #define UnMount 22
1108 #define Newfs 23
1109 #define FsCheck 24
1110 #define FsSync 25
1111 #define SimReadWrite 26
1112 #define SetFileSystemStatus 27
1113 #define BlockRead 28
1114 #define BlockWrite 29
1115 #define NvramIoctl 30
1116 #define FsSyncWait 31
1117 #define ClearArchiveBit 32
1118 #define SetAcl 33
1119 #define GetAcl 34
1120 #define AssignAcl 35
1121 #define FaultInsertion 36 /* Fault Insertion Command */
1122 #define CrazyCache 37 /* Crazycache */
1124 #define MAX_FSACOMMAND_NUM 38
1128 * Define the status returns. These are very unixlike although
1129 * most are not in fact used
1132 #define ST_OK 0
1133 #define ST_PERM 1
1134 #define ST_NOENT 2
1135 #define ST_IO 5
1136 #define ST_NXIO 6
1137 #define ST_E2BIG 7
1138 #define ST_ACCES 13
1139 #define ST_EXIST 17
1140 #define ST_XDEV 18
1141 #define ST_NODEV 19
1142 #define ST_NOTDIR 20
1143 #define ST_ISDIR 21
1144 #define ST_INVAL 22
1145 #define ST_FBIG 27
1146 #define ST_NOSPC 28
1147 #define ST_ROFS 30
1148 #define ST_MLINK 31
1149 #define ST_WOULDBLOCK 35
1150 #define ST_NAMETOOLONG 63
1151 #define ST_NOTEMPTY 66
1152 #define ST_DQUOT 69
1153 #define ST_STALE 70
1154 #define ST_REMOTE 71
1155 #define ST_NOT_READY 72
1156 #define ST_BADHANDLE 10001
1157 #define ST_NOT_SYNC 10002
1158 #define ST_BAD_COOKIE 10003
1159 #define ST_NOTSUPP 10004
1160 #define ST_TOOSMALL 10005
1161 #define ST_SERVERFAULT 10006
1162 #define ST_BADTYPE 10007
1163 #define ST_JUKEBOX 10008
1164 #define ST_NOTMOUNTED 10009
1165 #define ST_MAINTMODE 10010
1166 #define ST_STALEACL 10011
1169 * On writes how does the client want the data written.
1172 #define CACHE_CSTABLE 1
1173 #define CACHE_UNSTABLE 2
1176 * Lets the client know at which level the data was commited on
1177 * a write request
1180 #define CMFILE_SYNCH_NVRAM 1
1181 #define CMDATA_SYNCH_NVRAM 2
1182 #define CMFILE_SYNCH 3
1183 #define CMDATA_SYNCH 4
1184 #define CMUNSTABLE 5
1186 struct aac_read
1188 __le32 command;
1189 __le32 cid;
1190 __le32 block;
1191 __le32 count;
1192 struct sgmap sg; // Must be last in struct because it is variable
1195 struct aac_read64
1197 __le32 command;
1198 __le16 cid;
1199 __le16 sector_count;
1200 __le32 block;
1201 __le16 pad;
1202 __le16 flags;
1203 struct sgmap64 sg; // Must be last in struct because it is variable
1206 struct aac_read_reply
1208 __le32 status;
1209 __le32 count;
1212 struct aac_write
1214 __le32 command;
1215 __le32 cid;
1216 __le32 block;
1217 __le32 count;
1218 __le32 stable; // Not used
1219 struct sgmap sg; // Must be last in struct because it is variable
1222 struct aac_write64
1224 __le32 command;
1225 __le16 cid;
1226 __le16 sector_count;
1227 __le32 block;
1228 __le16 pad;
1229 __le16 flags;
1230 #define IO_TYPE_WRITE 0x00000000
1231 #define IO_TYPE_READ 0x00000001
1232 #define IO_SUREWRITE 0x00000008
1233 struct sgmap64 sg; // Must be last in struct because it is variable
1235 struct aac_write_reply
1237 __le32 status;
1238 __le32 count;
1239 __le32 committed;
1242 struct aac_raw_io
1244 __le32 block[2];
1245 __le32 count;
1246 __le16 cid;
1247 __le16 flags; /* 00 W, 01 R */
1248 __le16 bpTotal; /* reserved for F/W use */
1249 __le16 bpComplete; /* reserved for F/W use */
1250 struct sgmapraw sg;
1253 #define CT_FLUSH_CACHE 129
1254 struct aac_synchronize {
1255 __le32 command; /* VM_ContainerConfig */
1256 __le32 type; /* CT_FLUSH_CACHE */
1257 __le32 cid;
1258 __le32 parm1;
1259 __le32 parm2;
1260 __le32 parm3;
1261 __le32 parm4;
1262 __le32 count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1265 struct aac_synchronize_reply {
1266 __le32 dummy0;
1267 __le32 dummy1;
1268 __le32 status; /* CT_OK */
1269 __le32 parm1;
1270 __le32 parm2;
1271 __le32 parm3;
1272 __le32 parm4;
1273 __le32 parm5;
1274 u8 data[16];
1277 #define CT_POWER_MANAGEMENT 245
1278 #define CT_PM_START_UNIT 2
1279 #define CT_PM_STOP_UNIT 3
1280 #define CT_PM_UNIT_IMMEDIATE 1
1281 struct aac_power_management {
1282 __le32 command; /* VM_ContainerConfig */
1283 __le32 type; /* CT_POWER_MANAGEMENT */
1284 __le32 sub; /* CT_PM_* */
1285 __le32 cid;
1286 __le32 parm; /* CT_PM_sub_* */
1289 #define CT_PAUSE_IO 65
1290 #define CT_RELEASE_IO 66
1291 struct aac_pause {
1292 __le32 command; /* VM_ContainerConfig */
1293 __le32 type; /* CT_PAUSE_IO */
1294 __le32 timeout; /* 10ms ticks */
1295 __le32 min;
1296 __le32 noRescan;
1297 __le32 parm3;
1298 __le32 parm4;
1299 __le32 count; /* sizeof(((struct aac_pause_reply *)NULL)->data) */
1302 struct aac_srb
1304 __le32 function;
1305 __le32 channel;
1306 __le32 id;
1307 __le32 lun;
1308 __le32 timeout;
1309 __le32 flags;
1310 __le32 count; // Data xfer size
1311 __le32 retry_limit;
1312 __le32 cdb_size;
1313 u8 cdb[16];
1314 struct sgmap sg;
1318 * This and associated data structs are used by the
1319 * ioctl caller and are in cpu order.
1321 struct user_aac_srb
1323 u32 function;
1324 u32 channel;
1325 u32 id;
1326 u32 lun;
1327 u32 timeout;
1328 u32 flags;
1329 u32 count; // Data xfer size
1330 u32 retry_limit;
1331 u32 cdb_size;
1332 u8 cdb[16];
1333 struct user_sgmap sg;
1336 #define AAC_SENSE_BUFFERSIZE 30
1338 struct aac_srb_reply
1340 __le32 status;
1341 __le32 srb_status;
1342 __le32 scsi_status;
1343 __le32 data_xfer_length;
1344 __le32 sense_data_size;
1345 u8 sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1348 * SRB Flags
1350 #define SRB_NoDataXfer 0x0000
1351 #define SRB_DisableDisconnect 0x0004
1352 #define SRB_DisableSynchTransfer 0x0008
1353 #define SRB_BypassFrozenQueue 0x0010
1354 #define SRB_DisableAutosense 0x0020
1355 #define SRB_DataIn 0x0040
1356 #define SRB_DataOut 0x0080
1359 * SRB Functions - set in aac_srb->function
1361 #define SRBF_ExecuteScsi 0x0000
1362 #define SRBF_ClaimDevice 0x0001
1363 #define SRBF_IO_Control 0x0002
1364 #define SRBF_ReceiveEvent 0x0003
1365 #define SRBF_ReleaseQueue 0x0004
1366 #define SRBF_AttachDevice 0x0005
1367 #define SRBF_ReleaseDevice 0x0006
1368 #define SRBF_Shutdown 0x0007
1369 #define SRBF_Flush 0x0008
1370 #define SRBF_AbortCommand 0x0010
1371 #define SRBF_ReleaseRecovery 0x0011
1372 #define SRBF_ResetBus 0x0012
1373 #define SRBF_ResetDevice 0x0013
1374 #define SRBF_TerminateIO 0x0014
1375 #define SRBF_FlushQueue 0x0015
1376 #define SRBF_RemoveDevice 0x0016
1377 #define SRBF_DomainValidation 0x0017
1380 * SRB SCSI Status - set in aac_srb->scsi_status
1382 #define SRB_STATUS_PENDING 0x00
1383 #define SRB_STATUS_SUCCESS 0x01
1384 #define SRB_STATUS_ABORTED 0x02
1385 #define SRB_STATUS_ABORT_FAILED 0x03
1386 #define SRB_STATUS_ERROR 0x04
1387 #define SRB_STATUS_BUSY 0x05
1388 #define SRB_STATUS_INVALID_REQUEST 0x06
1389 #define SRB_STATUS_INVALID_PATH_ID 0x07
1390 #define SRB_STATUS_NO_DEVICE 0x08
1391 #define SRB_STATUS_TIMEOUT 0x09
1392 #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
1393 #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
1394 #define SRB_STATUS_MESSAGE_REJECTED 0x0D
1395 #define SRB_STATUS_BUS_RESET 0x0E
1396 #define SRB_STATUS_PARITY_ERROR 0x0F
1397 #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
1398 #define SRB_STATUS_NO_HBA 0x11
1399 #define SRB_STATUS_DATA_OVERRUN 0x12
1400 #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
1401 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
1402 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
1403 #define SRB_STATUS_REQUEST_FLUSHED 0x16
1404 #define SRB_STATUS_DELAYED_RETRY 0x17
1405 #define SRB_STATUS_INVALID_LUN 0x20
1406 #define SRB_STATUS_INVALID_TARGET_ID 0x21
1407 #define SRB_STATUS_BAD_FUNCTION 0x22
1408 #define SRB_STATUS_ERROR_RECOVERY 0x23
1409 #define SRB_STATUS_NOT_STARTED 0x24
1410 #define SRB_STATUS_NOT_IN_USE 0x30
1411 #define SRB_STATUS_FORCE_ABORT 0x31
1412 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL 0x32
1415 * Object-Server / Volume-Manager Dispatch Classes
1418 #define VM_Null 0
1419 #define VM_NameServe 1
1420 #define VM_ContainerConfig 2
1421 #define VM_Ioctl 3
1422 #define VM_FilesystemIoctl 4
1423 #define VM_CloseAll 5
1424 #define VM_CtBlockRead 6
1425 #define VM_CtBlockWrite 7
1426 #define VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
1427 #define VM_SliceBlockWrite 9
1428 #define VM_DriveBlockRead 10 /* raw access to physical devices */
1429 #define VM_DriveBlockWrite 11
1430 #define VM_EnclosureMgt 12 /* enclosure management */
1431 #define VM_Unused 13 /* used to be diskset management */
1432 #define VM_CtBlockVerify 14
1433 #define VM_CtPerf 15 /* performance test */
1434 #define VM_CtBlockRead64 16
1435 #define VM_CtBlockWrite64 17
1436 #define VM_CtBlockVerify64 18
1437 #define VM_CtHostRead64 19
1438 #define VM_CtHostWrite64 20
1439 #define VM_DrvErrTblLog 21
1440 #define VM_NameServe64 22
1442 #define MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */
1445 * Descriptive information (eg, vital stats)
1446 * that a content manager might report. The
1447 * FileArray filesystem component is one example
1448 * of a content manager. Raw mode might be
1449 * another.
1452 struct aac_fsinfo {
1453 __le32 fsTotalSize; /* Consumed by fs, incl. metadata */
1454 __le32 fsBlockSize;
1455 __le32 fsFragSize;
1456 __le32 fsMaxExtendSize;
1457 __le32 fsSpaceUnits;
1458 __le32 fsMaxNumFiles;
1459 __le32 fsNumFreeFiles;
1460 __le32 fsInodeDensity;
1461 }; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1463 union aac_contentinfo {
1464 struct aac_fsinfo filesys; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1468 * Query for Container Configuration Status
1471 #define CT_GET_CONFIG_STATUS 147
1472 struct aac_get_config_status {
1473 __le32 command; /* VM_ContainerConfig */
1474 __le32 type; /* CT_GET_CONFIG_STATUS */
1475 __le32 parm1;
1476 __le32 parm2;
1477 __le32 parm3;
1478 __le32 parm4;
1479 __le32 parm5;
1480 __le32 count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1483 #define CFACT_CONTINUE 0
1484 #define CFACT_PAUSE 1
1485 #define CFACT_ABORT 2
1486 struct aac_get_config_status_resp {
1487 __le32 response; /* ST_OK */
1488 __le32 dummy0;
1489 __le32 status; /* CT_OK */
1490 __le32 parm1;
1491 __le32 parm2;
1492 __le32 parm3;
1493 __le32 parm4;
1494 __le32 parm5;
1495 struct {
1496 __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1497 __le16 flags;
1498 __le16 count;
1499 } data;
1503 * Accept the configuration as-is
1506 #define CT_COMMIT_CONFIG 152
1508 struct aac_commit_config {
1509 __le32 command; /* VM_ContainerConfig */
1510 __le32 type; /* CT_COMMIT_CONFIG */
1514 * Query for Container Configuration Status
1517 #define CT_GET_CONTAINER_COUNT 4
1518 struct aac_get_container_count {
1519 __le32 command; /* VM_ContainerConfig */
1520 __le32 type; /* CT_GET_CONTAINER_COUNT */
1523 struct aac_get_container_count_resp {
1524 __le32 response; /* ST_OK */
1525 __le32 dummy0;
1526 __le32 MaxContainers;
1527 __le32 ContainerSwitchEntries;
1528 __le32 MaxPartitions;
1533 * Query for "mountable" objects, ie, objects that are typically
1534 * associated with a drive letter on the client (host) side.
1537 struct aac_mntent {
1538 __le32 oid;
1539 u8 name[16]; /* if applicable */
1540 struct creation_info create_info; /* if applicable */
1541 __le32 capacity;
1542 __le32 vol; /* substrate structure */
1543 __le32 obj; /* FT_FILESYS, etc. */
1544 __le32 state; /* unready for mounting,
1545 readonly, etc. */
1546 union aac_contentinfo fileinfo; /* Info specific to content
1547 manager (eg, filesystem) */
1548 __le32 altoid; /* != oid <==> snapshot or
1549 broken mirror exists */
1550 __le32 capacityhigh;
1553 #define FSCS_NOTCLEAN 0x0001 /* fsck is necessary before mounting */
1554 #define FSCS_READONLY 0x0002 /* possible result of broken mirror */
1555 #define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
1556 #define FSCS_NOT_READY 0x0008 /* Array spinning up to fulfil request */
1558 struct aac_query_mount {
1559 __le32 command;
1560 __le32 type;
1561 __le32 count;
1564 struct aac_mount {
1565 __le32 status;
1566 __le32 type; /* should be same as that requested */
1567 __le32 count;
1568 struct aac_mntent mnt[1];
1571 #define CT_READ_NAME 130
1572 struct aac_get_name {
1573 __le32 command; /* VM_ContainerConfig */
1574 __le32 type; /* CT_READ_NAME */
1575 __le32 cid;
1576 __le32 parm1;
1577 __le32 parm2;
1578 __le32 parm3;
1579 __le32 parm4;
1580 __le32 count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1583 struct aac_get_name_resp {
1584 __le32 dummy0;
1585 __le32 dummy1;
1586 __le32 status; /* CT_OK */
1587 __le32 parm1;
1588 __le32 parm2;
1589 __le32 parm3;
1590 __le32 parm4;
1591 __le32 parm5;
1592 u8 data[16];
1595 #define CT_CID_TO_32BITS_UID 165
1596 struct aac_get_serial {
1597 __le32 command; /* VM_ContainerConfig */
1598 __le32 type; /* CT_CID_TO_32BITS_UID */
1599 __le32 cid;
1602 struct aac_get_serial_resp {
1603 __le32 dummy0;
1604 __le32 dummy1;
1605 __le32 status; /* CT_OK */
1606 __le32 uid;
1610 * The following command is sent to shut down each container.
1613 struct aac_close {
1614 __le32 command;
1615 __le32 cid;
1618 struct aac_query_disk
1620 s32 cnum;
1621 s32 bus;
1622 s32 id;
1623 s32 lun;
1624 u32 valid;
1625 u32 locked;
1626 u32 deleted;
1627 s32 instance;
1628 s8 name[10];
1629 u32 unmapped;
1632 struct aac_delete_disk {
1633 u32 disknum;
1634 u32 cnum;
1637 struct fib_ioctl
1639 u32 fibctx;
1640 s32 wait;
1641 char __user *fib;
1644 struct revision
1646 u32 compat;
1647 __le32 version;
1648 __le32 build;
1653 * Ugly - non Linux like ioctl coding for back compat.
1656 #define CTL_CODE(function, method) ( \
1657 (4<< 16) | ((function) << 2) | (method) \
1661 * Define the method codes for how buffers are passed for I/O and FS
1662 * controls
1665 #define METHOD_BUFFERED 0
1666 #define METHOD_NEITHER 3
1669 * Filesystem ioctls
1672 #define FSACTL_SENDFIB CTL_CODE(2050, METHOD_BUFFERED)
1673 #define FSACTL_SEND_RAW_SRB CTL_CODE(2067, METHOD_BUFFERED)
1674 #define FSACTL_DELETE_DISK 0x163
1675 #define FSACTL_QUERY_DISK 0x173
1676 #define FSACTL_OPEN_GET_ADAPTER_FIB CTL_CODE(2100, METHOD_BUFFERED)
1677 #define FSACTL_GET_NEXT_ADAPTER_FIB CTL_CODE(2101, METHOD_BUFFERED)
1678 #define FSACTL_CLOSE_GET_ADAPTER_FIB CTL_CODE(2102, METHOD_BUFFERED)
1679 #define FSACTL_MINIPORT_REV_CHECK CTL_CODE(2107, METHOD_BUFFERED)
1680 #define FSACTL_GET_PCI_INFO CTL_CODE(2119, METHOD_BUFFERED)
1681 #define FSACTL_FORCE_DELETE_DISK CTL_CODE(2120, METHOD_NEITHER)
1682 #define FSACTL_GET_CONTAINERS 2131
1683 #define FSACTL_SEND_LARGE_FIB CTL_CODE(2138, METHOD_BUFFERED)
1686 struct aac_common
1689 * If this value is set to 1 then interrupt moderation will occur
1690 * in the base commuication support.
1692 u32 irq_mod;
1693 u32 peak_fibs;
1694 u32 zero_fibs;
1695 u32 fib_timeouts;
1697 * Statistical counters in debug mode
1699 #ifdef DBG
1700 u32 FibsSent;
1701 u32 FibRecved;
1702 u32 NoResponseSent;
1703 u32 NoResponseRecved;
1704 u32 AsyncSent;
1705 u32 AsyncRecved;
1706 u32 NormalSent;
1707 u32 NormalRecved;
1708 #endif
1711 extern struct aac_common aac_config;
1715 * The following macro is used when sending and receiving FIBs. It is
1716 * only used for debugging.
1719 #ifdef DBG
1720 #define FIB_COUNTER_INCREMENT(counter) (counter)++
1721 #else
1722 #define FIB_COUNTER_INCREMENT(counter)
1723 #endif
1726 * Adapter direct commands
1727 * Monitor/Kernel API
1730 #define BREAKPOINT_REQUEST 0x00000004
1731 #define INIT_STRUCT_BASE_ADDRESS 0x00000005
1732 #define READ_PERMANENT_PARAMETERS 0x0000000a
1733 #define WRITE_PERMANENT_PARAMETERS 0x0000000b
1734 #define HOST_CRASHING 0x0000000d
1735 #define SEND_SYNCHRONOUS_FIB 0x0000000c
1736 #define COMMAND_POST_RESULTS 0x00000014
1737 #define GET_ADAPTER_PROPERTIES 0x00000019
1738 #define GET_DRIVER_BUFFER_PROPERTIES 0x00000023
1739 #define RCV_TEMP_READINGS 0x00000025
1740 #define GET_COMM_PREFERRED_SETTINGS 0x00000026
1741 #define IOP_RESET 0x00001000
1742 #define IOP_RESET_ALWAYS 0x00001001
1743 #define RE_INIT_ADAPTER 0x000000ee
1746 * Adapter Status Register
1748 * Phase Staus mailbox is 32bits:
1749 * <31:16> = Phase Status
1750 * <15:0> = Phase
1752 * The adapter reports is present state through the phase. Only
1753 * a single phase should be ever be set. Each phase can have multiple
1754 * phase status bits to provide more detailed information about the
1755 * state of the board. Care should be taken to ensure that any phase
1756 * status bits that are set when changing the phase are also valid
1757 * for the new phase or be cleared out. Adapter software (monitor,
1758 * iflash, kernel) is responsible for properly maintining the phase
1759 * status mailbox when it is running.
1761 * MONKER_API Phases
1763 * Phases are bit oriented. It is NOT valid to have multiple bits set
1766 #define SELF_TEST_FAILED 0x00000004
1767 #define MONITOR_PANIC 0x00000020
1768 #define KERNEL_UP_AND_RUNNING 0x00000080
1769 #define KERNEL_PANIC 0x00000100
1772 * Doorbell bit defines
1775 #define DoorBellSyncCmdAvailable (1<<0) /* Host -> Adapter */
1776 #define DoorBellPrintfDone (1<<5) /* Host -> Adapter */
1777 #define DoorBellAdapterNormCmdReady (1<<1) /* Adapter -> Host */
1778 #define DoorBellAdapterNormRespReady (1<<2) /* Adapter -> Host */
1779 #define DoorBellAdapterNormCmdNotFull (1<<3) /* Adapter -> Host */
1780 #define DoorBellAdapterNormRespNotFull (1<<4) /* Adapter -> Host */
1781 #define DoorBellPrintfReady (1<<5) /* Adapter -> Host */
1784 * For FIB communication, we need all of the following things
1785 * to send back to the user.
1788 #define AifCmdEventNotify 1 /* Notify of event */
1789 #define AifEnConfigChange 3 /* Adapter configuration change */
1790 #define AifEnContainerChange 4 /* Container configuration change */
1791 #define AifEnDeviceFailure 5 /* SCSI device failed */
1792 #define AifEnEnclosureManagement 13 /* EM_DRIVE_* */
1793 #define EM_DRIVE_INSERTION 31
1794 #define EM_DRIVE_REMOVAL 32
1795 #define AifEnBatteryEvent 14 /* Change in Battery State */
1796 #define AifEnAddContainer 15 /* A new array was created */
1797 #define AifEnDeleteContainer 16 /* A container was deleted */
1798 #define AifEnExpEvent 23 /* Firmware Event Log */
1799 #define AifExeFirmwarePanic 3 /* Firmware Event Panic */
1800 #define AifHighPriority 3 /* Highest Priority Event */
1801 #define AifEnAddJBOD 30 /* JBOD created */
1802 #define AifEnDeleteJBOD 31 /* JBOD deleted */
1804 #define AifCmdJobProgress 2 /* Progress report */
1805 #define AifJobCtrZero 101 /* Array Zero progress */
1806 #define AifJobStsSuccess 1 /* Job completes */
1807 #define AifJobStsRunning 102 /* Job running */
1808 #define AifCmdAPIReport 3 /* Report from other user of API */
1809 #define AifCmdDriverNotify 4 /* Notify host driver of event */
1810 #define AifDenMorphComplete 200 /* A morph operation completed */
1811 #define AifDenVolumeExtendComplete 201 /* A volume extend completed */
1812 #define AifReqJobList 100 /* Gets back complete job list */
1813 #define AifReqJobsForCtr 101 /* Gets back jobs for specific container */
1814 #define AifReqJobsForScsi 102 /* Gets back jobs for specific SCSI device */
1815 #define AifReqJobReport 103 /* Gets back a specific job report or list of them */
1816 #define AifReqTerminateJob 104 /* Terminates job */
1817 #define AifReqSuspendJob 105 /* Suspends a job */
1818 #define AifReqResumeJob 106 /* Resumes a job */
1819 #define AifReqSendAPIReport 107 /* API generic report requests */
1820 #define AifReqAPIJobStart 108 /* Start a job from the API */
1821 #define AifReqAPIJobUpdate 109 /* Update a job report from the API */
1822 #define AifReqAPIJobFinish 110 /* Finish a job from the API */
1825 * Adapter Initiated FIB command structures. Start with the adapter
1826 * initiated FIBs that really come from the adapter, and get responded
1827 * to by the host.
1830 struct aac_aifcmd {
1831 __le32 command; /* Tell host what type of notify this is */
1832 __le32 seqnum; /* To allow ordering of reports (if necessary) */
1833 u8 data[1]; /* Undefined length (from kernel viewpoint) */
1837 * Convert capacity to cylinders
1838 * accounting for the fact capacity could be a 64 bit value
1841 static inline unsigned int cap_to_cyls(sector_t capacity, unsigned divisor)
1843 sector_div(capacity, divisor);
1844 return capacity;
1847 /* SCp.phase values */
1848 #define AAC_OWNER_MIDLEVEL 0x101
1849 #define AAC_OWNER_LOWLEVEL 0x102
1850 #define AAC_OWNER_ERROR_HANDLER 0x103
1851 #define AAC_OWNER_FIRMWARE 0x106
1853 const char *aac_driverinfo(struct Scsi_Host *);
1854 struct fib *aac_fib_alloc(struct aac_dev *dev);
1855 int aac_fib_setup(struct aac_dev *dev);
1856 void aac_fib_map_free(struct aac_dev *dev);
1857 void aac_fib_free(struct fib * context);
1858 void aac_fib_init(struct fib * context);
1859 void aac_printf(struct aac_dev *dev, u32 val);
1860 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1861 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1862 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1863 int aac_fib_complete(struct fib * context);
1864 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib_va->data)
1865 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1866 int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1867 int aac_get_containers(struct aac_dev *dev);
1868 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1869 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1870 #ifndef shost_to_class
1871 #define shost_to_class(shost) &shost->shost_dev
1872 #endif
1873 ssize_t aac_get_serial_number(struct device *dev, char *buf);
1874 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1875 int aac_rx_init(struct aac_dev *dev);
1876 int aac_rkt_init(struct aac_dev *dev);
1877 int aac_nark_init(struct aac_dev *dev);
1878 int aac_sa_init(struct aac_dev *dev);
1879 int aac_queue_get(struct aac_dev * dev, u32 * index, u32 qid, struct hw_fib * hw_fib, int wait, struct fib * fibptr, unsigned long *nonotify);
1880 unsigned int aac_response_normal(struct aac_queue * q);
1881 unsigned int aac_command_normal(struct aac_queue * q);
1882 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1883 int aac_reset_adapter(struct aac_dev * dev, int forced);
1884 int aac_check_health(struct aac_dev * dev);
1885 int aac_command_thread(void *data);
1886 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1887 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1888 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1889 int aac_get_adapter_info(struct aac_dev* dev);
1890 int aac_send_shutdown(struct aac_dev *dev);
1891 int aac_probe_container(struct aac_dev *dev, int cid);
1892 int _aac_rx_init(struct aac_dev *dev);
1893 int aac_rx_select_comm(struct aac_dev *dev, int comm);
1894 int aac_rx_deliver_producer(struct fib * fib);
1895 char * get_container_type(unsigned type);
1896 extern int numacb;
1897 extern int acbsize;
1898 extern char aac_driver_version[];
1899 extern int startup_timeout;
1900 extern int aif_timeout;
1901 extern int expose_physicals;
1902 extern int aac_reset_devices;
1903 extern int aac_msi;
1904 extern int aac_commit;
1905 extern int update_interval;
1906 extern int check_interval;
1907 extern int aac_check_reset;