[SCSI] aacraid: respond to enclosure service events
[linux-2.6/openmoko-kernel/knife-kernel.git] / drivers / scsi / aacraid / aacraid.h
blob858b97494343563b7dacec1657a70f4a8d6fb0dc
1 #if (!defined(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 2454
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 * Cluster Commands
355 #define ClusterCommand 550
357 * Scsi Port commands (scsi passthrough)
359 #define ScsiPortCommand 600
360 #define ScsiPortCommand64 601
362 * Misc house keeping and generic adapter initiated commands
364 #define AifRequest 700
365 #define CheckRevision 701
366 #define FsaHostShutdown 702
367 #define RequestAdapterInfo 703
368 #define IsAdapterPaused 704
369 #define SendHostTime 705
370 #define RequestSupplementAdapterInfo 706
371 #define LastMiscCommand 707
374 * Commands that will target the failover level on the FSA adapter
377 enum fib_xfer_state {
378 HostOwned = (1<<0),
379 AdapterOwned = (1<<1),
380 FibInitialized = (1<<2),
381 FibEmpty = (1<<3),
382 AllocatedFromPool = (1<<4),
383 SentFromHost = (1<<5),
384 SentFromAdapter = (1<<6),
385 ResponseExpected = (1<<7),
386 NoResponseExpected = (1<<8),
387 AdapterProcessed = (1<<9),
388 HostProcessed = (1<<10),
389 HighPriority = (1<<11),
390 NormalPriority = (1<<12),
391 Async = (1<<13),
392 AsyncIo = (1<<13), // rpbfix: remove with new regime
393 PageFileIo = (1<<14), // rpbfix: remove with new regime
394 ShutdownRequest = (1<<15),
395 LazyWrite = (1<<16), // rpbfix: remove with new regime
396 AdapterMicroFib = (1<<17),
397 BIOSFibPath = (1<<18),
398 FastResponseCapable = (1<<19),
399 ApiFib = (1<<20) // Its an API Fib.
403 * The following defines needs to be updated any time there is an
404 * incompatible change made to the aac_init structure.
407 #define ADAPTER_INIT_STRUCT_REVISION 3
408 #define ADAPTER_INIT_STRUCT_REVISION_4 4 // rocket science
410 struct aac_init
412 __le32 InitStructRevision;
413 __le32 MiniPortRevision;
414 __le32 fsrev;
415 __le32 CommHeaderAddress;
416 __le32 FastIoCommAreaAddress;
417 __le32 AdapterFibsPhysicalAddress;
418 __le32 AdapterFibsVirtualAddress;
419 __le32 AdapterFibsSize;
420 __le32 AdapterFibAlign;
421 __le32 printfbuf;
422 __le32 printfbufsiz;
423 __le32 HostPhysMemPages; /* number of 4k pages of host
424 physical memory */
425 __le32 HostElapsedSeconds; /* number of seconds since 1970. */
427 * ADAPTER_INIT_STRUCT_REVISION_4 begins here
429 __le32 InitFlags; /* flags for supported features */
430 #define INITFLAGS_NEW_COMM_SUPPORTED 0x00000001
431 __le32 MaxIoCommands; /* max outstanding commands */
432 __le32 MaxIoSize; /* largest I/O command */
433 __le32 MaxFibSize; /* largest FIB to adapter */
436 enum aac_log_level {
437 LOG_AAC_INIT = 10,
438 LOG_AAC_INFORMATIONAL = 20,
439 LOG_AAC_WARNING = 30,
440 LOG_AAC_LOW_ERROR = 40,
441 LOG_AAC_MEDIUM_ERROR = 50,
442 LOG_AAC_HIGH_ERROR = 60,
443 LOG_AAC_PANIC = 70,
444 LOG_AAC_DEBUG = 80,
445 LOG_AAC_WINDBG_PRINT = 90
448 #define FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT 0x030b
449 #define FSAFS_NTC_FIB_CONTEXT 0x030c
451 struct aac_dev;
452 struct fib;
453 struct scsi_cmnd;
455 struct adapter_ops
457 /* Low level operations */
458 void (*adapter_interrupt)(struct aac_dev *dev);
459 void (*adapter_notify)(struct aac_dev *dev, u32 event);
460 void (*adapter_disable_int)(struct aac_dev *dev);
461 void (*adapter_enable_int)(struct aac_dev *dev);
462 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);
463 int (*adapter_check_health)(struct aac_dev *dev);
464 int (*adapter_restart)(struct aac_dev *dev, int bled);
465 /* Transport operations */
466 int (*adapter_ioremap)(struct aac_dev * dev, u32 size);
467 irq_handler_t adapter_intr;
468 /* Packet operations */
469 int (*adapter_deliver)(struct fib * fib);
470 int (*adapter_bounds)(struct aac_dev * dev, struct scsi_cmnd * cmd, u64 lba);
471 int (*adapter_read)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count);
472 int (*adapter_write)(struct fib * fib, struct scsi_cmnd * cmd, u64 lba, u32 count, int fua);
473 int (*adapter_scsi)(struct fib * fib, struct scsi_cmnd * cmd);
474 /* Administrative operations */
475 int (*adapter_comm)(struct aac_dev * dev, int comm);
479 * Define which interrupt handler needs to be installed
482 struct aac_driver_ident
484 int (*init)(struct aac_dev *dev);
485 char * name;
486 char * vname;
487 char * model;
488 u16 channels;
489 int quirks;
492 * Some adapter firmware needs communication memory
493 * below 2gig. This tells the init function to set the
494 * dma mask such that fib memory will be allocated where the
495 * adapter firmware can get to it.
497 #define AAC_QUIRK_31BIT 0x0001
500 * Some adapter firmware, when the raid card's cache is turned off, can not
501 * split up scatter gathers in order to deal with the limits of the
502 * underlying CHIM. This limit is 34 scatter gather elements.
504 #define AAC_QUIRK_34SG 0x0002
507 * This adapter is a slave (no Firmware)
509 #define AAC_QUIRK_SLAVE 0x0004
512 * This adapter is a master.
514 #define AAC_QUIRK_MASTER 0x0008
517 * Some adapter firmware perform poorly when it must split up scatter gathers
518 * in order to deal with the limits of the underlying CHIM. This limit in this
519 * class of adapters is 17 scatter gather elements.
521 #define AAC_QUIRK_17SG 0x0010
524 * Some adapter firmware does not support 64 bit scsi passthrough
525 * commands.
527 #define AAC_QUIRK_SCSI_32 0x0020
530 * The adapter interface specs all queues to be located in the same
531 * physically contigous block. The host structure that defines the
532 * commuication queues will assume they are each a separate physically
533 * contigous memory region that will support them all being one big
534 * contigous block.
535 * There is a command and response queue for each level and direction of
536 * commuication. These regions are accessed by both the host and adapter.
539 struct aac_queue {
540 u64 logical; /*address we give the adapter */
541 struct aac_entry *base; /*system virtual address */
542 struct aac_qhdr headers; /*producer,consumer q headers*/
543 u32 entries; /*Number of queue entries */
544 wait_queue_head_t qfull; /*Event to wait on if q full */
545 wait_queue_head_t cmdready; /*Cmd ready from the adapter */
546 /* This is only valid for adapter to host command queues. */
547 spinlock_t *lock; /* Spinlock for this queue must take this lock before accessing the lock */
548 spinlock_t lockdata; /* Actual lock (used only on one side of the lock) */
549 struct list_head cmdq; /* A queue of FIBs which need to be prcessed by the FS thread. This is */
550 /* only valid for command queues which receive entries from the adapter. */
551 u32 numpending; /* Number of entries on outstanding queue. */
552 struct aac_dev * dev; /* Back pointer to adapter structure */
556 * Message queues. The order here is important, see also the
557 * queue type ordering
560 struct aac_queue_block
562 struct aac_queue queue[8];
566 * SaP1 Message Unit Registers
569 struct sa_drawbridge_CSR {
570 /* Offset | Name */
571 __le32 reserved[10]; /* 00h-27h | Reserved */
572 u8 LUT_Offset; /* 28h | Lookup Table Offset */
573 u8 reserved1[3]; /* 29h-2bh | Reserved */
574 __le32 LUT_Data; /* 2ch | Looup Table Data */
575 __le32 reserved2[26]; /* 30h-97h | Reserved */
576 __le16 PRICLEARIRQ; /* 98h | Primary Clear Irq */
577 __le16 SECCLEARIRQ; /* 9ah | Secondary Clear Irq */
578 __le16 PRISETIRQ; /* 9ch | Primary Set Irq */
579 __le16 SECSETIRQ; /* 9eh | Secondary Set Irq */
580 __le16 PRICLEARIRQMASK;/* a0h | Primary Clear Irq Mask */
581 __le16 SECCLEARIRQMASK;/* a2h | Secondary Clear Irq Mask */
582 __le16 PRISETIRQMASK; /* a4h | Primary Set Irq Mask */
583 __le16 SECSETIRQMASK; /* a6h | Secondary Set Irq Mask */
584 __le32 MAILBOX0; /* a8h | Scratchpad 0 */
585 __le32 MAILBOX1; /* ach | Scratchpad 1 */
586 __le32 MAILBOX2; /* b0h | Scratchpad 2 */
587 __le32 MAILBOX3; /* b4h | Scratchpad 3 */
588 __le32 MAILBOX4; /* b8h | Scratchpad 4 */
589 __le32 MAILBOX5; /* bch | Scratchpad 5 */
590 __le32 MAILBOX6; /* c0h | Scratchpad 6 */
591 __le32 MAILBOX7; /* c4h | Scratchpad 7 */
592 __le32 ROM_Setup_Data; /* c8h | Rom Setup and Data */
593 __le32 ROM_Control_Addr;/* cch | Rom Control and Address */
594 __le32 reserved3[12]; /* d0h-ffh | reserved */
595 __le32 LUT[64]; /* 100h-1ffh | Lookup Table Entries */
598 #define Mailbox0 SaDbCSR.MAILBOX0
599 #define Mailbox1 SaDbCSR.MAILBOX1
600 #define Mailbox2 SaDbCSR.MAILBOX2
601 #define Mailbox3 SaDbCSR.MAILBOX3
602 #define Mailbox4 SaDbCSR.MAILBOX4
603 #define Mailbox5 SaDbCSR.MAILBOX5
604 #define Mailbox6 SaDbCSR.MAILBOX6
605 #define Mailbox7 SaDbCSR.MAILBOX7
607 #define DoorbellReg_p SaDbCSR.PRISETIRQ
608 #define DoorbellReg_s SaDbCSR.SECSETIRQ
609 #define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ
612 #define DOORBELL_0 0x0001
613 #define DOORBELL_1 0x0002
614 #define DOORBELL_2 0x0004
615 #define DOORBELL_3 0x0008
616 #define DOORBELL_4 0x0010
617 #define DOORBELL_5 0x0020
618 #define DOORBELL_6 0x0040
621 #define PrintfReady DOORBELL_5
622 #define PrintfDone DOORBELL_5
624 struct sa_registers {
625 struct sa_drawbridge_CSR SaDbCSR; /* 98h - c4h */
629 #define Sa_MINIPORT_REVISION 1
631 #define sa_readw(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
632 #define sa_readl(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
633 #define sa_writew(AEP, CSR, value) writew(value, &((AEP)->regs.sa->CSR))
634 #define sa_writel(AEP, CSR, value) writel(value, &((AEP)->regs.sa->CSR))
637 * Rx Message Unit Registers
640 struct rx_mu_registers {
641 /* Local | PCI*| Name */
642 __le32 ARSR; /* 1300h | 00h | APIC Register Select Register */
643 __le32 reserved0; /* 1304h | 04h | Reserved */
644 __le32 AWR; /* 1308h | 08h | APIC Window Register */
645 __le32 reserved1; /* 130Ch | 0Ch | Reserved */
646 __le32 IMRx[2]; /* 1310h | 10h | Inbound Message Registers */
647 __le32 OMRx[2]; /* 1318h | 18h | Outbound Message Registers */
648 __le32 IDR; /* 1320h | 20h | Inbound Doorbell Register */
649 __le32 IISR; /* 1324h | 24h | Inbound Interrupt
650 Status Register */
651 __le32 IIMR; /* 1328h | 28h | Inbound Interrupt
652 Mask Register */
653 __le32 ODR; /* 132Ch | 2Ch | Outbound Doorbell Register */
654 __le32 OISR; /* 1330h | 30h | Outbound Interrupt
655 Status Register */
656 __le32 OIMR; /* 1334h | 34h | Outbound Interrupt
657 Mask Register */
658 __le32 reserved2; /* 1338h | 38h | Reserved */
659 __le32 reserved3; /* 133Ch | 3Ch | Reserved */
660 __le32 InboundQueue;/* 1340h | 40h | Inbound Queue Port relative to firmware */
661 __le32 OutboundQueue;/*1344h | 44h | Outbound Queue Port relative to firmware */
662 /* * Must access through ATU Inbound
663 Translation Window */
666 struct rx_inbound {
667 __le32 Mailbox[8];
670 #define INBOUNDDOORBELL_0 0x00000001
671 #define INBOUNDDOORBELL_1 0x00000002
672 #define INBOUNDDOORBELL_2 0x00000004
673 #define INBOUNDDOORBELL_3 0x00000008
674 #define INBOUNDDOORBELL_4 0x00000010
675 #define INBOUNDDOORBELL_5 0x00000020
676 #define INBOUNDDOORBELL_6 0x00000040
678 #define OUTBOUNDDOORBELL_0 0x00000001
679 #define OUTBOUNDDOORBELL_1 0x00000002
680 #define OUTBOUNDDOORBELL_2 0x00000004
681 #define OUTBOUNDDOORBELL_3 0x00000008
682 #define OUTBOUNDDOORBELL_4 0x00000010
684 #define InboundDoorbellReg MUnit.IDR
685 #define OutboundDoorbellReg MUnit.ODR
687 struct rx_registers {
688 struct rx_mu_registers MUnit; /* 1300h - 1344h */
689 __le32 reserved1[2]; /* 1348h - 134ch */
690 struct rx_inbound IndexRegs;
693 #define rx_readb(AEP, CSR) readb(&((AEP)->regs.rx->CSR))
694 #define rx_readl(AEP, CSR) readl(&((AEP)->regs.rx->CSR))
695 #define rx_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rx->CSR))
696 #define rx_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rx->CSR))
699 * Rkt Message Unit Registers (same as Rx, except a larger reserve region)
702 #define rkt_mu_registers rx_mu_registers
703 #define rkt_inbound rx_inbound
705 struct rkt_registers {
706 struct rkt_mu_registers MUnit; /* 1300h - 1344h */
707 __le32 reserved1[1006]; /* 1348h - 22fch */
708 struct rkt_inbound IndexRegs; /* 2300h - */
711 #define rkt_readb(AEP, CSR) readb(&((AEP)->regs.rkt->CSR))
712 #define rkt_readl(AEP, CSR) readl(&((AEP)->regs.rkt->CSR))
713 #define rkt_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rkt->CSR))
714 #define rkt_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rkt->CSR))
716 typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
718 struct aac_fib_context {
719 s16 type; // used for verification of structure
720 s16 size;
721 u32 unique; // unique value representing this context
722 ulong jiffies; // used for cleanup - dmb changed to ulong
723 struct list_head next; // used to link context's into a linked list
724 struct semaphore wait_sem; // this is used to wait for the next fib to arrive.
725 int wait; // Set to true when thread is in WaitForSingleObject
726 unsigned long count; // total number of FIBs on FibList
727 struct list_head fib_list; // this holds fibs and their attachd hw_fibs
730 struct sense_data {
731 u8 error_code; /* 70h (current errors), 71h(deferred errors) */
732 u8 valid:1; /* A valid bit of one indicates that the information */
733 /* field contains valid information as defined in the
734 * SCSI-2 Standard.
736 u8 segment_number; /* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
737 u8 sense_key:4; /* Sense Key */
738 u8 reserved:1;
739 u8 ILI:1; /* Incorrect Length Indicator */
740 u8 EOM:1; /* End Of Medium - reserved for random access devices */
741 u8 filemark:1; /* Filemark - reserved for random access devices */
743 u8 information[4]; /* for direct-access devices, contains the unsigned
744 * logical block address or residue associated with
745 * the sense key
747 u8 add_sense_len; /* number of additional sense bytes to follow this field */
748 u8 cmnd_info[4]; /* not used */
749 u8 ASC; /* Additional Sense Code */
750 u8 ASCQ; /* Additional Sense Code Qualifier */
751 u8 FRUC; /* Field Replaceable Unit Code - not used */
752 u8 bit_ptr:3; /* indicates which byte of the CDB or parameter data
753 * was in error
755 u8 BPV:1; /* bit pointer valid (BPV): 1- indicates that
756 * the bit_ptr field has valid value
758 u8 reserved2:2;
759 u8 CD:1; /* command data bit: 1- illegal parameter in CDB.
760 * 0- illegal parameter in data.
762 u8 SKSV:1;
763 u8 field_ptr[2]; /* byte of the CDB or parameter data in error */
766 struct fsa_dev_info {
767 u64 last;
768 u64 size;
769 u32 type;
770 u32 config_waiting_on;
771 unsigned long config_waiting_stamp;
772 u16 queue_depth;
773 u8 config_needed;
774 u8 valid;
775 u8 ro;
776 u8 locked;
777 u8 deleted;
778 char devname[8];
779 struct sense_data sense_data;
782 struct fib {
783 void *next; /* this is used by the allocator */
784 s16 type;
785 s16 size;
787 * The Adapter that this I/O is destined for.
789 struct aac_dev *dev;
791 * This is the event the sendfib routine will wait on if the
792 * caller did not pass one and this is synch io.
794 struct semaphore event_wait;
795 spinlock_t event_lock;
797 u32 done; /* gets set to 1 when fib is complete */
798 fib_callback callback;
799 void *callback_data;
800 u32 flags; // u32 dmb was ulong
802 * And for the internal issue/reply queues (we may be able
803 * to merge these two)
805 struct list_head fiblink;
806 void *data;
807 struct hw_fib *hw_fib_va; /* Actual shared object */
808 dma_addr_t hw_fib_pa; /* physical address of hw_fib*/
812 * Adapter Information Block
814 * This is returned by the RequestAdapterInfo block
817 struct aac_adapter_info
819 __le32 platform;
820 __le32 cpu;
821 __le32 subcpu;
822 __le32 clock;
823 __le32 execmem;
824 __le32 buffermem;
825 __le32 totalmem;
826 __le32 kernelrev;
827 __le32 kernelbuild;
828 __le32 monitorrev;
829 __le32 monitorbuild;
830 __le32 hwrev;
831 __le32 hwbuild;
832 __le32 biosrev;
833 __le32 biosbuild;
834 __le32 cluster;
835 __le32 clusterchannelmask;
836 __le32 serial[2];
837 __le32 battery;
838 __le32 options;
839 __le32 OEM;
842 struct aac_supplement_adapter_info
844 u8 AdapterTypeText[17+1];
845 u8 Pad[2];
846 __le32 FlashMemoryByteSize;
847 __le32 FlashImageId;
848 __le32 MaxNumberPorts;
849 __le32 Version;
850 __le32 FeatureBits;
851 u8 SlotNumber;
852 u8 ReservedPad0[3];
853 u8 BuildDate[12];
854 __le32 CurrentNumberPorts;
855 struct {
856 u8 AssemblyPn[8];
857 u8 FruPn[8];
858 u8 BatteryFruPn[8];
859 u8 EcVersionString[8];
860 u8 Tsid[12];
861 } VpdInfo;
862 __le32 FlashFirmwareRevision;
863 __le32 FlashFirmwareBuild;
864 __le32 RaidTypeMorphOptions;
865 __le32 FlashFirmwareBootRevision;
866 __le32 FlashFirmwareBootBuild;
867 u8 MfgPcbaSerialNo[12];
868 u8 MfgWWNName[8];
869 __le32 SupportedOptions2;
870 __le32 ReservedGrowth[1];
872 #define AAC_FEATURE_FALCON cpu_to_le32(0x00000010)
873 #define AAC_OPTION_MU_RESET cpu_to_le32(0x00000001)
874 #define AAC_OPTION_IGNORE_RESET cpu_to_le32(0x00000002)
875 #define AAC_SIS_VERSION_V3 3
876 #define AAC_SIS_SLOT_UNKNOWN 0xFF
878 #define GetBusInfo 0x00000009
879 struct aac_bus_info {
880 __le32 Command; /* VM_Ioctl */
881 __le32 ObjType; /* FT_DRIVE */
882 __le32 MethodId; /* 1 = SCSI Layer */
883 __le32 ObjectId; /* Handle */
884 __le32 CtlCmd; /* GetBusInfo */
887 struct aac_bus_info_response {
888 __le32 Status; /* ST_OK */
889 __le32 ObjType;
890 __le32 MethodId; /* unused */
891 __le32 ObjectId; /* unused */
892 __le32 CtlCmd; /* unused */
893 __le32 ProbeComplete;
894 __le32 BusCount;
895 __le32 TargetsPerBus;
896 u8 InitiatorBusId[10];
897 u8 BusValid[10];
901 * Battery platforms
903 #define AAC_BAT_REQ_PRESENT (1)
904 #define AAC_BAT_REQ_NOTPRESENT (2)
905 #define AAC_BAT_OPT_PRESENT (3)
906 #define AAC_BAT_OPT_NOTPRESENT (4)
907 #define AAC_BAT_NOT_SUPPORTED (5)
909 * cpu types
911 #define AAC_CPU_SIMULATOR (1)
912 #define AAC_CPU_I960 (2)
913 #define AAC_CPU_STRONGARM (3)
916 * Supported Options
918 #define AAC_OPT_SNAPSHOT cpu_to_le32(1)
919 #define AAC_OPT_CLUSTERS cpu_to_le32(1<<1)
920 #define AAC_OPT_WRITE_CACHE cpu_to_le32(1<<2)
921 #define AAC_OPT_64BIT_DATA cpu_to_le32(1<<3)
922 #define AAC_OPT_HOST_TIME_FIB cpu_to_le32(1<<4)
923 #define AAC_OPT_RAID50 cpu_to_le32(1<<5)
924 #define AAC_OPT_4GB_WINDOW cpu_to_le32(1<<6)
925 #define AAC_OPT_SCSI_UPGRADEABLE cpu_to_le32(1<<7)
926 #define AAC_OPT_SOFT_ERR_REPORT cpu_to_le32(1<<8)
927 #define AAC_OPT_SUPPORTED_RECONDITION cpu_to_le32(1<<9)
928 #define AAC_OPT_SGMAP_HOST64 cpu_to_le32(1<<10)
929 #define AAC_OPT_ALARM cpu_to_le32(1<<11)
930 #define AAC_OPT_NONDASD cpu_to_le32(1<<12)
931 #define AAC_OPT_SCSI_MANAGED cpu_to_le32(1<<13)
932 #define AAC_OPT_RAID_SCSI_MODE cpu_to_le32(1<<14)
933 #define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
934 #define AAC_OPT_NEW_COMM cpu_to_le32(1<<17)
935 #define AAC_OPT_NEW_COMM_64 cpu_to_le32(1<<18)
937 struct aac_dev
939 struct list_head entry;
940 const char *name;
941 int id;
944 * negotiated FIB settings
946 unsigned max_fib_size;
947 unsigned sg_tablesize;
950 * Map for 128 fib objects (64k)
952 dma_addr_t hw_fib_pa;
953 struct hw_fib *hw_fib_va;
954 struct hw_fib *aif_base_va;
956 * Fib Headers
958 struct fib *fibs;
960 struct fib *free_fib;
961 spinlock_t fib_lock;
963 struct aac_queue_block *queues;
965 * The user API will use an IOCTL to register itself to receive
966 * FIBs from the adapter. The following list is used to keep
967 * track of all the threads that have requested these FIBs. The
968 * mutex is used to synchronize access to all data associated
969 * with the adapter fibs.
971 struct list_head fib_list;
973 struct adapter_ops a_ops;
974 unsigned long fsrev; /* Main driver's revision number */
976 unsigned base_size; /* Size of mapped in region */
977 struct aac_init *init; /* Holds initialization info to communicate with adapter */
978 dma_addr_t init_pa; /* Holds physical address of the init struct */
980 struct pci_dev *pdev; /* Our PCI interface */
981 void * printfbuf; /* pointer to buffer used for printf's from the adapter */
982 void * comm_addr; /* Base address of Comm area */
983 dma_addr_t comm_phys; /* Physical Address of Comm area */
984 size_t comm_size;
986 struct Scsi_Host *scsi_host_ptr;
987 int maximum_num_containers;
988 int maximum_num_physicals;
989 int maximum_num_channels;
990 struct fsa_dev_info *fsa_dev;
991 struct task_struct *thread;
992 int cardtype;
995 * The following is the device specific extension.
997 #if (!defined(AAC_MIN_FOOTPRINT_SIZE))
998 # define AAC_MIN_FOOTPRINT_SIZE 8192
999 #endif
1000 union
1002 struct sa_registers __iomem *sa;
1003 struct rx_registers __iomem *rx;
1004 struct rkt_registers __iomem *rkt;
1005 } regs;
1006 volatile void __iomem *base;
1007 volatile struct rx_inbound __iomem *IndexRegs;
1008 u32 OIMR; /* Mask Register Cache */
1010 * AIF thread states
1012 u32 aif_thread;
1013 struct aac_adapter_info adapter_info;
1014 struct aac_supplement_adapter_info supplement_adapter_info;
1015 /* These are in adapter info but they are in the io flow so
1016 * lets break them out so we don't have to do an AND to check them
1018 u8 nondasd_support;
1019 u8 cache_protected;
1020 u8 dac_support;
1021 u8 raid_scsi_mode;
1022 u8 comm_interface;
1023 # define AAC_COMM_PRODUCER 0
1024 # define AAC_COMM_MESSAGE 1
1025 /* macro side-effects BEWARE */
1026 # define raw_io_interface \
1027 init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1028 u8 raw_io_64;
1029 u8 printf_enabled;
1030 u8 in_reset;
1033 #define aac_adapter_interrupt(dev) \
1034 (dev)->a_ops.adapter_interrupt(dev)
1036 #define aac_adapter_notify(dev, event) \
1037 (dev)->a_ops.adapter_notify(dev, event)
1039 #define aac_adapter_disable_int(dev) \
1040 (dev)->a_ops.adapter_disable_int(dev)
1042 #define aac_adapter_enable_int(dev) \
1043 (dev)->a_ops.adapter_enable_int(dev)
1045 #define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1046 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1048 #define aac_adapter_check_health(dev) \
1049 (dev)->a_ops.adapter_check_health(dev)
1051 #define aac_adapter_restart(dev,bled) \
1052 (dev)->a_ops.adapter_restart(dev,bled)
1054 #define aac_adapter_ioremap(dev, size) \
1055 (dev)->a_ops.adapter_ioremap(dev, size)
1057 #define aac_adapter_deliver(fib) \
1058 ((fib)->dev)->a_ops.adapter_deliver(fib)
1060 #define aac_adapter_bounds(dev,cmd,lba) \
1061 dev->a_ops.adapter_bounds(dev,cmd,lba)
1063 #define aac_adapter_read(fib,cmd,lba,count) \
1064 ((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)
1066 #define aac_adapter_write(fib,cmd,lba,count,fua) \
1067 ((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count,fua)
1069 #define aac_adapter_scsi(fib,cmd) \
1070 ((fib)->dev)->a_ops.adapter_scsi(fib,cmd)
1072 #define aac_adapter_comm(dev,comm) \
1073 (dev)->a_ops.adapter_comm(dev, comm)
1075 #define FIB_CONTEXT_FLAG_TIMED_OUT (0x00000001)
1076 #define FIB_CONTEXT_FLAG (0x00000002)
1079 * Define the command values
1082 #define Null 0
1083 #define GetAttributes 1
1084 #define SetAttributes 2
1085 #define Lookup 3
1086 #define ReadLink 4
1087 #define Read 5
1088 #define Write 6
1089 #define Create 7
1090 #define MakeDirectory 8
1091 #define SymbolicLink 9
1092 #define MakeNode 10
1093 #define Removex 11
1094 #define RemoveDirectoryx 12
1095 #define Rename 13
1096 #define Link 14
1097 #define ReadDirectory 15
1098 #define ReadDirectoryPlus 16
1099 #define FileSystemStatus 17
1100 #define FileSystemInfo 18
1101 #define PathConfigure 19
1102 #define Commit 20
1103 #define Mount 21
1104 #define UnMount 22
1105 #define Newfs 23
1106 #define FsCheck 24
1107 #define FsSync 25
1108 #define SimReadWrite 26
1109 #define SetFileSystemStatus 27
1110 #define BlockRead 28
1111 #define BlockWrite 29
1112 #define NvramIoctl 30
1113 #define FsSyncWait 31
1114 #define ClearArchiveBit 32
1115 #define SetAcl 33
1116 #define GetAcl 34
1117 #define AssignAcl 35
1118 #define FaultInsertion 36 /* Fault Insertion Command */
1119 #define CrazyCache 37 /* Crazycache */
1121 #define MAX_FSACOMMAND_NUM 38
1125 * Define the status returns. These are very unixlike although
1126 * most are not in fact used
1129 #define ST_OK 0
1130 #define ST_PERM 1
1131 #define ST_NOENT 2
1132 #define ST_IO 5
1133 #define ST_NXIO 6
1134 #define ST_E2BIG 7
1135 #define ST_ACCES 13
1136 #define ST_EXIST 17
1137 #define ST_XDEV 18
1138 #define ST_NODEV 19
1139 #define ST_NOTDIR 20
1140 #define ST_ISDIR 21
1141 #define ST_INVAL 22
1142 #define ST_FBIG 27
1143 #define ST_NOSPC 28
1144 #define ST_ROFS 30
1145 #define ST_MLINK 31
1146 #define ST_WOULDBLOCK 35
1147 #define ST_NAMETOOLONG 63
1148 #define ST_NOTEMPTY 66
1149 #define ST_DQUOT 69
1150 #define ST_STALE 70
1151 #define ST_REMOTE 71
1152 #define ST_BADHANDLE 10001
1153 #define ST_NOT_SYNC 10002
1154 #define ST_BAD_COOKIE 10003
1155 #define ST_NOTSUPP 10004
1156 #define ST_TOOSMALL 10005
1157 #define ST_SERVERFAULT 10006
1158 #define ST_BADTYPE 10007
1159 #define ST_JUKEBOX 10008
1160 #define ST_NOTMOUNTED 10009
1161 #define ST_MAINTMODE 10010
1162 #define ST_STALEACL 10011
1165 * On writes how does the client want the data written.
1168 #define CACHE_CSTABLE 1
1169 #define CACHE_UNSTABLE 2
1172 * Lets the client know at which level the data was commited on
1173 * a write request
1176 #define CMFILE_SYNCH_NVRAM 1
1177 #define CMDATA_SYNCH_NVRAM 2
1178 #define CMFILE_SYNCH 3
1179 #define CMDATA_SYNCH 4
1180 #define CMUNSTABLE 5
1182 struct aac_read
1184 __le32 command;
1185 __le32 cid;
1186 __le32 block;
1187 __le32 count;
1188 struct sgmap sg; // Must be last in struct because it is variable
1191 struct aac_read64
1193 __le32 command;
1194 __le16 cid;
1195 __le16 sector_count;
1196 __le32 block;
1197 __le16 pad;
1198 __le16 flags;
1199 struct sgmap64 sg; // Must be last in struct because it is variable
1202 struct aac_read_reply
1204 __le32 status;
1205 __le32 count;
1208 struct aac_write
1210 __le32 command;
1211 __le32 cid;
1212 __le32 block;
1213 __le32 count;
1214 __le32 stable; // Not used
1215 struct sgmap sg; // Must be last in struct because it is variable
1218 struct aac_write64
1220 __le32 command;
1221 __le16 cid;
1222 __le16 sector_count;
1223 __le32 block;
1224 __le16 pad;
1225 __le16 flags;
1226 #define IO_TYPE_WRITE 0x00000000
1227 #define IO_TYPE_READ 0x00000001
1228 #define IO_SUREWRITE 0x00000008
1229 struct sgmap64 sg; // Must be last in struct because it is variable
1231 struct aac_write_reply
1233 __le32 status;
1234 __le32 count;
1235 __le32 committed;
1238 struct aac_raw_io
1240 __le32 block[2];
1241 __le32 count;
1242 __le16 cid;
1243 __le16 flags; /* 00 W, 01 R */
1244 __le16 bpTotal; /* reserved for F/W use */
1245 __le16 bpComplete; /* reserved for F/W use */
1246 struct sgmapraw sg;
1249 #define CT_FLUSH_CACHE 129
1250 struct aac_synchronize {
1251 __le32 command; /* VM_ContainerConfig */
1252 __le32 type; /* CT_FLUSH_CACHE */
1253 __le32 cid;
1254 __le32 parm1;
1255 __le32 parm2;
1256 __le32 parm3;
1257 __le32 parm4;
1258 __le32 count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1261 struct aac_synchronize_reply {
1262 __le32 dummy0;
1263 __le32 dummy1;
1264 __le32 status; /* CT_OK */
1265 __le32 parm1;
1266 __le32 parm2;
1267 __le32 parm3;
1268 __le32 parm4;
1269 __le32 parm5;
1270 u8 data[16];
1273 #define CT_PAUSE_IO 65
1274 #define CT_RELEASE_IO 66
1275 struct aac_pause {
1276 __le32 command; /* VM_ContainerConfig */
1277 __le32 type; /* CT_PAUSE_IO */
1278 __le32 timeout; /* 10ms ticks */
1279 __le32 min;
1280 __le32 noRescan;
1281 __le32 parm3;
1282 __le32 parm4;
1283 __le32 count; /* sizeof(((struct aac_pause_reply *)NULL)->data) */
1286 struct aac_srb
1288 __le32 function;
1289 __le32 channel;
1290 __le32 id;
1291 __le32 lun;
1292 __le32 timeout;
1293 __le32 flags;
1294 __le32 count; // Data xfer size
1295 __le32 retry_limit;
1296 __le32 cdb_size;
1297 u8 cdb[16];
1298 struct sgmap sg;
1302 * This and associated data structs are used by the
1303 * ioctl caller and are in cpu order.
1305 struct user_aac_srb
1307 u32 function;
1308 u32 channel;
1309 u32 id;
1310 u32 lun;
1311 u32 timeout;
1312 u32 flags;
1313 u32 count; // Data xfer size
1314 u32 retry_limit;
1315 u32 cdb_size;
1316 u8 cdb[16];
1317 struct user_sgmap sg;
1320 #define AAC_SENSE_BUFFERSIZE 30
1322 struct aac_srb_reply
1324 __le32 status;
1325 __le32 srb_status;
1326 __le32 scsi_status;
1327 __le32 data_xfer_length;
1328 __le32 sense_data_size;
1329 u8 sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1332 * SRB Flags
1334 #define SRB_NoDataXfer 0x0000
1335 #define SRB_DisableDisconnect 0x0004
1336 #define SRB_DisableSynchTransfer 0x0008
1337 #define SRB_BypassFrozenQueue 0x0010
1338 #define SRB_DisableAutosense 0x0020
1339 #define SRB_DataIn 0x0040
1340 #define SRB_DataOut 0x0080
1343 * SRB Functions - set in aac_srb->function
1345 #define SRBF_ExecuteScsi 0x0000
1346 #define SRBF_ClaimDevice 0x0001
1347 #define SRBF_IO_Control 0x0002
1348 #define SRBF_ReceiveEvent 0x0003
1349 #define SRBF_ReleaseQueue 0x0004
1350 #define SRBF_AttachDevice 0x0005
1351 #define SRBF_ReleaseDevice 0x0006
1352 #define SRBF_Shutdown 0x0007
1353 #define SRBF_Flush 0x0008
1354 #define SRBF_AbortCommand 0x0010
1355 #define SRBF_ReleaseRecovery 0x0011
1356 #define SRBF_ResetBus 0x0012
1357 #define SRBF_ResetDevice 0x0013
1358 #define SRBF_TerminateIO 0x0014
1359 #define SRBF_FlushQueue 0x0015
1360 #define SRBF_RemoveDevice 0x0016
1361 #define SRBF_DomainValidation 0x0017
1364 * SRB SCSI Status - set in aac_srb->scsi_status
1366 #define SRB_STATUS_PENDING 0x00
1367 #define SRB_STATUS_SUCCESS 0x01
1368 #define SRB_STATUS_ABORTED 0x02
1369 #define SRB_STATUS_ABORT_FAILED 0x03
1370 #define SRB_STATUS_ERROR 0x04
1371 #define SRB_STATUS_BUSY 0x05
1372 #define SRB_STATUS_INVALID_REQUEST 0x06
1373 #define SRB_STATUS_INVALID_PATH_ID 0x07
1374 #define SRB_STATUS_NO_DEVICE 0x08
1375 #define SRB_STATUS_TIMEOUT 0x09
1376 #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
1377 #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
1378 #define SRB_STATUS_MESSAGE_REJECTED 0x0D
1379 #define SRB_STATUS_BUS_RESET 0x0E
1380 #define SRB_STATUS_PARITY_ERROR 0x0F
1381 #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
1382 #define SRB_STATUS_NO_HBA 0x11
1383 #define SRB_STATUS_DATA_OVERRUN 0x12
1384 #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
1385 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
1386 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
1387 #define SRB_STATUS_REQUEST_FLUSHED 0x16
1388 #define SRB_STATUS_DELAYED_RETRY 0x17
1389 #define SRB_STATUS_INVALID_LUN 0x20
1390 #define SRB_STATUS_INVALID_TARGET_ID 0x21
1391 #define SRB_STATUS_BAD_FUNCTION 0x22
1392 #define SRB_STATUS_ERROR_RECOVERY 0x23
1393 #define SRB_STATUS_NOT_STARTED 0x24
1394 #define SRB_STATUS_NOT_IN_USE 0x30
1395 #define SRB_STATUS_FORCE_ABORT 0x31
1396 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL 0x32
1399 * Object-Server / Volume-Manager Dispatch Classes
1402 #define VM_Null 0
1403 #define VM_NameServe 1
1404 #define VM_ContainerConfig 2
1405 #define VM_Ioctl 3
1406 #define VM_FilesystemIoctl 4
1407 #define VM_CloseAll 5
1408 #define VM_CtBlockRead 6
1409 #define VM_CtBlockWrite 7
1410 #define VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
1411 #define VM_SliceBlockWrite 9
1412 #define VM_DriveBlockRead 10 /* raw access to physical devices */
1413 #define VM_DriveBlockWrite 11
1414 #define VM_EnclosureMgt 12 /* enclosure management */
1415 #define VM_Unused 13 /* used to be diskset management */
1416 #define VM_CtBlockVerify 14
1417 #define VM_CtPerf 15 /* performance test */
1418 #define VM_CtBlockRead64 16
1419 #define VM_CtBlockWrite64 17
1420 #define VM_CtBlockVerify64 18
1421 #define VM_CtHostRead64 19
1422 #define VM_CtHostWrite64 20
1423 #define VM_DrvErrTblLog 21
1424 #define VM_NameServe64 22
1426 #define MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */
1429 * Descriptive information (eg, vital stats)
1430 * that a content manager might report. The
1431 * FileArray filesystem component is one example
1432 * of a content manager. Raw mode might be
1433 * another.
1436 struct aac_fsinfo {
1437 __le32 fsTotalSize; /* Consumed by fs, incl. metadata */
1438 __le32 fsBlockSize;
1439 __le32 fsFragSize;
1440 __le32 fsMaxExtendSize;
1441 __le32 fsSpaceUnits;
1442 __le32 fsMaxNumFiles;
1443 __le32 fsNumFreeFiles;
1444 __le32 fsInodeDensity;
1445 }; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1447 union aac_contentinfo {
1448 struct aac_fsinfo filesys; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1452 * Query for Container Configuration Status
1455 #define CT_GET_CONFIG_STATUS 147
1456 struct aac_get_config_status {
1457 __le32 command; /* VM_ContainerConfig */
1458 __le32 type; /* CT_GET_CONFIG_STATUS */
1459 __le32 parm1;
1460 __le32 parm2;
1461 __le32 parm3;
1462 __le32 parm4;
1463 __le32 parm5;
1464 __le32 count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1467 #define CFACT_CONTINUE 0
1468 #define CFACT_PAUSE 1
1469 #define CFACT_ABORT 2
1470 struct aac_get_config_status_resp {
1471 __le32 response; /* ST_OK */
1472 __le32 dummy0;
1473 __le32 status; /* CT_OK */
1474 __le32 parm1;
1475 __le32 parm2;
1476 __le32 parm3;
1477 __le32 parm4;
1478 __le32 parm5;
1479 struct {
1480 __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1481 __le16 flags;
1482 __le16 count;
1483 } data;
1487 * Accept the configuration as-is
1490 #define CT_COMMIT_CONFIG 152
1492 struct aac_commit_config {
1493 __le32 command; /* VM_ContainerConfig */
1494 __le32 type; /* CT_COMMIT_CONFIG */
1498 * Query for Container Configuration Status
1501 #define CT_GET_CONTAINER_COUNT 4
1502 struct aac_get_container_count {
1503 __le32 command; /* VM_ContainerConfig */
1504 __le32 type; /* CT_GET_CONTAINER_COUNT */
1507 struct aac_get_container_count_resp {
1508 __le32 response; /* ST_OK */
1509 __le32 dummy0;
1510 __le32 MaxContainers;
1511 __le32 ContainerSwitchEntries;
1512 __le32 MaxPartitions;
1517 * Query for "mountable" objects, ie, objects that are typically
1518 * associated with a drive letter on the client (host) side.
1521 struct aac_mntent {
1522 __le32 oid;
1523 u8 name[16]; /* if applicable */
1524 struct creation_info create_info; /* if applicable */
1525 __le32 capacity;
1526 __le32 vol; /* substrate structure */
1527 __le32 obj; /* FT_FILESYS, etc. */
1528 __le32 state; /* unready for mounting,
1529 readonly, etc. */
1530 union aac_contentinfo fileinfo; /* Info specific to content
1531 manager (eg, filesystem) */
1532 __le32 altoid; /* != oid <==> snapshot or
1533 broken mirror exists */
1534 __le32 capacityhigh;
1537 #define FSCS_NOTCLEAN 0x0001 /* fsck is necessary before mounting */
1538 #define FSCS_READONLY 0x0002 /* possible result of broken mirror */
1539 #define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
1541 struct aac_query_mount {
1542 __le32 command;
1543 __le32 type;
1544 __le32 count;
1547 struct aac_mount {
1548 __le32 status;
1549 __le32 type; /* should be same as that requested */
1550 __le32 count;
1551 struct aac_mntent mnt[1];
1554 #define CT_READ_NAME 130
1555 struct aac_get_name {
1556 __le32 command; /* VM_ContainerConfig */
1557 __le32 type; /* CT_READ_NAME */
1558 __le32 cid;
1559 __le32 parm1;
1560 __le32 parm2;
1561 __le32 parm3;
1562 __le32 parm4;
1563 __le32 count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1566 struct aac_get_name_resp {
1567 __le32 dummy0;
1568 __le32 dummy1;
1569 __le32 status; /* CT_OK */
1570 __le32 parm1;
1571 __le32 parm2;
1572 __le32 parm3;
1573 __le32 parm4;
1574 __le32 parm5;
1575 u8 data[16];
1578 #define CT_CID_TO_32BITS_UID 165
1579 struct aac_get_serial {
1580 __le32 command; /* VM_ContainerConfig */
1581 __le32 type; /* CT_CID_TO_32BITS_UID */
1582 __le32 cid;
1585 struct aac_get_serial_resp {
1586 __le32 dummy0;
1587 __le32 dummy1;
1588 __le32 status; /* CT_OK */
1589 __le32 uid;
1593 * The following command is sent to shut down each container.
1596 struct aac_close {
1597 __le32 command;
1598 __le32 cid;
1601 struct aac_query_disk
1603 s32 cnum;
1604 s32 bus;
1605 s32 id;
1606 s32 lun;
1607 u32 valid;
1608 u32 locked;
1609 u32 deleted;
1610 s32 instance;
1611 s8 name[10];
1612 u32 unmapped;
1615 struct aac_delete_disk {
1616 u32 disknum;
1617 u32 cnum;
1620 struct fib_ioctl
1622 u32 fibctx;
1623 s32 wait;
1624 char __user *fib;
1627 struct revision
1629 u32 compat;
1630 __le32 version;
1631 __le32 build;
1636 * Ugly - non Linux like ioctl coding for back compat.
1639 #define CTL_CODE(function, method) ( \
1640 (4<< 16) | ((function) << 2) | (method) \
1644 * Define the method codes for how buffers are passed for I/O and FS
1645 * controls
1648 #define METHOD_BUFFERED 0
1649 #define METHOD_NEITHER 3
1652 * Filesystem ioctls
1655 #define FSACTL_SENDFIB CTL_CODE(2050, METHOD_BUFFERED)
1656 #define FSACTL_SEND_RAW_SRB CTL_CODE(2067, METHOD_BUFFERED)
1657 #define FSACTL_DELETE_DISK 0x163
1658 #define FSACTL_QUERY_DISK 0x173
1659 #define FSACTL_OPEN_GET_ADAPTER_FIB CTL_CODE(2100, METHOD_BUFFERED)
1660 #define FSACTL_GET_NEXT_ADAPTER_FIB CTL_CODE(2101, METHOD_BUFFERED)
1661 #define FSACTL_CLOSE_GET_ADAPTER_FIB CTL_CODE(2102, METHOD_BUFFERED)
1662 #define FSACTL_MINIPORT_REV_CHECK CTL_CODE(2107, METHOD_BUFFERED)
1663 #define FSACTL_GET_PCI_INFO CTL_CODE(2119, METHOD_BUFFERED)
1664 #define FSACTL_FORCE_DELETE_DISK CTL_CODE(2120, METHOD_NEITHER)
1665 #define FSACTL_GET_CONTAINERS 2131
1666 #define FSACTL_SEND_LARGE_FIB CTL_CODE(2138, METHOD_BUFFERED)
1669 struct aac_common
1672 * If this value is set to 1 then interrupt moderation will occur
1673 * in the base commuication support.
1675 u32 irq_mod;
1676 u32 peak_fibs;
1677 u32 zero_fibs;
1678 u32 fib_timeouts;
1680 * Statistical counters in debug mode
1682 #ifdef DBG
1683 u32 FibsSent;
1684 u32 FibRecved;
1685 u32 NoResponseSent;
1686 u32 NoResponseRecved;
1687 u32 AsyncSent;
1688 u32 AsyncRecved;
1689 u32 NormalSent;
1690 u32 NormalRecved;
1691 #endif
1694 extern struct aac_common aac_config;
1698 * The following macro is used when sending and receiving FIBs. It is
1699 * only used for debugging.
1702 #ifdef DBG
1703 #define FIB_COUNTER_INCREMENT(counter) (counter)++
1704 #else
1705 #define FIB_COUNTER_INCREMENT(counter)
1706 #endif
1709 * Adapter direct commands
1710 * Monitor/Kernel API
1713 #define BREAKPOINT_REQUEST 0x00000004
1714 #define INIT_STRUCT_BASE_ADDRESS 0x00000005
1715 #define READ_PERMANENT_PARAMETERS 0x0000000a
1716 #define WRITE_PERMANENT_PARAMETERS 0x0000000b
1717 #define HOST_CRASHING 0x0000000d
1718 #define SEND_SYNCHRONOUS_FIB 0x0000000c
1719 #define COMMAND_POST_RESULTS 0x00000014
1720 #define GET_ADAPTER_PROPERTIES 0x00000019
1721 #define GET_DRIVER_BUFFER_PROPERTIES 0x00000023
1722 #define RCV_TEMP_READINGS 0x00000025
1723 #define GET_COMM_PREFERRED_SETTINGS 0x00000026
1724 #define IOP_RESET 0x00001000
1725 #define IOP_RESET_ALWAYS 0x00001001
1726 #define RE_INIT_ADAPTER 0x000000ee
1729 * Adapter Status Register
1731 * Phase Staus mailbox is 32bits:
1732 * <31:16> = Phase Status
1733 * <15:0> = Phase
1735 * The adapter reports is present state through the phase. Only
1736 * a single phase should be ever be set. Each phase can have multiple
1737 * phase status bits to provide more detailed information about the
1738 * state of the board. Care should be taken to ensure that any phase
1739 * status bits that are set when changing the phase are also valid
1740 * for the new phase or be cleared out. Adapter software (monitor,
1741 * iflash, kernel) is responsible for properly maintining the phase
1742 * status mailbox when it is running.
1744 * MONKER_API Phases
1746 * Phases are bit oriented. It is NOT valid to have multiple bits set
1749 #define SELF_TEST_FAILED 0x00000004
1750 #define MONITOR_PANIC 0x00000020
1751 #define KERNEL_UP_AND_RUNNING 0x00000080
1752 #define KERNEL_PANIC 0x00000100
1755 * Doorbell bit defines
1758 #define DoorBellSyncCmdAvailable (1<<0) /* Host -> Adapter */
1759 #define DoorBellPrintfDone (1<<5) /* Host -> Adapter */
1760 #define DoorBellAdapterNormCmdReady (1<<1) /* Adapter -> Host */
1761 #define DoorBellAdapterNormRespReady (1<<2) /* Adapter -> Host */
1762 #define DoorBellAdapterNormCmdNotFull (1<<3) /* Adapter -> Host */
1763 #define DoorBellAdapterNormRespNotFull (1<<4) /* Adapter -> Host */
1764 #define DoorBellPrintfReady (1<<5) /* Adapter -> Host */
1767 * For FIB communication, we need all of the following things
1768 * to send back to the user.
1771 #define AifCmdEventNotify 1 /* Notify of event */
1772 #define AifEnConfigChange 3 /* Adapter configuration change */
1773 #define AifEnContainerChange 4 /* Container configuration change */
1774 #define AifEnDeviceFailure 5 /* SCSI device failed */
1775 #define AifEnEnclosureManagement 13 /* EM_DRIVE_* */
1776 #define EM_DRIVE_INSERTION 31
1777 #define EM_DRIVE_REMOVAL 32
1778 #define AifEnBatteryEvent 14 /* Change in Battery State */
1779 #define AifEnAddContainer 15 /* A new array was created */
1780 #define AifEnDeleteContainer 16 /* A container was deleted */
1781 #define AifEnExpEvent 23 /* Firmware Event Log */
1782 #define AifExeFirmwarePanic 3 /* Firmware Event Panic */
1783 #define AifHighPriority 3 /* Highest Priority Event */
1785 #define AifCmdJobProgress 2 /* Progress report */
1786 #define AifJobCtrZero 101 /* Array Zero progress */
1787 #define AifJobStsSuccess 1 /* Job completes */
1788 #define AifJobStsRunning 102 /* Job running */
1789 #define AifCmdAPIReport 3 /* Report from other user of API */
1790 #define AifCmdDriverNotify 4 /* Notify host driver of event */
1791 #define AifDenMorphComplete 200 /* A morph operation completed */
1792 #define AifDenVolumeExtendComplete 201 /* A volume extend completed */
1793 #define AifReqJobList 100 /* Gets back complete job list */
1794 #define AifReqJobsForCtr 101 /* Gets back jobs for specific container */
1795 #define AifReqJobsForScsi 102 /* Gets back jobs for specific SCSI device */
1796 #define AifReqJobReport 103 /* Gets back a specific job report or list of them */
1797 #define AifReqTerminateJob 104 /* Terminates job */
1798 #define AifReqSuspendJob 105 /* Suspends a job */
1799 #define AifReqResumeJob 106 /* Resumes a job */
1800 #define AifReqSendAPIReport 107 /* API generic report requests */
1801 #define AifReqAPIJobStart 108 /* Start a job from the API */
1802 #define AifReqAPIJobUpdate 109 /* Update a job report from the API */
1803 #define AifReqAPIJobFinish 110 /* Finish a job from the API */
1806 * Adapter Initiated FIB command structures. Start with the adapter
1807 * initiated FIBs that really come from the adapter, and get responded
1808 * to by the host.
1811 struct aac_aifcmd {
1812 __le32 command; /* Tell host what type of notify this is */
1813 __le32 seqnum; /* To allow ordering of reports (if necessary) */
1814 u8 data[1]; /* Undefined length (from kernel viewpoint) */
1818 * Convert capacity to cylinders
1819 * accounting for the fact capacity could be a 64 bit value
1822 static inline unsigned int cap_to_cyls(sector_t capacity, unsigned divisor)
1824 sector_div(capacity, divisor);
1825 return capacity;
1828 /* SCp.phase values */
1829 #define AAC_OWNER_MIDLEVEL 0x101
1830 #define AAC_OWNER_LOWLEVEL 0x102
1831 #define AAC_OWNER_ERROR_HANDLER 0x103
1832 #define AAC_OWNER_FIRMWARE 0x106
1834 const char *aac_driverinfo(struct Scsi_Host *);
1835 struct fib *aac_fib_alloc(struct aac_dev *dev);
1836 int aac_fib_setup(struct aac_dev *dev);
1837 void aac_fib_map_free(struct aac_dev *dev);
1838 void aac_fib_free(struct fib * context);
1839 void aac_fib_init(struct fib * context);
1840 void aac_printf(struct aac_dev *dev, u32 val);
1841 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1842 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1843 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1844 int aac_fib_complete(struct fib * context);
1845 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib_va->data)
1846 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1847 int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1848 int aac_get_containers(struct aac_dev *dev);
1849 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1850 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1851 #ifndef shost_to_class
1852 #define shost_to_class(shost) &shost->shost_classdev
1853 #endif
1854 ssize_t aac_show_serial_number(struct class_device *class_dev, char *buf);
1855 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1856 int aac_rx_init(struct aac_dev *dev);
1857 int aac_rkt_init(struct aac_dev *dev);
1858 int aac_nark_init(struct aac_dev *dev);
1859 int aac_sa_init(struct aac_dev *dev);
1860 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);
1861 unsigned int aac_response_normal(struct aac_queue * q);
1862 unsigned int aac_command_normal(struct aac_queue * q);
1863 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1864 int aac_reset_adapter(struct aac_dev * dev, int forced);
1865 int aac_check_health(struct aac_dev * dev);
1866 int aac_command_thread(void *data);
1867 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1868 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1869 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1870 int aac_get_adapter_info(struct aac_dev* dev);
1871 int aac_send_shutdown(struct aac_dev *dev);
1872 int aac_probe_container(struct aac_dev *dev, int cid);
1873 int _aac_rx_init(struct aac_dev *dev);
1874 int aac_rx_select_comm(struct aac_dev *dev, int comm);
1875 int aac_rx_deliver_producer(struct fib * fib);
1876 char * get_container_type(unsigned type);
1877 extern int numacb;
1878 extern int acbsize;
1879 extern char aac_driver_version[];
1880 extern int startup_timeout;
1881 extern int aif_timeout;
1882 extern int expose_physicals;
1883 extern int aac_reset_devices;
1884 extern int aac_commit;
1885 extern int update_interval;
1886 extern int check_interval;
1887 extern int aac_check_reset;