]>
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"),
75 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
77 /* We allow reading of the 'unknown' ID for testing purposes */
78 assert(id
>= 0 && id
< COMPAT_COUNT
);
79 return compat_names
[id
];
82 fdt_addr_t
fdtdec_get_addr_size(const void *blob
, int node
,
83 const char *prop_name
, fdt_size_t
*sizep
)
85 const fdt_addr_t
*cell
;
88 debug("%s: %s: ", __func__
, prop_name
);
89 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
90 if (cell
&& ((!sizep
&& len
== sizeof(fdt_addr_t
)) ||
91 len
== sizeof(fdt_addr_t
) * 2)) {
92 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
94 const fdt_size_t
*size
;
96 size
= (fdt_size_t
*)((char *)cell
+
98 *sizep
= fdt_size_to_cpu(*size
);
99 debug("addr=%08lx, size=%08x\n",
100 (ulong
)addr
, *sizep
);
102 debug("%08lx\n", (ulong
)addr
);
106 debug("(not found)\n");
107 return FDT_ADDR_T_NONE
;
110 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
111 const char *prop_name
)
113 return fdtdec_get_addr_size(blob
, node
, prop_name
, NULL
);
116 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
117 uint64_t default_val
)
119 const uint64_t *cell64
;
122 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
123 if (!cell64
|| length
< sizeof(*cell64
))
126 return fdt64_to_cpu(*cell64
);
129 int fdtdec_get_is_enabled(const void *blob
, int node
)
134 * It should say "okay", so only allow that. Some fdts use "ok" but
135 * this is a bug. Please fix your device tree source file. See here
138 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
140 cell
= fdt_getprop(blob
, node
, "status", NULL
);
142 return 0 == strcmp(cell
, "okay");
146 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
148 enum fdt_compat_id id
;
150 /* Search our drivers */
151 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
152 if (0 == fdt_node_check_compatible(blob
, node
,
155 return COMPAT_UNKNOWN
;
158 int fdtdec_next_compatible(const void *blob
, int node
,
159 enum fdt_compat_id id
)
161 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
164 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
165 enum fdt_compat_id id
, int *depthp
)
168 node
= fdt_next_node(blob
, node
, depthp
);
169 } while (*depthp
> 1);
171 /* If this is a direct subnode, and compatible, return it */
172 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
173 blob
, node
, compat_names
[id
]))
176 return -FDT_ERR_NOTFOUND
;
179 int fdtdec_next_alias(const void *blob
, const char *name
,
180 enum fdt_compat_id id
, int *upto
)
182 #define MAX_STR_LEN 20
183 char str
[MAX_STR_LEN
+ 20];
186 /* snprintf() is not available */
187 assert(strlen(name
) < MAX_STR_LEN
);
188 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
189 node
= fdt_path_offset(blob
, str
);
192 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
196 return -FDT_ERR_NOTFOUND
;
201 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
202 enum fdt_compat_id id
, int *node_list
, int maxcount
)
204 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
206 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
209 /* TODO: Can we tighten this code up a little? */
210 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
211 enum fdt_compat_id id
, int *node_list
, int maxcount
)
213 int name_len
= strlen(name
);
221 /* find the alias node if present */
222 alias_node
= fdt_path_offset(blob
, "/aliases");
225 * start with nothing, and we can assume that the root node can't
228 memset(nodes
, '\0', sizeof(nodes
));
230 /* First find all the compatible nodes */
231 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
232 node
= fdtdec_next_compatible(blob
, node
, id
);
234 nodes
[count
++] = node
;
237 debug("%s: warning: maxcount exceeded with alias '%s'\n",
240 /* Now find all the aliases */
241 for (offset
= fdt_first_property_offset(blob
, alias_node
);
243 offset
= fdt_next_property_offset(blob
, offset
)) {
244 const struct fdt_property
*prop
;
250 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
251 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
252 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
253 node
= fdt_path_offset(blob
, prop
->data
);
257 /* Get the alias number */
258 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
259 if (number
< 0 || number
>= maxcount
) {
260 debug("%s: warning: alias '%s' is out of range\n",
265 /* Make sure the node we found is actually in our list! */
267 for (j
= 0; j
< count
; j
++)
268 if (nodes
[j
] == node
) {
274 debug("%s: warning: alias '%s' points to a node "
275 "'%s' that is missing or is not compatible "
276 " with '%s'\n", __func__
, path
,
277 fdt_get_name(blob
, node
, NULL
),
283 * Add this node to our list in the right place, and mark
286 if (fdtdec_get_is_enabled(blob
, node
)) {
287 if (node_list
[number
]) {
288 debug("%s: warning: alias '%s' requires that "
289 "a node be placed in the list in a "
290 "position which is already filled by "
291 "node '%s'\n", __func__
, path
,
292 fdt_get_name(blob
, node
, NULL
));
295 node_list
[number
] = node
;
296 if (number
>= num_found
)
297 num_found
= number
+ 1;
302 /* Add any nodes not mentioned by an alias */
303 for (i
= j
= 0; i
< maxcount
; i
++) {
305 for (; j
< maxcount
; j
++)
307 fdtdec_get_is_enabled(blob
, nodes
[j
]))
310 /* Have we run out of nodes to add? */
314 assert(!node_list
[i
]);
315 node_list
[i
] = nodes
[j
++];
324 int fdtdec_get_alias_seq(const void *blob
, const char *base
, int offset
,
327 int base_len
= strlen(base
);
328 const char *find_name
;
333 find_name
= fdt_get_name(blob
, offset
, &find_namelen
);
334 debug("Looking for '%s' at %d, name %s\n", base
, offset
, find_name
);
336 aliases
= fdt_path_offset(blob
, "/aliases");
337 for (prop_offset
= fdt_first_property_offset(blob
, aliases
);
339 prop_offset
= fdt_next_property_offset(blob
, prop_offset
)) {
346 prop
= fdt_getprop_by_offset(blob
, prop_offset
, &name
, &len
);
347 debug(" - %s, %s\n", name
, prop
);
348 if (len
< find_namelen
|| *prop
!= '/' || prop
[len
- 1] ||
349 strncmp(name
, base
, base_len
))
352 slash
= strrchr(prop
, '/');
353 if (strcmp(slash
+ 1, find_name
))
355 for (p
= name
; *p
; p
++) {
357 *seqp
= simple_strtoul(p
, NULL
, 10);
358 debug("Found seq %d\n", *seqp
);
364 debug("Not found\n");
368 int fdtdec_get_alias_node(const void *blob
, const char *name
)
375 return -FDT_ERR_NOTFOUND
;
376 alias_node
= fdt_path_offset(blob
, "/aliases");
377 prop
= fdt_getprop(blob
, alias_node
, name
, &len
);
379 return -FDT_ERR_NOTFOUND
;
380 return fdt_path_offset(blob
, prop
);
383 int fdtdec_check_fdt(void)
386 * We must have an FDT, but we cannot panic() yet since the console
387 * is not ready. So for now, just assert(). Boards which need an early
388 * FDT (prior to console ready) will need to make their own
389 * arrangements and do their own checks.
391 assert(!fdtdec_prepare_fdt());
396 * This function is a little odd in that it accesses global data. At some
397 * point if the architecture board.c files merge this will make more sense.
398 * Even now, it is common code.
400 int fdtdec_prepare_fdt(void)
402 if (!gd
->fdt_blob
|| ((uintptr_t)gd
->fdt_blob
& 3) ||
403 fdt_check_header(gd
->fdt_blob
)) {
404 printf("No valid FDT found - please append one to U-Boot "
405 "binary, use u-boot-dtb.bin or define "
406 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
412 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
417 debug("%s: %s\n", __func__
, prop_name
);
418 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
420 return -FDT_ERR_NOTFOUND
;
422 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
427 * Look up a property in a node and check that it has a minimum length.
429 * @param blob FDT blob
430 * @param node node to examine
431 * @param prop_name name of property to find
432 * @param min_len minimum property length in bytes
433 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
434 found, or -FDT_ERR_BADLAYOUT if not enough data
435 * @return pointer to cell, which is only valid if err == 0
437 static const void *get_prop_check_min_len(const void *blob
, int node
,
438 const char *prop_name
, int min_len
, int *err
)
443 debug("%s: %s\n", __func__
, prop_name
);
444 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
446 *err
= -FDT_ERR_NOTFOUND
;
447 else if (len
< min_len
)
448 *err
= -FDT_ERR_BADLAYOUT
;
454 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
455 u32
*array
, int count
)
460 debug("%s: %s\n", __func__
, prop_name
);
461 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
462 sizeof(u32
) * count
, &err
);
464 for (i
= 0; i
< count
; i
++)
465 array
[i
] = fdt32_to_cpu(cell
[i
]);
470 const u32
*fdtdec_locate_array(const void *blob
, int node
,
471 const char *prop_name
, int count
)
476 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
477 sizeof(u32
) * count
, &err
);
478 return err
? NULL
: cell
;
481 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
486 debug("%s: %s\n", __func__
, prop_name
);
487 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
492 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
495 * @param blob FDT blob to use
496 * @param node Node to look at
497 * @param prop_name Node property name
498 * @param gpio Array of gpio elements to fill from FDT. This will be
499 * untouched if either 0 or an error is returned
500 * @param max_count Maximum number of elements allowed
501 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
502 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
504 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
505 struct fdt_gpio_state
*gpio
, int max_count
)
507 const struct fdt_property
*prop
;
512 debug("%s: %s\n", __func__
, prop_name
);
513 assert(max_count
> 0);
514 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
516 debug("%s: property '%s' missing\n", __func__
, prop_name
);
517 return -FDT_ERR_NOTFOUND
;
520 /* We will use the name to tag the GPIO */
521 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
522 cell
= (u32
*)prop
->data
;
523 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
524 if (len
> max_count
) {
525 debug(" %s: too many GPIOs / cells for "
526 "property '%s'\n", __func__
, prop_name
);
527 return -FDT_ERR_BADLAYOUT
;
530 /* Read out the GPIO data from the cells */
531 for (i
= 0; i
< len
; i
++, cell
+= 3) {
532 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
533 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
540 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
541 struct fdt_gpio_state
*gpio
)
545 debug("%s: %s\n", __func__
, prop_name
);
546 gpio
->gpio
= FDT_GPIO_NONE
;
548 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
549 return err
== 1 ? 0 : err
;
552 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
556 if (!fdt_gpio_isvalid(gpio
))
559 val
= gpio_get_value(gpio
->gpio
);
560 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
563 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
565 if (!fdt_gpio_isvalid(gpio
))
568 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
569 return gpio_set_value(gpio
->gpio
, val
);
572 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
575 * Return success if there is no GPIO defined. This is used for
578 if (!fdt_gpio_isvalid(gpio
))
581 if (gpio_request(gpio
->gpio
, gpio
->name
))
586 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
587 u8
*array
, int count
)
592 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
594 memcpy(array
, cell
, count
);
598 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
599 const char *prop_name
, int count
)
604 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
610 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
615 debug("%s: %s\n", __func__
, prop_name
);
616 config_node
= fdt_path_offset(blob
, "/config");
619 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
622 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
627 debug("%s: %s\n", __func__
, prop_name
);
628 config_node
= fdt_path_offset(blob
, "/config");
631 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
636 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
642 debug("%s: %s\n", __func__
, prop_name
);
643 nodeoffset
= fdt_path_offset(blob
, "/config");
647 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
651 return (char *)nodep
;
654 int fdtdec_decode_region(const void *blob
, int node
,
655 const char *prop_name
, void **ptrp
, size_t *size
)
657 const fdt_addr_t
*cell
;
660 debug("%s: %s\n", __func__
, prop_name
);
661 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
662 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
665 *ptrp
= map_sysmem(fdt_addr_to_cpu(*cell
), *size
);
666 *size
= fdt_size_to_cpu(cell
[1]);
667 debug("%s: size=%zx\n", __func__
, *size
);
672 * Read a flash entry from the fdt
674 * @param blob FDT blob
675 * @param node Offset of node to read
676 * @param name Name of node being read
677 * @param entry Place to put offset and size of this node
678 * @return 0 if ok, -ve on error
680 int fdtdec_read_fmap_entry(const void *blob
, int node
, const char *name
,
681 struct fmap_entry
*entry
)
685 if (fdtdec_get_int_array(blob
, node
, "reg", reg
, 2)) {
686 debug("Node '%s' has bad/missing 'reg' property\n", name
);
687 return -FDT_ERR_NOTFOUND
;
689 entry
->offset
= reg
[0];
690 entry
->length
= reg
[1];