blob: 59d3be09a1e5e85a586d4efbef15f93ca5de69ee [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass6494d702014-02-26 15:59:18 -07002/*
3 * Copyright (C) 2013 Google, Inc
4 *
5 * (C) Copyright 2012
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 * Marek Vasut <marex@denx.de>
Simon Glass6494d702014-02-26 15:59:18 -07008 */
9
10#ifndef _DM_DEVICE_INTERNAL_H
11#define _DM_DEVICE_INTERNAL_H
12
Simon Glass396e3432017-05-18 20:09:05 -060013#include <dm/ofnode.h>
14
15struct device_node;
Heiko Schocher54c5d082014-05-22 12:43:05 +020016struct udevice;
Simon Glass6494d702014-02-26 15:59:18 -070017
18/**
Simon Glasse12052b2020-11-28 17:50:00 -070019 * device_bind_offset() - Create a device and bind it to a driver
Simon Glass6494d702014-02-26 15:59:18 -070020 *
21 * Called to set up a new device attached to a driver. The device will either
22 * have platdata, or a device tree node which can be used to create the
23 * platdata.
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 * @platdata: 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 * @of_offset: Offset of device tree node for this device. This is -1 for
35 * devices which don't use device tree.
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090036 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070037 * @return 0 if OK, -ve on error
38 */
Simon Glasse12052b2020-11-28 17:50:00 -070039int device_bind_offset(struct udevice *parent, const struct driver *drv,
40 const char *name, void *platdata, int of_offset,
41 struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070042
Simon Glassd677b002018-06-11 13:07:15 -060043int device_bind_ofnode(struct udevice *parent, const struct driver *drv,
44 const char *name, void *platdata, ofnode node,
45 struct udevice **devp);
46
Simon Glass6494d702014-02-26 15:59:18 -070047/**
Stephen Warrendaac3bf2016-05-11 15:26:24 -060048 * device_bind_with_driver_data() - Create a device and bind it to a driver
49 *
50 * Called to set up a new device attached to a driver, in the case where the
51 * driver was matched to the device by means of a match table that provides
52 * driver_data.
53 *
54 * Once bound a device exists but is not yet active until device_probe() is
55 * called.
56 *
57 * @parent: Pointer to device's parent, under which this driver will exist
58 * @drv: Device's driver
59 * @name: Name of device (e.g. device tree node name)
60 * @driver_data: The driver_data field from the driver's match table.
Simon Glass396e3432017-05-18 20:09:05 -060061 * @node: Device tree node for this device. This is invalid for devices which
62 * don't use device tree.
Stephen Warrendaac3bf2016-05-11 15:26:24 -060063 * @devp: if non-NULL, returns a pointer to the bound device
64 * @return 0 if OK, -ve on error
65 */
66int device_bind_with_driver_data(struct udevice *parent,
67 const struct driver *drv, const char *name,
Simon Glass396e3432017-05-18 20:09:05 -060068 ulong driver_data, ofnode node,
Stephen Warrendaac3bf2016-05-11 15:26:24 -060069 struct udevice **devp);
Stephen Warrendaac3bf2016-05-11 15:26:24 -060070/**
Simon Glass6494d702014-02-26 15:59:18 -070071 * device_bind_by_name: Create a device and bind it to a driver
72 *
73 * This is a helper function used to bind devices which do not use device
74 * tree.
75 *
76 * @parent: Pointer to device's parent
Bin Meng6244fc62018-10-10 22:06:59 -070077 * @pre_reloc_only: If true, bind the driver only if its DM_FLAG_PRE_RELOC flag
78 * is set. If false bind the driver always.
Simon Glass6494d702014-02-26 15:59:18 -070079 * @info: Name and platdata for this device
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090080 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070081 * @return 0 if OK, -ve on error
82 */
Simon Glass00606d72014-07-23 06:55:03 -060083int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
Simon Glassa294ead2020-10-03 11:31:33 -060084 const struct driver_info *info, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070085
86/**
Claudiu Bezneacfecbaf2020-09-07 17:46:33 +030087 * device_reparent: reparent the device to a new parent
88 *
89 * @dev: pointer to device to be reparented
90 * @new_parent: pointer to new parent device
91 * @return 0 if OK, -ve on error
92 */
93int device_reparent(struct udevice *dev, struct udevice *new_parent);
94
95/**
Simon Glassbcd90cb2019-12-29 21:19:20 -070096 * device_ofdata_to_platdata() - Read platform data for a device
97 *
98 * Read platform data for a device (typically from the device tree) so that
99 * the information needed to probe the device is present.
100 *
101 * This may cause some others devices to be probed if this one depends on them,
102 * e.g. a GPIO line will cause a GPIO device to be probed.
103 *
104 * All private data associated with the device is allocated.
105 *
106 * @dev: Pointer to device to process
107 * @return 0 if OK, -ve on error
108 */
109int device_ofdata_to_platdata(struct udevice *dev);
110
111/**
Simon Glass6494d702014-02-26 15:59:18 -0700112 * device_probe() - Probe a device, activating it
113 *
114 * Activate a device so that it is ready for use. All its parents are probed
115 * first.
116 *
117 * @dev: Pointer to device to probe
118 * @return 0 if OK, -ve on error
119 */
Heiko Schocher54c5d082014-05-22 12:43:05 +0200120int device_probe(struct udevice *dev);
Simon Glass6494d702014-02-26 15:59:18 -0700121
122/**
123 * device_remove() - Remove a device, de-activating it
124 *
125 * De-activate a device so that it is no longer ready for use. All its
126 * children are deactivated first.
127 *
128 * @dev: Pointer to device to remove
Simon Glasse88afcc2017-07-29 11:35:00 -0600129 * @flags: Flags for selective device removal (DM_REMOVE_...)
Simon Glass6494d702014-02-26 15:59:18 -0700130 * @return 0 if OK, -ve on error (an error here is normally a very bad thing)
131 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900132#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Stefan Roese706865a2017-03-20 12:51:48 +0100133int device_remove(struct udevice *dev, uint flags);
Simon Glass3ac435d2014-11-10 17:16:47 -0700134#else
Stefan Roese706865a2017-03-20 12:51:48 +0100135static inline int device_remove(struct udevice *dev, uint flags) { return 0; }
Simon Glass3ac435d2014-11-10 17:16:47 -0700136#endif
Simon Glass6494d702014-02-26 15:59:18 -0700137
138/**
139 * device_unbind() - Unbind a device, destroying it
140 *
141 * Unbind a device and remove all memory used by it
142 *
143 * @dev: Pointer to device to unbind
144 * @return 0 if OK, -ve on error
145 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900146#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Heiko Schocher54c5d082014-05-22 12:43:05 +0200147int device_unbind(struct udevice *dev);
Marek Vasut66c03152015-02-18 22:36:18 +0100148#else
149static inline int device_unbind(struct udevice *dev) { return 0; }
150#endif
Simon Glass6494d702014-02-26 15:59:18 -0700151
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900152#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Simon Glass3ac435d2014-11-10 17:16:47 -0700153void device_free(struct udevice *dev);
154#else
155static inline void device_free(struct udevice *dev) {}
156#endif
157
Simon Glassf3301772015-07-07 20:53:44 -0600158/**
Jean-Jacques Hiblot3be9bcb2018-08-09 16:17:45 +0200159 * device_chld_unbind() - Unbind all device's children from the device if bound
160 * to drv
161 *
162 * On error, the function continues to unbind all children, and reports the
163 * first error.
164 *
165 * @dev: The device that is to be stripped of its children
166 * @drv: The targeted driver
167 * @return 0 on success, -ve on error
168 */
169#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
170int device_chld_unbind(struct udevice *dev, struct driver *drv);
171#else
172static inline int device_chld_unbind(struct udevice *dev, struct driver *drv)
173{
174 return 0;
175}
176#endif
177
178/**
179 * device_chld_remove() - Stop all device's children
180 * @dev: The device whose children are to be removed
181 * @drv: The targeted driver
182 * @flags: Flag, if this functions is called in the pre-OS stage
183 * @return 0 on success, -ve on error
184 */
185#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
186int device_chld_remove(struct udevice *dev, struct driver *drv,
187 uint flags);
188#else
189static inline int device_chld_remove(struct udevice *dev, struct driver *drv,
190 uint flags)
191{
192 return 0;
193}
194#endif
195
196/**
Simon Glassf3301772015-07-07 20:53:44 -0600197 * simple_bus_translate() - translate a bus address to a system address
198 *
199 * This handles the 'ranges' property in a simple bus. It translates the
200 * device address @addr to a system address using this property.
201 *
202 * @dev: Simple bus device (parent of target device)
203 * @addr: Address to translate
204 * @return new address
205 */
206fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
207
Simon Glass89876a52014-06-11 23:29:49 -0600208/* Cast away any volatile pointer */
209#define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root)
210#define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root)
211
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900212/* device resource management */
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900213#ifdef CONFIG_DEVRES
214
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900215/**
216 * devres_release_probe - Release managed resources allocated after probing
217 * @dev: Device to release resources for
218 *
219 * Release all resources allocated for @dev when it was probed or later.
220 * This function is called on driver removal.
221 */
222void devres_release_probe(struct udevice *dev);
223
224/**
225 * devres_release_all - Release all managed resources
226 * @dev: Device to release resources for
227 *
228 * Release all resources associated with @dev. This function is
229 * called on driver unbinding.
230 */
231void devres_release_all(struct udevice *dev);
232
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900233#else /* ! CONFIG_DEVRES */
234
235static inline void devres_release_probe(struct udevice *dev)
236{
237}
238
239static inline void devres_release_all(struct udevice *dev)
240{
241}
242
243#endif /* ! CONFIG_DEVRES */
Simon Glass6494d702014-02-26 15:59:18 -0700244#endif