]>
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+
13 DECLARE_GLOBAL_DATA_PTR
;
16 * Here are the type we know about. One day we might allow drivers to
17 * register. For now we just put them here. The COMPAT macro allows us to
18 * turn this into a sparse list later, and keeps the ID with the name.
20 #define COMPAT(id, name) name
21 static const char * const compat_names
[COMPAT_COUNT
] = {
22 COMPAT(UNKNOWN
, "<none>"),
23 COMPAT(NVIDIA_TEGRA20_USB
, "nvidia,tegra20-ehci"),
24 COMPAT(NVIDIA_TEGRA30_USB
, "nvidia,tegra30-ehci"),
25 COMPAT(NVIDIA_TEGRA114_USB
, "nvidia,tegra114-ehci"),
26 COMPAT(NVIDIA_TEGRA114_I2C
, "nvidia,tegra114-i2c"),
27 COMPAT(NVIDIA_TEGRA20_I2C
, "nvidia,tegra20-i2c"),
28 COMPAT(NVIDIA_TEGRA20_DVC
, "nvidia,tegra20-i2c-dvc"),
29 COMPAT(NVIDIA_TEGRA20_EMC
, "nvidia,tegra20-emc"),
30 COMPAT(NVIDIA_TEGRA20_EMC_TABLE
, "nvidia,tegra20-emc-table"),
31 COMPAT(NVIDIA_TEGRA20_KBC
, "nvidia,tegra20-kbc"),
32 COMPAT(NVIDIA_TEGRA20_NAND
, "nvidia,tegra20-nand"),
33 COMPAT(NVIDIA_TEGRA20_PWM
, "nvidia,tegra20-pwm"),
34 COMPAT(NVIDIA_TEGRA20_DC
, "nvidia,tegra20-dc"),
35 COMPAT(NVIDIA_TEGRA124_SDMMC
, "nvidia,tegra124-sdhci"),
36 COMPAT(NVIDIA_TEGRA30_SDMMC
, "nvidia,tegra30-sdhci"),
37 COMPAT(NVIDIA_TEGRA20_SDMMC
, "nvidia,tegra20-sdhci"),
38 COMPAT(NVIDIA_TEGRA20_SFLASH
, "nvidia,tegra20-sflash"),
39 COMPAT(NVIDIA_TEGRA20_SLINK
, "nvidia,tegra20-slink"),
40 COMPAT(NVIDIA_TEGRA114_SPI
, "nvidia,tegra114-spi"),
41 COMPAT(SMSC_LAN9215
, "smsc,lan9215"),
42 COMPAT(SAMSUNG_EXYNOS5_SROMC
, "samsung,exynos-sromc"),
43 COMPAT(SAMSUNG_S3C2440_I2C
, "samsung,s3c2440-i2c"),
44 COMPAT(SAMSUNG_EXYNOS5_SOUND
, "samsung,exynos-sound"),
45 COMPAT(WOLFSON_WM8994_CODEC
, "wolfson,wm8994-codec"),
46 COMPAT(SAMSUNG_EXYNOS_SPI
, "samsung,exynos-spi"),
47 COMPAT(GOOGLE_CROS_EC
, "google,cros-ec"),
48 COMPAT(GOOGLE_CROS_EC_KEYB
, "google,cros-ec-keyb"),
49 COMPAT(SAMSUNG_EXYNOS_EHCI
, "samsung,exynos-ehci"),
50 COMPAT(SAMSUNG_EXYNOS5_XHCI
, "samsung,exynos5250-xhci"),
51 COMPAT(SAMSUNG_EXYNOS_USB_PHY
, "samsung,exynos-usb-phy"),
52 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY
, "samsung,exynos5250-usb3-phy"),
53 COMPAT(SAMSUNG_EXYNOS_TMU
, "samsung,exynos-tmu"),
54 COMPAT(SAMSUNG_EXYNOS_FIMD
, "samsung,exynos-fimd"),
55 COMPAT(SAMSUNG_EXYNOS5_DP
, "samsung,exynos5-dp"),
56 COMPAT(SAMSUNG_EXYNOS5_DWMMC
, "samsung,exynos5250-dwmmc"),
57 COMPAT(SAMSUNG_EXYNOS_SERIAL
, "samsung,exynos4210-uart"),
58 COMPAT(MAXIM_MAX77686_PMIC
, "maxim,max77686_pmic"),
59 COMPAT(GENERIC_SPI_FLASH
, "spi-flash"),
60 COMPAT(MAXIM_98095_CODEC
, "maxim,max98095-codec"),
61 COMPAT(INFINEON_SLB9635_TPM
, "infineon,slb9635-tpm"),
62 COMPAT(INFINEON_SLB9645_TPM
, "infineon,slb9645-tpm"),
63 COMPAT(SAMSUNG_EXYNOS5_I2C
, "samsung,exynos5-hsi2c"),
66 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
68 /* We allow reading of the 'unknown' ID for testing purposes */
69 assert(id
>= 0 && id
< COMPAT_COUNT
);
70 return compat_names
[id
];
73 fdt_addr_t
fdtdec_get_addr_size(const void *blob
, int node
,
74 const char *prop_name
, fdt_size_t
*sizep
)
76 const fdt_addr_t
*cell
;
79 debug("%s: %s: ", __func__
, prop_name
);
80 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
81 if (cell
&& ((!sizep
&& len
== sizeof(fdt_addr_t
)) ||
82 len
== sizeof(fdt_addr_t
) * 2)) {
83 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
85 const fdt_size_t
*size
;
87 size
= (fdt_size_t
*)((char *)cell
+
89 *sizep
= fdt_size_to_cpu(*size
);
90 debug("addr=%08lx, size=%08x\n",
93 debug("%08lx\n", (ulong
)addr
);
97 debug("(not found)\n");
98 return FDT_ADDR_T_NONE
;
101 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
102 const char *prop_name
)
104 return fdtdec_get_addr_size(blob
, node
, prop_name
, NULL
);
107 s32
fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
113 debug("%s: %s: ", __func__
, prop_name
);
114 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
115 if (cell
&& len
>= sizeof(s32
)) {
116 s32 val
= fdt32_to_cpu(cell
[0]);
118 debug("%#x (%d)\n", val
, val
);
121 debug("(not found)\n");
125 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
126 uint64_t default_val
)
128 const uint64_t *cell64
;
131 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
132 if (!cell64
|| length
< sizeof(*cell64
))
135 return fdt64_to_cpu(*cell64
);
138 int fdtdec_get_is_enabled(const void *blob
, int node
)
143 * It should say "okay", so only allow that. Some fdts use "ok" but
144 * this is a bug. Please fix your device tree source file. See here
147 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
149 cell
= fdt_getprop(blob
, node
, "status", NULL
);
151 return 0 == strcmp(cell
, "okay");
155 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
157 enum fdt_compat_id id
;
159 /* Search our drivers */
160 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
161 if (0 == fdt_node_check_compatible(blob
, node
,
164 return COMPAT_UNKNOWN
;
167 int fdtdec_next_compatible(const void *blob
, int node
,
168 enum fdt_compat_id id
)
170 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
173 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
174 enum fdt_compat_id id
, int *depthp
)
177 node
= fdt_next_node(blob
, node
, depthp
);
178 } while (*depthp
> 1);
180 /* If this is a direct subnode, and compatible, return it */
181 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
182 blob
, node
, compat_names
[id
]))
185 return -FDT_ERR_NOTFOUND
;
188 int fdtdec_next_alias(const void *blob
, const char *name
,
189 enum fdt_compat_id id
, int *upto
)
191 #define MAX_STR_LEN 20
192 char str
[MAX_STR_LEN
+ 20];
195 /* snprintf() is not available */
196 assert(strlen(name
) < MAX_STR_LEN
);
197 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
198 node
= fdt_path_offset(blob
, str
);
201 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
205 return -FDT_ERR_NOTFOUND
;
210 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
211 enum fdt_compat_id id
, int *node_list
, int maxcount
)
213 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
215 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
218 /* TODO: Can we tighten this code up a little? */
219 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
220 enum fdt_compat_id id
, int *node_list
, int maxcount
)
222 int name_len
= strlen(name
);
230 /* find the alias node if present */
231 alias_node
= fdt_path_offset(blob
, "/aliases");
234 * start with nothing, and we can assume that the root node can't
237 memset(nodes
, '\0', sizeof(nodes
));
239 /* First find all the compatible nodes */
240 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
241 node
= fdtdec_next_compatible(blob
, node
, id
);
243 nodes
[count
++] = node
;
246 debug("%s: warning: maxcount exceeded with alias '%s'\n",
249 /* Now find all the aliases */
250 for (offset
= fdt_first_property_offset(blob
, alias_node
);
252 offset
= fdt_next_property_offset(blob
, offset
)) {
253 const struct fdt_property
*prop
;
259 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
260 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
261 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
262 node
= fdt_path_offset(blob
, prop
->data
);
266 /* Get the alias number */
267 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
268 if (number
< 0 || number
>= maxcount
) {
269 debug("%s: warning: alias '%s' is out of range\n",
274 /* Make sure the node we found is actually in our list! */
276 for (j
= 0; j
< count
; j
++)
277 if (nodes
[j
] == node
) {
283 debug("%s: warning: alias '%s' points to a node "
284 "'%s' that is missing or is not compatible "
285 " with '%s'\n", __func__
, path
,
286 fdt_get_name(blob
, node
, NULL
),
292 * Add this node to our list in the right place, and mark
295 if (fdtdec_get_is_enabled(blob
, node
)) {
296 if (node_list
[number
]) {
297 debug("%s: warning: alias '%s' requires that "
298 "a node be placed in the list in a "
299 "position which is already filled by "
300 "node '%s'\n", __func__
, path
,
301 fdt_get_name(blob
, node
, NULL
));
304 node_list
[number
] = node
;
305 if (number
>= num_found
)
306 num_found
= number
+ 1;
311 /* Add any nodes not mentioned by an alias */
312 for (i
= j
= 0; i
< maxcount
; i
++) {
314 for (; j
< maxcount
; j
++)
316 fdtdec_get_is_enabled(blob
, nodes
[j
]))
319 /* Have we run out of nodes to add? */
323 assert(!node_list
[i
]);
324 node_list
[i
] = nodes
[j
++];
333 int fdtdec_check_fdt(void)
336 * We must have an FDT, but we cannot panic() yet since the console
337 * is not ready. So for now, just assert(). Boards which need an early
338 * FDT (prior to console ready) will need to make their own
339 * arrangements and do their own checks.
341 assert(!fdtdec_prepare_fdt());
346 * This function is a little odd in that it accesses global data. At some
347 * point if the architecture board.c files merge this will make more sense.
348 * Even now, it is common code.
350 int fdtdec_prepare_fdt(void)
352 if (!gd
->fdt_blob
|| ((uintptr_t)gd
->fdt_blob
& 3) ||
353 fdt_check_header(gd
->fdt_blob
)) {
354 printf("No valid FDT found - please append one to U-Boot "
355 "binary, use u-boot-dtb.bin or define "
356 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
362 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
367 debug("%s: %s\n", __func__
, prop_name
);
368 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
370 return -FDT_ERR_NOTFOUND
;
372 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
377 * Look up a property in a node and check that it has a minimum length.
379 * @param blob FDT blob
380 * @param node node to examine
381 * @param prop_name name of property to find
382 * @param min_len minimum property length in bytes
383 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
384 found, or -FDT_ERR_BADLAYOUT if not enough data
385 * @return pointer to cell, which is only valid if err == 0
387 static const void *get_prop_check_min_len(const void *blob
, int node
,
388 const char *prop_name
, int min_len
, int *err
)
393 debug("%s: %s\n", __func__
, prop_name
);
394 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
396 *err
= -FDT_ERR_NOTFOUND
;
397 else if (len
< min_len
)
398 *err
= -FDT_ERR_BADLAYOUT
;
404 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
405 u32
*array
, int count
)
410 debug("%s: %s\n", __func__
, prop_name
);
411 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
412 sizeof(u32
) * count
, &err
);
414 for (i
= 0; i
< count
; i
++)
415 array
[i
] = fdt32_to_cpu(cell
[i
]);
420 const u32
*fdtdec_locate_array(const void *blob
, int node
,
421 const char *prop_name
, int count
)
426 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
427 sizeof(u32
) * count
, &err
);
428 return err
? NULL
: cell
;
431 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
436 debug("%s: %s\n", __func__
, prop_name
);
437 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
442 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
445 * @param blob FDT blob to use
446 * @param node Node to look at
447 * @param prop_name Node property name
448 * @param gpio Array of gpio elements to fill from FDT. This will be
449 * untouched if either 0 or an error is returned
450 * @param max_count Maximum number of elements allowed
451 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
452 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
454 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
455 struct fdt_gpio_state
*gpio
, int max_count
)
457 const struct fdt_property
*prop
;
462 debug("%s: %s\n", __func__
, prop_name
);
463 assert(max_count
> 0);
464 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
466 debug("%s: property '%s' missing\n", __func__
, prop_name
);
467 return -FDT_ERR_NOTFOUND
;
470 /* We will use the name to tag the GPIO */
471 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
472 cell
= (u32
*)prop
->data
;
473 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
474 if (len
> max_count
) {
475 debug(" %s: too many GPIOs / cells for "
476 "property '%s'\n", __func__
, prop_name
);
477 return -FDT_ERR_BADLAYOUT
;
480 /* Read out the GPIO data from the cells */
481 for (i
= 0; i
< len
; i
++, cell
+= 3) {
482 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
483 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
490 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
491 struct fdt_gpio_state
*gpio
)
495 debug("%s: %s\n", __func__
, prop_name
);
496 gpio
->gpio
= FDT_GPIO_NONE
;
498 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
499 return err
== 1 ? 0 : err
;
502 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
506 if (!fdt_gpio_isvalid(gpio
))
509 val
= gpio_get_value(gpio
->gpio
);
510 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
513 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
515 if (!fdt_gpio_isvalid(gpio
))
518 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
519 return gpio_set_value(gpio
->gpio
, val
);
522 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
525 * Return success if there is no GPIO defined. This is used for
528 if (!fdt_gpio_isvalid(gpio
))
531 if (gpio_request(gpio
->gpio
, gpio
->name
))
536 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
537 u8
*array
, int count
)
542 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
544 memcpy(array
, cell
, count
);
548 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
549 const char *prop_name
, int count
)
554 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
560 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
565 debug("%s: %s\n", __func__
, prop_name
);
566 config_node
= fdt_path_offset(blob
, "/config");
569 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
572 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
577 debug("%s: %s\n", __func__
, prop_name
);
578 config_node
= fdt_path_offset(blob
, "/config");
581 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
586 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
592 debug("%s: %s\n", __func__
, prop_name
);
593 nodeoffset
= fdt_path_offset(blob
, "/config");
597 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
601 return (char *)nodep
;
604 int fdtdec_decode_region(const void *blob
, int node
,
605 const char *prop_name
, void **ptrp
, size_t *size
)
607 const fdt_addr_t
*cell
;
610 debug("%s: %s\n", __func__
, prop_name
);
611 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
612 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
615 *ptrp
= map_sysmem(fdt_addr_to_cpu(*cell
), *size
);
616 *size
= fdt_size_to_cpu(cell
[1]);
617 debug("%s: size=%zx\n", __func__
, *size
);