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