1 /*- 2 * Copyright (c) 2000 Michael Smith 3 * Copyright (c) 2003 Paul Saab 4 * Copyright (c) 2003 Vinod Kashyap 5 * Copyright (c) 2000 BSDi 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: src/sys/dev/twe/twevar.h,v 1.1.2.8 2004/06/11 18:57:32 vkashyap Exp $ 30 * $DragonFly: src/sys/dev/raid/twe/twevar.h,v 1.11 2008/06/10 17:20:52 dillon Exp $ 31 */ 32 33 #define TWE_DRIVER_VERSION_STRING "1.40.01.002" 34 #define TWE_CDEV_MAJOR 146 35 #define TWED_CDEV_MAJOR 147 36 37 38 #ifdef TWE_DEBUG 39 #define debug(level, fmt, args...) \ 40 do { \ 41 if (level <= TWE_DEBUG) kprintf("%s: " fmt "\n", __func__ , ##args); \ 42 } while(0) 43 #define debug_called(level) \ 44 do { \ 45 if (level <= TWE_DEBUG) kprintf("%s: called\n", __func__); \ 46 } while(0) 47 #else 48 #define debug(level, fmt, args...) 49 #define debug_called(level) 50 #endif 51 52 /* 53 * Structure describing a logical unit as attached to the controller 54 */ 55 struct twe_drive 56 { 57 /* unit properties */ 58 u_int32_t td_size; 59 int td_cylinders; 60 int td_heads; 61 int td_sectors; 62 int td_sys_unit; /* Unit #, as seen by the system 63 (the 0 in twed0, the 1 in twed1 etc.) */ 64 int td_twe_unit; /* Unit #, as seen by us, and our ctlr 65 (index into sc->twe_drive[]) */ 66 67 /* unit state and type */ 68 u_int8_t td_state; 69 u_int8_t td_type; 70 71 /* handle for attached driver */ 72 device_t td_disk; 73 }; 74 75 /* 76 * Disk device softc 77 */ 78 struct twed_softc 79 { 80 device_t twed_dev; 81 cdev_t twed_dev_t; 82 struct twe_softc *twed_controller; /* parent device softc */ 83 struct twe_drive *twed_drive; /* drive data in parent softc */ 84 struct disk twed_disk; /* generic disk handle */ 85 struct devstat twed_stats; /* accounting */ 86 int twed_flags; 87 #define TWED_OPEN (1<<0) /* drive is open (can't shut down) */ 88 }; 89 90 /* 91 * Per-command control structure. 92 * 93 * Note that due to alignment constraints on the tc_command field, this *must* be 64-byte aligned. 94 * We achieve this by placing the command at the beginning of the structure, and using malloc() 95 * to allocate each structure. 96 */ 97 struct twe_request 98 { 99 /* controller command */ 100 TWE_Command tr_command; /* command as submitted to controller */ 101 102 /* command payload */ 103 void *tr_data; /* data buffer */ 104 void *tr_realdata; /* copy of real data buffer pointer for alignment fixup */ 105 size_t tr_length; 106 107 TAILQ_ENTRY(twe_request) tr_link; /* list linkage */ 108 struct twe_softc *tr_sc; /* controller that owns us */ 109 int tr_status; /* command status */ 110 #define TWE_CMD_SETUP 0 /* being assembled */ 111 #define TWE_CMD_BUSY 1 /* submitted to controller */ 112 #define TWE_CMD_COMPLETE 2 /* completed by controller (maybe with error) */ 113 #define TWE_CMD_ERROR 3 /* encountered error, even before submission to controller */ 114 int tr_flags; 115 #define TWE_CMD_DATAIN (1<<0) 116 #define TWE_CMD_DATAOUT (1<<1) 117 #define TWE_CMD_ALIGNBUF (1<<2) /* data in bio is misaligned, have to copy to/from private buffer */ 118 #define TWE_CMD_SLEEPER (1<<3) /* owner is sleeping on this command */ 119 #define TWE_CMD_MAPPED (1<<4) /* cmd has been mapped */ 120 #define TWE_CMD_IN_PROGRESS (1<<5) /* bus_dmamap_load returned EINPROGRESS */ 121 void (* tr_complete)(struct twe_request *tr); /* completion handler */ 122 void *tr_private; /* submitter-private data or wait channel */ 123 124 TWE_PLATFORM_REQUEST /* platform-specific request elements */ 125 }; 126 127 /* 128 * Per-controller state. 129 */ 130 struct twe_softc 131 { 132 /* controller queues and arrays */ 133 TAILQ_HEAD(, twe_request) twe_free; /* command structures available for reuse */ 134 twe_bioq twe_bioq; /* outstanding I/O operations */ 135 TAILQ_HEAD(, twe_request) twe_ready; /* requests ready for the controller */ 136 TAILQ_HEAD(, twe_request) twe_busy; /* requests busy in the controller */ 137 TAILQ_HEAD(, twe_request) twe_complete; /* active commands (busy or waiting for completion) */ 138 struct twe_request *twe_lookup[TWE_Q_LENGTH]; /* commands indexed by request ID */ 139 struct twe_drive twe_drive[TWE_MAX_UNITS]; /* attached drives */ 140 141 /* asynchronous event handling */ 142 u_int16_t twe_aen_queue[TWE_Q_LENGTH]; /* AENs queued for userland tool(s) */ 143 int twe_aen_head, twe_aen_tail; /* ringbuffer pointers for AEN queue */ 144 int twe_wait_aen; /* wait-for-aen notification */ 145 146 /* controller status */ 147 int twe_state; 148 #define TWE_STATE_INTEN (1<<0) /* interrupts have been enabled */ 149 #define TWE_STATE_SHUTDOWN (1<<1) /* controller is shut down */ 150 #define TWE_STATE_OPEN (1<<2) /* control device is open */ 151 #define TWE_STATE_SUSPEND (1<<3) /* controller is suspended */ 152 #define TWE_STATE_FRZN (1<<4) /* got EINPROGRESS */ 153 #define TWE_STATE_CTLR_BUSY (1<<5) /* controller cmd queue full */ 154 int twe_host_id; 155 struct twe_qstat twe_qstat[TWEQ_COUNT]; /* queue statistics */ 156 157 TWE_PLATFORM_SOFTC /* platform-specific softc elements */ 158 }; 159 160 /* 161 * Interface betwen driver core and platform-dependant code. 162 */ 163 extern int twe_setup(struct twe_softc *sc); /* do early driver/controller setup */ 164 extern void twe_init(struct twe_softc *sc); /* init controller */ 165 extern void twe_deinit(struct twe_softc *sc); /* stop controller */ 166 extern void twe_intr(struct twe_softc *sc); /* hardware interrupt signalled */ 167 extern void twe_startio(struct twe_softc *sc); 168 extern int twe_start(struct twe_request *tr); 169 extern int twe_dump_blocks(struct twe_softc *sc, int unit, /* crashdump block write */ 170 u_int64_t lba, void *data, int nblks); 171 extern int twe_ioctl(struct twe_softc *sc, int cmd, 172 void *addr); /* handle user request */ 173 extern void twe_describe_controller(struct twe_softc *sc); /* print controller info */ 174 extern char *twe_describe_code(struct twe_code_lookup *table, u_int32_t code); 175 extern void twe_print_controller(struct twe_softc *sc); 176 extern void twe_enable_interrupts(struct twe_softc *sc); /* enable controller interrupts */ 177 extern void twe_disable_interrupts(struct twe_softc *sc); /* disable controller interrupts */ 178 179 extern int twe_attach_drive(struct twe_softc *sc, 180 struct twe_drive *dr); /* attach drive when found in twe_init */ 181 extern int twe_detach_drive(struct twe_softc *sc, 182 int unit); /* detach drive */ 183 extern void twe_clear_pci_parity_error(struct twe_softc *sc); 184 extern void twe_clear_pci_abort(struct twe_softc *sc); 185 extern void twed_intr(twe_bio *bp); /* return bio from core */ 186 extern struct twe_request *twe_allocate_request(struct twe_softc *sc);/* allocate request structure */ 187 extern int twe_map_request(struct twe_request *tr); /* make request visible to controller, do s/g */ 188 extern void twe_unmap_request(struct twe_request *tr); /* cleanup after transfer, unmap */ 189 190 /******************************************************************************** 191 * Queue primitives 192 */ 193 #define TWEQ_ADD(sc, qname) \ 194 do { \ 195 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \ 196 \ 197 qs->q_length++; \ 198 if (qs->q_length > qs->q_max) \ 199 qs->q_max = qs->q_length; \ 200 } while(0) 201 202 #define TWEQ_REMOVE(sc, qname) \ 203 do { \ 204 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \ 205 \ 206 qs->q_length--; \ 207 if (qs->q_length < qs->q_min) \ 208 qs->q_min = qs->q_length; \ 209 } while(0) 210 211 #define TWEQ_INIT(sc, qname) \ 212 do { \ 213 sc->twe_qstat[qname].q_length = 0; \ 214 sc->twe_qstat[qname].q_max = 0; \ 215 sc->twe_qstat[qname].q_min = 0xFFFFFFFF; \ 216 } while(0) 217 218 219 #define TWEQ_REQUEST_QUEUE(name, index) \ 220 static __inline void \ 221 twe_initq_ ## name (struct twe_softc *sc) \ 222 { \ 223 TAILQ_INIT(&sc->twe_ ## name); \ 224 TWEQ_INIT(sc, index); \ 225 } \ 226 static __inline void \ 227 twe_enqueue_ ## name (struct twe_request *tr) \ 228 { \ 229 crit_enter(); \ 230 TAILQ_INSERT_TAIL(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 231 TWEQ_ADD(tr->tr_sc, index); \ 232 crit_exit(); \ 233 } \ 234 static __inline void \ 235 twe_requeue_ ## name (struct twe_request *tr) \ 236 { \ 237 crit_enter(); \ 238 TAILQ_INSERT_HEAD(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 239 TWEQ_ADD(tr->tr_sc, index); \ 240 crit_exit(); \ 241 } \ 242 static __inline struct twe_request * \ 243 twe_dequeue_ ## name (struct twe_softc *sc) \ 244 { \ 245 struct twe_request *tr; \ 246 \ 247 crit_enter(); \ 248 if ((tr = TAILQ_FIRST(&sc->twe_ ## name)) != NULL) { \ 249 TAILQ_REMOVE(&sc->twe_ ## name, tr, tr_link); \ 250 TWEQ_REMOVE(sc, index); \ 251 } \ 252 crit_exit(); \ 253 return(tr); \ 254 } \ 255 static __inline void \ 256 twe_remove_ ## name (struct twe_request *tr) \ 257 { \ 258 crit_enter(); \ 259 TAILQ_REMOVE(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 260 TWEQ_REMOVE(tr->tr_sc, index); \ 261 crit_exit(); \ 262 } 263 264 TWEQ_REQUEST_QUEUE(free, TWEQ_FREE) 265 TWEQ_REQUEST_QUEUE(ready, TWEQ_READY) 266 TWEQ_REQUEST_QUEUE(busy, TWEQ_BUSY) 267 TWEQ_REQUEST_QUEUE(complete, TWEQ_COMPLETE) 268 269 270 /* 271 * outstanding bio queue 272 */ 273 static __inline void 274 twe_initq_bio(struct twe_softc *sc) 275 { 276 bioq_init(&sc->twe_bioq); 277 TWEQ_INIT(sc, TWEQ_BIO); 278 } 279 280 static __inline void 281 twe_enqueue_bio(struct twe_softc *sc, struct bio *bio) 282 { 283 crit_enter(); 284 bioqdisksort(&sc->twe_bioq, bio); 285 /* bioq_insert_tail(&sc->twe_bioq, bio); */ 286 TWEQ_ADD(sc, TWEQ_BIO); 287 crit_exit(); 288 } 289 290 static __inline 291 struct bio * 292 twe_dequeue_bio(struct twe_softc *sc) 293 { 294 struct bio *bio; 295 296 crit_enter(); 297 if ((bio = bioq_first(&sc->twe_bioq)) != NULL) { 298 bioq_remove(&sc->twe_bioq, bio); 299 TWEQ_REMOVE(sc, TWEQ_BIO); 300 } 301 crit_exit(); 302 return(bio); 303 } 304