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