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