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