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