]> git.ipfire.org Git - people/ms/u-boot.git/blob - lib/fdtdec.c
aes: Implement AES-128-CBC decryption function
[people/ms/u-boot.git] / lib / fdtdec.c
1 /*
2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
4 */
5
6 #ifndef USE_HOSTCC
7 #include <common.h>
8 #include <serial.h>
9 #include <libfdt.h>
10 #include <fdtdec.h>
11
12 #include <asm/gpio.h>
13
14 DECLARE_GLOBAL_DATA_PTR;
15
16 /*
17 * Here are the type we know about. One day we might allow drivers to
18 * register. For now we just put them here. The COMPAT macro allows us to
19 * turn this into a sparse list later, and keeps the ID with the name.
20 */
21 #define COMPAT(id, name) name
22 static const char * const compat_names[COMPAT_COUNT] = {
23 COMPAT(UNKNOWN, "<none>"),
24 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
25 COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
26 COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
27 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
28 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
29 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
30 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
31 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
32 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
33 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
34 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
35 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
36 COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
37 COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
38 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
39 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
40 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
41 COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
42 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
43 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
44 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
45 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
46 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
47 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
48 COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
49 COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
50 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
51 COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
52 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
53 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
54 COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
55 COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
56 COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
57 COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
58 COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
59 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
60 COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
61 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
62 COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
63 COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
64 COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
65 COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
66 COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
67 };
68
69 const char *fdtdec_get_compatible(enum fdt_compat_id id)
70 {
71 /* We allow reading of the 'unknown' ID for testing purposes */
72 assert(id >= 0 && id < COMPAT_COUNT);
73 return compat_names[id];
74 }
75
76 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
77 const char *prop_name, fdt_size_t *sizep)
78 {
79 const fdt_addr_t *cell;
80 int len;
81
82 debug("%s: %s: ", __func__, prop_name);
83 cell = fdt_getprop(blob, node, prop_name, &len);
84 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
85 len == sizeof(fdt_addr_t) * 2)) {
86 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
87 if (sizep) {
88 const fdt_size_t *size;
89
90 size = (fdt_size_t *)((char *)cell +
91 sizeof(fdt_addr_t));
92 *sizep = fdt_size_to_cpu(*size);
93 debug("addr=%08lx, size=%08x\n",
94 (ulong)addr, *sizep);
95 } else {
96 debug("%08lx\n", (ulong)addr);
97 }
98 return addr;
99 }
100 debug("(not found)\n");
101 return FDT_ADDR_T_NONE;
102 }
103
104 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
105 const char *prop_name)
106 {
107 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
108 }
109
110 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
111 s32 default_val)
112 {
113 const s32 *cell;
114 int len;
115
116 debug("%s: %s: ", __func__, prop_name);
117 cell = fdt_getprop(blob, node, prop_name, &len);
118 if (cell && len >= sizeof(s32)) {
119 s32 val = fdt32_to_cpu(cell[0]);
120
121 debug("%#x (%d)\n", val, val);
122 return val;
123 }
124 debug("(not found)\n");
125 return default_val;
126 }
127
128 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
129 uint64_t default_val)
130 {
131 const uint64_t *cell64;
132 int length;
133
134 cell64 = fdt_getprop(blob, node, prop_name, &length);
135 if (!cell64 || length < sizeof(*cell64))
136 return default_val;
137
138 return fdt64_to_cpu(*cell64);
139 }
140
141 int fdtdec_get_is_enabled(const void *blob, int node)
142 {
143 const char *cell;
144
145 /*
146 * It should say "okay", so only allow that. Some fdts use "ok" but
147 * this is a bug. Please fix your device tree source file. See here
148 * for discussion:
149 *
150 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
151 */
152 cell = fdt_getprop(blob, node, "status", NULL);
153 if (cell)
154 return 0 == strcmp(cell, "okay");
155 return 1;
156 }
157
158 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
159 {
160 enum fdt_compat_id id;
161
162 /* Search our drivers */
163 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
164 if (0 == fdt_node_check_compatible(blob, node,
165 compat_names[id]))
166 return id;
167 return COMPAT_UNKNOWN;
168 }
169
170 int fdtdec_next_compatible(const void *blob, int node,
171 enum fdt_compat_id id)
172 {
173 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
174 }
175
176 int fdtdec_next_compatible_subnode(const void *blob, int node,
177 enum fdt_compat_id id, int *depthp)
178 {
179 do {
180 node = fdt_next_node(blob, node, depthp);
181 } while (*depthp > 1);
182
183 /* If this is a direct subnode, and compatible, return it */
184 if (*depthp == 1 && 0 == fdt_node_check_compatible(
185 blob, node, compat_names[id]))
186 return node;
187
188 return -FDT_ERR_NOTFOUND;
189 }
190
191 int fdtdec_next_alias(const void *blob, const char *name,
192 enum fdt_compat_id id, int *upto)
193 {
194 #define MAX_STR_LEN 20
195 char str[MAX_STR_LEN + 20];
196 int node, err;
197
198 /* snprintf() is not available */
199 assert(strlen(name) < MAX_STR_LEN);
200 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
201 node = fdt_path_offset(blob, str);
202 if (node < 0)
203 return node;
204 err = fdt_node_check_compatible(blob, node, compat_names[id]);
205 if (err < 0)
206 return err;
207 if (err)
208 return -FDT_ERR_NOTFOUND;
209 (*upto)++;
210 return node;
211 }
212
213 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
214 enum fdt_compat_id id, int *node_list, int maxcount)
215 {
216 memset(node_list, '\0', sizeof(*node_list) * maxcount);
217
218 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
219 }
220
221 /* TODO: Can we tighten this code up a little? */
222 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
223 enum fdt_compat_id id, int *node_list, int maxcount)
224 {
225 int name_len = strlen(name);
226 int nodes[maxcount];
227 int num_found = 0;
228 int offset, node;
229 int alias_node;
230 int count;
231 int i, j;
232
233 /* find the alias node if present */
234 alias_node = fdt_path_offset(blob, "/aliases");
235
236 /*
237 * start with nothing, and we can assume that the root node can't
238 * match
239 */
240 memset(nodes, '\0', sizeof(nodes));
241
242 /* First find all the compatible nodes */
243 for (node = count = 0; node >= 0 && count < maxcount;) {
244 node = fdtdec_next_compatible(blob, node, id);
245 if (node >= 0)
246 nodes[count++] = node;
247 }
248 if (node >= 0)
249 debug("%s: warning: maxcount exceeded with alias '%s'\n",
250 __func__, name);
251
252 /* Now find all the aliases */
253 for (offset = fdt_first_property_offset(blob, alias_node);
254 offset > 0;
255 offset = fdt_next_property_offset(blob, offset)) {
256 const struct fdt_property *prop;
257 const char *path;
258 int number;
259 int found;
260
261 node = 0;
262 prop = fdt_get_property_by_offset(blob, offset, NULL);
263 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
264 if (prop->len && 0 == strncmp(path, name, name_len))
265 node = fdt_path_offset(blob, prop->data);
266 if (node <= 0)
267 continue;
268
269 /* Get the alias number */
270 number = simple_strtoul(path + name_len, NULL, 10);
271 if (number < 0 || number >= maxcount) {
272 debug("%s: warning: alias '%s' is out of range\n",
273 __func__, path);
274 continue;
275 }
276
277 /* Make sure the node we found is actually in our list! */
278 found = -1;
279 for (j = 0; j < count; j++)
280 if (nodes[j] == node) {
281 found = j;
282 break;
283 }
284
285 if (found == -1) {
286 debug("%s: warning: alias '%s' points to a node "
287 "'%s' that is missing or is not compatible "
288 " with '%s'\n", __func__, path,
289 fdt_get_name(blob, node, NULL),
290 compat_names[id]);
291 continue;
292 }
293
294 /*
295 * Add this node to our list in the right place, and mark
296 * it as done.
297 */
298 if (fdtdec_get_is_enabled(blob, node)) {
299 if (node_list[number]) {
300 debug("%s: warning: alias '%s' requires that "
301 "a node be placed in the list in a "
302 "position which is already filled by "
303 "node '%s'\n", __func__, path,
304 fdt_get_name(blob, node, NULL));
305 continue;
306 }
307 node_list[number] = node;
308 if (number >= num_found)
309 num_found = number + 1;
310 }
311 nodes[found] = 0;
312 }
313
314 /* Add any nodes not mentioned by an alias */
315 for (i = j = 0; i < maxcount; i++) {
316 if (!node_list[i]) {
317 for (; j < maxcount; j++)
318 if (nodes[j] &&
319 fdtdec_get_is_enabled(blob, nodes[j]))
320 break;
321
322 /* Have we run out of nodes to add? */
323 if (j == maxcount)
324 break;
325
326 assert(!node_list[i]);
327 node_list[i] = nodes[j++];
328 if (i >= num_found)
329 num_found = i + 1;
330 }
331 }
332
333 return num_found;
334 }
335
336 int fdtdec_check_fdt(void)
337 {
338 /*
339 * We must have an FDT, but we cannot panic() yet since the console
340 * is not ready. So for now, just assert(). Boards which need an early
341 * FDT (prior to console ready) will need to make their own
342 * arrangements and do their own checks.
343 */
344 assert(!fdtdec_prepare_fdt());
345 return 0;
346 }
347
348 /*
349 * This function is a little odd in that it accesses global data. At some
350 * point if the architecture board.c files merge this will make more sense.
351 * Even now, it is common code.
352 */
353 int fdtdec_prepare_fdt(void)
354 {
355 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
356 fdt_check_header(gd->fdt_blob)) {
357 printf("No valid FDT found - please append one to U-Boot "
358 "binary, use u-boot-dtb.bin or define "
359 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
360 return -1;
361 }
362 return 0;
363 }
364
365 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
366 {
367 const u32 *phandle;
368 int lookup;
369
370 debug("%s: %s\n", __func__, prop_name);
371 phandle = fdt_getprop(blob, node, prop_name, NULL);
372 if (!phandle)
373 return -FDT_ERR_NOTFOUND;
374
375 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
376 return lookup;
377 }
378
379 /**
380 * Look up a property in a node and check that it has a minimum length.
381 *
382 * @param blob FDT blob
383 * @param node node to examine
384 * @param prop_name name of property to find
385 * @param min_len minimum property length in bytes
386 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
387 found, or -FDT_ERR_BADLAYOUT if not enough data
388 * @return pointer to cell, which is only valid if err == 0
389 */
390 static const void *get_prop_check_min_len(const void *blob, int node,
391 const char *prop_name, int min_len, int *err)
392 {
393 const void *cell;
394 int len;
395
396 debug("%s: %s\n", __func__, prop_name);
397 cell = fdt_getprop(blob, node, prop_name, &len);
398 if (!cell)
399 *err = -FDT_ERR_NOTFOUND;
400 else if (len < min_len)
401 *err = -FDT_ERR_BADLAYOUT;
402 else
403 *err = 0;
404 return cell;
405 }
406
407 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
408 u32 *array, int count)
409 {
410 const u32 *cell;
411 int i, err = 0;
412
413 debug("%s: %s\n", __func__, prop_name);
414 cell = get_prop_check_min_len(blob, node, prop_name,
415 sizeof(u32) * count, &err);
416 if (!err) {
417 for (i = 0; i < count; i++)
418 array[i] = fdt32_to_cpu(cell[i]);
419 }
420 return err;
421 }
422
423 const u32 *fdtdec_locate_array(const void *blob, int node,
424 const char *prop_name, int count)
425 {
426 const u32 *cell;
427 int err;
428
429 cell = get_prop_check_min_len(blob, node, prop_name,
430 sizeof(u32) * count, &err);
431 return err ? NULL : cell;
432 }
433
434 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
435 {
436 const s32 *cell;
437 int len;
438
439 debug("%s: %s\n", __func__, prop_name);
440 cell = fdt_getprop(blob, node, prop_name, &len);
441 return cell != NULL;
442 }
443
444 /**
445 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
446 * terminating item.
447 *
448 * @param blob FDT blob to use
449 * @param node Node to look at
450 * @param prop_name Node property name
451 * @param gpio Array of gpio elements to fill from FDT. This will be
452 * untouched if either 0 or an error is returned
453 * @param max_count Maximum number of elements allowed
454 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
455 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
456 */
457 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
458 struct fdt_gpio_state *gpio, int max_count)
459 {
460 const struct fdt_property *prop;
461 const u32 *cell;
462 const char *name;
463 int len, i;
464
465 debug("%s: %s\n", __func__, prop_name);
466 assert(max_count > 0);
467 prop = fdt_get_property(blob, node, prop_name, &len);
468 if (!prop) {
469 debug("%s: property '%s' missing\n", __func__, prop_name);
470 return -FDT_ERR_NOTFOUND;
471 }
472
473 /* We will use the name to tag the GPIO */
474 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
475 cell = (u32 *)prop->data;
476 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
477 if (len > max_count) {
478 debug(" %s: too many GPIOs / cells for "
479 "property '%s'\n", __func__, prop_name);
480 return -FDT_ERR_BADLAYOUT;
481 }
482
483 /* Read out the GPIO data from the cells */
484 for (i = 0; i < len; i++, cell += 3) {
485 gpio[i].gpio = fdt32_to_cpu(cell[1]);
486 gpio[i].flags = fdt32_to_cpu(cell[2]);
487 gpio[i].name = name;
488 }
489
490 return len;
491 }
492
493 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
494 struct fdt_gpio_state *gpio)
495 {
496 int err;
497
498 debug("%s: %s\n", __func__, prop_name);
499 gpio->gpio = FDT_GPIO_NONE;
500 gpio->name = NULL;
501 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
502 return err == 1 ? 0 : err;
503 }
504
505 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
506 {
507 int val;
508
509 if (!fdt_gpio_isvalid(gpio))
510 return -1;
511
512 val = gpio_get_value(gpio->gpio);
513 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
514 }
515
516 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
517 {
518 if (!fdt_gpio_isvalid(gpio))
519 return -1;
520
521 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
522 return gpio_set_value(gpio->gpio, val);
523 }
524
525 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
526 {
527 /*
528 * Return success if there is no GPIO defined. This is used for
529 * optional GPIOs)
530 */
531 if (!fdt_gpio_isvalid(gpio))
532 return 0;
533
534 if (gpio_request(gpio->gpio, gpio->name))
535 return -1;
536 return 0;
537 }
538
539 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
540 u8 *array, int count)
541 {
542 const u8 *cell;
543 int err;
544
545 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
546 if (!err)
547 memcpy(array, cell, count);
548 return err;
549 }
550
551 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
552 const char *prop_name, int count)
553 {
554 const u8 *cell;
555 int err;
556
557 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
558 if (err)
559 return NULL;
560 return cell;
561 }
562
563 int fdtdec_get_config_int(const void *blob, const char *prop_name,
564 int default_val)
565 {
566 int config_node;
567
568 debug("%s: %s\n", __func__, prop_name);
569 config_node = fdt_path_offset(blob, "/config");
570 if (config_node < 0)
571 return default_val;
572 return fdtdec_get_int(blob, config_node, prop_name, default_val);
573 }
574
575 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
576 {
577 int config_node;
578 const void *prop;
579
580 debug("%s: %s\n", __func__, prop_name);
581 config_node = fdt_path_offset(blob, "/config");
582 if (config_node < 0)
583 return 0;
584 prop = fdt_get_property(blob, config_node, prop_name, NULL);
585
586 return prop != NULL;
587 }
588
589 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
590 {
591 const char *nodep;
592 int nodeoffset;
593 int len;
594
595 debug("%s: %s\n", __func__, prop_name);
596 nodeoffset = fdt_path_offset(blob, "/config");
597 if (nodeoffset < 0)
598 return NULL;
599
600 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
601 if (!nodep)
602 return NULL;
603
604 return (char *)nodep;
605 }
606
607 int fdtdec_decode_region(const void *blob, int node,
608 const char *prop_name, void **ptrp, size_t *size)
609 {
610 const fdt_addr_t *cell;
611 int len;
612
613 debug("%s: %s\n", __func__, prop_name);
614 cell = fdt_getprop(blob, node, prop_name, &len);
615 if (!cell || (len != sizeof(fdt_addr_t) * 2))
616 return -1;
617
618 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
619 *size = fdt_size_to_cpu(cell[1]);
620 debug("%s: size=%zx\n", __func__, *size);
621 return 0;
622 }
623
624 /**
625 * Read a flash entry from the fdt
626 *
627 * @param blob FDT blob
628 * @param node Offset of node to read
629 * @param name Name of node being read
630 * @param entry Place to put offset and size of this node
631 * @return 0 if ok, -ve on error
632 */
633 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
634 struct fmap_entry *entry)
635 {
636 u32 reg[2];
637
638 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
639 debug("Node '%s' has bad/missing 'reg' property\n", name);
640 return -FDT_ERR_NOTFOUND;
641 }
642 entry->offset = reg[0];
643 entry->length = reg[1];
644
645 return 0;
646 }
647 #else
648 #include "libfdt.h"
649 #include "fdt_support.h"
650
651 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
652 int default_val)
653 {
654 const int *cell;
655 int len;
656
657 cell = fdt_getprop_w((void *)blob, node, prop_name, &len);
658 if (cell && len >= sizeof(int)) {
659 int val = fdt32_to_cpu(cell[0]);
660
661 return val;
662 }
663 return default_val;
664 }
665 #endif