include/dm/uclass.h

7  * SPDX-License-Identifier:	GPL-2.0+
14 #include <dm/uclass-id.h>
19  * struct uclass - a U-Boot drive class, collecting together similar drivers
25  * There may be drivers for on-chip SoC GPIO banks, I2C GPIO expanders and
52  * struct uclass_driver - Driver for the uclass
65  * @init: Called to set up the uclass
67  * @priv_auto_alloc_size: If non-zero this is the size of the private data
68  * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
72  * value is non-zero.
74  * owned by the uclass as 'dev->uclass_platdata'. If the value is non-zero,
80  * its children. If non-zero this is the size of this data, to be allocated
113  * uclass_get() - Get a uclass based on an ID, creating it if needed
115  * Every uclass is identified by an ID, a number from 0 to n-1 where n is
116  * the number of uclasses. This function allows looking up a uclass by its
119  * @key: ID to look up
121  * @return 0 if OK, -ve on error
126  * uclass_get_name() - Get the name of a uclass driver
128  * @id: ID to look up
134  * uclass_get_by_name() - Look up a uclass by its driver name
136  * @name: Name to look up
142  * uclass_get_device() - Get a uclass device based on an ID and index
146  * @id: ID to look up
149  * @return 0 if OK, -ve on error
154  * uclass_get_device_by_name() - Get a uclass device by its name
160  * @id: ID to look up
163  * @return 0 if OK, -ve on error
169  * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
177  * @id: ID to look up
180  * @return 0 if OK, -ve on error
185  * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
192  * @id: ID to look up
193  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
195  * @return 0 if OK, -ve on error
201  * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
208  * @id: ID to look up
209  * @np: Device tree node to search for (if NULL then -ENODEV is returned)
211  * @return 0 if OK, -ve on error
217  * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
223  * @id: uclass ID to look up
224  * @phandle_id: the phandle id to look up
226  * @return 0 if OK, -ENODEV if there is no device match the phandle, other
227  *	-ve on error
233  * uclass_get_device_by_phandle() - Get a uclass device by phandle
239  * @id: uclass ID to look up
243  * @return 0 if OK, -ENOENT if there is no @name present in the node, other
244  *	-ve on error
250  * uclass_get_device_by_driver() - Get a uclass device for a driver
254  * the driver name - as used in U_BOOT_DRIVER(name).
258  * @id: ID to look up
261  * @return 0 if OK, -ve on error
267  * uclass_first_device() - Get the first device in a uclass
271  * This function is useful to start iterating through a list of devices which
274  * @id: Uclass ID to look up
278  * @return 0 if OK (found or not found), other -ve on error
283  * uclass_first_device_err() - Get the first device in a uclass
287  * @id: Uclass ID to look up
289  * @return 0 if found, -ENODEV if not found, other -ve on error
294  * uclass_next_device() - Get the next device in a uclass
298  * This function is useful to start iterating through a list of devices which
304  * @return 0 if OK (found or not found), other -ve on error
309  * uclass_first_device() - Get the first device in a uclass
313  * This function is useful to start iterating through a list of devices which
316  * @id: Uclass ID to look up
319  * @return 0 if OK (found or not found), other -ve on error. If an error occurs
325  * uclass_next_device() - Get the next device in a uclass
329  * This function is useful to start iterating through a list of devices which
334  * @return 0 if OK (found or not found), other -ve on error. If an error occurs
340  * uclass_resolve_seq() - Resolve a device's sequence number
342  * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a
350  * @return sequence number allocated, or -ve on error
355  * uclass_foreach_dev() - Helper function to iteration through devices
358  * a uclass in order from start to end.
365 	list_for_each_entry(pos, &uc->dev_head, uclass_node)
368  * uclass_foreach_dev_safe() - Helper function to safely iteration through devs
371  * a uclass in order from start to end. Inside the loop, it is safe to remove
380 	list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)