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