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
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.13 2006/09/05 03:48:11 dillon Exp $
35 * Generic driver for Compaq SMART RAID adapters.
37 * Specific probe routines are in:
39 * i386/eisa/ida_eisa.c
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>
52 #include <sys/devicestat.h>
56 #include <machine/bus_memio.h>
58 #include <machine/bus_pio.h>
59 #include <machine/bus.h>
60 #include <machine/clock.h>
63 #include <sys/thread2.h>
69 static void ida_alloc_qcb(struct ida_softc *ida);
70 static void ida_construct_qcb(struct ida_softc *ida);
71 static void ida_start(struct ida_softc *ida);
72 static void ida_done(struct ida_softc *ida, struct ida_qcb *qcb);
73 static int ida_wait(struct ida_softc *ida, struct ida_qcb *qcb);
75 DECLARE_DUMMY_MODULE(ida);
78 ida_free(struct ida_softc *ida)
82 for (i = 0; i < ida->num_qcbs; i++)
83 bus_dmamap_destroy(ida->buffer_dmat, ida->qcbs[i].dmamap);
85 if (ida->hwqcb_busaddr)
86 bus_dmamap_unload(ida->hwqcb_dmat, ida->hwqcb_dmamap);
89 bus_dmamem_free(ida->hwqcb_dmat, ida->hwqcbs,
93 bus_dma_tag_destroy(ida->buffer_dmat);
96 bus_dma_tag_destroy(ida->hwqcb_dmat);
98 if (ida->qcbs != NULL)
99 kfree(ida->qcbs, M_DEVBUF);
102 bus_teardown_intr(ida->dev, ida->irq, ida->ih);
104 if (ida->irq != NULL)
105 bus_release_resource(ida->dev, ida->irq_res_type,
108 if (ida->parent_dmat != NULL)
109 bus_dma_tag_destroy(ida->parent_dmat);
111 if (ida->regs != NULL)
112 bus_release_resource(ida->dev, ida->regs_res_type,
113 ida->regs_res_id, ida->regs);
117 * record bus address from bus_dmamap_load
120 ida_dma_map_cb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
124 baddr = (bus_addr_t *)arg;
125 *baddr = segs->ds_addr;
128 static __inline struct ida_qcb *
129 ida_get_qcb(struct ida_softc *ida)
133 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) {
134 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
137 if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL)
138 SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
143 static __inline bus_addr_t
144 idahwqcbvtop(struct ida_softc *ida, struct ida_hardware_qcb *hwqcb)
146 return (ida->hwqcb_busaddr +
147 ((bus_addr_t)hwqcb - (bus_addr_t)ida->hwqcbs));
150 static __inline struct ida_qcb *
151 idahwqcbptov(struct ida_softc *ida, bus_addr_t hwqcb_addr)
153 struct ida_hardware_qcb *hwqcb;
155 hwqcb = (struct ida_hardware_qcb *)
156 ((bus_addr_t)ida->hwqcbs + (hwqcb_addr - ida->hwqcb_busaddr));
162 * since we allocate all QCB space up front during initialization, then
163 * why bother with this routine?
166 ida_alloc_qcb(struct ida_softc *ida)
171 if (ida->num_qcbs >= IDA_QCB_MAX)
174 qcb = &ida->qcbs[ida->num_qcbs];
176 error = bus_dmamap_create(ida->buffer_dmat, /*flags*/0, &qcb->dmamap);
180 qcb->flags = QCB_FREE;
181 qcb->hwqcb = &ida->hwqcbs[ida->num_qcbs];
182 qcb->hwqcb->qcb = qcb;
183 qcb->hwqcb_busaddr = idahwqcbvtop(ida, qcb->hwqcb);
184 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
189 ida_init(struct ida_softc *ida)
193 ida->unit = device_get_unit(ida->dev);
194 ida->tag = rman_get_bustag(ida->regs);
195 ida->bsh = rman_get_bushandle(ida->regs);
197 SLIST_INIT(&ida->free_qcbs);
198 STAILQ_INIT(&ida->qcb_queue);
199 bioq_init(&ida->bio_queue);
201 ida->qcbs = kmalloc(IDA_QCB_MAX * sizeof(struct ida_qcb),
202 M_DEVBUF, M_INTWAIT|M_ZERO);
205 * Create our DMA tags
208 /* DMA tag for our hardware QCB structures */
209 error = bus_dma_tag_create(ida->parent_dmat,
210 /*alignment*/1, /*boundary*/0,
211 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
212 /*filter*/NULL, /*filterarg*/NULL,
213 IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
214 /*nsegments*/1, /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
215 /*flags*/0, &ida->hwqcb_dmat);
219 /* DMA tag for mapping buffers into device space */
220 error = bus_dma_tag_create(ida->parent_dmat,
221 /*alignment*/1, /*boundary*/0,
222 /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
223 /*filter*/NULL, /*filterarg*/NULL,
224 /*maxsize*/MAXBSIZE, /*nsegments*/IDA_NSEG,
225 /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, /*flags*/0, &ida->buffer_dmat);
229 /* Allocation of hardware QCBs */
230 /* XXX allocation is rounded to hardware page size */
231 error = bus_dmamem_alloc(ida->hwqcb_dmat,
232 (void **)&ida->hwqcbs, BUS_DMA_NOWAIT, &ida->hwqcb_dmamap);
236 /* And permanently map them in */
237 bus_dmamap_load(ida->hwqcb_dmat, ida->hwqcb_dmamap,
238 ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
239 ida_dma_map_cb, &ida->hwqcb_busaddr, /*flags*/0);
241 bzero(ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb));
243 ida_alloc_qcb(ida); /* allocate an initial qcb */
249 ida_attach(struct ida_softc *ida)
251 struct ida_controller_info cinfo;
254 ida->cmd.int_enable(ida, 0);
256 error = ida_command(ida, CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo),
257 IDA_CONTROLLER, 0, DMA_DATA_IN);
259 device_printf(ida->dev, "CMD_GET_CTRL_INFO failed.\n");
263 device_printf(ida->dev, "drives=%d firm_rev=%c%c%c%c\n",
264 cinfo.num_drvs, cinfo.firm_rev[0], cinfo.firm_rev[1],
265 cinfo.firm_rev[2], cinfo.firm_rev[3]);
267 if (ida->flags & IDA_FIRMWARE) {
270 error = ida_command(ida, CMD_START_FIRMWARE,
271 &data, sizeof(data), IDA_CONTROLLER, 0, DMA_DATA_IN);
273 device_printf(ida->dev, "CMD_START_FIRMWARE failed.\n");
279 for (i = 0; i < cinfo.num_drvs; i++)
280 device_add_child(ida->dev, /*"idad"*/NULL, -1);
282 bus_generic_attach(ida->dev);
284 ida->cmd.int_enable(ida, 1);
288 ida_detach(device_t dev)
290 struct ida_softc *ida;
293 ida = (struct ida_softc *)device_get_softc(dev);
297 * before detaching, we must make sure that the system is
298 * quiescent; nothing mounted, no pending activity.
303 * now, how are we supposed to maintain a list of our drives?
304 * iterate over our "child devices"?
313 ida_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
315 struct ida_hardware_qcb *hwqcb = (struct ida_hardware_qcb *)arg;
318 hwqcb->hdr.size = (sizeof(struct ida_req) +
319 sizeof(struct ida_sgb) * IDA_NSEG) >> 2;
321 for (i = 0; i < nsegments; i++) {
322 hwqcb->seg[i].addr = segs[i].ds_addr;
323 hwqcb->seg[i].length = segs[i].ds_len;
325 hwqcb->req.sgcount = nsegments;
329 ida_command(struct ida_softc *ida, int command, void *data, int datasize,
330 int drive, u_int32_t pblkno, int flags)
332 struct ida_hardware_qcb *hwqcb;
338 qcb = ida_get_qcb(ida);
342 printf("ida_command: out of QCBs");
347 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
349 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
350 (void *)data, datasize, ida_setup_dmamap, hwqcb, 0);
351 op = qcb->flags & DMA_DATA_IN ?
352 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
353 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
355 hwqcb->hdr.drive = drive;
356 hwqcb->req.blkno = pblkno;
357 hwqcb->req.bcount = howmany(datasize, DEV_BSIZE);
358 hwqcb->req.command = command;
360 qcb->flags = flags | IDA_COMMAND;
363 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
365 error = ida_wait(ida, qcb);
368 /* XXX should have status returned here? */
369 /* XXX have "status pointer" area in QCB? */
375 ida_submit_buf(struct ida_softc *ida, struct bio *bio)
377 bioq_insert_tail(&ida->bio_queue, bio);
378 ida_construct_qcb(ida);
383 ida_construct_qcb(struct ida_softc *ida)
385 struct ida_hardware_qcb *hwqcb;
391 bio = bioq_first(&ida->bio_queue);
393 return; /* no more buffers */
395 qcb = ida_get_qcb(ida);
397 return; /* out of resources */
399 bioq_remove(&ida->bio_queue, bio);
404 bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
407 bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
408 (void *)bp->b_data, bp->b_bcount, ida_setup_dmamap, hwqcb, 0);
409 op = qcb->flags & DMA_DATA_IN ?
410 BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
411 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
414 struct idad_softc *drv;
416 drv = (struct idad_softc *)bio->bio_driver_info;
417 hwqcb->hdr.drive = drv->drive;
420 hwqcb->req.blkno = bio->bio_offset >> DEV_BSHIFT;
421 hwqcb->req.bcount = howmany(bp->b_bcount, DEV_BSIZE);
422 hwqcb->req.command = (bp->b_cmd == BUF_CMD_READ) ? CMD_READ : CMD_WRITE;
424 STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
428 * This routine will be called from ida_intr in order to queue up more
429 * I/O, meaning that we may be in an interrupt context. Hence, we should
430 * not muck around with spl() in this routine.
433 ida_start(struct ida_softc *ida)
437 while ((qcb = STAILQ_FIRST(&ida->qcb_queue)) != NULL) {
438 if (ida->cmd.fifo_full(ida))
440 STAILQ_REMOVE_HEAD(&ida->qcb_queue, link.stqe);
443 * place the qcb on an active list and set a timeout?
445 qcb->state = QCB_ACTIVE;
446 ida->cmd.submit(ida, qcb);
451 ida_wait(struct ida_softc *ida, struct ida_qcb *qcb)
453 struct ida_qcb *qcb_done = NULL;
454 bus_addr_t completed;
457 if (ida->flags & IDA_INTERRUPTS) {
458 if (tsleep((caddr_t)qcb, 0, "idacmd", 5 * hz))
464 delay = 5 * 1000 * 100; /* 5 sec delay */
465 while ((completed = ida->cmd.done(ida)) == 0) {
471 qcb_done = idahwqcbptov(ida, completed & ~3);
481 struct ida_softc *ida;
483 bus_addr_t completed;
485 ida = (struct ida_softc *)data;
487 if (ida->cmd.int_pending(ida) == 0)
488 return; /* not our interrupt */
490 while ((completed = ida->cmd.done(ida)) != 0) {
491 qcb = idahwqcbptov(ida, completed & ~3);
493 if (qcb == NULL || qcb->state != QCB_ACTIVE) {
494 device_printf(ida->dev,
495 "ignoring completion %x\n", completed);
504 * should switch out command type; may be status, not just I/O.
507 ida_done(struct ida_softc *ida, struct ida_qcb *qcb)
514 if (qcb->flags & DMA_DATA_TRANSFER) {
517 op = qcb->flags & DMA_DATA_IN ?
518 BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE;
519 bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
520 bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap);
523 if (qcb->hwqcb->req.error & SOFT_ERROR)
524 device_printf(ida->dev, "soft error\n");
525 if (qcb->hwqcb->req.error & HARD_ERROR) {
527 device_printf(ida->dev, "hard error\n");
529 if (qcb->hwqcb->req.error & CMD_REJECTED) {
531 device_printf(ida->dev, "invalid request\n");
534 if (qcb->flags & IDA_COMMAND) {
535 if (ida->flags & IDA_INTERRUPTS)
539 qcb->bio->bio_buf->b_flags |= B_ERROR;
543 qcb->state = QCB_FREE;
544 SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
545 ida_construct_qcb(ida);