2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2006-2008, Juniper Networks, Inc.
5 * Copyright (c) 2008 Semihalf, Rafal Czubak
6 * Copyright (c) 2009 The FreeBSD Foundation
9 * Portions of this software were developed by Semihalf
10 * under sponsorship from the FreeBSD Foundation.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include "opt_platform.h"
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
49 #include <machine/bus.h>
54 #include <dev/fdt/fdt_common.h>
55 #include <dev/ofw/ofw_bus.h>
56 #include <dev/ofw/ofw_bus_subr.h>
58 #include <powerpc/mpc85xx/mpc85xx.h>
60 #include "ofw_bus_if.h"
64 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \
65 printf(fmt,##args); } while (0)
67 #define debugf(fmt, args...)
70 static MALLOC_DEFINE(M_LBC, "localbus", "localbus devices information");
72 static int lbc_probe(device_t);
73 static int lbc_attach(device_t);
74 static int lbc_shutdown(device_t);
75 static int lbc_activate_resource(device_t bus __unused, device_t child __unused,
76 int type, int rid __unused, struct resource *r);
77 static int lbc_deactivate_resource(device_t bus __unused,
78 device_t child __unused, int type __unused, int rid __unused,
80 static struct resource *lbc_alloc_resource(device_t, device_t, int, int *,
81 rman_res_t, rman_res_t, rman_res_t, u_int);
82 static int lbc_print_child(device_t, device_t);
83 static int lbc_release_resource(device_t, device_t, int, int,
85 static const struct ofw_bus_devinfo *lbc_get_devinfo(device_t, device_t);
88 * Bus interface definition
90 static device_method_t lbc_methods[] = {
91 /* Device interface */
92 DEVMETHOD(device_probe, lbc_probe),
93 DEVMETHOD(device_attach, lbc_attach),
94 DEVMETHOD(device_shutdown, lbc_shutdown),
97 DEVMETHOD(bus_print_child, lbc_print_child),
98 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
99 DEVMETHOD(bus_teardown_intr, NULL),
101 DEVMETHOD(bus_alloc_resource, lbc_alloc_resource),
102 DEVMETHOD(bus_release_resource, lbc_release_resource),
103 DEVMETHOD(bus_activate_resource, lbc_activate_resource),
104 DEVMETHOD(bus_deactivate_resource, lbc_deactivate_resource),
106 /* OFW bus interface */
107 DEVMETHOD(ofw_bus_get_devinfo, lbc_get_devinfo),
108 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
109 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
110 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
111 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
112 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
116 static driver_t lbc_driver = {
119 sizeof(struct lbc_softc)
122 devclass_t lbc_devclass;
124 EARLY_DRIVER_MODULE(lbc, ofwbus, lbc_driver, lbc_devclass,
128 * Calculate address mask used by OR(n) registers. Use memory region size to
129 * determine mask value. The size must be a power of two and within the range
130 * of 32KB - 4GB. Otherwise error code is returned. Value representing
131 * 4GB size can be passed as 0xffffffff.
134 lbc_address_mask(uint32_t size)
142 if (size == (1U << n))
150 return (0xffff8000 << (n - 15));
154 lbc_banks_unmap(struct lbc_softc *sc)
159 while (r < LBC_DEV_MAX) {
160 if (sc->sc_range[r].size == 0)
163 pmap_unmapdev(sc->sc_range[r].kva, sc->sc_range[r].size);
164 law_disable(OCP85XX_TGTIF_LBC, sc->sc_range[r].addr,
165 sc->sc_range[r].size);
171 lbc_banks_map(struct lbc_softc *sc)
173 vm_paddr_t end, start;
175 u_int i, r, ranges, s;
178 bzero(sc->sc_range, sizeof(sc->sc_range));
181 * Determine number of discontiguous address ranges to program.
184 for (i = 0; i < LBC_DEV_MAX; i++) {
185 size = sc->sc_banks[i].size;
189 start = sc->sc_banks[i].addr;
190 for (r = 0; r < ranges; r++) {
191 /* Avoid wrap-around bugs. */
192 end = sc->sc_range[r].addr - 1 + sc->sc_range[r].size;
193 if (start > 0 && end == start - 1) {
194 sc->sc_range[r].size += size;
197 /* Avoid wrap-around bugs. */
198 end = start - 1 + size;
199 if (sc->sc_range[r].addr > 0 &&
200 end == sc->sc_range[r].addr - 1) {
201 sc->sc_range[r].addr = start;
202 sc->sc_range[r].size += size;
207 /* New range; add using insertion sort */
209 while (r < ranges && sc->sc_range[r].addr < start)
211 for (s = ranges; s > r; s--)
212 sc->sc_range[s] = sc->sc_range[s-1];
213 sc->sc_range[r].addr = start;
214 sc->sc_range[r].size = size;
220 * Ranges are sorted so quickly go over the list to merge ranges
221 * that grew toward each other while building the ranges.
224 while (r < ranges - 1) {
225 end = sc->sc_range[r].addr + sc->sc_range[r].size;
226 if (end != sc->sc_range[r+1].addr) {
230 sc->sc_range[r].size += sc->sc_range[r+1].size;
231 for (s = r + 1; s < ranges - 1; s++)
232 sc->sc_range[s] = sc->sc_range[s+1];
233 bzero(&sc->sc_range[s], sizeof(sc->sc_range[s]));
238 * Configure LAW for the LBC ranges and map the physical memory
241 for (r = 0; r < ranges; r++) {
242 start = sc->sc_range[r].addr;
243 size = sc->sc_range[r].size;
244 error = law_enable(OCP85XX_TGTIF_LBC, start, size);
247 sc->sc_range[r].kva = (vm_offset_t)pmap_mapdev(start, size);
250 /* XXX: need something better here? */
254 /* Assign KVA to banks based on the enclosing range. */
255 for (i = 0; i < LBC_DEV_MAX; i++) {
256 size = sc->sc_banks[i].size;
260 start = sc->sc_banks[i].addr;
261 for (r = 0; r < ranges; r++) {
262 end = sc->sc_range[r].addr - 1 + sc->sc_range[r].size;
263 if (start >= sc->sc_range[r].addr &&
264 start - 1 + size <= end)
268 sc->sc_banks[i].kva = sc->sc_range[r].kva +
269 (start - sc->sc_range[r].addr);
277 lbc_banks_enable(struct lbc_softc *sc)
283 for (i = 0; i < LBC_DEV_MAX; i++) {
284 size = sc->sc_banks[i].size;
289 * Compute and program BR value.
291 regval = sc->sc_banks[i].addr;
292 switch (sc->sc_banks[i].width) {
306 regval |= (sc->sc_banks[i].decc << 9);
307 regval |= (sc->sc_banks[i].wp << 8);
308 regval |= (sc->sc_banks[i].msel << 5);
309 regval |= (sc->sc_banks[i].atom << 2);
311 bus_space_write_4(sc->sc_bst, sc->sc_bsh,
312 LBC85XX_BR(i), regval);
315 * Compute and program OR value.
317 regval = lbc_address_mask(size);
318 switch (sc->sc_banks[i].msel) {
319 case LBCRES_MSEL_GPCM:
320 /* TODO Add flag support for option registers */
323 case LBCRES_MSEL_FCM:
324 /* TODO Add flag support for options register */
327 case LBCRES_MSEL_UPMA:
328 case LBCRES_MSEL_UPMB:
329 case LBCRES_MSEL_UPMC:
330 printf("UPM mode not supported yet!");
334 bus_space_write_4(sc->sc_bst, sc->sc_bsh,
335 LBC85XX_OR(i), regval);
346 fdt_lbc_fixup(phandle_t node, struct lbc_softc *sc, struct lbc_devinfo *di)
351 if (OF_getprop(node, "bank-width", (void *)&width, sizeof(width)) <= 0)
355 if (sc->sc_banks[bank].size == 0)
358 /* Express width in bits. */
359 sc->sc_banks[bank].width = width * 8;
363 fdt_lbc_reg_decode(phandle_t node, struct lbc_softc *sc,
364 struct lbc_devinfo *di)
366 rman_res_t start, end, count;
367 pcell_t *reg, *regptr;
368 pcell_t addr_cells, size_cells;
369 int tuple_size, tuples;
372 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells) != 0)
375 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
376 tuples = OF_getencprop_alloc_multi(node, "reg", tuple_size,
378 debugf("addr_cells = %d, size_cells = %d\n", addr_cells, size_cells);
379 debugf("tuples = %d, tuple size = %d\n", tuples, tuple_size);
381 /* No 'reg' property in this node. */
385 for (i = 0; i < tuples; i++) {
386 bank = fdt_data_get((void *)reg, 1);
390 /* Get address/size. */
392 for (j = 0; j < addr_cells - 1; j++) {
396 for (j = 0; j < size_cells; j++) {
398 count |= reg[addr_cells + j - 1];
400 reg += addr_cells - 1 + size_cells;
402 /* Calculate address range relative to VA base. */
403 start = sc->sc_banks[bank].kva + start;
404 end = start + count - 1;
406 debugf("reg addr bank = %d, start = %jx, end = %jx, "
407 "count = %jx\n", bank, start, end, count);
409 /* Use bank (CS) cell as rid. */
410 resource_list_add(&di->di_res, SYS_RES_MEMORY, bank, start,
414 OF_prop_free(regptr);
421 struct lbc_softc *sc = arg;
424 ltesr = bus_space_read_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LTESR);
425 sc->sc_ltesr = ltesr;
426 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LTESR, ltesr);
431 lbc_probe(device_t dev)
434 if (!(ofw_bus_is_compatible(dev, "fsl,lbc") ||
435 ofw_bus_is_compatible(dev, "fsl,elbc")))
438 device_set_desc(dev, "Freescale Local Bus Controller");
439 return (BUS_PROBE_DEFAULT);
443 lbc_attach(device_t dev)
445 struct lbc_softc *sc;
446 struct lbc_devinfo *di;
448 uintmax_t offset, size;
451 phandle_t node, child;
452 pcell_t *ranges, *rangesptr;
453 int tuple_size, tuples;
455 int bank, error, i, j;
457 sc = device_get_softc(dev);
461 sc->sc_mres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_mrid,
463 if (sc->sc_mres == NULL)
466 sc->sc_bst = rman_get_bustag(sc->sc_mres);
467 sc->sc_bsh = rman_get_bushandle(sc->sc_mres);
469 for (bank = 0; bank < LBC_DEV_MAX; bank++) {
470 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_BR(bank), 0);
471 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_OR(bank), 0);
475 * Initialize configuration register:
477 * - set data buffer control signal function
478 * - disable parity byte select
479 * - set ECC parity type
480 * - set bus monitor timing and timer prescale
482 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LBCR, 0);
485 * Initialize clock ratio register:
486 * - disable PLL bypass mode
487 * - configure LCLK delay cycles for the assertion of LALE
488 * - set system clock divider
490 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LCRR, 0x00030008);
492 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LTEDR, 0);
493 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LTESR, ~0);
494 bus_space_write_4(sc->sc_bst, sc->sc_bsh, LBC85XX_LTEIR, 0x64080001);
497 sc->sc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->sc_irid,
498 RF_ACTIVE | RF_SHAREABLE);
499 if (sc->sc_ires != NULL) {
500 error = bus_setup_intr(dev, sc->sc_ires,
501 INTR_TYPE_MISC | INTR_MPSAFE, NULL, lbc_intr, sc,
504 device_printf(dev, "could not activate interrupt\n");
505 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irid,
516 rm->rm_type = RMAN_ARRAY;
517 rm->rm_descr = "Local Bus Space";
518 error = rman_init(rm);
522 error = rman_manage_region(rm, rm->rm_start, rm->rm_end);
529 * Process 'ranges' property.
531 node = ofw_bus_get_node(dev);
532 if ((fdt_addrsize_cells(node, &sc->sc_addr_cells,
533 &sc->sc_size_cells)) != 0) {
538 par_addr_cells = fdt_parent_addr_cells(node);
539 if (par_addr_cells > 2) {
540 device_printf(dev, "unsupported parent #addr-cells\n");
544 tuple_size = sizeof(pcell_t) * (sc->sc_addr_cells + par_addr_cells +
547 tuples = OF_getencprop_alloc_multi(node, "ranges", tuple_size,
550 device_printf(dev, "could not retrieve 'ranges' property\n");
556 debugf("par addr_cells = %d, addr_cells = %d, size_cells = %d, "
557 "tuple_size = %d, tuples = %d\n", par_addr_cells,
558 sc->sc_addr_cells, sc->sc_size_cells, tuple_size, tuples);
562 for (i = 0; i < tuples; i++) {
563 /* The first cell is the bank (chip select) number. */
564 bank = fdt_data_get(ranges, 1);
565 if (bank < 0 || bank > LBC_DEV_MAX) {
566 device_printf(dev, "bank out of range: %d\n", bank);
573 * Remaining cells of the child address define offset into
577 for (j = 0; j < sc->sc_addr_cells - 1; j++) {
578 offset <<= sizeof(pcell_t) * 8;
583 /* Parent bus start address of this bank. */
585 for (j = 0; j < par_addr_cells; j++) {
586 start <<= sizeof(pcell_t) * 8;
591 size = fdt_data_get((void *)ranges, sc->sc_size_cells);
592 ranges += sc->sc_size_cells;
593 debugf("bank = %d, start = %jx, size = %jx\n", bank,
594 (uintmax_t)start, size);
596 sc->sc_banks[bank].addr = start + offset;
597 sc->sc_banks[bank].size = size;
600 * Attributes for the bank.
602 * XXX Note there are no DT bindings defined for them at the
603 * moment, so we need to provide some defaults.
605 sc->sc_banks[bank].width = 16;
606 sc->sc_banks[bank].msel = LBCRES_MSEL_GPCM;
607 sc->sc_banks[bank].decc = LBCRES_DECC_DISABLED;
608 sc->sc_banks[bank].atom = LBCRES_ATOM_DISABLED;
609 sc->sc_banks[bank].wp = 0;
613 * Initialize mem-mappings for the LBC banks (i.e. chip selects).
615 error = lbc_banks_map(sc);
620 * Walk the localbus and add direct subordinates as our children.
622 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
623 di = malloc(sizeof(*di), M_LBC, M_WAITOK | M_ZERO);
625 if (ofw_bus_gen_setup_devinfo(&di->di_ofw, child) != 0) {
627 device_printf(dev, "could not set up devinfo\n");
631 resource_list_init(&di->di_res);
633 if (fdt_lbc_reg_decode(child, sc, di)) {
634 device_printf(dev, "could not process 'reg' "
636 ofw_bus_gen_destroy_devinfo(&di->di_ofw);
641 fdt_lbc_fixup(child, sc, di);
643 /* Add newbus device for this FDT node */
644 cdev = device_add_child(dev, NULL, -1);
646 device_printf(dev, "could not add child: %s\n",
647 di->di_ofw.obd_name);
648 resource_list_free(&di->di_res);
649 ofw_bus_gen_destroy_devinfo(&di->di_ofw);
653 debugf("added child name='%s', node=%x\n", di->di_ofw.obd_name,
655 device_set_ivars(cdev, di);
661 lbc_banks_enable(sc);
663 OF_prop_free(rangesptr);
664 return (bus_generic_attach(dev));
667 OF_prop_free(rangesptr);
668 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_mrid, sc->sc_mres);
673 lbc_shutdown(device_t dev)
680 static struct resource *
681 lbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
682 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
684 struct lbc_softc *sc;
685 struct lbc_devinfo *di;
686 struct resource_list_entry *rle;
687 struct resource *res;
691 /* We only support default allocations. */
692 if (!RMAN_IS_DEFAULT_RANGE(start, end))
695 sc = device_get_softc(bus);
696 if (type == SYS_RES_IRQ)
697 return (bus_alloc_resource(bus, type, rid, start, end, count,
701 * Request for the default allocation with a given rid: use resource
702 * list stored in the local device info.
704 if ((di = device_get_ivars(child)) == NULL)
707 if (type == SYS_RES_IOPORT)
708 type = SYS_RES_MEMORY;
712 rle = resource_list_find(&di->di_res, type, *rid);
714 device_printf(bus, "no default resources for "
715 "rid = %d, type = %d\n", *rid, type);
720 end = start + count - 1;
722 sc = device_get_softc(bus);
724 needactivate = flags & RF_ACTIVE;
729 res = rman_reserve_resource(rm, start, end, count, flags, child);
731 device_printf(bus, "failed to reserve resource %#jx - %#jx "
732 "(%#jx)\n", start, end, count);
736 rman_set_rid(res, *rid);
737 rman_set_bustag(res, &bs_be_tag);
738 rman_set_bushandle(res, rman_get_start(res));
741 if (bus_activate_resource(child, type, *rid, res)) {
742 device_printf(child, "resource activation failed\n");
743 rman_release_resource(res);
751 lbc_print_child(device_t dev, device_t child)
753 struct lbc_devinfo *di;
754 struct resource_list *rl;
757 di = device_get_ivars(child);
761 rv += bus_print_child_header(dev, child);
762 rv += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#jx");
763 rv += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
764 rv += bus_print_child_footer(dev, child);
770 lbc_release_resource(device_t dev, device_t child, int type, int rid,
771 struct resource *res)
775 if (rman_get_flags(res) & RF_ACTIVE) {
776 err = bus_deactivate_resource(child, type, rid, res);
781 return (rman_release_resource(res));
785 lbc_activate_resource(device_t bus __unused, device_t child __unused,
786 int type __unused, int rid __unused, struct resource *r)
789 /* Child resources were already mapped, just activate. */
790 return (rman_activate_resource(r));
794 lbc_deactivate_resource(device_t bus __unused, device_t child __unused,
795 int type __unused, int rid __unused, struct resource *r)
798 return (rman_deactivate_resource(r));
801 static const struct ofw_bus_devinfo *
802 lbc_get_devinfo(device_t bus, device_t child)
804 struct lbc_devinfo *di;
806 di = device_get_ivars(child);
807 return (&di->di_ofw);
811 lbc_write_reg(device_t child, u_int off, uint32_t val)
814 struct lbc_softc *sc;
816 dev = device_get_parent(child);
819 device_printf(dev, "%s(%s): invalid offset %#x\n",
820 __func__, device_get_nameunit(child), off);
824 sc = device_get_softc(dev);
826 if (off == LBC85XX_LTESR && sc->sc_ltesr != ~0u) {
827 sc->sc_ltesr ^= (val & sc->sc_ltesr);
831 if (off == LBC85XX_LTEATR && (val & 1) == 0)
833 bus_space_write_4(sc->sc_bst, sc->sc_bsh, off, val);
837 lbc_read_reg(device_t child, u_int off)
840 struct lbc_softc *sc;
843 dev = device_get_parent(child);
846 device_printf(dev, "%s(%s): invalid offset %#x\n",
847 __func__, device_get_nameunit(child), off);
851 sc = device_get_softc(dev);
853 if (off == LBC85XX_LTESR && sc->sc_ltesr != ~0U)
856 val = bus_space_read_4(sc->sc_bst, sc->sc_bsh, off);