[SCSI] aacraid: Use scmd_ functions
[linux-2.6/cjktty.git] / drivers / scsi / aacraid / aacraid.h
blobfcf046ca9965c36993dc5718465a968a9afd9168
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]
9 /*------------------------------------------------------------------------------
10 * D E F I N E S
11 *----------------------------------------------------------------------------*/
13 #define MAXIMUM_NUM_CONTAINERS 32
15 #define AAC_NUM_MGT_FIB 8
16 #define AAC_NUM_IO_FIB (512 - AAC_NUM_MGT_FIB)
17 #define AAC_NUM_FIB (AAC_NUM_IO_FIB + AAC_NUM_MGT_FIB)
19 #define AAC_MAX_LUN (8)
21 #define AAC_MAX_HOSTPHYSMEMPAGES (0xfffff)
22 #define AAC_MAX_32BIT_SGBCOUNT ((unsigned short)256)
25 * These macros convert from physical channels to virtual channels
27 #define CONTAINER_CHANNEL (0)
28 #define CONTAINER_TO_CHANNEL(cont) (CONTAINER_CHANNEL)
29 #define CONTAINER_TO_ID(cont) (cont)
30 #define CONTAINER_TO_LUN(cont) (0)
32 #define aac_phys_to_logical(x) (x+1)
33 #define aac_logical_to_phys(x) (x?x-1:0)
35 /* #define AAC_DETAILED_STATUS_INFO */
37 struct diskparm
39 int heads;
40 int sectors;
41 int cylinders;
46 * DON'T CHANGE THE ORDER, this is set by the firmware
49 #define CT_NONE 0
50 #define CT_VOLUME 1
51 #define CT_MIRROR 2
52 #define CT_STRIPE 3
53 #define CT_RAID5 4
54 #define CT_SSRW 5
55 #define CT_SSRO 6
56 #define CT_MORPH 7
57 #define CT_PASSTHRU 8
58 #define CT_RAID4 9
59 #define CT_RAID10 10 /* stripe of mirror */
60 #define CT_RAID00 11 /* stripe of stripe */
61 #define CT_VOLUME_OF_MIRRORS 12 /* volume of mirror */
62 #define CT_PSEUDO_RAID 13 /* really raid4 */
63 #define CT_LAST_VOLUME_TYPE 14
64 #define CT_OK 218
67 * Types of objects addressable in some fashion by the client.
68 * This is a superset of those objects handled just by the filesystem
69 * and includes "raw" objects that an administrator would use to
70 * configure containers and filesystems.
73 #define FT_REG 1 /* regular file */
74 #define FT_DIR 2 /* directory */
75 #define FT_BLK 3 /* "block" device - reserved */
76 #define FT_CHR 4 /* "character special" device - reserved */
77 #define FT_LNK 5 /* symbolic link */
78 #define FT_SOCK 6 /* socket */
79 #define FT_FIFO 7 /* fifo */
80 #define FT_FILESYS 8 /* ADAPTEC's "FSA"(tm) filesystem */
81 #define FT_DRIVE 9 /* physical disk - addressable in scsi by bus/id/lun */
82 #define FT_SLICE 10 /* virtual disk - raw volume - slice */
83 #define FT_PARTITION 11 /* FSA partition - carved out of a slice - building block for containers */
84 #define FT_VOLUME 12 /* Container - Volume Set */
85 #define FT_STRIPE 13 /* Container - Stripe Set */
86 #define FT_MIRROR 14 /* Container - Mirror Set */
87 #define FT_RAID5 15 /* Container - Raid 5 Set */
88 #define FT_DATABASE 16 /* Storage object with "foreign" content manager */
91 * Host side memory scatter gather list
92 * Used by the adapter for read, write, and readdirplus operations
93 * We have separate 32 and 64 bit version because even
94 * on 64 bit systems not all cards support the 64 bit version
96 struct sgentry {
97 __le32 addr; /* 32-bit address. */
98 __le32 count; /* Length. */
101 struct user_sgentry {
102 u32 addr; /* 32-bit address. */
103 u32 count; /* Length. */
106 struct sgentry64 {
107 __le32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
108 __le32 count; /* Length. */
111 struct user_sgentry64 {
112 u32 addr[2]; /* 64-bit addr. 2 pieces for data alignment */
113 u32 count; /* Length. */
116 struct sgentryraw {
117 __le32 next; /* reserved for F/W use */
118 __le32 prev; /* reserved for F/W use */
119 __le32 addr[2];
120 __le32 count;
121 __le32 flags; /* reserved for F/W use */
124 struct user_sgentryraw {
125 u32 next; /* reserved for F/W use */
126 u32 prev; /* reserved for F/W use */
127 u32 addr[2];
128 u32 count;
129 u32 flags; /* reserved for F/W use */
133 * SGMAP
135 * This is the SGMAP structure for all commands that use
136 * 32-bit addressing.
139 struct sgmap {
140 __le32 count;
141 struct sgentry sg[1];
144 struct user_sgmap {
145 u32 count;
146 struct user_sgentry sg[1];
149 struct sgmap64 {
150 __le32 count;
151 struct sgentry64 sg[1];
154 struct user_sgmap64 {
155 u32 count;
156 struct user_sgentry64 sg[1];
159 struct sgmapraw {
160 __le32 count;
161 struct sgentryraw sg[1];
164 struct user_sgmapraw {
165 u32 count;
166 struct user_sgentryraw sg[1];
169 struct creation_info
171 u8 buildnum; /* e.g., 588 */
172 u8 usec; /* e.g., 588 */
173 u8 via; /* e.g., 1 = FSU,
174 * 2 = API
176 u8 year; /* e.g., 1997 = 97 */
177 __le32 date; /*
178 * unsigned Month :4; // 1 - 12
179 * unsigned Day :6; // 1 - 32
180 * unsigned Hour :6; // 0 - 23
181 * unsigned Minute :6; // 0 - 60
182 * unsigned Second :6; // 0 - 60
184 __le32 serial[2]; /* e.g., 0x1DEADB0BFAFAF001 */
189 * Define all the constants needed for the communication interface
193 * Define how many queue entries each queue will have and the total
194 * number of entries for the entire communication interface. Also define
195 * how many queues we support.
197 * This has to match the controller
200 #define NUMBER_OF_COMM_QUEUES 8 // 4 command; 4 response
201 #define HOST_HIGH_CMD_ENTRIES 4
202 #define HOST_NORM_CMD_ENTRIES 8
203 #define ADAP_HIGH_CMD_ENTRIES 4
204 #define ADAP_NORM_CMD_ENTRIES 512
205 #define HOST_HIGH_RESP_ENTRIES 4
206 #define HOST_NORM_RESP_ENTRIES 512
207 #define ADAP_HIGH_RESP_ENTRIES 4
208 #define ADAP_NORM_RESP_ENTRIES 8
210 #define TOTAL_QUEUE_ENTRIES \
211 (HOST_NORM_CMD_ENTRIES + HOST_HIGH_CMD_ENTRIES + ADAP_NORM_CMD_ENTRIES + ADAP_HIGH_CMD_ENTRIES + \
212 HOST_NORM_RESP_ENTRIES + HOST_HIGH_RESP_ENTRIES + ADAP_NORM_RESP_ENTRIES + ADAP_HIGH_RESP_ENTRIES)
216 * Set the queues on a 16 byte alignment
219 #define QUEUE_ALIGNMENT 16
222 * The queue headers define the Communication Region queues. These
223 * are physically contiguous and accessible by both the adapter and the
224 * host. Even though all queue headers are in the same contiguous block
225 * they will be represented as individual units in the data structures.
228 struct aac_entry {
229 __le32 size; /* Size in bytes of Fib which this QE points to */
230 __le32 addr; /* Receiver address of the FIB */
234 * The adapter assumes the ProducerIndex and ConsumerIndex are grouped
235 * adjacently and in that order.
238 struct aac_qhdr {
239 __le64 header_addr;/* Address to hand the adapter to access
240 to this queue head */
241 __le32 *producer; /* The producer index for this queue (host address) */
242 __le32 *consumer; /* The consumer index for this queue (host address) */
246 * Define all the events which the adapter would like to notify
247 * the host of.
250 #define HostNormCmdQue 1 /* Change in host normal priority command queue */
251 #define HostHighCmdQue 2 /* Change in host high priority command queue */
252 #define HostNormRespQue 3 /* Change in host normal priority response queue */
253 #define HostHighRespQue 4 /* Change in host high priority response queue */
254 #define AdapNormRespNotFull 5
255 #define AdapHighRespNotFull 6
256 #define AdapNormCmdNotFull 7
257 #define AdapHighCmdNotFull 8
258 #define SynchCommandComplete 9
259 #define AdapInternalError 0xfe /* The adapter detected an internal error shutting down */
262 * Define all the events the host wishes to notify the
263 * adapter of. The first four values much match the Qid the
264 * corresponding queue.
267 #define AdapNormCmdQue 2
268 #define AdapHighCmdQue 3
269 #define AdapNormRespQue 6
270 #define AdapHighRespQue 7
271 #define HostShutdown 8
272 #define HostPowerFail 9
273 #define FatalCommError 10
274 #define HostNormRespNotFull 11
275 #define HostHighRespNotFull 12
276 #define HostNormCmdNotFull 13
277 #define HostHighCmdNotFull 14
278 #define FastIo 15
279 #define AdapPrintfDone 16
282 * Define all the queues that the adapter and host use to communicate
283 * Number them to match the physical queue layout.
286 enum aac_queue_types {
287 HostNormCmdQueue = 0, /* Adapter to host normal priority command traffic */
288 HostHighCmdQueue, /* Adapter to host high priority command traffic */
289 AdapNormCmdQueue, /* Host to adapter normal priority command traffic */
290 AdapHighCmdQueue, /* Host to adapter high priority command traffic */
291 HostNormRespQueue, /* Adapter to host normal priority response traffic */
292 HostHighRespQueue, /* Adapter to host high priority response traffic */
293 AdapNormRespQueue, /* Host to adapter normal priority response traffic */
294 AdapHighRespQueue /* Host to adapter high priority response traffic */
298 * Assign type values to the FSA communication data structures
301 #define FIB_MAGIC 0x0001
304 * Define the priority levels the FSA communication routines support.
307 #define FsaNormal 1
310 * Define the FIB. The FIB is the where all the requested data and
311 * command information are put to the application on the FSA adapter.
314 struct aac_fibhdr {
315 __le32 XferState; /* Current transfer state for this CCB */
316 __le16 Command; /* Routing information for the destination */
317 u8 StructType; /* Type FIB */
318 u8 Flags; /* Flags for FIB */
319 __le16 Size; /* Size of this FIB in bytes */
320 __le16 SenderSize; /* Size of the FIB in the sender
321 (for response sizing) */
322 __le32 SenderFibAddress; /* Host defined data in the FIB */
323 __le32 ReceiverFibAddress;/* Logical address of this FIB for
324 the adapter */
325 u32 SenderData; /* Place holder for the sender to store data */
326 union {
327 struct {
328 __le32 _ReceiverTimeStart; /* Timestamp for
329 receipt of fib */
330 __le32 _ReceiverTimeDone; /* Timestamp for
331 completion of fib */
332 } _s;
333 } _u;
336 struct hw_fib {
337 struct aac_fibhdr header;
338 u8 data[512-sizeof(struct aac_fibhdr)]; // Command specific data
342 * FIB commands
345 #define TestCommandResponse 1
346 #define TestAdapterCommand 2
348 * Lowlevel and comm commands
350 #define LastTestCommand 100
351 #define ReinitHostNormCommandQueue 101
352 #define ReinitHostHighCommandQueue 102
353 #define ReinitHostHighRespQueue 103
354 #define ReinitHostNormRespQueue 104
355 #define ReinitAdapNormCommandQueue 105
356 #define ReinitAdapHighCommandQueue 107
357 #define ReinitAdapHighRespQueue 108
358 #define ReinitAdapNormRespQueue 109
359 #define InterfaceShutdown 110
360 #define DmaCommandFib 120
361 #define StartProfile 121
362 #define TermProfile 122
363 #define SpeedTest 123
364 #define TakeABreakPt 124
365 #define RequestPerfData 125
366 #define SetInterruptDefTimer 126
367 #define SetInterruptDefCount 127
368 #define GetInterruptDefStatus 128
369 #define LastCommCommand 129
371 * Filesystem commands
373 #define NuFileSystem 300
374 #define UFS 301
375 #define HostFileSystem 302
376 #define LastFileSystemCommand 303
378 * Container Commands
380 #define ContainerCommand 500
381 #define ContainerCommand64 501
382 #define ContainerRawIo 502
384 * Cluster Commands
386 #define ClusterCommand 550
388 * Scsi Port commands (scsi passthrough)
390 #define ScsiPortCommand 600
391 #define ScsiPortCommand64 601
393 * Misc house keeping and generic adapter initiated commands
395 #define AifRequest 700
396 #define CheckRevision 701
397 #define FsaHostShutdown 702
398 #define RequestAdapterInfo 703
399 #define IsAdapterPaused 704
400 #define SendHostTime 705
401 #define RequestSupplementAdapterInfo 706
402 #define LastMiscCommand 707
405 * Commands that will target the failover level on the FSA adapter
408 enum fib_xfer_state {
409 HostOwned = (1<<0),
410 AdapterOwned = (1<<1),
411 FibInitialized = (1<<2),
412 FibEmpty = (1<<3),
413 AllocatedFromPool = (1<<4),
414 SentFromHost = (1<<5),
415 SentFromAdapter = (1<<6),
416 ResponseExpected = (1<<7),
417 NoResponseExpected = (1<<8),
418 AdapterProcessed = (1<<9),
419 HostProcessed = (1<<10),
420 HighPriority = (1<<11),
421 NormalPriority = (1<<12),
422 Async = (1<<13),
423 AsyncIo = (1<<13), // rpbfix: remove with new regime
424 PageFileIo = (1<<14), // rpbfix: remove with new regime
425 ShutdownRequest = (1<<15),
426 LazyWrite = (1<<16), // rpbfix: remove with new regime
427 AdapterMicroFib = (1<<17),
428 BIOSFibPath = (1<<18),
429 FastResponseCapable = (1<<19),
430 ApiFib = (1<<20) // Its an API Fib.
434 * The following defines needs to be updated any time there is an
435 * incompatible change made to the aac_init structure.
438 #define ADAPTER_INIT_STRUCT_REVISION 3
439 #define ADAPTER_INIT_STRUCT_REVISION_4 4 // rocket science
441 struct aac_init
443 __le32 InitStructRevision;
444 __le32 MiniPortRevision;
445 __le32 fsrev;
446 __le32 CommHeaderAddress;
447 __le32 FastIoCommAreaAddress;
448 __le32 AdapterFibsPhysicalAddress;
449 __le32 AdapterFibsVirtualAddress;
450 __le32 AdapterFibsSize;
451 __le32 AdapterFibAlign;
452 __le32 printfbuf;
453 __le32 printfbufsiz;
454 __le32 HostPhysMemPages; /* number of 4k pages of host
455 physical memory */
456 __le32 HostElapsedSeconds; /* number of seconds since 1970. */
458 * ADAPTER_INIT_STRUCT_REVISION_4 begins here
460 __le32 InitFlags; /* flags for supported features */
461 #define INITFLAGS_NEW_COMM_SUPPORTED 0x00000001
462 __le32 MaxIoCommands; /* max outstanding commands */
463 __le32 MaxIoSize; /* largest I/O command */
464 __le32 MaxFibSize; /* largest FIB to adapter */
467 enum aac_log_level {
468 LOG_AAC_INIT = 10,
469 LOG_AAC_INFORMATIONAL = 20,
470 LOG_AAC_WARNING = 30,
471 LOG_AAC_LOW_ERROR = 40,
472 LOG_AAC_MEDIUM_ERROR = 50,
473 LOG_AAC_HIGH_ERROR = 60,
474 LOG_AAC_PANIC = 70,
475 LOG_AAC_DEBUG = 80,
476 LOG_AAC_WINDBG_PRINT = 90
479 #define FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT 0x030b
480 #define FSAFS_NTC_FIB_CONTEXT 0x030c
482 struct aac_dev;
483 struct fib;
485 struct adapter_ops
487 void (*adapter_interrupt)(struct aac_dev *dev);
488 void (*adapter_notify)(struct aac_dev *dev, u32 event);
489 void (*adapter_disable_int)(struct aac_dev *dev);
490 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);
491 int (*adapter_check_health)(struct aac_dev *dev);
492 int (*adapter_send)(struct fib * fib);
496 * Define which interrupt handler needs to be installed
499 struct aac_driver_ident
501 int (*init)(struct aac_dev *dev);
502 char * name;
503 char * vname;
504 char * model;
505 u16 channels;
506 int quirks;
509 * Some adapter firmware needs communication memory
510 * below 2gig. This tells the init function to set the
511 * dma mask such that fib memory will be allocated where the
512 * adapter firmware can get to it.
514 #define AAC_QUIRK_31BIT 0x0001
517 * Some adapter firmware, when the raid card's cache is turned off, can not
518 * split up scatter gathers in order to deal with the limits of the
519 * underlying CHIM. This limit is 34 scatter gather elements.
521 #define AAC_QUIRK_34SG 0x0002
524 * This adapter is a slave (no Firmware)
526 #define AAC_QUIRK_SLAVE 0x0004
529 * This adapter is a master.
531 #define AAC_QUIRK_MASTER 0x0008
534 * Some adapter firmware perform poorly when it must split up scatter gathers
535 * in order to deal with the limits of the underlying CHIM. This limit in this
536 * class of adapters is 17 scatter gather elements.
538 #define AAC_QUIRK_17SG 0x0010
541 * The adapter interface specs all queues to be located in the same
542 * physically contigous block. The host structure that defines the
543 * commuication queues will assume they are each a separate physically
544 * contigous memory region that will support them all being one big
545 * contigous block.
546 * There is a command and response queue for each level and direction of
547 * commuication. These regions are accessed by both the host and adapter.
550 struct aac_queue {
551 u64 logical; /*address we give the adapter */
552 struct aac_entry *base; /*system virtual address */
553 struct aac_qhdr headers; /*producer,consumer q headers*/
554 u32 entries; /*Number of queue entries */
555 wait_queue_head_t qfull; /*Event to wait on if q full */
556 wait_queue_head_t cmdready; /*Cmd ready from the adapter */
557 /* This is only valid for adapter to host command queues. */
558 spinlock_t *lock; /* Spinlock for this queue must take this lock before accessing the lock */
559 spinlock_t lockdata; /* Actual lock (used only on one side of the lock) */
560 struct list_head cmdq; /* A queue of FIBs which need to be prcessed by the FS thread. This is */
561 /* only valid for command queues which receive entries from the adapter. */
562 struct list_head pendingq; /* A queue of outstanding fib's to the adapter. */
563 u32 numpending; /* Number of entries on outstanding queue. */
564 struct aac_dev * dev; /* Back pointer to adapter structure */
568 * Message queues. The order here is important, see also the
569 * queue type ordering
572 struct aac_queue_block
574 struct aac_queue queue[8];
578 * SaP1 Message Unit Registers
581 struct sa_drawbridge_CSR {
582 /* Offset | Name */
583 __le32 reserved[10]; /* 00h-27h | Reserved */
584 u8 LUT_Offset; /* 28h | Lookup Table Offset */
585 u8 reserved1[3]; /* 29h-2bh | Reserved */
586 __le32 LUT_Data; /* 2ch | Looup Table Data */
587 __le32 reserved2[26]; /* 30h-97h | Reserved */
588 __le16 PRICLEARIRQ; /* 98h | Primary Clear Irq */
589 __le16 SECCLEARIRQ; /* 9ah | Secondary Clear Irq */
590 __le16 PRISETIRQ; /* 9ch | Primary Set Irq */
591 __le16 SECSETIRQ; /* 9eh | Secondary Set Irq */
592 __le16 PRICLEARIRQMASK;/* a0h | Primary Clear Irq Mask */
593 __le16 SECCLEARIRQMASK;/* a2h | Secondary Clear Irq Mask */
594 __le16 PRISETIRQMASK; /* a4h | Primary Set Irq Mask */
595 __le16 SECSETIRQMASK; /* a6h | Secondary Set Irq Mask */
596 __le32 MAILBOX0; /* a8h | Scratchpad 0 */
597 __le32 MAILBOX1; /* ach | Scratchpad 1 */
598 __le32 MAILBOX2; /* b0h | Scratchpad 2 */
599 __le32 MAILBOX3; /* b4h | Scratchpad 3 */
600 __le32 MAILBOX4; /* b8h | Scratchpad 4 */
601 __le32 MAILBOX5; /* bch | Scratchpad 5 */
602 __le32 MAILBOX6; /* c0h | Scratchpad 6 */
603 __le32 MAILBOX7; /* c4h | Scratchpad 7 */
604 __le32 ROM_Setup_Data; /* c8h | Rom Setup and Data */
605 __le32 ROM_Control_Addr;/* cch | Rom Control and Address */
606 __le32 reserved3[12]; /* d0h-ffh | reserved */
607 __le32 LUT[64]; /* 100h-1ffh | Lookup Table Entries */
610 #define Mailbox0 SaDbCSR.MAILBOX0
611 #define Mailbox1 SaDbCSR.MAILBOX1
612 #define Mailbox2 SaDbCSR.MAILBOX2
613 #define Mailbox3 SaDbCSR.MAILBOX3
614 #define Mailbox4 SaDbCSR.MAILBOX4
615 #define Mailbox5 SaDbCSR.MAILBOX5
616 #define Mailbox6 SaDbCSR.MAILBOX6
617 #define Mailbox7 SaDbCSR.MAILBOX7
619 #define DoorbellReg_p SaDbCSR.PRISETIRQ
620 #define DoorbellReg_s SaDbCSR.SECSETIRQ
621 #define DoorbellClrReg_p SaDbCSR.PRICLEARIRQ
624 #define DOORBELL_0 0x0001
625 #define DOORBELL_1 0x0002
626 #define DOORBELL_2 0x0004
627 #define DOORBELL_3 0x0008
628 #define DOORBELL_4 0x0010
629 #define DOORBELL_5 0x0020
630 #define DOORBELL_6 0x0040
633 #define PrintfReady DOORBELL_5
634 #define PrintfDone DOORBELL_5
636 struct sa_registers {
637 struct sa_drawbridge_CSR SaDbCSR; /* 98h - c4h */
641 #define Sa_MINIPORT_REVISION 1
643 #define sa_readw(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
644 #define sa_readl(AEP, CSR) readl(&((AEP)->regs.sa->CSR))
645 #define sa_writew(AEP, CSR, value) writew(value, &((AEP)->regs.sa->CSR))
646 #define sa_writel(AEP, CSR, value) writel(value, &((AEP)->regs.sa->CSR))
649 * Rx Message Unit Registers
652 struct rx_mu_registers {
653 /* Local | PCI*| Name */
654 __le32 ARSR; /* 1300h | 00h | APIC Register Select Register */
655 __le32 reserved0; /* 1304h | 04h | Reserved */
656 __le32 AWR; /* 1308h | 08h | APIC Window Register */
657 __le32 reserved1; /* 130Ch | 0Ch | Reserved */
658 __le32 IMRx[2]; /* 1310h | 10h | Inbound Message Registers */
659 __le32 OMRx[2]; /* 1318h | 18h | Outbound Message Registers */
660 __le32 IDR; /* 1320h | 20h | Inbound Doorbell Register */
661 __le32 IISR; /* 1324h | 24h | Inbound Interrupt
662 Status Register */
663 __le32 IIMR; /* 1328h | 28h | Inbound Interrupt
664 Mask Register */
665 __le32 ODR; /* 132Ch | 2Ch | Outbound Doorbell Register */
666 __le32 OISR; /* 1330h | 30h | Outbound Interrupt
667 Status Register */
668 __le32 OIMR; /* 1334h | 34h | Outbound Interrupt
669 Mask Register */
670 __le32 reserved2; /* 1338h | 38h | Reserved */
671 __le32 reserved3; /* 133Ch | 3Ch | Reserved */
672 __le32 InboundQueue;/* 1340h | 40h | Inbound Queue Port relative to firmware */
673 __le32 OutboundQueue;/*1344h | 44h | Outbound Queue Port relative to firmware */
674 /* * Must access through ATU Inbound
675 Translation Window */
678 struct rx_inbound {
679 __le32 Mailbox[8];
682 #define InboundMailbox0 IndexRegs.Mailbox[0]
683 #define InboundMailbox1 IndexRegs.Mailbox[1]
684 #define InboundMailbox2 IndexRegs.Mailbox[2]
685 #define InboundMailbox3 IndexRegs.Mailbox[3]
686 #define InboundMailbox4 IndexRegs.Mailbox[4]
687 #define InboundMailbox5 IndexRegs.Mailbox[5]
688 #define InboundMailbox6 IndexRegs.Mailbox[6]
690 #define INBOUNDDOORBELL_0 0x00000001
691 #define INBOUNDDOORBELL_1 0x00000002
692 #define INBOUNDDOORBELL_2 0x00000004
693 #define INBOUNDDOORBELL_3 0x00000008
694 #define INBOUNDDOORBELL_4 0x00000010
695 #define INBOUNDDOORBELL_5 0x00000020
696 #define INBOUNDDOORBELL_6 0x00000040
698 #define OUTBOUNDDOORBELL_0 0x00000001
699 #define OUTBOUNDDOORBELL_1 0x00000002
700 #define OUTBOUNDDOORBELL_2 0x00000004
701 #define OUTBOUNDDOORBELL_3 0x00000008
702 #define OUTBOUNDDOORBELL_4 0x00000010
704 #define InboundDoorbellReg MUnit.IDR
705 #define OutboundDoorbellReg MUnit.ODR
707 struct rx_registers {
708 struct rx_mu_registers MUnit; /* 1300h - 1344h */
709 __le32 reserved1[2]; /* 1348h - 134ch */
710 struct rx_inbound IndexRegs;
713 #define rx_readb(AEP, CSR) readb(&((AEP)->regs.rx->CSR))
714 #define rx_readl(AEP, CSR) readl(&((AEP)->regs.rx->CSR))
715 #define rx_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rx->CSR))
716 #define rx_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rx->CSR))
719 * Rkt Message Unit Registers (same as Rx, except a larger reserve region)
722 #define rkt_mu_registers rx_mu_registers
723 #define rkt_inbound rx_inbound
725 struct rkt_registers {
726 struct rkt_mu_registers MUnit; /* 1300h - 1344h */
727 __le32 reserved1[1006]; /* 1348h - 22fch */
728 struct rkt_inbound IndexRegs; /* 2300h - */
731 #define rkt_readb(AEP, CSR) readb(&((AEP)->regs.rkt->CSR))
732 #define rkt_readl(AEP, CSR) readl(&((AEP)->regs.rkt->CSR))
733 #define rkt_writeb(AEP, CSR, value) writeb(value, &((AEP)->regs.rkt->CSR))
734 #define rkt_writel(AEP, CSR, value) writel(value, &((AEP)->regs.rkt->CSR))
736 typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
738 struct aac_fib_context {
739 s16 type; // used for verification of structure
740 s16 size;
741 u32 unique; // unique value representing this context
742 ulong jiffies; // used for cleanup - dmb changed to ulong
743 struct list_head next; // used to link context's into a linked list
744 struct semaphore wait_sem; // this is used to wait for the next fib to arrive.
745 int wait; // Set to true when thread is in WaitForSingleObject
746 unsigned long count; // total number of FIBs on FibList
747 struct list_head fib_list; // this holds fibs and their attachd hw_fibs
750 struct sense_data {
751 u8 error_code; /* 70h (current errors), 71h(deferred errors) */
752 u8 valid:1; /* A valid bit of one indicates that the information */
753 /* field contains valid information as defined in the
754 * SCSI-2 Standard.
756 u8 segment_number; /* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
757 u8 sense_key:4; /* Sense Key */
758 u8 reserved:1;
759 u8 ILI:1; /* Incorrect Length Indicator */
760 u8 EOM:1; /* End Of Medium - reserved for random access devices */
761 u8 filemark:1; /* Filemark - reserved for random access devices */
763 u8 information[4]; /* for direct-access devices, contains the unsigned
764 * logical block address or residue associated with
765 * the sense key
767 u8 add_sense_len; /* number of additional sense bytes to follow this field */
768 u8 cmnd_info[4]; /* not used */
769 u8 ASC; /* Additional Sense Code */
770 u8 ASCQ; /* Additional Sense Code Qualifier */
771 u8 FRUC; /* Field Replaceable Unit Code - not used */
772 u8 bit_ptr:3; /* indicates which byte of the CDB or parameter data
773 * was in error
775 u8 BPV:1; /* bit pointer valid (BPV): 1- indicates that
776 * the bit_ptr field has valid value
778 u8 reserved2:2;
779 u8 CD:1; /* command data bit: 1- illegal parameter in CDB.
780 * 0- illegal parameter in data.
782 u8 SKSV:1;
783 u8 field_ptr[2]; /* byte of the CDB or parameter data in error */
786 struct fsa_dev_info {
787 u64 last;
788 u64 size;
789 u32 type;
790 u32 config_waiting_on;
791 u16 queue_depth;
792 u8 config_needed;
793 u8 valid;
794 u8 ro;
795 u8 locked;
796 u8 deleted;
797 char devname[8];
798 struct sense_data sense_data;
801 struct fib {
802 void *next; /* this is used by the allocator */
803 s16 type;
804 s16 size;
806 * The Adapter that this I/O is destined for.
808 struct aac_dev *dev;
810 * This is the event the sendfib routine will wait on if the
811 * caller did not pass one and this is synch io.
813 struct semaphore event_wait;
814 spinlock_t event_lock;
816 u32 done; /* gets set to 1 when fib is complete */
817 fib_callback callback;
818 void *callback_data;
819 u32 flags; // u32 dmb was ulong
821 * The following is used to put this fib context onto the
822 * Outstanding I/O queue.
824 struct list_head queue;
826 * And for the internal issue/reply queues (we may be able
827 * to merge these two)
829 struct list_head fiblink;
830 void *data;
831 struct hw_fib *hw_fib; /* Actual shared object */
832 dma_addr_t hw_fib_pa; /* physical address of hw_fib*/
836 * Adapter Information Block
838 * This is returned by the RequestAdapterInfo block
841 struct aac_adapter_info
843 __le32 platform;
844 __le32 cpu;
845 __le32 subcpu;
846 __le32 clock;
847 __le32 execmem;
848 __le32 buffermem;
849 __le32 totalmem;
850 __le32 kernelrev;
851 __le32 kernelbuild;
852 __le32 monitorrev;
853 __le32 monitorbuild;
854 __le32 hwrev;
855 __le32 hwbuild;
856 __le32 biosrev;
857 __le32 biosbuild;
858 __le32 cluster;
859 __le32 clusterchannelmask;
860 __le32 serial[2];
861 __le32 battery;
862 __le32 options;
863 __le32 OEM;
866 struct aac_supplement_adapter_info
868 u8 AdapterTypeText[17+1];
869 u8 Pad[2];
870 __le32 FlashMemoryByteSize;
871 __le32 FlashImageId;
872 __le32 MaxNumberPorts;
873 __le32 Version;
874 __le32 FeatureBits;
875 u8 SlotNumber;
876 u8 ReservedPad0[0];
877 u8 BuildDate[12];
878 __le32 CurrentNumberPorts;
879 __le32 ReservedGrowth[24];
881 #define AAC_FEATURE_FALCON 0x00000010
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 struct fib *timeout_fib;
969 spinlock_t fib_lock;
971 struct aac_queue_block *queues;
973 * The user API will use an IOCTL to register itself to receive
974 * FIBs from the adapter. The following list is used to keep
975 * track of all the threads that have requested these FIBs. The
976 * mutex is used to synchronize access to all data associated
977 * with the adapter fibs.
979 struct list_head fib_list;
981 struct adapter_ops a_ops;
982 unsigned long fsrev; /* Main driver's revision number */
984 unsigned base_size; /* Size of mapped in region */
985 struct aac_init *init; /* Holds initialization info to communicate with adapter */
986 dma_addr_t init_pa; /* Holds physical address of the init struct */
988 struct pci_dev *pdev; /* Our PCI interface */
989 void * printfbuf; /* pointer to buffer used for printf's from the adapter */
990 void * comm_addr; /* Base address of Comm area */
991 dma_addr_t comm_phys; /* Physical Address of Comm area */
992 size_t comm_size;
994 struct Scsi_Host *scsi_host_ptr;
995 int maximum_num_containers;
996 int maximum_num_physicals;
997 int maximum_num_channels;
998 struct fsa_dev_info *fsa_dev;
999 struct task_struct *thread;
1000 int cardtype;
1003 * The following is the device specific extension.
1005 #if (!defined(AAC_MIN_FOOTPRINT_SIZE))
1006 # define AAC_MIN_FOOTPRINT_SIZE 8192
1007 #endif
1008 union
1010 struct sa_registers __iomem *sa;
1011 struct rx_registers __iomem *rx;
1012 struct rkt_registers __iomem *rkt;
1013 } regs;
1014 u32 OIMR; /* Mask Register Cache */
1016 * AIF thread states
1018 u32 aif_thread;
1019 struct aac_adapter_info adapter_info;
1020 struct aac_supplement_adapter_info supplement_adapter_info;
1021 /* These are in adapter info but they are in the io flow so
1022 * lets break them out so we don't have to do an AND to check them
1024 u8 nondasd_support;
1025 u8 dac_support;
1026 u8 raid_scsi_mode;
1027 u8 new_comm_interface;
1028 /* macro side-effects BEWARE */
1029 # define raw_io_interface \
1030 init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1031 u8 raw_io_64;
1032 u8 printf_enabled;
1035 #define aac_adapter_interrupt(dev) \
1036 (dev)->a_ops.adapter_interrupt(dev)
1038 #define aac_adapter_notify(dev, event) \
1039 (dev)->a_ops.adapter_notify(dev, event)
1041 #define aac_adapter_disable_int(dev) \
1042 (dev)->a_ops.adapter_disable_int(dev)
1044 #define aac_adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4) \
1045 (dev)->a_ops.adapter_sync_cmd(dev, command, p1, p2, p3, p4, p5, p6, status, r1, r2, r3, r4)
1047 #define aac_adapter_check_health(dev) \
1048 (dev)->a_ops.adapter_check_health(dev)
1050 #define aac_adapter_send(fib) \
1051 ((fib)->dev)->a_ops.adapter_send(fib)
1053 #define FIB_CONTEXT_FLAG_TIMED_OUT (0x00000001)
1056 * Define the command values
1059 #define Null 0
1060 #define GetAttributes 1
1061 #define SetAttributes 2
1062 #define Lookup 3
1063 #define ReadLink 4
1064 #define Read 5
1065 #define Write 6
1066 #define Create 7
1067 #define MakeDirectory 8
1068 #define SymbolicLink 9
1069 #define MakeNode 10
1070 #define Removex 11
1071 #define RemoveDirectoryx 12
1072 #define Rename 13
1073 #define Link 14
1074 #define ReadDirectory 15
1075 #define ReadDirectoryPlus 16
1076 #define FileSystemStatus 17
1077 #define FileSystemInfo 18
1078 #define PathConfigure 19
1079 #define Commit 20
1080 #define Mount 21
1081 #define UnMount 22
1082 #define Newfs 23
1083 #define FsCheck 24
1084 #define FsSync 25
1085 #define SimReadWrite 26
1086 #define SetFileSystemStatus 27
1087 #define BlockRead 28
1088 #define BlockWrite 29
1089 #define NvramIoctl 30
1090 #define FsSyncWait 31
1091 #define ClearArchiveBit 32
1092 #define SetAcl 33
1093 #define GetAcl 34
1094 #define AssignAcl 35
1095 #define FaultInsertion 36 /* Fault Insertion Command */
1096 #define CrazyCache 37 /* Crazycache */
1098 #define MAX_FSACOMMAND_NUM 38
1102 * Define the status returns. These are very unixlike although
1103 * most are not in fact used
1106 #define ST_OK 0
1107 #define ST_PERM 1
1108 #define ST_NOENT 2
1109 #define ST_IO 5
1110 #define ST_NXIO 6
1111 #define ST_E2BIG 7
1112 #define ST_ACCES 13
1113 #define ST_EXIST 17
1114 #define ST_XDEV 18
1115 #define ST_NODEV 19
1116 #define ST_NOTDIR 20
1117 #define ST_ISDIR 21
1118 #define ST_INVAL 22
1119 #define ST_FBIG 27
1120 #define ST_NOSPC 28
1121 #define ST_ROFS 30
1122 #define ST_MLINK 31
1123 #define ST_WOULDBLOCK 35
1124 #define ST_NAMETOOLONG 63
1125 #define ST_NOTEMPTY 66
1126 #define ST_DQUOT 69
1127 #define ST_STALE 70
1128 #define ST_REMOTE 71
1129 #define ST_BADHANDLE 10001
1130 #define ST_NOT_SYNC 10002
1131 #define ST_BAD_COOKIE 10003
1132 #define ST_NOTSUPP 10004
1133 #define ST_TOOSMALL 10005
1134 #define ST_SERVERFAULT 10006
1135 #define ST_BADTYPE 10007
1136 #define ST_JUKEBOX 10008
1137 #define ST_NOTMOUNTED 10009
1138 #define ST_MAINTMODE 10010
1139 #define ST_STALEACL 10011
1142 * On writes how does the client want the data written.
1145 #define CACHE_CSTABLE 1
1146 #define CACHE_UNSTABLE 2
1149 * Lets the client know at which level the data was commited on
1150 * a write request
1153 #define CMFILE_SYNCH_NVRAM 1
1154 #define CMDATA_SYNCH_NVRAM 2
1155 #define CMFILE_SYNCH 3
1156 #define CMDATA_SYNCH 4
1157 #define CMUNSTABLE 5
1159 struct aac_read
1161 __le32 command;
1162 __le32 cid;
1163 __le32 block;
1164 __le32 count;
1165 struct sgmap sg; // Must be last in struct because it is variable
1168 struct aac_read64
1170 __le32 command;
1171 __le16 cid;
1172 __le16 sector_count;
1173 __le32 block;
1174 __le16 pad;
1175 __le16 flags;
1176 struct sgmap64 sg; // Must be last in struct because it is variable
1179 struct aac_read_reply
1181 __le32 status;
1182 __le32 count;
1185 struct aac_write
1187 __le32 command;
1188 __le32 cid;
1189 __le32 block;
1190 __le32 count;
1191 __le32 stable; // Not used
1192 struct sgmap sg; // Must be last in struct because it is variable
1195 struct aac_write64
1197 __le32 command;
1198 __le16 cid;
1199 __le16 sector_count;
1200 __le32 block;
1201 __le16 pad;
1202 __le16 flags;
1203 struct sgmap64 sg; // Must be last in struct because it is variable
1205 struct aac_write_reply
1207 __le32 status;
1208 __le32 count;
1209 __le32 committed;
1212 struct aac_raw_io
1214 __le32 block[2];
1215 __le32 count;
1216 __le16 cid;
1217 __le16 flags; /* 00 W, 01 R */
1218 __le16 bpTotal; /* reserved for F/W use */
1219 __le16 bpComplete; /* reserved for F/W use */
1220 struct sgmapraw sg;
1223 #define CT_FLUSH_CACHE 129
1224 struct aac_synchronize {
1225 __le32 command; /* VM_ContainerConfig */
1226 __le32 type; /* CT_FLUSH_CACHE */
1227 __le32 cid;
1228 __le32 parm1;
1229 __le32 parm2;
1230 __le32 parm3;
1231 __le32 parm4;
1232 __le32 count; /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1235 struct aac_synchronize_reply {
1236 __le32 dummy0;
1237 __le32 dummy1;
1238 __le32 status; /* CT_OK */
1239 __le32 parm1;
1240 __le32 parm2;
1241 __le32 parm3;
1242 __le32 parm4;
1243 __le32 parm5;
1244 u8 data[16];
1247 struct aac_srb
1249 __le32 function;
1250 __le32 channel;
1251 __le32 id;
1252 __le32 lun;
1253 __le32 timeout;
1254 __le32 flags;
1255 __le32 count; // Data xfer size
1256 __le32 retry_limit;
1257 __le32 cdb_size;
1258 u8 cdb[16];
1259 struct sgmap sg;
1263 * This and associated data structs are used by the
1264 * ioctl caller and are in cpu order.
1266 struct user_aac_srb
1268 u32 function;
1269 u32 channel;
1270 u32 id;
1271 u32 lun;
1272 u32 timeout;
1273 u32 flags;
1274 u32 count; // Data xfer size
1275 u32 retry_limit;
1276 u32 cdb_size;
1277 u8 cdb[16];
1278 struct user_sgmap sg;
1281 #define AAC_SENSE_BUFFERSIZE 30
1283 struct aac_srb_reply
1285 __le32 status;
1286 __le32 srb_status;
1287 __le32 scsi_status;
1288 __le32 data_xfer_length;
1289 __le32 sense_data_size;
1290 u8 sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1293 * SRB Flags
1295 #define SRB_NoDataXfer 0x0000
1296 #define SRB_DisableDisconnect 0x0004
1297 #define SRB_DisableSynchTransfer 0x0008
1298 #define SRB_BypassFrozenQueue 0x0010
1299 #define SRB_DisableAutosense 0x0020
1300 #define SRB_DataIn 0x0040
1301 #define SRB_DataOut 0x0080
1304 * SRB Functions - set in aac_srb->function
1306 #define SRBF_ExecuteScsi 0x0000
1307 #define SRBF_ClaimDevice 0x0001
1308 #define SRBF_IO_Control 0x0002
1309 #define SRBF_ReceiveEvent 0x0003
1310 #define SRBF_ReleaseQueue 0x0004
1311 #define SRBF_AttachDevice 0x0005
1312 #define SRBF_ReleaseDevice 0x0006
1313 #define SRBF_Shutdown 0x0007
1314 #define SRBF_Flush 0x0008
1315 #define SRBF_AbortCommand 0x0010
1316 #define SRBF_ReleaseRecovery 0x0011
1317 #define SRBF_ResetBus 0x0012
1318 #define SRBF_ResetDevice 0x0013
1319 #define SRBF_TerminateIO 0x0014
1320 #define SRBF_FlushQueue 0x0015
1321 #define SRBF_RemoveDevice 0x0016
1322 #define SRBF_DomainValidation 0x0017
1325 * SRB SCSI Status - set in aac_srb->scsi_status
1327 #define SRB_STATUS_PENDING 0x00
1328 #define SRB_STATUS_SUCCESS 0x01
1329 #define SRB_STATUS_ABORTED 0x02
1330 #define SRB_STATUS_ABORT_FAILED 0x03
1331 #define SRB_STATUS_ERROR 0x04
1332 #define SRB_STATUS_BUSY 0x05
1333 #define SRB_STATUS_INVALID_REQUEST 0x06
1334 #define SRB_STATUS_INVALID_PATH_ID 0x07
1335 #define SRB_STATUS_NO_DEVICE 0x08
1336 #define SRB_STATUS_TIMEOUT 0x09
1337 #define SRB_STATUS_SELECTION_TIMEOUT 0x0A
1338 #define SRB_STATUS_COMMAND_TIMEOUT 0x0B
1339 #define SRB_STATUS_MESSAGE_REJECTED 0x0D
1340 #define SRB_STATUS_BUS_RESET 0x0E
1341 #define SRB_STATUS_PARITY_ERROR 0x0F
1342 #define SRB_STATUS_REQUEST_SENSE_FAILED 0x10
1343 #define SRB_STATUS_NO_HBA 0x11
1344 #define SRB_STATUS_DATA_OVERRUN 0x12
1345 #define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13
1346 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14
1347 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15
1348 #define SRB_STATUS_REQUEST_FLUSHED 0x16
1349 #define SRB_STATUS_DELAYED_RETRY 0x17
1350 #define SRB_STATUS_INVALID_LUN 0x20
1351 #define SRB_STATUS_INVALID_TARGET_ID 0x21
1352 #define SRB_STATUS_BAD_FUNCTION 0x22
1353 #define SRB_STATUS_ERROR_RECOVERY 0x23
1354 #define SRB_STATUS_NOT_STARTED 0x24
1355 #define SRB_STATUS_NOT_IN_USE 0x30
1356 #define SRB_STATUS_FORCE_ABORT 0x31
1357 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL 0x32
1360 * Object-Server / Volume-Manager Dispatch Classes
1363 #define VM_Null 0
1364 #define VM_NameServe 1
1365 #define VM_ContainerConfig 2
1366 #define VM_Ioctl 3
1367 #define VM_FilesystemIoctl 4
1368 #define VM_CloseAll 5
1369 #define VM_CtBlockRead 6
1370 #define VM_CtBlockWrite 7
1371 #define VM_SliceBlockRead 8 /* raw access to configured "storage objects" */
1372 #define VM_SliceBlockWrite 9
1373 #define VM_DriveBlockRead 10 /* raw access to physical devices */
1374 #define VM_DriveBlockWrite 11
1375 #define VM_EnclosureMgt 12 /* enclosure management */
1376 #define VM_Unused 13 /* used to be diskset management */
1377 #define VM_CtBlockVerify 14
1378 #define VM_CtPerf 15 /* performance test */
1379 #define VM_CtBlockRead64 16
1380 #define VM_CtBlockWrite64 17
1381 #define VM_CtBlockVerify64 18
1382 #define VM_CtHostRead64 19
1383 #define VM_CtHostWrite64 20
1384 #define VM_DrvErrTblLog 21
1385 #define VM_NameServe64 22
1387 #define MAX_VMCOMMAND_NUM 23 /* used for sizing stats array - leave last */
1390 * Descriptive information (eg, vital stats)
1391 * that a content manager might report. The
1392 * FileArray filesystem component is one example
1393 * of a content manager. Raw mode might be
1394 * another.
1397 struct aac_fsinfo {
1398 __le32 fsTotalSize; /* Consumed by fs, incl. metadata */
1399 __le32 fsBlockSize;
1400 __le32 fsFragSize;
1401 __le32 fsMaxExtendSize;
1402 __le32 fsSpaceUnits;
1403 __le32 fsMaxNumFiles;
1404 __le32 fsNumFreeFiles;
1405 __le32 fsInodeDensity;
1406 }; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1408 union aac_contentinfo {
1409 struct aac_fsinfo filesys; /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1413 * Query for Container Configuration Status
1416 #define CT_GET_CONFIG_STATUS 147
1417 struct aac_get_config_status {
1418 __le32 command; /* VM_ContainerConfig */
1419 __le32 type; /* CT_GET_CONFIG_STATUS */
1420 __le32 parm1;
1421 __le32 parm2;
1422 __le32 parm3;
1423 __le32 parm4;
1424 __le32 parm5;
1425 __le32 count; /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1428 #define CFACT_CONTINUE 0
1429 #define CFACT_PAUSE 1
1430 #define CFACT_ABORT 2
1431 struct aac_get_config_status_resp {
1432 __le32 response; /* ST_OK */
1433 __le32 dummy0;
1434 __le32 status; /* CT_OK */
1435 __le32 parm1;
1436 __le32 parm2;
1437 __le32 parm3;
1438 __le32 parm4;
1439 __le32 parm5;
1440 struct {
1441 __le32 action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1442 __le16 flags;
1443 __le16 count;
1444 } data;
1448 * Accept the configuration as-is
1451 #define CT_COMMIT_CONFIG 152
1453 struct aac_commit_config {
1454 __le32 command; /* VM_ContainerConfig */
1455 __le32 type; /* CT_COMMIT_CONFIG */
1459 * Query for Container Configuration Status
1462 #define CT_GET_CONTAINER_COUNT 4
1463 struct aac_get_container_count {
1464 __le32 command; /* VM_ContainerConfig */
1465 __le32 type; /* CT_GET_CONTAINER_COUNT */
1468 struct aac_get_container_count_resp {
1469 __le32 response; /* ST_OK */
1470 __le32 dummy0;
1471 __le32 MaxContainers;
1472 __le32 ContainerSwitchEntries;
1473 __le32 MaxPartitions;
1478 * Query for "mountable" objects, ie, objects that are typically
1479 * associated with a drive letter on the client (host) side.
1482 struct aac_mntent {
1483 __le32 oid;
1484 u8 name[16]; /* if applicable */
1485 struct creation_info create_info; /* if applicable */
1486 __le32 capacity;
1487 __le32 vol; /* substrate structure */
1488 __le32 obj; /* FT_FILESYS,
1489 FT_DATABASE, etc. */
1490 __le32 state; /* unready for mounting,
1491 readonly, etc. */
1492 union aac_contentinfo fileinfo; /* Info specific to content
1493 manager (eg, filesystem) */
1494 __le32 altoid; /* != oid <==> snapshot or
1495 broken mirror exists */
1496 __le32 capacityhigh;
1499 #define FSCS_NOTCLEAN 0x0001 /* fsck is neccessary before mounting */
1500 #define FSCS_READONLY 0x0002 /* possible result of broken mirror */
1501 #define FSCS_HIDDEN 0x0004 /* should be ignored - set during a clear */
1503 struct aac_query_mount {
1504 __le32 command;
1505 __le32 type;
1506 __le32 count;
1509 struct aac_mount {
1510 __le32 status;
1511 __le32 type; /* should be same as that requested */
1512 __le32 count;
1513 struct aac_mntent mnt[1];
1516 #define CT_READ_NAME 130
1517 struct aac_get_name {
1518 __le32 command; /* VM_ContainerConfig */
1519 __le32 type; /* CT_READ_NAME */
1520 __le32 cid;
1521 __le32 parm1;
1522 __le32 parm2;
1523 __le32 parm3;
1524 __le32 parm4;
1525 __le32 count; /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1528 #define CT_OK 218
1529 struct aac_get_name_resp {
1530 __le32 dummy0;
1531 __le32 dummy1;
1532 __le32 status; /* CT_OK */
1533 __le32 parm1;
1534 __le32 parm2;
1535 __le32 parm3;
1536 __le32 parm4;
1537 __le32 parm5;
1538 u8 data[16];
1542 * The following command is sent to shut down each container.
1545 struct aac_close {
1546 __le32 command;
1547 __le32 cid;
1550 struct aac_query_disk
1552 s32 cnum;
1553 s32 bus;
1554 s32 id;
1555 s32 lun;
1556 u32 valid;
1557 u32 locked;
1558 u32 deleted;
1559 s32 instance;
1560 s8 name[10];
1561 u32 unmapped;
1564 struct aac_delete_disk {
1565 u32 disknum;
1566 u32 cnum;
1569 struct fib_ioctl
1571 u32 fibctx;
1572 s32 wait;
1573 char __user *fib;
1576 struct revision
1578 u32 compat;
1579 __le32 version;
1580 __le32 build;
1585 * Ugly - non Linux like ioctl coding for back compat.
1588 #define CTL_CODE(function, method) ( \
1589 (4<< 16) | ((function) << 2) | (method) \
1593 * Define the method codes for how buffers are passed for I/O and FS
1594 * controls
1597 #define METHOD_BUFFERED 0
1598 #define METHOD_NEITHER 3
1601 * Filesystem ioctls
1604 #define FSACTL_SENDFIB CTL_CODE(2050, METHOD_BUFFERED)
1605 #define FSACTL_SEND_RAW_SRB CTL_CODE(2067, METHOD_BUFFERED)
1606 #define FSACTL_DELETE_DISK 0x163
1607 #define FSACTL_QUERY_DISK 0x173
1608 #define FSACTL_OPEN_GET_ADAPTER_FIB CTL_CODE(2100, METHOD_BUFFERED)
1609 #define FSACTL_GET_NEXT_ADAPTER_FIB CTL_CODE(2101, METHOD_BUFFERED)
1610 #define FSACTL_CLOSE_GET_ADAPTER_FIB CTL_CODE(2102, METHOD_BUFFERED)
1611 #define FSACTL_MINIPORT_REV_CHECK CTL_CODE(2107, METHOD_BUFFERED)
1612 #define FSACTL_GET_PCI_INFO CTL_CODE(2119, METHOD_BUFFERED)
1613 #define FSACTL_FORCE_DELETE_DISK CTL_CODE(2120, METHOD_NEITHER)
1614 #define FSACTL_GET_CONTAINERS 2131
1615 #define FSACTL_SEND_LARGE_FIB CTL_CODE(2138, METHOD_BUFFERED)
1618 struct aac_common
1621 * If this value is set to 1 then interrupt moderation will occur
1622 * in the base commuication support.
1624 u32 irq_mod;
1625 u32 peak_fibs;
1626 u32 zero_fibs;
1627 u32 fib_timeouts;
1629 * Statistical counters in debug mode
1631 #ifdef DBG
1632 u32 FibsSent;
1633 u32 FibRecved;
1634 u32 NoResponseSent;
1635 u32 NoResponseRecved;
1636 u32 AsyncSent;
1637 u32 AsyncRecved;
1638 u32 NormalSent;
1639 u32 NormalRecved;
1640 #endif
1643 extern struct aac_common aac_config;
1647 * The following macro is used when sending and receiving FIBs. It is
1648 * only used for debugging.
1651 #ifdef DBG
1652 #define FIB_COUNTER_INCREMENT(counter) (counter)++
1653 #else
1654 #define FIB_COUNTER_INCREMENT(counter)
1655 #endif
1658 * Adapter direct commands
1659 * Monitor/Kernel API
1662 #define BREAKPOINT_REQUEST 0x00000004
1663 #define INIT_STRUCT_BASE_ADDRESS 0x00000005
1664 #define READ_PERMANENT_PARAMETERS 0x0000000a
1665 #define WRITE_PERMANENT_PARAMETERS 0x0000000b
1666 #define HOST_CRASHING 0x0000000d
1667 #define SEND_SYNCHRONOUS_FIB 0x0000000c
1668 #define COMMAND_POST_RESULTS 0x00000014
1669 #define GET_ADAPTER_PROPERTIES 0x00000019
1670 #define GET_DRIVER_BUFFER_PROPERTIES 0x00000023
1671 #define RCV_TEMP_READINGS 0x00000025
1672 #define GET_COMM_PREFERRED_SETTINGS 0x00000026
1673 #define IOP_RESET 0x00001000
1674 #define RE_INIT_ADAPTER 0x000000ee
1677 * Adapter Status Register
1679 * Phase Staus mailbox is 32bits:
1680 * <31:16> = Phase Status
1681 * <15:0> = Phase
1683 * The adapter reports is present state through the phase. Only
1684 * a single phase should be ever be set. Each phase can have multiple
1685 * phase status bits to provide more detailed information about the
1686 * state of the board. Care should be taken to ensure that any phase
1687 * status bits that are set when changing the phase are also valid
1688 * for the new phase or be cleared out. Adapter software (monitor,
1689 * iflash, kernel) is responsible for properly maintining the phase
1690 * status mailbox when it is running.
1692 * MONKER_API Phases
1694 * Phases are bit oriented. It is NOT valid to have multiple bits set
1697 #define SELF_TEST_FAILED 0x00000004
1698 #define MONITOR_PANIC 0x00000020
1699 #define KERNEL_UP_AND_RUNNING 0x00000080
1700 #define KERNEL_PANIC 0x00000100
1703 * Doorbell bit defines
1706 #define DoorBellSyncCmdAvailable (1<<0) /* Host -> Adapter */
1707 #define DoorBellPrintfDone (1<<5) /* Host -> Adapter */
1708 #define DoorBellAdapterNormCmdReady (1<<1) /* Adapter -> Host */
1709 #define DoorBellAdapterNormRespReady (1<<2) /* Adapter -> Host */
1710 #define DoorBellAdapterNormCmdNotFull (1<<3) /* Adapter -> Host */
1711 #define DoorBellAdapterNormRespNotFull (1<<4) /* Adapter -> Host */
1712 #define DoorBellPrintfReady (1<<5) /* Adapter -> Host */
1715 * For FIB communication, we need all of the following things
1716 * to send back to the user.
1719 #define AifCmdEventNotify 1 /* Notify of event */
1720 #define AifEnConfigChange 3 /* Adapter configuration change */
1721 #define AifEnContainerChange 4 /* Container configuration change */
1722 #define AifEnDeviceFailure 5 /* SCSI device failed */
1723 #define AifEnAddContainer 15 /* A new array was created */
1724 #define AifEnDeleteContainer 16 /* A container was deleted */
1725 #define AifEnExpEvent 23 /* Firmware Event Log */
1726 #define AifExeFirmwarePanic 3 /* Firmware Event Panic */
1727 #define AifHighPriority 3 /* Highest Priority Event */
1729 #define AifCmdJobProgress 2 /* Progress report */
1730 #define AifJobCtrZero 101 /* Array Zero progress */
1731 #define AifJobStsSuccess 1 /* Job completes */
1732 #define AifJobStsRunning 102 /* Job running */
1733 #define AifCmdAPIReport 3 /* Report from other user of API */
1734 #define AifCmdDriverNotify 4 /* Notify host driver of event */
1735 #define AifDenMorphComplete 200 /* A morph operation completed */
1736 #define AifDenVolumeExtendComplete 201 /* A volume extend completed */
1737 #define AifReqJobList 100 /* Gets back complete job list */
1738 #define AifReqJobsForCtr 101 /* Gets back jobs for specific container */
1739 #define AifReqJobsForScsi 102 /* Gets back jobs for specific SCSI device */
1740 #define AifReqJobReport 103 /* Gets back a specific job report or list of them */
1741 #define AifReqTerminateJob 104 /* Terminates job */
1742 #define AifReqSuspendJob 105 /* Suspends a job */
1743 #define AifReqResumeJob 106 /* Resumes a job */
1744 #define AifReqSendAPIReport 107 /* API generic report requests */
1745 #define AifReqAPIJobStart 108 /* Start a job from the API */
1746 #define AifReqAPIJobUpdate 109 /* Update a job report from the API */
1747 #define AifReqAPIJobFinish 110 /* Finish a job from the API */
1750 * Adapter Initiated FIB command structures. Start with the adapter
1751 * initiated FIBs that really come from the adapter, and get responded
1752 * to by the host.
1755 struct aac_aifcmd {
1756 __le32 command; /* Tell host what type of notify this is */
1757 __le32 seqnum; /* To allow ordering of reports (if necessary) */
1758 u8 data[1]; /* Undefined length (from kernel viewpoint) */
1762 * Convert capacity to cylinders
1763 * accounting for the fact capacity could be a 64 bit value
1766 static inline u32 cap_to_cyls(sector_t capacity, u32 divisor)
1768 sector_div(capacity, divisor);
1769 return (u32)capacity;
1772 struct scsi_cmnd;
1774 const char *aac_driverinfo(struct Scsi_Host *);
1775 struct fib *aac_fib_alloc(struct aac_dev *dev);
1776 int aac_fib_setup(struct aac_dev *dev);
1777 void aac_fib_map_free(struct aac_dev *dev);
1778 void aac_fib_free(struct fib * context);
1779 void aac_fib_init(struct fib * context);
1780 void aac_printf(struct aac_dev *dev, u32 val);
1781 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1782 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1783 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1784 int aac_fib_complete(struct fib * context);
1785 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib->data)
1786 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1787 int aac_get_config_status(struct aac_dev *dev);
1788 int aac_get_containers(struct aac_dev *dev);
1789 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1790 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1791 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1792 int aac_rx_init(struct aac_dev *dev);
1793 int aac_rkt_init(struct aac_dev *dev);
1794 int aac_sa_init(struct aac_dev *dev);
1795 unsigned int aac_response_normal(struct aac_queue * q);
1796 unsigned int aac_command_normal(struct aac_queue * q);
1797 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1798 int aac_command_thread(void *data);
1799 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1800 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1801 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1802 int aac_get_adapter_info(struct aac_dev* dev);
1803 int aac_send_shutdown(struct aac_dev *dev);
1804 int aac_probe_container(struct aac_dev *dev, int cid);
1805 extern int numacb;
1806 extern int acbsize;
1807 extern char aac_driver_version[];