Home | History | Annotate | Line # | Download | only in ic
cac.c revision 1.11
      1 /*	$NetBSD: cac.c,v 1.11 2000/09/01 14:17:15 ad Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Andrew Doran.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * Driver for Compaq array controllers.
     41  */
     42 
     43 #include <sys/param.h>
     44 #include <sys/systm.h>
     45 #include <sys/kernel.h>
     46 #include <sys/device.h>
     47 #include <sys/queue.h>
     48 #include <sys/proc.h>
     49 #include <sys/buf.h>
     50 #include <sys/endian.h>
     51 #include <sys/malloc.h>
     52 #include <sys/pool.h>
     53 
     54 #include <machine/bswap.h>
     55 #include <machine/bus.h>
     56 
     57 #include <dev/ic/cacreg.h>
     58 #include <dev/ic/cacvar.h>
     59 
     60 static struct	cac_ccb *cac_ccb_alloc(struct cac_softc *, int);
     61 static void	cac_ccb_done(struct cac_softc *, struct cac_ccb *);
     62 static void	cac_ccb_free(struct cac_softc *, struct cac_ccb *);
     63 static void	cac_ccb_poll(struct cac_softc *, struct cac_ccb *, int);
     64 static int	cac_ccb_start(struct cac_softc *, struct cac_ccb *);
     65 static int	cac_print(void *, const char *);
     66 static void	cac_shutdown(void *);
     67 static int	cac_submatch(struct device *, struct cfdata *, void *);
     68 
     69 static struct	cac_ccb *cac_l0_completed(struct cac_softc *);
     70 static int	cac_l0_fifo_full(struct cac_softc *);
     71 static void	cac_l0_intr_enable(struct cac_softc *, int);
     72 static int	cac_l0_intr_pending(struct cac_softc *);
     73 static void	cac_l0_submit(struct cac_softc *, struct cac_ccb *);
     74 
     75 static void	*cac_sdh;	/* shutdown hook */
     76 
     77 struct cac_linkage cac_l0 = {
     78 	cac_l0_completed,
     79 	cac_l0_fifo_full,
     80 	cac_l0_intr_enable,
     81 	cac_l0_intr_pending,
     82 	cac_l0_submit
     83 };
     84 
     85 /*
     86  * Initialise our interface to the controller.
     87  */
     88 int
     89 cac_init(struct cac_softc *sc, const char *intrstr, int startfw)
     90 {
     91 	struct cac_controller_info cinfo;
     92 	struct cac_attach_args caca;
     93 	int error, rseg, size, i;
     94 	bus_dma_segment_t seg;
     95 	struct cac_ccb *ccb;
     96 
     97 	if (intrstr != NULL)
     98 		printf("%s: interrupting at %s\n", sc->sc_dv.dv_xname,
     99 		    intrstr);
    100 
    101 	SIMPLEQ_INIT(&sc->sc_ccb_free);
    102 	SIMPLEQ_INIT(&sc->sc_ccb_queue);
    103 
    104         size = sizeof(struct cac_ccb) * CAC_MAX_CCBS;
    105 
    106 	if ((error = bus_dmamem_alloc(sc->sc_dmat, size, NBPG, 0, &seg, 1,
    107 	    &rseg, BUS_DMA_NOWAIT)) != 0) {
    108 		printf("%s: unable to allocate CCBs, error = %d\n",
    109 		    sc->sc_dv.dv_xname, error);
    110 		return (-1);
    111 	}
    112 
    113 	if ((error = bus_dmamem_map(sc->sc_dmat, &seg, rseg, size,
    114 	    (caddr_t *)&sc->sc_ccbs,
    115 	    BUS_DMA_NOWAIT | BUS_DMA_COHERENT)) != 0) {
    116 		printf("%s: unable to map CCBs, error = %d\n",
    117 		    sc->sc_dv.dv_xname, error);
    118 		return (-1);
    119 	}
    120 
    121 	if ((error = bus_dmamap_create(sc->sc_dmat, size, size, 1, 0,
    122 	    BUS_DMA_NOWAIT, &sc->sc_dmamap)) != 0) {
    123 		printf("%s: unable to create CCB DMA map, error = %d\n",
    124 		    sc->sc_dv.dv_xname, error);
    125 		return (-1);
    126 	}
    127 
    128 	if ((error = bus_dmamap_load(sc->sc_dmat, sc->sc_dmamap, sc->sc_ccbs,
    129 	    size, NULL, BUS_DMA_NOWAIT)) != 0) {
    130 		printf("%s: unable to load CCB DMA map, error = %d\n",
    131 		    sc->sc_dv.dv_xname, error);
    132 		return (-1);
    133 	}
    134 
    135 	sc->sc_ccbs_paddr = sc->sc_dmamap->dm_segs[0].ds_addr;
    136 	memset(sc->sc_ccbs, 0, size);
    137 	ccb = (struct cac_ccb *)sc->sc_ccbs;
    138 
    139 	for (i = 0; i < CAC_MAX_CCBS; i++, ccb++) {
    140 		/* Create the DMA map for this CCB's data */
    141 		error = bus_dmamap_create(sc->sc_dmat, CAC_MAX_XFER,
    142 		    CAC_SG_SIZE, CAC_MAX_XFER, 0,
    143 		    BUS_DMA_NOWAIT | BUS_DMA_ALLOCNOW, &ccb->ccb_dmamap_xfer);
    144 
    145 		if (error) {
    146 			printf("%s: can't create ccb dmamap (%d)\n",
    147 			    sc->sc_dv.dv_xname, error);
    148 			break;
    149 		}
    150 
    151 		ccb->ccb_flags = 0;
    152 		ccb->ccb_paddr = sc->sc_ccbs_paddr + i * sizeof(struct cac_ccb);
    153 		SIMPLEQ_INSERT_TAIL(&sc->sc_ccb_free, ccb, ccb_chain);
    154 	}
    155 
    156 	/* Start firmware background tasks, if needed. */
    157 	if (startfw) {
    158 		if (cac_cmd(sc, CAC_CMD_START_FIRMWARE, &cinfo, sizeof(cinfo),
    159 		    0, 0, CAC_CCB_DATA_IN, NULL)) {
    160 			printf("%s: CAC_CMD_START_FIRMWARE failed\n",
    161 			    sc->sc_dv.dv_xname);
    162 			return (-1);
    163 		}
    164 	}
    165 
    166 	if (cac_cmd(sc, CAC_CMD_GET_CTRL_INFO, &cinfo, sizeof(cinfo), 0, 0,
    167 	    CAC_CCB_DATA_IN, NULL)) {
    168 		printf("%s: CAC_CMD_GET_CTRL_INFO failed\n",
    169 		    sc->sc_dv.dv_xname);
    170 		return (-1);
    171 	}
    172 
    173 	for (i = 0; i < cinfo.num_drvs; i++) {
    174 		caca.caca_unit = i;
    175 		config_found_sm(&sc->sc_dv, &caca, cac_print, cac_submatch);
    176 	}
    177 
    178 	/* Set our `shutdownhook' before we start any device activity. */
    179 	if (cac_sdh == NULL)
    180 		cac_sdh = shutdownhook_establish(cac_shutdown, NULL);
    181 
    182 	(*sc->sc_cl->cl_intr_enable)(sc, CAC_INTR_ENABLE);
    183 	return (0);
    184 }
    185 
    186 /*
    187  * Shut down all `cac' controllers.
    188  */
    189 static void
    190 cac_shutdown(void *cookie)
    191 {
    192 	extern struct cfdriver cac_cd;
    193 	struct cac_softc *sc;
    194 	u_int8_t buf[512];
    195 	int i;
    196 
    197 	for (i = 0; i < cac_cd.cd_ndevs; i++) {
    198 		if ((sc = device_lookup(&cac_cd, i)) == NULL)
    199 			continue;
    200 		memset(buf, 0, sizeof(buf));
    201 		buf[0] = 1;
    202 		cac_cmd(sc, CAC_CMD_FLUSH_CACHE, buf, sizeof(buf), 0, 0,
    203 		    CAC_CCB_DATA_OUT, NULL);
    204 	}
    205 }
    206 
    207 /*
    208  * Print autoconfiguration message for a sub-device.
    209  */
    210 static int
    211 cac_print(void *aux, const char *pnp)
    212 {
    213 	struct cac_attach_args *caca;
    214 
    215 	caca = (struct cac_attach_args *)aux;
    216 
    217 	if (pnp != NULL)
    218 		printf("block device at %s", pnp);
    219 	printf(" unit %d", caca->caca_unit);
    220 	return (UNCONF);
    221 }
    222 
    223 /*
    224  * Match a sub-device.
    225  */
    226 static int
    227 cac_submatch(struct device *parent, struct cfdata *cf, void *aux)
    228 {
    229 	struct cac_attach_args *caca;
    230 
    231 	caca = (struct cac_attach_args *)aux;
    232 
    233 	if (cf->cacacf_unit != CACACF_UNIT_UNKNOWN &&
    234 	    cf->cacacf_unit != caca->caca_unit)
    235 		return (0);
    236 
    237 	return (cf->cf_attach->ca_match(parent, cf, aux));
    238 }
    239 
    240 /*
    241  * Handle an interrupt from the controller: process finished CCBs and
    242  * dequeue any waiting CCBs.
    243  */
    244 int
    245 cac_intr(void *cookie)
    246 {
    247 	struct cac_softc *sc;
    248 	struct cac_ccb *ccb;
    249 
    250 	sc = (struct cac_softc *)cookie;
    251 
    252 	if (!(*sc->sc_cl->cl_intr_pending)(sc)) {
    253 #ifdef DEBUG
    254 		printf("%s: spurious intr\n", sc->sc_dv.dv_xname);
    255 #endif
    256 		return (0);
    257 	}
    258 
    259 	while ((ccb = (*sc->sc_cl->cl_completed)(sc)) != NULL) {
    260 		cac_ccb_done(sc, ccb);
    261 		cac_ccb_start(sc, NULL);
    262 	}
    263 
    264 	return (1);
    265 }
    266 
    267 /*
    268  * Execute a [polled] command.
    269  */
    270 int
    271 cac_cmd(struct cac_softc *sc, int command, void *data, int datasize,
    272 	int drive, int blkno, int flags, struct cac_context *context)
    273 {
    274 	struct cac_ccb *ccb;
    275 	struct cac_sgb *sgb;
    276 	int s, i, rv, size, nsegs;
    277 
    278 	size = 0;
    279 
    280 	if ((ccb = cac_ccb_alloc(sc, 0)) == NULL) {
    281 		printf("%s: unable to alloc CCB", sc->sc_dv.dv_xname);
    282 		return (1);
    283 	}
    284 
    285 	if ((flags & (CAC_CCB_DATA_IN | CAC_CCB_DATA_OUT)) != 0) {
    286 		bus_dmamap_load(sc->sc_dmat, ccb->ccb_dmamap_xfer,
    287 		    (void *)data, datasize, NULL, BUS_DMA_NOWAIT);
    288 
    289 		bus_dmamap_sync(sc->sc_dmat, ccb->ccb_dmamap_xfer, 0, datasize,
    290 		    (flags & CAC_CCB_DATA_IN) != 0 ? BUS_DMASYNC_PREREAD :
    291 		    BUS_DMASYNC_PREWRITE);
    292 
    293 		sgb = ccb->ccb_seg;
    294 		nsegs = min(ccb->ccb_dmamap_xfer->dm_nsegs, CAC_SG_SIZE);
    295 
    296 		for (i = 0; i < nsegs; i++, sgb++) {
    297 			size += ccb->ccb_dmamap_xfer->dm_segs[i].ds_len;
    298 			sgb->length =
    299 			    htole32(ccb->ccb_dmamap_xfer->dm_segs[i].ds_len);
    300 			sgb->addr =
    301 			    htole32(ccb->ccb_dmamap_xfer->dm_segs[i].ds_addr);
    302 		}
    303 	} else {
    304 		size = datasize;
    305 		nsegs = 0;
    306 	}
    307 
    308 	ccb->ccb_hdr.drive = drive;
    309 	ccb->ccb_hdr.size = htole16((sizeof(struct cac_req) +
    310 	    sizeof(struct cac_sgb) * CAC_SG_SIZE) >> 2);
    311 
    312 	ccb->ccb_req.bcount = htole16(howmany(size, DEV_BSIZE));
    313 	ccb->ccb_req.command = command;
    314 	ccb->ccb_req.sgcount = nsegs;
    315 	ccb->ccb_req.blkno = htole32(blkno);
    316 
    317 	ccb->ccb_flags = flags;
    318 	ccb->ccb_datasize = size;
    319 
    320 	if (context == NULL) {
    321 		memset(&ccb->ccb_context, 0, sizeof(struct cac_context));
    322 		s = splbio();
    323 
    324 		/* Synchronous commands musn't wait. */
    325 		if ((*sc->sc_cl->cl_fifo_full)(sc)) {
    326 			cac_ccb_free(sc, ccb);
    327 			rv = -1;
    328 		} else {
    329 			(*sc->sc_cl->cl_submit)(sc, ccb);
    330 			cac_ccb_poll(sc, ccb, 2000);
    331 			cac_ccb_free(sc, ccb);
    332 			rv = 0;
    333 		}
    334 	} else {
    335 		memcpy(&ccb->ccb_context, context, sizeof(struct cac_context));
    336 		s = splbio();
    337 		rv = cac_ccb_start(sc, ccb);
    338 	}
    339 
    340 	splx(s);
    341 	return (rv);
    342 }
    343 
    344 /*
    345  * Wait for the specified CCB to complete.  Must be called at splbio.
    346  */
    347 static void
    348 cac_ccb_poll(struct cac_softc *sc, struct cac_ccb *wantccb, int timo)
    349 {
    350 	struct cac_ccb *ccb;
    351 
    352 	timo *= 10;
    353 
    354 	do {
    355 		for (; timo != 0; timo--) {
    356 			if ((ccb = (*sc->sc_cl->cl_completed)(sc)) != NULL)
    357 				break;
    358 			DELAY(100);
    359 		}
    360 
    361 		if (timo == 0)
    362 			panic("%s: cac_ccb_poll: timeout", sc->sc_dv.dv_xname);
    363 
    364 		cac_ccb_done(sc, ccb);
    365 	} while (ccb != wantccb);
    366 }
    367 
    368 /*
    369  * Enqueue the specifed command (if any) and attempt to start all enqueued
    370  * commands.  Must be called at splbio.
    371  */
    372 static int
    373 cac_ccb_start(struct cac_softc *sc, struct cac_ccb *ccb)
    374 {
    375 
    376 	if (ccb != NULL)
    377 		SIMPLEQ_INSERT_TAIL(&sc->sc_ccb_queue, ccb, ccb_chain);
    378 
    379 	while ((ccb = SIMPLEQ_FIRST(&sc->sc_ccb_queue)) != NULL) {
    380 		if ((*sc->sc_cl->cl_fifo_full)(sc))
    381 			return (-1);
    382 		SIMPLEQ_REMOVE_HEAD(&sc->sc_ccb_queue, ccb, ccb_chain);
    383 #ifdef DIAGNOSTIC
    384 		ccb->ccb_flags |= CAC_CCB_ACTIVE;
    385 #endif
    386 		(*sc->sc_cl->cl_submit)(sc, ccb);
    387 	}
    388 
    389 	return (0);
    390 }
    391 
    392 /*
    393  * Process a finished CCB.
    394  */
    395 static void
    396 cac_ccb_done(struct cac_softc *sc, struct cac_ccb *ccb)
    397 {
    398 	const char *errdvn;
    399 	int error;
    400 
    401 	error = 0;
    402 
    403 #ifdef DIAGNOSTIC
    404 	if ((ccb->ccb_flags & CAC_CCB_ACTIVE) == 0)
    405 		panic("cac_ccb_done: CCB not active");
    406 	ccb->ccb_flags &= ~CAC_CCB_ACTIVE;
    407 #endif
    408 
    409 	if ((ccb->ccb_flags & (CAC_CCB_DATA_IN | CAC_CCB_DATA_OUT)) != 0) {
    410 		bus_dmamap_sync(sc->sc_dmat, ccb->ccb_dmamap_xfer, 0,
    411 		    ccb->ccb_datasize, ccb->ccb_flags & CAC_CCB_DATA_IN ?
    412 		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
    413 		bus_dmamap_unload(sc->sc_dmat, ccb->ccb_dmamap_xfer);
    414 	}
    415 
    416 	if (ccb->ccb_context.cc_dv != NULL)
    417 		errdvn = ccb->ccb_context.cc_dv->dv_xname;
    418 	else
    419 		errdvn = sc->sc_dv.dv_xname;
    420 
    421 	if ((ccb->ccb_req.error & CAC_RET_SOFT_ERROR) != 0)
    422 		printf("%s: soft error; corrected\n", errdvn);
    423 	if ((ccb->ccb_req.error & CAC_RET_HARD_ERROR) != 0) {
    424 		error = 1;
    425 		printf("%s: hard error\n", errdvn);
    426 	}
    427 	if ((ccb->ccb_req.error & CAC_RET_CMD_REJECTED) != 0) {
    428 		error = 1;
    429 		printf("%s: invalid request\n", errdvn);
    430 	}
    431 
    432 	if (ccb->ccb_context.cc_handler != NULL) {
    433 		(*ccb->ccb_context.cc_handler)(ccb, error);
    434 		cac_ccb_free(sc, ccb);
    435 	}
    436 }
    437 
    438 /*
    439  * Allocate a CCB.
    440  */
    441 struct cac_ccb *
    442 cac_ccb_alloc(struct cac_softc *sc, int nosleep)
    443 {
    444 	struct cac_ccb *ccb;
    445 	int s;
    446 
    447 	s = splbio();
    448 
    449 	for (;;) {
    450 		if ((ccb = SIMPLEQ_FIRST(&sc->sc_ccb_free)) != NULL) {
    451 			SIMPLEQ_REMOVE_HEAD(&sc->sc_ccb_free, ccb, ccb_chain);
    452 			break;
    453 		}
    454 		if (nosleep) {
    455 			ccb = NULL;
    456 			break;
    457 		}
    458 		tsleep(&sc->sc_ccb_free, PRIBIO, "cacccb", 0);
    459 	}
    460 
    461 	splx(s);
    462 	return (ccb);
    463 }
    464 
    465 /*
    466  * Put a CCB onto the freelist.
    467  */
    468 void
    469 cac_ccb_free(struct cac_softc *sc, struct cac_ccb *ccb)
    470 {
    471 	int s;
    472 
    473 	s = splbio();
    474 	ccb->ccb_flags = 0;
    475 	SIMPLEQ_INSERT_HEAD(&sc->sc_ccb_free, ccb, ccb_chain);
    476 	if (SIMPLEQ_NEXT(ccb, ccb_chain) == NULL)
    477 		wakeup_one(&sc->sc_ccb_free);
    478 	splx(s);
    479 }
    480 
    481 /*
    482  * Adjust the size of a transfer.
    483  */
    484 void
    485 cac_minphys(struct buf *bp)
    486 {
    487 
    488 	if (bp->b_bcount > CAC_MAX_XFER)
    489 		bp->b_bcount = CAC_MAX_XFER;
    490 	minphys(bp);
    491 }
    492 
    493 /*
    494  * Board specific linkage shared between multiple bus types.
    495  */
    496 
    497 static int
    498 cac_l0_fifo_full(struct cac_softc *sc)
    499 {
    500 
    501 	return (cac_inl(sc, CAC_REG_CMD_FIFO) == 0);
    502 }
    503 
    504 static void
    505 cac_l0_submit(struct cac_softc *sc, struct cac_ccb *ccb)
    506 {
    507 
    508 	bus_dmamap_sync(sc->sc_dmat, sc->sc_dmamap, (caddr_t)ccb - sc->sc_ccbs,
    509 	    sizeof(struct cac_ccb), BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
    510 	cac_outl(sc, CAC_REG_CMD_FIFO, ccb->ccb_paddr);
    511 }
    512 
    513 static struct cac_ccb *
    514 cac_l0_completed(struct cac_softc *sc)
    515 {
    516 	struct cac_ccb *ccb;
    517 	paddr_t off;
    518 
    519 	off = (cac_inl(sc, CAC_REG_DONE_FIFO) & ~3) - sc->sc_ccbs_paddr;
    520 	ccb = (struct cac_ccb *)(sc->sc_ccbs + off);
    521 
    522 	bus_dmamap_sync(sc->sc_dmat, sc->sc_dmamap, off, sizeof(struct cac_ccb),
    523 	    BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
    524 
    525 	return (ccb);
    526 }
    527 
    528 static int
    529 cac_l0_intr_pending(struct cac_softc *sc)
    530 {
    531 
    532 	return (cac_inl(sc, CAC_REG_INTR_PENDING));
    533 }
    534 
    535 static void
    536 cac_l0_intr_enable(struct cac_softc *sc, int state)
    537 {
    538 
    539 	cac_outl(sc, CAC_REG_INTR_MASK,
    540 	    state ? CAC_INTR_ENABLE : CAC_INTR_DISABLE);
    541 }
    542