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