1 // SPDX-License-Identifier: GPL-2.0+
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
6 * Copyright 2010-2011 Freescale Semiconductor, Inc.
14 #include <stdio_dev.h>
15 #include <linux/ctype.h>
16 #include <linux/types.h>
17 #include <asm/global_data.h>
18 #include <linux/libfdt.h>
19 #include <fdt_support.h>
23 DECLARE_GLOBAL_DATA_PTR;
26 * fdt_getprop_u32_default_node - Return a node's property or a default
28 * @fdt: ptr to device tree
29 * @off: offset of node
30 * @cell: cell offset in property
31 * @prop: property name
32 * @dflt: default value if the property isn't found
34 * Convenience function to return a node's property or a default value if
35 * the property doesn't exist.
37 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
38 const char *prop, const u32 dflt)
43 val = fdt_getprop(fdt, off, prop, &len);
45 /* Check if property exists */
49 /* Check if property is long enough */
50 if (len < ((cell + 1) * sizeof(uint32_t)))
53 return fdt32_to_cpu(*val);
57 * fdt_getprop_u32_default - Find a node and return it's property or a default
59 * @fdt: ptr to device tree
61 * @prop: property name
62 * @dflt: default value if the property isn't found
64 * Convenience function to find a node and return it's property or a
65 * default value if it doesn't exist.
67 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
68 const char *prop, const u32 dflt)
72 off = fdt_path_offset(fdt, path);
76 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
80 * fdt_find_and_setprop: Find a node and set it's property
82 * @fdt: ptr to device tree
84 * @prop: property name
85 * @val: ptr to new value
86 * @len: length of new property value
87 * @create: flag to create the property if it doesn't exist
89 * Convenience function to directly set a property given the path to the node.
91 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
92 const void *val, int len, int create)
94 int nodeoff = fdt_path_offset(fdt, node);
99 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
100 return 0; /* create flag not set; so exit quietly */
102 return fdt_setprop(fdt, nodeoff, prop, val, len);
106 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
108 * @fdt: pointer to the device tree blob
109 * @parentoffset: structure block offset of a node
110 * @name: name of the subnode to locate
112 * fdt_subnode_offset() finds a subnode of the node with a given name.
113 * If the subnode does not exist, it will be created.
115 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
119 offset = fdt_subnode_offset(fdt, parentoffset, name);
121 if (offset == -FDT_ERR_NOTFOUND)
122 offset = fdt_add_subnode(fdt, parentoffset, name);
125 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
130 /* rename to CONFIG_OF_STDOUT_PATH ? */
131 #if defined(OF_STDOUT_PATH)
132 static int fdt_fixup_stdout(void *fdt, int chosenoff)
134 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
135 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
137 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
138 static int fdt_fixup_stdout(void *fdt, int chosenoff)
142 char sername[9] = { 0 };
145 char tmp[256]; /* long enough */
147 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
149 aliasoff = fdt_path_offset(fdt, "/aliases");
155 path = fdt_getprop(fdt, aliasoff, sername, &len);
161 /* fdt_setprop may break "path" so we copy it to tmp buffer */
162 memcpy(tmp, path, len);
164 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
166 printf("WARNING: could not set linux,stdout-path %s.\n",
172 printf("WARNING: %s: could not read %s alias: %s\n",
173 __func__, sername, fdt_strerror(err));
178 static int fdt_fixup_stdout(void *fdt, int chosenoff)
184 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
185 uint64_t val, int is_u64)
188 return fdt_setprop_u64(fdt, nodeoffset, name, val);
190 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
193 int fdt_root(void *fdt)
198 err = fdt_check_header(fdt);
200 printf("fdt_root: %s\n", fdt_strerror(err));
204 serial = env_get("serial#");
206 err = fdt_setprop(fdt, 0, "serial-number", serial,
210 printf("WARNING: could not set serial-number %s.\n",
219 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
226 /* just return if the size of initrd is zero */
227 if (initrd_start == initrd_end)
230 /* find or create "/chosen" node. */
231 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
235 total = fdt_num_mem_rsv(fdt);
238 * Look for an existing entry and update it. If we don't find
239 * the entry, we will j be the next available slot.
241 for (j = 0; j < total; j++) {
242 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
243 if (addr == initrd_start) {
244 fdt_del_mem_rsv(fdt, j);
249 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
251 printf("fdt_initrd: %s\n", fdt_strerror(err));
255 is_u64 = (fdt_address_cells(fdt, 0) == 2);
257 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
258 (uint64_t)initrd_start, is_u64);
261 printf("WARNING: could not set linux,initrd-start %s.\n",
266 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
267 (uint64_t)initrd_end, is_u64);
270 printf("WARNING: could not set linux,initrd-end %s.\n",
279 int fdt_chosen(void *fdt)
283 char *str; /* used to set string properties */
285 err = fdt_check_header(fdt);
287 printf("fdt_chosen: %s\n", fdt_strerror(err));
291 /* find or create "/chosen" node. */
292 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
296 str = env_get("bootargs");
298 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
301 printf("WARNING: could not set bootargs %s.\n",
307 return fdt_fixup_stdout(fdt, nodeoffset);
310 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
311 const void *val, int len, int create)
315 debug("Updating property '%s/%s' = ", path, prop);
316 for (i = 0; i < len; i++)
317 debug(" %.2x", *(u8*)(val+i));
320 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
322 printf("Unable to update property %s:%s, err=%s\n",
323 path, prop, fdt_strerror(rc));
326 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
329 fdt32_t tmp = cpu_to_fdt32(val);
330 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
333 void do_fixup_by_prop(void *fdt,
334 const char *pname, const void *pval, int plen,
335 const char *prop, const void *val, int len,
341 debug("Updating property '%s' = ", prop);
342 for (i = 0; i < len; i++)
343 debug(" %.2x", *(u8*)(val+i));
346 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
347 while (off != -FDT_ERR_NOTFOUND) {
348 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
349 fdt_setprop(fdt, off, prop, val, len);
350 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
354 void do_fixup_by_prop_u32(void *fdt,
355 const char *pname, const void *pval, int plen,
356 const char *prop, u32 val, int create)
358 fdt32_t tmp = cpu_to_fdt32(val);
359 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
362 void do_fixup_by_compat(void *fdt, const char *compat,
363 const char *prop, const void *val, int len, int create)
368 debug("Updating property '%s' = ", prop);
369 for (i = 0; i < len; i++)
370 debug(" %.2x", *(u8*)(val+i));
373 off = fdt_node_offset_by_compatible(fdt, -1, compat);
374 while (off != -FDT_ERR_NOTFOUND) {
375 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
376 fdt_setprop(fdt, off, prop, val, len);
377 off = fdt_node_offset_by_compatible(fdt, off, compat);
381 void do_fixup_by_compat_u32(void *fdt, const char *compat,
382 const char *prop, u32 val, int create)
384 fdt32_t tmp = cpu_to_fdt32(val);
385 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
388 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
390 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
392 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
396 int address_cells = fdt_address_cells(fdt, 0);
397 int size_cells = fdt_size_cells(fdt, 0);
400 for (i = 0; i < n; i++) {
401 if (address_cells == 2)
402 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
404 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
405 p += 4 * address_cells;
408 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
410 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
414 return p - (char *)buf;
417 #if CONFIG_NR_DRAM_BANKS > 4
418 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
420 #define MEMORY_BANKS_MAX 4
422 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
426 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
428 if (banks > MEMORY_BANKS_MAX) {
429 printf("%s: num banks %d exceeds hardcoded limit %d."
430 " Recompile with higher MEMORY_BANKS_MAX?\n",
431 __FUNCTION__, banks, MEMORY_BANKS_MAX);
435 err = fdt_check_header(blob);
437 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
441 /* find or create "/memory" node. */
442 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
446 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
449 printf("WARNING: could not set %s %s.\n", "device_type",
454 for (i = 0; i < banks; i++) {
455 if (start[i] == 0 && size[i] == 0)
464 len = fdt_pack_reg(blob, tmp, start, size, banks);
466 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
468 printf("WARNING: could not set %s %s.\n",
469 "reg", fdt_strerror(err));
475 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int areas)
479 u8 tmp[8 * 16]; /* Up to 64-bit address + 64-bit size */
482 printf("%s: num areas %d exceeds hardcoded limit %d\n",
487 err = fdt_check_header(blob);
489 printf("%s: %s\n", __func__, fdt_strerror(err));
493 /* find or create "/memory" node. */
494 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
498 len = fdt_pack_reg(blob, tmp, start, size, areas);
500 err = fdt_setprop(blob, nodeoffset, "linux,usable-memory", tmp, len);
502 printf("WARNING: could not set %s %s.\n",
503 "reg", fdt_strerror(err));
511 int fdt_fixup_memory(void *blob, u64 start, u64 size)
513 return fdt_fixup_memory_banks(blob, &start, &size, 1);
516 void fdt_fixup_ethernet(void *fdt)
522 unsigned char mac_addr[ARP_HLEN];
524 #ifdef FDT_SEQ_MACADDR_FROM_ENV
526 const struct fdt_property *fdt_prop;
529 if (fdt_path_offset(fdt, "/aliases") < 0)
532 /* Cycle through all aliases */
533 for (prop = 0; ; prop++) {
536 /* FDT might have been edited, recompute the offset */
537 offset = fdt_first_property_offset(fdt,
538 fdt_path_offset(fdt, "/aliases"));
539 /* Select property number 'prop' */
540 for (j = 0; j < prop; j++)
541 offset = fdt_next_property_offset(fdt, offset);
546 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
547 if (!strncmp(name, "ethernet", 8)) {
548 /* Treat plain "ethernet" same as "ethernet0". */
549 if (!strcmp(name, "ethernet")
550 #ifdef FDT_SEQ_MACADDR_FROM_ENV
551 || !strcmp(name, "ethernet0")
555 #ifndef FDT_SEQ_MACADDR_FROM_ENV
557 i = trailing_strtol(name);
561 strcpy(mac, "ethaddr");
563 sprintf(mac, "eth%daddr", i);
567 #ifdef FDT_SEQ_MACADDR_FROM_ENV
568 nodeoff = fdt_path_offset(fdt, path);
569 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
571 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
579 for (j = 0; j < 6; j++) {
581 simple_strtoul(tmp, &end, 16) : 0;
583 tmp = (*end) ? end + 1 : end;
586 do_fixup_by_path(fdt, path, "mac-address",
588 do_fixup_by_path(fdt, path, "local-mac-address",
594 int fdt_record_loadable(void *blob, u32 index, const char *name,
595 uintptr_t load_addr, u32 size, uintptr_t entry_point,
596 const char *type, const char *os)
600 err = fdt_check_header(blob);
602 printf("%s: %s\n", __func__, fdt_strerror(err));
606 /* find or create "/fit-images" node */
607 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
611 /* find or create "/fit-images/<name>" node */
612 node = fdt_find_or_add_subnode(blob, node, name);
616 fdt_setprop_u64(blob, node, "load", load_addr);
617 if (entry_point != -1)
618 fdt_setprop_u64(blob, node, "entry", entry_point);
619 fdt_setprop_u32(blob, node, "size", size);
621 fdt_setprop_string(blob, node, "type", type);
623 fdt_setprop_string(blob, node, "os", os);
628 /* Resize the fdt to its actual size + a bit of padding */
629 int fdt_shrink_to_minimum(void *blob, uint extrasize)
640 total = fdt_num_mem_rsv(blob);
641 for (i = 0; i < total; i++) {
642 fdt_get_mem_rsv(blob, i, &addr, &size);
643 if (addr == (uintptr_t)blob) {
644 fdt_del_mem_rsv(blob, i);
651 * Calculate the actual size of the fdt
652 * plus the size needed for 5 fdt_add_mem_rsv, one
653 * for the fdt itself and 4 for a possible initrd
654 * ((initrd-start + initrd-end) * 2 (name & value))
656 actualsize = fdt_off_dt_strings(blob) +
657 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
659 actualsize += extrasize;
660 /* Make it so the fdt ends on a page boundary */
661 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
662 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
664 /* Change the fdt header to reflect the correct size */
665 fdt_set_totalsize(blob, actualsize);
668 /* Add the new reservation */
669 ret = fdt_add_mem_rsv(blob, map_to_sysmem(blob), actualsize);
678 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
680 #define FDT_PCI_PREFETCH (0x40000000)
681 #define FDT_PCI_MEM32 (0x02000000)
682 #define FDT_PCI_IO (0x01000000)
683 #define FDT_PCI_MEM64 (0x03000000)
685 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
687 int addrcell, sizecell, len, r;
689 /* sized based on pci addr cells, size-cells, & address-cells */
690 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
692 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
693 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
695 dma_range = &dma_ranges[0];
696 for (r = 0; r < hose->region_count; r++) {
697 u64 bus_start, phys_start, size;
699 /* skip if !PCI_REGION_SYS_MEMORY */
700 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
703 bus_start = (u64)hose->regions[r].bus_start;
704 phys_start = (u64)hose->regions[r].phys_start;
705 size = (u64)hose->regions[r].size;
708 if (size >= 0x100000000ull)
709 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM64);
711 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
712 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
713 dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
714 #ifdef CONFIG_SYS_PCI_64BIT
715 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
719 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
722 dma_range[3] = cpu_to_fdt32(phys_start >> 32);
723 dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
725 dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
729 dma_range[3 + addrcell + 0] =
730 cpu_to_fdt32(size >> 32);
731 dma_range[3 + addrcell + 1] =
732 cpu_to_fdt32(size & 0xffffffff);
734 dma_range[3 + addrcell + 0] =
735 cpu_to_fdt32(size & 0xffffffff);
738 dma_range += (3 + addrcell + sizecell);
741 len = dma_range - &dma_ranges[0];
743 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
749 int fdt_increase_size(void *fdt, int add_len)
753 newlen = fdt_totalsize(fdt) + add_len;
755 /* Open in place with a new len */
756 return fdt_open_into(fdt, fdt, newlen);
759 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
760 #include <jffs2/load_kernel.h>
761 #include <mtd_node.h>
763 static int fdt_del_subnodes(const void *blob, int parent_offset)
768 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
769 (off >= 0) && (ndepth > 0);
770 off = fdt_next_node(blob, off, &ndepth)) {
772 debug("delete %s: offset: %x\n",
773 fdt_get_name(blob, off, 0), off);
774 ret = fdt_del_node((void *)blob, off);
776 printf("Can't delete node: %s\n",
788 static int fdt_del_partitions(void *blob, int parent_offset)
795 off = fdt_next_node(blob, parent_offset, &ndepth);
796 if (off > 0 && ndepth == 1) {
797 prop = fdt_getprop(blob, off, "label", NULL);
800 * Could not find label property, nand {}; node?
801 * Check subnode, delete partitions there if any.
803 return fdt_del_partitions(blob, off);
805 ret = fdt_del_subnodes(blob, parent_offset);
807 printf("Can't remove subnodes: %s\n",
816 static int fdt_node_set_part_info(void *blob, int parent_offset,
817 struct mtd_device *dev)
819 struct list_head *pentry;
820 struct part_info *part;
826 ret = fdt_del_partitions(blob, parent_offset);
831 * Check if size/address is 1 or 2 cells.
832 * We assume #address-cells and #size-cells have same value.
834 sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
835 0, "#size-cells", 1);
838 * Check if it is nand {}; subnode, adjust
839 * the offset in this case
841 off = fdt_next_node(blob, parent_offset, &ndepth);
842 if (off > 0 && ndepth == 1)
846 list_for_each_prev(pentry, &dev->parts) {
849 part = list_entry(pentry, struct part_info, link);
851 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
852 part_num, part->name, part->size,
853 part->offset, part->mask_flags);
855 sprintf(buf, "partition@%llx", part->offset);
857 ret = fdt_add_subnode(blob, parent_offset, buf);
858 if (ret == -FDT_ERR_NOSPACE) {
859 ret = fdt_increase_size(blob, 512);
864 } else if (ret < 0) {
865 printf("Can't add partition node: %s\n",
871 /* Check MTD_WRITEABLE_CMD flag */
872 if (part->mask_flags & 1) {
874 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
875 if (ret == -FDT_ERR_NOSPACE) {
876 ret = fdt_increase_size(blob, 512);
887 ret = fdt_setprop_u64(blob, newoff,
888 "reg", part->offset);
890 ret = fdt_appendprop_u64(blob, newoff,
893 ret = fdt_setprop_u32(blob, newoff,
894 "reg", part->offset);
896 ret = fdt_appendprop_u32(blob, newoff,
900 if (ret == -FDT_ERR_NOSPACE) {
901 ret = fdt_increase_size(blob, 512);
910 ret = fdt_setprop_string(blob, newoff, "label", part->name);
911 if (ret == -FDT_ERR_NOSPACE) {
912 ret = fdt_increase_size(blob, 512);
924 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
927 printf("Can't add property: %s\n", fdt_strerror(ret));
932 * Update partitions in nor/nand nodes using info from
933 * mtdparts environment variable. The nodes to update are
934 * specified by node_info structure which contains mtd device
935 * type and compatible string: E. g. the board code in
936 * ft_board_setup() could use:
938 * struct node_info nodes[] = {
939 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
940 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
943 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
945 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
948 struct mtd_device *dev;
953 for (i = 0; i < node_info_size; i++) {
957 while ((noff = fdt_node_offset_by_compatible(blob, noff,
958 node_info[i].compat)) >= 0) {
961 prop = fdt_getprop(blob, noff, "status", NULL);
962 if (prop && !strcmp(prop, "disabled"))
965 debug("%s: %s, mtd dev type %d\n",
966 fdt_get_name(blob, noff, 0),
967 node_info[i].compat, node_info[i].type);
970 if (mtdparts_init() != 0)
975 dev = device_find(node_info[i].type, idx++);
977 if (fdt_node_set_part_info(blob, noff, dev))
978 return; /* return on error */
985 void fdt_del_node_and_alias(void *blob, const char *alias)
987 int off = fdt_path_offset(blob, alias);
992 fdt_del_node(blob, off);
994 off = fdt_path_offset(blob, "/aliases");
995 fdt_delprop(blob, off, alias);
998 /* Max address size we deal with */
999 #define OF_MAX_ADDR_CELLS 4
1000 #define OF_BAD_ADDR FDT_ADDR_T_NONE
1001 #define OF_CHECK_COUNTS(na, ns) (((na) > 0 && (na) <= OF_MAX_ADDR_CELLS) && \
1002 ((ns) > 0 || gd_size_cells_0()))
1006 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1010 printf(" %08x", *(addr++));
1014 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1018 * struct of_bus - Callbacks for bus specific translators
1019 * @name: A string used to identify this bus in debug output.
1020 * @addresses: The name of the DT property from which addresses are
1021 * to be read, typically "reg".
1022 * @match: Return non-zero if the node whose parent is at
1023 * parentoffset in the FDT blob corresponds to a bus
1024 * of this type, otherwise return zero. If NULL a match
1026 * @count_cells:Count how many cells (be32 values) a node whose parent
1027 * is at parentoffset in the FDT blob will require to
1028 * represent its address (written to *addrc) & size
1029 * (written to *sizec).
1030 * @map: Map the address addr from the address space of this
1031 * bus to that of its parent, making use of the ranges
1032 * read from DT to an array at range. na and ns are the
1033 * number of cells (be32 values) used to hold and address
1034 * or size, respectively, for this bus. pna is the number
1035 * of cells used to hold an address for the parent bus.
1036 * Returns the address in the address space of the parent
1038 * @translate: Update the value of the address cells at addr within an
1039 * FDT by adding offset to it. na specifies the number of
1040 * cells used to hold the address being translated. Returns
1041 * zero on success, non-zero on error.
1043 * Each bus type will include a struct of_bus in the of_busses array,
1044 * providing implementations of some or all of the functions used to
1045 * match the bus & handle address translation for its children.
1049 const char *addresses;
1050 int (*match)(const void *blob, int parentoffset);
1051 void (*count_cells)(const void *blob, int parentoffset,
1052 int *addrc, int *sizec);
1053 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1054 int na, int ns, int pna);
1055 int (*translate)(fdt32_t *addr, u64 offset, int na);
1058 /* Default translator (generic bus) */
1059 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1060 int *addrc, int *sizec)
1062 const fdt32_t *prop;
1065 *addrc = fdt_address_cells(blob, parentoffset);
1068 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1070 *sizec = be32_to_cpup(prop);
1076 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1077 int na, int ns, int pna)
1081 cp = fdt_read_number(range, na);
1082 s = fdt_read_number(range + na + pna, ns);
1083 da = fdt_read_number(addr, na);
1085 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1087 if (da < cp || da >= (cp + s))
1092 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1094 u64 a = fdt_read_number(addr, na);
1095 memset(addr, 0, na * 4);
1098 addr[na - 2] = cpu_to_fdt32(a >> 32);
1099 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1104 #ifdef CONFIG_OF_ISA_BUS
1106 /* ISA bus translator */
1107 static int of_bus_isa_match(const void *blob, int parentoffset)
1111 name = fdt_get_name(blob, parentoffset, NULL);
1115 return !strcmp(name, "isa");
1118 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1119 int *addrc, int *sizec)
1127 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1128 int na, int ns, int pna)
1132 /* Check address type match */
1133 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1136 cp = fdt_read_number(range + 1, na - 1);
1137 s = fdt_read_number(range + na + pna, ns);
1138 da = fdt_read_number(addr + 1, na - 1);
1140 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1142 if (da < cp || da >= (cp + s))
1147 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1149 return of_bus_default_translate(addr + 1, offset, na - 1);
1152 #endif /* CONFIG_OF_ISA_BUS */
1154 /* Array of bus specific translators */
1155 static struct of_bus of_busses[] = {
1156 #ifdef CONFIG_OF_ISA_BUS
1161 .match = of_bus_isa_match,
1162 .count_cells = of_bus_isa_count_cells,
1163 .map = of_bus_isa_map,
1164 .translate = of_bus_isa_translate,
1166 #endif /* CONFIG_OF_ISA_BUS */
1171 .count_cells = fdt_support_default_count_cells,
1172 .map = of_bus_default_map,
1173 .translate = of_bus_default_translate,
1177 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1181 if (ARRAY_SIZE(of_busses) == 1)
1184 for (bus = of_busses; bus; bus++) {
1185 if (!bus->match || bus->match(blob, parentoffset))
1190 * We should always have matched the default bus at least, since
1191 * it has a NULL match field. If we didn't then it somehow isn't
1192 * in the of_busses array or something equally catastrophic has
1199 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1200 struct of_bus *pbus, fdt32_t *addr,
1201 int na, int ns, int pna, const char *rprop)
1203 const fdt32_t *ranges;
1206 u64 offset = OF_BAD_ADDR;
1208 /* Normally, an absence of a "ranges" property means we are
1209 * crossing a non-translatable boundary, and thus the addresses
1210 * below the current not cannot be converted to CPU physical ones.
1211 * Unfortunately, while this is very clear in the spec, it's not
1212 * what Apple understood, and they do have things like /uni-n or
1213 * /ht nodes with no "ranges" property and a lot of perfectly
1214 * useable mapped devices below them. Thus we treat the absence of
1215 * "ranges" as equivalent to an empty "ranges" property which means
1216 * a 1:1 translation at that level. It's up to the caller not to try
1217 * to translate addresses that aren't supposed to be translated in
1218 * the first place. --BenH.
1220 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1221 if (ranges == NULL || rlen == 0) {
1222 offset = fdt_read_number(addr, na);
1223 memset(addr, 0, pna * 4);
1224 debug("OF: no ranges, 1:1 translation\n");
1228 debug("OF: walking ranges...\n");
1230 /* Now walk through the ranges */
1232 rone = na + pna + ns;
1233 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1234 offset = bus->map(addr, ranges, na, ns, pna);
1235 if (offset != OF_BAD_ADDR)
1238 if (offset == OF_BAD_ADDR) {
1239 debug("OF: not found !\n");
1242 memcpy(addr, ranges + na, 4 * pna);
1245 of_dump_addr("OF: parent translation for:", addr, pna);
1246 debug("OF: with offset: %llu\n", offset);
1248 /* Translate it into parent bus space */
1249 return pbus->translate(addr, offset, pna);
1253 * Translate an address from the device-tree into a CPU physical address,
1254 * this walks up the tree and applies the various bus mappings on the
1257 * Note: We consider that crossing any level with #size-cells == 0 to mean
1258 * that translation is impossible (that is we are not dealing with a value
1259 * that can be mapped to a cpu physical address). This is not really specified
1260 * that way, but this is traditionally the way IBM at least do things
1262 static u64 __of_translate_address(const void *blob, int node_offset,
1263 const fdt32_t *in_addr, const char *rprop)
1266 struct of_bus *bus, *pbus;
1267 fdt32_t addr[OF_MAX_ADDR_CELLS];
1268 int na, ns, pna, pns;
1269 u64 result = OF_BAD_ADDR;
1271 debug("OF: ** translation for device %s **\n",
1272 fdt_get_name(blob, node_offset, NULL));
1274 /* Get parent & match bus type */
1275 parent = fdt_parent_offset(blob, node_offset);
1278 bus = of_match_bus(blob, parent);
1280 /* Cound address cells & copy address locally */
1281 bus->count_cells(blob, parent, &na, &ns);
1282 if (!OF_CHECK_COUNTS(na, ns)) {
1283 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1284 fdt_get_name(blob, node_offset, NULL));
1287 memcpy(addr, in_addr, na * 4);
1289 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1290 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1291 of_dump_addr("OF: translating address:", addr, na);
1295 /* Switch to parent bus */
1296 node_offset = parent;
1297 parent = fdt_parent_offset(blob, node_offset);
1299 /* If root, we have finished */
1301 debug("OF: reached root node\n");
1302 result = fdt_read_number(addr, na);
1306 /* Get new parent bus and counts */
1307 pbus = of_match_bus(blob, parent);
1308 pbus->count_cells(blob, parent, &pna, &pns);
1309 if (!OF_CHECK_COUNTS(pna, pns)) {
1310 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1311 fdt_get_name(blob, node_offset, NULL));
1315 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1316 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1318 /* Apply bus translation */
1319 if (of_translate_one(blob, node_offset, bus, pbus,
1320 addr, na, ns, pna, rprop))
1323 /* Complete the move up one level */
1328 of_dump_addr("OF: one level translation:", addr, na);
1335 u64 fdt_translate_address(const void *blob, int node_offset,
1336 const fdt32_t *in_addr)
1338 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1341 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1342 const fdt32_t *in_addr)
1344 return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1347 int fdt_get_dma_range(const void *blob, int node, phys_addr_t *cpu,
1348 dma_addr_t *bus, u64 *size)
1350 bool found_dma_ranges = false;
1351 struct of_bus *bus_node;
1352 const fdt32_t *ranges;
1353 int na, ns, pna, pns;
1358 /* Find the closest dma-ranges property */
1359 while (parent >= 0) {
1360 ranges = fdt_getprop(blob, parent, "dma-ranges", &len);
1362 /* Ignore empty ranges, they imply no translation required */
1363 if (ranges && len > 0)
1366 /* Once we find 'dma-ranges', then a missing one is an error */
1367 if (found_dma_ranges && !ranges) {
1373 found_dma_ranges = true;
1375 parent = fdt_parent_offset(blob, parent);
1378 if (!ranges || parent < 0) {
1379 debug("no dma-ranges found for node %s\n",
1380 fdt_get_name(blob, node, NULL));
1385 /* switch to that node */
1387 parent = fdt_parent_offset(blob, node);
1389 printf("Found dma-ranges in root node, shoudln't happen\n");
1394 /* Get the address sizes both for the bus and its parent */
1395 bus_node = of_match_bus(blob, node);
1396 bus_node->count_cells(blob, node, &na, &ns);
1397 if (!OF_CHECK_COUNTS(na, ns)) {
1398 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1399 fdt_get_name(blob, node, NULL));
1404 bus_node = of_match_bus(blob, parent);
1405 bus_node->count_cells(blob, parent, &pna, &pns);
1406 if (!OF_CHECK_COUNTS(pna, pns)) {
1407 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1408 fdt_get_name(blob, parent, NULL));
1413 *bus = fdt_read_number(ranges, na);
1414 *cpu = fdt_translate_dma_address(blob, node, ranges + na);
1415 *size = fdt_read_number(ranges + na + pna, ns);
1421 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1422 * who's reg property matches a physical cpu address
1424 * @blob: ptr to device tree
1425 * @compat: compatiable string to match
1426 * @compat_off: property name
1429 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1430 phys_addr_t compat_off)
1432 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1433 while (off != -FDT_ERR_NOTFOUND) {
1434 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1436 if (compat_off == fdt_translate_address(blob, off, reg))
1439 off = fdt_node_offset_by_compatible(blob, off, compat);
1442 return -FDT_ERR_NOTFOUND;
1446 * fdt_alloc_phandle: Return next free phandle value
1448 * @blob: ptr to device tree
1450 int fdt_alloc_phandle(void *blob)
1453 uint32_t phandle = 0;
1455 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1456 offset = fdt_next_node(blob, offset, NULL)) {
1457 phandle = max(phandle, fdt_get_phandle(blob, offset));
1464 * fdt_set_phandle: Create a phandle property for the given node
1466 * @fdt: ptr to device tree
1467 * @nodeoffset: node to update
1468 * @phandle: phandle value to set (must be unique)
1470 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1475 int off = fdt_node_offset_by_phandle(fdt, phandle);
1477 if ((off >= 0) && (off != nodeoffset)) {
1480 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1481 printf("Trying to update node %s with phandle %u ",
1484 fdt_get_path(fdt, off, buf, sizeof(buf));
1485 printf("that already exists in node %s.\n", buf);
1486 return -FDT_ERR_BADPHANDLE;
1490 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1495 * For now, also set the deprecated "linux,phandle" property, so that we
1496 * don't break older kernels.
1498 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1504 * fdt_create_phandle: Create a phandle property for the given node
1506 * @fdt: ptr to device tree
1507 * @nodeoffset: node to update
1509 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1511 /* see if there is a phandle already */
1512 int phandle = fdt_get_phandle(fdt, nodeoffset);
1514 /* if we got 0, means no phandle so create one */
1518 phandle = fdt_alloc_phandle(fdt);
1519 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1521 printf("Can't set phandle %u: %s\n", phandle,
1531 * fdt_set_node_status: Set status for the given node
1533 * @fdt: ptr to device tree
1534 * @nodeoffset: node to update
1535 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1536 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1537 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1539 int fdt_set_node_status(void *fdt, int nodeoffset,
1540 enum fdt_status status, unsigned int error_code)
1549 case FDT_STATUS_OKAY:
1550 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1552 case FDT_STATUS_DISABLED:
1553 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1555 case FDT_STATUS_FAIL:
1556 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1558 case FDT_STATUS_FAIL_ERROR_CODE:
1559 sprintf(buf, "fail-%d", error_code);
1560 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1563 printf("Invalid fdt status: %x\n", status);
1572 * fdt_set_status_by_alias: Set status for the given node given an alias
1574 * @fdt: ptr to device tree
1575 * @alias: alias of node to update
1576 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1577 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1578 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1580 int fdt_set_status_by_alias(void *fdt, const char* alias,
1581 enum fdt_status status, unsigned int error_code)
1583 int offset = fdt_path_offset(fdt, alias);
1585 return fdt_set_node_status(fdt, offset, status, error_code);
1588 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1589 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1594 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1595 if (noff != -FDT_ERR_NOTFOUND) {
1596 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1598 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1599 if (ret == -FDT_ERR_NOSPACE) {
1600 ret = fdt_increase_size(blob, 512);
1605 } else if (ret < 0) {
1606 printf("Can't add property: %s\n", fdt_strerror(ret));
1612 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1618 * Verify the physical address of device tree node for a given alias
1620 * This function locates the device tree node of a given alias, and then
1621 * verifies that the physical address of that device matches the given
1622 * parameter. It displays a message if there is a mismatch.
1624 * Returns 1 on success, 0 on failure
1626 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1633 path = fdt_getprop(fdt, anode, alias, NULL);
1635 /* If there's no such alias, then it's not a failure */
1639 node = fdt_path_offset(fdt, path);
1641 printf("Warning: device tree alias '%s' points to invalid "
1642 "node %s.\n", alias, path);
1646 reg = fdt_getprop(fdt, node, "reg", &len);
1648 printf("Warning: device tree node '%s' has no address.\n",
1653 dt_addr = fdt_translate_address(fdt, node, reg);
1654 if (addr != dt_addr) {
1655 printf("Warning: U-Boot configured device %s at address %llu,\n"
1656 "but the device tree has it address %llx.\n",
1657 alias, addr, dt_addr);
1665 * Returns the base address of an SOC or PCI node
1667 u64 fdt_get_base_address(const void *fdt, int node)
1670 const fdt32_t *prop;
1672 prop = fdt_getprop(fdt, node, "reg", &size);
1674 return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1678 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1680 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1681 uint64_t *val, int cells)
1683 const fdt32_t *prop32 = &prop[cell_off];
1684 const unaligned_fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1686 if ((cell_off + cells) > prop_len)
1687 return -FDT_ERR_NOSPACE;
1691 *val = fdt32_to_cpu(*prop32);
1694 *val = fdt64_to_cpu(*prop64);
1697 return -FDT_ERR_NOSPACE;
1704 * fdt_read_range - Read a node's n'th range property
1706 * @fdt: ptr to device tree
1707 * @node: offset of node
1709 * @child_addr: pointer to storage for the "child address" field
1710 * @addr: pointer to storage for the CPU view translated physical start
1711 * @len: pointer to storage for the range length
1713 * Convenience function that reads and interprets a specific range out of
1714 * a number of the "ranges" property array.
1716 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1717 uint64_t *addr, uint64_t *len)
1719 int pnode = fdt_parent_offset(fdt, node);
1720 const fdt32_t *ranges;
1729 * The "ranges" property is an array of
1730 * { <child address> <parent address> <size in child address space> }
1732 * All 3 elements can span a diffent number of cells. Fetch their size.
1734 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1735 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1736 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1738 /* Now try to get the ranges property */
1739 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1741 return -FDT_ERR_NOTFOUND;
1742 ranges_len /= sizeof(uint32_t);
1744 /* Jump to the n'th entry */
1745 cell = n * (pacells + acells + scells);
1747 /* Read <child address> */
1749 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1756 /* Read <parent address> */
1758 *addr = fdt_translate_address(fdt, node, ranges + cell);
1761 /* Read <size in child address space> */
1763 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1772 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1774 * @fdt: ptr to device tree
1775 * @node: offset of the simplefb node
1776 * @base_address: framebuffer base address
1777 * @width: width in pixels
1778 * @height: height in pixels
1779 * @stride: bytes per line
1780 * @format: pixel format string
1782 * Convenience function to fill and enable a simplefb node.
1784 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1785 u32 height, u32 stride, const char *format)
1789 int i, addrc, sizec, ret;
1791 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1795 cells[i++] = cpu_to_fdt32(base_address >> 32);
1796 cells[i++] = cpu_to_fdt32(base_address);
1799 cells[i++] = cpu_to_fdt32(height * stride);
1801 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1805 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1806 ret = fdt_set_name(fdt, node, name);
1810 ret = fdt_setprop_u32(fdt, node, "width", width);
1814 ret = fdt_setprop_u32(fdt, node, "height", height);
1818 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1822 ret = fdt_setprop_string(fdt, node, "format", format);
1826 ret = fdt_setprop_string(fdt, node, "status", "okay");
1834 * Update native-mode in display-timings from display environment variable.
1835 * The node to update are specified by path.
1837 int fdt_fixup_display(void *blob, const char *path, const char *display)
1841 if (!display || !path)
1842 return -FDT_ERR_NOTFOUND;
1844 toff = fdt_path_offset(blob, path);
1846 toff = fdt_subnode_offset(blob, toff, "display-timings");
1850 for (off = fdt_first_subnode(blob, toff);
1852 off = fdt_next_subnode(blob, off)) {
1853 uint32_t h = fdt_get_phandle(blob, off);
1854 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1856 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1857 return fdt_setprop_u32(blob, toff, "native-mode", h);
1862 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1864 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1866 * @fdt: ptr to device tree
1867 * @fdto: ptr to device tree overlay
1869 * Convenience function to apply an overlay and display helpful messages
1870 * in the case of an error
1872 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1877 err = fdt_path_offset(fdt, "/__symbols__");
1878 has_symbols = err >= 0;
1880 err = fdt_overlay_apply(fdt, fdto);
1882 printf("failed on fdt_overlay_apply(): %s\n",
1885 printf("base fdt does did not have a /__symbols__ node\n");
1886 printf("make sure you've compiled with -@\n");