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