]>
git.ipfire.org Git - people/ms/u-boot.git/blob - lib/fdtdec.c
2 * Copyright (c) 2011 The Chromium OS Authors.
3 * See file CREDITS for list of people who contributed to this
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 DECLARE_GLOBAL_DATA_PTR
;
32 * Here are the type we know about. One day we might allow drivers to
33 * register. For now we just put them here. The COMPAT macro allows us to
34 * turn this into a sparse list later, and keeps the ID with the name.
36 #define COMPAT(id, name) name
37 static const char * const compat_names
[COMPAT_COUNT
] = {
38 COMPAT(UNKNOWN
, "<none>"),
39 COMPAT(NVIDIA_TEGRA20_USB
, "nvidia,tegra20-ehci"),
40 COMPAT(NVIDIA_TEGRA30_USB
, "nvidia,tegra30-ehci"),
41 COMPAT(NVIDIA_TEGRA114_USB
, "nvidia,tegra114-ehci"),
42 COMPAT(NVIDIA_TEGRA114_I2C
, "nvidia,tegra114-i2c"),
43 COMPAT(NVIDIA_TEGRA20_I2C
, "nvidia,tegra20-i2c"),
44 COMPAT(NVIDIA_TEGRA20_DVC
, "nvidia,tegra20-i2c-dvc"),
45 COMPAT(NVIDIA_TEGRA20_EMC
, "nvidia,tegra20-emc"),
46 COMPAT(NVIDIA_TEGRA20_EMC_TABLE
, "nvidia,tegra20-emc-table"),
47 COMPAT(NVIDIA_TEGRA20_KBC
, "nvidia,tegra20-kbc"),
48 COMPAT(NVIDIA_TEGRA20_NAND
, "nvidia,tegra20-nand"),
49 COMPAT(NVIDIA_TEGRA20_PWM
, "nvidia,tegra20-pwm"),
50 COMPAT(NVIDIA_TEGRA20_DC
, "nvidia,tegra20-dc"),
51 COMPAT(NVIDIA_TEGRA30_SDMMC
, "nvidia,tegra30-sdhci"),
52 COMPAT(NVIDIA_TEGRA20_SDMMC
, "nvidia,tegra20-sdhci"),
53 COMPAT(NVIDIA_TEGRA20_SFLASH
, "nvidia,tegra20-sflash"),
54 COMPAT(NVIDIA_TEGRA20_SLINK
, "nvidia,tegra20-slink"),
55 COMPAT(NVIDIA_TEGRA114_SPI
, "nvidia,tegra114-spi"),
56 COMPAT(SMSC_LAN9215
, "smsc,lan9215"),
57 COMPAT(SAMSUNG_EXYNOS5_SROMC
, "samsung,exynos-sromc"),
58 COMPAT(SAMSUNG_S3C2440_I2C
, "samsung,s3c2440-i2c"),
59 COMPAT(SAMSUNG_EXYNOS5_SOUND
, "samsung,exynos-sound"),
60 COMPAT(WOLFSON_WM8994_CODEC
, "wolfson,wm8994-codec"),
61 COMPAT(SAMSUNG_EXYNOS_SPI
, "samsung,exynos-spi"),
62 COMPAT(GOOGLE_CROS_EC
, "google,cros-ec"),
63 COMPAT(GOOGLE_CROS_EC_KEYB
, "google,cros-ec-keyb"),
64 COMPAT(SAMSUNG_EXYNOS_EHCI
, "samsung,exynos-ehci"),
65 COMPAT(SAMSUNG_EXYNOS_USB_PHY
, "samsung,exynos-usb-phy"),
66 COMPAT(SAMSUNG_EXYNOS_TMU
, "samsung,exynos-tmu"),
67 COMPAT(SAMSUNG_EXYNOS_FIMD
, "samsung,exynos-fimd"),
68 COMPAT(SAMSUNG_EXYNOS5_DP
, "samsung,exynos5-dp"),
69 COMPAT(SAMSUNG_EXYNOS5_DWMMC
, "samsung,exynos5250-dwmmc"),
70 COMPAT(SAMSUNG_EXYNOS_SERIAL
, "samsung,exynos4210-uart"),
71 COMPAT(MAXIM_MAX77686_PMIC
, "maxim,max77686_pmic"),
72 COMPAT(GENERIC_SPI_FLASH
, "spi-flash"),
73 COMPAT(MAXIM_98095_CODEC
, "maxim,max98095-codec"),
74 COMPAT(INFINEON_SLB9635_TPM
, "infineon,slb9635-tpm"),
75 COMPAT(INFINEON_SLB9645_TPM
, "infineon,slb9645-tpm"),
76 COMPAT(SAMSUNG_EXYNOS5_I2C
, "samsung,exynos5-hsi2c"),
79 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
81 /* We allow reading of the 'unknown' ID for testing purposes */
82 assert(id
>= 0 && id
< COMPAT_COUNT
);
83 return compat_names
[id
];
86 fdt_addr_t
fdtdec_get_addr_size(const void *blob
, int node
,
87 const char *prop_name
, fdt_size_t
*sizep
)
89 const fdt_addr_t
*cell
;
92 debug("%s: %s: ", __func__
, prop_name
);
93 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
94 if (cell
&& ((!sizep
&& len
== sizeof(fdt_addr_t
)) ||
95 len
== sizeof(fdt_addr_t
) * 2)) {
96 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
98 const fdt_size_t
*size
;
100 size
= (fdt_size_t
*)((char *)cell
+
102 *sizep
= fdt_size_to_cpu(*size
);
103 debug("addr=%p, size=%p\n", (void *)addr
,
106 debug("%p\n", (void *)addr
);
110 debug("(not found)\n");
111 return FDT_ADDR_T_NONE
;
114 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
115 const char *prop_name
)
117 return fdtdec_get_addr_size(blob
, node
, prop_name
, NULL
);
120 s32
fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
126 debug("%s: %s: ", __func__
, prop_name
);
127 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
128 if (cell
&& len
>= sizeof(s32
)) {
129 s32 val
= fdt32_to_cpu(cell
[0]);
131 debug("%#x (%d)\n", val
, val
);
134 debug("(not found)\n");
138 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
139 uint64_t default_val
)
141 const uint64_t *cell64
;
144 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
145 if (!cell64
|| length
< sizeof(*cell64
))
148 return fdt64_to_cpu(*cell64
);
151 int fdtdec_get_is_enabled(const void *blob
, int node
)
156 * It should say "okay", so only allow that. Some fdts use "ok" but
157 * this is a bug. Please fix your device tree source file. See here
160 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
162 cell
= fdt_getprop(blob
, node
, "status", NULL
);
164 return 0 == strcmp(cell
, "okay");
168 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
170 enum fdt_compat_id id
;
172 /* Search our drivers */
173 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
174 if (0 == fdt_node_check_compatible(blob
, node
,
177 return COMPAT_UNKNOWN
;
180 int fdtdec_next_compatible(const void *blob
, int node
,
181 enum fdt_compat_id id
)
183 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
186 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
187 enum fdt_compat_id id
, int *depthp
)
190 node
= fdt_next_node(blob
, node
, depthp
);
191 } while (*depthp
> 1);
193 /* If this is a direct subnode, and compatible, return it */
194 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
195 blob
, node
, compat_names
[id
]))
198 return -FDT_ERR_NOTFOUND
;
201 int fdtdec_next_alias(const void *blob
, const char *name
,
202 enum fdt_compat_id id
, int *upto
)
204 #define MAX_STR_LEN 20
205 char str
[MAX_STR_LEN
+ 20];
208 /* snprintf() is not available */
209 assert(strlen(name
) < MAX_STR_LEN
);
210 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
211 node
= fdt_path_offset(blob
, str
);
214 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
218 return -FDT_ERR_NOTFOUND
;
223 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
224 enum fdt_compat_id id
, int *node_list
, int maxcount
)
226 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
228 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
231 /* TODO: Can we tighten this code up a little? */
232 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
233 enum fdt_compat_id id
, int *node_list
, int maxcount
)
235 int name_len
= strlen(name
);
243 /* find the alias node if present */
244 alias_node
= fdt_path_offset(blob
, "/aliases");
247 * start with nothing, and we can assume that the root node can't
250 memset(nodes
, '\0', sizeof(nodes
));
252 /* First find all the compatible nodes */
253 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
254 node
= fdtdec_next_compatible(blob
, node
, id
);
256 nodes
[count
++] = node
;
259 debug("%s: warning: maxcount exceeded with alias '%s'\n",
262 /* Now find all the aliases */
263 for (offset
= fdt_first_property_offset(blob
, alias_node
);
265 offset
= fdt_next_property_offset(blob
, offset
)) {
266 const struct fdt_property
*prop
;
272 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
273 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
274 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
275 node
= fdt_path_offset(blob
, prop
->data
);
279 /* Get the alias number */
280 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
281 if (number
< 0 || number
>= maxcount
) {
282 debug("%s: warning: alias '%s' is out of range\n",
287 /* Make sure the node we found is actually in our list! */
289 for (j
= 0; j
< count
; j
++)
290 if (nodes
[j
] == node
) {
296 debug("%s: warning: alias '%s' points to a node "
297 "'%s' that is missing or is not compatible "
298 " with '%s'\n", __func__
, path
,
299 fdt_get_name(blob
, node
, NULL
),
305 * Add this node to our list in the right place, and mark
308 if (fdtdec_get_is_enabled(blob
, node
)) {
309 if (node_list
[number
]) {
310 debug("%s: warning: alias '%s' requires that "
311 "a node be placed in the list in a "
312 "position which is already filled by "
313 "node '%s'\n", __func__
, path
,
314 fdt_get_name(blob
, node
, NULL
));
317 node_list
[number
] = node
;
318 if (number
>= num_found
)
319 num_found
= number
+ 1;
324 /* Add any nodes not mentioned by an alias */
325 for (i
= j
= 0; i
< maxcount
; i
++) {
327 for (; j
< maxcount
; j
++)
329 fdtdec_get_is_enabled(blob
, nodes
[j
]))
332 /* Have we run out of nodes to add? */
336 assert(!node_list
[i
]);
337 node_list
[i
] = nodes
[j
++];
346 int fdtdec_check_fdt(void)
349 * We must have an FDT, but we cannot panic() yet since the console
350 * is not ready. So for now, just assert(). Boards which need an early
351 * FDT (prior to console ready) will need to make their own
352 * arrangements and do their own checks.
354 assert(!fdtdec_prepare_fdt());
359 * This function is a little odd in that it accesses global data. At some
360 * point if the architecture board.c files merge this will make more sense.
361 * Even now, it is common code.
363 int fdtdec_prepare_fdt(void)
365 if (!gd
->fdt_blob
|| ((uintptr_t)gd
->fdt_blob
& 3) ||
366 fdt_check_header(gd
->fdt_blob
)) {
367 printf("No valid FDT found - please append one to U-Boot "
368 "binary, use u-boot-dtb.bin or define "
369 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
375 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
380 debug("%s: %s\n", __func__
, prop_name
);
381 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
383 return -FDT_ERR_NOTFOUND
;
385 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
390 * Look up a property in a node and check that it has a minimum length.
392 * @param blob FDT blob
393 * @param node node to examine
394 * @param prop_name name of property to find
395 * @param min_len minimum property length in bytes
396 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
397 found, or -FDT_ERR_BADLAYOUT if not enough data
398 * @return pointer to cell, which is only valid if err == 0
400 static const void *get_prop_check_min_len(const void *blob
, int node
,
401 const char *prop_name
, int min_len
, int *err
)
406 debug("%s: %s\n", __func__
, prop_name
);
407 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
409 *err
= -FDT_ERR_NOTFOUND
;
410 else if (len
< min_len
)
411 *err
= -FDT_ERR_BADLAYOUT
;
417 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
418 u32
*array
, int count
)
423 debug("%s: %s\n", __func__
, prop_name
);
424 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
425 sizeof(u32
) * count
, &err
);
427 for (i
= 0; i
< count
; i
++)
428 array
[i
] = fdt32_to_cpu(cell
[i
]);
433 const u32
*fdtdec_locate_array(const void *blob
, int node
,
434 const char *prop_name
, int count
)
439 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
440 sizeof(u32
) * count
, &err
);
441 return err
? NULL
: cell
;
444 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
449 debug("%s: %s\n", __func__
, prop_name
);
450 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
455 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
458 * @param blob FDT blob to use
459 * @param node Node to look at
460 * @param prop_name Node property name
461 * @param gpio Array of gpio elements to fill from FDT. This will be
462 * untouched if either 0 or an error is returned
463 * @param max_count Maximum number of elements allowed
464 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
465 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
467 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
468 struct fdt_gpio_state
*gpio
, int max_count
)
470 const struct fdt_property
*prop
;
475 debug("%s: %s\n", __func__
, prop_name
);
476 assert(max_count
> 0);
477 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
479 debug("%s: property '%s' missing\n", __func__
, prop_name
);
480 return -FDT_ERR_NOTFOUND
;
483 /* We will use the name to tag the GPIO */
484 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
485 cell
= (u32
*)prop
->data
;
486 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
487 if (len
> max_count
) {
488 debug(" %s: too many GPIOs / cells for "
489 "property '%s'\n", __func__
, prop_name
);
490 return -FDT_ERR_BADLAYOUT
;
493 /* Read out the GPIO data from the cells */
494 for (i
= 0; i
< len
; i
++, cell
+= 3) {
495 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
496 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
503 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
504 struct fdt_gpio_state
*gpio
)
508 debug("%s: %s\n", __func__
, prop_name
);
509 gpio
->gpio
= FDT_GPIO_NONE
;
511 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
512 return err
== 1 ? 0 : err
;
515 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
519 if (!fdt_gpio_isvalid(gpio
))
522 val
= gpio_get_value(gpio
->gpio
);
523 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
526 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
528 if (!fdt_gpio_isvalid(gpio
))
531 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
532 return gpio_set_value(gpio
->gpio
, val
);
535 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
538 * Return success if there is no GPIO defined. This is used for
541 if (!fdt_gpio_isvalid(gpio
))
544 if (gpio_request(gpio
->gpio
, gpio
->name
))
549 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
550 u8
*array
, int count
)
555 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
557 memcpy(array
, cell
, count
);
561 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
562 const char *prop_name
, int count
)
567 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
573 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
578 debug("%s: %s\n", __func__
, prop_name
);
579 config_node
= fdt_path_offset(blob
, "/config");
582 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
585 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
590 debug("%s: %s\n", __func__
, prop_name
);
591 config_node
= fdt_path_offset(blob
, "/config");
594 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
599 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
605 debug("%s: %s\n", __func__
, prop_name
);
606 nodeoffset
= fdt_path_offset(blob
, "/config");
610 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
614 return (char *)nodep
;
617 int fdtdec_decode_region(const void *blob
, int node
,
618 const char *prop_name
, void **ptrp
, size_t *size
)
620 const fdt_addr_t
*cell
;
623 debug("%s: %s\n", __func__
, prop_name
);
624 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
625 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
628 *ptrp
= (void *)fdt_addr_to_cpu(*cell
);
629 *size
= fdt_size_to_cpu(cell
[1]);
630 debug("%s: size=%zx\n", __func__
, *size
);