1 // SPDX-License-Identifier: GPL-2.0+
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
6 * Copyright 2010-2011 Freescale Semiconductor, Inc.
11 #include <stdio_dev.h>
12 #include <linux/ctype.h>
13 #include <linux/types.h>
14 #include <asm/global_data.h>
15 #include <linux/libfdt.h>
16 #include <fdt_support.h>
21 * fdt_getprop_u32_default_node - Return a node's property or a default
23 * @fdt: ptr to device tree
24 * @off: offset of node
25 * @cell: cell offset in property
26 * @prop: property name
27 * @dflt: default value if the property isn't found
29 * Convenience function to return a node's property or a default value if
30 * the property doesn't exist.
32 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
33 const char *prop, const u32 dflt)
38 val = fdt_getprop(fdt, off, prop, &len);
40 /* Check if property exists */
44 /* Check if property is long enough */
45 if (len < ((cell + 1) * sizeof(uint32_t)))
48 return fdt32_to_cpu(*val);
52 * fdt_getprop_u32_default - Find a node and return it's property or a default
54 * @fdt: ptr to device tree
56 * @prop: property name
57 * @dflt: default value if the property isn't found
59 * Convenience function to find a node and return it's property or a
60 * default value if it doesn't exist.
62 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
63 const char *prop, const u32 dflt)
67 off = fdt_path_offset(fdt, path);
71 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
75 * fdt_find_and_setprop: Find a node and set it's property
77 * @fdt: ptr to device tree
79 * @prop: property name
80 * @val: ptr to new value
81 * @len: length of new property value
82 * @create: flag to create the property if it doesn't exist
84 * Convenience function to directly set a property given the path to the node.
86 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
87 const void *val, int len, int create)
89 int nodeoff = fdt_path_offset(fdt, node);
94 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
95 return 0; /* create flag not set; so exit quietly */
97 return fdt_setprop(fdt, nodeoff, prop, val, len);
101 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
103 * @fdt: pointer to the device tree blob
104 * @parentoffset: structure block offset of a node
105 * @name: name of the subnode to locate
107 * fdt_subnode_offset() finds a subnode of the node with a given name.
108 * If the subnode does not exist, it will be created.
110 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
114 offset = fdt_subnode_offset(fdt, parentoffset, name);
116 if (offset == -FDT_ERR_NOTFOUND)
117 offset = fdt_add_subnode(fdt, parentoffset, name);
120 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
125 /* rename to CONFIG_OF_STDOUT_PATH ? */
126 #if defined(OF_STDOUT_PATH)
127 static int fdt_fixup_stdout(void *fdt, int chosenoff)
129 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
130 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
132 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
133 static int fdt_fixup_stdout(void *fdt, int chosenoff)
137 char sername[9] = { 0 };
140 char tmp[256]; /* long enough */
142 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
144 aliasoff = fdt_path_offset(fdt, "/aliases");
150 path = fdt_getprop(fdt, aliasoff, sername, &len);
156 /* fdt_setprop may break "path" so we copy it to tmp buffer */
157 memcpy(tmp, path, len);
159 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
161 printf("WARNING: could not set linux,stdout-path %s.\n",
167 printf("WARNING: %s: could not read %s alias: %s\n",
168 __func__, sername, fdt_strerror(err));
173 static int fdt_fixup_stdout(void *fdt, int chosenoff)
179 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
180 uint64_t val, int is_u64)
183 return fdt_setprop_u64(fdt, nodeoffset, name, val);
185 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
188 int fdt_root(void *fdt)
193 err = fdt_check_header(fdt);
195 printf("fdt_root: %s\n", fdt_strerror(err));
199 serial = env_get("serial#");
201 err = fdt_setprop(fdt, 0, "serial-number", serial,
205 printf("WARNING: could not set serial-number %s.\n",
214 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
221 /* just return if the size of initrd is zero */
222 if (initrd_start == initrd_end)
225 /* find or create "/chosen" node. */
226 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
230 total = fdt_num_mem_rsv(fdt);
233 * Look for an existing entry and update it. If we don't find
234 * the entry, we will j be the next available slot.
236 for (j = 0; j < total; j++) {
237 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
238 if (addr == initrd_start) {
239 fdt_del_mem_rsv(fdt, j);
244 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
246 printf("fdt_initrd: %s\n", fdt_strerror(err));
250 is_u64 = (fdt_address_cells(fdt, 0) == 2);
252 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
253 (uint64_t)initrd_start, is_u64);
256 printf("WARNING: could not set linux,initrd-start %s.\n",
261 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
262 (uint64_t)initrd_end, is_u64);
265 printf("WARNING: could not set linux,initrd-end %s.\n",
274 int fdt_chosen(void *fdt)
278 char *str; /* used to set string properties */
280 err = fdt_check_header(fdt);
282 printf("fdt_chosen: %s\n", fdt_strerror(err));
286 /* find or create "/chosen" node. */
287 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
291 str = env_get("bootargs");
293 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
296 printf("WARNING: could not set bootargs %s.\n",
302 return fdt_fixup_stdout(fdt, nodeoffset);
305 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
306 const void *val, int len, int create)
310 debug("Updating property '%s/%s' = ", path, prop);
311 for (i = 0; i < len; i++)
312 debug(" %.2x", *(u8*)(val+i));
315 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
317 printf("Unable to update property %s:%s, err=%s\n",
318 path, prop, fdt_strerror(rc));
321 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
324 fdt32_t tmp = cpu_to_fdt32(val);
325 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
328 void do_fixup_by_prop(void *fdt,
329 const char *pname, const void *pval, int plen,
330 const char *prop, const void *val, int len,
336 debug("Updating property '%s' = ", prop);
337 for (i = 0; i < len; i++)
338 debug(" %.2x", *(u8*)(val+i));
341 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
342 while (off != -FDT_ERR_NOTFOUND) {
343 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
344 fdt_setprop(fdt, off, prop, val, len);
345 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
349 void do_fixup_by_prop_u32(void *fdt,
350 const char *pname, const void *pval, int plen,
351 const char *prop, u32 val, int create)
353 fdt32_t tmp = cpu_to_fdt32(val);
354 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
357 void do_fixup_by_compat(void *fdt, const char *compat,
358 const char *prop, const void *val, int len, int create)
363 debug("Updating property '%s' = ", prop);
364 for (i = 0; i < len; i++)
365 debug(" %.2x", *(u8*)(val+i));
368 off = fdt_node_offset_by_compatible(fdt, -1, compat);
369 while (off != -FDT_ERR_NOTFOUND) {
370 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
371 fdt_setprop(fdt, off, prop, val, len);
372 off = fdt_node_offset_by_compatible(fdt, off, compat);
376 void do_fixup_by_compat_u32(void *fdt, const char *compat,
377 const char *prop, u32 val, int create)
379 fdt32_t tmp = cpu_to_fdt32(val);
380 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
383 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
385 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
387 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
391 int address_cells = fdt_address_cells(fdt, 0);
392 int size_cells = fdt_size_cells(fdt, 0);
395 for (i = 0; i < n; i++) {
396 if (address_cells == 2)
397 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
399 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
400 p += 4 * address_cells;
403 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
405 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
409 return p - (char *)buf;
412 #if CONFIG_NR_DRAM_BANKS > 4
413 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
415 #define MEMORY_BANKS_MAX 4
417 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
421 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
423 if (banks > MEMORY_BANKS_MAX) {
424 printf("%s: num banks %d exceeds hardcoded limit %d."
425 " Recompile with higher MEMORY_BANKS_MAX?\n",
426 __FUNCTION__, banks, MEMORY_BANKS_MAX);
430 err = fdt_check_header(blob);
432 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
436 /* find or create "/memory" node. */
437 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
441 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
444 printf("WARNING: could not set %s %s.\n", "device_type",
449 for (i = 0; i < banks; i++) {
450 if (start[i] == 0 && size[i] == 0)
459 len = fdt_pack_reg(blob, tmp, start, size, banks);
461 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
463 printf("WARNING: could not set %s %s.\n",
464 "reg", fdt_strerror(err));
471 int fdt_fixup_memory(void *blob, u64 start, u64 size)
473 return fdt_fixup_memory_banks(blob, &start, &size, 1);
476 void fdt_fixup_ethernet(void *fdt)
482 unsigned char mac_addr[ARP_HLEN];
484 #ifdef FDT_SEQ_MACADDR_FROM_ENV
486 const struct fdt_property *fdt_prop;
489 if (fdt_path_offset(fdt, "/aliases") < 0)
492 /* Cycle through all aliases */
493 for (prop = 0; ; prop++) {
496 /* FDT might have been edited, recompute the offset */
497 offset = fdt_first_property_offset(fdt,
498 fdt_path_offset(fdt, "/aliases"));
499 /* Select property number 'prop' */
500 for (j = 0; j < prop; j++)
501 offset = fdt_next_property_offset(fdt, offset);
506 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
507 if (!strncmp(name, "ethernet", 8)) {
508 /* Treat plain "ethernet" same as "ethernet0". */
509 if (!strcmp(name, "ethernet")
510 #ifdef FDT_SEQ_MACADDR_FROM_ENV
511 || !strcmp(name, "ethernet0")
515 #ifndef FDT_SEQ_MACADDR_FROM_ENV
517 i = trailing_strtol(name);
521 strcpy(mac, "ethaddr");
523 sprintf(mac, "eth%daddr", i);
527 #ifdef FDT_SEQ_MACADDR_FROM_ENV
528 nodeoff = fdt_path_offset(fdt, path);
529 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
531 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
539 for (j = 0; j < 6; j++) {
541 simple_strtoul(tmp, &end, 16) : 0;
543 tmp = (*end) ? end + 1 : end;
546 do_fixup_by_path(fdt, path, "mac-address",
548 do_fixup_by_path(fdt, path, "local-mac-address",
554 int fdt_record_loadable(void *blob, u32 index, const char *name,
555 uintptr_t load_addr, u32 size, uintptr_t entry_point,
556 const char *type, const char *os)
560 err = fdt_check_header(blob);
562 printf("%s: %s\n", __func__, fdt_strerror(err));
566 /* find or create "/fit-images" node */
567 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
571 /* find or create "/fit-images/<name>" node */
572 node = fdt_find_or_add_subnode(blob, node, name);
577 * We record these as 32bit entities, possibly truncating addresses.
578 * However, spl_fit.c is not 64bit safe either: i.e. we should not
579 * have an issue here.
581 fdt_setprop_u32(blob, node, "load-addr", load_addr);
582 if (entry_point != -1)
583 fdt_setprop_u32(blob, node, "entry-point", entry_point);
584 fdt_setprop_u32(blob, node, "size", size);
586 fdt_setprop_string(blob, node, "type", type);
588 fdt_setprop_string(blob, node, "os", os);
593 /* Resize the fdt to its actual size + a bit of padding */
594 int fdt_shrink_to_minimum(void *blob, uint extrasize)
605 total = fdt_num_mem_rsv(blob);
606 for (i = 0; i < total; i++) {
607 fdt_get_mem_rsv(blob, i, &addr, &size);
608 if (addr == (uintptr_t)blob) {
609 fdt_del_mem_rsv(blob, i);
616 * Calculate the actual size of the fdt
617 * plus the size needed for 5 fdt_add_mem_rsv, one
618 * for the fdt itself and 4 for a possible initrd
619 * ((initrd-start + initrd-end) * 2 (name & value))
621 actualsize = fdt_off_dt_strings(blob) +
622 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
624 actualsize += extrasize;
625 /* Make it so the fdt ends on a page boundary */
626 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
627 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
629 /* Change the fdt header to reflect the correct size */
630 fdt_set_totalsize(blob, actualsize);
633 /* Add the new reservation */
634 ret = fdt_add_mem_rsv(blob, map_to_sysmem(blob), actualsize);
643 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
645 #define FDT_PCI_PREFETCH (0x40000000)
646 #define FDT_PCI_MEM32 (0x02000000)
647 #define FDT_PCI_IO (0x01000000)
648 #define FDT_PCI_MEM64 (0x03000000)
650 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
652 int addrcell, sizecell, len, r;
654 /* sized based on pci addr cells, size-cells, & address-cells */
655 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
657 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
658 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
660 dma_range = &dma_ranges[0];
661 for (r = 0; r < hose->region_count; r++) {
662 u64 bus_start, phys_start, size;
664 /* skip if !PCI_REGION_SYS_MEMORY */
665 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
668 bus_start = (u64)hose->regions[r].bus_start;
669 phys_start = (u64)hose->regions[r].phys_start;
670 size = (u64)hose->regions[r].size;
673 if (size >= 0x100000000ull)
674 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM64);
676 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
677 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
678 dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
679 #ifdef CONFIG_SYS_PCI_64BIT
680 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
684 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
687 dma_range[3] = cpu_to_fdt32(phys_start >> 32);
688 dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
690 dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
694 dma_range[3 + addrcell + 0] =
695 cpu_to_fdt32(size >> 32);
696 dma_range[3 + addrcell + 1] =
697 cpu_to_fdt32(size & 0xffffffff);
699 dma_range[3 + addrcell + 0] =
700 cpu_to_fdt32(size & 0xffffffff);
703 dma_range += (3 + addrcell + sizecell);
706 len = dma_range - &dma_ranges[0];
708 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
714 int fdt_increase_size(void *fdt, int add_len)
718 newlen = fdt_totalsize(fdt) + add_len;
720 /* Open in place with a new len */
721 return fdt_open_into(fdt, fdt, newlen);
724 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
725 #include <jffs2/load_kernel.h>
726 #include <mtd_node.h>
728 static int fdt_del_subnodes(const void *blob, int parent_offset)
733 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
734 (off >= 0) && (ndepth > 0);
735 off = fdt_next_node(blob, off, &ndepth)) {
737 debug("delete %s: offset: %x\n",
738 fdt_get_name(blob, off, 0), off);
739 ret = fdt_del_node((void *)blob, off);
741 printf("Can't delete node: %s\n",
753 static int fdt_del_partitions(void *blob, int parent_offset)
760 off = fdt_next_node(blob, parent_offset, &ndepth);
761 if (off > 0 && ndepth == 1) {
762 prop = fdt_getprop(blob, off, "label", NULL);
765 * Could not find label property, nand {}; node?
766 * Check subnode, delete partitions there if any.
768 return fdt_del_partitions(blob, off);
770 ret = fdt_del_subnodes(blob, parent_offset);
772 printf("Can't remove subnodes: %s\n",
781 int fdt_node_set_part_info(void *blob, int parent_offset,
782 struct mtd_device *dev)
784 struct list_head *pentry;
785 struct part_info *part;
791 ret = fdt_del_partitions(blob, parent_offset);
796 * Check if size/address is 1 or 2 cells.
797 * We assume #address-cells and #size-cells have same value.
799 sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
800 0, "#size-cells", 1);
803 * Check if it is nand {}; subnode, adjust
804 * the offset in this case
806 off = fdt_next_node(blob, parent_offset, &ndepth);
807 if (off > 0 && ndepth == 1)
811 list_for_each_prev(pentry, &dev->parts) {
814 part = list_entry(pentry, struct part_info, link);
816 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
817 part_num, part->name, part->size,
818 part->offset, part->mask_flags);
820 sprintf(buf, "partition@%llx", part->offset);
822 ret = fdt_add_subnode(blob, parent_offset, buf);
823 if (ret == -FDT_ERR_NOSPACE) {
824 ret = fdt_increase_size(blob, 512);
829 } else if (ret < 0) {
830 printf("Can't add partition node: %s\n",
836 /* Check MTD_WRITEABLE_CMD flag */
837 if (part->mask_flags & 1) {
839 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
840 if (ret == -FDT_ERR_NOSPACE) {
841 ret = fdt_increase_size(blob, 512);
852 ret = fdt_setprop_u64(blob, newoff,
853 "reg", part->offset);
855 ret = fdt_appendprop_u64(blob, newoff,
858 ret = fdt_setprop_u32(blob, newoff,
859 "reg", part->offset);
861 ret = fdt_appendprop_u32(blob, newoff,
865 if (ret == -FDT_ERR_NOSPACE) {
866 ret = fdt_increase_size(blob, 512);
875 ret = fdt_setprop_string(blob, newoff, "label", part->name);
876 if (ret == -FDT_ERR_NOSPACE) {
877 ret = fdt_increase_size(blob, 512);
889 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
892 printf("Can't add property: %s\n", fdt_strerror(ret));
897 * Update partitions in nor/nand nodes using info from
898 * mtdparts environment variable. The nodes to update are
899 * specified by node_info structure which contains mtd device
900 * type and compatible string: E. g. the board code in
901 * ft_board_setup() could use:
903 * struct node_info nodes[] = {
904 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
905 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
908 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
910 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
913 struct mtd_device *dev;
917 if (mtdparts_init() != 0)
920 for (i = 0; i < node_info_size; i++) {
922 noff = fdt_node_offset_by_compatible(blob, -1,
923 node_info[i].compat);
924 while (noff != -FDT_ERR_NOTFOUND) {
925 debug("%s: %s, mtd dev type %d\n",
926 fdt_get_name(blob, noff, 0),
927 node_info[i].compat, node_info[i].type);
928 dev = device_find(node_info[i].type, idx++);
930 if (fdt_node_set_part_info(blob, noff, dev))
931 return; /* return on error */
934 /* Jump to next flash node */
935 noff = fdt_node_offset_by_compatible(blob, noff,
936 node_info[i].compat);
942 void fdt_del_node_and_alias(void *blob, const char *alias)
944 int off = fdt_path_offset(blob, alias);
949 fdt_del_node(blob, off);
951 off = fdt_path_offset(blob, "/aliases");
952 fdt_delprop(blob, off, alias);
955 /* Max address size we deal with */
956 #define OF_MAX_ADDR_CELLS 4
957 #define OF_BAD_ADDR FDT_ADDR_T_NONE
958 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
963 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
967 printf(" %08x", *(addr++));
971 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
975 * struct of_bus - Callbacks for bus specific translators
976 * @name: A string used to identify this bus in debug output.
977 * @addresses: The name of the DT property from which addresses are
978 * to be read, typically "reg".
979 * @match: Return non-zero if the node whose parent is at
980 * parentoffset in the FDT blob corresponds to a bus
981 * of this type, otherwise return zero. If NULL a match
983 * @count_cells:Count how many cells (be32 values) a node whose parent
984 * is at parentoffset in the FDT blob will require to
985 * represent its address (written to *addrc) & size
986 * (written to *sizec).
987 * @map: Map the address addr from the address space of this
988 * bus to that of its parent, making use of the ranges
989 * read from DT to an array at range. na and ns are the
990 * number of cells (be32 values) used to hold and address
991 * or size, respectively, for this bus. pna is the number
992 * of cells used to hold an address for the parent bus.
993 * Returns the address in the address space of the parent
995 * @translate: Update the value of the address cells at addr within an
996 * FDT by adding offset to it. na specifies the number of
997 * cells used to hold the address being translated. Returns
998 * zero on success, non-zero on error.
1000 * Each bus type will include a struct of_bus in the of_busses array,
1001 * providing implementations of some or all of the functions used to
1002 * match the bus & handle address translation for its children.
1006 const char *addresses;
1007 int (*match)(const void *blob, int parentoffset);
1008 void (*count_cells)(const void *blob, int parentoffset,
1009 int *addrc, int *sizec);
1010 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1011 int na, int ns, int pna);
1012 int (*translate)(fdt32_t *addr, u64 offset, int na);
1015 /* Default translator (generic bus) */
1016 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1017 int *addrc, int *sizec)
1019 const fdt32_t *prop;
1022 *addrc = fdt_address_cells(blob, parentoffset);
1025 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1027 *sizec = be32_to_cpup(prop);
1033 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1034 int na, int ns, int pna)
1038 cp = fdt_read_number(range, na);
1039 s = fdt_read_number(range + na + pna, ns);
1040 da = fdt_read_number(addr, na);
1042 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1044 if (da < cp || da >= (cp + s))
1049 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1051 u64 a = fdt_read_number(addr, na);
1052 memset(addr, 0, na * 4);
1055 addr[na - 2] = cpu_to_fdt32(a >> 32);
1056 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1061 #ifdef CONFIG_OF_ISA_BUS
1063 /* ISA bus translator */
1064 static int of_bus_isa_match(const void *blob, int parentoffset)
1068 name = fdt_get_name(blob, parentoffset, NULL);
1072 return !strcmp(name, "isa");
1075 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1076 int *addrc, int *sizec)
1084 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1085 int na, int ns, int pna)
1089 /* Check address type match */
1090 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1093 cp = fdt_read_number(range + 1, na - 1);
1094 s = fdt_read_number(range + na + pna, ns);
1095 da = fdt_read_number(addr + 1, na - 1);
1097 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1099 if (da < cp || da >= (cp + s))
1104 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1106 return of_bus_default_translate(addr + 1, offset, na - 1);
1109 #endif /* CONFIG_OF_ISA_BUS */
1111 /* Array of bus specific translators */
1112 static struct of_bus of_busses[] = {
1113 #ifdef CONFIG_OF_ISA_BUS
1118 .match = of_bus_isa_match,
1119 .count_cells = of_bus_isa_count_cells,
1120 .map = of_bus_isa_map,
1121 .translate = of_bus_isa_translate,
1123 #endif /* CONFIG_OF_ISA_BUS */
1128 .count_cells = fdt_support_default_count_cells,
1129 .map = of_bus_default_map,
1130 .translate = of_bus_default_translate,
1134 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1138 if (ARRAY_SIZE(of_busses) == 1)
1141 for (bus = of_busses; bus; bus++) {
1142 if (!bus->match || bus->match(blob, parentoffset))
1147 * We should always have matched the default bus at least, since
1148 * it has a NULL match field. If we didn't then it somehow isn't
1149 * in the of_busses array or something equally catastrophic has
1156 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1157 struct of_bus *pbus, fdt32_t *addr,
1158 int na, int ns, int pna, const char *rprop)
1160 const fdt32_t *ranges;
1163 u64 offset = OF_BAD_ADDR;
1165 /* Normally, an absence of a "ranges" property means we are
1166 * crossing a non-translatable boundary, and thus the addresses
1167 * below the current not cannot be converted to CPU physical ones.
1168 * Unfortunately, while this is very clear in the spec, it's not
1169 * what Apple understood, and they do have things like /uni-n or
1170 * /ht nodes with no "ranges" property and a lot of perfectly
1171 * useable mapped devices below them. Thus we treat the absence of
1172 * "ranges" as equivalent to an empty "ranges" property which means
1173 * a 1:1 translation at that level. It's up to the caller not to try
1174 * to translate addresses that aren't supposed to be translated in
1175 * the first place. --BenH.
1177 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1178 if (ranges == NULL || rlen == 0) {
1179 offset = fdt_read_number(addr, na);
1180 memset(addr, 0, pna * 4);
1181 debug("OF: no ranges, 1:1 translation\n");
1185 debug("OF: walking ranges...\n");
1187 /* Now walk through the ranges */
1189 rone = na + pna + ns;
1190 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1191 offset = bus->map(addr, ranges, na, ns, pna);
1192 if (offset != OF_BAD_ADDR)
1195 if (offset == OF_BAD_ADDR) {
1196 debug("OF: not found !\n");
1199 memcpy(addr, ranges + na, 4 * pna);
1202 of_dump_addr("OF: parent translation for:", addr, pna);
1203 debug("OF: with offset: %llu\n", offset);
1205 /* Translate it into parent bus space */
1206 return pbus->translate(addr, offset, pna);
1210 * Translate an address from the device-tree into a CPU physical address,
1211 * this walks up the tree and applies the various bus mappings on the
1214 * Note: We consider that crossing any level with #size-cells == 0 to mean
1215 * that translation is impossible (that is we are not dealing with a value
1216 * that can be mapped to a cpu physical address). This is not really specified
1217 * that way, but this is traditionally the way IBM at least do things
1219 static u64 __of_translate_address(const void *blob, int node_offset,
1220 const fdt32_t *in_addr, const char *rprop)
1223 struct of_bus *bus, *pbus;
1224 fdt32_t addr[OF_MAX_ADDR_CELLS];
1225 int na, ns, pna, pns;
1226 u64 result = OF_BAD_ADDR;
1228 debug("OF: ** translation for device %s **\n",
1229 fdt_get_name(blob, node_offset, NULL));
1231 /* Get parent & match bus type */
1232 parent = fdt_parent_offset(blob, node_offset);
1235 bus = of_match_bus(blob, parent);
1237 /* Cound address cells & copy address locally */
1238 bus->count_cells(blob, parent, &na, &ns);
1239 if (!OF_CHECK_COUNTS(na, ns)) {
1240 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1241 fdt_get_name(blob, node_offset, NULL));
1244 memcpy(addr, in_addr, na * 4);
1246 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1247 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1248 of_dump_addr("OF: translating address:", addr, na);
1252 /* Switch to parent bus */
1253 node_offset = parent;
1254 parent = fdt_parent_offset(blob, node_offset);
1256 /* If root, we have finished */
1258 debug("OF: reached root node\n");
1259 result = fdt_read_number(addr, na);
1263 /* Get new parent bus and counts */
1264 pbus = of_match_bus(blob, parent);
1265 pbus->count_cells(blob, parent, &pna, &pns);
1266 if (!OF_CHECK_COUNTS(pna, pns)) {
1267 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1268 fdt_get_name(blob, node_offset, NULL));
1272 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1273 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1275 /* Apply bus translation */
1276 if (of_translate_one(blob, node_offset, bus, pbus,
1277 addr, na, ns, pna, rprop))
1280 /* Complete the move up one level */
1285 of_dump_addr("OF: one level translation:", addr, na);
1292 u64 fdt_translate_address(const void *blob, int node_offset,
1293 const fdt32_t *in_addr)
1295 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1298 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1299 const fdt32_t *in_addr)
1301 return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1305 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1306 * who's reg property matches a physical cpu address
1308 * @blob: ptr to device tree
1309 * @compat: compatiable string to match
1310 * @compat_off: property name
1313 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1314 phys_addr_t compat_off)
1316 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1317 while (off != -FDT_ERR_NOTFOUND) {
1318 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1320 if (compat_off == fdt_translate_address(blob, off, reg))
1323 off = fdt_node_offset_by_compatible(blob, off, compat);
1326 return -FDT_ERR_NOTFOUND;
1330 * fdt_alloc_phandle: Return next free phandle value
1332 * @blob: ptr to device tree
1334 int fdt_alloc_phandle(void *blob)
1337 uint32_t phandle = 0;
1339 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1340 offset = fdt_next_node(blob, offset, NULL)) {
1341 phandle = max(phandle, fdt_get_phandle(blob, offset));
1348 * fdt_set_phandle: Create a phandle property for the given node
1350 * @fdt: ptr to device tree
1351 * @nodeoffset: node to update
1352 * @phandle: phandle value to set (must be unique)
1354 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1359 int off = fdt_node_offset_by_phandle(fdt, phandle);
1361 if ((off >= 0) && (off != nodeoffset)) {
1364 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1365 printf("Trying to update node %s with phandle %u ",
1368 fdt_get_path(fdt, off, buf, sizeof(buf));
1369 printf("that already exists in node %s.\n", buf);
1370 return -FDT_ERR_BADPHANDLE;
1374 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1379 * For now, also set the deprecated "linux,phandle" property, so that we
1380 * don't break older kernels.
1382 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1388 * fdt_create_phandle: Create a phandle property for the given node
1390 * @fdt: ptr to device tree
1391 * @nodeoffset: node to update
1393 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1395 /* see if there is a phandle already */
1396 int phandle = fdt_get_phandle(fdt, nodeoffset);
1398 /* if we got 0, means no phandle so create one */
1402 phandle = fdt_alloc_phandle(fdt);
1403 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1405 printf("Can't set phandle %u: %s\n", phandle,
1415 * fdt_set_node_status: Set status for the given node
1417 * @fdt: ptr to device tree
1418 * @nodeoffset: node to update
1419 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1420 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1421 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1423 int fdt_set_node_status(void *fdt, int nodeoffset,
1424 enum fdt_status status, unsigned int error_code)
1433 case FDT_STATUS_OKAY:
1434 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1436 case FDT_STATUS_DISABLED:
1437 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1439 case FDT_STATUS_FAIL:
1440 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1442 case FDT_STATUS_FAIL_ERROR_CODE:
1443 sprintf(buf, "fail-%d", error_code);
1444 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1447 printf("Invalid fdt status: %x\n", status);
1456 * fdt_set_status_by_alias: Set status for the given node given an alias
1458 * @fdt: ptr to device tree
1459 * @alias: alias of node to update
1460 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1461 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1462 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1464 int fdt_set_status_by_alias(void *fdt, const char* alias,
1465 enum fdt_status status, unsigned int error_code)
1467 int offset = fdt_path_offset(fdt, alias);
1469 return fdt_set_node_status(fdt, offset, status, error_code);
1472 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1473 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1478 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1479 if (noff != -FDT_ERR_NOTFOUND) {
1480 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1482 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1483 if (ret == -FDT_ERR_NOSPACE) {
1484 ret = fdt_increase_size(blob, 512);
1489 } else if (ret < 0) {
1490 printf("Can't add property: %s\n", fdt_strerror(ret));
1496 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1502 * Verify the physical address of device tree node for a given alias
1504 * This function locates the device tree node of a given alias, and then
1505 * verifies that the physical address of that device matches the given
1506 * parameter. It displays a message if there is a mismatch.
1508 * Returns 1 on success, 0 on failure
1510 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1517 path = fdt_getprop(fdt, anode, alias, NULL);
1519 /* If there's no such alias, then it's not a failure */
1523 node = fdt_path_offset(fdt, path);
1525 printf("Warning: device tree alias '%s' points to invalid "
1526 "node %s.\n", alias, path);
1530 reg = fdt_getprop(fdt, node, "reg", &len);
1532 printf("Warning: device tree node '%s' has no address.\n",
1537 dt_addr = fdt_translate_address(fdt, node, reg);
1538 if (addr != dt_addr) {
1539 printf("Warning: U-Boot configured device %s at address %llu,\n"
1540 "but the device tree has it address %llx.\n",
1541 alias, addr, dt_addr);
1549 * Returns the base address of an SOC or PCI node
1551 u64 fdt_get_base_address(const void *fdt, int node)
1554 const fdt32_t *prop;
1556 prop = fdt_getprop(fdt, node, "reg", &size);
1558 return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1562 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1564 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1565 uint64_t *val, int cells)
1567 const fdt32_t *prop32 = &prop[cell_off];
1568 const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1570 if ((cell_off + cells) > prop_len)
1571 return -FDT_ERR_NOSPACE;
1575 *val = fdt32_to_cpu(*prop32);
1578 *val = fdt64_to_cpu(*prop64);
1581 return -FDT_ERR_NOSPACE;
1588 * fdt_read_range - Read a node's n'th range property
1590 * @fdt: ptr to device tree
1591 * @node: offset of node
1593 * @child_addr: pointer to storage for the "child address" field
1594 * @addr: pointer to storage for the CPU view translated physical start
1595 * @len: pointer to storage for the range length
1597 * Convenience function that reads and interprets a specific range out of
1598 * a number of the "ranges" property array.
1600 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1601 uint64_t *addr, uint64_t *len)
1603 int pnode = fdt_parent_offset(fdt, node);
1604 const fdt32_t *ranges;
1613 * The "ranges" property is an array of
1614 * { <child address> <parent address> <size in child address space> }
1616 * All 3 elements can span a diffent number of cells. Fetch their size.
1618 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1619 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1620 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1622 /* Now try to get the ranges property */
1623 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1625 return -FDT_ERR_NOTFOUND;
1626 ranges_len /= sizeof(uint32_t);
1628 /* Jump to the n'th entry */
1629 cell = n * (pacells + acells + scells);
1631 /* Read <child address> */
1633 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1640 /* Read <parent address> */
1642 *addr = fdt_translate_address(fdt, node, ranges + cell);
1645 /* Read <size in child address space> */
1647 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1656 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1658 * @fdt: ptr to device tree
1659 * @node: offset of the simplefb node
1660 * @base_address: framebuffer base address
1661 * @width: width in pixels
1662 * @height: height in pixels
1663 * @stride: bytes per line
1664 * @format: pixel format string
1666 * Convenience function to fill and enable a simplefb node.
1668 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1669 u32 height, u32 stride, const char *format)
1673 int i, addrc, sizec, ret;
1675 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1679 cells[i++] = cpu_to_fdt32(base_address >> 32);
1680 cells[i++] = cpu_to_fdt32(base_address);
1683 cells[i++] = cpu_to_fdt32(height * stride);
1685 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1689 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1690 ret = fdt_set_name(fdt, node, name);
1694 ret = fdt_setprop_u32(fdt, node, "width", width);
1698 ret = fdt_setprop_u32(fdt, node, "height", height);
1702 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1706 ret = fdt_setprop_string(fdt, node, "format", format);
1710 ret = fdt_setprop_string(fdt, node, "status", "okay");
1718 * Update native-mode in display-timings from display environment variable.
1719 * The node to update are specified by path.
1721 int fdt_fixup_display(void *blob, const char *path, const char *display)
1725 if (!display || !path)
1726 return -FDT_ERR_NOTFOUND;
1728 toff = fdt_path_offset(blob, path);
1730 toff = fdt_subnode_offset(blob, toff, "display-timings");
1734 for (off = fdt_first_subnode(blob, toff);
1736 off = fdt_next_subnode(blob, off)) {
1737 uint32_t h = fdt_get_phandle(blob, off);
1738 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1740 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1741 return fdt_setprop_u32(blob, toff, "native-mode", h);
1746 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1748 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1750 * @fdt: ptr to device tree
1751 * @fdto: ptr to device tree overlay
1753 * Convenience function to apply an overlay and display helpful messages
1754 * in the case of an error
1756 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1761 err = fdt_path_offset(fdt, "/__symbols__");
1762 has_symbols = err >= 0;
1764 err = fdt_overlay_apply(fdt, fdto);
1766 printf("failed on fdt_overlay_apply(): %s\n",
1769 printf("base fdt does did not have a /__symbols__ node\n");
1770 printf("make sure you've compiled with -@\n");