include/dm/device.h

   1 /*
   2  * Copyright (c) 2013 Google, Inc
   3  *
   4  * (C) Copyright 2012
   5  * Pavel Herrmann <morpheus.ibis@gmail.com>
   6  * Marek Vasut <marex@denx.de>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #ifndef _DM_DEVICE_H
  12 #define _DM_DEVICE_H
  13
  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
  21 struct driver_info;
  22
  23 /* Driver is active (probed). Cleared when it is removed */
  24 #define DM_FLAG_ACTIVATED               (1 << 0)
  25
  26 /* DM is responsible for allocating and freeing platdata */
  27 #define DM_FLAG_ALLOC_PDATA             (1 << 1)
  28
  29 /* DM should init this device prior to relocation */
  30 #define DM_FLAG_PRE_RELOC               (1 << 2)
  31
  32 /* DM is responsible for allocating and freeing parent_platdata */
  33 #define DM_FLAG_ALLOC_PARENT_PDATA      (1 << 3)
  34
  35 /* DM is responsible for allocating and freeing uclass_platdata */
  36 #define DM_FLAG_ALLOC_UCLASS_PDATA      (1 << 4)
  37
  38 /* Allocate driver private data on a DMA boundary */
  39 #define DM_FLAG_ALLOC_PRIV_DMA          (1 << 5)
  40
  41 /* Device is bound */
  42 #define DM_FLAG_BOUND                   (1 << 6)
  43
  44 /**
  45  * struct udevice - An instance of a driver
  46  *
  47  * This holds information about a device, which is a driver bound to a
  48  * particular port or peripheral (essentially a driver instance).
  49  *
  50  * A device will come into existence through a 'bind' call, either due to
  51  * a U_BOOT_DEVICE() macro (in which case platdata is non-NULL) or a node
  52  * in the device tree (in which case of_offset is >= 0). In the latter case
  53  * we translate the device tree information into platdata in a function
  54  * implemented by the driver ofdata_to_platdata method (called just before the
  55  * probe method if the device has a device tree node.
  56  *
  57  * All three of platdata, priv and uclass_priv can be allocated by the
  58  * driver, or you can use the auto_alloc_size members of struct driver and
  59  * struct uclass_driver to have driver model do this automatically.
  60  *
  61  * @driver: The driver used by this device
  62  * @name: Name of device, typically the FDT node name
  63  * @platdata: Configuration data for this device
  64  * @parent_platdata: The parent bus's configuration data for this device
  65  * @uclass_platdata: The uclass's configuration data for this device
  66  * @of_offset: Device tree node offset for this device (- for none)
  67  * @driver_data: Driver data word for the entry that matched this device with
  68  *              its driver
  69  * @parent: Parent of this device, or NULL for the top level device
  70  * @priv: Private data for this device
  71  * @uclass: Pointer to uclass for this device
  72  * @uclass_priv: The uclass's private data for this device
  73  * @parent_priv: The parent's private data for this device
  74  * @uclass_node: Used by uclass to link its devices
  75  * @child_head: List of children of this device
  76  * @sibling_node: Next device in list of all devices
  77  * @flags: Flags for this device DM_FLAG_...
  78  * @req_seq: Requested sequence number for this device (-1 = any)
  79  * @seq: Allocated sequence number for this device (-1 = none). This is set up
  80  * when the device is probed and will be unique within the device's uclass.
  81  * @devres_head: List of memory allocations associated with this device.
  82  *              When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
  83  *              add to this list. Memory so-allocated will be freed
  84  *              automatically when the device is removed / unbound
  85  */
  86 struct udevice {
  87         const struct driver *driver;
  88         const char *name;
  89         void *platdata;
  90         void *parent_platdata;
  91         void *uclass_platdata;
  92         int of_offset;
  93         ulong driver_data;
  94         struct udevice *parent;
  95         void *priv;
  96         struct uclass *uclass;
  97         void *uclass_priv;
  98         void *parent_priv;
  99         struct list_head uclass_node;
 100         struct list_head child_head;
 101         struct list_head sibling_node;
 102         uint32_t flags;
 103         int req_seq;
 104         int seq;
 105 #ifdef CONFIG_DEVRES
 106         struct list_head devres_head;
 107 #endif
 108 };
 109
 110 /* Maximum sequence number supported */
 111 #define DM_MAX_SEQ      999
 112
 113 /* Returns the operations for a device */
 114 #define device_get_ops(dev)     (dev->driver->ops)
 115
 116 /* Returns non-zero if the device is active (probed and not removed) */
 117 #define device_active(dev)      ((dev)->flags & DM_FLAG_ACTIVATED)
 118
 119 /**
 120  * struct udevice_id - Lists the compatible strings supported by a driver
 121  * @compatible: Compatible string
 122  * @data: Data for this compatible string
 123  */
 124 struct udevice_id {
 125         const char *compatible;
 126         ulong data;
 127 };
 128
 129 #if CONFIG_IS_ENABLED(OF_CONTROL)
 130 #define of_match_ptr(_ptr)      (_ptr)
 131 #else
 132 #define of_match_ptr(_ptr)      NULL
 133 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
 134
 135 /**
 136  * struct driver - A driver for a feature or peripheral
 137  *
 138  * This holds methods for setting up a new device, and also removing it.
 139  * The device needs information to set itself up - this is provided either
 140  * by platdata or a device tree node (which we find by looking up
 141  * matching compatible strings with of_match).
 142  *
 143  * Drivers all belong to a uclass, representing a class of devices of the
 144  * same type. Common elements of the drivers can be implemented in the uclass,
 145  * or the uclass can provide a consistent interface to the drivers within
 146  * it.
 147  *
 148  * @name: Device name
 149  * @id: Identiies the uclass we belong to
 150  * @of_match: List of compatible strings to match, and any identifying data
 151  * for each.
 152  * @bind: Called to bind a device to its driver
 153  * @probe: Called to probe a device, i.e. activate it
 154  * @remove: Called to remove a device, i.e. de-activate it
 155  * @unbind: Called to unbind a device from its driver
 156  * @ofdata_to_platdata: Called before probe to decode device tree data
 157  * @child_post_bind: Called after a new child has been bound
 158  * @child_pre_probe: Called before a child device is probed. The device has
 159  * memory allocated but it has not yet been probed.
 160  * @child_post_remove: Called after a child device is removed. The device
 161  * has memory allocated but its device_remove() method has been called.
 162  * @priv_auto_alloc_size: If non-zero this is the size of the private data
 163  * to be allocated in the device's ->priv pointer. If zero, then the driver
 164  * is responsible for allocating any data required.
 165  * @platdata_auto_alloc_size: If non-zero this is the size of the
 166  * platform data to be allocated in the device's ->platdata pointer.
 167  * This is typically only useful for device-tree-aware drivers (those with
 168  * an of_match), since drivers which use platdata will have the data
 169  * provided in the U_BOOT_DEVICE() instantiation.
 170  * @per_child_auto_alloc_size: Each device can hold private data owned by
 171  * its parent. If required this will be automatically allocated if this
 172  * value is non-zero.
 173  * TODO(sjg@chromium.org): I'm considering dropping this, and just having
 174  * device_probe_child() pass it in. So far the use case for allocating it
 175  * is SPI, but I found that unsatisfactory. Since it is here I will leave it
 176  * until things are clearer.
 177  * @per_child_platdata_auto_alloc_size: A bus likes to store information about
 178  * its children. If non-zero this is the size of this data, to be allocated
 179  * in the child's parent_platdata pointer.
 180  * @ops: Driver-specific operations. This is typically a list of function
 181  * pointers defined by the driver, to implement driver functions required by
 182  * the uclass.
 183  * @flags: driver flags - see DM_FLAGS_...
 184  */
 185 struct driver {
 186         char *name;
 187         enum uclass_id id;
 188         const struct udevice_id *of_match;
 189         int (*bind)(struct udevice *dev);
 190         int (*probe)(struct udevice *dev);
 191         int (*remove)(struct udevice *dev);
 192         int (*unbind)(struct udevice *dev);
 193         int (*ofdata_to_platdata)(struct udevice *dev);
 194         int (*child_post_bind)(struct udevice *dev);
 195         int (*child_pre_probe)(struct udevice *dev);
 196         int (*child_post_remove)(struct udevice *dev);
 197         int priv_auto_alloc_size;
 198         int platdata_auto_alloc_size;
 199         int per_child_auto_alloc_size;
 200         int per_child_platdata_auto_alloc_size;
 201         const void *ops;        /* driver-specific operations */
 202         uint32_t flags;
 203 };
 204
 205 /* Declare a new U-Boot driver */
 206 #define U_BOOT_DRIVER(__name)                                           \
 207         ll_entry_declare(struct driver, __name, driver)
 208
 209 /**
 210  * dev_get_platdata() - Get the platform data for a device
 211  *
 212  * This checks that dev is not NULL, but no other checks for now
 213  *
 214  * @dev         Device to check
 215  * @return platform data, or NULL if none
 216  */
 217 void *dev_get_platdata(struct udevice *dev);
 218
 219 /**
 220  * dev_get_parent_platdata() - Get the parent platform data for a device
 221  *
 222  * This checks that dev is not NULL, but no other checks for now
 223  *
 224  * @dev         Device to check
 225  * @return parent's platform data, or NULL if none
 226  */
 227 void *dev_get_parent_platdata(struct udevice *dev);
 228
 229 /**
 230  * dev_get_uclass_platdata() - Get the uclass platform data for a device
 231  *
 232  * This checks that dev is not NULL, but no other checks for now
 233  *
 234  * @dev         Device to check
 235  * @return uclass's platform data, or NULL if none
 236  */
 237 void *dev_get_uclass_platdata(struct udevice *dev);
 238
 239 /**
 240  * dev_get_priv() - Get the private data for a device
 241  *
 242  * This checks that dev is not NULL, but no other checks for now
 243  *
 244  * @dev         Device to check
 245  * @return private data, or NULL if none
 246  */
 247 void *dev_get_priv(struct udevice *dev);
 248
 249 /**
 250  * dev_get_parent_priv() - Get the parent private data for a device
 251  *
 252  * The parent private data is data stored in the device but owned by the
 253  * parent. For example, a USB device may have parent data which contains
 254  * information about how to talk to the device over USB.
 255  *
 256  * This checks that dev is not NULL, but no other checks for now
 257  *
 258  * @dev         Device to check
 259  * @return parent data, or NULL if none
 260  */
 261 void *dev_get_parent_priv(struct udevice *dev);
 262
 263 /**
 264  * dev_get_uclass_priv() - Get the private uclass data for a device
 265  *
 266  * This checks that dev is not NULL, but no other checks for now
 267  *
 268  * @dev         Device to check
 269  * @return private uclass data for this device, or NULL if none
 270  */
 271 void *dev_get_uclass_priv(struct udevice *dev);
 272
 273 /**
 274  * struct dev_get_parent() - Get the parent of a device
 275  *
 276  * @child:      Child to check
 277  * @return parent of child, or NULL if this is the root device
 278  */
 279 struct udevice *dev_get_parent(struct udevice *child);
 280
 281 /**
 282  * dev_get_driver_data() - get the driver data used to bind a device
 283  *
 284  * When a device is bound using a device tree node, it matches a
 285  * particular compatible string as in struct udevice_id. This function
 286  * returns the associated data value for that compatible string. This is
 287  * the 'data' field in struct udevice_id.
 288  *
 289  * For USB devices, this is the driver_info field in struct usb_device_id.
 290  *
 291  * @dev:        Device to check
 292  */
 293 ulong dev_get_driver_data(struct udevice *dev);
 294
 295 /**
 296  * dev_get_driver_ops() - get the device's driver's operations
 297  *
 298  * This checks that dev is not NULL, and returns the pointer to device's
 299  * driver's operations.
 300  *
 301  * @dev:        Device to check
 302  * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
 303  */
 304 const void *dev_get_driver_ops(struct udevice *dev);
 305
 306 /*
 307  * device_get_uclass_id() - return the uclass ID of a device
 308  *
 309  * @dev:        Device to check
 310  * @return uclass ID for the device
 311  */
 312 enum uclass_id device_get_uclass_id(struct udevice *dev);
 313
 314 /*
 315  * dev_get_uclass_name() - return the uclass name of a device
 316  *
 317  * This checks that dev is not NULL.
 318  *
 319  * @dev:        Device to check
 320  * @return  pointer to the uclass name for the device
 321  */
 322 const char *dev_get_uclass_name(struct udevice *dev);
 323
 324 /**
 325  * device_get_child() - Get the child of a device by index
 326  *
 327  * Returns the numbered child, 0 being the first. This does not use
 328  * sequence numbers, only the natural order.
 329  *
 330  * @dev:        Parent device to check
 331  * @index:      Child index
 332  * @devp:       Returns pointer to device
 333  * @return 0 if OK, -ENODEV if no such device, other error if the device fails
 334  *         to probe
 335  */
 336 int device_get_child(struct udevice *parent, int index, struct udevice **devp);
 337
 338 /**
 339  * device_find_child_by_seq() - Find a child device based on a sequence
 340  *
 341  * This searches for a device with the given seq or req_seq.
 342  *
 343  * For seq, if an active device has this sequence it will be returned.
 344  * If there is no such device then this will return -ENODEV.
 345  *
 346  * For req_seq, if a device (whether activated or not) has this req_seq
 347  * value, that device will be returned. This is a strong indication that
 348  * the device will receive that sequence when activated.
 349  *
 350  * @parent: Parent device
 351  * @seq_or_req_seq: Sequence number to find (0=first)
 352  * @find_req_seq: true to find req_seq, false to find seq
 353  * @devp: Returns pointer to device (there is only one per for each seq).
 354  * Set to NULL if none is found
 355  * @return 0 if OK, -ve on error
 356  */
 357 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
 358                              bool find_req_seq, struct udevice **devp);
 359
 360 /**
 361  * device_get_child_by_seq() - Get a child device based on a sequence
 362  *
 363  * If an active device has this sequence it will be returned. If there is no
 364  * such device then this will check for a device that is requesting this
 365  * sequence.
 366  *
 367  * The device is probed to activate it ready for use.
 368  *
 369  * @parent: Parent device
 370  * @seq: Sequence number to find (0=first)
 371  * @devp: Returns pointer to device (there is only one per for each seq)
 372  * Set to NULL if none is found
 373  * @return 0 if OK, -ve on error
 374  */
 375 int device_get_child_by_seq(struct udevice *parent, int seq,
 376                             struct udevice **devp);
 377
 378 /**
 379  * device_find_child_by_of_offset() - Find a child device based on FDT offset
 380  *
 381  * Locates a child device by its device tree offset.
 382  *
 383  * @parent: Parent device
 384  * @of_offset: Device tree offset to find
 385  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 386  * @return 0 if OK, -ve on error
 387  */
 388 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
 389                                    struct udevice **devp);
 390
 391 /**
 392  * device_get_child_by_of_offset() - Get a child device based on FDT offset
 393  *
 394  * Locates a child device by its device tree offset.
 395  *
 396  * The device is probed to activate it ready for use.
 397  *
 398  * @parent: Parent device
 399  * @of_offset: Device tree offset to find
 400  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 401  * @return 0 if OK, -ve on error
 402  */
 403 int device_get_child_by_of_offset(struct udevice *parent, int of_offset,
 404                                   struct udevice **devp);
 405
 406 /**
 407  * device_get_global_by_of_offset() - Get a device based on FDT offset
 408  *
 409  * Locates a device by its device tree offset, searching globally throughout
 410  * the all driver model devices.
 411  *
 412  * The device is probed to activate it ready for use.
 413  *
 414  * @of_offset: Device tree offset to find
 415  * @devp: Returns pointer to device if found, otherwise this is set to NULL
 416  * @return 0 if OK, -ve on error
 417  */
 418 int device_get_global_by_of_offset(int of_offset, struct udevice **devp);
 419
 420 /**
 421  * device_find_first_child() - Find the first child of a device
 422  *
 423  * @parent: Parent device to search
 424  * @devp: Returns first child device, or NULL if none
 425  * @return 0
 426  */
 427 int device_find_first_child(struct udevice *parent, struct udevice **devp);
 428
 429 /**
 430  * device_find_next_child() - Find the next child of a device
 431  *
 432  * @devp: Pointer to previous child device on entry. Returns pointer to next
 433  *              child device, or NULL if none
 434  * @return 0
 435  */
 436 int device_find_next_child(struct udevice **devp);
 437
 438 /**
 439  * dev_get_addr() - Get the reg property of a device
 440  *
 441  * @dev: Pointer to a device
 442  *
 443  * @return addr
 444  */
 445 fdt_addr_t dev_get_addr(struct udevice *dev);
 446
 447 /**
 448  * device_has_children() - check if a device has any children
 449  *
 450  * @dev:        Device to check
 451  * @return true if the device has one or more children
 452  */
 453 bool device_has_children(struct udevice *dev);
 454
 455 /**
 456  * device_has_active_children() - check if a device has any active children
 457  *
 458  * @dev:        Device to check
 459  * @return true if the device has one or more children and at least one of
 460  * them is active (probed).
 461  */
 462 bool device_has_active_children(struct udevice *dev);
 463
 464 /**
 465  * device_is_last_sibling() - check if a device is the last sibling
 466  *
 467  * This function can be useful for display purposes, when special action needs
 468  * to be taken when displaying the last sibling. This can happen when a tree
 469  * view of devices is being displayed.
 470  *
 471  * @dev:        Device to check
 472  * @return true if there are no more siblings after this one - i.e. is it
 473  * last in the list.
 474  */
 475 bool device_is_last_sibling(struct udevice *dev);
 476
 477 /**
 478  * device_set_name() - set the name of a device
 479  *
 480  * This must be called in the device's bind() method and no later. Normally
 481  * this is unnecessary but for probed devices which don't get a useful name
 482  * this function can be helpful.
 483  *
 484  * @dev:        Device to update
 485  * @name:       New name (this string is allocated new memory and attached to
 486  *              the device)
 487  * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
 488  * string
 489  */
 490 int device_set_name(struct udevice *dev, const char *name);
 491
 492 /**
 493  * device_is_on_pci_bus - Test if a device is on a PCI bus
 494  *
 495  * @dev:        device to test
 496  * @return:     true if it is on a PCI bus, false otherwise
 497  */
 498 static inline bool device_is_on_pci_bus(struct udevice *dev)
 499 {
 500         return device_get_uclass_id(dev->parent) == UCLASS_PCI;
 501 }
 502
 503 /* device resource management */
 504 typedef void (*dr_release_t)(struct udevice *dev, void *res);
 505 typedef int (*dr_match_t)(struct udevice *dev, void *res, void *match_data);
 506
 507 #ifdef CONFIG_DEVRES
 508
 509 #ifdef CONFIG_DEBUG_DEVRES
 510 void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
 511                      const char *name);
 512 #define _devres_alloc(release, size, gfp) \
 513         __devres_alloc(release, size, gfp, #release)
 514 #else
 515 void *_devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
 516 #endif
 517
 518 /**
 519  * devres_alloc() - Allocate device resource data
 520  * @release: Release function devres will be associated with
 521  * @size: Allocation size
 522  * @gfp: Allocation flags
 523  *
 524  * Allocate devres of @size bytes.  The allocated area is associated
 525  * with @release.  The returned pointer can be passed to
 526  * other devres_*() functions.
 527  *
 528  * RETURNS:
 529  * Pointer to allocated devres on success, NULL on failure.
 530  */
 531 #define devres_alloc(release, size, gfp) \
 532         _devres_alloc(release, size, gfp | __GFP_ZERO)
 533
 534 /**
 535  * devres_free() - Free device resource data
 536  * @res: Pointer to devres data to free
 537  *
 538  * Free devres created with devres_alloc().
 539  */
 540 void devres_free(void *res);
 541
 542 /**
 543  * devres_add() - Register device resource
 544  * @dev: Device to add resource to
 545  * @res: Resource to register
 546  *
 547  * Register devres @res to @dev.  @res should have been allocated
 548  * using devres_alloc().  On driver detach, the associated release
 549  * function will be invoked and devres will be freed automatically.
 550  */
 551 void devres_add(struct udevice *dev, void *res);
 552
 553 /**
 554  * devres_find() - Find device resource
 555  * @dev: Device to lookup resource from
 556  * @release: Look for resources associated with this release function
 557  * @match: Match function (optional)
 558  * @match_data: Data for the match function
 559  *
 560  * Find the latest devres of @dev which is associated with @release
 561  * and for which @match returns 1.  If @match is NULL, it's considered
 562  * to match all.
 563  *
 564  * @return pointer to found devres, NULL if not found.
 565  */
 566 void *devres_find(struct udevice *dev, dr_release_t release,
 567                   dr_match_t match, void *match_data);
 568
 569 /**
 570  * devres_get() - Find devres, if non-existent, add one atomically
 571  * @dev: Device to lookup or add devres for
 572  * @new_res: Pointer to new initialized devres to add if not found
 573  * @match: Match function (optional)
 574  * @match_data: Data for the match function
 575  *
 576  * Find the latest devres of @dev which has the same release function
 577  * as @new_res and for which @match return 1.  If found, @new_res is
 578  * freed; otherwise, @new_res is added atomically.
 579  *
 580  * @return ointer to found or added devres.
 581  */
 582 void *devres_get(struct udevice *dev, void *new_res,
 583                  dr_match_t match, void *match_data);
 584
 585 /**
 586  * devres_remove() - Find a device resource and remove it
 587  * @dev: Device to find resource from
 588  * @release: Look for resources associated with this release function
 589  * @match: Match function (optional)
 590  * @match_data: Data for the match function
 591  *
 592  * Find the latest devres of @dev associated with @release and for
 593  * which @match returns 1.  If @match is NULL, it's considered to
 594  * match all.  If found, the resource is removed atomically and
 595  * returned.
 596  *
 597  * @return ointer to removed devres on success, NULL if not found.
 598  */
 599 void *devres_remove(struct udevice *dev, dr_release_t release,
 600                     dr_match_t match, void *match_data);
 601
 602 /**
 603  * devres_destroy() - Find a device resource and destroy it
 604  * @dev: Device to find resource from
 605  * @release: Look for resources associated with this release function
 606  * @match: Match function (optional)
 607  * @match_data: Data for the match function
 608  *
 609  * Find the latest devres of @dev associated with @release and for
 610  * which @match returns 1.  If @match is NULL, it's considered to
 611  * match all.  If found, the resource is removed atomically and freed.
 612  *
 613  * Note that the release function for the resource will not be called,
 614  * only the devres-allocated data will be freed.  The caller becomes
 615  * responsible for freeing any other data.
 616  *
 617  * @return 0 if devres is found and freed, -ENOENT if not found.
 618  */
 619 int devres_destroy(struct udevice *dev, dr_release_t release,
 620                    dr_match_t match, void *match_data);
 621
 622 /**
 623  * devres_release() - Find a device resource and destroy it, calling release
 624  * @dev: Device to find resource from
 625  * @release: Look for resources associated with this release function
 626  * @match: Match function (optional)
 627  * @match_data: Data for the match function
 628  *
 629  * Find the latest devres of @dev associated with @release and for
 630  * which @match returns 1.  If @match is NULL, it's considered to
 631  * match all.  If found, the resource is removed atomically, the
 632  * release function called and the resource freed.
 633  *
 634  * @return 0 if devres is found and freed, -ENOENT if not found.
 635  */
 636 int devres_release(struct udevice *dev, dr_release_t release,
 637                    dr_match_t match, void *match_data);
 638
 639 /* managed devm_k.alloc/kfree for device drivers */
 640 /**
 641  * devm_kmalloc() - Resource-managed kmalloc
 642  * @dev: Device to allocate memory for
 643  * @size: Allocation size
 644  * @gfp: Allocation gfp flags
 645  *
 646  * Managed kmalloc.  Memory allocated with this function is
 647  * automatically freed on driver detach.  Like all other devres
 648  * resources, guaranteed alignment is unsigned long long.
 649  *
 650  * @return pointer to allocated memory on success, NULL on failure.
 651  */
 652 void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp);
 653 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
 654 {
 655         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
 656 }
 657 static inline void *devm_kmalloc_array(struct udevice *dev,
 658                                        size_t n, size_t size, gfp_t flags)
 659 {
 660         if (size != 0 && n > SIZE_MAX / size)
 661                 return NULL;
 662         return devm_kmalloc(dev, n * size, flags);
 663 }
 664 static inline void *devm_kcalloc(struct udevice *dev,
 665                                  size_t n, size_t size, gfp_t flags)
 666 {
 667         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
 668 }
 669
 670 /**
 671  * devm_kfree() - Resource-managed kfree
 672  * @dev: Device this memory belongs to
 673  * @ptr: Memory to free
 674  *
 675  * Free memory allocated with devm_kmalloc().
 676  */
 677 void devm_kfree(struct udevice *dev, void *ptr);
 678
 679 #else /* ! CONFIG_DEVRES */
 680
 681 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
 682 {
 683         return kzalloc(size, gfp);
 684 }
 685
 686 static inline void devres_free(void *res)
 687 {
 688         kfree(res);
 689 }
 690
 691 static inline void devres_add(struct udevice *dev, void *res)
 692 {
 693 }
 694
 695 static inline void *devres_find(struct udevice *dev, dr_release_t release,
 696                                 dr_match_t match, void *match_data)
 697 {
 698         return NULL;
 699 }
 700
 701 static inline void *devres_get(struct udevice *dev, void *new_res,
 702                                dr_match_t match, void *match_data)
 703 {
 704         return NULL;
 705 }
 706
 707 static inline void *devres_remove(struct udevice *dev, dr_release_t release,
 708                                   dr_match_t match, void *match_data)
 709 {
 710         return NULL;
 711 }
 712
 713 static inline int devres_destroy(struct udevice *dev, dr_release_t release,
 714                                  dr_match_t match, void *match_data)
 715 {
 716         return 0;
 717 }
 718
 719 static inline int devres_release(struct udevice *dev, dr_release_t release,
 720                                  dr_match_t match, void *match_data)
 721 {
 722         return 0;
 723 }
 724
 725 static inline void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp)
 726 {
 727         return kmalloc(size, gfp);
 728 }
 729
 730 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
 731 {
 732         return kzalloc(size, gfp);
 733 }
 734
 735 static inline void *devm_kmaloc_array(struct udevice *dev,
 736                                       size_t n, size_t size, gfp_t flags)
 737 {
 738         /* TODO: add kmalloc_array() to linux/compat.h */
 739         if (size != 0 && n > SIZE_MAX / size)
 740                 return NULL;
 741         return kmalloc(n * size, flags);
 742 }
 743
 744 static inline void *devm_kcalloc(struct udevice *dev,
 745                                  size_t n, size_t size, gfp_t flags)
 746 {
 747         /* TODO: add kcalloc() to linux/compat.h */
 748         return kmalloc(n * size, flags | __GFP_ZERO);
 749 }
 750
 751 static inline void devm_kfree(struct udevice *dev, void *ptr)
 752 {
 753         kfree(ptr);
 754 }
 755
 756 #endif /* ! CONFIG_DEVRES */
 757
 758 #endif