2 * Copyright (c) 2013 Google, Inc
5 * Pavel Herrmann <morpheus.ibis@gmail.com>
6 * Marek Vasut <marex@denx.de>
8 * SPDX-License-Identifier: GPL-2.0+
14 #include <dm/uclass-id.h>
16 #include <linker_lists.h>
17 #include <linux/compat.h>
18 #include <linux/kernel.h>
19 #include <linux/list.h>
23 /* Driver is active (probed). Cleared when it is removed */
24 #define DM_FLAG_ACTIVATED (1 << 0)
26 /* DM is responsible for allocating and freeing platdata */
27 #define DM_FLAG_ALLOC_PDATA (1 << 1)
29 /* DM should init this device prior to relocation */
30 #define DM_FLAG_PRE_RELOC (1 << 2)
32 /* DM is responsible for allocating and freeing parent_platdata */
33 #define DM_FLAG_ALLOC_PARENT_PDATA (1 << 3)
35 /* DM is responsible for allocating and freeing uclass_platdata */
36 #define DM_FLAG_ALLOC_UCLASS_PDATA (1 << 4)
38 /* Allocate driver private data on a DMA boundary */
39 #define DM_FLAG_ALLOC_PRIV_DMA (1 << 5)
42 #define DM_FLAG_BOUND (1 << 6)
44 /* Device name is allocated and should be freed on unbind() */
45 #define DM_FLAG_NAME_ALLOCED (1 << 7)
47 #define DM_FLAG_OF_PLATDATA (1 << 8)
50 * Call driver remove function to stop currently active DMA transfers or
51 * give DMA buffers back to the HW / controller. This may be needed for
52 * some drivers to do some final stage cleanup before the OS is called
55 #define DM_FLAG_ACTIVE_DMA (1 << 9)
58 * Call driver remove function to do some final configuration, before
59 * U-Boot exits and the OS is started
61 #define DM_FLAG_OS_PREPARE (1 << 10)
64 * One or multiple of these flags are passed to device_remove() so that
65 * a selective device removal as specified by the remove-stage and the
66 * driver flags can be done.
69 /* Normal remove, remove all devices */
70 DM_REMOVE_NORMAL = 1 << 0,
72 /* Remove devices with active DMA */
73 DM_REMOVE_ACTIVE_DMA = DM_FLAG_ACTIVE_DMA,
75 /* Remove devices which need some final OS preparation steps */
76 DM_REMOVE_OS_PREPARE = DM_FLAG_OS_PREPARE,
78 /* Add more use cases here */
80 /* Remove devices with any active flag */
81 DM_REMOVE_ACTIVE_ALL = DM_REMOVE_ACTIVE_DMA | DM_REMOVE_OS_PREPARE,
85 * struct udevice - An instance of a driver
87 * This holds information about a device, which is a driver bound to a
88 * particular port or peripheral (essentially a driver instance).
90 * A device will come into existence through a 'bind' call, either due to
91 * a U_BOOT_DEVICE() macro (in which case platdata is non-NULL) or a node
92 * in the device tree (in which case of_offset is >= 0). In the latter case
93 * we translate the device tree information into platdata in a function
94 * implemented by the driver ofdata_to_platdata method (called just before the
95 * probe method if the device has a device tree node.
97 * All three of platdata, priv and uclass_priv can be allocated by the
98 * driver, or you can use the auto_alloc_size members of struct driver and
99 * struct uclass_driver to have driver model do this automatically.
101 * @driver: The driver used by this device
102 * @name: Name of device, typically the FDT node name
103 * @platdata: Configuration data for this device
104 * @parent_platdata: The parent bus's configuration data for this device
105 * @uclass_platdata: The uclass's configuration data for this device
106 * @of_offset: Device tree node offset for this device (- for none)
107 * @driver_data: Driver data word for the entry that matched this device with
109 * @parent: Parent of this device, or NULL for the top level device
110 * @priv: Private data for this device
111 * @uclass: Pointer to uclass for this device
112 * @uclass_priv: The uclass's private data for this device
113 * @parent_priv: The parent's private data for this device
114 * @uclass_node: Used by uclass to link its devices
115 * @child_head: List of children of this device
116 * @sibling_node: Next device in list of all devices
117 * @flags: Flags for this device DM_FLAG_...
118 * @req_seq: Requested sequence number for this device (-1 = any)
119 * @seq: Allocated sequence number for this device (-1 = none). This is set up
120 * when the device is probed and will be unique within the device's uclass.
121 * @devres_head: List of memory allocations associated with this device.
122 * When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
123 * add to this list. Memory so-allocated will be freed
124 * automatically when the device is removed / unbound
127 const struct driver *driver;
130 void *parent_platdata;
131 void *uclass_platdata;
134 struct udevice *parent;
136 struct uclass *uclass;
139 struct list_head uclass_node;
140 struct list_head child_head;
141 struct list_head sibling_node;
146 struct list_head devres_head;
150 /* Maximum sequence number supported */
151 #define DM_MAX_SEQ 999
153 /* Returns the operations for a device */
154 #define device_get_ops(dev) (dev->driver->ops)
156 /* Returns non-zero if the device is active (probed and not removed) */
157 #define device_active(dev) ((dev)->flags & DM_FLAG_ACTIVATED)
159 static inline int dev_of_offset(const struct udevice *dev)
161 return dev->of_offset;
164 static inline void dev_set_of_offset(struct udevice *dev, int of_offset)
166 dev->of_offset = of_offset;
170 * struct udevice_id - Lists the compatible strings supported by a driver
171 * @compatible: Compatible string
172 * @data: Data for this compatible string
175 const char *compatible;
179 #if CONFIG_IS_ENABLED(OF_CONTROL)
180 #define of_match_ptr(_ptr) (_ptr)
182 #define of_match_ptr(_ptr) NULL
183 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
186 * struct driver - A driver for a feature or peripheral
188 * This holds methods for setting up a new device, and also removing it.
189 * The device needs information to set itself up - this is provided either
190 * by platdata or a device tree node (which we find by looking up
191 * matching compatible strings with of_match).
193 * Drivers all belong to a uclass, representing a class of devices of the
194 * same type. Common elements of the drivers can be implemented in the uclass,
195 * or the uclass can provide a consistent interface to the drivers within
199 * @id: Identiies the uclass we belong to
200 * @of_match: List of compatible strings to match, and any identifying data
202 * @bind: Called to bind a device to its driver
203 * @probe: Called to probe a device, i.e. activate it
204 * @remove: Called to remove a device, i.e. de-activate it
205 * @unbind: Called to unbind a device from its driver
206 * @ofdata_to_platdata: Called before probe to decode device tree data
207 * @child_post_bind: Called after a new child has been bound
208 * @child_pre_probe: Called before a child device is probed. The device has
209 * memory allocated but it has not yet been probed.
210 * @child_post_remove: Called after a child device is removed. The device
211 * has memory allocated but its device_remove() method has been called.
212 * @priv_auto_alloc_size: If non-zero this is the size of the private data
213 * to be allocated in the device's ->priv pointer. If zero, then the driver
214 * is responsible for allocating any data required.
215 * @platdata_auto_alloc_size: If non-zero this is the size of the
216 * platform data to be allocated in the device's ->platdata pointer.
217 * This is typically only useful for device-tree-aware drivers (those with
218 * an of_match), since drivers which use platdata will have the data
219 * provided in the U_BOOT_DEVICE() instantiation.
220 * @per_child_auto_alloc_size: Each device can hold private data owned by
221 * its parent. If required this will be automatically allocated if this
223 * @per_child_platdata_auto_alloc_size: A bus likes to store information about
224 * its children. If non-zero this is the size of this data, to be allocated
225 * in the child's parent_platdata pointer.
226 * @ops: Driver-specific operations. This is typically a list of function
227 * pointers defined by the driver, to implement driver functions required by
229 * @flags: driver flags - see DM_FLAGS_...
234 const struct udevice_id *of_match;
235 int (*bind)(struct udevice *dev);
236 int (*probe)(struct udevice *dev);
237 int (*remove)(struct udevice *dev);
238 int (*unbind)(struct udevice *dev);
239 int (*ofdata_to_platdata)(struct udevice *dev);
240 int (*child_post_bind)(struct udevice *dev);
241 int (*child_pre_probe)(struct udevice *dev);
242 int (*child_post_remove)(struct udevice *dev);
243 int priv_auto_alloc_size;
244 int platdata_auto_alloc_size;
245 int per_child_auto_alloc_size;
246 int per_child_platdata_auto_alloc_size;
247 const void *ops; /* driver-specific operations */
251 /* Declare a new U-Boot driver */
252 #define U_BOOT_DRIVER(__name) \
253 ll_entry_declare(struct driver, __name, driver)
255 /* Get a pointer to a given driver */
256 #define DM_GET_DRIVER(__name) \
257 ll_entry_get(struct driver, __name, driver)
260 * dev_get_platdata() - Get the platform data for a device
262 * This checks that dev is not NULL, but no other checks for now
264 * @dev Device to check
265 * @return platform data, or NULL if none
267 void *dev_get_platdata(struct udevice *dev);
270 * dev_get_parent_platdata() - Get the parent platform data for a device
272 * This checks that dev is not NULL, but no other checks for now
274 * @dev Device to check
275 * @return parent's platform data, or NULL if none
277 void *dev_get_parent_platdata(struct udevice *dev);
280 * dev_get_uclass_platdata() - Get the uclass platform data for a device
282 * This checks that dev is not NULL, but no other checks for now
284 * @dev Device to check
285 * @return uclass's platform data, or NULL if none
287 void *dev_get_uclass_platdata(struct udevice *dev);
290 * dev_get_priv() - Get the private data for a device
292 * This checks that dev is not NULL, but no other checks for now
294 * @dev Device to check
295 * @return private data, or NULL if none
297 void *dev_get_priv(struct udevice *dev);
300 * dev_get_parent_priv() - Get the parent private data for a device
302 * The parent private data is data stored in the device but owned by the
303 * parent. For example, a USB device may have parent data which contains
304 * information about how to talk to the device over USB.
306 * This checks that dev is not NULL, but no other checks for now
308 * @dev Device to check
309 * @return parent data, or NULL if none
311 void *dev_get_parent_priv(struct udevice *dev);
314 * dev_get_uclass_priv() - Get the private uclass data for a device
316 * This checks that dev is not NULL, but no other checks for now
318 * @dev Device to check
319 * @return private uclass data for this device, or NULL if none
321 void *dev_get_uclass_priv(struct udevice *dev);
324 * struct dev_get_parent() - Get the parent of a device
326 * @child: Child to check
327 * @return parent of child, or NULL if this is the root device
329 struct udevice *dev_get_parent(struct udevice *child);
332 * dev_get_driver_data() - get the driver data used to bind a device
334 * When a device is bound using a device tree node, it matches a
335 * particular compatible string in struct udevice_id. This function
336 * returns the associated data value for that compatible string. This is
337 * the 'data' field in struct udevice_id.
339 * As an example, consider this structure:
340 * static const struct udevice_id tegra_i2c_ids[] = {
341 * { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 },
342 * { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD },
343 * { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC },
347 * When driver model finds a driver for this it will store the 'data' value
348 * corresponding to the compatible string it matches. This function returns
349 * that value. This allows the driver to handle several variants of a device.
351 * For USB devices, this is the driver_info field in struct usb_device_id.
353 * @dev: Device to check
354 * @return driver data (0 if none is provided)
356 ulong dev_get_driver_data(struct udevice *dev);
359 * dev_get_driver_ops() - get the device's driver's operations
361 * This checks that dev is not NULL, and returns the pointer to device's
362 * driver's operations.
364 * @dev: Device to check
365 * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
367 const void *dev_get_driver_ops(struct udevice *dev);
370 * device_get_uclass_id() - return the uclass ID of a device
372 * @dev: Device to check
373 * @return uclass ID for the device
375 enum uclass_id device_get_uclass_id(struct udevice *dev);
378 * dev_get_uclass_name() - return the uclass name of a device
380 * This checks that dev is not NULL.
382 * @dev: Device to check
383 * @return pointer to the uclass name for the device
385 const char *dev_get_uclass_name(struct udevice *dev);
388 * device_get_child() - Get the child of a device by index
390 * Returns the numbered child, 0 being the first. This does not use
391 * sequence numbers, only the natural order.
393 * @dev: Parent device to check
394 * @index: Child index
395 * @devp: Returns pointer to device
396 * @return 0 if OK, -ENODEV if no such device, other error if the device fails
399 int device_get_child(struct udevice *parent, int index, struct udevice **devp);
402 * device_find_child_by_seq() - Find a child device based on a sequence
404 * This searches for a device with the given seq or req_seq.
406 * For seq, if an active device has this sequence it will be returned.
407 * If there is no such device then this will return -ENODEV.
409 * For req_seq, if a device (whether activated or not) has this req_seq
410 * value, that device will be returned. This is a strong indication that
411 * the device will receive that sequence when activated.
413 * @parent: Parent device
414 * @seq_or_req_seq: Sequence number to find (0=first)
415 * @find_req_seq: true to find req_seq, false to find seq
416 * @devp: Returns pointer to device (there is only one per for each seq).
417 * Set to NULL if none is found
418 * @return 0 if OK, -ve on error
420 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
421 bool find_req_seq, struct udevice **devp);
424 * device_get_child_by_seq() - Get a child device based on a sequence
426 * If an active device has this sequence it will be returned. If there is no
427 * such device then this will check for a device that is requesting this
430 * The device is probed to activate it ready for use.
432 * @parent: Parent device
433 * @seq: Sequence number to find (0=first)
434 * @devp: Returns pointer to device (there is only one per for each seq)
435 * Set to NULL if none is found
436 * @return 0 if OK, -ve on error
438 int device_get_child_by_seq(struct udevice *parent, int seq,
439 struct udevice **devp);
442 * device_find_child_by_of_offset() - Find a child device based on FDT offset
444 * Locates a child device by its device tree offset.
446 * @parent: Parent device
447 * @of_offset: Device tree offset to find
448 * @devp: Returns pointer to device if found, otherwise this is set to NULL
449 * @return 0 if OK, -ve on error
451 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
452 struct udevice **devp);
455 * device_get_child_by_of_offset() - Get a child device based on FDT offset
457 * Locates a child device by its device tree offset.
459 * The device is probed to activate it ready for use.
461 * @parent: Parent device
462 * @of_offset: Device tree offset to find
463 * @devp: Returns pointer to device if found, otherwise this is set to NULL
464 * @return 0 if OK, -ve on error
466 int device_get_child_by_of_offset(struct udevice *parent, int of_offset,
467 struct udevice **devp);
470 * device_get_global_by_of_offset() - Get a device based on FDT offset
472 * Locates a device by its device tree offset, searching globally throughout
473 * the all driver model devices.
475 * The device is probed to activate it ready for use.
477 * @of_offset: Device tree offset to find
478 * @devp: Returns pointer to device if found, otherwise this is set to NULL
479 * @return 0 if OK, -ve on error
481 int device_get_global_by_of_offset(int of_offset, struct udevice **devp);
484 * device_find_first_child() - Find the first child of a device
486 * @parent: Parent device to search
487 * @devp: Returns first child device, or NULL if none
490 int device_find_first_child(struct udevice *parent, struct udevice **devp);
493 * device_find_next_child() - Find the next child of a device
495 * @devp: Pointer to previous child device on entry. Returns pointer to next
496 * child device, or NULL if none
499 int device_find_next_child(struct udevice **devp);
502 * dev_get_addr() - Get the reg property of a device
504 * @dev: Pointer to a device
508 fdt_addr_t dev_get_addr(struct udevice *dev);
511 * dev_get_addr_ptr() - Return pointer to the address of the reg property
514 * @dev: Pointer to a device
516 * @return Pointer to addr, or NULL if there is no such property
518 void *dev_get_addr_ptr(struct udevice *dev);
521 * dev_map_physmem() - Read device address from reg property of the
522 * device node and map the address into CPU address
525 * @dev: Pointer to device
526 * @size: size of the memory to map
528 * @return mapped address, or NULL if the device does not have reg
531 void *dev_map_physmem(struct udevice *dev, unsigned long size);
534 * dev_get_addr_index() - Get the indexed reg property of a device
536 * @dev: Pointer to a device
537 * @index: the 'reg' property can hold a list of <addr, size> pairs
538 * and @index is used to select which one is required
542 fdt_addr_t dev_get_addr_index(struct udevice *dev, int index);
545 * dev_get_addr_size_index() - Get the indexed reg property of a device
547 * Returns the address and size specified in the 'reg' property of a device.
549 * @dev: Pointer to a device
550 * @index: the 'reg' property can hold a list of <addr, size> pairs
551 * and @index is used to select which one is required
552 * @size: Pointer to size varible - this function returns the size
553 * specified in the 'reg' property here
557 fdt_addr_t dev_get_addr_size_index(struct udevice *dev, int index,
561 * dev_get_addr_name() - Get the reg property of a device, indexed by name
563 * @dev: Pointer to a device
564 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
565 * 'reg-names' property providing named-based identification. @index
566 * indicates the value to search for in 'reg-names'.
570 fdt_addr_t dev_get_addr_name(struct udevice *dev, const char *name);
573 * device_has_children() - check if a device has any children
575 * @dev: Device to check
576 * @return true if the device has one or more children
578 bool device_has_children(struct udevice *dev);
581 * device_has_active_children() - check if a device has any active children
583 * @dev: Device to check
584 * @return true if the device has one or more children and at least one of
585 * them is active (probed).
587 bool device_has_active_children(struct udevice *dev);
590 * device_is_last_sibling() - check if a device is the last sibling
592 * This function can be useful for display purposes, when special action needs
593 * to be taken when displaying the last sibling. This can happen when a tree
594 * view of devices is being displayed.
596 * @dev: Device to check
597 * @return true if there are no more siblings after this one - i.e. is it
600 bool device_is_last_sibling(struct udevice *dev);
603 * device_set_name() - set the name of a device
605 * This must be called in the device's bind() method and no later. Normally
606 * this is unnecessary but for probed devices which don't get a useful name
607 * this function can be helpful.
609 * The name is allocated and will be freed automatically when the device is
612 * @dev: Device to update
613 * @name: New name (this string is allocated new memory and attached to
615 * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
618 int device_set_name(struct udevice *dev, const char *name);
621 * device_set_name_alloced() - note that a device name is allocated
623 * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is
624 * unbound the name will be freed. This avoids memory leaks.
626 * @dev: Device to update
628 void device_set_name_alloced(struct udevice *dev);
631 * of_device_is_compatible() - check if the device is compatible with the compat
633 * This allows to check whether the device is comaptible with the compat.
635 * @dev: udevice pointer for which compatible needs to be verified.
636 * @compat: Compatible string which needs to verified in the given
638 * @return true if OK, false if the compatible is not found
640 bool of_device_is_compatible(struct udevice *dev, const char *compat);
643 * of_machine_is_compatible() - check if the machine is compatible with
646 * This allows to check whether the machine is comaptible with the compat.
648 * @compat: Compatible string which needs to verified
649 * @return true if OK, false if the compatible is not found
651 bool of_machine_is_compatible(const char *compat);
654 * device_is_on_pci_bus - Test if a device is on a PCI bus
656 * @dev: device to test
657 * @return: true if it is on a PCI bus, false otherwise
659 static inline bool device_is_on_pci_bus(struct udevice *dev)
661 return device_get_uclass_id(dev->parent) == UCLASS_PCI;
665 * device_foreach_child_safe() - iterate through child devices safely
667 * This allows the @pos child to be removed in the loop if required.
669 * @pos: struct udevice * for the current device
670 * @next: struct udevice * for the next device
671 * @parent: parent device to scan
673 #define device_foreach_child_safe(pos, next, parent) \
674 list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
677 * dm_scan_fdt_dev() - Bind child device in a the device tree
679 * This handles device which have sub-nodes in the device tree. It scans all
680 * sub-nodes and binds drivers for each node where a driver can be found.
682 * If this is called prior to relocation, only pre-relocation devices will be
683 * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where
684 * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will
687 * @dev: Device to scan
688 * @return 0 if OK, -ve on error
690 int dm_scan_fdt_dev(struct udevice *dev);
692 /* device resource management */
693 typedef void (*dr_release_t)(struct udevice *dev, void *res);
694 typedef int (*dr_match_t)(struct udevice *dev, void *res, void *match_data);
698 #ifdef CONFIG_DEBUG_DEVRES
699 void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
701 #define _devres_alloc(release, size, gfp) \
702 __devres_alloc(release, size, gfp, #release)
704 void *_devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
708 * devres_alloc() - Allocate device resource data
709 * @release: Release function devres will be associated with
710 * @size: Allocation size
711 * @gfp: Allocation flags
713 * Allocate devres of @size bytes. The allocated area is associated
714 * with @release. The returned pointer can be passed to
715 * other devres_*() functions.
718 * Pointer to allocated devres on success, NULL on failure.
720 #define devres_alloc(release, size, gfp) \
721 _devres_alloc(release, size, gfp | __GFP_ZERO)
724 * devres_free() - Free device resource data
725 * @res: Pointer to devres data to free
727 * Free devres created with devres_alloc().
729 void devres_free(void *res);
732 * devres_add() - Register device resource
733 * @dev: Device to add resource to
734 * @res: Resource to register
736 * Register devres @res to @dev. @res should have been allocated
737 * using devres_alloc(). On driver detach, the associated release
738 * function will be invoked and devres will be freed automatically.
740 void devres_add(struct udevice *dev, void *res);
743 * devres_find() - Find device resource
744 * @dev: Device to lookup resource from
745 * @release: Look for resources associated with this release function
746 * @match: Match function (optional)
747 * @match_data: Data for the match function
749 * Find the latest devres of @dev which is associated with @release
750 * and for which @match returns 1. If @match is NULL, it's considered
753 * @return pointer to found devres, NULL if not found.
755 void *devres_find(struct udevice *dev, dr_release_t release,
756 dr_match_t match, void *match_data);
759 * devres_get() - Find devres, if non-existent, add one atomically
760 * @dev: Device to lookup or add devres for
761 * @new_res: Pointer to new initialized devres to add if not found
762 * @match: Match function (optional)
763 * @match_data: Data for the match function
765 * Find the latest devres of @dev which has the same release function
766 * as @new_res and for which @match return 1. If found, @new_res is
767 * freed; otherwise, @new_res is added atomically.
769 * @return ointer to found or added devres.
771 void *devres_get(struct udevice *dev, void *new_res,
772 dr_match_t match, void *match_data);
775 * devres_remove() - Find a device resource and remove it
776 * @dev: Device to find resource from
777 * @release: Look for resources associated with this release function
778 * @match: Match function (optional)
779 * @match_data: Data for the match function
781 * Find the latest devres of @dev associated with @release and for
782 * which @match returns 1. If @match is NULL, it's considered to
783 * match all. If found, the resource is removed atomically and
786 * @return ointer to removed devres on success, NULL if not found.
788 void *devres_remove(struct udevice *dev, dr_release_t release,
789 dr_match_t match, void *match_data);
792 * devres_destroy() - Find a device resource and destroy it
793 * @dev: Device to find resource from
794 * @release: Look for resources associated with this release function
795 * @match: Match function (optional)
796 * @match_data: Data for the match function
798 * Find the latest devres of @dev associated with @release and for
799 * which @match returns 1. If @match is NULL, it's considered to
800 * match all. If found, the resource is removed atomically and freed.
802 * Note that the release function for the resource will not be called,
803 * only the devres-allocated data will be freed. The caller becomes
804 * responsible for freeing any other data.
806 * @return 0 if devres is found and freed, -ENOENT if not found.
808 int devres_destroy(struct udevice *dev, dr_release_t release,
809 dr_match_t match, void *match_data);
812 * devres_release() - Find a device resource and destroy it, calling release
813 * @dev: Device to find resource from
814 * @release: Look for resources associated with this release function
815 * @match: Match function (optional)
816 * @match_data: Data for the match function
818 * Find the latest devres of @dev associated with @release and for
819 * which @match returns 1. If @match is NULL, it's considered to
820 * match all. If found, the resource is removed atomically, the
821 * release function called and the resource freed.
823 * @return 0 if devres is found and freed, -ENOENT if not found.
825 int devres_release(struct udevice *dev, dr_release_t release,
826 dr_match_t match, void *match_data);
828 /* managed devm_k.alloc/kfree for device drivers */
830 * devm_kmalloc() - Resource-managed kmalloc
831 * @dev: Device to allocate memory for
832 * @size: Allocation size
833 * @gfp: Allocation gfp flags
835 * Managed kmalloc. Memory allocated with this function is
836 * automatically freed on driver detach. Like all other devres
837 * resources, guaranteed alignment is unsigned long long.
839 * @return pointer to allocated memory on success, NULL on failure.
841 void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp);
842 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
844 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
846 static inline void *devm_kmalloc_array(struct udevice *dev,
847 size_t n, size_t size, gfp_t flags)
849 if (size != 0 && n > SIZE_MAX / size)
851 return devm_kmalloc(dev, n * size, flags);
853 static inline void *devm_kcalloc(struct udevice *dev,
854 size_t n, size_t size, gfp_t flags)
856 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
860 * devm_kfree() - Resource-managed kfree
861 * @dev: Device this memory belongs to
862 * @ptr: Memory to free
864 * Free memory allocated with devm_kmalloc().
866 void devm_kfree(struct udevice *dev, void *ptr);
868 #else /* ! CONFIG_DEVRES */
870 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
872 return kzalloc(size, gfp);
875 static inline void devres_free(void *res)
880 static inline void devres_add(struct udevice *dev, void *res)
884 static inline void *devres_find(struct udevice *dev, dr_release_t release,
885 dr_match_t match, void *match_data)
890 static inline void *devres_get(struct udevice *dev, void *new_res,
891 dr_match_t match, void *match_data)
896 static inline void *devres_remove(struct udevice *dev, dr_release_t release,
897 dr_match_t match, void *match_data)
902 static inline int devres_destroy(struct udevice *dev, dr_release_t release,
903 dr_match_t match, void *match_data)
908 static inline int devres_release(struct udevice *dev, dr_release_t release,
909 dr_match_t match, void *match_data)
914 static inline void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp)
916 return kmalloc(size, gfp);
919 static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
921 return kzalloc(size, gfp);
924 static inline void *devm_kmaloc_array(struct udevice *dev,
925 size_t n, size_t size, gfp_t flags)
927 /* TODO: add kmalloc_array() to linux/compat.h */
928 if (size != 0 && n > SIZE_MAX / size)
930 return kmalloc(n * size, flags);
933 static inline void *devm_kcalloc(struct udevice *dev,
934 size_t n, size_t size, gfp_t flags)
936 /* TODO: add kcalloc() to linux/compat.h */
937 return kmalloc(n * size, flags | __GFP_ZERO);
940 static inline void devm_kfree(struct udevice *dev, void *ptr)
945 #endif /* ! CONFIG_DEVRES */
948 * dm_set_translation_offset() - Set translation offset
949 * @offs: Translation offset
951 * Some platforms need a special address translation. Those
952 * platforms (e.g. mvebu in SPL) can configure a translation
953 * offset in the DM by calling this function. It will be
954 * added to all addresses returned in dev_get_addr().
956 void dm_set_translation_offset(fdt_addr_t offs);
959 * dm_get_translation_offset() - Get translation offset
961 * This function returns the translation offset that can
962 * be configured by calling dm_set_translation_offset().
964 * @return translation offset for the device address (0 as default).
966 fdt_addr_t dm_get_translation_offset(void);