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