2 * Copyright 2002 by Peter Grehan. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * 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
31 * Driver for KeyLargo/Pangea, the MacPPC south bridge ASIC.
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
45 #include <machine/bus.h>
46 #include <machine/intr_machdep.h>
47 #include <machine/pmap.h>
48 #include <machine/resource.h>
49 #include <machine/vmparam.h>
51 #include <dev/ofw/ofw_bus.h>
52 #include <dev/ofw/ofw_bus_subr.h>
53 #include <dev/ofw/openfirm.h>
55 #include <powerpc/powermac/maciovar.h>
57 #include <dev/pci/pcivar.h>
58 #include <dev/pci/pcireg.h>
67 struct rman sc_mem_rman;
71 struct resource *sc_memr;
74 static MALLOC_DEFINE(M_MACIO, "macio", "macio device information");
76 static int macio_probe(device_t);
77 static int macio_attach(device_t);
78 static int macio_print_child(device_t dev, device_t child);
79 static void macio_probe_nomatch(device_t, device_t);
80 static struct resource *macio_alloc_resource(device_t, device_t, int, int *,
81 u_long, u_long, u_long, u_int);
82 static int macio_activate_resource(device_t, device_t, int, int,
84 static int macio_deactivate_resource(device_t, device_t, int, int,
86 static int macio_release_resource(device_t, device_t, int, int,
88 static struct resource_list *macio_get_resource_list (device_t, device_t);
89 static ofw_bus_get_devinfo_t macio_get_devinfo;
92 * Bus interface definition
94 static device_method_t macio_methods[] = {
95 /* Device interface */
96 DEVMETHOD(device_probe, macio_probe),
97 DEVMETHOD(device_attach, macio_attach),
98 DEVMETHOD(device_detach, bus_generic_detach),
99 DEVMETHOD(device_shutdown, bus_generic_shutdown),
100 DEVMETHOD(device_suspend, bus_generic_suspend),
101 DEVMETHOD(device_resume, bus_generic_resume),
104 DEVMETHOD(bus_print_child, macio_print_child),
105 DEVMETHOD(bus_probe_nomatch, macio_probe_nomatch),
106 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
107 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
109 DEVMETHOD(bus_alloc_resource, macio_alloc_resource),
110 DEVMETHOD(bus_release_resource, macio_release_resource),
111 DEVMETHOD(bus_activate_resource, macio_activate_resource),
112 DEVMETHOD(bus_deactivate_resource, macio_deactivate_resource),
113 DEVMETHOD(bus_get_resource_list, macio_get_resource_list),
115 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
117 /* ofw_bus interface */
118 DEVMETHOD(ofw_bus_get_devinfo, macio_get_devinfo),
119 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
120 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
121 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
122 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
123 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
128 static driver_t macio_pci_driver = {
131 sizeof(struct macio_softc)
134 devclass_t macio_devclass;
136 DRIVER_MODULE(macio, pci, macio_pci_driver, macio_devclass, 0, 0);
139 * PCI ID search table
141 static struct macio_pci_dev {
144 } macio_pci_devlist[] = {
145 { 0x0017106b, "Paddington I/O Controller" },
146 { 0x0022106b, "KeyLargo I/O Controller" },
147 { 0x0025106b, "Pangea I/O Controller" },
148 { 0x003e106b, "Intrepid I/O Controller" },
149 { 0x0041106b, "K2 KeyLargo I/O Controller" },
150 { 0x004f106b, "Shasta I/O Controller" },
155 * Devices to exclude from the probe
156 * XXX some of these may be required in the future...
158 #define MACIO_QUIRK_IGNORE 0x00000001
159 #define MACIO_QUIRK_CHILD_HAS_INTR 0x00000002
160 #define MACIO_QUIRK_USE_CHILD_REG 0x00000004
162 struct macio_quirk_entry {
167 static struct macio_quirk_entry macio_quirks[] = {
168 { "escc-legacy", MACIO_QUIRK_IGNORE },
169 { "timer", MACIO_QUIRK_IGNORE },
170 { "escc", MACIO_QUIRK_CHILD_HAS_INTR },
171 { "i2s", MACIO_QUIRK_CHILD_HAS_INTR |
172 MACIO_QUIRK_USE_CHILD_REG },
177 macio_get_quirks(const char *name)
179 struct macio_quirk_entry *mqe;
181 for (mqe = macio_quirks; mqe->mq_name != NULL; mqe++)
182 if (strcmp(name, mqe->mq_name) == 0)
183 return (mqe->mq_quirks);
189 * Add an interrupt to the dev's resource list if present
192 macio_add_intr(phandle_t devnode, struct macio_devinfo *dinfo)
199 if (dinfo->mdi_ninterrupts >= 6) {
200 printf("macio: device has more than 6 interrupts\n");
204 if (OF_searchprop(devnode, "#interrupt-cells", &icells, sizeof(icells))
208 nintr = OF_getprop_alloc(devnode, "interrupts", sizeof(*intr),
211 nintr = OF_getprop_alloc(devnode, "AAPL,interrupts",
212 sizeof(*intr), (void **)&intr);
220 if (OF_getprop(devnode, "interrupt-parent", &iparent, sizeof(iparent))
222 panic("Interrupt but no interrupt parent!\n");
224 for (i = 0; i < nintr; i+=icells) {
225 u_int irq = MAP_IRQ(iparent, intr[i]);
227 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ,
228 dinfo->mdi_ninterrupts, irq, irq, 1);
230 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = irq;
231 dinfo->mdi_ninterrupts++;
237 macio_add_reg(phandle_t devnode, struct macio_devinfo *dinfo)
239 struct macio_reg *reg;
242 nreg = OF_getprop_alloc(devnode, "reg", sizeof(*reg), (void **)®);
246 for (i = 0; i < nreg; i++) {
247 resource_list_add(&dinfo->mdi_resources, SYS_RES_MEMORY, i,
248 reg[i].mr_base, reg[i].mr_base + reg[i].mr_size,
257 macio_probe(device_t dev)
262 devid = pci_get_devid(dev);
263 for (i = 0; macio_pci_devlist[i].mpd_desc != NULL; i++) {
264 if (devid == macio_pci_devlist[i].mpd_devid) {
265 device_set_desc(dev, macio_pci_devlist[i].mpd_desc);
274 * PCI attach: scan Open Firmware child nodes, and attach these as children
278 macio_attach(device_t dev)
280 struct macio_softc *sc;
281 struct macio_devinfo *dinfo;
289 sc = device_get_softc(dev);
290 root = sc->sc_node = ofw_bus_get_node(dev);
293 * Locate the device node and it's base address
295 if (OF_getprop(root, "assigned-addresses",
296 reg, sizeof(reg)) < (ssize_t)sizeof(reg)) {
300 sc->sc_base = reg[2];
301 sc->sc_size = MACIO_REG_SIZE;
303 sc->sc_memrid = PCIR_BAR(0);
304 sc->sc_memr = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
305 &sc->sc_memrid, RF_ACTIVE);
307 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
308 sc->sc_mem_rman.rm_descr = "MacIO Device Memory";
309 error = rman_init(&sc->sc_mem_rman);
311 device_printf(dev, "rman_init() failed. error = %d\n", error);
314 error = rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size);
317 "rman_manage_region() failed. error = %d\n", error);
322 * Iterate through the sub-devices
324 for (child = OF_child(root); child != 0; child = OF_peer(child)) {
325 dinfo = malloc(sizeof(*dinfo), M_MACIO, M_WAITOK | M_ZERO);
326 if (ofw_bus_gen_setup_devinfo(&dinfo->mdi_obdinfo, child) !=
328 free(dinfo, M_MACIO);
331 quirks = macio_get_quirks(dinfo->mdi_obdinfo.obd_name);
332 if ((quirks & MACIO_QUIRK_IGNORE) != 0) {
333 ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo);
334 free(dinfo, M_MACIO);
337 resource_list_init(&dinfo->mdi_resources);
338 dinfo->mdi_ninterrupts = 0;
339 macio_add_intr(child, dinfo);
340 if ((quirks & MACIO_QUIRK_USE_CHILD_REG) != 0)
341 macio_add_reg(OF_child(child), dinfo);
343 macio_add_reg(child, dinfo);
344 if ((quirks & MACIO_QUIRK_CHILD_HAS_INTR) != 0)
345 for (subchild = OF_child(child); subchild != 0;
346 subchild = OF_peer(subchild))
347 macio_add_intr(subchild, dinfo);
348 cdev = device_add_child(dev, NULL, -1);
350 device_printf(dev, "<%s>: device_add_child failed\n",
351 dinfo->mdi_obdinfo.obd_name);
352 resource_list_free(&dinfo->mdi_resources);
353 ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo);
354 free(dinfo, M_MACIO);
357 device_set_ivars(cdev, dinfo);
359 /* Set FCRs to enable some devices */
360 if (sc->sc_memr == NULL)
363 if (strcmp(ofw_bus_get_name(cdev), "bmac") == 0 ||
364 strcmp(ofw_bus_get_compat(cdev), "bmac+") == 0) {
367 fcr = bus_read_4(sc->sc_memr, HEATHROW_FCR);
369 fcr |= FCR_ENET_ENABLE & ~FCR_ENET_RESET;
370 bus_write_4(sc->sc_memr, HEATHROW_FCR, fcr);
372 fcr |= FCR_ENET_RESET;
373 bus_write_4(sc->sc_memr, HEATHROW_FCR, fcr);
375 fcr &= ~FCR_ENET_RESET;
376 bus_write_4(sc->sc_memr, HEATHROW_FCR, fcr);
379 bus_write_4(sc->sc_memr, HEATHROW_FCR, fcr);
383 return (bus_generic_attach(dev));
388 macio_print_child(device_t dev, device_t child)
390 struct macio_devinfo *dinfo;
391 struct resource_list *rl;
394 dinfo = device_get_ivars(child);
395 rl = &dinfo->mdi_resources;
397 retval += bus_print_child_header(dev, child);
399 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
400 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
402 retval += bus_print_child_footer(dev, child);
409 macio_probe_nomatch(device_t dev, device_t child)
411 struct macio_devinfo *dinfo;
412 struct resource_list *rl;
416 dinfo = device_get_ivars(child);
417 rl = &dinfo->mdi_resources;
419 if ((type = ofw_bus_get_type(child)) == NULL)
421 device_printf(dev, "<%s, %s>", type, ofw_bus_get_name(child));
422 resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
423 resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
424 printf(" (no driver attached)\n");
429 static struct resource *
430 macio_alloc_resource(device_t bus, device_t child, int type, int *rid,
431 u_long start, u_long end, u_long count, u_int flags)
433 struct macio_softc *sc;
437 u_long adjstart, adjend, adjcount;
438 struct macio_devinfo *dinfo;
439 struct resource_list_entry *rle;
441 sc = device_get_softc(bus);
442 dinfo = device_get_ivars(child);
444 needactivate = flags & RF_ACTIVE;
450 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_MEMORY,
453 device_printf(bus, "no rle for %s memory %d\n",
454 device_get_nameunit(child), *rid);
458 if (start < rle->start)
459 adjstart = rle->start;
460 else if (start > rle->end)
465 if (end < rle->start)
467 else if (end > rle->end)
472 adjcount = adjend - adjstart;
474 rm = &sc->sc_mem_rman;
478 /* Check for passthrough from subattachments like macgpio */
479 if (device_get_parent(child) != bus)
480 return BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
481 type, rid, start, end, count, flags);
483 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_IRQ,
486 if (dinfo->mdi_ninterrupts >= 6) {
488 "%s has more than 6 interrupts\n",
489 device_get_nameunit(child));
492 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ,
493 dinfo->mdi_ninterrupts, start, start, 1);
495 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = start;
496 dinfo->mdi_ninterrupts++;
499 return (resource_list_alloc(&dinfo->mdi_resources, bus, child,
500 type, rid, start, end, count, flags));
503 device_printf(bus, "unknown resource request from %s\n",
504 device_get_nameunit(child));
508 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags,
512 "failed to reserve resource %#lx - %#lx (%#lx) for %s\n",
513 adjstart, adjend, adjcount, device_get_nameunit(child));
517 rman_set_rid(rv, *rid);
520 if (bus_activate_resource(child, type, *rid, rv) != 0) {
522 "failed to activate resource for %s\n",
523 device_get_nameunit(child));
524 rman_release_resource(rv);
534 macio_release_resource(device_t bus, device_t child, int type, int rid,
535 struct resource *res)
537 if (rman_get_flags(res) & RF_ACTIVE) {
538 int error = bus_deactivate_resource(child, type, rid, res);
543 return (rman_release_resource(res));
548 macio_activate_resource(device_t bus, device_t child, int type, int rid,
549 struct resource *res)
551 struct macio_softc *sc;
554 sc = device_get_softc(bus);
556 if (type == SYS_RES_IRQ)
557 return (bus_activate_resource(bus, type, rid, res));
559 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
560 p = pmap_mapdev((vm_offset_t)rman_get_start(res) + sc->sc_base,
561 (vm_size_t)rman_get_size(res));
564 rman_set_virtual(res, p);
565 rman_set_bustag(res, &bs_le_tag);
566 rman_set_bushandle(res, (u_long)p);
569 return (rman_activate_resource(res));
574 macio_deactivate_resource(device_t bus, device_t child, int type, int rid,
575 struct resource *res)
578 * If this is a memory resource, unmap it.
580 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
583 psize = rman_get_size(res);
584 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize);
587 return (rman_deactivate_resource(res));
591 static struct resource_list *
592 macio_get_resource_list (device_t dev, device_t child)
594 struct macio_devinfo *dinfo;
596 dinfo = device_get_ivars(child);
597 return (&dinfo->mdi_resources);
600 static const struct ofw_bus_devinfo *
601 macio_get_devinfo(device_t dev, device_t child)
603 struct macio_devinfo *dinfo;
605 dinfo = device_get_ivars(child);
606 return (&dinfo->mdi_obdinfo);