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