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 * Marek Vasut <marex@denx.de>
8 */
9
10 #ifndef _DM_DEVICE_INTERNAL_H
11 #define _DM_DEVICE_INTERNAL_H
12
13 #include <dm/ofnode.h>
14
15 struct device_node;
16 struct udevice;
17
18 /**
19 * device_bind() - Create a device and bind it to a driver
20 *
21 * Called to set up a new device attached to a driver. The device will either
22 * have plat, or a device tree node which can be used to create the
23 * plat.
24 *
25 * Once bound a device exists but is not yet active until device_probe() is
26 * called.
27 *
28 * @parent: Pointer to device's parent, under which this driver will exist
29 * @drv: Device's driver
30 * @name: Name of device (e.g. device tree node name)
31 * @plat: Pointer to data for this device - the structure is device-
32 * specific but may include the device's I/O address, etc.. This is NULL for
33 * devices which use device tree.
34 * @ofnode: Devicetree node for this device. This is ofnode_null() for
35 * devices which don't use devicetree or don't have a node.
36 * @devp: if non-NULL, returns a pointer to the bound device
37 * @return 0 if OK, -ve on error
38 */
39 int device_bind(struct udevice *parent, const struct driver *drv,
40 const char *name, void *plat, ofnode node,
41 struct udevice **devp);
42
43 /**
44 * device_bind_with_driver_data() - Create a device and bind it to a driver
45 *
46 * Called to set up a new device attached to a driver, in the case where the
47 * driver was matched to the device by means of a match table that provides
48 * driver_data.
49 *
50 * Once bound a device exists but is not yet active until device_probe() is
51 * called.
52 *
53 * @parent: Pointer to device's parent, under which this driver will exist
54 * @drv: Device's driver
55 * @name: Name of device (e.g. device tree node name)
56 * @driver_data: The driver_data field from the driver's match table.
57 * @node: Device tree node for this device. This is invalid for devices which
58 * don't use device tree.
59 * @devp: if non-NULL, returns a pointer to the bound device
60 * @return 0 if OK, -ve on error
61 */
62 int device_bind_with_driver_data(struct udevice *parent,
63 const struct driver *drv, const char *name,
64 ulong driver_data, ofnode node,
65 struct udevice **devp);
66 /**
67 * device_bind_by_name: Create a device and bind it to a driver
68 *
69 * This is a helper function used to bind devices which do not use device
70 * tree.
71 *
72 * @parent: Pointer to device's parent
73 * @pre_reloc_only: If true, bind the driver only if its DM_FLAG_PRE_RELOC flag
74 * is set. If false bind the driver always.
75 * @info: Name and plat for this device
76 * @devp: if non-NULL, returns a pointer to the bound device
77 * @return 0 if OK, -ve on error
78 */
79 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
80 const struct driver_info *info, struct udevice **devp);
81
82 /**
83 * device_reparent: reparent the device to a new parent
84 *
85 * @dev: pointer to device to be reparented
86 * @new_parent: pointer to new parent device
87 * @return 0 if OK, -ve on error
88 */
89 int device_reparent(struct udevice *dev, struct udevice *new_parent);
90
91 /**
92 * device_of_to_plat() - Read platform data for a device
93 *
94 * Read platform data for a device (typically from the device tree) so that
95 * the information needed to probe the device is present.
96 *
97 * This may cause some others devices to be probed if this one depends on them,
98 * e.g. a GPIO line will cause a GPIO device to be probed.
99 *
100 * All private data associated with the device is allocated.
101 *
102 * @dev: Pointer to device to process
103 * @return 0 if OK, -ve on error
104 */
105 int device_of_to_plat(struct udevice *dev);
106
107 /**
108 * device_probe() - Probe a device, activating it
109 *
110 * Activate a device so that it is ready for use. All its parents are probed
111 * first.
112 *
113 * @dev: Pointer to device to probe
114 * @return 0 if OK, -ve on error
115 */
116 int device_probe(struct udevice *dev);
117
118 /**
119 * device_remove() - Remove a device, de-activating it
120 *
121 * De-activate a device so that it is no longer ready for use. All its
122 * children are deactivated first.
123 *
124 * @dev: Pointer to device to remove
125 * @flags: Flags for selective device removal (DM_REMOVE_...)
126 * @return 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if
127 * this is a vital device and flags is DM_REMOVE_NON_VITAL, other -ve on
128 * error (such an error here is normally a very bad thing)
129 */
130 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
131 int device_remove(struct udevice *dev, uint flags);
132 #else
device_remove(struct udevice * dev,uint flags)133 static inline int device_remove(struct udevice *dev, uint flags) { return 0; }
134 #endif
135
136 /**
137 * device_unbind() - Unbind a device, destroying it
138 *
139 * Unbind a device and remove all memory used by it
140 *
141 * @dev: Pointer to device to unbind
142 * @return 0 if OK, -ve on error
143 */
144 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
145 int device_unbind(struct udevice *dev);
146 #else
device_unbind(struct udevice * dev)147 static inline int device_unbind(struct udevice *dev) { return 0; }
148 #endif
149
150 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
151 void device_free(struct udevice *dev);
152 #else
device_free(struct udevice * dev)153 static inline void device_free(struct udevice *dev) {}
154 #endif
155
156 /**
157 * device_chld_unbind() - Unbind all device's children from the device if bound
158 * to drv
159 *
160 * On error, the function continues to unbind all children, and reports the
161 * first error.
162 *
163 * @dev: The device that is to be stripped of its children
164 * @drv: The targeted driver
165 * @return 0 on success, -ve on error
166 */
167 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
168 int device_chld_unbind(struct udevice *dev, struct driver *drv);
169 #else
device_chld_unbind(struct udevice * dev,struct driver * drv)170 static inline int device_chld_unbind(struct udevice *dev, struct driver *drv)
171 {
172 return 0;
173 }
174 #endif
175
176 /**
177 * device_chld_remove() - Stop all device's children
178 *
179 * This continues through all children recursively stopping part-way through if
180 * an error occurs. Return values of -EKEYREJECTED are ignored and processing
181 * continues, since they just indicate that the child did not elect to be
182 * removed based on the value of @flags. Return values of -EPROBE_DEFER cause
183 * processing of other children to continue, but the function will return
184 * -EPROBE_DEFER.
185 *
186 * @dev: The device whose children are to be removed
187 * @drv: The targeted driver
188 * @flags: Flag, if this functions is called in the pre-OS stage
189 * @return 0 on success, -EPROBE_DEFER if any child failed to remove, other
190 * -ve on error
191 */
192 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
193 int device_chld_remove(struct udevice *dev, struct driver *drv,
194 uint flags);
195 #else
device_chld_remove(struct udevice * dev,struct driver * drv,uint flags)196 static inline int device_chld_remove(struct udevice *dev, struct driver *drv,
197 uint flags)
198 {
199 return 0;
200 }
201 #endif
202
203 /**
204 * dev_set_priv() - Set the private data for a device
205 *
206 * This is normally handled by driver model, which automatically allocates
207 * private data when an 'auto' size if provided by the driver.
208 *
209 * Use this function to override normal operation for special situations, such
210 * as needing to allocate a variable amount of data.
211 *
212 * @dev Device to check
213 * @priv New private-data pointer
214 */
215 void dev_set_priv(struct udevice *dev, void *priv);
216
217 /**
218 * dev_set_parent_priv() - Set the parent-private data for a device
219 *
220 * This is normally handled by driver model, which automatically allocates
221 * parent-private data when an 'auto' size if provided by the driver.
222 *
223 * Use this function to override normal operation for special situations, such
224 * as needing to allocate a variable amount of data.
225 *
226 * @dev: Device to update
227 * @parent_priv: New parent-private data
228 */
229 void dev_set_parent_priv(struct udevice *dev, void *parent_priv);
230
231 /**
232 * dev_set_uclass_priv() - Set the uclass private data for a device
233 *
234 * This is normally handled by driver model, which automatically allocates
235 * uclass-private data when an 'auto' size if provided by the driver.
236 *
237 * Use this function to override normal operation for special situations, such
238 * as needing to allocate a variable amount of data.
239 *
240 * @dev: Device to update
241 * @uclass_priv: New uclass private data
242 */
243 void dev_set_uclass_priv(struct udevice *dev, void *uclass_priv);
244
245 /**
246 * dev_set_plat() - Set the platform data for a device
247 *
248 * This is normally handled by driver model, which automatically allocates
249 * platform data when an 'auto' size if provided by the driver.
250 *
251 * Use this function to override normal operation for special situations, such
252 * as needing to allocate a variable amount of data.
253 *
254 * @dev Device to check
255 * @plat New platform-data pointer
256 */
257 void dev_set_plat(struct udevice *dev, void *priv);
258
259 /**
260 * dev_set_parent_plat() - Set the parent platform data for a device
261 *
262 * This is normally handled by driver model, which automatically allocates
263 * parent platform data when an 'auto' size if provided by the driver.
264 *
265 * Use this function to override normal operation for special situations, such
266 * as needing to allocate a variable amount of data.
267 *
268 * @dev: Device to update
269 * @parent_plat: New parent platform data
270 */
271 void dev_set_parent_plat(struct udevice *dev, void *parent_plat);
272
273 /**
274 * dev_set_uclass_plat() - Set the uclass platform data for a device
275 *
276 * This is normally handled by driver model, which automatically allocates
277 * uclass platform data when an 'auto' size if provided by the driver.
278 *
279 * Use this function to override normal operation for special situations, such
280 * as needing to allocate a variable amount of data.
281 *
282 * @dev: Device to update
283 * @uclass_plat: New uclass platform data
284 */
285 void dev_set_uclass_plat(struct udevice *dev, void *uclass_plat);
286
287 /**
288 * simple_bus_translate() - translate a bus address to a system address
289 *
290 * This handles the 'ranges' property in a simple bus. It translates the
291 * device address @addr to a system address using this property.
292 *
293 * @dev: Simple bus device (parent of target device)
294 * @addr: Address to translate
295 * @return new address
296 */
297 fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
298
299 /* Cast away any volatile pointer */
300 #define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root)
301 #define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root)
302 #define DM_UCLASS_ROOT_S_NON_CONST (((gd_t *)gd)->uclass_root_s)
303
304 /* device resource management */
305 #ifdef CONFIG_DEVRES
306
307 /**
308 * devres_release_probe - Release managed resources allocated after probing
309 * @dev: Device to release resources for
310 *
311 * Release all resources allocated for @dev when it was probed or later.
312 * This function is called on driver removal.
313 */
314 void devres_release_probe(struct udevice *dev);
315
316 /**
317 * devres_release_all - Release all managed resources
318 * @dev: Device to release resources for
319 *
320 * Release all resources associated with @dev. This function is
321 * called on driver unbinding.
322 */
323 void devres_release_all(struct udevice *dev);
324
325 #else /* ! CONFIG_DEVRES */
326
devres_release_probe(struct udevice * dev)327 static inline void devres_release_probe(struct udevice *dev)
328 {
329 }
330
devres_release_all(struct udevice * dev)331 static inline void devres_release_all(struct udevice *dev)
332 {
333 }
334
335 #endif /* ! CONFIG_DEVRES */
336 #endif
337