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] |= FDT_PCI_MEM64;
676 dma_range[0] |= FDT_PCI_MEM32;
677 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
678 dma_range[0] |= FDT_PCI_PREFETCH;
679 #ifdef CONFIG_SYS_PCI_64BIT
680 dma_range[1] = bus_start >> 32;
684 dma_range[2] = bus_start & 0xffffffff;
687 dma_range[3] = phys_start >> 32;
688 dma_range[4] = phys_start & 0xffffffff;
690 dma_range[3] = phys_start & 0xffffffff;
694 dma_range[3 + addrcell + 0] = size >> 32;
695 dma_range[3 + addrcell + 1] = size & 0xffffffff;
697 dma_range[3 + addrcell + 0] = size & 0xffffffff;
700 dma_range += (3 + addrcell + sizecell);
703 len = dma_range - &dma_ranges[0];
705 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
711 int fdt_increase_size(void *fdt, int add_len)
715 newlen = fdt_totalsize(fdt) + add_len;
717 /* Open in place with a new len */
718 return fdt_open_into(fdt, fdt, newlen);
721 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
722 #include <jffs2/load_kernel.h>
723 #include <mtd_node.h>
730 static int fdt_del_subnodes(const void *blob, int parent_offset)
735 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
736 (off >= 0) && (ndepth > 0);
737 off = fdt_next_node(blob, off, &ndepth)) {
739 debug("delete %s: offset: %x\n",
740 fdt_get_name(blob, off, 0), off);
741 ret = fdt_del_node((void *)blob, off);
743 printf("Can't delete node: %s\n",
755 static int fdt_del_partitions(void *blob, int parent_offset)
762 off = fdt_next_node(blob, parent_offset, &ndepth);
763 if (off > 0 && ndepth == 1) {
764 prop = fdt_getprop(blob, off, "label", NULL);
767 * Could not find label property, nand {}; node?
768 * Check subnode, delete partitions there if any.
770 return fdt_del_partitions(blob, off);
772 ret = fdt_del_subnodes(blob, parent_offset);
774 printf("Can't remove subnodes: %s\n",
783 int fdt_node_set_part_info(void *blob, int parent_offset,
784 struct mtd_device *dev)
786 struct list_head *pentry;
787 struct part_info *part;
788 struct reg_cell cell;
793 ret = fdt_del_partitions(blob, parent_offset);
798 * Check if it is nand {}; subnode, adjust
799 * the offset in this case
801 off = fdt_next_node(blob, parent_offset, &ndepth);
802 if (off > 0 && ndepth == 1)
806 list_for_each_prev(pentry, &dev->parts) {
809 part = list_entry(pentry, struct part_info, link);
811 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
812 part_num, part->name, part->size,
813 part->offset, part->mask_flags);
815 sprintf(buf, "partition@%llx", part->offset);
817 ret = fdt_add_subnode(blob, parent_offset, buf);
818 if (ret == -FDT_ERR_NOSPACE) {
819 ret = fdt_increase_size(blob, 512);
824 } else if (ret < 0) {
825 printf("Can't add partition node: %s\n",
831 /* Check MTD_WRITEABLE_CMD flag */
832 if (part->mask_flags & 1) {
834 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
835 if (ret == -FDT_ERR_NOSPACE) {
836 ret = fdt_increase_size(blob, 512);
845 cell.r0 = cpu_to_fdt32(part->offset);
846 cell.r1 = cpu_to_fdt32(part->size);
848 ret = fdt_setprop(blob, newoff, "reg", &cell, sizeof(cell));
849 if (ret == -FDT_ERR_NOSPACE) {
850 ret = fdt_increase_size(blob, 512);
859 ret = fdt_setprop_string(blob, newoff, "label", part->name);
860 if (ret == -FDT_ERR_NOSPACE) {
861 ret = fdt_increase_size(blob, 512);
873 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
876 printf("Can't add property: %s\n", fdt_strerror(ret));
881 * Update partitions in nor/nand nodes using info from
882 * mtdparts environment variable. The nodes to update are
883 * specified by node_info structure which contains mtd device
884 * type and compatible string: E. g. the board code in
885 * ft_board_setup() could use:
887 * struct node_info nodes[] = {
888 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
889 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
892 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
894 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
897 struct mtd_device *dev;
901 if (mtdparts_init() != 0)
904 for (i = 0; i < node_info_size; i++) {
906 noff = fdt_node_offset_by_compatible(blob, -1,
907 node_info[i].compat);
908 while (noff != -FDT_ERR_NOTFOUND) {
909 debug("%s: %s, mtd dev type %d\n",
910 fdt_get_name(blob, noff, 0),
911 node_info[i].compat, node_info[i].type);
912 dev = device_find(node_info[i].type, idx++);
914 if (fdt_node_set_part_info(blob, noff, dev))
915 return; /* return on error */
918 /* Jump to next flash node */
919 noff = fdt_node_offset_by_compatible(blob, noff,
920 node_info[i].compat);
926 void fdt_del_node_and_alias(void *blob, const char *alias)
928 int off = fdt_path_offset(blob, alias);
933 fdt_del_node(blob, off);
935 off = fdt_path_offset(blob, "/aliases");
936 fdt_delprop(blob, off, alias);
939 /* Max address size we deal with */
940 #define OF_MAX_ADDR_CELLS 4
941 #define OF_BAD_ADDR FDT_ADDR_T_NONE
942 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
947 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
951 printf(" %08x", *(addr++));
955 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
959 * struct of_bus - Callbacks for bus specific translators
960 * @name: A string used to identify this bus in debug output.
961 * @addresses: The name of the DT property from which addresses are
962 * to be read, typically "reg".
963 * @match: Return non-zero if the node whose parent is at
964 * parentoffset in the FDT blob corresponds to a bus
965 * of this type, otherwise return zero. If NULL a match
967 * @count_cells:Count how many cells (be32 values) a node whose parent
968 * is at parentoffset in the FDT blob will require to
969 * represent its address (written to *addrc) & size
970 * (written to *sizec).
971 * @map: Map the address addr from the address space of this
972 * bus to that of its parent, making use of the ranges
973 * read from DT to an array at range. na and ns are the
974 * number of cells (be32 values) used to hold and address
975 * or size, respectively, for this bus. pna is the number
976 * of cells used to hold an address for the parent bus.
977 * Returns the address in the address space of the parent
979 * @translate: Update the value of the address cells at addr within an
980 * FDT by adding offset to it. na specifies the number of
981 * cells used to hold the address being translated. Returns
982 * zero on success, non-zero on error.
984 * Each bus type will include a struct of_bus in the of_busses array,
985 * providing implementations of some or all of the functions used to
986 * match the bus & handle address translation for its children.
990 const char *addresses;
991 int (*match)(const void *blob, int parentoffset);
992 void (*count_cells)(const void *blob, int parentoffset,
993 int *addrc, int *sizec);
994 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
995 int na, int ns, int pna);
996 int (*translate)(fdt32_t *addr, u64 offset, int na);
999 /* Default translator (generic bus) */
1000 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1001 int *addrc, int *sizec)
1003 const fdt32_t *prop;
1006 *addrc = fdt_address_cells(blob, parentoffset);
1009 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1011 *sizec = be32_to_cpup(prop);
1017 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1018 int na, int ns, int pna)
1022 cp = fdt_read_number(range, na);
1023 s = fdt_read_number(range + na + pna, ns);
1024 da = fdt_read_number(addr, na);
1026 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1028 if (da < cp || da >= (cp + s))
1033 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1035 u64 a = fdt_read_number(addr, na);
1036 memset(addr, 0, na * 4);
1039 addr[na - 2] = cpu_to_fdt32(a >> 32);
1040 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1045 #ifdef CONFIG_OF_ISA_BUS
1047 /* ISA bus translator */
1048 static int of_bus_isa_match(const void *blob, int parentoffset)
1052 name = fdt_get_name(blob, parentoffset, NULL);
1056 return !strcmp(name, "isa");
1059 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1060 int *addrc, int *sizec)
1068 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1069 int na, int ns, int pna)
1073 /* Check address type match */
1074 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1077 cp = fdt_read_number(range + 1, na - 1);
1078 s = fdt_read_number(range + na + pna, ns);
1079 da = fdt_read_number(addr + 1, na - 1);
1081 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1083 if (da < cp || da >= (cp + s))
1088 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1090 return of_bus_default_translate(addr + 1, offset, na - 1);
1093 #endif /* CONFIG_OF_ISA_BUS */
1095 /* Array of bus specific translators */
1096 static struct of_bus of_busses[] = {
1097 #ifdef CONFIG_OF_ISA_BUS
1102 .match = of_bus_isa_match,
1103 .count_cells = of_bus_isa_count_cells,
1104 .map = of_bus_isa_map,
1105 .translate = of_bus_isa_translate,
1107 #endif /* CONFIG_OF_ISA_BUS */
1112 .count_cells = fdt_support_default_count_cells,
1113 .map = of_bus_default_map,
1114 .translate = of_bus_default_translate,
1118 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1122 if (ARRAY_SIZE(of_busses) == 1)
1125 for (bus = of_busses; bus; bus++) {
1126 if (!bus->match || bus->match(blob, parentoffset))
1131 * We should always have matched the default bus at least, since
1132 * it has a NULL match field. If we didn't then it somehow isn't
1133 * in the of_busses array or something equally catastrophic has
1140 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1141 struct of_bus *pbus, fdt32_t *addr,
1142 int na, int ns, int pna, const char *rprop)
1144 const fdt32_t *ranges;
1147 u64 offset = OF_BAD_ADDR;
1149 /* Normally, an absence of a "ranges" property means we are
1150 * crossing a non-translatable boundary, and thus the addresses
1151 * below the current not cannot be converted to CPU physical ones.
1152 * Unfortunately, while this is very clear in the spec, it's not
1153 * what Apple understood, and they do have things like /uni-n or
1154 * /ht nodes with no "ranges" property and a lot of perfectly
1155 * useable mapped devices below them. Thus we treat the absence of
1156 * "ranges" as equivalent to an empty "ranges" property which means
1157 * a 1:1 translation at that level. It's up to the caller not to try
1158 * to translate addresses that aren't supposed to be translated in
1159 * the first place. --BenH.
1161 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1162 if (ranges == NULL || rlen == 0) {
1163 offset = fdt_read_number(addr, na);
1164 memset(addr, 0, pna * 4);
1165 debug("OF: no ranges, 1:1 translation\n");
1169 debug("OF: walking ranges...\n");
1171 /* Now walk through the ranges */
1173 rone = na + pna + ns;
1174 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1175 offset = bus->map(addr, ranges, na, ns, pna);
1176 if (offset != OF_BAD_ADDR)
1179 if (offset == OF_BAD_ADDR) {
1180 debug("OF: not found !\n");
1183 memcpy(addr, ranges + na, 4 * pna);
1186 of_dump_addr("OF: parent translation for:", addr, pna);
1187 debug("OF: with offset: %llu\n", offset);
1189 /* Translate it into parent bus space */
1190 return pbus->translate(addr, offset, pna);
1194 * Translate an address from the device-tree into a CPU physical address,
1195 * this walks up the tree and applies the various bus mappings on the
1198 * Note: We consider that crossing any level with #size-cells == 0 to mean
1199 * that translation is impossible (that is we are not dealing with a value
1200 * that can be mapped to a cpu physical address). This is not really specified
1201 * that way, but this is traditionally the way IBM at least do things
1203 static u64 __of_translate_address(const void *blob, int node_offset,
1204 const fdt32_t *in_addr, const char *rprop)
1207 struct of_bus *bus, *pbus;
1208 fdt32_t addr[OF_MAX_ADDR_CELLS];
1209 int na, ns, pna, pns;
1210 u64 result = OF_BAD_ADDR;
1212 debug("OF: ** translation for device %s **\n",
1213 fdt_get_name(blob, node_offset, NULL));
1215 /* Get parent & match bus type */
1216 parent = fdt_parent_offset(blob, node_offset);
1219 bus = of_match_bus(blob, parent);
1221 /* Cound address cells & copy address locally */
1222 bus->count_cells(blob, parent, &na, &ns);
1223 if (!OF_CHECK_COUNTS(na, ns)) {
1224 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1225 fdt_get_name(blob, node_offset, NULL));
1228 memcpy(addr, in_addr, na * 4);
1230 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1231 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1232 of_dump_addr("OF: translating address:", addr, na);
1236 /* Switch to parent bus */
1237 node_offset = parent;
1238 parent = fdt_parent_offset(blob, node_offset);
1240 /* If root, we have finished */
1242 debug("OF: reached root node\n");
1243 result = fdt_read_number(addr, na);
1247 /* Get new parent bus and counts */
1248 pbus = of_match_bus(blob, parent);
1249 pbus->count_cells(blob, parent, &pna, &pns);
1250 if (!OF_CHECK_COUNTS(pna, pns)) {
1251 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1252 fdt_get_name(blob, node_offset, NULL));
1256 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1257 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1259 /* Apply bus translation */
1260 if (of_translate_one(blob, node_offset, bus, pbus,
1261 addr, na, ns, pna, rprop))
1264 /* Complete the move up one level */
1269 of_dump_addr("OF: one level translation:", addr, na);
1276 u64 fdt_translate_address(const void *blob, int node_offset,
1277 const fdt32_t *in_addr)
1279 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1283 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1284 * who's reg property matches a physical cpu address
1286 * @blob: ptr to device tree
1287 * @compat: compatiable string to match
1288 * @compat_off: property name
1291 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1292 phys_addr_t compat_off)
1294 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1295 while (off != -FDT_ERR_NOTFOUND) {
1296 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1298 if (compat_off == fdt_translate_address(blob, off, reg))
1301 off = fdt_node_offset_by_compatible(blob, off, compat);
1304 return -FDT_ERR_NOTFOUND;
1308 * fdt_alloc_phandle: Return next free phandle value
1310 * @blob: ptr to device tree
1312 int fdt_alloc_phandle(void *blob)
1315 uint32_t phandle = 0;
1317 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1318 offset = fdt_next_node(blob, offset, NULL)) {
1319 phandle = max(phandle, fdt_get_phandle(blob, offset));
1326 * fdt_set_phandle: Create a phandle property for the given node
1328 * @fdt: ptr to device tree
1329 * @nodeoffset: node to update
1330 * @phandle: phandle value to set (must be unique)
1332 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1337 int off = fdt_node_offset_by_phandle(fdt, phandle);
1339 if ((off >= 0) && (off != nodeoffset)) {
1342 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1343 printf("Trying to update node %s with phandle %u ",
1346 fdt_get_path(fdt, off, buf, sizeof(buf));
1347 printf("that already exists in node %s.\n", buf);
1348 return -FDT_ERR_BADPHANDLE;
1352 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1357 * For now, also set the deprecated "linux,phandle" property, so that we
1358 * don't break older kernels.
1360 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1366 * fdt_create_phandle: Create a phandle property for the given node
1368 * @fdt: ptr to device tree
1369 * @nodeoffset: node to update
1371 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1373 /* see if there is a phandle already */
1374 int phandle = fdt_get_phandle(fdt, nodeoffset);
1376 /* if we got 0, means no phandle so create one */
1380 phandle = fdt_alloc_phandle(fdt);
1381 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1383 printf("Can't set phandle %u: %s\n", phandle,
1393 * fdt_set_node_status: Set status for the given node
1395 * @fdt: ptr to device tree
1396 * @nodeoffset: node to update
1397 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1398 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1399 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1401 int fdt_set_node_status(void *fdt, int nodeoffset,
1402 enum fdt_status status, unsigned int error_code)
1411 case FDT_STATUS_OKAY:
1412 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1414 case FDT_STATUS_DISABLED:
1415 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1417 case FDT_STATUS_FAIL:
1418 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1420 case FDT_STATUS_FAIL_ERROR_CODE:
1421 sprintf(buf, "fail-%d", error_code);
1422 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1425 printf("Invalid fdt status: %x\n", status);
1434 * fdt_set_status_by_alias: Set status for the given node given an alias
1436 * @fdt: ptr to device tree
1437 * @alias: alias of node to update
1438 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1439 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1440 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1442 int fdt_set_status_by_alias(void *fdt, const char* alias,
1443 enum fdt_status status, unsigned int error_code)
1445 int offset = fdt_path_offset(fdt, alias);
1447 return fdt_set_node_status(fdt, offset, status, error_code);
1450 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1451 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1456 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1457 if (noff != -FDT_ERR_NOTFOUND) {
1458 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1460 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1461 if (ret == -FDT_ERR_NOSPACE) {
1462 ret = fdt_increase_size(blob, 512);
1467 } else if (ret < 0) {
1468 printf("Can't add property: %s\n", fdt_strerror(ret));
1474 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1480 * Verify the physical address of device tree node for a given alias
1482 * This function locates the device tree node of a given alias, and then
1483 * verifies that the physical address of that device matches the given
1484 * parameter. It displays a message if there is a mismatch.
1486 * Returns 1 on success, 0 on failure
1488 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1495 path = fdt_getprop(fdt, anode, alias, NULL);
1497 /* If there's no such alias, then it's not a failure */
1501 node = fdt_path_offset(fdt, path);
1503 printf("Warning: device tree alias '%s' points to invalid "
1504 "node %s.\n", alias, path);
1508 reg = fdt_getprop(fdt, node, "reg", &len);
1510 printf("Warning: device tree node '%s' has no address.\n",
1515 dt_addr = fdt_translate_address(fdt, node, reg);
1516 if (addr != dt_addr) {
1517 printf("Warning: U-Boot configured device %s at address %llu,\n"
1518 "but the device tree has it address %llx.\n",
1519 alias, addr, dt_addr);
1527 * Returns the base address of an SOC or PCI node
1529 u64 fdt_get_base_address(const void *fdt, int node)
1532 const fdt32_t *prop;
1534 prop = fdt_getprop(fdt, node, "reg", &size);
1536 return prop ? fdt_translate_address(fdt, node, prop) : 0;
1540 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1542 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1543 uint64_t *val, int cells)
1545 const fdt32_t *prop32 = &prop[cell_off];
1546 const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1548 if ((cell_off + cells) > prop_len)
1549 return -FDT_ERR_NOSPACE;
1553 *val = fdt32_to_cpu(*prop32);
1556 *val = fdt64_to_cpu(*prop64);
1559 return -FDT_ERR_NOSPACE;
1566 * fdt_read_range - Read a node's n'th range property
1568 * @fdt: ptr to device tree
1569 * @node: offset of node
1571 * @child_addr: pointer to storage for the "child address" field
1572 * @addr: pointer to storage for the CPU view translated physical start
1573 * @len: pointer to storage for the range length
1575 * Convenience function that reads and interprets a specific range out of
1576 * a number of the "ranges" property array.
1578 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1579 uint64_t *addr, uint64_t *len)
1581 int pnode = fdt_parent_offset(fdt, node);
1582 const fdt32_t *ranges;
1591 * The "ranges" property is an array of
1592 * { <child address> <parent address> <size in child address space> }
1594 * All 3 elements can span a diffent number of cells. Fetch their size.
1596 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1597 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1598 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1600 /* Now try to get the ranges property */
1601 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1603 return -FDT_ERR_NOTFOUND;
1604 ranges_len /= sizeof(uint32_t);
1606 /* Jump to the n'th entry */
1607 cell = n * (pacells + acells + scells);
1609 /* Read <child address> */
1611 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1618 /* Read <parent address> */
1620 *addr = fdt_translate_address(fdt, node, ranges + cell);
1623 /* Read <size in child address space> */
1625 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1634 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1636 * @fdt: ptr to device tree
1637 * @node: offset of the simplefb node
1638 * @base_address: framebuffer base address
1639 * @width: width in pixels
1640 * @height: height in pixels
1641 * @stride: bytes per line
1642 * @format: pixel format string
1644 * Convenience function to fill and enable a simplefb node.
1646 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1647 u32 height, u32 stride, const char *format)
1651 int i, addrc, sizec, ret;
1653 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1657 cells[i++] = cpu_to_fdt32(base_address >> 32);
1658 cells[i++] = cpu_to_fdt32(base_address);
1661 cells[i++] = cpu_to_fdt32(height * stride);
1663 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1667 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1668 ret = fdt_set_name(fdt, node, name);
1672 ret = fdt_setprop_u32(fdt, node, "width", width);
1676 ret = fdt_setprop_u32(fdt, node, "height", height);
1680 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1684 ret = fdt_setprop_string(fdt, node, "format", format);
1688 ret = fdt_setprop_string(fdt, node, "status", "okay");
1696 * Update native-mode in display-timings from display environment variable.
1697 * The node to update are specified by path.
1699 int fdt_fixup_display(void *blob, const char *path, const char *display)
1703 if (!display || !path)
1704 return -FDT_ERR_NOTFOUND;
1706 toff = fdt_path_offset(blob, path);
1708 toff = fdt_subnode_offset(blob, toff, "display-timings");
1712 for (off = fdt_first_subnode(blob, toff);
1714 off = fdt_next_subnode(blob, off)) {
1715 uint32_t h = fdt_get_phandle(blob, off);
1716 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1718 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1719 return fdt_setprop_u32(blob, toff, "native-mode", h);
1724 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1726 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1728 * @fdt: ptr to device tree
1729 * @fdto: ptr to device tree overlay
1731 * Convenience function to apply an overlay and display helpful messages
1732 * in the case of an error
1734 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1739 err = fdt_path_offset(fdt, "/__symbols__");
1740 has_symbols = err >= 0;
1742 err = fdt_overlay_apply(fdt, fdto);
1744 printf("failed on fdt_overlay_apply(): %s\n",
1747 printf("base fdt does did not have a /__symbols__ node\n");
1748 printf("make sure you've compiled with -@\n");