2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009-2014 The FreeBSD Foundation
7 * This software was developed by Andrew Turner under sponsorship from
8 * the FreeBSD Foundation.
9 * This software was developed by Semihalf under sponsorship from
10 * 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.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
42 #include <sys/limits.h>
43 #include <sys/sysctl.h>
45 #include <machine/resource.h>
47 #include <dev/fdt/fdt_common.h>
48 #include <dev/ofw/ofw_bus.h>
49 #include <dev/ofw/ofw_bus_subr.h>
50 #include <dev/ofw/openfirm.h>
52 #include "ofw_bus_if.h"
55 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \
56 printf(fmt,##args); } while (0)
58 #define debugf(fmt, args...)
61 #define FDT_COMPAT_LEN 255
63 #define FDT_REG_CELLS 4
64 #define FDT_RANGES_SIZE 48
66 SYSCTL_NODE(_hw, OID_AUTO, fdt, CTLFLAG_RD, 0, "Flattened Device Tree");
68 vm_paddr_t fdt_immr_pa;
69 vm_offset_t fdt_immr_va;
70 vm_offset_t fdt_immr_size;
72 struct fdt_ic_list fdt_ic_list_head = SLIST_HEAD_INITIALIZER(fdt_ic_list_head);
75 fdt_get_range_by_busaddr(phandle_t node, u_long addr, u_long *base,
78 pcell_t ranges[32], *rangesptr;
79 pcell_t addr_cells, size_cells, par_addr_cells;
80 u_long bus_addr, par_bus_addr, pbase, psize;
81 int err, i, len, tuple_size, tuples;
89 if ((fdt_addrsize_cells(node, &addr_cells, &size_cells)) != 0)
92 * Process 'ranges' property.
94 par_addr_cells = fdt_parent_addr_cells(node);
95 if (par_addr_cells > 2) {
99 len = OF_getproplen(node, "ranges");
102 if (len > sizeof(ranges))
105 return (fdt_get_range_by_busaddr(OF_parent(node), addr,
109 if (OF_getprop(node, "ranges", ranges, sizeof(ranges)) <= 0)
112 tuple_size = addr_cells + par_addr_cells + size_cells;
113 tuples = len / (tuple_size * sizeof(cell_t));
115 if (par_addr_cells > 2 || addr_cells > 2 || size_cells > 2)
121 for (i = 0; i < tuples; i++) {
122 rangesptr = &ranges[i * tuple_size];
124 bus_addr = fdt_data_get((void *)rangesptr, addr_cells);
125 if (bus_addr != addr)
127 rangesptr += addr_cells;
129 par_bus_addr = fdt_data_get((void *)rangesptr, par_addr_cells);
130 rangesptr += par_addr_cells;
132 err = fdt_get_range_by_busaddr(OF_parent(node), par_bus_addr,
139 *base = par_bus_addr;
141 *size = fdt_data_get((void *)rangesptr, size_cells);
150 fdt_get_range(phandle_t node, int range_id, u_long *base, u_long *size)
152 pcell_t ranges[FDT_RANGES_SIZE], *rangesptr;
153 pcell_t addr_cells, size_cells, par_addr_cells;
154 u_long par_bus_addr, pbase, psize;
157 if ((fdt_addrsize_cells(node, &addr_cells, &size_cells)) != 0)
160 * Process 'ranges' property.
162 par_addr_cells = fdt_parent_addr_cells(node);
163 if (par_addr_cells > 2)
166 len = OF_getproplen(node, "ranges");
167 if (len > sizeof(ranges))
175 if (!(range_id < len))
178 if (OF_getprop(node, "ranges", ranges, sizeof(ranges)) <= 0)
181 if (par_addr_cells > 2 || addr_cells > 2 || size_cells > 2)
186 rangesptr = &ranges[range_id];
188 *base = fdt_data_get((void *)rangesptr, addr_cells);
189 rangesptr += addr_cells;
191 par_bus_addr = fdt_data_get((void *)rangesptr, par_addr_cells);
192 rangesptr += par_addr_cells;
194 err = fdt_get_range_by_busaddr(OF_parent(node), par_bus_addr,
199 *base += par_bus_addr;
201 *size = fdt_data_get((void *)rangesptr, size_cells);
206 fdt_immr_addr(vm_offset_t immr_va)
213 * Try to access the SOC node directly i.e. through /aliases/.
215 if ((node = OF_finddevice("soc")) != -1)
216 if (ofw_bus_node_is_compatible(node, "simple-bus"))
219 * Find the node the long way.
221 if ((node = OF_finddevice("/")) == -1)
224 if ((node = fdt_find_compatible(node, "simple-bus", 0)) == 0)
228 if ((r = fdt_get_range(node, 0, &base, &size)) == 0) {
230 fdt_immr_va = immr_va;
231 fdt_immr_size = size;
238 fdt_is_compatible_strict(phandle_t node, const char *compatible)
240 char compat[FDT_COMPAT_LEN];
242 if (OF_getproplen(node, "compatible") <= 0)
245 if (OF_getprop(node, "compatible", compat, FDT_COMPAT_LEN) < 0)
248 if (strncasecmp(compat, compatible, FDT_COMPAT_LEN) == 0)
256 fdt_find_compatible(phandle_t start, const char *compat, int strict)
261 * Traverse all children of 'start' node, and find first with
262 * matching 'compatible' property.
264 for (child = OF_child(start); child != 0; child = OF_peer(child))
265 if (ofw_bus_node_is_compatible(child, compat)) {
267 if (!fdt_is_compatible_strict(child, compat))
275 fdt_depth_search_compatible(phandle_t start, const char *compat, int strict)
277 phandle_t child, node;
280 * Depth-search all descendants of 'start' node, and find first with
281 * matching 'compatible' property.
283 for (node = OF_child(start); node != 0; node = OF_peer(node)) {
284 if (ofw_bus_node_is_compatible(node, compat) &&
285 (strict == 0 || fdt_is_compatible_strict(node, compat))) {
288 child = fdt_depth_search_compatible(node, compat, strict);
296 fdt_parent_addr_cells(phandle_t node)
300 /* Find out #address-cells of the superior bus. */
301 if (OF_searchprop(OF_parent(node), "#address-cells", &addr_cells,
302 sizeof(addr_cells)) <= 0)
305 return ((int)fdt32_to_cpu(addr_cells));
309 fdt_data_get(void *data, int cells)
313 return (fdt32_to_cpu(*((uint32_t *)data)));
315 return (fdt64_to_cpu(*((uint64_t *)data)));
319 fdt_addrsize_cells(phandle_t node, int *addr_cells, int *size_cells)
325 * Retrieve #{address,size}-cells.
327 cell_size = sizeof(cell);
328 if (OF_getencprop(node, "#address-cells", &cell, cell_size) < cell_size)
330 *addr_cells = (int)cell;
332 if (OF_getencprop(node, "#size-cells", &cell, cell_size) < cell_size)
334 *size_cells = (int)cell;
336 if (*addr_cells > 3 || *size_cells > 2)
342 fdt_data_to_res(pcell_t *data, int addr_cells, int size_cells, u_long *start,
346 /* Address portion. */
350 *start = fdt_data_get((void *)data, addr_cells);
357 *count = fdt_data_get((void *)data, size_cells);
362 fdt_regsize(phandle_t node, u_long *base, u_long *size)
365 int addr_cells, len, size_cells;
367 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells))
370 if ((sizeof(pcell_t) * (addr_cells + size_cells)) > sizeof(reg))
373 len = OF_getprop(node, "reg", ®, sizeof(reg));
377 *base = fdt_data_get(®[0], addr_cells);
378 *size = fdt_data_get(®[addr_cells], size_cells);
383 fdt_get_phyaddr(phandle_t node, device_t dev, int *phy_addr, void **phy_sc)
386 pcell_t phy_handle, phy_reg;
388 device_t parent, child;
390 if (OF_getencprop(node, "phy-handle", (void *)&phy_handle,
391 sizeof(phy_handle)) <= 0)
394 phy_node = OF_node_from_xref(phy_handle);
396 if (OF_getencprop(phy_node, "reg", (void *)&phy_reg,
397 sizeof(phy_reg)) <= 0)
406 * Search for softc used to communicate with phy.
410 * Step 1: Search for ancestor of the phy-node with a "phy-handle"
413 phy_node = OF_parent(phy_node);
414 while (phy_node != 0) {
415 if (OF_getprop(phy_node, "phy-handle", (void *)&phy_handle,
416 sizeof(phy_handle)) > 0)
418 phy_node = OF_parent(phy_node);
424 * Step 2: For each device with the same parent and name as ours
425 * compare its node with the one found in step 1, ancestor of phy
426 * node (stored in phy_node).
428 parent = device_get_parent(dev);
430 child = device_find_child(parent, device_get_name(dev), i);
431 while (child != NULL) {
432 if (ofw_bus_get_node(child) == phy_node)
435 child = device_find_child(parent, device_get_name(dev), i);
441 * Use softc of the device found.
443 *phy_sc = (void *)device_get_softc(child);
449 fdt_get_reserved_regions(struct mem_region *mr, int *mrcnt)
451 pcell_t reserve[FDT_REG_CELLS * FDT_MEM_REGIONS];
453 phandle_t memory, root;
454 int addr_cells, size_cells;
455 int i, res_len, rv, tuple_size, tuples;
457 root = OF_finddevice("/");
458 memory = OF_finddevice("/memory");
464 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells,
468 if (addr_cells > 2) {
473 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
475 res_len = OF_getproplen(root, "memreserve");
476 if (res_len <= 0 || res_len > sizeof(reserve)) {
481 if (OF_getprop(root, "memreserve", reserve, res_len) <= 0) {
486 tuples = res_len / tuple_size;
487 reservep = (pcell_t *)&reserve;
488 for (i = 0; i < tuples; i++) {
490 rv = fdt_data_to_res(reservep, addr_cells, size_cells,
491 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size);
496 reservep += addr_cells + size_cells;
506 fdt_get_reserved_mem(struct mem_region *reserved, int *mreserved)
508 pcell_t reg[FDT_REG_CELLS];
509 phandle_t child, root;
510 int addr_cells, size_cells;
513 root = OF_finddevice("/reserved-memory");
518 if ((rv = fdt_addrsize_cells(root, &addr_cells, &size_cells)) != 0)
521 if (addr_cells + size_cells > FDT_REG_CELLS)
522 panic("Too many address and size cells %d %d", addr_cells,
526 for (child = OF_child(root); child != 0; child = OF_peer(child)) {
527 if (!OF_hasprop(child, "no-map"))
530 rv = OF_getprop(child, "reg", reg, sizeof(reg));
532 /* XXX: Does a no-map of a dynamic range make sense? */
535 fdt_data_to_res(reg, addr_cells, size_cells,
536 (u_long *)&reserved[i].mr_start,
537 (u_long *)&reserved[i].mr_size);
547 fdt_get_mem_regions(struct mem_region *mr, int *mrcnt, uint64_t *memsize)
549 pcell_t reg[FDT_REG_CELLS * FDT_MEM_REGIONS];
552 uint64_t memory_size;
553 int addr_cells, size_cells;
554 int i, reg_len, rv, tuple_size, tuples;
556 memory = OF_finddevice("/memory");
562 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells,
566 if (addr_cells > 2) {
571 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells);
572 reg_len = OF_getproplen(memory, "reg");
573 if (reg_len <= 0 || reg_len > sizeof(reg)) {
578 if (OF_getprop(memory, "reg", reg, reg_len) <= 0) {
584 tuples = reg_len / tuple_size;
585 regp = (pcell_t *)®
586 for (i = 0; i < tuples; i++) {
588 rv = fdt_data_to_res(regp, addr_cells, size_cells,
589 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size);
594 regp += addr_cells + size_cells;
595 memory_size += mr[i].mr_size;
598 if (memory_size == 0) {
605 *memsize = memory_size;
612 fdt_get_chosen_bootargs(char *bootargs, size_t max_size)
616 chosen = OF_finddevice("/chosen");
619 if (OF_getprop(chosen, "bootargs", bootargs, max_size) == -1)