2 * Copyright (c) 1999,2000 Michael Smith
3 * Copyright (c) 2000 BSDi
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * Copyright (c) 2002 Eric Moore
29 * Copyright (c) 2002, 2004 LSI Logic Corporation
30 * All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. The party using or redistributing the source code and binary forms
41 * agrees to the disclaimer below and the terms and conditions set forth
44 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57 #include <sys/cdefs.h>
58 __FBSDID("$FreeBSD$");
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/kernel.h>
63 #include <sys/module.h>
64 #include <sys/sysctl.h>
70 #include <machine/bus.h>
71 #include <machine/resource.h>
74 #include <dev/pci/pcireg.h>
75 #include <dev/pci/pcivar.h>
77 #include <dev/amr/amrio.h>
78 #include <dev/amr/amrreg.h>
79 #include <dev/amr/amrvar.h>
81 static int amr_pci_probe(device_t dev);
82 static int amr_pci_attach(device_t dev);
83 static int amr_pci_detach(device_t dev);
84 static int amr_pci_shutdown(device_t dev);
85 static int amr_pci_suspend(device_t dev);
86 static int amr_pci_resume(device_t dev);
87 static void amr_pci_intr(void *arg);
88 static void amr_pci_free(struct amr_softc *sc);
89 static void amr_sglist_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
90 static int amr_sglist_map(struct amr_softc *sc);
91 static int amr_setup_mbox(struct amr_softc *sc);
92 static int amr_ccb_map(struct amr_softc *sc);
94 static u_int amr_force_sg32 = 0;
95 TUNABLE_INT("hw.amr.force_sg32", &amr_force_sg32);
97 SYSCTL_UINT(_hw_amr, OID_AUTO, force_sg32, CTLFLAG_RDTUN, &amr_force_sg32, 0,
98 "Force the AMR driver to use 32bit scatter gather");
100 static device_method_t amr_methods[] = {
101 /* Device interface */
102 DEVMETHOD(device_probe, amr_pci_probe),
103 DEVMETHOD(device_attach, amr_pci_attach),
104 DEVMETHOD(device_detach, amr_pci_detach),
105 DEVMETHOD(device_shutdown, amr_pci_shutdown),
106 DEVMETHOD(device_suspend, amr_pci_suspend),
107 DEVMETHOD(device_resume, amr_pci_resume),
112 static driver_t amr_pci_driver = {
115 sizeof(struct amr_softc)
118 static devclass_t amr_devclass;
119 DRIVER_MODULE(amr, pci, amr_pci_driver, amr_devclass, 0, 0);
120 MODULE_DEPEND(amr, pci, 1, 1, 1);
121 MODULE_DEPEND(amr, cam, 1, 1, 1);
123 static struct amr_ident
128 #define AMR_ID_PROBE_SIG (1<<0) /* generic i960RD, check signature */
129 #define AMR_ID_DO_SG64 (1<<1)
130 #define AMR_ID_QUARTZ (1<<2)
131 } amr_device_ids[] = {
134 {0x8086, 0x1960, AMR_ID_QUARTZ | AMR_ID_PROBE_SIG},
135 {0x101e, 0x1960, AMR_ID_QUARTZ},
136 {0x1000, 0x1960, AMR_ID_QUARTZ | AMR_ID_DO_SG64 | AMR_ID_PROBE_SIG},
137 {0x1000, 0x0407, AMR_ID_QUARTZ | AMR_ID_DO_SG64},
138 {0x1000, 0x0408, AMR_ID_QUARTZ | AMR_ID_DO_SG64},
139 {0x1000, 0x0409, AMR_ID_QUARTZ | AMR_ID_DO_SG64},
140 {0x1028, 0x000e, AMR_ID_QUARTZ | AMR_ID_DO_SG64 | AMR_ID_PROBE_SIG}, /* perc4/di i960 */
141 {0x1028, 0x000f, AMR_ID_QUARTZ | AMR_ID_DO_SG64}, /* perc4/di Verde*/
142 {0x1028, 0x0013, AMR_ID_QUARTZ | AMR_ID_DO_SG64}, /* perc4/di */
146 static struct amr_ident *
147 amr_find_ident(device_t dev)
149 struct amr_ident *id;
152 for (id = amr_device_ids; id->vendor != 0; id++) {
153 if ((pci_get_vendor(dev) == id->vendor) &&
154 (pci_get_device(dev) == id->device)) {
156 /* do we need to test for a signature? */
157 if (id->flags & AMR_ID_PROBE_SIG) {
158 sig = pci_read_config(dev, AMR_CFG_SIG, 2);
159 if ((sig != AMR_SIGNATURE_1) && (sig != AMR_SIGNATURE_2))
169 amr_pci_probe(device_t dev)
174 if (amr_find_ident(dev) != NULL) {
175 device_set_desc(dev, LSI_DESC_PCI);
176 return(BUS_PROBE_DEFAULT);
182 amr_pci_attach(device_t dev)
184 struct amr_softc *sc;
185 struct amr_ident *id;
186 int rid, rtype, error;
194 sc = device_get_softc(dev);
195 bzero(sc, sizeof(*sc));
198 /* assume failure is 'not configured' */
202 * Determine board type.
204 if ((id = amr_find_ident(dev)) == NULL)
207 command = pci_read_config(dev, PCIR_COMMAND, 1);
208 if (id->flags & AMR_ID_QUARTZ) {
210 * Make sure we are going to be able to talk to this board.
212 if ((command & PCIM_CMD_MEMEN) == 0) {
213 device_printf(dev, "memory window not available\n");
216 sc->amr_type |= AMR_TYPE_QUARTZ;
219 * Make sure we are going to be able to talk to this board.
221 if ((command & PCIM_CMD_PORTEN) == 0) {
222 device_printf(dev, "I/O window not available\n");
227 if ((amr_force_sg32 == 0) && (id->flags & AMR_ID_DO_SG64) &&
228 (sizeof(vm_paddr_t) > 4)) {
229 device_printf(dev, "Using 64-bit DMA\n");
230 sc->amr_type |= AMR_TYPE_SG64;
233 /* force the busmaster enable bit on */
234 if (!(command & PCIM_CMD_BUSMASTEREN)) {
235 device_printf(dev, "busmaster bit not set, enabling\n");
236 command |= PCIM_CMD_BUSMASTEREN;
237 pci_write_config(dev, PCIR_COMMAND, command, 2);
241 * Allocate the PCI register window.
244 rtype = AMR_IS_QUARTZ(sc) ? SYS_RES_MEMORY : SYS_RES_IOPORT;
245 sc->amr_reg = bus_alloc_resource_any(dev, rtype, &rid, RF_ACTIVE);
246 if (sc->amr_reg == NULL) {
247 device_printf(sc->amr_dev, "can't allocate register window\n");
250 sc->amr_btag = rman_get_bustag(sc->amr_reg);
251 sc->amr_bhandle = rman_get_bushandle(sc->amr_reg);
254 * Allocate and connect our interrupt.
257 sc->amr_irq = bus_alloc_resource_any(sc->amr_dev, SYS_RES_IRQ, &rid,
258 RF_SHAREABLE | RF_ACTIVE);
259 if (sc->amr_irq == NULL) {
260 device_printf(sc->amr_dev, "can't allocate interrupt\n");
263 if (bus_setup_intr(sc->amr_dev, sc->amr_irq,
264 INTR_TYPE_BIO | INTR_ENTROPY | INTR_MPSAFE, NULL, amr_pci_intr,
265 sc, &sc->amr_intr)) {
266 device_printf(sc->amr_dev, "can't set up interrupt\n");
270 debug(2, "interrupt attached");
272 /* assume failure is 'out of memory' */
276 * Allocate the parent bus DMA tag appropriate for PCI.
278 if (bus_dma_tag_create(bus_get_dma_tag(dev), /* PCI parent */
279 1, 0, /* alignment,boundary */
282 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
283 BUS_SPACE_MAXADDR, /* highaddr */
284 NULL, NULL, /* filter, filterarg */
285 MAXBSIZE, AMR_NSEG, /* maxsize, nsegments */
286 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
288 NULL, NULL, /* lockfunc, lockarg */
289 &sc->amr_parent_dmat)) {
290 device_printf(dev, "can't allocate parent DMA tag\n");
295 * Create DMA tag for mapping buffers into controller-addressable space.
297 if (bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
298 1, 0, /* alignment,boundary */
299 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
300 BUS_SPACE_MAXADDR, /* highaddr */
301 NULL, NULL, /* filter, filterarg */
302 MAXBSIZE, AMR_NSEG, /* maxsize, nsegments */
303 MAXBSIZE, /* maxsegsize */
305 busdma_lock_mutex, /* lockfunc */
306 &sc->amr_list_lock, /* lockarg */
307 &sc->amr_buffer_dmat)) {
308 device_printf(sc->amr_dev, "can't allocate buffer DMA tag\n");
312 if (bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
313 1, 0, /* alignment,boundary */
314 BUS_SPACE_MAXADDR, /* lowaddr */
315 BUS_SPACE_MAXADDR, /* highaddr */
316 NULL, NULL, /* filter, filterarg */
317 MAXBSIZE, AMR_NSEG, /* maxsize, nsegments */
318 MAXBSIZE, /* maxsegsize */
320 busdma_lock_mutex, /* lockfunc */
321 &sc->amr_list_lock, /* lockarg */
322 &sc->amr_buffer64_dmat)) {
323 device_printf(sc->amr_dev, "can't allocate buffer DMA tag\n");
327 debug(2, "dma tag done");
330 * Allocate and set up mailbox in a bus-visible fashion.
332 mtx_init(&sc->amr_list_lock, "AMR List Lock", NULL, MTX_DEF);
333 mtx_init(&sc->amr_hw_lock, "AMR HW Lock", NULL, MTX_DEF);
334 if ((error = amr_setup_mbox(sc)) != 0)
337 debug(2, "mailbox setup");
340 * Build the scatter/gather buffers.
342 if (amr_sglist_map(sc))
344 debug(2, "s/g list mapped");
348 debug(2, "ccb mapped");
352 * Do bus-independant initialisation, bring controller online.
354 error = amr_attach(sc);
362 /********************************************************************************
363 * Disconnect from the controller completely, in preparation for unload.
366 amr_pci_detach(device_t dev)
368 struct amr_softc *sc = device_get_softc(dev);
373 if (sc->amr_state & AMR_STATE_OPEN)
376 if ((error = amr_pci_shutdown(dev)))
384 /********************************************************************************
385 * Bring the controller down to a dormant state and detach all child devices.
387 * This function is called before detach, system shutdown, or before performing
388 * an operation which may add or delete system disks. (Call amr_startup to
389 * resume normal operation.)
391 * Note that we can assume that the bioq on the controller is empty, as we won't
392 * allow shutdown if any device is open.
395 amr_pci_shutdown(device_t dev)
397 struct amr_softc *sc = device_get_softc(dev);
402 /* mark ourselves as in-shutdown */
403 sc->amr_state |= AMR_STATE_SHUTDOWN;
406 /* flush controller */
407 device_printf(sc->amr_dev, "flushing cache...");
408 printf("%s\n", amr_flush(sc) ? "failed" : "done");
412 /* delete all our child devices */
413 for(i = 0 ; i < AMR_MAXLD; i++) {
414 if( sc->amr_drive[i].al_disk != 0) {
415 if((error = device_delete_child(sc->amr_dev,sc->amr_drive[i].al_disk)) != 0)
417 sc->amr_drive[i].al_disk = 0;
421 /* XXX disable interrupts? */
427 /********************************************************************************
428 * Bring the controller to a quiescent state, ready for system suspend.
431 amr_pci_suspend(device_t dev)
433 struct amr_softc *sc = device_get_softc(dev);
437 sc->amr_state |= AMR_STATE_SUSPEND;
439 /* flush controller */
440 device_printf(sc->amr_dev, "flushing cache...");
441 printf("%s\n", amr_flush(sc) ? "failed" : "done");
443 /* XXX disable interrupts? */
448 /********************************************************************************
449 * Bring the controller back to a state ready for operation.
452 amr_pci_resume(device_t dev)
454 struct amr_softc *sc = device_get_softc(dev);
458 sc->amr_state &= ~AMR_STATE_SUSPEND;
460 /* XXX enable interrupts? */
465 /*******************************************************************************
466 * Take an interrupt, or be poked by other code to look for interrupt-worthy
470 amr_pci_intr(void *arg)
472 struct amr_softc *sc = (struct amr_softc *)arg;
476 /* collect finished commands, queue anything waiting */
480 /********************************************************************************
481 * Free all of the resources associated with (sc)
483 * Should not be called if the controller is active.
486 amr_pci_free(struct amr_softc *sc)
494 /* destroy data-transfer DMA tag */
495 if (sc->amr_buffer_dmat)
496 bus_dma_tag_destroy(sc->amr_buffer_dmat);
497 if (sc->amr_buffer64_dmat)
498 bus_dma_tag_destroy(sc->amr_buffer64_dmat);
500 /* free and destroy DMA memory and tag for passthrough pool */
502 bus_dmamem_free(sc->amr_ccb_dmat, sc->amr_ccb, sc->amr_ccb_dmamap);
503 if (sc->amr_ccb_dmat)
504 bus_dma_tag_destroy(sc->amr_ccb_dmat);
506 /* free and destroy DMA memory and tag for s/g lists */
508 bus_dmamem_free(sc->amr_sg_dmat, sc->amr_sgtable, sc->amr_sg_dmamap);
510 bus_dma_tag_destroy(sc->amr_sg_dmat);
512 /* free and destroy DMA memory and tag for mailbox */
513 p = (void *)(uintptr_t)(volatile void *)sc->amr_mailbox64;
514 if (sc->amr_mailbox) {
515 bus_dmamem_free(sc->amr_mailbox_dmat, p, sc->amr_mailbox_dmamap);
517 if (sc->amr_mailbox_dmat)
518 bus_dma_tag_destroy(sc->amr_mailbox_dmat);
520 /* disconnect the interrupt handler */
522 bus_teardown_intr(sc->amr_dev, sc->amr_irq, sc->amr_intr);
523 if (sc->amr_irq != NULL)
524 bus_release_resource(sc->amr_dev, SYS_RES_IRQ, 0, sc->amr_irq);
526 /* destroy the parent DMA tag */
527 if (sc->amr_parent_dmat)
528 bus_dma_tag_destroy(sc->amr_parent_dmat);
530 /* release the register window mapping */
531 if (sc->amr_reg != NULL)
532 bus_release_resource(sc->amr_dev,
533 AMR_IS_QUARTZ(sc) ? SYS_RES_MEMORY : SYS_RES_IOPORT,
534 PCIR_BAR(0), sc->amr_reg);
537 /********************************************************************************
538 * Allocate and map the scatter/gather table in bus space.
541 amr_sglist_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
548 *addr = segs[0].ds_addr;
552 amr_sglist_map(struct amr_softc *sc)
561 * Create a single tag describing a region large enough to hold all of
562 * the s/g lists we will need.
564 * Note that we could probably use AMR_LIMITCMD here, but that may become
568 segsize = sizeof(struct amr_sg64entry) * AMR_NSEG * AMR_MAXCMD;
570 segsize = sizeof(struct amr_sgentry) * AMR_NSEG * AMR_MAXCMD;
572 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
573 512, 0, /* alignment,boundary */
574 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
575 BUS_SPACE_MAXADDR, /* highaddr */
576 NULL, NULL, /* filter, filterarg */
577 segsize, 1, /* maxsize, nsegments */
578 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
580 NULL, NULL, /* lockfunc, lockarg */
583 device_printf(sc->amr_dev, "can't allocate scatter/gather DMA tag\n");
588 * Allocate enough s/g maps for all commands and permanently map them into
589 * controller-visible space.
591 * XXX this assumes we can get enough space for all the s/g maps in one
592 * contiguous slab. We may need to switch to a more complex arrangement
593 * where we allocate in smaller chunks and keep a lookup table from slot
596 * XXX HACK ALERT: at least some controllers don't like the s/g memory
597 * being allocated below 0x2000. We leak some memory if
598 * we get some below this mark and allocate again. We
599 * should be able to avoid this with the tag setup, but
600 * that does't seem to work.
603 error = bus_dmamem_alloc(sc->amr_sg_dmat, (void **)&p, BUS_DMA_NOWAIT, &sc->amr_sg_dmamap);
605 device_printf(sc->amr_dev, "can't allocate s/g table\n");
608 bus_dmamap_load(sc->amr_sg_dmat, sc->amr_sg_dmamap, p, segsize, amr_sglist_helper, &sc->amr_sgbusaddr, 0);
609 if (sc->amr_sgbusaddr < 0x2000) {
610 debug(1, "s/g table too low (0x%x), reallocating\n", sc->amr_sgbusaddr);
615 sc->amr_sg64table = (struct amr_sg64entry *)p;
616 sc->amr_sgtable = (struct amr_sgentry *)p;
621 /********************************************************************************
622 * Allocate and set up mailbox areas for the controller (sc)
624 * The basic mailbox structure should be 16-byte aligned.
627 amr_setup_mbox(struct amr_softc *sc)
636 * Create a single tag describing a region large enough to hold the entire
639 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
640 16, 0, /* alignment,boundary */
641 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
642 BUS_SPACE_MAXADDR, /* highaddr */
643 NULL, NULL, /* filter, filterarg */
644 sizeof(struct amr_mailbox64), /* maxsize */
646 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
648 NULL, NULL, /* lockfunc, lockarg */
649 &sc->amr_mailbox_dmat);
651 device_printf(sc->amr_dev, "can't allocate mailbox tag\n");
656 * Allocate the mailbox structure and permanently map it into
657 * controller-visible space.
659 error = bus_dmamem_alloc(sc->amr_mailbox_dmat, (void **)&p, BUS_DMA_NOWAIT,
660 &sc->amr_mailbox_dmamap);
662 device_printf(sc->amr_dev, "can't allocate mailbox memory\n");
665 bus_dmamap_load(sc->amr_mailbox_dmat, sc->amr_mailbox_dmamap, p,
666 sizeof(struct amr_mailbox64), amr_sglist_helper, &baddr, 0);
668 * Conventional mailbox is inside the mailbox64 region.
670 /* save physical base of the basic mailbox structure */
671 sc->amr_mailboxphys = baddr + offsetof(struct amr_mailbox64, mb);
672 bzero(p, sizeof(struct amr_mailbox64));
673 sc->amr_mailbox64 = (struct amr_mailbox64 *)p;
674 sc->amr_mailbox = &sc->amr_mailbox64->mb;
680 amr_ccb_map(struct amr_softc *sc)
685 * Passthrough and Extended passthrough structures will share the same
688 ccbsize = sizeof(union amr_ccb) * AMR_MAXCMD;
689 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
690 128, 0, /* alignment,boundary */
691 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
692 BUS_SPACE_MAXADDR, /* highaddr */
693 NULL, NULL, /* filter, filterarg */
694 ccbsize, /* maxsize */
696 ccbsize, /* maxsegsize */
698 NULL, NULL, /* lockfunc, lockarg */
701 device_printf(sc->amr_dev, "can't allocate ccb tag\n");
705 error = bus_dmamem_alloc(sc->amr_ccb_dmat, (void **)&sc->amr_ccb,
706 BUS_DMA_NOWAIT, &sc->amr_ccb_dmamap);
708 device_printf(sc->amr_dev, "can't allocate ccb memory\n");
711 bus_dmamap_load(sc->amr_ccb_dmat, sc->amr_ccb_dmamap, sc->amr_ccb,
712 ccbsize, amr_sglist_helper, &sc->amr_ccb_busaddr, 0);
713 bzero(sc->amr_ccb, ccbsize);