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