include/dm/uclass-internal.h

7  * SPDX-License-Identifier:	GPL-2.0+
16  * uclass_get_device_tail() - handle the end of a get_device call
18  * This handles returning an error or probing a device as needed.
20  * @dev: Device that needs to be probed
21  * @ret: Error to return. If non-zero then the device is not probed
23  * @return ret, if non-zero, else the result of the device_probe() call
28  * uclass_find_device() - Return n-th child of uclass
31  * #devp:	Returns pointer to device, or NULL on error
33  * The device is not prepared for use - this is an internal function.
34  * The function uclass_get_device_tail() can be used to probe the device.
37  * return NULL on error.
42  * uclass_find_first_device() - Return the first device in a uclass
44  * #devp:	Returns pointer to device, or NULL on error
46  * The device is not prepared for use - this is an internal function.
47  * The function uclass_get_device_tail() can be used to probe the device.
49  * @return 0 if OK (found or not found), -1 on error
54  * uclass_find_next_device() - Return the next device in a uclass
55  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
56  * to the next device in the same uclass, or NULL if none
58  * The device is not prepared for use - this is an internal function.
59  * The function uclass_get_device_tail() can be used to probe the device.
61  * @return 0 if OK (found or not found), -1 on error
66  * uclass_find_device_by_name() - Find uclass device based on ID and name
68  * This searches for a device with the exactly given name.
70  * The device is NOT probed, it is merely returned.
73  * @name: name of a device to find
74  * @devp: Returns pointer to device (the first one with the name)
75  * @return 0 if OK, -ve on error
81  * uclass_find_device_by_seq() - Find uclass device based on ID and sequence
83  * This searches for a device with the given seq or req_seq.
85  * For seq, if an active device has this sequence it will be returned.
86  * If there is no such device then this will return -ENODEV.
88  * For req_seq, if a device (whether activated or not) has this req_seq
89  * value, that device will be returned. This is a strong indication that
90  * the device will receive that sequence when activated.
92  * The device is NOT probed, it is merely returned.
97  * @devp: Returns pointer to device (there is only one per for each seq)
98  * @return 0 if OK, -ve on error
104  * uclass_find_device_by_of_offset() - Find a uclass device by device tree node
107  * device tree node.
109  * The device is NOT probed, it is merely returned.
112  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
113  * @devp: Returns pointer to device (there is only one for each node)
114  * @return 0 if OK, -ve on error
120  * uclass_find_device_by_of_node() - Find a uclass device by device tree node
123  * device tree node.
125  * The device is NOT probed, it is merely returned.
128  * @node: Device tree offset to search for (if NULL then -ENODEV is returned)
129  * @devp: Returns pointer to device (there is only one for each node)
130  * @return 0 if OK, -ve on error
136  * uclass_bind_device() - Associate device with a uclass
138  * Connect the device into uclass's list of devices.
140  * @dev:	Pointer to the device
141  * #return 0 on success, -ve on error
146  * uclass_unbind_device() - Deassociate device with a uclass
148  * Disconnect the device from uclass's list of devices.
150  * @dev:	Pointer to the device
151  * #return 0 on success, -ve on error
160  * uclass_pre_probe_device() - Deal with a device that is about to be probed
162  * Perform any pre-processing that is needed by the uclass before it can be
163  * probed. This includes the uclass' pre-probe() method and the parent
166  * @dev:	Pointer to the device
167  * #return 0 on success, -ve on error
172  * uclass_post_probe_device() - Deal with a device that has just been probed
174  * Perform any post-processing of a probed device that is needed by the
177  * @dev:	Pointer to the device
178  * #return 0 on success, -ve on error
183  * uclass_pre_remove_device() - Handle a device which is about to be removed
185  * Perform any pre-processing of a device that is about to be removed.
187  * @dev:	Pointer to the device
188  * #return 0 on success, -ve on error
197  * uclass_find() - Find uclass by its id
205  * uclass_destroy() - Destroy a uclass
210  * @return 0 on success, -ve on error