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