1 // SPDX-License-Identifier: GPL-2.0+
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
6 * Copyright 2010-2011 Freescale Semiconductor, Inc.
10 #include <stdio_dev.h>
11 #include <linux/ctype.h>
12 #include <linux/types.h>
13 #include <asm/global_data.h>
14 #include <linux/libfdt.h>
15 #include <fdt_support.h>
20 * fdt_getprop_u32_default_node - Return a node's property or a default
22 * @fdt: ptr to device tree
23 * @off: offset of node
24 * @cell: cell offset in property
25 * @prop: property name
26 * @dflt: default value if the property isn't found
28 * Convenience function to return a node's property or a default value if
29 * the property doesn't exist.
31 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
32 const char *prop, const u32 dflt)
37 val = fdt_getprop(fdt, off, prop, &len);
39 /* Check if property exists */
43 /* Check if property is long enough */
44 if (len < ((cell + 1) * sizeof(uint32_t)))
47 return fdt32_to_cpu(*val);
51 * fdt_getprop_u32_default - Find a node and return it's property or a default
53 * @fdt: ptr to device tree
55 * @prop: property name
56 * @dflt: default value if the property isn't found
58 * Convenience function to find a node and return it's property or a
59 * default value if it doesn't exist.
61 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
62 const char *prop, const u32 dflt)
66 off = fdt_path_offset(fdt, path);
70 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
74 * fdt_find_and_setprop: Find a node and set it's property
76 * @fdt: ptr to device tree
78 * @prop: property name
79 * @val: ptr to new value
80 * @len: length of new property value
81 * @create: flag to create the property if it doesn't exist
83 * Convenience function to directly set a property given the path to the node.
85 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
86 const void *val, int len, int create)
88 int nodeoff = fdt_path_offset(fdt, node);
93 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
94 return 0; /* create flag not set; so exit quietly */
96 return fdt_setprop(fdt, nodeoff, prop, val, len);
100 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
102 * @fdt: pointer to the device tree blob
103 * @parentoffset: structure block offset of a node
104 * @name: name of the subnode to locate
106 * fdt_subnode_offset() finds a subnode of the node with a given name.
107 * If the subnode does not exist, it will be created.
109 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
113 offset = fdt_subnode_offset(fdt, parentoffset, name);
115 if (offset == -FDT_ERR_NOTFOUND)
116 offset = fdt_add_subnode(fdt, parentoffset, name);
119 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
124 /* rename to CONFIG_OF_STDOUT_PATH ? */
125 #if defined(OF_STDOUT_PATH)
126 static int fdt_fixup_stdout(void *fdt, int chosenoff)
128 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
129 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
131 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
132 static int fdt_fixup_stdout(void *fdt, int chosenoff)
136 char sername[9] = { 0 };
139 char tmp[256]; /* long enough */
141 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
143 aliasoff = fdt_path_offset(fdt, "/aliases");
149 path = fdt_getprop(fdt, aliasoff, sername, &len);
155 /* fdt_setprop may break "path" so we copy it to tmp buffer */
156 memcpy(tmp, path, len);
158 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
160 printf("WARNING: could not set linux,stdout-path %s.\n",
166 printf("WARNING: %s: could not read %s alias: %s\n",
167 __func__, sername, fdt_strerror(err));
172 static int fdt_fixup_stdout(void *fdt, int chosenoff)
178 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
179 uint64_t val, int is_u64)
182 return fdt_setprop_u64(fdt, nodeoffset, name, val);
184 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
187 int fdt_root(void *fdt)
192 err = fdt_check_header(fdt);
194 printf("fdt_root: %s\n", fdt_strerror(err));
198 serial = env_get("serial#");
200 err = fdt_setprop(fdt, 0, "serial-number", serial,
204 printf("WARNING: could not set serial-number %s.\n",
213 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
220 /* just return if the size of initrd is zero */
221 if (initrd_start == initrd_end)
224 /* find or create "/chosen" node. */
225 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
229 total = fdt_num_mem_rsv(fdt);
232 * Look for an existing entry and update it. If we don't find
233 * the entry, we will j be the next available slot.
235 for (j = 0; j < total; j++) {
236 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
237 if (addr == initrd_start) {
238 fdt_del_mem_rsv(fdt, j);
243 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
245 printf("fdt_initrd: %s\n", fdt_strerror(err));
249 is_u64 = (fdt_address_cells(fdt, 0) == 2);
251 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
252 (uint64_t)initrd_start, is_u64);
255 printf("WARNING: could not set linux,initrd-start %s.\n",
260 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
261 (uint64_t)initrd_end, is_u64);
264 printf("WARNING: could not set linux,initrd-end %s.\n",
273 int fdt_chosen(void *fdt)
277 char *str; /* used to set string properties */
279 err = fdt_check_header(fdt);
281 printf("fdt_chosen: %s\n", fdt_strerror(err));
285 /* find or create "/chosen" node. */
286 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
290 str = env_get("bootargs");
292 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
295 printf("WARNING: could not set bootargs %s.\n",
301 return fdt_fixup_stdout(fdt, nodeoffset);
304 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
305 const void *val, int len, int create)
309 debug("Updating property '%s/%s' = ", path, prop);
310 for (i = 0; i < len; i++)
311 debug(" %.2x", *(u8*)(val+i));
314 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
316 printf("Unable to update property %s:%s, err=%s\n",
317 path, prop, fdt_strerror(rc));
320 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
323 fdt32_t tmp = cpu_to_fdt32(val);
324 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
327 void do_fixup_by_prop(void *fdt,
328 const char *pname, const void *pval, int plen,
329 const char *prop, const void *val, int len,
335 debug("Updating property '%s' = ", prop);
336 for (i = 0; i < len; i++)
337 debug(" %.2x", *(u8*)(val+i));
340 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
341 while (off != -FDT_ERR_NOTFOUND) {
342 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
343 fdt_setprop(fdt, off, prop, val, len);
344 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
348 void do_fixup_by_prop_u32(void *fdt,
349 const char *pname, const void *pval, int plen,
350 const char *prop, u32 val, int create)
352 fdt32_t tmp = cpu_to_fdt32(val);
353 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
356 void do_fixup_by_compat(void *fdt, const char *compat,
357 const char *prop, const void *val, int len, int create)
362 debug("Updating property '%s' = ", prop);
363 for (i = 0; i < len; i++)
364 debug(" %.2x", *(u8*)(val+i));
367 off = fdt_node_offset_by_compatible(fdt, -1, compat);
368 while (off != -FDT_ERR_NOTFOUND) {
369 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
370 fdt_setprop(fdt, off, prop, val, len);
371 off = fdt_node_offset_by_compatible(fdt, off, compat);
375 void do_fixup_by_compat_u32(void *fdt, const char *compat,
376 const char *prop, u32 val, int create)
378 fdt32_t tmp = cpu_to_fdt32(val);
379 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
382 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
384 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
386 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
390 int address_cells = fdt_address_cells(fdt, 0);
391 int size_cells = fdt_size_cells(fdt, 0);
394 for (i = 0; i < n; i++) {
395 if (address_cells == 2)
396 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
398 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
399 p += 4 * address_cells;
402 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
404 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
408 return p - (char *)buf;
411 #if CONFIG_NR_DRAM_BANKS > 4
412 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
414 #define MEMORY_BANKS_MAX 4
416 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
420 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
422 if (banks > MEMORY_BANKS_MAX) {
423 printf("%s: num banks %d exceeds hardcoded limit %d."
424 " Recompile with higher MEMORY_BANKS_MAX?\n",
425 __FUNCTION__, banks, MEMORY_BANKS_MAX);
429 err = fdt_check_header(blob);
431 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
435 /* find or create "/memory" node. */
436 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
440 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
443 printf("WARNING: could not set %s %s.\n", "device_type",
448 for (i = 0; i < banks; i++) {
449 if (start[i] == 0 && size[i] == 0)
458 for (i = 0; i < banks; i++)
459 if (start[i] == 0 && size[i] == 0)
464 len = fdt_pack_reg(blob, tmp, start, size, banks);
466 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
468 printf("WARNING: could not set %s %s.\n",
469 "reg", fdt_strerror(err));
476 int fdt_fixup_memory(void *blob, u64 start, u64 size)
478 return fdt_fixup_memory_banks(blob, &start, &size, 1);
481 void fdt_fixup_ethernet(void *fdt)
487 unsigned char mac_addr[ARP_HLEN];
489 #ifdef FDT_SEQ_MACADDR_FROM_ENV
491 const struct fdt_property *fdt_prop;
494 if (fdt_path_offset(fdt, "/aliases") < 0)
497 /* Cycle through all aliases */
498 for (prop = 0; ; prop++) {
501 /* FDT might have been edited, recompute the offset */
502 offset = fdt_first_property_offset(fdt,
503 fdt_path_offset(fdt, "/aliases"));
504 /* Select property number 'prop' */
505 for (j = 0; j < prop; j++)
506 offset = fdt_next_property_offset(fdt, offset);
511 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
512 if (!strncmp(name, "ethernet", 8)) {
513 /* Treat plain "ethernet" same as "ethernet0". */
514 if (!strcmp(name, "ethernet")
515 #ifdef FDT_SEQ_MACADDR_FROM_ENV
516 || !strcmp(name, "ethernet0")
520 #ifndef FDT_SEQ_MACADDR_FROM_ENV
522 i = trailing_strtol(name);
526 strcpy(mac, "ethaddr");
528 sprintf(mac, "eth%daddr", i);
532 #ifdef FDT_SEQ_MACADDR_FROM_ENV
533 nodeoff = fdt_path_offset(fdt, path);
534 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
536 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
544 for (j = 0; j < 6; j++) {
546 simple_strtoul(tmp, &end, 16) : 0;
548 tmp = (*end) ? end + 1 : end;
551 do_fixup_by_path(fdt, path, "mac-address",
553 do_fixup_by_path(fdt, path, "local-mac-address",
559 int fdt_record_loadable(void *blob, u32 index, const char *name,
560 uintptr_t load_addr, u32 size, uintptr_t entry_point,
561 const char *type, const char *os)
565 err = fdt_check_header(blob);
567 printf("%s: %s\n", __func__, fdt_strerror(err));
571 /* find or create "/fit-images" node */
572 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
576 /* find or create "/fit-images/<name>" node */
577 node = fdt_find_or_add_subnode(blob, node, name);
582 * We record these as 32bit entities, possibly truncating addresses.
583 * However, spl_fit.c is not 64bit safe either: i.e. we should not
584 * have an issue here.
586 fdt_setprop_u32(blob, node, "load-addr", load_addr);
587 if (entry_point != -1)
588 fdt_setprop_u32(blob, node, "entry-point", entry_point);
589 fdt_setprop_u32(blob, node, "size", size);
591 fdt_setprop_string(blob, node, "type", type);
593 fdt_setprop_string(blob, node, "os", os);
598 /* Resize the fdt to its actual size + a bit of padding */
599 int fdt_shrink_to_minimum(void *blob, uint extrasize)
609 total = fdt_num_mem_rsv(blob);
610 for (i = 0; i < total; i++) {
611 fdt_get_mem_rsv(blob, i, &addr, &size);
612 if (addr == (uintptr_t)blob) {
613 fdt_del_mem_rsv(blob, i);
619 * Calculate the actual size of the fdt
620 * plus the size needed for 5 fdt_add_mem_rsv, one
621 * for the fdt itself and 4 for a possible initrd
622 * ((initrd-start + initrd-end) * 2 (name & value))
624 actualsize = fdt_off_dt_strings(blob) +
625 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
627 actualsize += extrasize;
628 /* Make it so the fdt ends on a page boundary */
629 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
630 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
632 /* Change the fdt header to reflect the correct size */
633 fdt_set_totalsize(blob, actualsize);
635 /* Add the new reservation */
636 ret = fdt_add_mem_rsv(blob, (uintptr_t)blob, actualsize);
644 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
646 #define FDT_PCI_PREFETCH (0x40000000)
647 #define FDT_PCI_MEM32 (0x02000000)
648 #define FDT_PCI_IO (0x01000000)
649 #define FDT_PCI_MEM64 (0x03000000)
651 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
653 int addrcell, sizecell, len, r;
655 /* sized based on pci addr cells, size-cells, & address-cells */
656 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
658 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
659 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
661 dma_range = &dma_ranges[0];
662 for (r = 0; r < hose->region_count; r++) {
663 u64 bus_start, phys_start, size;
665 /* skip if !PCI_REGION_SYS_MEMORY */
666 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
669 bus_start = (u64)hose->regions[r].bus_start;
670 phys_start = (u64)hose->regions[r].phys_start;
671 size = (u64)hose->regions[r].size;
674 if (size >= 0x100000000ull)
675 dma_range[0] |= FDT_PCI_MEM64;
677 dma_range[0] |= FDT_PCI_MEM32;
678 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
679 dma_range[0] |= FDT_PCI_PREFETCH;
680 #ifdef CONFIG_SYS_PCI_64BIT
681 dma_range[1] = bus_start >> 32;
685 dma_range[2] = bus_start & 0xffffffff;
688 dma_range[3] = phys_start >> 32;
689 dma_range[4] = phys_start & 0xffffffff;
691 dma_range[3] = phys_start & 0xffffffff;
695 dma_range[3 + addrcell + 0] = size >> 32;
696 dma_range[3 + addrcell + 1] = size & 0xffffffff;
698 dma_range[3 + addrcell + 0] = size & 0xffffffff;
701 dma_range += (3 + addrcell + sizecell);
704 len = dma_range - &dma_ranges[0];
706 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
712 int fdt_increase_size(void *fdt, int add_len)
716 newlen = fdt_totalsize(fdt) + add_len;
718 /* Open in place with a new len */
719 return fdt_open_into(fdt, fdt, newlen);
722 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
723 #include <jffs2/load_kernel.h>
724 #include <mtd_node.h>
731 static int fdt_del_subnodes(const void *blob, int parent_offset)
736 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
737 (off >= 0) && (ndepth > 0);
738 off = fdt_next_node(blob, off, &ndepth)) {
740 debug("delete %s: offset: %x\n",
741 fdt_get_name(blob, off, 0), off);
742 ret = fdt_del_node((void *)blob, off);
744 printf("Can't delete node: %s\n",
756 static int fdt_del_partitions(void *blob, int parent_offset)
763 off = fdt_next_node(blob, parent_offset, &ndepth);
764 if (off > 0 && ndepth == 1) {
765 prop = fdt_getprop(blob, off, "label", NULL);
768 * Could not find label property, nand {}; node?
769 * Check subnode, delete partitions there if any.
771 return fdt_del_partitions(blob, off);
773 ret = fdt_del_subnodes(blob, parent_offset);
775 printf("Can't remove subnodes: %s\n",
784 int fdt_node_set_part_info(void *blob, int parent_offset,
785 struct mtd_device *dev)
787 struct list_head *pentry;
788 struct part_info *part;
789 struct reg_cell cell;
794 ret = fdt_del_partitions(blob, parent_offset);
799 * Check if it is nand {}; subnode, adjust
800 * the offset in this case
802 off = fdt_next_node(blob, parent_offset, &ndepth);
803 if (off > 0 && ndepth == 1)
807 list_for_each_prev(pentry, &dev->parts) {
810 part = list_entry(pentry, struct part_info, link);
812 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
813 part_num, part->name, part->size,
814 part->offset, part->mask_flags);
816 sprintf(buf, "partition@%llx", part->offset);
818 ret = fdt_add_subnode(blob, parent_offset, buf);
819 if (ret == -FDT_ERR_NOSPACE) {
820 ret = fdt_increase_size(blob, 512);
825 } else if (ret < 0) {
826 printf("Can't add partition node: %s\n",
832 /* Check MTD_WRITEABLE_CMD flag */
833 if (part->mask_flags & 1) {
835 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
836 if (ret == -FDT_ERR_NOSPACE) {
837 ret = fdt_increase_size(blob, 512);
846 cell.r0 = cpu_to_fdt32(part->offset);
847 cell.r1 = cpu_to_fdt32(part->size);
849 ret = fdt_setprop(blob, newoff, "reg", &cell, sizeof(cell));
850 if (ret == -FDT_ERR_NOSPACE) {
851 ret = fdt_increase_size(blob, 512);
860 ret = fdt_setprop_string(blob, newoff, "label", part->name);
861 if (ret == -FDT_ERR_NOSPACE) {
862 ret = fdt_increase_size(blob, 512);
874 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
877 printf("Can't add property: %s\n", fdt_strerror(ret));
882 * Update partitions in nor/nand nodes using info from
883 * mtdparts environment variable. The nodes to update are
884 * specified by node_info structure which contains mtd device
885 * type and compatible string: E. g. the board code in
886 * ft_board_setup() could use:
888 * struct node_info nodes[] = {
889 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
890 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
893 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
895 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
898 struct mtd_device *dev;
902 if (mtdparts_init() != 0)
905 for (i = 0; i < node_info_size; i++) {
907 noff = fdt_node_offset_by_compatible(blob, -1,
908 node_info[i].compat);
909 while (noff != -FDT_ERR_NOTFOUND) {
910 debug("%s: %s, mtd dev type %d\n",
911 fdt_get_name(blob, noff, 0),
912 node_info[i].compat, node_info[i].type);
913 dev = device_find(node_info[i].type, idx++);
915 if (fdt_node_set_part_info(blob, noff, dev))
916 return; /* return on error */
919 /* Jump to next flash node */
920 noff = fdt_node_offset_by_compatible(blob, noff,
921 node_info[i].compat);
927 void fdt_del_node_and_alias(void *blob, const char *alias)
929 int off = fdt_path_offset(blob, alias);
934 fdt_del_node(blob, off);
936 off = fdt_path_offset(blob, "/aliases");
937 fdt_delprop(blob, off, alias);
940 /* Max address size we deal with */
941 #define OF_MAX_ADDR_CELLS 4
942 #define OF_BAD_ADDR FDT_ADDR_T_NONE
943 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
948 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
952 printf(" %08x", *(addr++));
956 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
960 * struct of_bus - Callbacks for bus specific translators
961 * @name: A string used to identify this bus in debug output.
962 * @addresses: The name of the DT property from which addresses are
963 * to be read, typically "reg".
964 * @match: Return non-zero if the node whose parent is at
965 * parentoffset in the FDT blob corresponds to a bus
966 * of this type, otherwise return zero. If NULL a match
968 * @count_cells:Count how many cells (be32 values) a node whose parent
969 * is at parentoffset in the FDT blob will require to
970 * represent its address (written to *addrc) & size
971 * (written to *sizec).
972 * @map: Map the address addr from the address space of this
973 * bus to that of its parent, making use of the ranges
974 * read from DT to an array at range. na and ns are the
975 * number of cells (be32 values) used to hold and address
976 * or size, respectively, for this bus. pna is the number
977 * of cells used to hold an address for the parent bus.
978 * Returns the address in the address space of the parent
980 * @translate: Update the value of the address cells at addr within an
981 * FDT by adding offset to it. na specifies the number of
982 * cells used to hold the address being translated. Returns
983 * zero on success, non-zero on error.
985 * Each bus type will include a struct of_bus in the of_busses array,
986 * providing implementations of some or all of the functions used to
987 * match the bus & handle address translation for its children.
991 const char *addresses;
992 int (*match)(const void *blob, int parentoffset);
993 void (*count_cells)(const void *blob, int parentoffset,
994 int *addrc, int *sizec);
995 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
996 int na, int ns, int pna);
997 int (*translate)(fdt32_t *addr, u64 offset, int na);
1000 /* Default translator (generic bus) */
1001 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1002 int *addrc, int *sizec)
1004 const fdt32_t *prop;
1007 *addrc = fdt_address_cells(blob, parentoffset);
1010 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1012 *sizec = be32_to_cpup(prop);
1018 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1019 int na, int ns, int pna)
1023 cp = fdt_read_number(range, na);
1024 s = fdt_read_number(range + na + pna, ns);
1025 da = fdt_read_number(addr, na);
1027 debug("OF: default map, cp=%llu, s=%llu, da=%llu\n", cp, s, da);
1029 if (da < cp || da >= (cp + s))
1034 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1036 u64 a = fdt_read_number(addr, na);
1037 memset(addr, 0, na * 4);
1040 addr[na - 2] = cpu_to_fdt32(a >> 32);
1041 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1046 #ifdef CONFIG_OF_ISA_BUS
1048 /* ISA bus translator */
1049 static int of_bus_isa_match(const void *blob, int parentoffset)
1053 name = fdt_get_name(blob, parentoffset, NULL);
1057 return !strcmp(name, "isa");
1060 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1061 int *addrc, int *sizec)
1069 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1070 int na, int ns, int pna)
1074 /* Check address type match */
1075 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1078 cp = fdt_read_number(range + 1, na - 1);
1079 s = fdt_read_number(range + na + pna, ns);
1080 da = fdt_read_number(addr + 1, na - 1);
1082 debug("OF: ISA map, cp=%llu, s=%llu, da=%llu\n", cp, s, da);
1084 if (da < cp || da >= (cp + s))
1089 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1091 return of_bus_default_translate(addr + 1, offset, na - 1);
1094 #endif /* CONFIG_OF_ISA_BUS */
1096 /* Array of bus specific translators */
1097 static struct of_bus of_busses[] = {
1098 #ifdef CONFIG_OF_ISA_BUS
1103 .match = of_bus_isa_match,
1104 .count_cells = of_bus_isa_count_cells,
1105 .map = of_bus_isa_map,
1106 .translate = of_bus_isa_translate,
1108 #endif /* CONFIG_OF_ISA_BUS */
1113 .count_cells = fdt_support_default_count_cells,
1114 .map = of_bus_default_map,
1115 .translate = of_bus_default_translate,
1119 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1123 if (ARRAY_SIZE(of_busses) == 1)
1126 for (bus = of_busses; bus; bus++) {
1127 if (!bus->match || bus->match(blob, parentoffset))
1132 * We should always have matched the default bus at least, since
1133 * it has a NULL match field. If we didn't then it somehow isn't
1134 * in the of_busses array or something equally catastrophic has
1141 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1142 struct of_bus *pbus, fdt32_t *addr,
1143 int na, int ns, int pna, const char *rprop)
1145 const fdt32_t *ranges;
1148 u64 offset = OF_BAD_ADDR;
1150 /* Normally, an absence of a "ranges" property means we are
1151 * crossing a non-translatable boundary, and thus the addresses
1152 * below the current not cannot be converted to CPU physical ones.
1153 * Unfortunately, while this is very clear in the spec, it's not
1154 * what Apple understood, and they do have things like /uni-n or
1155 * /ht nodes with no "ranges" property and a lot of perfectly
1156 * useable mapped devices below them. Thus we treat the absence of
1157 * "ranges" as equivalent to an empty "ranges" property which means
1158 * a 1:1 translation at that level. It's up to the caller not to try
1159 * to translate addresses that aren't supposed to be translated in
1160 * the first place. --BenH.
1162 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1163 if (ranges == NULL || rlen == 0) {
1164 offset = fdt_read_number(addr, na);
1165 memset(addr, 0, pna * 4);
1166 debug("OF: no ranges, 1:1 translation\n");
1170 debug("OF: walking ranges...\n");
1172 /* Now walk through the ranges */
1174 rone = na + pna + ns;
1175 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1176 offset = bus->map(addr, ranges, na, ns, pna);
1177 if (offset != OF_BAD_ADDR)
1180 if (offset == OF_BAD_ADDR) {
1181 debug("OF: not found !\n");
1184 memcpy(addr, ranges + na, 4 * pna);
1187 of_dump_addr("OF: parent translation for:", addr, pna);
1188 debug("OF: with offset: %llu\n", offset);
1190 /* Translate it into parent bus space */
1191 return pbus->translate(addr, offset, pna);
1195 * Translate an address from the device-tree into a CPU physical address,
1196 * this walks up the tree and applies the various bus mappings on the
1199 * Note: We consider that crossing any level with #size-cells == 0 to mean
1200 * that translation is impossible (that is we are not dealing with a value
1201 * that can be mapped to a cpu physical address). This is not really specified
1202 * that way, but this is traditionally the way IBM at least do things
1204 static u64 __of_translate_address(const void *blob, int node_offset,
1205 const fdt32_t *in_addr, const char *rprop)
1208 struct of_bus *bus, *pbus;
1209 fdt32_t addr[OF_MAX_ADDR_CELLS];
1210 int na, ns, pna, pns;
1211 u64 result = OF_BAD_ADDR;
1213 debug("OF: ** translation for device %s **\n",
1214 fdt_get_name(blob, node_offset, NULL));
1216 /* Get parent & match bus type */
1217 parent = fdt_parent_offset(blob, node_offset);
1220 bus = of_match_bus(blob, parent);
1222 /* Cound address cells & copy address locally */
1223 bus->count_cells(blob, parent, &na, &ns);
1224 if (!OF_CHECK_COUNTS(na, ns)) {
1225 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1226 fdt_get_name(blob, node_offset, NULL));
1229 memcpy(addr, in_addr, na * 4);
1231 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1232 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1233 of_dump_addr("OF: translating address:", addr, na);
1237 /* Switch to parent bus */
1238 node_offset = parent;
1239 parent = fdt_parent_offset(blob, node_offset);
1241 /* If root, we have finished */
1243 debug("OF: reached root node\n");
1244 result = fdt_read_number(addr, na);
1248 /* Get new parent bus and counts */
1249 pbus = of_match_bus(blob, parent);
1250 pbus->count_cells(blob, parent, &pna, &pns);
1251 if (!OF_CHECK_COUNTS(pna, pns)) {
1252 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1253 fdt_get_name(blob, node_offset, NULL));
1257 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1258 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1260 /* Apply bus translation */
1261 if (of_translate_one(blob, node_offset, bus, pbus,
1262 addr, na, ns, pna, rprop))
1265 /* Complete the move up one level */
1270 of_dump_addr("OF: one level translation:", addr, na);
1277 u64 fdt_translate_address(const void *blob, int node_offset,
1278 const fdt32_t *in_addr)
1280 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1284 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1285 * who's reg property matches a physical cpu address
1287 * @blob: ptr to device tree
1288 * @compat: compatiable string to match
1289 * @compat_off: property name
1292 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1293 phys_addr_t compat_off)
1295 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1296 while (off != -FDT_ERR_NOTFOUND) {
1297 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1299 if (compat_off == fdt_translate_address(blob, off, reg))
1302 off = fdt_node_offset_by_compatible(blob, off, compat);
1305 return -FDT_ERR_NOTFOUND;
1309 * fdt_alloc_phandle: Return next free phandle value
1311 * @blob: ptr to device tree
1313 int fdt_alloc_phandle(void *blob)
1316 uint32_t phandle = 0;
1318 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1319 offset = fdt_next_node(blob, offset, NULL)) {
1320 phandle = max(phandle, fdt_get_phandle(blob, offset));
1327 * fdt_set_phandle: Create a phandle property for the given node
1329 * @fdt: ptr to device tree
1330 * @nodeoffset: node to update
1331 * @phandle: phandle value to set (must be unique)
1333 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1338 int off = fdt_node_offset_by_phandle(fdt, phandle);
1340 if ((off >= 0) && (off != nodeoffset)) {
1343 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1344 printf("Trying to update node %s with phandle %u ",
1347 fdt_get_path(fdt, off, buf, sizeof(buf));
1348 printf("that already exists in node %s.\n", buf);
1349 return -FDT_ERR_BADPHANDLE;
1353 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1358 * For now, also set the deprecated "linux,phandle" property, so that we
1359 * don't break older kernels.
1361 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1367 * fdt_create_phandle: Create a phandle property for the given node
1369 * @fdt: ptr to device tree
1370 * @nodeoffset: node to update
1372 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1374 /* see if there is a phandle already */
1375 int phandle = fdt_get_phandle(fdt, nodeoffset);
1377 /* if we got 0, means no phandle so create one */
1381 phandle = fdt_alloc_phandle(fdt);
1382 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1384 printf("Can't set phandle %u: %s\n", phandle,
1394 * fdt_set_node_status: Set status for the given node
1396 * @fdt: ptr to device tree
1397 * @nodeoffset: node to update
1398 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1399 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1400 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1402 int fdt_set_node_status(void *fdt, int nodeoffset,
1403 enum fdt_status status, unsigned int error_code)
1412 case FDT_STATUS_OKAY:
1413 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1415 case FDT_STATUS_DISABLED:
1416 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1418 case FDT_STATUS_FAIL:
1419 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1421 case FDT_STATUS_FAIL_ERROR_CODE:
1422 sprintf(buf, "fail-%d", error_code);
1423 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1426 printf("Invalid fdt status: %x\n", status);
1435 * fdt_set_status_by_alias: Set status for the given node given an alias
1437 * @fdt: ptr to device tree
1438 * @alias: alias of node to update
1439 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1440 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1441 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1443 int fdt_set_status_by_alias(void *fdt, const char* alias,
1444 enum fdt_status status, unsigned int error_code)
1446 int offset = fdt_path_offset(fdt, alias);
1448 return fdt_set_node_status(fdt, offset, status, error_code);
1451 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1452 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1457 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1458 if (noff != -FDT_ERR_NOTFOUND) {
1459 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1461 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1462 if (ret == -FDT_ERR_NOSPACE) {
1463 ret = fdt_increase_size(blob, 512);
1468 } else if (ret < 0) {
1469 printf("Can't add property: %s\n", fdt_strerror(ret));
1475 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1481 * Verify the physical address of device tree node for a given alias
1483 * This function locates the device tree node of a given alias, and then
1484 * verifies that the physical address of that device matches the given
1485 * parameter. It displays a message if there is a mismatch.
1487 * Returns 1 on success, 0 on failure
1489 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1496 path = fdt_getprop(fdt, anode, alias, NULL);
1498 /* If there's no such alias, then it's not a failure */
1502 node = fdt_path_offset(fdt, path);
1504 printf("Warning: device tree alias '%s' points to invalid "
1505 "node %s.\n", alias, path);
1509 reg = fdt_getprop(fdt, node, "reg", &len);
1511 printf("Warning: device tree node '%s' has no address.\n",
1516 dt_addr = fdt_translate_address(fdt, node, reg);
1517 if (addr != dt_addr) {
1518 printf("Warning: U-Boot configured device %s at address %llu,\n"
1519 "but the device tree has it address %llx.\n",
1520 alias, addr, dt_addr);
1528 * Returns the base address of an SOC or PCI node
1530 u64 fdt_get_base_address(const void *fdt, int node)
1533 const fdt32_t *prop;
1535 prop = fdt_getprop(fdt, node, "reg", &size);
1537 return prop ? fdt_translate_address(fdt, node, prop) : 0;
1541 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1543 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1544 uint64_t *val, int cells)
1546 const fdt32_t *prop32 = &prop[cell_off];
1547 const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1549 if ((cell_off + cells) > prop_len)
1550 return -FDT_ERR_NOSPACE;
1554 *val = fdt32_to_cpu(*prop32);
1557 *val = fdt64_to_cpu(*prop64);
1560 return -FDT_ERR_NOSPACE;
1567 * fdt_read_range - Read a node's n'th range property
1569 * @fdt: ptr to device tree
1570 * @node: offset of node
1572 * @child_addr: pointer to storage for the "child address" field
1573 * @addr: pointer to storage for the CPU view translated physical start
1574 * @len: pointer to storage for the range length
1576 * Convenience function that reads and interprets a specific range out of
1577 * a number of the "ranges" property array.
1579 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1580 uint64_t *addr, uint64_t *len)
1582 int pnode = fdt_parent_offset(fdt, node);
1583 const fdt32_t *ranges;
1592 * The "ranges" property is an array of
1593 * { <child address> <parent address> <size in child address space> }
1595 * All 3 elements can span a diffent number of cells. Fetch their size.
1597 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1598 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1599 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1601 /* Now try to get the ranges property */
1602 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1604 return -FDT_ERR_NOTFOUND;
1605 ranges_len /= sizeof(uint32_t);
1607 /* Jump to the n'th entry */
1608 cell = n * (pacells + acells + scells);
1610 /* Read <child address> */
1612 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1619 /* Read <parent address> */
1621 *addr = fdt_translate_address(fdt, node, ranges + cell);
1624 /* Read <size in child address space> */
1626 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1635 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1637 * @fdt: ptr to device tree
1638 * @node: offset of the simplefb node
1639 * @base_address: framebuffer base address
1640 * @width: width in pixels
1641 * @height: height in pixels
1642 * @stride: bytes per line
1643 * @format: pixel format string
1645 * Convenience function to fill and enable a simplefb node.
1647 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1648 u32 height, u32 stride, const char *format)
1652 int i, addrc, sizec, ret;
1654 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1658 cells[i++] = cpu_to_fdt32(base_address >> 32);
1659 cells[i++] = cpu_to_fdt32(base_address);
1662 cells[i++] = cpu_to_fdt32(height * stride);
1664 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1668 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1669 ret = fdt_set_name(fdt, node, name);
1673 ret = fdt_setprop_u32(fdt, node, "width", width);
1677 ret = fdt_setprop_u32(fdt, node, "height", height);
1681 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1685 ret = fdt_setprop_string(fdt, node, "format", format);
1689 ret = fdt_setprop_string(fdt, node, "status", "okay");
1697 * Update native-mode in display-timings from display environment variable.
1698 * The node to update are specified by path.
1700 int fdt_fixup_display(void *blob, const char *path, const char *display)
1704 if (!display || !path)
1705 return -FDT_ERR_NOTFOUND;
1707 toff = fdt_path_offset(blob, path);
1709 toff = fdt_subnode_offset(blob, toff, "display-timings");
1713 for (off = fdt_first_subnode(blob, toff);
1715 off = fdt_next_subnode(blob, off)) {
1716 uint32_t h = fdt_get_phandle(blob, off);
1717 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1719 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1720 return fdt_setprop_u32(blob, toff, "native-mode", h);
1725 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1727 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1729 * @fdt: ptr to device tree
1730 * @fdto: ptr to device tree overlay
1732 * Convenience function to apply an overlay and display helpful messages
1733 * in the case of an error
1735 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1740 err = fdt_path_offset(fdt, "/__symbols__");
1741 has_symbols = err >= 0;
1743 err = fdt_overlay_apply(fdt, fdto);
1745 printf("failed on fdt_overlay_apply(): %s\n",
1748 printf("base fdt does did not have a /__symbols__ node\n");
1749 printf("make sure you've compiled with -@\n");