1 /*- 2 * Copyright (c) 1999,2000 Jonathan Lemon 3 * All rights reserved. 4 * 5 # Derived from the original IDA Compaq RAID driver, which is 6 * Copyright (c) 1996, 1997, 1998, 1999 7 * Mark Dawson and David James. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 /* 34 * Generic driver for Compaq SMART RAID adapters. 35 * 36 * Specific probe routines are in: 37 * pci/ida_pci.c 38 * i386/eisa/ida_eisa.c 39 */ 40 41 #include <pci.h> 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/malloc.h> 46 47 #include <sys/bio.h> 48 #include <sys/bus.h> 49 #include <sys/devicestat.h> 50 #include <sys/disk.h> 51 52 #if NPCI > 0 53 #include <machine/bus_memio.h> 54 #endif 55 #include <machine/bus_pio.h> 56 #include <machine/bus.h> 57 #include <sys/rman.h> 58 59 #include <dev/ida/idareg.h> 60 #include <dev/ida/idavar.h> 61 62 /* prototypes */ 63 static void ida_alloc_qcb(struct ida_softc *ida); 64 static void ida_construct_qcb(struct ida_softc *ida); 65 static void ida_start(struct ida_softc *ida); 66 static void ida_done(struct ida_softc *ida, struct ida_qcb *qcb); 67 static void ida_wait(struct ida_softc *ida, struct ida_qcb *qcb, int delay); 68 69 void 70 ida_free(struct ida_softc *ida) 71 { 72 int i; 73 74 for (i = 0; i < ida->num_qcbs; i++) 75 bus_dmamap_destroy(ida->buffer_dmat, ida->qcbs[i].dmamap); 76 77 if (ida->hwqcb_busaddr) 78 bus_dmamap_unload(ida->hwqcb_dmat, ida->hwqcb_dmamap); 79 80 if (ida->hwqcbs) 81 bus_dmamem_free(ida->hwqcb_dmat, ida->hwqcbs, 82 ida->hwqcb_dmamap); 83 84 if (ida->buffer_dmat) 85 bus_dma_tag_destroy(ida->buffer_dmat); 86 87 if (ida->hwqcb_dmat) 88 bus_dma_tag_destroy(ida->hwqcb_dmat); 89 90 if (ida->qcbs != NULL) 91 free(ida->qcbs, M_DEVBUF); 92 93 if (ida->ih != NULL) 94 bus_teardown_intr(ida->dev, ida->irq, ida->ih); 95 96 if (ida->irq != NULL) 97 bus_release_resource(ida->dev, ida->irq_res_type, 98 0, ida->irq); 99 100 if (ida->parent_dmat != NULL) 101 bus_dma_tag_destroy(ida->parent_dmat); 102 103 if (ida->regs != NULL) 104 bus_release_resource(ida->dev, ida->regs_res_type, 105 ida->regs_res_id, ida->regs); 106 } 107 108 /* 109 * record bus address from bus_dmamap_load 110 */ 111 static void 112 ida_dma_map_cb(void *arg, bus_dma_segment_t *segs, int nseg, int error) 113 { 114 bus_addr_t *baddr; 115 116 baddr = (bus_addr_t *)arg; 117 *baddr = segs->ds_addr; 118 } 119 120 static __inline struct ida_qcb * 121 ida_get_qcb(struct ida_softc *ida) 122 { 123 struct ida_qcb *qcb; 124 125 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) { 126 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle); 127 } else { 128 ida_alloc_qcb(ida); 129 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) 130 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle); 131 } 132 return (qcb); 133 } 134 135 static __inline bus_addr_t 136 idahwqcbvtop(struct ida_softc *ida, struct ida_hardware_qcb *hwqcb) 137 { 138 return (ida->hwqcb_busaddr + 139 ((bus_addr_t)hwqcb - (bus_addr_t)ida->hwqcbs)); 140 } 141 142 static __inline struct ida_qcb * 143 idahwqcbptov(struct ida_softc *ida, bus_addr_t hwqcb_addr) 144 { 145 struct ida_hardware_qcb *hwqcb; 146 147 hwqcb = (struct ida_hardware_qcb *) 148 ((bus_addr_t)ida->hwqcbs + (hwqcb_addr - ida->hwqcb_busaddr)); 149 return (hwqcb->qcb); 150 } 151 152 /* 153 * XXX 154 * since we allocate all QCB space up front during initialization, then 155 * why bother with this routine? 156 */ 157 static void 158 ida_alloc_qcb(struct ida_softc *ida) 159 { 160 struct ida_qcb *qcb; 161 int error; 162 163 if (ida->num_qcbs >= IDA_QCB_MAX) 164 return; 165 166 qcb = &ida->qcbs[ida->num_qcbs]; 167 168 error = bus_dmamap_create(ida->buffer_dmat, /*flags*/0, &qcb->dmamap); 169 if (error != 0) 170 return; 171 172 qcb->flags = QCB_FREE; 173 qcb->hwqcb = &ida->hwqcbs[ida->num_qcbs]; 174 qcb->hwqcb->qcb = qcb; 175 qcb->hwqcb_busaddr = idahwqcbvtop(ida, qcb->hwqcb); 176 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle); 177 ida->num_qcbs++; 178 } 179 180 int 181 ida_init(struct ida_softc *ida) 182 { 183 int error; 184 185 ida->unit = device_get_unit(ida->dev); 186 ida->tag = rman_get_bustag(ida->regs); 187 ida->bsh = rman_get_bushandle(ida->regs); 188 189 SLIST_INIT(&ida->free_qcbs); 190 STAILQ_INIT(&ida->qcb_queue); 191 bioq_init(&ida->bio_queue); 192 193 ida->qcbs = (struct ida_qcb *) 194 malloc(IDA_QCB_MAX * sizeof(struct ida_qcb), M_DEVBUF, M_NOWAIT); 195 if (ida->qcbs == NULL) 196 return (ENOMEM); 197 bzero(ida->qcbs, IDA_QCB_MAX * sizeof(struct ida_qcb)); 198 199 /* 200 * Create our DMA tags 201 */ 202 203 /* DMA tag for our hardware QCB structures */ 204 error = bus_dma_tag_create(ida->parent_dmat, 205 /*alignment*/1, /*boundary*/0, 206 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR, 207 /*filter*/NULL, /*filterarg*/NULL, 208 IDA_QCB_MAX * sizeof(struct ida_hardware_qcb), 209 /*nsegments*/1, /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, 210 /*flags*/0, &ida->hwqcb_dmat); 211 if (error) 212 return (ENOMEM); 213 214 /* DMA tag for mapping buffers into device space */ 215 error = bus_dma_tag_create(ida->parent_dmat, 216 /*alignment*/1, /*boundary*/0, 217 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR, 218 /*filter*/NULL, /*filterarg*/NULL, 219 /*maxsize*/MAXBSIZE, /*nsegments*/IDA_NSEG, 220 /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, /*flags*/0, &ida->buffer_dmat); 221 if (error) 222 return (ENOMEM); 223 224 /* Allocation of hardware QCBs */ 225 /* XXX allocation is rounded to hardware page size */ 226 error = bus_dmamem_alloc(ida->hwqcb_dmat, 227 (void **)&ida->hwqcbs, BUS_DMA_NOWAIT, &ida->hwqcb_dmamap); 228 if (error) 229 return (ENOMEM); 230 231 /* And permanently map them in */ 232 bus_dmamap_load(ida->hwqcb_dmat, ida->hwqcb_dmamap, 233 ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb), 234 ida_dma_map_cb, &ida->hwqcb_busaddr, /*flags*/0); 235 236 bzero(ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb)); 237 238 ida_alloc_qcb(ida); /* allocate an initial qcb */ 239 240 return (0); 241 } 242 243 void 244 ida_attach(struct ida_softc *ida) 245 { 246 struct ida_controller_info cinfo; 247 int error, i; 248 249 ida->cmd.int_enable(ida, 0); 250 251 error = ida_command(ida, CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo), 252 IDA_CONTROLLER, DMA_DATA_IN); 253 if (error) { 254 device_printf(ida->dev, "CMD_GET_CTRL_INFO failed.\n"); 255 return; 256 } 257 258 device_printf(ida->dev, "drives=%d firm_rev=%c%c%c%c\n", 259 cinfo.num_drvs, cinfo.firm_rev[0], cinfo.firm_rev[1], 260 cinfo.firm_rev[2], cinfo.firm_rev[3]); 261 262 if (ida->flags & IDA_FIRMWARE) { 263 int data; 264 265 error = ida_command(ida, CMD_START_FIRMWARE, 266 &data, sizeof(data), IDA_CONTROLLER, DMA_DATA_IN); 267 if (error) { 268 device_printf(ida->dev, "CMD_START_FIRMWARE failed.\n"); 269 return; 270 } 271 } 272 273 ida->num_drives = 0; 274 for (i = 0; i < cinfo.num_drvs; i++) 275 device_add_child(ida->dev, /*"idad"*/NULL, -1); 276 277 bus_generic_attach(ida->dev); 278 279 ida->cmd.int_enable(ida, 1); 280 } 281 282 int 283 ida_detach(device_t dev) 284 { 285 struct ida_softc *ida; 286 int error = 0; 287 288 ida = (struct ida_softc *)device_get_softc(dev); 289 290 /* 291 * XXX 292 * before detaching, we must make sure that the system is 293 * quiescent; nothing mounted, no pending activity. 294 */ 295 296 /* 297 * XXX 298 * now, how are we supposed to maintain a list of our drives? 299 * iterate over our "child devices"? 300 */ 301 302 303 ida_free(ida); 304 return (error); 305 } 306 307 static void 308 ida_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error) 309 { 310 struct ida_hardware_qcb *hwqcb = (struct ida_hardware_qcb *)arg; 311 int i; 312 313 hwqcb->hdr.size = (sizeof(struct ida_req) + 314 sizeof(struct ida_sgb) * IDA_NSEG) >> 2; 315 316 for (i = 0; i < nsegments; i++) { 317 hwqcb->seg[i].addr = segs[i].ds_addr; 318 hwqcb->seg[i].length = segs[i].ds_len; 319 } 320 hwqcb->req.sgcount = nsegments; 321 } 322 323 int 324 ida_command(struct ida_softc *ida, int command, void *data, int datasize, 325 int drive, int flags) 326 { 327 struct ida_hardware_qcb *hwqcb; 328 struct ida_qcb *qcb; 329 bus_dmasync_op_t op; 330 int s; 331 332 s = splbio(); 333 qcb = ida_get_qcb(ida); 334 splx(s); 335 336 if (qcb == NULL) { 337 printf("ida_command: out of QCBs"); 338 return (1); 339 } 340 341 hwqcb = qcb->hwqcb; 342 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req)); 343 344 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap, 345 (void *)data, datasize, ida_setup_dmamap, hwqcb, 0); 346 op = qcb->flags & DMA_DATA_IN ? 347 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE; 348 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op); 349 350 hwqcb->hdr.drive = drive; 351 hwqcb->req.bcount = howmany(datasize, DEV_BSIZE); 352 hwqcb->req.command = command; 353 354 qcb->flags = flags | IDA_COMMAND; 355 356 s = splbio(); 357 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe); 358 ida_start(ida); 359 ida_wait(ida, qcb, 500); 360 splx(s); 361 362 /* XXX should have status returned here? */ 363 /* XXX have "status pointer" area in QCB? */ 364 365 return (0); 366 } 367 368 void 369 ida_submit_buf(struct ida_softc *ida, struct bio *bp) 370 { 371 bioq_insert_tail(&ida->bio_queue, bp); 372 ida_construct_qcb(ida); 373 ida_start(ida); 374 } 375 376 static void 377 ida_construct_qcb(struct ida_softc *ida) 378 { 379 struct ida_hardware_qcb *hwqcb; 380 struct ida_qcb *qcb; 381 bus_dmasync_op_t op; 382 struct bio *bp; 383 384 bp = bioq_first(&ida->bio_queue); 385 if (bp == NULL) 386 return; /* no more buffers */ 387 388 qcb = ida_get_qcb(ida); 389 if (qcb == NULL) 390 return; /* out of resources */ 391 392 bioq_remove(&ida->bio_queue, bp); 393 qcb->buf = bp; 394 qcb->flags = 0; 395 396 hwqcb = qcb->hwqcb; 397 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req)); 398 399 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap, 400 (void *)bp->bio_data, bp->bio_bcount, ida_setup_dmamap, hwqcb, 0); 401 op = qcb->flags & DMA_DATA_IN ? 402 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE; 403 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op); 404 405 { 406 struct idad_softc *drv = (struct idad_softc *)bp->bio_driver1; 407 hwqcb->hdr.drive = drv->drive; 408 } 409 410 hwqcb->req.blkno = bp->bio_pblkno; 411 hwqcb->req.bcount = howmany(bp->bio_bcount, DEV_BSIZE); 412 hwqcb->req.command = bp->bio_cmd == BIO_READ ? CMD_READ : CMD_WRITE; 413 414 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe); 415 } 416 417 /* 418 * This routine will be called from ida_intr in order to queue up more 419 * I/O, meaning that we may be in an interrupt context. Hence, we should 420 * not muck around with spl() in this routine. 421 */ 422 static void 423 ida_start(struct ida_softc *ida) 424 { 425 struct ida_qcb *qcb; 426 427 while ((qcb = STAILQ_FIRST(&ida->qcb_queue)) != NULL) { 428 if (ida->cmd.fifo_full(ida)) 429 break; 430 STAILQ_REMOVE_HEAD(&ida->qcb_queue, link.stqe); 431 /* 432 * XXX 433 * place the qcb on an active list and set a timeout? 434 */ 435 qcb->state = QCB_ACTIVE; 436 ida->cmd.submit(ida, qcb); 437 } 438 } 439 440 static 441 void 442 ida_wait(struct ida_softc *ida, struct ida_qcb *qcb, int delay) 443 { 444 struct ida_qcb *qcb_done = NULL; 445 bus_addr_t completed; 446 447 if (ida->flags & IDA_ATTACHED) { 448 if (tsleep((caddr_t)qcb, PRIBIO, "idacmd", delay)) 449 panic("ida_command: timeout waiting for interrupt"); 450 return; 451 } 452 453 while ((completed = ida->cmd.done(ida)) == 0) { 454 if (delay-- == 0) 455 panic("ida_wait: timeout waiting for completion"); 456 DELAY(10); 457 } 458 459 qcb_done = idahwqcbptov(ida, completed & ~3); 460 if (qcb_done != qcb) 461 panic("ida_wait: incorrect qcb returned"); 462 ida_done(ida, qcb); 463 return; 464 } 465 466 void 467 ida_intr(void *data) 468 { 469 struct ida_softc *ida; 470 struct ida_qcb *qcb; 471 bus_addr_t completed; 472 473 ida = (struct ida_softc *)data; 474 475 if (ida->cmd.int_pending(ida) == 0) 476 return; /* not our interrupt */ 477 478 while ((completed = ida->cmd.done(ida)) != 0) { 479 qcb = idahwqcbptov(ida, completed & ~3); 480 481 if (qcb == NULL || qcb->state != QCB_ACTIVE) { 482 device_printf(ida->dev, 483 "ignoring completion %x\n", completed); 484 continue; 485 } 486 ida_done(ida, qcb); 487 } 488 ida_start(ida); 489 } 490 491 /* 492 * should switch out command type; may be status, not just I/O. 493 */ 494 static void 495 ida_done(struct ida_softc *ida, struct ida_qcb *qcb) 496 { 497 int error = 0; 498 499 /* 500 * finish up command 501 */ 502 if (qcb->flags & DMA_DATA_TRANSFER) { 503 bus_dmasync_op_t op; 504 505 op = qcb->flags & DMA_DATA_IN ? 506 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE; 507 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op); 508 bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap); 509 } 510 511 if (qcb->hwqcb->req.error & SOFT_ERROR) 512 device_printf(ida->dev, "soft error\n"); 513 if (qcb->hwqcb->req.error & HARD_ERROR) { 514 error = 1; 515 device_printf(ida->dev, "hard error\n"); 516 } 517 if (qcb->hwqcb->req.error & CMD_REJECTED) { 518 error = 1; 519 device_printf(ida->dev, "invalid request\n"); 520 } 521 522 if (qcb->flags & IDA_COMMAND) { 523 if (ida->flags & IDA_ATTACHED) 524 wakeup(qcb); 525 } else { 526 if (error) 527 qcb->buf->bio_flags |= BIO_ERROR; 528 idad_intr(qcb->buf); 529 } 530 531 qcb->state = QCB_FREE; 532 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle); 533 ida_construct_qcb(ida); 534 } 535