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_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  * @return address, if found, or FDT_ADDR_T_NONE if not
 301  */
 302 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
 303                 const char *prop_name, int index, int na, int ns,
 304                 fdt_size_t *sizep);
 305
 306 /*
 307  * Look up an address property in a node and return the parsed address, and
 308  * optionally the parsed size.
 309  *
 310  * This variant automatically determines the number of cells used to represent
 311  * the address and size by parsing the provided parent node's #address-cells
 312  * and #size-cells properties.
 313  *
 314  * @param blob  FDT blob
 315  * @param parent        parent node of @node
 316  * @param node  node to examine
 317  * @param prop_name     name of property to find
 318  * @param index which address to retrieve from a list of addresses. Often 0.
 319  * @param sizep a pointer to store the size into. Use NULL if not required
 320  * @return address, if found, or FDT_ADDR_T_NONE if not
 321  */
 322 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
 323                 int node, const char *prop_name, int index, fdt_size_t *sizep);
 324
 325 /*
 326  * Look up an address property in a node and return the parsed address, and
 327  * optionally the parsed size.
 328  *
 329  * This variant automatically determines the number of cells used to represent
 330  * the address and size by parsing the parent node's #address-cells
 331  * and #size-cells properties. The parent node is automatically found.
 332  *
 333  * The automatic parent lookup implemented by this function is slow.
 334  * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
 335  * possible.
 336  *
 337  * @param blob  FDT blob
 338  * @param parent        parent node of @node
 339  * @param node  node to examine
 340  * @param prop_name     name of property to find
 341  * @param index which address to retrieve from a list of addresses. Often 0.
 342  * @param sizep a pointer to store the size into. Use NULL if not required
 343  * @return address, if found, or FDT_ADDR_T_NONE if not
 344  */
 345 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
 346                 const char *prop_name, int index, fdt_size_t *sizep);
 347
 348 /*
 349  * Look up an address property in a node and return the parsed address.
 350  *
 351  * This variant hard-codes the number of cells used to represent the address
 352  * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
 353  * always returns the first address value in the property (index 0).
 354  *
 355  * Use of this function is not recommended due to the hard-coding of cell
 356  * counts. There is no programmatic validation that these hard-coded values
 357  * actually match the device tree content in any way at all. This assumption
 358  * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
 359  * set in the U-Boot build and exercising strict control over DT content to
 360  * ensure use of matching #address-cells/#size-cells properties. However, this
 361  * approach is error-prone; those familiar with DT will not expect the
 362  * assumption to exist, and could easily invalidate it. If the assumption is
 363  * invalidated, this function will not report the issue, and debugging will
 364  * be required. Instead, use fdtdec_get_addr_size_auto_parent().
 365  *
 366  * @param blob  FDT blob
 367  * @param node  node to examine
 368  * @param prop_name     name of property to find
 369  * @return address, if found, or FDT_ADDR_T_NONE if not
 370  */
 371 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
 372                 const char *prop_name);
 373
 374 /*
 375  * Look up an address property in a node and return the parsed address, and
 376  * optionally the parsed size.
 377  *
 378  * This variant hard-codes the number of cells used to represent the address
 379  * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
 380  * always returns the first address value in the property (index 0).
 381  *
 382  * Use of this function is not recommended due to the hard-coding of cell
 383  * counts. There is no programmatic validation that these hard-coded values
 384  * actually match the device tree content in any way at all. This assumption
 385  * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
 386  * set in the U-Boot build and exercising strict control over DT content to
 387  * ensure use of matching #address-cells/#size-cells properties. However, this
 388  * approach is error-prone; those familiar with DT will not expect the
 389  * assumption to exist, and could easily invalidate it. If the assumption is
 390  * invalidated, this function will not report the issue, and debugging will
 391  * be required. Instead, use fdtdec_get_addr_size_auto_parent().
 392  *
 393  * @param blob  FDT blob
 394  * @param node  node to examine
 395  * @param prop_name     name of property to find
 396  * @param sizep a pointer to store the size into. Use NULL if not required
 397  * @return address, if found, or FDT_ADDR_T_NONE if not
 398  */
 399 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
 400                 const char *prop_name, fdt_size_t *sizep);
 401
 402 /**
 403  * Look at an address property in a node and return the pci address which
 404  * corresponds to the given type in the form of fdt_pci_addr.
 405  * The property must hold one fdt_pci_addr with a lengh.
 406  *
 407  * @param blob          FDT blob
 408  * @param node          node to examine
 409  * @param type          pci address type (FDT_PCI_SPACE_xxx)
 410  * @param prop_name     name of property to find
 411  * @param addr          returns pci address in the form of fdt_pci_addr
 412  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
 413  *              format of the property was invalid, -ENXIO if the requested
 414  *              address type was not found
 415  */
 416 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
 417                 const char *prop_name, struct fdt_pci_addr *addr);
 418
 419 /**
 420  * Look at the compatible property of a device node that represents a PCI
 421  * device and extract pci vendor id and device id from it.
 422  *
 423  * @param blob          FDT blob
 424  * @param node          node to examine
 425  * @param vendor        vendor id of the pci device
 426  * @param device        device id of the pci device
 427  * @return 0 if ok, negative on error
 428  */
 429 int fdtdec_get_pci_vendev(const void *blob, int node,
 430                 u16 *vendor, u16 *device);
 431
 432 /**
 433  * Look at the pci address of a device node that represents a PCI device
 434  * and return base address of the pci device's registers.
 435  *
 436  * @param dev           device to examine
 437  * @param addr          pci address in the form of fdt_pci_addr
 438  * @param bar           returns base address of the pci device's registers
 439  * @return 0 if ok, negative on error
 440  */
 441 int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
 442                          u32 *bar);
 443
 444 /**
 445  * Look up a 32-bit integer property in a node and return it. The property
 446  * must have at least 4 bytes of data. The value of the first cell is
 447  * returned.
 448  *
 449  * @param blob  FDT blob
 450  * @param node  node to examine
 451  * @param prop_name     name of property to find
 452  * @param default_val   default value to return if the property is not found
 453  * @return integer value, if found, or default_val if not
 454  */
 455 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
 456                 s32 default_val);
 457
 458 /**
 459  * Unsigned version of fdtdec_get_int. The property must have at least
 460  * 4 bytes of data. The value of the first cell is returned.
 461  *
 462  * @param blob  FDT blob
 463  * @param node  node to examine
 464  * @param prop_name     name of property to find
 465  * @param default_val   default value to return if the property is not found
 466  * @return unsigned integer value, if found, or default_val if not
 467  */
 468 unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
 469                         unsigned int default_val);
 470
 471 /**
 472  * Get a variable-sized number from a property
 473  *
 474  * This reads a number from one or more cells.
 475  *
 476  * @param ptr   Pointer to property
 477  * @param cells Number of cells containing the number
 478  * @return the value in the cells
 479  */
 480 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
 481
 482 /**
 483  * Look up a 64-bit integer property in a node and return it. The property
 484  * must have at least 8 bytes of data (2 cells). The first two cells are
 485  * concatenated to form a 8 bytes value, where the first cell is top half and
 486  * the second cell is bottom half.
 487  *
 488  * @param blob  FDT blob
 489  * @param node  node to examine
 490  * @param prop_name     name of property to find
 491  * @param default_val   default value to return if the property is not found
 492  * @return integer value, if found, or default_val if not
 493  */
 494 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
 495                 uint64_t default_val);
 496
 497 /**
 498  * Checks whether a node is enabled.
 499  * This looks for a 'status' property. If this exists, then returns 1 if
 500  * the status is 'ok' and 0 otherwise. If there is no status property,
 501  * it returns 1 on the assumption that anything mentioned should be enabled
 502  * by default.
 503  *
 504  * @param blob  FDT blob
 505  * @param node  node to examine
 506  * @return integer value 0 (not enabled) or 1 (enabled)
 507  */
 508 int fdtdec_get_is_enabled(const void *blob, int node);
 509
 510 /**
 511  * Make sure we have a valid fdt available to control U-Boot.
 512  *
 513  * If not, a message is printed to the console if the console is ready.
 514  *
 515  * @return 0 if all ok, -1 if not
 516  */
 517 int fdtdec_prepare_fdt(void);
 518
 519 /**
 520  * Checks that we have a valid fdt available to control U-Boot.
 521
 522  * However, if not then for the moment nothing is done, since this function
 523  * is called too early to panic().
 524  *
 525  * @returns 0
 526  */
 527 int fdtdec_check_fdt(void);
 528
 529 /**
 530  * Find the nodes for a peripheral and return a list of them in the correct
 531  * order. This is used to enumerate all the peripherals of a certain type.
 532  *
 533  * To use this, optionally set up a /aliases node with alias properties for
 534  * a peripheral. For example, for usb you could have:
 535  *
 536  * aliases {
 537  *              usb0 = "/ehci@c5008000";
 538  *              usb1 = "/ehci@c5000000";
 539  * };
 540  *
 541  * Pass "usb" as the name to this function and will return a list of two
 542  * nodes offsets: /ehci@c5008000 and ehci@c5000000.
 543  *
 544  * All nodes returned will match the compatible ID, as it is assumed that
 545  * all peripherals use the same driver.
 546  *
 547  * If no alias node is found, then the node list will be returned in the
 548  * order found in the fdt. If the aliases mention a node which doesn't
 549  * exist, then this will be ignored. If nodes are found with no aliases,
 550  * they will be added in any order.
 551  *
 552  * If there is a gap in the aliases, then this function return a 0 node at
 553  * that position. The return value will also count these gaps.
 554  *
 555  * This function checks node properties and will not return nodes which are
 556  * marked disabled (status = "disabled").
 557  *
 558  * @param blob          FDT blob to use
 559  * @param name          Root name of alias to search for
 560  * @param id            Compatible ID to look for
 561  * @param node_list     Place to put list of found nodes
 562  * @param maxcount      Maximum number of nodes to find
 563  * @return number of nodes found on success, FDT_ERR_... on error
 564  */
 565 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
 566                         enum fdt_compat_id id, int *node_list, int maxcount);
 567
 568 /*
 569  * This function is similar to fdtdec_find_aliases_for_id() except that it
 570  * adds to the node_list that is passed in. Any 0 elements are considered
 571  * available for allocation - others are considered already used and are
 572  * skipped.
 573  *
 574  * You can use this by calling fdtdec_find_aliases_for_id() with an
 575  * uninitialised array, then setting the elements that are returned to -1,
 576  * say, then calling this function, perhaps with a different compat id.
 577  * Any elements you get back that are >0 are new nodes added by the call
 578  * to this function.
 579  *
 580  * Note that if you have some nodes with aliases and some without, you are
 581  * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
 582  * one compat_id may fill in positions for which you have aliases defined
 583  * for another compat_id. When you later call *this* function with the second
 584  * compat_id, the alias positions may already be used. A debug warning may
 585  * be generated in this case, but it is safest to define aliases for all
 586  * nodes when you care about the ordering.
 587  */
 588 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
 589                         enum fdt_compat_id id, int *node_list, int maxcount);
 590
 591 /**
 592  * Get the alias sequence number of a node
 593  *
 594  * This works out whether a node is pointed to by an alias, and if so, the
 595  * sequence number of that alias. Aliases are of the form <base><num> where
 596  * <num> is the sequence number. For example spi2 would be sequence number
 597  * 2.
 598  *
 599  * @param blob          Device tree blob (if NULL, then error is returned)
 600  * @param base          Base name for alias (before the underscore)
 601  * @param node          Node to look up
 602  * @param seqp          This is set to the sequence number if one is found,
 603  *                      but otherwise the value is left alone
 604  * @return 0 if a sequence was found, -ve if not
 605  */
 606 int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
 607                          int *seqp);
 608
 609 /**
 610  * Get a property from the /chosen node
 611  *
 612  * @param blob          Device tree blob (if NULL, then NULL is returned)
 613  * @param name          Property name to look up
 614  * @return Value of property, or NULL if it does not exist
 615  */
 616 const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
 617
 618 /**
 619  * Get the offset of the given /chosen node
 620  *
 621  * This looks up a property in /chosen containing the path to another node,
 622  * then finds the offset of that node.
 623  *
 624  * @param blob          Device tree blob (if NULL, then error is returned)
 625  * @param name          Property name, e.g. "stdout-path"
 626  * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
 627  */
 628 int fdtdec_get_chosen_node(const void *blob, const char *name);
 629
 630 /*
 631  * Get the name for a compatible ID
 632  *
 633  * @param id            Compatible ID to look for
 634  * @return compatible string for that id
 635  */
 636 const char *fdtdec_get_compatible(enum fdt_compat_id id);
 637
 638 /* Look up a phandle and follow it to its node. Then return the offset
 639  * of that node.
 640  *
 641  * @param blob          FDT blob
 642  * @param node          node to examine
 643  * @param prop_name     name of property to find
 644  * @return node offset if found, -ve error code on error
 645  */
 646 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
 647
 648 /**
 649  * Look up a property in a node and return its contents in an integer
 650  * array of given length. The property must have at least enough data for
 651  * the array (4*count bytes). It may have more, but this will be ignored.
 652  *
 653  * @param blob          FDT blob
 654  * @param node          node to examine
 655  * @param prop_name     name of property to find
 656  * @param array         array to fill with data
 657  * @param count         number of array elements
 658  * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
 659  *              or -FDT_ERR_BADLAYOUT if not enough data
 660  */
 661 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
 662                 u32 *array, int count);
 663
 664 /**
 665  * Look up a property in a node and return its contents in an integer
 666  * array of given length. The property must exist but may have less data that
 667  * expected (4*count bytes). It may have more, but this will be ignored.
 668  *
 669  * @param blob          FDT blob
 670  * @param node          node to examine
 671  * @param prop_name     name of property to find
 672  * @param array         array to fill with data
 673  * @param count         number of array elements
 674  * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
 675  *              property is not found
 676  */
 677 int fdtdec_get_int_array_count(const void *blob, int node,
 678                                const char *prop_name, u32 *array, int count);
 679
 680 /**
 681  * Look up a property in a node and return a pointer to its contents as a
 682  * unsigned int array of given length. The property must have at least enough
 683  * data for the array ('count' cells). It may have more, but this will be
 684  * ignored. The data is not copied.
 685  *
 686  * Note that you must access elements of the array with fdt32_to_cpu(),
 687  * since the elements will be big endian even on a little endian machine.
 688  *
 689  * @param blob          FDT blob
 690  * @param node          node to examine
 691  * @param prop_name     name of property to find
 692  * @param count         number of array elements
 693  * @return pointer to array if found, or NULL if the property is not
 694  *              found or there is not enough data
 695  */
 696 const u32 *fdtdec_locate_array(const void *blob, int node,
 697                                const char *prop_name, int count);
 698
 699 /**
 700  * Look up a boolean property in a node and return it.
 701  *
 702  * A boolean properly is true if present in the device tree and false if not
 703  * present, regardless of its value.
 704  *
 705  * @param blob  FDT blob
 706  * @param node  node to examine
 707  * @param prop_name     name of property to find
 708  * @return 1 if the properly is present; 0 if it isn't present
 709  */
 710 int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
 711
 712 /*
 713  * Count child nodes of one parent node.
 714  *
 715  * @param blob  FDT blob
 716  * @param node  parent node
 717  * @return number of child node; 0 if there is not child node
 718  */
 719 int fdtdec_get_child_count(const void *blob, int node);
 720
 721 /**
 722  * Look in the FDT for a config item with the given name and return its value
 723  * as a 32-bit integer. The property must have at least 4 bytes of data. The
 724  * value of the first cell is returned.
 725  *
 726  * @param blob          FDT blob to use
 727  * @param prop_name     Node property name
 728  * @param default_val   default value to return if the property is not found
 729  * @return integer value, if found, or default_val if not
 730  */
 731 int fdtdec_get_config_int(const void *blob, const char *prop_name,
 732                 int default_val);
 733
 734 /**
 735  * Look in the FDT for a config item with the given name
 736  * and return whether it exists.
 737  *
 738  * @param blob          FDT blob
 739  * @param prop_name     property name to look up
 740  * @return 1, if it exists, or 0 if not
 741  */
 742 int fdtdec_get_config_bool(const void *blob, const char *prop_name);
 743
 744 /**
 745  * Look in the FDT for a config item with the given name and return its value
 746  * as a string.
 747  *
 748  * @param blob          FDT blob
 749  * @param prop_name     property name to look up
 750  * @returns property string, NULL on error.
 751  */
 752 char *fdtdec_get_config_string(const void *blob, const char *prop_name);
 753
 754 /*
 755  * Look up a property in a node and return its contents in a byte
 756  * array of given length. The property must have at least enough data for
 757  * the array (count bytes). It may have more, but this will be ignored.
 758  *
 759  * @param blob          FDT blob
 760  * @param node          node to examine
 761  * @param prop_name     name of property to find
 762  * @param array         array to fill with data
 763  * @param count         number of array elements
 764  * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
 765  *              or -FDT_ERR_BADLAYOUT if not enough data
 766  */
 767 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
 768                 u8 *array, int count);
 769
 770 /**
 771  * Look up a property in a node and return a pointer to its contents as a
 772  * byte array of given length. The property must have at least enough data
 773  * for the array (count bytes). It may have more, but this will be ignored.
 774  * The data is not copied.
 775  *
 776  * @param blob          FDT blob
 777  * @param node          node to examine
 778  * @param prop_name     name of property to find
 779  * @param count         number of array elements
 780  * @return pointer to byte array if found, or NULL if the property is not
 781  *              found or there is not enough data
 782  */
 783 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
 784                              const char *prop_name, int count);
 785
 786 /**
 787  * Look up a property in a node which contains a memory region address and
 788  * size. Then return a pointer to this address.
 789  *
 790  * The property must hold one address with a length. This is only tested on
 791  * 32-bit machines.
 792  *
 793  * @param blob          FDT blob
 794  * @param node          node to examine
 795  * @param prop_name     name of property to find
 796  * @param basep         Returns base address of region
 797  * @param size          Returns size of region
 798  * @return 0 if ok, -1 on error (property not found)
 799  */
 800 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
 801                          fdt_addr_t *basep, fdt_size_t *sizep);
 802
 803 enum fmap_compress_t {
 804         FMAP_COMPRESS_NONE,
 805         FMAP_COMPRESS_LZO,
 806 };
 807
 808 enum fmap_hash_t {
 809         FMAP_HASH_NONE,
 810         FMAP_HASH_SHA1,
 811         FMAP_HASH_SHA256,
 812 };
 813
 814 /* A flash map entry, containing an offset and length */
 815 struct fmap_entry {
 816         uint32_t offset;
 817         uint32_t length;
 818         uint32_t used;                  /* Number of bytes used in region */
 819         enum fmap_compress_t compress_algo;     /* Compression type */
 820         enum fmap_hash_t hash_algo;             /* Hash algorithm */
 821         const uint8_t *hash;                    /* Hash value */
 822         int hash_size;                          /* Hash size */
 823 };
 824
 825 /**
 826  * Read a flash entry from the fdt
 827  *
 828  * @param blob          FDT blob
 829  * @param node          Offset of node to read
 830  * @param name          Name of node being read
 831  * @param entry         Place to put offset and size of this node
 832  * @return 0 if ok, -ve on error
 833  */
 834 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
 835                            struct fmap_entry *entry);
 836
 837 /**
 838  * Obtain an indexed resource from a device property.
 839  *
 840  * @param fdt           FDT blob
 841  * @param node          node to examine
 842  * @param property      name of the property to parse
 843  * @param index         index of the resource to retrieve
 844  * @param res           returns the resource
 845  * @return 0 if ok, negative on error
 846  */
 847 int fdt_get_resource(const void *fdt, int node, const char *property,
 848                      unsigned int index, struct fdt_resource *res);
 849
 850 /**
 851  * Obtain a named resource from a device property.
 852  *
 853  * Look up the index of the name in a list of strings and return the resource
 854  * at that index.
 855  *
 856  * @param fdt           FDT blob
 857  * @param node          node to examine
 858  * @param property      name of the property to parse
 859  * @param prop_names    name of the property containing the list of names
 860  * @param name          the name of the entry to look up
 861  * @param res           returns the resource
 862  */
 863 int fdt_get_named_resource(const void *fdt, int node, const char *property,
 864                            const char *prop_names, const char *name,
 865                            struct fdt_resource *res);
 866
 867 /**
 868  * Decode a named region within a memory bank of a given type.
 869  *
 870  * This function handles selection of a memory region. The region is
 871  * specified as an offset/size within a particular type of memory.
 872  *
 873  * The properties used are:
 874  *
 875  *      <mem_type>-memory<suffix> for the name of the memory bank
 876  *      <mem_type>-offset<suffix> for the offset in that bank
 877  *
 878  * The property value must have an offset and a size. The function checks
 879  * that the region is entirely within the memory bank.5
 880  *
 881  * @param blob          FDT blob
 882  * @param node          Node containing the properties (-1 for /config)
 883  * @param mem_type      Type of memory to use, which is a name, such as
 884  *                      "u-boot" or "kernel".
 885  * @param suffix        String to append to the memory/offset
 886  *                      property names
 887  * @param basep         Returns base of region
 888  * @param sizep         Returns size of region
 889  * @return 0 if OK, -ive on error
 890  */
 891 int fdtdec_decode_memory_region(const void *blob, int node,
 892                                 const char *mem_type, const char *suffix,
 893                                 fdt_addr_t *basep, fdt_size_t *sizep);
 894
 895 /* Display timings from linux include/video/display_timing.h */
 896 enum display_flags {
 897         DISPLAY_FLAGS_HSYNC_LOW         = 1 << 0,
 898         DISPLAY_FLAGS_HSYNC_HIGH        = 1 << 1,
 899         DISPLAY_FLAGS_VSYNC_LOW         = 1 << 2,
 900         DISPLAY_FLAGS_VSYNC_HIGH        = 1 << 3,
 901
 902         /* data enable flag */
 903         DISPLAY_FLAGS_DE_LOW            = 1 << 4,
 904         DISPLAY_FLAGS_DE_HIGH           = 1 << 5,
 905         /* drive data on pos. edge */
 906         DISPLAY_FLAGS_PIXDATA_POSEDGE   = 1 << 6,
 907         /* drive data on neg. edge */
 908         DISPLAY_FLAGS_PIXDATA_NEGEDGE   = 1 << 7,
 909         DISPLAY_FLAGS_INTERLACED        = 1 << 8,
 910         DISPLAY_FLAGS_DOUBLESCAN        = 1 << 9,
 911         DISPLAY_FLAGS_DOUBLECLK         = 1 << 10,
 912 };
 913
 914 /*
 915  * A single signal can be specified via a range of minimal and maximal values
 916  * with a typical value, that lies somewhere inbetween.
 917  */
 918 struct timing_entry {
 919         u32 min;
 920         u32 typ;
 921         u32 max;
 922 };
 923
 924 /*
 925  * Single "mode" entry. This describes one set of signal timings a display can
 926  * have in one setting. This struct can later be converted to struct videomode
 927  * (see include/video/videomode.h). As each timing_entry can be defined as a
 928  * range, one struct display_timing may become multiple struct videomodes.
 929  *
 930  * Example: hsync active high, vsync active low
 931  *
 932  *                                  Active Video
 933  * Video  ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
 934  *        |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
 935  *        |          |   porch  |                    |   porch   |
 936  *
 937  * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
 938  *
 939  * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
 940  */
 941 struct display_timing {
 942         struct timing_entry pixelclock;
 943
 944         struct timing_entry hactive;            /* hor. active video */
 945         struct timing_entry hfront_porch;       /* hor. front porch */
 946         struct timing_entry hback_porch;        /* hor. back porch */
 947         struct timing_entry hsync_len;          /* hor. sync len */
 948
 949         struct timing_entry vactive;            /* ver. active video */
 950         struct timing_entry vfront_porch;       /* ver. front porch */
 951         struct timing_entry vback_porch;        /* ver. back porch */
 952         struct timing_entry vsync_len;          /* ver. sync len */
 953
 954         enum display_flags flags;               /* display flags */
 955 };
 956
 957 /**
 958  * fdtdec_decode_display_timing() - decode display timings
 959  *
 960  * Decode display timings from the supplied 'display-timings' node.
 961  * See doc/device-tree-bindings/video/display-timing.txt for binding
 962  * information.
 963  *
 964  * @param blob          FDT blob
 965  * @param node          'display-timing' node containing the timing subnodes
 966  * @param index         Index number to read (0=first timing subnode)
 967  * @param config        Place to put timings
 968  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
 969  */
 970 int fdtdec_decode_display_timing(const void *blob, int node, int index,
 971                                  struct display_timing *config);
 972 /**
 973  * Set up the device tree ready for use
 974  */
 975 int fdtdec_setup(void);
 976
 977 #endif