1 /* 2 * Copyright (c) 2011 The Chromium OS Authors. 3 * SPDX-License-Identifier: GPL-2.0+ 4 */ 5 6 #ifndef __fdtdec_h 7 #define __fdtdec_h 8 9 /* 10 * This file contains convenience functions for decoding useful and 11 * enlightening information from FDTs. It is intended to be used by device 12 * drivers and board-specific code within U-Boot. It aims to reduce the 13 * amount of FDT munging required within U-Boot itself, so that driver code 14 * changes to support FDT are minimized. 15 */ 16 17 #include <libfdt.h> 18 19 /* 20 * A typedef for a physical address. Note that fdt data is always big 21 * endian even on a litle endian machine. 22 */ 23 #ifdef CONFIG_PHYS_64BIT 24 typedef u64 fdt_addr_t; 25 typedef u64 fdt_size_t; 26 #define FDT_ADDR_T_NONE (-1ULL) 27 #define fdt_addr_to_cpu(reg) be64_to_cpu(reg) 28 #define fdt_size_to_cpu(reg) be64_to_cpu(reg) 29 #else 30 typedef u32 fdt_addr_t; 31 typedef u32 fdt_size_t; 32 #define FDT_ADDR_T_NONE (-1U) 33 #define fdt_addr_to_cpu(reg) be32_to_cpu(reg) 34 #define fdt_size_to_cpu(reg) be32_to_cpu(reg) 35 #endif 36 37 /* Information obtained about memory from the FDT */ 38 struct fdt_memory { 39 fdt_addr_t start; 40 fdt_addr_t end; 41 }; 42 43 /* 44 * Information about a resource. start is the first address of the resource 45 * and end is the last address (inclusive). The length of the resource will 46 * be equal to: end - start + 1. 47 */ 48 struct fdt_resource { 49 fdt_addr_t start; 50 fdt_addr_t end; 51 }; 52 53 /** 54 * Compute the size of a resource. 55 * 56 * @param res the resource to operate on 57 * @return the size of the resource 58 */ 59 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res) 60 { 61 return res->end - res->start + 1; 62 } 63 64 /** 65 * Compat types that we know about and for which we might have drivers. 66 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory 67 * within drivers. 68 */ 69 enum fdt_compat_id { 70 COMPAT_UNKNOWN, 71 COMPAT_NVIDIA_TEGRA20_USB, /* Tegra20 USB port */ 72 COMPAT_NVIDIA_TEGRA30_USB, /* Tegra30 USB port */ 73 COMPAT_NVIDIA_TEGRA114_USB, /* Tegra114 USB port */ 74 COMPAT_NVIDIA_TEGRA114_I2C, /* Tegra114 I2C w/single clock source */ 75 COMPAT_NVIDIA_TEGRA20_I2C, /* Tegra20 i2c */ 76 COMPAT_NVIDIA_TEGRA20_DVC, /* Tegra20 dvc (really just i2c) */ 77 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */ 78 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */ 79 COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */ 80 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */ 81 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */ 82 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */ 83 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */ 84 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */ 85 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */ 86 COMPAT_NVIDIA_TEGRA20_SFLASH, /* Tegra 2 SPI flash controller */ 87 COMPAT_NVIDIA_TEGRA20_SLINK, /* Tegra 2 SPI SLINK controller */ 88 COMPAT_NVIDIA_TEGRA114_SPI, /* Tegra 114 SPI controller */ 89 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */ 90 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */ 91 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */ 92 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */ 93 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */ 94 COMPAT_SAMSUNG_EXYNOS_SPI, /* Exynos SPI */ 95 COMPAT_GOOGLE_CROS_EC, /* Google CROS_EC Protocol */ 96 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */ 97 COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */ 98 COMPAT_SAMSUNG_EXYNOS5_XHCI, /* Exynos5 XHCI controller */ 99 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */ 100 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */ 101 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */ 102 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */ 103 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */ 104 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */ 105 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */ 106 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */ 107 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */ 108 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */ 109 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */ 110 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */ 111 COMPAT_INFINEON_SLB9635_TPM, /* Infineon SLB9635 TPM */ 112 COMPAT_INFINEON_SLB9645_TPM, /* Infineon SLB9645 TPM */ 113 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */ 114 COMPAT_SANDBOX_HOST_EMULATION, /* Sandbox emulation of a function */ 115 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */ 116 COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */ 117 COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */ 118 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */ 119 COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */ 120 COMPAT_INTEL_LPC, /* Intel Low Pin Count I/F */ 121 COMPAT_INTEL_MICROCODE, /* Intel microcode update */ 122 COMPAT_MEMORY_SPD, /* Memory SPD information */ 123 124 COMPAT_COUNT, 125 }; 126 127 /* GPIOs are numbered from 0 */ 128 enum { 129 FDT_GPIO_NONE = -1U, /* an invalid GPIO used to end our list */ 130 131 FDT_GPIO_ACTIVE_LOW = 1 << 0, /* input is active low (else high) */ 132 }; 133 134 /* This is the state of a GPIO pin as defined by the fdt */ 135 struct fdt_gpio_state { 136 const char *name; /* name of the fdt property defining this */ 137 uint gpio; /* GPIO number, or FDT_GPIO_NONE if none */ 138 u8 flags; /* FDT_GPIO_... flags */ 139 }; 140 141 /* This tells us whether a fdt_gpio_state record is valid or not */ 142 #define fdt_gpio_isvalid(x) ((x)->gpio != FDT_GPIO_NONE) 143 144 /** 145 * Read the GPIO taking into account the polarity of the pin. 146 * 147 * @param gpio pointer to the decoded gpio 148 * @return value of the gpio if successful, < 0 if unsuccessful 149 */ 150 int fdtdec_get_gpio(struct fdt_gpio_state *gpio); 151 152 /** 153 * Write the GPIO taking into account the polarity of the pin. 154 * 155 * @param gpio pointer to the decoded gpio 156 * @return 0 if successful 157 */ 158 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val); 159 160 /** 161 * Find the next numbered alias for a peripheral. This is used to enumerate 162 * all the peripherals of a certain type. 163 * 164 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then 165 * this function will return a pointer to the node the alias points to, and 166 * then update *upto to 1. Next time you call this function, the next node 167 * will be returned. 168 * 169 * All nodes returned will match the compatible ID, as it is assumed that 170 * all peripherals use the same driver. 171 * 172 * @param blob FDT blob to use 173 * @param name Root name of alias to search for 174 * @param id Compatible ID to look for 175 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 176 */ 177 int fdtdec_next_alias(const void *blob, const char *name, 178 enum fdt_compat_id id, int *upto); 179 180 /** 181 * Find the compatible ID for a given node. 182 * 183 * Generally each node has at least one compatible string attached to it. 184 * This function looks through our list of known compatible strings and 185 * returns the corresponding ID which matches the compatible string. 186 * 187 * @param blob FDT blob to use 188 * @param node Node containing compatible string to find 189 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match 190 */ 191 enum fdt_compat_id fdtdec_lookup(const void *blob, int node); 192 193 /** 194 * Find the next compatible node for a peripheral. 195 * 196 * Do the first call with node = 0. This function will return a pointer to 197 * the next compatible node. Next time you call this function, pass the 198 * value returned, and the next node will be provided. 199 * 200 * @param blob FDT blob to use 201 * @param node Start node for search 202 * @param id Compatible ID to look for (enum fdt_compat_id) 203 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 204 */ 205 int fdtdec_next_compatible(const void *blob, int node, 206 enum fdt_compat_id id); 207 208 /** 209 * Find the next compatible subnode for a peripheral. 210 * 211 * Do the first call with node set to the parent and depth = 0. This 212 * function will return the offset of the next compatible node. Next time 213 * you call this function, pass the node value returned last time, with 214 * depth unchanged, and the next node will be provided. 215 * 216 * @param blob FDT blob to use 217 * @param node Start node for search 218 * @param id Compatible ID to look for (enum fdt_compat_id) 219 * @param depthp Current depth (set to 0 before first call) 220 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 221 */ 222 int fdtdec_next_compatible_subnode(const void *blob, int node, 223 enum fdt_compat_id id, int *depthp); 224 225 /** 226 * Look up an address property in a node and return it as an address. 227 * The property must hold either one address with no trailing data or 228 * one address with a length. This is only tested on 32-bit machines. 229 * 230 * @param blob FDT blob 231 * @param node node to examine 232 * @param prop_name name of property to find 233 * @return address, if found, or FDT_ADDR_T_NONE if not 234 */ 235 fdt_addr_t fdtdec_get_addr(const void *blob, int node, 236 const char *prop_name); 237 238 /** 239 * Look up an address property in a node and return it as an address. 240 * The property must hold one address with a length. This is only tested 241 * on 32-bit machines. 242 * 243 * @param blob FDT blob 244 * @param node node to examine 245 * @param prop_name name of property to find 246 * @return address, if found, or FDT_ADDR_T_NONE if not 247 */ 248 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, 249 const char *prop_name, fdt_size_t *sizep); 250 251 /** 252 * Look up a 32-bit integer property in a node and return it. The property 253 * must have at least 4 bytes of data. The value of the first cell is 254 * returned. 255 * 256 * @param blob FDT blob 257 * @param node node to examine 258 * @param prop_name name of property to find 259 * @param default_val default value to return if the property is not found 260 * @return integer value, if found, or default_val if not 261 */ 262 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, 263 s32 default_val); 264 265 /** 266 * Look up a 64-bit integer property in a node and return it. The property 267 * must have at least 8 bytes of data (2 cells). The first two cells are 268 * concatenated to form a 8 bytes value, where the first cell is top half and 269 * the second cell is bottom half. 270 * 271 * @param blob FDT blob 272 * @param node node to examine 273 * @param prop_name name of property to find 274 * @param default_val default value to return if the property is not found 275 * @return integer value, if found, or default_val if not 276 */ 277 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, 278 uint64_t default_val); 279 280 /** 281 * Checks whether a node is enabled. 282 * This looks for a 'status' property. If this exists, then returns 1 if 283 * the status is 'ok' and 0 otherwise. If there is no status property, 284 * it returns 1 on the assumption that anything mentioned should be enabled 285 * by default. 286 * 287 * @param blob FDT blob 288 * @param node node to examine 289 * @return integer value 0 (not enabled) or 1 (enabled) 290 */ 291 int fdtdec_get_is_enabled(const void *blob, int node); 292 293 /** 294 * Make sure we have a valid fdt available to control U-Boot. 295 * 296 * If not, a message is printed to the console if the console is ready. 297 * 298 * @return 0 if all ok, -1 if not 299 */ 300 int fdtdec_prepare_fdt(void); 301 302 /** 303 * Checks that we have a valid fdt available to control U-Boot. 304 305 * However, if not then for the moment nothing is done, since this function 306 * is called too early to panic(). 307 * 308 * @returns 0 309 */ 310 int fdtdec_check_fdt(void); 311 312 /** 313 * Find the nodes for a peripheral and return a list of them in the correct 314 * order. This is used to enumerate all the peripherals of a certain type. 315 * 316 * To use this, optionally set up a /aliases node with alias properties for 317 * a peripheral. For example, for usb you could have: 318 * 319 * aliases { 320 * usb0 = "/ehci@c5008000"; 321 * usb1 = "/ehci@c5000000"; 322 * }; 323 * 324 * Pass "usb" as the name to this function and will return a list of two 325 * nodes offsets: /ehci@c5008000 and ehci@c5000000. 326 * 327 * All nodes returned will match the compatible ID, as it is assumed that 328 * all peripherals use the same driver. 329 * 330 * If no alias node is found, then the node list will be returned in the 331 * order found in the fdt. If the aliases mention a node which doesn't 332 * exist, then this will be ignored. If nodes are found with no aliases, 333 * they will be added in any order. 334 * 335 * If there is a gap in the aliases, then this function return a 0 node at 336 * that position. The return value will also count these gaps. 337 * 338 * This function checks node properties and will not return nodes which are 339 * marked disabled (status = "disabled"). 340 * 341 * @param blob FDT blob to use 342 * @param name Root name of alias to search for 343 * @param id Compatible ID to look for 344 * @param node_list Place to put list of found nodes 345 * @param maxcount Maximum number of nodes to find 346 * @return number of nodes found on success, FTD_ERR_... on error 347 */ 348 int fdtdec_find_aliases_for_id(const void *blob, const char *name, 349 enum fdt_compat_id id, int *node_list, int maxcount); 350 351 /* 352 * This function is similar to fdtdec_find_aliases_for_id() except that it 353 * adds to the node_list that is passed in. Any 0 elements are considered 354 * available for allocation - others are considered already used and are 355 * skipped. 356 * 357 * You can use this by calling fdtdec_find_aliases_for_id() with an 358 * uninitialised array, then setting the elements that are returned to -1, 359 * say, then calling this function, perhaps with a different compat id. 360 * Any elements you get back that are >0 are new nodes added by the call 361 * to this function. 362 * 363 * Note that if you have some nodes with aliases and some without, you are 364 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with 365 * one compat_id may fill in positions for which you have aliases defined 366 * for another compat_id. When you later call *this* function with the second 367 * compat_id, the alias positions may already be used. A debug warning may 368 * be generated in this case, but it is safest to define aliases for all 369 * nodes when you care about the ordering. 370 */ 371 int fdtdec_add_aliases_for_id(const void *blob, const char *name, 372 enum fdt_compat_id id, int *node_list, int maxcount); 373 374 /** 375 * Get the alias sequence number of a node 376 * 377 * This works out whether a node is pointed to by an alias, and if so, the 378 * sequence number of that alias. Aliases are of the form <base><num> where 379 * <num> is the sequence number. For example spi2 would be sequence number 380 * 2. 381 * 382 * @param blob Device tree blob (if NULL, then error is returned) 383 * @param base Base name for alias (before the underscore) 384 * @param node Node to look up 385 * @param seqp This is set to the sequence number if one is found, 386 * but otherwise the value is left alone 387 * @return 0 if a sequence was found, -ve if not 388 */ 389 int fdtdec_get_alias_seq(const void *blob, const char *base, int node, 390 int *seqp); 391 392 /** 393 * Get the offset of the given alias node 394 * 395 * This looks up an alias in /aliases then finds the offset of that node. 396 * 397 * @param blob Device tree blob (if NULL, then error is returned) 398 * @param name Alias name, e.g. "console" 399 * @return Node offset referred to by that alias, or -ve FDT_ERR_... 400 */ 401 int fdtdec_get_alias_node(const void *blob, const char *name); 402 403 /** 404 * Get the offset of the given chosen node 405 * 406 * This looks up a property in /chosen containing the path to another node, 407 * then finds the offset of that node. 408 * 409 * @param blob Device tree blob (if NULL, then error is returned) 410 * @param name Property name, e.g. "stdout-path" 411 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_... 412 */ 413 int fdtdec_get_chosen_node(const void *blob, const char *name); 414 415 /* 416 * Get the name for a compatible ID 417 * 418 * @param id Compatible ID to look for 419 * @return compatible string for that id 420 */ 421 const char *fdtdec_get_compatible(enum fdt_compat_id id); 422 423 /* Look up a phandle and follow it to its node. Then return the offset 424 * of that node. 425 * 426 * @param blob FDT blob 427 * @param node node to examine 428 * @param prop_name name of property to find 429 * @return node offset if found, -ve error code on error 430 */ 431 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); 432 433 /** 434 * Look up a property in a node and return its contents in an integer 435 * array of given length. The property must have at least enough data for 436 * the array (4*count bytes). It may have more, but this will be ignored. 437 * 438 * @param blob FDT blob 439 * @param node node to examine 440 * @param prop_name name of property to find 441 * @param array array to fill with data 442 * @param count number of array elements 443 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, 444 * or -FDT_ERR_BADLAYOUT if not enough data 445 */ 446 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, 447 u32 *array, int count); 448 449 /** 450 * Look up a property in a node and return its contents in an integer 451 * array of given length. The property must exist but may have less data that 452 * expected (4*count bytes). It may have more, but this will be ignored. 453 * 454 * @param blob FDT blob 455 * @param node node to examine 456 * @param prop_name name of property to find 457 * @param array array to fill with data 458 * @param count number of array elements 459 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the 460 * property is not found 461 */ 462 int fdtdec_get_int_array_count(const void *blob, int node, 463 const char *prop_name, u32 *array, int count); 464 465 /** 466 * Look up a property in a node and return a pointer to its contents as a 467 * unsigned int array of given length. The property must have at least enough 468 * data for the array ('count' cells). It may have more, but this will be 469 * ignored. The data is not copied. 470 * 471 * Note that you must access elements of the array with fdt32_to_cpu(), 472 * since the elements will be big endian even on a little endian machine. 473 * 474 * @param blob FDT blob 475 * @param node node to examine 476 * @param prop_name name of property to find 477 * @param count number of array elements 478 * @return pointer to array if found, or NULL if the property is not 479 * found or there is not enough data 480 */ 481 const u32 *fdtdec_locate_array(const void *blob, int node, 482 const char *prop_name, int count); 483 484 /** 485 * Look up a boolean property in a node and return it. 486 * 487 * A boolean properly is true if present in the device tree and false if not 488 * present, regardless of its value. 489 * 490 * @param blob FDT blob 491 * @param node node to examine 492 * @param prop_name name of property to find 493 * @return 1 if the properly is present; 0 if it isn't present 494 */ 495 int fdtdec_get_bool(const void *blob, int node, const char *prop_name); 496 497 /** 498 * Decode a single GPIOs from an FDT. 499 * 500 * If the property is not found, then the GPIO structure will still be 501 * initialised, with gpio set to FDT_GPIO_NONE. This makes it easy to 502 * provide optional GPIOs. 503 * 504 * @param blob FDT blob to use 505 * @param node Node to look at 506 * @param prop_name Node property name 507 * @param gpio gpio elements to fill from FDT 508 * @return 0 if ok, -FDT_ERR_NOTFOUND if the property is missing. 509 */ 510 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name, 511 struct fdt_gpio_state *gpio); 512 513 /** 514 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no 515 * terminating item. 516 * 517 * @param blob FDT blob to use 518 * @param node Node to look at 519 * @param prop_name Node property name 520 * @param gpio Array of gpio elements to fill from FDT. This will be 521 * untouched if either 0 or an error is returned 522 * @param max_count Maximum number of elements allowed 523 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would 524 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing. 525 */ 526 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name, 527 struct fdt_gpio_state *gpio, int max_count); 528 529 /** 530 * Set up a GPIO pin according to the provided gpio information. At present this 531 * just requests the GPIO. 532 * 533 * If the gpio is FDT_GPIO_NONE, no action is taken. This makes it easy to 534 * deal with optional GPIOs. 535 * 536 * @param gpio GPIO info to use for set up 537 * @return 0 if all ok or gpio was FDT_GPIO_NONE; -1 on error 538 */ 539 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio); 540 541 /** 542 * Look in the FDT for a config item with the given name and return its value 543 * as a 32-bit integer. The property must have at least 4 bytes of data. The 544 * value of the first cell is returned. 545 * 546 * @param blob FDT blob to use 547 * @param prop_name Node property name 548 * @param default_val default value to return if the property is not found 549 * @return integer value, if found, or default_val if not 550 */ 551 int fdtdec_get_config_int(const void *blob, const char *prop_name, 552 int default_val); 553 554 /** 555 * Look in the FDT for a config item with the given name 556 * and return whether it exists. 557 * 558 * @param blob FDT blob 559 * @param prop_name property name to look up 560 * @return 1, if it exists, or 0 if not 561 */ 562 int fdtdec_get_config_bool(const void *blob, const char *prop_name); 563 564 /** 565 * Look in the FDT for a config item with the given name and return its value 566 * as a string. 567 * 568 * @param blob FDT blob 569 * @param prop_name property name to look up 570 * @returns property string, NULL on error. 571 */ 572 char *fdtdec_get_config_string(const void *blob, const char *prop_name); 573 574 /* 575 * Look up a property in a node and return its contents in a byte 576 * array of given length. The property must have at least enough data for 577 * the array (count bytes). It may have more, but this will be ignored. 578 * 579 * @param blob FDT blob 580 * @param node node to examine 581 * @param prop_name name of property to find 582 * @param array array to fill with data 583 * @param count number of array elements 584 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found, 585 * or -FDT_ERR_BADLAYOUT if not enough data 586 */ 587 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, 588 u8 *array, int count); 589 590 /** 591 * Look up a property in a node and return a pointer to its contents as a 592 * byte array of given length. The property must have at least enough data 593 * for the array (count bytes). It may have more, but this will be ignored. 594 * The data is not copied. 595 * 596 * @param blob FDT blob 597 * @param node node to examine 598 * @param prop_name name of property to find 599 * @param count number of array elements 600 * @return pointer to byte array if found, or NULL if the property is not 601 * found or there is not enough data 602 */ 603 const u8 *fdtdec_locate_byte_array(const void *blob, int node, 604 const char *prop_name, int count); 605 606 /** 607 * Look up a property in a node which contains a memory region address and 608 * size. Then return a pointer to this address. 609 * 610 * The property must hold one address with a length. This is only tested on 611 * 32-bit machines. 612 * 613 * @param blob FDT blob 614 * @param node node to examine 615 * @param prop_name name of property to find 616 * @param basep Returns base address of region 617 * @param size Returns size of region 618 * @return 0 if ok, -1 on error (property not found) 619 */ 620 int fdtdec_decode_region(const void *blob, int node, const char *prop_name, 621 fdt_addr_t *basep, fdt_size_t *sizep); 622 623 enum fmap_compress_t { 624 FMAP_COMPRESS_NONE, 625 FMAP_COMPRESS_LZO, 626 }; 627 628 enum fmap_hash_t { 629 FMAP_HASH_NONE, 630 FMAP_HASH_SHA1, 631 FMAP_HASH_SHA256, 632 }; 633 634 /* A flash map entry, containing an offset and length */ 635 struct fmap_entry { 636 uint32_t offset; 637 uint32_t length; 638 uint32_t used; /* Number of bytes used in region */ 639 enum fmap_compress_t compress_algo; /* Compression type */ 640 enum fmap_hash_t hash_algo; /* Hash algorithm */ 641 const uint8_t *hash; /* Hash value */ 642 int hash_size; /* Hash size */ 643 }; 644 645 /** 646 * Read a flash entry from the fdt 647 * 648 * @param blob FDT blob 649 * @param node Offset of node to read 650 * @param name Name of node being read 651 * @param entry Place to put offset and size of this node 652 * @return 0 if ok, -ve on error 653 */ 654 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name, 655 struct fmap_entry *entry); 656 657 /** 658 * Obtain an indexed resource from a device property. 659 * 660 * @param fdt FDT blob 661 * @param node node to examine 662 * @param property name of the property to parse 663 * @param index index of the resource to retrieve 664 * @param res returns the resource 665 * @return 0 if ok, negative on error 666 */ 667 int fdt_get_resource(const void *fdt, int node, const char *property, 668 unsigned int index, struct fdt_resource *res); 669 670 /** 671 * Obtain a named resource from a device property. 672 * 673 * Look up the index of the name in a list of strings and return the resource 674 * at that index. 675 * 676 * @param fdt FDT blob 677 * @param node node to examine 678 * @param property name of the property to parse 679 * @param prop_names name of the property containing the list of names 680 * @param name the name of the entry to look up 681 * @param res returns the resource 682 */ 683 int fdt_get_named_resource(const void *fdt, int node, const char *property, 684 const char *prop_names, const char *name, 685 struct fdt_resource *res); 686 687 /** 688 * Look at the reg property of a device node that represents a PCI device 689 * and parse the bus, device and function number from it. 690 * 691 * @param fdt FDT blob 692 * @param node node to examine 693 * @param bdf returns bus, device, function triplet 694 * @return 0 if ok, negative on error 695 */ 696 int fdtdec_pci_get_bdf(const void *fdt, int node, int *bdf); 697 698 /** 699 * Decode a named region within a memory bank of a given type. 700 * 701 * This function handles selection of a memory region. The region is 702 * specified as an offset/size within a particular type of memory. 703 * 704 * The properties used are: 705 * 706 * <mem_type>-memory<suffix> for the name of the memory bank 707 * <mem_type>-offset<suffix> for the offset in that bank 708 * 709 * The property value must have an offset and a size. The function checks 710 * that the region is entirely within the memory bank.5 711 * 712 * @param blob FDT blob 713 * @param node Node containing the properties (-1 for /config) 714 * @param mem_type Type of memory to use, which is a name, such as 715 * "u-boot" or "kernel". 716 * @param suffix String to append to the memory/offset 717 * property names 718 * @param basep Returns base of region 719 * @param sizep Returns size of region 720 * @return 0 if OK, -ive on error 721 */ 722 int fdtdec_decode_memory_region(const void *blob, int node, 723 const char *mem_type, const char *suffix, 724 fdt_addr_t *basep, fdt_size_t *sizep); 725 #endif 726