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
56 * $FreeBSD: src/sys/dev/amr/amr_pci.c,v 1.40 2007/12/12 05:55:03 scottl Exp $
59 #include <sys/param.h>
60 #include <sys/systm.h>
61 #include <sys/kernel.h>
62 #include <sys/module.h>
63 #include <sys/sysctl.h>
71 #include <bus/pci/pcireg.h>
72 #include <bus/pci/pcivar.h>
74 #include <dev/raid/amr/amrio.h>
75 #include <dev/raid/amr/amrreg.h>
76 #include <dev/raid/amr/amrvar.h>
78 static int amr_pci_probe(device_t dev);
79 static int amr_pci_attach(device_t dev);
80 static int amr_pci_detach(device_t dev);
81 static int amr_pci_shutdown(device_t dev);
82 static int amr_pci_suspend(device_t dev);
83 static int amr_pci_resume(device_t dev);
84 static void amr_pci_intr(void *arg);
85 static void amr_pci_free(struct amr_softc *sc);
86 static void amr_sglist_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
87 static int amr_sglist_map(struct amr_softc *sc);
88 static int amr_setup_mbox(struct amr_softc *sc);
89 static int amr_ccb_map(struct amr_softc *sc);
91 static u_int amr_force_sg32 = 0;
92 TUNABLE_INT("hw.amr.force_sg32", &amr_force_sg32);
94 SYSCTL_UINT(_hw_amr, OID_AUTO, force_sg32, CTLFLAG_RD, &amr_force_sg32, 0,
95 "Force the AMR driver to use 32bit scatter gather");
97 static device_method_t amr_methods[] = {
98 /* Device interface */
99 DEVMETHOD(device_probe, amr_pci_probe),
100 DEVMETHOD(device_attach, amr_pci_attach),
101 DEVMETHOD(device_detach, amr_pci_detach),
102 DEVMETHOD(device_shutdown, amr_pci_shutdown),
103 DEVMETHOD(device_suspend, amr_pci_suspend),
104 DEVMETHOD(device_resume, amr_pci_resume),
106 DEVMETHOD(bus_print_child, bus_generic_print_child),
107 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
111 static driver_t amr_pci_driver = {
114 sizeof(struct amr_softc)
117 static devclass_t amr_devclass;
118 DRIVER_MODULE(amr, pci, amr_pci_driver, amr_devclass, NULL, NULL);
119 MODULE_VERSION(amr, 1);
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_MPSAFE, amr_pci_intr,
265 sc, &sc->amr_intr, NULL)) {
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(NULL, /* 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 &sc->amr_parent_dmat)) {
289 device_printf(dev, "can't allocate parent DMA tag\n");
294 * Create DMA tag for mapping buffers into controller-addressable space.
296 if (bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
297 1, 0, /* alignment,boundary */
298 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
299 BUS_SPACE_MAXADDR, /* highaddr */
300 NULL, NULL, /* filter, filterarg */
301 MAXBSIZE, AMR_NSEG, /* maxsize, nsegments */
302 MAXBSIZE, /* maxsegsize */
304 &sc->amr_buffer_dmat)) {
305 device_printf(sc->amr_dev, "can't allocate buffer DMA tag\n");
309 if (bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
310 1, 0, /* alignment,boundary */
311 BUS_SPACE_MAXADDR, /* lowaddr */
312 BUS_SPACE_MAXADDR, /* highaddr */
313 NULL, NULL, /* filter, filterarg */
314 MAXBSIZE, AMR_NSEG, /* maxsize, nsegments */
315 MAXBSIZE, /* maxsegsize */
317 &sc->amr_buffer64_dmat)) {
318 device_printf(sc->amr_dev, "can't allocate buffer DMA tag\n");
322 debug(2, "dma tag done");
325 * Allocate and set up mailbox in a bus-visible fashion.
327 lockinit(&sc->amr_list_lock, "AMR List Lock", 0, LK_CANRECURSE);
328 lockinit(&sc->amr_hw_lock, "AMR HW Lock", 0, LK_CANRECURSE);
329 if ((error = amr_setup_mbox(sc)) != 0)
332 debug(2, "mailbox setup");
335 * Build the scatter/gather buffers.
337 if ((error = amr_sglist_map(sc)) != 0)
339 debug(2, "s/g list mapped");
341 if ((error = amr_ccb_map(sc)) != 0)
343 debug(2, "ccb mapped");
347 * Do bus-independant initialisation, bring controller online.
349 error = amr_attach(sc);
357 /********************************************************************************
358 * Disconnect from the controller completely, in preparation for unload.
361 amr_pci_detach(device_t dev)
363 struct amr_softc *sc = device_get_softc(dev);
368 if (sc->amr_state & AMR_STATE_OPEN)
371 if ((error = amr_pci_shutdown(dev)))
379 /********************************************************************************
380 * Bring the controller down to a dormant state and detach all child devices.
382 * This function is called before detach, system shutdown, or before performing
383 * an operation which may add or delete system disks. (Call amr_startup to
384 * resume normal operation.)
386 * Note that we can assume that the bioq on the controller is empty, as we won't
387 * allow shutdown if any device is open.
390 amr_pci_shutdown(device_t dev)
392 struct amr_softc *sc = device_get_softc(dev);
397 /* mark ourselves as in-shutdown */
398 sc->amr_state |= AMR_STATE_SHUTDOWN;
401 /* flush controller */
402 device_printf(sc->amr_dev, "flushing cache...");
403 kprintf("%s\n", amr_flush(sc) ? "failed" : "done");
407 /* delete all our child devices */
408 for(i = 0 ; i < AMR_MAXLD; i++) {
409 if( sc->amr_drive[i].al_disk != NULL) {
410 if((error = device_delete_child(sc->amr_dev,sc->amr_drive[i].al_disk)) != 0)
412 sc->amr_drive[i].al_disk = NULL;
416 /* XXX disable interrupts? */
422 /********************************************************************************
423 * Bring the controller to a quiescent state, ready for system suspend.
426 amr_pci_suspend(device_t dev)
428 struct amr_softc *sc = device_get_softc(dev);
432 sc->amr_state |= AMR_STATE_SUSPEND;
434 /* flush controller */
435 device_printf(sc->amr_dev, "flushing cache...");
436 kprintf("%s\n", amr_flush(sc) ? "failed" : "done");
438 /* XXX disable interrupts? */
443 /********************************************************************************
444 * Bring the controller back to a state ready for operation.
447 amr_pci_resume(device_t dev)
449 struct amr_softc *sc = device_get_softc(dev);
453 sc->amr_state &= ~AMR_STATE_SUSPEND;
455 /* XXX enable interrupts? */
460 /*******************************************************************************
461 * Take an interrupt, or be poked by other code to look for interrupt-worthy
465 amr_pci_intr(void *arg)
467 struct amr_softc *sc = (struct amr_softc *)arg;
471 /* collect finished commands, queue anything waiting */
475 /********************************************************************************
476 * Free all of the resources associated with (sc)
478 * Should not be called if the controller is active.
481 amr_pci_free(struct amr_softc *sc)
489 /* destroy data-transfer DMA tag */
490 if (sc->amr_buffer_dmat)
491 bus_dma_tag_destroy(sc->amr_buffer_dmat);
492 if (sc->amr_buffer64_dmat)
493 bus_dma_tag_destroy(sc->amr_buffer64_dmat);
495 /* free and destroy DMA memory and tag for passthrough pool */
497 bus_dmamem_free(sc->amr_ccb_dmat, sc->amr_ccb, sc->amr_ccb_dmamap);
498 if (sc->amr_ccb_dmat)
499 bus_dma_tag_destroy(sc->amr_ccb_dmat);
501 /* free and destroy DMA memory and tag for s/g lists */
503 bus_dmamem_free(sc->amr_sg_dmat, sc->amr_sgtable, sc->amr_sg_dmamap);
505 bus_dma_tag_destroy(sc->amr_sg_dmat);
507 /* free and destroy DMA memory and tag for mailbox */
508 p = (void *)(uintptr_t)(volatile void *)sc->amr_mailbox64;
509 if (sc->amr_mailbox) {
510 bus_dmamem_free(sc->amr_mailbox_dmat, p, sc->amr_mailbox_dmamap);
512 if (sc->amr_mailbox_dmat)
513 bus_dma_tag_destroy(sc->amr_mailbox_dmat);
515 /* disconnect the interrupt handler */
517 bus_teardown_intr(sc->amr_dev, sc->amr_irq, sc->amr_intr);
518 if (sc->amr_irq != NULL)
519 bus_release_resource(sc->amr_dev, SYS_RES_IRQ, 0, sc->amr_irq);
521 /* destroy the parent DMA tag */
522 if (sc->amr_parent_dmat)
523 bus_dma_tag_destroy(sc->amr_parent_dmat);
525 /* release the register window mapping */
526 if (sc->amr_reg != NULL)
527 bus_release_resource(sc->amr_dev,
528 AMR_IS_QUARTZ(sc) ? SYS_RES_MEMORY : SYS_RES_IOPORT,
529 PCIR_BAR(0), sc->amr_reg);
532 /********************************************************************************
533 * Allocate and map the scatter/gather table in bus space.
536 amr_sglist_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
543 *addr = segs[0].ds_addr;
547 amr_sglist_map(struct amr_softc *sc)
556 * Create a single tag describing a region large enough to hold all of
557 * the s/g lists we will need.
559 * Note that we could probably use AMR_LIMITCMD here, but that may become
563 segsize = sizeof(struct amr_sg64entry) * AMR_NSEG * AMR_MAXCMD;
565 segsize = sizeof(struct amr_sgentry) * AMR_NSEG * AMR_MAXCMD;
567 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
568 512, 0, /* alignment,boundary */
569 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
570 BUS_SPACE_MAXADDR, /* highaddr */
571 NULL, NULL, /* filter, filterarg */
572 segsize, 1, /* maxsize, nsegments */
573 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
577 device_printf(sc->amr_dev, "can't allocate scatter/gather DMA tag\n");
582 * Allocate enough s/g maps for all commands and permanently map them into
583 * controller-visible space.
585 * XXX this assumes we can get enough space for all the s/g maps in one
586 * contiguous slab. We may need to switch to a more complex arrangement
587 * where we allocate in smaller chunks and keep a lookup table from slot
590 * XXX HACK ALERT: at least some controllers don't like the s/g memory
591 * being allocated below 0x2000. We leak some memory if
592 * we get some below this mark and allocate again. We
593 * should be able to avoid this with the tag setup, but
594 * that does't seem to work.
597 error = bus_dmamem_alloc(sc->amr_sg_dmat, &p, BUS_DMA_NOWAIT,
600 device_printf(sc->amr_dev, "can't allocate s/g table\n");
603 bus_dmamap_load(sc->amr_sg_dmat, sc->amr_sg_dmamap, p, segsize, amr_sglist_helper, &sc->amr_sgbusaddr, 0);
604 if (sc->amr_sgbusaddr < 0x2000) {
605 debug(1, "s/g table too low (0x%x), reallocating\n", sc->amr_sgbusaddr);
610 sc->amr_sg64table = (struct amr_sg64entry *)p;
611 sc->amr_sgtable = (struct amr_sgentry *)p;
616 /********************************************************************************
617 * Allocate and set up mailbox areas for the controller (sc)
619 * The basic mailbox structure should be 16-byte aligned.
622 amr_setup_mbox(struct amr_softc *sc)
631 * Create a single tag describing a region large enough to hold the entire
634 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
635 16, 0, /* alignment,boundary */
636 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
637 BUS_SPACE_MAXADDR, /* highaddr */
638 NULL, NULL, /* filter, filterarg */
639 sizeof(struct amr_mailbox64), /* maxsize */
641 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
643 &sc->amr_mailbox_dmat);
645 device_printf(sc->amr_dev, "can't allocate mailbox tag\n");
650 * Allocate the mailbox structure and permanently map it into
651 * controller-visible space.
653 error = bus_dmamem_alloc(sc->amr_mailbox_dmat, &p, BUS_DMA_NOWAIT,
654 &sc->amr_mailbox_dmamap);
656 device_printf(sc->amr_dev, "can't allocate mailbox memory\n");
659 bus_dmamap_load(sc->amr_mailbox_dmat, sc->amr_mailbox_dmamap, p,
660 sizeof(struct amr_mailbox64), amr_sglist_helper, &baddr, 0);
662 * Conventional mailbox is inside the mailbox64 region.
664 /* save physical base of the basic mailbox structure */
665 sc->amr_mailboxphys = baddr + offsetof(struct amr_mailbox64, mb);
666 bzero(p, sizeof(struct amr_mailbox64));
667 sc->amr_mailbox64 = (struct amr_mailbox64 *)p;
668 sc->amr_mailbox = &sc->amr_mailbox64->mb;
674 amr_ccb_map(struct amr_softc *sc)
679 * Passthrough and Extended passthrough structures will share the same
682 ccbsize = sizeof(union amr_ccb) * AMR_MAXCMD;
683 error = bus_dma_tag_create(sc->amr_parent_dmat, /* parent */
684 128, 0, /* alignment,boundary */
685 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
686 BUS_SPACE_MAXADDR, /* highaddr */
687 NULL, NULL, /* filter, filterarg */
688 ccbsize, /* maxsize */
690 ccbsize, /* maxsegsize */
694 device_printf(sc->amr_dev, "can't allocate ccb tag\n");
698 error = bus_dmamem_alloc(sc->amr_ccb_dmat, (void **)&sc->amr_ccb,
699 BUS_DMA_NOWAIT, &sc->amr_ccb_dmamap);
701 device_printf(sc->amr_dev, "can't allocate ccb memory\n");
704 bus_dmamap_load(sc->amr_ccb_dmat, sc->amr_ccb_dmamap, sc->amr_ccb,
705 ccbsize, amr_sglist_helper, &sc->amr_ccb_busaddr, 0);
706 bzero(sc->amr_ccb, ccbsize);