mlxvar.h revision 60074
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: head/sys/dev/mlx/mlxvar.h 60074 2000-05-06 08:54:33Z msmith $ 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", __FUNCTION__ , ##args); } while(0) 37#define debug_called(level) do { if (level <= MLX_DEBUG) printf(__FUNCTION__ ": 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_NSEG 64 51 52#define MLX_NSLOTS 256 /* max number of command slots */ 53 54#define MLX_MAXDRIVES 32 /* max number of system drives */ 55 56/* 57 * Structure describing a System Drive as attached to the controller. 58 */ 59struct mlx_sysdrive 60{ 61 /* from MLX_CMD_ENQSYSDRIVE */ 62 u_int32_t ms_size; 63 int ms_state; 64 int ms_raidlevel; 65 66 /* synthetic geometry */ 67 int ms_cylinders; 68 int ms_heads; 69 int ms_sectors; 70 71 /* handle for attached driver */ 72 device_t ms_disk; 73}; 74 75/* 76 * Per-command control structure. 77 */ 78struct mlx_command 79{ 80 TAILQ_ENTRY(mlx_command) mc_link; /* list linkage */ 81 82 struct mlx_softc *mc_sc; /* controller that owns us */ 83 u_int8_t mc_slot; /* command slot we occupy */ 84 u_int16_t mc_status; /* command completion status */ 85 time_t mc_timeout; /* when this command expires */ 86 u_int8_t mc_mailbox[16]; /* command mailbox */ 87 u_int32_t mc_sgphys; /* physical address of s/g array in controller space */ 88 int mc_nsgent; /* number of entries in s/g map */ 89 int mc_flags; 90#define MLX_CMD_DATAIN (1<<0) 91#define MLX_CMD_DATAOUT (1<<1) 92#define MLX_CMD_PRIORITY (1<<2) /* high-priority command */ 93 94 void *mc_data; /* data buffer */ 95 size_t mc_length; 96 bus_dmamap_t mc_dmamap; /* DMA map for data */ 97 u_int32_t mc_dataphys; /* data buffer base address controller space */ 98 99 void (* mc_complete)(struct mlx_command *mc); /* completion handler */ 100 void *mc_private; /* submitter-private data or wait channel */ 101}; 102 103/* 104 * Per-controller structure. 105 */ 106struct mlx_softc 107{ 108 /* bus connections */ 109 device_t mlx_dev; 110 dev_t mlx_dev_t; 111 struct resource *mlx_mem; /* mailbox interface window */ 112 bus_space_handle_t mlx_bhandle; /* bus space handle */ 113 bus_space_tag_t mlx_btag; /* bus space tag */ 114 bus_dma_tag_t mlx_parent_dmat;/* parent DMA tag */ 115 bus_dma_tag_t mlx_buffer_dmat;/* data buffer DMA tag */ 116 struct resource *mlx_irq; /* interrupt */ 117 void *mlx_intr; /* interrupt handle */ 118 119 /* scatter/gather lists and their controller-visible mappings */ 120 struct mlx_sgentry *mlx_sgtable; /* s/g lists */ 121 u_int32_t mlx_sgbusaddr; /* s/g table base address in bus space */ 122 bus_dma_tag_t mlx_sg_dmat; /* s/g buffer DMA tag */ 123 bus_dmamap_t mlx_sg_dmamap; /* map for s/g buffers */ 124 125 /* controller limits and features */ 126 struct mlx_enquiry2 *mlx_enq2; 127 int mlx_feature; /* controller features/quirks */ 128#define MLX_FEAT_PAUSEWORKS (1<<0) /* channel pause works as expected */ 129 130 /* controller queues and arrays */ 131 TAILQ_HEAD(, mlx_command) mlx_freecmds; /* command structures available for reuse */ 132 TAILQ_HEAD(, mlx_command) mlx_work; /* active commands */ 133 struct mlx_command *mlx_busycmd[MLX_NSLOTS]; /* busy commands */ 134 int mlx_busycmds; /* count of busy commands */ 135 struct mlx_sysdrive mlx_sysdrive[MLX_MAXDRIVES]; /* system drives */ 136 struct bio_queue_head mlx_bioq; /* outstanding I/O operations */ 137 int mlx_waitbufs; /* number of bufs awaiting commands */ 138 139 /* controller status */ 140 int mlx_geom; 141#define MLX_GEOM_128_32 0 /* geoemetry translation modes */ 142#define MLX_GEOM_256_63 1 143 int mlx_state; 144#define MLX_STATE_INTEN (1<<0) /* interrupts have been enabled */ 145#define MLX_STATE_SHUTDOWN (1<<1) /* controller is shut down */ 146#define MLX_STATE_OPEN (1<<2) /* control device is open */ 147#define MLX_STATE_SUSPEND (1<<3) /* controller is suspended */ 148 struct callout_handle mlx_timeout; /* periodic status monitor */ 149 time_t mlx_lastpoll; /* last time_second we polled for status */ 150 u_int16_t mlx_lastevent; /* sequence number of the last event we recorded */ 151 int mlx_currevent; /* sequence number last time we looked */ 152 int mlx_background; /* if != 0 rebuild or check is in progress */ 153#define MLX_BACKGROUND_CHECK 1 /* we started a check */ 154#define MLX_BACKGROUND_REBUILD 2 /* we started a rebuild */ 155#define MLX_BACKGROUND_SPONTANEOUS 3 /* it just happened somehow */ 156 struct mlx_rebuild_status mlx_rebuildstat; /* last rebuild status */ 157 struct mlx_pause mlx_pause; /* pending pause operation details */ 158 159 int mlx_locks; /* reentrancy avoidance */ 160 int mlx_flags; 161#define MLX_SPINUP_REPORTED (1<<0) /* "spinning up drives" message displayed */ 162#define MLX_EVENTLOG_BUSY (1<<1) /* currently reading event log */ 163 164 /* interface-specific accessor functions */ 165 int mlx_iftype; /* interface protocol */ 166#define MLX_IFTYPE_2 2 167#define MLX_IFTYPE_3 3 168#define MLX_IFTYPE_4 4 169#define MLX_IFTYPE_5 5 170 int (* mlx_tryqueue)(struct mlx_softc *sc, struct mlx_command *mc); 171 int (* mlx_findcomplete)(struct mlx_softc *sc, u_int8_t *slot, u_int16_t *status); 172 void (* mlx_intaction)(struct mlx_softc *sc, int action); 173 int (* mlx_fw_handshake)(struct mlx_softc *sc, int *error, int *param1, int *param2); 174#define MLX_INTACTION_DISABLE 0 175#define MLX_INTACTION_ENABLE 1 176}; 177 178/* 179 * Simple (stupid) locks. 180 * 181 * Note that these are designed to avoid reentrancy, not concurrency, and will 182 * need to be replaced with something better. 183 */ 184#define MLX_LOCK_COMPLETING (1<<0) 185#define MLX_LOCK_STARTING (1<<1) 186 187static __inline int 188mlx_lock_tas(struct mlx_softc *sc, int lock) 189{ 190 if ((sc)->mlx_locks & (lock)) 191 return(1); 192 atomic_set_int(&sc->mlx_locks, lock); 193 return(0); 194} 195 196static __inline void 197mlx_lock_clr(struct mlx_softc *sc, int lock) 198{ 199 atomic_clear_int(&sc->mlx_locks, lock); 200} 201 202/* 203 * Interface between bus connections and driver core. 204 */ 205extern void mlx_free(struct mlx_softc *sc); 206extern int mlx_attach(struct mlx_softc *sc); 207extern void mlx_startup(struct mlx_softc *sc); 208extern void mlx_intr(void *data); 209extern int mlx_detach(device_t dev); 210extern int mlx_shutdown(device_t dev); 211extern int mlx_suspend(device_t dev); 212extern int mlx_resume(device_t dev); 213extern d_open_t mlx_open; 214extern d_close_t mlx_close; 215extern d_ioctl_t mlx_ioctl; 216 217extern devclass_t mlx_devclass; 218extern devclass_t mlxd_devclass; 219 220/* 221 * Mylex System Disk driver 222 */ 223struct mlxd_softc 224{ 225 device_t mlxd_dev; 226 dev_t mlxd_dev_t; 227 struct mlx_softc *mlxd_controller; 228 struct mlx_sysdrive *mlxd_drive; 229 struct disk mlxd_disk; 230 struct devstat mlxd_stats; 231 struct disklabel mlxd_label; 232 int mlxd_unit; 233 int mlxd_flags; 234#define MLXD_OPEN (1<<0) /* drive is open (can't shut down) */ 235}; 236 237/* 238 * Interface between driver core and disk driver (should be using a bus?) 239 */ 240extern int mlx_submit_buf(struct mlx_softc *sc, struct bio *bp); 241extern int mlx_submit_ioctl(struct mlx_softc *sc, struct mlx_sysdrive *drive, u_long cmd, 242 caddr_t addr, int32_t flag, struct proc *p); 243extern void mlxd_intr(void *data); 244 245 246