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