include/fdtdec.h

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