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.5 2005/08/22 21:16:20 hmp 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) printf("%s: " fmt "\n", __func__ , ##args); \ 42 } while(0) 43 #define debug_called(level) \ 44 do { \ 45 if (level <= TWE_DEBUG) printf("%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 dev_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 struct disklabel twed_label; /* synthetic label */ 87 int twed_flags; 88 #define TWED_OPEN (1<<0) /* drive is open (can't shut down) */ 89 }; 90 91 /* 92 * Per-command control structure. 93 * 94 * Note that due to alignment constraints on the tc_command field, this *must* be 64-byte aligned. 95 * We achieve this by placing the command at the beginning of the structure, and using malloc() 96 * to allocate each structure. 97 */ 98 struct twe_request 99 { 100 /* controller command */ 101 TWE_Command tr_command; /* command as submitted to controller */ 102 103 /* command payload */ 104 void *tr_data; /* data buffer */ 105 void *tr_realdata; /* copy of real data buffer pointer for alignment fixup */ 106 size_t tr_length; 107 108 TAILQ_ENTRY(twe_request) tr_link; /* list linkage */ 109 struct twe_softc *tr_sc; /* controller that owns us */ 110 int tr_status; /* command status */ 111 #define TWE_CMD_SETUP 0 /* being assembled */ 112 #define TWE_CMD_BUSY 1 /* submitted to controller */ 113 #define TWE_CMD_COMPLETE 2 /* completed by controller (maybe with error) */ 114 #define TWE_CMD_ERROR 3 /* encountered error, even before submission to controller */ 115 int tr_flags; 116 #define TWE_CMD_DATAIN (1<<0) 117 #define TWE_CMD_DATAOUT (1<<1) 118 #define TWE_CMD_ALIGNBUF (1<<2) /* data in bio is misaligned, have to copy to/from private buffer */ 119 #define TWE_CMD_SLEEPER (1<<3) /* owner is sleeping on this command */ 120 #define TWE_CMD_MAPPED (1<<4) /* cmd has been mapped */ 121 #define TWE_CMD_IN_PROGRESS (1<<5) /* bus_dmamap_load returned EINPROGRESS */ 122 void (* tr_complete)(struct twe_request *tr); /* completion handler */ 123 void *tr_private; /* submitter-private data or wait channel */ 124 125 TWE_PLATFORM_REQUEST /* platform-specific request elements */ 126 }; 127 128 /* 129 * Per-controller state. 130 */ 131 struct twe_softc 132 { 133 /* controller queues and arrays */ 134 TAILQ_HEAD(, twe_request) twe_free; /* command structures available for reuse */ 135 twe_bioq twe_bioq; /* outstanding I/O operations */ 136 TAILQ_HEAD(, twe_request) twe_ready; /* requests ready for the controller */ 137 TAILQ_HEAD(, twe_request) twe_busy; /* requests busy in the controller */ 138 TAILQ_HEAD(, twe_request) twe_complete; /* active commands (busy or waiting for completion) */ 139 struct twe_request *twe_lookup[TWE_Q_LENGTH]; /* commands indexed by request ID */ 140 struct twe_drive twe_drive[TWE_MAX_UNITS]; /* attached drives */ 141 142 /* asynchronous event handling */ 143 u_int16_t twe_aen_queue[TWE_Q_LENGTH]; /* AENs queued for userland tool(s) */ 144 int twe_aen_head, twe_aen_tail; /* ringbuffer pointers for AEN queue */ 145 int twe_wait_aen; /* wait-for-aen notification */ 146 147 /* controller status */ 148 int twe_state; 149 #define TWE_STATE_INTEN (1<<0) /* interrupts have been enabled */ 150 #define TWE_STATE_SHUTDOWN (1<<1) /* controller is shut down */ 151 #define TWE_STATE_OPEN (1<<2) /* control device is open */ 152 #define TWE_STATE_SUSPEND (1<<3) /* controller is suspended */ 153 #define TWE_STATE_FRZN (1<<4) /* got EINPROGRESS */ 154 #define TWE_STATE_CTLR_BUSY (1<<5) /* controller cmd queue full */ 155 int twe_host_id; 156 struct twe_qstat twe_qstat[TWEQ_COUNT]; /* queue statistics */ 157 158 TWE_PLATFORM_SOFTC /* platform-specific softc elements */ 159 }; 160 161 /* 162 * Interface betwen driver core and platform-dependant code. 163 */ 164 extern int twe_setup(struct twe_softc *sc); /* do early driver/controller setup */ 165 extern void twe_init(struct twe_softc *sc); /* init controller */ 166 extern void twe_deinit(struct twe_softc *sc); /* stop controller */ 167 extern void twe_intr(struct twe_softc *sc); /* hardware interrupt signalled */ 168 extern void twe_startio(struct twe_softc *sc); 169 extern int twe_start(struct twe_request *tr); 170 extern int twe_dump_blocks(struct twe_softc *sc, int unit, /* crashdump block write */ 171 u_int32_t lba, void *data, int nblks); 172 extern int twe_ioctl(struct twe_softc *sc, int cmd, 173 void *addr); /* handle user request */ 174 extern void twe_describe_controller(struct twe_softc *sc); /* print controller info */ 175 extern char *twe_describe_code(struct twe_code_lookup *table, u_int32_t code); 176 extern void twe_print_controller(struct twe_softc *sc); 177 extern void twe_enable_interrupts(struct twe_softc *sc); /* enable controller interrupts */ 178 extern void twe_disable_interrupts(struct twe_softc *sc); /* disable controller interrupts */ 179 180 extern int twe_attach_drive(struct twe_softc *sc, 181 struct twe_drive *dr); /* attach drive when found in twe_init */ 182 extern int twe_detach_drive(struct twe_softc *sc, 183 int unit); /* detach drive */ 184 extern void twe_clear_pci_parity_error(struct twe_softc *sc); 185 extern void twe_clear_pci_abort(struct twe_softc *sc); 186 extern void twed_intr(twe_bio *bp); /* return bio from core */ 187 extern struct twe_request *twe_allocate_request(struct twe_softc *sc);/* allocate request structure */ 188 extern int twe_map_request(struct twe_request *tr); /* make request visible to controller, do s/g */ 189 extern void twe_unmap_request(struct twe_request *tr); /* cleanup after transfer, unmap */ 190 191 /******************************************************************************** 192 * Queue primitives 193 */ 194 #define TWEQ_ADD(sc, qname) \ 195 do { \ 196 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \ 197 \ 198 qs->q_length++; \ 199 if (qs->q_length > qs->q_max) \ 200 qs->q_max = qs->q_length; \ 201 } while(0) 202 203 #define TWEQ_REMOVE(sc, qname) \ 204 do { \ 205 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \ 206 \ 207 qs->q_length--; \ 208 if (qs->q_length < qs->q_min) \ 209 qs->q_min = qs->q_length; \ 210 } while(0) 211 212 #define TWEQ_INIT(sc, qname) \ 213 do { \ 214 sc->twe_qstat[qname].q_length = 0; \ 215 sc->twe_qstat[qname].q_max = 0; \ 216 sc->twe_qstat[qname].q_min = 0xFFFFFFFF; \ 217 } while(0) 218 219 220 #define TWEQ_REQUEST_QUEUE(name, index) \ 221 static __inline void \ 222 twe_initq_ ## name (struct twe_softc *sc) \ 223 { \ 224 TAILQ_INIT(&sc->twe_ ## name); \ 225 TWEQ_INIT(sc, index); \ 226 } \ 227 static __inline void \ 228 twe_enqueue_ ## name (struct twe_request *tr) \ 229 { \ 230 crit_enter(); \ 231 TAILQ_INSERT_TAIL(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 232 TWEQ_ADD(tr->tr_sc, index); \ 233 crit_exit(); \ 234 } \ 235 static __inline void \ 236 twe_requeue_ ## name (struct twe_request *tr) \ 237 { \ 238 crit_enter(); \ 239 TAILQ_INSERT_HEAD(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 240 TWEQ_ADD(tr->tr_sc, index); \ 241 crit_exit(); \ 242 } \ 243 static __inline struct twe_request * \ 244 twe_dequeue_ ## name (struct twe_softc *sc) \ 245 { \ 246 struct twe_request *tr; \ 247 \ 248 crit_enter(); \ 249 if ((tr = TAILQ_FIRST(&sc->twe_ ## name)) != NULL) { \ 250 TAILQ_REMOVE(&sc->twe_ ## name, tr, tr_link); \ 251 TWEQ_REMOVE(sc, index); \ 252 } \ 253 crit_exit(); \ 254 return(tr); \ 255 } \ 256 static __inline void \ 257 twe_remove_ ## name (struct twe_request *tr) \ 258 { \ 259 crit_enter(); \ 260 TAILQ_REMOVE(&tr->tr_sc->twe_ ## name, tr, tr_link); \ 261 TWEQ_REMOVE(tr->tr_sc, index); \ 262 crit_exit(); \ 263 } 264 265 TWEQ_REQUEST_QUEUE(free, TWEQ_FREE) 266 TWEQ_REQUEST_QUEUE(ready, TWEQ_READY) 267 TWEQ_REQUEST_QUEUE(busy, TWEQ_BUSY) 268 TWEQ_REQUEST_QUEUE(complete, TWEQ_COMPLETE) 269 270 271 /* 272 * outstanding bio queue 273 */ 274 static __inline void 275 twe_initq_bio(struct twe_softc *sc) 276 { 277 TWE_BIO_QINIT(sc->twe_bioq); 278 TWEQ_INIT(sc, TWEQ_BIO); 279 } 280 281 static __inline void 282 twe_enqueue_bio(struct twe_softc *sc, twe_bio *bp) 283 { 284 crit_enter(); 285 TWE_BIO_QINSERT(sc->twe_bioq, bp); 286 TWEQ_ADD(sc, TWEQ_BIO); 287 crit_exit(); 288 } 289 290 static __inline twe_bio * 291 twe_dequeue_bio(struct twe_softc *sc) 292 { 293 twe_bio *bp; 294 295 crit_enter(); 296 if ((bp = TWE_BIO_QFIRST(sc->twe_bioq)) != NULL) { 297 TWE_BIO_QREMOVE(sc->twe_bioq, bp); 298 TWEQ_REMOVE(sc, TWEQ_BIO); 299 } 300 crit_exit(); 301 return(bp); 302 } 303