2 * Copyright (c) 2009-2010 The FreeBSD Foundation
5 * This software was developed by Semihalf under sponsorship from
6 * the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
38 #include <sys/limits.h>
40 #include <machine/fdt.h>
41 #include <machine/resource.h>
43 #include <dev/fdt/fdt_common.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
46 #include <dev/ofw/openfirm.h>
48 #include "ofw_bus_if.h"
51 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \
52 printf(fmt,##args); } while (0)
54 #define debugf(fmt, args...)
57 #define FDT_COMPAT_LEN 255
58 #define FDT_TYPE_LEN 64
60 #define FDT_REG_CELLS 4
62 vm_paddr_t fdt_immr_pa;
63 vm_offset_t fdt_immr_va;
64 vm_offset_t fdt_immr_size;
67 fdt_get_range(phandle_t node, int range_id, u_long *base, u_long *size)
69 pcell_t ranges[6], *rangesptr;
70 pcell_t addr_cells, size_cells, par_addr_cells;
71 int len, tuple_size, tuples;
73 if ((fdt_addrsize_cells(node, &addr_cells, &size_cells)) != 0)
76 * Process 'ranges' property.
78 par_addr_cells = fdt_parent_addr_cells(node);
79 if (par_addr_cells > 2)
82 len = OF_getproplen(node, "ranges");
83 if (len > sizeof(ranges))
91 if (!(range_id < len))
94 if (OF_getprop(node, "ranges", ranges, sizeof(ranges)) <= 0)
97 tuple_size = sizeof(pcell_t) * (addr_cells + par_addr_cells +
99 tuples = len / tuple_size;
101 if (fdt_ranges_verify(ranges, tuples, par_addr_cells,
102 addr_cells, size_cells)) {
107 rangesptr = &ranges[range_id];
109 *base = fdt_data_get((void *)rangesptr, addr_cells);
110 rangesptr += addr_cells;
111 *base += fdt_data_get((void *)rangesptr, par_addr_cells);
112 rangesptr += par_addr_cells;
113 *size = fdt_data_get((void *)rangesptr, size_cells);
118 fdt_immr_addr(vm_offset_t immr_va)
125 * Try to access the SOC node directly i.e. through /aliases/.
127 if ((node = OF_finddevice("soc")) != 0)
128 if (fdt_is_compatible_strict(node, "simple-bus"))
131 * Find the node the long way.
133 if ((node = OF_finddevice("/")) == 0)
136 if ((node = fdt_find_compatible(node, "simple-bus", 1)) == 0)
140 if ((r = fdt_get_range(node, 0, &base, &size)) == 0) {
142 fdt_immr_va = immr_va;
143 fdt_immr_size = size;
150 * This routine is an early-usage version of the ofw_bus_is_compatible() when
151 * the ofw_bus I/F is not available (like early console routines and similar).
152 * Note the buffer has to be on the stack since malloc() is usually not
153 * available in such cases either.
156 fdt_is_compatible(phandle_t node, const char *compatstr)
158 char buf[FDT_COMPAT_LEN];
160 int len, onelen, l, rv;
162 if ((len = OF_getproplen(node, "compatible")) <= 0)
165 compat = (char *)&buf;
166 bzero(compat, FDT_COMPAT_LEN);
168 if (OF_getprop(node, "compatible", compat, FDT_COMPAT_LEN) < 0)
171 onelen = strlen(compatstr);
174 if (strncasecmp(compat, compatstr, onelen) == 0) {
179 /* Slide to the next sub-string. */
180 l = strlen(compat) + 1;
189 fdt_is_compatible_strict(phandle_t node, const char *compatible)
191 char compat[FDT_COMPAT_LEN];
193 if (OF_getproplen(node, "compatible") <= 0)
196 if (OF_getprop(node, "compatible", compat, FDT_COMPAT_LEN) < 0)
199 if (strncasecmp(compat, compatible, FDT_COMPAT_LEN) == 0)
207 fdt_find_compatible(phandle_t start, const char *compat, int strict)
212 * Traverse all children of 'start' node, and find first with
213 * matching 'compatible' property.
215 for (child = OF_child(start); child != 0; child = OF_peer(child))
216 if (fdt_is_compatible(child, compat)) {
218 if (!fdt_is_compatible_strict(child, compat))
226 fdt_is_enabled(phandle_t node)
231 len = OF_getprop_alloc(node, "status", sizeof(char),
235 /* It is OK if no 'status' property. */
238 /* Anything other than 'okay' means disabled. */
240 if (strncmp((char *)stat, "okay", len) == 0)
243 free(stat, M_OFWPROP);
248 fdt_is_type(phandle_t node, const char *typestr)
250 char type[FDT_TYPE_LEN];
252 if (OF_getproplen(node, "device_type") <= 0)
255 if (OF_getprop(node, "device_type", type, FDT_TYPE_LEN) < 0)
258 if (strncasecmp(type, typestr, FDT_TYPE_LEN) == 0)
266 fdt_parent_addr_cells(phandle_t node)
270 /* Find out #address-cells of the superior bus. */
271 if (OF_searchprop(OF_parent(node), "#address-cells", &addr_cells,
272 sizeof(addr_cells)) <= 0)
275 return ((int)fdt32_to_cpu(addr_cells));
279 fdt_data_verify(void *data, int cells)
284 d64 = fdt64_to_cpu(*((uint64_t *)data));
285 if (((d64 >> 32) & 0xffffffffull) != 0 || cells > 2)
293 fdt_pm_is_enabled(phandle_t node)
299 #if defined(SOC_MV_KIRKWOOD) || defined(SOC_MV_DISCOVERY)
306 fdt_data_get(void *data, int cells)
310 return (fdt32_to_cpu(*((uint32_t *)data)));
312 return (fdt64_to_cpu(*((uint64_t *)data)));
316 fdt_addrsize_cells(phandle_t node, int *addr_cells, int *size_cells)
322 * Retrieve #{address,size}-cells.
324 cell_size = sizeof(cell);
325 if (OF_getprop(node, "#address-cells", &cell, cell_size) < cell_size)
327 *addr_cells = fdt32_to_cpu((int)cell);
329 if (OF_getprop(node, "#size-cells", &cell, cell_size) < cell_size)
331 *size_cells = fdt32_to_cpu((int)cell);
333 if (*addr_cells > 3 || *size_cells > 2)
339 fdt_ranges_verify(pcell_t *ranges, int tuples, int par_addr_cells,
340 int this_addr_cells, int this_size_cells)
344 if (par_addr_cells > 2 || this_addr_cells > 2 || this_size_cells > 2)
348 * This is the max size the resource manager can handle for addresses
351 ulsz = sizeof(u_long);
352 if (par_addr_cells <= ulsz && this_addr_cells <= ulsz &&
353 this_size_cells <= ulsz)
354 /* We can handle everything */
358 for (i = 0; i < tuples; i++) {
360 if (fdt_data_verify((void *)ranges, par_addr_cells))
362 ranges += par_addr_cells;
364 if (fdt_data_verify((void *)ranges, this_addr_cells))
366 ranges += this_addr_cells;
368 if (fdt_data_verify((void *)ranges, this_size_cells))
370 ranges += this_size_cells;
376 debugf("using address range >%d-bit not supported\n", ulsz * 8);
381 fdt_data_to_res(pcell_t *data, int addr_cells, int size_cells, u_long *start,
385 /* Address portion. */
386 if (fdt_data_verify((void *)data, addr_cells))
389 *start = fdt_data_get((void *)data, addr_cells);
393 if (fdt_data_verify((void *)data, size_cells))
396 *count = fdt_data_get((void *)data, size_cells);
401 fdt_regsize(phandle_t node, u_long *base, u_long *size)
404 int addr_cells, len, size_cells;
406 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells))
409 if ((sizeof(pcell_t) * (addr_cells + size_cells)) > sizeof(reg))
412 len = OF_getprop(node, "reg", ®, sizeof(reg));
416 *base = fdt_data_get(®[0], addr_cells);
417 *size = fdt_data_get(®[addr_cells], size_cells);
422 fdt_reg_to_rl(phandle_t node, struct resource_list *rl)
424 u_long end, count, start;
425 pcell_t *reg, *regptr;
426 pcell_t addr_cells, size_cells;
427 int tuple_size, tuples;
429 long busaddr, bussize;
431 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells) != 0)
433 if (fdt_get_range(OF_parent(node), 0, &busaddr, &bussize)) {
438 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
439 tuples = OF_getprop_alloc(node, "reg", tuple_size, (void **)®);
440 debugf("addr_cells = %d, size_cells = %d\n", addr_cells, size_cells);
441 debugf("tuples = %d, tuple size = %d\n", tuples, tuple_size);
443 /* No 'reg' property in this node. */
447 for (i = 0; i < tuples; i++) {
449 rv = fdt_data_to_res(reg, addr_cells, size_cells, &start,
452 resource_list_free(rl);
455 reg += addr_cells + size_cells;
457 /* Calculate address range relative to base. */
459 end = start + count - 1;
461 debugf("reg addr start = %lx, end = %lx, count = %lx\n", start,
464 resource_list_add(rl, SYS_RES_MEMORY, i, start, end,
470 free(regptr, M_OFWPROP);
475 fdt_intr_decode(phandle_t intr_parent, pcell_t *intr, int *interrupt,
478 fdt_pic_decode_t intr_decode;
481 for (i = 0; fdt_pic_table[i] != NULL; i++) {
483 /* XXX check if pic_handle has interrupt-controller prop? */
485 intr_decode = fdt_pic_table[i];
486 rv = intr_decode(intr_parent, intr, interrupt, trig, pol);
489 /* This was recognized as our PIC and decoded. */
497 fdt_intr_to_rl(phandle_t node, struct resource_list *rl,
498 struct fdt_sense_level *intr_sl)
504 int interrupt, trig, pol;
505 int i, intr_num, irq, rv;
507 if (OF_getproplen(node, "interrupts") <= 0)
508 /* Node does not have 'interrupts' property. */
512 * Find #interrupt-cells of the interrupt domain.
514 if (OF_getprop(node, "interrupt-parent", &iph, sizeof(iph)) <= 0) {
515 debugf("no intr-parent phandle\n");
516 intr_par = OF_parent(node);
518 iph = fdt32_to_cpu(iph);
519 intr_par = OF_instance_to_package(iph);
522 if (OF_getprop(intr_par, "#interrupt-cells", &intr_cells,
523 sizeof(intr_cells)) <= 0) {
524 debugf("no intr-cells defined, defaulting to 1\n");
528 intr_cells = fdt32_to_cpu(intr_cells);
530 intr_num = OF_getprop_alloc(node, "interrupts",
531 intr_cells * sizeof(pcell_t), (void **)&intr);
532 if (intr_num <= 0 || intr_num > DI_MAX_INTR_NUM)
536 for (i = 0; i < intr_num; i++) {
541 if (fdt_intr_decode(intr_par, &intr[i * intr_cells],
542 &interrupt, &trig, &pol) != 0) {
552 debugf("decoded intr = %d, trig = %d, pol = %d\n", interrupt,
555 intr_sl[i].trig = trig;
556 intr_sl[i].pol = pol;
558 irq = FDT_MAP_IRQ(intr_par, interrupt);
559 resource_list_add(rl, SYS_RES_IRQ, i, irq, irq, 1);
563 free(intr, M_OFWPROP);
568 fdt_get_phyaddr(phandle_t node, device_t dev, int *phy_addr, void **phy_sc)
571 ihandle_t phy_ihandle;
572 pcell_t phy_handle, phy_reg;
574 device_t parent, child;
576 if (OF_getprop(node, "phy-handle", (void *)&phy_handle,
577 sizeof(phy_handle)) <= 0)
580 phy_ihandle = (ihandle_t)phy_handle;
581 phy_ihandle = fdt32_to_cpu(phy_ihandle);
582 phy_node = OF_instance_to_package(phy_ihandle);
584 if (OF_getprop(phy_node, "reg", (void *)&phy_reg,
585 sizeof(phy_reg)) <= 0)
588 *phy_addr = fdt32_to_cpu(phy_reg);
591 * Search for softc used to communicate with phy.
595 * Step 1: Search for ancestor of the phy-node with a "phy-handle"
598 phy_node = OF_parent(phy_node);
599 while (phy_node != 0) {
600 if (OF_getprop(phy_node, "phy-handle", (void *)&phy_handle,
601 sizeof(phy_handle)) > 0)
603 phy_node = OF_parent(phy_node);
609 * Step 2: For each device with the same parent and name as ours
610 * compare its node with the one found in step 1, ancestor of phy
611 * node (stored in phy_node).
613 parent = device_get_parent(dev);
615 child = device_find_child(parent, device_get_name(dev), i);
616 while (child != NULL) {
617 if (ofw_bus_get_node(child) == phy_node)
620 child = device_find_child(parent, device_get_name(dev), i);
626 * Use softc of the device found.
628 *phy_sc = (void *)device_get_softc(child);
634 fdt_get_reserved_regions(struct mem_region *mr, int *mrcnt)
636 pcell_t reserve[FDT_REG_CELLS * FDT_MEM_REGIONS];
638 phandle_t memory, root;
639 uint32_t memory_size;
640 int addr_cells, size_cells;
641 int i, max_size, res_len, rv, tuple_size, tuples;
643 max_size = sizeof(reserve);
644 root = OF_finddevice("/");
645 memory = OF_finddevice("/memory");
651 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells,
655 if (addr_cells > 2) {
660 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
662 res_len = OF_getproplen(root, "memreserve");
663 if (res_len <= 0 || res_len > sizeof(reserve)) {
668 if (OF_getprop(root, "memreserve", reserve, res_len) <= 0) {
674 tuples = res_len / tuple_size;
675 reservep = (pcell_t *)&reserve;
676 for (i = 0; i < tuples; i++) {
678 rv = fdt_data_to_res(reservep, addr_cells, size_cells,
679 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size);
684 reservep += addr_cells + size_cells;
694 fdt_get_mem_regions(struct mem_region *mr, int *mrcnt, uint32_t *memsize)
696 pcell_t reg[FDT_REG_CELLS * FDT_MEM_REGIONS];
699 uint32_t memory_size;
700 int addr_cells, size_cells;
701 int i, max_size, reg_len, rv, tuple_size, tuples;
703 max_size = sizeof(reg);
704 memory = OF_finddevice("/memory");
710 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells,
714 if (addr_cells > 2) {
719 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
720 reg_len = OF_getproplen(memory, "reg");
721 if (reg_len <= 0 || reg_len > sizeof(reg)) {
726 if (OF_getprop(memory, "reg", reg, reg_len) <= 0) {
732 tuples = reg_len / tuple_size;
733 regp = (pcell_t *)®
734 for (i = 0; i < tuples; i++) {
736 rv = fdt_data_to_res(regp, addr_cells, size_cells,
737 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size);
742 regp += addr_cells + size_cells;
743 memory_size += mr[i].mr_size;
746 if (memory_size == 0) {
752 *memsize = memory_size;
759 fdt_get_unit(device_t dev)
763 name = ofw_bus_get_name(dev);
764 name = strchr(name, '@') + 1;
766 return (strtol(name,NULL,0));