Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[sfrench/cifs-2.6.git] / drivers / scsi / aacraid / aacraid.h
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 2423
15 # define AAC_DRIVER_BRANCH "-mh3"
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         int  (*adapter_ioremap)(struct aac_dev * dev, u32 size);
498 };
499
500 /*
501  *      Define which interrupt handler needs to be installed
502  */
503
504 struct aac_driver_ident
505 {
506         int     (*init)(struct aac_dev *dev);
507         char *  name;
508         char *  vname;
509         char *  model;
510         u16     channels;
511         int     quirks;
512 };
513 /*
514  * Some adapter firmware needs communication memory 
515  * below 2gig. This tells the init function to set the
516  * dma mask such that fib memory will be allocated where the
517  * adapter firmware can get to it.
518  */
519 #define AAC_QUIRK_31BIT 0x0001
520
521 /*
522  * Some adapter firmware, when the raid card's cache is turned off, can not
523  * split up scatter gathers in order to deal with the limits of the
524  * underlying CHIM. This limit is 34 scatter gather elements.
525  */
526 #define AAC_QUIRK_34SG  0x0002
527
528 /*
529  * This adapter is a slave (no Firmware)
530  */
531 #define AAC_QUIRK_SLAVE 0x0004
532
533 /*
534  * This adapter is a master.
535  */
536 #define AAC_QUIRK_MASTER 0x0008
537
538 /*
539  * Some adapter firmware perform poorly when it must split up scatter gathers
540  * in order to deal with the limits of the underlying CHIM. This limit in this
541  * class of adapters is 17 scatter gather elements.
542  */
543 #define AAC_QUIRK_17SG  0x0010
544
545 /*
546  *      The adapter interface specs all queues to be located in the same
547  *      physically contigous block. The host structure that defines the
548  *      commuication queues will assume they are each a separate physically
549  *      contigous memory region that will support them all being one big
550  *      contigous block. 
551  *      There is a command and response queue for each level and direction of
552  *      commuication. These regions are accessed by both the host and adapter.
553  */
554  
555 struct aac_queue {
556         u64                     logical;        /*address we give the adapter */
557         struct aac_entry        *base;          /*system virtual address */
558         struct aac_qhdr         headers;        /*producer,consumer q headers*/
559         u32                     entries;        /*Number of queue entries */
560         wait_queue_head_t       qfull;          /*Event to wait on if q full */
561         wait_queue_head_t       cmdready;       /*Cmd ready from the adapter */
562                   /* This is only valid for adapter to host command queues. */ 
563         spinlock_t              *lock;          /* Spinlock for this queue must take this lock before accessing the lock */
564         spinlock_t              lockdata;       /* Actual lock (used only on one side of the lock) */
565         struct list_head        cmdq;           /* A queue of FIBs which need to be prcessed by the FS thread. This is */
566                                                 /* only valid for command queues which receive entries from 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 INBOUNDDOORBELL_0       0x00000001
687 #define INBOUNDDOORBELL_1       0x00000002
688 #define INBOUNDDOORBELL_2       0x00000004
689 #define INBOUNDDOORBELL_3       0x00000008
690 #define INBOUNDDOORBELL_4       0x00000010
691 #define INBOUNDDOORBELL_5       0x00000020
692 #define INBOUNDDOORBELL_6       0x00000040
693
694 #define OUTBOUNDDOORBELL_0      0x00000001
695 #define OUTBOUNDDOORBELL_1      0x00000002
696 #define OUTBOUNDDOORBELL_2      0x00000004
697 #define OUTBOUNDDOORBELL_3      0x00000008
698 #define OUTBOUNDDOORBELL_4      0x00000010
699
700 #define InboundDoorbellReg      MUnit.IDR
701 #define OutboundDoorbellReg     MUnit.ODR
702
703 struct rx_registers {
704         struct rx_mu_registers          MUnit;          /* 1300h - 1344h */
705         __le32                          reserved1[2];   /* 1348h - 134ch */
706         struct rx_inbound               IndexRegs;
707 };
708
709 #define rx_readb(AEP, CSR)              readb(&((AEP)->regs.rx->CSR))
710 #define rx_readl(AEP, CSR)              readl(&((AEP)->regs.rx->CSR))
711 #define rx_writeb(AEP, CSR, value)      writeb(value, &((AEP)->regs.rx->CSR))
712 #define rx_writel(AEP, CSR, value)      writel(value, &((AEP)->regs.rx->CSR))
713
714 /*
715  *      Rkt Message Unit Registers (same as Rx, except a larger reserve region)
716  */
717
718 #define rkt_mu_registers rx_mu_registers
719 #define rkt_inbound rx_inbound
720
721 struct rkt_registers {
722         struct rkt_mu_registers         MUnit;           /* 1300h - 1344h */
723         __le32                          reserved1[1006]; /* 1348h - 22fch */
724         struct rkt_inbound              IndexRegs;       /* 2300h - */
725 };
726
727 #define rkt_readb(AEP, CSR)             readb(&((AEP)->regs.rkt->CSR))
728 #define rkt_readl(AEP, CSR)             readl(&((AEP)->regs.rkt->CSR))
729 #define rkt_writeb(AEP, CSR, value)     writeb(value, &((AEP)->regs.rkt->CSR))
730 #define rkt_writel(AEP, CSR, value)     writel(value, &((AEP)->regs.rkt->CSR))
731
732 typedef void (*fib_callback)(void *ctxt, struct fib *fibctx);
733
734 struct aac_fib_context {
735         s16                     type;           // used for verification of structure   
736         s16                     size;
737         u32                     unique;         // unique value representing this context
738         ulong                   jiffies;        // used for cleanup - dmb changed to ulong
739         struct list_head        next;           // used to link context's into a linked list
740         struct semaphore        wait_sem;       // this is used to wait for the next fib to arrive.
741         int                     wait;           // Set to true when thread is in WaitForSingleObject
742         unsigned long           count;          // total number of FIBs on FibList
743         struct list_head        fib_list;       // this holds fibs and their attachd hw_fibs
744 };
745
746 struct sense_data {
747         u8 error_code;          /* 70h (current errors), 71h(deferred errors) */
748         u8 valid:1;             /* A valid bit of one indicates that the information  */
749                                 /* field contains valid information as defined in the
750                                  * SCSI-2 Standard.
751                                  */
752         u8 segment_number;      /* Only used for COPY, COMPARE, or COPY AND VERIFY Commands */
753         u8 sense_key:4;         /* Sense Key */
754         u8 reserved:1;
755         u8 ILI:1;               /* Incorrect Length Indicator */
756         u8 EOM:1;               /* End Of Medium - reserved for random access devices */
757         u8 filemark:1;          /* Filemark - reserved for random access devices */
758
759         u8 information[4];      /* for direct-access devices, contains the unsigned 
760                                  * logical block address or residue associated with 
761                                  * the sense key 
762                                  */
763         u8 add_sense_len;       /* number of additional sense bytes to follow this field */
764         u8 cmnd_info[4];        /* not used */
765         u8 ASC;                 /* Additional Sense Code */
766         u8 ASCQ;                /* Additional Sense Code Qualifier */
767         u8 FRUC;                /* Field Replaceable Unit Code - not used */
768         u8 bit_ptr:3;           /* indicates which byte of the CDB or parameter data
769                                  * was in error
770                                  */
771         u8 BPV:1;               /* bit pointer valid (BPV): 1- indicates that 
772                                  * the bit_ptr field has valid value
773                                  */
774         u8 reserved2:2;
775         u8 CD:1;                /* command data bit: 1- illegal parameter in CDB.
776                                  * 0- illegal parameter in data.
777                                  */
778         u8 SKSV:1;
779         u8 field_ptr[2];        /* byte of the CDB or parameter data in error */
780 };
781
782 struct fsa_dev_info {
783         u64             last;
784         u64             size;
785         u32             type;
786         u32             config_waiting_on;
787         unsigned long   config_waiting_stamp;
788         u16             queue_depth;
789         u8              config_needed;
790         u8              valid;
791         u8              ro;
792         u8              locked;
793         u8              deleted;
794         char            devname[8];
795         struct sense_data sense_data;
796 };
797
798 struct fib {
799         void                    *next;  /* this is used by the allocator */
800         s16                     type;
801         s16                     size;
802         /*
803          *      The Adapter that this I/O is destined for.
804          */
805         struct aac_dev          *dev;
806         /*
807          *      This is the event the sendfib routine will wait on if the
808          *      caller did not pass one and this is synch io.
809          */
810         struct semaphore        event_wait;
811         spinlock_t              event_lock;
812
813         u32                     done;   /* gets set to 1 when fib is complete */
814         fib_callback            callback;
815         void                    *callback_data;
816         u32                     flags; // u32 dmb was ulong
817         /*
818          *      And for the internal issue/reply queues (we may be able
819          *      to merge these two)
820          */
821         struct list_head        fiblink;
822         void                    *data;
823         struct hw_fib           *hw_fib;                /* Actual shared object */
824         dma_addr_t              hw_fib_pa;              /* physical address of hw_fib*/
825 };
826
827 /*
828  *      Adapter Information Block
829  *
830  *      This is returned by the RequestAdapterInfo block
831  */
832  
833 struct aac_adapter_info
834 {
835         __le32  platform;
836         __le32  cpu;
837         __le32  subcpu;
838         __le32  clock;
839         __le32  execmem;
840         __le32  buffermem;
841         __le32  totalmem;
842         __le32  kernelrev;
843         __le32  kernelbuild;
844         __le32  monitorrev;
845         __le32  monitorbuild;
846         __le32  hwrev;
847         __le32  hwbuild;
848         __le32  biosrev;
849         __le32  biosbuild;
850         __le32  cluster;
851         __le32  clusterchannelmask; 
852         __le32  serial[2];
853         __le32  battery;
854         __le32  options;
855         __le32  OEM;
856 };
857
858 struct aac_supplement_adapter_info
859 {
860         u8      AdapterTypeText[17+1];
861         u8      Pad[2];
862         __le32  FlashMemoryByteSize;
863         __le32  FlashImageId;
864         __le32  MaxNumberPorts;
865         __le32  Version;
866         __le32  FeatureBits;
867         u8      SlotNumber;
868         u8      ReservedPad0[0];
869         u8      BuildDate[12];
870         __le32  CurrentNumberPorts;
871         __le32  ReservedGrowth[24];
872 };
873 #define AAC_FEATURE_FALCON      0x00000010
874 #define AAC_SIS_VERSION_V3      3
875 #define AAC_SIS_SLOT_UNKNOWN    0xFF
876
877 #define GetBusInfo 0x00000009
878 struct aac_bus_info {
879         __le32  Command;        /* VM_Ioctl */
880         __le32  ObjType;        /* FT_DRIVE */
881         __le32  MethodId;       /* 1 = SCSI Layer */
882         __le32  ObjectId;       /* Handle */
883         __le32  CtlCmd;         /* GetBusInfo */
884 };
885
886 struct aac_bus_info_response {
887         __le32  Status;         /* ST_OK */
888         __le32  ObjType;
889         __le32  MethodId;       /* unused */
890         __le32  ObjectId;       /* unused */
891         __le32  CtlCmd;         /* unused */
892         __le32  ProbeComplete;
893         __le32  BusCount;
894         __le32  TargetsPerBus;
895         u8      InitiatorBusId[10];
896         u8      BusValid[10];
897 };
898
899 /*
900  * Battery platforms
901  */
902 #define AAC_BAT_REQ_PRESENT     (1)
903 #define AAC_BAT_REQ_NOTPRESENT  (2)
904 #define AAC_BAT_OPT_PRESENT     (3)
905 #define AAC_BAT_OPT_NOTPRESENT  (4)
906 #define AAC_BAT_NOT_SUPPORTED   (5)
907 /*
908  * cpu types
909  */
910 #define AAC_CPU_SIMULATOR       (1)
911 #define AAC_CPU_I960            (2)
912 #define AAC_CPU_STRONGARM       (3)
913
914 /*
915  * Supported Options
916  */
917 #define AAC_OPT_SNAPSHOT                cpu_to_le32(1)
918 #define AAC_OPT_CLUSTERS                cpu_to_le32(1<<1)
919 #define AAC_OPT_WRITE_CACHE             cpu_to_le32(1<<2)
920 #define AAC_OPT_64BIT_DATA              cpu_to_le32(1<<3)
921 #define AAC_OPT_HOST_TIME_FIB           cpu_to_le32(1<<4)
922 #define AAC_OPT_RAID50                  cpu_to_le32(1<<5)
923 #define AAC_OPT_4GB_WINDOW              cpu_to_le32(1<<6)
924 #define AAC_OPT_SCSI_UPGRADEABLE        cpu_to_le32(1<<7)
925 #define AAC_OPT_SOFT_ERR_REPORT         cpu_to_le32(1<<8)
926 #define AAC_OPT_SUPPORTED_RECONDITION   cpu_to_le32(1<<9)
927 #define AAC_OPT_SGMAP_HOST64            cpu_to_le32(1<<10)
928 #define AAC_OPT_ALARM                   cpu_to_le32(1<<11)
929 #define AAC_OPT_NONDASD                 cpu_to_le32(1<<12)
930 #define AAC_OPT_SCSI_MANAGED            cpu_to_le32(1<<13)
931 #define AAC_OPT_RAID_SCSI_MODE          cpu_to_le32(1<<14)
932 #define AAC_OPT_SUPPLEMENT_ADAPTER_INFO cpu_to_le32(1<<16)
933 #define AAC_OPT_NEW_COMM                cpu_to_le32(1<<17)
934 #define AAC_OPT_NEW_COMM_64             cpu_to_le32(1<<18)
935
936 struct aac_dev
937 {
938         struct list_head        entry;
939         const char              *name;
940         int                     id;
941
942         /*
943          *      negotiated FIB settings
944          */
945         unsigned                max_fib_size;
946         unsigned                sg_tablesize;
947
948         /*
949          *      Map for 128 fib objects (64k)
950          */     
951         dma_addr_t              hw_fib_pa;
952         struct hw_fib           *hw_fib_va;
953         struct hw_fib           *aif_base_va;
954         /*
955          *      Fib Headers
956          */
957         struct fib              *fibs;
958
959         struct fib              *free_fib;
960         struct fib              *timeout_fib;
961         spinlock_t              fib_lock;
962         
963         struct aac_queue_block *queues;
964         /*
965          *      The user API will use an IOCTL to register itself to receive
966          *      FIBs from the adapter.  The following list is used to keep
967          *      track of all the threads that have requested these FIBs.  The
968          *      mutex is used to synchronize access to all data associated 
969          *      with the adapter fibs.
970          */
971         struct list_head        fib_list;
972
973         struct adapter_ops      a_ops;
974         unsigned long           fsrev;          /* Main driver's revision number */
975         
976         unsigned                base_size;      /* Size of mapped in region */
977         struct aac_init         *init;          /* Holds initialization info to communicate with adapter */
978         dma_addr_t              init_pa;        /* Holds physical address of the init struct */
979         
980         struct pci_dev          *pdev;          /* Our PCI interface */
981         void *                  printfbuf;      /* pointer to buffer used for printf's from the adapter */
982         void *                  comm_addr;      /* Base address of Comm area */
983         dma_addr_t              comm_phys;      /* Physical Address of Comm area */
984         size_t                  comm_size;
985
986         struct Scsi_Host        *scsi_host_ptr;
987         int                     maximum_num_containers;
988         int                     maximum_num_physicals;
989         int                     maximum_num_channels;
990         struct fsa_dev_info     *fsa_dev;
991         struct task_struct      *thread;
992         int                     cardtype;
993         
994         /*
995          *      The following is the device specific extension.
996          */
997 #if (!defined(AAC_MIN_FOOTPRINT_SIZE))
998 #       define AAC_MIN_FOOTPRINT_SIZE 8192
999 #endif
1000         union
1001         {
1002                 struct sa_registers __iomem *sa;
1003                 struct rx_registers __iomem *rx;
1004                 struct rkt_registers __iomem *rkt;
1005         } regs;
1006         volatile void __iomem *base;
1007         volatile struct rx_inbound __iomem *IndexRegs;
1008         u32                     OIMR; /* Mask Register Cache */
1009         /*
1010          *      AIF thread states
1011          */
1012         u32                     aif_thread;
1013         struct aac_adapter_info adapter_info;
1014         struct aac_supplement_adapter_info supplement_adapter_info;
1015         /* These are in adapter info but they are in the io flow so
1016          * lets break them out so we don't have to do an AND to check them
1017          */
1018         u8                      nondasd_support; 
1019         u8                      dac_support;
1020         u8                      raid_scsi_mode;
1021         u8                      new_comm_interface;
1022         /* macro side-effects BEWARE */
1023 #       define                  raw_io_interface \
1024           init->InitStructRevision==cpu_to_le32(ADAPTER_INIT_STRUCT_REVISION_4)
1025         u8                      raw_io_64;
1026         u8                      printf_enabled;
1027         u8                      in_reset;
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 aac_adapter_ioremap(dev, size) \
1049         (dev)->a_ops.adapter_ioremap(dev, size)
1050
1051 #define FIB_CONTEXT_FLAG_TIMED_OUT              (0x00000001)
1052
1053 /*
1054  *      Define the command values
1055  */
1056  
1057 #define         Null                    0
1058 #define         GetAttributes           1
1059 #define         SetAttributes           2
1060 #define         Lookup                  3
1061 #define         ReadLink                4
1062 #define         Read                    5
1063 #define         Write                   6
1064 #define         Create                  7
1065 #define         MakeDirectory           8
1066 #define         SymbolicLink            9
1067 #define         MakeNode                10
1068 #define         Removex                 11
1069 #define         RemoveDirectoryx        12
1070 #define         Rename                  13
1071 #define         Link                    14
1072 #define         ReadDirectory           15
1073 #define         ReadDirectoryPlus       16
1074 #define         FileSystemStatus        17
1075 #define         FileSystemInfo          18
1076 #define         PathConfigure           19
1077 #define         Commit                  20
1078 #define         Mount                   21
1079 #define         UnMount                 22
1080 #define         Newfs                   23
1081 #define         FsCheck                 24
1082 #define         FsSync                  25
1083 #define         SimReadWrite            26
1084 #define         SetFileSystemStatus     27
1085 #define         BlockRead               28
1086 #define         BlockWrite              29
1087 #define         NvramIoctl              30
1088 #define         FsSyncWait              31
1089 #define         ClearArchiveBit         32
1090 #define         SetAcl                  33
1091 #define         GetAcl                  34
1092 #define         AssignAcl               35
1093 #define         FaultInsertion          36      /* Fault Insertion Command */
1094 #define         CrazyCache              37      /* Crazycache */
1095
1096 #define         MAX_FSACOMMAND_NUM      38
1097
1098
1099 /*
1100  *      Define the status returns. These are very unixlike although
1101  *      most are not in fact used
1102  */
1103
1104 #define         ST_OK           0
1105 #define         ST_PERM         1
1106 #define         ST_NOENT        2
1107 #define         ST_IO           5
1108 #define         ST_NXIO         6
1109 #define         ST_E2BIG        7
1110 #define         ST_ACCES        13
1111 #define         ST_EXIST        17
1112 #define         ST_XDEV         18
1113 #define         ST_NODEV        19
1114 #define         ST_NOTDIR       20
1115 #define         ST_ISDIR        21
1116 #define         ST_INVAL        22
1117 #define         ST_FBIG         27
1118 #define         ST_NOSPC        28
1119 #define         ST_ROFS         30
1120 #define         ST_MLINK        31
1121 #define         ST_WOULDBLOCK   35
1122 #define         ST_NAMETOOLONG  63
1123 #define         ST_NOTEMPTY     66
1124 #define         ST_DQUOT        69
1125 #define         ST_STALE        70
1126 #define         ST_REMOTE       71
1127 #define         ST_BADHANDLE    10001
1128 #define         ST_NOT_SYNC     10002
1129 #define         ST_BAD_COOKIE   10003
1130 #define         ST_NOTSUPP      10004
1131 #define         ST_TOOSMALL     10005
1132 #define         ST_SERVERFAULT  10006
1133 #define         ST_BADTYPE      10007
1134 #define         ST_JUKEBOX      10008
1135 #define         ST_NOTMOUNTED   10009
1136 #define         ST_MAINTMODE    10010
1137 #define         ST_STALEACL     10011
1138
1139 /*
1140  *      On writes how does the client want the data written.
1141  */
1142
1143 #define CACHE_CSTABLE           1
1144 #define CACHE_UNSTABLE          2
1145
1146 /*
1147  *      Lets the client know at which level the data was commited on
1148  *      a write request
1149  */
1150
1151 #define CMFILE_SYNCH_NVRAM      1
1152 #define CMDATA_SYNCH_NVRAM      2
1153 #define CMFILE_SYNCH            3
1154 #define CMDATA_SYNCH            4
1155 #define CMUNSTABLE              5
1156
1157 struct aac_read
1158 {
1159         __le32          command;
1160         __le32          cid;
1161         __le32          block;
1162         __le32          count;
1163         struct sgmap    sg;     // Must be last in struct because it is variable
1164 };
1165
1166 struct aac_read64
1167 {
1168         __le32          command;
1169         __le16          cid;
1170         __le16          sector_count;
1171         __le32          block;
1172         __le16          pad;
1173         __le16          flags;
1174         struct sgmap64  sg;     // Must be last in struct because it is variable
1175 };
1176
1177 struct aac_read_reply
1178 {
1179         __le32          status;
1180         __le32          count;
1181 };
1182
1183 struct aac_write
1184 {
1185         __le32          command;
1186         __le32          cid;
1187         __le32          block;
1188         __le32          count;
1189         __le32          stable; // Not used
1190         struct sgmap    sg;     // Must be last in struct because it is variable
1191 };
1192
1193 struct aac_write64
1194 {
1195         __le32          command;
1196         __le16          cid;
1197         __le16          sector_count;
1198         __le32          block;
1199         __le16          pad;
1200         __le16          flags;
1201         struct sgmap64  sg;     // Must be last in struct because it is variable
1202 };
1203 struct aac_write_reply
1204 {
1205         __le32          status;
1206         __le32          count;
1207         __le32          committed;
1208 };
1209
1210 struct aac_raw_io
1211 {
1212         __le32          block[2];
1213         __le32          count;
1214         __le16          cid;
1215         __le16          flags;          /* 00 W, 01 R */
1216         __le16          bpTotal;        /* reserved for F/W use */
1217         __le16          bpComplete;     /* reserved for F/W use */
1218         struct sgmapraw sg;
1219 };
1220
1221 #define CT_FLUSH_CACHE 129
1222 struct aac_synchronize {
1223         __le32          command;        /* VM_ContainerConfig */
1224         __le32          type;           /* CT_FLUSH_CACHE */
1225         __le32          cid;
1226         __le32          parm1;
1227         __le32          parm2;
1228         __le32          parm3;
1229         __le32          parm4;
1230         __le32          count;  /* sizeof(((struct aac_synchronize_reply *)NULL)->data) */
1231 };
1232
1233 struct aac_synchronize_reply {
1234         __le32          dummy0;
1235         __le32          dummy1;
1236         __le32          status; /* CT_OK */
1237         __le32          parm1;
1238         __le32          parm2;
1239         __le32          parm3;
1240         __le32          parm4;
1241         __le32          parm5;
1242         u8              data[16];
1243 };
1244
1245 struct aac_srb
1246 {
1247         __le32          function;
1248         __le32          channel;
1249         __le32          id;
1250         __le32          lun;
1251         __le32          timeout;
1252         __le32          flags;
1253         __le32          count;          // Data xfer size
1254         __le32          retry_limit;
1255         __le32          cdb_size;
1256         u8              cdb[16];
1257         struct  sgmap   sg;
1258 };
1259
1260 /*
1261  * This and associated data structs are used by the
1262  * ioctl caller and are in cpu order.
1263  */
1264 struct user_aac_srb
1265 {
1266         u32             function;
1267         u32             channel;
1268         u32             id;
1269         u32             lun;
1270         u32             timeout;
1271         u32             flags;
1272         u32             count;          // Data xfer size
1273         u32             retry_limit;
1274         u32             cdb_size;
1275         u8              cdb[16];
1276         struct  user_sgmap      sg;
1277 };
1278
1279 #define         AAC_SENSE_BUFFERSIZE     30
1280
1281 struct aac_srb_reply
1282 {
1283         __le32          status;
1284         __le32          srb_status;
1285         __le32          scsi_status;
1286         __le32          data_xfer_length;
1287         __le32          sense_data_size;
1288         u8              sense_data[AAC_SENSE_BUFFERSIZE]; // Can this be SCSI_SENSE_BUFFERSIZE
1289 };
1290 /*
1291  * SRB Flags
1292  */
1293 #define         SRB_NoDataXfer           0x0000
1294 #define         SRB_DisableDisconnect    0x0004
1295 #define         SRB_DisableSynchTransfer 0x0008
1296 #define         SRB_BypassFrozenQueue    0x0010
1297 #define         SRB_DisableAutosense     0x0020
1298 #define         SRB_DataIn               0x0040
1299 #define         SRB_DataOut              0x0080
1300
1301 /*
1302  * SRB Functions - set in aac_srb->function
1303  */
1304 #define SRBF_ExecuteScsi        0x0000
1305 #define SRBF_ClaimDevice        0x0001
1306 #define SRBF_IO_Control         0x0002
1307 #define SRBF_ReceiveEvent       0x0003
1308 #define SRBF_ReleaseQueue       0x0004
1309 #define SRBF_AttachDevice       0x0005
1310 #define SRBF_ReleaseDevice      0x0006
1311 #define SRBF_Shutdown           0x0007
1312 #define SRBF_Flush              0x0008
1313 #define SRBF_AbortCommand       0x0010
1314 #define SRBF_ReleaseRecovery    0x0011
1315 #define SRBF_ResetBus           0x0012
1316 #define SRBF_ResetDevice        0x0013
1317 #define SRBF_TerminateIO        0x0014
1318 #define SRBF_FlushQueue         0x0015
1319 #define SRBF_RemoveDevice       0x0016
1320 #define SRBF_DomainValidation   0x0017
1321
1322 /* 
1323  * SRB SCSI Status - set in aac_srb->scsi_status
1324  */
1325 #define SRB_STATUS_PENDING                  0x00
1326 #define SRB_STATUS_SUCCESS                  0x01
1327 #define SRB_STATUS_ABORTED                  0x02
1328 #define SRB_STATUS_ABORT_FAILED             0x03
1329 #define SRB_STATUS_ERROR                    0x04
1330 #define SRB_STATUS_BUSY                     0x05
1331 #define SRB_STATUS_INVALID_REQUEST          0x06
1332 #define SRB_STATUS_INVALID_PATH_ID          0x07
1333 #define SRB_STATUS_NO_DEVICE                0x08
1334 #define SRB_STATUS_TIMEOUT                  0x09
1335 #define SRB_STATUS_SELECTION_TIMEOUT        0x0A
1336 #define SRB_STATUS_COMMAND_TIMEOUT          0x0B
1337 #define SRB_STATUS_MESSAGE_REJECTED         0x0D
1338 #define SRB_STATUS_BUS_RESET                0x0E
1339 #define SRB_STATUS_PARITY_ERROR             0x0F
1340 #define SRB_STATUS_REQUEST_SENSE_FAILED     0x10
1341 #define SRB_STATUS_NO_HBA                   0x11
1342 #define SRB_STATUS_DATA_OVERRUN             0x12
1343 #define SRB_STATUS_UNEXPECTED_BUS_FREE      0x13
1344 #define SRB_STATUS_PHASE_SEQUENCE_FAILURE   0x14
1345 #define SRB_STATUS_BAD_SRB_BLOCK_LENGTH     0x15
1346 #define SRB_STATUS_REQUEST_FLUSHED          0x16
1347 #define SRB_STATUS_DELAYED_RETRY            0x17
1348 #define SRB_STATUS_INVALID_LUN              0x20
1349 #define SRB_STATUS_INVALID_TARGET_ID        0x21
1350 #define SRB_STATUS_BAD_FUNCTION             0x22
1351 #define SRB_STATUS_ERROR_RECOVERY           0x23
1352 #define SRB_STATUS_NOT_STARTED              0x24
1353 #define SRB_STATUS_NOT_IN_USE               0x30
1354 #define SRB_STATUS_FORCE_ABORT              0x31
1355 #define SRB_STATUS_DOMAIN_VALIDATION_FAIL   0x32
1356
1357 /*
1358  * Object-Server / Volume-Manager Dispatch Classes
1359  */
1360
1361 #define         VM_Null                 0
1362 #define         VM_NameServe            1
1363 #define         VM_ContainerConfig      2
1364 #define         VM_Ioctl                3
1365 #define         VM_FilesystemIoctl      4
1366 #define         VM_CloseAll             5
1367 #define         VM_CtBlockRead          6
1368 #define         VM_CtBlockWrite         7
1369 #define         VM_SliceBlockRead       8       /* raw access to configured "storage objects" */
1370 #define         VM_SliceBlockWrite      9
1371 #define         VM_DriveBlockRead       10      /* raw access to physical devices */
1372 #define         VM_DriveBlockWrite      11
1373 #define         VM_EnclosureMgt         12      /* enclosure management */
1374 #define         VM_Unused               13      /* used to be diskset management */
1375 #define         VM_CtBlockVerify        14
1376 #define         VM_CtPerf               15      /* performance test */
1377 #define         VM_CtBlockRead64        16
1378 #define         VM_CtBlockWrite64       17
1379 #define         VM_CtBlockVerify64      18
1380 #define         VM_CtHostRead64         19
1381 #define         VM_CtHostWrite64        20
1382 #define         VM_DrvErrTblLog         21
1383 #define         VM_NameServe64          22
1384
1385 #define         MAX_VMCOMMAND_NUM       23      /* used for sizing stats array - leave last */
1386
1387 /*
1388  *      Descriptive information (eg, vital stats)
1389  *      that a content manager might report.  The
1390  *      FileArray filesystem component is one example
1391  *      of a content manager.  Raw mode might be
1392  *      another.
1393  */
1394
1395 struct aac_fsinfo {
1396         __le32  fsTotalSize;    /* Consumed by fs, incl. metadata */
1397         __le32  fsBlockSize;
1398         __le32  fsFragSize;
1399         __le32  fsMaxExtendSize;
1400         __le32  fsSpaceUnits;
1401         __le32  fsMaxNumFiles;
1402         __le32  fsNumFreeFiles;
1403         __le32  fsInodeDensity;
1404 };      /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1405
1406 union aac_contentinfo {
1407         struct aac_fsinfo filesys;      /* valid iff ObjType == FT_FILESYS && !(ContentState & FSCS_NOTCLEAN) */
1408 };
1409
1410 /*
1411  *      Query for Container Configuration Status
1412  */
1413
1414 #define CT_GET_CONFIG_STATUS 147
1415 struct aac_get_config_status {
1416         __le32          command;        /* VM_ContainerConfig */
1417         __le32          type;           /* CT_GET_CONFIG_STATUS */
1418         __le32          parm1;
1419         __le32          parm2;
1420         __le32          parm3;
1421         __le32          parm4;
1422         __le32          parm5;
1423         __le32          count;  /* sizeof(((struct aac_get_config_status_resp *)NULL)->data) */
1424 };
1425
1426 #define CFACT_CONTINUE 0
1427 #define CFACT_PAUSE    1
1428 #define CFACT_ABORT    2
1429 struct aac_get_config_status_resp {
1430         __le32          response; /* ST_OK */
1431         __le32          dummy0;
1432         __le32          status; /* CT_OK */
1433         __le32          parm1;
1434         __le32          parm2;
1435         __le32          parm3;
1436         __le32          parm4;
1437         __le32          parm5;
1438         struct {
1439                 __le32  action; /* CFACT_CONTINUE, CFACT_PAUSE or CFACT_ABORT */
1440                 __le16  flags;
1441                 __le16  count;
1442         }               data;
1443 };
1444
1445 /*
1446  *      Accept the configuration as-is
1447  */
1448
1449 #define CT_COMMIT_CONFIG 152
1450
1451 struct aac_commit_config {
1452         __le32          command;        /* VM_ContainerConfig */
1453         __le32          type;           /* CT_COMMIT_CONFIG */
1454 };
1455
1456 /*
1457  *      Query for Container Configuration Status
1458  */
1459
1460 #define CT_GET_CONTAINER_COUNT 4
1461 struct aac_get_container_count {
1462         __le32          command;        /* VM_ContainerConfig */
1463         __le32          type;           /* CT_GET_CONTAINER_COUNT */
1464 };
1465
1466 struct aac_get_container_count_resp {
1467         __le32          response; /* ST_OK */
1468         __le32          dummy0;
1469         __le32          MaxContainers;
1470         __le32          ContainerSwitchEntries;
1471         __le32          MaxPartitions;
1472 };
1473
1474
1475 /*
1476  *      Query for "mountable" objects, ie, objects that are typically
1477  *      associated with a drive letter on the client (host) side.
1478  */
1479
1480 struct aac_mntent {
1481         __le32                  oid;
1482         u8                      name[16];       /* if applicable */
1483         struct creation_info    create_info;    /* if applicable */
1484         __le32                  capacity;
1485         __le32                  vol;            /* substrate structure */
1486         __le32                  obj;            /* FT_FILESYS, 
1487                                                    FT_DATABASE, etc. */
1488         __le32                  state;          /* unready for mounting, 
1489                                                    readonly, etc. */
1490         union aac_contentinfo   fileinfo;       /* Info specific to content 
1491                                                    manager (eg, filesystem) */
1492         __le32                  altoid;         /* != oid <==> snapshot or 
1493                                                    broken mirror exists */
1494         __le32                  capacityhigh;
1495 };
1496
1497 #define FSCS_NOTCLEAN   0x0001  /* fsck is neccessary before mounting */
1498 #define FSCS_READONLY   0x0002  /* possible result of broken mirror */
1499 #define FSCS_HIDDEN     0x0004  /* should be ignored - set during a clear */
1500
1501 struct aac_query_mount {
1502         __le32          command;
1503         __le32          type;
1504         __le32          count;
1505 };
1506
1507 struct aac_mount {
1508         __le32          status;
1509         __le32          type;           /* should be same as that requested */
1510         __le32          count;
1511         struct aac_mntent mnt[1];
1512 };
1513
1514 #define CT_READ_NAME 130
1515 struct aac_get_name {
1516         __le32          command;        /* VM_ContainerConfig */
1517         __le32          type;           /* CT_READ_NAME */
1518         __le32          cid;
1519         __le32          parm1;
1520         __le32          parm2;
1521         __le32          parm3;
1522         __le32          parm4;
1523         __le32          count;  /* sizeof(((struct aac_get_name_resp *)NULL)->data) */
1524 };
1525
1526 struct aac_get_name_resp {
1527         __le32          dummy0;
1528         __le32          dummy1;
1529         __le32          status; /* CT_OK */
1530         __le32          parm1;
1531         __le32          parm2;
1532         __le32          parm3;
1533         __le32          parm4;
1534         __le32          parm5;
1535         u8              data[16];
1536 };
1537
1538 /*
1539  * The following command is sent to shut down each container.
1540  */
1541
1542 struct aac_close {
1543         __le32  command;
1544         __le32  cid;
1545 };
1546
1547 struct aac_query_disk
1548 {
1549         s32     cnum;
1550         s32     bus;
1551         s32     id;
1552         s32     lun;
1553         u32     valid;
1554         u32     locked;
1555         u32     deleted;
1556         s32     instance;
1557         s8      name[10];
1558         u32     unmapped;
1559 };
1560
1561 struct aac_delete_disk {
1562         u32     disknum;
1563         u32     cnum;
1564 };
1565  
1566 struct fib_ioctl
1567 {
1568         u32     fibctx;
1569         s32     wait;
1570         char    __user *fib;
1571 };
1572
1573 struct revision
1574 {
1575         u32 compat;
1576         __le32 version;
1577         __le32 build;
1578 };
1579         
1580
1581 /*
1582  *      Ugly - non Linux like ioctl coding for back compat.
1583  */
1584
1585 #define CTL_CODE(function, method) (                 \
1586     (4<< 16) | ((function) << 2) | (method) \
1587 )
1588
1589 /*
1590  *      Define the method codes for how buffers are passed for I/O and FS 
1591  *      controls
1592  */
1593
1594 #define METHOD_BUFFERED                 0
1595 #define METHOD_NEITHER                  3
1596
1597 /*
1598  *      Filesystem ioctls
1599  */
1600
1601 #define FSACTL_SENDFIB                          CTL_CODE(2050, METHOD_BUFFERED)
1602 #define FSACTL_SEND_RAW_SRB                     CTL_CODE(2067, METHOD_BUFFERED)
1603 #define FSACTL_DELETE_DISK                      0x163
1604 #define FSACTL_QUERY_DISK                       0x173
1605 #define FSACTL_OPEN_GET_ADAPTER_FIB             CTL_CODE(2100, METHOD_BUFFERED)
1606 #define FSACTL_GET_NEXT_ADAPTER_FIB             CTL_CODE(2101, METHOD_BUFFERED)
1607 #define FSACTL_CLOSE_GET_ADAPTER_FIB            CTL_CODE(2102, METHOD_BUFFERED)
1608 #define FSACTL_MINIPORT_REV_CHECK               CTL_CODE(2107, METHOD_BUFFERED)
1609 #define FSACTL_GET_PCI_INFO                     CTL_CODE(2119, METHOD_BUFFERED)
1610 #define FSACTL_FORCE_DELETE_DISK                CTL_CODE(2120, METHOD_NEITHER)
1611 #define FSACTL_GET_CONTAINERS                   2131
1612 #define FSACTL_SEND_LARGE_FIB                   CTL_CODE(2138, METHOD_BUFFERED)
1613
1614
1615 struct aac_common
1616 {
1617         /*
1618          *      If this value is set to 1 then interrupt moderation will occur 
1619          *      in the base commuication support.
1620          */
1621         u32 irq_mod;
1622         u32 peak_fibs;
1623         u32 zero_fibs;
1624         u32 fib_timeouts;
1625         /*
1626          *      Statistical counters in debug mode
1627          */
1628 #ifdef DBG
1629         u32 FibsSent;
1630         u32 FibRecved;
1631         u32 NoResponseSent;
1632         u32 NoResponseRecved;
1633         u32 AsyncSent;
1634         u32 AsyncRecved;
1635         u32 NormalSent;
1636         u32 NormalRecved;
1637 #endif
1638 };
1639
1640 extern struct aac_common aac_config;
1641
1642
1643 /*
1644  *      The following macro is used when sending and receiving FIBs. It is
1645  *      only used for debugging.
1646  */
1647  
1648 #ifdef DBG
1649 #define FIB_COUNTER_INCREMENT(counter)          (counter)++
1650 #else
1651 #define FIB_COUNTER_INCREMENT(counter)          
1652 #endif
1653
1654 /*
1655  *      Adapter direct commands
1656  *      Monitor/Kernel API
1657  */
1658
1659 #define BREAKPOINT_REQUEST              0x00000004
1660 #define INIT_STRUCT_BASE_ADDRESS        0x00000005
1661 #define READ_PERMANENT_PARAMETERS       0x0000000a
1662 #define WRITE_PERMANENT_PARAMETERS      0x0000000b
1663 #define HOST_CRASHING                   0x0000000d
1664 #define SEND_SYNCHRONOUS_FIB            0x0000000c
1665 #define COMMAND_POST_RESULTS            0x00000014
1666 #define GET_ADAPTER_PROPERTIES          0x00000019
1667 #define GET_DRIVER_BUFFER_PROPERTIES    0x00000023
1668 #define RCV_TEMP_READINGS               0x00000025
1669 #define GET_COMM_PREFERRED_SETTINGS     0x00000026
1670 #define IOP_RESET                       0x00001000
1671 #define IOP_RESET_ALWAYS                0x00001001
1672 #define RE_INIT_ADAPTER                 0x000000ee
1673
1674 /*
1675  *      Adapter Status Register
1676  *
1677  *  Phase Staus mailbox is 32bits:
1678  *      <31:16> = Phase Status
1679  *      <15:0>  = Phase
1680  *
1681  *      The adapter reports is present state through the phase.  Only
1682  *      a single phase should be ever be set.  Each phase can have multiple
1683  *      phase status bits to provide more detailed information about the 
1684  *      state of the board.  Care should be taken to ensure that any phase 
1685  *      status bits that are set when changing the phase are also valid
1686  *      for the new phase or be cleared out.  Adapter software (monitor,
1687  *      iflash, kernel) is responsible for properly maintining the phase 
1688  *      status mailbox when it is running.
1689  *                                                                                      
1690  *      MONKER_API Phases                                                       
1691  *
1692  *      Phases are bit oriented.  It is NOT valid  to have multiple bits set                                            
1693  */                                     
1694
1695 #define SELF_TEST_FAILED                0x00000004
1696 #define MONITOR_PANIC                   0x00000020
1697 #define KERNEL_UP_AND_RUNNING           0x00000080
1698 #define KERNEL_PANIC                    0x00000100
1699
1700 /*
1701  *      Doorbell bit defines
1702  */
1703
1704 #define DoorBellSyncCmdAvailable        (1<<0)  /* Host -> Adapter */
1705 #define DoorBellPrintfDone              (1<<5)  /* Host -> Adapter */
1706 #define DoorBellAdapterNormCmdReady     (1<<1)  /* Adapter -> Host */
1707 #define DoorBellAdapterNormRespReady    (1<<2)  /* Adapter -> Host */
1708 #define DoorBellAdapterNormCmdNotFull   (1<<3)  /* Adapter -> Host */
1709 #define DoorBellAdapterNormRespNotFull  (1<<4)  /* Adapter -> Host */
1710 #define DoorBellPrintfReady             (1<<5)  /* Adapter -> Host */
1711
1712 /*
1713  *      For FIB communication, we need all of the following things
1714  *      to send back to the user.
1715  */
1716  
1717 #define         AifCmdEventNotify       1       /* Notify of event */
1718 #define                 AifEnConfigChange       3       /* Adapter configuration change */
1719 #define                 AifEnContainerChange    4       /* Container configuration change */
1720 #define                 AifEnDeviceFailure      5       /* SCSI device failed */
1721 #define                 AifEnAddContainer       15      /* A new array was created */
1722 #define                 AifEnDeleteContainer    16      /* A container was deleted */
1723 #define                 AifEnExpEvent           23      /* Firmware Event Log */
1724 #define                 AifExeFirmwarePanic     3       /* Firmware Event Panic */
1725 #define                 AifHighPriority         3       /* Highest Priority Event */
1726
1727 #define         AifCmdJobProgress       2       /* Progress report */
1728 #define                 AifJobCtrZero   101     /* Array Zero progress */
1729 #define                 AifJobStsSuccess 1      /* Job completes */
1730 #define                 AifJobStsRunning 102    /* Job running */
1731 #define         AifCmdAPIReport         3       /* Report from other user of API */
1732 #define         AifCmdDriverNotify      4       /* Notify host driver of event */
1733 #define                 AifDenMorphComplete 200 /* A morph operation completed */
1734 #define                 AifDenVolumeExtendComplete 201 /* A volume extend completed */
1735 #define         AifReqJobList           100     /* Gets back complete job list */
1736 #define         AifReqJobsForCtr        101     /* Gets back jobs for specific container */
1737 #define         AifReqJobsForScsi       102     /* Gets back jobs for specific SCSI device */ 
1738 #define         AifReqJobReport         103     /* Gets back a specific job report or list of them */ 
1739 #define         AifReqTerminateJob      104     /* Terminates job */
1740 #define         AifReqSuspendJob        105     /* Suspends a job */
1741 #define         AifReqResumeJob         106     /* Resumes a job */ 
1742 #define         AifReqSendAPIReport     107     /* API generic report requests */
1743 #define         AifReqAPIJobStart       108     /* Start a job from the API */
1744 #define         AifReqAPIJobUpdate      109     /* Update a job report from the API */
1745 #define         AifReqAPIJobFinish      110     /* Finish a job from the API */
1746
1747 /*
1748  *      Adapter Initiated FIB command structures. Start with the adapter
1749  *      initiated FIBs that really come from the adapter, and get responded
1750  *      to by the host.
1751  */
1752
1753 struct aac_aifcmd {
1754         __le32 command;         /* Tell host what type of notify this is */
1755         __le32 seqnum;          /* To allow ordering of reports (if necessary) */
1756         u8 data[1];             /* Undefined length (from kernel viewpoint) */
1757 };
1758
1759 /**
1760  *      Convert capacity to cylinders
1761  *      accounting for the fact capacity could be a 64 bit value
1762  *
1763  */
1764 static inline u32 cap_to_cyls(sector_t capacity, u32 divisor)
1765 {
1766         sector_div(capacity, divisor);
1767         return (u32)capacity;
1768 }
1769
1770 struct scsi_cmnd;
1771 /* SCp.phase values */
1772 #define AAC_OWNER_MIDLEVEL      0x101
1773 #define AAC_OWNER_LOWLEVEL      0x102
1774 #define AAC_OWNER_ERROR_HANDLER 0x103
1775 #define AAC_OWNER_FIRMWARE      0x106
1776
1777 const char *aac_driverinfo(struct Scsi_Host *);
1778 struct fib *aac_fib_alloc(struct aac_dev *dev);
1779 int aac_fib_setup(struct aac_dev *dev);
1780 void aac_fib_map_free(struct aac_dev *dev);
1781 void aac_fib_free(struct fib * context);
1782 void aac_fib_init(struct fib * context);
1783 void aac_printf(struct aac_dev *dev, u32 val);
1784 int aac_fib_send(u16 command, struct fib * context, unsigned long size, int priority, int wait, int reply, fib_callback callback, void *ctxt);
1785 int aac_consumer_get(struct aac_dev * dev, struct aac_queue * q, struct aac_entry **entry);
1786 void aac_consumer_free(struct aac_dev * dev, struct aac_queue * q, u32 qnum);
1787 int aac_fib_complete(struct fib * context);
1788 #define fib_data(fibctx) ((void *)(fibctx)->hw_fib->data)
1789 struct aac_dev *aac_init_adapter(struct aac_dev *dev);
1790 int aac_get_config_status(struct aac_dev *dev, int commit_flag);
1791 int aac_get_containers(struct aac_dev *dev);
1792 int aac_scsi_cmd(struct scsi_cmnd *cmd);
1793 int aac_dev_ioctl(struct aac_dev *dev, int cmd, void __user *arg);
1794 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg);
1795 int aac_rx_init(struct aac_dev *dev);
1796 int aac_rkt_init(struct aac_dev *dev);
1797 int aac_sa_init(struct aac_dev *dev);
1798 unsigned int aac_response_normal(struct aac_queue * q);
1799 unsigned int aac_command_normal(struct aac_queue * q);
1800 unsigned int aac_intr_normal(struct aac_dev * dev, u32 Index);
1801 int aac_check_health(struct aac_dev * dev);
1802 int aac_command_thread(void *data);
1803 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context *fibctx);
1804 int aac_fib_adapter_complete(struct fib * fibptr, unsigned short size);
1805 struct aac_driver_ident* aac_get_driver_ident(int devtype);
1806 int aac_get_adapter_info(struct aac_dev* dev);
1807 int aac_send_shutdown(struct aac_dev *dev);
1808 int aac_probe_container(struct aac_dev *dev, int cid);
1809 extern int numacb;
1810 extern int acbsize;
1811 extern char aac_driver_version[];
1812 extern int startup_timeout;
1813 extern int aif_timeout;