]>
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+
14 DECLARE_GLOBAL_DATA_PTR
;
17 * Here are the type we know about. One day we might allow drivers to
18 * register. For now we just put them here. The COMPAT macro allows us to
19 * turn this into a sparse list later, and keeps the ID with the name.
21 #define COMPAT(id, name) name
22 static const char * const compat_names
[COMPAT_COUNT
] = {
23 COMPAT(UNKNOWN
, "<none>"),
24 COMPAT(NVIDIA_TEGRA20_USB
, "nvidia,tegra20-ehci"),
25 COMPAT(NVIDIA_TEGRA30_USB
, "nvidia,tegra30-ehci"),
26 COMPAT(NVIDIA_TEGRA114_USB
, "nvidia,tegra114-ehci"),
27 COMPAT(NVIDIA_TEGRA114_I2C
, "nvidia,tegra114-i2c"),
28 COMPAT(NVIDIA_TEGRA20_I2C
, "nvidia,tegra20-i2c"),
29 COMPAT(NVIDIA_TEGRA20_DVC
, "nvidia,tegra20-i2c-dvc"),
30 COMPAT(NVIDIA_TEGRA20_EMC
, "nvidia,tegra20-emc"),
31 COMPAT(NVIDIA_TEGRA20_EMC_TABLE
, "nvidia,tegra20-emc-table"),
32 COMPAT(NVIDIA_TEGRA20_KBC
, "nvidia,tegra20-kbc"),
33 COMPAT(NVIDIA_TEGRA20_NAND
, "nvidia,tegra20-nand"),
34 COMPAT(NVIDIA_TEGRA20_PWM
, "nvidia,tegra20-pwm"),
35 COMPAT(NVIDIA_TEGRA20_DC
, "nvidia,tegra20-dc"),
36 COMPAT(NVIDIA_TEGRA124_SDMMC
, "nvidia,tegra124-sdhci"),
37 COMPAT(NVIDIA_TEGRA30_SDMMC
, "nvidia,tegra30-sdhci"),
38 COMPAT(NVIDIA_TEGRA20_SDMMC
, "nvidia,tegra20-sdhci"),
39 COMPAT(NVIDIA_TEGRA20_SFLASH
, "nvidia,tegra20-sflash"),
40 COMPAT(NVIDIA_TEGRA20_SLINK
, "nvidia,tegra20-slink"),
41 COMPAT(NVIDIA_TEGRA114_SPI
, "nvidia,tegra114-spi"),
42 COMPAT(SMSC_LAN9215
, "smsc,lan9215"),
43 COMPAT(SAMSUNG_EXYNOS5_SROMC
, "samsung,exynos-sromc"),
44 COMPAT(SAMSUNG_S3C2440_I2C
, "samsung,s3c2440-i2c"),
45 COMPAT(SAMSUNG_EXYNOS5_SOUND
, "samsung,exynos-sound"),
46 COMPAT(WOLFSON_WM8994_CODEC
, "wolfson,wm8994-codec"),
47 COMPAT(SAMSUNG_EXYNOS_SPI
, "samsung,exynos-spi"),
48 COMPAT(GOOGLE_CROS_EC
, "google,cros-ec"),
49 COMPAT(GOOGLE_CROS_EC_KEYB
, "google,cros-ec-keyb"),
50 COMPAT(SAMSUNG_EXYNOS_EHCI
, "samsung,exynos-ehci"),
51 COMPAT(SAMSUNG_EXYNOS5_XHCI
, "samsung,exynos5250-xhci"),
52 COMPAT(SAMSUNG_EXYNOS_USB_PHY
, "samsung,exynos-usb-phy"),
53 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY
, "samsung,exynos5250-usb3-phy"),
54 COMPAT(SAMSUNG_EXYNOS_TMU
, "samsung,exynos-tmu"),
55 COMPAT(SAMSUNG_EXYNOS_FIMD
, "samsung,exynos-fimd"),
56 COMPAT(SAMSUNG_EXYNOS5_DP
, "samsung,exynos5-dp"),
57 COMPAT(SAMSUNG_EXYNOS5_DWMMC
, "samsung,exynos5250-dwmmc"),
58 COMPAT(SAMSUNG_EXYNOS_SERIAL
, "samsung,exynos4210-uart"),
59 COMPAT(MAXIM_MAX77686_PMIC
, "maxim,max77686_pmic"),
60 COMPAT(GENERIC_SPI_FLASH
, "spi-flash"),
61 COMPAT(MAXIM_98095_CODEC
, "maxim,max98095-codec"),
62 COMPAT(INFINEON_SLB9635_TPM
, "infineon,slb9635-tpm"),
63 COMPAT(INFINEON_SLB9645_TPM
, "infineon,slb9645-tpm"),
64 COMPAT(SAMSUNG_EXYNOS5_I2C
, "samsung,exynos5-hsi2c"),
65 COMPAT(SANDBOX_HOST_EMULATION
, "sandbox,host-emulation"),
66 COMPAT(SANDBOX_LCD_SDL
, "sandbox,lcd-sdl"),
69 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
71 /* We allow reading of the 'unknown' ID for testing purposes */
72 assert(id
>= 0 && id
< COMPAT_COUNT
);
73 return compat_names
[id
];
76 fdt_addr_t
fdtdec_get_addr_size(const void *blob
, int node
,
77 const char *prop_name
, fdt_size_t
*sizep
)
79 const fdt_addr_t
*cell
;
82 debug("%s: %s: ", __func__
, prop_name
);
83 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
84 if (cell
&& ((!sizep
&& len
== sizeof(fdt_addr_t
)) ||
85 len
== sizeof(fdt_addr_t
) * 2)) {
86 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
88 const fdt_size_t
*size
;
90 size
= (fdt_size_t
*)((char *)cell
+
92 *sizep
= fdt_size_to_cpu(*size
);
93 debug("addr=%08lx, size=%08x\n",
96 debug("%08lx\n", (ulong
)addr
);
100 debug("(not found)\n");
101 return FDT_ADDR_T_NONE
;
104 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
105 const char *prop_name
)
107 return fdtdec_get_addr_size(blob
, node
, prop_name
, NULL
);
110 s32
fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
116 debug("%s: %s: ", __func__
, prop_name
);
117 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
118 if (cell
&& len
>= sizeof(s32
)) {
119 s32 val
= fdt32_to_cpu(cell
[0]);
121 debug("%#x (%d)\n", val
, val
);
124 debug("(not found)\n");
128 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
129 uint64_t default_val
)
131 const uint64_t *cell64
;
134 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
135 if (!cell64
|| length
< sizeof(*cell64
))
138 return fdt64_to_cpu(*cell64
);
141 int fdtdec_get_is_enabled(const void *blob
, int node
)
146 * It should say "okay", so only allow that. Some fdts use "ok" but
147 * this is a bug. Please fix your device tree source file. See here
150 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
152 cell
= fdt_getprop(blob
, node
, "status", NULL
);
154 return 0 == strcmp(cell
, "okay");
158 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
160 enum fdt_compat_id id
;
162 /* Search our drivers */
163 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
164 if (0 == fdt_node_check_compatible(blob
, node
,
167 return COMPAT_UNKNOWN
;
170 int fdtdec_next_compatible(const void *blob
, int node
,
171 enum fdt_compat_id id
)
173 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
176 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
177 enum fdt_compat_id id
, int *depthp
)
180 node
= fdt_next_node(blob
, node
, depthp
);
181 } while (*depthp
> 1);
183 /* If this is a direct subnode, and compatible, return it */
184 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
185 blob
, node
, compat_names
[id
]))
188 return -FDT_ERR_NOTFOUND
;
191 int fdtdec_next_alias(const void *blob
, const char *name
,
192 enum fdt_compat_id id
, int *upto
)
194 #define MAX_STR_LEN 20
195 char str
[MAX_STR_LEN
+ 20];
198 /* snprintf() is not available */
199 assert(strlen(name
) < MAX_STR_LEN
);
200 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
201 node
= fdt_path_offset(blob
, str
);
204 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
208 return -FDT_ERR_NOTFOUND
;
213 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
214 enum fdt_compat_id id
, int *node_list
, int maxcount
)
216 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
218 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
221 /* TODO: Can we tighten this code up a little? */
222 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
223 enum fdt_compat_id id
, int *node_list
, int maxcount
)
225 int name_len
= strlen(name
);
233 /* find the alias node if present */
234 alias_node
= fdt_path_offset(blob
, "/aliases");
237 * start with nothing, and we can assume that the root node can't
240 memset(nodes
, '\0', sizeof(nodes
));
242 /* First find all the compatible nodes */
243 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
244 node
= fdtdec_next_compatible(blob
, node
, id
);
246 nodes
[count
++] = node
;
249 debug("%s: warning: maxcount exceeded with alias '%s'\n",
252 /* Now find all the aliases */
253 for (offset
= fdt_first_property_offset(blob
, alias_node
);
255 offset
= fdt_next_property_offset(blob
, offset
)) {
256 const struct fdt_property
*prop
;
262 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
263 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
264 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
265 node
= fdt_path_offset(blob
, prop
->data
);
269 /* Get the alias number */
270 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
271 if (number
< 0 || number
>= maxcount
) {
272 debug("%s: warning: alias '%s' is out of range\n",
277 /* Make sure the node we found is actually in our list! */
279 for (j
= 0; j
< count
; j
++)
280 if (nodes
[j
] == node
) {
286 debug("%s: warning: alias '%s' points to a node "
287 "'%s' that is missing or is not compatible "
288 " with '%s'\n", __func__
, path
,
289 fdt_get_name(blob
, node
, NULL
),
295 * Add this node to our list in the right place, and mark
298 if (fdtdec_get_is_enabled(blob
, node
)) {
299 if (node_list
[number
]) {
300 debug("%s: warning: alias '%s' requires that "
301 "a node be placed in the list in a "
302 "position which is already filled by "
303 "node '%s'\n", __func__
, path
,
304 fdt_get_name(blob
, node
, NULL
));
307 node_list
[number
] = node
;
308 if (number
>= num_found
)
309 num_found
= number
+ 1;
314 /* Add any nodes not mentioned by an alias */
315 for (i
= j
= 0; i
< maxcount
; i
++) {
317 for (; j
< maxcount
; j
++)
319 fdtdec_get_is_enabled(blob
, nodes
[j
]))
322 /* Have we run out of nodes to add? */
326 assert(!node_list
[i
]);
327 node_list
[i
] = nodes
[j
++];
336 int fdtdec_check_fdt(void)
339 * We must have an FDT, but we cannot panic() yet since the console
340 * is not ready. So for now, just assert(). Boards which need an early
341 * FDT (prior to console ready) will need to make their own
342 * arrangements and do their own checks.
344 assert(!fdtdec_prepare_fdt());
349 * This function is a little odd in that it accesses global data. At some
350 * point if the architecture board.c files merge this will make more sense.
351 * Even now, it is common code.
353 int fdtdec_prepare_fdt(void)
355 if (!gd
->fdt_blob
|| ((uintptr_t)gd
->fdt_blob
& 3) ||
356 fdt_check_header(gd
->fdt_blob
)) {
357 printf("No valid FDT found - please append one to U-Boot "
358 "binary, use u-boot-dtb.bin or define "
359 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
365 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
370 debug("%s: %s\n", __func__
, prop_name
);
371 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
373 return -FDT_ERR_NOTFOUND
;
375 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
380 * Look up a property in a node and check that it has a minimum length.
382 * @param blob FDT blob
383 * @param node node to examine
384 * @param prop_name name of property to find
385 * @param min_len minimum property length in bytes
386 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
387 found, or -FDT_ERR_BADLAYOUT if not enough data
388 * @return pointer to cell, which is only valid if err == 0
390 static const void *get_prop_check_min_len(const void *blob
, int node
,
391 const char *prop_name
, int min_len
, int *err
)
396 debug("%s: %s\n", __func__
, prop_name
);
397 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
399 *err
= -FDT_ERR_NOTFOUND
;
400 else if (len
< min_len
)
401 *err
= -FDT_ERR_BADLAYOUT
;
407 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
408 u32
*array
, int count
)
413 debug("%s: %s\n", __func__
, prop_name
);
414 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
415 sizeof(u32
) * count
, &err
);
417 for (i
= 0; i
< count
; i
++)
418 array
[i
] = fdt32_to_cpu(cell
[i
]);
423 const u32
*fdtdec_locate_array(const void *blob
, int node
,
424 const char *prop_name
, int count
)
429 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
430 sizeof(u32
) * count
, &err
);
431 return err
? NULL
: cell
;
434 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
439 debug("%s: %s\n", __func__
, prop_name
);
440 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
445 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
448 * @param blob FDT blob to use
449 * @param node Node to look at
450 * @param prop_name Node property name
451 * @param gpio Array of gpio elements to fill from FDT. This will be
452 * untouched if either 0 or an error is returned
453 * @param max_count Maximum number of elements allowed
454 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
455 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
457 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
458 struct fdt_gpio_state
*gpio
, int max_count
)
460 const struct fdt_property
*prop
;
465 debug("%s: %s\n", __func__
, prop_name
);
466 assert(max_count
> 0);
467 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
469 debug("%s: property '%s' missing\n", __func__
, prop_name
);
470 return -FDT_ERR_NOTFOUND
;
473 /* We will use the name to tag the GPIO */
474 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
475 cell
= (u32
*)prop
->data
;
476 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
477 if (len
> max_count
) {
478 debug(" %s: too many GPIOs / cells for "
479 "property '%s'\n", __func__
, prop_name
);
480 return -FDT_ERR_BADLAYOUT
;
483 /* Read out the GPIO data from the cells */
484 for (i
= 0; i
< len
; i
++, cell
+= 3) {
485 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
486 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
493 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
494 struct fdt_gpio_state
*gpio
)
498 debug("%s: %s\n", __func__
, prop_name
);
499 gpio
->gpio
= FDT_GPIO_NONE
;
501 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
502 return err
== 1 ? 0 : err
;
505 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
509 if (!fdt_gpio_isvalid(gpio
))
512 val
= gpio_get_value(gpio
->gpio
);
513 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
516 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
518 if (!fdt_gpio_isvalid(gpio
))
521 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
522 return gpio_set_value(gpio
->gpio
, val
);
525 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
528 * Return success if there is no GPIO defined. This is used for
531 if (!fdt_gpio_isvalid(gpio
))
534 if (gpio_request(gpio
->gpio
, gpio
->name
))
539 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
540 u8
*array
, int count
)
545 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
547 memcpy(array
, cell
, count
);
551 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
552 const char *prop_name
, int count
)
557 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
563 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
568 debug("%s: %s\n", __func__
, prop_name
);
569 config_node
= fdt_path_offset(blob
, "/config");
572 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
575 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
580 debug("%s: %s\n", __func__
, prop_name
);
581 config_node
= fdt_path_offset(blob
, "/config");
584 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
589 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
595 debug("%s: %s\n", __func__
, prop_name
);
596 nodeoffset
= fdt_path_offset(blob
, "/config");
600 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
604 return (char *)nodep
;
607 int fdtdec_decode_region(const void *blob
, int node
,
608 const char *prop_name
, void **ptrp
, size_t *size
)
610 const fdt_addr_t
*cell
;
613 debug("%s: %s\n", __func__
, prop_name
);
614 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
615 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
618 *ptrp
= map_sysmem(fdt_addr_to_cpu(*cell
), *size
);
619 *size
= fdt_size_to_cpu(cell
[1]);
620 debug("%s: size=%zx\n", __func__
, *size
);
625 * Read a flash entry from the fdt
627 * @param blob FDT blob
628 * @param node Offset of node to read
629 * @param name Name of node being read
630 * @param entry Place to put offset and size of this node
631 * @return 0 if ok, -ve on error
633 int fdtdec_read_fmap_entry(const void *blob
, int node
, const char *name
,
634 struct fmap_entry
*entry
)
638 if (fdtdec_get_int_array(blob
, node
, "reg", reg
, 2)) {
639 debug("Node '%s' has bad/missing 'reg' property\n", name
);
640 return -FDT_ERR_NOTFOUND
;
642 entry
->offset
= reg
[0];
643 entry
->length
= reg
[1];
649 #include "fdt_support.h"
651 int fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
657 cell
= fdt_getprop_w((void *)blob
, node
, prop_name
, &len
);
658 if (cell
&& len
>= sizeof(int)) {
659 int val
= fdt32_to_cpu(cell
[0]);