1 // SPDX-License-Identifier: GPL-2.0+
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
6 * Copyright 2010-2011 Freescale Semiconductor, Inc.
12 #include <stdio_dev.h>
13 #include <linux/ctype.h>
14 #include <linux/types.h>
15 #include <asm/global_data.h>
16 #include <linux/libfdt.h>
17 #include <fdt_support.h>
22 * fdt_getprop_u32_default_node - Return a node's property or a default
24 * @fdt: ptr to device tree
25 * @off: offset of node
26 * @cell: cell offset in property
27 * @prop: property name
28 * @dflt: default value if the property isn't found
30 * Convenience function to return a node's property or a default value if
31 * the property doesn't exist.
33 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
34 const char *prop, const u32 dflt)
39 val = fdt_getprop(fdt, off, prop, &len);
41 /* Check if property exists */
45 /* Check if property is long enough */
46 if (len < ((cell + 1) * sizeof(uint32_t)))
49 return fdt32_to_cpu(*val);
53 * fdt_getprop_u32_default - Find a node and return it's property or a default
55 * @fdt: ptr to device tree
57 * @prop: property name
58 * @dflt: default value if the property isn't found
60 * Convenience function to find a node and return it's property or a
61 * default value if it doesn't exist.
63 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
64 const char *prop, const u32 dflt)
68 off = fdt_path_offset(fdt, path);
72 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
76 * fdt_find_and_setprop: Find a node and set it's property
78 * @fdt: ptr to device tree
80 * @prop: property name
81 * @val: ptr to new value
82 * @len: length of new property value
83 * @create: flag to create the property if it doesn't exist
85 * Convenience function to directly set a property given the path to the node.
87 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
88 const void *val, int len, int create)
90 int nodeoff = fdt_path_offset(fdt, node);
95 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
96 return 0; /* create flag not set; so exit quietly */
98 return fdt_setprop(fdt, nodeoff, prop, val, len);
102 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
104 * @fdt: pointer to the device tree blob
105 * @parentoffset: structure block offset of a node
106 * @name: name of the subnode to locate
108 * fdt_subnode_offset() finds a subnode of the node with a given name.
109 * If the subnode does not exist, it will be created.
111 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
115 offset = fdt_subnode_offset(fdt, parentoffset, name);
117 if (offset == -FDT_ERR_NOTFOUND)
118 offset = fdt_add_subnode(fdt, parentoffset, name);
121 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
126 /* rename to CONFIG_OF_STDOUT_PATH ? */
127 #if defined(OF_STDOUT_PATH)
128 static int fdt_fixup_stdout(void *fdt, int chosenoff)
130 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
131 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
133 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
134 static int fdt_fixup_stdout(void *fdt, int chosenoff)
138 char sername[9] = { 0 };
141 char tmp[256]; /* long enough */
143 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
145 aliasoff = fdt_path_offset(fdt, "/aliases");
151 path = fdt_getprop(fdt, aliasoff, sername, &len);
157 /* fdt_setprop may break "path" so we copy it to tmp buffer */
158 memcpy(tmp, path, len);
160 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
162 printf("WARNING: could not set linux,stdout-path %s.\n",
168 printf("WARNING: %s: could not read %s alias: %s\n",
169 __func__, sername, fdt_strerror(err));
174 static int fdt_fixup_stdout(void *fdt, int chosenoff)
180 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
181 uint64_t val, int is_u64)
184 return fdt_setprop_u64(fdt, nodeoffset, name, val);
186 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
189 int fdt_root(void *fdt)
194 err = fdt_check_header(fdt);
196 printf("fdt_root: %s\n", fdt_strerror(err));
200 serial = env_get("serial#");
202 err = fdt_setprop(fdt, 0, "serial-number", serial,
206 printf("WARNING: could not set serial-number %s.\n",
215 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
222 /* just return if the size of initrd is zero */
223 if (initrd_start == initrd_end)
226 /* find or create "/chosen" node. */
227 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
231 total = fdt_num_mem_rsv(fdt);
234 * Look for an existing entry and update it. If we don't find
235 * the entry, we will j be the next available slot.
237 for (j = 0; j < total; j++) {
238 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
239 if (addr == initrd_start) {
240 fdt_del_mem_rsv(fdt, j);
245 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
247 printf("fdt_initrd: %s\n", fdt_strerror(err));
251 is_u64 = (fdt_address_cells(fdt, 0) == 2);
253 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
254 (uint64_t)initrd_start, is_u64);
257 printf("WARNING: could not set linux,initrd-start %s.\n",
262 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
263 (uint64_t)initrd_end, is_u64);
266 printf("WARNING: could not set linux,initrd-end %s.\n",
275 int fdt_chosen(void *fdt)
279 char *str; /* used to set string properties */
281 err = fdt_check_header(fdt);
283 printf("fdt_chosen: %s\n", fdt_strerror(err));
287 /* find or create "/chosen" node. */
288 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
292 str = env_get("bootargs");
294 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
297 printf("WARNING: could not set bootargs %s.\n",
303 return fdt_fixup_stdout(fdt, nodeoffset);
306 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
307 const void *val, int len, int create)
311 debug("Updating property '%s/%s' = ", path, prop);
312 for (i = 0; i < len; i++)
313 debug(" %.2x", *(u8*)(val+i));
316 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
318 printf("Unable to update property %s:%s, err=%s\n",
319 path, prop, fdt_strerror(rc));
322 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
325 fdt32_t tmp = cpu_to_fdt32(val);
326 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
329 void do_fixup_by_prop(void *fdt,
330 const char *pname, const void *pval, int plen,
331 const char *prop, const void *val, int len,
337 debug("Updating property '%s' = ", prop);
338 for (i = 0; i < len; i++)
339 debug(" %.2x", *(u8*)(val+i));
342 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
343 while (off != -FDT_ERR_NOTFOUND) {
344 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
345 fdt_setprop(fdt, off, prop, val, len);
346 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
350 void do_fixup_by_prop_u32(void *fdt,
351 const char *pname, const void *pval, int plen,
352 const char *prop, u32 val, int create)
354 fdt32_t tmp = cpu_to_fdt32(val);
355 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
358 void do_fixup_by_compat(void *fdt, const char *compat,
359 const char *prop, const void *val, int len, int create)
364 debug("Updating property '%s' = ", prop);
365 for (i = 0; i < len; i++)
366 debug(" %.2x", *(u8*)(val+i));
369 off = fdt_node_offset_by_compatible(fdt, -1, compat);
370 while (off != -FDT_ERR_NOTFOUND) {
371 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
372 fdt_setprop(fdt, off, prop, val, len);
373 off = fdt_node_offset_by_compatible(fdt, off, compat);
377 void do_fixup_by_compat_u32(void *fdt, const char *compat,
378 const char *prop, u32 val, int create)
380 fdt32_t tmp = cpu_to_fdt32(val);
381 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
384 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
386 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
388 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
392 int address_cells = fdt_address_cells(fdt, 0);
393 int size_cells = fdt_size_cells(fdt, 0);
396 for (i = 0; i < n; i++) {
397 if (address_cells == 2)
398 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
400 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
401 p += 4 * address_cells;
404 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
406 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
410 return p - (char *)buf;
413 #if CONFIG_NR_DRAM_BANKS > 4
414 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
416 #define MEMORY_BANKS_MAX 4
418 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
422 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
424 if (banks > MEMORY_BANKS_MAX) {
425 printf("%s: num banks %d exceeds hardcoded limit %d."
426 " Recompile with higher MEMORY_BANKS_MAX?\n",
427 __FUNCTION__, banks, MEMORY_BANKS_MAX);
431 err = fdt_check_header(blob);
433 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
437 /* find or create "/memory" node. */
438 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
442 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
445 printf("WARNING: could not set %s %s.\n", "device_type",
450 for (i = 0; i < banks; i++) {
451 if (start[i] == 0 && size[i] == 0)
460 len = fdt_pack_reg(blob, tmp, start, size, banks);
462 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
464 printf("WARNING: could not set %s %s.\n",
465 "reg", fdt_strerror(err));
472 int fdt_fixup_memory(void *blob, u64 start, u64 size)
474 return fdt_fixup_memory_banks(blob, &start, &size, 1);
477 void fdt_fixup_ethernet(void *fdt)
483 unsigned char mac_addr[ARP_HLEN];
485 #ifdef FDT_SEQ_MACADDR_FROM_ENV
487 const struct fdt_property *fdt_prop;
490 if (fdt_path_offset(fdt, "/aliases") < 0)
493 /* Cycle through all aliases */
494 for (prop = 0; ; prop++) {
497 /* FDT might have been edited, recompute the offset */
498 offset = fdt_first_property_offset(fdt,
499 fdt_path_offset(fdt, "/aliases"));
500 /* Select property number 'prop' */
501 for (j = 0; j < prop; j++)
502 offset = fdt_next_property_offset(fdt, offset);
507 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
508 if (!strncmp(name, "ethernet", 8)) {
509 /* Treat plain "ethernet" same as "ethernet0". */
510 if (!strcmp(name, "ethernet")
511 #ifdef FDT_SEQ_MACADDR_FROM_ENV
512 || !strcmp(name, "ethernet0")
516 #ifndef FDT_SEQ_MACADDR_FROM_ENV
518 i = trailing_strtol(name);
522 strcpy(mac, "ethaddr");
524 sprintf(mac, "eth%daddr", i);
528 #ifdef FDT_SEQ_MACADDR_FROM_ENV
529 nodeoff = fdt_path_offset(fdt, path);
530 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
532 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
540 for (j = 0; j < 6; j++) {
542 simple_strtoul(tmp, &end, 16) : 0;
544 tmp = (*end) ? end + 1 : end;
547 do_fixup_by_path(fdt, path, "mac-address",
549 do_fixup_by_path(fdt, path, "local-mac-address",
555 int fdt_record_loadable(void *blob, u32 index, const char *name,
556 uintptr_t load_addr, u32 size, uintptr_t entry_point,
557 const char *type, const char *os)
561 err = fdt_check_header(blob);
563 printf("%s: %s\n", __func__, fdt_strerror(err));
567 /* find or create "/fit-images" node */
568 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
572 /* find or create "/fit-images/<name>" node */
573 node = fdt_find_or_add_subnode(blob, node, name);
578 * We record these as 32bit entities, possibly truncating addresses.
579 * However, spl_fit.c is not 64bit safe either: i.e. we should not
580 * have an issue here.
582 fdt_setprop_u32(blob, node, "load-addr", load_addr);
583 if (entry_point != -1)
584 fdt_setprop_u32(blob, node, "entry-point", entry_point);
585 fdt_setprop_u32(blob, node, "size", size);
587 fdt_setprop_string(blob, node, "type", type);
589 fdt_setprop_string(blob, node, "os", os);
594 /* Resize the fdt to its actual size + a bit of padding */
595 int fdt_shrink_to_minimum(void *blob, uint extrasize)
606 total = fdt_num_mem_rsv(blob);
607 for (i = 0; i < total; i++) {
608 fdt_get_mem_rsv(blob, i, &addr, &size);
609 if (addr == (uintptr_t)blob) {
610 fdt_del_mem_rsv(blob, i);
617 * Calculate the actual size of the fdt
618 * plus the size needed for 5 fdt_add_mem_rsv, one
619 * for the fdt itself and 4 for a possible initrd
620 * ((initrd-start + initrd-end) * 2 (name & value))
622 actualsize = fdt_off_dt_strings(blob) +
623 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
625 actualsize += extrasize;
626 /* Make it so the fdt ends on a page boundary */
627 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
628 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
630 /* Change the fdt header to reflect the correct size */
631 fdt_set_totalsize(blob, actualsize);
634 /* Add the new reservation */
635 ret = fdt_add_mem_rsv(blob, map_to_sysmem(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] |= cpu_to_fdt32(FDT_PCI_MEM64);
677 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
678 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
679 dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
680 #ifdef CONFIG_SYS_PCI_64BIT
681 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
685 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
688 dma_range[3] = cpu_to_fdt32(phys_start >> 32);
689 dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
691 dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
695 dma_range[3 + addrcell + 0] =
696 cpu_to_fdt32(size >> 32);
697 dma_range[3 + addrcell + 1] =
698 cpu_to_fdt32(size & 0xffffffff);
700 dma_range[3 + addrcell + 0] =
701 cpu_to_fdt32(size & 0xffffffff);
704 dma_range += (3 + addrcell + sizecell);
707 len = dma_range - &dma_ranges[0];
709 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
715 int fdt_increase_size(void *fdt, int add_len)
719 newlen = fdt_totalsize(fdt) + add_len;
721 /* Open in place with a new len */
722 return fdt_open_into(fdt, fdt, newlen);
725 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
726 #include <jffs2/load_kernel.h>
727 #include <mtd_node.h>
729 static int fdt_del_subnodes(const void *blob, int parent_offset)
734 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
735 (off >= 0) && (ndepth > 0);
736 off = fdt_next_node(blob, off, &ndepth)) {
738 debug("delete %s: offset: %x\n",
739 fdt_get_name(blob, off, 0), off);
740 ret = fdt_del_node((void *)blob, off);
742 printf("Can't delete node: %s\n",
754 static int fdt_del_partitions(void *blob, int parent_offset)
761 off = fdt_next_node(blob, parent_offset, &ndepth);
762 if (off > 0 && ndepth == 1) {
763 prop = fdt_getprop(blob, off, "label", NULL);
766 * Could not find label property, nand {}; node?
767 * Check subnode, delete partitions there if any.
769 return fdt_del_partitions(blob, off);
771 ret = fdt_del_subnodes(blob, parent_offset);
773 printf("Can't remove subnodes: %s\n",
782 int fdt_node_set_part_info(void *blob, int parent_offset,
783 struct mtd_device *dev)
785 struct list_head *pentry;
786 struct part_info *part;
792 ret = fdt_del_partitions(blob, parent_offset);
797 * Check if size/address is 1 or 2 cells.
798 * We assume #address-cells and #size-cells have same value.
800 sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
801 0, "#size-cells", 1);
804 * Check if it is nand {}; subnode, adjust
805 * the offset in this case
807 off = fdt_next_node(blob, parent_offset, &ndepth);
808 if (off > 0 && ndepth == 1)
812 list_for_each_prev(pentry, &dev->parts) {
815 part = list_entry(pentry, struct part_info, link);
817 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
818 part_num, part->name, part->size,
819 part->offset, part->mask_flags);
821 sprintf(buf, "partition@%llx", part->offset);
823 ret = fdt_add_subnode(blob, parent_offset, buf);
824 if (ret == -FDT_ERR_NOSPACE) {
825 ret = fdt_increase_size(blob, 512);
830 } else if (ret < 0) {
831 printf("Can't add partition node: %s\n",
837 /* Check MTD_WRITEABLE_CMD flag */
838 if (part->mask_flags & 1) {
840 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
841 if (ret == -FDT_ERR_NOSPACE) {
842 ret = fdt_increase_size(blob, 512);
853 ret = fdt_setprop_u64(blob, newoff,
854 "reg", part->offset);
856 ret = fdt_appendprop_u64(blob, newoff,
859 ret = fdt_setprop_u32(blob, newoff,
860 "reg", part->offset);
862 ret = fdt_appendprop_u32(blob, newoff,
866 if (ret == -FDT_ERR_NOSPACE) {
867 ret = fdt_increase_size(blob, 512);
876 ret = fdt_setprop_string(blob, newoff, "label", part->name);
877 if (ret == -FDT_ERR_NOSPACE) {
878 ret = fdt_increase_size(blob, 512);
890 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
893 printf("Can't add property: %s\n", fdt_strerror(ret));
898 * Update partitions in nor/nand nodes using info from
899 * mtdparts environment variable. The nodes to update are
900 * specified by node_info structure which contains mtd device
901 * type and compatible string: E. g. the board code in
902 * ft_board_setup() could use:
904 * struct node_info nodes[] = {
905 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
906 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
909 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
911 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
914 struct mtd_device *dev;
918 if (mtdparts_init() != 0)
921 for (i = 0; i < node_info_size; i++) {
923 noff = fdt_node_offset_by_compatible(blob, -1,
924 node_info[i].compat);
925 while (noff != -FDT_ERR_NOTFOUND) {
926 debug("%s: %s, mtd dev type %d\n",
927 fdt_get_name(blob, noff, 0),
928 node_info[i].compat, node_info[i].type);
929 dev = device_find(node_info[i].type, idx++);
931 if (fdt_node_set_part_info(blob, noff, dev))
932 return; /* return on error */
935 /* Jump to next flash node */
936 noff = fdt_node_offset_by_compatible(blob, noff,
937 node_info[i].compat);
943 void fdt_del_node_and_alias(void *blob, const char *alias)
945 int off = fdt_path_offset(blob, alias);
950 fdt_del_node(blob, off);
952 off = fdt_path_offset(blob, "/aliases");
953 fdt_delprop(blob, off, alias);
956 /* Max address size we deal with */
957 #define OF_MAX_ADDR_CELLS 4
958 #define OF_BAD_ADDR FDT_ADDR_T_NONE
959 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
964 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
968 printf(" %08x", *(addr++));
972 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
976 * struct of_bus - Callbacks for bus specific translators
977 * @name: A string used to identify this bus in debug output.
978 * @addresses: The name of the DT property from which addresses are
979 * to be read, typically "reg".
980 * @match: Return non-zero if the node whose parent is at
981 * parentoffset in the FDT blob corresponds to a bus
982 * of this type, otherwise return zero. If NULL a match
984 * @count_cells:Count how many cells (be32 values) a node whose parent
985 * is at parentoffset in the FDT blob will require to
986 * represent its address (written to *addrc) & size
987 * (written to *sizec).
988 * @map: Map the address addr from the address space of this
989 * bus to that of its parent, making use of the ranges
990 * read from DT to an array at range. na and ns are the
991 * number of cells (be32 values) used to hold and address
992 * or size, respectively, for this bus. pna is the number
993 * of cells used to hold an address for the parent bus.
994 * Returns the address in the address space of the parent
996 * @translate: Update the value of the address cells at addr within an
997 * FDT by adding offset to it. na specifies the number of
998 * cells used to hold the address being translated. Returns
999 * zero on success, non-zero on error.
1001 * Each bus type will include a struct of_bus in the of_busses array,
1002 * providing implementations of some or all of the functions used to
1003 * match the bus & handle address translation for its children.
1007 const char *addresses;
1008 int (*match)(const void *blob, int parentoffset);
1009 void (*count_cells)(const void *blob, int parentoffset,
1010 int *addrc, int *sizec);
1011 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1012 int na, int ns, int pna);
1013 int (*translate)(fdt32_t *addr, u64 offset, int na);
1016 /* Default translator (generic bus) */
1017 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1018 int *addrc, int *sizec)
1020 const fdt32_t *prop;
1023 *addrc = fdt_address_cells(blob, parentoffset);
1026 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1028 *sizec = be32_to_cpup(prop);
1034 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1035 int na, int ns, int pna)
1039 cp = fdt_read_number(range, na);
1040 s = fdt_read_number(range + na + pna, ns);
1041 da = fdt_read_number(addr, na);
1043 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1045 if (da < cp || da >= (cp + s))
1050 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1052 u64 a = fdt_read_number(addr, na);
1053 memset(addr, 0, na * 4);
1056 addr[na - 2] = cpu_to_fdt32(a >> 32);
1057 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1062 #ifdef CONFIG_OF_ISA_BUS
1064 /* ISA bus translator */
1065 static int of_bus_isa_match(const void *blob, int parentoffset)
1069 name = fdt_get_name(blob, parentoffset, NULL);
1073 return !strcmp(name, "isa");
1076 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1077 int *addrc, int *sizec)
1085 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1086 int na, int ns, int pna)
1090 /* Check address type match */
1091 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1094 cp = fdt_read_number(range + 1, na - 1);
1095 s = fdt_read_number(range + na + pna, ns);
1096 da = fdt_read_number(addr + 1, na - 1);
1098 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1100 if (da < cp || da >= (cp + s))
1105 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1107 return of_bus_default_translate(addr + 1, offset, na - 1);
1110 #endif /* CONFIG_OF_ISA_BUS */
1112 /* Array of bus specific translators */
1113 static struct of_bus of_busses[] = {
1114 #ifdef CONFIG_OF_ISA_BUS
1119 .match = of_bus_isa_match,
1120 .count_cells = of_bus_isa_count_cells,
1121 .map = of_bus_isa_map,
1122 .translate = of_bus_isa_translate,
1124 #endif /* CONFIG_OF_ISA_BUS */
1129 .count_cells = fdt_support_default_count_cells,
1130 .map = of_bus_default_map,
1131 .translate = of_bus_default_translate,
1135 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1139 if (ARRAY_SIZE(of_busses) == 1)
1142 for (bus = of_busses; bus; bus++) {
1143 if (!bus->match || bus->match(blob, parentoffset))
1148 * We should always have matched the default bus at least, since
1149 * it has a NULL match field. If we didn't then it somehow isn't
1150 * in the of_busses array or something equally catastrophic has
1157 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1158 struct of_bus *pbus, fdt32_t *addr,
1159 int na, int ns, int pna, const char *rprop)
1161 const fdt32_t *ranges;
1164 u64 offset = OF_BAD_ADDR;
1166 /* Normally, an absence of a "ranges" property means we are
1167 * crossing a non-translatable boundary, and thus the addresses
1168 * below the current not cannot be converted to CPU physical ones.
1169 * Unfortunately, while this is very clear in the spec, it's not
1170 * what Apple understood, and they do have things like /uni-n or
1171 * /ht nodes with no "ranges" property and a lot of perfectly
1172 * useable mapped devices below them. Thus we treat the absence of
1173 * "ranges" as equivalent to an empty "ranges" property which means
1174 * a 1:1 translation at that level. It's up to the caller not to try
1175 * to translate addresses that aren't supposed to be translated in
1176 * the first place. --BenH.
1178 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1179 if (ranges == NULL || rlen == 0) {
1180 offset = fdt_read_number(addr, na);
1181 memset(addr, 0, pna * 4);
1182 debug("OF: no ranges, 1:1 translation\n");
1186 debug("OF: walking ranges...\n");
1188 /* Now walk through the ranges */
1190 rone = na + pna + ns;
1191 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1192 offset = bus->map(addr, ranges, na, ns, pna);
1193 if (offset != OF_BAD_ADDR)
1196 if (offset == OF_BAD_ADDR) {
1197 debug("OF: not found !\n");
1200 memcpy(addr, ranges + na, 4 * pna);
1203 of_dump_addr("OF: parent translation for:", addr, pna);
1204 debug("OF: with offset: %llu\n", offset);
1206 /* Translate it into parent bus space */
1207 return pbus->translate(addr, offset, pna);
1211 * Translate an address from the device-tree into a CPU physical address,
1212 * this walks up the tree and applies the various bus mappings on the
1215 * Note: We consider that crossing any level with #size-cells == 0 to mean
1216 * that translation is impossible (that is we are not dealing with a value
1217 * that can be mapped to a cpu physical address). This is not really specified
1218 * that way, but this is traditionally the way IBM at least do things
1220 static u64 __of_translate_address(const void *blob, int node_offset,
1221 const fdt32_t *in_addr, const char *rprop)
1224 struct of_bus *bus, *pbus;
1225 fdt32_t addr[OF_MAX_ADDR_CELLS];
1226 int na, ns, pna, pns;
1227 u64 result = OF_BAD_ADDR;
1229 debug("OF: ** translation for device %s **\n",
1230 fdt_get_name(blob, node_offset, NULL));
1232 /* Get parent & match bus type */
1233 parent = fdt_parent_offset(blob, node_offset);
1236 bus = of_match_bus(blob, parent);
1238 /* Cound address cells & copy address locally */
1239 bus->count_cells(blob, parent, &na, &ns);
1240 if (!OF_CHECK_COUNTS(na, ns)) {
1241 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1242 fdt_get_name(blob, node_offset, NULL));
1245 memcpy(addr, in_addr, na * 4);
1247 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1248 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1249 of_dump_addr("OF: translating address:", addr, na);
1253 /* Switch to parent bus */
1254 node_offset = parent;
1255 parent = fdt_parent_offset(blob, node_offset);
1257 /* If root, we have finished */
1259 debug("OF: reached root node\n");
1260 result = fdt_read_number(addr, na);
1264 /* Get new parent bus and counts */
1265 pbus = of_match_bus(blob, parent);
1266 pbus->count_cells(blob, parent, &pna, &pns);
1267 if (!OF_CHECK_COUNTS(pna, pns)) {
1268 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1269 fdt_get_name(blob, node_offset, NULL));
1273 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1274 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1276 /* Apply bus translation */
1277 if (of_translate_one(blob, node_offset, bus, pbus,
1278 addr, na, ns, pna, rprop))
1281 /* Complete the move up one level */
1286 of_dump_addr("OF: one level translation:", addr, na);
1293 u64 fdt_translate_address(const void *blob, int node_offset,
1294 const fdt32_t *in_addr)
1296 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1299 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1300 const fdt32_t *in_addr)
1302 return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1306 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1307 * who's reg property matches a physical cpu address
1309 * @blob: ptr to device tree
1310 * @compat: compatiable string to match
1311 * @compat_off: property name
1314 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1315 phys_addr_t compat_off)
1317 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1318 while (off != -FDT_ERR_NOTFOUND) {
1319 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1321 if (compat_off == fdt_translate_address(blob, off, reg))
1324 off = fdt_node_offset_by_compatible(blob, off, compat);
1327 return -FDT_ERR_NOTFOUND;
1331 * fdt_alloc_phandle: Return next free phandle value
1333 * @blob: ptr to device tree
1335 int fdt_alloc_phandle(void *blob)
1338 uint32_t phandle = 0;
1340 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1341 offset = fdt_next_node(blob, offset, NULL)) {
1342 phandle = max(phandle, fdt_get_phandle(blob, offset));
1349 * fdt_set_phandle: Create a phandle property for the given node
1351 * @fdt: ptr to device tree
1352 * @nodeoffset: node to update
1353 * @phandle: phandle value to set (must be unique)
1355 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1360 int off = fdt_node_offset_by_phandle(fdt, phandle);
1362 if ((off >= 0) && (off != nodeoffset)) {
1365 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1366 printf("Trying to update node %s with phandle %u ",
1369 fdt_get_path(fdt, off, buf, sizeof(buf));
1370 printf("that already exists in node %s.\n", buf);
1371 return -FDT_ERR_BADPHANDLE;
1375 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1380 * For now, also set the deprecated "linux,phandle" property, so that we
1381 * don't break older kernels.
1383 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1389 * fdt_create_phandle: Create a phandle property for the given node
1391 * @fdt: ptr to device tree
1392 * @nodeoffset: node to update
1394 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1396 /* see if there is a phandle already */
1397 int phandle = fdt_get_phandle(fdt, nodeoffset);
1399 /* if we got 0, means no phandle so create one */
1403 phandle = fdt_alloc_phandle(fdt);
1404 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1406 printf("Can't set phandle %u: %s\n", phandle,
1416 * fdt_set_node_status: Set status for the given node
1418 * @fdt: ptr to device tree
1419 * @nodeoffset: node to update
1420 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1421 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1422 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1424 int fdt_set_node_status(void *fdt, int nodeoffset,
1425 enum fdt_status status, unsigned int error_code)
1434 case FDT_STATUS_OKAY:
1435 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1437 case FDT_STATUS_DISABLED:
1438 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1440 case FDT_STATUS_FAIL:
1441 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1443 case FDT_STATUS_FAIL_ERROR_CODE:
1444 sprintf(buf, "fail-%d", error_code);
1445 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1448 printf("Invalid fdt status: %x\n", status);
1457 * fdt_set_status_by_alias: Set status for the given node given an alias
1459 * @fdt: ptr to device tree
1460 * @alias: alias of node to update
1461 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1462 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1463 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1465 int fdt_set_status_by_alias(void *fdt, const char* alias,
1466 enum fdt_status status, unsigned int error_code)
1468 int offset = fdt_path_offset(fdt, alias);
1470 return fdt_set_node_status(fdt, offset, status, error_code);
1473 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1474 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1479 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1480 if (noff != -FDT_ERR_NOTFOUND) {
1481 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1483 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1484 if (ret == -FDT_ERR_NOSPACE) {
1485 ret = fdt_increase_size(blob, 512);
1490 } else if (ret < 0) {
1491 printf("Can't add property: %s\n", fdt_strerror(ret));
1497 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1503 * Verify the physical address of device tree node for a given alias
1505 * This function locates the device tree node of a given alias, and then
1506 * verifies that the physical address of that device matches the given
1507 * parameter. It displays a message if there is a mismatch.
1509 * Returns 1 on success, 0 on failure
1511 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1518 path = fdt_getprop(fdt, anode, alias, NULL);
1520 /* If there's no such alias, then it's not a failure */
1524 node = fdt_path_offset(fdt, path);
1526 printf("Warning: device tree alias '%s' points to invalid "
1527 "node %s.\n", alias, path);
1531 reg = fdt_getprop(fdt, node, "reg", &len);
1533 printf("Warning: device tree node '%s' has no address.\n",
1538 dt_addr = fdt_translate_address(fdt, node, reg);
1539 if (addr != dt_addr) {
1540 printf("Warning: U-Boot configured device %s at address %llu,\n"
1541 "but the device tree has it address %llx.\n",
1542 alias, addr, dt_addr);
1550 * Returns the base address of an SOC or PCI node
1552 u64 fdt_get_base_address(const void *fdt, int node)
1555 const fdt32_t *prop;
1557 prop = fdt_getprop(fdt, node, "reg", &size);
1559 return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1563 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1565 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1566 uint64_t *val, int cells)
1568 const fdt32_t *prop32 = &prop[cell_off];
1569 const unaligned_fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1571 if ((cell_off + cells) > prop_len)
1572 return -FDT_ERR_NOSPACE;
1576 *val = fdt32_to_cpu(*prop32);
1579 *val = fdt64_to_cpu(*prop64);
1582 return -FDT_ERR_NOSPACE;
1589 * fdt_read_range - Read a node's n'th range property
1591 * @fdt: ptr to device tree
1592 * @node: offset of node
1594 * @child_addr: pointer to storage for the "child address" field
1595 * @addr: pointer to storage for the CPU view translated physical start
1596 * @len: pointer to storage for the range length
1598 * Convenience function that reads and interprets a specific range out of
1599 * a number of the "ranges" property array.
1601 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1602 uint64_t *addr, uint64_t *len)
1604 int pnode = fdt_parent_offset(fdt, node);
1605 const fdt32_t *ranges;
1614 * The "ranges" property is an array of
1615 * { <child address> <parent address> <size in child address space> }
1617 * All 3 elements can span a diffent number of cells. Fetch their size.
1619 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1620 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1621 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1623 /* Now try to get the ranges property */
1624 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1626 return -FDT_ERR_NOTFOUND;
1627 ranges_len /= sizeof(uint32_t);
1629 /* Jump to the n'th entry */
1630 cell = n * (pacells + acells + scells);
1632 /* Read <child address> */
1634 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1641 /* Read <parent address> */
1643 *addr = fdt_translate_address(fdt, node, ranges + cell);
1646 /* Read <size in child address space> */
1648 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1657 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1659 * @fdt: ptr to device tree
1660 * @node: offset of the simplefb node
1661 * @base_address: framebuffer base address
1662 * @width: width in pixels
1663 * @height: height in pixels
1664 * @stride: bytes per line
1665 * @format: pixel format string
1667 * Convenience function to fill and enable a simplefb node.
1669 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1670 u32 height, u32 stride, const char *format)
1674 int i, addrc, sizec, ret;
1676 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1680 cells[i++] = cpu_to_fdt32(base_address >> 32);
1681 cells[i++] = cpu_to_fdt32(base_address);
1684 cells[i++] = cpu_to_fdt32(height * stride);
1686 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1690 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1691 ret = fdt_set_name(fdt, node, name);
1695 ret = fdt_setprop_u32(fdt, node, "width", width);
1699 ret = fdt_setprop_u32(fdt, node, "height", height);
1703 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1707 ret = fdt_setprop_string(fdt, node, "format", format);
1711 ret = fdt_setprop_string(fdt, node, "status", "okay");
1719 * Update native-mode in display-timings from display environment variable.
1720 * The node to update are specified by path.
1722 int fdt_fixup_display(void *blob, const char *path, const char *display)
1726 if (!display || !path)
1727 return -FDT_ERR_NOTFOUND;
1729 toff = fdt_path_offset(blob, path);
1731 toff = fdt_subnode_offset(blob, toff, "display-timings");
1735 for (off = fdt_first_subnode(blob, toff);
1737 off = fdt_next_subnode(blob, off)) {
1738 uint32_t h = fdt_get_phandle(blob, off);
1739 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1741 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1742 return fdt_setprop_u32(blob, toff, "native-mode", h);
1747 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1749 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1751 * @fdt: ptr to device tree
1752 * @fdto: ptr to device tree overlay
1754 * Convenience function to apply an overlay and display helpful messages
1755 * in the case of an error
1757 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1762 err = fdt_path_offset(fdt, "/__symbols__");
1763 has_symbols = err >= 0;
1765 err = fdt_overlay_apply(fdt, fdto);
1767 printf("failed on fdt_overlay_apply(): %s\n",
1770 printf("base fdt does did not have a /__symbols__ node\n");
1771 printf("make sure you've compiled with -@\n");