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