sys/dev/mlx/mlxvar.h

   1 /*-
   2  * Copyright (c) 1999 Michael Smith
   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  *      $FreeBSD$
  27  */
  28
  29 /*
  30  * Debugging levels:
  31  *  0 - quiet, only emit warnings
  32  *  1 - noisy, emit major function points and things done
  33  *  2 - extremely noisy, emit trace items in loops, etc.
  34  */
  35 #ifdef MLX_DEBUG
  36 #define debug(level, fmt, args...)      do { if (level <= MLX_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); } while(0)
  37 #define debug_called(level)             do { if (level <= MLX_DEBUG) printf(__func__ ": called\n"); } while(0)
  38 #else
  39 #define debug(level, fmt, args...)
  40 #define debug_called(level)
  41 #endif
  42
  43 /*
  44  * Regardless of the actual capacity of the controller, we will allocate space
  45  * for 64 s/g entries.  Typically controllers support 17 or 33 entries (64k or
  46  * 128k maximum transfer assuming 4k page size and non-optimal alignment), but
  47  * making that fit cleanly without crossing page boundaries requires rounding up
  48  * to the next power of two.
  49  */
  50 #define MLX_MAXPHYS     (128 * 1024)
  51 #define MLX_NSEG        64
  52
  53 #define MLX_NSLOTS      256             /* max number of command slots */
  54
  55 #define MLX_MAXDRIVES   32              /* max number of system drives */
  56
  57 /*
  58  * Structure describing a System Drive as attached to the controller.
  59  */
  60 struct mlx_sysdrive
  61 {
  62     /* from MLX_CMD_ENQSYSDRIVE */
  63     u_int32_t           ms_size;
  64     int                 ms_state;
  65     int                 ms_raidlevel;
  66
  67     /* synthetic geometry */
  68     int                 ms_cylinders;
  69     int                 ms_heads;
  70     int                 ms_sectors;
  71
  72     /* handle for attached driver */
  73     device_t            ms_disk;
  74 };
  75
  76 /*
  77  * Per-command control structure.
  78  */
  79 struct mlx_command
  80 {
  81     TAILQ_ENTRY(mlx_command)    mc_link;        /* list linkage */
  82
  83     struct mlx_softc            *mc_sc;         /* controller that owns us */
  84     u_int8_t                    mc_slot;        /* command slot we occupy */
  85     u_int16_t                   mc_status;      /* command completion status */
  86     time_t                      mc_timeout;     /* when this command expires */
  87     u_int8_t                    mc_mailbox[16]; /* command mailbox */
  88     u_int32_t                   mc_sgphys;      /* physical address of s/g array in controller space */
  89     int                         mc_nsgent;      /* number of entries in s/g map */
  90     int                         mc_flags;
  91 #define MLX_CMD_DATAIN          (1<<0)
  92 #define MLX_CMD_DATAOUT         (1<<1)
  93 #define MLX_CMD_PRIORITY        (1<<2)          /* high-priority command */
  94
  95     void                        *mc_data;       /* data buffer */
  96     size_t                      mc_length;
  97     bus_dmamap_t                mc_dmamap;      /* DMA map for data */
  98     u_int32_t                   mc_dataphys;    /* data buffer base address controller space */
  99
 100     void                        (* mc_complete)(struct mlx_command *mc);        /* completion handler */
 101     void                        *mc_private;    /* submitter-private data or wait channel */
 102     int                         mc_command;
 103 };
 104
 105 /*
 106  * Per-controller structure.
 107  */
 108 struct mlx_softc
 109 {
 110     /* bus connections */
 111     device_t            mlx_dev;
 112     struct cdev *mlx_dev_t;
 113     struct resource     *mlx_mem;       /* mailbox interface window */
 114     int                 mlx_mem_rid;
 115     int                 mlx_mem_type;
 116     bus_dma_tag_t       mlx_parent_dmat;/* parent DMA tag */
 117     bus_dma_tag_t       mlx_buffer_dmat;/* data buffer DMA tag */
 118     struct resource     *mlx_irq;       /* interrupt */
 119     void                *mlx_intr;      /* interrupt handle */
 120
 121     /* scatter/gather lists and their controller-visible mappings */
 122     struct mlx_sgentry  *mlx_sgtable;   /* s/g lists */
 123     u_int32_t           mlx_sgbusaddr;  /* s/g table base address in bus space */
 124     bus_dma_tag_t       mlx_sg_dmat;    /* s/g buffer DMA tag */
 125     bus_dmamap_t        mlx_sg_dmamap;  /* map for s/g buffers */
 126
 127     /* controller limits and features */
 128     struct mlx_enquiry2 *mlx_enq2;
 129     int                 mlx_feature;    /* controller features/quirks */
 130 #define MLX_FEAT_PAUSEWORKS     (1<<0)  /* channel pause works as expected */
 131
 132     /* controller queues and arrays */
 133     TAILQ_HEAD(, mlx_command)   mlx_freecmds;           /* command structures available for reuse */
 134     TAILQ_HEAD(, mlx_command)   mlx_work;               /* active commands */
 135     struct mlx_command  *mlx_busycmd[MLX_NSLOTS];       /* busy commands */
 136     int                 mlx_busycmds;                   /* count of busy commands */
 137     struct mlx_sysdrive mlx_sysdrive[MLX_MAXDRIVES];    /* system drives */
 138     struct bio_queue_head mlx_bioq;                     /* outstanding I/O operations */
 139     int                 mlx_waitbufs;                   /* number of bufs awaiting commands */
 140
 141     /* controller status */
 142     int                 mlx_geom;
 143 #define MLX_GEOM_128_32         0       /* geoemetry translation modes */
 144 #define MLX_GEOM_256_63         1
 145     int                 mlx_state;
 146 #define MLX_STATE_INTEN         (1<<0)  /* interrupts have been enabled */
 147 #define MLX_STATE_SHUTDOWN      (1<<1)  /* controller is shut down */
 148 #define MLX_STATE_OPEN          (1<<2)  /* control device is open */
 149 #define MLX_STATE_SUSPEND       (1<<3)  /* controller is suspended */
 150 #define MLX_STATE_QFROZEN       (1<<4)  /* bio queue frozen */
 151     struct mtx          mlx_io_lock;
 152     struct sx           mlx_config_lock;
 153     struct callout      mlx_timeout;    /* periodic status monitor */
 154     time_t              mlx_lastpoll;   /* last time_second we polled for status */
 155     u_int16_t           mlx_lastevent;  /* sequence number of the last event we recorded */
 156     int                 mlx_currevent;  /* sequence number last time we looked */
 157     int                 mlx_background; /* if != 0 rebuild or check is in progress */
 158 #define MLX_BACKGROUND_CHECK            1       /* we started a check */
 159 #define MLX_BACKGROUND_REBUILD          2       /* we started a rebuild */
 160 #define MLX_BACKGROUND_SPONTANEOUS      3       /* it just happened somehow */
 161     struct mlx_rebuild_status mlx_rebuildstat;  /* last rebuild status */
 162     struct mlx_pause    mlx_pause;      /* pending pause operation details */
 163
 164     int                 mlx_flags;
 165 #define MLX_SPINUP_REPORTED     (1<<0)  /* "spinning up drives" message displayed */
 166 #define MLX_EVENTLOG_BUSY       (1<<1)  /* currently reading event log */
 167
 168     /* interface-specific accessor functions */
 169     int                 mlx_iftype;     /* interface protocol */
 170 #define MLX_IFTYPE_2    2
 171 #define MLX_IFTYPE_3    3
 172 #define MLX_IFTYPE_4    4
 173 #define MLX_IFTYPE_5    5
 174     int                 (* mlx_tryqueue)(struct mlx_softc *sc, struct mlx_command *mc);
 175     int                 (* mlx_findcomplete)(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status);
 176     void                (* mlx_intaction)(struct mlx_softc *sc, int action);
 177     int                 (* mlx_fw_handshake)(struct mlx_softc *sc, int *error, int *param1, int *param2, int first);
 178 #define MLX_INTACTION_DISABLE           0
 179 #define MLX_INTACTION_ENABLE            1
 180 };
 181
 182 #define MLX_IO_LOCK(sc)                 mtx_lock(&(sc)->mlx_io_lock)
 183 #define MLX_IO_UNLOCK(sc)               mtx_unlock(&(sc)->mlx_io_lock)
 184 #define MLX_IO_ASSERT_LOCKED(sc)        mtx_assert(&(sc)->mlx_io_lock, MA_OWNED)
 185 #define MLX_CONFIG_LOCK(sc)             sx_xlock(&(sc)->mlx_config_lock)
 186 #define MLX_CONFIG_UNLOCK(sc)           sx_xunlock(&(sc)->mlx_config_lock)
 187 #define MLX_CONFIG_ASSERT_LOCKED(sc)    sx_assert(&(sc)->mlx_config_lock, SA_XLOCKED)
 188
 189 /*
 190  * Interface between bus connections and driver core.
 191  */
 192 extern void             mlx_free(struct mlx_softc *sc);
 193 extern int              mlx_attach(struct mlx_softc *sc);
 194 extern void             mlx_startup(struct mlx_softc *sc);
 195 extern void             mlx_intr(void *data);
 196 extern int              mlx_detach(device_t dev);
 197 extern int              mlx_shutdown(device_t dev);
 198 extern int              mlx_suspend(device_t dev);
 199 extern int              mlx_resume(device_t dev);
 200 extern d_open_t         mlx_open;
 201 extern d_close_t        mlx_close;
 202 extern d_ioctl_t        mlx_ioctl;
 203
 204 extern devclass_t       mlx_devclass;
 205 extern devclass_t       mlxd_devclass;
 206
 207 /*
 208  * Mylex System Disk driver
 209  */
 210 struct mlxd_softc
 211 {
 212     device_t            mlxd_dev;
 213     struct mlx_softc    *mlxd_controller;
 214     struct mlx_sysdrive *mlxd_drive;
 215     struct disk         *mlxd_disk;
 216     int                 mlxd_unit;
 217     int                 mlxd_flags;
 218 #define MLXD_OPEN       (1<<0)          /* drive is open (can't shut down) */
 219 };
 220
 221 /*
 222  * Interface between driver core and disk driver (should be using a bus?)
 223  */
 224 extern int      mlx_submit_buf(struct mlx_softc *sc, struct bio *bp);
 225 extern int      mlx_submit_ioctl(struct mlx_softc *sc,
 226                         struct mlx_sysdrive *drive, u_long cmd,
 227                         caddr_t addr, int32_t flag, struct thread *td);
 228 extern void     mlxd_intr(struct bio *bp);
 229
 230