]> git.ipfire.org Git - people/ms/u-boot.git/blob - lib/fdtdec.c
fdtdec: Add compatible string for High speed i2c
[people/ms/u-boot.git] / lib / fdtdec.c
1 /*
2 * Copyright (c) 2011 The Chromium OS Authors.
3 * See file CREDITS for list of people who contributed to this
4 * project.
5 *
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.
10 *
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.
15 *
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,
19 * MA 02111-1307 USA
20 */
21
22 #include <common.h>
23 #include <serial.h>
24 #include <libfdt.h>
25 #include <fdtdec.h>
26
27 #include <asm/gpio.h>
28
29 DECLARE_GLOBAL_DATA_PTR;
30
31 /*
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.
35 */
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"),
77 };
78
79 const char *fdtdec_get_compatible(enum fdt_compat_id id)
80 {
81 /* We allow reading of the 'unknown' ID for testing purposes */
82 assert(id >= 0 && id < COMPAT_COUNT);
83 return compat_names[id];
84 }
85
86 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
87 const char *prop_name, fdt_size_t *sizep)
88 {
89 const fdt_addr_t *cell;
90 int len;
91
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);
97 if (sizep) {
98 const fdt_size_t *size;
99
100 size = (fdt_size_t *)((char *)cell +
101 sizeof(fdt_addr_t));
102 *sizep = fdt_size_to_cpu(*size);
103 debug("addr=%p, size=%p\n", (void *)addr,
104 (void *)*sizep);
105 } else {
106 debug("%p\n", (void *)addr);
107 }
108 return addr;
109 }
110 debug("(not found)\n");
111 return FDT_ADDR_T_NONE;
112 }
113
114 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
115 const char *prop_name)
116 {
117 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
118 }
119
120 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
121 s32 default_val)
122 {
123 const s32 *cell;
124 int len;
125
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]);
130
131 debug("%#x (%d)\n", val, val);
132 return val;
133 }
134 debug("(not found)\n");
135 return default_val;
136 }
137
138 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
139 uint64_t default_val)
140 {
141 const uint64_t *cell64;
142 int length;
143
144 cell64 = fdt_getprop(blob, node, prop_name, &length);
145 if (!cell64 || length < sizeof(*cell64))
146 return default_val;
147
148 return fdt64_to_cpu(*cell64);
149 }
150
151 int fdtdec_get_is_enabled(const void *blob, int node)
152 {
153 const char *cell;
154
155 /*
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
158 * for discussion:
159 *
160 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
161 */
162 cell = fdt_getprop(blob, node, "status", NULL);
163 if (cell)
164 return 0 == strcmp(cell, "okay");
165 return 1;
166 }
167
168 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
169 {
170 enum fdt_compat_id id;
171
172 /* Search our drivers */
173 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
174 if (0 == fdt_node_check_compatible(blob, node,
175 compat_names[id]))
176 return id;
177 return COMPAT_UNKNOWN;
178 }
179
180 int fdtdec_next_compatible(const void *blob, int node,
181 enum fdt_compat_id id)
182 {
183 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
184 }
185
186 int fdtdec_next_compatible_subnode(const void *blob, int node,
187 enum fdt_compat_id id, int *depthp)
188 {
189 do {
190 node = fdt_next_node(blob, node, depthp);
191 } while (*depthp > 1);
192
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]))
196 return node;
197
198 return -FDT_ERR_NOTFOUND;
199 }
200
201 int fdtdec_next_alias(const void *blob, const char *name,
202 enum fdt_compat_id id, int *upto)
203 {
204 #define MAX_STR_LEN 20
205 char str[MAX_STR_LEN + 20];
206 int node, err;
207
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);
212 if (node < 0)
213 return node;
214 err = fdt_node_check_compatible(blob, node, compat_names[id]);
215 if (err < 0)
216 return err;
217 if (err)
218 return -FDT_ERR_NOTFOUND;
219 (*upto)++;
220 return node;
221 }
222
223 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
224 enum fdt_compat_id id, int *node_list, int maxcount)
225 {
226 memset(node_list, '\0', sizeof(*node_list) * maxcount);
227
228 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
229 }
230
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)
234 {
235 int name_len = strlen(name);
236 int nodes[maxcount];
237 int num_found = 0;
238 int offset, node;
239 int alias_node;
240 int count;
241 int i, j;
242
243 /* find the alias node if present */
244 alias_node = fdt_path_offset(blob, "/aliases");
245
246 /*
247 * start with nothing, and we can assume that the root node can't
248 * match
249 */
250 memset(nodes, '\0', sizeof(nodes));
251
252 /* First find all the compatible nodes */
253 for (node = count = 0; node >= 0 && count < maxcount;) {
254 node = fdtdec_next_compatible(blob, node, id);
255 if (node >= 0)
256 nodes[count++] = node;
257 }
258 if (node >= 0)
259 debug("%s: warning: maxcount exceeded with alias '%s'\n",
260 __func__, name);
261
262 /* Now find all the aliases */
263 for (offset = fdt_first_property_offset(blob, alias_node);
264 offset > 0;
265 offset = fdt_next_property_offset(blob, offset)) {
266 const struct fdt_property *prop;
267 const char *path;
268 int number;
269 int found;
270
271 node = 0;
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);
276 if (node <= 0)
277 continue;
278
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",
283 __func__, path);
284 continue;
285 }
286
287 /* Make sure the node we found is actually in our list! */
288 found = -1;
289 for (j = 0; j < count; j++)
290 if (nodes[j] == node) {
291 found = j;
292 break;
293 }
294
295 if (found == -1) {
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),
300 compat_names[id]);
301 continue;
302 }
303
304 /*
305 * Add this node to our list in the right place, and mark
306 * it as done.
307 */
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));
315 continue;
316 }
317 node_list[number] = node;
318 if (number >= num_found)
319 num_found = number + 1;
320 }
321 nodes[found] = 0;
322 }
323
324 /* Add any nodes not mentioned by an alias */
325 for (i = j = 0; i < maxcount; i++) {
326 if (!node_list[i]) {
327 for (; j < maxcount; j++)
328 if (nodes[j] &&
329 fdtdec_get_is_enabled(blob, nodes[j]))
330 break;
331
332 /* Have we run out of nodes to add? */
333 if (j == maxcount)
334 break;
335
336 assert(!node_list[i]);
337 node_list[i] = nodes[j++];
338 if (i >= num_found)
339 num_found = i + 1;
340 }
341 }
342
343 return num_found;
344 }
345
346 int fdtdec_check_fdt(void)
347 {
348 /*
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.
353 */
354 assert(!fdtdec_prepare_fdt());
355 return 0;
356 }
357
358 /*
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.
362 */
363 int fdtdec_prepare_fdt(void)
364 {
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");
370 return -1;
371 }
372 return 0;
373 }
374
375 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
376 {
377 const u32 *phandle;
378 int lookup;
379
380 debug("%s: %s\n", __func__, prop_name);
381 phandle = fdt_getprop(blob, node, prop_name, NULL);
382 if (!phandle)
383 return -FDT_ERR_NOTFOUND;
384
385 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
386 return lookup;
387 }
388
389 /**
390 * Look up a property in a node and check that it has a minimum length.
391 *
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
399 */
400 static const void *get_prop_check_min_len(const void *blob, int node,
401 const char *prop_name, int min_len, int *err)
402 {
403 const void *cell;
404 int len;
405
406 debug("%s: %s\n", __func__, prop_name);
407 cell = fdt_getprop(blob, node, prop_name, &len);
408 if (!cell)
409 *err = -FDT_ERR_NOTFOUND;
410 else if (len < min_len)
411 *err = -FDT_ERR_BADLAYOUT;
412 else
413 *err = 0;
414 return cell;
415 }
416
417 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
418 u32 *array, int count)
419 {
420 const u32 *cell;
421 int i, err = 0;
422
423 debug("%s: %s\n", __func__, prop_name);
424 cell = get_prop_check_min_len(blob, node, prop_name,
425 sizeof(u32) * count, &err);
426 if (!err) {
427 for (i = 0; i < count; i++)
428 array[i] = fdt32_to_cpu(cell[i]);
429 }
430 return err;
431 }
432
433 const u32 *fdtdec_locate_array(const void *blob, int node,
434 const char *prop_name, int count)
435 {
436 const u32 *cell;
437 int err;
438
439 cell = get_prop_check_min_len(blob, node, prop_name,
440 sizeof(u32) * count, &err);
441 return err ? NULL : cell;
442 }
443
444 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
445 {
446 const s32 *cell;
447 int len;
448
449 debug("%s: %s\n", __func__, prop_name);
450 cell = fdt_getprop(blob, node, prop_name, &len);
451 return cell != NULL;
452 }
453
454 /**
455 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
456 * terminating item.
457 *
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.
466 */
467 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
468 struct fdt_gpio_state *gpio, int max_count)
469 {
470 const struct fdt_property *prop;
471 const u32 *cell;
472 const char *name;
473 int len, i;
474
475 debug("%s: %s\n", __func__, prop_name);
476 assert(max_count > 0);
477 prop = fdt_get_property(blob, node, prop_name, &len);
478 if (!prop) {
479 debug("%s: property '%s' missing\n", __func__, prop_name);
480 return -FDT_ERR_NOTFOUND;
481 }
482
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;
491 }
492
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]);
497 gpio[i].name = name;
498 }
499
500 return len;
501 }
502
503 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
504 struct fdt_gpio_state *gpio)
505 {
506 int err;
507
508 debug("%s: %s\n", __func__, prop_name);
509 gpio->gpio = FDT_GPIO_NONE;
510 gpio->name = NULL;
511 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
512 return err == 1 ? 0 : err;
513 }
514
515 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
516 {
517 int val;
518
519 if (!fdt_gpio_isvalid(gpio))
520 return -1;
521
522 val = gpio_get_value(gpio->gpio);
523 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
524 }
525
526 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
527 {
528 if (!fdt_gpio_isvalid(gpio))
529 return -1;
530
531 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
532 return gpio_set_value(gpio->gpio, val);
533 }
534
535 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
536 {
537 /*
538 * Return success if there is no GPIO defined. This is used for
539 * optional GPIOs)
540 */
541 if (!fdt_gpio_isvalid(gpio))
542 return 0;
543
544 if (gpio_request(gpio->gpio, gpio->name))
545 return -1;
546 return 0;
547 }
548
549 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
550 u8 *array, int count)
551 {
552 const u8 *cell;
553 int err;
554
555 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
556 if (!err)
557 memcpy(array, cell, count);
558 return err;
559 }
560
561 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
562 const char *prop_name, int count)
563 {
564 const u8 *cell;
565 int err;
566
567 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
568 if (err)
569 return NULL;
570 return cell;
571 }
572
573 int fdtdec_get_config_int(const void *blob, const char *prop_name,
574 int default_val)
575 {
576 int config_node;
577
578 debug("%s: %s\n", __func__, prop_name);
579 config_node = fdt_path_offset(blob, "/config");
580 if (config_node < 0)
581 return default_val;
582 return fdtdec_get_int(blob, config_node, prop_name, default_val);
583 }
584
585 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
586 {
587 int config_node;
588 const void *prop;
589
590 debug("%s: %s\n", __func__, prop_name);
591 config_node = fdt_path_offset(blob, "/config");
592 if (config_node < 0)
593 return 0;
594 prop = fdt_get_property(blob, config_node, prop_name, NULL);
595
596 return prop != NULL;
597 }
598
599 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
600 {
601 const char *nodep;
602 int nodeoffset;
603 int len;
604
605 debug("%s: %s\n", __func__, prop_name);
606 nodeoffset = fdt_path_offset(blob, "/config");
607 if (nodeoffset < 0)
608 return NULL;
609
610 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
611 if (!nodep)
612 return NULL;
613
614 return (char *)nodep;
615 }
616
617 int fdtdec_decode_region(const void *blob, int node,
618 const char *prop_name, void **ptrp, size_t *size)
619 {
620 const fdt_addr_t *cell;
621 int len;
622
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))
626 return -1;
627
628 *ptrp = (void *)fdt_addr_to_cpu(*cell);
629 *size = fdt_size_to_cpu(cell[1]);
630 debug("%s: size=%zx\n", __func__, *size);
631 return 0;
632 }