include/dm/device.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2013 Google, Inc
   4  *
   5  * (C) Copyright 2012
   6  * Pavel Herrmann <morpheus.ibis@gmail.com>
   7  * Marek Vasut <marex@denx.de>
   8  */
   9
  10 #ifndef _DM_DEVICE_H
  11 #define _DM_DEVICE_H
  12
  13 #include <dm/ofnode.h>
  14 #include <dm/uclass-id.h>
  15 #include <fdtdec.h>
  16 #include <linker_lists.h>
  17 #include <linux/kernel.h>
  18 #include <linux/list.h>
  19 #include <linux/printk.h>
  20
  21 struct driver_info;
  22
  23 /* Driver is active (probed). Cleared when it is removed */
  24 #define DM_FLAG_ACTIVATED               (1 << 0)
  25
  26 /* DM is responsible for allocating and freeing plat */
  27 #define DM_FLAG_ALLOC_PDATA             (1 << 1)
  28
  29 /* DM should init this device prior to relocation */
  30 #define DM_FLAG_PRE_RELOC               (1 << 2)
  31
  32 /* DM is responsible for allocating and freeing parent_plat */
  33 #define DM_FLAG_ALLOC_PARENT_PDATA      (1 << 3)
  34
  35 /* DM is responsible for allocating and freeing uclass_plat */
  36 #define DM_FLAG_ALLOC_UCLASS_PDATA      (1 << 4)
  37
  38 /* Allocate driver private data on a DMA boundary */
  39 #define DM_FLAG_ALLOC_PRIV_DMA          (1 << 5)
  40
  41 /* Device is bound */
  42 #define DM_FLAG_BOUND                   (1 << 6)
  43
  44 /* Device name is allocated and should be freed on unbind() */
  45 #define DM_FLAG_NAME_ALLOCED            (1 << 7)
  46
  47 /* Device has platform data provided by of-platdata */
  48 #define DM_FLAG_OF_PLATDATA             (1 << 8)
  49
  50 /*
  51  * Call driver remove function to stop currently active DMA transfers or
  52  * give DMA buffers back to the HW / controller. This may be needed for
  53  * some drivers to do some final stage cleanup before the OS is called
  54  * (U-Boot exit)
  55  */
  56 #define DM_FLAG_ACTIVE_DMA              (1 << 9)
  57
  58 /*
  59  * Call driver remove function to do some final configuration, before
  60  * U-Boot exits and the OS is started
  61  */
  62 #define DM_FLAG_OS_PREPARE              (1 << 10)
  63
  64 /* DM does not enable/disable the power domains corresponding to this device */
  65 #define DM_FLAG_DEFAULT_PD_CTRL_OFF     (1 << 11)
  66
  67 /* Driver plat has been read. Cleared when the device is removed */
  68 #define DM_FLAG_PLATDATA_VALID          (1 << 12)
  69
  70 /*
  71  * Device is removed without switching off its power domain. This might
  72  * be required, i. e. for serial console (debug) output when booting OS.
  73  */
  74 #define DM_FLAG_REMOVE_WITH_PD_ON       (1 << 13)
  75
  76 /*
  77  * One or multiple of these flags are passed to device_remove() so that
  78  * a selective device removal as specified by the remove-stage and the
  79  * driver flags can be done.
  80  */
  81 enum {
  82         /* Normal remove, remove all devices */
  83         DM_REMOVE_NORMAL        = 1 << 0,
  84
  85         /* Remove devices with active DMA */
  86         DM_REMOVE_ACTIVE_DMA    = DM_FLAG_ACTIVE_DMA,
  87
  88         /* Remove devices which need some final OS preparation steps */
  89         DM_REMOVE_OS_PREPARE    = DM_FLAG_OS_PREPARE,
  90
  91         /* Add more use cases here */
  92
  93         /* Remove devices with any active flag */
  94         DM_REMOVE_ACTIVE_ALL    = DM_REMOVE_ACTIVE_DMA | DM_REMOVE_OS_PREPARE,
  95
  96         /* Don't power down any attached power domains */
  97         DM_REMOVE_NO_PD         = 1 << 1,
  98 };
  99
 100 /**
 101  * struct udevice - An instance of a driver
 102  *
 103  * This holds information about a device, which is a driver bound to a
 104  * particular port or peripheral (essentially a driver instance).
 105  *
 106  * A device will come into existence through a 'bind' call, either due to
 107  * a U_BOOT_DEVICE() macro (in which case plat is non-NULL) or a node
 108  * in the device tree (in which case of_offset is >= 0). In the latter case
 109  * we translate the device tree information into plat in a function
 110  * implemented by the driver of_to_plat method (called just before the
 111  * probe method if the device has a device tree node.
 112  *
 113  * All three of plat, priv and uclass_priv can be allocated by the
 114  * driver, or you can use the auto_alloc_size members of struct driver and
 115  * struct uclass_driver to have driver model do this automatically.
 116  *
 117  * @driver: The driver used by this device
 118  * @name: Name of device, typically the FDT node name
 119  * @plat: Configuration data for this device
 120  * @parent_plat: The parent bus's configuration data for this device
 121  * @uclass_plat: The uclass's configuration data for this device
 122  * @node: Reference to device tree node for this device
 123  * @driver_data: Driver data word for the entry that matched this device with
 124  *              its driver
 125  * @parent: Parent of this device, or NULL for the top level device
 126  * @priv: Private data for this device
 127  * @uclass: Pointer to uclass for this device
 128  * @uclass_priv: The uclass's private data for this device
 129  * @parent_priv: The parent's private data for this device
 130  * @uclass_node: Used by uclass to link its devices
 131  * @child_head: List of children of this device
 132  * @sibling_node: Next device in list of all devices
 133  * @flags: Flags for this device DM_FLAG_...
 134  * @sqq: Allocated sequence number for this device (-1 = none). This is set up
 135  * when the device is bound and is unique within the device's uclass. If the
 136  * device has an alias in the devicetree then that is used to set the sequence
 137  * number. Otherwise, the next available number is used. Sequence numbers are
 138  * used by certain commands that need device to be numbered (e.g. 'mmc dev')
 139  *
 140  * The following two fields are deprecated:
 141  * @req_seq: Requested sequence number for this device (-1 = any)
 142  * @seq: Allocated sequence number for this device (-1 = none). This is set up
 143  * when the device is probed and will be unique within the device's uclass.
 144  * @devres_head: List of memory allocations associated with this device.
 145  *              When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
 146  *              add to this list. Memory so-allocated will be freed
 147  *              automatically when the device is removed / unbound
 148  */
 149 struct udevice {
 150         const struct driver *driver;
 151         const char *name;
 152         void *plat;
 153         void *parent_plat;
 154         void *uclass_plat;
 155         ofnode node;
 156         ulong driver_data;
 157         struct udevice *parent;
 158         void *priv;
 159         struct uclass *uclass;
 160         void *uclass_priv;
 161         void *parent_priv;
 162         struct list_head uclass_node;
 163         struct list_head child_head;
 164         struct list_head sibling_node;
 165         uint32_t flags;
 166         int sqq;
 167         int req_seq;
 168         int seq;
 169 #ifdef CONFIG_DEVRES
 170         struct list_head devres_head;
 171 #endif
 172 };
 173
 174 /* Maximum sequence number supported */
 175 #define DM_MAX_SEQ      999
 176
 177 /* Returns the operations for a device */
 178 #define device_get_ops(dev)     (dev->driver->ops)
 179
 180 /* Returns non-zero if the device is active (probed and not removed) */
 181 #define device_active(dev)      ((dev)->flags & DM_FLAG_ACTIVATED)
 182
 183 static inline int dev_of_offset(const struct udevice *dev)
 184 {
 185         return ofnode_to_offset(dev->node);
 186 }
 187
 188 static inline bool dev_has_of_node(struct udevice *dev)
 189 {
 190         return ofnode_valid(dev->node);
 191 }
 192
 193 static inline int dev_seq(const struct udevice *dev)
 194 {
 195         return dev->seq;
 196 }
 197
 198 /**
 199  * struct udevice_id - Lists the compatible strings supported by a driver
 200  * @compatible: Compatible string
 201  * @data: Data for this compatible string
 202  */
 203 struct udevice_id {
 204         const char *compatible;
 205         ulong data;
 206 };
 207
 208 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 209 #define of_match_ptr(_ptr)      (_ptr)
 210 #else
 211 #define of_match_ptr(_ptr)      NULL
 212 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
 213
 214 /**
 215  * struct driver - A driver for a feature or peripheral
 216  *
 217  * This holds methods for setting up a new device, and also removing it.
 218  * The device needs information to set itself up - this is provided either
 219  * by plat or a device tree node (which we find by looking up
 220  * matching compatible strings with of_match).
 221  *
 222  * Drivers all belong to a uclass, representing a class of devices of the
 223  * same type. Common elements of the drivers can be implemented in the uclass,
 224  * or the uclass can provide a consistent interface to the drivers within
 225  * it.
 226  *
 227  * @name: Device name
 228  * @id: Identifies the uclass we belong to
 229  * @of_match: List of compatible strings to match, and any identifying data
 230  * for each.
 231  * @bind: Called to bind a device to its driver
 232  * @probe: Called to probe a device, i.e. activate it
 233  * @remove: Called to remove a device, i.e. de-activate it
 234  * @unbind: Called to unbind a device from its driver
 235  * @of_to_plat: Called before probe to decode device tree data
 236  * @child_post_bind: Called after a new child has been bound
 237  * @child_pre_probe: Called before a child device is probed. The device has
 238  * memory allocated but it has not yet been probed.
 239  * @child_post_remove: Called after a child device is removed. The device
 240  * has memory allocated but its device_remove() method has been called.
 241  * @priv_auto: If non-zero this is the size of the private data
 242  * to be allocated in the device's ->priv pointer. If zero, then the driver
 243  * is responsible for allocating any data required.
 244  * @plat_auto: If non-zero this is the size of the
 245  * platform data to be allocated in the device's ->plat pointer.
 246  * This is typically only useful for device-tree-aware drivers (those with
 247  * an of_match), since drivers which use plat will have the data
 248  * provided in the U_BOOT_DEVICE() instantiation.
 249  * @per_child_auto: Each device can hold private data owned by
 250  * its parent. If required this will be automatically allocated if this
 251  * value is non-zero.
 252  * @per_child_plat_auto: A bus likes to store information about
 253  * its children. If non-zero this is the size of this data, to be allocated
 254  * in the child's parent_plat pointer.
 255  * @ops: Driver-specific operations. This is typically a list of function
 256  * pointers defined by the driver, to implement driver functions required by
 257  * the uclass.
 258  * @flags: driver flags - see DM_FLAGS_...
 259  * @acpi_ops: Advanced Configuration and Power Interface (ACPI) operations,
 260  * allowing the device to add things to the ACPI tables passed to Linux
 261  */
 262 struct driver {
 263         char *name;
 264         enum uclass_id id;
 265         const struct udevice_id *of_match;
 266         int (*bind)(struct udevice *dev);
 267         int (*probe)(struct udevice *dev);
 268         int (*remove)(struct udevice *dev);
 269         int (*unbind)(struct udevice *dev);
 270         int (*of_to_plat)(struct udevice *dev);
 271         int (*child_post_bind)(struct udevice *dev);
 272         int (*child_pre_probe)(struct udevice *dev);
 273         int (*child_post_remove)(struct udevice *dev);
 274         int priv_auto;
 275         int plat_auto;
 276         int per_child_auto;
 277         int per_child_plat_auto;
 278         const void *ops;        /* driver-specific operations */
 279         uint32_t flags;
 280 #if CONFIG_IS_ENABLED(ACPIGEN)
 281         struct acpi_ops *acpi_ops;
 282 #endif
 283 };
 284
 285 /* Declare a new U-Boot driver */
 286 #define U_BOOT_DRIVER(__name)                                           \
 287         ll_entry_declare(struct driver, __name, driver)
 288
 289 /* Get a pointer to a given driver */
 290 #define DM_GET_DRIVER(__name)                                           \
 291         ll_entry_get(struct driver, __name, driver)
 292
 293 /**
 294  * Declare a macro to state a alias for a driver name. This macro will
 295  * produce no code but its information will be parsed by tools like
 296  * dtoc
 297  */
 298 #define U_BOOT_DRIVER_ALIAS(__name, __alias)
 299
 300 /**
 301  * dev_get_plat() - Get the platform data for a device
 302  *
 303  * This checks that dev is not NULL, but no other checks for now
 304  *
 305  * @dev         Device to check
 306  * @return platform data, or NULL if none
 307  */
 308 void *dev_get_plat(const struct udevice *dev);
 309
 310 /**
 311  * dev_get_parent_plat() - Get the parent platform data for a device
 312  *
 313  * This checks that dev is not NULL, but no other checks for now
 314  *
 315  * @dev         Device to check
 316  * @return parent's platform data, or NULL if none
 317  */
 318 void *dev_get_parent_plat(const struct udevice *dev);
 319
 320 /**
 321  * dev_get_uclass_plat() - Get the uclass platform data for a device
 322  *
 323  * This checks that dev is not NULL, but no other checks for now
 324  *
 325  * @dev         Device to check
 326  * @return uclass's platform data, or NULL if none
 327  */
 328 void *dev_get_uclass_plat(const struct udevice *dev);
 329
 330 /**
 331  * dev_get_priv() - Get the private data for a device
 332  *
 333  * This checks that dev is not NULL, but no other checks for now
 334  *
 335  * @dev         Device to check
 336  * @return private data, or NULL if none
 337  */
 338 void *dev_get_priv(const struct udevice *dev);
 339
 340 /**
 341  * dev_get_parent_priv() - Get the parent private data for a device
 342  *
 343  * The parent private data is data stored in the device but owned by the
 344  * parent. For example, a USB device may have parent data which contains
 345  * information about how to talk to the device over USB.
 346  *
 347  * This checks that dev is not NULL, but no other checks for now
 348  *
 349  * @dev         Device to check
 350  * @return parent data, or NULL if none
 351  */
 352 void *dev_get_parent_priv(const struct udevice *dev);
 353
 354 /**
 355  * dev_get_uclass_priv() - Get the private uclass data for a device
 356  *
 357  * This checks that dev is not NULL, but no other checks for now
 358  *
 359  * @dev         Device to check
 360  * @return private uclass data for this device, or NULL if none
 361  */
 362 void *dev_get_uclass_priv(const struct udevice *dev);
 363
 364 /**
 365  * struct dev_get_parent() - Get the parent of a device
 366  *
 367  * @child:      Child to check
 368  * @return parent of child, or NULL if this is the root device
 369  */
 370 struct udevice *dev_get_parent(const struct udevice *child);
 371
 372 /**
 373  * dev_get_driver_data() - get the driver data used to bind a device
 374  *
 375  * When a device is bound using a device tree node, it matches a
 376  * particular compatible string in struct udevice_id. This function
 377  * returns the associated data value for that compatible string. This is
 378  * the 'data' field in struct udevice_id.
 379  *
 380  * As an example, consider this structure:
 381  * static const struct udevice_id tegra_i2c_ids[] = {
 382  *      { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 },
 383  *      { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD },
 384  *      { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC },
 385  *      { }
 386  * };
 387  *
 388  * When driver model finds a driver for this it will store the 'data' value
 389  * corresponding to the compatible string it matches. This function returns
 390  * that value. This allows the driver to handle several variants of a device.
 391  *
 392  * For USB devices, this is the driver_info field in struct usb_device_id.
 393  *
 394  * @dev:        Device to check
 395  * @return driver data (0 if none is provided)
 396  */
 397 ulong dev_get_driver_data(const struct udevice *dev);
 398
 399 /**
 400  * dev_get_driver_ops() - get the device's driver's operations
 401  *
 402  * This checks that dev is not NULL, and returns the pointer to device's
 403  * driver's operations.
 404  *
 405  * @dev:        Device to check
 406  * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
 407  */
 408 const void *dev_get_driver_ops(const struct udevice *dev);
 409
 410 /**
 411  * device_get_uclass_id() - return the uclass ID of a device
 412  *
 413  * @dev:        Device to check
 414  * @return uclass ID for the device
 415  */
 416 enum uclass_id device_get_uclass_id(const struct udevice *dev);
 417
 418 /**
 419  * dev_get_uclass_name() - return the uclass name of a device
 420  *
 421  * This checks that dev is not NULL.
 422  *
 423  * @dev:        Device to check
 424  * @return  pointer to the uclass name for the device
 425  */
 426 const char *dev_get_uclass_name(const struct udevice *dev);
 427
 428 /**
 429  * device_get_child() - Get the child of a device by index
 430  *
 431  * Returns the numbered child, 0 being the first. This does not use
 432  * sequence numbers, only the natural order.
 433  *
 434  * @dev:        Parent device to check
 435  * @index:      Child index
 436  * @devp:       Returns pointer to device
 437  * @return 0 if OK, -ENODEV if no such device, other error if the device fails
 438  *         to probe
 439  */
 440 int device_get_child(const struct udevice *parent, int index,
 441                      struct udevice **devp);
 442
 443 /**
 444  * device_get_child_count() - Get the available child count of a device
 445  *
 446  * Returns the number of children to a device.
 447  *
 448  * @parent:     Parent device to check
 449  */
 450 int device_get_child_count(const struct udevice *parent);
 451
 452 /**
 453  * device_find_child_by_seq() - Find a child device based on a sequence
 454  *
 455  * This searches for a device with the given seq or req_seq.
 456  *
 457  * For seq, if an active device has this sequence it will be returned.
 458  * If there is no such device then this will return -ENODEV.
 459  *
 460  * For req_seq, if a device (whether activated or not) has this req_seq
 461  * value, that device will be returned. This is a strong indication that
 462  * the device will receive that sequence when activated.
 463  *
 464  * @parent: Parent device
 465  * @seq_or_req_seq: Sequence number to find (0=first)
 466  * @find_req_seq: true to find req_seq, false to find seq
 467  * @devp: Returns pointer to device (there is only one per for each seq).
 468  * Set to NULL if none is found
 469  * @return 0 if OK, -ve on error
 470  */
 471 int device_find_child_by_seq(const struct udevice *parent, int seq_or_req_seq,
 472                              bool find_req_seq, struct udevice **devp);
 473
 474 /**
 475  * device_get_child_by_seq() - Get a child device based on a sequence
 476  *
 477  * If an active device has this sequence it will be returned. If there is no
 478  * such device then this will check for a device that is requesting this
 479  * sequence.
 480  *
 481  * The device is probed to activate it ready for use.
 482  *
 483  * @parent: Parent device
 484  * @seq: Sequence number to find (0=first)
 485  * @devp: Returns pointer to device (there is only one per for each seq)
 486  * Set to NULL if none is found
 487  * @return 0 if OK, -ve on error
 488  */
 489 int device_get_child_by_seq(const struct udevice *parent, int seq,
 490                             struct udevice **devp);
 491
 492 /**
 493  * device_find_child_by_of_offset() - Find a child device based on FDT offset
 494  *
 495  * Locates a child device by its device tree offset.
 496  *
 497  * @parent: Parent device
 498  * @of_offset: Device tree offset to find
 499  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 500  * @return 0 if OK, -ve on error
 501  */
 502 int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
 503                                    struct udevice **devp);
 504
 505 /**
 506  * device_get_child_by_of_offset() - Get a child device based on FDT offset
 507  *
 508  * Locates a child device by its device tree offset.
 509  *
 510  * The device is probed to activate it ready for use.
 511  *
 512  * @parent: Parent device
 513  * @of_offset: Device tree offset to find
 514  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 515  * @return 0 if OK, -ve on error
 516  */
 517 int device_get_child_by_of_offset(const struct udevice *parent, int of_offset,
 518                                   struct udevice **devp);
 519
 520 /**
 521  * device_find_global_by_ofnode() - Get a device based on ofnode
 522  *
 523  * Locates a device by its device tree ofnode, searching globally throughout
 524  * the all driver model devices.
 525  *
 526  * The device is NOT probed
 527  *
 528  * @node: Device tree ofnode to find
 529  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 530  * @return 0 if OK, -ve on error
 531  */
 532
 533 int device_find_global_by_ofnode(ofnode node, struct udevice **devp);
 534
 535 /**
 536  * device_get_global_by_ofnode() - Get a device based on ofnode
 537  *
 538  * Locates a device by its device tree ofnode, searching globally throughout
 539  * the all driver model devices.
 540  *
 541  * The device is probed to activate it ready for use.
 542  *
 543  * @node: Device tree ofnode to find
 544  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 545  * @return 0 if OK, -ve on error
 546  */
 547 int device_get_global_by_ofnode(ofnode node, struct udevice **devp);
 548
 549 /**
 550  * device_get_by_driver_info() - Get a device based on driver_info
 551  *
 552  * Locates a device by its struct driver_info, by using its reference which
 553  * is updated during the bind process.
 554  *
 555  * The device is probed to activate it ready for use.
 556  *
 557  * @info: Struct driver_info
 558  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 559  * @return 0 if OK, -ve on error
 560  */
 561 int device_get_by_driver_info(const struct driver_info *info,
 562                               struct udevice **devp);
 563
 564 /**
 565  * device_get_by_driver_info_idx() - Get a device based on driver_info index
 566  *
 567  * Locates a device by its struct driver_info, by using its index number which
 568  * is written into the idx field of struct phandle_1_arg, etc.
 569  *
 570  * The device is probed to activate it ready for use.
 571  *
 572  * @idx: Index number of the driver_info structure (0=first)
 573  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 574  * @return 0 if OK, -ve on error
 575  */
 576 int device_get_by_driver_info_idx(uint idx, struct udevice **devp);
 577
 578 /**
 579  * device_find_first_child() - Find the first child of a device
 580  *
 581  * @parent: Parent device to search
 582  * @devp: Returns first child device, or NULL if none
 583  * @return 0
 584  */
 585 int device_find_first_child(const struct udevice *parent,
 586                             struct udevice **devp);
 587
 588 /**
 589  * device_find_next_child() - Find the next child of a device
 590  *
 591  * @devp: Pointer to previous child device on entry. Returns pointer to next
 592  *              child device, or NULL if none
 593  * @return 0
 594  */
 595 int device_find_next_child(struct udevice **devp);
 596
 597 /**
 598  * device_find_first_inactive_child() - Find the first inactive child
 599  *
 600  * This is used to locate an existing child of a device which is of a given
 601  * uclass.
 602  *
 603  * The device is NOT probed
 604  *
 605  * @parent:     Parent device to search
 606  * @uclass_id:  Uclass to look for
 607  * @devp:       Returns device found, if any
 608  * @return 0 if found, else -ENODEV
 609  */
 610 int device_find_first_inactive_child(const struct udevice *parent,
 611                                      enum uclass_id uclass_id,
 612                                      struct udevice **devp);
 613
 614 /**
 615  * device_find_first_child_by_uclass() - Find the first child of a device in uc
 616  *
 617  * @parent: Parent device to search
 618  * @uclass_id:  Uclass to look for
 619  * @devp: Returns first child device in that uclass, if any
 620  * @return 0 if found, else -ENODEV
 621  */
 622 int device_find_first_child_by_uclass(const struct udevice *parent,
 623                                       enum uclass_id uclass_id,
 624                                       struct udevice **devp);
 625
 626 /**
 627  * device_find_child_by_name() - Find a child by device name
 628  *
 629  * @parent:     Parent device to search
 630  * @name:       Name to look for
 631  * @devp:       Returns device found, if any
 632  * @return 0 if found, else -ENODEV
 633  */
 634 int device_find_child_by_name(const struct udevice *parent, const char *name,
 635                               struct udevice **devp);
 636
 637 /**
 638  * device_first_child_ofdata_err() - Find the first child and reads its plat
 639  *
 640  * The of_to_plat() method is called on the child before it is returned,
 641  * but the child is not probed.
 642  *
 643  * @parent: Parent to check
 644  * @devp: Returns child that was found, if any
 645  * @return 0 on success, -ENODEV if no children, other -ve on error
 646  */
 647 int device_first_child_ofdata_err(struct udevice *parent,
 648                                   struct udevice **devp);
 649
 650 /*
 651  * device_next_child_ofdata_err() - Find the next child and read its plat
 652  *
 653  * The of_to_plat() method is called on the child before it is returned,
 654  * but the child is not probed.
 655  *
 656  * @devp: On entry, points to the previous child; on exit returns the child that
 657  *      was found, if any
 658  * @return 0 on success, -ENODEV if no children, other -ve on error
 659  */
 660 int device_next_child_ofdata_err(struct udevice **devp);
 661
 662 /**
 663  * device_first_child_err() - Get the first child of a device
 664  *
 665  * The device returned is probed if necessary, and ready for use
 666  *
 667  * @parent:     Parent device to search
 668  * @devp:       Returns device found, if any
 669  * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
 670  */
 671 int device_first_child_err(struct udevice *parent, struct udevice **devp);
 672
 673 /**
 674  * device_next_child_err() - Get the next child of a parent device
 675  *
 676  * The device returned is probed if necessary, and ready for use
 677  *
 678  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 679  * to the next sibling if no error occurred
 680  * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
 681  */
 682 int device_next_child_err(struct udevice **devp);
 683
 684 /**
 685  * device_has_children() - check if a device has any children
 686  *
 687  * @dev:        Device to check
 688  * @return true if the device has one or more children
 689  */
 690 bool device_has_children(const struct udevice *dev);
 691
 692 /**
 693  * device_has_active_children() - check if a device has any active children
 694  *
 695  * @dev:        Device to check
 696  * @return true if the device has one or more children and at least one of
 697  * them is active (probed).
 698  */
 699 bool device_has_active_children(const struct udevice *dev);
 700
 701 /**
 702  * device_is_last_sibling() - check if a device is the last sibling
 703  *
 704  * This function can be useful for display purposes, when special action needs
 705  * to be taken when displaying the last sibling. This can happen when a tree
 706  * view of devices is being displayed.
 707  *
 708  * @dev:        Device to check
 709  * @return true if there are no more siblings after this one - i.e. is it
 710  * last in the list.
 711  */
 712 bool device_is_last_sibling(const struct udevice *dev);
 713
 714 /**
 715  * device_set_name() - set the name of a device
 716  *
 717  * This must be called in the device's bind() method and no later. Normally
 718  * this is unnecessary but for probed devices which don't get a useful name
 719  * this function can be helpful.
 720  *
 721  * The name is allocated and will be freed automatically when the device is
 722  * unbound.
 723  *
 724  * @dev:        Device to update
 725  * @name:       New name (this string is allocated new memory and attached to
 726  *              the device)
 727  * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
 728  * string
 729  */
 730 int device_set_name(struct udevice *dev, const char *name);
 731
 732 /**
 733  * device_set_name_alloced() - note that a device name is allocated
 734  *
 735  * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is
 736  * unbound the name will be freed. This avoids memory leaks.
 737  *
 738  * @dev:        Device to update
 739  */
 740 void device_set_name_alloced(struct udevice *dev);
 741
 742 /**
 743  * device_is_compatible() - check if the device is compatible with the compat
 744  *
 745  * This allows to check whether the device is comaptible with the compat.
 746  *
 747  * @dev:        udevice pointer for which compatible needs to be verified.
 748  * @compat:     Compatible string which needs to verified in the given
 749  *              device
 750  * @return true if OK, false if the compatible is not found
 751  */
 752 bool device_is_compatible(const struct udevice *dev, const char *compat);
 753
 754 /**
 755  * of_machine_is_compatible() - check if the machine is compatible with
 756  *                              the compat
 757  *
 758  * This allows to check whether the machine is comaptible with the compat.
 759  *
 760  * @compat:     Compatible string which needs to verified
 761  * @return true if OK, false if the compatible is not found
 762  */
 763 bool of_machine_is_compatible(const char *compat);
 764
 765 /**
 766  * dev_disable_by_path() - Disable a device given its device tree path
 767  *
 768  * @path:       The device tree path identifying the device to be disabled
 769  * @return 0 on success, -ve on error
 770  */
 771 int dev_disable_by_path(const char *path);
 772
 773 /**
 774  * dev_enable_by_path() - Enable a device given its device tree path
 775  *
 776  * @path:       The device tree path identifying the device to be enabled
 777  * @return 0 on success, -ve on error
 778  */
 779 int dev_enable_by_path(const char *path);
 780
 781 /**
 782  * device_is_on_pci_bus - Test if a device is on a PCI bus
 783  *
 784  * @dev:        device to test
 785  * @return:     true if it is on a PCI bus, false otherwise
 786  */
 787 static inline bool device_is_on_pci_bus(const struct udevice *dev)
 788 {
 789         return dev->parent && device_get_uclass_id(dev->parent) == UCLASS_PCI;
 790 }
 791
 792 /**
 793  * device_foreach_child_safe() - iterate through child devices safely
 794  *
 795  * This allows the @pos child to be removed in the loop if required.
 796  *
 797  * @pos: struct udevice * for the current device
 798  * @next: struct udevice * for the next device
 799  * @parent: parent device to scan
 800  */
 801 #define device_foreach_child_safe(pos, next, parent)    \
 802         list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
 803
 804 /**
 805  * device_foreach_child() - iterate through child devices
 806  *
 807  * @pos: struct udevice * for the current device
 808  * @parent: parent device to scan
 809  */
 810 #define device_foreach_child(pos, parent)       \
 811         list_for_each_entry(pos, &parent->child_head, sibling_node)
 812
 813 /**
 814  * device_foreach_child_of_to_plat() - iterate through children
 815  *
 816  * This stops when it gets an error, with @pos set to the device that failed to
 817  * read ofdata.
 818
 819  * This creates a for() loop which works through the available children of
 820  * a device in order from start to end. Device ofdata is read by calling
 821  * device_of_to_plat() on each one. The devices are not probed.
 822  *
 823  * @pos: struct udevice * for the current device
 824  * @parent: parent device to scan
 825  */
 826 #define device_foreach_child_of_to_plat(pos, parent)    \
 827         for (int _ret = device_first_child_ofdata_err(parent, &dev); !_ret; \
 828              _ret = device_next_child_ofdata_err(&dev))
 829
 830 /**
 831  * device_foreach_child_probe() - iterate through children, probing them
 832  *
 833  * This creates a for() loop which works through the available children of
 834  * a device in order from start to end. Devices are probed if necessary,
 835  * and ready for use.
 836  *
 837  * This stops when it gets an error, with @pos set to the device that failed to
 838  * probe
 839  *
 840  * @pos: struct udevice * for the current device
 841  * @parent: parent device to scan
 842  */
 843 #define device_foreach_child_probe(pos, parent) \
 844         for (int _ret = device_first_child_err(parent, &dev); !_ret; \
 845              _ret = device_next_child_err(&dev))
 846
 847 /**
 848  * dm_scan_fdt_dev() - Bind child device in the device tree
 849  *
 850  * This handles device which have sub-nodes in the device tree. It scans all
 851  * sub-nodes and binds drivers for each node where a driver can be found.
 852  *
 853  * If this is called prior to relocation, only pre-relocation devices will be
 854  * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where
 855  * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will
 856  * be bound.
 857  *
 858  * @dev:        Device to scan
 859  * @return 0 if OK, -ve on error
 860  */
 861 int dm_scan_fdt_dev(struct udevice *dev);
 862
 863 #endif