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