drivers/scsi/aacraid/aacraid.h

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