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_TEGRA114_I2C, /* Tegra114 I2C w/single clock source */ 119 COMPAT_NVIDIA_TEGRA20_I2C, /* Tegra20 i2c */ 120 COMPAT_NVIDIA_TEGRA20_DVC, /* Tegra20 dvc (really just i2c) */ 121 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */ 122 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */ 123 COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */ 124 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */ 125 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */ 126 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */ 127 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */ 128 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */ 129 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */ 130 COMPAT_NVIDIA_TEGRA20_SFLASH, /* Tegra 2 SPI flash controller */ 131 COMPAT_NVIDIA_TEGRA20_SLINK, /* Tegra 2 SPI SLINK controller */ 132 COMPAT_NVIDIA_TEGRA114_SPI, /* Tegra 114 SPI controller */ 133 COMPAT_NVIDIA_TEGRA124_PCIE, /* Tegra 124 PCIe controller */ 134 COMPAT_NVIDIA_TEGRA30_PCIE, /* Tegra 30 PCIe controller */ 135 COMPAT_NVIDIA_TEGRA20_PCIE, /* Tegra 20 PCIe controller */ 136 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL, 137 /* Tegra124 XUSB pad controller */ 138 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */ 139 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */ 140 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */ 141 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */ 142 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */ 143 COMPAT_SAMSUNG_EXYNOS_SPI, /* Exynos SPI */ 144 COMPAT_GOOGLE_CROS_EC, /* Google CROS_EC Protocol */ 145 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */ 146 COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */ 147 COMPAT_SAMSUNG_EXYNOS5_XHCI, /* Exynos5 XHCI controller */ 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_HOST_EMULATION, /* Sandbox emulation of a function */ 164 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */ 165 COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */ 166 COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */ 167 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */ 168 COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */ 169 COMPAT_INTEL_LPC, /* Intel Low Pin Count I/F */ 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 177 COMPAT_COUNT, 178 }; 179 180 /* GPIOs are numbered from 0 */ 181 enum { 182 FDT_GPIO_NONE = -1U, /* an invalid GPIO used to end our list */ 183 184 FDT_GPIO_ACTIVE_LOW = 1 << 0, /* input is active low (else high) */ 185 }; 186 187 /* This is the state of a GPIO pin as defined by the fdt */ 188 struct fdt_gpio_state { 189 const char *name; /* name of the fdt property defining this */ 190 uint gpio; /* GPIO number, or FDT_GPIO_NONE if none */ 191 u8 flags; /* FDT_GPIO_... flags */ 192 }; 193 194 /* This tells us whether a fdt_gpio_state record is valid or not */ 195 #define fdt_gpio_isvalid(x) ((x)->gpio != FDT_GPIO_NONE) 196 197 /** 198 * Read the GPIO taking into account the polarity of the pin. 199 * 200 * @param gpio pointer to the decoded gpio 201 * @return value of the gpio if successful, < 0 if unsuccessful 202 */ 203 int fdtdec_get_gpio(struct fdt_gpio_state *gpio); 204 205 /** 206 * Write the GPIO taking into account the polarity of the pin. 207 * 208 * @param gpio pointer to the decoded gpio 209 * @return 0 if successful 210 */ 211 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val); 212 213 /** 214 * Find the next numbered alias for a peripheral. This is used to enumerate 215 * all the peripherals of a certain type. 216 * 217 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then 218 * this function will return a pointer to the node the alias points to, and 219 * then update *upto to 1. Next time you call this function, the next node 220 * will be returned. 221 * 222 * All nodes returned will match the compatible ID, as it is assumed that 223 * all peripherals use the same driver. 224 * 225 * @param blob FDT blob to use 226 * @param name Root name of alias to search for 227 * @param id Compatible ID to look for 228 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 229 */ 230 int fdtdec_next_alias(const void *blob, const char *name, 231 enum fdt_compat_id id, int *upto); 232 233 /** 234 * Find the compatible ID for a given node. 235 * 236 * Generally each node has at least one compatible string attached to it. 237 * This function looks through our list of known compatible strings and 238 * returns the corresponding ID which matches the compatible string. 239 * 240 * @param blob FDT blob to use 241 * @param node Node containing compatible string to find 242 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match 243 */ 244 enum fdt_compat_id fdtdec_lookup(const void *blob, int node); 245 246 /** 247 * Find the next compatible node for a peripheral. 248 * 249 * Do the first call with node = 0. This function will return a pointer to 250 * the next compatible node. Next time you call this function, pass the 251 * value returned, and the next node will be provided. 252 * 253 * @param blob FDT blob to use 254 * @param node Start node for search 255 * @param id Compatible ID to look for (enum fdt_compat_id) 256 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 257 */ 258 int fdtdec_next_compatible(const void *blob, int node, 259 enum fdt_compat_id id); 260 261 /** 262 * Find the next compatible subnode for a peripheral. 263 * 264 * Do the first call with node set to the parent and depth = 0. This 265 * function will return the offset of the next compatible node. Next time 266 * you call this function, pass the node value returned last time, with 267 * depth unchanged, and the next node will be provided. 268 * 269 * @param blob FDT blob to use 270 * @param node Start node for search 271 * @param id Compatible ID to look for (enum fdt_compat_id) 272 * @param depthp Current depth (set to 0 before first call) 273 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more 274 */ 275 int fdtdec_next_compatible_subnode(const void *blob, int node, 276 enum fdt_compat_id id, int *depthp); 277 278 /** 279 * Look up an address property in a node and return it as an address. 280 * The property must hold either one address with no trailing data or 281 * one address with a length. This is only tested on 32-bit machines. 282 * 283 * @param blob FDT blob 284 * @param node node to examine 285 * @param prop_name name of property to find 286 * @return address, if found, or FDT_ADDR_T_NONE if not 287 */ 288 fdt_addr_t fdtdec_get_addr(const void *blob, int node, 289 const char *prop_name); 290 291 /** 292 * Look up an address property in a node and return it as an address. 293 * The property must hold one address with a length. This is only tested 294 * on 32-bit machines. 295 * 296 * @param blob FDT blob 297 * @param node node to examine 298 * @param prop_name name of property to find 299 * @return address, if found, or FDT_ADDR_T_NONE if not 300 */ 301 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, 302 const char *prop_name, fdt_size_t *sizep); 303 304 /** 305 * Look at an address property in a node and return the pci address which 306 * corresponds to the given type in the form of fdt_pci_addr. 307 * The property must hold one fdt_pci_addr with a lengh. 308 * 309 * @param blob FDT blob 310 * @param node node to examine 311 * @param type pci address type (FDT_PCI_SPACE_xxx) 312 * @param prop_name name of property to find 313 * @param addr returns pci address in the form of fdt_pci_addr 314 * @return 0 if ok, negative on error 315 */ 316 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type, 317 const char *prop_name, struct fdt_pci_addr *addr); 318 319 /** 320 * Look at the compatible property of a device node that represents a PCI 321 * device and extract pci vendor id and device id from it. 322 * 323 * @param blob FDT blob 324 * @param node node to examine 325 * @param vendor vendor id of the pci device 326 * @param device device id of the pci device 327 * @return 0 if ok, negative on error 328 */ 329 int fdtdec_get_pci_vendev(const void *blob, int node, 330 u16 *vendor, u16 *device); 331 332 /** 333 * Look at the pci address of a device node that represents a PCI device 334 * and parse the bus, device and function number from it. 335 * 336 * @param blob FDT blob 337 * @param node node to examine 338 * @param addr pci address in the form of fdt_pci_addr 339 * @param bdf returns bus, device, function triplet 340 * @return 0 if ok, negative on error 341 */ 342 int fdtdec_get_pci_bdf(const void *blob, int node, 343 struct fdt_pci_addr *addr, pci_dev_t *bdf); 344 345 /** 346 * Look at the pci address of a device node that represents a PCI device 347 * and return base address of the pci device's registers. 348 * 349 * @param blob FDT blob 350 * @param node node to examine 351 * @param addr pci address in the form of fdt_pci_addr 352 * @param bar returns base address of the pci device's registers 353 * @return 0 if ok, negative on error 354 */ 355 int fdtdec_get_pci_bar32(const void *blob, int node, 356 struct fdt_pci_addr *addr, u32 *bar); 357 358 /** 359 * Look up a 32-bit integer property in a node and return it. The property 360 * must have at least 4 bytes of data. The value of the first cell is 361 * returned. 362 * 363 * @param blob FDT blob 364 * @param node node to examine 365 * @param prop_name name of property to find 366 * @param default_val default value to return if the property is not found 367 * @return integer value, if found, or default_val if not 368 */ 369 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, 370 s32 default_val); 371 372 /** 373 * Look up a 64-bit integer property in a node and return it. The property 374 * must have at least 8 bytes of data (2 cells). The first two cells are 375 * concatenated to form a 8 bytes value, where the first cell is top half and 376 * the second cell is bottom half. 377 * 378 * @param blob FDT blob 379 * @param node node to examine 380 * @param prop_name name of property to find 381 * @param default_val default value to return if the property is not found 382 * @return integer value, if found, or default_val if not 383 */ 384 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, 385 uint64_t default_val); 386 387 /** 388 * Checks whether a node is enabled. 389 * This looks for a 'status' property. If this exists, then returns 1 if 390 * the status is 'ok' and 0 otherwise. If there is no status property, 391 * it returns 1 on the assumption that anything mentioned should be enabled 392 * by default. 393 * 394 * @param blob FDT blob 395 * @param node node to examine 396 * @return integer value 0 (not enabled) or 1 (enabled) 397 */ 398 int fdtdec_get_is_enabled(const void *blob, int node); 399 400 /** 401 * Make sure we have a valid fdt available to control U-Boot. 402 * 403 * If not, a message is printed to the console if the console is ready. 404 * 405 * @return 0 if all ok, -1 if not 406 */ 407 int fdtdec_prepare_fdt(void); 408 409 /** 410 * Checks that we have a valid fdt available to control U-Boot. 411 412 * However, if not then for the moment nothing is done, since this function 413 * is called too early to panic(). 414 * 415 * @returns 0 416 */ 417 int fdtdec_check_fdt(void); 418 419 /** 420 * Find the nodes for a peripheral and return a list of them in the correct 421 * order. This is used to enumerate all the peripherals of a certain type. 422 * 423 * To use this, optionally set up a /aliases node with alias properties for 424 * a peripheral. For example, for usb you could have: 425 * 426 * aliases { 427 * usb0 = "/ehci@c5008000"; 428 * usb1 = "/ehci@c5000000"; 429 * }; 430 * 431 * Pass "usb" as the name to this function and will return a list of two 432 * nodes offsets: /ehci@c5008000 and ehci@c5000000. 433 * 434 * All nodes returned will match the compatible ID, as it is assumed that 435 * all peripherals use the same driver. 436 * 437 * If no alias node is found, then the node list will be returned in the 438 * order found in the fdt. If the aliases mention a node which doesn't 439 * exist, then this will be ignored. If nodes are found with no aliases, 440 * they will be added in any order. 441 * 442 * If there is a gap in the aliases, then this function return a 0 node at 443 * that position. The return value will also count these gaps. 444 * 445 * This function checks node properties and will not return nodes which are 446 * marked disabled (status = "disabled"). 447 * 448 * @param blob FDT blob to use 449 * @param name Root name of alias to search for 450 * @param id Compatible ID to look for 451 * @param node_list Place to put list of found nodes 452 * @param maxcount Maximum number of nodes to find 453 * @return number of nodes found on success, FTD_ERR_... on error 454 */ 455 int fdtdec_find_aliases_for_id(const void *blob, const char *name, 456 enum fdt_compat_id id, int *node_list, int maxcount); 457 458 /* 459 * This function is similar to fdtdec_find_aliases_for_id() except that it 460 * adds to the node_list that is passed in. Any 0 elements are considered 461 * available for allocation - others are considered already used and are 462 * skipped. 463 * 464 * You can use this by calling fdtdec_find_aliases_for_id() with an 465 * uninitialised array, then setting the elements that are returned to -1, 466 * say, then calling this function, perhaps with a different compat id. 467 * Any elements you get back that are >0 are new nodes added by the call 468 * to this function. 469 * 470 * Note that if you have some nodes with aliases and some without, you are 471 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with 472 * one compat_id may fill in positions for which you have aliases defined 473 * for another compat_id. When you later call *this* function with the second 474 * compat_id, the alias positions may already be used. A debug warning may 475 * be generated in this case, but it is safest to define aliases for all 476 * nodes when you care about the ordering. 477 */ 478 int fdtdec_add_aliases_for_id(const void *blob, const char *name, 479 enum fdt_compat_id id, int *node_list, int maxcount); 480 481 /** 482 * Get the alias sequence number of a node 483 * 484 * This works out whether a node is pointed to by an alias, and if so, the 485 * sequence number of that alias. Aliases are of the form <base><num> where 486 * <num> is the sequence number. For example spi2 would be sequence number 487 * 2. 488 * 489 * @param blob Device tree blob (if NULL, then error is returned) 490 * @param base Base name for alias (before the underscore) 491 * @param node Node to look up 492 * @param seqp This is set to the sequence number if one is found, 493 * but otherwise the value is left alone 494 * @return 0 if a sequence was found, -ve if not 495 */ 496 int fdtdec_get_alias_seq(const void *blob, const char *base, int node, 497 int *seqp); 498 499 /** 500 * Get the offset of the given chosen node 501 * 502 * This looks up a property in /chosen containing the path to another node, 503 * then finds the offset of that node. 504 * 505 * @param blob Device tree blob (if NULL, then error is returned) 506 * @param name Property name, e.g. "stdout-path" 507 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_... 508 */ 509 int fdtdec_get_chosen_node(const void *blob, const char *name); 510 511 /* 512 * Get the name for a compatible ID 513 * 514 * @param id Compatible ID to look for 515 * @return compatible string for that id 516 */ 517 const char *fdtdec_get_compatible(enum fdt_compat_id id); 518 519 /* Look up a phandle and follow it to its node. Then return the offset 520 * of that node. 521 * 522 * @param blob FDT blob 523 * @param node node to examine 524 * @param prop_name name of property to find 525 * @return node offset if found, -ve error code on error 526 */ 527 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); 528 529 /** 530 * Look up a property in a node and return its contents in an integer 531 * array of given length. The property must have at least enough data for 532 * the array (4*count bytes). It may have more, but this will be ignored. 533 * 534 * @param blob FDT blob 535 * @param node node to examine 536 * @param prop_name name of property to find 537 * @param array array to fill with data 538 * @param count number of array elements 539 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, 540 * or -FDT_ERR_BADLAYOUT if not enough data 541 */ 542 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, 543 u32 *array, int count); 544 545 /** 546 * Look up a property in a node and return its contents in an integer 547 * array of given length. The property must exist but may have less data that 548 * expected (4*count bytes). It may have more, but this will be ignored. 549 * 550 * @param blob FDT blob 551 * @param node node to examine 552 * @param prop_name name of property to find 553 * @param array array to fill with data 554 * @param count number of array elements 555 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the 556 * property is not found 557 */ 558 int fdtdec_get_int_array_count(const void *blob, int node, 559 const char *prop_name, u32 *array, int count); 560 561 /** 562 * Look up a property in a node and return a pointer to its contents as a 563 * unsigned int array of given length. The property must have at least enough 564 * data for the array ('count' cells). It may have more, but this will be 565 * ignored. The data is not copied. 566 * 567 * Note that you must access elements of the array with fdt32_to_cpu(), 568 * since the elements will be big endian even on a little endian machine. 569 * 570 * @param blob FDT blob 571 * @param node node to examine 572 * @param prop_name name of property to find 573 * @param count number of array elements 574 * @return pointer to array if found, or NULL if the property is not 575 * found or there is not enough data 576 */ 577 const u32 *fdtdec_locate_array(const void *blob, int node, 578 const char *prop_name, int count); 579 580 /** 581 * Look up a boolean property in a node and return it. 582 * 583 * A boolean properly is true if present in the device tree and false if not 584 * present, regardless of its value. 585 * 586 * @param blob FDT blob 587 * @param node node to examine 588 * @param prop_name name of property to find 589 * @return 1 if the properly is present; 0 if it isn't present 590 */ 591 int fdtdec_get_bool(const void *blob, int node, const char *prop_name); 592 593 /** 594 * Decode a single GPIOs from an FDT. 595 * 596 * If the property is not found, then the GPIO structure will still be 597 * initialised, with gpio set to FDT_GPIO_NONE. This makes it easy to 598 * provide optional GPIOs. 599 * 600 * @param blob FDT blob to use 601 * @param node Node to look at 602 * @param prop_name Node property name 603 * @param gpio gpio elements to fill from FDT 604 * @return 0 if ok, -FDT_ERR_NOTFOUND if the property is missing. 605 */ 606 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name, 607 struct fdt_gpio_state *gpio); 608 609 /** 610 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no 611 * terminating item. 612 * 613 * @param blob FDT blob to use 614 * @param node Node to look at 615 * @param prop_name Node property name 616 * @param gpio Array of gpio elements to fill from FDT. This will be 617 * untouched if either 0 or an error is returned 618 * @param max_count Maximum number of elements allowed 619 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would 620 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing. 621 */ 622 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name, 623 struct fdt_gpio_state *gpio, int max_count); 624 625 /** 626 * Set up a GPIO pin according to the provided gpio information. At present this 627 * just requests the GPIO. 628 * 629 * If the gpio is FDT_GPIO_NONE, no action is taken. This makes it easy to 630 * deal with optional GPIOs. 631 * 632 * @param gpio GPIO info to use for set up 633 * @return 0 if all ok or gpio was FDT_GPIO_NONE; -1 on error 634 */ 635 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio); 636 637 /** 638 * Look in the FDT for a config item with the given name and return its value 639 * as a 32-bit integer. The property must have at least 4 bytes of data. The 640 * value of the first cell is returned. 641 * 642 * @param blob FDT blob to use 643 * @param prop_name Node property name 644 * @param default_val default value to return if the property is not found 645 * @return integer value, if found, or default_val if not 646 */ 647 int fdtdec_get_config_int(const void *blob, const char *prop_name, 648 int default_val); 649 650 /** 651 * Look in the FDT for a config item with the given name 652 * and return whether it exists. 653 * 654 * @param blob FDT blob 655 * @param prop_name property name to look up 656 * @return 1, if it exists, or 0 if not 657 */ 658 int fdtdec_get_config_bool(const void *blob, const char *prop_name); 659 660 /** 661 * Look in the FDT for a config item with the given name and return its value 662 * as a string. 663 * 664 * @param blob FDT blob 665 * @param prop_name property name to look up 666 * @returns property string, NULL on error. 667 */ 668 char *fdtdec_get_config_string(const void *blob, const char *prop_name); 669 670 /* 671 * Look up a property in a node and return its contents in a byte 672 * array of given length. The property must have at least enough data for 673 * the array (count bytes). It may have more, but this will be ignored. 674 * 675 * @param blob FDT blob 676 * @param node node to examine 677 * @param prop_name name of property to find 678 * @param array array to fill with data 679 * @param count number of array elements 680 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found, 681 * or -FDT_ERR_BADLAYOUT if not enough data 682 */ 683 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, 684 u8 *array, int count); 685 686 /** 687 * Look up a property in a node and return a pointer to its contents as a 688 * byte array of given length. The property must have at least enough data 689 * for the array (count bytes). It may have more, but this will be ignored. 690 * The data is not copied. 691 * 692 * @param blob FDT blob 693 * @param node node to examine 694 * @param prop_name name of property to find 695 * @param count number of array elements 696 * @return pointer to byte array if found, or NULL if the property is not 697 * found or there is not enough data 698 */ 699 const u8 *fdtdec_locate_byte_array(const void *blob, int node, 700 const char *prop_name, int count); 701 702 /** 703 * Look up a property in a node which contains a memory region address and 704 * size. Then return a pointer to this address. 705 * 706 * The property must hold one address with a length. This is only tested on 707 * 32-bit machines. 708 * 709 * @param blob FDT blob 710 * @param node node to examine 711 * @param prop_name name of property to find 712 * @param basep Returns base address of region 713 * @param size Returns size of region 714 * @return 0 if ok, -1 on error (property not found) 715 */ 716 int fdtdec_decode_region(const void *blob, int node, const char *prop_name, 717 fdt_addr_t *basep, fdt_size_t *sizep); 718 719 enum fmap_compress_t { 720 FMAP_COMPRESS_NONE, 721 FMAP_COMPRESS_LZO, 722 }; 723 724 enum fmap_hash_t { 725 FMAP_HASH_NONE, 726 FMAP_HASH_SHA1, 727 FMAP_HASH_SHA256, 728 }; 729 730 /* A flash map entry, containing an offset and length */ 731 struct fmap_entry { 732 uint32_t offset; 733 uint32_t length; 734 uint32_t used; /* Number of bytes used in region */ 735 enum fmap_compress_t compress_algo; /* Compression type */ 736 enum fmap_hash_t hash_algo; /* Hash algorithm */ 737 const uint8_t *hash; /* Hash value */ 738 int hash_size; /* Hash size */ 739 }; 740 741 /** 742 * Read a flash entry from the fdt 743 * 744 * @param blob FDT blob 745 * @param node Offset of node to read 746 * @param name Name of node being read 747 * @param entry Place to put offset and size of this node 748 * @return 0 if ok, -ve on error 749 */ 750 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name, 751 struct fmap_entry *entry); 752 753 /** 754 * Obtain an indexed resource from a device property. 755 * 756 * @param fdt FDT blob 757 * @param node node to examine 758 * @param property name of the property to parse 759 * @param index index of the resource to retrieve 760 * @param res returns the resource 761 * @return 0 if ok, negative on error 762 */ 763 int fdt_get_resource(const void *fdt, int node, const char *property, 764 unsigned int index, struct fdt_resource *res); 765 766 /** 767 * Obtain a named resource from a device property. 768 * 769 * Look up the index of the name in a list of strings and return the resource 770 * at that index. 771 * 772 * @param fdt FDT blob 773 * @param node node to examine 774 * @param property name of the property to parse 775 * @param prop_names name of the property containing the list of names 776 * @param name the name of the entry to look up 777 * @param res returns the resource 778 */ 779 int fdt_get_named_resource(const void *fdt, int node, const char *property, 780 const char *prop_names, const char *name, 781 struct fdt_resource *res); 782 783 /** 784 * Decode a named region within a memory bank of a given type. 785 * 786 * This function handles selection of a memory region. The region is 787 * specified as an offset/size within a particular type of memory. 788 * 789 * The properties used are: 790 * 791 * <mem_type>-memory<suffix> for the name of the memory bank 792 * <mem_type>-offset<suffix> for the offset in that bank 793 * 794 * The property value must have an offset and a size. The function checks 795 * that the region is entirely within the memory bank.5 796 * 797 * @param blob FDT blob 798 * @param node Node containing the properties (-1 for /config) 799 * @param mem_type Type of memory to use, which is a name, such as 800 * "u-boot" or "kernel". 801 * @param suffix String to append to the memory/offset 802 * property names 803 * @param basep Returns base of region 804 * @param sizep Returns size of region 805 * @return 0 if OK, -ive on error 806 */ 807 int fdtdec_decode_memory_region(const void *blob, int node, 808 const char *mem_type, const char *suffix, 809 fdt_addr_t *basep, fdt_size_t *sizep); 810 #endif 811