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