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