2 * Copyright (c) 2003 Jake Burkholder.
3 * Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
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 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
39 #include <dev/led/led.h>
40 #include <dev/ofw/ofw_bus.h>
41 #include <dev/ofw/ofw_bus_subr.h>
42 #include <dev/ofw/openfirm.h>
44 #include <machine/bus.h>
45 #include <machine/bus_common.h>
46 #include <machine/resource.h>
50 #include <sparc64/fhc/fhcreg.h>
51 #include <sparc64/sbus/ofw_sbus.h>
54 struct ofw_bus_devinfo fdi_obdinfo;
55 struct resource_list fdi_rl;
59 struct resource *sc_memres[FHC_NREG];
61 struct sbus_ranges *sc_ranges;
63 struct cdev *sc_led_dev;
66 static device_probe_t fhc_probe;
67 static device_attach_t fhc_attach;
68 static bus_print_child_t fhc_print_child;
69 static bus_probe_nomatch_t fhc_probe_nomatch;
70 static bus_setup_intr_t fhc_setup_intr;
71 static bus_alloc_resource_t fhc_alloc_resource;
72 static bus_get_resource_list_t fhc_get_resource_list;
73 static ofw_bus_get_devinfo_t fhc_get_devinfo;
75 static void fhc_intr_enable(void *);
76 static void fhc_intr_disable(void *);
77 static void fhc_intr_assign(void *);
78 static void fhc_intr_clear(void *);
79 static void fhc_led_func(void *, int);
80 static int fhc_print_res(struct fhc_devinfo *);
82 static device_method_t fhc_methods[] = {
83 /* Device interface */
84 DEVMETHOD(device_probe, fhc_probe),
85 DEVMETHOD(device_attach, fhc_attach),
86 DEVMETHOD(device_shutdown, bus_generic_shutdown),
87 DEVMETHOD(device_suspend, bus_generic_suspend),
88 DEVMETHOD(device_resume, bus_generic_resume),
91 DEVMETHOD(bus_print_child, fhc_print_child),
92 DEVMETHOD(bus_probe_nomatch, fhc_probe_nomatch),
93 DEVMETHOD(bus_alloc_resource, fhc_alloc_resource),
94 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
95 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
96 DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource),
97 DEVMETHOD(bus_setup_intr, fhc_setup_intr),
98 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
99 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
100 DEVMETHOD(bus_get_resource_list, fhc_get_resource_list),
101 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
103 /* ofw_bus interface */
104 DEVMETHOD(ofw_bus_get_devinfo, fhc_get_devinfo),
105 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
106 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
107 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
108 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
109 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
114 static driver_t fhc_driver = {
117 sizeof(struct fhc_softc),
120 static devclass_t fhc_devclass;
122 DRIVER_MODULE(fhc, central, fhc_driver, fhc_devclass, 0, 0);
123 DRIVER_MODULE(fhc, nexus, fhc_driver, fhc_devclass, 0, 0);
124 MODULE_DEPEND(fhc, central, 1, 1, 1);
125 MODULE_VERSION(fhc, 1);
127 static const struct intr_controller fhc_ic = {
135 struct fhc_softc *fica_sc;
136 struct resource *fica_memres;
140 fhc_probe(device_t dev)
143 if (strcmp(ofw_bus_get_name(dev), "fhc") == 0) {
144 device_set_desc(dev, "fhc");
151 fhc_attach(device_t dev)
153 char ledname[sizeof("boardXX")];
154 struct fhc_devinfo *fdi;
155 struct fhc_icarg *fica;
156 struct fhc_softc *sc;
157 struct sbus_regs *reg;
171 sc = device_get_softc(dev);
172 node = ofw_bus_get_node(dev);
175 if (strcmp(device_get_name(device_get_parent(dev)), "central") == 0)
178 for (i = 0; i < FHC_NREG; i++) {
180 sc->sc_memres[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
182 if (sc->sc_memres[i] == NULL) {
183 device_printf(dev, "cannot allocate resource %d\n", i);
190 board = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_BSR);
191 board = ((board >> 16) & 0x1) | ((board >> 12) & 0xe);
193 if (OF_getprop(node, "board#", &board, sizeof(board)) == -1) {
194 device_printf(dev, "cannot get board number\n");
200 device_printf(dev, "board %d, ", board);
201 if (OF_getprop_alloc(node, "board-model", 1, (void **)&name) != -1) {
202 printf("model %s\n", name);
203 free(name, M_OFWPROP);
205 printf("model unknown\n");
207 for (i = FHC_FANFAIL; i <= FHC_TOD; i++) {
208 bus_write_4(sc->sc_memres[i], FHC_ICLR, 0x0);
209 (void)bus_read_4(sc->sc_memres[i], FHC_ICLR);
212 sc->sc_ign = board << 1;
213 bus_write_4(sc->sc_memres[FHC_IGN], 0x0, sc->sc_ign);
214 sc->sc_ign = bus_read_4(sc->sc_memres[FHC_IGN], 0x0);
216 ctrl = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
218 ctrl |= FHC_CTRL_IXIST;
219 ctrl &= ~(FHC_CTRL_AOFF | FHC_CTRL_BOFF | FHC_CTRL_SLINE);
220 bus_write_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL, ctrl);
221 (void)bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
223 sc->sc_nrange = OF_getprop_alloc(node, "ranges",
224 sizeof(*sc->sc_ranges), (void **)&sc->sc_ranges);
225 if (sc->sc_nrange == -1) {
226 device_printf(dev, "cannot get ranges\n");
232 * Apparently only the interrupt controller of boards hanging off
233 * of central(4) is indented to be used, otherwise we would have
234 * conflicts registering the interrupt controllers for all FHC
235 * boards as the board number and thus the IGN isn't unique.
239 * Hunt through all the interrupt mapping regs and register
240 * our interrupt controller for the corresponding interrupt
241 * vectors. We do this early in order to be able to catch
244 for (i = FHC_FANFAIL; i <= FHC_TOD; i++) {
245 fica = malloc(sizeof(*fica), M_DEVBUF, M_NOWAIT);
247 panic("%s: could not allocate interrupt "
248 "controller argument", __func__);
250 fica->fica_memres = sc->sc_memres[i];
252 device_printf(dev, "intr map %d: %#lx, clr: %#lx\n", i,
253 (u_long)bus_read_4(fica->fica_memres, FHC_IMAP),
254 (u_long)bus_read_4(fica->fica_memres, FHC_ICLR));
257 * XXX we only pick the INO rather than the INR
258 * from the IMR since the firmware may not provide
259 * the IGN and the IGN is constant for all devices
260 * on that FireHose controller.
262 j = intr_controller_register(INTMAP_VEC(sc->sc_ign,
263 INTINO(bus_read_4(fica->fica_memres, FHC_IMAP))),
266 device_printf(dev, "could not register "
267 "interrupt controller for map %d (%d)\n",
271 snprintf(ledname, sizeof(ledname), "board%d", board);
272 sc->sc_led_dev = led_create(fhc_led_func, sc, ledname);
275 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
276 fdi = malloc(sizeof(*fdi), M_DEVBUF, M_WAITOK | M_ZERO);
277 if (ofw_bus_gen_setup_devinfo(&fdi->fdi_obdinfo, child) != 0) {
281 i = OF_getprop_alloc(child, "reg", sizeof(*reg),
284 device_printf(dev, "<%s>: incomplete\n",
285 fdi->fdi_obdinfo.obd_name);
286 ofw_bus_gen_destroy_devinfo(&fdi->fdi_obdinfo);
290 resource_list_init(&fdi->fdi_rl);
291 for (j = 0; j < i; j++)
292 resource_list_add(&fdi->fdi_rl, SYS_RES_MEMORY, j,
293 reg[j].sbr_offset, reg[j].sbr_offset +
294 reg[j].sbr_size, reg[j].sbr_size);
295 free(reg, M_OFWPROP);
297 i = OF_getprop_alloc(child, "interrupts",
298 sizeof(*intr), (void **)&intr);
300 for (j = 0; j < i; j++) {
301 iv = INTMAP_VEC(sc->sc_ign, intr[j]);
302 resource_list_add(&fdi->fdi_rl,
303 SYS_RES_IRQ, j, iv, iv, 1);
305 free(intr, M_OFWPROP);
308 cdev = device_add_child(dev, NULL, -1);
310 device_printf(dev, "<%s>: device_add_child failed\n",
311 fdi->fdi_obdinfo.obd_name);
312 resource_list_free(&fdi->fdi_rl);
313 ofw_bus_gen_destroy_devinfo(&fdi->fdi_obdinfo);
317 device_set_ivars(cdev, fdi);
320 return (bus_generic_attach(dev));
323 for (i = 0; i < FHC_NREG; i++)
324 if (sc->sc_memres[i] != NULL)
325 bus_release_resource(dev, SYS_RES_MEMORY,
326 rman_get_rid(sc->sc_memres[i]), sc->sc_memres[i]);
331 fhc_print_child(device_t dev, device_t child)
335 rv = bus_print_child_header(dev, child);
336 rv += fhc_print_res(device_get_ivars(child));
337 rv += bus_print_child_footer(dev, child);
342 fhc_probe_nomatch(device_t dev, device_t child)
346 device_printf(dev, "<%s>", ofw_bus_get_name(child));
347 fhc_print_res(device_get_ivars(child));
348 type = ofw_bus_get_type(child);
349 printf(" type %s (no driver attached)\n",
350 type != NULL ? type : "unknown");
354 fhc_intr_enable(void *arg)
356 struct intr_vector *iv = arg;
357 struct fhc_icarg *fica = iv->iv_icarg;
359 bus_write_4(fica->fica_memres, FHC_IMAP,
360 INTMAP_ENABLE(iv->iv_vec, iv->iv_mid));
361 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
365 fhc_intr_disable(void *arg)
367 struct intr_vector *iv = arg;
368 struct fhc_icarg *fica = iv->iv_icarg;
370 bus_write_4(fica->fica_memres, FHC_IMAP, iv->iv_vec);
371 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
375 fhc_intr_assign(void *arg)
377 struct intr_vector *iv = arg;
378 struct fhc_icarg *fica = iv->iv_icarg;
380 bus_write_4(fica->fica_memres, FHC_IMAP, INTMAP_TID(
381 bus_read_4(fica->fica_memres, FHC_IMAP), iv->iv_mid));
382 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
386 fhc_intr_clear(void *arg)
388 struct intr_vector *iv = arg;
389 struct fhc_icarg *fica = iv->iv_icarg;
391 bus_write_4(fica->fica_memres, FHC_ICLR, 0x0);
392 (void)bus_read_4(fica->fica_memres, FHC_ICLR);
396 fhc_setup_intr(device_t bus, device_t child, struct resource *r, int flags,
397 driver_filter_t *filt, driver_intr_t *func, void *arg, void **cookiep)
399 struct fhc_softc *sc;
402 sc = device_get_softc(bus);
404 * Make sure the vector is fully specified and we registered
405 * our interrupt controller for it.
407 vec = rman_get_start(r);
408 if (INTIGN(vec) != sc->sc_ign || intr_vectors[vec].iv_ic != &fhc_ic) {
409 device_printf(bus, "invalid interrupt vector 0x%lx\n", vec);
412 return (bus_generic_setup_intr(bus, child, r, flags, filt, func,
416 static struct resource *
417 fhc_alloc_resource(device_t bus, device_t child, int type, int *rid,
418 u_long start, u_long end, u_long count, u_int flags)
420 struct resource_list *rl;
421 struct resource_list_entry *rle;
422 struct fhc_softc *sc;
423 struct resource *res;
431 isdefault = (start == 0UL && end == ~0UL);
432 passthrough = (device_get_parent(child) != bus);
435 rl = BUS_GET_RESOURCE_LIST(bus, child);
436 sc = device_get_softc(bus);
439 return (resource_list_alloc(rl, bus, child, type, rid, start,
443 rle = resource_list_find(rl, type, *rid);
446 if (rle->res != NULL)
447 panic("%s: resource entry is busy", __func__);
450 count = ulmax(count, rle->count);
451 end = ulmax(rle->end, start + count - 1);
454 for (i = 0; i < sc->sc_nrange; i++) {
455 coffset = sc->sc_ranges[i].coffset;
456 cend = coffset + sc->sc_ranges[i].size - 1;
457 if (start >= coffset && end <= cend) {
460 phys = sc->sc_ranges[i].poffset |
461 ((bus_addr_t)sc->sc_ranges[i].pspace << 32);
462 res = bus_generic_alloc_resource(bus, child,
463 type, rid, phys + start, phys + end,
475 static struct resource_list *
476 fhc_get_resource_list(device_t bus, device_t child)
478 struct fhc_devinfo *fdi;
480 fdi = device_get_ivars(child);
481 return (&fdi->fdi_rl);
484 static const struct ofw_bus_devinfo *
485 fhc_get_devinfo(device_t bus, device_t child)
487 struct fhc_devinfo *fdi;
489 fdi = device_get_ivars(child);
490 return (&fdi->fdi_obdinfo);
494 fhc_led_func(void *arg, int onoff)
496 struct fhc_softc *sc;
499 sc = (struct fhc_softc *)arg;
501 ctrl = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
503 ctrl |= FHC_CTRL_RLED;
505 ctrl &= ~FHC_CTRL_RLED;
506 ctrl &= ~(FHC_CTRL_AOFF | FHC_CTRL_BOFF | FHC_CTRL_SLINE);
507 bus_write_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL, ctrl);
508 (void)bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
512 fhc_print_res(struct fhc_devinfo *fdi)
517 rv += resource_list_print_type(&fdi->fdi_rl, "mem", SYS_RES_MEMORY,
519 rv += resource_list_print_type(&fdi->fdi_rl, "irq", SYS_RES_IRQ, "%ld");