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