sys/dev/mly/mlyvar.h

   1 /*-
   2  * Copyright (c) 2000, 2001 Michael Smith
   3  * Copyright (c) 2000 BSDi
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  *      $FreeBSD$
  28  */
  29
  30 /********************************************************************************
  31  ********************************************************************************
  32                                                      Driver Parameter Definitions
  33  ********************************************************************************
  34  ********************************************************************************/
  35
  36 /*
  37  * The firmware interface allows for a 16-bit command identifier.  A lookup
  38  * table this size (256k) would be too expensive, so we cap ourselves at a
  39  * reasonable limit.
  40  */
  41 #define MLY_MAX_COMMANDS        256     /* max commands per controller */
  42
  43 /*
  44  * The firmware interface allows for a 16-bit s/g list length.  We limit
  45  * ourselves to a reasonable maximum and ensure alignment.
  46  */
  47 #define MLY_MAX_SGENTRIES       64      /* max S/G entries, limit 65535 */
  48
  49 /*
  50  * The interval at which we poke the controller for status updates (in seconds).
  51  */
  52 #define MLY_PERIODIC_INTERVAL   1
  53
  54 /********************************************************************************
  55  ********************************************************************************
  56                                                       Cross-version Compatibility
  57  ********************************************************************************
  58  ********************************************************************************/
  59
  60 #if __FreeBSD_version >= 500005
  61 # include <sys/taskqueue.h>
  62 #endif
  63
  64 #if __FreeBSD_version <= 500014
  65 # include <machine/clock.h>
  66 # undef offsetof
  67 # define offsetof(type, field) ((size_t)(&((type *)0)->field))
  68 #endif
  69
  70 #ifndef INTR_ENTROPY
  71 # define INTR_ENTROPY 0
  72 #endif
  73
  74 /********************************************************************************
  75  ********************************************************************************
  76                                                       Driver Variable Definitions
  77  ********************************************************************************
  78  ********************************************************************************/
  79
  80 /*
  81  * Debugging levels:
  82  *  0 - quiet, only emit warnings
  83  *  1 - noisy, emit major function points and things done
  84  *  2 - extremely noisy, emit trace items in loops, etc.
  85  */
  86 #ifdef MLY_DEBUG
  87 # define debug(level, fmt, args...)     do { if (level <= MLY_DEBUG) printf("%s: " fmt "\n", __FUNCTION__ , ##args); } while(0)
  88 # define debug_called(level)            do { if (level <= MLY_DEBUG) printf(__FUNCTION__ ": called\n"); } while(0)
  89 # define debug_struct(s)                printf("  SIZE %s: %d\n", #s, sizeof(struct s))
  90 # define debug_union(s)                 printf("  SIZE %s: %d\n", #s, sizeof(union s))
  91 # define debug_field(s, f)              printf("  OFFSET %s.%s: %d\n", #s, #f, ((int)&(((struct s *)0)->f)))
  92 extern void             mly_printstate0(void);
  93 extern struct mly_softc *mly_softc0;
  94 #else
  95 # define debug(level, fmt, args...)
  96 # define debug_called(level)
  97 # define debug_struct(s)
  98 #endif
  99
 100 #define mly_printf(sc, fmt, args...)    device_printf(sc->mly_dev, fmt , ##args)
 101
 102 /*
 103  * Per-device structure, used to save persistent state on devices.
 104  *
 105  * Note that this isn't really Bus/Target/Lun since we don't support
 106  * lun != 0 at this time.
 107  */
 108 struct mly_btl {
 109     int                 mb_flags;
 110 #define MLY_BTL_PHYSICAL        (1<<0)          /* physical device */
 111 #define MLY_BTL_LOGICAL         (1<<1)          /* logical device */
 112 #define MLY_BTL_PROTECTED       (1<<2)          /* device is protected - I/O not allowed */
 113 #define MLY_BTL_RESCAN          (1<<3)          /* device needs to be rescanned */
 114     char                mb_name[16];            /* peripheral attached to this device */
 115     int                 mb_state;               /* see 8.1 */
 116     int                 mb_type;                /* see 8.2 */
 117
 118     /* physical devices only */
 119     int                 mb_speed;               /* interface transfer rate */
 120     int                 mb_width;               /* interface width */
 121 };
 122
 123 /*
 124  * Per-command control structure.
 125  */
 126 struct mly_command {
 127     TAILQ_ENTRY(mly_command)    mc_link;        /* list linkage */
 128
 129     struct mly_softc            *mc_sc;         /* controller that owns us */
 130     u_int16_t                   mc_slot;        /* command slot we occupy */
 131     int                         mc_flags;
 132 #define MLY_CMD_BUSY            (1<<0)          /* command is being run, or ready to run, or not completed */
 133 #define MLY_CMD_COMPLETE        (1<<1)          /* command has been completed */
 134 #define MLY_CMD_MAPPED          (1<<3)          /* command has had its data mapped */
 135 #define MLY_CMD_DATAIN          (1<<4)          /* data moves controller->system */
 136 #define MLY_CMD_DATAOUT         (1<<5)          /* data moves system->controller */
 137     u_int16_t                   mc_status;      /* command completion status */
 138     u_int8_t                    mc_sense;       /* sense data length */
 139     int32_t                     mc_resid;       /* I/O residual count */
 140
 141     union mly_command_packet    *mc_packet;     /* our controller command */
 142     u_int64_t                   mc_packetphys;  /* physical address of the mapped packet */
 143
 144     void                        *mc_data;       /* data buffer */
 145     size_t                      mc_length;      /* data length */
 146     bus_dmamap_t                mc_datamap;     /* DMA map for data */
 147
 148     void        (* mc_complete)(struct mly_command *mc);        /* completion handler */
 149     void        *mc_private;                                    /* caller-private data */
 150
 151 };
 152
 153 /*
 154  * Command slot regulation.
 155  *
 156  * We can't use slot 0 due to the memory mailbox implementation.
 157  */
 158 #define MLY_SLOT_START          1
 159 #define MLY_SLOT_MAX            (MLY_SLOT_START + MLY_MAX_COMMANDS)
 160
 161 /*
 162  * Per-controller structure.
 163  */
 164 struct mly_softc {
 165     /* bus connections */
 166     device_t            mly_dev;
 167     dev_t               mly_dev_t;
 168     struct resource     *mly_regs_resource;     /* register interface window */
 169     int                 mly_regs_rid;           /* resource ID */
 170     bus_space_handle_t  mly_bhandle;            /* bus space handle */
 171     bus_space_tag_t     mly_btag;               /* bus space tag */
 172     bus_dma_tag_t       mly_parent_dmat;        /* parent DMA tag */
 173     bus_dma_tag_t       mly_buffer_dmat;        /* data buffer/command DMA tag */
 174     struct resource     *mly_irq;               /* interrupt */
 175     int                 mly_irq_rid;
 176     void                *mly_intr;              /* interrupt handle */
 177
 178     /* scatter/gather lists and their controller-visible mappings */
 179     struct mly_sg_entry *mly_sg_table;          /* s/g lists */
 180     u_int32_t           mly_sg_busaddr;         /* s/g table base address in bus space */
 181     bus_dma_tag_t       mly_sg_dmat;            /* s/g buffer DMA tag */
 182     bus_dmamap_t        mly_sg_dmamap;          /* map for s/g buffers */
 183
 184     /* controller hardware interface */
 185     int                 mly_hwif;
 186 #define MLY_HWIF_I960RX         0
 187 #define MLY_HWIF_STRONGARM      1
 188     u_int8_t            mly_doorbell_true;      /* xor map to make hardware doorbell 'true' bits into 1s */
 189     u_int8_t            mly_command_mailbox;    /* register offsets */
 190     u_int8_t            mly_status_mailbox;
 191     u_int8_t            mly_idbr;
 192     u_int8_t            mly_odbr;
 193     u_int8_t            mly_error_status;
 194     u_int8_t            mly_interrupt_status;
 195     u_int8_t            mly_interrupt_mask;
 196     struct mly_mmbox    *mly_mmbox;                     /* kernel-space address of memory mailbox */
 197     u_int64_t           mly_mmbox_busaddr;              /* bus-space address of memory mailbox */
 198     bus_dma_tag_t       mly_mmbox_dmat;                 /* memory mailbox DMA tag */
 199     bus_dmamap_t        mly_mmbox_dmamap;               /* memory mailbox DMA map */
 200     u_int32_t           mly_mmbox_command_index;        /* next index to use */
 201     u_int32_t           mly_mmbox_status_index;         /* index we next expect status at */
 202
 203     /* controller features, limits and status */
 204     int                 mly_state;
 205 #define MLY_STATE_OPEN          (1<<1)
 206 #define MLY_STATE_INTERRUPTS_ON (1<<2)
 207 #define MLY_STATE_MMBOX_ACTIVE  (1<<3)
 208 #define MLY_STATE_CAM_FROZEN    (1<<4)
 209     struct mly_ioctl_getcontrollerinfo  *mly_controllerinfo;
 210     struct mly_param_controller         *mly_controllerparam;
 211     struct mly_btl                      mly_btl[MLY_MAX_CHANNELS][MLY_MAX_TARGETS];
 212
 213     /* command management */
 214     struct mly_command          mly_command[MLY_MAX_COMMANDS];  /* commands */
 215     union mly_command_packet    *mly_packet;            /* command packets */
 216     bus_dma_tag_t               mly_packet_dmat;        /* packet DMA tag */
 217     bus_dmamap_t                mly_packetmap;          /* packet DMA map */
 218     u_int64_t                   mly_packetphys;         /* packet array base address */
 219     TAILQ_HEAD(,mly_command)    mly_free;               /* commands available for reuse */
 220     TAILQ_HEAD(,mly_command)    mly_busy;
 221     TAILQ_HEAD(,mly_command)    mly_complete;           /* commands which have been returned by the controller */
 222     struct mly_qstat            mly_qstat[MLYQ_COUNT];  /* queue statistics */
 223
 224     /* health monitoring */
 225     u_int32_t                   mly_event_change;       /* event status change indicator */
 226     u_int32_t                   mly_event_counter;      /* next event for which we anticpiate status */
 227     u_int32_t                   mly_event_waiting;      /* next event the controller will post status for */
 228     struct callout_handle       mly_periodic;           /* periodic event handling */
 229
 230     /* CAM connection */
 231     struct cam_devq             *mly_cam_devq;                  /* CAM device queue */
 232     struct cam_sim              *mly_cam_sim[MLY_MAX_CHANNELS]; /* CAM SIMs */
 233     struct cam_path             *mly_cam_path;                  /* rescan path */
 234     int                         mly_cam_channels;               /* total channel count */
 235
 236 #if __FreeBSD_version >= 500005
 237     /* command-completion task */
 238     struct task         mly_task_complete;      /* deferred-completion task */
 239 #endif
 240 };
 241
 242 /*
 243  * Register access helpers.
 244  */
 245 #define MLY_SET_REG(sc, reg, val)       bus_space_write_1(sc->mly_btag, sc->mly_bhandle, reg, val)
 246 #define MLY_GET_REG(sc, reg)            bus_space_read_1 (sc->mly_btag, sc->mly_bhandle, reg)
 247 #define MLY_GET_REG2(sc, reg)           bus_space_read_2 (sc->mly_btag, sc->mly_bhandle, reg)
 248 #define MLY_GET_REG4(sc, reg)           bus_space_read_4 (sc->mly_btag, sc->mly_bhandle, reg)
 249
 250 #define MLY_SET_MBOX(sc, mbox, ptr)                                                                     \
 251         do {                                                                                            \
 252             bus_space_write_4(sc->mly_btag, sc->mly_bhandle, mbox,      *((u_int32_t *)ptr));           \
 253             bus_space_write_4(sc->mly_btag, sc->mly_bhandle, mbox +  4, *((u_int32_t *)ptr + 1));       \
 254             bus_space_write_4(sc->mly_btag, sc->mly_bhandle, mbox +  8, *((u_int32_t *)ptr + 2));       \
 255             bus_space_write_4(sc->mly_btag, sc->mly_bhandle, mbox + 12, *((u_int32_t *)ptr + 3));       \
 256         } while(0);
 257 #define MLY_GET_MBOX(sc, mbox, ptr)                                                                     \
 258         do {                                                                                            \
 259             *((u_int32_t *)ptr) = bus_space_read_4(sc->mly_btag, sc->mly_bhandle, mbox);                \
 260             *((u_int32_t *)ptr + 1) = bus_space_read_4(sc->mly_btag, sc->mly_bhandle, mbox + 4);        \
 261             *((u_int32_t *)ptr + 2) = bus_space_read_4(sc->mly_btag, sc->mly_bhandle, mbox + 8);        \
 262             *((u_int32_t *)ptr + 3) = bus_space_read_4(sc->mly_btag, sc->mly_bhandle, mbox + 12);       \
 263         } while(0);
 264
 265 #define MLY_IDBR_TRUE(sc, mask)                                                         \
 266         ((((MLY_GET_REG((sc), (sc)->mly_idbr)) ^ (sc)->mly_doorbell_true) & (mask)) == (mask))
 267 #define MLY_ODBR_TRUE(sc, mask)                                                         \
 268         ((MLY_GET_REG((sc), (sc)->mly_odbr) & (mask)) == (mask))
 269 #define MLY_ERROR_VALID(sc)                                                             \
 270         ((((MLY_GET_REG((sc), (sc)->mly_error_status)) ^ (sc)->mly_doorbell_true) & (MLY_MSG_EMPTY)) == 0)
 271
 272 #define MLY_MASK_INTERRUPTS(sc)                                                         \
 273         do {                                                                            \
 274             MLY_SET_REG((sc), (sc)->mly_interrupt_mask, MLY_INTERRUPT_MASK_DISABLE);    \
 275             sc->mly_state &= ~MLY_STATE_INTERRUPTS_ON;                                  \
 276         } while(0);
 277 #define MLY_UNMASK_INTERRUPTS(sc)                                                       \
 278         do {                                                                            \
 279             MLY_SET_REG((sc), (sc)->mly_interrupt_mask, MLY_INTERRUPT_MASK_ENABLE);     \
 280             sc->mly_state |= MLY_STATE_INTERRUPTS_ON;                                   \
 281         } while(0);
 282
 283 /*
 284  * Bus/target/logical ID-related macros.
 285  */
 286 #define MLY_LOGDEV_ID(sc, bus, target)  (((bus) - (sc)->mly_controllerinfo->physical_channels_present) * \
 287                                          MLY_MAX_TARGETS + (target))
 288 #define MLY_LOGDEV_BUS(sc, logdev)      (((logdev) / MLY_MAX_TARGETS) + \
 289                                          (sc)->mly_controllerinfo->physical_channels_present)
 290 #define MLY_LOGDEV_TARGET(sc, logdev)   ((logdev) % MLY_MAX_TARGETS)
 291 #define MLY_BUS_IS_VIRTUAL(sc, bus)     ((bus) >= (sc)->mly_controllerinfo->physical_channels_present)
 292 #define MLY_BUS_IS_VALID(sc, bus)       (((bus) < (sc)->mly_cam_channels) && ((sc)->mly_cam_sim[(bus)] != NULL))
 293
 294 /********************************************************************************
 295  * Queue primitives
 296  */
 297
 298 #define MLYQ_ADD(sc, qname)                                     \
 299         do {                                                    \
 300             struct mly_qstat *qs = &(sc)->mly_qstat[qname];     \
 301                                                                 \
 302             qs->q_length++;                                     \
 303             if (qs->q_length > qs->q_max)                       \
 304                 qs->q_max = qs->q_length;                       \
 305         } while(0)
 306
 307 #define MLYQ_REMOVE(sc, qname)    (sc)->mly_qstat[qname].q_length--
 308 #define MLYQ_INIT(sc, qname)                    \
 309         do {                                    \
 310             sc->mly_qstat[qname].q_length = 0;  \
 311             sc->mly_qstat[qname].q_max = 0;     \
 312         } while(0)
 313
 314
 315 #define MLYQ_COMMAND_QUEUE(name, index)                                 \
 316 static __inline void                                                    \
 317 mly_initq_ ## name (struct mly_softc *sc)                               \
 318 {                                                                       \
 319     TAILQ_INIT(&sc->mly_ ## name);                                      \
 320     MLYQ_INIT(sc, index);                                               \
 321 }                                                                       \
 322 static __inline void                                                    \
 323 mly_enqueue_ ## name (struct mly_command *mc)                           \
 324 {                                                                       \
 325     int         s;                                                      \
 326                                                                         \
 327     s = splcam();                                                       \
 328     TAILQ_INSERT_TAIL(&mc->mc_sc->mly_ ## name, mc, mc_link);           \
 329     MLYQ_ADD(mc->mc_sc, index);                                         \
 330     splx(s);                                                            \
 331 }                                                                       \
 332 static __inline void                                                    \
 333 mly_requeue_ ## name (struct mly_command *mc)                           \
 334 {                                                                       \
 335     int         s;                                                      \
 336                                                                         \
 337     s = splcam();                                                       \
 338     TAILQ_INSERT_HEAD(&mc->mc_sc->mly_ ## name, mc, mc_link);           \
 339     MLYQ_ADD(mc->mc_sc, index);                                         \
 340     splx(s);                                                            \
 341 }                                                                       \
 342 static __inline struct mly_command *                                    \
 343 mly_dequeue_ ## name (struct mly_softc *sc)                             \
 344 {                                                                       \
 345     struct mly_command  *mc;                                            \
 346     int                 s;                                              \
 347                                                                         \
 348     s = splcam();                                                       \
 349     if ((mc = TAILQ_FIRST(&sc->mly_ ## name)) != NULL) {                \
 350         TAILQ_REMOVE(&sc->mly_ ## name, mc, mc_link);                   \
 351         MLYQ_REMOVE(sc, index);                                         \
 352     }                                                                   \
 353     splx(s);                                                            \
 354     return(mc);                                                         \
 355 }                                                                       \
 356 static __inline void                                                    \
 357 mly_remove_ ## name (struct mly_command *mc)                            \
 358 {                                                                       \
 359     int                 s;                                              \
 360                                                                         \
 361     s = splcam();                                                       \
 362     TAILQ_REMOVE(&mc->mc_sc->mly_ ## name, mc, mc_link);                \
 363     MLYQ_REMOVE(mc->mc_sc, index);                                      \
 364     splx(s);                                                            \
 365 }                                                                       \
 366 struct hack
 367
 368 MLYQ_COMMAND_QUEUE(free, MLYQ_FREE);
 369 MLYQ_COMMAND_QUEUE(busy, MLYQ_BUSY);
 370 MLYQ_COMMAND_QUEUE(complete, MLYQ_COMPLETE);
 371
 372 /********************************************************************************
 373  * space-fill a character string
 374  */
 375 static __inline void
 376 padstr(char *targ, char *src, int len)
 377 {
 378     while (len-- > 0) {
 379         if (*src != 0) {
 380             *targ++ = *src++;
 381         } else {
 382             *targ++ = ' ';
 383         }
 384     }
 385 }