blob: 9388870d0c2a973b58e6447e167af9c3b0046690 [file] [log] [blame]
Simon Glass6494d702014-02-26 15:59:18 -07001/*
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
Heiko Schocher54c5d082014-05-22 12:43:05 +020014struct udevice;
Simon Glass6494d702014-02-26 15:59:18 -070015
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.
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090034 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070035 * @return 0 if OK, -ve on error
36 */
Simon Glass34792532015-03-25 12:21:54 -060037int device_bind(struct udevice *parent, const struct driver *drv,
Simon Glass6494d702014-02-26 15:59:18 -070038 const char *name, void *platdata, int of_offset,
Heiko Schocher54c5d082014-05-22 12:43:05 +020039 struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070040
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
Simon Glass00606d72014-07-23 06:55:03 -060048 * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set.
49 * If false bind the driver always.
Simon Glass6494d702014-02-26 15:59:18 -070050 * @info: Name and platdata for this device
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090051 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070052 * @return 0 if OK, -ve on error
53 */
Simon Glass00606d72014-07-23 06:55:03 -060054int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
55 const struct driver_info *info, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070056
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 */
Heiko Schocher54c5d082014-05-22 12:43:05 +020066int device_probe(struct udevice *dev);
Simon Glass6494d702014-02-26 15:59:18 -070067
68/**
Simon Glassaccd4b12014-10-13 23:41:50 -060069 * 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 */
79int device_probe_child(struct udevice *dev, void *parent_priv);
80
81/**
Simon Glass6494d702014-02-26 15:59:18 -070082 * 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 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +090090#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Heiko Schocher54c5d082014-05-22 12:43:05 +020091int device_remove(struct udevice *dev);
Simon Glass3ac435d2014-11-10 17:16:47 -070092#else
93static inline int device_remove(struct udevice *dev) { return 0; }
94#endif
Simon Glass6494d702014-02-26 15:59:18 -070095
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 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900104#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Heiko Schocher54c5d082014-05-22 12:43:05 +0200105int device_unbind(struct udevice *dev);
Marek Vasut66c03152015-02-18 22:36:18 +0100106#else
107static inline int device_unbind(struct udevice *dev) { return 0; }
108#endif
Simon Glass6494d702014-02-26 15:59:18 -0700109
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900110#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Simon Glass3ac435d2014-11-10 17:16:47 -0700111void device_free(struct udevice *dev);
112#else
113static inline void device_free(struct udevice *dev) {}
114#endif
115
Simon Glassf3301772015-07-07 20:53:44 -0600116/**
117 * simple_bus_translate() - translate a bus address to a system address
118 *
119 * This handles the 'ranges' property in a simple bus. It translates the
120 * device address @addr to a system address using this property.
121 *
122 * @dev: Simple bus device (parent of target device)
123 * @addr: Address to translate
124 * @return new address
125 */
126fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
127
Simon Glass89876a52014-06-11 23:29:49 -0600128/* Cast away any volatile pointer */
129#define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root)
130#define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root)
131
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900132/* device resource management */
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900133#ifdef CONFIG_DEVRES
134
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900135/**
136 * devres_release_probe - Release managed resources allocated after probing
137 * @dev: Device to release resources for
138 *
139 * Release all resources allocated for @dev when it was probed or later.
140 * This function is called on driver removal.
141 */
142void devres_release_probe(struct udevice *dev);
143
144/**
145 * devres_release_all - Release all managed resources
146 * @dev: Device to release resources for
147 *
148 * Release all resources associated with @dev. This function is
149 * called on driver unbinding.
150 */
151void devres_release_all(struct udevice *dev);
152
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900153#else /* ! CONFIG_DEVRES */
154
155static inline void devres_release_probe(struct udevice *dev)
156{
157}
158
159static inline void devres_release_all(struct udevice *dev)
160{
161}
162
163#endif /* ! CONFIG_DEVRES */
Simon Glass6494d702014-02-26 15:59:18 -0700164#endif