GUI: Fix Tomato RAF theme for all builds. Compilation typo.
[tomato.git] / release / src-rt-6.x.4708 / linux / linux-2.6.36 / drivers / scsi / aacraid / aacraid.h
blob4dbcc055ac783bb4b8b3752def53a91dee759a7a
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 26400
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)
29 #define AAC_DEBUG_INSTRUMENT_AIF_DELETE
32 * These macros convert from physical channels to virtual channels
34 #define CONTAINER_CHANNEL (0)
35 #define CONTAINER_TO_CHANNEL(cont) (CONTAINER_CHANNEL)
36 #define CONTAINER_TO_ID(cont) (cont)
37 #define CONTAINER_TO_LUN(cont) (0)
39 #define aac_phys_to_logical(x) ((x)+1)
40 #define aac_logical_to_phys(x) ((x)?(x)-1:0)
42 /* #define AAC_DETAILED_STATUS_INFO */
44 struct diskparm
46 int heads;
47 int sectors;
48 int cylinders;
53 * Firmware constants
56 #define CT_NONE 0
57 #define CT_OK 218
58 #define FT_FILESYS 8 /* ADAPTEC's "FSA"(tm) filesystem */
59 #define FT_DRIVE 9 /* physical disk - addressable in scsi by bus/id/lun */
62 * Host side memory scatter gather list
63 * Used by the adapter for read, write, and readdirplus operations
64 * We have separate 32 and 64 bit version because even
65 * on 64 bit systems not all cards support the 64 bit version
67 struct sgentry {
68 __le32 addr; /* 32-bit address. */
69 __le32 count; /* Length. */
72 struct user_sgentry {
73 u32 addr; /* 32-bit address. */
74 u32 count; /* Length. */
77 struct sgentry64 {
78 __le32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
79 __le32 count; /* Length. */
82 struct user_sgentry64 {
83 u32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
84 u32 count; /* Length. */
87 struct sgentryraw {
88 __le32 next; /* reserved for F/W use */
89 __le32 prev; /* reserved for F/W use */
90 __le32 addr[2];
91 __le32 count;
92 __le32 flags; /* reserved for F/W use */
95 struct user_sgentryraw {
96 u32 next; /* reserved for F/W use */
97 u32 prev; /* reserved for F/W use */
98 u32 addr[2];
99 u32 count;
100 u32 flags; /* reserved for F/W use */
104 * SGMAP
106 * This is the SGMAP structure for all commands that use
107 * 32-bit addressing.
110 struct sgmap {
111 __le32 count;
112 struct sgentry sg[1];
115 struct user_sgmap {
116 u32 count;
117 struct user_sgentry sg[1];
120 struct sgmap64 {
121 __le32 count;
122 struct sgentry64 sg[1];
125 struct user_sgmap64 {
126 u32 count;
127 struct user_sgentry64 sg[1];
130 struct sgmapraw {
131 __le32 count;
132 struct sgentryraw sg[1];
135 struct user_sgmapraw {
136 u32 count;
137 struct user_sgentryraw sg[1];
140 struct creation_info
142 u8 buildnum; /* e.g., 588 */
143 u8 usec; /* e.g., 588 */
144 u8 via; /* e.g., 1 = FSU,
145 * 2 = API
147 u8 year; /* e.g., 1997 = 97 */
148 __le32 date; /*
149 * unsigned Month :4; // 1 - 12
150 * unsigned Day :6; // 1 - 32
151 * unsigned Hour :6; // 0 - 23
152 * unsigned Minute :6; // 0 - 60
153 * unsigned Second :6; // 0 - 60
155 __le32 serial[2]; /* e.g., 0x1DEADB0BFAFAF001 */
160 * Define all the constants needed for the communication interface
164 * Define how many queue entries each queue will have and the total
165 * number of entries for the entire communication interface. Also define
166 * how many queues we support.
168 * This has to match the controller
171 #define NUMBER_OF_COMM_QUEUES 8 // 4 command; 4 response
172 #define HOST_HIGH_CMD_ENTRIES 4
173 #define HOST_NORM_CMD_ENTRIES 8
174 #define ADAP_HIGH_CMD_ENTRIES 4
175 #define ADAP_NORM_CMD_ENTRIES 512
176 #define HOST_HIGH_RESP_ENTRIES 4
177 #define HOST_NORM_RESP_ENTRIES 512
178 #define ADAP_HIGH_RESP_ENTRIES 4
179 #define ADAP_NORM_RESP_ENTRIES 8
181 #define TOTAL_QUEUE_ENTRIES \
182 (HOST_NORM_CMD_ENTRIES + HOST_HIGH_CMD_ENTRIES + ADAP_NORM_CMD_ENTRIES + ADAP_HIGH_CMD_ENTRIES + \
183 HOST_NORM_RESP_ENTRIES + HOST_HIGH_RESP_ENTRIES + ADAP_NORM_RESP_ENTRIES + ADAP_HIGH_RESP_ENTRIES)
187 * Set the queues on a 16 byte alignment
190 #define QUEUE_ALIGNMENT 16
193 * The queue headers define the Communication Region queues. These
194 * are physically contiguous and accessible by both the adapter and the
195 * host. Even though all queue headers are in the same contiguous block
196 * they will be represented as individual units in the data structures.
199 struct aac_entry {
200 __le32 size; /* Size in bytes of Fib which this QE points to */
201 __le32 addr; /* Receiver address of the FIB */
205 * The adapter assumes the ProducerIndex and ConsumerIndex are grouped
206 * adjacently and in that order.
209 struct aac_qhdr {
210 __le64 header_addr;/* Address to hand the adapter to access
211 to this queue head */
212 __le32 *producer; /* The producer index for this queue (host address) */
213 __le32 *consumer; /* The consumer index for this queue (host address) */
217 * Define all the events which the adapter would like to notify
218 * the host of.
221 #define HostNormCmdQue 1 /* Change in host normal priority command queue */
222 #define HostHighCmdQue 2 /* Change in host high priority command queue */
223 #define HostNormRespQue 3 /* Change in host normal priority response queue */
224 #define HostHighRespQue 4 /* Change in host high priority response queue */
225 #define AdapNormRespNotFull 5
226 #define AdapHighRespNotFull 6
227 #define AdapNormCmdNotFull 7
228 #define AdapHighCmdNotFull 8
229 #define SynchCommandComplete 9
230 #define AdapInternalError 0xfe /* The adapter detected an internal error shutting down */
233 * Define all the events the host wishes to notify the
234 * adapter of. The first four values much match the Qid the
235 * corresponding queue.
238 #define AdapNormCmdQue 2
239 #define AdapHighCmdQue 3
240 #define AdapNormRespQue 6
241 #define AdapHighRespQue 7
242 #define HostShutdown 8
243 #define HostPowerFail 9
244 #define FatalCommError 10
245 #define HostNormRespNotFull 11
246 #define HostHighRespNotFull 12
247 #define HostNormCmdNotFull 13
248 #define HostHighCmdNotFull 14
249 #define FastIo 15
250 #define AdapPrintfDone 16
253 * Define all the queues that the adapter and host use to communicate
254 * Number them to match the physical queue layout.
257 enum aac_queue_types {
258 HostNormCmdQueue = 0, /* Adapter to host normal priority command traffic */
259 HostHighCmdQueue, /* Adapter to host high priority command traffic */
260 AdapNormCmdQueue, /* Host to adapter normal priority command traffic */
261 AdapHighCmdQueue, /* Host to adapter high priority command traffic */
262 HostNormRespQueue, /* Adapter to host normal priority response traffic */
263 HostHighRespQueue, /* Adapter to host high priority response traffic */
264 AdapNormRespQueue, /* Host to adapter normal priority response traffic */
265 AdapHighRespQueue /* Host to adapter high priority response traffic */
269 * Assign type values to the FSA communication data structures
272 #define FIB_MAGIC 0x0001
275 * Define the priority levels the FSA communication routines support.
278 #define FsaNormal 1
281 * Define the FIB. The FIB is the where all the requested data and
282 * command information are put to the application on the FSA adapter.
285 struct aac_fibhdr {
286 __le32 XferState; /* Current transfer state for this CCB */
287 __le16 Command; /* Routing information for the destination */
288 u8 StructType; /* Type FIB */
289 u8 Flags; /* Flags for FIB */
290 __le16 Size; /* Size of this FIB in bytes */
291 __le16 SenderSize; /* Size of the FIB in the sender
292 (for response sizing) */
293 __le32 SenderFibAddress; /* Host defined data in the FIB */
294 __le32 ReceiverFibAddress;/* Logical address of this FIB for
295 the adapter */
296 u32 SenderData; /* Place holder for the sender to store data */
297 union {
298 struct {
299 __le32 _ReceiverTimeStart; /* Timestamp for
300 receipt of fib */
301 __le32 _ReceiverTimeDone; /* Timestamp for
302 completion of fib */
303 } _s;
304 } _u;
307 struct hw_fib {
308 struct aac_fibhdr header;
309 u8 data[512-sizeof(struct aac_fibhdr)]; // Command specific data
313 * FIB commands
316 #define TestCommandResponse 1
317 #define TestAdapterCommand 2
319 * Lowlevel and comm commands
321 #define LastTestCommand 100
322 #define ReinitHostNormCommandQueue 101
323 #define ReinitHostHighCommandQueue 102
324 #define ReinitHostHighRespQueue 103
325 #define ReinitHostNormRespQueue 104
326 #define ReinitAdapNormCommandQueue 105
327 #define ReinitAdapHighCommandQueue 107
328 #define ReinitAdapHighRespQueue 108
329 #define ReinitAdapNormRespQueue 109
330 #define InterfaceShutdown 110
331 #define DmaCommandFib 120
332 #define StartProfile 121
333 #define TermProfile 122
334 #define SpeedTest 123
335 #define TakeABreakPt 124
336 #define RequestPerfData 125
337 #define SetInterruptDefTimer 126
338 #define SetInterruptDefCount 127
339 #define GetInterruptDefStatus 128
340 #define LastCommCommand 129
342 * Filesystem commands
344 #define NuFileSystem 300
345 #define UFS 301
346 #define HostFileSystem 302
347 #define LastFileSystemCommand 303
349 * Container Commands
351 #define ContainerCommand 500
352 #define ContainerCommand64 501
353 #define ContainerRawIo 502
355 * Scsi Port commands (scsi passthrough)
357 #define ScsiPortCommand 600
358 #define ScsiPortCommand64 601
360 * Misc house keeping and generic adapter initiated commands
362 #define AifRequest 700
363 #define CheckRevision 701
364 #define FsaHostShutdown 702
365 #define RequestAdapterInfo 703
366 #define IsAdapterPaused 704
367 #define SendHostTime 705
368 #define RequestSupplementAdapterInfo 706
369 #define LastMiscCommand 707
372 * Commands that will target the failover level on the FSA adapter
375 enum fib_xfer_state {
376 HostOwned = (1<<0),
377 AdapterOwned = (1<<1),
378 FibInitialized = (1<<2),
379 FibEmpty = (1<<3),
380 AllocatedFromPool = (1<<4),
381 SentFromHost = (1<<5),
382 SentFromAdapter = (1<<6),
383 ResponseExpected = (1<<7),
384 NoResponseExpected = (1<<8),
385 AdapterProcessed = (1<<9),
386 HostProcessed = (1<<10),
387 HighPriority = (1<<11),
388 NormalPriority = (1<<12),
389 Async = (1<<13),
390 AsyncIo = (1<<13), // rpbfix: remove with new regime
391 PageFileIo = (1<<14), // rpbfix: remove with new regime
392 ShutdownRequest = (1<<15),
393 LazyWrite = (1<<16), // rpbfix: remove with new regime
394 AdapterMicroFib = (1<<17),
395 BIOSFibPath = (1<<18),
396 FastResponseCapable = (1<<19),
397 ApiFib = (1<<20) // Its an API Fib.
401 * The following defines needs to be updated any time there is an
402 * incompatible change made to the aac_init structure.
405 #define ADAPTER_INIT_STRUCT_REVISION 3
406 #define ADAPTER_INIT_STRUCT_REVISION_4 4 // rocket science
408 struct aac_init
410 __le32 InitStructRevision;
411 __le32 MiniPortRevision;
412 __le32 fsrev;
413 __le32 CommHeaderAddress;
414 __le32 FastIoCommAreaAddress;
415 __le32 AdapterFibsPhysicalAddress;
416 __le32 AdapterFibsVirtualAddress;
417 __le32 AdapterFibsSize;
418 __le32 AdapterFibAlign;
419 __le32 printfbuf;
420 __le32 printfbufsiz;
421 __le32 HostPhysMemPages; /* number of 4k pages of host
422 physical memory */
423 __le32 HostElapsedSeconds; /* number of seconds since 1970. */
425 * ADAPTER_INIT_STRUCT_REVISION_4 begins here
427 __le32 InitFlags; /* flags for supported features */
428 #define INITFLAGS_NEW_COMM_SUPPORTED 0x00000001
429 #define INITFLAGS_DRIVER_USES_UTC_TIME 0x00000010
430 #define INITFLAGS_DRIVER_SUPPORTS_PM 0x00000020
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 contiguous block. The host structure that defines the
532 * commuication queues will assume they are each a separate physically
533 * contiguous memory region that will support them all being one big
534 * contiguous 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 StructExpansion;
871 /* StructExpansion == 1 */
872 __le32 FeatureBits3;
873 __le32 SupportedPerformanceModes;
874 __le32 ReservedForFutureGrowth[80];
876 #define AAC_FEATURE_FALCON cpu_to_le32(0x00000010)
877 #define AAC_FEATURE_JBOD cpu_to_le32(0x08000000)
878 /* SupportedOptions2 */
879 #define AAC_OPTION_MU_RESET cpu_to_le32(0x00000001)
880 #define AAC_OPTION_IGNORE_RESET cpu_to_le32(0x00000002)
881 #define AAC_OPTION_POWER_MANAGEMENT cpu_to_le32(0x00000004)
882 #define AAC_SIS_VERSION_V3 3
883 #define AAC_SIS_SLOT_UNKNOWN 0xFF
885 #define GetBusInfo 0x00000009
886 struct aac_bus_info {
887 __le32 Command; /* VM_Ioctl */
888 __le32 ObjType; /* FT_DRIVE */
889 __le32 MethodId; /* 1 = SCSI Layer */
890 __le32 ObjectId; /* Handle */
891 __le32 CtlCmd; /* GetBusInfo */
894 struct aac_bus_info_response {
895 __le32 Status; /* ST_OK */
896 __le32 ObjType;
897 __le32 MethodId; /* unused */
898 __le32 ObjectId; /* unused */
899 __le32 CtlCmd; /* unused */
900 __le32 ProbeComplete;
901 __le32 BusCount;
902 __le32 TargetsPerBus;
903 u8 InitiatorBusId[10];
904 u8 BusValid[10];
908 * Battery platforms
910 #define AAC_BAT_REQ_PRESENT (1)
911 #define AAC_BAT_REQ_NOTPRESENT (2)
912 #define AAC_BAT_OPT_PRESENT (3)
913 #define AAC_BAT_OPT_NOTPRESENT (4)
914 #define AAC_BAT_NOT_SUPPORTED (5)
916 * cpu types
918 #define AAC_CPU_SIMULATOR (1)
919 #define AAC_CPU_I960 (2)
920 #define AAC_CPU_STRONGARM (3)
923 * Supported Options
925 #define AAC_OPT_SNAPSHOT cpu_to_le32(1)
926 #define AAC_OPT_CLUSTERS cpu_to_le32(1<<1)
927 #define AAC_OPT_WRITE_CACHE cpu_to_le32(1<<2)
928 #define AAC_OPT_64BIT_DATA cpu_to_le32(1<<3)
929 #define AAC_OPT_HOST_TIME_FIB cpu_to_le32(1<<4)
930 #define AAC_OPT_RAID50 cpu_to_le32(1<<5)
931 #define AAC_OPT_4GB_WINDOW cpu_to_le32(1<<6)
932 #define AAC_OPT_SCSI_UPGRADEABLE cpu_to_le32(1<<7)
933 #define AAC_OPT_SOFT_ERR_REPORT cpu_to_le32(1<<8)
934 #define AAC_OPT_SUPPORTED_RECONDITION cpu_to_le32(1<<9)
935 #define AAC_OPT_SGMAP_HOST64 cpu_to_le32(1<<10)
936 #define AAC_OPT_ALARM cpu_to_le32(1<<11)
937 #define AAC_OPT_NONDASD cpu_to_le32(1<<12)
938 #define AAC_OPT_SCSI_MANAGED cpu_to_le32(1<<13)
939 #define AAC_OPT_RAID_SCSI_MODE cpu_to_le32(1<<14)
940 #define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
941 #define AAC_OPT_NEW_COMM cpu_to_le32(1<<17)
942 #define AAC_OPT_NEW_COMM_64 cpu_to_le32(1<<18)
944 struct aac_dev
946 struct list_head entry;
947 const char *name;
948 int id;
951 * negotiated FIB settings
953 unsigned max_fib_size;
954 unsigned sg_tablesize;
957 * Map for 128 fib objects (64k)
959 dma_addr_t hw_fib_pa;
960 struct hw_fib *hw_fib_va;
961 struct hw_fib *aif_base_va;
963 * Fib Headers
965 struct fib *fibs;
967 struct fib *free_fib;
968 spinlock_t fib_lock;
970 struct aac_queue_block *queues;
972 * The user API will use an IOCTL to register itself to receive
973 * FIBs from the adapter. The following list is used to keep
974 * track of all the threads that have requested these FIBs. The
975 * mutex is used to synchronize access to all data associated
976 * with the adapter fibs.
978 struct list_head fib_list;
980 struct adapter_ops a_ops;
981 unsigned long fsrev; /* Main driver's revision number */
983 unsigned base_size; /* Size of mapped in region */
984 struct aac_init *init; /* Holds initialization info to communicate with adapter */
985 dma_addr_t init_pa; /* Holds physical address of the init struct */
987 struct pci_dev *pdev; /* Our PCI interface */
988 void * printfbuf; /* pointer to buffer used for printf's from the adapter */
989 void * comm_addr; /* Base address of Comm area */
990 dma_addr_t comm_phys; /* Physical Address of Comm area */
991 size_t comm_size;
993 struct Scsi_Host *scsi_host_ptr;
994 int maximum_num_containers;
995 int maximum_num_physicals;
996 int maximum_num_channels;
997 struct fsa_dev_info *fsa_dev;
998 struct task_struct *thread;
999 int cardtype;
1002 * The following is the device specific extension.
1004 #ifndef AAC_MIN_FOOTPRINT_SIZE
1005 # define AAC_MIN_FOOTPRINT_SIZE 8192
1006 #endif
1007 union
1009 struct sa_registers __iomem *sa;
1010 struct rx_registers __iomem *rx;
1011 struct rkt_registers __iomem *rkt;
1012 } regs;
1013 volatile void __iomem *base;
1014 volatile struct rx_inbound __iomem *IndexRegs;
1015 u32 OIMR; /* Mask Register Cache */
1017 * AIF thread states
1019 u32 aif_thread;
1020 struct aac_adapter_info adapter_info;
1021 struct aac_supplement_adapter_info supplement_adapter_info;
1022 /* These are in adapter info but they are in the io flow so
1023 * lets break them out so we don't have to do an AND to check them
1025 u8 nondasd_support;
1026 u8 jbod;
1027 u8 cache_protected;
1028 u8 dac_support;
1029 u8 needs_dac;
1030 u8 raid_scsi_mode;
1031 u8 comm_interface;
1032 # define AAC_COMM_PRODUCER 0
1033 # define AAC_COMM_MESSAGE 1
1034 /* macro side-effects BEWARE */
1035 # define raw_io_interface \
1036 init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1037 u8 raw_io_64;
1038 u8 printf_enabled;
1039 u8 in_reset;
1040 u8 msi;
1041 int management_fib_count;
1042 spinlock_t manage_lock;
1046 #define aac_adapter_interrupt(dev) \
1047 (dev)->a_ops.adapter_interrupt(dev)
1049 #define aac_adapter_notify(dev, event) \
1050 (dev)->a_ops.adapter_notify(dev, event)
1052 #define aac_adapter_disable_int(dev) \
1053 (dev)->a_ops.adapter_disable_int(dev)
1055 #define aac_adapter_enable_int(dev) \
1056 (dev)->a_ops.adapter_enable_int(dev)
1058 #define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1059 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1061 #define aac_adapter_check_health(dev) \
1062 (dev)->a_ops.adapter_check_health(dev)
1064 #define aac_adapter_restart(dev,bled) \
1065 (dev)->a_ops.adapter_restart(dev,bled)
1067 #define aac_adapter_ioremap(dev, size) \
1068 (dev)->a_ops.adapter_ioremap(dev, size)
1070 #define aac_adapter_deliver(fib) \
1071 ((fib)->dev)->a_ops.adapter_deliver(fib)
1073 #define aac_adapter_bounds(dev,cmd,lba) \
1074 dev->a_ops.adapter_bounds(dev,cmd,lba)
1076 #define aac_adapter_read(fib,cmd,lba,count) \
1077 ((fib)->dev)->a_ops.adapter_read(fib,cmd,lba,count)
1079 #define aac_adapter_write(fib,cmd,lba,count,fua) \
1080 ((fib)->dev)->a_ops.adapter_write(fib,cmd,lba,count,fua)
1082 #define aac_adapter_scsi(fib,cmd) \
1083 ((fib)->dev)->a_ops.adapter_scsi(fib,cmd)
1085 #define aac_adapter_comm(dev,comm) \
1086 (dev)->a_ops.adapter_comm(dev, comm)
1088 #define FIB_CONTEXT_FLAG_TIMED_OUT (0x00000001)
1089 #define FIB_CONTEXT_FLAG (0x00000002)
1092 * Define the command values
1095 #define Null 0
1096 #define GetAttributes 1
1097 #define SetAttributes 2
1098 #define Lookup 3
1099 #define ReadLink 4
1100 #define Read 5
1101 #define Write 6
1102 #define Create 7
1103 #define MakeDirectory 8
1104 #define SymbolicLink 9
1105 #define MakeNode 10
1106 #define Removex 11
1107 #define RemoveDirectoryx 12
1108 #define Rename 13
1109 #define Link 14
1110 #define ReadDirectory 15
1111 #define ReadDirectoryPlus 16
1112 #define FileSystemStatus 17
1113 #define FileSystemInfo 18
1114 #define PathConfigure 19
1115 #define Commit 20
1116 #define Mount 21
1117 #define UnMount 22
1118 #define Newfs 23
1119 #define FsCheck 24
1120 #define FsSync 25
1121 #define SimReadWrite 26
1122 #define SetFileSystemStatus 27
1123 #define BlockRead 28
1124 #define BlockWrite 29
1125 #define NvramIoctl 30
1126 #define FsSyncWait 31
1127 #define ClearArchiveBit 32
1128 #define SetAcl 33
1129 #define GetAcl 34
1130 #define AssignAcl 35
1131 #define FaultInsertion 36 /* Fault Insertion Command */
1132 #define CrazyCache 37 /* Crazycache */
1134 #define MAX_FSACOMMAND_NUM 38
1138 * Define the status returns. These are very unixlike although
1139 * most are not in fact used
1142 #define ST_OK 0
1143 #define ST_PERM 1
1144 #define ST_NOENT 2
1145 #define ST_IO 5
1146 #define ST_NXIO 6
1147 #define ST_E2BIG 7
1148 #define ST_ACCES 13
1149 #define ST_EXIST 17
1150 #define ST_XDEV 18
1151 #define ST_NODEV 19
1152 #define ST_NOTDIR 20
1153 #define ST_ISDIR 21
1154 #define ST_INVAL 22
1155 #define ST_FBIG 27
1156 #define ST_NOSPC 28
1157 #define ST_ROFS 30
1158 #define ST_MLINK 31
1159 #define ST_WOULDBLOCK 35
1160 #define ST_NAMETOOLONG 63
1161 #define ST_NOTEMPTY 66
1162 #define ST_DQUOT 69
1163 #define ST_STALE 70
1164 #define ST_REMOTE 71
1165 #define ST_NOT_READY 72
1166 #define ST_BADHANDLE 10001
1167 #define ST_NOT_SYNC 10002
1168 #define ST_BAD_COOKIE 10003
1169 #define ST_NOTSUPP 10004
1170 #define ST_TOOSMALL 10005
1171 #define ST_SERVERFAULT 10006
1172 #define ST_BADTYPE 10007
1173 #define ST_JUKEBOX 10008
1174 #define ST_NOTMOUNTED 10009
1175 #define ST_MAINTMODE 10010
1176 #define ST_STALEACL 10011
1179 * On writes how does the client want the data written.
1182 #define CACHE_CSTABLE 1
1183 #define CACHE_UNSTABLE 2
1186 * Lets the client know at which level the data was commited on
1187 * a write request
1190 #define CMFILE_SYNCH_NVRAM 1
1191 #define CMDATA_SYNCH_NVRAM 2
1192 #define CMFILE_SYNCH 3
1193 #define CMDATA_SYNCH 4
1194 #define CMUNSTABLE 5
1196 struct aac_read
1198 __le32 command;
1199 __le32 cid;
1200 __le32 block;
1201 __le32 count;
1202 struct sgmap sg; // Must be last in struct because it is variable
1205 struct aac_read64
1207 __le32 command;
1208 __le16 cid;
1209 __le16 sector_count;
1210 __le32 block;
1211 __le16 pad;
1212 __le16 flags;
1213 struct sgmap64 sg; // Must be last in struct because it is variable
1216 struct aac_read_reply
1218 __le32 status;
1219 __le32 count;
1222 struct aac_write
1224 __le32 command;
1225 __le32 cid;
1226 __le32 block;
1227 __le32 count;
1228 __le32 stable; // Not used
1229 struct sgmap sg; // Must be last in struct because it is variable
1232 struct aac_write64
1234 __le32 command;
1235 __le16 cid;
1236 __le16 sector_count;
1237 __le32 block;
1238 __le16 pad;
1239 __le16 flags;
1240 #define IO_TYPE_WRITE 0x00000000
1241 #define IO_TYPE_READ 0x00000001
1242 #define IO_SUREWRITE 0x00000008
1243 struct sgmap64 sg; // Must be last in struct because it is variable
1245 struct aac_write_reply
1247 __le32 status;
1248 __le32 count;
1249 __le32 committed;
1252 struct aac_raw_io
1254 __le32 block[2];
1255 __le32 count;
1256 __le16 cid;
1257 __le16 flags; /* 00 W, 01 R */
1258 __le16 bpTotal; /* reserved for F/W use */
1259 __le16 bpComplete; /* reserved for F/W use */
1260 struct sgmapraw sg;
1263 #define CT_FLUSH_CACHE 129
1264 struct aac_synchronize {
1265 __le32 command; /* VM_ContainerConfig */
1266 __le32 type; /* CT_FLUSH_CACHE */
1267 __le32 cid;
1268 __le32 parm1;
1269 __le32 parm2;
1270 __le32 parm3;
1271 __le32 parm4;
1272 __le32 count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1275 struct aac_synchronize_reply {
1276 __le32 dummy0;
1277 __le32 dummy1;
1278 __le32 status; /* CT_OK */
1279 __le32 parm1;
1280 __le32 parm2;
1281 __le32 parm3;
1282 __le32 parm4;
1283 __le32 parm5;
1284 u8 data[16];
1287 #define CT_POWER_MANAGEMENT 245
1288 #define CT_PM_START_UNIT 2
1289 #define CT_PM_STOP_UNIT 3
1290 #define CT_PM_UNIT_IMMEDIATE 1
1291 struct aac_power_management {
1292 __le32 command; /* VM_ContainerConfig */
1293 __le32 type; /* CT_POWER_MANAGEMENT */
1294 __le32 sub; /* CT_PM_* */
1295 __le32 cid;
1296 __le32 parm; /* CT_PM_sub_* */
1299 #define CT_PAUSE_IO 65
1300 #define CT_RELEASE_IO 66
1301 struct aac_pause {
1302 __le32 command; /* VM_ContainerConfig */
1303 __le32 type; /* CT_PAUSE_IO */
1304 __le32 timeout; /* 10ms ticks */
1305 __le32 min;
1306 __le32 noRescan;
1307 __le32 parm3;
1308 __le32 parm4;
1309 __le32 count; /* sizeof(((struct aac_pause_reply *)NULL)->data) */
1312 struct aac_srb
1314 __le32 function;
1315 __le32 channel;
1316 __le32 id;
1317 __le32 lun;
1318 __le32 timeout;
1319 __le32 flags;
1320 __le32 count; // Data xfer size
1321 __le32 retry_limit;
1322 __le32 cdb_size;
1323 u8 cdb[16];
1324 struct sgmap sg;
1328 * This and associated data structs are used by the
1329 * ioctl caller and are in cpu order.
1331 struct user_aac_srb
1333 u32 function;
1334 u32 channel;
1335 u32 id;
1336 u32 lun;
1337 u32 timeout;
1338 u32 flags;
1339 u32 count; // Data xfer size
1340 u32 retry_limit;
1341 u32 cdb_size;
1342 u8 cdb[16];
1343 struct user_sgmap sg;
1346 #define AAC_SENSE_BUFFERSIZE 30
1348 struct aac_srb_reply
1350 __le32 status;
1351 __le32 srb_status;
1352 __le32 scsi_status;
1353 __le32 data_xfer_length;
1354 __le32 sense_data_size;
1355 u8 sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1358 * SRB Flags
1360 #define SRB_NoDataXfer 0x0000
1361 #define SRB_DisableDisconnect 0x0004
1362 #define SRB_DisableSynchTransfer 0x0008
1363 #define SRB_BypassFrozenQueue 0x0010
1364 #define SRB_DisableAutosense 0x0020
1365 #define SRB_DataIn 0x0040
1366 #define SRB_DataOut 0x0080
1369 * SRB Functions - set in aac_srb->function
1371 #define SRBF_ExecuteScsi 0x0000
1372 #define SRBF_ClaimDevice 0x0001
1373 #define SRBF_IO_Control 0x0002
1374 #define SRBF_ReceiveEvent 0x0003
1375 #define SRBF_ReleaseQueue 0x0004
1376 #define SRBF_AttachDevice 0x0005
1377 #define SRBF_ReleaseDevice 0x0006
1378 #define SRBF_Shutdown 0x0007
1379 #define SRBF_Flush 0x0008
1380 #define SRBF_AbortCommand 0x0010
1381 #define SRBF_ReleaseRecovery 0x0011
1382 #define SRBF_ResetBus 0x0012
1383 #define SRBF_ResetDevice 0x0013
1384 #define SRBF_TerminateIO 0x0014
1385 #define SRBF_FlushQueue 0x0015
1386 #define SRBF_RemoveDevice 0x0016
1387 #define SRBF_DomainValidation 0x0017
1390 * SRB SCSI Status - set in aac_srb->scsi_status
1392 #define SRB_STATUS_PENDING 0x00
1393 #define SRB_STATUS_SUCCESS 0x01
1394 #define SRB_STATUS_ABORTED 0x02
1395 #define SRB_STATUS_ABORT_FAILED 0x03
1396 #define SRB_STATUS_ERROR 0x04
1397 #define SRB_STATUS_BUSY 0x05
1398 #define SRB_STATUS_INVALID_REQUEST 0x06
1399 #define SRB_STATUS_INVALID_PATH_ID 0x07
1400 #define SRB_STATUS_NO_DEVICE 0x08
1401 #define SRB_STATUS_TIMEOUT 0x09
1402 #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
1403 #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
1404 #define SRB_STATUS_MESSAGE_REJECTED 0x0D
1405 #define SRB_STATUS_BUS_RESET 0x0E
1406 #define SRB_STATUS_PARITY_ERROR 0x0F
1407 #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
1408 #define SRB_STATUS_NO_HBA 0x11
1409 #define SRB_STATUS_DATA_OVERRUN 0x12
1410 #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
1411 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
1412 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
1413 #define SRB_STATUS_REQUEST_FLUSHED 0x16
1414 #define SRB_STATUS_DELAYED_RETRY 0x17
1415 #define SRB_STATUS_INVALID_LUN 0x20
1416 #define SRB_STATUS_INVALID_TARGET_ID 0x21
1417 #define SRB_STATUS_BAD_FUNCTION 0x22
1418 #define SRB_STATUS_ERROR_RECOVERY 0x23
1419 #define SRB_STATUS_NOT_STARTED 0x24
1420 #define SRB_STATUS_NOT_IN_USE 0x30
1421 #define SRB_STATUS_FORCE_ABORT 0x31
1422 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL 0x32
1425 * Object-Server / Volume-Manager Dispatch Classes
1428 #define VM_Null 0
1429 #define VM_NameServe 1
1430 #define VM_ContainerConfig 2
1431 #define VM_Ioctl 3
1432 #define VM_FilesystemIoctl 4
1433 #define VM_CloseAll 5
1434 #define VM_CtBlockRead 6
1435 #define VM_CtBlockWrite 7
1436 #define VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
1437 #define VM_SliceBlockWrite 9
1438 #define VM_DriveBlockRead 10 /* raw access to physical devices */
1439 #define VM_DriveBlockWrite 11
1440 #define VM_EnclosureMgt 12 /* enclosure management */
1441 #define VM_Unused 13 /* used to be diskset management */
1442 #define VM_CtBlockVerify 14
1443 #define VM_CtPerf 15 /* performance test */
1444 #define VM_CtBlockRead64 16
1445 #define VM_CtBlockWrite64 17
1446 #define VM_CtBlockVerify64 18
1447 #define VM_CtHostRead64 19
1448 #define VM_CtHostWrite64 20
1449 #define VM_DrvErrTblLog 21
1450 #define VM_NameServe64 22
1452 #define MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */
1455 * Descriptive information (eg, vital stats)
1456 * that a content manager might report. The
1457 * FileArray filesystem component is one example
1458 * of a content manager. Raw mode might be
1459 * another.
1462 struct aac_fsinfo {
1463 __le32 fsTotalSize; /* Consumed by fs, incl. metadata */
1464 __le32 fsBlockSize;
1465 __le32 fsFragSize;
1466 __le32 fsMaxExtendSize;
1467 __le32 fsSpaceUnits;
1468 __le32 fsMaxNumFiles;
1469 __le32 fsNumFreeFiles;
1470 __le32 fsInodeDensity;
1471 }; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1473 union aac_contentinfo {
1474 struct aac_fsinfo filesys; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1478 * Query for Container Configuration Status
1481 #define CT_GET_CONFIG_STATUS 147
1482 struct aac_get_config_status {
1483 __le32 command; /* VM_ContainerConfig */
1484 __le32 type; /* CT_GET_CONFIG_STATUS */
1485 __le32 parm1;
1486 __le32 parm2;
1487 __le32 parm3;
1488 __le32 parm4;
1489 __le32 parm5;
1490 __le32 count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1493 #define CFACT_CONTINUE 0
1494 #define CFACT_PAUSE 1
1495 #define CFACT_ABORT 2
1496 struct aac_get_config_status_resp {
1497 __le32 response; /* ST_OK */
1498 __le32 dummy0;
1499 __le32 status; /* CT_OK */
1500 __le32 parm1;
1501 __le32 parm2;
1502 __le32 parm3;
1503 __le32 parm4;
1504 __le32 parm5;
1505 struct {
1506 __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1507 __le16 flags;
1508 __le16 count;
1509 } data;
1513 * Accept the configuration as-is
1516 #define CT_COMMIT_CONFIG 152
1518 struct aac_commit_config {
1519 __le32 command; /* VM_ContainerConfig */
1520 __le32 type; /* CT_COMMIT_CONFIG */
1524 * Query for Container Configuration Status
1527 #define CT_GET_CONTAINER_COUNT 4
1528 struct aac_get_container_count {
1529 __le32 command; /* VM_ContainerConfig */
1530 __le32 type; /* CT_GET_CONTAINER_COUNT */
1533 struct aac_get_container_count_resp {
1534 __le32 response; /* ST_OK */
1535 __le32 dummy0;
1536 __le32 MaxContainers;
1537 __le32 ContainerSwitchEntries;
1538 __le32 MaxPartitions;
1543 * Query for "mountable" objects, ie, objects that are typically
1544 * associated with a drive letter on the client (host) side.
1547 struct aac_mntent {
1548 __le32 oid;
1549 u8 name[16]; /* if applicable */
1550 struct creation_info create_info; /* if applicable */
1551 __le32 capacity;
1552 __le32 vol; /* substrate structure */
1553 __le32 obj; /* FT_FILESYS, etc. */
1554 __le32 state; /* unready for mounting,
1555 readonly, etc. */
1556 union aac_contentinfo fileinfo; /* Info specific to content
1557 manager (eg, filesystem) */
1558 __le32 altoid; /* != oid <==> snapshot or
1559 broken mirror exists */
1560 __le32 capacityhigh;
1563 #define FSCS_NOTCLEAN 0x0001 /* fsck is necessary before mounting */
1564 #define FSCS_READONLY 0x0002 /* possible result of broken mirror */
1565 #define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
1566 #define FSCS_NOT_READY 0x0008 /* Array spinning up to fulfil request */
1568 struct aac_query_mount {
1569 __le32 command;
1570 __le32 type;
1571 __le32 count;
1574 struct aac_mount {
1575 __le32 status;
1576 __le32 type; /* should be same as that requested */
1577 __le32 count;
1578 struct aac_mntent mnt[1];
1581 #define CT_READ_NAME 130
1582 struct aac_get_name {
1583 __le32 command; /* VM_ContainerConfig */
1584 __le32 type; /* CT_READ_NAME */
1585 __le32 cid;
1586 __le32 parm1;
1587 __le32 parm2;
1588 __le32 parm3;
1589 __le32 parm4;
1590 __le32 count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1593 struct aac_get_name_resp {
1594 __le32 dummy0;
1595 __le32 dummy1;
1596 __le32 status; /* CT_OK */
1597 __le32 parm1;
1598 __le32 parm2;
1599 __le32 parm3;
1600 __le32 parm4;
1601 __le32 parm5;
1602 u8 data[16];
1605 #define CT_CID_TO_32BITS_UID 165
1606 struct aac_get_serial {
1607 __le32 command; /* VM_ContainerConfig */
1608 __le32 type; /* CT_CID_TO_32BITS_UID */
1609 __le32 cid;
1612 struct aac_get_serial_resp {
1613 __le32 dummy0;
1614 __le32 dummy1;
1615 __le32 status; /* CT_OK */
1616 __le32 uid;
1620 * The following command is sent to shut down each container.
1623 struct aac_close {
1624 __le32 command;
1625 __le32 cid;
1628 struct aac_query_disk
1630 s32 cnum;
1631 s32 bus;
1632 s32 id;
1633 s32 lun;
1634 u32 valid;
1635 u32 locked;
1636 u32 deleted;
1637 s32 instance;
1638 s8 name[10];
1639 u32 unmapped;
1642 struct aac_delete_disk {
1643 u32 disknum;
1644 u32 cnum;
1647 struct fib_ioctl
1649 u32 fibctx;
1650 s32 wait;
1651 char __user *fib;
1654 struct revision
1656 u32 compat;
1657 __le32 version;
1658 __le32 build;
1663 * Ugly - non Linux like ioctl coding for back compat.
1666 #define CTL_CODE(function, method) ( \
1667 (4<< 16) | ((function) << 2) | (method) \
1671 * Define the method codes for how buffers are passed for I/O and FS
1672 * controls
1675 #define METHOD_BUFFERED 0
1676 #define METHOD_NEITHER 3
1679 * Filesystem ioctls
1682 #define FSACTL_SENDFIB CTL_CODE(2050, METHOD_BUFFERED)
1683 #define FSACTL_SEND_RAW_SRB CTL_CODE(2067, METHOD_BUFFERED)
1684 #define FSACTL_DELETE_DISK 0x163
1685 #define FSACTL_QUERY_DISK 0x173
1686 #define FSACTL_OPEN_GET_ADAPTER_FIB CTL_CODE(2100, METHOD_BUFFERED)
1687 #define FSACTL_GET_NEXT_ADAPTER_FIB CTL_CODE(2101, METHOD_BUFFERED)
1688 #define FSACTL_CLOSE_GET_ADAPTER_FIB CTL_CODE(2102, METHOD_BUFFERED)
1689 #define FSACTL_MINIPORT_REV_CHECK CTL_CODE(2107, METHOD_BUFFERED)
1690 #define FSACTL_GET_PCI_INFO CTL_CODE(2119, METHOD_BUFFERED)
1691 #define FSACTL_FORCE_DELETE_DISK CTL_CODE(2120, METHOD_NEITHER)
1692 #define FSACTL_GET_CONTAINERS 2131
1693 #define FSACTL_SEND_LARGE_FIB CTL_CODE(2138, METHOD_BUFFERED)
1696 struct aac_common
1699 * If this value is set to 1 then interrupt moderation will occur
1700 * in the base commuication support.
1702 u32 irq_mod;
1703 u32 peak_fibs;
1704 u32 zero_fibs;
1705 u32 fib_timeouts;
1707 * Statistical counters in debug mode
1709 #ifdef DBG
1710 u32 FibsSent;
1711 u32 FibRecved;
1712 u32 NoResponseSent;
1713 u32 NoResponseRecved;
1714 u32 AsyncSent;
1715 u32 AsyncRecved;
1716 u32 NormalSent;
1717 u32 NormalRecved;
1718 #endif
1721 extern struct aac_common aac_config;
1725 * The following macro is used when sending and receiving FIBs. It is
1726 * only used for debugging.
1729 #ifdef DBG
1730 #define FIB_COUNTER_INCREMENT(counter) (counter)++
1731 #else
1732 #define FIB_COUNTER_INCREMENT(counter)
1733 #endif
1736 * Adapter direct commands
1737 * Monitor/Kernel API
1740 #define BREAKPOINT_REQUEST 0x00000004
1741 #define INIT_STRUCT_BASE_ADDRESS 0x00000005
1742 #define READ_PERMANENT_PARAMETERS 0x0000000a
1743 #define WRITE_PERMANENT_PARAMETERS 0x0000000b
1744 #define HOST_CRASHING 0x0000000d
1745 #define SEND_SYNCHRONOUS_FIB 0x0000000c
1746 #define COMMAND_POST_RESULTS 0x00000014
1747 #define GET_ADAPTER_PROPERTIES 0x00000019
1748 #define GET_DRIVER_BUFFER_PROPERTIES 0x00000023
1749 #define RCV_TEMP_READINGS 0x00000025
1750 #define GET_COMM_PREFERRED_SETTINGS 0x00000026
1751 #define IOP_RESET 0x00001000
1752 #define IOP_RESET_ALWAYS 0x00001001
1753 #define RE_INIT_ADAPTER 0x000000ee
1756 * Adapter Status Register
1758 * Phase Staus mailbox is 32bits:
1759 * <31:16> = Phase Status
1760 * <15:0> = Phase
1762 * The adapter reports is present state through the phase. Only
1763 * a single phase should be ever be set. Each phase can have multiple
1764 * phase status bits to provide more detailed information about the
1765 * state of the board. Care should be taken to ensure that any phase
1766 * status bits that are set when changing the phase are also valid
1767 * for the new phase or be cleared out. Adapter software (monitor,
1768 * iflash, kernel) is responsible for properly maintining the phase
1769 * status mailbox when it is running.
1771 * MONKER_API Phases
1773 * Phases are bit oriented. It is NOT valid to have multiple bits set
1776 #define SELF_TEST_FAILED 0x00000004
1777 #define MONITOR_PANIC 0x00000020
1778 #define KERNEL_UP_AND_RUNNING 0x00000080
1779 #define KERNEL_PANIC 0x00000100
1782 * Doorbell bit defines
1785 #define DoorBellSyncCmdAvailable (1<<0) /* Host -> Adapter */
1786 #define DoorBellPrintfDone (1<<5) /* Host -> Adapter */
1787 #define DoorBellAdapterNormCmdReady (1<<1) /* Adapter -> Host */
1788 #define DoorBellAdapterNormRespReady (1<<2) /* Adapter -> Host */
1789 #define DoorBellAdapterNormCmdNotFull (1<<3) /* Adapter -> Host */
1790 #define DoorBellAdapterNormRespNotFull (1<<4) /* Adapter -> Host */
1791 #define DoorBellPrintfReady (1<<5) /* Adapter -> Host */
1794 * For FIB communication, we need all of the following things
1795 * to send back to the user.
1798 #define AifCmdEventNotify 1 /* Notify of event */
1799 #define AifEnConfigChange 3 /* Adapter configuration change */
1800 #define AifEnContainerChange 4 /* Container configuration change */
1801 #define AifEnDeviceFailure 5 /* SCSI device failed */
1802 #define AifEnEnclosureManagement 13 /* EM_DRIVE_* */
1803 #define EM_DRIVE_INSERTION 31
1804 #define EM_DRIVE_REMOVAL 32
1805 #define AifEnBatteryEvent 14 /* Change in Battery State */
1806 #define AifEnAddContainer 15 /* A new array was created */
1807 #define AifEnDeleteContainer 16 /* A container was deleted */
1808 #define AifEnExpEvent 23 /* Firmware Event Log */
1809 #define AifExeFirmwarePanic 3 /* Firmware Event Panic */
1810 #define AifHighPriority 3 /* Highest Priority Event */
1811 #define AifEnAddJBOD 30 /* JBOD created */
1812 #define AifEnDeleteJBOD 31 /* JBOD deleted */
1814 #define AifCmdJobProgress 2 /* Progress report */
1815 #define AifJobCtrZero 101 /* Array Zero progress */
1816 #define AifJobStsSuccess 1 /* Job completes */
1817 #define AifJobStsRunning 102 /* Job running */
1818 #define AifCmdAPIReport 3 /* Report from other user of API */
1819 #define AifCmdDriverNotify 4 /* Notify host driver of event */
1820 #define AifDenMorphComplete 200 /* A morph operation completed */
1821 #define AifDenVolumeExtendComplete 201 /* A volume extend completed */
1822 #define AifReqJobList 100 /* Gets back complete job list */
1823 #define AifReqJobsForCtr 101 /* Gets back jobs for specific container */
1824 #define AifReqJobsForScsi 102 /* Gets back jobs for specific SCSI device */
1825 #define AifReqJobReport 103 /* Gets back a specific job report or list of them */
1826 #define AifReqTerminateJob 104 /* Terminates job */
1827 #define AifReqSuspendJob 105 /* Suspends a job */
1828 #define AifReqResumeJob 106 /* Resumes a job */
1829 #define AifReqSendAPIReport 107 /* API generic report requests */
1830 #define AifReqAPIJobStart 108 /* Start a job from the API */
1831 #define AifReqAPIJobUpdate 109 /* Update a job report from the API */
1832 #define AifReqAPIJobFinish 110 /* Finish a job from the API */
1835 * Adapter Initiated FIB command structures. Start with the adapter
1836 * initiated FIBs that really come from the adapter, and get responded
1837 * to by the host.
1840 struct aac_aifcmd {
1841 __le32 command; /* Tell host what type of notify this is */
1842 __le32 seqnum; /* To allow ordering of reports (if necessary) */
1843 u8 data[1]; /* Undefined length (from kernel viewpoint) */
1847 * Convert capacity to cylinders
1848 * accounting for the fact capacity could be a 64 bit value
1851 static inline unsigned int cap_to_cyls(sector_t capacity, unsigned divisor)
1853 sector_div(capacity, divisor);
1854 return capacity;
1857 /* SCp.phase values */
1858 #define AAC_OWNER_MIDLEVEL 0x101
1859 #define AAC_OWNER_LOWLEVEL 0x102
1860 #define AAC_OWNER_ERROR_HANDLER 0x103
1861 #define AAC_OWNER_FIRMWARE 0x106
1863 const char *aac_driverinfo(struct Scsi_Host *);
1864 struct fib *aac_fib_alloc(struct aac_dev *dev);
1865 int aac_fib_setup(struct aac_dev *dev);
1866 void aac_fib_map_free(struct aac_dev *dev);
1867 void aac_fib_free(struct fib * context);
1868 void aac_fib_init(struct fib * context);
1869 void aac_printf(struct aac_dev *dev, u32 val);
1870 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1871 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1872 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1873 int aac_fib_complete(struct fib * context);
1874 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib_va->data)
1875 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1876 int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1877 int aac_get_containers(struct aac_dev *dev);
1878 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1879 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1880 #ifndef shost_to_class
1881 #define shost_to_class(shost) &shost->shost_dev
1882 #endif
1883 ssize_t aac_get_serial_number(struct device *dev, char *buf);
1884 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1885 int aac_rx_init(struct aac_dev *dev);
1886 int aac_rkt_init(struct aac_dev *dev);
1887 int aac_nark_init(struct aac_dev *dev);
1888 int aac_sa_init(struct aac_dev *dev);
1889 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);
1890 unsigned int aac_response_normal(struct aac_queue * q);
1891 unsigned int aac_command_normal(struct aac_queue * q);
1892 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1893 int aac_reset_adapter(struct aac_dev * dev, int forced);
1894 int aac_check_health(struct aac_dev * dev);
1895 int aac_command_thread(void *data);
1896 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1897 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1898 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1899 int aac_get_adapter_info(struct aac_dev* dev);
1900 int aac_send_shutdown(struct aac_dev *dev);
1901 int aac_probe_container(struct aac_dev *dev, int cid);
1902 int _aac_rx_init(struct aac_dev *dev);
1903 int aac_rx_select_comm(struct aac_dev *dev, int comm);
1904 int aac_rx_deliver_producer(struct fib * fib);
1905 char * get_container_type(unsigned type);
1906 extern int numacb;
1907 extern int acbsize;
1908 extern char aac_driver_version[];
1909 extern int startup_timeout;
1910 extern int aif_timeout;
1911 extern int expose_physicals;
1912 extern int aac_reset_devices;
1913 extern int aac_msi;
1914 extern int aac_commit;
1915 extern int update_interval;
1916 extern int check_interval;
1917 extern int aac_check_reset;