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_TEGRA114_I2C
, "nvidia,tegra114-i2c"),
41 COMPAT(NVIDIA_TEGRA20_I2C
, "nvidia,tegra20-i2c"),
42 COMPAT(NVIDIA_TEGRA20_DVC
, "nvidia,tegra20-i2c-dvc"),
43 COMPAT(NVIDIA_TEGRA20_EMC
, "nvidia,tegra20-emc"),
44 COMPAT(NVIDIA_TEGRA20_EMC_TABLE
, "nvidia,tegra20-emc-table"),
45 COMPAT(NVIDIA_TEGRA20_KBC
, "nvidia,tegra20-kbc"),
46 COMPAT(NVIDIA_TEGRA20_NAND
, "nvidia,tegra20-nand"),
47 COMPAT(NVIDIA_TEGRA20_PWM
, "nvidia,tegra20-pwm"),
48 COMPAT(NVIDIA_TEGRA20_DC
, "nvidia,tegra20-dc"),
49 COMPAT(NVIDIA_TEGRA30_SDMMC
, "nvidia,tegra30-sdhci"),
50 COMPAT(NVIDIA_TEGRA20_SDMMC
, "nvidia,tegra20-sdhci"),
51 COMPAT(NVIDIA_TEGRA20_SFLASH
, "nvidia,tegra20-sflash"),
52 COMPAT(NVIDIA_TEGRA20_SLINK
, "nvidia,tegra20-slink"),
53 COMPAT(NVIDIA_TEGRA114_SPI
, "nvidia,tegra114-spi"),
54 COMPAT(SMSC_LAN9215
, "smsc,lan9215"),
55 COMPAT(SAMSUNG_EXYNOS5_SROMC
, "samsung,exynos-sromc"),
56 COMPAT(SAMSUNG_S3C2440_I2C
, "samsung,s3c2440-i2c"),
57 COMPAT(SAMSUNG_EXYNOS5_SOUND
, "samsung,exynos-sound"),
58 COMPAT(WOLFSON_WM8994_CODEC
, "wolfson,wm8994-codec"),
59 COMPAT(SAMSUNG_EXYNOS_SPI
, "samsung,exynos-spi"),
60 COMPAT(SAMSUNG_EXYNOS_EHCI
, "samsung,exynos-ehci"),
61 COMPAT(SAMSUNG_EXYNOS_USB_PHY
, "samsung,exynos-usb-phy"),
62 COMPAT(SAMSUNG_EXYNOS_TMU
, "samsung,exynos-tmu"),
63 COMPAT(MAXIM_MAX77686_PMIC
, "maxim,max77686_pmic"),
64 COMPAT(MAXIM_98095_CODEC
, "maxim,max98095-codec"),
67 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
69 /* We allow reading of the 'unknown' ID for testing purposes */
70 assert(id
>= 0 && id
< COMPAT_COUNT
);
71 return compat_names
[id
];
74 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
75 const char *prop_name
)
77 const fdt_addr_t
*cell
;
80 debug("%s: %s: ", __func__
, prop_name
);
81 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
82 if (cell
&& (len
== sizeof(fdt_addr_t
) ||
83 len
== sizeof(fdt_addr_t
) * 2)) {
84 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
86 debug("%p\n", (void *)addr
);
89 debug("(not found)\n");
90 return FDT_ADDR_T_NONE
;
93 s32
fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
99 debug("%s: %s: ", __func__
, prop_name
);
100 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
101 if (cell
&& len
>= sizeof(s32
)) {
102 s32 val
= fdt32_to_cpu(cell
[0]);
104 debug("%#x (%d)\n", val
, val
);
107 debug("(not found)\n");
111 uint64_t fdtdec_get_uint64(const void *blob
, int node
, const char *prop_name
,
112 uint64_t default_val
)
114 const uint64_t *cell64
;
117 cell64
= fdt_getprop(blob
, node
, prop_name
, &length
);
118 if (!cell64
|| length
< sizeof(*cell64
))
121 return fdt64_to_cpu(*cell64
);
124 int fdtdec_get_is_enabled(const void *blob
, int node
)
129 * It should say "okay", so only allow that. Some fdts use "ok" but
130 * this is a bug. Please fix your device tree source file. See here
133 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
135 cell
= fdt_getprop(blob
, node
, "status", NULL
);
137 return 0 == strcmp(cell
, "okay");
141 enum fdt_compat_id
fdtdec_lookup(const void *blob
, int node
)
143 enum fdt_compat_id id
;
145 /* Search our drivers */
146 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
147 if (0 == fdt_node_check_compatible(blob
, node
,
150 return COMPAT_UNKNOWN
;
153 int fdtdec_next_compatible(const void *blob
, int node
,
154 enum fdt_compat_id id
)
156 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
159 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
160 enum fdt_compat_id id
, int *depthp
)
163 node
= fdt_next_node(blob
, node
, depthp
);
164 } while (*depthp
> 1);
166 /* If this is a direct subnode, and compatible, return it */
167 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
168 blob
, node
, compat_names
[id
]))
171 return -FDT_ERR_NOTFOUND
;
174 int fdtdec_next_alias(const void *blob
, const char *name
,
175 enum fdt_compat_id id
, int *upto
)
177 #define MAX_STR_LEN 20
178 char str
[MAX_STR_LEN
+ 20];
181 /* snprintf() is not available */
182 assert(strlen(name
) < MAX_STR_LEN
);
183 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
184 node
= fdt_path_offset(blob
, str
);
187 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
191 return -FDT_ERR_NOTFOUND
;
196 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
197 enum fdt_compat_id id
, int *node_list
, int maxcount
)
199 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
201 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
204 /* TODO: Can we tighten this code up a little? */
205 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
206 enum fdt_compat_id id
, int *node_list
, int maxcount
)
208 int name_len
= strlen(name
);
216 /* find the alias node if present */
217 alias_node
= fdt_path_offset(blob
, "/aliases");
220 * start with nothing, and we can assume that the root node can't
223 memset(nodes
, '\0', sizeof(nodes
));
225 /* First find all the compatible nodes */
226 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
227 node
= fdtdec_next_compatible(blob
, node
, id
);
229 nodes
[count
++] = node
;
232 debug("%s: warning: maxcount exceeded with alias '%s'\n",
235 /* Now find all the aliases */
236 for (offset
= fdt_first_property_offset(blob
, alias_node
);
238 offset
= fdt_next_property_offset(blob
, offset
)) {
239 const struct fdt_property
*prop
;
245 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
246 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
247 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
248 node
= fdt_path_offset(blob
, prop
->data
);
252 /* Get the alias number */
253 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
254 if (number
< 0 || number
>= maxcount
) {
255 debug("%s: warning: alias '%s' is out of range\n",
260 /* Make sure the node we found is actually in our list! */
262 for (j
= 0; j
< count
; j
++)
263 if (nodes
[j
] == node
) {
269 debug("%s: warning: alias '%s' points to a node "
270 "'%s' that is missing or is not compatible "
271 " with '%s'\n", __func__
, path
,
272 fdt_get_name(blob
, node
, NULL
),
278 * Add this node to our list in the right place, and mark
281 if (fdtdec_get_is_enabled(blob
, node
)) {
282 if (node_list
[number
]) {
283 debug("%s: warning: alias '%s' requires that "
284 "a node be placed in the list in a "
285 "position which is already filled by "
286 "node '%s'\n", __func__
, path
,
287 fdt_get_name(blob
, node
, NULL
));
290 node_list
[number
] = node
;
291 if (number
>= num_found
)
292 num_found
= number
+ 1;
297 /* Add any nodes not mentioned by an alias */
298 for (i
= j
= 0; i
< maxcount
; i
++) {
300 for (; j
< maxcount
; j
++)
302 fdtdec_get_is_enabled(blob
, nodes
[j
]))
305 /* Have we run out of nodes to add? */
309 assert(!node_list
[i
]);
310 node_list
[i
] = nodes
[j
++];
319 int fdtdec_check_fdt(void)
322 * We must have an FDT, but we cannot panic() yet since the console
323 * is not ready. So for now, just assert(). Boards which need an early
324 * FDT (prior to console ready) will need to make their own
325 * arrangements and do their own checks.
327 assert(!fdtdec_prepare_fdt());
332 * This function is a little odd in that it accesses global data. At some
333 * point if the architecture board.c files merge this will make more sense.
334 * Even now, it is common code.
336 int fdtdec_prepare_fdt(void)
338 if (((uintptr_t)gd
->fdt_blob
& 3) || fdt_check_header(gd
->fdt_blob
)) {
339 printf("No valid FDT found - please append one to U-Boot "
340 "binary, use u-boot-dtb.bin or define "
341 "CONFIG_OF_EMBED\n");
347 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
352 debug("%s: %s\n", __func__
, prop_name
);
353 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
355 return -FDT_ERR_NOTFOUND
;
357 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
362 * Look up a property in a node and check that it has a minimum length.
364 * @param blob FDT blob
365 * @param node node to examine
366 * @param prop_name name of property to find
367 * @param min_len minimum property length in bytes
368 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
369 found, or -FDT_ERR_BADLAYOUT if not enough data
370 * @return pointer to cell, which is only valid if err == 0
372 static const void *get_prop_check_min_len(const void *blob
, int node
,
373 const char *prop_name
, int min_len
, int *err
)
378 debug("%s: %s\n", __func__
, prop_name
);
379 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
381 *err
= -FDT_ERR_NOTFOUND
;
382 else if (len
< min_len
)
383 *err
= -FDT_ERR_BADLAYOUT
;
389 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
390 u32
*array
, int count
)
395 debug("%s: %s\n", __func__
, prop_name
);
396 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
397 sizeof(u32
) * count
, &err
);
399 for (i
= 0; i
< count
; i
++)
400 array
[i
] = fdt32_to_cpu(cell
[i
]);
405 const u32
*fdtdec_locate_array(const void *blob
, int node
,
406 const char *prop_name
, int count
)
411 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
412 sizeof(u32
) * count
, &err
);
413 return err
? NULL
: cell
;
416 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
421 debug("%s: %s\n", __func__
, prop_name
);
422 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
427 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
430 * @param blob FDT blob to use
431 * @param node Node to look at
432 * @param prop_name Node property name
433 * @param gpio Array of gpio elements to fill from FDT. This will be
434 * untouched if either 0 or an error is returned
435 * @param max_count Maximum number of elements allowed
436 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
437 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
439 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
440 struct fdt_gpio_state
*gpio
, int max_count
)
442 const struct fdt_property
*prop
;
447 debug("%s: %s\n", __func__
, prop_name
);
448 assert(max_count
> 0);
449 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
451 debug("%s: property '%s' missing\n", __func__
, prop_name
);
452 return -FDT_ERR_NOTFOUND
;
455 /* We will use the name to tag the GPIO */
456 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
457 cell
= (u32
*)prop
->data
;
458 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
459 if (len
> max_count
) {
460 debug(" %s: too many GPIOs / cells for "
461 "property '%s'\n", __func__
, prop_name
);
462 return -FDT_ERR_BADLAYOUT
;
465 /* Read out the GPIO data from the cells */
466 for (i
= 0; i
< len
; i
++, cell
+= 3) {
467 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
468 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
475 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
476 struct fdt_gpio_state
*gpio
)
480 debug("%s: %s\n", __func__
, prop_name
);
481 gpio
->gpio
= FDT_GPIO_NONE
;
483 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
484 return err
== 1 ? 0 : err
;
487 int fdtdec_get_gpio(struct fdt_gpio_state
*gpio
)
491 if (!fdt_gpio_isvalid(gpio
))
494 val
= gpio_get_value(gpio
->gpio
);
495 return gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
498 int fdtdec_set_gpio(struct fdt_gpio_state
*gpio
, int val
)
500 if (!fdt_gpio_isvalid(gpio
))
503 val
= gpio
->flags
& FDT_GPIO_ACTIVE_LOW
? val
^ 1 : val
;
504 return gpio_set_value(gpio
->gpio
, val
);
507 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
510 * Return success if there is no GPIO defined. This is used for
513 if (!fdt_gpio_isvalid(gpio
))
516 if (gpio_request(gpio
->gpio
, gpio
->name
))
521 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
522 u8
*array
, int count
)
527 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
529 memcpy(array
, cell
, count
);
533 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
534 const char *prop_name
, int count
)
539 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
545 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
550 debug("%s: %s\n", __func__
, prop_name
);
551 config_node
= fdt_path_offset(blob
, "/config");
554 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
557 int fdtdec_get_config_bool(const void *blob
, const char *prop_name
)
562 debug("%s: %s\n", __func__
, prop_name
);
563 config_node
= fdt_path_offset(blob
, "/config");
566 prop
= fdt_get_property(blob
, config_node
, prop_name
, NULL
);
571 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
577 debug("%s: %s\n", __func__
, prop_name
);
578 nodeoffset
= fdt_path_offset(blob
, "/config");
582 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
586 return (char *)nodep
;
589 int fdtdec_decode_region(const void *blob
, int node
,
590 const char *prop_name
, void **ptrp
, size_t *size
)
592 const fdt_addr_t
*cell
;
595 debug("%s: %s\n", __func__
, prop_name
);
596 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
597 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
600 *ptrp
= (void *)fdt_addr_to_cpu(*cell
);
601 *size
= fdt_size_to_cpu(cell
[1]);
602 debug("%s: size=%zx\n", __func__
, *size
);