sys/dev/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
  53 #ifndef _MFIVAR_H
  54 #define _MFIVAR_H
  55
  56 #include <sys/cdefs.h>
  57 __FBSDID("$FreeBSD$");
  58
  59 #include <sys/lock.h>
  60 #include <sys/sx.h>
  61
  62 #include <sys/types.h>
  63 #include <sys/taskqueue.h>
  64
  65 /*
  66  * SCSI structures and definitions are used from here, but no linking
  67  * requirements are made to CAM.
  68  */
  69 #include <cam/scsi/scsi_all.h>
  70
  71 struct mfi_hwcomms {
  72         uint32_t                hw_pi;
  73         uint32_t                hw_ci;
  74         uint32_t                hw_reply_q[1];
  75 };
  76 #define MEGASAS_MAX_NAME        32
  77 #define MEGASAS_VERSION         "4.23"
  78
  79 struct mfi_softc;
  80 struct disk;
  81 struct ccb_hdr;
  82
  83 struct mfi_command {
  84         TAILQ_ENTRY(mfi_command) cm_link;
  85         time_t                  cm_timestamp;
  86         struct mfi_softc        *cm_sc;
  87         union mfi_frame         *cm_frame;
  88         bus_addr_t              cm_frame_busaddr;
  89         struct mfi_sense        *cm_sense;
  90         bus_addr_t              cm_sense_busaddr;
  91         bus_dmamap_t            cm_dmamap;
  92         union mfi_sgl           *cm_sg;
  93         void                    *cm_data;
  94         int                     cm_len;
  95         int                     cm_stp_len;
  96         int                     cm_total_frame_size;
  97         int                     cm_extra_frames;
  98         int                     cm_flags;
  99 #define MFI_CMD_MAPPED          (1<<0)
 100 #define MFI_CMD_DATAIN          (1<<1)
 101 #define MFI_CMD_DATAOUT         (1<<2)
 102 #define MFI_CMD_COMPLETED       (1<<3)
 103 #define MFI_CMD_POLLED          (1<<4)
 104 #define MFI_ON_MFIQ_FREE        (1<<5)
 105 #define MFI_ON_MFIQ_READY       (1<<6)
 106 #define MFI_ON_MFIQ_BUSY        (1<<7)
 107 #define MFI_ON_MFIQ_MASK        ((1<<5)|(1<<6)|(1<<7))
 108 #define MFI_CMD_SCSI            (1<<8)
 109         uint8_t                 retry_for_fw_reset;
 110         void                    (* cm_complete)(struct mfi_command *cm);
 111         void                    *cm_private;
 112         int                     cm_index;
 113         int                     cm_error;
 114 };
 115
 116 struct mfi_disk {
 117         TAILQ_ENTRY(mfi_disk)   ld_link;
 118         device_t        ld_dev;
 119         int             ld_id;
 120         int             ld_unit;
 121         struct mfi_softc *ld_controller;
 122         struct mfi_ld_info      *ld_info;
 123         struct disk     *ld_disk;
 124         int             ld_flags;
 125 #define MFI_DISK_FLAGS_OPEN     0x01
 126 #define MFI_DISK_FLAGS_DISABLED 0x02
 127 };
 128
 129 struct mfi_disk_pending {
 130         TAILQ_ENTRY(mfi_disk_pending)   ld_link;
 131         int             ld_id;
 132 };
 133
 134 struct mfi_system_pd {
 135         TAILQ_ENTRY(mfi_system_pd) pd_link;
 136         device_t        pd_dev;
 137         int             pd_id;
 138         int             pd_unit;
 139         struct mfi_softc *pd_controller;
 140         struct mfi_pd_info *pd_info;
 141         struct disk     *pd_disk;
 142         int             pd_flags;
 143 };
 144
 145 struct mfi_system_pending {
 146         TAILQ_ENTRY(mfi_system_pending) pd_link;
 147         int             pd_id;
 148 };
 149
 150 struct mfi_evt_queue_elm {
 151         TAILQ_ENTRY(mfi_evt_queue_elm)  link;
 152         struct mfi_evt_detail           detail;
 153 };
 154
 155 struct mfi_aen {
 156         TAILQ_ENTRY(mfi_aen) aen_link;
 157         struct proc                     *p;
 158 };
 159
 160 struct mfi_skinny_dma_info {
 161         bus_dma_tag_t                   dmat[514];
 162         bus_dmamap_t                    dmamap[514];
 163         uint32_t                        mem[514];
 164         int                             noofmaps;
 165 };
 166
 167 struct megasas_sge
 168 {
 169         bus_addr_t                      phys_addr;
 170         uint32_t                        length;
 171 };
 172
 173 struct mfi_cmd_tbolt;
 174
 175 struct mfi_softc {
 176         device_t                        mfi_dev;
 177         int                             mfi_flags;
 178 #define MFI_FLAGS_SG64          (1<<0)
 179 #define MFI_FLAGS_QFRZN         (1<<1)
 180 #define MFI_FLAGS_OPEN          (1<<2)
 181 #define MFI_FLAGS_STOP          (1<<3)
 182 #define MFI_FLAGS_1064R         (1<<4)
 183 #define MFI_FLAGS_1078          (1<<5)
 184 #define MFI_FLAGS_GEN2          (1<<6)
 185 #define MFI_FLAGS_SKINNY        (1<<7)
 186 #define MFI_FLAGS_TBOLT         (1<<8)
 187         // Start: LSIP200113393
 188         bus_dma_tag_t                   verbuf_h_dmat;
 189         bus_dmamap_t                    verbuf_h_dmamap;
 190         bus_addr_t                      verbuf_h_busaddr;
 191         uint32_t                        *verbuf;
 192         void                            *kbuff_arr[MAX_IOCTL_SGE];
 193         bus_dma_tag_t                   mfi_kbuff_arr_dmat[2];
 194         bus_dmamap_t                    mfi_kbuff_arr_dmamap[2];
 195         bus_addr_t                      mfi_kbuff_arr_busaddr[2];
 196
 197         struct mfi_hwcomms              *mfi_comms;
 198         TAILQ_HEAD(,mfi_command)        mfi_free;
 199         TAILQ_HEAD(,mfi_command)        mfi_ready;
 200         TAILQ_HEAD(BUSYQ,mfi_command)   mfi_busy;
 201         struct bio_queue_head           mfi_bioq;
 202         struct mfi_qstat                mfi_qstat[MFIQ_COUNT];
 203
 204         struct resource                 *mfi_regs_resource;
 205         bus_space_handle_t              mfi_bhandle;
 206         bus_space_tag_t                 mfi_btag;
 207         int                             mfi_regs_rid;
 208
 209         bus_dma_tag_t                   mfi_parent_dmat;
 210         bus_dma_tag_t                   mfi_buffer_dmat;
 211
 212         bus_dma_tag_t                   mfi_comms_dmat;
 213         bus_dmamap_t                    mfi_comms_dmamap;
 214         bus_addr_t                      mfi_comms_busaddr;
 215
 216         bus_dma_tag_t                   mfi_frames_dmat;
 217         bus_dmamap_t                    mfi_frames_dmamap;
 218         bus_addr_t                      mfi_frames_busaddr;
 219         union mfi_frame                 *mfi_frames;
 220
 221         bus_dma_tag_t                   mfi_tb_init_dmat;
 222         bus_dmamap_t                    mfi_tb_init_dmamap;
 223         bus_addr_t                      mfi_tb_init_busaddr;
 224         bus_addr_t                      mfi_tb_ioc_init_busaddr;
 225         union mfi_frame                 *mfi_tb_init;
 226
 227         TAILQ_HEAD(,mfi_evt_queue_elm)  mfi_evt_queue;
 228         struct task                     mfi_evt_task;
 229         struct task                     mfi_map_sync_task;
 230         TAILQ_HEAD(,mfi_aen)            mfi_aen_pids;
 231         struct mfi_command              *mfi_aen_cm;
 232         struct mfi_command              *mfi_skinny_cm;
 233         struct mfi_command              *mfi_map_sync_cm;
 234         int                             cm_aen_abort;
 235         int                             cm_map_abort;
 236         uint32_t                        mfi_aen_triggered;
 237         uint32_t                        mfi_poll_waiting;
 238         uint32_t                        mfi_boot_seq_num;
 239         struct selinfo                  mfi_select;
 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         bus_addr_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
 253         struct intr_config_hook         mfi_ich;
 254         eventhandler_tag                eh;
 255         /* OCR flags */
 256         uint8_t adpreset;
 257         uint8_t issuepend_done;
 258         uint8_t disableOnlineCtrlReset;
 259         uint32_t mfiStatus;
 260         uint32_t last_seq_num;
 261         uint32_t volatile hw_crit_error;
 262
 263         /*
 264          * Allocation for the command array.  Used as an indexable array to
 265          * recover completed commands.
 266          */
 267         struct mfi_command              *mfi_commands;
 268         /*
 269          * How many commands were actually allocated
 270          */
 271         int                             mfi_total_cmds;
 272         /*
 273          * How many commands the firmware can handle.  Also how big the reply
 274          * queue is, minus 1.
 275          */
 276         int                             mfi_max_fw_cmds;
 277         /*
 278          * How many S/G elements we'll ever actually use
 279          */
 280         int                             mfi_max_sge;
 281         /*
 282          * How many bytes a compound frame is, including all of the extra frames
 283          * that are used for S/G elements.
 284          */
 285         int                             mfi_cmd_size;
 286         /*
 287          * How large an S/G element is.  Used to calculate the number of single
 288          * frames in a command.
 289          */
 290         int                             mfi_sge_size;
 291         /*
 292          * Max number of sectors that the firmware allows
 293          */
 294         uint32_t                        mfi_max_io;
 295
 296         TAILQ_HEAD(,mfi_disk)           mfi_ld_tqh;
 297         TAILQ_HEAD(,mfi_system_pd)      mfi_syspd_tqh;
 298         TAILQ_HEAD(,mfi_disk_pending)   mfi_ld_pend_tqh;
 299         TAILQ_HEAD(,mfi_system_pending) mfi_syspd_pend_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 mtx                      mfi_io_lock;
 307         struct sx                       mfi_config_lock;
 308
 309         /* Controller type specific interfaces */
 310         void    (*mfi_enable_intr)(struct mfi_softc *sc);
 311         void    (*mfi_disable_intr)(struct mfi_softc *sc);
 312         int32_t (*mfi_read_fw_status)(struct mfi_softc *sc);
 313         int     (*mfi_check_clear_intr)(struct mfi_softc *sc);
 314         void    (*mfi_issue_cmd)(struct mfi_softc *sc, bus_addr_t bus_add,
 315                     uint32_t frame_cnt);
 316         int     (*mfi_adp_reset)(struct mfi_softc *sc);
 317         int     (*mfi_adp_check_reset)(struct mfi_softc *sc);
 318         void                            (*mfi_intr_ptr)(void *sc);
 319
 320         /* ThunderBolt */
 321         uint32_t                        mfi_tbolt;
 322         uint32_t                        MFA_enabled;
 323         /* Single Reply structure size */
 324         uint16_t                        reply_size;
 325         /* Singler message size. */
 326         uint16_t                        raid_io_msg_size;
 327         TAILQ_HEAD(TB, mfi_cmd_tbolt)   mfi_cmd_tbolt_tqh;
 328         /* ThunderBolt base contiguous memory mapping. */
 329         bus_dma_tag_t                   mfi_tb_dmat;
 330         bus_dmamap_t                    mfi_tb_dmamap;
 331         bus_addr_t                      mfi_tb_busaddr;
 332         /* ThunderBolt Contiguous DMA memory Mapping */
 333         uint8_t *                       request_message_pool;
 334         uint8_t *                       request_message_pool_align;
 335         uint8_t *                       request_desc_pool;
 336         bus_addr_t                      request_msg_busaddr;
 337         bus_addr_t                      reply_frame_busaddr;
 338         bus_addr_t                      sg_frame_busaddr;
 339         /* ThunderBolt IOC Init Descriptor */
 340         bus_dma_tag_t                   mfi_tb_ioc_init_dmat;
 341         bus_dmamap_t                    mfi_tb_ioc_init_dmamap;
 342         uint8_t *                       mfi_tb_ioc_init_desc;
 343         struct mfi_cmd_tbolt            **mfi_cmd_pool_tbolt;
 344         /* Virtual address of reply Frame Pool */
 345         struct mfi_mpi2_reply_header*   reply_frame_pool;
 346         struct mfi_mpi2_reply_header*   reply_frame_pool_align;
 347
 348         /* Last reply frame address */
 349         uint8_t *                       reply_pool_limit;
 350         uint16_t                        last_reply_idx;
 351         uint8_t                         max_SGEs_in_chain_message;
 352         uint8_t                         max_SGEs_in_main_message;
 353         uint8_t                         chain_offset_value_for_main_message;
 354         uint8_t                         chain_offset_value_for_mpt_ptmsg;
 355 };
 356
 357 union desc_value {
 358         uint64_t        word;
 359         struct {
 360                 uint32_t        low;
 361                 uint32_t        high;
 362         }u;
 363 };
 364
 365 // TODO find the right definition
 366 #define XXX_MFI_CMD_OP_INIT2                    0x9
 367 /*
 368  * Request descriptor types
 369  */
 370 #define MFI_REQ_DESCRIPT_FLAGS_LD_IO           0x7
 371 #define MFI_REQ_DESCRIPT_FLAGS_MFA             0x1
 372 #define MFI_REQ_DESCRIPT_FLAGS_TYPE_SHIFT       0x1
 373 #define MFI_FUSION_FP_DEFAULT_TIMEOUT           0x14
 374 #define MFI_LOAD_BALANCE_FLAG                   0x1
 375 #define MFI_DCMD_MBOX_PEND_FLAG                 0x1
 376
 377 //#define MR_PROT_INFO_TYPE_CONTROLLER  0x08
 378 #define MEGASAS_SCSI_VARIABLE_LENGTH_CMD        0x7f
 379 #define MEGASAS_SCSI_SERVICE_ACTION_READ32      0x9
 380 #define MEGASAS_SCSI_SERVICE_ACTION_WRITE32     0xB
 381 #define MEGASAS_SCSI_ADDL_CDB_LEN               0x18
 382 #define MEGASAS_RD_WR_PROTECT_CHECK_ALL         0x20
 383 #define MEGASAS_RD_WR_PROTECT_CHECK_NONE        0x60
 384 #define MEGASAS_EEDPBLOCKSIZE                   512
 385 struct mfi_cmd_tbolt {
 386         union mfi_mpi2_request_descriptor *request_desc;
 387         struct mfi_mpi2_request_raid_scsi_io *io_request;
 388         bus_addr_t              io_request_phys_addr;
 389         bus_addr_t              sg_frame_phys_addr;
 390         bus_addr_t              sense_phys_addr;
 391         MPI2_SGE_IO_UNION       *sg_frame;
 392         uint8_t                 *sense;
 393         TAILQ_ENTRY(mfi_cmd_tbolt) next;
 394         /*
 395          * Context for a MFI frame.
 396          * Used to get the mfi cmd from list when a MFI cmd is completed
 397          */
 398         uint32_t                sync_cmd_idx;
 399         uint16_t                index;
 400         uint8_t                 status;
 401 };
 402
 403 extern int mfi_attach(struct mfi_softc *);
 404 extern void mfi_free(struct mfi_softc *);
 405 extern int mfi_shutdown(struct mfi_softc *);
 406 extern void mfi_startio(struct mfi_softc *);
 407 extern void mfi_disk_complete(struct bio *);
 408 extern int mfi_disk_disable(struct mfi_disk *);
 409 extern void mfi_disk_enable(struct mfi_disk *);
 410 extern int mfi_dump_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
 411 extern int mfi_syspd_disable(struct mfi_system_pd *);
 412 extern void mfi_syspd_enable(struct mfi_system_pd *);
 413 extern int mfi_dump_syspd_blocks(struct mfi_softc *, int id, uint64_t, void *,
 414     int);
 415 extern int mfi_transition_firmware(struct mfi_softc *sc);
 416 extern int mfi_aen_setup(struct mfi_softc *sc, uint32_t seq_start);
 417 extern void mfi_complete(struct mfi_softc *sc, struct mfi_command *cm);
 418 extern int mfi_mapcmd(struct mfi_softc *sc,struct mfi_command *cm);
 419 extern int mfi_wait_command(struct mfi_softc *sc, struct mfi_command *cm);
 420 extern void mfi_tbolt_enable_intr_ppc(struct mfi_softc *);
 421 extern void mfi_tbolt_disable_intr_ppc(struct mfi_softc *);
 422 extern int32_t mfi_tbolt_read_fw_status_ppc(struct mfi_softc *);
 423 extern int32_t mfi_tbolt_check_clear_intr_ppc(struct mfi_softc *);
 424 extern void mfi_tbolt_issue_cmd_ppc(struct mfi_softc *, bus_addr_t, uint32_t);
 425 extern void mfi_tbolt_init_globals(struct mfi_softc*);
 426 extern uint32_t mfi_tbolt_get_memory_requirement(struct mfi_softc *);
 427 extern int mfi_tbolt_init_desc_pool(struct mfi_softc *, uint8_t *, uint32_t);
 428 extern int mfi_tbolt_init_MFI_queue(struct mfi_softc *);
 429 extern void mfi_intr_tbolt(void *arg);
 430 extern int mfi_tbolt_alloc_cmd(struct mfi_softc *sc);
 431 extern int mfi_tbolt_send_frame(struct mfi_softc *sc, struct mfi_command *cm);
 432 extern int mfi_tbolt_adp_reset(struct mfi_softc *sc);
 433 extern int mfi_tbolt_reset(struct mfi_softc *sc);
 434 extern void mfi_tbolt_sync_map_info(struct mfi_softc *sc);
 435 extern void mfi_handle_map_sync(void *context, int pending);
 436 extern int mfi_dcmd_command(struct mfi_softc *, struct mfi_command **,
 437      uint32_t, void **, size_t);
 438 extern int mfi_build_cdb(int, uint8_t, u_int64_t, u_int32_t, uint8_t *);
 439
 440 #define MFIQ_ADD(sc, qname)                                     \
 441         do {                                                    \
 442                 struct mfi_qstat *qs;                           \
 443                                                                 \
 444                 qs = &(sc)->mfi_qstat[qname];                   \
 445                 qs->q_length++;                                 \
 446                 if (qs->q_length > qs->q_max)                   \
 447                         qs->q_max = qs->q_length;               \
 448         } while (0)
 449
 450 #define MFIQ_REMOVE(sc, qname)  (sc)->mfi_qstat[qname].q_length--
 451
 452 #define MFIQ_INIT(sc, qname)                                    \
 453         do {                                                    \
 454                 sc->mfi_qstat[qname].q_length = 0;              \
 455                 sc->mfi_qstat[qname].q_max = 0;                 \
 456         } while (0)
 457
 458 #define MFIQ_COMMAND_QUEUE(name, index)                                 \
 459         static __inline void                                            \
 460         mfi_initq_ ## name (struct mfi_softc *sc)                       \
 461         {                                                               \
 462                 TAILQ_INIT(&sc->mfi_ ## name);                          \
 463                 MFIQ_INIT(sc, index);                                   \
 464         }                                                               \
 465         static __inline void                                            \
 466         mfi_enqueue_ ## name (struct mfi_command *cm)                   \
 467         {                                                               \
 468                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 469                         printf("command %p is on another queue, "       \
 470                             "flags = %#x\n", cm, cm->cm_flags);         \
 471                         panic("command is on another queue");           \
 472                 }                                                       \
 473                 TAILQ_INSERT_TAIL(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 474                 cm->cm_flags |= MFI_ON_ ## index;                       \
 475                 MFIQ_ADD(cm->cm_sc, index);                             \
 476         }                                                               \
 477         static __inline void                                            \
 478         mfi_requeue_ ## name (struct mfi_command *cm)                   \
 479         {                                                               \
 480                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 481                         printf("command %p is on another queue, "       \
 482                             "flags = %#x\n", cm, cm->cm_flags);         \
 483                         panic("command is on another queue");           \
 484                 }                                                       \
 485                 TAILQ_INSERT_HEAD(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 486                 cm->cm_flags |= MFI_ON_ ## index;                       \
 487                 MFIQ_ADD(cm->cm_sc, index);                             \
 488         }                                                               \
 489         static __inline struct mfi_command *                            \
 490         mfi_dequeue_ ## name (struct mfi_softc *sc)                     \
 491         {                                                               \
 492                 struct mfi_command *cm;                                 \
 493                                                                         \
 494                 if ((cm = TAILQ_FIRST(&sc->mfi_ ## name)) != NULL) {    \
 495                         if ((cm->cm_flags & MFI_ON_ ## index) == 0) {   \
 496                                 printf("command %p not in queue, "      \
 497                                     "flags = %#x, bit = %#x\n", cm,     \
 498                                     cm->cm_flags, MFI_ON_ ## index);    \
 499                                 panic("command not in queue");          \
 500                         }                                               \
 501                         TAILQ_REMOVE(&sc->mfi_ ## name, cm, cm_link);   \
 502                         cm->cm_flags &= ~MFI_ON_ ## index;              \
 503                         MFIQ_REMOVE(sc, index);                         \
 504                 }                                                       \
 505                 return (cm);                                            \
 506         }                                                               \
 507         static __inline void                                            \
 508         mfi_remove_ ## name (struct mfi_command *cm)                    \
 509         {                                                               \
 510                 if ((cm->cm_flags & MFI_ON_ ## index) == 0) {           \
 511                         printf("command %p not in queue, flags = %#x, " \
 512                             "bit = %#x\n", cm, cm->cm_flags,            \
 513                             MFI_ON_ ## index);                          \
 514                         panic("command not in queue");                  \
 515                 }                                                       \
 516                 TAILQ_REMOVE(&cm->cm_sc->mfi_ ## name, cm, cm_link);    \
 517                 cm->cm_flags &= ~MFI_ON_ ## index;                      \
 518                 MFIQ_REMOVE(cm->cm_sc, index);                          \
 519         }                                                               \
 520 struct hack
 521
 522 MFIQ_COMMAND_QUEUE(free, MFIQ_FREE);
 523 MFIQ_COMMAND_QUEUE(ready, MFIQ_READY);
 524 MFIQ_COMMAND_QUEUE(busy, MFIQ_BUSY);
 525
 526 static __inline void
 527 mfi_initq_bio(struct mfi_softc *sc)
 528 {
 529         bioq_init(&sc->mfi_bioq);
 530         MFIQ_INIT(sc, MFIQ_BIO);
 531 }
 532
 533 static __inline void
 534 mfi_enqueue_bio(struct mfi_softc *sc, struct bio *bp)
 535 {
 536         bioq_insert_tail(&sc->mfi_bioq, bp);
 537         MFIQ_ADD(sc, MFIQ_BIO);
 538 }
 539
 540 static __inline struct bio *
 541 mfi_dequeue_bio(struct mfi_softc *sc)
 542 {
 543         struct bio *bp;
 544
 545         if ((bp = bioq_first(&sc->mfi_bioq)) != NULL) {
 546                 bioq_remove(&sc->mfi_bioq, bp);
 547                 MFIQ_REMOVE(sc, MFIQ_BIO);
 548         }
 549         return (bp);
 550 }
 551
 552 /*
 553  * This is from the original scsi_extract_sense() in CAM.  It's copied
 554  * here because CAM now uses a non-inline version that follows more complex
 555  * additions to the SPC spec, and we don't want to force a dependency on
 556  * the CAM module for such a trivial action.
 557  */
 558 static __inline void
 559 mfi_extract_sense(struct scsi_sense_data_fixed *sense,
 560     int *error_code, int *sense_key, int *asc, int *ascq)
 561 {
 562
 563         *error_code = sense->error_code & SSD_ERRCODE;
 564         *sense_key = sense->flags & SSD_KEY;
 565         *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
 566         *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
 567 }
 568
 569 static __inline void
 570 mfi_print_sense(struct mfi_softc *sc, void *sense)
 571 {
 572         int error, key, asc, ascq;
 573
 574         mfi_extract_sense((struct scsi_sense_data_fixed *)sense,
 575             &error, &key, &asc, &ascq);
 576         device_printf(sc->mfi_dev, "sense error %d, sense_key %d, "
 577             "asc %d, ascq %d\n", error, key, asc, ascq);
 578 }
 579
 580
 581 #define MFI_WRITE4(sc, reg, val)        bus_space_write_4((sc)->mfi_btag, \
 582         sc->mfi_bhandle, (reg), (val))
 583 #define MFI_READ4(sc, reg)              bus_space_read_4((sc)->mfi_btag, \
 584         (sc)->mfi_bhandle, (reg))
 585 #define MFI_WRITE2(sc, reg, val)        bus_space_write_2((sc)->mfi_btag, \
 586         sc->mfi_bhandle, (reg), (val))
 587 #define MFI_READ2(sc, reg)              bus_space_read_2((sc)->mfi_btag, \
 588         (sc)->mfi_bhandle, (reg))
 589 #define MFI_WRITE1(sc, reg, val)        bus_space_write_1((sc)->mfi_btag, \
 590         sc->mfi_bhandle, (reg), (val))
 591 #define MFI_READ1(sc, reg)              bus_space_read_1((sc)->mfi_btag, \
 592         (sc)->mfi_bhandle, (reg))
 593
 594 MALLOC_DECLARE(M_MFIBUF);
 595 SYSCTL_DECL(_hw_mfi);
 596
 597 #define MFI_RESET_WAIT_TIME 180
 598 #define MFI_CMD_TIMEOUT 30
 599 #define MFI_SYS_PD_IO   0
 600 #define MFI_LD_IO       1
 601 #define MFI_SKINNY_MEMORY 0x02000000
 602 #define MFI_MAXPHYS (128 * 1024)
 603
 604 #ifdef MFI_DEBUG
 605 extern void mfi_print_cmd(struct mfi_command *cm);
 606 extern void mfi_dump_cmds(struct mfi_softc *sc);
 607 extern void mfi_validate_sg(struct mfi_softc *, struct mfi_command *, const char *, int );
 608 #define MFI_PRINT_CMD(cm)       mfi_print_cmd(cm)
 609 #define MFI_DUMP_CMDS(sc)       mfi_dump_cmds(sc)
 610 #define MFI_VALIDATE_CMD(sc, cm) mfi_validate_sg(sc, cm, __FUNCTION__, __LINE__)
 611 #else
 612 #define MFI_PRINT_CMD(cm)
 613 #define MFI_DUMP_CMDS(sc)
 614 #define MFI_VALIDATE_CMD(sc, cm)
 615 #endif
 616
 617 extern void mfi_release_command(struct mfi_command *cm);
 618
 619 #endif /* _MFIVAR_H */