include/dm/read.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Function to read values from the device tree node attached to a udevice.
   4  *
   5  * Copyright (c) 2017 Google, Inc
   6  * Written by Simon Glass <sjg@chromium.org>
   7  */
   8
   9 #ifndef _DM_READ_H
  10 #define _DM_READ_H
  11
  12 #include <linux/errno.h>
  13
  14 #include <dm/device.h>
  15 #include <dm/fdtaddr.h>
  16 #include <dm/ofnode.h>
  17 #include <dm/uclass.h>
  18
  19 struct resource;
  20
  21 #if CONFIG_IS_ENABLED(OF_LIVE)
  22 static inline const struct device_node *dev_np(const struct udevice *dev)
  23 {
  24         return ofnode_to_np(dev_ofnode(dev));
  25 }
  26 #else
  27 static inline const struct device_node *dev_np(const struct udevice *dev)
  28 {
  29         return NULL;
  30 }
  31 #endif
  32
  33 #if !defined(CONFIG_DM_DEV_READ_INLINE) || CONFIG_IS_ENABLED(OF_PLATDATA)
  34 /**
  35  * dev_read_u32() - read a 32-bit integer from a device's DT property
  36  *
  37  * @dev:        device to read DT property from
  38  * @propname:   name of the property to read from
  39  * @outp:       place to put value (if found)
  40  * @return 0 if OK, -ve on error
  41  */
  42 int dev_read_u32(const struct udevice *dev, const char *propname, u32 *outp);
  43
  44 /**
  45  * dev_read_u32_default() - read a 32-bit integer from a device's DT property
  46  *
  47  * @dev:        device to read DT property from
  48  * @propname:   name of the property to read from
  49  * @def:        default value to return if the property has no value
  50  * @return property value, or @def if not found
  51  */
  52 int dev_read_u32_default(const struct udevice *dev, const char *propname,
  53                          int def);
  54
  55 /**
  56  * dev_read_u32_index() - read an indexed 32-bit integer from a device's DT
  57  *                        property
  58  *
  59  * @dev:        device to read DT property from
  60  * @propname:   name of the property to read from
  61  * @index:      index of the integer to return
  62  * @outp:       place to put value (if found)
  63  * @return 0 if OK, -ve on error
  64  */
  65 int dev_read_u32_index(struct udevice *dev, const char *propname, int index,
  66                        u32 *outp);
  67
  68 /**
  69  * dev_read_u32_index_default() - read an indexed 32-bit integer from a device's
  70  *                                DT property
  71  *
  72  * @dev:        device to read DT property from
  73  * @propname:   name of the property to read from
  74  * @index:      index of the integer to return
  75  * @def:        default value to return if the property has no value
  76  * @return property value, or @def if not found
  77  */
  78 u32 dev_read_u32_index_default(struct udevice *dev, const char *propname,
  79                                int index, u32 def);
  80
  81 /**
  82  * dev_read_s32() - read a signed 32-bit integer from a device's DT property
  83  *
  84  * @dev:        device to read DT property from
  85  * @propname:   name of the property to read from
  86  * @outp:       place to put value (if found)
  87  * @return 0 if OK, -ve on error
  88  */
  89 int dev_read_s32(const struct udevice *dev, const char *propname, s32 *outp);
  90
  91 /**
  92  * dev_read_s32_default() - read a signed 32-bit int from a device's DT property
  93  *
  94  * @dev:        device to read DT property from
  95  * @propname:   name of the property to read from
  96  * @def:        default value to return if the property has no value
  97  * @return property value, or @def if not found
  98  */
  99 int dev_read_s32_default(const struct udevice *dev, const char *propname,
 100                          int def);
 101
 102 /**
 103  * dev_read_u32u() - read a 32-bit integer from a device's DT property
 104  *
 105  * This version uses a standard uint type.
 106  *
 107  * @dev:        device to read DT property from
 108  * @propname:   name of the property to read from
 109  * @outp:       place to put value (if found)
 110  * @return 0 if OK, -ve on error
 111  */
 112 int dev_read_u32u(const struct udevice *dev, const char *propname, uint *outp);
 113
 114 /**
 115  * dev_read_u64() - read a 64-bit integer from a device's DT property
 116  *
 117  * @dev:        device to read DT property from
 118  * @propname:   name of the property to read from
 119  * @outp:       place to put value (if found)
 120  * @return 0 if OK, -ve on error
 121  */
 122 int dev_read_u64(const struct udevice *dev, const char *propname, u64 *outp);
 123
 124 /**
 125  * dev_read_u64_default() - read a 64-bit integer from a device's DT property
 126  *
 127  * @dev:        device to read DT property from
 128  * @propname:   name of the property to read from
 129  * @def:        default value to return if the property has no value
 130  * @return property value, or @def if not found
 131  */
 132 u64 dev_read_u64_default(const struct udevice *dev, const char *propname,
 133                          u64 def);
 134
 135 /**
 136  * dev_read_string() - Read a string from a device's DT property
 137  *
 138  * @dev:        device to read DT property from
 139  * @propname:   name of the property to read
 140  * @return string from property value, or NULL if there is no such property
 141  */
 142 const char *dev_read_string(const struct udevice *dev, const char *propname);
 143
 144 /**
 145  * dev_read_bool() - read a boolean value from a device's DT property
 146  *
 147  * @dev:        device to read DT property from
 148  * @propname:   name of property to read
 149  * @return true if property is present (meaning true), false if not present
 150  */
 151 bool dev_read_bool(const struct udevice *dev, const char *propname);
 152
 153 /**
 154  * dev_read_subnode() - find a named subnode of a device
 155  *
 156  * @dev:        device whose DT node contains the subnode
 157  * @subnode_name: name of subnode to find
 158  * @return reference to subnode (which can be invalid if there is no such
 159  * subnode)
 160  */
 161 ofnode dev_read_subnode(const struct udevice *dev, const char *subbnode_name);
 162
 163 /**
 164  * dev_read_size() - read the size of a property
 165  *
 166  * @dev: device to check
 167  * @propname: property to check
 168  * @return size of property if present, or -EINVAL if not
 169  */
 170 int dev_read_size(const struct udevice *dev, const char *propname);
 171
 172 /**
 173  * dev_read_addr_index() - Get the indexed reg property of a device
 174  *
 175  * @dev: Device to read from
 176  * @index: the 'reg' property can hold a list of <addr, size> pairs
 177  *         and @index is used to select which one is required
 178  *
 179  * @return address or FDT_ADDR_T_NONE if not found
 180  */
 181 fdt_addr_t dev_read_addr_index(const struct udevice *dev, int index);
 182
 183 /**
 184  * dev_read_addr_index_ptr() - Get the indexed reg property of a device
 185  *                             as a pointer
 186  *
 187  * @dev: Device to read from
 188  * @index: the 'reg' property can hold a list of <addr, size> pairs
 189  *         and @index is used to select which one is required
 190  *
 191  * @return pointer or NULL if not found
 192  */
 193 void *dev_read_addr_index_ptr(const struct udevice *dev, int index);
 194
 195 /**
 196  * dev_read_addr_size_index() - Get the indexed reg property of a device
 197  *
 198  * @dev: Device to read from
 199  * @index: the 'reg' property can hold a list of <addr, size> pairs
 200  *         and @index is used to select which one is required
 201  * @size: place to put size value (on success)
 202  *
 203  * @return address or FDT_ADDR_T_NONE if not found
 204  */
 205 fdt_addr_t dev_read_addr_size_index(const struct udevice *dev, int index,
 206                                     fdt_size_t *size);
 207
 208 /**
 209  * dev_remap_addr_index() - Get the indexed reg property of a device
 210  *                               as a memory-mapped I/O pointer
 211  *
 212  * @dev: Device to read from
 213  * @index: the 'reg' property can hold a list of <addr, size> pairs
 214  *         and @index is used to select which one is required
 215  *
 216  * @return pointer or NULL if not found
 217  */
 218 void *dev_remap_addr_index(const struct udevice *dev, int index);
 219
 220 /**
 221  * dev_read_addr_name() - Get the reg property of a device, indexed by name
 222  *
 223  * @dev: Device to read from
 224  * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
 225  *        'reg-names' property providing named-based identification. @index
 226  *        indicates the value to search for in 'reg-names'.
 227  *
 228  * @return address or FDT_ADDR_T_NONE if not found
 229  */
 230 fdt_addr_t dev_read_addr_name(const struct udevice *dev, const char *name);
 231
 232 /**
 233  * dev_read_addr_size_name() - Get the reg property of a device, indexed by name
 234  *
 235  * @dev: Device to read from
 236  * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
 237  *        'reg-names' property providing named-based identification. @index
 238  *        indicates the value to search for in 'reg-names'.
 239  *  @size: place to put size value (on success)
 240  *
 241  * @return address or FDT_ADDR_T_NONE if not found
 242  */
 243 fdt_addr_t dev_read_addr_size_name(const struct udevice *dev, const char *name,
 244                                    fdt_size_t *size);
 245
 246 /**
 247  * dev_remap_addr_name() - Get the reg property of a device, indexed by name,
 248  *                         as a memory-mapped I/O pointer
 249  *
 250  * @dev: Device to read from
 251  * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
 252  *        'reg-names' property providing named-based identification. @index
 253  *        indicates the value to search for in 'reg-names'.
 254  *
 255  * @return pointer or NULL if not found
 256  */
 257 void *dev_remap_addr_name(const struct udevice *dev, const char *name);
 258
 259 /**
 260  * dev_read_addr() - Get the reg property of a device
 261  *
 262  * @dev: Device to read from
 263  *
 264  * @return address or FDT_ADDR_T_NONE if not found
 265  */
 266 fdt_addr_t dev_read_addr(const struct udevice *dev);
 267
 268 /**
 269  * dev_read_addr_ptr() - Get the reg property of a device
 270  *                       as a pointer
 271  *
 272  * @dev: Device to read from
 273  *
 274  * @return pointer or NULL if not found
 275  */
 276 void *dev_read_addr_ptr(const struct udevice *dev);
 277
 278 /**
 279  * dev_read_addr_pci() - Read an address and handle PCI address translation
 280  *
 281  * At present U-Boot does not have address translation logic for PCI in the
 282  * livetree implementation (of_addr.c). This special function supports this for
 283  * the flat tree implementation.
 284  *
 285  * This function should be removed (and code should use dev_read() instead)
 286  * once:
 287  *
 288  * 1. PCI address translation is added; and either
 289  * 2. everything uses livetree where PCI translation is used (which is feasible
 290  *    in SPL and U-Boot proper) or PCI address translation is added to
 291  *    fdtdec_get_addr() and friends.
 292  *
 293  * @dev: Device to read from
 294  * @return address or FDT_ADDR_T_NONE if not found
 295  */
 296 fdt_addr_t dev_read_addr_pci(const struct udevice *dev);
 297
 298 /**
 299  * dev_remap_addr() - Get the reg property of a device as a
 300  *                         memory-mapped I/O pointer
 301  *
 302  * @dev: Device to read from
 303  *
 304  * @return pointer or NULL if not found
 305  */
 306 void *dev_remap_addr(const struct udevice *dev);
 307
 308 /**
 309  * dev_read_addr_size() - get address and size from a device property
 310  *
 311  * This does no address translation. It simply reads an property that contains
 312  * an address and a size value, one after the other.
 313  *
 314  * @dev: Device to read from
 315  * @propname: property to read
 316  * @sizep: place to put size value (on success)
 317  * @return address value, or FDT_ADDR_T_NONE on error
 318  */
 319 fdt_addr_t dev_read_addr_size(const struct udevice *dev, const char *propname,
 320                               fdt_size_t *sizep);
 321
 322 /**
 323  * dev_read_name() - get the name of a device's node
 324  *
 325  * @dev: Device to read from
 326  * @return name of node
 327  */
 328 const char *dev_read_name(const struct udevice *dev);
 329
 330 /**
 331  * dev_read_stringlist_search() - find string in a string list and return index
 332  *
 333  * Note that it is possible for this function to succeed on property values
 334  * that are not NUL-terminated. That's because the function will stop after
 335  * finding the first occurrence of @string. This can for example happen with
 336  * small-valued cell properties, such as #address-cells, when searching for
 337  * the empty string.
 338  *
 339  * @dev: device to check
 340  * @propname: name of the property containing the string list
 341  * @string: string to look up in the string list
 342  *
 343  * @return:
 344  *   the index of the string in the list of strings
 345  *   -ENODATA if the property is not found
 346  *   -EINVAL on some other error
 347  */
 348 int dev_read_stringlist_search(const struct udevice *dev, const char *property,
 349                                const char *string);
 350
 351 /**
 352  * dev_read_string_index() - obtain an indexed string from a string list
 353  *
 354  * @dev: device to examine
 355  * @propname: name of the property containing the string list
 356  * @index: index of the string to return
 357  * @out: return location for the string
 358  *
 359  * @return:
 360  *   length of string, if found or -ve error value if not found
 361  */
 362 int dev_read_string_index(const struct udevice *dev, const char *propname,
 363                           int index, const char **outp);
 364
 365 /**
 366  * dev_read_string_count() - find the number of strings in a string list
 367  *
 368  * @dev: device to examine
 369  * @propname: name of the property containing the string list
 370  * @return:
 371  *   number of strings in the list, or -ve error value if not found
 372  */
 373 int dev_read_string_count(const struct udevice *dev, const char *propname);
 374
 375 /**
 376  * dev_read_string_list() - read a list of strings
 377  *
 378  * This produces a list of string pointers with each one pointing to a string
 379  * in the string list. If the property does not exist, it returns {NULL}.
 380  *
 381  * The data is allocated and the caller is reponsible for freeing the return
 382  * value (the list of string pointers). The strings themselves may not be
 383  * changed as they point directly into the devicetree property.
 384  *
 385  * @dev: device to examine
 386  * @propname: name of the property containing the string list
 387  * @listp: returns an allocated, NULL-terminated list of strings if the return
 388  *      value is > 0, else is set to NULL
 389  * @return number of strings in list, 0 if none, -ENOMEM if out of memory,
 390  *      -ENOENT if no such property
 391  */
 392 int dev_read_string_list(const struct udevice *dev, const char *propname,
 393                          const char ***listp);
 394
 395 /**
 396  * dev_read_phandle_with_args() - Find a node pointed by phandle in a list
 397  *
 398  * This function is useful to parse lists of phandles and their arguments.
 399  * Returns 0 on success and fills out_args, on error returns appropriate
 400  * errno value.
 401  *
 402  * Caller is responsible to call of_node_put() on the returned out_args->np
 403  * pointer.
 404  *
 405  * Example:
 406  *
 407  * phandle1: node1 {
 408  *      #list-cells = <2>;
 409  * }
 410  *
 411  * phandle2: node2 {
 412  *      #list-cells = <1>;
 413  * }
 414  *
 415  * node3 {
 416  *      list = <&phandle1 1 2 &phandle2 3>;
 417  * }
 418  *
 419  * To get a device_node of the `node2' node you may call this:
 420  * dev_read_phandle_with_args(dev, "list", "#list-cells", 0, 1, &args);
 421  *
 422  * @dev:        device whose node containing a list
 423  * @list_name:  property name that contains a list
 424  * @cells_name: property name that specifies phandles' arguments count
 425  * @cells_count: Cell count to use if @cells_name is NULL
 426  * @index:      index of a phandle to parse out
 427  * @out_args:   optional pointer to output arguments structure (will be filled)
 428  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
 429  *      @list_name does not exist, -EINVAL if a phandle was not found,
 430  *      @cells_name could not be found, the arguments were truncated or there
 431  *      were too many arguments.
 432  */
 433 int dev_read_phandle_with_args(const struct udevice *dev, const char *list_name,
 434                                const char *cells_name, int cell_count,
 435                                int index, struct ofnode_phandle_args *out_args);
 436
 437 /**
 438  * dev_count_phandle_with_args() - Return phandle number in a list
 439  *
 440  * This function is usefull to get phandle number contained in a property list.
 441  * For example, this allows to allocate the right amount of memory to keep
 442  * clock's reference contained into the "clocks" property.
 443  *
 444  *
 445  * @dev:        device whose node containing a list
 446  * @list_name:  property name that contains a list
 447  * @cells_name: property name that specifies phandles' arguments count
 448  * @cells_count: Cell count to use if @cells_name is NULL
 449  * @Returns number of phandle found on success, on error returns appropriate
 450  * errno value.
 451  */
 452
 453 int dev_count_phandle_with_args(const struct udevice *dev,
 454                                 const char *list_name, const char *cells_name,
 455                                 int cell_count);
 456
 457 /**
 458  * dev_read_addr_cells() - Get the number of address cells for a device's node
 459  *
 460  * This walks back up the tree to find the closest #address-cells property
 461  * which controls the given node.
 462  *
 463  * @dev: device to check
 464  * @return number of address cells this node uses
 465  */
 466 int dev_read_addr_cells(const struct udevice *dev);
 467
 468 /**
 469  * dev_read_size_cells() - Get the number of size cells for a device's node
 470  *
 471  * This walks back up the tree to find the closest #size-cells property
 472  * which controls the given node.
 473  *
 474  * @dev: device to check
 475  * @return number of size cells this node uses
 476  */
 477 int dev_read_size_cells(const struct udevice *dev);
 478
 479 /**
 480  * dev_read_addr_cells() - Get the address cells property in a node
 481  *
 482  * This function matches fdt_address_cells().
 483  *
 484  * @dev: device to check
 485  * @return number of address cells this node uses
 486  */
 487 int dev_read_simple_addr_cells(const struct udevice *dev);
 488
 489 /**
 490  * dev_read_size_cells() - Get the size cells property in a node
 491  *
 492  * This function matches fdt_size_cells().
 493  *
 494  * @dev: device to check
 495  * @return number of size cells this node uses
 496  */
 497 int dev_read_simple_size_cells(const struct udevice *dev);
 498
 499 /**
 500  * dev_read_phandle() - Get the phandle from a device
 501  *
 502  * @dev: device to check
 503  * @return phandle (1 or greater), or 0 if no phandle or other error
 504  */
 505 int dev_read_phandle(const struct udevice *dev);
 506
 507 /**
 508  * dev_read_prop()- - read a property from a device's node
 509  *
 510  * @dev: device to check
 511  * @propname: property to read
 512  * @lenp: place to put length on success
 513  * @return pointer to property, or NULL if not found
 514  */
 515 const void *dev_read_prop(const struct udevice *dev, const char *propname,
 516                           int *lenp);
 517
 518 /**
 519  * dev_read_first_prop()- get the reference of the first property
 520  *
 521  * Get reference to the first property of the node, it is used to iterate
 522  * and read all the property with dev_read_prop_by_prop().
 523  *
 524  * @dev: device to check
 525  * @prop: place to put argument reference
 526  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 527  */
 528 int dev_read_first_prop(const struct udevice *dev, struct ofprop *prop);
 529
 530 /**
 531  * ofnode_get_next_property() - get the reference of the next property
 532  *
 533  * Get reference to the next property of the node, it is used to iterate
 534  * and read all the property with dev_read_prop_by_prop().
 535  *
 536  * @prop: reference of current argument and place to put reference of next one
 537  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 538  */
 539 int dev_read_next_prop(struct ofprop *prop);
 540
 541 /**
 542  * dev_read_prop_by_prop() - get a pointer to the value of a property
 543  *
 544  * Get value for the property identified by the provided reference.
 545  *
 546  * @prop: reference on property
 547  * @propname: If non-NULL, place to property name on success,
 548  * @lenp: If non-NULL, place to put length on success
 549  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 550  */
 551 const void *dev_read_prop_by_prop(struct ofprop *prop,
 552                                   const char **propname, int *lenp);
 553
 554 /**
 555  * dev_read_alias_seq() - Get the alias sequence number of a node
 556  *
 557  * This works out whether a node is pointed to by an alias, and if so, the
 558  * sequence number of that alias. Aliases are of the form <base><num> where
 559  * <num> is the sequence number. For example spi2 would be sequence number 2.
 560  *
 561  * @dev: device to look up
 562  * @devnump: set to the sequence number if one is found
 563  * @return 0 if a sequence was found, -ve if not
 564  */
 565 int dev_read_alias_seq(const struct udevice *dev, int *devnump);
 566
 567 /**
 568  * dev_read_u32_array() - Find and read an array of 32 bit integers
 569  *
 570  * Search for a property in a device node and read 32-bit value(s) from
 571  * it.
 572  *
 573  * The out_values is modified only if a valid u32 value can be decoded.
 574  *
 575  * @dev: device to look up
 576  * @propname:   name of the property to read
 577  * @out_values: pointer to return value, modified only if return value is 0
 578  * @sz:         number of array elements to read
 579  * @return 0 on success, -EINVAL if the property does not exist, -ENODATA if
 580  * property does not have a value, and -EOVERFLOW if the property data isn't
 581  * large enough.
 582  */
 583 int dev_read_u32_array(const struct udevice *dev, const char *propname,
 584                        u32 *out_values, size_t sz);
 585
 586 /**
 587  * dev_read_first_subnode() - find the first subnode of a device's node
 588  *
 589  * @dev: device to look up
 590  * @return reference to the first subnode (which can be invalid if the device's
 591  * node has no subnodes)
 592  */
 593 ofnode dev_read_first_subnode(const struct udevice *dev);
 594
 595 /**
 596  * ofnode_next_subnode() - find the next sibling of a subnode
 597  *
 598  * @node:       valid reference to previous node (sibling)
 599  * @return reference to the next subnode (which can be invalid if the node
 600  * has no more siblings)
 601  */
 602 ofnode dev_read_next_subnode(ofnode node);
 603
 604 /**
 605  * dev_read_u8_array_ptr() - find an 8-bit array
 606  *
 607  * Look up a device's node property and return a pointer to its contents as a
 608  * byte array of given length. The property must have at least enough data
 609  * for the array (count bytes). It may have more, but this will be ignored.
 610  * The data is not copied.
 611  *
 612  * @dev: device to look up
 613  * @propname: name of property to find
 614  * @sz: number of array elements
 615  * @return pointer to byte array if found, or NULL if the property is not
 616  *              found or there is not enough data
 617  */
 618 const uint8_t *dev_read_u8_array_ptr(const struct udevice *dev,
 619                                      const char *propname, size_t sz);
 620
 621 /**
 622  * dev_read_enabled() - check whether a node is enabled
 623  *
 624  * This looks for a 'status' property. If this exists, then returns 1 if
 625  * the status is 'ok' and 0 otherwise. If there is no status property,
 626  * it returns 1 on the assumption that anything mentioned should be enabled
 627  * by default.
 628  *
 629  * @dev: device to examine
 630  * @return integer value 0 (not enabled) or 1 (enabled)
 631  */
 632 int dev_read_enabled(const struct udevice *dev);
 633
 634 /**
 635  * dev_read_resource() - obtain an indexed resource from a device.
 636  *
 637  * @dev: device to examine
 638  * @index index of the resource to retrieve (0 = first)
 639  * @res returns the resource
 640  * @return 0 if ok, negative on error
 641  */
 642 int dev_read_resource(const struct udevice *dev, uint index,
 643                       struct resource *res);
 644
 645 /**
 646  * dev_read_resource_byname() - obtain a named resource from a device.
 647  *
 648  * @dev: device to examine
 649  * @name: name of the resource to retrieve
 650  * @res: returns the resource
 651  * @return 0 if ok, negative on error
 652  */
 653 int dev_read_resource_byname(const struct udevice *dev, const char *name,
 654                              struct resource *res);
 655
 656 /**
 657  * dev_translate_address() - Translate a device-tree address
 658  *
 659  * Translate an address from the device-tree into a CPU physical address.  This
 660  * function walks up the tree and applies the various bus mappings along the
 661  * way.
 662  *
 663  * @dev: device giving the context in which to translate the address
 664  * @in_addr: pointer to the address to translate
 665  * @return the translated address; OF_BAD_ADDR on error
 666  */
 667 u64 dev_translate_address(const struct udevice *dev, const fdt32_t *in_addr);
 668
 669 /**
 670  * dev_translate_dma_address() - Translate a device-tree DMA address
 671  *
 672  * Translate a DMA address from the device-tree into a CPU physical address.
 673  * This function walks up the tree and applies the various bus mappings along
 674  * the way.
 675  *
 676  * @dev: device giving the context in which to translate the DMA address
 677  * @in_addr: pointer to the DMA address to translate
 678  * @return the translated DMA address; OF_BAD_ADDR on error
 679  */
 680 u64 dev_translate_dma_address(const struct udevice *dev,
 681                               const fdt32_t *in_addr);
 682
 683 /**
 684  * dev_get_dma_range() - Get a device's DMA constraints
 685  *
 686  * Provide the address bases and size of the linear mapping between the CPU and
 687  * a device's BUS address space.
 688  *
 689  * @dev: device giving the context in which to translate the DMA address
 690  * @cpu: base address for CPU's view of memory
 691  * @bus: base address for BUS's view of memory
 692  * @size: size of the address space
 693  * @return 0 if ok, negative on error
 694  */
 695 int dev_get_dma_range(const struct udevice *dev, phys_addr_t *cpu,
 696                       dma_addr_t *bus, u64 *size);
 697
 698 /**
 699  * dev_read_alias_highest_id - Get highest alias id for the given stem
 700  * @stem:       Alias stem to be examined
 701  *
 702  * The function travels the lookup table to get the highest alias id for the
 703  * given alias stem.
 704  * @return alias ID, if found, else -1
 705  */
 706 int dev_read_alias_highest_id(const char *stem);
 707
 708 /**
 709  * dev_get_child_count() - get the child count of a device
 710  *
 711  * @dev: device to use for interation (struct udevice *)
 712  * @return the count of child subnode
 713  */
 714 int dev_get_child_count(const struct udevice *dev);
 715
 716 /**
 717  * dev_read_pci_bus_range - Read PCI bus-range resource
 718  *
 719  * Look at the bus range property of a device node and return the pci bus
 720  * range for this node.
 721  *
 722  * @dev: device to examine
 723  * @res returns the resource
 724  * @return 0 if ok, negative on error
 725  */
 726 int dev_read_pci_bus_range(const struct udevice *dev, struct resource *res);
 727
 728 /**
 729  * dev_decode_display_timing() - decode display timings
 730  *
 731  * Decode display timings from the supplied 'display-timings' node.
 732  * See doc/device-tree-bindings/video/display-timing.txt for binding
 733  * information.
 734  *
 735  * @dev: device to read DT display timings from. The node linked to the device
 736  *       contains a child node called 'display-timings' which in turn contains
 737  *       one or more display timing nodes.
 738  * @index: index number to read (0=first timing subnode)
 739  * @config: place to put timings
 740  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
 741  */
 742 int dev_decode_display_timing(const struct udevice *dev, int index,
 743                               struct display_timing *config);
 744
 745 #else /* CONFIG_DM_DEV_READ_INLINE is enabled */
 746 #include <asm/global_data.h>
 747
 748 static inline int dev_read_u32(const struct udevice *dev,
 749                                const char *propname, u32 *outp)
 750 {
 751         return ofnode_read_u32(dev_ofnode(dev), propname, outp);
 752 }
 753
 754 static inline int dev_read_u32_default(const struct udevice *dev,
 755                                        const char *propname, int def)
 756 {
 757         return ofnode_read_u32_default(dev_ofnode(dev), propname, def);
 758 }
 759
 760 static inline int dev_read_u32_index(struct udevice *dev,
 761                                      const char *propname, int index, u32 *outp)
 762 {
 763         return ofnode_read_u32_index(dev_ofnode(dev), propname, index, outp);
 764 }
 765
 766 static inline u32 dev_read_u32_index_default(struct udevice *dev,
 767                                              const char *propname, int index,
 768                                              u32 def)
 769 {
 770         return ofnode_read_u32_index_default(dev_ofnode(dev), propname, index,
 771                                              def);
 772 }
 773
 774 static inline int dev_read_s32(const struct udevice *dev,
 775                                const char *propname, s32 *outp)
 776 {
 777         return ofnode_read_s32(dev_ofnode(dev), propname, outp);
 778 }
 779
 780 static inline int dev_read_s32_default(const struct udevice *dev,
 781                                        const char *propname, int def)
 782 {
 783         return ofnode_read_s32_default(dev_ofnode(dev), propname, def);
 784 }
 785
 786 static inline int dev_read_u32u(const struct udevice *dev,
 787                                 const char *propname, uint *outp)
 788 {
 789         u32 val;
 790         int ret;
 791
 792         ret = ofnode_read_u32(dev_ofnode(dev), propname, &val);
 793         if (ret)
 794                 return ret;
 795         *outp = val;
 796
 797         return 0;
 798 }
 799
 800 static inline int dev_read_u64(const struct udevice *dev,
 801                                const char *propname, u64 *outp)
 802 {
 803         return ofnode_read_u64(dev_ofnode(dev), propname, outp);
 804 }
 805
 806 static inline u64 dev_read_u64_default(const struct udevice *dev,
 807                                        const char *propname, u64 def)
 808 {
 809         return ofnode_read_u64_default(dev_ofnode(dev), propname, def);
 810 }
 811
 812 static inline const char *dev_read_string(const struct udevice *dev,
 813                                           const char *propname)
 814 {
 815         return ofnode_read_string(dev_ofnode(dev), propname);
 816 }
 817
 818 static inline bool dev_read_bool(const struct udevice *dev,
 819                                  const char *propname)
 820 {
 821         return ofnode_read_bool(dev_ofnode(dev), propname);
 822 }
 823
 824 static inline ofnode dev_read_subnode(const struct udevice *dev,
 825                                       const char *subbnode_name)
 826 {
 827         return ofnode_find_subnode(dev_ofnode(dev), subbnode_name);
 828 }
 829
 830 static inline int dev_read_size(const struct udevice *dev, const char *propname)
 831 {
 832         return ofnode_read_size(dev_ofnode(dev), propname);
 833 }
 834
 835 static inline fdt_addr_t dev_read_addr_index(const struct udevice *dev,
 836                                              int index)
 837 {
 838         return devfdt_get_addr_index(dev, index);
 839 }
 840
 841 static inline void *dev_read_addr_index_ptr(const struct udevice *dev,
 842                                             int index)
 843 {
 844         return devfdt_get_addr_index_ptr(dev, index);
 845 }
 846
 847 static inline fdt_addr_t dev_read_addr_size_index(const struct udevice *dev,
 848                                                   int index,
 849                                                   fdt_size_t *size)
 850 {
 851         return devfdt_get_addr_size_index(dev, index, size);
 852 }
 853
 854 static inline fdt_addr_t dev_read_addr_name(const struct udevice *dev,
 855                                             const char *name)
 856 {
 857         return devfdt_get_addr_name(dev, name);
 858 }
 859
 860 static inline fdt_addr_t dev_read_addr_size_name(const struct udevice *dev,
 861                                                  const char *name,
 862                                                  fdt_size_t *size)
 863 {
 864         return devfdt_get_addr_size_name(dev, name, size);
 865 }
 866
 867 static inline fdt_addr_t dev_read_addr(const struct udevice *dev)
 868 {
 869         return devfdt_get_addr(dev);
 870 }
 871
 872 static inline void *dev_read_addr_ptr(const struct udevice *dev)
 873 {
 874         return devfdt_get_addr_ptr(dev);
 875 }
 876
 877 static inline fdt_addr_t dev_read_addr_pci(const struct udevice *dev)
 878 {
 879         return devfdt_get_addr_pci(dev);
 880 }
 881
 882 static inline void *dev_remap_addr(const struct udevice *dev)
 883 {
 884         return devfdt_remap_addr(dev);
 885 }
 886
 887 static inline void *dev_remap_addr_index(const struct udevice *dev, int index)
 888 {
 889         return devfdt_remap_addr_index(dev, index);
 890 }
 891
 892 static inline void *dev_remap_addr_name(const struct udevice *dev,
 893                                         const char *name)
 894 {
 895         return devfdt_remap_addr_name(dev, name);
 896 }
 897
 898 static inline fdt_addr_t dev_read_addr_size(const struct udevice *dev,
 899                                             const char *propname,
 900                                             fdt_size_t *sizep)
 901 {
 902         return ofnode_get_addr_size(dev_ofnode(dev), propname, sizep);
 903 }
 904
 905 static inline const char *dev_read_name(const struct udevice *dev)
 906 {
 907         return ofnode_get_name(dev_ofnode(dev));
 908 }
 909
 910 static inline int dev_read_stringlist_search(const struct udevice *dev,
 911                                              const char *propname,
 912                                              const char *string)
 913 {
 914         return ofnode_stringlist_search(dev_ofnode(dev), propname, string);
 915 }
 916
 917 static inline int dev_read_string_index(const struct udevice *dev,
 918                                         const char *propname, int index,
 919                                         const char **outp)
 920 {
 921         return ofnode_read_string_index(dev_ofnode(dev), propname, index, outp);
 922 }
 923
 924 static inline int dev_read_string_count(const struct udevice *dev,
 925                                         const char *propname)
 926 {
 927         return ofnode_read_string_count(dev_ofnode(dev), propname);
 928 }
 929
 930 static inline int dev_read_string_list(const struct udevice *dev,
 931                                        const char *propname,
 932                                        const char ***listp)
 933 {
 934         return ofnode_read_string_list(dev_ofnode(dev), propname, listp);
 935 }
 936
 937 static inline int dev_read_phandle_with_args(const struct udevice *dev,
 938                 const char *list_name, const char *cells_name, int cell_count,
 939                 int index, struct ofnode_phandle_args *out_args)
 940 {
 941         return ofnode_parse_phandle_with_args(dev_ofnode(dev), list_name,
 942                                               cells_name, cell_count, index,
 943                                               out_args);
 944 }
 945
 946 static inline int dev_count_phandle_with_args(const struct udevice *dev,
 947                 const char *list_name, const char *cells_name, int cell_count)
 948 {
 949         return ofnode_count_phandle_with_args(dev_ofnode(dev), list_name,
 950                                               cells_name, cell_count);
 951 }
 952
 953 static inline int dev_read_addr_cells(const struct udevice *dev)
 954 {
 955         int parent = fdt_parent_offset(gd->fdt_blob, dev_of_offset(dev));
 956
 957         return fdt_address_cells(gd->fdt_blob, parent);
 958 }
 959
 960 static inline int dev_read_size_cells(const struct udevice *dev)
 961 {
 962         int parent = fdt_parent_offset(gd->fdt_blob, dev_of_offset(dev));
 963
 964         return fdt_size_cells(gd->fdt_blob, parent);
 965 }
 966
 967 static inline int dev_read_simple_addr_cells(const struct udevice *dev)
 968 {
 969         return fdt_address_cells(gd->fdt_blob, dev_of_offset(dev));
 970 }
 971
 972 static inline int dev_read_simple_size_cells(const struct udevice *dev)
 973 {
 974         return fdt_size_cells(gd->fdt_blob, dev_of_offset(dev));
 975 }
 976
 977 static inline int dev_read_phandle(const struct udevice *dev)
 978 {
 979         return fdt_get_phandle(gd->fdt_blob, dev_of_offset(dev));
 980 }
 981
 982 static inline const void *dev_read_prop(const struct udevice *dev,
 983                                         const char *propname, int *lenp)
 984 {
 985         return ofnode_get_property(dev_ofnode(dev), propname, lenp);
 986 }
 987
 988 static inline int dev_read_first_prop(const struct udevice *dev, struct ofprop *prop)
 989 {
 990         return ofnode_get_first_property(dev_ofnode(dev), prop);
 991 }
 992
 993 static inline int dev_read_next_prop(struct ofprop *prop)
 994 {
 995         return ofnode_get_next_property(prop);
 996 }
 997
 998 static inline const void *dev_read_prop_by_prop(struct ofprop *prop,
 999                                                 const char **propname,
1000                                                 int *lenp)
1001 {
1002         return ofnode_get_property_by_prop(prop, propname, lenp);
1003 }
1004
1005 static inline int dev_read_alias_seq(const struct udevice *dev, int *devnump)
1006 {
1007 #if CONFIG_IS_ENABLED(OF_CONTROL)
1008         return fdtdec_get_alias_seq(gd->fdt_blob, dev->uclass->uc_drv->name,
1009                                     dev_of_offset(dev), devnump);
1010 #else
1011         return -ENOTSUPP;
1012 #endif
1013 }
1014
1015 static inline int dev_read_u32_array(const struct udevice *dev,
1016                                      const char *propname, u32 *out_values,
1017                                      size_t sz)
1018 {
1019         return ofnode_read_u32_array(dev_ofnode(dev), propname, out_values, sz);
1020 }
1021
1022 static inline ofnode dev_read_first_subnode(const struct udevice *dev)
1023 {
1024         return ofnode_first_subnode(dev_ofnode(dev));
1025 }
1026
1027 static inline ofnode dev_read_next_subnode(ofnode node)
1028 {
1029         return ofnode_next_subnode(node);
1030 }
1031
1032 static inline const uint8_t *dev_read_u8_array_ptr(const struct udevice *dev,
1033                                                    const char *propname,
1034                                                    size_t sz)
1035 {
1036         return ofnode_read_u8_array_ptr(dev_ofnode(dev), propname, sz);
1037 }
1038
1039 static inline int dev_read_enabled(const struct udevice *dev)
1040 {
1041         return fdtdec_get_is_enabled(gd->fdt_blob, dev_of_offset(dev));
1042 }
1043
1044 static inline int dev_read_resource(const struct udevice *dev, uint index,
1045                                     struct resource *res)
1046 {
1047         return ofnode_read_resource(dev_ofnode(dev), index, res);
1048 }
1049
1050 static inline int dev_read_resource_byname(const struct udevice *dev,
1051                                            const char *name,
1052                                            struct resource *res)
1053 {
1054         return ofnode_read_resource_byname(dev_ofnode(dev), name, res);
1055 }
1056
1057 static inline u64 dev_translate_address(const struct udevice *dev,
1058                                         const fdt32_t *in_addr)
1059 {
1060         return ofnode_translate_address(dev_ofnode(dev), in_addr);
1061 }
1062
1063 static inline u64 dev_translate_dma_address(const struct udevice *dev,
1064                                             const fdt32_t *in_addr)
1065 {
1066         return ofnode_translate_dma_address(dev_ofnode(dev), in_addr);
1067 }
1068
1069 static inline int dev_get_dma_range(const struct udevice *dev, phys_addr_t *cpu,
1070                                     dma_addr_t *bus, u64 *size)
1071 {
1072         return ofnode_get_dma_range(dev_ofnode(dev), cpu, bus, size);
1073 }
1074
1075 static inline int dev_read_alias_highest_id(const char *stem)
1076 {
1077         if (!CONFIG_IS_ENABLED(OF_LIBFDT) || !gd->fdt_blob)
1078                 return -1;
1079         return fdtdec_get_alias_highest_id(gd->fdt_blob, stem);
1080 }
1081
1082 static inline int dev_get_child_count(const struct udevice *dev)
1083 {
1084         return ofnode_get_child_count(dev_ofnode(dev));
1085 }
1086
1087 static inline int dev_decode_display_timing(const struct udevice *dev,
1088                                             int index,
1089                                             struct display_timing *config)
1090 {
1091         return ofnode_decode_display_timing(dev_ofnode(dev), index, config);
1092 }
1093
1094 #endif /* CONFIG_DM_DEV_READ_INLINE */
1095
1096 /**
1097  * dev_for_each_subnode() - Helper function to iterate through subnodes
1098  *
1099  * This creates a for() loop which works through the subnodes in a device's
1100  * device-tree node.
1101  *
1102  * @subnode: ofnode holding the current subnode
1103  * @dev: device to use for interation (struct udevice *)
1104  */
1105 #define dev_for_each_subnode(subnode, dev) \
1106         for (subnode = dev_read_first_subnode(dev); \
1107              ofnode_valid(subnode); \
1108              subnode = ofnode_next_subnode(subnode))
1109
1110 /**
1111  * dev_for_each_property() - Helper function to iterate through property
1112  *
1113  * This creates a for() loop which works through the property in a device's
1114  * device-tree node.
1115  *
1116  * @prop: struct ofprop holding the current property
1117  * @dev: device to use for interation (struct udevice *)
1118  */
1119 #define dev_for_each_property(prop, dev) \
1120         for (int ret_prop = dev_read_first_prop(dev, &prop); \
1121              !ret_prop; \
1122              ret_prop = dev_read_next_prop(&prop))
1123
1124 #endif