xref: /freebsd/sys/dev/ida/ida.c (revision f6b1c44d1f70d5f298b911f2c1dcd802b0d11339) 
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/systm.h>
44 #include <sys/malloc.h>
45 
46 #include <sys/bio.h>
47 #include <sys/bus.h>
48 #include <sys/conf.h>
49 
50 #include <machine/bus_memio.h>
51 #include <machine/bus_pio.h>
52 #include <machine/bus.h>
53 #include <sys/rman.h>
54 
55 #include <geom/geom_disk.h>
56 
57 #include <dev/ida/idareg.h>
58 #include <dev/ida/idavar.h>
59 
60 /* prototypes */
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);
66 
67 void
68 ida_free(struct ida_softc *ida)
69 {
70 	int i;
71 
72 	for (i = 0; i < ida->num_qcbs; i++)
73 		bus_dmamap_destroy(ida->buffer_dmat, ida->qcbs[i].dmamap);
74 
75 	if (ida->hwqcb_busaddr)
76 		bus_dmamap_unload(ida->hwqcb_dmat, ida->hwqcb_dmamap);
77 
78 	if (ida->hwqcbs)
79 		bus_dmamem_free(ida->hwqcb_dmat, ida->hwqcbs,
80 		    ida->hwqcb_dmamap);
81 
82 	if (ida->buffer_dmat)
83 		bus_dma_tag_destroy(ida->buffer_dmat);
84 
85 	if (ida->hwqcb_dmat)
86 		bus_dma_tag_destroy(ida->hwqcb_dmat);
87 
88 	if (ida->qcbs != NULL)
89 		free(ida->qcbs, M_DEVBUF);
90 
91 	if (ida->ih != NULL)
92                 bus_teardown_intr(ida->dev, ida->irq, ida->ih);
93 
94 	if (ida->irq != NULL)
95 		bus_release_resource(ida->dev, ida->irq_res_type,
96 		    0, ida->irq);
97 
98 	if (ida->parent_dmat != NULL)
99 		bus_dma_tag_destroy(ida->parent_dmat);
100 
101 	if (ida->regs != NULL)
102 		bus_release_resource(ida->dev, ida->regs_res_type,
103 		    ida->regs_res_id, ida->regs);
104 }
105 
106 /*
107  * record bus address from bus_dmamap_load
108  */
109 static void
110 ida_dma_map_cb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
111 {
112         bus_addr_t *baddr;
113 
114         baddr = (bus_addr_t *)arg;
115         *baddr = segs->ds_addr;
116 }
117 
118 static __inline struct ida_qcb *
119 ida_get_qcb(struct ida_softc *ida)
120 {
121 	struct ida_qcb *qcb;
122 
123 	if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL) {
124 		SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
125 	} else {
126 		ida_alloc_qcb(ida);
127 		if ((qcb = SLIST_FIRST(&ida->free_qcbs)) != NULL)
128 			SLIST_REMOVE_HEAD(&ida->free_qcbs, link.sle);
129 	}
130 	return (qcb);
131 }
132 
133 static __inline bus_addr_t
134 idahwqcbvtop(struct ida_softc *ida, struct ida_hardware_qcb *hwqcb)
135 {
136 	return (ida->hwqcb_busaddr +
137 	    ((bus_addr_t)hwqcb - (bus_addr_t)ida->hwqcbs));
138 }
139 
140 static __inline struct ida_qcb *
141 idahwqcbptov(struct ida_softc *ida, bus_addr_t hwqcb_addr)
142 {
143 	struct ida_hardware_qcb *hwqcb;
144 
145 	hwqcb = (struct ida_hardware_qcb *)
146 	    ((bus_addr_t)ida->hwqcbs + (hwqcb_addr - ida->hwqcb_busaddr));
147 	return (hwqcb->qcb);
148 }
149 
150 /*
151  * XXX
152  * since we allocate all QCB space up front during initialization, then
153  * why bother with this routine?
154  */
155 static void
156 ida_alloc_qcb(struct ida_softc *ida)
157 {
158 	struct ida_qcb *qcb;
159 	int error;
160 
161 	if (ida->num_qcbs >= IDA_QCB_MAX)
162 		return;
163 
164 	qcb = &ida->qcbs[ida->num_qcbs];
165 
166 	error = bus_dmamap_create(ida->buffer_dmat, /*flags*/0, &qcb->dmamap);
167 	if (error != 0)
168 		return;
169 
170 	qcb->flags = QCB_FREE;
171 	qcb->hwqcb = &ida->hwqcbs[ida->num_qcbs];
172 	qcb->hwqcb->qcb = qcb;
173 	qcb->hwqcb_busaddr = idahwqcbvtop(ida, qcb->hwqcb);
174 	SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
175 	ida->num_qcbs++;
176 }
177 
178 int
179 ida_init(struct ida_softc *ida)
180 {
181 	int error;
182 
183 	ida->unit = device_get_unit(ida->dev);
184 	ida->tag = rman_get_bustag(ida->regs);
185 	ida->bsh = rman_get_bushandle(ida->regs);
186 
187 	SLIST_INIT(&ida->free_qcbs);
188 	STAILQ_INIT(&ida->qcb_queue);
189         bioq_init(&ida->bio_queue);
190 
191 	ida->qcbs = (struct ida_qcb *)
192 	    malloc(IDA_QCB_MAX * sizeof(struct ida_qcb), M_DEVBUF,
193 		M_NOWAIT | M_ZERO);
194 	if (ida->qcbs == NULL)
195 		return (ENOMEM);
196 
197 	/*
198 	 * Create our DMA tags
199 	 */
200 
201 	/* DMA tag for our hardware QCB structures */
202 	error = bus_dma_tag_create(ida->parent_dmat,
203 	    /*alignment*/1, /*boundary*/0,
204 	    /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
205 	    /*filter*/NULL, /*filterarg*/NULL,
206 	    IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
207 	    /*nsegments*/1, /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
208 	    /*flags*/0, /*lockfunc*/busdma_lock_mutex, /*lockarg*/&Giant,
209 	    &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,
220 	    /*lockfunc*/busdma_lock_mutex, /*lockarg*/&Giant, &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, 0, 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, 0, 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, u_int32_t pblkno, int flags)
326 {
327 	struct ida_hardware_qcb *hwqcb;
328 	struct ida_qcb *qcb;
329 	bus_dmasync_op_t op;
330 	int s, error;
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 (EAGAIN);
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.blkno = pblkno;
352 	hwqcb->req.bcount = howmany(datasize, DEV_BSIZE);
353 	hwqcb->req.command = command;
354 
355 	qcb->flags = flags | IDA_COMMAND;
356 
357 	s = splbio();
358 	STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
359 	ida_start(ida);
360 	error = ida_wait(ida, qcb);
361 	splx(s);
362 
363 	/* XXX should have status returned here? */
364 	/* XXX have "status pointer" area in QCB? */
365 
366 	return (error);
367 }
368 
369 void
370 ida_submit_buf(struct ida_softc *ida, struct bio *bp)
371 {
372         bioq_insert_tail(&ida->bio_queue, bp);
373         ida_construct_qcb(ida);
374 	ida_start(ida);
375 }
376 
377 static void
378 ida_construct_qcb(struct ida_softc *ida)
379 {
380 	struct ida_hardware_qcb *hwqcb;
381 	struct ida_qcb *qcb;
382 	bus_dmasync_op_t op;
383 	struct bio *bp;
384 
385 	bp = bioq_first(&ida->bio_queue);
386 	if (bp == NULL)
387 		return;				/* no more buffers */
388 
389 	qcb = ida_get_qcb(ida);
390 	if (qcb == NULL)
391 		return;				/* out of resources */
392 
393 	bioq_remove(&ida->bio_queue, bp);
394 	qcb->buf = bp;
395 	qcb->flags = 0;
396 
397 	hwqcb = qcb->hwqcb;
398 	bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
399 
400 	bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
401 	    (void *)bp->bio_data, bp->bio_bcount, ida_setup_dmamap, hwqcb, 0);
402 	op = qcb->flags & DMA_DATA_IN ?
403 	    BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
404 	bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
405 
406 	{
407 		struct idad_softc *drv = (struct idad_softc *)bp->bio_driver1;
408 		hwqcb->hdr.drive = drv->drive;
409 	}
410 
411 	hwqcb->req.blkno = bp->bio_pblkno;
412 	hwqcb->req.bcount = howmany(bp->bio_bcount, DEV_BSIZE);
413 	hwqcb->req.command = bp->bio_cmd == BIO_READ ? CMD_READ : CMD_WRITE;
414 
415 	STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
416 }
417 
418 /*
419  * This routine will be called from ida_intr in order to queue up more
420  * I/O, meaning that we may be in an interrupt context.  Hence, we should
421  * not muck around with spl() in this routine.
422  */
423 static void
424 ida_start(struct ida_softc *ida)
425 {
426 	struct ida_qcb *qcb;
427 
428 	while ((qcb = STAILQ_FIRST(&ida->qcb_queue)) != NULL) {
429 		if (ida->cmd.fifo_full(ida))
430 			break;
431 		STAILQ_REMOVE_HEAD(&ida->qcb_queue, link.stqe);
432 		/*
433 		 * XXX
434 		 * place the qcb on an active list and set a timeout?
435 		 */
436 		qcb->state = QCB_ACTIVE;
437 		ida->cmd.submit(ida, qcb);
438 	}
439 }
440 
441 static int
442 ida_wait(struct ida_softc *ida, struct ida_qcb *qcb)
443 {
444 	struct ida_qcb *qcb_done = NULL;
445 	bus_addr_t completed;
446 	int delay;
447 
448 	if (ida->flags & IDA_INTERRUPTS) {
449 		if (tsleep(qcb, PRIBIO, "idacmd", 5 * hz))
450 			return (ETIMEDOUT);
451 		return (0);
452 	}
453 
454 again:
455 	delay = 5 * 1000 * 100;			/* 5 sec delay */
456 	while ((completed = ida->cmd.done(ida)) == 0) {
457 		if (delay-- == 0)
458 			return (ETIMEDOUT);
459 		DELAY(10);
460 	}
461 
462 	qcb_done = idahwqcbptov(ida, completed & ~3);
463 	if (qcb_done != qcb)
464 		goto again;
465 	ida_done(ida, qcb);
466 	return (0);
467 }
468 
469 void
470 ida_intr(void *data)
471 {
472 	struct ida_softc *ida;
473 	struct ida_qcb *qcb;
474 	bus_addr_t completed;
475 
476 	ida = (struct ida_softc *)data;
477 
478 	if (ida->cmd.int_pending(ida) == 0)
479 		return;				/* not our interrupt */
480 
481 	while ((completed = ida->cmd.done(ida)) != 0) {
482 		qcb = idahwqcbptov(ida, completed & ~3);
483 
484 		if (qcb == NULL || qcb->state != QCB_ACTIVE) {
485 			device_printf(ida->dev,
486 			    "ignoring completion %jx\n", (intmax_t)completed);
487 			continue;
488 		}
489 		ida_done(ida, qcb);
490 	}
491 	ida_start(ida);
492 }
493 
494 /*
495  * should switch out command type; may be status, not just I/O.
496  */
497 static void
498 ida_done(struct ida_softc *ida, struct ida_qcb *qcb)
499 {
500 	int error = 0;
501 
502 	/*
503 	 * finish up command
504 	 */
505 	if (qcb->flags & DMA_DATA_TRANSFER) {
506 		bus_dmasync_op_t op;
507 
508 		op = qcb->flags & DMA_DATA_IN ?
509 		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE;
510 		bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
511 		bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap);
512 	}
513 
514 	if (qcb->hwqcb->req.error & SOFT_ERROR)
515 		device_printf(ida->dev, "soft error\n");
516 	if (qcb->hwqcb->req.error & HARD_ERROR) {
517 		error = 1;
518 		device_printf(ida->dev, "hard error\n");
519 	}
520 	if (qcb->hwqcb->req.error & CMD_REJECTED) {
521 		error = 1;
522 		device_printf(ida->dev, "invalid request\n");
523 	}
524 
525 	if (qcb->flags & IDA_COMMAND) {
526 		if (ida->flags & IDA_INTERRUPTS)
527 			wakeup(qcb);
528 	} else {
529 		if (error)
530 			qcb->buf->bio_flags |= BIO_ERROR;
531 		idad_intr(qcb->buf);
532 	}
533 
534 	qcb->state = QCB_FREE;
535 	SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
536 	ida_construct_qcb(ida);
537 }
538