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>
24 * fdt_getprop_u32_default_node - Return a node's property or a default
26 * @fdt: ptr to device tree
27 * @off: offset of node
28 * @cell: cell offset in property
29 * @prop: property name
30 * @dflt: default value if the property isn't found
32 * Convenience function to return a node's property or a default value if
33 * the property doesn't exist.
35 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
36 const char *prop, const u32 dflt)
41 val = fdt_getprop(fdt, off, prop, &len);
43 /* Check if property exists */
47 /* Check if property is long enough */
48 if (len < ((cell + 1) * sizeof(uint32_t)))
51 return fdt32_to_cpu(*val);
55 * fdt_getprop_u32_default - Find a node and return it's property or a default
57 * @fdt: ptr to device tree
59 * @prop: property name
60 * @dflt: default value if the property isn't found
62 * Convenience function to find a node and return it's property or a
63 * default value if it doesn't exist.
65 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
66 const char *prop, const u32 dflt)
70 off = fdt_path_offset(fdt, path);
74 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
78 * fdt_find_and_setprop: Find a node and set it's property
80 * @fdt: ptr to device tree
82 * @prop: property name
83 * @val: ptr to new value
84 * @len: length of new property value
85 * @create: flag to create the property if it doesn't exist
87 * Convenience function to directly set a property given the path to the node.
89 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
90 const void *val, int len, int create)
92 int nodeoff = fdt_path_offset(fdt, node);
97 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
98 return 0; /* create flag not set; so exit quietly */
100 return fdt_setprop(fdt, nodeoff, prop, val, len);
104 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
106 * @fdt: pointer to the device tree blob
107 * @parentoffset: structure block offset of a node
108 * @name: name of the subnode to locate
110 * fdt_subnode_offset() finds a subnode of the node with a given name.
111 * If the subnode does not exist, it will be created.
113 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
117 offset = fdt_subnode_offset(fdt, parentoffset, name);
119 if (offset == -FDT_ERR_NOTFOUND)
120 offset = fdt_add_subnode(fdt, parentoffset, name);
123 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
128 #if defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
129 static int fdt_fixup_stdout(void *fdt, int chosenoff)
133 char sername[9] = { 0 };
136 char tmp[256]; /* long enough */
138 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
140 aliasoff = fdt_path_offset(fdt, "/aliases");
146 path = fdt_getprop(fdt, aliasoff, sername, &len);
152 /* fdt_setprop may break "path" so we copy it to tmp buffer */
153 memcpy(tmp, path, len);
155 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
157 printf("WARNING: could not set linux,stdout-path %s.\n",
163 printf("WARNING: %s: could not read %s alias: %s\n",
164 __func__, sername, fdt_strerror(err));
169 static int fdt_fixup_stdout(void *fdt, int chosenoff)
175 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
176 uint64_t val, int is_u64)
179 return fdt_setprop_u64(fdt, nodeoffset, name, val);
181 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
184 int fdt_root(void *fdt)
189 err = fdt_check_header(fdt);
191 printf("fdt_root: %s\n", fdt_strerror(err));
195 serial = env_get("serial#");
197 err = fdt_setprop(fdt, 0, "serial-number", serial,
201 printf("WARNING: could not set serial-number %s.\n",
210 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
217 /* just return if the size of initrd is zero */
218 if (initrd_start == initrd_end)
221 /* find or create "/chosen" node. */
222 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
226 total = fdt_num_mem_rsv(fdt);
229 * Look for an existing entry and update it. If we don't find
230 * the entry, we will j be the next available slot.
232 for (j = 0; j < total; j++) {
233 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
234 if (addr == initrd_start) {
235 fdt_del_mem_rsv(fdt, j);
240 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
242 printf("fdt_initrd: %s\n", fdt_strerror(err));
246 is_u64 = (fdt_address_cells(fdt, 0) == 2);
248 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
249 (uint64_t)initrd_start, is_u64);
252 printf("WARNING: could not set linux,initrd-start %s.\n",
257 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
258 (uint64_t)initrd_end, is_u64);
261 printf("WARNING: could not set linux,initrd-end %s.\n",
271 * board_fdt_chosen_bootargs - boards may override this function to use
272 * alternative kernel command line arguments
274 __weak char *board_fdt_chosen_bootargs(void)
276 return env_get("bootargs");
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 = board_fdt_chosen_bootargs();
299 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
302 printf("WARNING: could not set bootargs %s.\n",
308 return fdt_fixup_stdout(fdt, nodeoffset);
311 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
312 const void *val, int len, int create)
316 debug("Updating property '%s/%s' = ", path, prop);
317 for (i = 0; i < len; i++)
318 debug(" %.2x", *(u8*)(val+i));
321 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
323 printf("Unable to update property %s:%s, err=%s\n",
324 path, prop, fdt_strerror(rc));
327 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
330 fdt32_t tmp = cpu_to_fdt32(val);
331 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
334 void do_fixup_by_prop(void *fdt,
335 const char *pname, const void *pval, int plen,
336 const char *prop, const void *val, int len,
342 debug("Updating property '%s' = ", prop);
343 for (i = 0; i < len; i++)
344 debug(" %.2x", *(u8*)(val+i));
347 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
348 while (off != -FDT_ERR_NOTFOUND) {
349 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
350 fdt_setprop(fdt, off, prop, val, len);
351 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
355 void do_fixup_by_prop_u32(void *fdt,
356 const char *pname, const void *pval, int plen,
357 const char *prop, u32 val, int create)
359 fdt32_t tmp = cpu_to_fdt32(val);
360 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
363 void do_fixup_by_compat(void *fdt, const char *compat,
364 const char *prop, const void *val, int len, int create)
369 debug("Updating property '%s' = ", prop);
370 for (i = 0; i < len; i++)
371 debug(" %.2x", *(u8*)(val+i));
374 off = fdt_node_offset_by_compatible(fdt, -1, compat);
375 while (off != -FDT_ERR_NOTFOUND) {
376 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
377 fdt_setprop(fdt, off, prop, val, len);
378 off = fdt_node_offset_by_compatible(fdt, off, compat);
382 void do_fixup_by_compat_u32(void *fdt, const char *compat,
383 const char *prop, u32 val, int create)
385 fdt32_t tmp = cpu_to_fdt32(val);
386 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
389 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
391 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
393 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
397 int address_cells = fdt_address_cells(fdt, 0);
398 int size_cells = fdt_size_cells(fdt, 0);
401 for (i = 0; i < n; i++) {
402 if (address_cells == 2)
403 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
405 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
406 p += 4 * address_cells;
409 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
411 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
415 return p - (char *)buf;
418 #if CONFIG_NR_DRAM_BANKS > 4
419 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
421 #define MEMORY_BANKS_MAX 4
423 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
427 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
429 if (banks > MEMORY_BANKS_MAX) {
430 printf("%s: num banks %d exceeds hardcoded limit %d."
431 " Recompile with higher MEMORY_BANKS_MAX?\n",
432 __FUNCTION__, banks, MEMORY_BANKS_MAX);
436 err = fdt_check_header(blob);
438 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
442 /* find or create "/memory" node. */
443 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
447 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
450 printf("WARNING: could not set %s %s.\n", "device_type",
455 for (i = 0; i < banks; i++) {
456 if (start[i] == 0 && size[i] == 0)
465 len = fdt_pack_reg(blob, tmp, start, size, banks);
467 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
469 printf("WARNING: could not set %s %s.\n",
470 "reg", fdt_strerror(err));
476 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int areas)
480 u8 tmp[8 * 16]; /* Up to 64-bit address + 64-bit size */
483 printf("%s: num areas %d exceeds hardcoded limit %d\n",
488 err = fdt_check_header(blob);
490 printf("%s: %s\n", __func__, fdt_strerror(err));
494 /* find or create "/memory" node. */
495 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
499 len = fdt_pack_reg(blob, tmp, start, size, areas);
501 err = fdt_setprop(blob, nodeoffset, "linux,usable-memory", tmp, len);
503 printf("WARNING: could not set %s %s.\n",
504 "reg", fdt_strerror(err));
512 int fdt_fixup_memory(void *blob, u64 start, u64 size)
514 return fdt_fixup_memory_banks(blob, &start, &size, 1);
517 void fdt_fixup_ethernet(void *fdt)
523 unsigned char mac_addr[ARP_HLEN];
525 #ifdef FDT_SEQ_MACADDR_FROM_ENV
527 const struct fdt_property *fdt_prop;
530 if (fdt_path_offset(fdt, "/aliases") < 0)
533 /* Cycle through all aliases */
534 for (prop = 0; ; prop++) {
537 /* FDT might have been edited, recompute the offset */
538 offset = fdt_first_property_offset(fdt,
539 fdt_path_offset(fdt, "/aliases"));
540 /* Select property number 'prop' */
541 for (j = 0; j < prop; j++)
542 offset = fdt_next_property_offset(fdt, offset);
547 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
548 if (!strncmp(name, "ethernet", 8)) {
549 /* Treat plain "ethernet" same as "ethernet0". */
550 if (!strcmp(name, "ethernet")
551 #ifdef FDT_SEQ_MACADDR_FROM_ENV
552 || !strcmp(name, "ethernet0")
556 #ifndef FDT_SEQ_MACADDR_FROM_ENV
558 i = trailing_strtol(name);
562 strcpy(mac, "ethaddr");
564 sprintf(mac, "eth%daddr", i);
568 #ifdef FDT_SEQ_MACADDR_FROM_ENV
569 nodeoff = fdt_path_offset(fdt, path);
570 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
572 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
580 for (j = 0; j < 6; j++) {
582 simple_strtoul(tmp, &end, 16) : 0;
584 tmp = (*end) ? end + 1 : end;
587 do_fixup_by_path(fdt, path, "mac-address",
589 do_fixup_by_path(fdt, path, "local-mac-address",
595 int fdt_record_loadable(void *blob, u32 index, const char *name,
596 uintptr_t load_addr, u32 size, uintptr_t entry_point,
597 const char *type, const char *os)
601 err = fdt_check_header(blob);
603 printf("%s: %s\n", __func__, fdt_strerror(err));
607 /* find or create "/fit-images" node */
608 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
612 /* find or create "/fit-images/<name>" node */
613 node = fdt_find_or_add_subnode(blob, node, name);
617 fdt_setprop_u64(blob, node, "load", load_addr);
618 if (entry_point != -1)
619 fdt_setprop_u64(blob, node, "entry", entry_point);
620 fdt_setprop_u32(blob, node, "size", size);
622 fdt_setprop_string(blob, node, "type", type);
624 fdt_setprop_string(blob, node, "os", os);
629 /* Resize the fdt to its actual size + a bit of padding */
630 int fdt_shrink_to_minimum(void *blob, uint extrasize)
641 total = fdt_num_mem_rsv(blob);
642 for (i = 0; i < total; i++) {
643 fdt_get_mem_rsv(blob, i, &addr, &size);
644 if (addr == (uintptr_t)blob) {
645 fdt_del_mem_rsv(blob, i);
652 * Calculate the actual size of the fdt
653 * plus the size needed for 5 fdt_add_mem_rsv, one
654 * for the fdt itself and 4 for a possible initrd
655 * ((initrd-start + initrd-end) * 2 (name & value))
657 actualsize = fdt_off_dt_strings(blob) +
658 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
660 actualsize += extrasize;
661 /* Make it so the fdt ends on a page boundary */
662 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
663 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
665 /* Change the fdt header to reflect the correct size */
666 fdt_set_totalsize(blob, actualsize);
669 /* Add the new reservation */
670 ret = fdt_add_mem_rsv(blob, map_to_sysmem(blob), actualsize);
679 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
681 #define FDT_PCI_PREFETCH (0x40000000)
682 #define FDT_PCI_MEM32 (0x02000000)
683 #define FDT_PCI_IO (0x01000000)
684 #define FDT_PCI_MEM64 (0x03000000)
686 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
688 int addrcell, sizecell, len, r;
690 /* sized based on pci addr cells, size-cells, & address-cells */
691 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
693 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
694 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
696 dma_range = &dma_ranges[0];
697 for (r = 0; r < hose->region_count; r++) {
698 u64 bus_start, phys_start, size;
700 /* skip if !PCI_REGION_SYS_MEMORY */
701 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
704 bus_start = (u64)hose->regions[r].bus_start;
705 phys_start = (u64)hose->regions[r].phys_start;
706 size = (u64)hose->regions[r].size;
709 if (size >= 0x100000000ull)
710 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM64);
712 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
713 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
714 dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
715 #ifdef CONFIG_SYS_PCI_64BIT
716 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
720 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
723 dma_range[3] = cpu_to_fdt32(phys_start >> 32);
724 dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
726 dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
730 dma_range[3 + addrcell + 0] =
731 cpu_to_fdt32(size >> 32);
732 dma_range[3 + addrcell + 1] =
733 cpu_to_fdt32(size & 0xffffffff);
735 dma_range[3 + addrcell + 0] =
736 cpu_to_fdt32(size & 0xffffffff);
739 dma_range += (3 + addrcell + sizecell);
742 len = dma_range - &dma_ranges[0];
744 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
750 int fdt_increase_size(void *fdt, int add_len)
754 newlen = fdt_totalsize(fdt) + add_len;
756 /* Open in place with a new len */
757 return fdt_open_into(fdt, fdt, newlen);
760 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
761 #include <jffs2/load_kernel.h>
762 #include <mtd_node.h>
764 static int fdt_del_subnodes(const void *blob, int parent_offset)
769 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
770 (off >= 0) && (ndepth > 0);
771 off = fdt_next_node(blob, off, &ndepth)) {
773 debug("delete %s: offset: %x\n",
774 fdt_get_name(blob, off, 0), off);
775 ret = fdt_del_node((void *)blob, off);
777 printf("Can't delete node: %s\n",
789 static int fdt_del_partitions(void *blob, int parent_offset)
796 off = fdt_next_node(blob, parent_offset, &ndepth);
797 if (off > 0 && ndepth == 1) {
798 prop = fdt_getprop(blob, off, "label", NULL);
801 * Could not find label property, nand {}; node?
802 * Check subnode, delete partitions there if any.
804 return fdt_del_partitions(blob, off);
806 ret = fdt_del_subnodes(blob, parent_offset);
808 printf("Can't remove subnodes: %s\n",
817 static int fdt_node_set_part_info(void *blob, int parent_offset,
818 struct mtd_device *dev)
820 struct list_head *pentry;
821 struct part_info *part;
827 ret = fdt_del_partitions(blob, parent_offset);
832 * Check if size/address is 1 or 2 cells.
833 * We assume #address-cells and #size-cells have same value.
835 sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
836 0, "#size-cells", 1);
839 * Check if it is nand {}; subnode, adjust
840 * the offset in this case
842 off = fdt_next_node(blob, parent_offset, &ndepth);
843 if (off > 0 && ndepth == 1)
847 list_for_each_prev(pentry, &dev->parts) {
850 part = list_entry(pentry, struct part_info, link);
852 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
853 part_num, part->name, part->size,
854 part->offset, part->mask_flags);
856 sprintf(buf, "partition@%llx", part->offset);
858 ret = fdt_add_subnode(blob, parent_offset, buf);
859 if (ret == -FDT_ERR_NOSPACE) {
860 ret = fdt_increase_size(blob, 512);
865 } else if (ret < 0) {
866 printf("Can't add partition node: %s\n",
872 /* Check MTD_WRITEABLE_CMD flag */
873 if (part->mask_flags & 1) {
875 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
876 if (ret == -FDT_ERR_NOSPACE) {
877 ret = fdt_increase_size(blob, 512);
888 ret = fdt_setprop_u64(blob, newoff,
889 "reg", part->offset);
891 ret = fdt_appendprop_u64(blob, newoff,
894 ret = fdt_setprop_u32(blob, newoff,
895 "reg", part->offset);
897 ret = fdt_appendprop_u32(blob, newoff,
901 if (ret == -FDT_ERR_NOSPACE) {
902 ret = fdt_increase_size(blob, 512);
911 ret = fdt_setprop_string(blob, newoff, "label", part->name);
912 if (ret == -FDT_ERR_NOSPACE) {
913 ret = fdt_increase_size(blob, 512);
925 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
928 printf("Can't add property: %s\n", fdt_strerror(ret));
933 * Update partitions in nor/nand nodes using info from
934 * mtdparts environment variable. The nodes to update are
935 * specified by node_info structure which contains mtd device
936 * type and compatible string: E. g. the board code in
937 * ft_board_setup() could use:
939 * struct node_info nodes[] = {
940 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
941 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
944 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
946 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
949 struct mtd_device *dev;
954 for (i = 0; i < node_info_size; i++) {
958 while ((noff = fdt_node_offset_by_compatible(blob, noff,
959 node_info[i].compat)) >= 0) {
962 prop = fdt_getprop(blob, noff, "status", NULL);
963 if (prop && !strcmp(prop, "disabled"))
966 debug("%s: %s, mtd dev type %d\n",
967 fdt_get_name(blob, noff, 0),
968 node_info[i].compat, node_info[i].type);
971 if (mtdparts_init() != 0)
976 dev = device_find(node_info[i].type, idx++);
978 if (fdt_node_set_part_info(blob, noff, dev))
979 return; /* return on error */
986 void fdt_del_node_and_alias(void *blob, const char *alias)
988 int off = fdt_path_offset(blob, alias);
993 fdt_del_node(blob, off);
995 off = fdt_path_offset(blob, "/aliases");
996 fdt_delprop(blob, off, alias);
999 /* Max address size we deal with */
1000 #define OF_MAX_ADDR_CELLS 4
1001 #define OF_BAD_ADDR FDT_ADDR_T_NONE
1002 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
1007 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1011 printf(" %08x", *(addr++));
1015 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1019 * struct of_bus - Callbacks for bus specific translators
1020 * @name: A string used to identify this bus in debug output.
1021 * @addresses: The name of the DT property from which addresses are
1022 * to be read, typically "reg".
1023 * @match: Return non-zero if the node whose parent is at
1024 * parentoffset in the FDT blob corresponds to a bus
1025 * of this type, otherwise return zero. If NULL a match
1027 * @count_cells:Count how many cells (be32 values) a node whose parent
1028 * is at parentoffset in the FDT blob will require to
1029 * represent its address (written to *addrc) & size
1030 * (written to *sizec).
1031 * @map: Map the address addr from the address space of this
1032 * bus to that of its parent, making use of the ranges
1033 * read from DT to an array at range. na and ns are the
1034 * number of cells (be32 values) used to hold and address
1035 * or size, respectively, for this bus. pna is the number
1036 * of cells used to hold an address for the parent bus.
1037 * Returns the address in the address space of the parent
1039 * @translate: Update the value of the address cells at addr within an
1040 * FDT by adding offset to it. na specifies the number of
1041 * cells used to hold the address being translated. Returns
1042 * zero on success, non-zero on error.
1044 * Each bus type will include a struct of_bus in the of_busses array,
1045 * providing implementations of some or all of the functions used to
1046 * match the bus & handle address translation for its children.
1050 const char *addresses;
1051 int (*match)(const void *blob, int parentoffset);
1052 void (*count_cells)(const void *blob, int parentoffset,
1053 int *addrc, int *sizec);
1054 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1055 int na, int ns, int pna);
1056 int (*translate)(fdt32_t *addr, u64 offset, int na);
1059 /* Default translator (generic bus) */
1060 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1061 int *addrc, int *sizec)
1063 const fdt32_t *prop;
1066 *addrc = fdt_address_cells(blob, parentoffset);
1069 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1071 *sizec = be32_to_cpup(prop);
1077 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1078 int na, int ns, int pna)
1082 cp = fdt_read_number(range, na);
1083 s = fdt_read_number(range + na + pna, ns);
1084 da = fdt_read_number(addr, na);
1086 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1088 if (da < cp || da >= (cp + s))
1093 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1095 u64 a = fdt_read_number(addr, na);
1096 memset(addr, 0, na * 4);
1099 addr[na - 2] = cpu_to_fdt32(a >> 32);
1100 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1105 #ifdef CONFIG_OF_ISA_BUS
1107 /* ISA bus translator */
1108 static int of_bus_isa_match(const void *blob, int parentoffset)
1112 name = fdt_get_name(blob, parentoffset, NULL);
1116 return !strcmp(name, "isa");
1119 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1120 int *addrc, int *sizec)
1128 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1129 int na, int ns, int pna)
1133 /* Check address type match */
1134 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1137 cp = fdt_read_number(range + 1, na - 1);
1138 s = fdt_read_number(range + na + pna, ns);
1139 da = fdt_read_number(addr + 1, na - 1);
1141 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1143 if (da < cp || da >= (cp + s))
1148 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1150 return of_bus_default_translate(addr + 1, offset, na - 1);
1153 #endif /* CONFIG_OF_ISA_BUS */
1155 /* Array of bus specific translators */
1156 static struct of_bus of_busses[] = {
1157 #ifdef CONFIG_OF_ISA_BUS
1162 .match = of_bus_isa_match,
1163 .count_cells = of_bus_isa_count_cells,
1164 .map = of_bus_isa_map,
1165 .translate = of_bus_isa_translate,
1167 #endif /* CONFIG_OF_ISA_BUS */
1172 .count_cells = fdt_support_default_count_cells,
1173 .map = of_bus_default_map,
1174 .translate = of_bus_default_translate,
1178 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1182 if (ARRAY_SIZE(of_busses) == 1)
1185 for (bus = of_busses; bus; bus++) {
1186 if (!bus->match || bus->match(blob, parentoffset))
1191 * We should always have matched the default bus at least, since
1192 * it has a NULL match field. If we didn't then it somehow isn't
1193 * in the of_busses array or something equally catastrophic has
1200 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1201 struct of_bus *pbus, fdt32_t *addr,
1202 int na, int ns, int pna, const char *rprop)
1204 const fdt32_t *ranges;
1207 u64 offset = OF_BAD_ADDR;
1209 /* Normally, an absence of a "ranges" property means we are
1210 * crossing a non-translatable boundary, and thus the addresses
1211 * below the current not cannot be converted to CPU physical ones.
1212 * Unfortunately, while this is very clear in the spec, it's not
1213 * what Apple understood, and they do have things like /uni-n or
1214 * /ht nodes with no "ranges" property and a lot of perfectly
1215 * useable mapped devices below them. Thus we treat the absence of
1216 * "ranges" as equivalent to an empty "ranges" property which means
1217 * a 1:1 translation at that level. It's up to the caller not to try
1218 * to translate addresses that aren't supposed to be translated in
1219 * the first place. --BenH.
1221 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1222 if (ranges == NULL || rlen == 0) {
1223 offset = fdt_read_number(addr, na);
1224 memset(addr, 0, pna * 4);
1225 debug("OF: no ranges, 1:1 translation\n");
1229 debug("OF: walking ranges...\n");
1231 /* Now walk through the ranges */
1233 rone = na + pna + ns;
1234 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1235 offset = bus->map(addr, ranges, na, ns, pna);
1236 if (offset != OF_BAD_ADDR)
1239 if (offset == OF_BAD_ADDR) {
1240 debug("OF: not found !\n");
1243 memcpy(addr, ranges + na, 4 * pna);
1246 of_dump_addr("OF: parent translation for:", addr, pna);
1247 debug("OF: with offset: %llu\n", offset);
1249 /* Translate it into parent bus space */
1250 return pbus->translate(addr, offset, pna);
1254 * Translate an address from the device-tree into a CPU physical address,
1255 * this walks up the tree and applies the various bus mappings on the
1258 * Note: We consider that crossing any level with #size-cells == 0 to mean
1259 * that translation is impossible (that is we are not dealing with a value
1260 * that can be mapped to a cpu physical address). This is not really specified
1261 * that way, but this is traditionally the way IBM at least do things
1263 static u64 __of_translate_address(const void *blob, int node_offset,
1264 const fdt32_t *in_addr, const char *rprop)
1267 struct of_bus *bus, *pbus;
1268 fdt32_t addr[OF_MAX_ADDR_CELLS];
1269 int na, ns, pna, pns;
1270 u64 result = OF_BAD_ADDR;
1272 debug("OF: ** translation for device %s **\n",
1273 fdt_get_name(blob, node_offset, NULL));
1275 /* Get parent & match bus type */
1276 parent = fdt_parent_offset(blob, node_offset);
1279 bus = of_match_bus(blob, parent);
1281 /* Cound address cells & copy address locally */
1282 bus->count_cells(blob, parent, &na, &ns);
1283 if (!OF_CHECK_COUNTS(na, ns)) {
1284 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1285 fdt_get_name(blob, node_offset, NULL));
1288 memcpy(addr, in_addr, na * 4);
1290 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1291 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1292 of_dump_addr("OF: translating address:", addr, na);
1296 /* Switch to parent bus */
1297 node_offset = parent;
1298 parent = fdt_parent_offset(blob, node_offset);
1300 /* If root, we have finished */
1302 debug("OF: reached root node\n");
1303 result = fdt_read_number(addr, na);
1307 /* Get new parent bus and counts */
1308 pbus = of_match_bus(blob, parent);
1309 pbus->count_cells(blob, parent, &pna, &pns);
1310 if (!OF_CHECK_COUNTS(pna, pns)) {
1311 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1312 fdt_get_name(blob, node_offset, NULL));
1316 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1317 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1319 /* Apply bus translation */
1320 if (of_translate_one(blob, node_offset, bus, pbus,
1321 addr, na, ns, pna, rprop))
1324 /* Complete the move up one level */
1329 of_dump_addr("OF: one level translation:", addr, na);
1336 u64 fdt_translate_address(const void *blob, int node_offset,
1337 const fdt32_t *in_addr)
1339 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1342 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1343 const fdt32_t *in_addr)
1345 return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1348 int fdt_get_dma_range(const void *blob, int node, phys_addr_t *cpu,
1349 dma_addr_t *bus, u64 *size)
1351 bool found_dma_ranges = false;
1352 struct of_bus *bus_node;
1353 const fdt32_t *ranges;
1354 int na, ns, pna, pns;
1359 /* Find the closest dma-ranges property */
1360 while (parent >= 0) {
1361 ranges = fdt_getprop(blob, parent, "dma-ranges", &len);
1363 /* Ignore empty ranges, they imply no translation required */
1364 if (ranges && len > 0)
1367 /* Once we find 'dma-ranges', then a missing one is an error */
1368 if (found_dma_ranges && !ranges) {
1374 found_dma_ranges = true;
1376 parent = fdt_parent_offset(blob, parent);
1379 if (!ranges || parent < 0) {
1380 debug("no dma-ranges found for node %s\n",
1381 fdt_get_name(blob, node, NULL));
1386 /* switch to that node */
1388 parent = fdt_parent_offset(blob, node);
1390 printf("Found dma-ranges in root node, shoudln't happen\n");
1395 /* Get the address sizes both for the bus and its parent */
1396 bus_node = of_match_bus(blob, node);
1397 bus_node->count_cells(blob, node, &na, &ns);
1398 if (!OF_CHECK_COUNTS(na, ns)) {
1399 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1400 fdt_get_name(blob, node, NULL));
1405 bus_node = of_match_bus(blob, parent);
1406 bus_node->count_cells(blob, parent, &pna, &pns);
1407 if (!OF_CHECK_COUNTS(pna, pns)) {
1408 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1409 fdt_get_name(blob, parent, NULL));
1414 *bus = fdt_read_number(ranges, na);
1415 *cpu = fdt_translate_dma_address(blob, node, ranges + na);
1416 *size = fdt_read_number(ranges + na + pna, ns);
1422 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1423 * who's reg property matches a physical cpu address
1425 * @blob: ptr to device tree
1426 * @compat: compatiable string to match
1427 * @compat_off: property name
1430 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1431 phys_addr_t compat_off)
1433 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1434 while (off != -FDT_ERR_NOTFOUND) {
1435 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1437 if (compat_off == fdt_translate_address(blob, off, reg))
1440 off = fdt_node_offset_by_compatible(blob, off, compat);
1443 return -FDT_ERR_NOTFOUND;
1447 * fdt_alloc_phandle: Return next free phandle value
1449 * @blob: ptr to device tree
1451 int fdt_alloc_phandle(void *blob)
1454 uint32_t phandle = 0;
1456 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1457 offset = fdt_next_node(blob, offset, NULL)) {
1458 phandle = max(phandle, fdt_get_phandle(blob, offset));
1465 * fdt_set_phandle: Create a phandle property for the given node
1467 * @fdt: ptr to device tree
1468 * @nodeoffset: node to update
1469 * @phandle: phandle value to set (must be unique)
1471 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1476 int off = fdt_node_offset_by_phandle(fdt, phandle);
1478 if ((off >= 0) && (off != nodeoffset)) {
1481 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1482 printf("Trying to update node %s with phandle %u ",
1485 fdt_get_path(fdt, off, buf, sizeof(buf));
1486 printf("that already exists in node %s.\n", buf);
1487 return -FDT_ERR_BADPHANDLE;
1491 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1496 * For now, also set the deprecated "linux,phandle" property, so that we
1497 * don't break older kernels.
1499 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1505 * fdt_create_phandle: Create a phandle property for the given node
1507 * @fdt: ptr to device tree
1508 * @nodeoffset: node to update
1510 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1512 /* see if there is a phandle already */
1513 int phandle = fdt_get_phandle(fdt, nodeoffset);
1515 /* if we got 0, means no phandle so create one */
1519 phandle = fdt_alloc_phandle(fdt);
1520 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1522 printf("Can't set phandle %u: %s\n", phandle,
1532 * fdt_set_node_status: Set status for the given node
1534 * @fdt: ptr to device tree
1535 * @nodeoffset: node to update
1536 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1537 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1538 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1540 int fdt_set_node_status(void *fdt, int nodeoffset,
1541 enum fdt_status status, unsigned int error_code)
1550 case FDT_STATUS_OKAY:
1551 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1553 case FDT_STATUS_DISABLED:
1554 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1556 case FDT_STATUS_FAIL:
1557 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1559 case FDT_STATUS_FAIL_ERROR_CODE:
1560 sprintf(buf, "fail-%d", error_code);
1561 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1564 printf("Invalid fdt status: %x\n", status);
1573 * fdt_set_status_by_alias: Set status for the given node given an alias
1575 * @fdt: ptr to device tree
1576 * @alias: alias of node to update
1577 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1578 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1579 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1581 int fdt_set_status_by_alias(void *fdt, const char* alias,
1582 enum fdt_status status, unsigned int error_code)
1584 int offset = fdt_path_offset(fdt, alias);
1586 return fdt_set_node_status(fdt, offset, status, error_code);
1589 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1590 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1595 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1596 if (noff != -FDT_ERR_NOTFOUND) {
1597 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1599 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1600 if (ret == -FDT_ERR_NOSPACE) {
1601 ret = fdt_increase_size(blob, 512);
1606 } else if (ret < 0) {
1607 printf("Can't add property: %s\n", fdt_strerror(ret));
1613 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1619 * Verify the physical address of device tree node for a given alias
1621 * This function locates the device tree node of a given alias, and then
1622 * verifies that the physical address of that device matches the given
1623 * parameter. It displays a message if there is a mismatch.
1625 * Returns 1 on success, 0 on failure
1627 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1634 path = fdt_getprop(fdt, anode, alias, NULL);
1636 /* If there's no such alias, then it's not a failure */
1640 node = fdt_path_offset(fdt, path);
1642 printf("Warning: device tree alias '%s' points to invalid "
1643 "node %s.\n", alias, path);
1647 reg = fdt_getprop(fdt, node, "reg", &len);
1649 printf("Warning: device tree node '%s' has no address.\n",
1654 dt_addr = fdt_translate_address(fdt, node, reg);
1655 if (addr != dt_addr) {
1656 printf("Warning: U-Boot configured device %s at address %llu,\n"
1657 "but the device tree has it address %llx.\n",
1658 alias, addr, dt_addr);
1666 * Returns the base address of an SOC or PCI node
1668 u64 fdt_get_base_address(const void *fdt, int node)
1671 const fdt32_t *prop;
1673 prop = fdt_getprop(fdt, node, "reg", &size);
1675 return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1679 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells,
1680 * or 3 cells specially for a PCI address.
1682 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1683 uint64_t *val, int cells)
1685 const fdt32_t *prop32;
1686 const unaligned_fdt64_t *prop64;
1688 if ((cell_off + cells) > prop_len)
1689 return -FDT_ERR_NOSPACE;
1691 prop32 = &prop[cell_off];
1694 * Special handling for PCI address in PCI bus <ranges>
1696 * PCI child address is made up of 3 cells. Advance the cell offset
1697 * by 1 so that the PCI child address can be correctly read.
1701 prop64 = (const fdt64_t *)&prop[cell_off];
1705 *val = fdt32_to_cpu(*prop32);
1709 *val = fdt64_to_cpu(*prop64);
1712 return -FDT_ERR_NOSPACE;
1719 * fdt_read_range - Read a node's n'th range property
1721 * @fdt: ptr to device tree
1722 * @node: offset of node
1724 * @child_addr: pointer to storage for the "child address" field
1725 * @addr: pointer to storage for the CPU view translated physical start
1726 * @len: pointer to storage for the range length
1728 * Convenience function that reads and interprets a specific range out of
1729 * a number of the "ranges" property array.
1731 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1732 uint64_t *addr, uint64_t *len)
1734 int pnode = fdt_parent_offset(fdt, node);
1735 const fdt32_t *ranges;
1744 * The "ranges" property is an array of
1745 * { <child address> <parent address> <size in child address space> }
1747 * All 3 elements can span a diffent number of cells. Fetch their size.
1749 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1750 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1751 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1753 /* Now try to get the ranges property */
1754 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1756 return -FDT_ERR_NOTFOUND;
1757 ranges_len /= sizeof(uint32_t);
1759 /* Jump to the n'th entry */
1760 cell = n * (pacells + acells + scells);
1762 /* Read <child address> */
1764 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1771 /* Read <parent address> */
1773 *addr = fdt_translate_address(fdt, node, ranges + cell);
1776 /* Read <size in child address space> */
1778 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1787 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1789 * @fdt: ptr to device tree
1790 * @node: offset of the simplefb node
1791 * @base_address: framebuffer base address
1792 * @width: width in pixels
1793 * @height: height in pixels
1794 * @stride: bytes per line
1795 * @format: pixel format string
1797 * Convenience function to fill and enable a simplefb node.
1799 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1800 u32 height, u32 stride, const char *format)
1804 int i, addrc, sizec, ret;
1806 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1810 cells[i++] = cpu_to_fdt32(base_address >> 32);
1811 cells[i++] = cpu_to_fdt32(base_address);
1814 cells[i++] = cpu_to_fdt32(height * stride);
1816 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1820 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1821 ret = fdt_set_name(fdt, node, name);
1825 ret = fdt_setprop_u32(fdt, node, "width", width);
1829 ret = fdt_setprop_u32(fdt, node, "height", height);
1833 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1837 ret = fdt_setprop_string(fdt, node, "format", format);
1841 ret = fdt_setprop_string(fdt, node, "status", "okay");
1849 * Update native-mode in display-timings from display environment variable.
1850 * The node to update are specified by path.
1852 int fdt_fixup_display(void *blob, const char *path, const char *display)
1856 if (!display || !path)
1857 return -FDT_ERR_NOTFOUND;
1859 toff = fdt_path_offset(blob, path);
1861 toff = fdt_subnode_offset(blob, toff, "display-timings");
1865 for (off = fdt_first_subnode(blob, toff);
1867 off = fdt_next_subnode(blob, off)) {
1868 uint32_t h = fdt_get_phandle(blob, off);
1869 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1871 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1872 return fdt_setprop_u32(blob, toff, "native-mode", h);
1877 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1879 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1881 * @fdt: ptr to device tree
1882 * @fdto: ptr to device tree overlay
1884 * Convenience function to apply an overlay and display helpful messages
1885 * in the case of an error
1887 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1892 err = fdt_path_offset(fdt, "/__symbols__");
1893 has_symbols = err >= 0;
1895 err = fdt_overlay_apply(fdt, fdto);
1897 printf("failed on fdt_overlay_apply(): %s\n",
1900 printf("base fdt does did not have a /__symbols__ node\n");
1901 printf("make sure you've compiled with -@\n");