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