ida.c revision 115343 
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: head/sys/dev/ida/ida.c 115343 2003-05-27 04:59:59Z scottl $
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 */
61static void ida_alloc_qcb(struct ida_softc *ida);
62static void ida_construct_qcb(struct ida_softc *ida);
63static void ida_start(struct ida_softc *ida);
64static void ida_done(struct ida_softc *ida, struct ida_qcb *qcb);
65static int ida_wait(struct ida_softc *ida, struct ida_qcb *qcb);
66
67void
68ida_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 */
109static void
110ida_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
118static __inline struct ida_qcb *
119ida_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
133static __inline bus_addr_t
134idahwqcbvtop(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
140static __inline struct ida_qcb *
141idahwqcbptov(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 */
155static void
156ida_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
178int
179ida_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, &ida->hwqcb_dmat);
209	if (error)
210                return (ENOMEM);
211
212	/* DMA tag for mapping buffers into device space */
213	error = bus_dma_tag_create(ida->parent_dmat,
214	    /*alignment*/1, /*boundary*/0,
215	    /*lowaddr*/BUS_SPACE_MAXADDR, /*highaddr*/BUS_SPACE_MAXADDR,
216	    /*filter*/NULL, /*filterarg*/NULL,
217	    /*maxsize*/MAXBSIZE, /*nsegments*/IDA_NSEG,
218	    /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT, /*flags*/0, &ida->buffer_dmat);
219	if (error)
220                return (ENOMEM);
221
222        /* Allocation of hardware QCBs */
223	/* XXX allocation is rounded to hardware page size */
224	error = bus_dmamem_alloc(ida->hwqcb_dmat,
225	    (void **)&ida->hwqcbs, BUS_DMA_NOWAIT, &ida->hwqcb_dmamap);
226	if (error)
227                return (ENOMEM);
228
229        /* And permanently map them in */
230        bus_dmamap_load(ida->hwqcb_dmat, ida->hwqcb_dmamap,
231	    ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb),
232	    ida_dma_map_cb, &ida->hwqcb_busaddr, /*flags*/0);
233
234	bzero(ida->hwqcbs, IDA_QCB_MAX * sizeof(struct ida_hardware_qcb));
235
236	ida_alloc_qcb(ida);		/* allocate an initial qcb */
237
238	return (0);
239}
240
241void
242ida_attach(struct ida_softc *ida)
243{
244	struct ida_controller_info cinfo;
245	int error, i;
246
247	ida->cmd.int_enable(ida, 0);
248
249	error = ida_command(ida, CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo),
250	    IDA_CONTROLLER, 0, DMA_DATA_IN);
251	if (error) {
252		device_printf(ida->dev, "CMD_GET_CTRL_INFO failed.\n");
253		return;
254	}
255
256	device_printf(ida->dev, "drives=%d firm_rev=%c%c%c%c\n",
257	    cinfo.num_drvs, cinfo.firm_rev[0], cinfo.firm_rev[1],
258	    cinfo.firm_rev[2], cinfo.firm_rev[3]);
259
260	if (ida->flags & IDA_FIRMWARE) {
261		int data;
262
263		error = ida_command(ida, CMD_START_FIRMWARE,
264		    &data, sizeof(data), IDA_CONTROLLER, 0, DMA_DATA_IN);
265		if (error) {
266			device_printf(ida->dev, "CMD_START_FIRMWARE failed.\n");
267			return;
268		}
269	}
270
271	ida->num_drives = 0;
272	for (i = 0; i < cinfo.num_drvs; i++)
273		device_add_child(ida->dev, /*"idad"*/NULL, -1);
274
275	bus_generic_attach(ida->dev);
276
277	ida->cmd.int_enable(ida, 1);
278}
279
280int
281ida_detach(device_t dev)
282{
283	struct ida_softc *ida;
284	int error = 0;
285
286        ida = (struct ida_softc *)device_get_softc(dev);
287
288	/*
289	 * XXX
290	 * before detaching, we must make sure that the system is
291	 * quiescent; nothing mounted, no pending activity.
292	 */
293
294	/*
295	 * XXX
296	 * now, how are we supposed to maintain a list of our drives?
297	 * iterate over our "child devices"?
298	 */
299
300
301	ida_free(ida);
302	return (error);
303}
304
305static void
306ida_setup_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
307{
308	struct ida_hardware_qcb *hwqcb = (struct ida_hardware_qcb *)arg;
309	int i;
310
311	hwqcb->hdr.size = (sizeof(struct ida_req) +
312	    sizeof(struct ida_sgb) * IDA_NSEG) >> 2;
313
314	for (i = 0; i < nsegments; i++) {
315		hwqcb->seg[i].addr = segs[i].ds_addr;
316		hwqcb->seg[i].length = segs[i].ds_len;
317	}
318	hwqcb->req.sgcount = nsegments;
319}
320
321int
322ida_command(struct ida_softc *ida, int command, void *data, int datasize,
323	int drive, u_int32_t pblkno, int flags)
324{
325	struct ida_hardware_qcb *hwqcb;
326	struct ida_qcb *qcb;
327	bus_dmasync_op_t op;
328	int s, error;
329
330	s = splbio();
331	qcb = ida_get_qcb(ida);
332	splx(s);
333
334	if (qcb == NULL) {
335		printf("ida_command: out of QCBs");
336		return (EAGAIN);
337	}
338
339	hwqcb = qcb->hwqcb;
340	bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
341
342	bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
343	    (void *)data, datasize, ida_setup_dmamap, hwqcb, 0);
344	op = qcb->flags & DMA_DATA_IN ?
345	    BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
346	bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
347
348	hwqcb->hdr.drive = drive;
349	hwqcb->req.blkno = pblkno;
350	hwqcb->req.bcount = howmany(datasize, DEV_BSIZE);
351	hwqcb->req.command = command;
352
353	qcb->flags = flags | IDA_COMMAND;
354
355	s = splbio();
356	STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
357	ida_start(ida);
358	error = ida_wait(ida, qcb);
359	splx(s);
360
361	/* XXX should have status returned here? */
362	/* XXX have "status pointer" area in QCB? */
363
364	return (error);
365}
366
367void
368ida_submit_buf(struct ida_softc *ida, struct bio *bp)
369{
370        bioq_insert_tail(&ida->bio_queue, bp);
371        ida_construct_qcb(ida);
372	ida_start(ida);
373}
374
375static void
376ida_construct_qcb(struct ida_softc *ida)
377{
378	struct ida_hardware_qcb *hwqcb;
379	struct ida_qcb *qcb;
380	bus_dmasync_op_t op;
381	struct bio *bp;
382
383	bp = bioq_first(&ida->bio_queue);
384	if (bp == NULL)
385		return;				/* no more buffers */
386
387	qcb = ida_get_qcb(ida);
388	if (qcb == NULL)
389		return;				/* out of resources */
390
391	bioq_remove(&ida->bio_queue, bp);
392	qcb->buf = bp;
393	qcb->flags = 0;
394
395	hwqcb = qcb->hwqcb;
396	bzero(hwqcb, sizeof(struct ida_hdr) + sizeof(struct ida_req));
397
398	bus_dmamap_load(ida->buffer_dmat, qcb->dmamap,
399	    (void *)bp->bio_data, bp->bio_bcount, ida_setup_dmamap, hwqcb, 0);
400	op = qcb->flags & DMA_DATA_IN ?
401	    BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE;
402	bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
403
404	{
405		struct idad_softc *drv = (struct idad_softc *)bp->bio_driver1;
406		hwqcb->hdr.drive = drv->drive;
407	}
408
409	hwqcb->req.blkno = bp->bio_pblkno;
410	hwqcb->req.bcount = howmany(bp->bio_bcount, DEV_BSIZE);
411	hwqcb->req.command = bp->bio_cmd == BIO_READ ? CMD_READ : CMD_WRITE;
412
413	STAILQ_INSERT_TAIL(&ida->qcb_queue, qcb, link.stqe);
414}
415
416/*
417 * This routine will be called from ida_intr in order to queue up more
418 * I/O, meaning that we may be in an interrupt context.  Hence, we should
419 * not muck around with spl() in this routine.
420 */
421static void
422ida_start(struct ida_softc *ida)
423{
424	struct ida_qcb *qcb;
425
426	while ((qcb = STAILQ_FIRST(&ida->qcb_queue)) != NULL) {
427		if (ida->cmd.fifo_full(ida))
428			break;
429		STAILQ_REMOVE_HEAD(&ida->qcb_queue, link.stqe);
430		/*
431		 * XXX
432		 * place the qcb on an active list and set a timeout?
433		 */
434		qcb->state = QCB_ACTIVE;
435		ida->cmd.submit(ida, qcb);
436	}
437}
438
439static int
440ida_wait(struct ida_softc *ida, struct ida_qcb *qcb)
441{
442	struct ida_qcb *qcb_done = NULL;
443	bus_addr_t completed;
444	int delay;
445
446	if (ida->flags & IDA_INTERRUPTS) {
447		if (tsleep(qcb, PRIBIO, "idacmd", 5 * hz))
448			return (ETIMEDOUT);
449		return (0);
450	}
451
452again:
453	delay = 5 * 1000 * 100;			/* 5 sec delay */
454	while ((completed = ida->cmd.done(ida)) == 0) {
455		if (delay-- == 0)
456			return (ETIMEDOUT);
457		DELAY(10);
458	}
459
460	qcb_done = idahwqcbptov(ida, completed & ~3);
461	if (qcb_done != qcb)
462		goto again;
463	ida_done(ida, qcb);
464	return (0);
465}
466
467void
468ida_intr(void *data)
469{
470	struct ida_softc *ida;
471	struct ida_qcb *qcb;
472	bus_addr_t completed;
473
474	ida = (struct ida_softc *)data;
475
476	if (ida->cmd.int_pending(ida) == 0)
477		return;				/* not our interrupt */
478
479	while ((completed = ida->cmd.done(ida)) != 0) {
480		qcb = idahwqcbptov(ida, completed & ~3);
481
482		if (qcb == NULL || qcb->state != QCB_ACTIVE) {
483			device_printf(ida->dev,
484			    "ignoring completion %jx\n", (intmax_t)completed);
485			continue;
486		}
487		ida_done(ida, qcb);
488	}
489	ida_start(ida);
490}
491
492/*
493 * should switch out command type; may be status, not just I/O.
494 */
495static void
496ida_done(struct ida_softc *ida, struct ida_qcb *qcb)
497{
498	int error = 0;
499
500	/*
501	 * finish up command
502	 */
503	if (qcb->flags & DMA_DATA_TRANSFER) {
504		bus_dmasync_op_t op;
505
506		op = qcb->flags & DMA_DATA_IN ?
507		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE;
508		bus_dmamap_sync(ida->buffer_dmat, qcb->dmamap, op);
509		bus_dmamap_unload(ida->buffer_dmat, qcb->dmamap);
510	}
511
512	if (qcb->hwqcb->req.error & SOFT_ERROR)
513		device_printf(ida->dev, "soft error\n");
514	if (qcb->hwqcb->req.error & HARD_ERROR) {
515		error = 1;
516		device_printf(ida->dev, "hard error\n");
517	}
518	if (qcb->hwqcb->req.error & CMD_REJECTED) {
519		error = 1;
520		device_printf(ida->dev, "invalid request\n");
521	}
522
523	if (qcb->flags & IDA_COMMAND) {
524		if (ida->flags & IDA_INTERRUPTS)
525			wakeup(qcb);
526	} else {
527		if (error)
528			qcb->buf->bio_flags |= BIO_ERROR;
529		idad_intr(qcb->buf);
530	}
531
532	qcb->state = QCB_FREE;
533	SLIST_INSERT_HEAD(&ida->free_qcbs, qcb, link.sle);
534	ida_construct_qcb(ida);
535}
536