dm: core: Add a uclass pre_probe() method for devices
[oweals/u-boot.git] / include / dm / uclass.h
1 /*
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
13 #include <dm/uclass-id.h>
14 #include <linker_lists.h>
15 #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'
30  * @dev_head: List of devices in this uclass (devices are attached to their
31  * uclass when their bind method is called)
32  * @sibling_node: Next uclass in the linked list of uclasses
33  */
34 struct uclass {
35         void *priv;
36         struct uclass_driver *uc_drv;
37         struct list_head dev_head;
38         struct list_head sibling_node;
39 };
40
41 struct udevice;
42
43 /* Members of this uclass sequence themselves with aliases */
44 #define DM_UC_FLAG_SEQ_ALIAS                    (1 << 0)
45
46 /**
47  * struct uclass_driver - Driver for the uclass
48  *
49  * A uclass_driver provides a consistent interface to a set of related
50  * drivers.
51  *
52  * @name: Name of uclass driver
53  * @id: ID number of this uclass
54  * @post_bind: Called after a new device is bound to this uclass
55  * @pre_unbind: Called before a device is unbound from this uclass
56  * @pre_probe: Called before a new device is probed
57  * @post_probe: Called after a new device is probed
58  * @pre_remove: Called before a device is removed
59  * @child_post_bind: Called after a child is bound to a device in this uclass
60  * @init: Called to set up the uclass
61  * @destroy: Called to destroy the uclass
62  * @priv_auto_alloc_size: If non-zero this is the size of the private data
63  * to be allocated in the uclass's ->priv pointer. If zero, then the uclass
64  * driver is responsible for allocating any data required.
65  * @per_device_auto_alloc_size: Each device can hold private data owned
66  * by the uclass. If required this will be automatically allocated if this
67  * value is non-zero.
68  * @per_child_auto_alloc_size: Each child device (of a parent in this
69  * uclass) can hold parent data for the device/uclass. This value is only
70  * used as a falback if this member is 0 in the driver.
71  * @per_child_platdata_auto_alloc_size: A bus likes to store information about
72  * its children. If non-zero this is the size of this data, to be allocated
73  * in the child device's parent_platdata pointer. This value is only used as
74  * a falback if this member is 0 in the driver.
75  * @ops: Uclass operations, providing the consistent interface to devices
76  * within the uclass.
77  * @flags: Flags for this uclass (DM_UC_...)
78  */
79 struct uclass_driver {
80         const char *name;
81         enum uclass_id id;
82         int (*post_bind)(struct udevice *dev);
83         int (*pre_unbind)(struct udevice *dev);
84         int (*pre_probe)(struct udevice *dev);
85         int (*post_probe)(struct udevice *dev);
86         int (*pre_remove)(struct udevice *dev);
87         int (*child_post_bind)(struct udevice *dev);
88         int (*child_pre_probe)(struct udevice *dev);
89         int (*init)(struct uclass *class);
90         int (*destroy)(struct uclass *class);
91         int priv_auto_alloc_size;
92         int per_device_auto_alloc_size;
93         int per_child_auto_alloc_size;
94         int per_child_platdata_auto_alloc_size;
95         const void *ops;
96         uint32_t flags;
97 };
98
99 /* Declare a new uclass_driver */
100 #define UCLASS_DRIVER(__name)                                           \
101         ll_entry_declare(struct uclass_driver, __name, uclass)
102
103 /**
104  * uclass_get() - Get a uclass based on an ID, creating it if needed
105  *
106  * Every uclass is identified by an ID, a number from 0 to n-1 where n is
107  * the number of uclasses. This function allows looking up a uclass by its
108  * ID.
109  *
110  * @key: ID to look up
111  * @ucp: Returns pointer to uclass (there is only one per ID)
112  * @return 0 if OK, -ve on error
113  */
114 int uclass_get(enum uclass_id key, struct uclass **ucp);
115
116 /**
117  * uclass_get_device() - Get a uclass device based on an ID and index
118  *
119  * The device is probed to activate it ready for use.
120  *
121  * @id: ID to look up
122  * @index: Device number within that uclass (0=first)
123  * @devp: Returns pointer to device (there is only one per for each ID)
124  * @return 0 if OK, -ve on error
125  */
126 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp);
127
128 /**
129  * uclass_get_device_by_seq() - Get a uclass device based on an ID and sequence
130  *
131  * If an active device has this sequence it will be returned. If there is no
132  * such device then this will check for a device that is requesting this
133  * sequence.
134  *
135  * The device is probed to activate it ready for use.
136  *
137  * @id: ID to look up
138  * @seq: Sequence number to find (0=first)
139  * @devp: Returns pointer to device (there is only one for each seq)
140  * @return 0 if OK, -ve on error
141  */
142 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp);
143
144 /**
145  * uclass_get_device_by_of_offset() - Get a uclass device by device tree node
146  *
147  * This searches the devices in the uclass for one attached to the given
148  * device tree node.
149  *
150  * The device is probed to activate it ready for use.
151  *
152  * @id: ID to look up
153  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
154  * @devp: Returns pointer to device (there is only one for each node)
155  * @return 0 if OK, -ve on error
156  */
157 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
158                                    struct udevice **devp);
159
160 /**
161  * uclass_first_device() - Get the first device in a uclass
162  *
163  * The device returned is probed if necessary, and ready for use
164  *
165  * @id: Uclass ID to look up
166  * @devp: Returns pointer to the first device in that uclass, or NULL if none
167  * @return 0 if OK (found or not found), -1 on error
168  */
169 int uclass_first_device(enum uclass_id id, struct udevice **devp);
170
171 /**
172  * uclass_next_device() - Get the next device in a uclass
173  *
174  * The device returned is probed if necessary, and ready for use
175  *
176  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
177  * to the next device in the same uclass, or NULL if none
178  * @return 0 if OK (found or not found), -1 on error
179  */
180 int uclass_next_device(struct udevice **devp);
181
182 /**
183  * uclass_resolve_seq() - Resolve a device's sequence number
184  *
185  * On entry dev->seq is -1, and dev->req_seq may be -1 (to allocate a
186  * sequence number automatically, or >= 0 to select a particular number.
187  * If the requested sequence number is in use, then this device will
188  * be allocated another one.
189  *
190  * Note that the device's seq value is not changed by this function.
191  *
192  * @dev: Device for which to allocate sequence number
193  * @return sequence number allocated, or -ve on error
194  */
195 int uclass_resolve_seq(struct udevice *dev);
196
197 /**
198  * uclass_foreach_dev() - Helper function to iteration through devices
199  *
200  * This creates a for() loop which works through the available devices in
201  * a uclass in order from start to end.
202  *
203  * @pos: struct udevice * to hold the current device. Set to NULL when there
204  * are no more devices.
205  * @uc: uclass to scan
206  */
207 #define uclass_foreach_dev(pos, uc)                                     \
208         for (pos = list_entry((&(uc)->dev_head)->next, typeof(*pos),    \
209                         uclass_node);                                   \
210              prefetch(pos->uclass_node.next),                           \
211                         &pos->uclass_node != (&(uc)->dev_head);         \
212              pos = list_entry(pos->uclass_node.next, typeof(*pos),      \
213                         uclass_node))
214
215 #endif