| 1 | /*- |
| 2 | * Copyright (c) 2001 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: src/sys/dev/ciss/cissvar.h,v 1.3.2.2 2003/02/06 21:42:59 ps Exp $ |
| 27 | * $DragonFly: src/sys/dev/raid/ciss/cissvar.h,v 1.6 2006/09/10 01:26:35 dillon Exp $ |
| 28 | */ |
| 29 | |
| 30 | #include <sys/thread2.h> |
| 31 | |
| 32 | /* |
| 33 | * CISS adapter driver datastructures |
| 34 | */ |
| 35 | |
| 36 | /************************************************************************ |
| 37 | * Tunable parameters |
| 38 | */ |
| 39 | |
| 40 | /* |
| 41 | * There is no guaranteed upper bound on the number of concurrent |
| 42 | * commands an adapter may claim to support. Cap it at a reasonable |
| 43 | * value. |
| 44 | */ |
| 45 | #define CISS_MAX_REQUESTS 256 |
| 46 | |
| 47 | /* |
| 48 | * Maximum number of logical drives we support. |
| 49 | */ |
| 50 | #define CISS_MAX_LOGICAL 15 |
| 51 | |
| 52 | /* |
| 53 | * Interrupt reduction can be controlled by tuning the interrupt |
| 54 | * coalesce delay and count paramters. The delay (in microseconds) |
| 55 | * defers delivery of interrupts to increase the chance of there being |
| 56 | * more than one completed command ready when the interrupt is |
| 57 | * delivered. The count expedites the delivery of the interrupt when |
| 58 | * the given number of commands are ready. |
| 59 | * |
| 60 | * If the delay is set to 0, interrupts are delivered immediately. |
| 61 | */ |
| 62 | #define CISS_INTERRUPT_COALESCE_DELAY 1000 |
| 63 | #define CISS_INTERRUPT_COALESCE_COUNT 16 |
| 64 | |
| 65 | /* |
| 66 | * Heartbeat routine timeout in seconds. Note that since event |
| 67 | * handling is performed on a callback basis, we don't need this to |
| 68 | * run very often. |
| 69 | */ |
| 70 | #define CISS_HEARTBEAT_RATE 10 |
| 71 | |
| 72 | /* |
| 73 | * Maximum number of events we will queue for a monitoring utility. |
| 74 | */ |
| 75 | #define CISS_MAX_EVENTS 32 |
| 76 | |
| 77 | /************************************************************************ |
| 78 | * Compatibility with older versions of FreeBSD |
| 79 | */ |
| 80 | #if defined(__FreeBSD__) && __FreeBSD_version < 440001 |
| 81 | #warning testing old-FreeBSD compat |
| 82 | typedef struct proc d_thread_t; |
| 83 | #endif |
| 84 | |
| 85 | /************************************************************************ |
| 86 | * Command queue statistics |
| 87 | */ |
| 88 | |
| 89 | #define CISSQ_FREE 0 |
| 90 | #define CISSQ_BUSY 1 |
| 91 | #define CISSQ_COMPLETE 2 |
| 92 | #define CISSQ_COUNT 3 |
| 93 | |
| 94 | struct ciss_qstat |
| 95 | { |
| 96 | u_int32_t q_length; |
| 97 | u_int32_t q_max; |
| 98 | }; |
| 99 | |
| 100 | /************************************************************************ |
| 101 | * Driver version. Only really significant to the ACU interface. |
| 102 | */ |
| 103 | #define CISS_DRIVER_VERSION 20011201 |
| 104 | |
| 105 | /************************************************************************ |
| 106 | * Driver data structures |
| 107 | */ |
| 108 | |
| 109 | /* |
| 110 | * Each command issued to the adapter is managed by a request |
| 111 | * structure. |
| 112 | */ |
| 113 | struct ciss_request |
| 114 | { |
| 115 | TAILQ_ENTRY(ciss_request) cr_link; |
| 116 | int cr_onq; /* which queue we are on */ |
| 117 | |
| 118 | struct ciss_softc *cr_sc; /* controller softc */ |
| 119 | void *cr_data; /* data buffer */ |
| 120 | u_int32_t cr_length; /* data length */ |
| 121 | bus_dmamap_t cr_datamap; /* DMA map for data */ |
| 122 | int cr_tag; |
| 123 | int cr_flags; |
| 124 | #define CISS_REQ_MAPPED (1<<0) /* data mapped */ |
| 125 | #define CISS_REQ_SLEEP (1<<1) /* submitter sleeping */ |
| 126 | #define CISS_REQ_POLL (1<<2) /* submitter polling */ |
| 127 | #define CISS_REQ_DATAOUT (1<<3) /* data host->adapter */ |
| 128 | #define CISS_REQ_DATAIN (1<<4) /* data adapter->host */ |
| 129 | |
| 130 | void (* cr_complete)(struct ciss_request *); |
| 131 | void *cr_private; |
| 132 | }; |
| 133 | |
| 134 | /* |
| 135 | * The adapter command structure is defined with a zero-length |
| 136 | * scatter/gather list size. In practise, we want space for a |
| 137 | * scatter-gather list, and we also want to avoid having commands |
| 138 | * cross page boundaries. |
| 139 | * |
| 140 | * Note that 512 bytes yields 28 scatter/gather entries, or the |
| 141 | * ability to map (26 * PAGE_SIZE) + 2 bytes of data. On x86, this is |
| 142 | * 104kB. 256 bytes would only yield 12 entries, giving a mere 40kB, |
| 143 | * too small. |
| 144 | */ |
| 145 | |
| 146 | #define CISS_COMMAND_ALLOC_SIZE 512 /* XXX tune to get sensible s/g list length */ |
| 147 | #define CISS_COMMAND_SG_LENGTH ((CISS_COMMAND_ALLOC_SIZE - sizeof(struct ciss_command)) \ |
| 148 | / sizeof(struct ciss_sg_entry)) |
| 149 | |
| 150 | /* |
| 151 | * Per-logical-drive data. |
| 152 | */ |
| 153 | struct ciss_ldrive |
| 154 | { |
| 155 | union ciss_device_address cl_address; |
| 156 | |
| 157 | int cl_status; |
| 158 | #define CISS_LD_NONEXISTENT 0 |
| 159 | #define CISS_LD_ONLINE 1 |
| 160 | #define CISS_LD_OFFLINE 2 |
| 161 | |
| 162 | struct ciss_bmic_id_ldrive *cl_ldrive; |
| 163 | struct ciss_bmic_id_lstatus *cl_lstatus; |
| 164 | struct ciss_ldrive_geometry cl_geometry; |
| 165 | |
| 166 | char cl_name[16]; /* device name */ |
| 167 | }; |
| 168 | |
| 169 | /* |
| 170 | * Per-adapter data |
| 171 | */ |
| 172 | struct ciss_softc |
| 173 | { |
| 174 | /* bus connections */ |
| 175 | device_t ciss_dev; /* bus attachment */ |
| 176 | cdev_t ciss_dev_t; /* control device */ |
| 177 | |
| 178 | struct resource *ciss_regs_resource; /* register interface window */ |
| 179 | int ciss_regs_rid; /* resource ID */ |
| 180 | bus_space_handle_t ciss_regs_bhandle; /* bus space handle */ |
| 181 | bus_space_tag_t ciss_regs_btag; /* bus space tag */ |
| 182 | |
| 183 | struct resource *ciss_cfg_resource; /* config struct interface window */ |
| 184 | int ciss_cfg_rid; /* resource ID */ |
| 185 | struct ciss_config_table *ciss_cfg; /* config table in adapter memory */ |
| 186 | struct ciss_bmic_id_table *ciss_id; /* ID table in host memory */ |
| 187 | u_int32_t ciss_heartbeat; /* last heartbeat value */ |
| 188 | int ciss_heart_attack; /* number of times we have seen this value */ |
| 189 | |
| 190 | struct resource *ciss_irq_resource; /* interrupt */ |
| 191 | int ciss_irq_rid; /* resource ID */ |
| 192 | void *ciss_intr; /* interrupt handle */ |
| 193 | |
| 194 | bus_dma_tag_t ciss_parent_dmat; /* parent DMA tag */ |
| 195 | bus_dma_tag_t ciss_buffer_dmat; /* data buffer/command DMA tag */ |
| 196 | |
| 197 | u_int32_t ciss_interrupt_mask; /* controller interrupt mask bits */ |
| 198 | |
| 199 | int ciss_max_requests; |
| 200 | struct ciss_request ciss_request[CISS_MAX_REQUESTS]; /* requests */ |
| 201 | void *ciss_command; /* command structures */ |
| 202 | bus_dma_tag_t ciss_command_dmat; /* command DMA tag */ |
| 203 | bus_dmamap_t ciss_command_map; /* command DMA map */ |
| 204 | u_int32_t ciss_command_phys; /* command array base address */ |
| 205 | TAILQ_HEAD(,ciss_request) ciss_free; /* requests available for reuse */ |
| 206 | TAILQ_HEAD(,ciss_request) ciss_busy; /* requests in the adapter */ |
| 207 | TAILQ_HEAD(,ciss_request) ciss_complete; /* requests which have been returned by the adapter */ |
| 208 | |
| 209 | struct callout ciss_periodic; /* periodic event handling */ |
| 210 | struct ciss_request *ciss_periodic_notify; /* notify callback request */ |
| 211 | |
| 212 | struct ciss_notify ciss_notify[CISS_MAX_EVENTS]; |
| 213 | int ciss_notify_head; /* saved-event ringbuffer */ |
| 214 | int ciss_notify_tail; |
| 215 | |
| 216 | struct ciss_ldrive ciss_logical[CISS_MAX_LOGICAL]; |
| 217 | |
| 218 | struct cam_devq *ciss_cam_devq; |
| 219 | struct cam_sim *ciss_cam_sim; |
| 220 | struct cam_path *ciss_cam_path; |
| 221 | |
| 222 | int ciss_flags; |
| 223 | #define CISS_FLAG_NOTIFY_OK (1<<0) /* notify command running OK */ |
| 224 | #define CISS_FLAG_CONTROL_OPEN (1<<1) /* control device is open */ |
| 225 | #define CISS_FLAG_ABORTING (1<<2) /* driver is going away */ |
| 226 | #define CISS_FLAG_RUNNING (1<<3) /* driver is running (interrupts usable) */ |
| 227 | |
| 228 | #define CISS_FLAG_FAKE_SYNCH (1<<16) /* needs SYNCHRONISE_CACHE faked */ |
| 229 | #define CISS_FLAG_BMIC_ABORT (1<<17) /* use BMIC command to abort Notify on Event */ |
| 230 | |
| 231 | struct ciss_qstat ciss_qstat[CISSQ_COUNT]; /* queue statistics */ |
| 232 | }; |
| 233 | |
| 234 | /* |
| 235 | * Given a request tag, find the corresponding command in virtual or |
| 236 | * physical space. |
| 237 | * |
| 238 | * The arithmetic here is due to the allocation of ciss_command structures |
| 239 | * inside CISS_COMMAND_ALLOC_SIZE blocks. See the comment at the definition |
| 240 | * of CISS_COMMAND_ALLOC_SIZE above. |
| 241 | */ |
| 242 | #define CISS_FIND_COMMAND(cr) \ |
| 243 | (struct ciss_command *)((u_int8_t *)(cr)->cr_sc->ciss_command + \ |
| 244 | ((cr)->cr_tag * CISS_COMMAND_ALLOC_SIZE)) |
| 245 | #define CISS_FIND_COMMANDPHYS(cr) ((cr)->cr_sc->ciss_command_phys + \ |
| 246 | ((cr)->cr_tag * CISS_COMMAND_ALLOC_SIZE)) |
| 247 | |
| 248 | /************************************************************************ |
| 249 | * Debugging/diagnostic output. |
| 250 | */ |
| 251 | |
| 252 | /* |
| 253 | * Debugging levels: |
| 254 | * 0 - quiet, only emit warnings |
| 255 | * 1 - talkative, log major events, but nothing on the I/O path |
| 256 | * 2 - noisy, log events on the I/O path |
| 257 | * 3 - extremely noisy, log items in loops |
| 258 | */ |
| 259 | #ifdef CISS_DEBUG |
| 260 | # define debug(level, fmt, args...) \ |
| 261 | do { \ |
| 262 | if (level <= CISS_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \ |
| 263 | } while(0) |
| 264 | # define debug_called(level) \ |
| 265 | do { \ |
| 266 | if (level <= CISS_DEBUG) printf("%s: called\n", __func__); \ |
| 267 | } while(0) |
| 268 | # define debug_struct(s) printf(" SIZE %s: %d\n", #s, sizeof(struct s)) |
| 269 | # define debug_union(s) printf(" SIZE %s: %d\n", #s, sizeof(union s)) |
| 270 | # define debug_type(s) printf(" SIZE %s: %d\n", #s, sizeof(s)) |
| 271 | # define debug_field(s, f) printf(" OFFSET %s.%s: %d\n", #s, #f, ((int)&(((struct s *)0)->f))) |
| 272 | # define debug_const(c) printf(" CONST %s %d/0x%x\n", #c, c, c); |
| 273 | #else |
| 274 | # define debug(level, fmt, args...) |
| 275 | # define debug_called(level) |
| 276 | # define debug_struct(s) |
| 277 | # define debug_union(s) |
| 278 | # define debug_type(s) |
| 279 | # define debug_field(s, f) |
| 280 | # define debug_const(c) |
| 281 | #endif |
| 282 | |
| 283 | #define ciss_printf(sc, fmt, args...) device_printf(sc->ciss_dev, fmt , ##args) |
| 284 | |
| 285 | /************************************************************************ |
| 286 | * Queue primitives |
| 287 | */ |
| 288 | |
| 289 | #define CISSQ_ADD(sc, qname) \ |
| 290 | do { \ |
| 291 | struct ciss_qstat *qs = &(sc)->ciss_qstat[qname]; \ |
| 292 | \ |
| 293 | qs->q_length++; \ |
| 294 | if (qs->q_length > qs->q_max) \ |
| 295 | qs->q_max = qs->q_length; \ |
| 296 | } while(0) |
| 297 | |
| 298 | #define CISSQ_REMOVE(sc, qname) (sc)->ciss_qstat[qname].q_length-- |
| 299 | #define CISSQ_INIT(sc, qname) \ |
| 300 | do { \ |
| 301 | sc->ciss_qstat[qname].q_length = 0; \ |
| 302 | sc->ciss_qstat[qname].q_max = 0; \ |
| 303 | } while(0) |
| 304 | |
| 305 | |
| 306 | #define CISSQ_REQUEST_QUEUE(name, index) \ |
| 307 | static __inline void \ |
| 308 | ciss_initq_ ## name (struct ciss_softc *sc) \ |
| 309 | { \ |
| 310 | TAILQ_INIT(&sc->ciss_ ## name); \ |
| 311 | CISSQ_INIT(sc, index); \ |
| 312 | } \ |
| 313 | static __inline void \ |
| 314 | ciss_enqueue_ ## name (struct ciss_request *cr) \ |
| 315 | { \ |
| 316 | crit_enter(); \ |
| 317 | TAILQ_INSERT_TAIL(&cr->cr_sc->ciss_ ## name, cr, cr_link); \ |
| 318 | CISSQ_ADD(cr->cr_sc, index); \ |
| 319 | cr->cr_onq = index; \ |
| 320 | crit_exit(); \ |
| 321 | } \ |
| 322 | static __inline void \ |
| 323 | ciss_requeue_ ## name (struct ciss_request *cr) \ |
| 324 | { \ |
| 325 | crit_enter(); \ |
| 326 | TAILQ_INSERT_HEAD(&cr->cr_sc->ciss_ ## name, cr, cr_link); \ |
| 327 | CISSQ_ADD(cr->cr_sc, index); \ |
| 328 | cr->cr_onq = index; \ |
| 329 | crit_exit(); \ |
| 330 | } \ |
| 331 | static __inline struct ciss_request * \ |
| 332 | ciss_dequeue_ ## name (struct ciss_softc *sc) \ |
| 333 | { \ |
| 334 | struct ciss_request *cr; \ |
| 335 | \ |
| 336 | crit_enter(); \ |
| 337 | if ((cr = TAILQ_FIRST(&sc->ciss_ ## name)) != NULL) { \ |
| 338 | TAILQ_REMOVE(&sc->ciss_ ## name, cr, cr_link); \ |
| 339 | CISSQ_REMOVE(sc, index); \ |
| 340 | cr->cr_onq = -1; \ |
| 341 | } \ |
| 342 | crit_exit(); \ |
| 343 | return(cr); \ |
| 344 | } \ |
| 345 | static __inline int \ |
| 346 | ciss_remove_ ## name (struct ciss_request *cr) \ |
| 347 | { \ |
| 348 | int error; \ |
| 349 | \ |
| 350 | crit_enter(); \ |
| 351 | if (cr->cr_onq != index) { \ |
| 352 | printf("request on queue %d (expected %d)\n", cr->cr_onq, index);\ |
| 353 | error = 1; \ |
| 354 | } else { \ |
| 355 | TAILQ_REMOVE(&cr->cr_sc->ciss_ ## name, cr, cr_link); \ |
| 356 | CISSQ_REMOVE(cr->cr_sc, index); \ |
| 357 | cr->cr_onq = -1; \ |
| 358 | error = 0; \ |
| 359 | } \ |
| 360 | crit_exit(); \ |
| 361 | return(error); \ |
| 362 | } \ |
| 363 | struct hack |
| 364 | |
| 365 | CISSQ_REQUEST_QUEUE(free, CISSQ_FREE); |
| 366 | CISSQ_REQUEST_QUEUE(busy, CISSQ_BUSY); |
| 367 | CISSQ_REQUEST_QUEUE(complete, CISSQ_COMPLETE); |
| 368 | |
| 369 | /******************************************************************************** |
| 370 | * space-fill a character string |
| 371 | */ |
| 372 | static __inline void |
| 373 | padstr(char *targ, const char *src, int len) |
| 374 | { |
| 375 | while (len-- > 0) { |
| 376 | if (*src != 0) { |
| 377 | *targ++ = *src++; |
| 378 | } else { |
| 379 | *targ++ = ' '; |
| 380 | } |
| 381 | } |
| 382 | } |