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 for (i = 0; i < banks; i++)
460 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));
477 int fdt_fixup_memory(void *blob, u64 start, u64 size)
479 return fdt_fixup_memory_banks(blob, &start, &size, 1);
482 void fdt_fixup_ethernet(void *fdt)
488 unsigned char mac_addr[ARP_HLEN];
490 #ifdef FDT_SEQ_MACADDR_FROM_ENV
492 const struct fdt_property *fdt_prop;
495 if (fdt_path_offset(fdt, "/aliases") < 0)
498 /* Cycle through all aliases */
499 for (prop = 0; ; prop++) {
502 /* FDT might have been edited, recompute the offset */
503 offset = fdt_first_property_offset(fdt,
504 fdt_path_offset(fdt, "/aliases"));
505 /* Select property number 'prop' */
506 for (j = 0; j < prop; j++)
507 offset = fdt_next_property_offset(fdt, offset);
512 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
513 if (!strncmp(name, "ethernet", 8)) {
514 /* Treat plain "ethernet" same as "ethernet0". */
515 if (!strcmp(name, "ethernet")
516 #ifdef FDT_SEQ_MACADDR_FROM_ENV
517 || !strcmp(name, "ethernet0")
521 #ifndef FDT_SEQ_MACADDR_FROM_ENV
523 i = trailing_strtol(name);
527 strcpy(mac, "ethaddr");
529 sprintf(mac, "eth%daddr", i);
533 #ifdef FDT_SEQ_MACADDR_FROM_ENV
534 nodeoff = fdt_path_offset(fdt, path);
535 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
537 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
545 for (j = 0; j < 6; j++) {
547 simple_strtoul(tmp, &end, 16) : 0;
549 tmp = (*end) ? end + 1 : end;
552 do_fixup_by_path(fdt, path, "mac-address",
554 do_fixup_by_path(fdt, path, "local-mac-address",
560 int fdt_record_loadable(void *blob, u32 index, const char *name,
561 uintptr_t load_addr, u32 size, uintptr_t entry_point,
562 const char *type, const char *os)
566 err = fdt_check_header(blob);
568 printf("%s: %s\n", __func__, fdt_strerror(err));
572 /* find or create "/fit-images" node */
573 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
577 /* find or create "/fit-images/<name>" node */
578 node = fdt_find_or_add_subnode(blob, node, name);
583 * We record these as 32bit entities, possibly truncating addresses.
584 * However, spl_fit.c is not 64bit safe either: i.e. we should not
585 * have an issue here.
587 fdt_setprop_u32(blob, node, "load-addr", load_addr);
588 if (entry_point != -1)
589 fdt_setprop_u32(blob, node, "entry-point", entry_point);
590 fdt_setprop_u32(blob, node, "size", size);
592 fdt_setprop_string(blob, node, "type", type);
594 fdt_setprop_string(blob, node, "os", os);
599 /* Resize the fdt to its actual size + a bit of padding */
600 int fdt_shrink_to_minimum(void *blob, uint extrasize)
610 total = fdt_num_mem_rsv(blob);
611 for (i = 0; i < total; i++) {
612 fdt_get_mem_rsv(blob, i, &addr, &size);
613 if (addr == (uintptr_t)blob) {
614 fdt_del_mem_rsv(blob, i);
620 * Calculate the actual size of the fdt
621 * plus the size needed for 5 fdt_add_mem_rsv, one
622 * for the fdt itself and 4 for a possible initrd
623 * ((initrd-start + initrd-end) * 2 (name & value))
625 actualsize = fdt_off_dt_strings(blob) +
626 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
628 actualsize += extrasize;
629 /* Make it so the fdt ends on a page boundary */
630 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
631 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
633 /* Change the fdt header to reflect the correct size */
634 fdt_set_totalsize(blob, actualsize);
636 /* Add the new reservation */
637 ret = fdt_add_mem_rsv(blob, (uintptr_t)blob, actualsize);
645 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
647 #define FDT_PCI_PREFETCH (0x40000000)
648 #define FDT_PCI_MEM32 (0x02000000)
649 #define FDT_PCI_IO (0x01000000)
650 #define FDT_PCI_MEM64 (0x03000000)
652 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
654 int addrcell, sizecell, len, r;
656 /* sized based on pci addr cells, size-cells, & address-cells */
657 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
659 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
660 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
662 dma_range = &dma_ranges[0];
663 for (r = 0; r < hose->region_count; r++) {
664 u64 bus_start, phys_start, size;
666 /* skip if !PCI_REGION_SYS_MEMORY */
667 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
670 bus_start = (u64)hose->regions[r].bus_start;
671 phys_start = (u64)hose->regions[r].phys_start;
672 size = (u64)hose->regions[r].size;
675 if (size >= 0x100000000ull)
676 dma_range[0] |= FDT_PCI_MEM64;
678 dma_range[0] |= FDT_PCI_MEM32;
679 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
680 dma_range[0] |= FDT_PCI_PREFETCH;
681 #ifdef CONFIG_SYS_PCI_64BIT
682 dma_range[1] = bus_start >> 32;
686 dma_range[2] = bus_start & 0xffffffff;
689 dma_range[3] = phys_start >> 32;
690 dma_range[4] = phys_start & 0xffffffff;
692 dma_range[3] = phys_start & 0xffffffff;
696 dma_range[3 + addrcell + 0] = size >> 32;
697 dma_range[3 + addrcell + 1] = size & 0xffffffff;
699 dma_range[3 + addrcell + 0] = size & 0xffffffff;
702 dma_range += (3 + addrcell + sizecell);
705 len = dma_range - &dma_ranges[0];
707 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
713 int fdt_increase_size(void *fdt, int add_len)
717 newlen = fdt_totalsize(fdt) + add_len;
719 /* Open in place with a new len */
720 return fdt_open_into(fdt, fdt, newlen);
723 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
724 #include <jffs2/load_kernel.h>
725 #include <mtd_node.h>
732 static int fdt_del_subnodes(const void *blob, int parent_offset)
737 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
738 (off >= 0) && (ndepth > 0);
739 off = fdt_next_node(blob, off, &ndepth)) {
741 debug("delete %s: offset: %x\n",
742 fdt_get_name(blob, off, 0), off);
743 ret = fdt_del_node((void *)blob, off);
745 printf("Can't delete node: %s\n",
757 static int fdt_del_partitions(void *blob, int parent_offset)
764 off = fdt_next_node(blob, parent_offset, &ndepth);
765 if (off > 0 && ndepth == 1) {
766 prop = fdt_getprop(blob, off, "label", NULL);
769 * Could not find label property, nand {}; node?
770 * Check subnode, delete partitions there if any.
772 return fdt_del_partitions(blob, off);
774 ret = fdt_del_subnodes(blob, parent_offset);
776 printf("Can't remove subnodes: %s\n",
785 int fdt_node_set_part_info(void *blob, int parent_offset,
786 struct mtd_device *dev)
788 struct list_head *pentry;
789 struct part_info *part;
790 struct reg_cell cell;
795 ret = fdt_del_partitions(blob, parent_offset);
800 * Check if it is nand {}; subnode, adjust
801 * the offset in this case
803 off = fdt_next_node(blob, parent_offset, &ndepth);
804 if (off > 0 && ndepth == 1)
808 list_for_each_prev(pentry, &dev->parts) {
811 part = list_entry(pentry, struct part_info, link);
813 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
814 part_num, part->name, part->size,
815 part->offset, part->mask_flags);
817 sprintf(buf, "partition@%llx", part->offset);
819 ret = fdt_add_subnode(blob, parent_offset, buf);
820 if (ret == -FDT_ERR_NOSPACE) {
821 ret = fdt_increase_size(blob, 512);
826 } else if (ret < 0) {
827 printf("Can't add partition node: %s\n",
833 /* Check MTD_WRITEABLE_CMD flag */
834 if (part->mask_flags & 1) {
836 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
837 if (ret == -FDT_ERR_NOSPACE) {
838 ret = fdt_increase_size(blob, 512);
847 cell.r0 = cpu_to_fdt32(part->offset);
848 cell.r1 = cpu_to_fdt32(part->size);
850 ret = fdt_setprop(blob, newoff, "reg", &cell, sizeof(cell));
851 if (ret == -FDT_ERR_NOSPACE) {
852 ret = fdt_increase_size(blob, 512);
861 ret = fdt_setprop_string(blob, newoff, "label", part->name);
862 if (ret == -FDT_ERR_NOSPACE) {
863 ret = fdt_increase_size(blob, 512);
875 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
878 printf("Can't add property: %s\n", fdt_strerror(ret));
883 * Update partitions in nor/nand nodes using info from
884 * mtdparts environment variable. The nodes to update are
885 * specified by node_info structure which contains mtd device
886 * type and compatible string: E. g. the board code in
887 * ft_board_setup() could use:
889 * struct node_info nodes[] = {
890 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
891 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
894 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
896 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
899 struct mtd_device *dev;
903 if (mtdparts_init() != 0)
906 for (i = 0; i < node_info_size; i++) {
908 noff = fdt_node_offset_by_compatible(blob, -1,
909 node_info[i].compat);
910 while (noff != -FDT_ERR_NOTFOUND) {
911 debug("%s: %s, mtd dev type %d\n",
912 fdt_get_name(blob, noff, 0),
913 node_info[i].compat, node_info[i].type);
914 dev = device_find(node_info[i].type, idx++);
916 if (fdt_node_set_part_info(blob, noff, dev))
917 return; /* return on error */
920 /* Jump to next flash node */
921 noff = fdt_node_offset_by_compatible(blob, noff,
922 node_info[i].compat);
928 void fdt_del_node_and_alias(void *blob, const char *alias)
930 int off = fdt_path_offset(blob, alias);
935 fdt_del_node(blob, off);
937 off = fdt_path_offset(blob, "/aliases");
938 fdt_delprop(blob, off, alias);
941 /* Max address size we deal with */
942 #define OF_MAX_ADDR_CELLS 4
943 #define OF_BAD_ADDR FDT_ADDR_T_NONE
944 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
949 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
953 printf(" %08x", *(addr++));
957 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
961 * struct of_bus - Callbacks for bus specific translators
962 * @name: A string used to identify this bus in debug output.
963 * @addresses: The name of the DT property from which addresses are
964 * to be read, typically "reg".
965 * @match: Return non-zero if the node whose parent is at
966 * parentoffset in the FDT blob corresponds to a bus
967 * of this type, otherwise return zero. If NULL a match
969 * @count_cells:Count how many cells (be32 values) a node whose parent
970 * is at parentoffset in the FDT blob will require to
971 * represent its address (written to *addrc) & size
972 * (written to *sizec).
973 * @map: Map the address addr from the address space of this
974 * bus to that of its parent, making use of the ranges
975 * read from DT to an array at range. na and ns are the
976 * number of cells (be32 values) used to hold and address
977 * or size, respectively, for this bus. pna is the number
978 * of cells used to hold an address for the parent bus.
979 * Returns the address in the address space of the parent
981 * @translate: Update the value of the address cells at addr within an
982 * FDT by adding offset to it. na specifies the number of
983 * cells used to hold the address being translated. Returns
984 * zero on success, non-zero on error.
986 * Each bus type will include a struct of_bus in the of_busses array,
987 * providing implementations of some or all of the functions used to
988 * match the bus & handle address translation for its children.
992 const char *addresses;
993 int (*match)(const void *blob, int parentoffset);
994 void (*count_cells)(const void *blob, int parentoffset,
995 int *addrc, int *sizec);
996 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
997 int na, int ns, int pna);
998 int (*translate)(fdt32_t *addr, u64 offset, int na);
1001 /* Default translator (generic bus) */
1002 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1003 int *addrc, int *sizec)
1005 const fdt32_t *prop;
1008 *addrc = fdt_address_cells(blob, parentoffset);
1011 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1013 *sizec = be32_to_cpup(prop);
1019 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1020 int na, int ns, int pna)
1024 cp = fdt_read_number(range, na);
1025 s = fdt_read_number(range + na + pna, ns);
1026 da = fdt_read_number(addr, na);
1028 debug("OF: default map, cp=%" PRIu64 ", s=%" PRIu64
1029 ", da=%" PRIu64 "\n", cp, s, da);
1031 if (da < cp || da >= (cp + s))
1036 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1038 u64 a = fdt_read_number(addr, na);
1039 memset(addr, 0, na * 4);
1042 addr[na - 2] = cpu_to_fdt32(a >> 32);
1043 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1048 #ifdef CONFIG_OF_ISA_BUS
1050 /* ISA bus translator */
1051 static int of_bus_isa_match(const void *blob, int parentoffset)
1055 name = fdt_get_name(blob, parentoffset, NULL);
1059 return !strcmp(name, "isa");
1062 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1063 int *addrc, int *sizec)
1071 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1072 int na, int ns, int pna)
1076 /* Check address type match */
1077 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1080 cp = fdt_read_number(range + 1, na - 1);
1081 s = fdt_read_number(range + na + pna, ns);
1082 da = fdt_read_number(addr + 1, na - 1);
1084 debug("OF: ISA map, cp=%" PRIu64 ", s=%" PRIu64
1085 ", da=%" PRIu64 "\n", cp, s, da);
1087 if (da < cp || da >= (cp + s))
1092 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1094 return of_bus_default_translate(addr + 1, offset, na - 1);
1097 #endif /* CONFIG_OF_ISA_BUS */
1099 /* Array of bus specific translators */
1100 static struct of_bus of_busses[] = {
1101 #ifdef CONFIG_OF_ISA_BUS
1106 .match = of_bus_isa_match,
1107 .count_cells = of_bus_isa_count_cells,
1108 .map = of_bus_isa_map,
1109 .translate = of_bus_isa_translate,
1111 #endif /* CONFIG_OF_ISA_BUS */
1116 .count_cells = fdt_support_default_count_cells,
1117 .map = of_bus_default_map,
1118 .translate = of_bus_default_translate,
1122 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1126 if (ARRAY_SIZE(of_busses) == 1)
1129 for (bus = of_busses; bus; bus++) {
1130 if (!bus->match || bus->match(blob, parentoffset))
1135 * We should always have matched the default bus at least, since
1136 * it has a NULL match field. If we didn't then it somehow isn't
1137 * in the of_busses array or something equally catastrophic has
1144 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1145 struct of_bus *pbus, fdt32_t *addr,
1146 int na, int ns, int pna, const char *rprop)
1148 const fdt32_t *ranges;
1151 u64 offset = OF_BAD_ADDR;
1153 /* Normally, an absence of a "ranges" property means we are
1154 * crossing a non-translatable boundary, and thus the addresses
1155 * below the current not cannot be converted to CPU physical ones.
1156 * Unfortunately, while this is very clear in the spec, it's not
1157 * what Apple understood, and they do have things like /uni-n or
1158 * /ht nodes with no "ranges" property and a lot of perfectly
1159 * useable mapped devices below them. Thus we treat the absence of
1160 * "ranges" as equivalent to an empty "ranges" property which means
1161 * a 1:1 translation at that level. It's up to the caller not to try
1162 * to translate addresses that aren't supposed to be translated in
1163 * the first place. --BenH.
1165 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1166 if (ranges == NULL || rlen == 0) {
1167 offset = fdt_read_number(addr, na);
1168 memset(addr, 0, pna * 4);
1169 debug("OF: no ranges, 1:1 translation\n");
1173 debug("OF: walking ranges...\n");
1175 /* Now walk through the ranges */
1177 rone = na + pna + ns;
1178 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1179 offset = bus->map(addr, ranges, na, ns, pna);
1180 if (offset != OF_BAD_ADDR)
1183 if (offset == OF_BAD_ADDR) {
1184 debug("OF: not found !\n");
1187 memcpy(addr, ranges + na, 4 * pna);
1190 of_dump_addr("OF: parent translation for:", addr, pna);
1191 debug("OF: with offset: %" PRIu64 "\n", offset);
1193 /* Translate it into parent bus space */
1194 return pbus->translate(addr, offset, pna);
1198 * Translate an address from the device-tree into a CPU physical address,
1199 * this walks up the tree and applies the various bus mappings on the
1202 * Note: We consider that crossing any level with #size-cells == 0 to mean
1203 * that translation is impossible (that is we are not dealing with a value
1204 * that can be mapped to a cpu physical address). This is not really specified
1205 * that way, but this is traditionally the way IBM at least do things
1207 static u64 __of_translate_address(const void *blob, int node_offset,
1208 const fdt32_t *in_addr, const char *rprop)
1211 struct of_bus *bus, *pbus;
1212 fdt32_t addr[OF_MAX_ADDR_CELLS];
1213 int na, ns, pna, pns;
1214 u64 result = OF_BAD_ADDR;
1216 debug("OF: ** translation for device %s **\n",
1217 fdt_get_name(blob, node_offset, NULL));
1219 /* Get parent & match bus type */
1220 parent = fdt_parent_offset(blob, node_offset);
1223 bus = of_match_bus(blob, parent);
1225 /* Cound address cells & copy address locally */
1226 bus->count_cells(blob, parent, &na, &ns);
1227 if (!OF_CHECK_COUNTS(na, ns)) {
1228 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1229 fdt_get_name(blob, node_offset, NULL));
1232 memcpy(addr, in_addr, na * 4);
1234 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1235 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1236 of_dump_addr("OF: translating address:", addr, na);
1240 /* Switch to parent bus */
1241 node_offset = parent;
1242 parent = fdt_parent_offset(blob, node_offset);
1244 /* If root, we have finished */
1246 debug("OF: reached root node\n");
1247 result = fdt_read_number(addr, na);
1251 /* Get new parent bus and counts */
1252 pbus = of_match_bus(blob, parent);
1253 pbus->count_cells(blob, parent, &pna, &pns);
1254 if (!OF_CHECK_COUNTS(pna, pns)) {
1255 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1256 fdt_get_name(blob, node_offset, NULL));
1260 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1261 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1263 /* Apply bus translation */
1264 if (of_translate_one(blob, node_offset, bus, pbus,
1265 addr, na, ns, pna, rprop))
1268 /* Complete the move up one level */
1273 of_dump_addr("OF: one level translation:", addr, na);
1280 u64 fdt_translate_address(const void *blob, int node_offset,
1281 const fdt32_t *in_addr)
1283 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1287 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1288 * who's reg property matches a physical cpu address
1290 * @blob: ptr to device tree
1291 * @compat: compatiable string to match
1292 * @compat_off: property name
1295 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1296 phys_addr_t compat_off)
1298 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1299 while (off != -FDT_ERR_NOTFOUND) {
1300 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1302 if (compat_off == fdt_translate_address(blob, off, reg))
1305 off = fdt_node_offset_by_compatible(blob, off, compat);
1308 return -FDT_ERR_NOTFOUND;
1312 * fdt_alloc_phandle: Return next free phandle value
1314 * @blob: ptr to device tree
1316 int fdt_alloc_phandle(void *blob)
1319 uint32_t phandle = 0;
1321 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1322 offset = fdt_next_node(blob, offset, NULL)) {
1323 phandle = max(phandle, fdt_get_phandle(blob, offset));
1330 * fdt_set_phandle: Create a phandle property for the given node
1332 * @fdt: ptr to device tree
1333 * @nodeoffset: node to update
1334 * @phandle: phandle value to set (must be unique)
1336 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1341 int off = fdt_node_offset_by_phandle(fdt, phandle);
1343 if ((off >= 0) && (off != nodeoffset)) {
1346 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1347 printf("Trying to update node %s with phandle %u ",
1350 fdt_get_path(fdt, off, buf, sizeof(buf));
1351 printf("that already exists in node %s.\n", buf);
1352 return -FDT_ERR_BADPHANDLE;
1356 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1361 * For now, also set the deprecated "linux,phandle" property, so that we
1362 * don't break older kernels.
1364 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1370 * fdt_create_phandle: Create a phandle property for the given node
1372 * @fdt: ptr to device tree
1373 * @nodeoffset: node to update
1375 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1377 /* see if there is a phandle already */
1378 int phandle = fdt_get_phandle(fdt, nodeoffset);
1380 /* if we got 0, means no phandle so create one */
1384 phandle = fdt_alloc_phandle(fdt);
1385 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1387 printf("Can't set phandle %u: %s\n", phandle,
1397 * fdt_set_node_status: Set status for the given node
1399 * @fdt: ptr to device tree
1400 * @nodeoffset: node to update
1401 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1402 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1403 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1405 int fdt_set_node_status(void *fdt, int nodeoffset,
1406 enum fdt_status status, unsigned int error_code)
1415 case FDT_STATUS_OKAY:
1416 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1418 case FDT_STATUS_DISABLED:
1419 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1421 case FDT_STATUS_FAIL:
1422 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1424 case FDT_STATUS_FAIL_ERROR_CODE:
1425 sprintf(buf, "fail-%d", error_code);
1426 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1429 printf("Invalid fdt status: %x\n", status);
1438 * fdt_set_status_by_alias: Set status for the given node given an alias
1440 * @fdt: ptr to device tree
1441 * @alias: alias of node to update
1442 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1443 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1444 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1446 int fdt_set_status_by_alias(void *fdt, const char* alias,
1447 enum fdt_status status, unsigned int error_code)
1449 int offset = fdt_path_offset(fdt, alias);
1451 return fdt_set_node_status(fdt, offset, status, error_code);
1454 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1455 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1460 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1461 if (noff != -FDT_ERR_NOTFOUND) {
1462 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1464 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1465 if (ret == -FDT_ERR_NOSPACE) {
1466 ret = fdt_increase_size(blob, 512);
1471 } else if (ret < 0) {
1472 printf("Can't add property: %s\n", fdt_strerror(ret));
1478 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1484 * Verify the physical address of device tree node for a given alias
1486 * This function locates the device tree node of a given alias, and then
1487 * verifies that the physical address of that device matches the given
1488 * parameter. It displays a message if there is a mismatch.
1490 * Returns 1 on success, 0 on failure
1492 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1499 path = fdt_getprop(fdt, anode, alias, NULL);
1501 /* If there's no such alias, then it's not a failure */
1505 node = fdt_path_offset(fdt, path);
1507 printf("Warning: device tree alias '%s' points to invalid "
1508 "node %s.\n", alias, path);
1512 reg = fdt_getprop(fdt, node, "reg", &len);
1514 printf("Warning: device tree node '%s' has no address.\n",
1519 dt_addr = fdt_translate_address(fdt, node, reg);
1520 if (addr != dt_addr) {
1521 printf("Warning: U-Boot configured device %s at address %"
1522 PRIx64 ",\n but the device tree has it address %"
1523 PRIx64 ".\n", alias, addr, dt_addr);
1531 * Returns the base address of an SOC or PCI node
1533 u64 fdt_get_base_address(const void *fdt, int node)
1536 const fdt32_t *prop;
1538 prop = fdt_getprop(fdt, node, "reg", &size);
1540 return prop ? fdt_translate_address(fdt, node, prop) : 0;
1544 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1546 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1547 uint64_t *val, int cells)
1549 const fdt32_t *prop32 = &prop[cell_off];
1550 const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1552 if ((cell_off + cells) > prop_len)
1553 return -FDT_ERR_NOSPACE;
1557 *val = fdt32_to_cpu(*prop32);
1560 *val = fdt64_to_cpu(*prop64);
1563 return -FDT_ERR_NOSPACE;
1570 * fdt_read_range - Read a node's n'th range property
1572 * @fdt: ptr to device tree
1573 * @node: offset of node
1575 * @child_addr: pointer to storage for the "child address" field
1576 * @addr: pointer to storage for the CPU view translated physical start
1577 * @len: pointer to storage for the range length
1579 * Convenience function that reads and interprets a specific range out of
1580 * a number of the "ranges" property array.
1582 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1583 uint64_t *addr, uint64_t *len)
1585 int pnode = fdt_parent_offset(fdt, node);
1586 const fdt32_t *ranges;
1595 * The "ranges" property is an array of
1596 * { <child address> <parent address> <size in child address space> }
1598 * All 3 elements can span a diffent number of cells. Fetch their size.
1600 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1601 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1602 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1604 /* Now try to get the ranges property */
1605 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1607 return -FDT_ERR_NOTFOUND;
1608 ranges_len /= sizeof(uint32_t);
1610 /* Jump to the n'th entry */
1611 cell = n * (pacells + acells + scells);
1613 /* Read <child address> */
1615 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1622 /* Read <parent address> */
1624 *addr = fdt_translate_address(fdt, node, ranges + cell);
1627 /* Read <size in child address space> */
1629 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1638 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1640 * @fdt: ptr to device tree
1641 * @node: offset of the simplefb node
1642 * @base_address: framebuffer base address
1643 * @width: width in pixels
1644 * @height: height in pixels
1645 * @stride: bytes per line
1646 * @format: pixel format string
1648 * Convenience function to fill and enable a simplefb node.
1650 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1651 u32 height, u32 stride, const char *format)
1655 int i, addrc, sizec, ret;
1657 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1661 cells[i++] = cpu_to_fdt32(base_address >> 32);
1662 cells[i++] = cpu_to_fdt32(base_address);
1665 cells[i++] = cpu_to_fdt32(height * stride);
1667 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1671 snprintf(name, sizeof(name), "framebuffer@%" PRIx64, base_address);
1672 ret = fdt_set_name(fdt, node, name);
1676 ret = fdt_setprop_u32(fdt, node, "width", width);
1680 ret = fdt_setprop_u32(fdt, node, "height", height);
1684 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1688 ret = fdt_setprop_string(fdt, node, "format", format);
1692 ret = fdt_setprop_string(fdt, node, "status", "okay");
1700 * Update native-mode in display-timings from display environment variable.
1701 * The node to update are specified by path.
1703 int fdt_fixup_display(void *blob, const char *path, const char *display)
1707 if (!display || !path)
1708 return -FDT_ERR_NOTFOUND;
1710 toff = fdt_path_offset(blob, path);
1712 toff = fdt_subnode_offset(blob, toff, "display-timings");
1716 for (off = fdt_first_subnode(blob, toff);
1718 off = fdt_next_subnode(blob, off)) {
1719 uint32_t h = fdt_get_phandle(blob, off);
1720 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1722 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1723 return fdt_setprop_u32(blob, toff, "native-mode", h);
1728 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1730 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1732 * @fdt: ptr to device tree
1733 * @fdto: ptr to device tree overlay
1735 * Convenience function to apply an overlay and display helpful messages
1736 * in the case of an error
1738 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1743 err = fdt_path_offset(fdt, "/__symbols__");
1744 has_symbols = err >= 0;
1746 err = fdt_overlay_apply(fdt, fdto);
1748 printf("failed on fdt_overlay_apply(): %s\n",
1751 printf("base fdt does did not have a /__symbols__ node\n");
1752 printf("make sure you've compiled with -@\n");