xref: /freebsd/sys/dev/ida/ida.c (revision f9218d3d4fd34f082473b3a021c6d4d109fb47cf) 
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 <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/stdint.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/conf.h>
51 #include <sys/disk.h>
52 
53 #include <machine/bus_memio.h>
54 #include <machine/bus_pio.h>
55 #include <machine/bus.h>
56 #include <sys/rman.h>
57 
58 #include <dev/ida/idareg.h>
59 #include <dev/ida/idavar.h>
60 
61 /* prototypes */
62 static void ida_alloc_qcb(struct ida_softc *ida);
63 static void ida_construct_qcb(struct ida_softc *ida);
64 static void ida_start(struct ida_softc *ida);
65 static void ida_done(struct ida_softc *ida, struct ida_qcb *qcb);
66 static int ida_wait(struct ida_softc *ida, struct ida_qcb *qcb);
67 
68 void
69 ida_free(struct ida_softc *ida)
70 {
71 	int i;
72 
73 	for (i = 0; i < ida->num_qcbs; i++)
74 		bus_dmamap_destroy(ida->buffer_dmat, ida->qcbs[i].dmamap);
75 
76 	if (ida->hwqcb_busaddr)
77 		bus_dmamap_unload(ida->hwqcb_dmat, ida->hwqcb_dmamap);
78 
79 	if (ida->hwqcbs)
80 		bus_dmamem_free(ida->hwqcb_dmat, ida->hwqcbs,
81 		    ida->hwqcb_dmamap);
82 
83 	if (ida->buffer_dmat)
84 		bus_dma_tag_destroy(ida->buffer_dmat);
85 
86 	if (ida->hwqcb_dmat)
87 		bus_dma_tag_destroy(ida->hwqcb_dmat);
88 
89 	if (ida->qcbs != NULL)
90 		free(ida->qcbs, M_DEVBUF);
91 
92 	if (ida->ih != NULL)
93                 bus_teardown_intr(ida->dev, ida->irq, ida->ih);
94 
95 	if (ida->irq != NULL)
96 		bus_release_resource(ida->dev, ida->irq_res_type,
97 		    0, ida->irq);
98 
99 	if (ida->parent_dmat != NULL)
100 		bus_dma_tag_destroy(ida->parent_dmat);
101 
102 	if (ida->regs != NULL)
103 		bus_release_resource(ida->dev, ida->regs_res_type,
104 		    ida->regs_res_id, ida->regs);
105 }
106 
107 /*
108  * record bus address from bus_dmamap_load
109  */
110 static void
111 ida_dma_map_cb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
112 {
113         bus_addr_t *baddr;
114 
115         baddr = (bus_addr_t *)arg;
116         *baddr = segs->ds_addr;
117 }
118 
119 static __inline struct ida_qcb *
120 ida_get_qcb(struct ida_softc *ida)
121 {
122 	struct ida_qcb *qcb;
123 
124 	if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) {
125 		SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
126 	} else {
127 		ida_alloc_qcb(ida);
128 		if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL)
129 			SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
130 	}
131 	return (qcb);
132 }
133 
134 static __inline bus_addr_t
135 idahwqcbvtop(struct ida_softc *ida, struct ida_hardware_qcb *hwqcb)
136 {
137 	return (ida->hwqcb_busaddr +
138 	    ((bus_addr_t)hwqcb - (bus_addr_t)ida->hwqcbs));
139 }
140 
141 static __inline struct ida_qcb *
142 idahwqcbptov(struct ida_softc *ida, bus_addr_t hwqcb_addr)
143 {
144 	struct ida_hardware_qcb *hwqcb;
145 
146 	hwqcb = (struct ida_hardware_qcb *)
147 	    ((bus_addr_t)ida->hwqcbs + (hwqcb_addr - ida->hwqcb_busaddr));
148 	return (hwqcb->qcb);
149 }
150 
151 /*
152  * XXX
153  * since we allocate all QCB space up front during initialization, then
154  * why bother with this routine?
155  */
156 static void
157 ida_alloc_qcb(struct ida_softc *ida)
158 {
159 	struct ida_qcb *qcb;
160 	int error;
161 
162 	if (ida->num_qcbs >= IDA_QCB_MAX)
163 		return;
164 
165 	qcb = &ida->qcbs[ida->num_qcbs];
166 
167 	error = bus_dmamap_create(ida->buffer_dmat, /*flags*/0, &qcb->dmamap);
168 	if (error != 0)
169 		return;
170 
171 	qcb->flags = QCB_FREE;
172 	qcb->hwqcb = &ida->hwqcbs[ida->num_qcbs];
173 	qcb->hwqcb->qcb = qcb;
174 	qcb->hwqcb_busaddr = idahwqcbvtop(ida, qcb->hwqcb);
175 	SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
176 	ida->num_qcbs++;
177 }
178 
179 int
180 ida_init(struct ida_softc *ida)
181 {
182 	int error;
183 
184 	ida->unit = device_get_unit(ida->dev);
185 	ida->tag = rman_get_bustag(ida->regs);
186 	ida->bsh = rman_get_bushandle(ida->regs);
187 
188 	SLIST_INIT(&ida->free_qcbs);
189 	STAILQ_INIT(&ida->qcb_queue);
190         bioq_init(&ida->bio_queue);
191 
192 	ida->qcbs = (struct ida_qcb *)
193 	    malloc(IDA_QCB_MAX * sizeof(struct ida_qcb), M_DEVBUF,
194 		M_NOWAIT | M_ZERO);
195 	if (ida->qcbs == NULL)
196 		return (ENOMEM);
197 
198 	/*
199 	 * Create our DMA tags
200 	 */
201 
202 	/* DMA tag for our hardware QCB structures */
203 	error = bus_dma_tag_create(ida->parent_dmat,
204 	    /*alignment*/1, /*boundary*/0,
205 	    /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
206 	    /*filter*/NULL, /*filterarg*/NULL,
207 	    IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
208 	    /*nsegments*/1, /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
209 	    /*flags*/0, &ida->hwqcb_dmat);
210 	if (error)
211                 return (ENOMEM);
212 
213 	/* DMA tag for mapping buffers into device space */
214 	error = bus_dma_tag_create(ida->parent_dmat,
215 	    /*alignment*/1, /*boundary*/0,
216 	    /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
217 	    /*filter*/NULL, /*filterarg*/NULL,
218 	    /*maxsize*/MAXBSIZE, /*nsegments*/IDA_NSEG,
219 	    /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, /*flags*/0, &ida->buffer_dmat);
220 	if (error)
221                 return (ENOMEM);
222 
223         /* Allocation of hardware QCBs */
224 	/* XXX allocation is rounded to hardware page size */
225 	error = bus_dmamem_alloc(ida->hwqcb_dmat,
226 	    (void **)&ida->hwqcbs, BUS_DMA_NOWAIT, &ida->hwqcb_dmamap);
227 	if (error)
228                 return (ENOMEM);
229 
230         /* And permanently map them in */
231         bus_dmamap_load(ida->hwqcb_dmat, ida->hwqcb_dmamap,
232 	    ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
233 	    ida_dma_map_cb, &ida->hwqcb_busaddr, /*flags*/0);
234 
235 	bzero(ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb));
236 
237 	ida_alloc_qcb(ida);		/* allocate an initial qcb */
238 
239 	return (0);
240 }
241 
242 void
243 ida_attach(struct ida_softc *ida)
244 {
245 	struct ida_controller_info cinfo;
246 	int error, i;
247 
248 	ida->cmd.int_enable(ida, 0);
249 
250 	error = ida_command(ida, CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo),
251 	    IDA_CONTROLLER, 0, DMA_DATA_IN);
252 	if (error) {
253 		device_printf(ida->dev, "CMD_GET_CTRL_INFO failed.\n");
254 		return;
255 	}
256 
257 	device_printf(ida->dev, "drives=%d firm_rev=%c%c%c%c\n",
258 	    cinfo.num_drvs, cinfo.firm_rev[0], cinfo.firm_rev[1],
259 	    cinfo.firm_rev[2], cinfo.firm_rev[3]);
260 
261 	if (ida->flags & IDA_FIRMWARE) {
262 		int data;
263 
264 		error = ida_command(ida, CMD_START_FIRMWARE,
265 		    &data, sizeof(data), IDA_CONTROLLER, 0, DMA_DATA_IN);
266 		if (error) {
267 			device_printf(ida->dev, "CMD_START_FIRMWARE failed.\n");
268 			return;
269 		}
270 	}
271 
272 	ida->num_drives = 0;
273 	for (i = 0; i < cinfo.num_drvs; i++)
274 		device_add_child(ida->dev, /*"idad"*/NULL, -1);
275 
276 	bus_generic_attach(ida->dev);
277 
278 	ida->cmd.int_enable(ida, 1);
279 }
280 
281 int
282 ida_detach(device_t dev)
283 {
284 	struct ida_softc *ida;
285 	int error = 0;
286 
287         ida = (struct ida_softc *)device_get_softc(dev);
288 
289 	/*
290 	 * XXX
291 	 * before detaching, we must make sure that the system is
292 	 * quiescent; nothing mounted, no pending activity.
293 	 */
294 
295 	/*
296 	 * XXX
297 	 * now, how are we supposed to maintain a list of our drives?
298 	 * iterate over our "child devices"?
299 	 */
300 
301 
302 	ida_free(ida);
303 	return (error);
304 }
305 
306 static void
307 ida_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
308 {
309 	struct ida_hardware_qcb *hwqcb = (struct ida_hardware_qcb *)arg;
310 	int i;
311 
312 	hwqcb->hdr.size = (sizeof(struct ida_req) +
313 	    sizeof(struct ida_sgb) * IDA_NSEG) >> 2;
314 
315 	for (i = 0; i < nsegments; i++) {
316 		hwqcb->seg[i].addr = segs[i].ds_addr;
317 		hwqcb->seg[i].length = segs[i].ds_len;
318 	}
319 	hwqcb->req.sgcount = nsegments;
320 }
321 
322 int
323 ida_command(struct ida_softc *ida, int command, void *data, int datasize,
324 	int drive, u_int32_t pblkno, int flags)
325 {
326 	struct ida_hardware_qcb *hwqcb;
327 	struct ida_qcb *qcb;
328 	bus_dmasync_op_t op;
329 	int s, error;
330 
331 	s = splbio();
332 	qcb = ida_get_qcb(ida);
333 	splx(s);
334 
335 	if (qcb == NULL) {
336 		printf("ida_command: out of QCBs");
337 		return (EAGAIN);
338 	}
339 
340 	hwqcb = qcb->hwqcb;
341 	bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
342 
343 	bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
344 	    (void *)data, datasize, ida_setup_dmamap, hwqcb, 0);
345 	op = qcb->flags & DMA_DATA_IN ?
346 	    BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
347 	bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
348 
349 	hwqcb->hdr.drive = drive;
350 	hwqcb->req.blkno = pblkno;
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 	error = ida_wait(ida, qcb);
360 	splx(s);
361 
362 	/* XXX should have status returned here? */
363 	/* XXX have "status pointer" area in QCB? */
364 
365 	return (error);
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 int
441 ida_wait(struct ida_softc *ida, struct ida_qcb *qcb)
442 {
443 	struct ida_qcb *qcb_done = NULL;
444 	bus_addr_t completed;
445 	int delay;
446 
447 	if (ida->flags & IDA_INTERRUPTS) {
448 		if (tsleep(qcb, PRIBIO, "idacmd", 5 * hz))
449 			return (ETIMEDOUT);
450 		return (0);
451 	}
452 
453 again:
454 	delay = 5 * 1000 * 100;			/* 5 sec delay */
455 	while ((completed = ida->cmd.done(ida)) == 0) {
456 		if (delay-- == 0)
457 			return (ETIMEDOUT);
458 		DELAY(10);
459 	}
460 
461 	qcb_done = idahwqcbptov(ida, completed & ~3);
462 	if (qcb_done != qcb)
463 		goto again;
464 	ida_done(ida, qcb);
465 	return (0);
466 }
467 
468 void
469 ida_intr(void *data)
470 {
471 	struct ida_softc *ida;
472 	struct ida_qcb *qcb;
473 	bus_addr_t completed;
474 
475 	ida = (struct ida_softc *)data;
476 
477 	if (ida->cmd.int_pending(ida) == 0)
478 		return;				/* not our interrupt */
479 
480 	while ((completed = ida->cmd.done(ida)) != 0) {
481 		qcb = idahwqcbptov(ida, completed & ~3);
482 
483 		if (qcb == NULL || qcb->state != QCB_ACTIVE) {
484 			device_printf(ida->dev,
485 			    "ignoring completion %jx\n", (intmax_t)completed);
486 			continue;
487 		}
488 		ida_done(ida, qcb);
489 	}
490 	ida_start(ida);
491 }
492 
493 /*
494  * should switch out command type; may be status, not just I/O.
495  */
496 static void
497 ida_done(struct ida_softc *ida, struct ida_qcb *qcb)
498 {
499 	int error = 0;
500 
501 	/*
502 	 * finish up command
503 	 */
504 	if (qcb->flags & DMA_DATA_TRANSFER) {
505 		bus_dmasync_op_t op;
506 
507 		op = qcb->flags & DMA_DATA_IN ?
508 		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE;
509 		bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
510 		bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap);
511 	}
512 
513 	if (qcb->hwqcb->req.error & SOFT_ERROR)
514 		device_printf(ida->dev, "soft error\n");
515 	if (qcb->hwqcb->req.error & HARD_ERROR) {
516 		error = 1;
517 		device_printf(ida->dev, "hard error\n");
518 	}
519 	if (qcb->hwqcb->req.error & CMD_REJECTED) {
520 		error = 1;
521 		device_printf(ida->dev, "invalid request\n");
522 	}
523 
524 	if (qcb->flags & IDA_COMMAND) {
525 		if (ida->flags & IDA_INTERRUPTS)
526 			wakeup(qcb);
527 	} else {
528 		if (error)
529 			qcb->buf->bio_flags |= BIO_ERROR;
530 		idad_intr(qcb->buf);
531 	}
532 
533 	qcb->state = QCB_FREE;
534 	SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
535 	ida_construct_qcb(ida);
536 }
537