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