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