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