blob: 7188304304696db00cb252e6491df439ff1baa2a [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glassdd6ab882014-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 Glassdd6ab882014-02-26 15:59:18 -07007 */
8
9#ifndef _DM_UCLASS_H
10#define _DM_UCLASS_H
11
Simon Glassee145d62017-05-18 20:09:09 -060012#include <dm/ofnode.h>
Simon Glassdd6ab882014-02-26 15:59:18 -070013#include <dm/uclass-id.h>
Masahiro Yamada63b3a8f2014-10-07 14:49:13 +090014#include <linker_lists.h>
Simon Glassdd6ab882014-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 *
27 * @priv: Private data for this uclass
28 * @uc_drv: The driver for the uclass itself, not to be confused with a
29 * 'struct driver'
Simon Glass4dbb5cf2014-06-11 23:29:54 -060030 * @dev_head: List of devices in this uclass (devices are attached to their
Simon Glassdd6ab882014-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 {
35 void *priv;
36 struct uclass_driver *uc_drv;
37 struct list_head dev_head;
38 struct list_head sibling_node;
39};
40
Simon Glass32d8ab62016-07-17 15:23:15 -060041struct driver;
Heiko Schocherb74fcb42014-05-22 12:43:05 +020042struct udevice;
Simon Glassdd6ab882014-02-26 15:59:18 -070043
Simon Glass0ccb0972015-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 Glass7ebd13d2018-10-01 12:22:05 -060047/* Same as DM_FLAG_ALLOC_PRIV_DMA */
48#define DM_UC_FLAG_ALLOC_PRIV_DMA (1 << 5)
49
Simon Glassdd6ab882014-02-26 15:59:18 -070050/**
51 * struct uclass_driver - Driver for the uclass
52 *
53 * A uclass_driver provides a consistent interface to a set of related
54 * drivers.
55 *
56 * @name: Name of uclass driver
57 * @id: ID number of this uclass
58 * @post_bind: Called after a new device is bound to this uclass
59 * @pre_unbind: Called before a device is unbound from this uclass
Simon Glass9c1f3822015-03-05 12:25:22 -070060 * @pre_probe: Called before a new device is probed
Simon Glassdd6ab882014-02-26 15:59:18 -070061 * @post_probe: Called after a new device is probed
62 * @pre_remove: Called before a device is removed
Simon Glassf4c9b3e2015-01-25 08:27:08 -070063 * @child_post_bind: Called after a child is bound to a device in this uclass
Bin Meng30569cf2018-10-15 02:20:57 -070064 * @child_pre_probe: Called before a child in this uclass is probed
65 * @child_post_probe: Called after a child in this uclass is probed
Simon Glassdd6ab882014-02-26 15:59:18 -070066 * @init: Called to set up the uclass
67 * @destroy: Called to destroy the uclass
68 * @priv_auto_alloc_size: If non-zero this is the size of the private data
69 * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
70 * driver is responsible for allocating any data required.
71 * @per_device_auto_alloc_size: Each device can hold private data owned
72 * by the uclass. If required this will be automatically allocated if this
73 * value is non-zero.
Przemyslaw Marczakd850e672015-04-15 13:07:18 +020074 * @per_device_platdata_auto_alloc_size: Each device can hold platform data
75 * owned by the uclass as 'dev->uclass_platdata'. If the value is non-zero,
76 * then this will be automatically allocated.
Simon Glassc23b4282015-01-25 08:27:06 -070077 * @per_child_auto_alloc_size: Each child device (of a parent in this
78 * uclass) can hold parent data for the device/uclass. This value is only
Heinrich Schuchardt1777b8e2017-12-17 18:19:43 +010079 * used as a fallback if this member is 0 in the driver.
Simon Glass57f95402015-01-25 08:27:02 -070080 * @per_child_platdata_auto_alloc_size: A bus likes to store information about
81 * its children. If non-zero this is the size of this data, to be allocated
82 * in the child device's parent_platdata pointer. This value is only used as
Heinrich Schuchardt1777b8e2017-12-17 18:19:43 +010083 * a fallback if this member is 0 in the driver.
Simon Glassdd6ab882014-02-26 15:59:18 -070084 * @ops: Uclass operations, providing the consistent interface to devices
85 * within the uclass.
Simon Glass0ccb0972015-01-25 08:27:05 -070086 * @flags: Flags for this uclass (DM_UC_...)
Simon Glassdd6ab882014-02-26 15:59:18 -070087 */
88struct uclass_driver {
89 const char *name;
90 enum uclass_id id;
Heiko Schocherb74fcb42014-05-22 12:43:05 +020091 int (*post_bind)(struct udevice *dev);
92 int (*pre_unbind)(struct udevice *dev);
Simon Glass9c1f3822015-03-05 12:25:22 -070093 int (*pre_probe)(struct udevice *dev);
Heiko Schocherb74fcb42014-05-22 12:43:05 +020094 int (*post_probe)(struct udevice *dev);
95 int (*pre_remove)(struct udevice *dev);
Simon Glassf4c9b3e2015-01-25 08:27:08 -070096 int (*child_post_bind)(struct udevice *dev);
Simon Glass5104b982015-01-25 08:27:10 -070097 int (*child_pre_probe)(struct udevice *dev);
Bin Meng30569cf2018-10-15 02:20:57 -070098 int (*child_post_probe)(struct udevice *dev);
Simon Glassdd6ab882014-02-26 15:59:18 -070099 int (*init)(struct uclass *class);
100 int (*destroy)(struct uclass *class);
101 int priv_auto_alloc_size;
102 int per_device_auto_alloc_size;
Przemyslaw Marczakd850e672015-04-15 13:07:18 +0200103 int per_device_platdata_auto_alloc_size;
Simon Glassc23b4282015-01-25 08:27:06 -0700104 int per_child_auto_alloc_size;
Simon Glass57f95402015-01-25 08:27:02 -0700105 int per_child_platdata_auto_alloc_size;
Simon Glassdd6ab882014-02-26 15:59:18 -0700106 const void *ops;
Simon Glass0ccb0972015-01-25 08:27:05 -0700107 uint32_t flags;
Simon Glassdd6ab882014-02-26 15:59:18 -0700108};
109
110/* Declare a new uclass_driver */
111#define UCLASS_DRIVER(__name) \
112 ll_entry_declare(struct uclass_driver, __name, uclass)
113
114/**
115 * uclass_get() - Get a uclass based on an ID, creating it if needed
116 *
117 * Every uclass is identified by an ID, a number from 0 to n-1 where n is
118 * the number of uclasses. This function allows looking up a uclass by its
119 * ID.
120 *
121 * @key: ID to look up
122 * @ucp: Returns pointer to uclass (there is only one per ID)
123 * @return 0 if OK, -ve on error
124 */
125int uclass_get(enum uclass_id key, struct uclass **ucp);
126
127/**
Simon Glassd19d0732016-10-05 20:42:13 -0600128 * uclass_get_name() - Get the name of a uclass driver
129 *
130 * @id: ID to look up
131 * @returns the name of the uclass driver for that ID, or NULL if none
132 */
133const char *uclass_get_name(enum uclass_id id);
134
135/**
Simon Glass70e35b42017-12-28 13:14:15 -0700136 * uclass_get_by_name() - Look up a uclass by its driver name
137 *
138 * @name: Name to look up
139 * @returns the associated uclass ID, or UCLASS_INVALID if not found
140 */
141enum uclass_id uclass_get_by_name(const char *name);
142
143/**
Simon Glassdd6ab882014-02-26 15:59:18 -0700144 * uclass_get_device() - Get a uclass device based on an ID and index
145 *
Simon Glass4dbb5cf2014-06-11 23:29:54 -0600146 * The device is probed to activate it ready for use.
147 *
Simon Glasscebcebb2014-07-23 06:55:17 -0600148 * @id: ID to look up
Simon Glassdd6ab882014-02-26 15:59:18 -0700149 * @index: Device number within that uclass (0=first)
Simon Glass4dbb5cf2014-06-11 23:29:54 -0600150 * @devp: Returns pointer to device (there is only one per for each ID)
Simon Glassdd6ab882014-02-26 15:59:18 -0700151 * @return 0 if OK, -ve on error
152 */
Simon Glass4dbb5cf2014-06-11 23:29:54 -0600153int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
Simon Glassdd6ab882014-02-26 15:59:18 -0700154
155/**
Simon Glassc4a9cbe2015-07-30 13:40:40 -0600156 * uclass_get_device_by_name() - Get a uclass device by its name
Przemyslaw Marczaka12a1f52015-04-15 13:07:23 +0200157 *
Przemyslaw Marczakc9177722015-04-20 13:32:34 +0200158 * This searches the devices in the uclass for one with the exactly given name.
Przemyslaw Marczaka12a1f52015-04-15 13:07:23 +0200159 *
160 * The device is probed to activate it ready for use.
161 *
162 * @id: ID to look up
163 * @name: name of a device to get
164 * @devp: Returns pointer to device (the first one with the name)
165 * @return 0 if OK, -ve on error
166 */
167int uclass_get_device_by_name(enum uclass_id id, const char *name,
168 struct udevice **devp);
169
170/**
Simon Glassdb6f0202014-07-23 06:55:12 -0600171 * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
172 *
173 * If an active device has this sequence it will be returned. If there is no
174 * such device then this will check for a device that is requesting this
175 * sequence.
176 *
177 * The device is probed to activate it ready for use.
178 *
179 * @id: ID to look up
180 * @seq: Sequence number to find (0=first)
181 * @devp: Returns pointer to device (there is only one for each seq)
182 * @return 0 if OK, -ve on error
183 */
184int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
185
186/**
Simon Glassc1464ab2014-07-23 06:55:14 -0600187 * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
188 *
189 * This searches the devices in the uclass for one attached to the given
190 * device tree node.
191 *
192 * The device is probed to activate it ready for use.
193 *
194 * @id: ID to look up
195 * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
196 * @devp: Returns pointer to device (there is only one for each node)
197 * @return 0 if OK, -ve on error
198 */
199int uclass_get_device_by_of_offset(enum uclass_id id, int node,
200 struct udevice **devp);
201
202/**
Simon Glassee145d62017-05-18 20:09:09 -0600203 * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
204 *
205 * This searches the devices in the uclass for one attached to the given
206 * device tree node.
207 *
208 * The device is probed to activate it ready for use.
209 *
210 * @id: ID to look up
211 * @np: Device tree node to search for (if NULL then -ENODEV is returned)
212 * @devp: Returns pointer to device (there is only one for each node)
213 * @return 0 if OK, -ve on error
214 */
215int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
216 struct udevice **devp);
217
218/**
Kever Yang66a0b5a2018-02-09 10:56:23 +0800219 * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
220 *
221 * This searches the devices in the uclass for one with the given phandle id.
222 *
223 * The device is probed to activate it ready for use.
224 *
225 * @id: uclass ID to look up
226 * @phandle_id: the phandle id to look up
Dario Binacchi8ef373b2020-10-11 14:25:46 +0200227 * @devp: Returns pointer to device (there is only one for each node). NULL if
228 * there is no such device.
Kever Yang66a0b5a2018-02-09 10:56:23 +0800229 * @return 0 if OK, -ENODEV if there is no device match the phandle, other
230 * -ve on error
231 */
232int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
233 struct udevice **devp);
234
235/**
Simon Glass75f00df2015-07-02 18:15:38 -0600236 * uclass_get_device_by_phandle() - Get a uclass device by phandle
237 *
238 * This searches the devices in the uclass for one with the given phandle.
239 *
240 * The device is probed to activate it ready for use.
241 *
242 * @id: uclass ID to look up
243 * @parent: Parent device containing the phandle pointer
244 * @name: Name of property in the parent device node
245 * @devp: Returns pointer to device (there is only one for each node)
246 * @return 0 if OK, -ENOENT if there is no @name present in the node, other
247 * -ve on error
248 */
249int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
250 const char *name, struct udevice **devp);
251
252/**
Simon Glass32d8ab62016-07-17 15:23:15 -0600253 * uclass_get_device_by_driver() - Get a uclass device for a driver
254 *
255 * This searches the devices in the uclass for one that uses the given
256 * driver. Use DM_GET_DRIVER(name) for the @drv argument, where 'name' is
257 * the driver name - as used in U_BOOT_DRIVER(name).
258 *
259 * The device is probed to activate it ready for use.
260 *
261 * @id: ID to look up
262 * @drv: Driver to look for
263 * @devp: Returns pointer to the first device with that driver
264 * @return 0 if OK, -ve on error
265 */
266int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv,
267 struct udevice **devp);
268
269/**
Simon Glassdd6ab882014-02-26 15:59:18 -0700270 * uclass_first_device() - Get the first device in a uclass
271 *
Simon Glass8f5251d2015-01-25 08:26:57 -0700272 * The device returned is probed if necessary, and ready for use
273 *
Simon Glass98c9fb02017-04-23 20:10:43 -0600274 * This function is useful to start iterating through a list of devices which
275 * are functioning correctly and can be probed.
276 *
Simon Glassdd6ab882014-02-26 15:59:18 -0700277 * @id: Uclass ID to look up
Simon Glass98c9fb02017-04-23 20:10:43 -0600278 * @devp: Returns pointer to the first device in that uclass if no error
279 * occurred, or NULL if there is no first device, or an error occurred with
280 * that device.
Simon Glass832c3f02016-02-11 13:23:25 -0700281 * @return 0 if OK (found or not found), other -ve on error
Simon Glassdd6ab882014-02-26 15:59:18 -0700282 */
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200283int uclass_first_device(enum uclass_id id, struct udevice **devp);
Simon Glassdd6ab882014-02-26 15:59:18 -0700284
285/**
Simon Glass832c3f02016-02-11 13:23:25 -0700286 * uclass_first_device_err() - Get the first device in a uclass
287 *
288 * The device returned is probed if necessary, and ready for use
289 *
290 * @id: Uclass ID to look up
291 * @devp: Returns pointer to the first device in that uclass, or NULL if none
292 * @return 0 if found, -ENODEV if not found, other -ve on error
293 */
294int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
295
296/**
Simon Glassdd6ab882014-02-26 15:59:18 -0700297 * uclass_next_device() - Get the next device in a uclass
298 *
Simon Glass8f5251d2015-01-25 08:26:57 -0700299 * The device returned is probed if necessary, and ready for use
300 *
Baruch Siachd89bb862019-07-11 11:23:44 +0300301 * This function is useful to iterate through a list of devices which
Simon Glass98c9fb02017-04-23 20:10:43 -0600302 * are functioning correctly and can be probed.
303 *
Simon Glassdd6ab882014-02-26 15:59:18 -0700304 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
Simon Glass98c9fb02017-04-23 20:10:43 -0600305 * to the next device in the uclass if no error occurred, or NULL if there is
306 * no next device, or an error occurred with that next device.
Simon Glass832c3f02016-02-11 13:23:25 -0700307 * @return 0 if OK (found or not found), other -ve on error
Simon Glassdd6ab882014-02-26 15:59:18 -0700308 */
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200309int uclass_next_device(struct udevice **devp);
Simon Glassdd6ab882014-02-26 15:59:18 -0700310
311/**
Patrice Chotard4dff1782018-10-24 14:10:15 +0200312 * uclass_next_device_err() - Get the next device in a uclass
313 *
314 * The device returned is probed if necessary, and ready for use
315 *
316 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
317 * to the next device in the uclass if no error occurred, or -ENODEV if
318 * there is no next device.
319 * @return 0 if found, -ENODEV if not found, other -ve on error
320 */
321int uclass_next_device_err(struct udevice **devp);
322
323/**
Bin Mengf4254042018-08-03 01:14:34 -0700324 * uclass_first_device_check() - Get the first device in a uclass
Simon Glass3ff83bc2017-04-23 20:10:45 -0600325 *
326 * The device returned is probed if necessary, and ready for use
327 *
328 * This function is useful to start iterating through a list of devices which
329 * are functioning correctly and can be probed.
330 *
331 * @id: Uclass ID to look up
332 * @devp: Returns pointer to the first device in that uclass, or NULL if there
333 * is no first device
334 * @return 0 if OK (found or not found), other -ve on error. If an error occurs
335 * it is still possible to move to the next device.
336 */
337int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
338
339/**
Bin Mengf4254042018-08-03 01:14:34 -0700340 * uclass_next_device_check() - Get the next device in a uclass
Simon Glass3ff83bc2017-04-23 20:10:45 -0600341 *
342 * The device returned is probed if necessary, and ready for use
343 *
344 * This function is useful to start iterating through a list of devices which
345 * are functioning correctly and can be probed.
346 *
347 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
348 * to the next device in the uclass if any
349 * @return 0 if OK (found or not found), other -ve on error. If an error occurs
350 * it is still possible to move to the next device.
351 */
352int uclass_next_device_check(struct udevice **devp);
353
354/**
Simon Glass35cb2a42020-02-06 09:54:50 -0700355 * uclass_first_device_drvdata() - Find the first device with given driver data
356 *
357 * This searches through the devices for a particular uclass looking for one
358 * that has the given driver data.
359 *
360 * @id: Uclass ID to check
361 * @driver_data: Driver data to search for
362 * @devp: Returns pointer to the first matching device in that uclass, if found
363 * @return 0 if found, -ENODEV if not found, other -ve on error
364 */
365int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
366 struct udevice **devp);
367
368/**
Simon Glassdb6f0202014-07-23 06:55:12 -0600369 * uclass_resolve_seq() - Resolve a device's sequence number
370 *
371 * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a
372 * sequence number automatically, or >= 0 to select a particular number.
373 * If the requested sequence number is in use, then this device will
374 * be allocated another one.
375 *
376 * Note that the device's seq value is not changed by this function.
377 *
378 * @dev: Device for which to allocate sequence number
379 * @return sequence number allocated, or -ve on error
380 */
381int uclass_resolve_seq(struct udevice *dev);
382
383/**
Simon Glass27c0e172020-02-06 09:54:49 -0700384 * uclass_id_foreach_dev() - Helper function to iteration through devices
385 *
386 * This creates a for() loop which works through the available devices in
387 * a uclass ID in order from start to end.
388 *
389 * If for some reason the uclass cannot be found, this does nothing.
390 *
391 * @id: enum uclass_id ID to use
392 * @pos: struct udevice * to hold the current device. Set to NULL when there
393 * are no more devices.
Simon Glass32868432020-06-14 08:48:39 -0600394 * @uc: temporary uclass variable (struct uclass *)
Simon Glass27c0e172020-02-06 09:54:49 -0700395 */
396#define uclass_id_foreach_dev(id, pos, uc) \
397 if (!uclass_get(id, &uc)) \
398 list_for_each_entry(pos, &uc->dev_head, uclass_node)
399
400/**
Simon Glassdd6ab882014-02-26 15:59:18 -0700401 * uclass_foreach_dev() - Helper function to iteration through devices
402 *
403 * This creates a for() loop which works through the available devices in
404 * a uclass in order from start to end.
405 *
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200406 * @pos: struct udevice * to hold the current device. Set to NULL when there
Simon Glassdd6ab882014-02-26 15:59:18 -0700407 * are no more devices.
Simon Glass4dbb5cf2014-06-11 23:29:54 -0600408 * @uc: uclass to scan
Simon Glassdd6ab882014-02-26 15:59:18 -0700409 */
Masahiro Yamada5115fda2015-08-11 01:09:43 +0900410#define uclass_foreach_dev(pos, uc) \
411 list_for_each_entry(pos, &uc->dev_head, uclass_node)
Simon Glassdd6ab882014-02-26 15:59:18 -0700412
Simon Glass0a74c962015-11-08 23:47:52 -0700413/**
414 * uclass_foreach_dev_safe() - Helper function to safely iteration through devs
415 *
416 * This creates a for() loop which works through the available devices in
417 * a uclass in order from start to end. Inside the loop, it is safe to remove
418 * @pos if required.
419 *
420 * @pos: struct udevice * to hold the current device. Set to NULL when there
421 * are no more devices.
422 * @next: struct udevice * to hold the next next
423 * @uc: uclass to scan
424 */
425#define uclass_foreach_dev_safe(pos, next, uc) \
426 list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)
427
Patrice Chotard492b7a92018-10-24 14:10:16 +0200428/**
429 * uclass_foreach_dev_probe() - Helper function to iteration through devices
430 * of given uclass
431 *
432 * This creates a for() loop which works through the available devices in
433 * a uclass in order from start to end. Devices are probed if necessary,
434 * and ready for use.
435 *
436 * @id: Uclass ID
437 * @dev: struct udevice * to hold the current device. Set to NULL when there
438 * are no more devices.
439 */
440#define uclass_foreach_dev_probe(id, dev) \
441 for (int _ret = uclass_first_device_err(id, &dev); !_ret && dev; \
442 _ret = uclass_next_device_err(&dev))
443
Simon Glassdd6ab882014-02-26 15:59:18 -0700444#endif