blob: a5bf3eb831868b7f5e3efd75e2d505da4078df37 [file] [log] [blame]
Simon Glass6494d702014-02-26 15:59:18 -07001/*
2 * Copyright (c) 2013 Google, Inc
3 *
4 * (C) Copyright 2012
5 * Pavel Herrmann <morpheus.ibis@gmail.com>
6 *
7 * SPDX-License-Identifier: GPL-2.0+
8 */
9
10#ifndef _DM_UCLASS_H
11#define _DM_UCLASS_H
12
Simon Glass40bb6372017-05-18 20:09:09 -060013#include <dm/ofnode.h>
Simon Glass6494d702014-02-26 15:59:18 -070014#include <dm/uclass-id.h>
Masahiro Yamada42c23dd2014-10-07 14:49:13 +090015#include <linker_lists.h>
Simon Glass6494d702014-02-26 15:59:18 -070016#include <linux/list.h>
17
18/**
19 * struct uclass - a U-Boot drive class, collecting together similar drivers
20 *
21 * A uclass provides an interface to a particular function, which is
22 * implemented by one or more drivers. Every driver belongs to a uclass even
23 * if it is the only driver in that uclass. An example uclass is GPIO, which
24 * provides the ability to change read inputs, set and clear outputs, etc.
25 * There may be drivers for on-chip SoC GPIO banks, I2C GPIO expanders and
26 * PMIC IO lines, all made available in a unified way through the uclass.
27 *
28 * @priv: Private data for this uclass
29 * @uc_drv: The driver for the uclass itself, not to be confused with a
30 * 'struct driver'
Simon Glassf2bc6fc2014-06-11 23:29:54 -060031 * @dev_head: List of devices in this uclass (devices are attached to their
Simon Glass6494d702014-02-26 15:59:18 -070032 * uclass when their bind method is called)
33 * @sibling_node: Next uclass in the linked list of uclasses
34 */
35struct uclass {
36 void *priv;
37 struct uclass_driver *uc_drv;
38 struct list_head dev_head;
39 struct list_head sibling_node;
40};
41
Simon Glassc57f8062016-07-17 15:23:15 -060042struct driver;
Heiko Schocher54c5d082014-05-22 12:43:05 +020043struct udevice;
Simon Glass6494d702014-02-26 15:59:18 -070044
Simon Glass9cc36a22015-01-25 08:27:05 -070045/* Members of this uclass sequence themselves with aliases */
46#define DM_UC_FLAG_SEQ_ALIAS (1 << 0)
47
Simon Glass6494d702014-02-26 15:59:18 -070048/**
49 * struct uclass_driver - Driver for the uclass
50 *
51 * A uclass_driver provides a consistent interface to a set of related
52 * drivers.
53 *
54 * @name: Name of uclass driver
55 * @id: ID number of this uclass
56 * @post_bind: Called after a new device is bound to this uclass
57 * @pre_unbind: Called before a device is unbound from this uclass
Simon Glass02c07b32015-03-05 12:25:22 -070058 * @pre_probe: Called before a new device is probed
Simon Glass6494d702014-02-26 15:59:18 -070059 * @post_probe: Called after a new device is probed
60 * @pre_remove: Called before a device is removed
Simon Glass081f2fc2015-01-25 08:27:08 -070061 * @child_post_bind: Called after a child is bound to a device in this uclass
Simon Glass6494d702014-02-26 15:59:18 -070062 * @init: Called to set up the uclass
63 * @destroy: Called to destroy the uclass
64 * @priv_auto_alloc_size: If non-zero this is the size of the private data
65 * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
66 * driver is responsible for allocating any data required.
67 * @per_device_auto_alloc_size: Each device can hold private data owned
68 * by the uclass. If required this will be automatically allocated if this
69 * value is non-zero.
Przemyslaw Marczak5eaed882015-04-15 13:07:18 +020070 * @per_device_platdata_auto_alloc_size: Each device can hold platform data
71 * owned by the uclass as 'dev->uclass_platdata'. If the value is non-zero,
72 * then this will be automatically allocated.
Simon Glassdac8db22015-01-25 08:27:06 -070073 * @per_child_auto_alloc_size: Each child device (of a parent in this
74 * uclass) can hold parent data for the device/uclass. This value is only
Heinrich Schuchardtfa9335a2017-12-17 18:19:43 +010075 * used as a fallback if this member is 0 in the driver.
Simon Glassba8da9d2015-01-25 08:27:02 -070076 * @per_child_platdata_auto_alloc_size: A bus likes to store information about
77 * its children. If non-zero this is the size of this data, to be allocated
78 * in the child device's parent_platdata pointer. This value is only used as
Heinrich Schuchardtfa9335a2017-12-17 18:19:43 +010079 * a fallback if this member is 0 in the driver.
Simon Glass6494d702014-02-26 15:59:18 -070080 * @ops: Uclass operations, providing the consistent interface to devices
81 * within the uclass.
Simon Glass9cc36a22015-01-25 08:27:05 -070082 * @flags: Flags for this uclass (DM_UC_...)
Simon Glass6494d702014-02-26 15:59:18 -070083 */
84struct uclass_driver {
85 const char *name;
86 enum uclass_id id;
Heiko Schocher54c5d082014-05-22 12:43:05 +020087 int (*post_bind)(struct udevice *dev);
88 int (*pre_unbind)(struct udevice *dev);
Simon Glass02c07b32015-03-05 12:25:22 -070089 int (*pre_probe)(struct udevice *dev);
Heiko Schocher54c5d082014-05-22 12:43:05 +020090 int (*post_probe)(struct udevice *dev);
91 int (*pre_remove)(struct udevice *dev);
Simon Glass081f2fc2015-01-25 08:27:08 -070092 int (*child_post_bind)(struct udevice *dev);
Simon Glass83c7e432015-01-25 08:27:10 -070093 int (*child_pre_probe)(struct udevice *dev);
Simon Glass6494d702014-02-26 15:59:18 -070094 int (*init)(struct uclass *class);
95 int (*destroy)(struct uclass *class);
96 int priv_auto_alloc_size;
97 int per_device_auto_alloc_size;
Przemyslaw Marczak5eaed882015-04-15 13:07:18 +020098 int per_device_platdata_auto_alloc_size;
Simon Glassdac8db22015-01-25 08:27:06 -070099 int per_child_auto_alloc_size;
Simon Glassba8da9d2015-01-25 08:27:02 -0700100 int per_child_platdata_auto_alloc_size;
Simon Glass6494d702014-02-26 15:59:18 -0700101 const void *ops;
Simon Glass9cc36a22015-01-25 08:27:05 -0700102 uint32_t flags;
Simon Glass6494d702014-02-26 15:59:18 -0700103};
104
105/* Declare a new uclass_driver */
106#define UCLASS_DRIVER(__name) \
107 ll_entry_declare(struct uclass_driver, __name, uclass)
108
109/**
110 * uclass_get() - Get a uclass based on an ID, creating it if needed
111 *
112 * Every uclass is identified by an ID, a number from 0 to n-1 where n is
113 * the number of uclasses. This function allows looking up a uclass by its
114 * ID.
115 *
116 * @key: ID to look up
117 * @ucp: Returns pointer to uclass (there is only one per ID)
118 * @return 0 if OK, -ve on error
119 */
120int uclass_get(enum uclass_id key, struct uclass **ucp);
121
122/**
Simon Glass0a5f6f82016-10-05 20:42:13 -0600123 * uclass_get_name() - Get the name of a uclass driver
124 *
125 * @id: ID to look up
126 * @returns the name of the uclass driver for that ID, or NULL if none
127 */
128const char *uclass_get_name(enum uclass_id id);
129
130/**
Simon Glass6e43d1b2017-12-28 13:14:15 -0700131 * uclass_get_by_name() - Look up a uclass by its driver name
132 *
133 * @name: Name to look up
134 * @returns the associated uclass ID, or UCLASS_INVALID if not found
135 */
136enum uclass_id uclass_get_by_name(const char *name);
137
138/**
Simon Glass6494d702014-02-26 15:59:18 -0700139 * uclass_get_device() - Get a uclass device based on an ID and index
140 *
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600141 * The device is probed to activate it ready for use.
142 *
Simon Glass0040b942014-07-23 06:55:17 -0600143 * @id: ID to look up
Simon Glass6494d702014-02-26 15:59:18 -0700144 * @index: Device number within that uclass (0=first)
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600145 * @devp: Returns pointer to device (there is only one per for each ID)
Simon Glass6494d702014-02-26 15:59:18 -0700146 * @return 0 if OK, -ve on error
147 */
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600148int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700149
150/**
Simon Glass74356d72015-07-30 13:40:40 -0600151 * uclass_get_device_by_name() - Get a uclass device by its name
Przemyslaw Marczakb7af1a22015-04-15 13:07:23 +0200152 *
Przemyslaw Marczaka7b82502015-04-20 13:32:34 +0200153 * This searches the devices in the uclass for one with the exactly given name.
Przemyslaw Marczakb7af1a22015-04-15 13:07:23 +0200154 *
155 * The device is probed to activate it ready for use.
156 *
157 * @id: ID to look up
158 * @name: name of a device to get
159 * @devp: Returns pointer to device (the first one with the name)
160 * @return 0 if OK, -ve on error
161 */
162int uclass_get_device_by_name(enum uclass_id id, const char *name,
163 struct udevice **devp);
164
165/**
Simon Glass5a66a8f2014-07-23 06:55:12 -0600166 * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
167 *
168 * If an active device has this sequence it will be returned. If there is no
169 * such device then this will check for a device that is requesting this
170 * sequence.
171 *
172 * The device is probed to activate it ready for use.
173 *
174 * @id: ID to look up
175 * @seq: Sequence number to find (0=first)
176 * @devp: Returns pointer to device (there is only one for each seq)
177 * @return 0 if OK, -ve on error
178 */
179int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
180
181/**
Simon Glassf4cdead2014-07-23 06:55:14 -0600182 * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
183 *
184 * This searches the devices in the uclass for one attached to the given
185 * device tree node.
186 *
187 * The device is probed to activate it ready for use.
188 *
189 * @id: ID to look up
190 * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
191 * @devp: Returns pointer to device (there is only one for each node)
192 * @return 0 if OK, -ve on error
193 */
194int uclass_get_device_by_of_offset(enum uclass_id id, int node,
195 struct udevice **devp);
196
197/**
Simon Glass40bb6372017-05-18 20:09:09 -0600198 * uclass_get_device_by_ofnode() - Get a uclass device by device tree node
199 *
200 * This searches the devices in the uclass for one attached to the given
201 * device tree node.
202 *
203 * The device is probed to activate it ready for use.
204 *
205 * @id: ID to look up
206 * @np: Device tree node to search for (if NULL then -ENODEV is returned)
207 * @devp: Returns pointer to device (there is only one for each node)
208 * @return 0 if OK, -ve on error
209 */
210int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
211 struct udevice **devp);
212
213/**
Kever Yangd255fad2018-02-09 10:56:23 +0800214 * uclass_get_device_by_phandle_id() - Get a uclass device by phandle id
215 *
216 * This searches the devices in the uclass for one with the given phandle id.
217 *
218 * The device is probed to activate it ready for use.
219 *
220 * @id: uclass ID to look up
221 * @phandle_id: the phandle id to look up
222 * @devp: Returns pointer to device (there is only one for each node)
223 * @return 0 if OK, -ENODEV if there is no device match the phandle, other
224 * -ve on error
225 */
226int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
227 struct udevice **devp);
228
229/**
Simon Glassd82ba4c2015-07-02 18:15:38 -0600230 * uclass_get_device_by_phandle() - Get a uclass device by phandle
231 *
232 * This searches the devices in the uclass for one with the given phandle.
233 *
234 * The device is probed to activate it ready for use.
235 *
236 * @id: uclass ID to look up
237 * @parent: Parent device containing the phandle pointer
238 * @name: Name of property in the parent device node
239 * @devp: Returns pointer to device (there is only one for each node)
240 * @return 0 if OK, -ENOENT if there is no @name present in the node, other
241 * -ve on error
242 */
243int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
244 const char *name, struct udevice **devp);
245
246/**
Simon Glassc57f8062016-07-17 15:23:15 -0600247 * uclass_get_device_by_driver() - Get a uclass device for a driver
248 *
249 * This searches the devices in the uclass for one that uses the given
250 * driver. Use DM_GET_DRIVER(name) for the @drv argument, where 'name' is
251 * the driver name - as used in U_BOOT_DRIVER(name).
252 *
253 * The device is probed to activate it ready for use.
254 *
255 * @id: ID to look up
256 * @drv: Driver to look for
257 * @devp: Returns pointer to the first device with that driver
258 * @return 0 if OK, -ve on error
259 */
260int uclass_get_device_by_driver(enum uclass_id id, const struct driver *drv,
261 struct udevice **devp);
262
263/**
Simon Glass6494d702014-02-26 15:59:18 -0700264 * uclass_first_device() - Get the first device in a uclass
265 *
Simon Glass040b69a2015-01-25 08:26:57 -0700266 * The device returned is probed if necessary, and ready for use
267 *
Simon Glass30a570a2017-04-23 20:10:43 -0600268 * This function is useful to start iterating through a list of devices which
269 * are functioning correctly and can be probed.
270 *
Simon Glass6494d702014-02-26 15:59:18 -0700271 * @id: Uclass ID to look up
Simon Glass30a570a2017-04-23 20:10:43 -0600272 * @devp: Returns pointer to the first device in that uclass if no error
273 * occurred, or NULL if there is no first device, or an error occurred with
274 * that device.
Simon Glassb0675052016-02-11 13:23:25 -0700275 * @return 0 if OK (found or not found), other -ve on error
Simon Glass6494d702014-02-26 15:59:18 -0700276 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200277int uclass_first_device(enum uclass_id id, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700278
279/**
Simon Glassb0675052016-02-11 13:23:25 -0700280 * uclass_first_device_err() - Get the first device in a uclass
281 *
282 * The device returned is probed if necessary, and ready for use
283 *
284 * @id: Uclass ID to look up
285 * @devp: Returns pointer to the first device in that uclass, or NULL if none
286 * @return 0 if found, -ENODEV if not found, other -ve on error
287 */
288int uclass_first_device_err(enum uclass_id id, struct udevice **devp);
289
290/**
Simon Glass6494d702014-02-26 15:59:18 -0700291 * uclass_next_device() - Get the next device in a uclass
292 *
Simon Glass040b69a2015-01-25 08:26:57 -0700293 * The device returned is probed if necessary, and ready for use
294 *
Simon Glass30a570a2017-04-23 20:10:43 -0600295 * This function is useful to start iterating through a list of devices which
296 * are functioning correctly and can be probed.
297 *
Simon Glass6494d702014-02-26 15:59:18 -0700298 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
Simon Glass30a570a2017-04-23 20:10:43 -0600299 * to the next device in the uclass if no error occurred, or NULL if there is
300 * no next device, or an error occurred with that next device.
Simon Glassb0675052016-02-11 13:23:25 -0700301 * @return 0 if OK (found or not found), other -ve on error
Simon Glass6494d702014-02-26 15:59:18 -0700302 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200303int uclass_next_device(struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -0700304
305/**
Simon Glass95ce3852017-04-23 20:10:45 -0600306 * uclass_first_device() - Get the first device in a uclass
307 *
308 * The device returned is probed if necessary, and ready for use
309 *
310 * This function is useful to start iterating through a list of devices which
311 * are functioning correctly and can be probed.
312 *
313 * @id: Uclass ID to look up
314 * @devp: Returns pointer to the first device in that uclass, or NULL if there
315 * is no first device
316 * @return 0 if OK (found or not found), other -ve on error. If an error occurs
317 * it is still possible to move to the next device.
318 */
319int uclass_first_device_check(enum uclass_id id, struct udevice **devp);
320
321/**
322 * uclass_next_device() - Get the next device in a uclass
323 *
324 * The device returned is probed if necessary, and ready for use
325 *
326 * This function is useful to start iterating through a list of devices which
327 * are functioning correctly and can be probed.
328 *
329 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
330 * to the next device in the uclass if any
331 * @return 0 if OK (found or not found), other -ve on error. If an error occurs
332 * it is still possible to move to the next device.
333 */
334int uclass_next_device_check(struct udevice **devp);
335
336/**
Simon Glass5a66a8f2014-07-23 06:55:12 -0600337 * uclass_resolve_seq() - Resolve a device's sequence number
338 *
339 * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a
340 * sequence number automatically, or >= 0 to select a particular number.
341 * If the requested sequence number is in use, then this device will
342 * be allocated another one.
343 *
344 * Note that the device's seq value is not changed by this function.
345 *
346 * @dev: Device for which to allocate sequence number
347 * @return sequence number allocated, or -ve on error
348 */
349int uclass_resolve_seq(struct udevice *dev);
350
351/**
Simon Glass6494d702014-02-26 15:59:18 -0700352 * uclass_foreach_dev() - Helper function to iteration through devices
353 *
354 * This creates a for() loop which works through the available devices in
355 * a uclass in order from start to end.
356 *
Heiko Schocher54c5d082014-05-22 12:43:05 +0200357 * @pos: struct udevice * to hold the current device. Set to NULL when there
Simon Glass6494d702014-02-26 15:59:18 -0700358 * are no more devices.
Simon Glassf2bc6fc2014-06-11 23:29:54 -0600359 * @uc: uclass to scan
Simon Glass6494d702014-02-26 15:59:18 -0700360 */
Masahiro Yamada71f1e3f2015-08-11 01:09:43 +0900361#define uclass_foreach_dev(pos, uc) \
362 list_for_each_entry(pos, &uc->dev_head, uclass_node)
Simon Glass6494d702014-02-26 15:59:18 -0700363
Simon Glass7aeac5b2015-11-08 23:47:52 -0700364/**
365 * uclass_foreach_dev_safe() - Helper function to safely iteration through devs
366 *
367 * This creates a for() loop which works through the available devices in
368 * a uclass in order from start to end. Inside the loop, it is safe to remove
369 * @pos if required.
370 *
371 * @pos: struct udevice * to hold the current device. Set to NULL when there
372 * are no more devices.
373 * @next: struct udevice * to hold the next next
374 * @uc: uclass to scan
375 */
376#define uclass_foreach_dev_safe(pos, next, uc) \
377 list_for_each_entry_safe(pos, next, &uc->dev_head, uclass_node)
378
Simon Glass6494d702014-02-26 15:59:18 -0700379#endif