blob: eaeadd48d2a999506c6afd03bb6304c5f7f1329b [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
Simon Glass396e3432017-05-18 20:09:05 -060014#include <dm/ofnode.h>
15
16struct device_node;
Heiko Schocher54c5d082014-05-22 12:43:05 +020017struct udevice;
Simon Glass6494d702014-02-26 15:59:18 -070018
19/**
20 * device_bind() - Create a device and bind it to a driver
21 *
22 * Called to set up a new device attached to a driver. The device will either
23 * have platdata, or a device tree node which can be used to create the
24 * platdata.
25 *
26 * Once bound a device exists but is not yet active until device_probe() is
27 * called.
28 *
29 * @parent: Pointer to device's parent, under which this driver will exist
30 * @drv: Device's driver
31 * @name: Name of device (e.g. device tree node name)
32 * @platdata: Pointer to data for this device - the structure is device-
33 * specific but may include the device's I/O address, etc.. This is NULL for
34 * devices which use device tree.
35 * @of_offset: Offset of device tree node for this device. This is -1 for
36 * devices which don't use device tree.
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090037 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070038 * @return 0 if OK, -ve on error
39 */
Simon Glass34792532015-03-25 12:21:54 -060040int device_bind(struct udevice *parent, const struct driver *drv,
Simon Glass6494d702014-02-26 15:59:18 -070041 const char *name, void *platdata, int of_offset,
Heiko Schocher54c5d082014-05-22 12:43:05 +020042 struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070043
44/**
Stephen Warrendaac3bf2016-05-11 15:26:24 -060045 * device_bind_with_driver_data() - Create a device and bind it to a driver
46 *
47 * Called to set up a new device attached to a driver, in the case where the
48 * driver was matched to the device by means of a match table that provides
49 * driver_data.
50 *
51 * Once bound a device exists but is not yet active until device_probe() is
52 * called.
53 *
54 * @parent: Pointer to device's parent, under which this driver will exist
55 * @drv: Device's driver
56 * @name: Name of device (e.g. device tree node name)
57 * @driver_data: The driver_data field from the driver's match table.
Simon Glass396e3432017-05-18 20:09:05 -060058 * @node: Device tree node for this device. This is invalid for devices which
59 * don't use device tree.
Stephen Warrendaac3bf2016-05-11 15:26:24 -060060 * @devp: if non-NULL, returns a pointer to the bound device
61 * @return 0 if OK, -ve on error
62 */
63int device_bind_with_driver_data(struct udevice *parent,
64 const struct driver *drv, const char *name,
Simon Glass396e3432017-05-18 20:09:05 -060065 ulong driver_data, ofnode node,
Stephen Warrendaac3bf2016-05-11 15:26:24 -060066 struct udevice **devp);
Stephen Warrendaac3bf2016-05-11 15:26:24 -060067/**
Simon Glass6494d702014-02-26 15:59:18 -070068 * device_bind_by_name: Create a device and bind it to a driver
69 *
70 * This is a helper function used to bind devices which do not use device
71 * tree.
72 *
73 * @parent: Pointer to device's parent
Simon Glass00606d72014-07-23 06:55:03 -060074 * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set.
75 * If false bind the driver always.
Simon Glass6494d702014-02-26 15:59:18 -070076 * @info: Name and platdata for this device
Masahiro Yamadae6cabe42015-08-27 12:44:28 +090077 * @devp: if non-NULL, returns a pointer to the bound device
Simon Glass6494d702014-02-26 15:59:18 -070078 * @return 0 if OK, -ve on error
79 */
Simon Glass00606d72014-07-23 06:55:03 -060080int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
81 const struct driver_info *info, struct udevice **devp);
Simon Glass6494d702014-02-26 15:59:18 -070082
83/**
84 * device_probe() - Probe a device, activating it
85 *
86 * Activate a device so that it is ready for use. All its parents are probed
87 * first.
88 *
89 * @dev: Pointer to device to probe
90 * @return 0 if OK, -ve on error
91 */
Heiko Schocher54c5d082014-05-22 12:43:05 +020092int device_probe(struct udevice *dev);
Simon Glass6494d702014-02-26 15:59:18 -070093
94/**
95 * device_remove() - Remove a device, de-activating it
96 *
97 * De-activate a device so that it is no longer ready for use. All its
98 * children are deactivated first.
99 *
100 * @dev: Pointer to device to remove
Simon Glasse88afcc2017-07-29 11:35:00 -0600101 * @flags: Flags for selective device removal (DM_REMOVE_...)
Simon Glass6494d702014-02-26 15:59:18 -0700102 * @return 0 if OK, -ve on error (an error here is normally a very bad thing)
103 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900104#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Stefan Roese706865a2017-03-20 12:51:48 +0100105int device_remove(struct udevice *dev, uint flags);
Simon Glass3ac435d2014-11-10 17:16:47 -0700106#else
Stefan Roese706865a2017-03-20 12:51:48 +0100107static inline int device_remove(struct udevice *dev, uint flags) { return 0; }
Simon Glass3ac435d2014-11-10 17:16:47 -0700108#endif
Simon Glass6494d702014-02-26 15:59:18 -0700109
110/**
111 * device_unbind() - Unbind a device, destroying it
112 *
113 * Unbind a device and remove all memory used by it
114 *
115 * @dev: Pointer to device to unbind
116 * @return 0 if OK, -ve on error
117 */
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900118#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Heiko Schocher54c5d082014-05-22 12:43:05 +0200119int device_unbind(struct udevice *dev);
Marek Vasut66c03152015-02-18 22:36:18 +0100120#else
121static inline int device_unbind(struct udevice *dev) { return 0; }
122#endif
Simon Glass6494d702014-02-26 15:59:18 -0700123
Masahiro Yamada0a5804b2015-08-12 07:31:52 +0900124#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
Simon Glass3ac435d2014-11-10 17:16:47 -0700125void device_free(struct udevice *dev);
126#else
127static inline void device_free(struct udevice *dev) {}
128#endif
129
Simon Glassf3301772015-07-07 20:53:44 -0600130/**
131 * simple_bus_translate() - translate a bus address to a system address
132 *
133 * This handles the 'ranges' property in a simple bus. It translates the
134 * device address @addr to a system address using this property.
135 *
136 * @dev: Simple bus device (parent of target device)
137 * @addr: Address to translate
138 * @return new address
139 */
140fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
141
Simon Glass89876a52014-06-11 23:29:49 -0600142/* Cast away any volatile pointer */
143#define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root)
144#define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root)
145
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900146/* device resource management */
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900147#ifdef CONFIG_DEVRES
148
Masahiro Yamada608f26c2015-07-25 21:52:35 +0900149/**
150 * devres_release_probe - Release managed resources allocated after probing
151 * @dev: Device to release resources for
152 *
153 * Release all resources allocated for @dev when it was probed or later.
154 * This function is called on driver removal.
155 */
156void devres_release_probe(struct udevice *dev);
157
158/**
159 * devres_release_all - Release all managed resources
160 * @dev: Device to release resources for
161 *
162 * Release all resources associated with @dev. This function is
163 * called on driver unbinding.
164 */
165void devres_release_all(struct udevice *dev);
166
Masahiro Yamadae2282d72015-07-25 21:52:37 +0900167#else /* ! CONFIG_DEVRES */
168
169static inline void devres_release_probe(struct udevice *dev)
170{
171}
172
173static inline void devres_release_all(struct udevice *dev)
174{
175}
176
177#endif /* ! CONFIG_DEVRES */
Simon Glass6494d702014-02-26 15:59:18 -0700178#endif