3 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
5 * Copyright 2010-2011 Freescale Semiconductor, Inc.
7 * SPDX-License-Identifier: GPL-2.0+
12 #include <stdio_dev.h>
13 #include <linux/ctype.h>
14 #include <linux/types.h>
15 #include <asm/global_data.h>
17 #include <fdt_support.h>
22 * fdt_getprop_u32_default_node - Return a node's property or a default
24 * @fdt: ptr to device tree
25 * @off: offset of node
26 * @cell: cell offset in property
27 * @prop: property name
28 * @dflt: default value if the property isn't found
30 * Convenience function to return a node's property or a default value if
31 * the property doesn't exist.
33 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
34 const char *prop, const u32 dflt)
39 val = fdt_getprop(fdt, off, prop, &len);
41 /* Check if property exists */
45 /* Check if property is long enough */
46 if (len < ((cell + 1) * sizeof(uint32_t)))
49 return fdt32_to_cpu(*val);
53 * fdt_getprop_u32_default - Find a node and return it's property or a default
55 * @fdt: ptr to device tree
57 * @prop: property name
58 * @dflt: default value if the property isn't found
60 * Convenience function to find a node and return it's property or a
61 * default value if it doesn't exist.
63 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
64 const char *prop, const u32 dflt)
68 off = fdt_path_offset(fdt, path);
72 return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
76 * fdt_find_and_setprop: Find a node and set it's property
78 * @fdt: ptr to device tree
80 * @prop: property name
81 * @val: ptr to new value
82 * @len: length of new property value
83 * @create: flag to create the property if it doesn't exist
85 * Convenience function to directly set a property given the path to the node.
87 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
88 const void *val, int len, int create)
90 int nodeoff = fdt_path_offset(fdt, node);
95 if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
96 return 0; /* create flag not set; so exit quietly */
98 return fdt_setprop(fdt, nodeoff, prop, val, len);
102 * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
104 * @fdt: pointer to the device tree blob
105 * @parentoffset: structure block offset of a node
106 * @name: name of the subnode to locate
108 * fdt_subnode_offset() finds a subnode of the node with a given name.
109 * If the subnode does not exist, it will be created.
111 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
115 offset = fdt_subnode_offset(fdt, parentoffset, name);
117 if (offset == -FDT_ERR_NOTFOUND)
118 offset = fdt_add_subnode(fdt, parentoffset, name);
121 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
126 /* rename to CONFIG_OF_STDOUT_PATH ? */
127 #if defined(OF_STDOUT_PATH)
128 static int fdt_fixup_stdout(void *fdt, int chosenoff)
130 return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
131 OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
133 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
134 static int fdt_fixup_stdout(void *fdt, int chosenoff)
138 char sername[9] = { 0 };
141 char tmp[256]; /* long enough */
143 sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
145 aliasoff = fdt_path_offset(fdt, "/aliases");
151 path = fdt_getprop(fdt, aliasoff, sername, &len);
157 /* fdt_setprop may break "path" so we copy it to tmp buffer */
158 memcpy(tmp, path, len);
160 err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
162 printf("WARNING: could not set linux,stdout-path %s.\n",
168 printf("WARNING: %s: could not read %s alias: %s\n",
169 __func__, sername, fdt_strerror(err));
174 static int fdt_fixup_stdout(void *fdt, int chosenoff)
180 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
181 uint64_t val, int is_u64)
184 return fdt_setprop_u64(fdt, nodeoffset, name, val);
186 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
189 int fdt_root(void *fdt)
194 err = fdt_check_header(fdt);
196 printf("fdt_root: %s\n", fdt_strerror(err));
200 serial = getenv("serial#");
202 err = fdt_setprop(fdt, 0, "serial-number", serial,
206 printf("WARNING: could not set serial-number %s.\n",
215 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
222 /* just return if the size of initrd is zero */
223 if (initrd_start == initrd_end)
226 /* find or create "/chosen" node. */
227 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
231 total = fdt_num_mem_rsv(fdt);
234 * Look for an existing entry and update it. If we don't find
235 * the entry, we will j be the next available slot.
237 for (j = 0; j < total; j++) {
238 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
239 if (addr == initrd_start) {
240 fdt_del_mem_rsv(fdt, j);
245 err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
247 printf("fdt_initrd: %s\n", fdt_strerror(err));
251 is_u64 = (fdt_address_cells(fdt, 0) == 2);
253 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
254 (uint64_t)initrd_start, is_u64);
257 printf("WARNING: could not set linux,initrd-start %s.\n",
262 err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
263 (uint64_t)initrd_end, is_u64);
266 printf("WARNING: could not set linux,initrd-end %s.\n",
275 int fdt_chosen(void *fdt)
279 char *str; /* used to set string properties */
281 err = fdt_check_header(fdt);
283 printf("fdt_chosen: %s\n", fdt_strerror(err));
287 /* find or create "/chosen" node. */
288 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
292 str = getenv("bootargs");
294 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
297 printf("WARNING: could not set bootargs %s.\n",
303 return fdt_fixup_stdout(fdt, nodeoffset);
306 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
307 const void *val, int len, int create)
311 debug("Updating property '%s/%s' = ", path, prop);
312 for (i = 0; i < len; i++)
313 debug(" %.2x", *(u8*)(val+i));
316 int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
318 printf("Unable to update property %s:%s, err=%s\n",
319 path, prop, fdt_strerror(rc));
322 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
325 fdt32_t tmp = cpu_to_fdt32(val);
326 do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
329 void do_fixup_by_prop(void *fdt,
330 const char *pname, const void *pval, int plen,
331 const char *prop, const void *val, int len,
337 debug("Updating property '%s' = ", prop);
338 for (i = 0; i < len; i++)
339 debug(" %.2x", *(u8*)(val+i));
342 off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
343 while (off != -FDT_ERR_NOTFOUND) {
344 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
345 fdt_setprop(fdt, off, prop, val, len);
346 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
350 void do_fixup_by_prop_u32(void *fdt,
351 const char *pname, const void *pval, int plen,
352 const char *prop, u32 val, int create)
354 fdt32_t tmp = cpu_to_fdt32(val);
355 do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
358 void do_fixup_by_compat(void *fdt, const char *compat,
359 const char *prop, const void *val, int len, int create)
364 debug("Updating property '%s' = ", prop);
365 for (i = 0; i < len; i++)
366 debug(" %.2x", *(u8*)(val+i));
369 off = fdt_node_offset_by_compatible(fdt, -1, compat);
370 while (off != -FDT_ERR_NOTFOUND) {
371 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
372 fdt_setprop(fdt, off, prop, val, len);
373 off = fdt_node_offset_by_compatible(fdt, off, compat);
377 void do_fixup_by_compat_u32(void *fdt, const char *compat,
378 const char *prop, u32 val, int create)
380 fdt32_t tmp = cpu_to_fdt32(val);
381 do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
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 #ifdef CONFIG_NR_DRAM_BANKS
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",
452 len = fdt_pack_reg(blob, tmp, start, size, banks);
454 err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
456 printf("WARNING: could not set %s %s.\n",
457 "reg", fdt_strerror(err));
463 int fdt_fixup_memory(void *blob, u64 start, u64 size)
465 return fdt_fixup_memory_banks(blob, &start, &size, 1);
468 void fdt_fixup_ethernet(void *fdt)
474 unsigned char mac_addr[6];
477 if (fdt_path_offset(fdt, "/aliases") < 0)
480 /* Cycle through all aliases */
481 for (prop = 0; ; prop++) {
483 int len = strlen("ethernet");
485 /* FDT might have been edited, recompute the offset */
486 offset = fdt_first_property_offset(fdt,
487 fdt_path_offset(fdt, "/aliases"));
488 /* Select property number 'prop' */
489 for (i = 0; i < prop; i++)
490 offset = fdt_next_property_offset(fdt, offset);
495 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
496 if (!strncmp(name, "ethernet", len)) {
497 i = trailing_strtol(name);
500 strcpy(mac, "ethaddr");
502 sprintf(mac, "eth%daddr", i);
510 for (j = 0; j < 6; j++) {
512 simple_strtoul(tmp, &end, 16) : 0;
514 tmp = (*end) ? end + 1 : end;
517 do_fixup_by_path(fdt, path, "mac-address",
519 do_fixup_by_path(fdt, path, "local-mac-address",
525 /* Resize the fdt to its actual size + a bit of padding */
526 int fdt_shrink_to_minimum(void *blob, uint extrasize)
536 total = fdt_num_mem_rsv(blob);
537 for (i = 0; i < total; i++) {
538 fdt_get_mem_rsv(blob, i, &addr, &size);
539 if (addr == (uintptr_t)blob) {
540 fdt_del_mem_rsv(blob, i);
546 * Calculate the actual size of the fdt
547 * plus the size needed for 5 fdt_add_mem_rsv, one
548 * for the fdt itself and 4 for a possible initrd
549 * ((initrd-start + initrd-end) * 2 (name & value))
551 actualsize = fdt_off_dt_strings(blob) +
552 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
554 actualsize += extrasize;
555 /* Make it so the fdt ends on a page boundary */
556 actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
557 actualsize = actualsize - ((uintptr_t)blob & 0xfff);
559 /* Change the fdt header to reflect the correct size */
560 fdt_set_totalsize(blob, actualsize);
562 /* Add the new reservation */
563 ret = fdt_add_mem_rsv(blob, (uintptr_t)blob, actualsize);
571 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
573 #define FDT_PCI_PREFETCH (0x40000000)
574 #define FDT_PCI_MEM32 (0x02000000)
575 #define FDT_PCI_IO (0x01000000)
576 #define FDT_PCI_MEM64 (0x03000000)
578 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
580 int addrcell, sizecell, len, r;
582 /* sized based on pci addr cells, size-cells, & address-cells */
583 u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
585 addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
586 sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
588 dma_range = &dma_ranges[0];
589 for (r = 0; r < hose->region_count; r++) {
590 u64 bus_start, phys_start, size;
592 /* skip if !PCI_REGION_SYS_MEMORY */
593 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
596 bus_start = (u64)hose->regions[r].bus_start;
597 phys_start = (u64)hose->regions[r].phys_start;
598 size = (u64)hose->regions[r].size;
601 if (size >= 0x100000000ull)
602 dma_range[0] |= FDT_PCI_MEM64;
604 dma_range[0] |= FDT_PCI_MEM32;
605 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
606 dma_range[0] |= FDT_PCI_PREFETCH;
607 #ifdef CONFIG_SYS_PCI_64BIT
608 dma_range[1] = bus_start >> 32;
612 dma_range[2] = bus_start & 0xffffffff;
615 dma_range[3] = phys_start >> 32;
616 dma_range[4] = phys_start & 0xffffffff;
618 dma_range[3] = phys_start & 0xffffffff;
622 dma_range[3 + addrcell + 0] = size >> 32;
623 dma_range[3 + addrcell + 1] = size & 0xffffffff;
625 dma_range[3 + addrcell + 0] = size & 0xffffffff;
628 dma_range += (3 + addrcell + sizecell);
631 len = dma_range - &dma_ranges[0];
633 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
639 #ifdef CONFIG_FDT_FIXUP_NOR_FLASH_SIZE
641 * Provide a weak default function to return the flash bank size.
642 * There might be multiple non-identical flash chips connected to one
643 * chip-select, so we need to pass an index as well.
645 u32 __flash_get_bank_size(int cs, int idx)
647 extern flash_info_t flash_info[];
650 * As default, a simple 1:1 mapping is provided. Boards with
651 * a different mapping need to supply a board specific mapping
654 return flash_info[cs].size;
656 u32 flash_get_bank_size(int cs, int idx)
657 __attribute__((weak, alias("__flash_get_bank_size")));
660 * This function can be used to update the size in the "reg" property
661 * of all NOR FLASH device nodes. This is necessary for boards with
662 * non-fixed NOR FLASH sizes.
664 int fdt_fixup_nor_flash_size(void *blob)
666 char compat[][16] = { "cfi-flash", "jedec-flash" };
669 struct fdt_property *prop;
673 for (i = 0; i < 2; i++) {
674 off = fdt_node_offset_by_compatible(blob, -1, compat[i]);
675 while (off != -FDT_ERR_NOTFOUND) {
679 * Found one compatible node, so fixup the size
680 * int its reg properties
682 prop = fdt_get_property_w(blob, off, "reg", &len);
684 int tuple_size = 3 * sizeof(reg);
687 * There might be multiple reg-tuples,
688 * so loop through them all
690 reg = reg2 = (u32 *)&prop->data[0];
691 for (idx = 0; idx < (len / tuple_size); idx++) {
693 * Update size in reg property
695 reg[2] = flash_get_bank_size(reg[0],
699 * Point to next reg tuple
704 fdt_setprop(blob, off, "reg", reg2, len);
707 /* Move to next compatible node */
708 off = fdt_node_offset_by_compatible(blob, off,
717 int fdt_increase_size(void *fdt, int add_len)
721 newlen = fdt_totalsize(fdt) + add_len;
723 /* Open in place with a new len */
724 return fdt_open_into(fdt, fdt, newlen);
727 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
728 #include <jffs2/load_kernel.h>
729 #include <mtd_node.h>
736 int fdt_del_subnodes(const void *blob, int parent_offset)
741 for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
742 (off >= 0) && (ndepth > 0);
743 off = fdt_next_node(blob, off, &ndepth)) {
745 debug("delete %s: offset: %x\n",
746 fdt_get_name(blob, off, 0), off);
747 ret = fdt_del_node((void *)blob, off);
749 printf("Can't delete node: %s\n",
761 int fdt_del_partitions(void *blob, int parent_offset)
768 off = fdt_next_node(blob, parent_offset, &ndepth);
769 if (off > 0 && ndepth == 1) {
770 prop = fdt_getprop(blob, off, "label", NULL);
773 * Could not find label property, nand {}; node?
774 * Check subnode, delete partitions there if any.
776 return fdt_del_partitions(blob, off);
778 ret = fdt_del_subnodes(blob, parent_offset);
780 printf("Can't remove subnodes: %s\n",
789 int fdt_node_set_part_info(void *blob, int parent_offset,
790 struct mtd_device *dev)
792 struct list_head *pentry;
793 struct part_info *part;
794 struct reg_cell cell;
799 ret = fdt_del_partitions(blob, parent_offset);
804 * Check if it is nand {}; subnode, adjust
805 * the offset in this case
807 off = fdt_next_node(blob, parent_offset, &ndepth);
808 if (off > 0 && ndepth == 1)
812 list_for_each_prev(pentry, &dev->parts) {
815 part = list_entry(pentry, struct part_info, link);
817 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
818 part_num, part->name, part->size,
819 part->offset, part->mask_flags);
821 sprintf(buf, "partition@%llx", part->offset);
823 ret = fdt_add_subnode(blob, parent_offset, buf);
824 if (ret == -FDT_ERR_NOSPACE) {
825 ret = fdt_increase_size(blob, 512);
830 } else if (ret < 0) {
831 printf("Can't add partition node: %s\n",
837 /* Check MTD_WRITEABLE_CMD flag */
838 if (part->mask_flags & 1) {
840 ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
841 if (ret == -FDT_ERR_NOSPACE) {
842 ret = fdt_increase_size(blob, 512);
851 cell.r0 = cpu_to_fdt32(part->offset);
852 cell.r1 = cpu_to_fdt32(part->size);
854 ret = fdt_setprop(blob, newoff, "reg", &cell, sizeof(cell));
855 if (ret == -FDT_ERR_NOSPACE) {
856 ret = fdt_increase_size(blob, 512);
865 ret = fdt_setprop_string(blob, newoff, "label", part->name);
866 if (ret == -FDT_ERR_NOSPACE) {
867 ret = fdt_increase_size(blob, 512);
879 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
882 printf("Can't add property: %s\n", fdt_strerror(ret));
887 * Update partitions in nor/nand nodes using info from
888 * mtdparts environment variable. The nodes to update are
889 * specified by node_info structure which contains mtd device
890 * type and compatible string: E. g. the board code in
891 * ft_board_setup() could use:
893 * struct node_info nodes[] = {
894 * { "fsl,mpc5121-nfc", MTD_DEV_TYPE_NAND, },
895 * { "cfi-flash", MTD_DEV_TYPE_NOR, },
898 * fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
900 void fdt_fixup_mtdparts(void *blob, void *node_info, int node_info_size)
902 struct node_info *ni = node_info;
903 struct mtd_device *dev;
908 parts = getenv("mtdparts");
912 if (mtdparts_init() != 0)
915 for (i = 0; i < node_info_size; i++) {
917 noff = fdt_node_offset_by_compatible(blob, -1, ni[i].compat);
918 while (noff != -FDT_ERR_NOTFOUND) {
919 debug("%s: %s, mtd dev type %d\n",
920 fdt_get_name(blob, noff, 0),
921 ni[i].compat, ni[i].type);
922 dev = device_find(ni[i].type, idx++);
924 if (fdt_node_set_part_info(blob, noff, dev))
925 return; /* return on error */
928 /* Jump to next flash node */
929 noff = fdt_node_offset_by_compatible(blob, noff,
936 void fdt_del_node_and_alias(void *blob, const char *alias)
938 int off = fdt_path_offset(blob, alias);
943 fdt_del_node(blob, off);
945 off = fdt_path_offset(blob, "/aliases");
946 fdt_delprop(blob, off, alias);
949 /* Max address size we deal with */
950 #define OF_MAX_ADDR_CELLS 4
951 #define OF_BAD_ADDR FDT_ADDR_T_NONE
952 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
957 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
961 printf(" %08x", *(addr++));
965 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
969 * struct of_bus - Callbacks for bus specific translators
970 * @name: A string used to identify this bus in debug output.
971 * @addresses: The name of the DT property from which addresses are
972 * to be read, typically "reg".
973 * @match: Return non-zero if the node whose parent is at
974 * parentoffset in the FDT blob corresponds to a bus
975 * of this type, otherwise return zero. If NULL a match
977 * @count_cells:Count how many cells (be32 values) a node whose parent
978 * is at parentoffset in the FDT blob will require to
979 * represent its address (written to *addrc) & size
980 * (written to *sizec).
981 * @map: Map the address addr from the address space of this
982 * bus to that of its parent, making use of the ranges
983 * read from DT to an array at range. na and ns are the
984 * number of cells (be32 values) used to hold and address
985 * or size, respectively, for this bus. pna is the number
986 * of cells used to hold an address for the parent bus.
987 * Returns the address in the address space of the parent
989 * @translate: Update the value of the address cells at addr within an
990 * FDT by adding offset to it. na specifies the number of
991 * cells used to hold the address being translated. Returns
992 * zero on success, non-zero on error.
994 * Each bus type will include a struct of_bus in the of_busses array,
995 * providing implementations of some or all of the functions used to
996 * match the bus & handle address translation for its children.
1000 const char *addresses;
1001 int (*match)(const void *blob, int parentoffset);
1002 void (*count_cells)(const void *blob, int parentoffset,
1003 int *addrc, int *sizec);
1004 u64 (*map)(fdt32_t *addr, const fdt32_t *range,
1005 int na, int ns, int pna);
1006 int (*translate)(fdt32_t *addr, u64 offset, int na);
1009 /* Default translator (generic bus) */
1010 void of_bus_default_count_cells(const void *blob, int parentoffset,
1011 int *addrc, int *sizec)
1013 const fdt32_t *prop;
1016 *addrc = fdt_address_cells(blob, parentoffset);
1019 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1021 *sizec = be32_to_cpup(prop);
1027 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1028 int na, int ns, int pna)
1032 cp = of_read_number(range, na);
1033 s = of_read_number(range + na + pna, ns);
1034 da = of_read_number(addr, na);
1036 debug("OF: default map, cp=%" PRIu64 ", s=%" PRIu64
1037 ", da=%" PRIu64 "\n", cp, s, da);
1039 if (da < cp || da >= (cp + s))
1044 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1046 u64 a = of_read_number(addr, na);
1047 memset(addr, 0, na * 4);
1050 addr[na - 2] = cpu_to_fdt32(a >> 32);
1051 addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1056 #ifdef CONFIG_OF_ISA_BUS
1058 /* ISA bus translator */
1059 static int of_bus_isa_match(const void *blob, int parentoffset)
1063 name = fdt_get_name(blob, parentoffset, NULL);
1067 return !strcmp(name, "isa");
1070 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1071 int *addrc, int *sizec)
1079 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1080 int na, int ns, int pna)
1084 /* Check address type match */
1085 if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1088 cp = of_read_number(range + 1, na - 1);
1089 s = of_read_number(range + na + pna, ns);
1090 da = of_read_number(addr + 1, na - 1);
1092 debug("OF: ISA map, cp=%" PRIu64 ", s=%" PRIu64
1093 ", da=%" PRIu64 "\n", cp, s, da);
1095 if (da < cp || da >= (cp + s))
1100 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1102 return of_bus_default_translate(addr + 1, offset, na - 1);
1105 #endif /* CONFIG_OF_ISA_BUS */
1107 /* Array of bus specific translators */
1108 static struct of_bus of_busses[] = {
1109 #ifdef CONFIG_OF_ISA_BUS
1114 .match = of_bus_isa_match,
1115 .count_cells = of_bus_isa_count_cells,
1116 .map = of_bus_isa_map,
1117 .translate = of_bus_isa_translate,
1119 #endif /* CONFIG_OF_ISA_BUS */
1124 .count_cells = of_bus_default_count_cells,
1125 .map = of_bus_default_map,
1126 .translate = of_bus_default_translate,
1130 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1134 if (ARRAY_SIZE(of_busses) == 1)
1137 for (bus = of_busses; bus; bus++) {
1138 if (!bus->match || bus->match(blob, parentoffset))
1143 * We should always have matched the default bus at least, since
1144 * it has a NULL match field. If we didn't then it somehow isn't
1145 * in the of_busses array or something equally catastrophic has
1152 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1153 struct of_bus *pbus, fdt32_t *addr,
1154 int na, int ns, int pna, const char *rprop)
1156 const fdt32_t *ranges;
1159 u64 offset = OF_BAD_ADDR;
1161 /* Normally, an absence of a "ranges" property means we are
1162 * crossing a non-translatable boundary, and thus the addresses
1163 * below the current not cannot be converted to CPU physical ones.
1164 * Unfortunately, while this is very clear in the spec, it's not
1165 * what Apple understood, and they do have things like /uni-n or
1166 * /ht nodes with no "ranges" property and a lot of perfectly
1167 * useable mapped devices below them. Thus we treat the absence of
1168 * "ranges" as equivalent to an empty "ranges" property which means
1169 * a 1:1 translation at that level. It's up to the caller not to try
1170 * to translate addresses that aren't supposed to be translated in
1171 * the first place. --BenH.
1173 ranges = fdt_getprop(blob, parent, rprop, &rlen);
1174 if (ranges == NULL || rlen == 0) {
1175 offset = of_read_number(addr, na);
1176 memset(addr, 0, pna * 4);
1177 debug("OF: no ranges, 1:1 translation\n");
1181 debug("OF: walking ranges...\n");
1183 /* Now walk through the ranges */
1185 rone = na + pna + ns;
1186 for (; rlen >= rone; rlen -= rone, ranges += rone) {
1187 offset = bus->map(addr, ranges, na, ns, pna);
1188 if (offset != OF_BAD_ADDR)
1191 if (offset == OF_BAD_ADDR) {
1192 debug("OF: not found !\n");
1195 memcpy(addr, ranges + na, 4 * pna);
1198 of_dump_addr("OF: parent translation for:", addr, pna);
1199 debug("OF: with offset: %" PRIu64 "\n", offset);
1201 /* Translate it into parent bus space */
1202 return pbus->translate(addr, offset, pna);
1206 * Translate an address from the device-tree into a CPU physical address,
1207 * this walks up the tree and applies the various bus mappings on the
1210 * Note: We consider that crossing any level with #size-cells == 0 to mean
1211 * that translation is impossible (that is we are not dealing with a value
1212 * that can be mapped to a cpu physical address). This is not really specified
1213 * that way, but this is traditionally the way IBM at least do things
1215 static u64 __of_translate_address(const void *blob, int node_offset,
1216 const fdt32_t *in_addr, const char *rprop)
1219 struct of_bus *bus, *pbus;
1220 fdt32_t addr[OF_MAX_ADDR_CELLS];
1221 int na, ns, pna, pns;
1222 u64 result = OF_BAD_ADDR;
1224 debug("OF: ** translation for device %s **\n",
1225 fdt_get_name(blob, node_offset, NULL));
1227 /* Get parent & match bus type */
1228 parent = fdt_parent_offset(blob, node_offset);
1231 bus = of_match_bus(blob, parent);
1233 /* Cound address cells & copy address locally */
1234 bus->count_cells(blob, parent, &na, &ns);
1235 if (!OF_CHECK_COUNTS(na, ns)) {
1236 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1237 fdt_get_name(blob, node_offset, NULL));
1240 memcpy(addr, in_addr, na * 4);
1242 debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1243 bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1244 of_dump_addr("OF: translating address:", addr, na);
1248 /* Switch to parent bus */
1249 node_offset = parent;
1250 parent = fdt_parent_offset(blob, node_offset);
1252 /* If root, we have finished */
1254 debug("OF: reached root node\n");
1255 result = of_read_number(addr, na);
1259 /* Get new parent bus and counts */
1260 pbus = of_match_bus(blob, parent);
1261 pbus->count_cells(blob, parent, &pna, &pns);
1262 if (!OF_CHECK_COUNTS(pna, pns)) {
1263 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1264 fdt_get_name(blob, node_offset, NULL));
1268 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1269 pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1271 /* Apply bus translation */
1272 if (of_translate_one(blob, node_offset, bus, pbus,
1273 addr, na, ns, pna, rprop))
1276 /* Complete the move up one level */
1281 of_dump_addr("OF: one level translation:", addr, na);
1288 u64 fdt_translate_address(const void *blob, int node_offset,
1289 const fdt32_t *in_addr)
1291 return __of_translate_address(blob, node_offset, in_addr, "ranges");
1295 * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1296 * who's reg property matches a physical cpu address
1298 * @blob: ptr to device tree
1299 * @compat: compatiable string to match
1300 * @compat_off: property name
1303 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1304 phys_addr_t compat_off)
1306 int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1307 while (off != -FDT_ERR_NOTFOUND) {
1308 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1310 if (compat_off == fdt_translate_address(blob, off, reg))
1313 off = fdt_node_offset_by_compatible(blob, off, compat);
1316 return -FDT_ERR_NOTFOUND;
1320 * fdt_alloc_phandle: Return next free phandle value
1322 * @blob: ptr to device tree
1324 int fdt_alloc_phandle(void *blob)
1327 uint32_t phandle = 0;
1329 for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1330 offset = fdt_next_node(blob, offset, NULL)) {
1331 phandle = max(phandle, fdt_get_phandle(blob, offset));
1338 * fdt_set_phandle: Create a phandle property for the given node
1340 * @fdt: ptr to device tree
1341 * @nodeoffset: node to update
1342 * @phandle: phandle value to set (must be unique)
1344 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1349 int off = fdt_node_offset_by_phandle(fdt, phandle);
1351 if ((off >= 0) && (off != nodeoffset)) {
1354 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1355 printf("Trying to update node %s with phandle %u ",
1358 fdt_get_path(fdt, off, buf, sizeof(buf));
1359 printf("that already exists in node %s.\n", buf);
1360 return -FDT_ERR_BADPHANDLE;
1364 ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1369 * For now, also set the deprecated "linux,phandle" property, so that we
1370 * don't break older kernels.
1372 ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1378 * fdt_create_phandle: Create a phandle property for the given node
1380 * @fdt: ptr to device tree
1381 * @nodeoffset: node to update
1383 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1385 /* see if there is a phandle already */
1386 int phandle = fdt_get_phandle(fdt, nodeoffset);
1388 /* if we got 0, means no phandle so create one */
1392 phandle = fdt_alloc_phandle(fdt);
1393 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1395 printf("Can't set phandle %u: %s\n", phandle,
1405 * fdt_set_node_status: Set status for the given node
1407 * @fdt: ptr to device tree
1408 * @nodeoffset: node to update
1409 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1410 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1411 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1413 int fdt_set_node_status(void *fdt, int nodeoffset,
1414 enum fdt_status status, unsigned int error_code)
1423 case FDT_STATUS_OKAY:
1424 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1426 case FDT_STATUS_DISABLED:
1427 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1429 case FDT_STATUS_FAIL:
1430 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1432 case FDT_STATUS_FAIL_ERROR_CODE:
1433 sprintf(buf, "fail-%d", error_code);
1434 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1437 printf("Invalid fdt status: %x\n", status);
1446 * fdt_set_status_by_alias: Set status for the given node given an alias
1448 * @fdt: ptr to device tree
1449 * @alias: alias of node to update
1450 * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1451 * FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1452 * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1454 int fdt_set_status_by_alias(void *fdt, const char* alias,
1455 enum fdt_status status, unsigned int error_code)
1457 int offset = fdt_path_offset(fdt, alias);
1459 return fdt_set_node_status(fdt, offset, status, error_code);
1462 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1463 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1468 noff = fdt_node_offset_by_compatible(blob, -1, compat);
1469 if (noff != -FDT_ERR_NOTFOUND) {
1470 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1472 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1473 if (ret == -FDT_ERR_NOSPACE) {
1474 ret = fdt_increase_size(blob, 512);
1479 } else if (ret < 0) {
1480 printf("Can't add property: %s\n", fdt_strerror(ret));
1486 printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1492 * Verify the physical address of device tree node for a given alias
1494 * This function locates the device tree node of a given alias, and then
1495 * verifies that the physical address of that device matches the given
1496 * parameter. It displays a message if there is a mismatch.
1498 * Returns 1 on success, 0 on failure
1500 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1507 path = fdt_getprop(fdt, anode, alias, NULL);
1509 /* If there's no such alias, then it's not a failure */
1513 node = fdt_path_offset(fdt, path);
1515 printf("Warning: device tree alias '%s' points to invalid "
1516 "node %s.\n", alias, path);
1520 reg = fdt_getprop(fdt, node, "reg", &len);
1522 printf("Warning: device tree node '%s' has no address.\n",
1527 dt_addr = fdt_translate_address(fdt, node, reg);
1528 if (addr != dt_addr) {
1529 printf("Warning: U-Boot configured device %s at address %"
1530 PRIx64 ",\n but the device tree has it address %"
1531 PRIx64 ".\n", alias, addr, dt_addr);
1539 * Returns the base address of an SOC or PCI node
1541 u64 fdt_get_base_address(void *fdt, int node)
1545 const fdt32_t *prop;
1547 naddr = fdt_address_cells(fdt, node);
1549 prop = fdt_getprop(fdt, node, "ranges", &size);
1551 return prop ? fdt_translate_address(fdt, node, prop + naddr) : 0;
1555 * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1557 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1558 uint64_t *val, int cells)
1560 const fdt32_t *prop32 = &prop[cell_off];
1561 const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1563 if ((cell_off + cells) > prop_len)
1564 return -FDT_ERR_NOSPACE;
1568 *val = fdt32_to_cpu(*prop32);
1571 *val = fdt64_to_cpu(*prop64);
1574 return -FDT_ERR_NOSPACE;
1581 * fdt_read_range - Read a node's n'th range property
1583 * @fdt: ptr to device tree
1584 * @node: offset of node
1586 * @child_addr: pointer to storage for the "child address" field
1587 * @addr: pointer to storage for the CPU view translated physical start
1588 * @len: pointer to storage for the range length
1590 * Convenience function that reads and interprets a specific range out of
1591 * a number of the "ranges" property array.
1593 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1594 uint64_t *addr, uint64_t *len)
1596 int pnode = fdt_parent_offset(fdt, node);
1597 const fdt32_t *ranges;
1606 * The "ranges" property is an array of
1607 * { <child address> <parent address> <size in child address space> }
1609 * All 3 elements can span a diffent number of cells. Fetch their size.
1611 pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1612 acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1613 scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1615 /* Now try to get the ranges property */
1616 ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1618 return -FDT_ERR_NOTFOUND;
1619 ranges_len /= sizeof(uint32_t);
1621 /* Jump to the n'th entry */
1622 cell = n * (pacells + acells + scells);
1624 /* Read <child address> */
1626 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1633 /* Read <parent address> */
1635 *addr = fdt_translate_address(fdt, node, ranges + cell);
1638 /* Read <size in child address space> */
1640 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1649 * fdt_setup_simplefb_node - Fill and enable a simplefb node
1651 * @fdt: ptr to device tree
1652 * @node: offset of the simplefb node
1653 * @base_address: framebuffer base address
1654 * @width: width in pixels
1655 * @height: height in pixels
1656 * @stride: bytes per line
1657 * @format: pixel format string
1659 * Convenience function to fill and enable a simplefb node.
1661 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1662 u32 height, u32 stride, const char *format)
1666 int i, addrc, sizec, ret;
1668 of_bus_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1672 cells[i++] = cpu_to_fdt32(base_address >> 32);
1673 cells[i++] = cpu_to_fdt32(base_address);
1676 cells[i++] = cpu_to_fdt32(height * stride);
1678 ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1682 snprintf(name, sizeof(name), "framebuffer@%" PRIx64, base_address);
1683 ret = fdt_set_name(fdt, node, name);
1687 ret = fdt_setprop_u32(fdt, node, "width", width);
1691 ret = fdt_setprop_u32(fdt, node, "height", height);
1695 ret = fdt_setprop_u32(fdt, node, "stride", stride);
1699 ret = fdt_setprop_string(fdt, node, "format", format);
1703 ret = fdt_setprop_string(fdt, node, "status", "okay");
1711 * Update native-mode in display-timings from display environment variable.
1712 * The node to update are specified by path.
1714 int fdt_fixup_display(void *blob, const char *path, const char *display)
1718 if (!display || !path)
1719 return -FDT_ERR_NOTFOUND;
1721 toff = fdt_path_offset(blob, path);
1723 toff = fdt_subnode_offset(blob, toff, "display-timings");
1727 for (off = fdt_first_subnode(blob, toff);
1729 off = fdt_next_subnode(blob, off)) {
1730 uint32_t h = fdt_get_phandle(blob, off);
1731 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1733 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1734 return fdt_setprop_u32(blob, toff, "native-mode", h);