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