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(struct udevice *parent, int index, struct udevice **devp);
 413
 414 /**
 415  * device_get_child_count() - Get the available child count of a device
 416  *
 417  * Returns the number of children to a device.
 418  *
 419  * @parent:     Parent device to check
 420  */
 421 int device_get_child_count(struct udevice *parent);
 422
 423 /**
 424  * device_find_child_by_seq() - Find a child device based on a sequence
 425  *
 426  * This searches for a device with the given seq or req_seq.
 427  *
 428  * For seq, if an active device has this sequence it will be returned.
 429  * If there is no such device then this will return -ENODEV.
 430  *
 431  * For req_seq, if a device (whether activated or not) has this req_seq
 432  * value, that device will be returned. This is a strong indication that
 433  * the device will receive that sequence when activated.
 434  *
 435  * @parent: Parent device
 436  * @seq_or_req_seq: Sequence number to find (0=first)
 437  * @find_req_seq: true to find req_seq, false to find seq
 438  * @devp: Returns pointer to device (there is only one per for each seq).
 439  * Set to NULL if none is found
 440  * @return 0 if OK, -ve on error
 441  */
 442 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
 443                              bool find_req_seq, struct udevice **devp);
 444
 445 /**
 446  * device_get_child_by_seq() - Get a child device based on a sequence
 447  *
 448  * If an active device has this sequence it will be returned. If there is no
 449  * such device then this will check for a device that is requesting this
 450  * sequence.
 451  *
 452  * The device is probed to activate it ready for use.
 453  *
 454  * @parent: Parent device
 455  * @seq: Sequence number to find (0=first)
 456  * @devp: Returns pointer to device (there is only one per for each seq)
 457  * Set to NULL if none is found
 458  * @return 0 if OK, -ve on error
 459  */
 460 int device_get_child_by_seq(struct udevice *parent, int seq,
 461                             struct udevice **devp);
 462
 463 /**
 464  * device_find_child_by_of_offset() - Find a child device based on FDT offset
 465  *
 466  * Locates a child device by its device tree offset.
 467  *
 468  * @parent: Parent device
 469  * @of_offset: Device tree offset to find
 470  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 471  * @return 0 if OK, -ve on error
 472  */
 473 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
 474                                    struct udevice **devp);
 475
 476 /**
 477  * device_get_child_by_of_offset() - Get a child device based on FDT offset
 478  *
 479  * Locates a child device by its device tree offset.
 480  *
 481  * The device is probed to activate it ready for use.
 482  *
 483  * @parent: Parent device
 484  * @of_offset: Device tree offset to find
 485  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 486  * @return 0 if OK, -ve on error
 487  */
 488 int device_get_child_by_of_offset(struct udevice *parent, int of_offset,
 489                                   struct udevice **devp);
 490
 491 /**
 492  * device_find_global_by_ofnode() - Get a device based on ofnode
 493  *
 494  * Locates a device by its device tree ofnode, searching globally throughout
 495  * the all driver model devices.
 496  *
 497  * The device is NOT probed
 498  *
 499  * @node: Device tree ofnode to find
 500  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 501  * @return 0 if OK, -ve on error
 502  */
 503
 504 int device_find_global_by_ofnode(ofnode node, struct udevice **devp);
 505
 506 /**
 507  * device_get_global_by_ofnode() - Get a device based on ofnode
 508  *
 509  * Locates a device by its device tree ofnode, searching globally throughout
 510  * the all driver model devices.
 511  *
 512  * The device is probed to activate it ready for use.
 513  *
 514  * @node: Device tree ofnode to find
 515  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 516  * @return 0 if OK, -ve on error
 517  */
 518 int device_get_global_by_ofnode(ofnode node, struct udevice **devp);
 519
 520 /**
 521  * device_find_first_child() - Find the first child of a device
 522  *
 523  * @parent: Parent device to search
 524  * @devp: Returns first child device, or NULL if none
 525  * @return 0
 526  */
 527 int device_find_first_child(struct udevice *parent, struct udevice **devp);
 528
 529 /**
 530  * device_find_next_child() - Find the next child of a device
 531  *
 532  * @devp: Pointer to previous child device on entry. Returns pointer to next
 533  *              child device, or NULL if none
 534  * @return 0
 535  */
 536 int device_find_next_child(struct udevice **devp);
 537
 538 /**
 539  * device_find_first_inactive_child() - Find the first inactive child
 540  *
 541  * This is used to locate an existing child of a device which is of a given
 542  * uclass.
 543  *
 544  * The device is NOT probed
 545  *
 546  * @parent:     Parent device to search
 547  * @uclass_id:  Uclass to look for
 548  * @devp:       Returns device found, if any
 549  * @return 0 if found, else -ENODEV
 550  */
 551 int device_find_first_inactive_child(struct udevice *parent,
 552                                      enum uclass_id uclass_id,
 553                                      struct udevice **devp);
 554
 555 /**
 556  * device_find_first_child_by_uclass() - Find the first child of a device in uc
 557  *
 558  * @parent: Parent device to search
 559  * @uclass_id:  Uclass to look for
 560  * @devp: Returns first child device in that uclass, if any
 561  * @return 0 if found, else -ENODEV
 562  */
 563 int device_find_first_child_by_uclass(struct udevice *parent,
 564                                       enum uclass_id uclass_id,
 565                                       struct udevice **devp);
 566
 567 /**
 568  * device_find_child_by_name() - Find a child by device name
 569  *
 570  * @parent:     Parent device to search
 571  * @name:       Name to look for
 572  * @devp:       Returns device found, if any
 573  * @return 0 if found, else -ENODEV
 574  */
 575 int device_find_child_by_name(struct udevice *parent, const char *name,
 576                               struct udevice **devp);
 577
 578 /**
 579  * device_has_children() - check if a device has any children
 580  *
 581  * @dev:        Device to check
 582  * @return true if the device has one or more children
 583  */
 584 bool device_has_children(const struct udevice *dev);
 585
 586 /**
 587  * device_has_active_children() - check if a device has any active children
 588  *
 589  * @dev:        Device to check
 590  * @return true if the device has one or more children and at least one of
 591  * them is active (probed).
 592  */
 593 bool device_has_active_children(struct udevice *dev);
 594
 595 /**
 596  * device_is_last_sibling() - check if a device is the last sibling
 597  *
 598  * This function can be useful for display purposes, when special action needs
 599  * to be taken when displaying the last sibling. This can happen when a tree
 600  * view of devices is being displayed.
 601  *
 602  * @dev:        Device to check
 603  * @return true if there are no more siblings after this one - i.e. is it
 604  * last in the list.
 605  */
 606 bool device_is_last_sibling(struct udevice *dev);
 607
 608 /**
 609  * device_set_name() - set the name of a device
 610  *
 611  * This must be called in the device's bind() method and no later. Normally
 612  * this is unnecessary but for probed devices which don't get a useful name
 613  * this function can be helpful.
 614  *
 615  * The name is allocated and will be freed automatically when the device is
 616  * unbound.
 617  *
 618  * @dev:        Device to update
 619  * @name:       New name (this string is allocated new memory and attached to
 620  *              the device)
 621  * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
 622  * string
 623  */
 624 int device_set_name(struct udevice *dev, const char *name);
 625
 626 /**
 627  * device_set_name_alloced() - note that a device name is allocated
 628  *
 629  * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is
 630  * unbound the name will be freed. This avoids memory leaks.
 631  *
 632  * @dev:        Device to update
 633  */
 634 void device_set_name_alloced(struct udevice *dev);
 635
 636 /**
 637  * device_is_compatible() - check if the device is compatible with the compat
 638  *
 639  * This allows to check whether the device is comaptible with the compat.
 640  *
 641  * @dev:        udevice pointer for which compatible needs to be verified.
 642  * @compat:     Compatible string which needs to verified in the given
 643  *              device
 644  * @return true if OK, false if the compatible is not found
 645  */
 646 bool device_is_compatible(struct udevice *dev, const char *compat);
 647
 648 /**
 649  * of_machine_is_compatible() - check if the machine is compatible with
 650  *                              the compat
 651  *
 652  * This allows to check whether the machine is comaptible with the compat.
 653  *
 654  * @compat:     Compatible string which needs to verified
 655  * @return true if OK, false if the compatible is not found
 656  */
 657 bool of_machine_is_compatible(const char *compat);
 658
 659 /**
 660  * dev_disable_by_path() - Disable a device given its device tree path
 661  *
 662  * @path:       The device tree path identifying the device to be disabled
 663  * @return 0 on success, -ve on error
 664  */
 665 int dev_disable_by_path(const char *path);
 666
 667 /**
 668  * dev_enable_by_path() - Enable a device given its device tree path
 669  *
 670  * @path:       The device tree path identifying the device to be enabled
 671  * @return 0 on success, -ve on error
 672  */
 673 int dev_enable_by_path(const char *path);
 674
 675 /**
 676  * device_is_on_pci_bus - Test if a device is on a PCI bus
 677  *
 678  * @dev:        device to test
 679  * @return:     true if it is on a PCI bus, false otherwise
 680  */
 681 static inline bool device_is_on_pci_bus(struct udevice *dev)
 682 {
 683         return device_get_uclass_id(dev->parent) == UCLASS_PCI;
 684 }
 685
 686 /**
 687  * device_foreach_child_safe() - iterate through child devices safely
 688  *
 689  * This allows the @pos child to be removed in the loop if required.
 690  *
 691  * @pos: struct udevice * for the current device
 692  * @next: struct udevice * for the next device
 693  * @parent: parent device to scan
 694  */
 695 #define device_foreach_child_safe(pos, next, parent)    \
 696         list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
 697
 698 /**
 699  * device_foreach_child() - iterate through child devices
 700  *
 701  * @pos: struct udevice * for the current device
 702  * @parent: parent device to scan
 703  */
 704 #define device_foreach_child(pos, parent)       \
 705         list_for_each_entry(pos, &parent->child_head, sibling_node)
 706
 707 /**
 708  * dm_scan_fdt_dev() - Bind child device in a the device tree
 709  *
 710  * This handles device which have sub-nodes in the device tree. It scans all
 711  * sub-nodes and binds drivers for each node where a driver can be found.
 712  *
 713  * If this is called prior to relocation, only pre-relocation devices will be
 714  * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where
 715  * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will
 716  * be bound.
 717  *
 718  * @dev:        Device to scan
 719  * @return 0 if OK, -ve on error
 720  */
 721 int dm_scan_fdt_dev(struct udevice *dev);
 722
 723 /* device resource management */
 724 typedef void (*dr_release_t)(struct udevice *dev, void *res);
 725 typedef int (*dr_match_t)(struct udevice *dev, void *res, void *match_data);
 726
 727 #ifdef CONFIG_DEVRES
 728
 729 #ifdef CONFIG_DEBUG_DEVRES
 730 void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
 731                      const char *name);
 732 #define _devres_alloc(release, size, gfp) \
 733         __devres_alloc(release, size, gfp, #release)
 734 #else
 735 void *_devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
 736 #endif
 737
 738 /**
 739  * devres_alloc() - Allocate device resource data
 740  * @release: Release function devres will be associated with
 741  * @size: Allocation size
 742  * @gfp: Allocation flags
 743  *
 744  * Allocate devres of @size bytes.  The allocated area is associated
 745  * with @release.  The returned pointer can be passed to
 746  * other devres_*() functions.
 747  *
 748  * RETURNS:
 749  * Pointer to allocated devres on success, NULL on failure.
 750  */
 751 #define devres_alloc(release, size, gfp) \
 752         _devres_alloc(release, size, gfp | __GFP_ZERO)
 753
 754 /**
 755  * devres_free() - Free device resource data
 756  * @res: Pointer to devres data to free
 757  *
 758  * Free devres created with devres_alloc().
 759  */
 760 void devres_free(void *res);
 761
 762 /**
 763  * devres_add() - Register device resource
 764  * @dev: Device to add resource to
 765  * @res: Resource to register
 766  *
 767  * Register devres @res to @dev.  @res should have been allocated
 768  * using devres_alloc().  On driver detach, the associated release
 769  * function will be invoked and devres will be freed automatically.
 770  */
 771 void devres_add(struct udevice *dev, void *res);
 772
 773 /**
 774  * devres_find() - Find device resource
 775  * @dev: Device to lookup resource from
 776  * @release: Look for resources associated with this release function
 777  * @match: Match function (optional)
 778  * @match_data: Data for the match function
 779  *
 780  * Find the latest devres of @dev which is associated with @release
 781  * and for which @match returns 1.  If @match is NULL, it's considered
 782  * to match all.
 783  *
 784  * @return pointer to found devres, NULL if not found.
 785  */
 786 void *devres_find(struct udevice *dev, dr_release_t release,
 787                   dr_match_t match, void *match_data);
 788
 789 /**
 790  * devres_get() - Find devres, if non-existent, add one atomically
 791  * @dev: Device to lookup or add devres for
 792  * @new_res: Pointer to new initialized devres to add if not found
 793  * @match: Match function (optional)
 794  * @match_data: Data for the match function
 795  *
 796  * Find the latest devres of @dev which has the same release function
 797  * as @new_res and for which @match return 1.  If found, @new_res is
 798  * freed; otherwise, @new_res is added atomically.
 799  *
 800  * @return ointer to found or added devres.
 801  */
 802 void *devres_get(struct udevice *dev, void *new_res,
 803                  dr_match_t match, void *match_data);
 804
 805 /**
 806  * devres_remove() - Find a device resource and remove it
 807  * @dev: Device to find resource from
 808  * @release: Look for resources associated with this release function
 809  * @match: Match function (optional)
 810  * @match_data: Data for the match function
 811  *
 812  * Find the latest devres of @dev associated with @release and for
 813  * which @match returns 1.  If @match is NULL, it's considered to
 814  * match all.  If found, the resource is removed atomically and
 815  * returned.
 816  *
 817  * @return ointer to removed devres on success, NULL if not found.
 818  */
 819 void *devres_remove(struct udevice *dev, dr_release_t release,
 820                     dr_match_t match, void *match_data);
 821
 822 /**
 823  * devres_destroy() - Find a device resource and destroy it
 824  * @dev: Device to find resource from
 825  * @release: Look for resources associated with this release function
 826  * @match: Match function (optional)
 827  * @match_data: Data for the match function
 828  *
 829  * Find the latest devres of @dev associated with @release and for
 830  * which @match returns 1.  If @match is NULL, it's considered to
 831  * match all.  If found, the resource is removed atomically and freed.
 832  *
 833  * Note that the release function for the resource will not be called,
 834  * only the devres-allocated data will be freed.  The caller becomes
 835  * responsible for freeing any other data.
 836  *
 837  * @return 0 if devres is found and freed, -ENOENT if not found.
 838  */
 839 int devres_destroy(struct udevice *dev, dr_release_t release,
 840                    dr_match_t match, void *match_data);
 841
 842 /**
 843  * devres_release() - Find a device resource and destroy it, calling release
 844  * @dev: Device to find resource from
 845  * @release: Look for resources associated with this release function
 846  * @match: Match function (optional)
 847  * @match_data: Data for the match function
 848  *
 849  * Find the latest devres of @dev associated with @release and for
 850  * which @match returns 1.  If @match is NULL, it's considered to
 851  * match all.  If found, the resource is removed atomically, the
 852  * release function called and the resource freed.
 853  *
 854  * @return 0 if devres is found and freed, -ENOENT if not found.
 855  */
 856 int devres_release(struct udevice *dev, dr_release_t release,
 857                    dr_match_t match, void *match_data);
 858
 859 /* managed devm_k.alloc/kfree for device drivers */
 860 /**
 861  * devm_kmalloc() - Resource-managed kmalloc
 862  * @dev: Device to allocate memory for
 863  * @size: Allocation size
 864  * @gfp: Allocation gfp flags
 865  *
 866  * Managed kmalloc.  Memory allocated with this function is
 867  * automatically freed on driver detach.  Like all other devres
 868  * resources, guaranteed alignment is unsigned long long.
 869  *
 870  * @return pointer to allocated memory on success, NULL on failure.
 871  */
 872 void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp);
 873 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
 874 {
 875         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
 876 }
 877 static inline void *devm_kmalloc_array(struct udevice *dev,
 878                                        size_t n, size_t size, gfp_t flags)
 879 {
 880         if (size != 0 && n > SIZE_MAX / size)
 881                 return NULL;
 882         return devm_kmalloc(dev, n * size, flags);
 883 }
 884 static inline void *devm_kcalloc(struct udevice *dev,
 885                                  size_t n, size_t size, gfp_t flags)
 886 {
 887         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
 888 }
 889
 890 /**
 891  * devm_kfree() - Resource-managed kfree
 892  * @dev: Device this memory belongs to
 893  * @ptr: Memory to free
 894  *
 895  * Free memory allocated with devm_kmalloc().
 896  */
 897 void devm_kfree(struct udevice *dev, void *ptr);
 898
 899 #else /* ! CONFIG_DEVRES */
 900
 901 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
 902 {
 903         return kzalloc(size, gfp);
 904 }
 905
 906 static inline void devres_free(void *res)
 907 {
 908         kfree(res);
 909 }
 910
 911 static inline void devres_add(struct udevice *dev, void *res)
 912 {
 913 }
 914
 915 static inline void *devres_find(struct udevice *dev, dr_release_t release,
 916                                 dr_match_t match, void *match_data)
 917 {
 918         return NULL;
 919 }
 920
 921 static inline void *devres_get(struct udevice *dev, void *new_res,
 922                                dr_match_t match, void *match_data)
 923 {
 924         return NULL;
 925 }
 926
 927 static inline void *devres_remove(struct udevice *dev, dr_release_t release,
 928                                   dr_match_t match, void *match_data)
 929 {
 930         return NULL;
 931 }
 932
 933 static inline int devres_destroy(struct udevice *dev, dr_release_t release,
 934                                  dr_match_t match, void *match_data)
 935 {
 936         return 0;
 937 }
 938
 939 static inline int devres_release(struct udevice *dev, dr_release_t release,
 940                                  dr_match_t match, void *match_data)
 941 {
 942         return 0;
 943 }
 944
 945 static inline void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp)
 946 {
 947         return kmalloc(size, gfp);
 948 }
 949
 950 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
 951 {
 952         return kzalloc(size, gfp);
 953 }
 954
 955 static inline void *devm_kmalloc_array(struct udevice *dev,
 956                                        size_t n, size_t size, gfp_t flags)
 957 {
 958         /* TODO: add kmalloc_array() to linux/compat.h */
 959         if (size != 0 && n > SIZE_MAX / size)
 960                 return NULL;
 961         return kmalloc(n * size, flags);
 962 }
 963
 964 static inline void *devm_kcalloc(struct udevice *dev,
 965                                  size_t n, size_t size, gfp_t flags)
 966 {
 967         /* TODO: add kcalloc() to linux/compat.h */
 968         return kmalloc(n * size, flags | __GFP_ZERO);
 969 }
 970
 971 static inline void devm_kfree(struct udevice *dev, void *ptr)
 972 {
 973         kfree(ptr);
 974 }
 975
 976 #endif /* ! CONFIG_DEVRES */
 977
 978 /*
 979  * REVISIT:
 980  * remove the following after resolving conflicts with <linux/compat.h>
 981  */
 982 #ifdef dev_dbg
 983 #undef dev_dbg
 984 #endif
 985 #ifdef dev_vdbg
 986 #undef dev_vdbg
 987 #endif
 988 #ifdef dev_info
 989 #undef dev_info
 990 #endif
 991 #ifdef dev_err
 992 #undef dev_err
 993 #endif
 994 #ifdef dev_warn
 995 #undef dev_warn
 996 #endif
 997
 998 /*
 999  * REVISIT:
1000  * print device name like Linux
1001  */
1002 #define dev_printk(dev, fmt, ...)                               \
1003 ({                                                              \
1004         printk(fmt, ##__VA_ARGS__);                             \
1005 })
1006
1007 #define __dev_printk(level, dev, fmt, ...)                      \
1008 ({                                                              \
1009         if (level < CONFIG_VAL(LOGLEVEL))                       \
1010                 dev_printk(dev, fmt, ##__VA_ARGS__);            \
1011 })
1012
1013 #define dev_emerg(dev, fmt, ...) \
1014         __dev_printk(0, dev, fmt, ##__VA_ARGS__)
1015 #define dev_alert(dev, fmt, ...) \
1016         __dev_printk(1, dev, fmt, ##__VA_ARGS__)
1017 #define dev_crit(dev, fmt, ...) \
1018         __dev_printk(2, dev, fmt, ##__VA_ARGS__)
1019 #define dev_err(dev, fmt, ...) \
1020         __dev_printk(3, dev, fmt, ##__VA_ARGS__)
1021 #define dev_warn(dev, fmt, ...) \
1022         __dev_printk(4, dev, fmt, ##__VA_ARGS__)
1023 #define dev_notice(dev, fmt, ...) \
1024         __dev_printk(5, dev, fmt, ##__VA_ARGS__)
1025 #define dev_info(dev, fmt, ...) \
1026         __dev_printk(6, dev, fmt, ##__VA_ARGS__)
1027
1028 #ifdef DEBUG
1029 #define dev_dbg(dev, fmt, ...) \
1030         __dev_printk(7, dev, fmt, ##__VA_ARGS__)
1031 #else
1032 #define dev_dbg(dev, fmt, ...)                                  \
1033 ({                                                              \
1034         if (0)                                                  \
1035                 __dev_printk(7, dev, fmt, ##__VA_ARGS__);       \
1036 })
1037 #endif
1038
1039 #ifdef VERBOSE_DEBUG
1040 #define dev_vdbg        dev_dbg
1041 #else
1042 #define dev_vdbg(dev, fmt, ...)                                 \
1043 ({                                                              \
1044         if (0)                                                  \
1045                 __dev_printk(7, dev, fmt, ##__VA_ARGS__);       \
1046 })
1047 #endif
1048
1049 #endif