sys/dev/raid/mfi/mfivar.h

   1 /*-
   2  * Copyright (c) 2006 IronPort Systems
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26 /*-
  27  * Copyright (c) 2007 LSI Corp.
  28  * Copyright (c) 2007 Rajesh Prabhakaran.
  29  * All rights reserved.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * $FreeBSD: src/sys/dev/mfi/mfivar.h,v 1.14 2011/09/29 08:37:53 mav Exp $
  53  * FreeBSD projects/head_mfi/ r232949
  54  */
  55
  56 #ifndef _MFIVAR_H
  57 #define _MFIVAR_H
  58
  59 #include <sys/devicestat.h>
  60 #include <sys/disk.h>
  61 #include <sys/eventhandler.h>
  62 #include <sys/lock.h>
  63 #include <sys/sysctl.h>
  64 #include <sys/taskqueue.h>
  65
  66 /*
  67  * SCSI structures and definitions are used from here, but no linking
  68  * requirements are made to CAM.
  69  */
  70 #include <bus/cam/scsi/scsi_all.h>
  71
  72 struct mfi_hwcomms {
  73         uint32_t                hw_pi;
  74         uint32_t                hw_ci;
  75         uint32_t                hw_reply_q[1];
  76 };
  77
  78 #define MEGASAS_MAX_NAME        32
  79 #define MEGASAS_VERSION         "4.23"
  80
  81 struct mfi_softc;
  82 struct disk;
  83 struct ccb_hdr;
  84
  85 struct mfi_command {
  86         TAILQ_ENTRY(mfi_command) cm_link;
  87         time_t                  cm_timestamp;
  88         struct mfi_softc        *cm_sc;
  89         union mfi_frame         *cm_frame;
  90         bus_addr_t              cm_frame_busaddr;
  91         struct mfi_sense        *cm_sense;
  92         bus_addr_t              cm_sense_busaddr;
  93         bus_dmamap_t            cm_dmamap;
  94         union mfi_sgl           *cm_sg;
  95         void                    *cm_data;
  96         int                     cm_len;
  97         int                     cm_stp_len;
  98         int                     cm_total_frame_size;
  99         int                     cm_extra_frames;
 100         int                     cm_flags;
 101 #define MFI_CMD_MAPPED          (1<<0)
 102 #define MFI_CMD_DATAIN          (1<<1)
 103 #define MFI_CMD_DATAOUT         (1<<2)
 104 #define MFI_CMD_COMPLETED       (1<<3)
 105 #define MFI_CMD_POLLED          (1<<4)
 106 #define MFI_ON_MFIQ_FREE        (1<<5)
 107 #define MFI_ON_MFIQ_READY       (1<<6)
 108 #define MFI_ON_MFIQ_BUSY        (1<<7)
 109 #define MFI_ON_MFIQ_MASK        ((1<<5)|(1<<6)|(1<<7))
 110         int                     cm_aen_abort;
 111         uint8_t                 retry_for_fw_reset;
 112         void                    (* cm_complete)(struct mfi_command *cm);
 113         void                    *cm_private;
 114         int                     cm_index;
 115         int                     cm_error;
 116 };
 117
 118 /*
 119  * XXX swildner
 120  *
 121  * At the moment we rely on mfi_disk and mfi_system_pd having the same size.
 122  * A future cleanup should merge them.
 123  */
 124 struct mfi_disk {
 125         TAILQ_ENTRY(mfi_disk)   ld_link;
 126         device_t        ld_dev;
 127         cdev_t          ld_dev_t;
 128         int             ld_id;
 129         int             ld_unit;
 130         struct mfi_softc *ld_controller;
 131         struct mfi_ld_info      *ld_info;
 132         struct disk     ld_disk;
 133         struct devstat  ld_devstat;
 134         int             ld_flags;
 135 #define MFI_DISK_FLAGS_OPEN     0x01
 136 #define MFI_DISK_FLAGS_DISABLED 0x02
 137 #define MFI_DISK_FLAGS_SYSPD    0x04
 138 };
 139
 140 struct mfi_system_pd {
 141         TAILQ_ENTRY(mfi_system_pd)      pd_link;
 142         device_t        pd_dev;
 143         cdev_t          pd_dev_t;
 144         int             pd_id;
 145         int             pd_unit;
 146         struct mfi_softc *pd_controller;
 147         struct mfi_pd_info      *pd_info;
 148         struct disk     pd_disk;
 149         struct devstat  pd_devstat;
 150         int             pd_flags;
 151 };
 152
 153 struct mfi_evt_queue_elm {
 154         TAILQ_ENTRY(mfi_evt_queue_elm)  link;
 155         struct mfi_evt_detail           detail;
 156 };
 157
 158 struct mfi_aen {
 159         TAILQ_ENTRY(mfi_aen) aen_link;
 160         struct proc                     *p;
 161 };
 162
 163 struct mfi_skinny_dma_info {
 164         bus_dma_tag_t   dmat[514];
 165         bus_dmamap_t    dmamap[514];
 166         uint32_t        mem[514];
 167         int             noofmaps;
 168 };
 169
 170 struct mfi_cmd_tbolt;
 171 typedef struct {
 172         volatile unsigned int val;
 173 } atomic_t;
 174
 175 #define atomic_read(v)  ((v)->val)
 176 #define atomic_set(v,i) ((v)->val - (i))
 177
 178 struct mfi_softc {
 179         device_t                        mfi_dev;
 180         int                             mfi_flags;
 181 #define MFI_FLAGS_SG64          (1<<0)
 182 #define MFI_FLAGS_QFRZN         (1<<1)
 183 #define MFI_FLAGS_OPEN          (1<<2)
 184 #define MFI_FLAGS_STOP          (1<<3)
 185 #define MFI_FLAGS_1064R         (1<<4)
 186 #define MFI_FLAGS_1078          (1<<5)
 187 #define MFI_FLAGS_GEN2          (1<<6)
 188 #define MFI_FLAGS_SKINNY        (1<<7)
 189 #define MFI_FLAGS_TBOLT         (1<<8)
 190 #define MFI_FLAGS_MRSAS         (1<<9)
 191         // Start: LSIP200113393
 192         bus_dma_tag_t                   verbuf_h_dmat;
 193         bus_dmamap_t                    verbuf_h_dmamap;
 194         uint32_t                        verbuf_h_busaddr;
 195         uint32_t                        *verbuf;
 196         void                            *kbuff_arr[MAX_IOCTL_SGE];
 197         bus_dma_tag_t                   mfi_kbuff_arr_dmat[2];
 198         bus_dmamap_t                    mfi_kbuff_arr_dmamap[2];
 199         bus_addr_t                      mfi_kbuff_arr_busaddr[2];
 200
 201         struct mfi_hwcomms              *mfi_comms;
 202         TAILQ_HEAD(,mfi_command)        mfi_free;
 203         TAILQ_HEAD(,mfi_command)        mfi_ready;
 204         TAILQ_HEAD(BUSYQ,mfi_command)   mfi_busy;
 205         struct bio_queue_head           mfi_bioq;
 206         struct mfi_qstat                mfi_qstat[MFIQ_COUNT];
 207
 208         struct resource                 *mfi_regs_resource;
 209         bus_space_handle_t              mfi_bhandle;
 210         bus_space_tag_t                 mfi_btag;
 211         int                             mfi_regs_rid;
 212
 213         bus_dma_tag_t                   mfi_parent_dmat;
 214         bus_dma_tag_t                   mfi_buffer_dmat;
 215
 216         bus_dma_tag_t                   mfi_comms_dmat;
 217         bus_dmamap_t                    mfi_comms_dmamap;
 218         bus_addr_t                      mfi_comms_busaddr;
 219
 220         bus_dma_tag_t                   mfi_frames_dmat;
 221         bus_dmamap_t                    mfi_frames_dmamap;
 222         bus_addr_t                      mfi_frames_busaddr;
 223         union mfi_frame                 *mfi_frames;
 224
 225         bus_dma_tag_t                   mfi_tb_init_dmat;
 226         bus_dmamap_t                    mfi_tb_init_dmamap;
 227         bus_addr_t                      mfi_tb_init_busaddr;
 228         bus_addr_t                      mfi_tb_ioc_init_busaddr;
 229         union mfi_frame                 *mfi_tb_init;
 230
 231         TAILQ_HEAD(,mfi_evt_queue_elm)  mfi_evt_queue;
 232         struct task                     mfi_evt_task;
 233         TAILQ_HEAD(,mfi_aen)            mfi_aen_pids;
 234         struct mfi_command              *mfi_aen_cm;
 235         struct mfi_command              *mfi_skinny_cm;
 236         uint32_t                        mfi_aen_triggered;
 237         uint32_t                        mfi_poll_waiting;
 238         struct kqinfo                   mfi_kq;
 239         uint32_t                        mfi_boot_seq_num;
 240         int                             mfi_delete_busy_volumes;
 241         int                             mfi_keep_deleted_volumes;
 242         int                             mfi_detaching;
 243
 244         bus_dma_tag_t                   mfi_sense_dmat;
 245         bus_dmamap_t                    mfi_sense_dmamap;
 246         uint32_t                        mfi_sense_busaddr;
 247         struct mfi_sense                *mfi_sense;
 248
 249         struct resource                 *mfi_irq;
 250         void                            *mfi_intr;
 251         int                             mfi_irq_rid;
 252         int                             mfi_irq_type;
 253
 254         struct intr_config_hook         mfi_ich;
 255         eventhandler_tag                eh;
 256         /* OCR flags */
 257         atomic_t fw_reset_no_pci_access;
 258         uint8_t adpreset;
 259         uint8_t issuepend_done;
 260         uint8_t disableOnlineCtrlReset;
 261         uint32_t mfiStatus;
 262         uint32_t last_seq_num;
 263         uint32_t volatile hw_crit_error;
 264
 265         /*
 266          * Allocation for the command array.  Used as an indexable array to
 267          * recover completed commands.
 268          */
 269         struct mfi_command              *mfi_commands;
 270         /*
 271          * How many commands were actually allocated
 272          */
 273         int                             mfi_total_cmds;
 274         /*
 275          * How many commands the firmware can handle.  Also how big the reply
 276          * queue is, minus 1.
 277          */
 278         int                             mfi_max_fw_cmds;
 279         /*
 280          * How many S/G elements we'll ever actually use
 281          */
 282         int                             mfi_max_sge;
 283         /*
 284          * How many bytes a compound frame is, including all of the extra frames
 285          * that are used for S/G elements.
 286          */
 287         int                             mfi_cmd_size;
 288         /*
 289          * How large an S/G element is.  Used to calculate the number of single
 290          * frames in a command.
 291          */
 292         int                             mfi_sge_size;
 293         /*
 294          * Max number of sectors that the firmware allows
 295          */
 296         uint32_t                        mfi_max_io;
 297
 298         TAILQ_HEAD(,mfi_disk)           mfi_ld_tqh;
 299         TAILQ_HEAD(,mfi_system_pd)      mfi_syspd_tqh;
 300         eventhandler_tag                mfi_eh;
 301         struct cdev                     *mfi_cdev;
 302
 303         TAILQ_HEAD(, ccb_hdr)           mfi_cam_ccbq;
 304         struct mfi_command *            (* mfi_cam_start)(void *);
 305         struct callout                  mfi_watchdog_callout;
 306         struct lock                     mfi_io_lock;
 307         struct lock                     mfi_config_lock;
 308
 309         struct sysctl_ctx_list          mfi_sysctl_ctx;
 310         struct sysctl_oid               *mfi_sysctl_tree;
 311
 312         /* Controller type specific interfaces */
 313         void    (*mfi_enable_intr)(struct mfi_softc *sc);
 314         void    (*mfi_disable_intr)(struct mfi_softc *sc);
 315         int32_t (*mfi_read_fw_status)(struct mfi_softc *sc);
 316         int     (*mfi_check_clear_intr)(struct mfi_softc *sc);
 317         void    (*mfi_issue_cmd)(struct mfi_softc *sc, bus_addr_t bus_add,
 318                     uint32_t frame_cnt);
 319         int     (*mfi_adp_reset)(struct mfi_softc *sc);
 320         int     (*mfi_adp_check_reset)(struct mfi_softc *sc);
 321
 322         /* ThunderBolt */
 323         uint32_t                        mfi_tbolt;
 324         uint32_t                        MFA_enabled;
 325         uint64_t                        map_id;
 326         struct mfi_command              *map_update_cmd;
 327         /* Single Reply structure size */
 328         uint16_t                        reply_size;
 329         /* Singler message size. */
 330         uint16_t                        raid_io_msg_size;
 331         TAILQ_HEAD(TB, mfi_cmd_tbolt)   mfi_cmd_tbolt_tqh;
 332         /* ThunderBolt base contiguous memory mapping. */
 333         bus_dma_tag_t                   mfi_tb_dmat;
 334         bus_dmamap_t                    mfi_tb_dmamap;
 335         bus_addr_t                      mfi_tb_busaddr;
 336         /* ThunderBolt Contiguous DMA memory Mapping */
 337         uint8_t *                       request_message_pool;
 338         uint8_t *                       request_message_pool_align;
 339         uint8_t *                       request_desc_pool;
 340         //uint32_t                      request_desc_busaddr;
 341         bus_addr_t                      request_msg_busaddr;
 342         bus_addr_t                      reply_frame_busaddr;
 343         bus_addr_t                      sg_frame_busaddr;
 344         /* ThunderBolt IOC Init Descriptor */
 345         bus_dma_tag_t                   mfi_tb_ioc_init_dmat;
 346         bus_dmamap_t                    mfi_tb_ioc_init_dmamap;
 347         uint8_t *                       mfi_tb_ioc_init_desc;
 348         struct mfi_cmd_tbolt            **mfi_cmd_pool_tbolt;
 349         /* Virtual address of reply Frame Pool */
 350         struct mfi_mpi2_reply_header*   reply_frame_pool;
 351         struct mfi_mpi2_reply_header*   reply_frame_pool_align;
 352
 353         /* Last reply frame address */
 354         uint8_t *                       reply_pool_limit;
 355         uint16_t                        last_reply_idx;
 356         uint8_t                         max_SGEs_in_chain_message;
 357         uint8_t                         max_SGEs_in_main_message;
 358         uint8_t                         chain_offset_value_for_main_message;
 359         uint8_t                         chain_offset_value_for_mpt_ptmsg;
 360 };
 361
 362 union desc_value {
 363         uint64_t        word;
 364         struct {
 365                 uint32_t        low;
 366                 uint32_t        high;
 367         }u;
 368 };
 369
 370 // TODO find the right definition
 371 #define XXX_MFI_CMD_OP_INIT2                    0x9
 372 /*
 373  * Request descriptor types
 374  */
 375 #define MFI_REQ_DESCRIPT_FLAGS_LD_IO           0x7
 376 #define MFI_REQ_DESCRIPT_FLAGS_MFA             0x1
 377 #define MFI_REQ_DESCRIPT_FLAGS_TYPE_SHIFT       0x1
 378 #define MFI_FUSION_FP_DEFAULT_TIMEOUT           0x14
 379 #define MFI_LOAD_BALANCE_FLAG                   0x1
 380 #define MFI_DCMD_MBOX_PEND_FLAG                 0x1
 381
 382 //#define MR_PROT_INFO_TYPE_CONTROLLER  0x08
 383 #define MEGASAS_SCSI_VARIABLE_LENGTH_CMD        0x7f
 384 #define MEGASAS_SCSI_SERVICE_ACTION_READ32      0x9
 385 #define MEGASAS_SCSI_SERVICE_ACTION_WRITE32     0xB
 386 #define MEGASAS_SCSI_ADDL_CDB_LEN               0x18
 387 #define MEGASAS_RD_WR_PROTECT_CHECK_ALL         0x20
 388 #define MEGASAS_RD_WR_PROTECT_CHECK_NONE        0x60
 389 #define MEGASAS_EEDPBLOCKSIZE                   512
 390 struct mfi_cmd_tbolt {
 391         union mfi_mpi2_request_descriptor *request_desc;
 392         struct mfi_mpi2_request_raid_scsi_io *io_request;
 393         bus_addr_t              io_request_phys_addr;
 394         bus_addr_t              sg_frame_phys_addr;
 395         bus_addr_t              sense_phys_addr;
 396         MPI2_SGE_IO_UNION       *sg_frame;
 397         uint8_t                 *sense;
 398         TAILQ_ENTRY(mfi_cmd_tbolt) next;
 399         /*
 400          * Context for a MFI frame.
 401          * Used to get the mfi cmd from list when a MFI cmd is completed
 402          */
 403         uint32_t                sync_cmd_idx;
 404         uint16_t                index;
 405         uint8_t                 status;
 406 };
 407
 408 extern int mfi_attach(struct mfi_softc *);
 409 extern void mfi_free(struct mfi_softc *);
 410 extern int mfi_shutdown(struct mfi_softc *);
 411 extern void mfi_startio(struct mfi_softc *);
 412 extern void mfi_disk_complete(struct bio *);
 413 extern int mfi_disk_disable(struct mfi_disk *);
 414 extern void mfi_disk_enable(struct mfi_disk *);
 415 extern int mfi_dump_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
 416 extern int mfi_syspd_disable(struct mfi_system_pd *);
 417 extern void mfi_syspd_enable(struct mfi_system_pd *);
 418 extern int mfi_dump_syspd_blocks(struct mfi_softc *, int id, uint64_t, void *,
 419     int);
 420 extern int mfi_transition_firmware(struct mfi_softc *sc);
 421 extern int mfi_aen_setup(struct mfi_softc *sc, uint32_t seq_start);
 422 extern void mfi_complete(struct mfi_softc *sc, struct mfi_command *cm);
 423 extern int mfi_mapcmd(struct mfi_softc *sc,struct mfi_command *cm);
 424 extern int mfi_wait_command(struct mfi_softc *sc, struct mfi_command *cm);
 425 extern void mfi_tbolt_enable_intr_ppc(struct mfi_softc *);
 426 extern void mfi_tbolt_disable_intr_ppc(struct mfi_softc *);
 427 extern int32_t mfi_tbolt_read_fw_status_ppc(struct mfi_softc *);
 428 extern int32_t mfi_tbolt_check_clear_intr_ppc(struct mfi_softc *);
 429 extern void mfi_tbolt_issue_cmd_ppc(struct mfi_softc *, bus_addr_t, uint32_t);
 430 extern void mfi_tbolt_init_globals(struct mfi_softc*);
 431 extern uint32_t mfi_tbolt_get_memory_requirement(struct mfi_softc *);
 432 extern int mfi_tbolt_init_desc_pool(struct mfi_softc *, uint8_t *, uint32_t);
 433 extern int mfi_tbolt_init_MFI_queue(struct mfi_softc *);
 434 extern void mfi_intr_tbolt(void *arg);
 435 extern int mfi_tbolt_alloc_cmd(struct mfi_softc *sc);
 436 extern int mfi_tbolt_send_frame(struct mfi_softc *sc, struct mfi_command *cm);
 437 extern int mfi_tbolt_adp_reset(struct mfi_softc *sc);
 438 extern int mfi_tbolt_reset(struct mfi_softc *sc);
 439 extern int mfi_tbolt_sync_map_info(struct mfi_softc *sc);
 440
 441 #define MFIQ_ADD(sc, qname)                                     \
 442         do {                                                    \
 443                 struct mfi_qstat *qs;                           \
 444                                                                 \
 445                 qs = &(sc)->mfi_qstat[qname];                   \
 446                 qs->q_length++;                                 \
 447                 if (qs->q_length > qs->q_max)                   \
 448                         qs->q_max = qs->q_length;               \
 449         } while (0)
 450
 451 #define MFIQ_REMOVE(sc, qname)  (sc)->mfi_qstat[qname].q_length--
 452
 453 #define MFIQ_INIT(sc, qname)                                    \
 454         do {                                                    \
 455                 sc->mfi_qstat[qname].q_length = 0;              \
 456                 sc->mfi_qstat[qname].q_max = 0;                 \
 457         } while (0)
 458
 459 #define MFIQ_COMMAND_QUEUE(name, index)                                 \
 460         static __inline void                                            \
 461         mfi_initq_ ## name (struct mfi_softc *sc)                       \
 462         {                                                               \
 463                 TAILQ_INIT(&sc->mfi_ ## name);                          \
 464                 MFIQ_INIT(sc, index);                                   \
 465         }                                                               \
 466         static __inline void                                            \
 467         mfi_enqueue_ ## name (struct mfi_command *cm)                   \
 468         {                                                               \
 469                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 470                         kprintf("command %p is on another queue, "      \
 471                             "flags = %#x\n", cm, cm->cm_flags);         \
 472                         panic("command is on another queue");           \
 473                 }                                                       \
 474                 TAILQ_INSERT_TAIL(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 475                 cm->cm_flags |= MFI_ON_ ## index;                       \
 476                 MFIQ_ADD(cm->cm_sc, index);                             \
 477         }                                                               \
 478         static __inline void                                            \
 479         mfi_requeue_ ## name (struct mfi_command *cm)                   \
 480         {                                                               \
 481                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 482                         kprintf("command %p is on another queue, "      \
 483                             "flags = %#x\n", cm, cm->cm_flags);         \
 484                         panic("command is on another queue");           \
 485                 }                                                       \
 486                 TAILQ_INSERT_HEAD(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 487                 cm->cm_flags |= MFI_ON_ ## index;                       \
 488                 MFIQ_ADD(cm->cm_sc, index);                             \
 489         }                                                               \
 490         static __inline struct mfi_command *                            \
 491         mfi_dequeue_ ## name (struct mfi_softc *sc)                     \
 492         {                                                               \
 493                 struct mfi_command *cm;                                 \
 494                                                                         \
 495                 if ((cm = TAILQ_FIRST(&sc->mfi_ ## name)) != NULL) {    \
 496                         if ((cm->cm_flags & MFI_ON_ ## index) == 0) {   \
 497                                 kprintf("command %p not in queue, "     \
 498                                     "flags = %#x, bit = %#x\n", cm,     \
 499                                     cm->cm_flags, MFI_ON_ ## index);    \
 500                                 panic("command not in queue");          \
 501                         }                                               \
 502                         TAILQ_REMOVE(&sc->mfi_ ## name, cm, cm_link);   \
 503                         cm->cm_flags &= ~MFI_ON_ ## index;              \
 504                         MFIQ_REMOVE(sc, index);                         \
 505                 }                                                       \
 506                 return (cm);                                            \
 507         }                                                               \
 508         static __inline void                                            \
 509         mfi_remove_ ## name (struct mfi_command *cm)                    \
 510         {                                                               \
 511                 if ((cm->cm_flags & MFI_ON_ ## index) == 0) {           \
 512                         kprintf("command %p not in queue, flags = %#x, " \
 513                             "bit = %#x\n", cm, cm->cm_flags,            \
 514                             MFI_ON_ ## index);                          \
 515                         panic("command not in queue");                  \
 516                 }                                                       \
 517                 TAILQ_REMOVE(&cm->cm_sc->mfi_ ## name, cm, cm_link);    \
 518                 cm->cm_flags &= ~MFI_ON_ ## index;                      \
 519                 MFIQ_REMOVE(cm->cm_sc, index);                          \
 520         }                                                               \
 521 struct hack
 522
 523 MFIQ_COMMAND_QUEUE(free, MFIQ_FREE);
 524 MFIQ_COMMAND_QUEUE(ready, MFIQ_READY);
 525 MFIQ_COMMAND_QUEUE(busy, MFIQ_BUSY);
 526
 527 static __inline void
 528 mfi_initq_bio(struct mfi_softc *sc)
 529 {
 530         bioq_init(&sc->mfi_bioq);
 531         MFIQ_INIT(sc, MFIQ_BIO);
 532 }
 533
 534 static __inline void
 535 mfi_enqueue_bio(struct mfi_softc *sc, struct bio *bp)
 536 {
 537         bioq_insert_tail(&sc->mfi_bioq, bp);
 538         MFIQ_ADD(sc, MFIQ_BIO);
 539 }
 540
 541 static __inline struct bio *
 542 mfi_dequeue_bio(struct mfi_softc *sc)
 543 {
 544         struct bio *bp;
 545
 546         if ((bp = bioq_first(&sc->mfi_bioq)) != NULL) {
 547                 bioq_remove(&sc->mfi_bioq, bp);
 548                 MFIQ_REMOVE(sc, MFIQ_BIO);
 549         }
 550         return (bp);
 551 }
 552
 553 static __inline void
 554 mfi_print_sense(struct mfi_softc *sc, void *sense)
 555 {
 556         int error, key, asc, ascq;
 557
 558         scsi_extract_sense((struct scsi_sense_data *)sense,
 559             &error, &key, &asc, &ascq);
 560         device_printf(sc->mfi_dev, "sense error %d, sense_key %d, "
 561             "asc %d, ascq %d\n", error, key, asc, ascq);
 562 }
 563
 564 /* XXX
 565  *
 566  * Mimics FreeBSD's mtx_assert() behavior.
 567  * We might want a global lockassert() function in the future.
 568  */
 569 static __inline void
 570 mfi_lockassert(struct lock *lockp)
 571 {
 572         if (panicstr == NULL && !dumping)
 573                 KKASSERT(lockstatus(lockp, curthread) != 0);
 574 }
 575
 576 #define MFI_WRITE4(sc, reg, val)        bus_space_write_4((sc)->mfi_btag, \
 577         sc->mfi_bhandle, (reg), (val))
 578 #define MFI_READ4(sc, reg)              bus_space_read_4((sc)->mfi_btag, \
 579         (sc)->mfi_bhandle, (reg))
 580 #define MFI_WRITE2(sc, reg, val)        bus_space_write_2((sc)->mfi_btag, \
 581         sc->mfi_bhandle, (reg), (val))
 582 #define MFI_READ2(sc, reg)              bus_space_read_2((sc)->mfi_btag, \
 583         (sc)->mfi_bhandle, (reg))
 584 #define MFI_WRITE1(sc, reg, val)        bus_space_write_1((sc)->mfi_btag, \
 585         sc->mfi_bhandle, (reg), (val))
 586 #define MFI_READ1(sc, reg)              bus_space_read_1((sc)->mfi_btag, \
 587         (sc)->mfi_bhandle, (reg))
 588
 589 MALLOC_DECLARE(M_MFIBUF);
 590
 591 #define MFI_RESET_WAIT_TIME 180
 592 #define MFI_CMD_TIMEOUT 30
 593 #define SKINNY_MEMORY 0x02000000
 594 #define MFI_MAXPHYS (128 * 1024)
 595
 596 #ifdef MFI_DEBUG
 597 extern void mfi_print_cmd(struct mfi_command *cm);
 598 extern void mfi_dump_cmds(struct mfi_softc *sc);
 599 extern void mfi_validate_sg(struct mfi_softc *, struct mfi_command *, const char *, int );
 600 #define MFI_PRINT_CMD(cm)       mfi_print_cmd(cm)
 601 #define MFI_DUMP_CMDS(sc)       mfi_dump_cmds(sc)
 602 #define MFI_VALIDATE_CMD(sc, cm) mfi_validate_sg(sc, cm, __func__, __LINE__)
 603 #else
 604 #define MFI_PRINT_CMD(cm)
 605 #define MFI_DUMP_CMDS(sc)
 606 #define MFI_VALIDATE_CMD(sc, cm)
 607 #endif
 608
 609 extern void mfi_release_command(struct mfi_command *cm);
 610
 611 #endif /* _MFIVAR_H */