2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2002 Benno Rice.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
35 #include <sys/kernel.h>
37 #include <dev/ofw/openfirm.h>
38 #include <dev/ofw/ofw_pci.h>
39 #include <dev/ofw/ofw_bus.h>
40 #include <dev/ofw/ofw_bus_subr.h>
42 #include <dev/pci/pcivar.h>
43 #include <dev/pci/pcireg.h>
45 #include <machine/bus.h>
46 #include <machine/intr_machdep.h>
47 #include <machine/md_var.h>
48 #include <machine/pio.h>
49 #include <machine/resource.h>
53 #include <powerpc/powermac/uninorthvar.h>
59 * Driver for the Uninorth chip itself.
62 static MALLOC_DEFINE(M_UNIN, "unin", "unin device information");
68 static int unin_chip_probe(device_t);
69 static int unin_chip_attach(device_t);
74 static int unin_chip_print_child(device_t dev, device_t child);
75 static void unin_chip_probe_nomatch(device_t, device_t);
76 static struct resource *unin_chip_alloc_resource(device_t, device_t, int, int *,
77 rman_res_t, rman_res_t,
79 static int unin_chip_activate_resource(device_t, device_t, int, int,
81 static int unin_chip_deactivate_resource(device_t, device_t, int, int,
83 static int unin_chip_release_resource(device_t, device_t, int, int,
85 static struct resource_list *unin_chip_get_resource_list (device_t, device_t);
91 static ofw_bus_get_devinfo_t unin_chip_get_devinfo;
97 static void unin_enable_gmac(device_t dev);
98 static void unin_enable_mpic(device_t dev);
103 static device_method_t unin_chip_methods[] = {
105 /* Device interface */
106 DEVMETHOD(device_probe, unin_chip_probe),
107 DEVMETHOD(device_attach, unin_chip_attach),
110 DEVMETHOD(bus_print_child, unin_chip_print_child),
111 DEVMETHOD(bus_probe_nomatch, unin_chip_probe_nomatch),
112 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
113 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
115 DEVMETHOD(bus_alloc_resource, unin_chip_alloc_resource),
116 DEVMETHOD(bus_release_resource, unin_chip_release_resource),
117 DEVMETHOD(bus_activate_resource, unin_chip_activate_resource),
118 DEVMETHOD(bus_deactivate_resource, unin_chip_deactivate_resource),
119 DEVMETHOD(bus_get_resource_list, unin_chip_get_resource_list),
121 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
123 /* ofw_bus interface */
124 DEVMETHOD(ofw_bus_get_devinfo, unin_chip_get_devinfo),
125 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
126 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
127 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
128 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
129 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
134 static driver_t unin_chip_driver = {
137 sizeof(struct unin_chip_softc)
140 static devclass_t unin_chip_devclass;
143 * Assume there is only one unin chip in a PowerMac, so that pmu.c functions can
144 * suspend the chip after the whole rest of the device tree is suspended, not
147 static device_t unin_chip;
149 DRIVER_MODULE(unin, ofwbus, unin_chip_driver, unin_chip_devclass, 0, 0);
152 * Add an interrupt to the dev's resource list if present
155 unin_chip_add_intr(phandle_t devnode, struct unin_chip_devinfo *dinfo)
162 if (dinfo->udi_ninterrupts >= 6) {
163 printf("unin: device has more than 6 interrupts\n");
167 nintr = OF_getprop_alloc(devnode, "interrupts", sizeof(*intr),
170 nintr = OF_getprop_alloc(devnode, "AAPL,interrupts",
171 sizeof(*intr), (void **)&intr);
179 if (OF_getprop(devnode, "interrupt-parent", &iparent, sizeof(iparent))
181 panic("Interrupt but no interrupt parent!\n");
183 if (OF_searchprop(iparent, "#interrupt-cells", &icells, sizeof(icells))
187 for (i = 0; i < nintr; i+=icells) {
188 u_int irq = MAP_IRQ(iparent, intr[i]);
190 resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
191 dinfo->udi_ninterrupts, irq, irq, 1);
194 powerpc_config_intr(irq,
195 (intr[i+1] & 1) ? INTR_TRIGGER_LEVEL :
196 INTR_TRIGGER_EDGE, INTR_POLARITY_LOW);
199 dinfo->udi_interrupts[dinfo->udi_ninterrupts] = irq;
200 dinfo->udi_ninterrupts++;
205 unin_chip_add_reg(phandle_t devnode, struct unin_chip_devinfo *dinfo)
207 struct unin_chip_reg *reg;
210 nreg = OF_getprop_alloc(devnode, "reg", sizeof(*reg), (void **)®);
214 for (i = 0; i < nreg; i++) {
215 resource_list_add(&dinfo->udi_resources, SYS_RES_MEMORY, i,
217 reg[i].mr_base + reg[i].mr_size,
223 unin_update_reg(device_t dev, uint32_t regoff, uint32_t set, uint32_t clr)
226 struct unin_chip_softc *sc;
229 sc = device_get_softc(dev);
230 reg = (void *)(sc->sc_addr + regoff);
238 unin_enable_gmac(device_t dev)
240 unin_update_reg(dev, UNIN_CLOCKCNTL, UNIN_CLOCKCNTL_GMAC, 0);
244 unin_enable_mpic(device_t dev)
246 unin_update_reg(dev, UNIN_TOGGLE_REG, UNIN_MPIC_RESET | UNIN_MPIC_OUTPUT_ENABLE, 0);
250 unin_chip_probe(device_t dev)
254 name = ofw_bus_get_name(dev);
259 if (strcmp(name, "uni-n") != 0 && strcmp(name, "u3") != 0
260 && strcmp(name, "u4") != 0)
263 device_set_desc(dev, "Apple UniNorth System Controller");
268 unin_chip_attach(device_t dev)
270 struct unin_chip_softc *sc;
271 struct unin_chip_devinfo *dinfo;
276 cell_t acells, scells;
282 sc = device_get_softc(dev);
283 root = ofw_bus_get_node(dev);
285 if (OF_getprop(root, "reg", reg, sizeof(reg)) < 8)
289 OF_getprop(OF_parent(root), "#address-cells", &acells, sizeof(acells));
290 OF_getprop(OF_parent(root), "#size-cells", &scells, sizeof(scells));
293 sc->sc_physaddr = reg[i++];
295 sc->sc_physaddr <<= 32;
296 sc->sc_physaddr |= reg[i++];
298 sc->sc_size = reg[i++];
301 sc->sc_size |= reg[i++];
304 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
305 sc->sc_mem_rman.rm_descr = "UniNorth Device Memory";
307 error = rman_init(&sc->sc_mem_rman);
310 device_printf(dev, "rman_init() failed. error = %d\n", error);
314 error = rman_manage_region(&sc->sc_mem_rman, sc->sc_physaddr,
315 sc->sc_physaddr + sc->sc_size - 1);
318 "rman_manage_region() failed. error = %d\n",
323 if (unin_chip == NULL)
327 * Iterate through the sub-devices
329 for (child = OF_child(root); child != 0; child = OF_peer(child)) {
330 dinfo = malloc(sizeof(*dinfo), M_UNIN, M_WAITOK | M_ZERO);
331 if (ofw_bus_gen_setup_devinfo(&dinfo->udi_obdinfo, child)
338 resource_list_init(&dinfo->udi_resources);
339 dinfo->udi_ninterrupts = 0;
340 unin_chip_add_intr(child, dinfo);
343 * Some Apple machines do have a bug in OF, they miss
344 * the interrupt entries on the U3 I2C node. That means they
345 * do not have an entry with number of interrupts nor the
346 * entry of the interrupt parent handle.
347 * We define an interrupt and hardwire it to the /u3/mpic
351 if (OF_getprop(child, "name", name, sizeof(name)) <= 0)
352 device_printf(dev, "device has no name!\n");
353 if (dinfo->udi_ninterrupts == 0 &&
354 (strcmp(name, "i2c-bus") == 0 ||
355 strcmp(name, "i2c") == 0)) {
356 if (OF_getprop(child, "interrupt-parent", &iparent,
357 sizeof(iparent)) <= 0) {
358 iparent = OF_finddevice("/u3/mpic");
359 device_printf(dev, "Set /u3/mpic as iparent!\n");
361 /* Add an interrupt number 0 to the parent. */
362 irq = MAP_IRQ(iparent, 0);
363 resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
364 dinfo->udi_ninterrupts, irq, irq, 1);
365 dinfo->udi_interrupts[dinfo->udi_ninterrupts] = irq;
366 dinfo->udi_ninterrupts++;
369 unin_chip_add_reg(child, dinfo);
371 cdev = device_add_child(dev, NULL, -1);
373 device_printf(dev, "<%s>: device_add_child failed\n",
374 dinfo->udi_obdinfo.obd_name);
375 resource_list_free(&dinfo->udi_resources);
376 ofw_bus_gen_destroy_devinfo(&dinfo->udi_obdinfo);
381 device_set_ivars(cdev, dinfo);
385 * Only map the first page, since that is where the registers
388 sc->sc_addr = (vm_offset_t)pmap_mapdev(sc->sc_physaddr, PAGE_SIZE);
390 sc->sc_version = *(u_int *)sc->sc_addr;
391 device_printf(dev, "Version %d\n", sc->sc_version);
394 * Enable the GMAC Ethernet cell and the integrated OpenPIC
395 * if Open Firmware says they are used.
397 for (child = OF_child(root); child; child = OF_peer(child)) {
398 memset(compat, 0, sizeof(compat));
399 OF_getprop(child, "compatible", compat, sizeof(compat));
400 if (strcmp(compat, "gmac") == 0)
401 unin_enable_gmac(dev);
402 if (strcmp(compat, "chrp,open-pic") == 0)
403 unin_enable_mpic(dev);
407 * GMAC lives under the PCI bus, so just check if enet is gmac.
409 child = OF_finddevice("enet");
410 memset(compat, 0, sizeof(compat));
411 OF_getprop(child, "compatible", compat, sizeof(compat));
412 if (strcmp(compat, "gmac") == 0)
413 unin_enable_gmac(dev);
415 return (bus_generic_attach(dev));
419 unin_chip_print_child(device_t dev, device_t child)
421 struct unin_chip_devinfo *dinfo;
422 struct resource_list *rl;
425 dinfo = device_get_ivars(child);
426 rl = &dinfo->udi_resources;
428 retval += bus_print_child_header(dev, child);
430 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#jx");
431 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
433 retval += bus_print_child_footer(dev, child);
439 unin_chip_probe_nomatch(device_t dev, device_t child)
441 struct unin_chip_devinfo *dinfo;
442 struct resource_list *rl;
446 dinfo = device_get_ivars(child);
447 rl = &dinfo->udi_resources;
449 if ((type = ofw_bus_get_type(child)) == NULL)
451 device_printf(dev, "<%s, %s>", type, ofw_bus_get_name(child));
452 resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#jx");
453 resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
454 printf(" (no driver attached)\n");
459 static struct resource *
460 unin_chip_alloc_resource(device_t bus, device_t child, int type, int *rid,
461 rman_res_t start, rman_res_t end, rman_res_t count,
464 struct unin_chip_softc *sc;
468 u_long adjstart, adjend, adjcount;
469 struct unin_chip_devinfo *dinfo;
470 struct resource_list_entry *rle;
472 sc = device_get_softc(bus);
473 dinfo = device_get_ivars(child);
475 needactivate = flags & RF_ACTIVE;
481 rle = resource_list_find(&dinfo->udi_resources, SYS_RES_MEMORY,
484 device_printf(bus, "no rle for %s memory %d\n",
485 device_get_nameunit(child), *rid);
489 rle->end = rle->end - 1; /* Hack? */
491 if (start < rle->start)
492 adjstart = rle->start;
493 else if (start > rle->end)
498 if (end < rle->start)
500 else if (end > rle->end)
505 adjcount = adjend - adjstart;
507 rm = &sc->sc_mem_rman;
511 /* Check for passthrough from subattachments. */
512 if (device_get_parent(child) != bus)
513 return BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
514 type, rid, start, end, count,
517 rle = resource_list_find(&dinfo->udi_resources, SYS_RES_IRQ,
520 if (dinfo->udi_ninterrupts >= 6) {
522 "%s has more than 6 interrupts\n",
523 device_get_nameunit(child));
526 resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ,
527 dinfo->udi_ninterrupts, start, start,
530 dinfo->udi_interrupts[dinfo->udi_ninterrupts] = start;
531 dinfo->udi_ninterrupts++;
534 return (resource_list_alloc(&dinfo->udi_resources, bus, child,
535 type, rid, start, end, count,
538 device_printf(bus, "unknown resource request from %s\n",
539 device_get_nameunit(child));
543 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags,
547 "failed to reserve resource %#lx - %#lx (%#lx)"
548 " for %s\n", adjstart, adjend, adjcount,
549 device_get_nameunit(child));
553 rman_set_rid(rv, *rid);
556 if (bus_activate_resource(child, type, *rid, rv) != 0) {
558 "failed to activate resource for %s\n",
559 device_get_nameunit(child));
560 rman_release_resource(rv);
569 unin_chip_release_resource(device_t bus, device_t child, int type, int rid,
570 struct resource *res)
572 if (rman_get_flags(res) & RF_ACTIVE) {
573 int error = bus_deactivate_resource(child, type, rid, res);
578 return (rman_release_resource(res));
582 unin_chip_activate_resource(device_t bus, device_t child, int type, int rid,
583 struct resource *res)
587 if (type == SYS_RES_IRQ)
588 return (bus_activate_resource(bus, type, rid, res));
590 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
593 start = (vm_offset_t) rman_get_start(res);
596 printf("unin mapdev: start %zx, len %jd\n", start,
599 p = pmap_mapdev(start, (vm_size_t) rman_get_size(res));
602 rman_set_virtual(res, p);
603 rman_set_bustag(res, &bs_be_tag);
604 rman_set_bushandle(res, (u_long)p);
607 return (rman_activate_resource(res));
612 unin_chip_deactivate_resource(device_t bus, device_t child, int type, int rid,
613 struct resource *res)
616 * If this is a memory resource, unmap it.
618 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
621 psize = rman_get_size(res);
622 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize);
625 return (rman_deactivate_resource(res));
629 static struct resource_list *
630 unin_chip_get_resource_list (device_t dev, device_t child)
632 struct unin_chip_devinfo *dinfo;
634 dinfo = device_get_ivars(child);
635 return (&dinfo->udi_resources);
638 static const struct ofw_bus_devinfo *
639 unin_chip_get_devinfo(device_t dev, device_t child)
641 struct unin_chip_devinfo *dinfo;
643 dinfo = device_get_ivars(child);
644 return (&dinfo->udi_obdinfo);
648 unin_chip_wake(device_t dev)
653 unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_NORMAL, UNIN_PWR_MASK);
655 unin_update_reg(dev, UNIN_HWINIT_STATE, UNIN_RUNNING, 0);
662 unin_chip_sleep(device_t dev, int idle)
667 unin_update_reg(dev, UNIN_HWINIT_STATE, UNIN_SLEEPING, 0);
670 unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_IDLE2, UNIN_PWR_MASK);
672 unin_update_reg(dev, UNIN_PWR_MGMT, UNIN_PWR_SLEEP, UNIN_PWR_MASK);