include/fdtdec.h

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