]>
git.ipfire.org Git - people/ms/u-boot.git/blob - lib/fdtdec.c
2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
12 #include <linux/ctype.h>
16 DECLARE_GLOBAL_DATA_PTR
;
19 * Here are the type we know about. One day we might allow drivers to
20 * register. For now we just put them here. The COMPAT macro allows us to
21 * turn this into a sparse list later, and keeps the ID with the name.
23 #define COMPAT(id, name) name
24 static const char * const compat_names
[COMPAT_COUNT
] = {
25 COMPAT(UNKNOWN
, "<none>"),
26 COMPAT(NVIDIA_TEGRA20_USB
, "nvidia,tegra20-ehci"),
27 COMPAT(NVIDIA_TEGRA30_USB
, "nvidia,tegra30-ehci"),
28 COMPAT(NVIDIA_TEGRA114_USB
, "nvidia,tegra114-ehci"),
29 COMPAT(NVIDIA_TEGRA114_I2C
, "nvidia,tegra114-i2c"),
30 COMPAT(NVIDIA_TEGRA20_I2C
, "nvidia,tegra20-i2c"),
31 COMPAT(NVIDIA_TEGRA20_DVC
, "nvidia,tegra20-i2c-dvc"),
32 COMPAT(NVIDIA_TEGRA20_EMC
, "nvidia,tegra20-emc"),
33 COMPAT(NVIDIA_TEGRA20_EMC_TABLE
, "nvidia,tegra20-emc-table"),
34 COMPAT(NVIDIA_TEGRA20_KBC
, "nvidia,tegra20-kbc"),
35 COMPAT(NVIDIA_TEGRA20_NAND
, "nvidia,tegra20-nand"),
36 COMPAT(NVIDIA_TEGRA20_PWM
, "nvidia,tegra20-pwm"),
37 COMPAT(NVIDIA_TEGRA20_DC
, "nvidia,tegra20-dc"),
38 COMPAT(NVIDIA_TEGRA124_SDMMC
, "nvidia,tegra124-sdhci"),
39 COMPAT(NVIDIA_TEGRA30_SDMMC
, "nvidia,tegra30-sdhci"),
40 COMPAT(NVIDIA_TEGRA20_SDMMC
, "nvidia,tegra20-sdhci"),
41 COMPAT(NVIDIA_TEGRA20_SFLASH
, "nvidia,tegra20-sflash"),
42 COMPAT(NVIDIA_TEGRA20_SLINK
, "nvidia,tegra20-slink"),
43 COMPAT(NVIDIA_TEGRA114_SPI
, "nvidia,tegra114-spi"),
44 COMPAT(SMSC_LAN9215
, "smsc,lan9215"),
45 COMPAT(SAMSUNG_EXYNOS5_SROMC
, "samsung,exynos-sromc"),
46 COMPAT(SAMSUNG_S3C2440_I2C
, "samsung,s3c2440-i2c"),
47 COMPAT(SAMSUNG_EXYNOS5_SOUND
, "samsung,exynos-sound"),
48 COMPAT(WOLFSON_WM8994_CODEC
, "wolfson,wm8994-codec"),
49 COMPAT(SAMSUNG_EXYNOS_SPI
, "samsung,exynos-spi"),
50 COMPAT(GOOGLE_CROS_EC
, "google,cros-ec"),
51 COMPAT(GOOGLE_CROS_EC_KEYB
, "google,cros-ec-keyb"),
52 COMPAT(SAMSUNG_EXYNOS_EHCI
, "samsung,exynos-ehci"),
53 COMPAT(SAMSUNG_EXYNOS5_XHCI
, "samsung,exynos5250-xhci"),
54 COMPAT(SAMSUNG_EXYNOS_USB_PHY
, "samsung,exynos-usb-phy"),
55 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY
, "samsung,exynos5250-usb3-phy"),
56 COMPAT(SAMSUNG_EXYNOS_TMU
, "samsung,exynos-tmu"),
57 COMPAT(SAMSUNG_EXYNOS_FIMD
, "samsung,exynos-fimd"),
58 COMPAT(SAMSUNG_EXYNOS_MIPI_DSI
, "samsung,exynos-mipi-dsi"),
59 COMPAT(SAMSUNG_EXYNOS5_DP
, "samsung,exynos5-dp"),
60 COMPAT(SAMSUNG_EXYNOS_DWMMC
, "samsung,exynos-dwmmc"),
61 COMPAT(SAMSUNG_EXYNOS_MMC
, "samsung,exynos-mmc"),
62 COMPAT(SAMSUNG_EXYNOS_SERIAL
, "samsung,exynos4210-uart"),
63 COMPAT(MAXIM_MAX77686_PMIC
, "maxim,max77686_pmic"),
64 COMPAT(GENERIC_SPI_FLASH
, "spi-flash"),
65 COMPAT(MAXIM_98095_CODEC
, "maxim,max98095-codec"),
66 COMPAT(INFINEON_SLB9635_TPM
, "infineon,slb9635-tpm"),
67 COMPAT(INFINEON_SLB9645_TPM
, "infineon,slb9645-tpm"),
68 COMPAT(SAMSUNG_EXYNOS5_I2C
, "samsung,exynos5-hsi2c"),
69 COMPAT(SANDBOX_HOST_EMULATION
, "sandbox,host-emulation"),
70 COMPAT(SANDBOX_LCD_SDL
, "sandbox,lcd-sdl"),
71 COMPAT(TI_TPS65090
, "ti,tps65090"),
72 COMPAT(COMPAT_NXP_PTN3460
, "nxp,ptn3460"),
73 COMPAT(SAMSUNG_EXYNOS_SYSMMU
, "samsung,sysmmu-v3.3"),
74 COMPAT(PARADE_PS8625
, "parade,ps8625"),
77 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
79 /* We allow reading of the 'unknown' ID for testing purposes */
80 assert(id
>= 0 && id
< COMPAT_COUNT
);
81 return compat_names
[id
];
84 fdt_addr_t
fdtdec_get_addr_size(const void *blob
, int node
,
85 const char *prop_name
, fdt_size_t
*sizep
)
87 const fdt_addr_t
*cell
;
90 debug("%s: %s: ", __func__
, prop_name
);
91 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
92 if (cell
&& ((!sizep
&& len
== sizeof(fdt_addr_t
)) ||
93 len
== sizeof(fdt_addr_t
) * 2)) {
94 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
96 const fdt_size_t
*size
;
98 size
= (fdt_size_t
*)((char *)cell
+
100 *sizep
= fdt_size_to_cpu(*size
);
101 debug("addr=%08lx, size=%08x\n",
102 (ulong
)addr
, *sizep
);
104 debug("%08lx\n", (ulong
)addr
);
108 debug("(not found)\n");
109 return FDT_ADDR_T_NONE
;
112 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
113 const char *prop_name
)
115 return fdtdec_get_addr_size(blob
, node
, prop_name
, NULL
);
118 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
119 uint64_t default_val
)
121 const uint64_t *cell64
;
124 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
125 if (!cell64
|| length
< sizeof(*cell64
))
128 return fdt64_to_cpu(*cell64
);
131 int fdtdec_get_is_enabled(const void *blob
, int node
)
136 * It should say "okay", so only allow that. Some fdts use "ok" but
137 * this is a bug. Please fix your device tree source file. See here
140 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
142 cell
= fdt_getprop(blob
, node
, "status", NULL
);
144 return 0 == strcmp(cell
, "okay");
148 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
150 enum fdt_compat_id id
;
152 /* Search our drivers */
153 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
154 if (0 == fdt_node_check_compatible(blob
, node
,
157 return COMPAT_UNKNOWN
;
160 int fdtdec_next_compatible(const void *blob
, int node
,
161 enum fdt_compat_id id
)
163 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
166 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
167 enum fdt_compat_id id
, int *depthp
)
170 node
= fdt_next_node(blob
, node
, depthp
);
171 } while (*depthp
> 1);
173 /* If this is a direct subnode, and compatible, return it */
174 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
175 blob
, node
, compat_names
[id
]))
178 return -FDT_ERR_NOTFOUND
;
181 int fdtdec_next_alias(const void *blob
, const char *name
,
182 enum fdt_compat_id id
, int *upto
)
184 #define MAX_STR_LEN 20
185 char str
[MAX_STR_LEN
+ 20];
188 /* snprintf() is not available */
189 assert(strlen(name
) < MAX_STR_LEN
);
190 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
191 node
= fdt_path_offset(blob
, str
);
194 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
198 return -FDT_ERR_NOTFOUND
;
203 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
204 enum fdt_compat_id id
, int *node_list
, int maxcount
)
206 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
208 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
211 /* TODO: Can we tighten this code up a little? */
212 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
213 enum fdt_compat_id id
, int *node_list
, int maxcount
)
215 int name_len
= strlen(name
);
223 /* find the alias node if present */
224 alias_node
= fdt_path_offset(blob
, "/aliases");
227 * start with nothing, and we can assume that the root node can't
230 memset(nodes
, '\0', sizeof(nodes
));
232 /* First find all the compatible nodes */
233 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
234 node
= fdtdec_next_compatible(blob
, node
, id
);
236 nodes
[count
++] = node
;
239 debug("%s: warning: maxcount exceeded with alias '%s'\n",
242 /* Now find all the aliases */
243 for (offset
= fdt_first_property_offset(blob
, alias_node
);
245 offset
= fdt_next_property_offset(blob
, offset
)) {
246 const struct fdt_property
*prop
;
252 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
253 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
254 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
255 node
= fdt_path_offset(blob
, prop
->data
);
259 /* Get the alias number */
260 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
261 if (number
< 0 || number
>= maxcount
) {
262 debug("%s: warning: alias '%s' is out of range\n",
267 /* Make sure the node we found is actually in our list! */
269 for (j
= 0; j
< count
; j
++)
270 if (nodes
[j
] == node
) {
276 debug("%s: warning: alias '%s' points to a node "
277 "'%s' that is missing or is not compatible "
278 " with '%s'\n", __func__
, path
,
279 fdt_get_name(blob
, node
, NULL
),
285 * Add this node to our list in the right place, and mark
288 if (fdtdec_get_is_enabled(blob
, node
)) {
289 if (node_list
[number
]) {
290 debug("%s: warning: alias '%s' requires that "
291 "a node be placed in the list in a "
292 "position which is already filled by "
293 "node '%s'\n", __func__
, path
,
294 fdt_get_name(blob
, node
, NULL
));
297 node_list
[number
] = node
;
298 if (number
>= num_found
)
299 num_found
= number
+ 1;
304 /* Add any nodes not mentioned by an alias */
305 for (i
= j
= 0; i
< maxcount
; i
++) {
307 for (; j
< maxcount
; j
++)
309 fdtdec_get_is_enabled(blob
, nodes
[j
]))
312 /* Have we run out of nodes to add? */
316 assert(!node_list
[i
]);
317 node_list
[i
] = nodes
[j
++];
326 int fdtdec_get_alias_seq(const void *blob
, const char *base
, int offset
,
329 int base_len
= strlen(base
);
330 const char *find_name
;
335 find_name
= fdt_get_name(blob
, offset
, &find_namelen
);
336 debug("Looking for '%s' at %d, name %s\n", base
, offset
, find_name
);
338 aliases
= fdt_path_offset(blob
, "/aliases");
339 for (prop_offset
= fdt_first_property_offset(blob
, aliases
);
341 prop_offset
= fdt_next_property_offset(blob
, prop_offset
)) {
348 prop
= fdt_getprop_by_offset(blob
, prop_offset
, &name
, &len
);
349 debug(" - %s, %s\n", name
, prop
);
350 if (len
< find_namelen
|| *prop
!= '/' || prop
[len
- 1] ||
351 strncmp(name
, base
, base_len
))
354 slash
= strrchr(prop
, '/');
355 if (strcmp(slash
+ 1, find_name
))
357 for (p
= name
; *p
; p
++) {
359 *seqp
= simple_strtoul(p
, NULL
, 10);
360 debug("Found seq %d\n", *seqp
);
366 debug("Not found\n");
370 int fdtdec_get_alias_node(const void *blob
, const char *name
)
377 return -FDT_ERR_NOTFOUND
;
378 alias_node
= fdt_path_offset(blob
, "/aliases");
379 prop
= fdt_getprop(blob
, alias_node
, name
, &len
);
381 return -FDT_ERR_NOTFOUND
;
382 return fdt_path_offset(blob
, prop
);
385 int fdtdec_get_chosen_node(const void *blob
, const char *name
)
392 return -FDT_ERR_NOTFOUND
;
393 chosen_node
= fdt_path_offset(blob
, "/chosen");
394 prop
= fdt_getprop(blob
, chosen_node
, name
, &len
);
396 return -FDT_ERR_NOTFOUND
;
397 return fdt_path_offset(blob
, prop
);
400 int fdtdec_check_fdt(void)
403 * We must have an FDT, but we cannot panic() yet since the console
404 * is not ready. So for now, just assert(). Boards which need an early
405 * FDT (prior to console ready) will need to make their own
406 * arrangements and do their own checks.
408 assert(!fdtdec_prepare_fdt());
413 * This function is a little odd in that it accesses global data. At some
414 * point if the architecture board.c files merge this will make more sense.
415 * Even now, it is common code.
417 int fdtdec_prepare_fdt(void)
419 if (!gd
->fdt_blob
|| ((uintptr_t)gd
->fdt_blob
& 3) ||
420 fdt_check_header(gd
->fdt_blob
)) {
421 printf("No valid FDT found - please append one to U-Boot "
422 "binary, use u-boot-dtb.bin or define "
423 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
429 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
434 debug("%s: %s\n", __func__
, prop_name
);
435 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
437 return -FDT_ERR_NOTFOUND
;
439 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
444 * Look up a property in a node and check that it has a minimum length.
446 * @param blob FDT blob
447 * @param node node to examine
448 * @param prop_name name of property to find
449 * @param min_len minimum property length in bytes
450 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
451 found, or -FDT_ERR_BADLAYOUT if not enough data
452 * @return pointer to cell, which is only valid if err == 0
454 static const void *get_prop_check_min_len(const void *blob
, int node
,
455 const char *prop_name
, int min_len
, int *err
)
460 debug("%s: %s\n", __func__
, prop_name
);
461 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
463 *err
= -FDT_ERR_NOTFOUND
;
464 else if (len
< min_len
)
465 *err
= -FDT_ERR_BADLAYOUT
;
471 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
472 u32
*array
, int count
)
477 debug("%s: %s\n", __func__
, prop_name
);
478 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
479 sizeof(u32
) * count
, &err
);
481 for (i
= 0; i
< count
; i
++)
482 array
[i
] = fdt32_to_cpu(cell
[i
]);
487 const u32
*fdtdec_locate_array(const void *blob
, int node
,
488 const char *prop_name
, int count
)
493 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
494 sizeof(u32
) * count
, &err
);
495 return err
? NULL
: cell
;
498 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
503 debug("%s: %s\n", __func__
, prop_name
);
504 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
509 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
512 * @param blob FDT blob to use
513 * @param node Node to look at
514 * @param prop_name Node property name
515 * @param gpio Array of gpio elements to fill from FDT. This will be
516 * untouched if either 0 or an error is returned
517 * @param max_count Maximum number of elements allowed
518 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
519 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
521 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
522 struct fdt_gpio_state
*gpio
, int max_count
)
524 const struct fdt_property
*prop
;
529 debug("%s: %s\n", __func__
, prop_name
);
530 assert(max_count
> 0);
531 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
533 debug("%s: property '%s' missing\n", __func__
, prop_name
);
534 return -FDT_ERR_NOTFOUND
;
537 /* We will use the name to tag the GPIO */
538 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
539 cell
= (u32
*)prop
->data
;
540 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
541 if (len
> max_count
) {
542 debug(" %s: too many GPIOs / cells for "
543 "property '%s'\n", __func__
, prop_name
);
544 return -FDT_ERR_BADLAYOUT
;
547 /* Read out the GPIO data from the cells */
548 for (i
= 0; i
< len
; i
++, cell
+= 3) {
549 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
550 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
557 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
558 struct fdt_gpio_state
*gpio
)
562 debug("%s: %s\n", __func__
, prop_name
);
563 gpio
->gpio
= FDT_GPIO_NONE
;
565 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
566 return err
== 1 ? 0 : err
;
569 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
573 if (!fdt_gpio_isvalid(gpio
))
576 val
= gpio_get_value(gpio
->gpio
);
577 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
580 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
582 if (!fdt_gpio_isvalid(gpio
))
585 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
586 return gpio_set_value(gpio
->gpio
, val
);
589 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
592 * Return success if there is no GPIO defined. This is used for
595 if (!fdt_gpio_isvalid(gpio
))
598 if (gpio_request(gpio
->gpio
, gpio
->name
))
603 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
604 u8
*array
, int count
)
609 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
611 memcpy(array
, cell
, count
);
615 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
616 const char *prop_name
, int count
)
621 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
627 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
632 debug("%s: %s\n", __func__
, prop_name
);
633 config_node
= fdt_path_offset(blob
, "/config");
636 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
639 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
644 debug("%s: %s\n", __func__
, prop_name
);
645 config_node
= fdt_path_offset(blob
, "/config");
648 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
653 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
659 debug("%s: %s\n", __func__
, prop_name
);
660 nodeoffset
= fdt_path_offset(blob
, "/config");
664 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
668 return (char *)nodep
;
671 int fdtdec_decode_region(const void *blob
, int node
,
672 const char *prop_name
, void **ptrp
, size_t *size
)
674 const fdt_addr_t
*cell
;
677 debug("%s: %s\n", __func__
, prop_name
);
678 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
679 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
682 *ptrp
= map_sysmem(fdt_addr_to_cpu(*cell
), *size
);
683 *size
= fdt_size_to_cpu(cell
[1]);
684 debug("%s: size=%zx\n", __func__
, *size
);
689 * Read a flash entry from the fdt
691 * @param blob FDT blob
692 * @param node Offset of node to read
693 * @param name Name of node being read
694 * @param entry Place to put offset and size of this node
695 * @return 0 if ok, -ve on error
697 int fdtdec_read_fmap_entry(const void *blob
, int node
, const char *name
,
698 struct fmap_entry
*entry
)
702 if (fdtdec_get_int_array(blob
, node
, "reg", reg
, 2)) {
703 debug("Node '%s' has bad/missing 'reg' property\n", name
);
704 return -FDT_ERR_NOTFOUND
;
706 entry
->offset
= reg
[0];
707 entry
->length
= reg
[1];
712 static u64
fdtdec_get_number(const fdt32_t
*ptr
, unsigned int cells
)
717 number
= (number
<< 32) | fdt32_to_cpu(*ptr
++);
722 int fdt_get_resource(const void *fdt
, int node
, const char *property
,
723 unsigned int index
, struct fdt_resource
*res
)
725 const fdt32_t
*ptr
, *end
;
726 int na
, ns
, len
, parent
;
729 parent
= fdt_parent_offset(fdt
, node
);
733 na
= fdt_address_cells(fdt
, parent
);
734 ns
= fdt_size_cells(fdt
, parent
);
736 ptr
= fdt_getprop(fdt
, node
, property
, &len
);
740 end
= ptr
+ len
/ sizeof(*ptr
);
742 while (ptr
+ na
+ ns
<= end
) {
744 res
->start
= res
->end
= fdtdec_get_number(ptr
, na
);
745 res
->end
+= fdtdec_get_number(&ptr
[na
], ns
) - 1;
753 return -FDT_ERR_NOTFOUND
;
756 int fdt_get_named_resource(const void *fdt
, int node
, const char *property
,
757 const char *prop_names
, const char *name
,
758 struct fdt_resource
*res
)
762 index
= fdt_find_string(fdt
, node
, prop_names
, name
);
766 return fdt_get_resource(fdt
, node
, property
, index
, res
);