]>
Commit | Line | Data |
---|---|---|
6494d708 SG |
1 | /* |
2 | * Copyright (C) 2013 Google, Inc | |
3 | * | |
4 | * (C) Copyright 2012 | |
5 | * Pavel Herrmann <morpheus.ibis@gmail.com> | |
6 | * Marek Vasut <marex@denx.de> | |
7 | * | |
8 | * SPDX-License-Identifier: GPL-2.0+ | |
9 | */ | |
10 | ||
11 | #ifndef _DM_DEVICE_INTERNAL_H | |
12 | #define _DM_DEVICE_INTERNAL_H | |
13 | ||
54c5d08a | 14 | struct udevice; |
6494d708 SG |
15 | |
16 | /** | |
17 | * device_bind() - Create a device and bind it to a driver | |
18 | * | |
19 | * Called to set up a new device attached to a driver. The device will either | |
20 | * have platdata, or a device tree node which can be used to create the | |
21 | * platdata. | |
22 | * | |
23 | * Once bound a device exists but is not yet active until device_probe() is | |
24 | * called. | |
25 | * | |
26 | * @parent: Pointer to device's parent, under which this driver will exist | |
27 | * @drv: Device's driver | |
28 | * @name: Name of device (e.g. device tree node name) | |
29 | * @platdata: Pointer to data for this device - the structure is device- | |
30 | * specific but may include the device's I/O address, etc.. This is NULL for | |
31 | * devices which use device tree. | |
32 | * @of_offset: Offset of device tree node for this device. This is -1 for | |
33 | * devices which don't use device tree. | |
34 | * @devp: Returns a pointer to the bound device | |
35 | * @return 0 if OK, -ve on error | |
36 | */ | |
3479253d | 37 | int device_bind(struct udevice *parent, const struct driver *drv, |
6494d708 | 38 | const char *name, void *platdata, int of_offset, |
54c5d08a | 39 | struct udevice **devp); |
6494d708 SG |
40 | |
41 | /** | |
42 | * device_bind_by_name: Create a device and bind it to a driver | |
43 | * | |
44 | * This is a helper function used to bind devices which do not use device | |
45 | * tree. | |
46 | * | |
47 | * @parent: Pointer to device's parent | |
00606d7e SG |
48 | * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set. |
49 | * If false bind the driver always. | |
6494d708 SG |
50 | * @info: Name and platdata for this device |
51 | * @devp: Returns a pointer to the bound device | |
52 | * @return 0 if OK, -ve on error | |
53 | */ | |
00606d7e SG |
54 | int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, |
55 | const struct driver_info *info, struct udevice **devp); | |
6494d708 SG |
56 | |
57 | /** | |
58 | * device_probe() - Probe a device, activating it | |
59 | * | |
60 | * Activate a device so that it is ready for use. All its parents are probed | |
61 | * first. | |
62 | * | |
63 | * @dev: Pointer to device to probe | |
64 | * @return 0 if OK, -ve on error | |
65 | */ | |
54c5d08a | 66 | int device_probe(struct udevice *dev); |
6494d708 | 67 | |
accd4b19 SG |
68 | /** |
69 | * device_probe() - Probe a child device, activating it | |
70 | * | |
71 | * Activate a device so that it is ready for use. All its parents are probed | |
72 | * first. The child is provided with parent data if parent_priv is not NULL. | |
73 | * | |
74 | * @dev: Pointer to device to probe | |
75 | * @parent_priv: Pointer to parent data. If non-NULL then this is provided to | |
76 | * the child. | |
77 | * @return 0 if OK, -ve on error | |
78 | */ | |
79 | int device_probe_child(struct udevice *dev, void *parent_priv); | |
80 | ||
6494d708 SG |
81 | /** |
82 | * device_remove() - Remove a device, de-activating it | |
83 | * | |
84 | * De-activate a device so that it is no longer ready for use. All its | |
85 | * children are deactivated first. | |
86 | * | |
87 | * @dev: Pointer to device to remove | |
88 | * @return 0 if OK, -ve on error (an error here is normally a very bad thing) | |
89 | */ | |
3ac435d3 | 90 | #ifdef CONFIG_DM_DEVICE_REMOVE |
54c5d08a | 91 | int device_remove(struct udevice *dev); |
3ac435d3 SG |
92 | #else |
93 | static inline int device_remove(struct udevice *dev) { return 0; } | |
94 | #endif | |
6494d708 SG |
95 | |
96 | /** | |
97 | * device_unbind() - Unbind a device, destroying it | |
98 | * | |
99 | * Unbind a device and remove all memory used by it | |
100 | * | |
101 | * @dev: Pointer to device to unbind | |
102 | * @return 0 if OK, -ve on error | |
103 | */ | |
66c03151 | 104 | #ifdef CONFIG_DM_DEVICE_REMOVE |
54c5d08a | 105 | int device_unbind(struct udevice *dev); |
66c03151 MV |
106 | #else |
107 | static inline int device_unbind(struct udevice *dev) { return 0; } | |
108 | #endif | |
6494d708 | 109 | |
bb52b367 HG |
110 | /** |
111 | * device_remove_children() - Stop all device's children | |
112 | * @dev: The device whose children are to be removed | |
113 | * @return 0 on success, -ve on error | |
114 | */ | |
115 | #ifdef CONFIG_DM_DEVICE_REMOVE | |
116 | int device_remove_children(struct udevice *dev); | |
117 | #else | |
118 | static inline int device_remove_children(struct udevice *dev) { return 0; } | |
119 | #endif | |
120 | ||
121 | /** | |
122 | * device_unbind_children() - Unbind all device's children from the device | |
123 | * | |
124 | * On error, the function continues to unbind all children, and reports the | |
125 | * first error. | |
126 | * | |
127 | * @dev: The device that is to be stripped of its children | |
128 | * @return 0 on success, -ve on error | |
129 | */ | |
130 | #ifdef CONFIG_DM_DEVICE_REMOVE | |
131 | int device_unbind_children(struct udevice *dev); | |
132 | #else | |
133 | static inline int device_unbind_children(struct udevice *dev) { return 0; } | |
134 | #endif | |
135 | ||
3ac435d3 SG |
136 | #ifdef CONFIG_DM_DEVICE_REMOVE |
137 | void device_free(struct udevice *dev); | |
138 | #else | |
139 | static inline void device_free(struct udevice *dev) {} | |
140 | #endif | |
141 | ||
f3301771 SG |
142 | /** |
143 | * simple_bus_translate() - translate a bus address to a system address | |
144 | * | |
145 | * This handles the 'ranges' property in a simple bus. It translates the | |
146 | * device address @addr to a system address using this property. | |
147 | * | |
148 | * @dev: Simple bus device (parent of target device) | |
149 | * @addr: Address to translate | |
150 | * @return new address | |
151 | */ | |
152 | fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr); | |
153 | ||
89876a55 SG |
154 | /* Cast away any volatile pointer */ |
155 | #define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root) | |
156 | #define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root) | |
157 | ||
608f26c5 | 158 | /* device resource management */ |
e2282d70 MY |
159 | #ifdef CONFIG_DEVRES |
160 | ||
608f26c5 MY |
161 | /** |
162 | * devres_release_probe - Release managed resources allocated after probing | |
163 | * @dev: Device to release resources for | |
164 | * | |
165 | * Release all resources allocated for @dev when it was probed or later. | |
166 | * This function is called on driver removal. | |
167 | */ | |
168 | void devres_release_probe(struct udevice *dev); | |
169 | ||
170 | /** | |
171 | * devres_release_all - Release all managed resources | |
172 | * @dev: Device to release resources for | |
173 | * | |
174 | * Release all resources associated with @dev. This function is | |
175 | * called on driver unbinding. | |
176 | */ | |
177 | void devres_release_all(struct udevice *dev); | |
178 | ||
e2282d70 MY |
179 | #else /* ! CONFIG_DEVRES */ |
180 | ||
181 | static inline void devres_release_probe(struct udevice *dev) | |
182 | { | |
183 | } | |
184 | ||
185 | static inline void devres_release_all(struct udevice *dev) | |
186 | { | |
187 | } | |
188 | ||
189 | #endif /* ! CONFIG_DEVRES */ | |
6494d708 | 190 | #endif |