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