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 #include <pci.h> 19 20 /* 21 * A typedef for a physical address. Note that fdt data is always big 22 * endian even on a litle endian machine. 23 */ 24 #ifdef CONFIG_PHYS_64BIT 25 typedef u64 fdt_addr_t; 26 typedef u64 fdt_size_t; 27 #define FDT_ADDR_T_NONE (-1ULL) 28 #define fdt_addr_to_cpu(reg) be64_to_cpu(reg) 29 #define fdt_size_to_cpu(reg) be64_to_cpu(reg) 30 #else 31 typedef u32 fdt_addr_t; 32 typedef u32 fdt_size_t; 33 #define FDT_ADDR_T_NONE (-1U) 34 #define fdt_addr_to_cpu(reg) be32_to_cpu(reg) 35 #define fdt_size_to_cpu(reg) be32_to_cpu(reg) 36 #endif 37 38 /* Information obtained about memory from the FDT */ 39 struct fdt_memory { 40 fdt_addr_t start; 41 fdt_addr_t end; 42 }; 43 44 #ifdef CONFIG_OF_CONTROL 45 # if defined(CONFIG_SPL_BUILD) && defined(SPL_DISABLE_OF_CONTROL) 46 # define OF_CONTROL 0 47 # else 48 # define OF_CONTROL 1 49 # endif 50 #else 51 # define OF_CONTROL 0 52 #endif 53 54 /* 55 * Information about a resource. start is the first address of the resource 56 * and end is the last address (inclusive). The length of the resource will 57 * be equal to: end - start + 1. 58 */ 59 struct fdt_resource { 60 fdt_addr_t start; 61 fdt_addr_t end; 62 }; 63 64 enum fdt_pci_space { 65 FDT_PCI_SPACE_CONFIG = 0, 66 FDT_PCI_SPACE_IO = 0x01000000, 67 FDT_PCI_SPACE_MEM32 = 0x02000000, 68 FDT_PCI_SPACE_MEM64 = 0x03000000, 69 FDT_PCI_SPACE_MEM32_PREF = 0x42000000, 70 FDT_PCI_SPACE_MEM64_PREF = 0x43000000, 71 }; 72 73 #define FDT_PCI_ADDR_CELLS 3 74 #define FDT_PCI_SIZE_CELLS 2 75 #define FDT_PCI_REG_SIZE \ 76 ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32)) 77 78 /* 79 * The Open Firmware spec defines PCI physical address as follows: 80 * 81 * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00 82 * 83 * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr 84 * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh 85 * phys.lo cell: llllllll llllllll llllllll llllllll 86 * 87 * where: 88 * 89 * n: is 0 if the address is relocatable, 1 otherwise 90 * p: is 1 if addressable region is prefetchable, 0 otherwise 91 * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB 92 * (for Memory), or below 64KB (for relocatable I/O) 93 * ss: is the space code, denoting the address space 94 * bbbbbbbb: is the 8-bit Bus Number 95 * ddddd: is the 5-bit Device Number 96 * fff: is the 3-bit Function Number 97 * rrrrrrrr: is the 8-bit Register Number 98 * hhhhhhhh: is a 32-bit unsigned number 99 * llllllll: is a 32-bit unsigned number 100 */ 101 struct fdt_pci_addr { 102 u32 phys_hi; 103 u32 phys_mid; 104 u32 phys_lo; 105 }; 106 107 /** 108 * Compute the size of a resource. 109 * 110 * @param res the resource to operate on 111 * @return the size of the resource 112 */ 113 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res) 114 { 115 return res->end - res->start + 1; 116 } 117 118 /** 119 * Compat types that we know about and for which we might have drivers. 120 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory 121 * within drivers. 122 */ 123 enum fdt_compat_id { 124 COMPAT_UNKNOWN, 125 COMPAT_NVIDIA_TEGRA20_USB, /* Tegra20 USB port */ 126 COMPAT_NVIDIA_TEGRA30_USB, /* Tegra30 USB port */ 127 COMPAT_NVIDIA_TEGRA114_USB, /* Tegra114 USB port */ 128 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */ 129 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */ 130 COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */ 131 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */ 132 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */ 133 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */ 134 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */ 135 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */ 136 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */ 137 COMPAT_NVIDIA_TEGRA124_PCIE, /* Tegra 124 PCIe controller */ 138 COMPAT_NVIDIA_TEGRA30_PCIE, /* Tegra 30 PCIe controller */ 139 COMPAT_NVIDIA_TEGRA20_PCIE, /* Tegra 20 PCIe controller */ 140 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL, 141 /* Tegra124 XUSB pad controller */ 142 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */ 143 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */ 144 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */ 145 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */ 146 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */ 147 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */ 148 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */ 149 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */ 150 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */ 151 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */ 152 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */ 153 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */ 154 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */ 155 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */ 156 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */ 157 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */ 158 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */ 159 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */ 160 COMPAT_INFINEON_SLB9635_TPM, /* Infineon SLB9635 TPM */ 161 COMPAT_INFINEON_SLB9645_TPM, /* Infineon SLB9645 TPM */ 162 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */ 163 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */ 164 COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */ 165 COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */ 166 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */ 167 COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */ 168 COMPAT_INTEL_MICROCODE, /* Intel microcode update */ 169 COMPAT_MEMORY_SPD, /* Memory SPD information */ 170 COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */ 171 COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */ 172 COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */ 173 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */ 174 COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */ 175 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */ 176 COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */ 177 COMPAT_INTEL_PCH, /* Intel PCH */ 178 179 COMPAT_COUNT, 180 }; 181 182 #define MAX_PHANDLE_ARGS 16 183 struct fdtdec_phandle_args { 184 int node; 185 int args_count; 186 uint32_t args[MAX_PHANDLE_ARGS]; 187 }; 188 189 /** 190 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list 191 * 192 * This function is useful to parse lists of phandles and their arguments. 193 * 194 * Example: 195 * 196 * phandle1: node1 { 197 * #list-cells = <2>; 198 * } 199 * 200 * phandle2: node2 { 201 * #list-cells = <1>; 202 * } 203 * 204 * node3 { 205 * list = <&phandle1 1 2 &phandle2 3>; 206 * } 207 * 208 * To get a device_node of the `node2' node you may call this: 209 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1, 210 * &args); 211 * 212 * (This function is a modified version of __of_parse_phandle_with_args() from 213 * Linux 3.18) 214 * 215 * @blob: Pointer to device tree 216 * @src_node: Offset of device tree node containing a list 217 * @list_name: property name that contains a list 218 * @cells_name: property name that specifies the phandles' arguments count, 219 * or NULL to use @cells_count 220 * @cells_count: Cell count to use if @cells_name is NULL 221 * @index: index of a phandle to parse out 222 * @out_args: optional pointer to output arguments structure (will be filled) 223 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if 224 * @list_name does not exist, a phandle was not found, @cells_name 225 * could not be found, the arguments were truncated or there were too 226 * many arguments. 227 * 228 */ 229 int fdtdec_parse_phandle_with_args(const void *blob, int src_node, 230 const char *list_name, 231 const char *cells_name, 232 int cell_count, int index, 233 struct fdtdec_phandle_args *out_args); 234 235 /** 236 * Find the next numbered alias for a peripheral. This is used to enumerate 237 * all the peripherals of a certain type. 238 * 239 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then 240 * this function will return a pointer to the node the alias points to, and 241 * then update *upto to 1. Next time you call this function, the next node 242 * will be returned. 243 * 244 * All nodes returned will match the compatible ID, as it is assumed that 245 * all peripherals use the same driver. 246 * 247 * @param blob FDT blob to use 248 * @param name Root name of alias to search for 249 * @param id Compatible ID to look for 250 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 251 */ 252 int fdtdec_next_alias(const void *blob, const char *name, 253 enum fdt_compat_id id, int *upto); 254 255 /** 256 * Find the compatible ID for a given node. 257 * 258 * Generally each node has at least one compatible string attached to it. 259 * This function looks through our list of known compatible strings and 260 * returns the corresponding ID which matches the compatible string. 261 * 262 * @param blob FDT blob to use 263 * @param node Node containing compatible string to find 264 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match 265 */ 266 enum fdt_compat_id fdtdec_lookup(const void *blob, int node); 267 268 /** 269 * Find the next compatible node for a peripheral. 270 * 271 * Do the first call with node = 0. This function will return a pointer to 272 * the next compatible node. Next time you call this function, pass the 273 * value returned, and the next node will be provided. 274 * 275 * @param blob FDT blob to use 276 * @param node Start node for search 277 * @param id Compatible ID to look for (enum fdt_compat_id) 278 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 279 */ 280 int fdtdec_next_compatible(const void *blob, int node, 281 enum fdt_compat_id id); 282 283 /** 284 * Find the next compatible subnode for a peripheral. 285 * 286 * Do the first call with node set to the parent and depth = 0. This 287 * function will return the offset of the next compatible node. Next time 288 * you call this function, pass the node value returned last time, with 289 * depth unchanged, and the next node will be provided. 290 * 291 * @param blob FDT blob to use 292 * @param node Start node for search 293 * @param id Compatible ID to look for (enum fdt_compat_id) 294 * @param depthp Current depth (set to 0 before first call) 295 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 296 */ 297 int fdtdec_next_compatible_subnode(const void *blob, int node, 298 enum fdt_compat_id id, int *depthp); 299 300 /** 301 * Look up an address property in a node and return it as an address. 302 * The property must hold either one address with no trailing data or 303 * one address with a length. This is only tested on 32-bit machines. 304 * 305 * @param blob FDT blob 306 * @param node node to examine 307 * @param prop_name name of property to find 308 * @return address, if found, or FDT_ADDR_T_NONE if not 309 */ 310 fdt_addr_t fdtdec_get_addr(const void *blob, int node, 311 const char *prop_name); 312 313 /** 314 * Look up an address property in a node and return it as an address. 315 * The property must hold one address with a length. This is only tested 316 * on 32-bit machines. 317 * 318 * @param blob FDT blob 319 * @param node node to examine 320 * @param prop_name name of property to find 321 * @return address, if found, or FDT_ADDR_T_NONE if not 322 */ 323 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, 324 const char *prop_name, fdt_size_t *sizep); 325 326 /** 327 * Look at an address property in a node and return the pci address which 328 * corresponds to the given type in the form of fdt_pci_addr. 329 * The property must hold one fdt_pci_addr with a lengh. 330 * 331 * @param blob FDT blob 332 * @param node node to examine 333 * @param type pci address type (FDT_PCI_SPACE_xxx) 334 * @param prop_name name of property to find 335 * @param addr returns pci address in the form of fdt_pci_addr 336 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the 337 * format of the property was invalid, -ENXIO if the requested 338 * address type was not found 339 */ 340 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type, 341 const char *prop_name, struct fdt_pci_addr *addr); 342 343 /** 344 * Look at the compatible property of a device node that represents a PCI 345 * device and extract pci vendor id and device id from it. 346 * 347 * @param blob FDT blob 348 * @param node node to examine 349 * @param vendor vendor id of the pci device 350 * @param device device id of the pci device 351 * @return 0 if ok, negative on error 352 */ 353 int fdtdec_get_pci_vendev(const void *blob, int node, 354 u16 *vendor, u16 *device); 355 356 /** 357 * Look at the pci address of a device node that represents a PCI device 358 * and parse the bus, device and function number from it. For some cases 359 * like the bus number encoded in reg property is not correct after pci 360 * enumeration, this function looks through the node's compatible strings 361 * to get these numbers extracted instead. 362 * 363 * @param blob FDT blob 364 * @param node node to examine 365 * @param addr pci address in the form of fdt_pci_addr 366 * @param bdf returns bus, device, function triplet 367 * @return 0 if ok, negative on error 368 */ 369 int fdtdec_get_pci_bdf(const void *blob, int node, 370 struct fdt_pci_addr *addr, pci_dev_t *bdf); 371 372 /** 373 * Look at the pci address of a device node that represents a PCI device 374 * and return base address of the pci device's registers. 375 * 376 * @param blob FDT blob 377 * @param node node to examine 378 * @param addr pci address in the form of fdt_pci_addr 379 * @param bar returns base address of the pci device's registers 380 * @return 0 if ok, negative on error 381 */ 382 int fdtdec_get_pci_bar32(const void *blob, int node, 383 struct fdt_pci_addr *addr, u32 *bar); 384 385 /** 386 * Look up a 32-bit integer property in a node and return it. The property 387 * must have at least 4 bytes of data. The value of the first cell is 388 * returned. 389 * 390 * @param blob FDT blob 391 * @param node node to examine 392 * @param prop_name name of property to find 393 * @param default_val default value to return if the property is not found 394 * @return integer value, if found, or default_val if not 395 */ 396 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, 397 s32 default_val); 398 399 /** 400 * Get a variable-sized number from a property 401 * 402 * This reads a number from one or more cells. 403 * 404 * @param ptr Pointer to property 405 * @param cells Number of cells containing the number 406 * @return the value in the cells 407 */ 408 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells); 409 410 /** 411 * Look up a 64-bit integer property in a node and return it. The property 412 * must have at least 8 bytes of data (2 cells). The first two cells are 413 * concatenated to form a 8 bytes value, where the first cell is top half and 414 * the second cell is bottom half. 415 * 416 * @param blob FDT blob 417 * @param node node to examine 418 * @param prop_name name of property to find 419 * @param default_val default value to return if the property is not found 420 * @return integer value, if found, or default_val if not 421 */ 422 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, 423 uint64_t default_val); 424 425 /** 426 * Checks whether a node is enabled. 427 * This looks for a 'status' property. If this exists, then returns 1 if 428 * the status is 'ok' and 0 otherwise. If there is no status property, 429 * it returns 1 on the assumption that anything mentioned should be enabled 430 * by default. 431 * 432 * @param blob FDT blob 433 * @param node node to examine 434 * @return integer value 0 (not enabled) or 1 (enabled) 435 */ 436 int fdtdec_get_is_enabled(const void *blob, int node); 437 438 /** 439 * Make sure we have a valid fdt available to control U-Boot. 440 * 441 * If not, a message is printed to the console if the console is ready. 442 * 443 * @return 0 if all ok, -1 if not 444 */ 445 int fdtdec_prepare_fdt(void); 446 447 /** 448 * Checks that we have a valid fdt available to control U-Boot. 449 450 * However, if not then for the moment nothing is done, since this function 451 * is called too early to panic(). 452 * 453 * @returns 0 454 */ 455 int fdtdec_check_fdt(void); 456 457 /** 458 * Find the nodes for a peripheral and return a list of them in the correct 459 * order. This is used to enumerate all the peripherals of a certain type. 460 * 461 * To use this, optionally set up a /aliases node with alias properties for 462 * a peripheral. For example, for usb you could have: 463 * 464 * aliases { 465 * usb0 = "/ehci@c5008000"; 466 * usb1 = "/ehci@c5000000"; 467 * }; 468 * 469 * Pass "usb" as the name to this function and will return a list of two 470 * nodes offsets: /ehci@c5008000 and ehci@c5000000. 471 * 472 * All nodes returned will match the compatible ID, as it is assumed that 473 * all peripherals use the same driver. 474 * 475 * If no alias node is found, then the node list will be returned in the 476 * order found in the fdt. If the aliases mention a node which doesn't 477 * exist, then this will be ignored. If nodes are found with no aliases, 478 * they will be added in any order. 479 * 480 * If there is a gap in the aliases, then this function return a 0 node at 481 * that position. The return value will also count these gaps. 482 * 483 * This function checks node properties and will not return nodes which are 484 * marked disabled (status = "disabled"). 485 * 486 * @param blob FDT blob to use 487 * @param name Root name of alias to search for 488 * @param id Compatible ID to look for 489 * @param node_list Place to put list of found nodes 490 * @param maxcount Maximum number of nodes to find 491 * @return number of nodes found on success, FTD_ERR_... on error 492 */ 493 int fdtdec_find_aliases_for_id(const void *blob, const char *name, 494 enum fdt_compat_id id, int *node_list, int maxcount); 495 496 /* 497 * This function is similar to fdtdec_find_aliases_for_id() except that it 498 * adds to the node_list that is passed in. Any 0 elements are considered 499 * available for allocation - others are considered already used and are 500 * skipped. 501 * 502 * You can use this by calling fdtdec_find_aliases_for_id() with an 503 * uninitialised array, then setting the elements that are returned to -1, 504 * say, then calling this function, perhaps with a different compat id. 505 * Any elements you get back that are >0 are new nodes added by the call 506 * to this function. 507 * 508 * Note that if you have some nodes with aliases and some without, you are 509 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with 510 * one compat_id may fill in positions for which you have aliases defined 511 * for another compat_id. When you later call *this* function with the second 512 * compat_id, the alias positions may already be used. A debug warning may 513 * be generated in this case, but it is safest to define aliases for all 514 * nodes when you care about the ordering. 515 */ 516 int fdtdec_add_aliases_for_id(const void *blob, const char *name, 517 enum fdt_compat_id id, int *node_list, int maxcount); 518 519 /** 520 * Get the alias sequence number of a node 521 * 522 * This works out whether a node is pointed to by an alias, and if so, the 523 * sequence number of that alias. Aliases are of the form <base><num> where 524 * <num> is the sequence number. For example spi2 would be sequence number 525 * 2. 526 * 527 * @param blob Device tree blob (if NULL, then error is returned) 528 * @param base Base name for alias (before the underscore) 529 * @param node Node to look up 530 * @param seqp This is set to the sequence number if one is found, 531 * but otherwise the value is left alone 532 * @return 0 if a sequence was found, -ve if not 533 */ 534 int fdtdec_get_alias_seq(const void *blob, const char *base, int node, 535 int *seqp); 536 537 /** 538 * Get the offset of the given chosen node 539 * 540 * This looks up a property in /chosen containing the path to another node, 541 * then finds the offset of that node. 542 * 543 * @param blob Device tree blob (if NULL, then error is returned) 544 * @param name Property name, e.g. "stdout-path" 545 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_... 546 */ 547 int fdtdec_get_chosen_node(const void *blob, const char *name); 548 549 /* 550 * Get the name for a compatible ID 551 * 552 * @param id Compatible ID to look for 553 * @return compatible string for that id 554 */ 555 const char *fdtdec_get_compatible(enum fdt_compat_id id); 556 557 /* Look up a phandle and follow it to its node. Then return the offset 558 * of that node. 559 * 560 * @param blob FDT blob 561 * @param node node to examine 562 * @param prop_name name of property to find 563 * @return node offset if found, -ve error code on error 564 */ 565 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); 566 567 /** 568 * Look up a property in a node and return its contents in an integer 569 * array of given length. The property must have at least enough data for 570 * the array (4*count bytes). It may have more, but this will be ignored. 571 * 572 * @param blob FDT blob 573 * @param node node to examine 574 * @param prop_name name of property to find 575 * @param array array to fill with data 576 * @param count number of array elements 577 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, 578 * or -FDT_ERR_BADLAYOUT if not enough data 579 */ 580 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, 581 u32 *array, int count); 582 583 /** 584 * Look up a property in a node and return its contents in an integer 585 * array of given length. The property must exist but may have less data that 586 * expected (4*count bytes). It may have more, but this will be ignored. 587 * 588 * @param blob FDT blob 589 * @param node node to examine 590 * @param prop_name name of property to find 591 * @param array array to fill with data 592 * @param count number of array elements 593 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the 594 * property is not found 595 */ 596 int fdtdec_get_int_array_count(const void *blob, int node, 597 const char *prop_name, u32 *array, int count); 598 599 /** 600 * Look up a property in a node and return a pointer to its contents as a 601 * unsigned int array of given length. The property must have at least enough 602 * data for the array ('count' cells). It may have more, but this will be 603 * ignored. The data is not copied. 604 * 605 * Note that you must access elements of the array with fdt32_to_cpu(), 606 * since the elements will be big endian even on a little endian machine. 607 * 608 * @param blob FDT blob 609 * @param node node to examine 610 * @param prop_name name of property to find 611 * @param count number of array elements 612 * @return pointer to array if found, or NULL if the property is not 613 * found or there is not enough data 614 */ 615 const u32 *fdtdec_locate_array(const void *blob, int node, 616 const char *prop_name, int count); 617 618 /** 619 * Look up a boolean property in a node and return it. 620 * 621 * A boolean properly is true if present in the device tree and false if not 622 * present, regardless of its value. 623 * 624 * @param blob FDT blob 625 * @param node node to examine 626 * @param prop_name name of property to find 627 * @return 1 if the properly is present; 0 if it isn't present 628 */ 629 int fdtdec_get_bool(const void *blob, int node, const char *prop_name); 630 631 /** 632 * Look in the FDT for a config item with the given name and return its value 633 * as a 32-bit integer. The property must have at least 4 bytes of data. The 634 * value of the first cell is returned. 635 * 636 * @param blob FDT blob to use 637 * @param prop_name Node property name 638 * @param default_val default value to return if the property is not found 639 * @return integer value, if found, or default_val if not 640 */ 641 int fdtdec_get_config_int(const void *blob, const char *prop_name, 642 int default_val); 643 644 /** 645 * Look in the FDT for a config item with the given name 646 * and return whether it exists. 647 * 648 * @param blob FDT blob 649 * @param prop_name property name to look up 650 * @return 1, if it exists, or 0 if not 651 */ 652 int fdtdec_get_config_bool(const void *blob, const char *prop_name); 653 654 /** 655 * Look in the FDT for a config item with the given name and return its value 656 * as a string. 657 * 658 * @param blob FDT blob 659 * @param prop_name property name to look up 660 * @returns property string, NULL on error. 661 */ 662 char *fdtdec_get_config_string(const void *blob, const char *prop_name); 663 664 /* 665 * Look up a property in a node and return its contents in a byte 666 * array of given length. The property must have at least enough data for 667 * the array (count bytes). It may have more, but this will be ignored. 668 * 669 * @param blob FDT blob 670 * @param node node to examine 671 * @param prop_name name of property to find 672 * @param array array to fill with data 673 * @param count number of array elements 674 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found, 675 * or -FDT_ERR_BADLAYOUT if not enough data 676 */ 677 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, 678 u8 *array, int count); 679 680 /** 681 * Look up a property in a node and return a pointer to its contents as a 682 * byte array of given length. The property must have at least enough data 683 * for the array (count bytes). It may have more, but this will be ignored. 684 * The data is not copied. 685 * 686 * @param blob FDT blob 687 * @param node node to examine 688 * @param prop_name name of property to find 689 * @param count number of array elements 690 * @return pointer to byte array if found, or NULL if the property is not 691 * found or there is not enough data 692 */ 693 const u8 *fdtdec_locate_byte_array(const void *blob, int node, 694 const char *prop_name, int count); 695 696 /** 697 * Look up a property in a node which contains a memory region address and 698 * size. Then return a pointer to this address. 699 * 700 * The property must hold one address with a length. This is only tested on 701 * 32-bit machines. 702 * 703 * @param blob FDT blob 704 * @param node node to examine 705 * @param prop_name name of property to find 706 * @param basep Returns base address of region 707 * @param size Returns size of region 708 * @return 0 if ok, -1 on error (property not found) 709 */ 710 int fdtdec_decode_region(const void *blob, int node, const char *prop_name, 711 fdt_addr_t *basep, fdt_size_t *sizep); 712 713 enum fmap_compress_t { 714 FMAP_COMPRESS_NONE, 715 FMAP_COMPRESS_LZO, 716 }; 717 718 enum fmap_hash_t { 719 FMAP_HASH_NONE, 720 FMAP_HASH_SHA1, 721 FMAP_HASH_SHA256, 722 }; 723 724 /* A flash map entry, containing an offset and length */ 725 struct fmap_entry { 726 uint32_t offset; 727 uint32_t length; 728 uint32_t used; /* Number of bytes used in region */ 729 enum fmap_compress_t compress_algo; /* Compression type */ 730 enum fmap_hash_t hash_algo; /* Hash algorithm */ 731 const uint8_t *hash; /* Hash value */ 732 int hash_size; /* Hash size */ 733 }; 734 735 /** 736 * Read a flash entry from the fdt 737 * 738 * @param blob FDT blob 739 * @param node Offset of node to read 740 * @param name Name of node being read 741 * @param entry Place to put offset and size of this node 742 * @return 0 if ok, -ve on error 743 */ 744 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name, 745 struct fmap_entry *entry); 746 747 /** 748 * Obtain an indexed resource from a device property. 749 * 750 * @param fdt FDT blob 751 * @param node node to examine 752 * @param property name of the property to parse 753 * @param index index of the resource to retrieve 754 * @param res returns the resource 755 * @return 0 if ok, negative on error 756 */ 757 int fdt_get_resource(const void *fdt, int node, const char *property, 758 unsigned int index, struct fdt_resource *res); 759 760 /** 761 * Obtain a named resource from a device property. 762 * 763 * Look up the index of the name in a list of strings and return the resource 764 * at that index. 765 * 766 * @param fdt FDT blob 767 * @param node node to examine 768 * @param property name of the property to parse 769 * @param prop_names name of the property containing the list of names 770 * @param name the name of the entry to look up 771 * @param res returns the resource 772 */ 773 int fdt_get_named_resource(const void *fdt, int node, const char *property, 774 const char *prop_names, const char *name, 775 struct fdt_resource *res); 776 777 /** 778 * Decode a named region within a memory bank of a given type. 779 * 780 * This function handles selection of a memory region. The region is 781 * specified as an offset/size within a particular type of memory. 782 * 783 * The properties used are: 784 * 785 * <mem_type>-memory<suffix> for the name of the memory bank 786 * <mem_type>-offset<suffix> for the offset in that bank 787 * 788 * The property value must have an offset and a size. The function checks 789 * that the region is entirely within the memory bank.5 790 * 791 * @param blob FDT blob 792 * @param node Node containing the properties (-1 for /config) 793 * @param mem_type Type of memory to use, which is a name, such as 794 * "u-boot" or "kernel". 795 * @param suffix String to append to the memory/offset 796 * property names 797 * @param basep Returns base of region 798 * @param sizep Returns size of region 799 * @return 0 if OK, -ive on error 800 */ 801 int fdtdec_decode_memory_region(const void *blob, int node, 802 const char *mem_type, const char *suffix, 803 fdt_addr_t *basep, fdt_size_t *sizep); 804 805 /** 806 * Set up the device tree ready for use 807 */ 808 int fdtdec_setup(void); 809 810 #endif 811