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_TEGRA20_I2C, "nvidia,tegra20-i2c"),
41 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
42 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
43 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
44 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
45 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
46 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
47 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
48 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
49 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
52 const char *fdtdec_get_compatible(enum fdt_compat_id id)
54 /* We allow reading of the 'unknown' ID for testing purposes */
55 assert(id >= 0 && id < COMPAT_COUNT);
56 return compat_names[id];
59 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
60 const char *prop_name)
62 const fdt_addr_t *cell;
65 debug("%s: %s: ", __func__, prop_name);
66 cell = fdt_getprop(blob, node, prop_name, &len);
67 if (cell && (len == sizeof(fdt_addr_t) ||
68 len == sizeof(fdt_addr_t) * 2)) {
69 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
71 debug("%p\n", (void *)addr);
74 debug("(not found)\n");
75 return FDT_ADDR_T_NONE;
78 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
84 debug("%s: %s: ", __func__, prop_name);
85 cell = fdt_getprop(blob, node, prop_name, &len);
86 if (cell && len >= sizeof(s32)) {
87 s32 val = fdt32_to_cpu(cell[0]);
89 debug("%#x (%d)\n", val, val);
92 debug("(not found)\n");
96 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
99 const uint64_t *cell64;
102 cell64 = fdt_getprop(blob, node, prop_name, &length);
103 if (!cell64 || length < sizeof(*cell64))
106 return fdt64_to_cpu(*cell64);
109 int fdtdec_get_is_enabled(const void *blob, int node)
114 * It should say "okay", so only allow that. Some fdts use "ok" but
115 * this is a bug. Please fix your device tree source file. See here
118 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
120 cell = fdt_getprop(blob, node, "status", NULL);
122 return 0 == strcmp(cell, "okay");
126 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
128 enum fdt_compat_id id;
130 /* Search our drivers */
131 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
132 if (0 == fdt_node_check_compatible(blob, node,
135 return COMPAT_UNKNOWN;
138 int fdtdec_next_compatible(const void *blob, int node,
139 enum fdt_compat_id id)
141 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
144 int fdtdec_next_compatible_subnode(const void *blob, int node,
145 enum fdt_compat_id id, int *depthp)
148 node = fdt_next_node(blob, node, depthp);
149 } while (*depthp > 1);
151 /* If this is a direct subnode, and compatible, return it */
152 if (*depthp == 1 && 0 == fdt_node_check_compatible(
153 blob, node, compat_names[id]))
156 return -FDT_ERR_NOTFOUND;
159 int fdtdec_next_alias(const void *blob, const char *name,
160 enum fdt_compat_id id, int *upto)
162 #define MAX_STR_LEN 20
163 char str[MAX_STR_LEN + 20];
166 /* snprintf() is not available */
167 assert(strlen(name) < MAX_STR_LEN);
168 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
169 node = fdt_path_offset(blob, str);
172 err = fdt_node_check_compatible(blob, node, compat_names[id]);
176 return -FDT_ERR_NOTFOUND;
181 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
182 enum fdt_compat_id id, int *node_list, int maxcount)
184 memset(node_list, '\0', sizeof(*node_list) * maxcount);
186 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
189 /* TODO: Can we tighten this code up a little? */
190 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
191 enum fdt_compat_id id, int *node_list, int maxcount)
193 int name_len = strlen(name);
201 /* find the alias node if present */
202 alias_node = fdt_path_offset(blob, "/aliases");
205 * start with nothing, and we can assume that the root node can't
208 memset(nodes, '\0', sizeof(nodes));
210 /* First find all the compatible nodes */
211 for (node = count = 0; node >= 0 && count < maxcount;) {
212 node = fdtdec_next_compatible(blob, node, id);
214 nodes[count++] = node;
217 debug("%s: warning: maxcount exceeded with alias '%s'\n",
220 /* Now find all the aliases */
221 for (offset = fdt_first_property_offset(blob, alias_node);
223 offset = fdt_next_property_offset(blob, offset)) {
224 const struct fdt_property *prop;
230 prop = fdt_get_property_by_offset(blob, offset, NULL);
231 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
232 if (prop->len && 0 == strncmp(path, name, name_len))
233 node = fdt_path_offset(blob, prop->data);
237 /* Get the alias number */
238 number = simple_strtoul(path + name_len, NULL, 10);
239 if (number < 0 || number >= maxcount) {
240 debug("%s: warning: alias '%s' is out of range\n",
245 /* Make sure the node we found is actually in our list! */
247 for (j = 0; j < count; j++)
248 if (nodes[j] == node) {
254 debug("%s: warning: alias '%s' points to a node "
255 "'%s' that is missing or is not compatible "
256 " with '%s'\n", __func__, path,
257 fdt_get_name(blob, node, NULL),
263 * Add this node to our list in the right place, and mark
266 if (fdtdec_get_is_enabled(blob, node)) {
267 if (node_list[number]) {
268 debug("%s: warning: alias '%s' requires that "
269 "a node be placed in the list in a "
270 "position which is already filled by "
271 "node '%s'\n", __func__, path,
272 fdt_get_name(blob, node, NULL));
275 node_list[number] = node;
276 if (number >= num_found)
277 num_found = number + 1;
282 /* Add any nodes not mentioned by an alias */
283 for (i = j = 0; i < maxcount; i++) {
285 for (; j < maxcount; j++)
287 fdtdec_get_is_enabled(blob, nodes[j]))
290 /* Have we run out of nodes to add? */
294 assert(!node_list[i]);
295 node_list[i] = nodes[j++];
304 int fdtdec_check_fdt(void)
307 * We must have an FDT, but we cannot panic() yet since the console
308 * is not ready. So for now, just assert(). Boards which need an early
309 * FDT (prior to console ready) will need to make their own
310 * arrangements and do their own checks.
312 assert(!fdtdec_prepare_fdt());
317 * This function is a little odd in that it accesses global data. At some
318 * point if the architecture board.c files merge this will make more sense.
319 * Even now, it is common code.
321 int fdtdec_prepare_fdt(void)
323 if (((uintptr_t)gd->fdt_blob & 3) || fdt_check_header(gd->fdt_blob)) {
324 printf("No valid FDT found - please append one to U-Boot "
325 "binary, use u-boot-dtb.bin or define "
326 "CONFIG_OF_EMBED\n");
332 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
337 debug("%s: %s\n", __func__, prop_name);
338 phandle = fdt_getprop(blob, node, prop_name, NULL);
340 return -FDT_ERR_NOTFOUND;
342 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
347 * Look up a property in a node and check that it has a minimum length.
349 * @param blob FDT blob
350 * @param node node to examine
351 * @param prop_name name of property to find
352 * @param min_len minimum property length in bytes
353 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
354 found, or -FDT_ERR_BADLAYOUT if not enough data
355 * @return pointer to cell, which is only valid if err == 0
357 static const void *get_prop_check_min_len(const void *blob, int node,
358 const char *prop_name, int min_len, int *err)
363 debug("%s: %s\n", __func__, prop_name);
364 cell = fdt_getprop(blob, node, prop_name, &len);
366 *err = -FDT_ERR_NOTFOUND;
367 else if (len < min_len)
368 *err = -FDT_ERR_BADLAYOUT;
374 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
375 u32 *array, int count)
380 debug("%s: %s\n", __func__, prop_name);
381 cell = get_prop_check_min_len(blob, node, prop_name,
382 sizeof(u32) * count, &err);
384 for (i = 0; i < count; i++)
385 array[i] = fdt32_to_cpu(cell[i]);
390 const u32 *fdtdec_locate_array(const void *blob, int node,
391 const char *prop_name, int count)
396 cell = get_prop_check_min_len(blob, node, prop_name,
397 sizeof(u32) * count, &err);
398 return err ? NULL : cell;
401 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
406 debug("%s: %s\n", __func__, prop_name);
407 cell = fdt_getprop(blob, node, prop_name, &len);
412 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
415 * @param blob FDT blob to use
416 * @param node Node to look at
417 * @param prop_name Node property name
418 * @param gpio Array of gpio elements to fill from FDT. This will be
419 * untouched if either 0 or an error is returned
420 * @param max_count Maximum number of elements allowed
421 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
422 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
424 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
425 struct fdt_gpio_state *gpio, int max_count)
427 const struct fdt_property *prop;
432 debug("%s: %s\n", __func__, prop_name);
433 assert(max_count > 0);
434 prop = fdt_get_property(blob, node, prop_name, &len);
436 debug("%s: property '%s' missing\n", __func__, prop_name);
437 return -FDT_ERR_NOTFOUND;
440 /* We will use the name to tag the GPIO */
441 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
442 cell = (u32 *)prop->data;
443 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
444 if (len > max_count) {
445 debug(" %s: too many GPIOs / cells for "
446 "property '%s'\n", __func__, prop_name);
447 return -FDT_ERR_BADLAYOUT;
450 /* Read out the GPIO data from the cells */
451 for (i = 0; i < len; i++, cell += 3) {
452 gpio[i].gpio = fdt32_to_cpu(cell[1]);
453 gpio[i].flags = fdt32_to_cpu(cell[2]);
460 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
461 struct fdt_gpio_state *gpio)
465 debug("%s: %s\n", __func__, prop_name);
466 gpio->gpio = FDT_GPIO_NONE;
468 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
469 return err == 1 ? 0 : err;
472 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
476 if (!fdt_gpio_isvalid(gpio))
479 val = gpio_get_value(gpio->gpio);
480 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
483 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
485 if (!fdt_gpio_isvalid(gpio))
488 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
489 return gpio_set_value(gpio->gpio, val);
492 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
495 * Return success if there is no GPIO defined. This is used for
498 if (!fdt_gpio_isvalid(gpio))
501 if (gpio_request(gpio->gpio, gpio->name))
506 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
507 u8 *array, int count)
512 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
514 memcpy(array, cell, count);
518 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
519 const char *prop_name, int count)
524 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
530 int fdtdec_get_config_int(const void *blob, const char *prop_name,
535 debug("%s: %s\n", __func__, prop_name);
536 config_node = fdt_path_offset(blob, "/config");
539 return fdtdec_get_int(blob, config_node, prop_name, default_val);
542 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
547 debug("%s: %s\n", __func__, prop_name);
548 config_node = fdt_path_offset(blob, "/config");
551 prop = fdt_get_property(blob, config_node, prop_name, NULL);
556 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
562 debug("%s: %s\n", __func__, prop_name);
563 nodeoffset = fdt_path_offset(blob, "/config");
567 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
571 return (char *)nodep;
574 int fdtdec_decode_region(const void *blob, int node,
575 const char *prop_name, void **ptrp, size_t *size)
577 const fdt_addr_t *cell;
580 debug("%s: %s\n", __func__, prop_name);
581 cell = fdt_getprop(blob, node, prop_name, &len);
582 if (!cell || (len != sizeof(fdt_addr_t) * 2))
585 *ptrp = (void *)fdt_addr_to_cpu(*cell);
586 *size = fdt_size_to_cpu(cell[1]);
587 debug("%s: size=%zx\n", __func__, *size);