2 * Copyright (c) 1999,2000 Jonathan Lemon
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.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 * Generic driver for Compaq SMART RAID adapters.
38 #include <sys/param.h>
39 #include <sys/kernel.h>
40 #include <sys/systm.h>
41 #include <sys/malloc.h>
47 #include <sys/endian.h>
49 #include <machine/bus_memio.h>
50 #include <machine/bus_pio.h>
51 #include <machine/bus.h>
54 #include <geom/geom_disk.h>
56 #include <dev/ida/idareg.h>
57 #include <dev/ida/idavar.h>
58 #include <dev/ida/idaio.h>
61 static void ida_alloc_qcb(struct ida_softc *ida);
62 static void ida_construct_qcb(struct ida_softc *ida);
63 static void ida_start(struct ida_softc *ida);
64 static void ida_done(struct ida_softc *ida, struct ida_qcb *qcb);
65 static int ida_wait(struct ida_softc *ida, struct ida_qcb *qcb);
67 static d_ioctl_t ida_ioctl;
68 static struct cdevsw ida_cdevsw = {
69 .d_version = D_VERSION,
70 .d_flags = D_NEEDGIANT,
76 ida_free(struct ida_softc *ida)
80 for (i = 0; i < ida->num_qcbs; i++)
81 bus_dmamap_destroy(ida->buffer_dmat, ida->qcbs[i].dmamap);
83 if (ida->hwqcb_busaddr)
84 bus_dmamap_unload(ida->hwqcb_dmat, ida->hwqcb_dmamap);
87 bus_dmamem_free(ida->hwqcb_dmat, ida->hwqcbs,
91 bus_dma_tag_destroy(ida->buffer_dmat);
94 bus_dma_tag_destroy(ida->hwqcb_dmat);
96 if (ida->qcbs != NULL)
97 free(ida->qcbs, M_DEVBUF);
100 bus_teardown_intr(ida->dev, ida->irq, ida->ih);
102 if (ida->irq != NULL)
103 bus_release_resource(ida->dev, ida->irq_res_type,
106 if (ida->parent_dmat != NULL)
107 bus_dma_tag_destroy(ida->parent_dmat);
109 if (ida->regs != NULL)
110 bus_release_resource(ida->dev, ida->regs_res_type,
111 ida->regs_res_id, ida->regs);
115 * record bus address from bus_dmamap_load
118 ida_dma_map_cb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
122 baddr = (bus_addr_t *)arg;
123 *baddr = segs->ds_addr;
126 static __inline struct ida_qcb *
127 ida_get_qcb(struct ida_softc *ida)
131 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) {
132 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
135 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL)
136 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
141 static __inline bus_addr_t
142 idahwqcbvtop(struct ida_softc *ida, struct ida_hardware_qcb *hwqcb)
144 return (ida->hwqcb_busaddr +
145 ((bus_addr_t)hwqcb - (bus_addr_t)ida->hwqcbs));
148 static __inline struct ida_qcb *
149 idahwqcbptov(struct ida_softc *ida, bus_addr_t hwqcb_addr)
151 struct ida_hardware_qcb *hwqcb;
153 hwqcb = (struct ida_hardware_qcb *)
154 ((bus_addr_t)ida->hwqcbs + (hwqcb_addr - ida->hwqcb_busaddr));
160 * since we allocate all QCB space up front during initialization, then
161 * why bother with this routine?
164 ida_alloc_qcb(struct ida_softc *ida)
169 if (ida->num_qcbs >= IDA_QCB_MAX)
172 qcb = &ida->qcbs[ida->num_qcbs];
174 error = bus_dmamap_create(ida->buffer_dmat, /*flags*/0, &qcb->dmamap);
178 qcb->flags = QCB_FREE;
179 qcb->hwqcb = &ida->hwqcbs[ida->num_qcbs];
180 qcb->hwqcb->qcb = qcb;
181 qcb->hwqcb_busaddr = idahwqcbvtop(ida, qcb->hwqcb);
182 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
187 ida_init(struct ida_softc *ida)
191 ida->unit = device_get_unit(ida->dev);
192 ida->tag = rman_get_bustag(ida->regs);
193 ida->bsh = rman_get_bushandle(ida->regs);
195 SLIST_INIT(&ida->free_qcbs);
196 STAILQ_INIT(&ida->qcb_queue);
197 bioq_init(&ida->bio_queue);
199 ida->qcbs = (struct ida_qcb *)
200 malloc(IDA_QCB_MAX * sizeof(struct ida_qcb), M_DEVBUF,
202 if (ida->qcbs == NULL)
206 * Create our DMA tags
209 /* DMA tag for our hardware QCB structures */
210 error = bus_dma_tag_create(ida->parent_dmat,
211 /*alignment*/1, /*boundary*/0,
212 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
213 /*filter*/NULL, /*filterarg*/NULL,
214 IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
215 /*nsegments*/1, /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
216 /*flags*/0, /*lockfunc*/busdma_lock_mutex, /*lockarg*/&Giant,
221 /* DMA tag for mapping buffers into device space */
222 error = bus_dma_tag_create(ida->parent_dmat,
223 /*alignment*/1, /*boundary*/0,
224 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
225 /*filter*/NULL, /*filterarg*/NULL,
226 /*maxsize*/MAXBSIZE, /*nsegments*/IDA_NSEG,
227 /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, /*flags*/0,
228 /*lockfunc*/busdma_lock_mutex, /*lockarg*/&Giant, &ida->buffer_dmat);
232 /* Allocation of hardware QCBs */
233 /* XXX allocation is rounded to hardware page size */
234 error = bus_dmamem_alloc(ida->hwqcb_dmat,
235 (void **)&ida->hwqcbs, BUS_DMA_NOWAIT, &ida->hwqcb_dmamap);
239 /* And permanently map them in */
240 bus_dmamap_load(ida->hwqcb_dmat, ida->hwqcb_dmamap,
241 ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
242 ida_dma_map_cb, &ida->hwqcb_busaddr, /*flags*/0);
244 bzero(ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb));
246 ida_alloc_qcb(ida); /* allocate an initial qcb */
252 ida_attach(struct ida_softc *ida)
254 struct ida_controller_info cinfo;
257 ida->cmd.int_enable(ida, 0);
259 error = ida_command(ida, CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo),
260 IDA_CONTROLLER, 0, DMA_DATA_IN);
262 device_printf(ida->dev, "CMD_GET_CTRL_INFO failed.\n");
266 device_printf(ida->dev, "drives=%d firm_rev=%c%c%c%c\n",
267 cinfo.num_drvs, cinfo.firm_rev[0], cinfo.firm_rev[1],
268 cinfo.firm_rev[2], cinfo.firm_rev[3]);
270 if (ida->flags & IDA_FIRMWARE) {
273 error = ida_command(ida, CMD_START_FIRMWARE,
274 &data, sizeof(data), IDA_CONTROLLER, 0, DMA_DATA_IN);
276 device_printf(ida->dev, "CMD_START_FIRMWARE failed.\n");
281 ida->ida_dev_t = make_dev(&ida_cdevsw, ida->unit,
282 UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
284 ida->ida_dev_t->si_drv1 = ida;
287 for (i = 0; i < cinfo.num_drvs; i++)
288 device_add_child(ida->dev, /*"idad"*/NULL, -1);
290 bus_generic_attach(ida->dev);
292 ida->cmd.int_enable(ida, 1);
296 ida_detach(device_t dev)
298 struct ida_softc *ida;
301 ida = (struct ida_softc *)device_get_softc(dev);
305 * before detaching, we must make sure that the system is
306 * quiescent; nothing mounted, no pending activity.
311 * now, how are we supposed to maintain a list of our drives?
312 * iterate over our "child devices"?
315 destroy_dev(ida->ida_dev_t);
321 ida_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
323 struct ida_hardware_qcb *hwqcb = (struct ida_hardware_qcb *)arg;
326 hwqcb->hdr.size = htole16((sizeof(struct ida_req) +
327 sizeof(struct ida_sgb) * IDA_NSEG) >> 2);
329 for (i = 0; i < nsegments; i++) {
330 hwqcb->seg[i].addr = htole32(segs[i].ds_addr);
331 hwqcb->seg[i].length = htole32(segs[i].ds_len);
333 hwqcb->req.sgcount = nsegments;
337 ida_command(struct ida_softc *ida, int command, void *data, int datasize,
338 int drive, u_int32_t pblkno, int flags)
340 struct ida_hardware_qcb *hwqcb;
346 qcb = ida_get_qcb(ida);
350 printf("ida_command: out of QCBs");
355 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
357 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
358 (void *)data, datasize, ida_setup_dmamap, hwqcb, 0);
359 op = qcb->flags & DMA_DATA_IN ?
360 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
361 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
363 hwqcb->hdr.drive = drive;
364 hwqcb->req.blkno = htole32(pblkno);
365 hwqcb->req.bcount = htole16(howmany(datasize, DEV_BSIZE));
366 hwqcb->req.command = command;
368 qcb->flags = flags | IDA_COMMAND;
371 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
373 error = ida_wait(ida, qcb);
376 /* XXX should have status returned here? */
377 /* XXX have "status pointer" area in QCB? */
383 ida_submit_buf(struct ida_softc *ida, struct bio *bp)
385 bioq_insert_tail(&ida->bio_queue, bp);
386 ida_construct_qcb(ida);
391 ida_construct_qcb(struct ida_softc *ida)
393 struct ida_hardware_qcb *hwqcb;
398 bp = bioq_first(&ida->bio_queue);
400 return; /* no more buffers */
402 qcb = ida_get_qcb(ida);
404 return; /* out of resources */
406 bioq_remove(&ida->bio_queue, bp);
408 qcb->flags = bp->bio_cmd == BIO_READ ? DMA_DATA_IN : DMA_DATA_OUT;
411 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
413 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
414 (void *)bp->bio_data, bp->bio_bcount, ida_setup_dmamap, hwqcb, 0);
415 op = qcb->flags & DMA_DATA_IN ?
416 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
417 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
420 struct idad_softc *drv = (struct idad_softc *)bp->bio_driver1;
421 hwqcb->hdr.drive = drv->drive;
424 hwqcb->req.blkno = bp->bio_pblkno;
425 hwqcb->req.bcount = howmany(bp->bio_bcount, DEV_BSIZE);
426 hwqcb->req.command = bp->bio_cmd == BIO_READ ? CMD_READ : CMD_WRITE;
428 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
432 * This routine will be called from ida_intr in order to queue up more
433 * I/O, meaning that we may be in an interrupt context. Hence, we should
434 * not muck around with spl() in this routine.
437 ida_start(struct ida_softc *ida)
441 while ((qcb = STAILQ_FIRST(&ida->qcb_queue)) != NULL) {
442 if (ida->cmd.fifo_full(ida))
444 STAILQ_REMOVE_HEAD(&ida->qcb_queue, link.stqe);
447 * place the qcb on an active list and set a timeout?
449 qcb->state = QCB_ACTIVE;
450 ida->cmd.submit(ida, qcb);
455 ida_wait(struct ida_softc *ida, struct ida_qcb *qcb)
457 struct ida_qcb *qcb_done = NULL;
458 bus_addr_t completed;
461 if (ida->flags & IDA_INTERRUPTS) {
462 if (tsleep(qcb, PRIBIO, "idacmd", 5 * hz))
468 delay = 5 * 1000 * 100; /* 5 sec delay */
469 while ((completed = ida->cmd.done(ida)) == 0) {
475 qcb_done = idahwqcbptov(ida, completed & ~3);
485 struct ida_softc *ida;
487 bus_addr_t completed;
489 ida = (struct ida_softc *)data;
491 if (ida->cmd.int_pending(ida) == 0)
492 return; /* not our interrupt */
494 while ((completed = ida->cmd.done(ida)) != 0) {
495 qcb = idahwqcbptov(ida, completed & ~3);
497 if (qcb == NULL || qcb->state != QCB_ACTIVE) {
498 device_printf(ida->dev,
499 "ignoring completion %jx\n", (intmax_t)completed);
502 /* Handle "Bad Command List" errors. */
503 if ((completed & 3) && (qcb->hwqcb->req.error == 0))
504 qcb->hwqcb->req.error = CMD_REJECTED;
511 * should switch out command type; may be status, not just I/O.
514 ida_done(struct ida_softc *ida, struct ida_qcb *qcb)
521 if (qcb->flags & DMA_DATA_TRANSFER) {
524 op = qcb->flags & DMA_DATA_IN ?
525 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE;
526 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
527 bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap);
530 if (qcb->hwqcb->req.error & SOFT_ERROR) {
532 device_printf(ida->dev, "soft %s error\n",
533 qcb->buf->bio_cmd == BIO_READ ?
536 device_printf(ida->dev, "soft error\n");
538 if (qcb->hwqcb->req.error & HARD_ERROR) {
541 device_printf(ida->dev, "hard %s error\n",
542 qcb->buf->bio_cmd == BIO_READ ?
545 device_printf(ida->dev, "hard error\n");
547 if (qcb->hwqcb->req.error & CMD_REJECTED) {
549 device_printf(ida->dev, "invalid request\n");
552 if (qcb->flags & IDA_COMMAND) {
553 if (ida->flags & IDA_INTERRUPTS)
557 qcb->buf->bio_flags |= BIO_ERROR;
561 qcb->state = QCB_FREE;
563 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
564 ida_construct_qcb(ida);
568 * IOCTL stuff follows.
575 static struct cmd_info *ida_cmd_lookup(int);
578 ida_ioctl (dev_t dev, u_long cmd, caddr_t addr, int32_t flag, struct thread *td)
580 struct ida_softc *sc;
581 struct ida_user_command *uc;
589 sc = (struct ida_softc *)dev->si_drv1;
590 uc = (struct ida_user_command *)addr;
595 ci = ida_cmd_lookup(uc->command);
608 error = ida_command(sc, uc->command, daddr, len,
609 uc->drive, uc->blkno, flags);
618 static struct cmd_info ci_list[] = {
619 { CMD_GET_LOG_DRV_INFO,
620 sizeof(struct ida_drive_info), DMA_DATA_IN },
622 sizeof(struct ida_controller_info), DMA_DATA_IN },
623 { CMD_SENSE_DRV_STATUS,
624 sizeof(struct ida_drive_status), DMA_DATA_IN },
625 { CMD_START_RECOVERY, 0, 0 },
626 { CMD_GET_PHYS_DRV_INFO,
627 sizeof(struct ida_phys_drv_info), DMA_DATA_TRANSFER },
628 { CMD_BLINK_DRV_LEDS,
629 sizeof(struct ida_blink_drv_leds), DMA_DATA_OUT },
630 { CMD_SENSE_DRV_LEDS,
631 sizeof(struct ida_blink_drv_leds), DMA_DATA_IN },
632 { CMD_GET_LOG_DRV_EXT,
633 sizeof(struct ida_drive_info_ext), DMA_DATA_IN },
634 { CMD_RESET_CTRL, 0, 0 },
635 { CMD_GET_CONFIG, 0, 0 },
636 { CMD_SET_CONFIG, 0, 0 },
638 sizeof(struct ida_label_logical), DMA_DATA_OUT },
639 { CMD_SET_SURFACE_DELAY, 0, 0 },
640 { CMD_SENSE_BUS_PARAMS, 0, 0 },
641 { CMD_SENSE_SUBSYS_INFO, 0, 0 },
642 { CMD_SENSE_SURFACE_ATS, 0, 0 },
643 { CMD_PASSTHROUGH, 0, 0 },
644 { CMD_RESET_SCSI_DEV, 0, 0 },
645 { CMD_PAUSE_BG_ACT, 0, 0 },
646 { CMD_RESUME_BG_ACT, 0, 0 },
647 { CMD_START_FIRMWARE, 0, 0 },
648 { CMD_SENSE_DRV_ERR_LOG, 0, 0 },
649 { CMD_START_CPM, 0, 0 },
650 { CMD_SENSE_CP, 0, 0 },
651 { CMD_STOP_CPM, 0, 0 },
652 { CMD_FLUSH_CACHE, 0, 0 },
653 { CMD_ACCEPT_MEDIA_EXCH, 0, 0 },
657 static struct cmd_info *
658 ida_cmd_lookup (int command)
664 if (ci->cmd == command)