blob: 456eef7f2f319ec07132d9e567b2d958efe58013 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass6494d702014-02-26 15:59:18 -07002/*
3 * Copyright (c) 2013 Google, Inc
4 *
5 * (C) Copyright 2012
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
Simon Glass6494d702014-02-26 15:59:18 -07007 */
8
9#ifndef _DM_UCLASS_H
10#define _DM_UCLASS_H
11
Simon Glass40bb6372017-05-18 20:09:09 -060012#include <dm/ofnode.h>
Simon Glass6494d702014-02-26 15:59:18 -070013#include <dm/uclass-id.h>
Masahiro Yamada42c23dd2014-10-07 14:49:13 +090014#include <linker_lists.h>
Simon Glass6494d702014-02-26 15:59:18 -070015#include <linux/list.h>
16
17/**
18 * struct uclass - a U-Boot drive class, collecting together similar drivers
19 *
20 * A uclass provides an interface to a particular function, which is
21 * implemented by one or more drivers. Every driver belongs to a uclass even
22 * if it is the only driver in that uclass. An example uclass is GPIO, which
23 * provides the ability to change read inputs, set and clear outputs, etc.
24 * There may be drivers for on-chip SoC GPIO banks, I2C GPIO expanders and
25 * PMIC IO lines, all made available in a unified way through the uclass.
26 *
Simon Glassfb8c9fb2020-12-22 19:30:30 -070027 * @priv_: Private data for this uclass (do not access outside driver model)
Simon Glass6494d702014-02-26 15:59:18 -070028 * @uc_drv: The driver for the uclass itself, not to be confused with a
29 * 'struct driver'
Simon Glassf2bc6fc2014-06-11 23:29:54 -060030 * @dev_head: List of devices in this uclass (devices are attached to their
Simon Glass6494d702014-02-26 15:59:18 -070031 * uclass when their bind method is called)
32 * @sibling_node: Next uclass in the linked list of uclasses
33 */
34struct uclass {
Simon Glassfb8c9fb2020-12-22 19:30:30 -070035 void *priv_;
Simon Glass6494d702014-02-26 15:59:18 -070036 struct uclass_driver *uc_drv;
37 struct list_head dev_head;
38 struct list_head sibling_node;
39};
40
Simon Glassc57f8062016-07-17 15:23:15 -060041struct driver;
Heiko Schocher54c5d082014-05-22 12:43:05 +020042struct udevice;
Simon Glass6494d702014-02-26 15:59:18 -070043
Simon Glass9cc36a22015-01-25 08:27:05 -070044/* Members of this uclass sequence themselves with aliases */
45#define DM_UC_FLAG_SEQ_ALIAS (1 << 0)
46
Simon Glass15a11962020-12-16 21:20:17 -070047/* Members of this uclass without aliases don't get a sequence number */
48#define DM_UC_FLAG_NO_AUTO_SEQ (1 << 1)
49
Simon Glassc7a3acc2018-10-01 12:22:05 -060050/* Same as DM_FLAG_ALLOC_PRIV_DMA */
51#define DM_UC_FLAG_ALLOC_PRIV_DMA (1 << 5)
52
Simon Glass6494d702014-02-26 15:59:18 -070053/**
54 * struct uclass_driver - Driver for the uclass
55 *
56 * A uclass_driver provides a consistent interface to a set of related
57 * drivers.
58 *
59 * @name: Name of uclass driver
60 * @id: ID number of this uclass
61 * @post_bind: Called after a new device is bound to this uclass
62 * @pre_unbind: Called before a device is unbound from this uclass
Simon Glass02c07b32015-03-05 12:25:22 -070063 * @pre_probe: Called before a new device is probed
Simon Glass6494d702014-02-26 15:59:18 -070064 * @post_probe: Called after a new device is probed
65 * @pre_remove: Called before a device is removed
Simon Glass081f2fc2015-01-25 08:27:08 -070066 * @child_post_bind: Called after a child is bound to a device in this uclass
Bin Meng651d0c02018-10-15 02:20:57 -070067 * @child_pre_probe: Called before a child in this uclass is probed
68 * @child_post_probe: Called after a child in this uclass is probed
Simon Glass6494d702014-02-26 15:59:18 -070069 * @init: Called to set up the uclass
70 * @destroy: Called to destroy the uclass
Simon Glass41575d82020-12-03 16:55:17 -070071 * @priv_auto: If non-zero this is the size of the private data
Simon Glass6494d702014-02-26 15:59:18 -070072 * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
73 * driver is responsible for allocating any data required.
Simon Glass41575d82020-12-03 16:55:17 -070074 * @per_device_auto: Each device can hold private data owned
Simon Glass6494d702014-02-26 15:59:18 -070075 * by the uclass. If required this will be automatically allocated if this
76 * value is non-zero.
Simon Glasscaa4daa2020-12-03 16:55:18 -070077 * @per_device_plat_auto: Each device can hold platform data
78 * owned by the uclass as 'dev->uclass_plat'. If the value is non-zero,
Przemyslaw Marczak5eaed882015-04-15 13:07:18 +020079 * then this will be automatically allocated.
Simon Glass41575d82020-12-03 16:55:17 -070080 * @per_child_auto: Each child device (of a parent in this
Simon Glassdac8db22015-01-25 08:27:06 -070081 * uclass) can hold parent data for the device/uclass. This value is only
Heinrich Schuchardtfa9335a2017-12-17 18:19:43 +010082 * used as a fallback if this member is 0 in the driver.
Simon Glasscaa4daa2020-12-03 16:55:18 -070083 * @per_child_plat_auto: A bus likes to store information about
Simon Glassba8da9d2015-01-25 08:27:02 -070084 * its children. If non-zero this is the size of this data, to be allocated
Simon Glasscaa4daa2020-12-03 16:55:18 -070085 * in the child device's parent_plat pointer. This value is only used as
Heinrich Schuchardtfa9335a2017-12-17 18:19:43 +010086 * a fallback if this member is 0 in the driver.
Patrick Delaunay797b2a22022-01-12 10:53:42 +010087 * @flags: Flags for this uclass ``(DM_UC_...)``
Simon Glass6494d702014-02-26 15:59:18 -070088 */
89struct uclass_driver {
90 const char *name;
91 enum uclass_id id;
Heiko Schocher54c5d082014-05-22 12:43:05 +020092 int (*post_bind)(struct udevice *dev);
93 int (*pre_unbind)(struct udevice *dev);
Simon Glass02c07b32015-03-05 12:25:22 -070094 int (*pre_probe)(struct udevice *dev);
Heiko Schocher54c5d082014-05-22 12:43:05 +020095 int (*post_probe)(struct udevice *dev);
96 int (*pre_remove)(struct udevice *dev);
Simon Glass081f2fc2015-01-25 08:27:08 -070097 int (*child_post_bind)(struct udevice *dev);
Simon Glass83c7e432015-01-25 08:27:10 -070098 int (*child_pre_probe)(struct udevice *dev);
Bin Meng651d0c02018-10-15 02:20:57 -070099 int (*child_post_probe)(struct udevice *dev);
Simon Glass6494d702014-02-26 15:59:18 -0700100 int (*init)(struct uclass *class);
101 int (*destroy)(struct uclass *class);
Simon Glass41575d82020-12-03 16:55:17 -0700102 int priv_auto;
103 int per_device_auto;
Simon Glasscaa4daa2020-12-03 16:55:18 -0700104 int per_device_plat_auto;
Simon Glass41575d82020-12-03 16:55:17 -0700105 int per_child_auto;
Simon Glasscaa4daa2020-12-03 16:55:18 -0700106 int per_child_plat_auto;
Simon Glass9cc36a22015-01-25 08:27:05 -0700107 uint32_t flags;
Simon Glass6494d702014-02-26 15:59:18 -0700108};
109
110/* Declare a new uclass_driver */
111#define UCLASS_DRIVER(__name) \
Simon Glass9c503132020-12-22 19:30:23 -0700112 ll_entry_declare(struct uclass_driver, __name, uclass_driver)
Simon Glass6494d702014-02-26 15:59:18 -0700113
Simon Glass607f9bc2021-03-15 17:25:14 +1300114/*
115 * These two macros DM_UCLASS_DRIVER_REF and DM_UCLASS_DRIVER_REF are only
116 * allowed in code generated by dtoc, because the ordering is important and if
117 * other instances creep in then they may mess up the ordering expected by dtoc.
118 *
119 * It is OK to use them with 'extern' though, since that does not actually
120 * add a new record to the linker_list.
121 */
122
123/**
124 * DM_UCLASS_DRIVER_REF() - Get a reference to a uclass driver
125 *
126 * This is useful in data structures and code for referencing a uclass_driver at
127 * build time. Before this is used, an extern UCLASS_DRIVER() must have been
128 * declared.
129 *
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100130 * For example::
Simon Glass607f9bc2021-03-15 17:25:14 +1300131 *
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100132 * extern UCLASS_DRIVER(clk);
133 * struct uclass_driver *drvs[] = {
134 * DM_UCLASS_DRIVER_REF(clk),
135 * };
Simon Glass607f9bc2021-03-15 17:25:14 +1300136 *
137 * @_name: Name of the uclass_driver. This must be a valid C identifier, used by
138 * the linker_list.
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100139 * Return: struct uclass_driver * for the uclass driver
Simon Glass607f9bc2021-03-15 17:25:14 +1300140 */
141#define DM_UCLASS_DRIVER_REF(_name) \
142 ll_entry_ref(struct uclass_driver, _name, uclass_driver)
143
Simon Glass6494d702014-02-26 15:59:18 -0700144/**
Simon Glass80647392020-12-22 19:30:26 -0700145 * uclass_get_priv() - Get the private data for a uclass
146 *
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100147 * @uc: Uclass to check
148 * Return: private data, or NULL if none
Simon Glass80647392020-12-22 19:30:26 -0700149 */
150void *uclass_get_priv(const struct uclass *uc);
151
152/**
Simon Glass6494d702014-02-26 15:59:18 -0700153 * uclass_get() - Get a uclass based on an ID, creating it if needed
154 *
155 * Every uclass is identified by an ID, a number from 0 to n-1 where n is
156 * the number of uclasses. This function allows looking up a uclass by its
157 * ID.
158 *
159 * @key: ID to look up
160 * @ucp: Returns pointer to uclass (there is only one per ID)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100161 * Return:
162 * 0 if OK, -EDEADLK if driver model is not yet inited,
163 * other -ve on other error
Simon Glass6494d702014-02-26 15:59:18 -0700164 */
165int uclass_get(enum uclass_id key, struct uclass **ucp);
166
167/**
Simon Glass0a5f6f82016-10-05 20:42:13 -0600168 * uclass_get_name() - Get the name of a uclass driver
169 *
170 * @id: ID to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100171 * Return: the name of the uclass driver for that ID, or NULL if none
Simon Glass0a5f6f82016-10-05 20:42:13 -0600172 */
173const char *uclass_get_name(enum uclass_id id);
174
175/**
Simon Glass6aa4fe32022-04-24 23:30:59 -0600176 * uclass_get_by_namelen() - Look up a uclass by its driver name
Simon Glass6e43d1b2017-12-28 13:14:15 -0700177 *
178 * @name: Name to look up
Simon Glass6aa4fe32022-04-24 23:30:59 -0600179 * @len: Length of @name (the uclass driver name must have the same length)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100180 * Return: the associated uclass ID, or UCLASS_INVALID if not found
Simon Glass4b030172021-10-23 17:26:08 -0600181 */
Simon Glass6aa4fe32022-04-24 23:30:59 -0600182enum uclass_id uclass_get_by_namelen(const char *name, int len);
Simon Glass4b030172021-10-23 17:26:08 -0600183
184/**
185 * uclass_get_by_name() - Look up a uclass by its driver name
186 *
187 * @name: Name to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100188 * Return: the associated uclass ID, or UCLASS_INVALID if not found
Simon Glass6e43d1b2017-12-28 13:14:15 -0700189 */
190enum uclass_id uclass_get_by_name(const char *name);
191
192/**
Simon Glass6494d702014-02-26 15:59:18 -0700193 * uclass_get_device() - Get a uclass device based on an ID and index
194 *
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600195 * The device is probed to activate it ready for use.
196 *
Simon Glass0040b942014-07-23 06:55:17 -0600197 * @id: ID to look up
Simon Glass6494d702014-02-26 15:59:18 -0700198 * @index: Device number within that uclass (0=first)
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600199 * @devp: Returns pointer to device (there is only one per for each ID)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100200 * Return: 0 if OK, -ve on error
Simon Glass6494d702014-02-26 15:59:18 -0700201 */
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600202int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700203
204/**
Simon Glass74356d72015-07-30 13:40:40 -0600205 * uclass_get_device_by_name() - Get a uclass device by its name
Przemyslaw Marczakb7af1a22015-04-15 13:07:23 +0200206 *
Przemyslaw Marczaka7b82502015-04-20 13:32:34 +0200207 * This searches the devices in the uclass for one with the exactly given name.
Przemyslaw Marczakb7af1a22015-04-15 13:07:23 +0200208 *
209 * The device is probed to activate it ready for use.
210 *
211 * @id: ID to look up
212 * @name: name of a device to get
213 * @devp: Returns pointer to device (the first one with the name)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100214 * Return: 0 if OK, -ve on error
Przemyslaw Marczakb7af1a22015-04-15 13:07:23 +0200215 */
216int uclass_get_device_by_name(enum uclass_id id, const char *name,
217 struct udevice **devp);
218
219/**
Simon Glass5a66a8f2014-07-23 06:55:12 -0600220 * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
221 *
222 * If an active device has this sequence it will be returned. If there is no
223 * such device then this will check for a device that is requesting this
224 * sequence.
225 *
226 * The device is probed to activate it ready for use.
227 *
228 * @id: ID to look up
229 * @seq: Sequence number to find (0=first)
230 * @devp: Returns pointer to device (there is only one for each seq)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100231 * Return: 0 if OK, -ve on error
Simon Glass5a66a8f2014-07-23 06:55:12 -0600232 */
233int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
234
235/**
Simon Glassf4cdead2014-07-23 06:55:14 -0600236 * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
237 *
238 * This searches the devices in the uclass for one attached to the given
239 * device tree node.
240 *
241 * The device is probed to activate it ready for use.
242 *
243 * @id: ID to look up
244 * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
245 * @devp: Returns pointer to device (there is only one for each node)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100246 * Return: 0 if OK, -ve on error
Simon Glassf4cdead2014-07-23 06:55:14 -0600247 */
248int uclass_get_device_by_of_offset(enum uclass_id id, int node,
249 struct udevice **devp);
250
251/**
Simon Glass40bb6372017-05-18 20:09:09 -0600252 * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
253 *
254 * This searches the devices in the uclass for one attached to the given
255 * device tree node.
256 *
257 * The device is probed to activate it ready for use.
258 *
259 * @id: ID to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100260 * @node: Device tree node to search for (if NULL then -ENODEV is returned)
Simon Glass40bb6372017-05-18 20:09:09 -0600261 * @devp: Returns pointer to device (there is only one for each node)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100262 * Return: 0 if OK, -ve on error
Simon Glass40bb6372017-05-18 20:09:09 -0600263 */
264int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
265 struct udevice **devp);
266
267/**
Rasmus Villemoesca031c02023-04-13 17:17:03 +0200268 * uclass_get_device_by_of_path() - Get a uclass device by device tree path
269 *
270 * This searches the devices in the uclass for one attached to the
271 * device tree node corresponding to the given path (which may also be
272 * an alias).
273 *
274 * The device is probed to activate it ready for use.
275 *
276 * @id: ID to look up
Heinrich Schuchardtf8816a82023-05-02 04:59:18 +0200277 * @path: Device tree path to search for (if no such path then -ENODEV is returned)
Rasmus Villemoesca031c02023-04-13 17:17:03 +0200278 * @devp: Returns pointer to device (there is only one for each node)
279 * Return: 0 if OK, -ve on error
280 */
281int uclass_get_device_by_of_path(enum uclass_id id, const char *path,
282 struct udevice **devp);
283
284/**
Kever Yangd255fad2018-02-09 10:56:23 +0800285 * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
286 *
287 * This searches the devices in the uclass for one with the given phandle id.
288 *
289 * The device is probed to activate it ready for use.
290 *
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100291 * @id: uclass ID to look up
Kever Yangd255fad2018-02-09 10:56:23 +0800292 * @phandle_id: the phandle id to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100293 * @devp: Returns pointer to device (there is only one for each node).
294 * NULL if there is no such device.
295 * Return:
296 * 0 if OK, -ENODEV if there is no device match the phandle,
297 * other -ve on error
Kever Yangd255fad2018-02-09 10:56:23 +0800298 */
299int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
300 struct udevice **devp);
301
302/**
Simon Glassd82ba4c2015-07-02 18:15:38 -0600303 * uclass_get_device_by_phandle() - Get a uclass device by phandle
304 *
305 * This searches the devices in the uclass for one with the given phandle.
306 *
307 * The device is probed to activate it ready for use.
308 *
309 * @id: uclass ID to look up
310 * @parent: Parent device containing the phandle pointer
311 * @name: Name of property in the parent device node
312 * @devp: Returns pointer to device (there is only one for each node)
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100313 * Return: 0 if OK, -ENOENT if there is no @name present in the node, other
314 * -ve on error
Simon Glassd82ba4c2015-07-02 18:15:38 -0600315 */
316int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
317 const char *name, struct udevice **devp);
318
319/**
Simon Glassc57f8062016-07-17 15:23:15 -0600320 * uclass_get_device_by_driver() - Get a uclass device for a driver
321 *
322 * This searches the devices in the uclass for one that uses the given
Simon Glass65e25be2020-12-28 20:34:56 -0700323 * driver. Use DM_DRIVER_GET(name) for the @drv argument, where 'name' is
Simon Glassc57f8062016-07-17 15:23:15 -0600324 * the driver name - as used in U_BOOT_DRIVER(name).
325 *
326 * The device is probed to activate it ready for use.
327 *
328 * @id: ID to look up
329 * @drv: Driver to look for
330 * @devp: Returns pointer to the first device with that driver
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100331 * Return: 0 if OK, -ve on error
Simon Glassc57f8062016-07-17 15:23:15 -0600332 */
333int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv,
334 struct udevice **devp);
335
336/**
Simon Glass6494d702014-02-26 15:59:18 -0700337 * uclass_first_device() - Get the first device in a uclass
338 *
Simon Glass040b69a2015-01-25 08:26:57 -0700339 * The device returned is probed if necessary, and ready for use
Michal Suchanekf2195472022-10-12 21:58:09 +0200340 * Devices that fail to probe are skipped
Simon Glass040b69a2015-01-25 08:26:57 -0700341 *
Simon Glass30a570a2017-04-23 20:10:43 -0600342 * This function is useful to start iterating through a list of devices which
343 * are functioning correctly and can be probed.
344 *
Simon Glass6494d702014-02-26 15:59:18 -0700345 * @id: Uclass ID to look up
Simon Glass30a570a2017-04-23 20:10:43 -0600346 * @devp: Returns pointer to the first device in that uclass if no error
Michal Suchanekf2195472022-10-12 21:58:09 +0200347 * occurred, or NULL if there is no usable device
Simon Glass6494d702014-02-26 15:59:18 -0700348 */
Michal Suchanekf2195472022-10-12 21:58:09 +0200349void uclass_first_device(enum uclass_id id, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700350
351/**
352 * uclass_next_device() - Get the next device in a uclass
353 *
Simon Glass040b69a2015-01-25 08:26:57 -0700354 * The device returned is probed if necessary, and ready for use
Michal Suchanekf2195472022-10-12 21:58:09 +0200355 * Devices that fail to probe are skipped
Simon Glass040b69a2015-01-25 08:26:57 -0700356 *
Baruch Siachc0262312019-07-11 11:23:44 +0300357 * This function is useful to iterate through a list of devices which
Simon Glass30a570a2017-04-23 20:10:43 -0600358 * are functioning correctly and can be probed.
359 *
Simon Glass6494d702014-02-26 15:59:18 -0700360 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
Simon Glass30a570a2017-04-23 20:10:43 -0600361 * to the next device in the uclass if no error occurred, or NULL if there is
Michal Suchanekf2195472022-10-12 21:58:09 +0200362 * no next device
Simon Glass6494d702014-02-26 15:59:18 -0700363 */
Michal Suchanekf2195472022-10-12 21:58:09 +0200364void uclass_next_device(struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700365
366/**
Michal Suchaneke44d7e72022-10-12 21:58:06 +0200367 * uclass_first_device_err() - Get the first device in a uclass
368 *
Michal Suchanek58ddb932022-09-25 13:08:16 +0200369 * The device returned is probed if necessary, and ready for use if no error is
370 * returned
Michal Suchaneke44d7e72022-10-12 21:58:06 +0200371 *
372 * @id: Uclass ID to look up
373 * @devp: Returns pointer to the first device in that uclass, or NULL if none
374 * Return: 0 if found, -ENODEV if not found, other -ve on error
375 */
376int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
377
378/**
Patrice Chotardf6abd532018-10-24 14:10:15 +0200379 * uclass_next_device_err() - Get the next device in a uclass
380 *
Michal Suchanek58ddb932022-09-25 13:08:16 +0200381 * The device returned is probed if necessary, and ready for use if no error is
382 * returned
Patrice Chotardf6abd532018-10-24 14:10:15 +0200383 *
384 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
Simon Glass79b3f362021-08-18 21:40:29 -0600385 * to the next device in the uclass if no error occurred, or NULL if
Patrice Chotardf6abd532018-10-24 14:10:15 +0200386 * there is no next device.
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100387 * Return: 0 if found, -ENODEV if not found, other -ve on error
Patrice Chotardf6abd532018-10-24 14:10:15 +0200388 */
389int uclass_next_device_err(struct udevice **devp);
390
391/**
Bin Mengd4941312018-08-03 01:14:34 -0700392 * uclass_first_device_check() - Get the first device in a uclass
Simon Glass95ce3852017-04-23 20:10:45 -0600393 *
Michal Suchanek58ddb932022-09-25 13:08:16 +0200394 * The device returned is probed if necessary, and ready for use if no error is
395 * returned
Simon Glass95ce3852017-04-23 20:10:45 -0600396 *
397 * This function is useful to start iterating through a list of devices which
398 * are functioning correctly and can be probed.
399 *
400 * @id: Uclass ID to look up
401 * @devp: Returns pointer to the first device in that uclass, or NULL if there
402 * is no first device
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100403 * Return: 0 if OK (found or not found), other -ve on error. If an error occurs
Simon Glass95ce3852017-04-23 20:10:45 -0600404 * it is still possible to move to the next device.
405 */
406int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
407
408/**
Bin Mengd4941312018-08-03 01:14:34 -0700409 * uclass_next_device_check() - Get the next device in a uclass
Simon Glass95ce3852017-04-23 20:10:45 -0600410 *
Michal Suchanek58ddb932022-09-25 13:08:16 +0200411 * The device returned is probed if necessary, and ready for use if no error is
412 * returned
Simon Glass95ce3852017-04-23 20:10:45 -0600413 *
414 * This function is useful to start iterating through a list of devices which
415 * are functioning correctly and can be probed.
416 *
417 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
418 * to the next device in the uclass if any
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100419 * Return: 0 if OK (found or not found), other -ve on error. If an error occurs
Simon Glass95ce3852017-04-23 20:10:45 -0600420 * it is still possible to move to the next device.
421 */
422int uclass_next_device_check(struct udevice **devp);
423
424/**
Simon Glass50162342020-02-06 09:54:50 -0700425 * uclass_first_device_drvdata() - Find the first device with given driver data
426 *
427 * This searches through the devices for a particular uclass looking for one
428 * that has the given driver data.
429 *
430 * @id: Uclass ID to check
431 * @driver_data: Driver data to search for
432 * @devp: Returns pointer to the first matching device in that uclass, if found
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100433 * Return: 0 if found, -ENODEV if not found, other -ve on error
Simon Glass50162342020-02-06 09:54:50 -0700434 */
435int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
436 struct udevice **devp);
437
438/**
Vabhav Sharmaa59153d2020-12-09 10:42:03 +0530439 * uclass_probe_all() - Probe all devices based on an uclass ID
440 *
441 * This function probes all devices associated with a uclass by
442 * looking for its ID.
443 *
444 * @id: uclass ID to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100445 * Return: 0 if OK, other -ve on error
Vabhav Sharmaa59153d2020-12-09 10:42:03 +0530446 */
447int uclass_probe_all(enum uclass_id id);
448
449/**
Simon Glass29fe5552021-10-23 17:26:09 -0600450 * uclass_id_count() - Count the number of devices in a uclass
451 *
452 * @id: uclass ID to look up
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100453 * Return: number of devices in that uclass (0 if none)
Simon Glass29fe5552021-10-23 17:26:09 -0600454 */
455int uclass_id_count(enum uclass_id id);
456
457/**
Simon Glasse86b6f72022-02-28 12:08:34 -0700458 * uclass_id_foreach_dev() - iterate through devices of a given uclass ID
Simon Glass3cf0fba2020-02-06 09:54:49 -0700459 *
460 * This creates a for() loop which works through the available devices in
461 * a uclass ID in order from start to end.
462 *
463 * If for some reason the uclass cannot be found, this does nothing.
464 *
465 * @id: enum uclass_id ID to use
466 * @pos: struct udevice * to hold the current device. Set to NULL when there
467 * are no more devices.
Patrick Delaunay797b2a22022-01-12 10:53:42 +0100468 * @uc: temporary uclass variable (``struct uclass *``)
Simon Glass3cf0fba2020-02-06 09:54:49 -0700469 */
470#define uclass_id_foreach_dev(id, pos, uc) \
471 if (!uclass_get(id, &uc)) \
472 list_for_each_entry(pos, &uc->dev_head, uclass_node)
473
474/**
Simon Glasse86b6f72022-02-28 12:08:34 -0700475 * uclass_foreach_dev() - iterate through devices of a given uclass
Simon Glass6494d702014-02-26 15:59:18 -0700476 *
477 * This creates a for() loop which works through the available devices in
478 * a uclass in order from start to end.
479 *
Heiko Schocher54c5d082014-05-22 12:43:05 +0200480 * @pos: struct udevice * to hold the current device. Set to NULL when there
Simon Glass6494d702014-02-26 15:59:18 -0700481 * are no more devices.
Simon Glasse86b6f72022-02-28 12:08:34 -0700482 * @uc: uclass to scan (`struct uclass *`)
Simon Glass6494d702014-02-26 15:59:18 -0700483 */
Masahiro Yamada71f1e3f2015-08-11 01:09:43 +0900484#define uclass_foreach_dev(pos, uc) \
485 list_for_each_entry(pos, &uc->dev_head, uclass_node)
Simon Glass6494d702014-02-26 15:59:18 -0700486
Simon Glass7aeac5b2015-11-08 23:47:52 -0700487/**
Simon Glasse86b6f72022-02-28 12:08:34 -0700488 * uclass_foreach_dev_safe() - safely iterate through devices of a given uclass
Simon Glass7aeac5b2015-11-08 23:47:52 -0700489 *
490 * This creates a for() loop which works through the available devices in
491 * a uclass in order from start to end. Inside the loop, it is safe to remove
492 * @pos if required.
493 *
494 * @pos: struct udevice * to hold the current device. Set to NULL when there
495 * are no more devices.
496 * @next: struct udevice * to hold the next next
Simon Glasse86b6f72022-02-28 12:08:34 -0700497 * @uc: uclass to scan (`struct uclass *`)
Simon Glass7aeac5b2015-11-08 23:47:52 -0700498 */
499#define uclass_foreach_dev_safe(pos, next, uc) \
500 list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)
501
Patrice Chotard37b596a2018-10-24 14:10:16 +0200502/**
Simon Glasse86b6f72022-02-28 12:08:34 -0700503 * uclass_foreach_dev_probe() - iterate through devices of a given uclass ID
Patrice Chotard37b596a2018-10-24 14:10:16 +0200504 *
505 * This creates a for() loop which works through the available devices in
506 * a uclass in order from start to end. Devices are probed if necessary,
507 * and ready for use.
508 *
509 * @id: Uclass ID
510 * @dev: struct udevice * to hold the current device. Set to NULL when there
511 * are no more devices.
512 */
513#define uclass_foreach_dev_probe(id, dev) \
Michal Suchanek801f7112022-10-12 21:58:05 +0200514 for (uclass_first_device(id, &dev); dev; \
515 uclass_next_device(&dev))
Patrice Chotard37b596a2018-10-24 14:10:16 +0200516
Simon Glass6494d702014-02-26 15:59:18 -0700517#endif