2 * Copyright (c) 2006 Marius Strobl <marius@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/resource.h>
38 #include <dev/ofw/ofw_bus.h>
39 #include <dev/ofw/ofw_bus_subr.h>
40 #include <dev/ofw/openfirm.h>
42 #include <machine/bus.h>
43 #include <machine/bus_common.h>
44 #include <machine/intr_machdep.h>
45 #include <machine/resource.h>
54 #define UPA_CFG_UPA0 0x00 /* UPA0 config register */
55 #define UPA_CFG_UPA1 0x08 /* UPA1 config register */
56 #define UPA_CFG_IF 0x10 /* interface config register */
57 #define UPA_CFG_IF_RST 0x00
58 #define UPA_CFG_IF_POK_RST 0x02
59 #define UPA_CFG_IF_POK 0x03
60 #define UPA_CFG_ESTAR 0x18 /* Estar config register */
61 #define UPA_CFG_ESTAR_SPEED_FULL 0x01
62 #define UPA_CFG_ESTAR_SPEED_1_2 0x02
63 #define UPA_CFG_ESTAR_SPEED_1_64 0x40
65 #define UPA_INO_BASE 0x2a
66 #define UPA_INO_MAX 0x2b
80 struct ofw_bus_devinfo udi_obdinfo;
81 struct resource_list udi_rl;
85 struct resource *sc_res[UPA_NREG];
86 bus_space_tag_t sc_bt[UPA_NREG];
87 bus_space_handle_t sc_bh[UPA_NREG];
92 struct upa_ranges *sc_ranges;
95 #define UPA_READ(sc, reg, off) \
96 bus_space_read_8((sc)->sc_bt[(reg)], (sc)->sc_bh[(reg)], (off))
97 #define UPA_WRITE(sc, reg, off, val) \
98 bus_space_write_8((sc)->sc_bt[(reg)], (sc)->sc_bh[(reg)], (off), (val))
100 static device_probe_t upa_probe;
101 static device_attach_t upa_attach;
102 static bus_print_child_t upa_print_child;
103 static bus_probe_nomatch_t upa_probe_nomatch;
104 static bus_alloc_resource_t upa_alloc_resource;
105 static bus_adjust_resource_t upa_adjust_resource;
106 static bus_setup_intr_t upa_setup_intr;
107 static bus_get_resource_list_t upa_get_resource_list;
108 static ofw_bus_get_devinfo_t upa_get_devinfo;
110 static void upa_intr_enable(void *);
111 static void upa_intr_disable(void *);
112 static void upa_intr_assign(void *);
113 static struct upa_devinfo *upa_setup_dinfo(device_t, struct upa_softc *,
114 phandle_t, uint32_t);
115 static void upa_destroy_dinfo(struct upa_devinfo *);
116 static int upa_print_res(struct upa_devinfo *);
118 static device_method_t upa_methods[] = {
119 /* Device interface */
120 DEVMETHOD(device_probe, upa_probe),
121 DEVMETHOD(device_attach, upa_attach),
122 DEVMETHOD(device_shutdown, bus_generic_shutdown),
123 DEVMETHOD(device_suspend, bus_generic_suspend),
124 DEVMETHOD(device_resume, bus_generic_resume),
127 DEVMETHOD(bus_print_child, upa_print_child),
128 DEVMETHOD(bus_probe_nomatch, upa_probe_nomatch),
129 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar),
130 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar),
131 DEVMETHOD(bus_alloc_resource, upa_alloc_resource),
132 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
133 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
134 DEVMETHOD(bus_adjust_resource, upa_adjust_resource),
135 DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource),
136 DEVMETHOD(bus_setup_intr, upa_setup_intr),
137 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
138 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
139 DEVMETHOD(bus_get_resource_list, upa_get_resource_list),
140 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
142 /* ofw_bus interface */
143 DEVMETHOD(ofw_bus_get_devinfo, upa_get_devinfo),
144 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
145 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
146 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
147 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
148 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
153 static devclass_t upa_devclass;
155 DEFINE_CLASS_0(upa, upa_driver, upa_methods, sizeof(struct upa_softc));
156 EARLY_DRIVER_MODULE(upa, nexus, upa_driver, upa_devclass, 0, 0, BUS_PASS_BUS);
158 static const struct intr_controller upa_ic = {
162 /* The interrupts are pulse type and thus automatically cleared. */
167 struct upa_softc *uica_sc;
172 upa_probe(device_t dev)
176 compat = ofw_bus_get_compat(dev);
177 if (compat != NULL && strcmp(ofw_bus_get_name(dev), "upa") == 0 &&
178 strcmp(compat, "upa64s") == 0) {
179 device_set_desc(dev, "UPA bridge");
180 return (BUS_PROBE_DEFAULT);
186 upa_attach(device_t dev)
188 struct upa_devinfo *udi;
189 struct upa_icarg *uica;
190 struct upa_softc *sc;
191 phandle_t child, node;
196 device_t *children, schizo;
197 rman_res_t scount, sstart, ucount, ustart;
201 sc = device_get_softc(dev);
202 node = ofw_bus_get_node(dev);
203 for (i = UPA_CFG; i <= UPA_IMR2; i++) {
206 * The UPA_IMR{1,2} resources are shared with that of the
207 * Schizo PCI bus B CSR bank.
210 sc->sc_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
211 &rid, ((i == UPA_IMR1 || i == UPA_IMR2) ? RF_SHAREABLE :
213 if (sc->sc_res[i] == NULL) {
215 "could not allocate resource %d\n", i);
218 sc->sc_bt[i] = rman_get_bustag(sc->sc_res[i]);
219 sc->sc_bh[i] = rman_get_bushandle(sc->sc_res[i]);
222 * Workaround for the fact that rman(9) only allows to
223 * share resources of the same size.
225 if (i == UPA_IMR1 || i == UPA_IMR2) {
226 if (bus_get_resource(dev, SYS_RES_MEMORY, i, &ustart,
229 "could not determine UPA resource\n");
232 if (device_get_children(device_get_parent(dev),
233 &children, &nchildren) != 0) {
234 device_printf(dev, "could not get children\n");
238 for (j = 0; j < nchildren; j++) {
239 if (ofw_bus_get_type(children[j]) != NULL &&
240 strcmp(ofw_bus_get_type(children[j]),
242 ofw_bus_get_compat(children[j]) != NULL &&
243 strcmp(ofw_bus_get_compat(children[j]),
244 "pci108e,8001") == 0 &&
245 ((bus_get_resource_start(children[j],
246 SYS_RES_MEMORY, 0) >> 20) & 1) == 1) {
247 schizo = children[j];
251 free(children, M_TEMP);
252 if (schizo == NULL) {
253 device_printf(dev, "could not find Schizo\n");
256 if (bus_get_resource(schizo, SYS_RES_MEMORY, 0,
257 &sstart, &scount) != 0) {
259 "could not determine Schizo resource\n");
262 sc->sc_res[i] = bus_alloc_resource(dev, SYS_RES_MEMORY,
263 &rid, sstart, sstart + scount - 1, scount,
264 RF_SHAREABLE | RF_ACTIVE);
266 sc->sc_res[i] = bus_alloc_resource_any(dev,
267 SYS_RES_MEMORY, &rid, RF_ACTIVE);
268 if (sc->sc_res[i] == NULL) {
270 "could not allocate resource %d\n", i);
273 sc->sc_bt[i] = rman_get_bustag(sc->sc_res[i]);
274 sc->sc_bh[i] = rman_get_bushandle(sc->sc_res[i]);
275 if (i == UPA_IMR1 || i == UPA_IMR2)
276 bus_space_subregion(sc->sc_bt[i], sc->sc_bh[i],
277 ustart - sstart, ucount, &sc->sc_bh[i]);
281 if (OF_getprop(node, "portid", &sc->sc_ign, sizeof(sc->sc_ign)) == -1) {
282 device_printf(dev, "could not determine IGN\n");
286 sc->sc_nrange = OF_getprop_alloc(node, "ranges", sizeof(*sc->sc_ranges),
287 (void **)&sc->sc_ranges);
288 if (sc->sc_nrange == -1) {
289 device_printf(dev, "could not determine ranges\n");
294 * Hunt through all the interrupt mapping regs and register our
295 * interrupt controller for the corresponding interrupt vectors.
296 * We do this early in order to be able to catch stray interrupts.
298 for (i = UPA_INO_BASE; i <= UPA_INO_MAX; i++) {
300 for (j = UPA_IMR1; j <= UPA_IMR2; j++) {
301 if (INTVEC(UPA_READ(sc, j, 0x0)) ==
302 INTMAP_VEC(sc->sc_ign, i)) {
309 uica = malloc(sizeof(*uica), M_DEVBUF, M_NOWAIT);
311 panic("%s: could not allocate interrupt controller "
312 "argument", __func__);
314 uica->uica_imr = imr;
316 device_printf(dev, "intr map (INO %d) IMR%d: %#lx\n",
317 i, imr, (u_long)UPA_READ(sc, imr, 0x0));
319 j = intr_controller_register(INTMAP_VEC(sc->sc_ign, i),
322 device_printf(dev, "could not register interrupt "
323 "controller for INO %d (%d)\n", i, j);
326 /* Make sure the power level is appropriate for normal operation. */
327 if (UPA_READ(sc, UPA_CFG, UPA_CFG_IF) != UPA_CFG_IF_POK) {
329 device_printf(dev, "applying power\n");
330 UPA_WRITE(sc, UPA_CFG, UPA_CFG_ESTAR, UPA_CFG_ESTAR_SPEED_1_2);
331 UPA_WRITE(sc, UPA_CFG, UPA_CFG_ESTAR, UPA_CFG_ESTAR_SPEED_FULL);
332 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_ESTAR);
333 UPA_WRITE(sc, UPA_CFG, UPA_CFG_IF, UPA_CFG_IF_POK_RST);
334 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_IF);
336 UPA_WRITE(sc, UPA_CFG, UPA_CFG_IF, UPA_CFG_IF_POK);
337 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_IF);
340 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
342 * The `upa-portid' properties of the children are used as
343 * index for the interrupt mapping registers.
344 * The `upa-portid' properties are also used to make up the
345 * INOs of the children as the values contained in their
346 * `interrupts' properties are bogus.
348 if (OF_getprop(child, "upa-portid", &portid,
349 sizeof(portid)) == -1) {
351 "could not determine upa-portid of child 0x%lx\n",
352 (unsigned long)child);
357 "upa-portid %d of child 0x%lx invalid\n", portid,
358 (unsigned long)child);
361 if ((udi = upa_setup_dinfo(dev, sc, child, portid)) == NULL)
363 if ((cdev = device_add_child(dev, NULL, -1)) == NULL) {
364 device_printf(dev, "<%s>: device_add_child failed\n",
365 udi->udi_obdinfo.obd_name);
366 upa_destroy_dinfo(udi);
369 device_set_ivars(cdev, udi);
372 return (bus_generic_attach(dev));
375 for (i = UPA_CFG; i <= UPA_IMR2 && sc->sc_res[i] != NULL; i++)
376 bus_release_resource(dev, SYS_RES_MEMORY,
377 rman_get_rid(sc->sc_res[i]), sc->sc_res[i]);
382 upa_print_child(device_t dev, device_t child)
386 rv = bus_print_child_header(dev, child);
387 rv += upa_print_res(device_get_ivars(child));
388 rv += bus_print_child_footer(dev, child);
393 upa_probe_nomatch(device_t dev, device_t child)
397 device_printf(dev, "<%s>", ofw_bus_get_name(child));
398 upa_print_res(device_get_ivars(child));
399 type = ofw_bus_get_type(child);
400 printf(" type %s (no driver attached)\n",
401 type != NULL ? type : "unknown");
404 static struct resource *
405 upa_alloc_resource(device_t dev, device_t child, int type, int *rid,
406 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
408 struct resource_list *rl;
409 struct resource_list_entry *rle;
410 struct upa_softc *sc;
412 bus_addr_t cend, cstart;
413 int i, isdefault, passthrough;
415 isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
416 passthrough = (device_get_parent(child) != dev);
417 sc = device_get_softc(dev);
418 rl = BUS_GET_RESOURCE_LIST(dev, child);
422 return (resource_list_alloc(rl, dev, child, type, rid, start,
426 rle = resource_list_find(rl, type, *rid);
429 if (rle->res != NULL)
430 panic("%s: resource entry is busy", __func__);
433 count = ulmax(count, rle->count);
434 end = ulmax(rle->end, start + count - 1);
437 for (i = 0; i < sc->sc_nrange; i++) {
438 cstart = sc->sc_ranges[i].child;
439 cend = cstart + sc->sc_ranges[i].size - 1;
440 if (start < cstart || start > cend)
442 if (end < cstart || end > cend)
444 start += sc->sc_ranges[i].parent - cstart;
445 end += sc->sc_ranges[i].parent - cstart;
446 rv = bus_generic_alloc_resource(dev, child, type, rid,
447 start, end, count, flags);
459 upa_intr_enable(void *arg)
461 struct intr_vector *iv = arg;
462 struct upa_icarg *uica = iv->iv_icarg;
464 UPA_WRITE(uica->uica_sc, uica->uica_imr, 0x0,
465 INTMAP_ENABLE(iv->iv_vec, iv->iv_mid));
466 (void)UPA_READ(uica->uica_sc, uica->uica_imr, 0x0);
470 upa_intr_disable(void *arg)
472 struct intr_vector *iv = arg;
473 struct upa_icarg *uica = iv->iv_icarg;
475 UPA_WRITE(uica->uica_sc, uica->uica_imr, 0x0, iv->iv_vec);
476 (void)UPA_READ(uica->uica_sc, uica->uica_imr, 0x0);
480 upa_intr_assign(void *arg)
482 struct intr_vector *iv = arg;
483 struct upa_icarg *uica = iv->iv_icarg;
485 UPA_WRITE(uica->uica_sc, uica->uica_imr, 0x0, INTMAP_TID(
486 UPA_READ(uica->uica_sc, uica->uica_imr, 0x0), iv->iv_mid));
487 (void)UPA_READ(uica->uica_sc, uica->uica_imr, 0x0);
491 upa_setup_intr(device_t dev, device_t child, struct resource *ires, int flags,
492 driver_filter_t *filt, driver_intr_t *func, void *arg, void **cookiep)
494 struct upa_softc *sc;
497 sc = device_get_softc(dev);
499 * Make sure the vector is fully specified and we registered
500 * our interrupt controller for it.
502 vec = rman_get_start(ires);
503 if (INTIGN(vec) != sc->sc_ign || intr_vectors[vec].iv_ic != &upa_ic) {
504 device_printf(dev, "invalid interrupt vector 0x%lx\n", vec);
507 return (bus_generic_setup_intr(dev, child, ires, flags, filt, func,
512 upa_adjust_resource(device_t bus __unused, device_t child __unused,
513 int type __unused, struct resource *r __unused, rman_res_t start __unused,
514 rman_res_t end __unused)
520 static struct resource_list *
521 upa_get_resource_list(device_t dev, device_t child)
523 struct upa_devinfo *udi;
525 udi = device_get_ivars(child);
526 return (&udi->udi_rl);
529 static const struct ofw_bus_devinfo *
530 upa_get_devinfo(device_t dev, device_t child)
532 struct upa_devinfo *udi;
534 udi = device_get_ivars(child);
535 return (&udi->udi_obdinfo);
538 static struct upa_devinfo *
539 upa_setup_dinfo(device_t dev, struct upa_softc *sc, phandle_t node,
542 struct upa_devinfo *udi;
543 struct upa_regs *reg;
547 udi = malloc(sizeof(*udi), M_DEVBUF, M_WAITOK | M_ZERO);
548 if (ofw_bus_gen_setup_devinfo(&udi->udi_obdinfo, node) != 0) {
552 resource_list_init(&udi->udi_rl);
554 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®);
556 device_printf(dev, "<%s>: incomplete\n",
557 udi->udi_obdinfo.obd_name);
560 for (i = 0; i < nreg; i++)
561 resource_list_add(&udi->udi_rl, SYS_RES_MEMORY, i, reg[i].phys,
562 reg[i].phys + reg[i].size - 1, reg[i].size);
565 intr = INTMAP_VEC(sc->sc_ign, (UPA_INO_BASE + portid));
566 resource_list_add(&udi->udi_rl, SYS_RES_IRQ, 0, intr, intr, 1);
571 upa_destroy_dinfo(udi);
576 upa_destroy_dinfo(struct upa_devinfo *dinfo)
579 resource_list_free(&dinfo->udi_rl);
580 ofw_bus_gen_destroy_devinfo(&dinfo->udi_obdinfo);
581 free(dinfo, M_DEVBUF);
585 upa_print_res(struct upa_devinfo *udi)
590 rv += resource_list_print_type(&udi->udi_rl, "mem", SYS_RES_MEMORY,
592 rv += resource_list_print_type(&udi->udi_rl, "irq", SYS_RES_IRQ,