]>
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_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"),
48 const char *fdtdec_get_compatible(enum fdt_compat_id id
)
50 /* We allow reading of the 'unknown' ID for testing purposes */
51 assert(id
>= 0 && id
< COMPAT_COUNT
);
52 return compat_names
[id
];
56 * Look in the FDT for an alias with the given name and return its node.
58 * @param blob FDT blob
59 * @param name alias name to look up
60 * @return node offset if found, or an error code < 0 otherwise
62 static int find_alias_node(const void *blob
, const char *name
)
67 debug("find_alias_node: %s\n", name
);
68 alias_node
= fdt_path_offset(blob
, "/aliases");
71 path
= fdt_getprop(blob
, alias_node
, name
, NULL
);
73 return -FDT_ERR_NOTFOUND
;
74 return fdt_path_offset(blob
, path
);
77 fdt_addr_t
fdtdec_get_addr(const void *blob
, int node
,
78 const char *prop_name
)
80 const fdt_addr_t
*cell
;
83 debug("%s: %s: ", __func__
, prop_name
);
84 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
85 if (cell
&& (len
== sizeof(fdt_addr_t
) ||
86 len
== sizeof(fdt_addr_t
) * 2)) {
87 fdt_addr_t addr
= fdt_addr_to_cpu(*cell
);
89 debug("%p\n", (void *)addr
);
92 debug("(not found)\n");
93 return FDT_ADDR_T_NONE
;
96 s32
fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
102 debug("%s: %s: ", __func__
, prop_name
);
103 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
104 if (cell
&& len
>= sizeof(s32
)) {
105 s32 val
= fdt32_to_cpu(cell
[0]);
107 debug("%#x (%d)\n", val
, val
);
110 debug("(not found)\n");
114 int fdtdec_get_is_enabled(const void *blob
, int node
)
119 * It should say "okay", so only allow that. Some fdts use "ok" but
120 * this is a bug. Please fix your device tree source file. See here
123 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
125 cell
= fdt_getprop(blob
, node
, "status", NULL
);
127 return 0 == strcmp(cell
, "okay");
131 enum fdt_compat_id
fd_dec_lookup(const void *blob
, int node
)
133 enum fdt_compat_id id
;
135 /* Search our drivers */
136 for (id
= COMPAT_UNKNOWN
; id
< COMPAT_COUNT
; id
++)
137 if (0 == fdt_node_check_compatible(blob
, node
,
140 return COMPAT_UNKNOWN
;
143 int fdtdec_next_compatible(const void *blob
, int node
,
144 enum fdt_compat_id id
)
146 return fdt_node_offset_by_compatible(blob
, node
, compat_names
[id
]);
149 int fdtdec_next_compatible_subnode(const void *blob
, int node
,
150 enum fdt_compat_id id
, int *depthp
)
153 node
= fdt_next_node(blob
, node
, depthp
);
154 } while (*depthp
> 1);
156 /* If this is a direct subnode, and compatible, return it */
157 if (*depthp
== 1 && 0 == fdt_node_check_compatible(
158 blob
, node
, compat_names
[id
]))
161 return -FDT_ERR_NOTFOUND
;
164 int fdtdec_next_alias(const void *blob
, const char *name
,
165 enum fdt_compat_id id
, int *upto
)
167 #define MAX_STR_LEN 20
168 char str
[MAX_STR_LEN
+ 20];
171 /* snprintf() is not available */
172 assert(strlen(name
) < MAX_STR_LEN
);
173 sprintf(str
, "%.*s%d", MAX_STR_LEN
, name
, *upto
);
174 node
= find_alias_node(blob
, str
);
177 err
= fdt_node_check_compatible(blob
, node
, compat_names
[id
]);
181 return -FDT_ERR_NOTFOUND
;
186 int fdtdec_find_aliases_for_id(const void *blob
, const char *name
,
187 enum fdt_compat_id id
, int *node_list
, int maxcount
)
189 memset(node_list
, '\0', sizeof(*node_list
) * maxcount
);
191 return fdtdec_add_aliases_for_id(blob
, name
, id
, node_list
, maxcount
);
194 /* TODO: Can we tighten this code up a little? */
195 int fdtdec_add_aliases_for_id(const void *blob
, const char *name
,
196 enum fdt_compat_id id
, int *node_list
, int maxcount
)
198 int name_len
= strlen(name
);
206 /* find the alias node if present */
207 alias_node
= fdt_path_offset(blob
, "/aliases");
210 * start with nothing, and we can assume that the root node can't
213 memset(nodes
, '\0', sizeof(nodes
));
215 /* First find all the compatible nodes */
216 for (node
= count
= 0; node
>= 0 && count
< maxcount
;) {
217 node
= fdtdec_next_compatible(blob
, node
, id
);
219 nodes
[count
++] = node
;
222 debug("%s: warning: maxcount exceeded with alias '%s'\n",
225 /* Now find all the aliases */
226 for (offset
= fdt_first_property_offset(blob
, alias_node
);
228 offset
= fdt_next_property_offset(blob
, offset
)) {
229 const struct fdt_property
*prop
;
235 prop
= fdt_get_property_by_offset(blob
, offset
, NULL
);
236 path
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
237 if (prop
->len
&& 0 == strncmp(path
, name
, name_len
))
238 node
= fdt_path_offset(blob
, prop
->data
);
242 /* Get the alias number */
243 number
= simple_strtoul(path
+ name_len
, NULL
, 10);
244 if (number
< 0 || number
>= maxcount
) {
245 debug("%s: warning: alias '%s' is out of range\n",
250 /* Make sure the node we found is actually in our list! */
252 for (j
= 0; j
< count
; j
++)
253 if (nodes
[j
] == node
) {
259 debug("%s: warning: alias '%s' points to a node "
260 "'%s' that is missing or is not compatible "
261 " with '%s'\n", __func__
, path
,
262 fdt_get_name(blob
, node
, NULL
),
268 * Add this node to our list in the right place, and mark
271 if (fdtdec_get_is_enabled(blob
, node
)) {
272 if (node_list
[number
]) {
273 debug("%s: warning: alias '%s' requires that "
274 "a node be placed in the list in a "
275 "position which is already filled by "
276 "node '%s'\n", __func__
, path
,
277 fdt_get_name(blob
, node
, NULL
));
280 node_list
[number
] = node
;
281 if (number
>= num_found
)
282 num_found
= number
+ 1;
287 /* Add any nodes not mentioned by an alias */
288 for (i
= j
= 0; i
< maxcount
; i
++) {
290 for (; j
< maxcount
; j
++)
292 fdtdec_get_is_enabled(blob
, nodes
[j
]))
295 /* Have we run out of nodes to add? */
299 assert(!node_list
[i
]);
300 node_list
[i
] = nodes
[j
++];
309 int fdtdec_check_fdt(void)
312 * We must have an FDT, but we cannot panic() yet since the console
313 * is not ready. So for now, just assert(). Boards which need an early
314 * FDT (prior to console ready) will need to make their own
315 * arrangements and do their own checks.
317 assert(!fdtdec_prepare_fdt());
322 * This function is a little odd in that it accesses global data. At some
323 * point if the architecture board.c files merge this will make more sense.
324 * Even now, it is common code.
326 int fdtdec_prepare_fdt(void)
328 if (((uintptr_t)gd
->fdt_blob
& 3) || fdt_check_header(gd
->fdt_blob
)) {
329 printf("No valid FDT found - please append one to U-Boot "
330 "binary, use u-boot-dtb.bin or define "
331 "CONFIG_OF_EMBED\n");
337 int fdtdec_lookup_phandle(const void *blob
, int node
, const char *prop_name
)
342 debug("%s: %s\n", __func__
, prop_name
);
343 phandle
= fdt_getprop(blob
, node
, prop_name
, NULL
);
345 return -FDT_ERR_NOTFOUND
;
347 lookup
= fdt_node_offset_by_phandle(blob
, fdt32_to_cpu(*phandle
));
352 * Look up a property in a node and check that it has a minimum length.
354 * @param blob FDT blob
355 * @param node node to examine
356 * @param prop_name name of property to find
357 * @param min_len minimum property length in bytes
358 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
359 found, or -FDT_ERR_BADLAYOUT if not enough data
360 * @return pointer to cell, which is only valid if err == 0
362 static const void *get_prop_check_min_len(const void *blob
, int node
,
363 const char *prop_name
, int min_len
, int *err
)
368 debug("%s: %s\n", __func__
, prop_name
);
369 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
371 *err
= -FDT_ERR_NOTFOUND
;
372 else if (len
< min_len
)
373 *err
= -FDT_ERR_BADLAYOUT
;
379 int fdtdec_get_int_array(const void *blob
, int node
, const char *prop_name
,
380 u32
*array
, int count
)
385 debug("%s: %s\n", __func__
, prop_name
);
386 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
387 sizeof(u32
) * count
, &err
);
389 for (i
= 0; i
< count
; i
++)
390 array
[i
] = fdt32_to_cpu(cell
[i
]);
395 const u32
*fdtdec_locate_array(const void *blob
, int node
,
396 const char *prop_name
, int count
)
401 cell
= get_prop_check_min_len(blob
, node
, prop_name
,
402 sizeof(u32
) * count
, &err
);
403 return err
? NULL
: cell
;
406 int fdtdec_get_bool(const void *blob
, int node
, const char *prop_name
)
411 debug("%s: %s\n", __func__
, prop_name
);
412 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
417 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
420 * @param blob FDT blob to use
421 * @param node Node to look at
422 * @param prop_name Node property name
423 * @param gpio Array of gpio elements to fill from FDT. This will be
424 * untouched if either 0 or an error is returned
425 * @param max_count Maximum number of elements allowed
426 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
427 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
429 int fdtdec_decode_gpios(const void *blob
, int node
, const char *prop_name
,
430 struct fdt_gpio_state
*gpio
, int max_count
)
432 const struct fdt_property
*prop
;
437 debug("%s: %s\n", __func__
, prop_name
);
438 assert(max_count
> 0);
439 prop
= fdt_get_property(blob
, node
, prop_name
, &len
);
441 debug("%s: property '%s' missing\n", __func__
, prop_name
);
442 return -FDT_ERR_NOTFOUND
;
445 /* We will use the name to tag the GPIO */
446 name
= fdt_string(blob
, fdt32_to_cpu(prop
->nameoff
));
447 cell
= (u32
*)prop
->data
;
448 len
/= sizeof(u32
) * 3; /* 3 cells per GPIO record */
449 if (len
> max_count
) {
450 debug(" %s: too many GPIOs / cells for "
451 "property '%s'\n", __func__
, prop_name
);
452 return -FDT_ERR_BADLAYOUT
;
455 /* Read out the GPIO data from the cells */
456 for (i
= 0; i
< len
; i
++, cell
+= 3) {
457 gpio
[i
].gpio
= fdt32_to_cpu(cell
[1]);
458 gpio
[i
].flags
= fdt32_to_cpu(cell
[2]);
465 int fdtdec_decode_gpio(const void *blob
, int node
, const char *prop_name
,
466 struct fdt_gpio_state
*gpio
)
470 debug("%s: %s\n", __func__
, prop_name
);
471 gpio
->gpio
= FDT_GPIO_NONE
;
473 err
= fdtdec_decode_gpios(blob
, node
, prop_name
, gpio
, 1);
474 return err
== 1 ? 0 : err
;
477 int fdtdec_setup_gpio(struct fdt_gpio_state
*gpio
)
480 * Return success if there is no GPIO defined. This is used for
483 if (!fdt_gpio_isvalid(gpio
))
486 if (gpio_request(gpio
->gpio
, gpio
->name
))
491 int fdtdec_get_byte_array(const void *blob
, int node
, const char *prop_name
,
492 u8
*array
, int count
)
497 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
499 memcpy(array
, cell
, count
);
503 const u8
*fdtdec_locate_byte_array(const void *blob
, int node
,
504 const char *prop_name
, int count
)
509 cell
= get_prop_check_min_len(blob
, node
, prop_name
, count
, &err
);
515 int fdtdec_get_config_int(const void *blob
, const char *prop_name
,
520 debug("%s: %s\n", __func__
, prop_name
);
521 config_node
= fdt_path_offset(blob
, "/config");
524 return fdtdec_get_int(blob
, config_node
, prop_name
, default_val
);
527 char *fdtdec_get_config_string(const void *blob
, const char *prop_name
)
533 debug("%s: %s\n", __func__
, prop_name
);
534 nodeoffset
= fdt_path_offset(blob
, "/config");
538 nodep
= fdt_getprop(blob
, nodeoffset
, prop_name
, &len
);
542 return (char *)nodep
;
545 int fdtdec_decode_region(const void *blob
, int node
,
546 const char *prop_name
, void **ptrp
, size_t *size
)
548 const fdt_addr_t
*cell
;
551 debug("%s: %s\n", __func__
, prop_name
);
552 cell
= fdt_getprop(blob
, node
, prop_name
, &len
);
553 if (!cell
|| (len
!= sizeof(fdt_addr_t
) * 2))
556 *ptrp
= (void *)fdt_addr_to_cpu(*cell
);
557 *size
= fdt_size_to_cpu(cell
[1]);
558 debug("%s: size=%zx\n", __func__
, *size
);