sys/dev/aac/aacvar.h

   1 /*-
   2  * Copyright (c) 2000 Michael Smith
   3  * Copyright (c) 2001 Scott Long
   4  * Copyright (c) 2000 BSDi
   5  * Copyright (c) 2001 Adaptec, Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      $FreeBSD$
  30  */
  31
  32 #include <sys/bio.h>
  33 #include <sys/callout.h>
  34 #include <sys/lock.h>
  35 #include <sys/mutex.h>
  36 #include <sys/taskqueue.h>
  37 #include <sys/selinfo.h>
  38 #include <geom/geom_disk.h>
  39
  40 #define AAC_TYPE_DEVO                   1
  41 #define AAC_TYPE_ALPHA                  2
  42 #define AAC_TYPE_BETA                   3
  43 #define AAC_TYPE_RELEASE                4
  44
  45 #define AAC_DRIVER_MAJOR_VERSION        2
  46 #define AAC_DRIVER_MINOR_VERSION        1
  47 #define AAC_DRIVER_BUGFIX_LEVEL         9
  48 #define AAC_DRIVER_TYPE                 AAC_TYPE_RELEASE
  49
  50 #ifndef AAC_DRIVER_BUILD
  51 # define AAC_DRIVER_BUILD 1
  52 #endif
  53
  54 /*
  55  * Driver Parameter Definitions
  56  */
  57
  58 /*
  59  * The firmware interface allows for a 16-bit s/g list length.  We limit
  60  * ourselves to a reasonable maximum and ensure alignment.
  61  */
  62 #define AAC_MAXSGENTRIES        64      /* max S/G entries, limit 65535 */
  63
  64 /*
  65  * We allocate a small set of FIBs for the adapter to use to send us messages.
  66  */
  67 #define AAC_ADAPTER_FIBS        8
  68
  69 /*
  70  * The controller reports status events in AIFs.  We hang on to a number of
  71  * these in order to pass them out to user-space management tools.
  72  */
  73 #define AAC_AIFQ_LENGTH         64
  74
  75 /*
  76  * Firmware messages are passed in the printf buffer.
  77  */
  78 #define AAC_PRINTF_BUFSIZE      256
  79
  80 /*
  81  * We wait this many seconds for the adapter to come ready if it is still
  82  * booting
  83  */
  84 #define AAC_BOOT_TIMEOUT        (3 * 60)
  85
  86 /*
  87  * Timeout for immediate commands.
  88  */
  89 #define AAC_IMMEDIATE_TIMEOUT   30              /* seconds */
  90
  91 /*
  92  * Timeout for normal commands
  93  */
  94 #define AAC_CMD_TIMEOUT         120             /* seconds */
  95
  96 /*
  97  * Rate at which we periodically check for timed out commands and kick the
  98  * controller.
  99  */
 100 #define AAC_PERIODIC_INTERVAL   20              /* seconds */
 101
 102 /*
 103  * Per-container data structure
 104  */
 105 struct aac_container
 106 {
 107         struct aac_mntobj               co_mntobj;
 108         device_t                        co_disk;
 109         int                             co_found;
 110         TAILQ_ENTRY(aac_container)      co_link;
 111 };
 112
 113 /*
 114  * Per-SIM data structure
 115  */
 116 struct aac_sim
 117 {
 118         device_t                sim_dev;
 119         int                     TargetsPerBus;
 120         int                     BusNumber;
 121         int                     InitiatorBusId;
 122         struct aac_softc        *aac_sc;
 123         TAILQ_ENTRY(aac_sim)    sim_link;
 124 };
 125
 126 /*
 127  * Per-disk structure
 128  */
 129 struct aac_disk
 130 {
 131         device_t                        ad_dev;
 132         struct aac_softc                *ad_controller;
 133         struct aac_container            *ad_container;
 134         struct disk                     *ad_disk;
 135         int                             ad_flags;
 136 #define AAC_DISK_OPEN   (1<<0)
 137         int                             ad_cylinders;
 138         int                             ad_heads;
 139         int                             ad_sectors;
 140         u_int64_t                       ad_size;
 141         int                             unit;
 142 };
 143
 144 /*
 145  * Per-command control structure.
 146  */
 147 struct aac_command
 148 {
 149         TAILQ_ENTRY(aac_command) cm_link;       /* list linkage */
 150
 151         struct aac_softc        *cm_sc;         /* controller that owns us */
 152
 153         struct aac_fib          *cm_fib;        /* FIB associated with this
 154                                                  * command */
 155         u_int64_t               cm_fibphys;     /* bus address of the FIB */
 156         struct bio              *cm_data;       /* pointer to data in kernel
 157                                                  * space */
 158         u_int32_t               cm_datalen;     /* data length */
 159         bus_dmamap_t            cm_datamap;     /* DMA map for bio data */
 160         struct aac_sg_table     *cm_sgtable;    /* pointer to s/g table in
 161                                                  * command */
 162         int                     cm_flags;
 163 #define AAC_CMD_MAPPED          (1<<0)          /* command has had its data
 164                                                  * mapped */
 165 #define AAC_CMD_DATAIN          (1<<1)          /* command involves data moving
 166                                                  * from controller to host */
 167 #define AAC_CMD_DATAOUT         (1<<2)          /* command involves data moving
 168                                                  * from host to controller */
 169 #define AAC_CMD_COMPLETED       (1<<3)          /* command has been completed */
 170 #define AAC_CMD_TIMEDOUT        (1<<4)          /* command taken too long */
 171 #define AAC_ON_AACQ_FREE        (1<<5)
 172 #define AAC_ON_AACQ_READY       (1<<6)
 173 #define AAC_ON_AACQ_BUSY        (1<<7)
 174 #define AAC_ON_AACQ_AIF         (1<<8)
 175 #define AAC_ON_AACQ_NORM        (1<<10)
 176 #define AAC_ON_AACQ_MASK        ((1<<5)|(1<<6)|(1<<7)|(1<<8)|(1<<10))
 177 #define AAC_QUEUE_FRZN          (1<<9)          /* Freeze the processing of
 178                                                  * commands on the queue. */
 179
 180         void                    (* cm_complete)(struct aac_command *cm);
 181         void                    *cm_private;
 182         time_t                  cm_timestamp;   /* command creation time */
 183         int                     cm_queue;
 184         int                     cm_index;
 185 };
 186
 187 struct aac_fibmap {
 188         TAILQ_ENTRY(aac_fibmap) fm_link;        /* list linkage */
 189         struct aac_fib          *aac_fibs;
 190         bus_dmamap_t            aac_fibmap;
 191         struct aac_command      *aac_commands;
 192 };
 193
 194 /*
 195  * We gather a number of adapter-visible items into a single structure.
 196  *
 197  * The ordering of this strucure may be important; we copy the Linux driver:
 198  *
 199  * Adapter FIBs
 200  * Init struct
 201  * Queue headers (Comm Area)
 202  * Printf buffer
 203  *
 204  * In addition, we add:
 205  * Sync Fib
 206  */
 207 struct aac_common {
 208         /* fibs for the controller to send us messages */
 209         struct aac_fib          ac_fibs[AAC_ADAPTER_FIBS];
 210
 211         /* the init structure */
 212         struct aac_adapter_init ac_init;
 213
 214         /* arena within which the queue structures are kept */
 215         u_int8_t                ac_qbuf[sizeof(struct aac_queue_table) +
 216                                 AAC_QUEUE_ALIGN];
 217
 218         /* buffer for text messages from the controller */
 219         char                    ac_printf[AAC_PRINTF_BUFSIZE];
 220
 221         /* fib for synchronous commands */
 222         struct aac_fib          ac_sync_fib;
 223 };
 224
 225 /*
 226  * Interface operations
 227  */
 228 struct aac_interface
 229 {
 230         int     (*aif_get_fwstatus)(struct aac_softc *sc);
 231         void    (*aif_qnotify)(struct aac_softc *sc, int qbit);
 232         int     (*aif_get_istatus)(struct aac_softc *sc);
 233         void    (*aif_clr_istatus)(struct aac_softc *sc, int mask);
 234         void    (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command,
 235                                    u_int32_t arg0, u_int32_t arg1,
 236                                    u_int32_t arg2, u_int32_t arg3);
 237         int     (*aif_get_mailbox)(struct aac_softc *sc, int mb);
 238         void    (*aif_set_interrupts)(struct aac_softc *sc, int enable);
 239         int (*aif_send_command)(struct aac_softc *sc, struct aac_command *cm);
 240         int (*aif_get_outb_queue)(struct aac_softc *sc);
 241         void (*aif_set_outb_queue)(struct aac_softc *sc, int index);
 242 };
 243 extern struct aac_interface     aac_rx_interface;
 244 extern struct aac_interface     aac_sa_interface;
 245 extern struct aac_interface     aac_fa_interface;
 246 extern struct aac_interface     aac_rkt_interface;
 247
 248 #define AAC_GET_FWSTATUS(sc)            ((sc)->aac_if.aif_get_fwstatus((sc)))
 249 #define AAC_QNOTIFY(sc, qbit)           ((sc)->aac_if.aif_qnotify((sc), (qbit)))
 250 #define AAC_GET_ISTATUS(sc)             ((sc)->aac_if.aif_get_istatus((sc)))
 251 #define AAC_CLEAR_ISTATUS(sc, mask)     ((sc)->aac_if.aif_clr_istatus((sc), \
 252                                         (mask)))
 253 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \
 254         ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \
 255         (arg3)))
 256 #define AAC_GET_MAILBOX(sc, mb)         ((sc)->aac_if.aif_get_mailbox((sc), \
 257                                         (mb)))
 258 #define AAC_MASK_INTERRUPTS(sc)         ((sc)->aac_if.aif_set_interrupts((sc), \
 259                                         0))
 260 #define AAC_UNMASK_INTERRUPTS(sc)       ((sc)->aac_if.aif_set_interrupts((sc), \
 261                                         1))
 262 #define AAC_SEND_COMMAND(sc, cm)        ((sc)->aac_if.aif_send_command((sc), (cm)))
 263 #define AAC_GET_OUTB_QUEUE(sc)          ((sc)->aac_if.aif_get_outb_queue((sc)))
 264 #define AAC_SET_OUTB_QUEUE(sc, idx)     ((sc)->aac_if.aif_set_outb_queue((sc), (idx)))
 265
 266 #define AAC_MEM0_SETREG4(sc, reg, val)  bus_space_write_4(sc->aac_btag0, \
 267                                         sc->aac_bhandle0, reg, val)
 268 #define AAC_MEM0_GETREG4(sc, reg)       bus_space_read_4(sc->aac_btag0, \
 269                                         sc->aac_bhandle0, reg)
 270 #define AAC_MEM0_SETREG2(sc, reg, val)  bus_space_write_2(sc->aac_btag0, \
 271                                         sc->aac_bhandle0, reg, val)
 272 #define AAC_MEM0_GETREG2(sc, reg)       bus_space_read_2(sc->aac_btag0, \
 273                                         sc->aac_bhandle0, reg)
 274 #define AAC_MEM0_SETREG1(sc, reg, val)  bus_space_write_1(sc->aac_btag0, \
 275                                         sc->aac_bhandle0, reg, val)
 276 #define AAC_MEM0_GETREG1(sc, reg)       bus_space_read_1(sc->aac_btag0, \
 277                                         sc->aac_bhandle0, reg)
 278
 279 #define AAC_MEM1_SETREG4(sc, reg, val)  bus_space_write_4(sc->aac_btag1, \
 280                                         sc->aac_bhandle1, reg, val)
 281 #define AAC_MEM1_GETREG4(sc, reg)       bus_space_read_4(sc->aac_btag1, \
 282                                         sc->aac_bhandle1, reg)
 283 #define AAC_MEM1_SETREG2(sc, reg, val)  bus_space_write_2(sc->aac_btag1, \
 284                                         sc->aac_bhandle1, reg, val)
 285 #define AAC_MEM1_GETREG2(sc, reg)       bus_space_read_2(sc->aac_btag1, \
 286                                         sc->aac_bhandle1, reg)
 287 #define AAC_MEM1_SETREG1(sc, reg, val)  bus_space_write_1(sc->aac_btag1, \
 288                                         sc->aac_bhandle1, reg, val)
 289 #define AAC_MEM1_GETREG1(sc, reg)       bus_space_read_1(sc->aac_btag1, \
 290                                         sc->aac_bhandle1, reg)
 291
 292 /* fib context (IOCTL) */
 293 struct aac_fib_context {
 294         u_int32_t               unique;
 295         int                     ctx_idx;
 296         int                     ctx_wrap;
 297         struct aac_fib_context *next, *prev;
 298 };
 299
 300 /*
 301  * Per-controller structure.
 302  */
 303 struct aac_softc
 304 {
 305         /* bus connections */
 306         device_t                aac_dev;
 307         struct resource         *aac_regs_res0, *aac_regs_res1; /* reg. if. window */
 308         int                     aac_regs_rid0, aac_regs_rid1;           /* resource ID */
 309         bus_space_handle_t      aac_bhandle0, aac_bhandle1;             /* bus space handle */
 310         bus_space_tag_t         aac_btag0, aac_btag1;           /* bus space tag */
 311         bus_dma_tag_t           aac_parent_dmat;        /* parent DMA tag */
 312         bus_dma_tag_t           aac_buffer_dmat;        /* data buffer/command
 313                                                          * DMA tag */
 314         struct resource         *aac_irq;               /* interrupt */
 315         int                     aac_irq_rid;
 316         void                    *aac_intr;              /* interrupt handle */
 317         eventhandler_tag        eh;
 318
 319         /* controller features, limits and status */
 320         int                     aac_state;
 321 #define AAC_STATE_SUSPEND       (1<<0)
 322 #define AAC_STATE_OPEN          (1<<1)
 323 #define AAC_STATE_INTERRUPTS_ON (1<<2)
 324 #define AAC_STATE_AIF_SLEEPER   (1<<3)
 325         int                     aac_open_cnt;
 326         struct FsaRevision              aac_revision;
 327
 328         /* controller hardware interface */
 329         int                     aac_hwif;
 330 #define AAC_HWIF_I960RX         0
 331 #define AAC_HWIF_STRONGARM      1
 332 #define AAC_HWIF_RKT            3
 333 #define AAC_HWIF_NARK           4
 334 #define AAC_HWIF_UNKNOWN        -1
 335         bus_dma_tag_t           aac_common_dmat;        /* common structure
 336                                                          * DMA tag */
 337         bus_dmamap_t            aac_common_dmamap;      /* common structure
 338                                                          * DMA map */
 339         struct aac_common       *aac_common;
 340         u_int32_t               aac_common_busaddr;
 341         struct aac_interface    aac_if;
 342
 343         /* command/fib resources */
 344         bus_dma_tag_t           aac_fib_dmat;   /* DMA tag for allocing FIBs */
 345         TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh;
 346         u_int                   total_fibs;
 347         struct aac_command      *aac_commands;
 348
 349         /* command management */
 350         TAILQ_HEAD(,aac_command) aac_free;      /* command structures
 351                                                  * available for reuse */
 352         TAILQ_HEAD(,aac_command) aac_ready;     /* commands on hold for
 353                                                  * controller resources */
 354         TAILQ_HEAD(,aac_command) aac_busy;
 355         TAILQ_HEAD(,aac_event)  aac_ev_cmfree;
 356         struct bio_queue_head   aac_bioq;
 357         struct aac_queue_table  *aac_queues;
 358         struct aac_queue_entry  *aac_qentries[AAC_QUEUE_COUNT];
 359
 360         struct aac_qstat        aac_qstat[AACQ_COUNT];  /* queue statistics */
 361
 362         /* connected containters */
 363         TAILQ_HEAD(,aac_container)      aac_container_tqh;
 364         struct mtx              aac_container_lock;
 365
 366         /*
 367          * The general I/O lock.  This protects the sync fib, the lists, the
 368          * queues, and the registers.
 369          */
 370         struct mtx              aac_io_lock;
 371
 372         /* delayed activity infrastructure */
 373         struct task             aac_task_complete;      /* deferred-completion
 374                                                          * task */
 375         struct intr_config_hook aac_ich;
 376
 377         /* management interface */
 378         struct cdev *aac_dev_t;
 379         struct mtx              aac_aifq_lock;
 380         struct aac_fib          aac_aifq[AAC_AIFQ_LENGTH];
 381         int                     aifq_idx;
 382         int                     aifq_filled;
 383         struct aac_fib_context *fibctx;
 384         struct selinfo          rcv_select;
 385         struct proc             *aifthread;
 386         int                     aifflags;
 387 #define AAC_AIFFLAGS_RUNNING    (1 << 0)
 388 #define AAC_AIFFLAGS_AIF        (1 << 1)
 389 #define AAC_AIFFLAGS_EXIT       (1 << 2)
 390 #define AAC_AIFFLAGS_EXITED     (1 << 3)
 391 #define AAC_AIFFLAGS_PRINTF     (1 << 4)
 392 #define AAC_AIFFLAGS_ALLOCFIBS  (1 << 5)
 393 #define AAC_AIFFLAGS_PENDING    (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \
 394                                  AAC_AIFFLAGS_ALLOCFIBS)
 395         u_int32_t               flags;
 396 #define AAC_FLAGS_PERC2QC       (1 << 0)
 397 #define AAC_FLAGS_ENABLE_CAM    (1 << 1)        /* No SCSI passthrough */
 398 #define AAC_FLAGS_CAM_NORESET   (1 << 2)        /* Fake SCSI resets */
 399 #define AAC_FLAGS_CAM_PASSONLY  (1 << 3)        /* Only create pass devices */
 400 #define AAC_FLAGS_SG_64BIT      (1 << 4)        /* Use 64-bit S/G addresses */
 401 #define AAC_FLAGS_4GB_WINDOW    (1 << 5)        /* Device can access host mem
 402                                                  * 2GB-4GB range */
 403 #define AAC_FLAGS_NO4GB         (1 << 6)        /* Can't access host mem >2GB */
 404 #define AAC_FLAGS_256FIBS       (1 << 7)        /* Can only do 256 commands */
 405 #define AAC_FLAGS_BROKEN_MEMMAP (1 << 8)        /* Broken HostPhysMemPages */
 406 #define AAC_FLAGS_SLAVE (1 << 9)
 407 #define AAC_FLAGS_MASTER        (1 << 10)
 408 #define AAC_FLAGS_NEW_COMM      (1 << 11)       /* New comm. interface supported */
 409 #define AAC_FLAGS_RAW_IO        (1 << 12)       /* Raw I/O interface */
 410 #define AAC_FLAGS_ARRAY_64BIT   (1 << 13)       /* 64-bit array size */
 411 #define AAC_FLAGS_LBA_64BIT     (1 << 14)       /* 64-bit LBA support */
 412
 413         u_int32_t               supported_options;
 414         u_int32_t               scsi_method_id;
 415         TAILQ_HEAD(,aac_sim)    aac_sim_tqh;
 416
 417         struct callout  aac_daemontime;         /* clock daemon callout */
 418
 419         u_int32_t       aac_max_fibs;           /* max. FIB count */
 420         u_int32_t       aac_max_fibs_alloc;             /* max. alloc. per alloc_commands() */
 421         u_int32_t       aac_max_fib_size;               /* max. FIB size */
 422         u_int32_t       aac_sg_tablesize;               /* max. sg count from host */
 423         u_int32_t       aac_max_sectors;                /* max. I/O size from host (blocks) */
 424 };
 425
 426 /*
 427  * Event callback mechanism for the driver
 428  */
 429 #define AAC_EVENT_NONE          0x00
 430 #define AAC_EVENT_CMFREE        0x01
 431 #define AAC_EVENT_MASK          0xff
 432 #define AAC_EVENT_REPEAT        0x100
 433
 434 typedef void aac_event_cb_t(struct aac_softc *sc, struct aac_event *event,
 435     void *arg);
 436 struct aac_event {
 437         TAILQ_ENTRY(aac_event)  ev_links;
 438         int                     ev_type;
 439         aac_event_cb_t          *ev_callback;
 440         void                    *ev_arg;
 441 };
 442
 443 /*
 444  * Public functions
 445  */
 446 extern void             aac_free(struct aac_softc *sc);
 447 extern int              aac_attach(struct aac_softc *sc);
 448 extern int              aac_detach(device_t dev);
 449 extern int              aac_shutdown(device_t dev);
 450 extern int              aac_suspend(device_t dev);
 451 extern int              aac_resume(device_t dev);
 452 extern void             aac_new_intr(void *arg);
 453 extern int              aac_filter(void *arg);
 454 extern void             aac_submit_bio(struct bio *bp);
 455 extern void             aac_biodone(struct bio *bp);
 456 extern void             aac_startio(struct aac_softc *sc);
 457 extern int              aac_alloc_command(struct aac_softc *sc,
 458                                           struct aac_command **cmp);
 459 extern void             aac_release_command(struct aac_command *cm);
 460 extern int              aac_sync_fib(struct aac_softc *sc, u_int32_t command,
 461                                      u_int32_t xferstate, struct aac_fib *fib,
 462                                      u_int16_t datasize);
 463 extern void             aac_add_event(struct aac_softc *sc, struct aac_event
 464                                       *event);
 465
 466 #ifdef AAC_DEBUG
 467 extern int      aac_debug_enable;
 468 # define fwprintf(sc, flags, fmt, args...)                              \
 469 do {                                                                    \
 470         if (!aac_debug_enable)                                          \
 471                 break;                                                  \
 472         if (sc != NULL)                                                 \
 473                 device_printf(((struct aac_softc *)sc)->aac_dev,        \
 474                     "%s: " fmt "\n", __func__, ##args);                 \
 475         else                                                            \
 476                 printf("%s: " fmt "\n", __func__, ##args);              \
 477 } while(0)
 478
 479 extern void     aac_print_queues(struct aac_softc *sc);
 480 extern void     aac_panic(struct aac_softc *sc, char *reason);
 481 extern void     aac_print_fib(struct aac_softc *sc, struct aac_fib *fib,
 482                               const char *caller);
 483 extern void     aac_print_aif(struct aac_softc *sc,
 484                               struct aac_aif_command *aif);
 485
 486 #define AAC_PRINT_FIB(sc, fib)  aac_print_fib(sc, fib, __func__)
 487
 488 #else
 489 # define fwprintf(sc, flags, fmt, args...)
 490
 491 # define aac_print_queues(sc)
 492 # define aac_panic(sc, reason)
 493
 494 # define AAC_PRINT_FIB(sc, fib)
 495 # define aac_print_aif(sc, aac_aif_command)
 496 #endif
 497
 498 struct aac_code_lookup {
 499         char    *string;
 500         u_int32_t       code;
 501 };
 502
 503 /*
 504  * Queue primitives for driver queues.
 505  */
 506 #define AACQ_ADD(sc, qname)                                     \
 507         do {                                                    \
 508                 struct aac_qstat *qs;                           \
 509                                                                 \
 510                 qs = &(sc)->aac_qstat[qname];                   \
 511                                                                 \
 512                 qs->q_length++;                                 \
 513                 if (qs->q_length > qs->q_max)                   \
 514                         qs->q_max = qs->q_length;               \
 515         } while (0)
 516
 517 #define AACQ_REMOVE(sc, qname)    (sc)->aac_qstat[qname].q_length--
 518 #define AACQ_INIT(sc, qname)                            \
 519         do {                                            \
 520                 sc->aac_qstat[qname].q_length = 0;      \
 521                 sc->aac_qstat[qname].q_max = 0;         \
 522         } while (0)
 523
 524
 525 #define AACQ_COMMAND_QUEUE(name, index)                                 \
 526 static __inline void                                                    \
 527 aac_initq_ ## name (struct aac_softc *sc)                               \
 528 {                                                                       \
 529         TAILQ_INIT(&sc->aac_ ## name);                                  \
 530         AACQ_INIT(sc, index);                                           \
 531 }                                                                       \
 532 static __inline void                                                    \
 533 aac_enqueue_ ## name (struct aac_command *cm)                           \
 534 {                                                                       \
 535         if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) {                   \
 536                 printf("command %p is on another queue, flags = %#x\n", \
 537                        cm, cm->cm_flags);                               \
 538                 panic("command is on another queue");                   \
 539         }                                                               \
 540         TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link);       \
 541         cm->cm_flags |= AAC_ON_ ## index;                               \
 542         AACQ_ADD(cm->cm_sc, index);                                     \
 543 }                                                                       \
 544 static __inline void                                                    \
 545 aac_requeue_ ## name (struct aac_command *cm)                           \
 546 {                                                                       \
 547         if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) {                   \
 548                 printf("command %p is on another queue, flags = %#x\n", \
 549                        cm, cm->cm_flags);                               \
 550                 panic("command is on another queue");                   \
 551         }                                                               \
 552         TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link);       \
 553         cm->cm_flags |= AAC_ON_ ## index;                               \
 554         AACQ_ADD(cm->cm_sc, index);                                     \
 555 }                                                                       \
 556 static __inline struct aac_command *                                    \
 557 aac_dequeue_ ## name (struct aac_softc *sc)                             \
 558 {                                                                       \
 559         struct aac_command *cm;                                         \
 560                                                                         \
 561         if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) {            \
 562                 if ((cm->cm_flags & AAC_ON_ ## index) == 0) {           \
 563                         printf("command %p not in queue, flags = %#x, " \
 564                                "bit = %#x\n", cm, cm->cm_flags,         \
 565                                AAC_ON_ ## index);                       \
 566                         panic("command not in queue");                  \
 567                 }                                                       \
 568                 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link);           \
 569                 cm->cm_flags &= ~AAC_ON_ ## index;                      \
 570                 AACQ_REMOVE(sc, index);                                 \
 571         }                                                               \
 572         return(cm);                                                     \
 573 }                                                                       \
 574 static __inline void                                                    \
 575 aac_remove_ ## name (struct aac_command *cm)                            \
 576 {                                                                       \
 577         if ((cm->cm_flags & AAC_ON_ ## index) == 0) {                   \
 578                 printf("command %p not in queue, flags = %#x, "         \
 579                        "bit = %#x\n", cm, cm->cm_flags,                 \
 580                        AAC_ON_ ## index);                               \
 581                 panic("command not in queue");                          \
 582         }                                                               \
 583         TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link);            \
 584         cm->cm_flags &= ~AAC_ON_ ## index;                              \
 585         AACQ_REMOVE(cm->cm_sc, index);                                  \
 586 }                                                                       \
 587 struct hack
 588
 589 AACQ_COMMAND_QUEUE(free, AACQ_FREE);
 590 AACQ_COMMAND_QUEUE(ready, AACQ_READY);
 591 AACQ_COMMAND_QUEUE(busy, AACQ_BUSY);
 592
 593 /*
 594  * outstanding bio queue
 595  */
 596 static __inline void
 597 aac_initq_bio(struct aac_softc *sc)
 598 {
 599         bioq_init(&sc->aac_bioq);
 600         AACQ_INIT(sc, AACQ_BIO);
 601 }
 602
 603 static __inline void
 604 aac_enqueue_bio(struct aac_softc *sc, struct bio *bp)
 605 {
 606         bioq_insert_tail(&sc->aac_bioq, bp);
 607         AACQ_ADD(sc, AACQ_BIO);
 608 }
 609
 610 static __inline struct bio *
 611 aac_dequeue_bio(struct aac_softc *sc)
 612 {
 613         struct bio *bp;
 614
 615         if ((bp = bioq_first(&sc->aac_bioq)) != NULL) {
 616                 bioq_remove(&sc->aac_bioq, bp);
 617                 AACQ_REMOVE(sc, AACQ_BIO);
 618         }
 619         return(bp);
 620 }
 621
 622 static __inline void
 623 aac_print_printf(struct aac_softc *sc)
 624 {
 625         /*
 626          * XXX We have the ability to read the length of the printf string
 627          * from out of the mailboxes.
 628          */
 629         device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE,
 630                       sc->aac_common->ac_printf);
 631         sc->aac_common->ac_printf[0] = 0;
 632         AAC_QNOTIFY(sc, AAC_DB_PRINTF);
 633 }
 634
 635 static __inline int
 636 aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib)
 637 {
 638
 639         mtx_assert(&sc->aac_io_lock, MA_OWNED);
 640         *fib = &sc->aac_common->ac_sync_fib;
 641         return (0);
 642 }
 643
 644 static __inline void
 645 aac_release_sync_fib(struct aac_softc *sc)
 646 {
 647
 648         mtx_assert(&sc->aac_io_lock, MA_OWNED);
 649 }
 650