blob: 2cfe10766ff3e1eb9262b940c3a543b33717d295 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glassdd6ab882014-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 Glassdd6ab882014-02-26 15:59:18 -07008 */
9
10#ifndef _DM_DEVICE_H
11#define _DM_DEVICE_H
12
Simon Glass9a148602017-05-17 17:18:10 -060013#include <dm/ofnode.h>
Simon Glassdd6ab882014-02-26 15:59:18 -070014#include <dm/uclass-id.h>
Peng Fan99b72352015-02-10 14:46:32 +080015#include <fdtdec.h>
Simon Glassdd6ab882014-02-26 15:59:18 -070016#include <linker_lists.h>
Masahiro Yamadab475e1f2015-07-25 21:52:36 +090017#include <linux/kernel.h>
Simon Glassdd6ab882014-02-26 15:59:18 -070018#include <linux/list.h>
Masahiro Yamada9e74eb52017-09-26 11:58:29 +090019#include <linux/printk.h>
Simon Glassdd6ab882014-02-26 15:59:18 -070020
21struct driver_info;
22
23/* Driver is active (probed). Cleared when it is removed */
Simon Glassaa741682015-09-28 23:32:03 -060024#define DM_FLAG_ACTIVATED (1 << 0)
Simon Glassdd6ab882014-02-26 15:59:18 -070025
26/* DM is responsible for allocating and freeing platdata */
Simon Glassaa741682015-09-28 23:32:03 -060027#define DM_FLAG_ALLOC_PDATA (1 << 1)
Simon Glassdd6ab882014-02-26 15:59:18 -070028
Simon Glassfef72b72014-07-23 06:55:03 -060029/* DM should init this device prior to relocation */
Simon Glassaa741682015-09-28 23:32:03 -060030#define DM_FLAG_PRE_RELOC (1 << 2)
Simon Glassfef72b72014-07-23 06:55:03 -060031
Simon Glass11b61732015-01-25 08:27:01 -070032/* DM is responsible for allocating and freeing parent_platdata */
33#define DM_FLAG_ALLOC_PARENT_PDATA (1 << 3)
34
Przemyslaw Marczakd850e672015-04-15 13:07:18 +020035/* DM is responsible for allocating and freeing uclass_platdata */
36#define DM_FLAG_ALLOC_UCLASS_PDATA (1 << 4)
37
Simon Glass825d3f92015-03-25 12:21:53 -060038/* Allocate driver private data on a DMA boundary */
Simon Glassaa741682015-09-28 23:32:03 -060039#define DM_FLAG_ALLOC_PRIV_DMA (1 << 5)
Simon Glass825d3f92015-03-25 12:21:53 -060040
Masahiro Yamadabdbb5dd2015-07-25 21:52:34 +090041/* Device is bound */
Simon Glassaa741682015-09-28 23:32:03 -060042#define DM_FLAG_BOUND (1 << 6)
Masahiro Yamadabdbb5dd2015-07-25 21:52:34 +090043
Simon Glass7760ba22016-05-01 13:52:23 -060044/* Device name is allocated and should be freed on unbind() */
Simon Glass2d4c7dc2016-07-04 11:58:15 -060045#define DM_FLAG_NAME_ALLOCED (1 << 7)
Simon Glass7760ba22016-05-01 13:52:23 -060046
Simon Glass2137c242019-12-29 21:19:19 -070047/* Device has platform data provided by of-platdata */
Simon Glassafbf9b82016-07-04 11:58:18 -060048#define DM_FLAG_OF_PLATDATA (1 << 8)
49
Stefan Roese80b5bc92017-03-20 12:51:48 +010050/*
51 * Call driver remove function to stop currently active DMA transfers or
52 * give DMA buffers back to the HW / controller. This may be needed for
53 * some drivers to do some final stage cleanup before the OS is called
54 * (U-Boot exit)
55 */
56#define DM_FLAG_ACTIVE_DMA (1 << 9)
57
58/*
Stefan Roese07456762017-04-24 09:48:02 +020059 * Call driver remove function to do some final configuration, before
60 * U-Boot exits and the OS is started
61 */
62#define DM_FLAG_OS_PREPARE (1 << 10)
63
Lokesh Vutlac10e52b2019-09-27 13:48:12 +053064/* DM does not enable/disable the power domains corresponding to this device */
65#define DM_FLAG_DEFAULT_PD_CTRL_OFF (1 << 11)
66
Simon Glassd3c9d302019-12-29 21:19:21 -070067/* Driver platdata has been read. Cleared when the device is removed */
68#define DM_FLAG_PLATDATA_VALID (1 << 12)
69
Stefan Roese07456762017-04-24 09:48:02 +020070/*
Anatolij Gustschincfb28f12020-02-17 12:36:43 +010071 * Device is removed without switching off its power domain. This might
72 * be required, i. e. for serial console (debug) output when booting OS.
73 */
74#define DM_FLAG_REMOVE_WITH_PD_ON (1 << 13)
75
76/*
Stefan Roese80b5bc92017-03-20 12:51:48 +010077 * One or multiple of these flags are passed to device_remove() so that
78 * a selective device removal as specified by the remove-stage and the
79 * driver flags can be done.
80 */
81enum {
82 /* Normal remove, remove all devices */
Simon Glass42697f52020-03-28 14:03:48 -060083 DM_REMOVE_NORMAL = 1 << 0,
Stefan Roese80b5bc92017-03-20 12:51:48 +010084
85 /* Remove devices with active DMA */
Simon Glass42697f52020-03-28 14:03:48 -060086 DM_REMOVE_ACTIVE_DMA = DM_FLAG_ACTIVE_DMA,
Stefan Roese80b5bc92017-03-20 12:51:48 +010087
Stefan Roese07456762017-04-24 09:48:02 +020088 /* Remove devices which need some final OS preparation steps */
Simon Glass42697f52020-03-28 14:03:48 -060089 DM_REMOVE_OS_PREPARE = DM_FLAG_OS_PREPARE,
Stefan Roese07456762017-04-24 09:48:02 +020090
Stefan Roese80b5bc92017-03-20 12:51:48 +010091 /* Add more use cases here */
92
93 /* Remove devices with any active flag */
Simon Glass42697f52020-03-28 14:03:48 -060094 DM_REMOVE_ACTIVE_ALL = DM_REMOVE_ACTIVE_DMA | DM_REMOVE_OS_PREPARE,
95
96 /* Don't power down any attached power domains */
97 DM_REMOVE_NO_PD = 1 << 1,
Stefan Roese80b5bc92017-03-20 12:51:48 +010098};
99
Simon Glassdd6ab882014-02-26 15:59:18 -0700100/**
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200101 * struct udevice - An instance of a driver
Simon Glassdd6ab882014-02-26 15:59:18 -0700102 *
103 * This holds information about a device, which is a driver bound to a
104 * particular port or peripheral (essentially a driver instance).
105 *
106 * A device will come into existence through a 'bind' call, either due to
107 * a U_BOOT_DEVICE() macro (in which case platdata is non-NULL) or a node
108 * in the device tree (in which case of_offset is >= 0). In the latter case
109 * we translate the device tree information into platdata in a function
110 * implemented by the driver ofdata_to_platdata method (called just before the
111 * probe method if the device has a device tree node.
112 *
113 * All three of platdata, priv and uclass_priv can be allocated by the
114 * driver, or you can use the auto_alloc_size members of struct driver and
115 * struct uclass_driver to have driver model do this automatically.
116 *
117 * @driver: The driver used by this device
118 * @name: Name of device, typically the FDT node name
119 * @platdata: Configuration data for this device
Simon Glass11b61732015-01-25 08:27:01 -0700120 * @parent_platdata: The parent bus's configuration data for this device
Przemyslaw Marczakd850e672015-04-15 13:07:18 +0200121 * @uclass_platdata: The uclass's configuration data for this device
Simon Glass9a148602017-05-17 17:18:10 -0600122 * @node: Reference to device tree node for this device
Simon Glass46227bd2015-03-25 12:21:55 -0600123 * @driver_data: Driver data word for the entry that matched this device with
124 * its driver
Simon Glassdd6ab882014-02-26 15:59:18 -0700125 * @parent: Parent of this device, or NULL for the top level device
126 * @priv: Private data for this device
127 * @uclass: Pointer to uclass for this device
128 * @uclass_priv: The uclass's private data for this device
Simon Glass60d971b2014-07-23 06:55:20 -0600129 * @parent_priv: The parent's private data for this device
Simon Glassdd6ab882014-02-26 15:59:18 -0700130 * @uclass_node: Used by uclass to link its devices
131 * @child_head: List of children of this device
132 * @sibling_node: Next device in list of all devices
133 * @flags: Flags for this device DM_FLAG_...
Simon Glassdb6f0202014-07-23 06:55:12 -0600134 * @req_seq: Requested sequence number for this device (-1 = any)
Simon Glass47424ec2014-10-13 23:41:51 -0600135 * @seq: Allocated sequence number for this device (-1 = none). This is set up
136 * when the device is probed and will be unique within the device's uclass.
Simon Glassc8ca1cb2015-09-28 23:32:04 -0600137 * @devres_head: List of memory allocations associated with this device.
138 * When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
139 * add to this list. Memory so-allocated will be freed
140 * automatically when the device is removed / unbound
Simon Glassdd6ab882014-02-26 15:59:18 -0700141 */
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200142struct udevice {
Simon Glassa626dff2015-03-25 12:21:54 -0600143 const struct driver *driver;
Simon Glassdd6ab882014-02-26 15:59:18 -0700144 const char *name;
145 void *platdata;
Simon Glass11b61732015-01-25 08:27:01 -0700146 void *parent_platdata;
Przemyslaw Marczakd850e672015-04-15 13:07:18 +0200147 void *uclass_platdata;
Simon Glass9a148602017-05-17 17:18:10 -0600148 ofnode node;
Simon Glass46227bd2015-03-25 12:21:55 -0600149 ulong driver_data;
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200150 struct udevice *parent;
Simon Glassdd6ab882014-02-26 15:59:18 -0700151 void *priv;
152 struct uclass *uclass;
153 void *uclass_priv;
Simon Glass60d971b2014-07-23 06:55:20 -0600154 void *parent_priv;
Simon Glassdd6ab882014-02-26 15:59:18 -0700155 struct list_head uclass_node;
156 struct list_head child_head;
157 struct list_head sibling_node;
158 uint32_t flags;
Simon Glassdb6f0202014-07-23 06:55:12 -0600159 int req_seq;
160 int seq;
Masahiro Yamada029bfca2015-07-25 21:52:37 +0900161#ifdef CONFIG_DEVRES
Masahiro Yamada8b15b162015-07-25 21:52:35 +0900162 struct list_head devres_head;
Masahiro Yamada029bfca2015-07-25 21:52:37 +0900163#endif
Simon Glassdd6ab882014-02-26 15:59:18 -0700164};
165
Simon Glassdb6f0202014-07-23 06:55:12 -0600166/* Maximum sequence number supported */
167#define DM_MAX_SEQ 999
168
Simon Glassdd6ab882014-02-26 15:59:18 -0700169/* Returns the operations for a device */
170#define device_get_ops(dev) (dev->driver->ops)
171
172/* Returns non-zero if the device is active (probed and not removed) */
173#define device_active(dev) ((dev)->flags & DM_FLAG_ACTIVATED)
174
Simon Glassdd79d6e2017-01-17 16:52:55 -0700175static inline int dev_of_offset(const struct udevice *dev)
176{
Simon Glass9a148602017-05-17 17:18:10 -0600177 return ofnode_to_offset(dev->node);
Simon Glassdd79d6e2017-01-17 16:52:55 -0700178}
179
180static inline void dev_set_of_offset(struct udevice *dev, int of_offset)
181{
Simon Glass9a148602017-05-17 17:18:10 -0600182 dev->node = offset_to_ofnode(of_offset);
183}
184
185static inline bool dev_has_of_node(struct udevice *dev)
186{
187 return ofnode_valid(dev->node);
Simon Glassdd79d6e2017-01-17 16:52:55 -0700188}
189
Simon Glassdd6ab882014-02-26 15:59:18 -0700190/**
Simon Glass767827a2014-06-11 23:29:45 -0600191 * struct udevice_id - Lists the compatible strings supported by a driver
Simon Glassdd6ab882014-02-26 15:59:18 -0700192 * @compatible: Compatible string
193 * @data: Data for this compatible string
194 */
Simon Glass767827a2014-06-11 23:29:45 -0600195struct udevice_id {
Simon Glassdd6ab882014-02-26 15:59:18 -0700196 const char *compatible;
197 ulong data;
198};
199
Masahiro Yamada366b24f2015-08-12 07:31:55 +0900200#if CONFIG_IS_ENABLED(OF_CONTROL)
Masahiro Yamadaf797bc22014-10-07 14:51:31 +0900201#define of_match_ptr(_ptr) (_ptr)
202#else
203#define of_match_ptr(_ptr) NULL
Masahiro Yamada366b24f2015-08-12 07:31:55 +0900204#endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
Masahiro Yamadaf797bc22014-10-07 14:51:31 +0900205
Simon Glassdd6ab882014-02-26 15:59:18 -0700206/**
207 * struct driver - A driver for a feature or peripheral
208 *
209 * This holds methods for setting up a new device, and also removing it.
210 * The device needs information to set itself up - this is provided either
211 * by platdata or a device tree node (which we find by looking up
212 * matching compatible strings with of_match).
213 *
214 * Drivers all belong to a uclass, representing a class of devices of the
215 * same type. Common elements of the drivers can be implemented in the uclass,
216 * or the uclass can provide a consistent interface to the drivers within
217 * it.
218 *
219 * @name: Device name
Heinrich Schuchardt3e142d92018-02-12 12:38:36 +0100220 * @id: Identifies the uclass we belong to
Simon Glassdd6ab882014-02-26 15:59:18 -0700221 * @of_match: List of compatible strings to match, and any identifying data
222 * for each.
223 * @bind: Called to bind a device to its driver
224 * @probe: Called to probe a device, i.e. activate it
225 * @remove: Called to remove a device, i.e. de-activate it
226 * @unbind: Called to unbind a device from its driver
227 * @ofdata_to_platdata: Called before probe to decode device tree data
Simon Glassa4a51a02015-01-25 08:27:03 -0700228 * @child_post_bind: Called after a new child has been bound
Simon Glassd45560d2014-07-23 06:55:21 -0600229 * @child_pre_probe: Called before a child device is probed. The device has
230 * memory allocated but it has not yet been probed.
231 * @child_post_remove: Called after a child device is removed. The device
232 * has memory allocated but its device_remove() method has been called.
Simon Glassdd6ab882014-02-26 15:59:18 -0700233 * @priv_auto_alloc_size: If non-zero this is the size of the private data
234 * to be allocated in the device's ->priv pointer. If zero, then the driver
235 * is responsible for allocating any data required.
236 * @platdata_auto_alloc_size: If non-zero this is the size of the
237 * platform data to be allocated in the device's ->platdata pointer.
238 * This is typically only useful for device-tree-aware drivers (those with
239 * an of_match), since drivers which use platdata will have the data
240 * provided in the U_BOOT_DEVICE() instantiation.
Simon Glass60d971b2014-07-23 06:55:20 -0600241 * @per_child_auto_alloc_size: Each device can hold private data owned by
242 * its parent. If required this will be automatically allocated if this
243 * value is non-zero.
Simon Glass11b61732015-01-25 08:27:01 -0700244 * @per_child_platdata_auto_alloc_size: A bus likes to store information about
245 * its children. If non-zero this is the size of this data, to be allocated
246 * in the child's parent_platdata pointer.
Simon Glasscebcebb2014-07-23 06:55:17 -0600247 * @ops: Driver-specific operations. This is typically a list of function
Simon Glassdd6ab882014-02-26 15:59:18 -0700248 * pointers defined by the driver, to implement driver functions required by
249 * the uclass.
Simon Glassfef72b72014-07-23 06:55:03 -0600250 * @flags: driver flags - see DM_FLAGS_...
Simon Glass9fb9e9b2020-04-09 10:27:38 -0600251 * @acpi_ops: Advanced Configuration and Power Interface (ACPI) operations,
252 * allowing the device to add things to the ACPI tables passed to Linux
Simon Glassdd6ab882014-02-26 15:59:18 -0700253 */
254struct driver {
255 char *name;
256 enum uclass_id id;
Simon Glass767827a2014-06-11 23:29:45 -0600257 const struct udevice_id *of_match;
Heiko Schocherb74fcb42014-05-22 12:43:05 +0200258 int (*bind)(struct udevice *dev);
259 int (*probe)(struct udevice *dev);
260 int (*remove)(struct udevice *dev);
261 int (*unbind)(struct udevice *dev);
262 int (*ofdata_to_platdata)(struct udevice *dev);
Simon Glassa4a51a02015-01-25 08:27:03 -0700263 int (*child_post_bind)(struct udevice *dev);
Simon Glassd45560d2014-07-23 06:55:21 -0600264 int (*child_pre_probe)(struct udevice *dev);
265 int (*child_post_remove)(struct udevice *dev);
Simon Glassdd6ab882014-02-26 15:59:18 -0700266 int priv_auto_alloc_size;
267 int platdata_auto_alloc_size;
Simon Glass60d971b2014-07-23 06:55:20 -0600268 int per_child_auto_alloc_size;
Simon Glass11b61732015-01-25 08:27:01 -0700269 int per_child_platdata_auto_alloc_size;
Simon Glassdd6ab882014-02-26 15:59:18 -0700270 const void *ops; /* driver-specific operations */
Simon Glassfef72b72014-07-23 06:55:03 -0600271 uint32_t flags;
Simon Glass9fb9e9b2020-04-09 10:27:38 -0600272#if CONFIG_IS_ENABLED(ACPIGEN)
273 struct acpi_ops *acpi_ops;
274#endif
Simon Glassdd6ab882014-02-26 15:59:18 -0700275};
276
277/* Declare a new U-Boot driver */
278#define U_BOOT_DRIVER(__name) \
279 ll_entry_declare(struct driver, __name, driver)
280
Simon Glass32d8ab62016-07-17 15:23:15 -0600281/* Get a pointer to a given driver */
282#define DM_GET_DRIVER(__name) \
283 ll_entry_get(struct driver, __name, driver)
284
Simon Glassdd6ab882014-02-26 15:59:18 -0700285/**
Walter Lozano48e5b042020-06-25 01:10:06 -0300286 * Declare a macro to state a alias for a driver name. This macro will
287 * produce no code but its information will be parsed by tools like
288 * dtoc
289 */
290#define U_BOOT_DRIVER_ALIAS(__name, __alias)
291
292/**
Simon Glassdd6ab882014-02-26 15:59:18 -0700293 * dev_get_platdata() - Get the platform data for a device
294 *
295 * This checks that dev is not NULL, but no other checks for now
296 *
297 * @dev Device to check
298 * @return platform data, or NULL if none
299 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600300void *dev_get_platdata(const struct udevice *dev);
Simon Glassdd6ab882014-02-26 15:59:18 -0700301
302/**
Simon Glass11b61732015-01-25 08:27:01 -0700303 * dev_get_parent_platdata() - Get the parent platform data for a device
304 *
305 * This checks that dev is not NULL, but no other checks for now
306 *
307 * @dev Device to check
308 * @return parent's platform data, or NULL if none
309 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600310void *dev_get_parent_platdata(const struct udevice *dev);
Simon Glass11b61732015-01-25 08:27:01 -0700311
312/**
Przemyslaw Marczakd850e672015-04-15 13:07:18 +0200313 * dev_get_uclass_platdata() - Get the uclass platform data for a device
314 *
315 * This checks that dev is not NULL, but no other checks for now
316 *
317 * @dev Device to check
318 * @return uclass's platform data, or NULL if none
319 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600320void *dev_get_uclass_platdata(const struct udevice *dev);
Przemyslaw Marczakd850e672015-04-15 13:07:18 +0200321
322/**
Simon Glassffca2022015-09-28 23:32:02 -0600323 * dev_get_priv() - Get the private data for a device
324 *
325 * This checks that dev is not NULL, but no other checks for now
326 *
327 * @dev Device to check
328 * @return private data, or NULL if none
329 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600330void *dev_get_priv(const struct udevice *dev);
Simon Glassffca2022015-09-28 23:32:02 -0600331
332/**
Simon Glassde44acf2015-09-28 23:32:01 -0600333 * dev_get_parent_priv() - Get the parent private data for a device
Simon Glass60d971b2014-07-23 06:55:20 -0600334 *
Simon Glassde44acf2015-09-28 23:32:01 -0600335 * The parent private data is data stored in the device but owned by the
336 * parent. For example, a USB device may have parent data which contains
337 * information about how to talk to the device over USB.
Simon Glass60d971b2014-07-23 06:55:20 -0600338 *
339 * This checks that dev is not NULL, but no other checks for now
340 *
341 * @dev Device to check
342 * @return parent data, or NULL if none
343 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600344void *dev_get_parent_priv(const struct udevice *dev);
Simon Glass60d971b2014-07-23 06:55:20 -0600345
346/**
Simon Glassffca2022015-09-28 23:32:02 -0600347 * dev_get_uclass_priv() - Get the private uclass data for a device
Simon Glassdd6ab882014-02-26 15:59:18 -0700348 *
349 * This checks that dev is not NULL, but no other checks for now
350 *
351 * @dev Device to check
Simon Glassffca2022015-09-28 23:32:02 -0600352 * @return private uclass data for this device, or NULL if none
Simon Glassdd6ab882014-02-26 15:59:18 -0700353 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600354void *dev_get_uclass_priv(const struct udevice *dev);
Simon Glassdd6ab882014-02-26 15:59:18 -0700355
Simon Glassdb6f0202014-07-23 06:55:12 -0600356/**
Simon Glass43f488a2014-11-11 10:46:19 -0700357 * struct dev_get_parent() - Get the parent of a device
358 *
359 * @child: Child to check
360 * @return parent of child, or NULL if this is the root device
361 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600362struct udevice *dev_get_parent(const struct udevice *child);
Simon Glass43f488a2014-11-11 10:46:19 -0700363
364/**
Simon Glass46227bd2015-03-25 12:21:55 -0600365 * dev_get_driver_data() - get the driver data used to bind a device
Simon Glass70c3a0e2014-11-11 10:46:18 -0700366 *
367 * When a device is bound using a device tree node, it matches a
Simon Glass1958eec2015-09-28 23:32:06 -0600368 * particular compatible string in struct udevice_id. This function
Simon Glass46227bd2015-03-25 12:21:55 -0600369 * returns the associated data value for that compatible string. This is
370 * the 'data' field in struct udevice_id.
371 *
Simon Glass1958eec2015-09-28 23:32:06 -0600372 * As an example, consider this structure:
373 * static const struct udevice_id tegra_i2c_ids[] = {
374 * { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 },
375 * { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD },
376 * { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC },
377 * { }
378 * };
379 *
380 * When driver model finds a driver for this it will store the 'data' value
381 * corresponding to the compatible string it matches. This function returns
382 * that value. This allows the driver to handle several variants of a device.
383 *
Simon Glass46227bd2015-03-25 12:21:55 -0600384 * For USB devices, this is the driver_info field in struct usb_device_id.
385 *
386 * @dev: Device to check
Simon Glass1958eec2015-09-28 23:32:06 -0600387 * @return driver data (0 if none is provided)
Simon Glass70c3a0e2014-11-11 10:46:18 -0700388 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600389ulong dev_get_driver_data(const struct udevice *dev);
Simon Glass70c3a0e2014-11-11 10:46:18 -0700390
Przemyslaw Marczakd3ef0d72015-04-15 13:07:24 +0200391/**
392 * dev_get_driver_ops() - get the device's driver's operations
393 *
394 * This checks that dev is not NULL, and returns the pointer to device's
395 * driver's operations.
396 *
397 * @dev: Device to check
398 * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
399 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600400const void *dev_get_driver_ops(const struct udevice *dev);
Przemyslaw Marczakd3ef0d72015-04-15 13:07:24 +0200401
Simon Glass1958eec2015-09-28 23:32:06 -0600402/**
Simon Glass98fd5d12015-01-25 08:27:04 -0700403 * device_get_uclass_id() - return the uclass ID of a device
404 *
405 * @dev: Device to check
406 * @return uclass ID for the device
407 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600408enum uclass_id device_get_uclass_id(const struct udevice *dev);
Simon Glass98fd5d12015-01-25 08:27:04 -0700409
Simon Glass1958eec2015-09-28 23:32:06 -0600410/**
Przemyslaw Marczak5ed2e422015-04-15 13:07:25 +0200411 * dev_get_uclass_name() - return the uclass name of a device
412 *
413 * This checks that dev is not NULL.
414 *
415 * @dev: Device to check
416 * @return pointer to the uclass name for the device
417 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600418const char *dev_get_uclass_name(const struct udevice *dev);
Przemyslaw Marczak5ed2e422015-04-15 13:07:25 +0200419
Simon Glass70c3a0e2014-11-11 10:46:18 -0700420/**
Simon Glass48d4e292014-07-23 06:55:19 -0600421 * device_get_child() - Get the child of a device by index
422 *
423 * Returns the numbered child, 0 being the first. This does not use
424 * sequence numbers, only the natural order.
425 *
426 * @dev: Parent device to check
427 * @index: Child index
428 * @devp: Returns pointer to device
Simon Glass147a5602015-07-27 15:47:19 -0600429 * @return 0 if OK, -ENODEV if no such device, other error if the device fails
430 * to probe
Simon Glass48d4e292014-07-23 06:55:19 -0600431 */
Simon Glass2a580882020-01-27 08:49:36 -0700432int device_get_child(const struct udevice *parent, int index,
433 struct udevice **devp);
Simon Glass48d4e292014-07-23 06:55:19 -0600434
435/**
Lokesh Vutlafa45a082019-09-04 16:01:26 +0530436 * device_get_child_count() - Get the available child count of a device
437 *
438 * Returns the number of children to a device.
439 *
440 * @parent: Parent device to check
441 */
Simon Glass2a580882020-01-27 08:49:36 -0700442int device_get_child_count(const struct udevice *parent);
Lokesh Vutlafa45a082019-09-04 16:01:26 +0530443
444/**
Simon Glassdb6f0202014-07-23 06:55:12 -0600445 * device_find_child_by_seq() - Find a child device based on a sequence
446 *
447 * This searches for a device with the given seq or req_seq.
448 *
449 * For seq, if an active device has this sequence it will be returned.
450 * If there is no such device then this will return -ENODEV.
451 *
452 * For req_seq, if a device (whether activated or not) has this req_seq
453 * value, that device will be returned. This is a strong indication that
454 * the device will receive that sequence when activated.
455 *
456 * @parent: Parent device
457 * @seq_or_req_seq: Sequence number to find (0=first)
458 * @find_req_seq: true to find req_seq, false to find seq
459 * @devp: Returns pointer to device (there is only one per for each seq).
460 * Set to NULL if none is found
461 * @return 0 if OK, -ve on error
462 */
Simon Glass2a580882020-01-27 08:49:36 -0700463int device_find_child_by_seq(const struct udevice *parent, int seq_or_req_seq,
Simon Glassdb6f0202014-07-23 06:55:12 -0600464 bool find_req_seq, struct udevice **devp);
465
Simon Glass48d4e292014-07-23 06:55:19 -0600466/**
467 * device_get_child_by_seq() - Get a child device based on a sequence
468 *
469 * If an active device has this sequence it will be returned. If there is no
470 * such device then this will check for a device that is requesting this
471 * sequence.
472 *
473 * The device is probed to activate it ready for use.
474 *
475 * @parent: Parent device
476 * @seq: Sequence number to find (0=first)
477 * @devp: Returns pointer to device (there is only one per for each seq)
478 * Set to NULL if none is found
479 * @return 0 if OK, -ve on error
480 */
Simon Glass2a580882020-01-27 08:49:36 -0700481int device_get_child_by_seq(const struct udevice *parent, int seq,
Simon Glass48d4e292014-07-23 06:55:19 -0600482 struct udevice **devp);
483
484/**
485 * device_find_child_by_of_offset() - Find a child device based on FDT offset
486 *
487 * Locates a child device by its device tree offset.
488 *
489 * @parent: Parent device
490 * @of_offset: Device tree offset to find
491 * @devp: Returns pointer to device if found, otherwise this is set to NULL
492 * @return 0 if OK, -ve on error
493 */
Simon Glass2a580882020-01-27 08:49:36 -0700494int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
Simon Glass48d4e292014-07-23 06:55:19 -0600495 struct udevice **devp);
496
497/**
498 * device_get_child_by_of_offset() - Get a child device based on FDT offset
499 *
500 * Locates a child device by its device tree offset.
501 *
502 * The device is probed to activate it ready for use.
503 *
504 * @parent: Parent device
505 * @of_offset: Device tree offset to find
506 * @devp: Returns pointer to device if found, otherwise this is set to NULL
507 * @return 0 if OK, -ve on error
508 */
Simon Glass2a580882020-01-27 08:49:36 -0700509int device_get_child_by_of_offset(const struct udevice *parent, int of_offset,
Simon Glass48d4e292014-07-23 06:55:19 -0600510 struct udevice **devp);
511
Simon Glass44da7352014-10-13 23:41:49 -0600512/**
Jean-Jacques Hiblota7b0d6a2018-08-09 16:17:44 +0200513 * device_find_global_by_ofnode() - Get a device based on ofnode
Simon Glassae2efac2015-06-23 15:38:37 -0600514 *
Jean-Jacques Hiblota7b0d6a2018-08-09 16:17:44 +0200515 * Locates a device by its device tree ofnode, searching globally throughout
Simon Glassae2efac2015-06-23 15:38:37 -0600516 * the all driver model devices.
517 *
Jean-Jacques Hiblota7b0d6a2018-08-09 16:17:44 +0200518 * The device is NOT probed
519 *
520 * @node: Device tree ofnode to find
521 * @devp: Returns pointer to device if found, otherwise this is set to NULL
522 * @return 0 if OK, -ve on error
523 */
524
525int device_find_global_by_ofnode(ofnode node, struct udevice **devp);
526
527/**
528 * device_get_global_by_ofnode() - Get a device based on ofnode
529 *
530 * Locates a device by its device tree ofnode, searching globally throughout
531 * the all driver model devices.
532 *
Simon Glassae2efac2015-06-23 15:38:37 -0600533 * The device is probed to activate it ready for use.
534 *
Jean-Jacques Hiblota7b0d6a2018-08-09 16:17:44 +0200535 * @node: Device tree ofnode to find
Simon Glassae2efac2015-06-23 15:38:37 -0600536 * @devp: Returns pointer to device if found, otherwise this is set to NULL
537 * @return 0 if OK, -ve on error
538 */
Jean-Jacques Hiblota7b0d6a2018-08-09 16:17:44 +0200539int device_get_global_by_ofnode(ofnode node, struct udevice **devp);
Simon Glassae2efac2015-06-23 15:38:37 -0600540
541/**
Simon Glass44da7352014-10-13 23:41:49 -0600542 * device_find_first_child() - Find the first child of a device
543 *
544 * @parent: Parent device to search
545 * @devp: Returns first child device, or NULL if none
546 * @return 0
547 */
Simon Glass2a580882020-01-27 08:49:36 -0700548int device_find_first_child(const struct udevice *parent,
549 struct udevice **devp);
Simon Glass44da7352014-10-13 23:41:49 -0600550
551/**
Simon Glass147a5602015-07-27 15:47:19 -0600552 * device_find_next_child() - Find the next child of a device
Simon Glass44da7352014-10-13 23:41:49 -0600553 *
554 * @devp: Pointer to previous child device on entry. Returns pointer to next
555 * child device, or NULL if none
556 * @return 0
557 */
558int device_find_next_child(struct udevice **devp);
559
Peng Fan99b72352015-02-10 14:46:32 +0800560/**
Simon Glassb775e872018-10-01 12:22:07 -0600561 * device_find_first_inactive_child() - Find the first inactive child
562 *
563 * This is used to locate an existing child of a device which is of a given
564 * uclass.
565 *
Simon Glassa11341a2018-11-18 08:14:31 -0700566 * The device is NOT probed
567 *
Simon Glassb775e872018-10-01 12:22:07 -0600568 * @parent: Parent device to search
569 * @uclass_id: Uclass to look for
570 * @devp: Returns device found, if any
571 * @return 0 if found, else -ENODEV
572 */
Simon Glass2a580882020-01-27 08:49:36 -0700573int device_find_first_inactive_child(const struct udevice *parent,
Simon Glassb775e872018-10-01 12:22:07 -0600574 enum uclass_id uclass_id,
575 struct udevice **devp);
576
577/**
Simon Glassa11341a2018-11-18 08:14:31 -0700578 * device_find_first_child_by_uclass() - Find the first child of a device in uc
579 *
580 * @parent: Parent device to search
581 * @uclass_id: Uclass to look for
582 * @devp: Returns first child device in that uclass, if any
583 * @return 0 if found, else -ENODEV
584 */
Simon Glass2a580882020-01-27 08:49:36 -0700585int device_find_first_child_by_uclass(const struct udevice *parent,
Simon Glassa11341a2018-11-18 08:14:31 -0700586 enum uclass_id uclass_id,
587 struct udevice **devp);
588
589/**
590 * device_find_child_by_name() - Find a child by device name
591 *
592 * @parent: Parent device to search
593 * @name: Name to look for
594 * @devp: Returns device found, if any
595 * @return 0 if found, else -ENODEV
596 */
Simon Glass2a580882020-01-27 08:49:36 -0700597int device_find_child_by_name(const struct udevice *parent, const char *name,
Simon Glassa11341a2018-11-18 08:14:31 -0700598 struct udevice **devp);
599
600/**
Simon Glass000676b2020-01-27 08:49:47 -0700601 * device_first_child_ofdata_err() - Find the first child and reads its platdata
602 *
603 * The ofdata_to_platdata() method is called on the child before it is returned,
604 * but the child is not probed.
605 *
606 * @parent: Parent to check
607 * @devp: Returns child that was found, if any
608 * @return 0 on success, -ENODEV if no children, other -ve on error
609 */
610int device_first_child_ofdata_err(struct udevice *parent,
611 struct udevice **devp);
612
613/*
614 * device_next_child_ofdata_err() - Find the next child and read its platdata
615 *
616 * The ofdata_to_platdata() method is called on the child before it is returned,
617 * but the child is not probed.
618 *
619 * @devp: On entry, points to the previous child; on exit returns the child that
620 * was found, if any
621 * @return 0 on success, -ENODEV if no children, other -ve on error
622 */
623int device_next_child_ofdata_err(struct udevice **devp);
624
625/**
Simon Glass76db9b72020-01-27 08:49:48 -0700626 * device_first_child_err() - Get the first child of a device
627 *
628 * The device returned is probed if necessary, and ready for use
629 *
630 * @parent: Parent device to search
631 * @devp: Returns device found, if any
632 * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
633 */
634int device_first_child_err(struct udevice *parent, struct udevice **devp);
635
636/**
637 * device_next_child_err() - Get the next child of a parent device
638 *
639 * The device returned is probed if necessary, and ready for use
640 *
641 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
642 * to the next sibling if no error occurred
643 * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
644 */
645int device_next_child_err(struct udevice **devp);
646
647/**
Simon Glass40f829a2015-03-25 12:21:57 -0600648 * device_has_children() - check if a device has any children
649 *
650 * @dev: Device to check
651 * @return true if the device has one or more children
652 */
Simon Glass2e5e5ec2018-10-01 12:22:06 -0600653bool device_has_children(const struct udevice *dev);
Simon Glass40f829a2015-03-25 12:21:57 -0600654
655/**
656 * device_has_active_children() - check if a device has any active children
657 *
658 * @dev: Device to check
659 * @return true if the device has one or more children and at least one of
660 * them is active (probed).
661 */
Simon Glass2a580882020-01-27 08:49:36 -0700662bool device_has_active_children(const struct udevice *dev);
Simon Glass40f829a2015-03-25 12:21:57 -0600663
664/**
665 * device_is_last_sibling() - check if a device is the last sibling
666 *
667 * This function can be useful for display purposes, when special action needs
668 * to be taken when displaying the last sibling. This can happen when a tree
669 * view of devices is being displayed.
670 *
671 * @dev: Device to check
672 * @return true if there are no more siblings after this one - i.e. is it
673 * last in the list.
674 */
Simon Glass2a580882020-01-27 08:49:36 -0700675bool device_is_last_sibling(const struct udevice *dev);
Simon Glass40f829a2015-03-25 12:21:57 -0600676
Simon Glasse3b23e22015-07-30 13:40:39 -0600677/**
678 * device_set_name() - set the name of a device
679 *
680 * This must be called in the device's bind() method and no later. Normally
681 * this is unnecessary but for probed devices which don't get a useful name
682 * this function can be helpful.
683 *
Simon Glass7760ba22016-05-01 13:52:23 -0600684 * The name is allocated and will be freed automatically when the device is
685 * unbound.
686 *
Simon Glasse3b23e22015-07-30 13:40:39 -0600687 * @dev: Device to update
688 * @name: New name (this string is allocated new memory and attached to
689 * the device)
690 * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
691 * string
692 */
693int device_set_name(struct udevice *dev, const char *name);
694
Bin Meng05bedb12015-09-11 03:24:34 -0700695/**
Simon Glass7760ba22016-05-01 13:52:23 -0600696 * device_set_name_alloced() - note that a device name is allocated
697 *
Simon Glass2d4c7dc2016-07-04 11:58:15 -0600698 * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is
Simon Glass7760ba22016-05-01 13:52:23 -0600699 * unbound the name will be freed. This avoids memory leaks.
700 *
701 * @dev: Device to update
702 */
703void device_set_name_alloced(struct udevice *dev);
704
705/**
Simon Glass54cbcc82017-05-18 20:08:57 -0600706 * device_is_compatible() - check if the device is compatible with the compat
Mugunthan V N4666bd92016-04-28 15:36:02 +0530707 *
708 * This allows to check whether the device is comaptible with the compat.
709 *
710 * @dev: udevice pointer for which compatible needs to be verified.
711 * @compat: Compatible string which needs to verified in the given
712 * device
713 * @return true if OK, false if the compatible is not found
714 */
Simon Glass2a580882020-01-27 08:49:36 -0700715bool device_is_compatible(const struct udevice *dev, const char *compat);
Mugunthan V N4666bd92016-04-28 15:36:02 +0530716
717/**
718 * of_machine_is_compatible() - check if the machine is compatible with
719 * the compat
720 *
721 * This allows to check whether the machine is comaptible with the compat.
722 *
723 * @compat: Compatible string which needs to verified
724 * @return true if OK, false if the compatible is not found
725 */
726bool of_machine_is_compatible(const char *compat);
727
728/**
Mario Six3bedfbe2018-06-26 08:46:50 +0200729 * dev_disable_by_path() - Disable a device given its device tree path
730 *
731 * @path: The device tree path identifying the device to be disabled
732 * @return 0 on success, -ve on error
733 */
734int dev_disable_by_path(const char *path);
735
736/**
737 * dev_enable_by_path() - Enable a device given its device tree path
738 *
739 * @path: The device tree path identifying the device to be enabled
740 * @return 0 on success, -ve on error
741 */
742int dev_enable_by_path(const char *path);
743
744/**
Bin Meng05bedb12015-09-11 03:24:34 -0700745 * device_is_on_pci_bus - Test if a device is on a PCI bus
746 *
747 * @dev: device to test
748 * @return: true if it is on a PCI bus, false otherwise
749 */
Simon Glass2a580882020-01-27 08:49:36 -0700750static inline bool device_is_on_pci_bus(const struct udevice *dev)
Bin Meng05bedb12015-09-11 03:24:34 -0700751{
752 return device_get_uclass_id(dev->parent) == UCLASS_PCI;
753}
754
Simon Glass0a74c962015-11-08 23:47:52 -0700755/**
756 * device_foreach_child_safe() - iterate through child devices safely
757 *
758 * This allows the @pos child to be removed in the loop if required.
759 *
760 * @pos: struct udevice * for the current device
761 * @next: struct udevice * for the next device
762 * @parent: parent device to scan
763 */
764#define device_foreach_child_safe(pos, next, parent) \
765 list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
766
Simon Glass5d5388d2016-07-05 17:10:08 -0600767/**
Simon Glasscfd72932019-09-25 08:55:56 -0600768 * device_foreach_child() - iterate through child devices
769 *
770 * @pos: struct udevice * for the current device
771 * @parent: parent device to scan
772 */
773#define device_foreach_child(pos, parent) \
774 list_for_each_entry(pos, &parent->child_head, sibling_node)
775
776/**
Simon Glass000676b2020-01-27 08:49:47 -0700777 * device_foreach_child_ofdata_to_platdata() - iterate through children
778 *
779 * This stops when it gets an error, with @pos set to the device that failed to
780 * read ofdata.
781
782 * This creates a for() loop which works through the available children of
783 * a device in order from start to end. Device ofdata is read by calling
784 * device_ofdata_to_platdata() on each one. The devices are not probed.
785 *
786 * @pos: struct udevice * for the current device
787 * @parent: parent device to scan
788 */
789#define device_foreach_child_ofdata_to_platdata(pos, parent) \
790 for (int _ret = device_first_child_ofdata_err(parent, &dev); !_ret; \
791 _ret = device_next_child_ofdata_err(&dev))
792
793/**
Simon Glass76db9b72020-01-27 08:49:48 -0700794 * device_foreach_child_probe() - iterate through children, probing them
795 *
796 * This creates a for() loop which works through the available children of
797 * a device in order from start to end. Devices are probed if necessary,
798 * and ready for use.
799 *
800 * This stops when it gets an error, with @pos set to the device that failed to
801 * probe
802 *
803 * @pos: struct udevice * for the current device
804 * @parent: parent device to scan
805 */
806#define device_foreach_child_probe(pos, parent) \
807 for (int _ret = device_first_child_err(parent, &dev); !_ret; \
808 _ret = device_next_child_err(&dev))
809
810/**
Simon Glass5d5388d2016-07-05 17:10:08 -0600811 * dm_scan_fdt_dev() - Bind child device in a the device tree
812 *
813 * This handles device which have sub-nodes in the device tree. It scans all
814 * sub-nodes and binds drivers for each node where a driver can be found.
815 *
816 * If this is called prior to relocation, only pre-relocation devices will be
817 * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where
818 * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will
819 * be bound.
820 *
821 * @dev: Device to scan
822 * @return 0 if OK, -ve on error
823 */
824int dm_scan_fdt_dev(struct udevice *dev);
825
Simon Glassdd6ab882014-02-26 15:59:18 -0700826#endif