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 /* rename to CONFIG_OF_STDOUT_PATH ? */
129 #if defined(OF_STDOUT_PATH)
130 static int fdt_fixup_stdout(void *fdt, int chosenoff)
132 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
133 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
135 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
136 static int fdt_fixup_stdout(void *fdt, int chosenoff)
140 char sername[9] = { 0 };
143 char tmp[256]; /* long enough */
145 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
147 aliasoff = fdt_path_offset(fdt, "/aliases");
153 path = fdt_getprop(fdt, aliasoff, sername, &len);
159 /* fdt_setprop may break "path" so we copy it to tmp buffer */
160 memcpy(tmp, path, len);
162 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
164 printf("WARNING: could not set linux,stdout-path %s.\n",
170 printf("WARNING: %s: could not read %s alias: %s\n",
171 __func__, sername, fdt_strerror(err));
176 static int fdt_fixup_stdout(void *fdt, int chosenoff)
182 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
183 uint64_t val, int is_u64)
186 return fdt_setprop_u64(fdt, nodeoffset, name, val);
188 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
191 int fdt_root(void *fdt)
196 err = fdt_check_header(fdt);
198 printf("fdt_root: %s\n", fdt_strerror(err));
202 serial = env_get("serial#");
204 err = fdt_setprop(fdt, 0, "serial-number", serial,
208 printf("WARNING: could not set serial-number %s.\n",
217 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
224 /* just return if the size of initrd is zero */
225 if (initrd_start == initrd_end)
228 /* find or create "/chosen" node. */
229 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
233 total = fdt_num_mem_rsv(fdt);
236 * Look for an existing entry and update it. If we don't find
237 * the entry, we will j be the next available slot.
239 for (j = 0; j < total; j++) {
240 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
241 if (addr == initrd_start) {
242 fdt_del_mem_rsv(fdt, j);
247 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
249 printf("fdt_initrd: %s\n", fdt_strerror(err));
253 is_u64 = (fdt_address_cells(fdt, 0) == 2);
255 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
256 (uint64_t)initrd_start, is_u64);
259 printf("WARNING: could not set linux,initrd-start %s.\n",
264 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
265 (uint64_t)initrd_end, is_u64);
268 printf("WARNING: could not set linux,initrd-end %s.\n",
277 int fdt_chosen(void *fdt)
281 char *str; /* used to set string properties */
283 err = fdt_check_header(fdt);
285 printf("fdt_chosen: %s\n", fdt_strerror(err));
289 /* find or create "/chosen" node. */
290 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
294 str = env_get("bootargs");
296 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
299 printf("WARNING: could not set bootargs %s.\n",
305 return fdt_fixup_stdout(fdt, nodeoffset);
308 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
309 const void *val, int len, int create)
313 debug("Updating property '%s/%s' = ", path, prop);
314 for (i = 0; i < len; i++)
315 debug(" %.2x", *(u8*)(val+i));
318 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
320 printf("Unable to update property %s:%s, err=%s\n",
321 path, prop, fdt_strerror(rc));
324 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
327 fdt32_t tmp = cpu_to_fdt32(val);
328 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
331 void do_fixup_by_prop(void *fdt,
332 const char *pname, const void *pval, int plen,
333 const char *prop, const void *val, int len,
339 debug("Updating property '%s' = ", prop);
340 for (i = 0; i < len; i++)
341 debug(" %.2x", *(u8*)(val+i));
344 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
345 while (off != -FDT_ERR_NOTFOUND) {
346 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
347 fdt_setprop(fdt, off, prop, val, len);
348 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
352 void do_fixup_by_prop_u32(void *fdt,
353 const char *pname, const void *pval, int plen,
354 const char *prop, u32 val, int create)
356 fdt32_t tmp = cpu_to_fdt32(val);
357 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
360 void do_fixup_by_compat(void *fdt, const char *compat,
361 const char *prop, const void *val, int len, int create)
366 debug("Updating property '%s' = ", prop);
367 for (i = 0; i < len; i++)
368 debug(" %.2x", *(u8*)(val+i));
371 off = fdt_node_offset_by_compatible(fdt, -1, compat);
372 while (off != -FDT_ERR_NOTFOUND) {
373 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
374 fdt_setprop(fdt, off, prop, val, len);
375 off = fdt_node_offset_by_compatible(fdt, off, compat);
379 void do_fixup_by_compat_u32(void *fdt, const char *compat,
380 const char *prop, u32 val, int create)
382 fdt32_t tmp = cpu_to_fdt32(val);
383 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
386 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
388 * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
390 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
394 int address_cells = fdt_address_cells(fdt, 0);
395 int size_cells = fdt_size_cells(fdt, 0);
398 for (i = 0; i < n; i++) {
399 if (address_cells == 2)
400 *(fdt64_t *)p = cpu_to_fdt64(address[i]);
402 *(fdt32_t *)p = cpu_to_fdt32(address[i]);
403 p += 4 * address_cells;
406 *(fdt64_t *)p = cpu_to_fdt64(size[i]);
408 *(fdt32_t *)p = cpu_to_fdt32(size[i]);
412 return p - (char *)buf;
415 #if CONFIG_NR_DRAM_BANKS > 4
416 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
418 #define MEMORY_BANKS_MAX 4
420 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
424 u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
426 if (banks > MEMORY_BANKS_MAX) {
427 printf("%s: num banks %d exceeds hardcoded limit %d."
428 " Recompile with higher MEMORY_BANKS_MAX?\n",
429 __FUNCTION__, banks, MEMORY_BANKS_MAX);
433 err = fdt_check_header(blob);
435 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
439 /* find or create "/memory" node. */
440 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
444 err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
447 printf("WARNING: could not set %s %s.\n", "device_type",
452 for (i = 0; i < banks; i++) {
453 if (start[i] == 0 && size[i] == 0)
462 len = fdt_pack_reg(blob, tmp, start, size, banks);
464 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
466 printf("WARNING: could not set %s %s.\n",
467 "reg", fdt_strerror(err));
473 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int areas)
477 u8 tmp[8 * 16]; /* Up to 64-bit address + 64-bit size */
480 printf("%s: num areas %d exceeds hardcoded limit %d\n",
485 err = fdt_check_header(blob);
487 printf("%s: %s\n", __func__, fdt_strerror(err));
491 /* find or create "/memory" node. */
492 nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
496 len = fdt_pack_reg(blob, tmp, start, size, areas);
498 err = fdt_setprop(blob, nodeoffset, "linux,usable-memory", tmp, len);
500 printf("WARNING: could not set %s %s.\n",
501 "reg", fdt_strerror(err));
509 int fdt_fixup_memory(void *blob, u64 start, u64 size)
511 return fdt_fixup_memory_banks(blob, &start, &size, 1);
514 void fdt_fixup_ethernet(void *fdt)
520 unsigned char mac_addr[ARP_HLEN];
522 #ifdef FDT_SEQ_MACADDR_FROM_ENV
524 const struct fdt_property *fdt_prop;
527 if (fdt_path_offset(fdt, "/aliases") < 0)
530 /* Cycle through all aliases */
531 for (prop = 0; ; prop++) {
534 /* FDT might have been edited, recompute the offset */
535 offset = fdt_first_property_offset(fdt,
536 fdt_path_offset(fdt, "/aliases"));
537 /* Select property number 'prop' */
538 for (j = 0; j < prop; j++)
539 offset = fdt_next_property_offset(fdt, offset);
544 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
545 if (!strncmp(name, "ethernet", 8)) {
546 /* Treat plain "ethernet" same as "ethernet0". */
547 if (!strcmp(name, "ethernet")
548 #ifdef FDT_SEQ_MACADDR_FROM_ENV
549 || !strcmp(name, "ethernet0")
553 #ifndef FDT_SEQ_MACADDR_FROM_ENV
555 i = trailing_strtol(name);
559 strcpy(mac, "ethaddr");
561 sprintf(mac, "eth%daddr", i);
565 #ifdef FDT_SEQ_MACADDR_FROM_ENV
566 nodeoff = fdt_path_offset(fdt, path);
567 fdt_prop = fdt_get_property(fdt, nodeoff, "status",
569 if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
577 for (j = 0; j < 6; j++) {
579 simple_strtoul(tmp, &end, 16) : 0;
581 tmp = (*end) ? end + 1 : end;
584 do_fixup_by_path(fdt, path, "mac-address",
586 do_fixup_by_path(fdt, path, "local-mac-address",
592 int fdt_record_loadable(void *blob, u32 index, const char *name,
593 uintptr_t load_addr, u32 size, uintptr_t entry_point,
594 const char *type, const char *os)
598 err = fdt_check_header(blob);
600 printf("%s: %s\n", __func__, fdt_strerror(err));
604 /* find or create "/fit-images" node */
605 node = fdt_find_or_add_subnode(blob, 0, "fit-images");
609 /* find or create "/fit-images/<name>" node */
610 node = fdt_find_or_add_subnode(blob, node, name);
615 * We record these as 32bit entities, possibly truncating addresses.
616 * However, spl_fit.c is not 64bit safe either: i.e. we should not
617 * have an issue here.
619 fdt_setprop_u32(blob, node, "load", load_addr);
620 if (entry_point != -1)
621 fdt_setprop_u32(blob, node, "entry", entry_point);
622 fdt_setprop_u32(blob, node, "size", size);
624 fdt_setprop_string(blob, node, "type", type);
626 fdt_setprop_string(blob, node, "os", os);
631 /* Resize the fdt to its actual size + a bit of padding */
632 int fdt_shrink_to_minimum(void *blob, uint extrasize)
643 total = fdt_num_mem_rsv(blob);
644 for (i = 0; i < total; i++) {
645 fdt_get_mem_rsv(blob, i, &addr, &size);
646 if (addr == (uintptr_t)blob) {
647 fdt_del_mem_rsv(blob, i);
654 * Calculate the actual size of the fdt
655 * plus the size needed for 5 fdt_add_mem_rsv, one
656 * for the fdt itself and 4 for a possible initrd
657 * ((initrd-start + initrd-end) * 2 (name & value))
659 actualsize = fdt_off_dt_strings(blob) +
660 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
662 actualsize += extrasize;
663 /* Make it so the fdt ends on a page boundary */
664 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
665 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
667 /* Change the fdt header to reflect the correct size */
668 fdt_set_totalsize(blob, actualsize);
671 /* Add the new reservation */
672 ret = fdt_add_mem_rsv(blob, map_to_sysmem(blob), actualsize);
681 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
683 #define FDT_PCI_PREFETCH (0x40000000)
684 #define FDT_PCI_MEM32 (0x02000000)
685 #define FDT_PCI_IO (0x01000000)
686 #define FDT_PCI_MEM64 (0x03000000)
688 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
690 int addrcell, sizecell, len, r;
692 /* sized based on pci addr cells, size-cells, & address-cells */
693 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
695 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
696 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
698 dma_range = &dma_ranges[0];
699 for (r = 0; r < hose->region_count; r++) {
700 u64 bus_start, phys_start, size;
702 /* skip if !PCI_REGION_SYS_MEMORY */
703 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
706 bus_start = (u64)hose->regions[r].bus_start;
707 phys_start = (u64)hose->regions[r].phys_start;
708 size = (u64)hose->regions[r].size;
711 if (size >= 0x100000000ull)
712 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM64);
714 dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
715 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
716 dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
717 #ifdef CONFIG_SYS_PCI_64BIT
718 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
722 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
725 dma_range[3] = cpu_to_fdt32(phys_start >> 32);
726 dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
728 dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
732 dma_range[3 + addrcell + 0] =
733 cpu_to_fdt32(size >> 32);
734 dma_range[3 + addrcell + 1] =
735 cpu_to_fdt32(size & 0xffffffff);
737 dma_range[3 + addrcell + 0] =
738 cpu_to_fdt32(size & 0xffffffff);
741 dma_range += (3 + addrcell + sizecell);
744 len = dma_range - &dma_ranges[0];
746 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
752 int fdt_increase_size(void *fdt, int add_len)
756 newlen = fdt_totalsize(fdt) + add_len;
758 /* Open in place with a new len */
759 return fdt_open_into(fdt, fdt, newlen);
762 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
763 #include <jffs2/load_kernel.h>
764 #include <mtd_node.h>
766 static int fdt_del_subnodes(const void *blob, int parent_offset)
771 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
772 (off >= 0) && (ndepth > 0);
773 off = fdt_next_node(blob, off, &ndepth)) {
775 debug("delete %s: offset: %x\n",
776 fdt_get_name(blob, off, 0), off);
777 ret = fdt_del_node((void *)blob, off);
779 printf("Can't delete node: %s\n",
791 static int fdt_del_partitions(void *blob, int parent_offset)
798 off = fdt_next_node(blob, parent_offset, &ndepth);
799 if (off > 0 && ndepth == 1) {
800 prop = fdt_getprop(blob, off, "label", NULL);
803 * Could not find label property, nand {}; node?
804 * Check subnode, delete partitions there if any.
806 return fdt_del_partitions(blob, off);
808 ret = fdt_del_subnodes(blob, parent_offset);
810 printf("Can't remove subnodes: %s\n",
819 static int fdt_node_set_part_info(void *blob, int parent_offset,
820 struct mtd_device *dev)
822 struct list_head *pentry;
823 struct part_info *part;
829 ret = fdt_del_partitions(blob, parent_offset);
834 * Check if size/address is 1 or 2 cells.
835 * We assume #address-cells and #size-cells have same value.
837 sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
838 0, "#size-cells", 1);
841 * Check if it is nand {}; subnode, adjust
842 * the offset in this case
844 off = fdt_next_node(blob, parent_offset, &ndepth);
845 if (off > 0 && ndepth == 1)
849 list_for_each_prev(pentry, &dev->parts) {
852 part = list_entry(pentry, struct part_info, link);
854 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
855 part_num, part->name, part->size,
856 part->offset, part->mask_flags);
858 sprintf(buf, "partition@%llx", part->offset);
860 ret = fdt_add_subnode(blob, parent_offset, buf);
861 if (ret == -FDT_ERR_NOSPACE) {
862 ret = fdt_increase_size(blob, 512);
867 } else if (ret < 0) {
868 printf("Can't add partition node: %s\n",
874 /* Check MTD_WRITEABLE_CMD flag */
875 if (part->mask_flags & 1) {
877 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
878 if (ret == -FDT_ERR_NOSPACE) {
879 ret = fdt_increase_size(blob, 512);
890 ret = fdt_setprop_u64(blob, newoff,
891 "reg", part->offset);
893 ret = fdt_appendprop_u64(blob, newoff,
896 ret = fdt_setprop_u32(blob, newoff,
897 "reg", part->offset);
899 ret = fdt_appendprop_u32(blob, newoff,
903 if (ret == -FDT_ERR_NOSPACE) {
904 ret = fdt_increase_size(blob, 512);
913 ret = fdt_setprop_string(blob, newoff, "label", part->name);
914 if (ret == -FDT_ERR_NOSPACE) {
915 ret = fdt_increase_size(blob, 512);
927 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
930 printf("Can't add property: %s\n", fdt_strerror(ret));
935 * Update partitions in nor/nand nodes using info from
936 * mtdparts environment variable. The nodes to update are
937 * specified by node_info structure which contains mtd device
938 * type and compatible string: E. g. the board code in
939 * ft_board_setup() could use:
941 * struct node_info nodes[] = {
942 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
943 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
946 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
948 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
951 struct mtd_device *dev;
956 for (i = 0; i < node_info_size; i++) {
960 while ((noff = fdt_node_offset_by_compatible(blob, noff,
961 node_info[i].compat)) >= 0) {
964 prop = fdt_getprop(blob, noff, "status", NULL);
965 if (prop && !strcmp(prop, "disabled"))
968 debug("%s: %s, mtd dev type %d\n",
969 fdt_get_name(blob, noff, 0),
970 node_info[i].compat, node_info[i].type);
973 if (mtdparts_init() != 0)
978 dev = device_find(node_info[i].type, idx++);
980 if (fdt_node_set_part_info(blob, noff, dev))
981 return; /* return on error */
988 void fdt_del_node_and_alias(void *blob, const char *alias)
990 int off = fdt_path_offset(blob, alias);
995 fdt_del_node(blob, off);
997 off = fdt_path_offset(blob, "/aliases");
998 fdt_delprop(blob, off, alias);
1001 /* Max address size we deal with */
1002 #define OF_MAX_ADDR_CELLS 4
1003 #define OF_BAD_ADDR FDT_ADDR_T_NONE
1004 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
1009 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1013 printf(" %08x", *(addr++));
1017 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1021 * struct of_bus - Callbacks for bus specific translators
1022 * @name: A string used to identify this bus in debug output.
1023 * @addresses: The name of the DT property from which addresses are
1024 * to be read, typically "reg".
1025 * @match: Return non-zero if the node whose parent is at
1026 * parentoffset in the FDT blob corresponds to a bus
1027 * of this type, otherwise return zero. If NULL a match
1029 * @count_cells:Count how many cells (be32 values) a node whose parent
1030 * is at parentoffset in the FDT blob will require to
1031 * represent its address (written to *addrc) & size
1032 * (written to *sizec).
1033 * @map: Map the address addr from the address space of this
1034 * bus to that of its parent, making use of the ranges
1035 * read from DT to an array at range. na and ns are the
1036 * number of cells (be32 values) used to hold and address
1037 * or size, respectively, for this bus. pna is the number
1038 * of cells used to hold an address for the parent bus.
1039 * Returns the address in the address space of the parent
1041 * @translate: Update the value of the address cells at addr within an
1042 * FDT by adding offset to it. na specifies the number of
1043 * cells used to hold the address being translated. Returns
1044 * zero on success, non-zero on error.
1046 * Each bus type will include a struct of_bus in the of_busses array,
1047 * providing implementations of some or all of the functions used to
1048 * match the bus & handle address translation for its children.
1052 const char *addresses;
1053 int (*match)(const void *blob, int parentoffset);
1054 void (*count_cells)(const void *blob, int parentoffset,
1055 int *addrc, int *sizec);
1056 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1057 int na, int ns, int pna);
1058 int (*translate)(fdt32_t *addr, u64 offset, int na);
1061 /* Default translator (generic bus) */
1062 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1063 int *addrc, int *sizec)
1065 const fdt32_t *prop;
1068 *addrc = fdt_address_cells(blob, parentoffset);
1071 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1073 *sizec = be32_to_cpup(prop);
1079 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1080 int na, int ns, int pna)
1084 cp = fdt_read_number(range, na);
1085 s = fdt_read_number(range + na + pna, ns);
1086 da = fdt_read_number(addr, na);
1088 debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1090 if (da < cp || da >= (cp + s))
1095 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1097 u64 a = fdt_read_number(addr, na);
1098 memset(addr, 0, na * 4);
1101 addr[na - 2] = cpu_to_fdt32(a >> 32);
1102 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1107 #ifdef CONFIG_OF_ISA_BUS
1109 /* ISA bus translator */
1110 static int of_bus_isa_match(const void *blob, int parentoffset)
1114 name = fdt_get_name(blob, parentoffset, NULL);
1118 return !strcmp(name, "isa");
1121 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1122 int *addrc, int *sizec)
1130 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1131 int na, int ns, int pna)
1135 /* Check address type match */
1136 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1139 cp = fdt_read_number(range + 1, na - 1);
1140 s = fdt_read_number(range + na + pna, ns);
1141 da = fdt_read_number(addr + 1, na - 1);
1143 debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1145 if (da < cp || da >= (cp + s))
1150 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1152 return of_bus_default_translate(addr + 1, offset, na - 1);
1155 #endif /* CONFIG_OF_ISA_BUS */
1157 /* Array of bus specific translators */
1158 static struct of_bus of_busses[] = {
1159 #ifdef CONFIG_OF_ISA_BUS
1164 .match = of_bus_isa_match,
1165 .count_cells = of_bus_isa_count_cells,
1166 .map = of_bus_isa_map,
1167 .translate = of_bus_isa_translate,
1169 #endif /* CONFIG_OF_ISA_BUS */
1174 .count_cells = fdt_support_default_count_cells,
1175 .map = of_bus_default_map,
1176 .translate = of_bus_default_translate,
1180 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1184 if (ARRAY_SIZE(of_busses) == 1)
1187 for (bus = of_busses; bus; bus++) {
1188 if (!bus->match || bus->match(blob, parentoffset))
1193 * We should always have matched the default bus at least, since
1194 * it has a NULL match field. If we didn't then it somehow isn't
1195 * in the of_busses array or something equally catastrophic has
1202 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1203 struct of_bus *pbus, fdt32_t *addr,
1204 int na, int ns, int pna, const char *rprop)
1206 const fdt32_t *ranges;
1209 u64 offset = OF_BAD_ADDR;
1211 /* Normally, an absence of a "ranges" property means we are
1212 * crossing a non-translatable boundary, and thus the addresses
1213 * below the current not cannot be converted to CPU physical ones.
1214 * Unfortunately, while this is very clear in the spec, it's not
1215 * what Apple understood, and they do have things like /uni-n or
1216 * /ht nodes with no "ranges" property and a lot of perfectly
1217 * useable mapped devices below them. Thus we treat the absence of
1218 * "ranges" as equivalent to an empty "ranges" property which means
1219 * a 1:1 translation at that level. It's up to the caller not to try
1220 * to translate addresses that aren't supposed to be translated in
1221 * the first place. --BenH.
1223 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1224 if (ranges == NULL || rlen == 0) {
1225 offset = fdt_read_number(addr, na);
1226 memset(addr, 0, pna * 4);
1227 debug("OF: no ranges, 1:1 translation\n");
1231 debug("OF: walking ranges...\n");
1233 /* Now walk through the ranges */
1235 rone = na + pna + ns;
1236 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1237 offset = bus->map(addr, ranges, na, ns, pna);
1238 if (offset != OF_BAD_ADDR)
1241 if (offset == OF_BAD_ADDR) {
1242 debug("OF: not found !\n");
1245 memcpy(addr, ranges + na, 4 * pna);
1248 of_dump_addr("OF: parent translation for:", addr, pna);
1249 debug("OF: with offset: %llu\n", offset);
1251 /* Translate it into parent bus space */
1252 return pbus->translate(addr, offset, pna);
1256 * Translate an address from the device-tree into a CPU physical address,
1257 * this walks up the tree and applies the various bus mappings on the
1260 * Note: We consider that crossing any level with #size-cells == 0 to mean
1261 * that translation is impossible (that is we are not dealing with a value
1262 * that can be mapped to a cpu physical address). This is not really specified
1263 * that way, but this is traditionally the way IBM at least do things
1265 static u64 __of_translate_address(const void *blob, int node_offset,
1266 const fdt32_t *in_addr, const char *rprop)
1269 struct of_bus *bus, *pbus;
1270 fdt32_t addr[OF_MAX_ADDR_CELLS];
1271 int na, ns, pna, pns;
1272 u64 result = OF_BAD_ADDR;
1274 debug("OF: ** translation for device %s **\n",
1275 fdt_get_name(blob, node_offset, NULL));
1277 /* Get parent & match bus type */
1278 parent = fdt_parent_offset(blob, node_offset);
1281 bus = of_match_bus(blob, parent);
1283 /* Cound address cells & copy address locally */
1284 bus->count_cells(blob, parent, &na, &ns);
1285 if (!OF_CHECK_COUNTS(na, ns)) {
1286 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1287 fdt_get_name(blob, node_offset, NULL));
1290 memcpy(addr, in_addr, na * 4);
1292 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1293 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1294 of_dump_addr("OF: translating address:", addr, na);
1298 /* Switch to parent bus */
1299 node_offset = parent;
1300 parent = fdt_parent_offset(blob, node_offset);
1302 /* If root, we have finished */
1304 debug("OF: reached root node\n");
1305 result = fdt_read_number(addr, na);
1309 /* Get new parent bus and counts */
1310 pbus = of_match_bus(blob, parent);
1311 pbus->count_cells(blob, parent, &pna, &pns);
1312 if (!OF_CHECK_COUNTS(pna, pns)) {
1313 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1314 fdt_get_name(blob, node_offset, NULL));
1318 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1319 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1321 /* Apply bus translation */
1322 if (of_translate_one(blob, node_offset, bus, pbus,
1323 addr, na, ns, pna, rprop))
1326 /* Complete the move up one level */
1331 of_dump_addr("OF: one level translation:", addr, na);
1338 u64 fdt_translate_address(const void *blob, int node_offset,
1339 const fdt32_t *in_addr)
1341 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1344 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1345 const fdt32_t *in_addr)
1347 return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1351 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1352 * who's reg property matches a physical cpu address
1354 * @blob: ptr to device tree
1355 * @compat: compatiable string to match
1356 * @compat_off: property name
1359 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1360 phys_addr_t compat_off)
1362 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1363 while (off != -FDT_ERR_NOTFOUND) {
1364 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1366 if (compat_off == fdt_translate_address(blob, off, reg))
1369 off = fdt_node_offset_by_compatible(blob, off, compat);
1372 return -FDT_ERR_NOTFOUND;
1376 * fdt_alloc_phandle: Return next free phandle value
1378 * @blob: ptr to device tree
1380 int fdt_alloc_phandle(void *blob)
1383 uint32_t phandle = 0;
1385 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1386 offset = fdt_next_node(blob, offset, NULL)) {
1387 phandle = max(phandle, fdt_get_phandle(blob, offset));
1394 * fdt_set_phandle: Create a phandle property for the given node
1396 * @fdt: ptr to device tree
1397 * @nodeoffset: node to update
1398 * @phandle: phandle value to set (must be unique)
1400 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1405 int off = fdt_node_offset_by_phandle(fdt, phandle);
1407 if ((off >= 0) && (off != nodeoffset)) {
1410 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1411 printf("Trying to update node %s with phandle %u ",
1414 fdt_get_path(fdt, off, buf, sizeof(buf));
1415 printf("that already exists in node %s.\n", buf);
1416 return -FDT_ERR_BADPHANDLE;
1420 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1425 * For now, also set the deprecated "linux,phandle" property, so that we
1426 * don't break older kernels.
1428 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1434 * fdt_create_phandle: Create a phandle property for the given node
1436 * @fdt: ptr to device tree
1437 * @nodeoffset: node to update
1439 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1441 /* see if there is a phandle already */
1442 int phandle = fdt_get_phandle(fdt, nodeoffset);
1444 /* if we got 0, means no phandle so create one */
1448 phandle = fdt_alloc_phandle(fdt);
1449 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1451 printf("Can't set phandle %u: %s\n", phandle,
1461 * fdt_set_node_status: Set status for the given node
1463 * @fdt: ptr to device tree
1464 * @nodeoffset: node to update
1465 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1466 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1467 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1469 int fdt_set_node_status(void *fdt, int nodeoffset,
1470 enum fdt_status status, unsigned int error_code)
1479 case FDT_STATUS_OKAY:
1480 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1482 case FDT_STATUS_DISABLED:
1483 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1485 case FDT_STATUS_FAIL:
1486 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1488 case FDT_STATUS_FAIL_ERROR_CODE:
1489 sprintf(buf, "fail-%d", error_code);
1490 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1493 printf("Invalid fdt status: %x\n", status);
1502 * fdt_set_status_by_alias: Set status for the given node given an alias
1504 * @fdt: ptr to device tree
1505 * @alias: alias of node to update
1506 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1507 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1508 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1510 int fdt_set_status_by_alias(void *fdt, const char* alias,
1511 enum fdt_status status, unsigned int error_code)
1513 int offset = fdt_path_offset(fdt, alias);
1515 return fdt_set_node_status(fdt, offset, status, error_code);
1518 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1519 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1524 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1525 if (noff != -FDT_ERR_NOTFOUND) {
1526 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1528 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1529 if (ret == -FDT_ERR_NOSPACE) {
1530 ret = fdt_increase_size(blob, 512);
1535 } else if (ret < 0) {
1536 printf("Can't add property: %s\n", fdt_strerror(ret));
1542 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1548 * Verify the physical address of device tree node for a given alias
1550 * This function locates the device tree node of a given alias, and then
1551 * verifies that the physical address of that device matches the given
1552 * parameter. It displays a message if there is a mismatch.
1554 * Returns 1 on success, 0 on failure
1556 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1563 path = fdt_getprop(fdt, anode, alias, NULL);
1565 /* If there's no such alias, then it's not a failure */
1569 node = fdt_path_offset(fdt, path);
1571 printf("Warning: device tree alias '%s' points to invalid "
1572 "node %s.\n", alias, path);
1576 reg = fdt_getprop(fdt, node, "reg", &len);
1578 printf("Warning: device tree node '%s' has no address.\n",
1583 dt_addr = fdt_translate_address(fdt, node, reg);
1584 if (addr != dt_addr) {
1585 printf("Warning: U-Boot configured device %s at address %llu,\n"
1586 "but the device tree has it address %llx.\n",
1587 alias, addr, dt_addr);
1595 * Returns the base address of an SOC or PCI node
1597 u64 fdt_get_base_address(const void *fdt, int node)
1600 const fdt32_t *prop;
1602 prop = fdt_getprop(fdt, node, "reg", &size);
1604 return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1608 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1610 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1611 uint64_t *val, int cells)
1613 const fdt32_t *prop32 = &prop[cell_off];
1614 const unaligned_fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1616 if ((cell_off + cells) > prop_len)
1617 return -FDT_ERR_NOSPACE;
1621 *val = fdt32_to_cpu(*prop32);
1624 *val = fdt64_to_cpu(*prop64);
1627 return -FDT_ERR_NOSPACE;
1634 * fdt_read_range - Read a node's n'th range property
1636 * @fdt: ptr to device tree
1637 * @node: offset of node
1639 * @child_addr: pointer to storage for the "child address" field
1640 * @addr: pointer to storage for the CPU view translated physical start
1641 * @len: pointer to storage for the range length
1643 * Convenience function that reads and interprets a specific range out of
1644 * a number of the "ranges" property array.
1646 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1647 uint64_t *addr, uint64_t *len)
1649 int pnode = fdt_parent_offset(fdt, node);
1650 const fdt32_t *ranges;
1659 * The "ranges" property is an array of
1660 * { <child address> <parent address> <size in child address space> }
1662 * All 3 elements can span a diffent number of cells. Fetch their size.
1664 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1665 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1666 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1668 /* Now try to get the ranges property */
1669 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1671 return -FDT_ERR_NOTFOUND;
1672 ranges_len /= sizeof(uint32_t);
1674 /* Jump to the n'th entry */
1675 cell = n * (pacells + acells + scells);
1677 /* Read <child address> */
1679 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1686 /* Read <parent address> */
1688 *addr = fdt_translate_address(fdt, node, ranges + cell);
1691 /* Read <size in child address space> */
1693 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1702 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1704 * @fdt: ptr to device tree
1705 * @node: offset of the simplefb node
1706 * @base_address: framebuffer base address
1707 * @width: width in pixels
1708 * @height: height in pixels
1709 * @stride: bytes per line
1710 * @format: pixel format string
1712 * Convenience function to fill and enable a simplefb node.
1714 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1715 u32 height, u32 stride, const char *format)
1719 int i, addrc, sizec, ret;
1721 fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1725 cells[i++] = cpu_to_fdt32(base_address >> 32);
1726 cells[i++] = cpu_to_fdt32(base_address);
1729 cells[i++] = cpu_to_fdt32(height * stride);
1731 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1735 snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1736 ret = fdt_set_name(fdt, node, name);
1740 ret = fdt_setprop_u32(fdt, node, "width", width);
1744 ret = fdt_setprop_u32(fdt, node, "height", height);
1748 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1752 ret = fdt_setprop_string(fdt, node, "format", format);
1756 ret = fdt_setprop_string(fdt, node, "status", "okay");
1764 * Update native-mode in display-timings from display environment variable.
1765 * The node to update are specified by path.
1767 int fdt_fixup_display(void *blob, const char *path, const char *display)
1771 if (!display || !path)
1772 return -FDT_ERR_NOTFOUND;
1774 toff = fdt_path_offset(blob, path);
1776 toff = fdt_subnode_offset(blob, toff, "display-timings");
1780 for (off = fdt_first_subnode(blob, toff);
1782 off = fdt_next_subnode(blob, off)) {
1783 uint32_t h = fdt_get_phandle(blob, off);
1784 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1786 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1787 return fdt_setprop_u32(blob, toff, "native-mode", h);
1792 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1794 * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1796 * @fdt: ptr to device tree
1797 * @fdto: ptr to device tree overlay
1799 * Convenience function to apply an overlay and display helpful messages
1800 * in the case of an error
1802 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1807 err = fdt_path_offset(fdt, "/__symbols__");
1808 has_symbols = err >= 0;
1810 err = fdt_overlay_apply(fdt, fdto);
1812 printf("failed on fdt_overlay_apply(): %s\n",
1815 printf("base fdt does did not have a /__symbols__ node\n");
1816 printf("make sure you've compiled with -@\n");