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),
102 /* ofw_bus interface */
103 DEVMETHOD(ofw_bus_get_devinfo, fhc_get_devinfo),
104 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
105 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
106 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
107 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
108 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
113 static driver_t fhc_driver = {
116 sizeof(struct fhc_softc),
119 static devclass_t fhc_devclass;
121 DRIVER_MODULE(fhc, central, fhc_driver, fhc_devclass, 0, 0);
122 DRIVER_MODULE(fhc, nexus, fhc_driver, fhc_devclass, 0, 0);
123 MODULE_DEPEND(fhc, central, 1, 1, 1);
124 MODULE_VERSION(fhc, 1);
126 static const struct intr_controller fhc_ic = {
134 struct fhc_softc *fica_sc;
135 struct resource *fica_memres;
139 fhc_probe(device_t dev)
142 if (strcmp(ofw_bus_get_name(dev), "fhc") == 0) {
143 device_set_desc(dev, "fhc");
150 fhc_attach(device_t dev)
152 char ledname[sizeof("boardXX")];
153 struct fhc_devinfo *fdi;
154 struct fhc_icarg *fica;
155 struct fhc_softc *sc;
156 struct sbus_regs *reg;
170 sc = device_get_softc(dev);
171 node = ofw_bus_get_node(dev);
174 if (strcmp(device_get_name(device_get_parent(dev)), "central") == 0)
177 for (i = 0; i < FHC_NREG; i++) {
179 sc->sc_memres[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
181 if (sc->sc_memres[i] == NULL) {
182 device_printf(dev, "cannot allocate resource %d\n", i);
189 board = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_BSR);
190 board = ((board >> 16) & 0x1) | ((board >> 12) & 0xe);
192 if (OF_getprop(node, "board#", &board, sizeof(board)) == -1) {
193 device_printf(dev, "cannot get board number\n");
199 device_printf(dev, "board %d, ", board);
200 if (OF_getprop_alloc(node, "board-model", 1, (void **)&name) != -1) {
201 printf("model %s\n", name);
202 free(name, M_OFWPROP);
204 printf("model unknown\n");
206 for (i = FHC_FANFAIL; i <= FHC_TOD; i++) {
207 bus_write_4(sc->sc_memres[i], FHC_ICLR, 0x0);
208 (void)bus_read_4(sc->sc_memres[i], FHC_ICLR);
211 sc->sc_ign = board << 1;
212 bus_write_4(sc->sc_memres[FHC_IGN], 0x0, sc->sc_ign);
213 sc->sc_ign = bus_read_4(sc->sc_memres[FHC_IGN], 0x0);
215 ctrl = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
217 ctrl |= FHC_CTRL_IXIST;
218 ctrl &= ~(FHC_CTRL_AOFF | FHC_CTRL_BOFF | FHC_CTRL_SLINE);
219 bus_write_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL, ctrl);
220 (void)bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
222 sc->sc_nrange = OF_getprop_alloc(node, "ranges",
223 sizeof(*sc->sc_ranges), (void **)&sc->sc_ranges);
224 if (sc->sc_nrange == -1) {
225 device_printf(dev, "cannot get ranges\n");
231 * Apparently only the interrupt controller of boards hanging off
232 * of central(4) is indented to be used, otherwise we would have
233 * conflicts registering the interrupt controllers for all FHC
234 * boards as the board number and thus the IGN isn't unique.
238 * Hunt through all the interrupt mapping regs and register
239 * our interrupt controller for the corresponding interrupt
240 * vectors. We do this early in order to be able to catch
243 for (i = FHC_FANFAIL; i <= FHC_TOD; i++) {
244 fica = malloc(sizeof(*fica), M_DEVBUF, M_NOWAIT);
246 panic("%s: could not allocate interrupt "
247 "controller argument", __func__);
249 fica->fica_memres = sc->sc_memres[i];
251 device_printf(dev, "intr map %d: %#lx, clr: %#lx\n", i,
252 (u_long)bus_read_4(fica->fica_memres, FHC_IMAP),
253 (u_long)bus_read_4(fica->fica_memres, FHC_ICLR));
256 * XXX we only pick the INO rather than the INR
257 * from the IMR since the firmware may not provide
258 * the IGN and the IGN is constant for all devices
259 * on that FireHose controller.
261 j = intr_controller_register(INTMAP_VEC(sc->sc_ign,
262 INTINO(bus_read_4(fica->fica_memres, FHC_IMAP))),
265 device_printf(dev, "could not register "
266 "interrupt controller for map %d (%d)\n",
270 snprintf(ledname, sizeof(ledname), "board%d", board);
271 sc->sc_led_dev = led_create(fhc_led_func, sc, ledname);
274 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
275 fdi = malloc(sizeof(*fdi), M_DEVBUF, M_WAITOK | M_ZERO);
276 if (ofw_bus_gen_setup_devinfo(&fdi->fdi_obdinfo, child) != 0) {
280 i = OF_getprop_alloc(child, "reg", sizeof(*reg),
283 device_printf(dev, "<%s>: incomplete\n",
284 fdi->fdi_obdinfo.obd_name);
285 ofw_bus_gen_destroy_devinfo(&fdi->fdi_obdinfo);
289 resource_list_init(&fdi->fdi_rl);
290 for (j = 0; j < i; j++)
291 resource_list_add(&fdi->fdi_rl, SYS_RES_MEMORY, j,
292 reg[j].sbr_offset, reg[j].sbr_offset +
293 reg[j].sbr_size, reg[j].sbr_size);
294 free(reg, M_OFWPROP);
296 i = OF_getprop_alloc(child, "interrupts",
297 sizeof(*intr), (void **)&intr);
299 for (j = 0; j < i; j++) {
300 iv = INTMAP_VEC(sc->sc_ign, intr[j]);
301 resource_list_add(&fdi->fdi_rl,
302 SYS_RES_IRQ, j, iv, iv, 1);
304 free(intr, M_OFWPROP);
307 cdev = device_add_child(dev, NULL, -1);
309 device_printf(dev, "<%s>: device_add_child failed\n",
310 fdi->fdi_obdinfo.obd_name);
311 resource_list_free(&fdi->fdi_rl);
312 ofw_bus_gen_destroy_devinfo(&fdi->fdi_obdinfo);
316 device_set_ivars(cdev, fdi);
319 return (bus_generic_attach(dev));
322 for (i = 0; i < FHC_NREG; i++)
323 if (sc->sc_memres[i] != NULL)
324 bus_release_resource(dev, SYS_RES_MEMORY,
325 rman_get_rid(sc->sc_memres[i]), sc->sc_memres[i]);
330 fhc_print_child(device_t dev, device_t child)
334 rv = bus_print_child_header(dev, child);
335 rv += fhc_print_res(device_get_ivars(child));
336 rv += bus_print_child_footer(dev, child);
341 fhc_probe_nomatch(device_t dev, device_t child)
345 device_printf(dev, "<%s>", ofw_bus_get_name(child));
346 fhc_print_res(device_get_ivars(child));
347 type = ofw_bus_get_type(child);
348 printf(" type %s (no driver attached)\n",
349 type != NULL ? type : "unknown");
353 fhc_intr_enable(void *arg)
355 struct intr_vector *iv = arg;
356 struct fhc_icarg *fica = iv->iv_icarg;
358 bus_write_4(fica->fica_memres, FHC_IMAP,
359 INTMAP_ENABLE(iv->iv_vec, iv->iv_mid));
360 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
364 fhc_intr_disable(void *arg)
366 struct intr_vector *iv = arg;
367 struct fhc_icarg *fica = iv->iv_icarg;
369 bus_write_4(fica->fica_memres, FHC_IMAP, iv->iv_vec);
370 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
374 fhc_intr_assign(void *arg)
376 struct intr_vector *iv = arg;
377 struct fhc_icarg *fica = iv->iv_icarg;
379 bus_write_4(fica->fica_memres, FHC_IMAP, INTMAP_TID(
380 bus_read_4(fica->fica_memres, FHC_IMAP), iv->iv_mid));
381 (void)bus_read_4(fica->fica_memres, FHC_IMAP);
385 fhc_intr_clear(void *arg)
387 struct intr_vector *iv = arg;
388 struct fhc_icarg *fica = iv->iv_icarg;
390 bus_write_4(fica->fica_memres, FHC_ICLR, 0x0);
391 (void)bus_read_4(fica->fica_memres, FHC_ICLR);
395 fhc_setup_intr(device_t bus, device_t child, struct resource *r, int flags,
396 driver_filter_t *filt, driver_intr_t *func, void *arg, void **cookiep)
398 struct fhc_softc *sc;
401 sc = device_get_softc(bus);
403 * Make sure the vector is fully specified and we registered
404 * our interrupt controller for it.
406 vec = rman_get_start(r);
407 if (INTIGN(vec) != sc->sc_ign || intr_vectors[vec].iv_ic != &fhc_ic) {
408 device_printf(bus, "invalid interrupt vector 0x%lx\n", vec);
411 return (bus_generic_setup_intr(bus, child, r, flags, filt, func,
415 static struct resource *
416 fhc_alloc_resource(device_t bus, device_t child, int type, int *rid,
417 u_long start, u_long end, u_long count, u_int flags)
419 struct resource_list *rl;
420 struct resource_list_entry *rle;
421 struct fhc_softc *sc;
422 struct resource *res;
430 isdefault = (start == 0UL && end == ~0UL);
431 passthrough = (device_get_parent(child) != bus);
434 rl = BUS_GET_RESOURCE_LIST(bus, child);
435 sc = device_get_softc(bus);
438 return (resource_list_alloc(rl, bus, child, type, rid, start,
442 rle = resource_list_find(rl, type, *rid);
445 if (rle->res != NULL)
446 panic("%s: resource entry is busy", __func__);
449 count = ulmax(count, rle->count);
450 end = ulmax(rle->end, start + count - 1);
453 for (i = 0; i < sc->sc_nrange; i++) {
454 coffset = sc->sc_ranges[i].coffset;
455 cend = coffset + sc->sc_ranges[i].size - 1;
456 if (start >= coffset && end <= cend) {
459 phys = sc->sc_ranges[i].poffset |
460 ((bus_addr_t)sc->sc_ranges[i].pspace << 32);
461 res = bus_generic_alloc_resource(bus, child,
462 type, rid, phys + start, phys + end,
474 static struct resource_list *
475 fhc_get_resource_list(device_t bus, device_t child)
477 struct fhc_devinfo *fdi;
479 fdi = device_get_ivars(child);
480 return (&fdi->fdi_rl);
483 static const struct ofw_bus_devinfo *
484 fhc_get_devinfo(device_t bus, device_t child)
486 struct fhc_devinfo *fdi;
488 fdi = device_get_ivars(child);
489 return (&fdi->fdi_obdinfo);
493 fhc_led_func(void *arg, int onoff)
495 struct fhc_softc *sc;
498 sc = (struct fhc_softc *)arg;
500 ctrl = bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
502 ctrl |= FHC_CTRL_RLED;
504 ctrl &= ~FHC_CTRL_RLED;
505 ctrl &= ~(FHC_CTRL_AOFF | FHC_CTRL_BOFF | FHC_CTRL_SLINE);
506 bus_write_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL, ctrl);
507 (void)bus_read_4(sc->sc_memres[FHC_INTERNAL], FHC_CTRL);
511 fhc_print_res(struct fhc_devinfo *fdi)
516 rv += resource_list_print_type(&fdi->fdi_rl, "mem", SYS_RES_MEMORY,
518 rv += resource_list_print_type(&fdi->fdi_rl, "irq", SYS_RES_IRQ, "%ld");