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 /*-
  53  * Redistribution and use in source and binary forms, with or without
  54  * modification, are permitted provided that the following conditions
  55  * are met:
  56  *
  57  *            Copyright 1994-2009 The FreeBSD Project.
  58  *            All rights reserved.
  59  *
  60  * 1. Redistributions of source code must retain the above copyright
  61  *    notice, this list of conditions and the following disclaimer.
  62  * 2. Redistributions in binary form must reproduce the above copyright
  63  *    notice, this list of conditions and the following disclaimer in the
  64  *    documentation and/or other materials provided with the distribution.
  65  *
  66  *    THIS SOFTWARE IS PROVIDED BY THE FREEBSD PROJECT``AS IS'' AND
  67  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  68  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FREEBSD PROJECT OR
  70  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  71  * EXEMPLARY,OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  72  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  73  * PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY THEORY
  74  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  75  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  76  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  77  *
  78  * The views and conclusions contained in the software and documentation
  79  * are those of the authors and should not be interpreted as representing
  80  * official policies,either expressed or implied, of the FreeBSD Project.
  81  *
  82  * $FreeBSD: src/sys/dev/mfi/mfivar.h,v 1.13 2009/07/10 08:18:08 scottl Exp $
  83  */
  84
  85 #ifndef _MFIVAR_H
  86 #define _MFIVAR_H
  87
  88 #include <sys/devicestat.h>
  89 #include <sys/disk.h>
  90 #include <sys/eventhandler.h>
  91 #include <sys/lock.h>
  92 #include <sys/sysctl.h>
  93
  94 /*
  95  * SCSI structures and definitions are used from here, but no linking
  96  * requirements are made to CAM.
  97  */
  98 #include <bus/cam/scsi/scsi_all.h>
  99
 100 struct mfi_hwcomms {
 101         uint32_t                hw_pi;
 102         uint32_t                hw_ci;
 103         uint32_t                hw_reply_q[1];
 104 };
 105
 106 struct mfi_softc;
 107 struct disk;
 108 struct ccb_hdr;
 109
 110 struct mfi_command {
 111         TAILQ_ENTRY(mfi_command) cm_link;
 112         time_t                  cm_timestamp;
 113         struct mfi_softc        *cm_sc;
 114         union mfi_frame         *cm_frame;
 115 #if defined(__x86_64__)
 116         uint64_t                cm_frame_busaddr;
 117 #else
 118         uint32_t                cm_frame_busaddr;
 119 #endif
 120         struct mfi_sense        *cm_sense;
 121 #if defined(__x86_64__)
 122         uint64_t                cm_sense_busaddr;
 123 #else
 124         uint32_t                cm_sense_busaddr;
 125 #endif
 126         bus_dmamap_t            cm_dmamap;
 127         union mfi_sgl           *cm_sg;
 128         void                    *cm_data;
 129         int                     cm_len;
 130         int                     cm_total_frame_size;
 131         int                     cm_extra_frames;
 132         int                     cm_flags;
 133 #define MFI_CMD_MAPPED          (1<<0)
 134 #define MFI_CMD_DATAIN          (1<<1)
 135 #define MFI_CMD_DATAOUT         (1<<2)
 136 #define MFI_CMD_COMPLETED       (1<<3)
 137 #define MFI_CMD_POLLED          (1<<4)
 138 #define MFI_ON_MFIQ_FREE        (1<<5)
 139 #define MFI_ON_MFIQ_READY       (1<<6)
 140 #define MFI_ON_MFIQ_BUSY        (1<<7)
 141 #define MFI_ON_MFIQ_MASK        ((1<<5)|(1<<6)|(1<<7))
 142         int                     cm_aen_abort;
 143         void                    (* cm_complete)(struct mfi_command *cm);
 144         void                    *cm_private;
 145         int                     cm_index;
 146         int                     cm_error;
 147 };
 148
 149 /*
 150  * XXX swildner
 151  *
 152  * At the moment we rely on mfi_disk and mfi_system_pd having the same size.
 153  * A future cleanup should merge them.
 154  */
 155 struct mfi_disk {
 156         TAILQ_ENTRY(mfi_disk)   ld_link;
 157         device_t        ld_dev;
 158         cdev_t          ld_dev_t;
 159         int             ld_id;
 160         int             ld_unit;
 161         struct mfi_softc *ld_controller;
 162         struct mfi_ld_info      *ld_info;
 163         struct disk     ld_disk;
 164         struct devstat  ld_devstat;
 165         int             ld_flags;
 166 #define MFI_DISK_FLAGS_OPEN     0x01
 167 #define MFI_DISK_FLAGS_DISABLED 0x02
 168 #define MFI_DISK_FLAGS_SYSPD    0x04
 169 };
 170
 171 struct mfi_system_pd {
 172         TAILQ_ENTRY(mfi_system_pd)      pd_link;
 173         device_t        pd_dev;
 174         cdev_t          pd_dev_t;
 175         int             pd_id;
 176         int             pd_unit;
 177         struct mfi_softc *pd_controller;
 178         struct mfi_pd_info      *pd_info;
 179         struct disk     pd_disk;
 180         struct devstat  pd_devstat;
 181         int             pd_flags;
 182 };
 183
 184 struct mfi_aen {
 185         TAILQ_ENTRY(mfi_aen) aen_link;
 186         struct proc                     *p;
 187 };
 188
 189 struct mfi_softc {
 190         device_t                        mfi_dev;
 191         int                             mfi_flags;
 192 #define MFI_FLAGS_SG64          (1<<0)
 193 #define MFI_FLAGS_QFRZN         (1<<1)
 194 #define MFI_FLAGS_OPEN          (1<<2)
 195 #define MFI_FLAGS_STOP          (1<<3)
 196 #define MFI_FLAGS_1064R         (1<<4)
 197 #define MFI_FLAGS_1078          (1<<5)
 198 #define MFI_FLAGS_GEN2          (1<<6)
 199 #define MFI_FLAGS_SKINNY        (1<<7)
 200
 201         struct mfi_hwcomms              *mfi_comms;
 202         TAILQ_HEAD(,mfi_command)        mfi_free;
 203         TAILQ_HEAD(,mfi_command)        mfi_ready;
 204         TAILQ_HEAD(,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         uint32_t                        mfi_comms_busaddr;
 219
 220         bus_dma_tag_t                   mfi_frames_dmat;
 221         bus_dmamap_t                    mfi_frames_dmamap;
 222         uint32_t                        mfi_frames_busaddr;
 223         union mfi_frame                 *mfi_frames;
 224
 225         TAILQ_HEAD(,mfi_aen)            mfi_aen_pids;
 226         struct mfi_command              *mfi_aen_cm;
 227         struct mfi_command              *mfi_skinny_cm;
 228         uint32_t                        mfi_aen_triggered;
 229         uint32_t                        mfi_poll_waiting;
 230         struct kqinfo                   mfi_kq;
 231         int                             mfi_delete_busy_volumes;
 232         int                             mfi_keep_deleted_volumes;
 233         int                             mfi_detaching;
 234
 235         bus_dma_tag_t                   mfi_sense_dmat;
 236         bus_dmamap_t                    mfi_sense_dmamap;
 237         uint32_t                        mfi_sense_busaddr;
 238         struct mfi_sense                *mfi_sense;
 239
 240         struct resource                 *mfi_irq;
 241         void                            *mfi_intr;
 242         int                             mfi_irq_rid;
 243         int                             mfi_irq_type;
 244
 245         struct intr_config_hook         mfi_ich;
 246         eventhandler_tag                eh;
 247
 248         /*
 249          * Allocation for the command array.  Used as an indexable array to
 250          * recover completed commands.
 251          */
 252         struct mfi_command              *mfi_commands;
 253         /*
 254          * How many commands were actually allocated
 255          */
 256         int                             mfi_total_cmds;
 257         /*
 258          * How many commands the firmware can handle.  Also how big the reply
 259          * queue is, minus 1.
 260          */
 261         int                             mfi_max_fw_cmds;
 262         /*
 263          * How many S/G elements we'll ever actually use
 264          */
 265         int                             mfi_max_sge;
 266         /*
 267          * How many bytes a compound frame is, including all of the extra frames
 268          * that are used for S/G elements.
 269          */
 270         int                             mfi_cmd_size;
 271         /*
 272          * How large an S/G element is.  Used to calculate the number of single
 273          * frames in a command.
 274          */
 275         int                             mfi_sge_size;
 276         /*
 277          * Max number of sectors that the firmware allows
 278          */
 279         uint32_t                        mfi_max_io;
 280
 281         TAILQ_HEAD(,mfi_disk)           mfi_ld_tqh;
 282         TAILQ_HEAD(,mfi_system_pd)      mfi_syspd_tqh;
 283         eventhandler_tag                mfi_eh;
 284         struct cdev                     *mfi_cdev;
 285
 286         TAILQ_HEAD(, ccb_hdr)           mfi_cam_ccbq;
 287         struct mfi_command *            (* mfi_cam_start)(void *);
 288         struct callout                  mfi_watchdog_callout;
 289         struct lock                     mfi_io_lock;
 290         struct lock                     mfi_config_lock;
 291
 292         struct sysctl_ctx_list          mfi_sysctl_ctx;
 293         struct sysctl_oid               *mfi_sysctl_tree;
 294
 295         /* Controller type specific interfaces */
 296         void    (*mfi_enable_intr)(struct mfi_softc *sc);
 297         int32_t (*mfi_read_fw_status)(struct mfi_softc *sc);
 298         int     (*mfi_check_clear_intr)(struct mfi_softc *sc);
 299         void    (*mfi_issue_cmd)(struct mfi_softc *sc,uint32_t bus_add,uint32_t frame_cnt);
 300 };
 301
 302 extern int mfi_attach(struct mfi_softc *);
 303 extern void mfi_free(struct mfi_softc *);
 304 extern int mfi_shutdown(struct mfi_softc *);
 305 extern void mfi_startio(struct mfi_softc *);
 306 extern void mfi_disk_complete(struct bio *);
 307 extern int mfi_disk_disable(struct mfi_disk *);
 308 extern void mfi_disk_enable(struct mfi_disk *);
 309 extern int mfi_dump_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
 310 extern int mfi_syspd_disable(struct mfi_system_pd *);
 311 extern void mfi_syspd_enable(struct mfi_system_pd *);
 312 extern int mfi_dump_syspd_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
 313
 314 #define MFIQ_ADD(sc, qname)                                     \
 315         do {                                                    \
 316                 struct mfi_qstat *qs;                           \
 317                                                                 \
 318                 qs = &(sc)->mfi_qstat[qname];                   \
 319                 qs->q_length++;                                 \
 320                 if (qs->q_length > qs->q_max)                   \
 321                         qs->q_max = qs->q_length;               \
 322         } while (0)
 323
 324 #define MFIQ_REMOVE(sc, qname)  (sc)->mfi_qstat[qname].q_length--
 325
 326 #define MFIQ_INIT(sc, qname)                                    \
 327         do {                                                    \
 328                 sc->mfi_qstat[qname].q_length = 0;              \
 329                 sc->mfi_qstat[qname].q_max = 0;                 \
 330         } while (0)
 331
 332 #define MFIQ_COMMAND_QUEUE(name, index)                                 \
 333         static __inline void                                            \
 334         mfi_initq_ ## name (struct mfi_softc *sc)                       \
 335         {                                                               \
 336                 TAILQ_INIT(&sc->mfi_ ## name);                          \
 337                 MFIQ_INIT(sc, index);                                   \
 338         }                                                               \
 339         static __inline void                                            \
 340         mfi_enqueue_ ## name (struct mfi_command *cm)                   \
 341         {                                                               \
 342                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 343                         kprintf("command %p is on another queue, "      \
 344                             "flags = %#x\n", cm, cm->cm_flags);         \
 345                         panic("command is on another queue");           \
 346                 }                                                       \
 347                 TAILQ_INSERT_TAIL(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 348                 cm->cm_flags |= MFI_ON_ ## index;                       \
 349                 MFIQ_ADD(cm->cm_sc, index);                             \
 350         }                                                               \
 351         static __inline void                                            \
 352         mfi_requeue_ ## name (struct mfi_command *cm)                   \
 353         {                                                               \
 354                 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {           \
 355                         kprintf("command %p is on another queue, "      \
 356                             "flags = %#x\n", cm, cm->cm_flags);         \
 357                         panic("command is on another queue");           \
 358                 }                                                       \
 359                 TAILQ_INSERT_HEAD(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
 360                 cm->cm_flags |= MFI_ON_ ## index;                       \
 361                 MFIQ_ADD(cm->cm_sc, index);                             \
 362         }                                                               \
 363         static __inline struct mfi_command *                            \
 364         mfi_dequeue_ ## name (struct mfi_softc *sc)                     \
 365         {                                                               \
 366                 struct mfi_command *cm;                                 \
 367                                                                         \
 368                 if ((cm = TAILQ_FIRST(&sc->mfi_ ## name)) != NULL) {    \
 369                         if ((cm->cm_flags & MFI_ON_ ## index) == 0) {   \
 370                                 kprintf("command %p not in queue, "     \
 371                                     "flags = %#x, bit = %#x\n", cm,     \
 372                                     cm->cm_flags, MFI_ON_ ## index);    \
 373                                 panic("command not in queue");          \
 374                         }                                               \
 375                         TAILQ_REMOVE(&sc->mfi_ ## name, cm, cm_link);   \
 376                         cm->cm_flags &= ~MFI_ON_ ## index;              \
 377                         MFIQ_REMOVE(sc, index);                         \
 378                 }                                                       \
 379                 return (cm);                                            \
 380         }                                                               \
 381         static __inline void                                            \
 382         mfi_remove_ ## name (struct mfi_command *cm)                    \
 383         {                                                               \
 384                 if ((cm->cm_flags & MFI_ON_ ## index) == 0) {           \
 385                         kprintf("command %p not in queue, flags = %#x, " \
 386                             "bit = %#x\n", cm, cm->cm_flags,            \
 387                             MFI_ON_ ## index);                          \
 388                         panic("command not in queue");                  \
 389                 }                                                       \
 390                 TAILQ_REMOVE(&cm->cm_sc->mfi_ ## name, cm, cm_link);    \
 391                 cm->cm_flags &= ~MFI_ON_ ## index;                      \
 392                 MFIQ_REMOVE(cm->cm_sc, index);                          \
 393         }                                                               \
 394 struct hack
 395
 396 MFIQ_COMMAND_QUEUE(free, MFIQ_FREE);
 397 MFIQ_COMMAND_QUEUE(ready, MFIQ_READY);
 398 MFIQ_COMMAND_QUEUE(busy, MFIQ_BUSY);
 399
 400 static __inline void
 401 mfi_initq_bio(struct mfi_softc *sc)
 402 {
 403         bioq_init(&sc->mfi_bioq);
 404         MFIQ_INIT(sc, MFIQ_BIO);
 405 }
 406
 407 static __inline void
 408 mfi_enqueue_bio(struct mfi_softc *sc, struct bio *bp)
 409 {
 410         bioq_insert_tail(&sc->mfi_bioq, bp);
 411         MFIQ_ADD(sc, MFIQ_BIO);
 412 }
 413
 414 static __inline struct bio *
 415 mfi_dequeue_bio(struct mfi_softc *sc)
 416 {
 417         struct bio *bp;
 418
 419         if ((bp = bioq_first(&sc->mfi_bioq)) != NULL) {
 420                 bioq_remove(&sc->mfi_bioq, bp);
 421                 MFIQ_REMOVE(sc, MFIQ_BIO);
 422         }
 423         return (bp);
 424 }
 425
 426 static __inline void
 427 mfi_print_sense(struct mfi_softc *sc, void *sense)
 428 {
 429         int error, key, asc, ascq;
 430
 431         scsi_extract_sense((struct scsi_sense_data *)sense,
 432             &error, &key, &asc, &ascq);
 433         device_printf(sc->mfi_dev, "sense error %d, sense_key %d, "
 434             "asc %d, ascq %d\n", error, key, asc, ascq);
 435 }
 436
 437
 438 #define MFI_WRITE4(sc, reg, val)        bus_space_write_4((sc)->mfi_btag, \
 439         sc->mfi_bhandle, (reg), (val))
 440 #define MFI_READ4(sc, reg)              bus_space_read_4((sc)->mfi_btag, \
 441         (sc)->mfi_bhandle, (reg))
 442 #define MFI_WRITE2(sc, reg, val)        bus_space_write_2((sc)->mfi_btag, \
 443         sc->mfi_bhandle, (reg), (val))
 444 #define MFI_READ2(sc, reg)              bus_space_read_2((sc)->mfi_btag, \
 445         (sc)->mfi_bhandle, (reg))
 446 #define MFI_WRITE1(sc, reg, val)        bus_space_write_1((sc)->mfi_btag, \
 447         sc->mfi_bhandle, (reg), (val))
 448 #define MFI_READ1(sc, reg)              bus_space_read_1((sc)->mfi_btag, \
 449         (sc)->mfi_bhandle, (reg))
 450
 451 MALLOC_DECLARE(M_MFIBUF);
 452
 453 #define MFI_CMD_TIMEOUT 30
 454 #define MFI_MAXPHYS (128 * 1024)
 455 #define SKINNY_MEMORY 0x02000000
 456
 457 #ifdef MFI_DEBUG
 458 extern void mfi_print_cmd(struct mfi_command *cm);
 459 extern void mfi_dump_cmds(struct mfi_softc *sc);
 460 extern void mfi_validate_sg(struct mfi_softc *, struct mfi_command *, const char *, int );
 461 #define MFI_PRINT_CMD(cm)       mfi_print_cmd(cm)
 462 #define MFI_DUMP_CMDS(sc)       mfi_dump_cmds(sc)
 463 #define MFI_VALIDATE_CMD(sc, cm) mfi_validate_sg(sc, cm, __FUNCTION__, __LINE__)
 464 #else
 465 #define MFI_PRINT_CMD(cm)
 466 #define MFI_DUMP_CMDS(sc)
 467 #define MFI_VALIDATE_CMD(sc, cm)
 468 #endif
 469
 470 extern void mfi_release_command(struct mfi_command *cm);
 471
 472 #endif /* _MFIVAR_H */