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