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