xref: /openbmc/u-boot/include/dm/uclass-internal.h (revision 93f33627)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (c) 2013 Google, Inc
4  *
5  * (C) Copyright 2012
6  * Pavel Herrmann <morpheus.ibis@gmail.com>
7  */
8 
9 #ifndef _DM_UCLASS_INTERNAL_H
10 #define _DM_UCLASS_INTERNAL_H
11 
12 #include <dm/ofnode.h>
13 
14 /**
15  * uclass_get_device_tail() - handle the end of a get_device call
16  *
17  * This handles returning an error or probing a device as needed.
18  *
19  * @dev: Device that needs to be probed
20  * @ret: Error to return. If non-zero then the device is not probed
21  * @devp: Returns the value of 'dev' if there is no error
22  * @return ret, if non-zero, else the result of the device_probe() call
23  */
24 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp);
25 
26 /**
27  * dev_get_uclass_index() - Get uclass and index of device
28  * @dev:	- in - Device that we want the uclass/index of
29  * @ucp:	- out - A pointer to the uclass the device belongs to
30  *
31  * The device is not prepared for use - this is an internal function.
32  *
33  * @return the index of the device in the uclass list or -ENODEV if not found.
34  */
35 int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp);
36 
37 /**
38  * uclass_find_device() - Return n-th child of uclass
39  * @id:		Id number of the uclass
40  * @index:	Position of the child in uclass's list
41  * #devp:	Returns pointer to device, or NULL on error
42  *
43  * The device is not prepared for use - this is an internal function.
44  * The function uclass_get_device_tail() can be used to probe the device.
45  *
46  * @return the uclass pointer of a child at the given index or
47  * return NULL on error.
48  */
49 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
50 
51 /**
52  * uclass_find_first_device() - Return the first device in a uclass
53  * @id:		Id number of the uclass
54  * #devp:	Returns pointer to device, or NULL on error
55  *
56  * The device is not prepared for use - this is an internal function.
57  * The function uclass_get_device_tail() can be used to probe the device.
58  *
59  * @return 0 if OK (found or not found), -1 on error
60  */
61 int uclass_find_first_device(enum uclass_id id, struct udevice **devp);
62 
63 /**
64  * uclass_find_next_device() - Return the next device in a uclass
65  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
66  * to the next device in the same uclass, or NULL if none
67  *
68  * The device is not prepared for use - this is an internal function.
69  * The function uclass_get_device_tail() can be used to probe the device.
70  *
71  * @return 0 if OK (found or not found), -1 on error
72  */
73 int uclass_find_next_device(struct udevice **devp);
74 
75 /**
76  * uclass_find_device_by_name() - Find uclass device based on ID and name
77  *
78  * This searches for a device with the exactly given name.
79  *
80  * The device is NOT probed, it is merely returned.
81  *
82  * @id: ID to look up
83  * @name: name of a device to find
84  * @devp: Returns pointer to device (the first one with the name)
85  * @return 0 if OK, -ve on error
86  */
87 int uclass_find_device_by_name(enum uclass_id id, const char *name,
88 			       struct udevice **devp);
89 
90 /**
91  * uclass_find_device_by_seq() - Find uclass device based on ID and sequence
92  *
93  * This searches for a device with the given seq or req_seq.
94  *
95  * For seq, if an active device has this sequence it will be returned.
96  * If there is no such device then this will return -ENODEV.
97  *
98  * For req_seq, if a device (whether activated or not) has this req_seq
99  * value, that device will be returned. This is a strong indication that
100  * the device will receive that sequence when activated.
101  *
102  * The device is NOT probed, it is merely returned.
103  *
104  * @id: ID to look up
105  * @seq_or_req_seq: Sequence number to find (0=first)
106  * @find_req_seq: true to find req_seq, false to find seq
107  * @devp: Returns pointer to device (there is only one per for each seq)
108  * @return 0 if OK, -ve on error
109  */
110 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
111 			      bool find_req_seq, struct udevice **devp);
112 
113 /**
114  * uclass_find_device_by_of_offset() - Find a uclass device by device tree node
115  *
116  * This searches the devices in the uclass for one attached to the given
117  * device tree node.
118  *
119  * The device is NOT probed, it is merely returned.
120  *
121  * @id: ID to look up
122  * @node: Device tree offset to search for (if -ve then -ENODEV is returned)
123  * @devp: Returns pointer to device (there is only one for each node)
124  * @return 0 if OK, -ve on error
125  */
126 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
127 				    struct udevice **devp);
128 
129 /**
130  * uclass_find_device_by_of_node() - Find a uclass device by device tree node
131  *
132  * This searches the devices in the uclass for one attached to the given
133  * device tree node.
134  *
135  * The device is NOT probed, it is merely returned.
136  *
137  * @id: ID to look up
138  * @node: Device tree offset to search for (if NULL then -ENODEV is returned)
139  * @devp: Returns pointer to device (there is only one for each node)
140  * @return 0 if OK, -ve on error
141  */
142 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
143 				 struct udevice **devp);
144 
145 /**
146  * uclass_bind_device() - Associate device with a uclass
147  *
148  * Connect the device into uclass's list of devices.
149  *
150  * @dev:	Pointer to the device
151  * #return 0 on success, -ve on error
152  */
153 int uclass_bind_device(struct udevice *dev);
154 
155 /**
156  * uclass_unbind_device() - Deassociate device with a uclass
157  *
158  * Disconnect the device from uclass's list of devices.
159  *
160  * @dev:	Pointer to the device
161  * #return 0 on success, -ve on error
162  */
163 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
164 int uclass_unbind_device(struct udevice *dev);
165 #else
166 static inline int uclass_unbind_device(struct udevice *dev) { return 0; }
167 #endif
168 
169 /**
170  * uclass_pre_probe_device() - Deal with a device that is about to be probed
171  *
172  * Perform any pre-processing that is needed by the uclass before it can be
173  * probed. This includes the uclass' pre-probe() method and the parent
174  * uclass' child_pre_probe() method.
175  *
176  * @dev:	Pointer to the device
177  * #return 0 on success, -ve on error
178  */
179 int uclass_pre_probe_device(struct udevice *dev);
180 
181 /**
182  * uclass_post_probe_device() - Deal with a device that has just been probed
183  *
184  * Perform any post-processing of a probed device that is needed by the
185  * uclass.
186  *
187  * @dev:	Pointer to the device
188  * #return 0 on success, -ve on error
189  */
190 int uclass_post_probe_device(struct udevice *dev);
191 
192 /**
193  * uclass_pre_remove_device() - Handle a device which is about to be removed
194  *
195  * Perform any pre-processing of a device that is about to be removed.
196  *
197  * @dev:	Pointer to the device
198  * #return 0 on success, -ve on error
199  */
200 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
201 int uclass_pre_remove_device(struct udevice *dev);
202 #else
203 static inline int uclass_pre_remove_device(struct udevice *dev) { return 0; }
204 #endif
205 
206 /**
207  * uclass_find() - Find uclass by its id
208  *
209  * @id:		Id to serach for
210  * @return pointer to uclass, or NULL if not found
211  */
212 struct uclass *uclass_find(enum uclass_id key);
213 
214 /**
215  * uclass_destroy() - Destroy a uclass
216  *
217  * Destroy a uclass and all its devices
218  *
219  * @uc: uclass to destroy
220  * @return 0 on success, -ve on error
221  */
222 int uclass_destroy(struct uclass *uc);
223 
224 #endif
225