Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 2 | /* |
| 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 Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 8 | */ |
| 9 | |
| 10 | #ifndef _DM_DEVICE_H |
| 11 | #define _DM_DEVICE_H |
| 12 | |
Simon Glass | 9a14860 | 2017-05-17 17:18:10 -0600 | [diff] [blame] | 13 | #include <dm/ofnode.h> |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 14 | #include <dm/uclass-id.h> |
Peng Fan | 99b7235 | 2015-02-10 14:46:32 +0800 | [diff] [blame] | 15 | #include <fdtdec.h> |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 16 | #include <linker_lists.h> |
Masahiro Yamada | b475e1f | 2015-07-25 21:52:36 +0900 | [diff] [blame] | 17 | #include <linux/kernel.h> |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 18 | #include <linux/list.h> |
Masahiro Yamada | 9e74eb5 | 2017-09-26 11:58:29 +0900 | [diff] [blame] | 19 | #include <linux/printk.h> |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 20 | |
| 21 | struct driver_info; |
| 22 | |
| 23 | /* Driver is active (probed). Cleared when it is removed */ |
Simon Glass | aa74168 | 2015-09-28 23:32:03 -0600 | [diff] [blame] | 24 | #define DM_FLAG_ACTIVATED (1 << 0) |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 25 | |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 26 | /* DM is responsible for allocating and freeing plat */ |
Simon Glass | aa74168 | 2015-09-28 23:32:03 -0600 | [diff] [blame] | 27 | #define DM_FLAG_ALLOC_PDATA (1 << 1) |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 28 | |
Simon Glass | fef72b7 | 2014-07-23 06:55:03 -0600 | [diff] [blame] | 29 | /* DM should init this device prior to relocation */ |
Simon Glass | aa74168 | 2015-09-28 23:32:03 -0600 | [diff] [blame] | 30 | #define DM_FLAG_PRE_RELOC (1 << 2) |
Simon Glass | fef72b7 | 2014-07-23 06:55:03 -0600 | [diff] [blame] | 31 | |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 32 | /* DM is responsible for allocating and freeing parent_plat */ |
Simon Glass | 11b6173 | 2015-01-25 08:27:01 -0700 | [diff] [blame] | 33 | #define DM_FLAG_ALLOC_PARENT_PDATA (1 << 3) |
| 34 | |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 35 | /* DM is responsible for allocating and freeing uclass_plat */ |
Przemyslaw Marczak | d850e67 | 2015-04-15 13:07:18 +0200 | [diff] [blame] | 36 | #define DM_FLAG_ALLOC_UCLASS_PDATA (1 << 4) |
| 37 | |
Simon Glass | 825d3f9 | 2015-03-25 12:21:53 -0600 | [diff] [blame] | 38 | /* Allocate driver private data on a DMA boundary */ |
Simon Glass | aa74168 | 2015-09-28 23:32:03 -0600 | [diff] [blame] | 39 | #define DM_FLAG_ALLOC_PRIV_DMA (1 << 5) |
Simon Glass | 825d3f9 | 2015-03-25 12:21:53 -0600 | [diff] [blame] | 40 | |
Masahiro Yamada | bdbb5dd | 2015-07-25 21:52:34 +0900 | [diff] [blame] | 41 | /* Device is bound */ |
Simon Glass | aa74168 | 2015-09-28 23:32:03 -0600 | [diff] [blame] | 42 | #define DM_FLAG_BOUND (1 << 6) |
Masahiro Yamada | bdbb5dd | 2015-07-25 21:52:34 +0900 | [diff] [blame] | 43 | |
Simon Glass | 7760ba2 | 2016-05-01 13:52:23 -0600 | [diff] [blame] | 44 | /* Device name is allocated and should be freed on unbind() */ |
Simon Glass | 2d4c7dc | 2016-07-04 11:58:15 -0600 | [diff] [blame] | 45 | #define DM_FLAG_NAME_ALLOCED (1 << 7) |
Simon Glass | 7760ba2 | 2016-05-01 13:52:23 -0600 | [diff] [blame] | 46 | |
Simon Glass | 2137c24 | 2019-12-29 21:19:19 -0700 | [diff] [blame] | 47 | /* Device has platform data provided by of-platdata */ |
Simon Glass | afbf9b8 | 2016-07-04 11:58:18 -0600 | [diff] [blame] | 48 | #define DM_FLAG_OF_PLATDATA (1 << 8) |
| 49 | |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 50 | /* |
| 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 Roese | 0745676 | 2017-04-24 09:48:02 +0200 | [diff] [blame] | 59 | * 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 Vutla | c10e52b | 2019-09-27 13:48:12 +0530 | [diff] [blame] | 64 | /* DM does not enable/disable the power domains corresponding to this device */ |
| 65 | #define DM_FLAG_DEFAULT_PD_CTRL_OFF (1 << 11) |
| 66 | |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 67 | /* Driver plat has been read. Cleared when the device is removed */ |
Simon Glass | d3c9d30 | 2019-12-29 21:19:21 -0700 | [diff] [blame] | 68 | #define DM_FLAG_PLATDATA_VALID (1 << 12) |
| 69 | |
Stefan Roese | 0745676 | 2017-04-24 09:48:02 +0200 | [diff] [blame] | 70 | /* |
Anatolij Gustschin | cfb28f1 | 2020-02-17 12:36:43 +0100 | [diff] [blame] | 71 | * 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 | */ |
Simon Glass | 1281065 | 2021-01-24 14:32:42 -0700 | [diff] [blame] | 74 | #define DM_FLAG_LEAVE_PD_ON (1 << 13) |
Anatolij Gustschin | cfb28f1 | 2020-02-17 12:36:43 +0100 | [diff] [blame] | 75 | |
| 76 | /* |
Marek Vasut | abbdbbd | 2021-01-24 14:32:46 -0700 | [diff] [blame] | 77 | * Device is vital to the operation of other devices. It is possible to remove |
| 78 | * removed this device after all regular devices are removed. This is useful |
| 79 | * e.g. for clock, which need to be active during the device-removal phase. |
| 80 | */ |
| 81 | #define DM_FLAG_VITAL (1 << 14) |
| 82 | |
| 83 | /* |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 84 | * One or multiple of these flags are passed to device_remove() so that |
| 85 | * a selective device removal as specified by the remove-stage and the |
| 86 | * driver flags can be done. |
Simon Glass | 97c2dfc | 2021-01-24 14:32:43 -0700 | [diff] [blame] | 87 | * |
| 88 | * DO NOT use these flags in your driver's @flags value... |
| 89 | * use the above DM_FLAG_... values instead |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 90 | */ |
| 91 | enum { |
| 92 | /* Normal remove, remove all devices */ |
Simon Glass | 42697f5 | 2020-03-28 14:03:48 -0600 | [diff] [blame] | 93 | DM_REMOVE_NORMAL = 1 << 0, |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 94 | |
| 95 | /* Remove devices with active DMA */ |
Simon Glass | 42697f5 | 2020-03-28 14:03:48 -0600 | [diff] [blame] | 96 | DM_REMOVE_ACTIVE_DMA = DM_FLAG_ACTIVE_DMA, |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 97 | |
Stefan Roese | 0745676 | 2017-04-24 09:48:02 +0200 | [diff] [blame] | 98 | /* Remove devices which need some final OS preparation steps */ |
Simon Glass | 42697f5 | 2020-03-28 14:03:48 -0600 | [diff] [blame] | 99 | DM_REMOVE_OS_PREPARE = DM_FLAG_OS_PREPARE, |
Stefan Roese | 0745676 | 2017-04-24 09:48:02 +0200 | [diff] [blame] | 100 | |
Marek Vasut | abbdbbd | 2021-01-24 14:32:46 -0700 | [diff] [blame] | 101 | /* Remove only devices that are not marked vital */ |
| 102 | DM_REMOVE_NON_VITAL = DM_FLAG_VITAL, |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 103 | |
| 104 | /* Remove devices with any active flag */ |
Simon Glass | 42697f5 | 2020-03-28 14:03:48 -0600 | [diff] [blame] | 105 | DM_REMOVE_ACTIVE_ALL = DM_REMOVE_ACTIVE_DMA | DM_REMOVE_OS_PREPARE, |
| 106 | |
| 107 | /* Don't power down any attached power domains */ |
| 108 | DM_REMOVE_NO_PD = 1 << 1, |
Stefan Roese | 80b5bc9 | 2017-03-20 12:51:48 +0100 | [diff] [blame] | 109 | }; |
| 110 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 111 | /** |
Heiko Schocher | b74fcb4 | 2014-05-22 12:43:05 +0200 | [diff] [blame] | 112 | * struct udevice - An instance of a driver |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 113 | * |
| 114 | * This holds information about a device, which is a driver bound to a |
| 115 | * particular port or peripheral (essentially a driver instance). |
| 116 | * |
| 117 | * A device will come into existence through a 'bind' call, either due to |
Simon Glass | 1d8364a | 2020-12-28 20:34:54 -0700 | [diff] [blame] | 118 | * a U_BOOT_DRVINFO() macro (in which case plat is non-NULL) or a node |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 119 | * in the device tree (in which case of_offset is >= 0). In the latter case |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 120 | * we translate the device tree information into plat in a function |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 121 | * implemented by the driver of_to_plat method (called just before the |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 122 | * probe method if the device has a device tree node. |
| 123 | * |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 124 | * All three of plat, priv and uclass_priv can be allocated by the |
Dario Binacchi | 107819c | 2021-01-23 19:48:57 +0100 | [diff] [blame] | 125 | * driver, or you can use the auto members of struct driver and |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 126 | * struct uclass_driver to have driver model do this automatically. |
| 127 | * |
| 128 | * @driver: The driver used by this device |
| 129 | * @name: Name of device, typically the FDT node name |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 130 | * @plat_: Configuration data for this device (do not access outside driver |
| 131 | * model) |
| 132 | * @parent_plat_: The parent bus's configuration data for this device (do not |
| 133 | * access outside driver model) |
| 134 | * @uclass_plat_: The uclass's configuration data for this device (do not access |
| 135 | * outside driver model) |
Simon Glass | 46227bd | 2015-03-25 12:21:55 -0600 | [diff] [blame] | 136 | * @driver_data: Driver data word for the entry that matched this device with |
| 137 | * its driver |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 138 | * @parent: Parent of this device, or NULL for the top level device |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 139 | * @priv_: Private data for this device (do not access outside driver model) |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 140 | * @uclass: Pointer to uclass for this device |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 141 | * @uclass_priv_: The uclass's private data for this device (do not access |
| 142 | * outside driver model) |
| 143 | * @parent_priv_: The parent's private data for this device (do not access |
| 144 | * outside driver model) |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 145 | * @uclass_node: Used by uclass to link its devices |
| 146 | * @child_head: List of children of this device |
| 147 | * @sibling_node: Next device in list of all devices |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 148 | * @flags_: Flags for this device `DM_FLAG_...` (do not access outside driver |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 149 | * model) |
Simon Glass | 5e34992 | 2020-12-19 10:40:09 -0700 | [diff] [blame] | 150 | * @seq_: Allocated sequence number for this device (-1 = none). This is set up |
Simon Glass | 7272e92 | 2020-12-16 21:20:09 -0700 | [diff] [blame] | 151 | * when the device is bound and is unique within the device's uclass. If the |
| 152 | * device has an alias in the devicetree then that is used to set the sequence |
| 153 | * number. Otherwise, the next available number is used. Sequence numbers are |
Simon Glass | 5e34992 | 2020-12-19 10:40:09 -0700 | [diff] [blame] | 154 | * used by certain commands that need device to be numbered (e.g. 'mmc dev'). |
| 155 | * (do not access outside driver model) |
Simon Glass | 6931439 | 2020-12-19 10:40:15 -0700 | [diff] [blame] | 156 | * @node_: Reference to device tree node for this device (do not access outside |
| 157 | * driver model) |
Simon Glass | c8ca1cb | 2015-09-28 23:32:04 -0600 | [diff] [blame] | 158 | * @devres_head: List of memory allocations associated with this device. |
| 159 | * When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will |
| 160 | * add to this list. Memory so-allocated will be freed |
| 161 | * automatically when the device is removed / unbound |
Nicolas Saenz Julienne | a2c7ead | 2021-01-12 13:55:24 +0100 | [diff] [blame] | 162 | * @dma_offset: Offset between the physical address space (CPU's) and the |
| 163 | * device's bus address space |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 164 | */ |
Heiko Schocher | b74fcb4 | 2014-05-22 12:43:05 +0200 | [diff] [blame] | 165 | struct udevice { |
Simon Glass | a626dff | 2015-03-25 12:21:54 -0600 | [diff] [blame] | 166 | const struct driver *driver; |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 167 | const char *name; |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 168 | void *plat_; |
| 169 | void *parent_plat_; |
| 170 | void *uclass_plat_; |
Simon Glass | 46227bd | 2015-03-25 12:21:55 -0600 | [diff] [blame] | 171 | ulong driver_data; |
Heiko Schocher | b74fcb4 | 2014-05-22 12:43:05 +0200 | [diff] [blame] | 172 | struct udevice *parent; |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 173 | void *priv_; |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 174 | struct uclass *uclass; |
Simon Glass | 541f62c | 2020-12-22 19:30:30 -0700 | [diff] [blame] | 175 | void *uclass_priv_; |
| 176 | void *parent_priv_; |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 177 | struct list_head uclass_node; |
| 178 | struct list_head child_head; |
| 179 | struct list_head sibling_node; |
Simon Glass | b5660c4 | 2021-03-15 17:25:37 +1300 | [diff] [blame] | 180 | #if !CONFIG_IS_ENABLED(OF_PLATDATA_RT) |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 181 | u32 flags_; |
Simon Glass | b5660c4 | 2021-03-15 17:25:37 +1300 | [diff] [blame] | 182 | #endif |
Simon Glass | 5e34992 | 2020-12-19 10:40:09 -0700 | [diff] [blame] | 183 | int seq_; |
Simon Glass | 9288265 | 2021-08-07 07:24:04 -0600 | [diff] [blame] | 184 | #if CONFIG_IS_ENABLED(OF_REAL) |
Simon Glass | 6931439 | 2020-12-19 10:40:15 -0700 | [diff] [blame] | 185 | ofnode node_; |
| 186 | #endif |
Simon Glass | 3996f06 | 2022-03-27 14:26:19 -0600 | [diff] [blame^] | 187 | #if CONFIG_IS_ENABLED(DEVRES) |
Masahiro Yamada | 8b15b16 | 2015-07-25 21:52:35 +0900 | [diff] [blame] | 188 | struct list_head devres_head; |
Masahiro Yamada | 029bfca | 2015-07-25 21:52:37 +0900 | [diff] [blame] | 189 | #endif |
Nicolas Saenz Julienne | a2c7ead | 2021-01-12 13:55:24 +0100 | [diff] [blame] | 190 | #if CONFIG_IS_ENABLED(DM_DMA) |
| 191 | ulong dma_offset; |
| 192 | #endif |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 193 | }; |
| 194 | |
Simon Glass | 8beeb28 | 2021-03-15 17:25:36 +1300 | [diff] [blame] | 195 | /** |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 196 | * struct udevice_rt - runtime information set up by U-Boot |
Simon Glass | 8beeb28 | 2021-03-15 17:25:36 +1300 | [diff] [blame] | 197 | * |
| 198 | * This is only used with OF_PLATDATA_RT |
| 199 | * |
| 200 | * There is one of these for every udevice in the linker list, indexed by |
| 201 | * the udevice_info idx value. |
| 202 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 203 | * @flags_: Flags for this device `DM_FLAG_...` (do not access outside driver |
Simon Glass | 8beeb28 | 2021-03-15 17:25:36 +1300 | [diff] [blame] | 204 | * model) |
| 205 | */ |
| 206 | struct udevice_rt { |
| 207 | u32 flags_; |
| 208 | }; |
| 209 | |
Patrick Delaunay | 9838538 | 2021-09-22 18:29:08 +0200 | [diff] [blame] | 210 | /* Maximum sequence number supported and associated string length */ |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 211 | #define DM_MAX_SEQ 999 |
Patrick Delaunay | 9838538 | 2021-09-22 18:29:08 +0200 | [diff] [blame] | 212 | #define DM_MAX_SEQ_STR 3 |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 213 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 214 | /* Returns the operations for a device */ |
Sughosh Ganu | 912b6f5 | 2022-01-30 00:51:08 +0530 | [diff] [blame] | 215 | #define device_get_ops(dev) ((dev)->driver->ops) |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 216 | |
Simon Glass | b5660c4 | 2021-03-15 17:25:37 +1300 | [diff] [blame] | 217 | #if CONFIG_IS_ENABLED(OF_PLATDATA_RT) |
| 218 | u32 dev_get_flags(const struct udevice *dev); |
| 219 | void dev_or_flags(const struct udevice *dev, u32 or); |
| 220 | void dev_bic_flags(const struct udevice *dev, u32 bic); |
| 221 | #else |
Simon Glass | 6211d76 | 2020-12-19 10:40:10 -0700 | [diff] [blame] | 222 | static inline u32 dev_get_flags(const struct udevice *dev) |
| 223 | { |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 224 | return dev->flags_; |
Simon Glass | 6211d76 | 2020-12-19 10:40:10 -0700 | [diff] [blame] | 225 | } |
| 226 | |
| 227 | static inline void dev_or_flags(struct udevice *dev, u32 or) |
| 228 | { |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 229 | dev->flags_ |= or; |
Simon Glass | 6211d76 | 2020-12-19 10:40:10 -0700 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | static inline void dev_bic_flags(struct udevice *dev, u32 bic) |
| 233 | { |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 234 | dev->flags_ &= ~bic; |
Simon Glass | 6211d76 | 2020-12-19 10:40:10 -0700 | [diff] [blame] | 235 | } |
Simon Glass | b5660c4 | 2021-03-15 17:25:37 +1300 | [diff] [blame] | 236 | #endif /* OF_PLATDATA_RT */ |
Simon Glass | 6211d76 | 2020-12-19 10:40:10 -0700 | [diff] [blame] | 237 | |
Simon Glass | f1d50f7 | 2020-12-19 10:40:13 -0700 | [diff] [blame] | 238 | /** |
| 239 | * dev_ofnode() - get the DT node reference associated with a udevice |
| 240 | * |
| 241 | * @dev: device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 242 | * Return: reference of the device's DT node |
Simon Glass | f1d50f7 | 2020-12-19 10:40:13 -0700 | [diff] [blame] | 243 | */ |
| 244 | static inline ofnode dev_ofnode(const struct udevice *dev) |
| 245 | { |
Simon Glass | 9288265 | 2021-08-07 07:24:04 -0600 | [diff] [blame] | 246 | #if CONFIG_IS_ENABLED(OF_REAL) |
Simon Glass | 6931439 | 2020-12-19 10:40:15 -0700 | [diff] [blame] | 247 | return dev->node_; |
Simon Glass | a7ece58 | 2020-12-19 10:40:14 -0700 | [diff] [blame] | 248 | #else |
| 249 | return ofnode_null(); |
| 250 | #endif |
Simon Glass | f1d50f7 | 2020-12-19 10:40:13 -0700 | [diff] [blame] | 251 | } |
| 252 | |
Simon Glass | 2ef5638 | 2020-12-19 10:40:11 -0700 | [diff] [blame] | 253 | /* Returns non-zero if the device is active (probed and not removed) */ |
| 254 | #define device_active(dev) (dev_get_flags(dev) & DM_FLAG_ACTIVATED) |
| 255 | |
Nicolas Saenz Julienne | a2c7ead | 2021-01-12 13:55:24 +0100 | [diff] [blame] | 256 | #if CONFIG_IS_ENABLED(DM_DMA) |
| 257 | #define dev_set_dma_offset(_dev, _offset) _dev->dma_offset = _offset |
| 258 | #define dev_get_dma_offset(_dev) _dev->dma_offset |
| 259 | #else |
| 260 | #define dev_set_dma_offset(_dev, _offset) |
| 261 | #define dev_get_dma_offset(_dev) 0 |
| 262 | #endif |
| 263 | |
Simon Glass | dd79d6e | 2017-01-17 16:52:55 -0700 | [diff] [blame] | 264 | static inline int dev_of_offset(const struct udevice *dev) |
| 265 | { |
Simon Glass | 9288265 | 2021-08-07 07:24:04 -0600 | [diff] [blame] | 266 | #if CONFIG_IS_ENABLED(OF_REAL) |
Simon Glass | a7ece58 | 2020-12-19 10:40:14 -0700 | [diff] [blame] | 267 | return ofnode_to_offset(dev_ofnode(dev)); |
| 268 | #else |
| 269 | return -1; |
| 270 | #endif |
Simon Glass | dd79d6e | 2017-01-17 16:52:55 -0700 | [diff] [blame] | 271 | } |
| 272 | |
Simon Glass | f1d50f7 | 2020-12-19 10:40:13 -0700 | [diff] [blame] | 273 | static inline bool dev_has_ofnode(const struct udevice *dev) |
Simon Glass | 9a14860 | 2017-05-17 17:18:10 -0600 | [diff] [blame] | 274 | { |
Simon Glass | 9288265 | 2021-08-07 07:24:04 -0600 | [diff] [blame] | 275 | #if CONFIG_IS_ENABLED(OF_REAL) |
Simon Glass | a7ece58 | 2020-12-19 10:40:14 -0700 | [diff] [blame] | 276 | return ofnode_valid(dev_ofnode(dev)); |
| 277 | #else |
| 278 | return false; |
| 279 | #endif |
| 280 | } |
| 281 | |
| 282 | static inline void dev_set_ofnode(struct udevice *dev, ofnode node) |
| 283 | { |
Simon Glass | 9288265 | 2021-08-07 07:24:04 -0600 | [diff] [blame] | 284 | #if CONFIG_IS_ENABLED(OF_REAL) |
Simon Glass | 6931439 | 2020-12-19 10:40:15 -0700 | [diff] [blame] | 285 | dev->node_ = node; |
Simon Glass | a7ece58 | 2020-12-19 10:40:14 -0700 | [diff] [blame] | 286 | #endif |
Simon Glass | dd79d6e | 2017-01-17 16:52:55 -0700 | [diff] [blame] | 287 | } |
| 288 | |
Simon Glass | 75e534b | 2020-12-16 21:20:07 -0700 | [diff] [blame] | 289 | static inline int dev_seq(const struct udevice *dev) |
| 290 | { |
Simon Glass | 5e34992 | 2020-12-19 10:40:09 -0700 | [diff] [blame] | 291 | return dev->seq_; |
Simon Glass | 75e534b | 2020-12-16 21:20:07 -0700 | [diff] [blame] | 292 | } |
| 293 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 294 | /** |
Simon Glass | 767827a | 2014-06-11 23:29:45 -0600 | [diff] [blame] | 295 | * struct udevice_id - Lists the compatible strings supported by a driver |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 296 | * @compatible: Compatible string |
| 297 | * @data: Data for this compatible string |
| 298 | */ |
Simon Glass | 767827a | 2014-06-11 23:29:45 -0600 | [diff] [blame] | 299 | struct udevice_id { |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 300 | const char *compatible; |
| 301 | ulong data; |
| 302 | }; |
| 303 | |
Simon Glass | 3580f6d | 2021-08-07 07:24:03 -0600 | [diff] [blame] | 304 | #if CONFIG_IS_ENABLED(OF_REAL) |
Masahiro Yamada | f797bc2 | 2014-10-07 14:51:31 +0900 | [diff] [blame] | 305 | #define of_match_ptr(_ptr) (_ptr) |
| 306 | #else |
| 307 | #define of_match_ptr(_ptr) NULL |
Masahiro Yamada | 366b24f | 2015-08-12 07:31:55 +0900 | [diff] [blame] | 308 | #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */ |
Masahiro Yamada | f797bc2 | 2014-10-07 14:51:31 +0900 | [diff] [blame] | 309 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 310 | /** |
| 311 | * struct driver - A driver for a feature or peripheral |
| 312 | * |
| 313 | * This holds methods for setting up a new device, and also removing it. |
| 314 | * The device needs information to set itself up - this is provided either |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 315 | * by plat or a device tree node (which we find by looking up |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 316 | * matching compatible strings with of_match). |
| 317 | * |
| 318 | * Drivers all belong to a uclass, representing a class of devices of the |
| 319 | * same type. Common elements of the drivers can be implemented in the uclass, |
| 320 | * or the uclass can provide a consistent interface to the drivers within |
| 321 | * it. |
| 322 | * |
| 323 | * @name: Device name |
Heinrich Schuchardt | 3e142d9 | 2018-02-12 12:38:36 +0100 | [diff] [blame] | 324 | * @id: Identifies the uclass we belong to |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 325 | * @of_match: List of compatible strings to match, and any identifying data |
| 326 | * for each. |
| 327 | * @bind: Called to bind a device to its driver |
| 328 | * @probe: Called to probe a device, i.e. activate it |
| 329 | * @remove: Called to remove a device, i.e. de-activate it |
| 330 | * @unbind: Called to unbind a device from its driver |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 331 | * @of_to_plat: Called before probe to decode device tree data |
Simon Glass | a4a51a0 | 2015-01-25 08:27:03 -0700 | [diff] [blame] | 332 | * @child_post_bind: Called after a new child has been bound |
Simon Glass | d45560d | 2014-07-23 06:55:21 -0600 | [diff] [blame] | 333 | * @child_pre_probe: Called before a child device is probed. The device has |
| 334 | * memory allocated but it has not yet been probed. |
| 335 | * @child_post_remove: Called after a child device is removed. The device |
| 336 | * has memory allocated but its device_remove() method has been called. |
Simon Glass | 8a2b47f | 2020-12-03 16:55:17 -0700 | [diff] [blame] | 337 | * @priv_auto: If non-zero this is the size of the private data |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 338 | * to be allocated in the device's ->priv pointer. If zero, then the driver |
| 339 | * is responsible for allocating any data required. |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 340 | * @plat_auto: If non-zero this is the size of the |
| 341 | * platform data to be allocated in the device's ->plat pointer. |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 342 | * This is typically only useful for device-tree-aware drivers (those with |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 343 | * an of_match), since drivers which use plat will have the data |
Simon Glass | 1d8364a | 2020-12-28 20:34:54 -0700 | [diff] [blame] | 344 | * provided in the U_BOOT_DRVINFO() instantiation. |
Simon Glass | 8a2b47f | 2020-12-03 16:55:17 -0700 | [diff] [blame] | 345 | * @per_child_auto: Each device can hold private data owned by |
Simon Glass | 60d971b | 2014-07-23 06:55:20 -0600 | [diff] [blame] | 346 | * its parent. If required this will be automatically allocated if this |
| 347 | * value is non-zero. |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 348 | * @per_child_plat_auto: A bus likes to store information about |
Simon Glass | 11b6173 | 2015-01-25 08:27:01 -0700 | [diff] [blame] | 349 | * its children. If non-zero this is the size of this data, to be allocated |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 350 | * in the child's parent_plat pointer. |
Simon Glass | cebcebb | 2014-07-23 06:55:17 -0600 | [diff] [blame] | 351 | * @ops: Driver-specific operations. This is typically a list of function |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 352 | * pointers defined by the driver, to implement driver functions required by |
| 353 | * the uclass. |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 354 | * @flags: driver flags - see `DM_FLAGS_...` |
Simon Glass | 9fb9e9b | 2020-04-09 10:27:38 -0600 | [diff] [blame] | 355 | * @acpi_ops: Advanced Configuration and Power Interface (ACPI) operations, |
| 356 | * allowing the device to add things to the ACPI tables passed to Linux |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 357 | */ |
| 358 | struct driver { |
| 359 | char *name; |
| 360 | enum uclass_id id; |
Simon Glass | 767827a | 2014-06-11 23:29:45 -0600 | [diff] [blame] | 361 | const struct udevice_id *of_match; |
Heiko Schocher | b74fcb4 | 2014-05-22 12:43:05 +0200 | [diff] [blame] | 362 | int (*bind)(struct udevice *dev); |
| 363 | int (*probe)(struct udevice *dev); |
| 364 | int (*remove)(struct udevice *dev); |
| 365 | int (*unbind)(struct udevice *dev); |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 366 | int (*of_to_plat)(struct udevice *dev); |
Simon Glass | a4a51a0 | 2015-01-25 08:27:03 -0700 | [diff] [blame] | 367 | int (*child_post_bind)(struct udevice *dev); |
Simon Glass | d45560d | 2014-07-23 06:55:21 -0600 | [diff] [blame] | 368 | int (*child_pre_probe)(struct udevice *dev); |
| 369 | int (*child_post_remove)(struct udevice *dev); |
Simon Glass | 8a2b47f | 2020-12-03 16:55:17 -0700 | [diff] [blame] | 370 | int priv_auto; |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 371 | int plat_auto; |
Simon Glass | 8a2b47f | 2020-12-03 16:55:17 -0700 | [diff] [blame] | 372 | int per_child_auto; |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 373 | int per_child_plat_auto; |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 374 | const void *ops; /* driver-specific operations */ |
Simon Glass | fef72b7 | 2014-07-23 06:55:03 -0600 | [diff] [blame] | 375 | uint32_t flags; |
Simon Glass | 9fb9e9b | 2020-04-09 10:27:38 -0600 | [diff] [blame] | 376 | #if CONFIG_IS_ENABLED(ACPIGEN) |
| 377 | struct acpi_ops *acpi_ops; |
| 378 | #endif |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 379 | }; |
| 380 | |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 381 | /** |
| 382 | * U_BOOT_DRIVER() - Declare a new U-Boot driver |
| 383 | * @__name: name of the driver |
| 384 | */ |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 385 | #define U_BOOT_DRIVER(__name) \ |
| 386 | ll_entry_declare(struct driver, __name, driver) |
| 387 | |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 388 | /** |
| 389 | * DM_DRIVER_GET() - Get a pointer to a given driver |
| 390 | * |
| 391 | * This is useful in code for referencing a driver at build time. |
| 392 | * Before this is used, an extern U_BOOT_DRIVER() must have been |
| 393 | * declared. |
| 394 | * |
| 395 | * @__name: Name of the driver. This must be a valid C identifier, |
| 396 | * used by the linker_list |
| 397 | * Return: struct driver * for the driver |
| 398 | */ |
Simon Glass | 65130cd | 2020-12-28 20:34:56 -0700 | [diff] [blame] | 399 | #define DM_DRIVER_GET(__name) \ |
Simon Glass | 32d8ab6 | 2016-07-17 15:23:15 -0600 | [diff] [blame] | 400 | ll_entry_get(struct driver, __name, driver) |
| 401 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 402 | /** |
Simon Glass | 7074354 | 2021-03-15 17:25:14 +1300 | [diff] [blame] | 403 | * DM_DRIVER_REF() - Get a reference to a driver |
| 404 | * |
| 405 | * This is useful in data structures and code for referencing a driver at |
| 406 | * build time. Before this is used, an extern U_BOOT_DRIVER() must have been |
| 407 | * declared. |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 408 | * This is like DM_DRIVER_GET, but without the extra code, so it is suitable |
| 409 | * for putting into data structures. |
Simon Glass | 7074354 | 2021-03-15 17:25:14 +1300 | [diff] [blame] | 410 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 411 | * For example:: |
Simon Glass | 7074354 | 2021-03-15 17:25:14 +1300 | [diff] [blame] | 412 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 413 | * extern U_BOOT_DRIVER(sandbox_fixed_clock); |
| 414 | * struct driver *drvs[] = { |
| 415 | * DM_DRIVER_REF(sandbox_fixed_clock), |
| 416 | * }; |
Simon Glass | 7074354 | 2021-03-15 17:25:14 +1300 | [diff] [blame] | 417 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 418 | * @_name: Name of the driver. This must be a valid C identifier, |
| 419 | * used by the linker_list |
| 420 | * Return: struct driver * for the driver |
Simon Glass | 7074354 | 2021-03-15 17:25:14 +1300 | [diff] [blame] | 421 | */ |
| 422 | #define DM_DRIVER_REF(_name) \ |
| 423 | ll_entry_ref(struct driver, _name, driver) |
| 424 | |
| 425 | /** |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 426 | * DM_DRIVER_ALIAS() - Declare a macro to state an alias for a driver name |
| 427 | * |
| 428 | * This macro will produce no code but its information will be parsed by tools |
| 429 | * like dtoc |
| 430 | * |
| 431 | * @__name: name of driver |
| 432 | * @__alias: alias for the driver name |
Walter Lozano | 48e5b04 | 2020-06-25 01:10:06 -0300 | [diff] [blame] | 433 | */ |
Simon Glass | df65db8 | 2020-12-28 20:34:57 -0700 | [diff] [blame] | 434 | #define DM_DRIVER_ALIAS(__name, __alias) |
Walter Lozano | 48e5b04 | 2020-06-25 01:10:06 -0300 | [diff] [blame] | 435 | |
| 436 | /** |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 437 | * DM_PHASE() - Declare a macro to indicate which phase of U-Boot this driver is for. |
Simon Glass | f303ee7 | 2021-02-03 06:01:02 -0700 | [diff] [blame] | 438 | * |
| 439 | * This macro produces no code but its information will be parsed by dtoc. The |
| 440 | * macro can be only be used once in a driver. Put it within the U_BOOT_DRIVER() |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 441 | * declaration, e.g.:: |
| 442 | * |
| 443 | * U_BOOT_DRIVER(cpu) = { |
| 444 | * .name = ... |
| 445 | * ... |
| 446 | * DM_PHASE(tpl) |
| 447 | * }; |
Simon Glass | f303ee7 | 2021-02-03 06:01:02 -0700 | [diff] [blame] | 448 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 449 | * @_phase: Associated phase of U-Boot ("spl", "tpl") |
Simon Glass | f303ee7 | 2021-02-03 06:01:02 -0700 | [diff] [blame] | 450 | */ |
| 451 | #define DM_PHASE(_phase) |
| 452 | |
| 453 | /** |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 454 | * DM_HEADER() - Declare a macro to declare a header needed for a driver. |
| 455 | * |
| 456 | * Often the correct header can be found automatically, but only for struct |
| 457 | * declarations. For enums and #defines used in the driver declaration and |
| 458 | * declared in a different header from the structs, this macro must be used. |
Simon Glass | a7b1c77 | 2021-02-03 06:01:04 -0700 | [diff] [blame] | 459 | * |
| 460 | * This macro produces no code but its information will be parsed by dtoc. The |
| 461 | * macro can be used multiple times with different headers, for the same driver. |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 462 | * Put it within the U_BOOT_DRIVER() declaration, e.g.:: |
Simon Glass | a7b1c77 | 2021-02-03 06:01:04 -0700 | [diff] [blame] | 463 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 464 | * U_BOOT_DRIVER(cpu) = { |
| 465 | * .name = ... |
| 466 | * ... |
| 467 | * DM_HEADER(<asm/cpu.h>) |
| 468 | * }; |
| 469 | * |
| 470 | * @_hdr: header needed for a driver |
Simon Glass | a7b1c77 | 2021-02-03 06:01:04 -0700 | [diff] [blame] | 471 | */ |
| 472 | #define DM_HEADER(_hdr) |
| 473 | |
| 474 | /** |
Simon Glass | fa20e93 | 2020-12-03 16:55:20 -0700 | [diff] [blame] | 475 | * dev_get_plat() - Get the platform data for a device |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 476 | * |
| 477 | * This checks that dev is not NULL, but no other checks for now |
| 478 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 479 | * @dev: Device to check |
| 480 | * Return: platform data, or NULL if none |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 481 | */ |
Simon Glass | fa20e93 | 2020-12-03 16:55:20 -0700 | [diff] [blame] | 482 | void *dev_get_plat(const struct udevice *dev); |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 483 | |
| 484 | /** |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 485 | * dev_get_parent_plat() - Get the parent platform data for a device |
Simon Glass | 11b6173 | 2015-01-25 08:27:01 -0700 | [diff] [blame] | 486 | * |
| 487 | * This checks that dev is not NULL, but no other checks for now |
| 488 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 489 | * @dev: Device to check |
| 490 | * Return: parent's platform data, or NULL if none |
Simon Glass | 11b6173 | 2015-01-25 08:27:01 -0700 | [diff] [blame] | 491 | */ |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 492 | void *dev_get_parent_plat(const struct udevice *dev); |
Simon Glass | 11b6173 | 2015-01-25 08:27:01 -0700 | [diff] [blame] | 493 | |
| 494 | /** |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 495 | * dev_get_uclass_plat() - Get the uclass platform data for a device |
Przemyslaw Marczak | d850e67 | 2015-04-15 13:07:18 +0200 | [diff] [blame] | 496 | * |
| 497 | * This checks that dev is not NULL, but no other checks for now |
| 498 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 499 | * @dev: Device to check |
| 500 | * Return: uclass's platform data, or NULL if none |
Przemyslaw Marczak | d850e67 | 2015-04-15 13:07:18 +0200 | [diff] [blame] | 501 | */ |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 502 | void *dev_get_uclass_plat(const struct udevice *dev); |
Przemyslaw Marczak | d850e67 | 2015-04-15 13:07:18 +0200 | [diff] [blame] | 503 | |
| 504 | /** |
Simon Glass | ffca202 | 2015-09-28 23:32:02 -0600 | [diff] [blame] | 505 | * dev_get_priv() - Get the private data for a device |
| 506 | * |
| 507 | * This checks that dev is not NULL, but no other checks for now |
| 508 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 509 | * @dev: Device to check |
| 510 | * Return: private data, or NULL if none |
Simon Glass | ffca202 | 2015-09-28 23:32:02 -0600 | [diff] [blame] | 511 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 512 | void *dev_get_priv(const struct udevice *dev); |
Simon Glass | ffca202 | 2015-09-28 23:32:02 -0600 | [diff] [blame] | 513 | |
| 514 | /** |
Simon Glass | de44acf | 2015-09-28 23:32:01 -0600 | [diff] [blame] | 515 | * dev_get_parent_priv() - Get the parent private data for a device |
Simon Glass | 60d971b | 2014-07-23 06:55:20 -0600 | [diff] [blame] | 516 | * |
Simon Glass | de44acf | 2015-09-28 23:32:01 -0600 | [diff] [blame] | 517 | * The parent private data is data stored in the device but owned by the |
| 518 | * parent. For example, a USB device may have parent data which contains |
| 519 | * information about how to talk to the device over USB. |
Simon Glass | 60d971b | 2014-07-23 06:55:20 -0600 | [diff] [blame] | 520 | * |
| 521 | * This checks that dev is not NULL, but no other checks for now |
| 522 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 523 | * @dev: Device to check |
| 524 | * Return: parent data, or NULL if none |
Simon Glass | 60d971b | 2014-07-23 06:55:20 -0600 | [diff] [blame] | 525 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 526 | void *dev_get_parent_priv(const struct udevice *dev); |
Simon Glass | 60d971b | 2014-07-23 06:55:20 -0600 | [diff] [blame] | 527 | |
| 528 | /** |
Simon Glass | ffca202 | 2015-09-28 23:32:02 -0600 | [diff] [blame] | 529 | * dev_get_uclass_priv() - Get the private uclass data for a device |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 530 | * |
| 531 | * This checks that dev is not NULL, but no other checks for now |
| 532 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 533 | * @dev: Device to check |
| 534 | * Return: private uclass data for this device, or NULL if none |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 535 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 536 | void *dev_get_uclass_priv(const struct udevice *dev); |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 537 | |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 538 | /** |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 539 | * dev_get_parent() - Get the parent of a device |
Simon Glass | 43f488a | 2014-11-11 10:46:19 -0700 | [diff] [blame] | 540 | * |
| 541 | * @child: Child to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 542 | * Return: parent of child, or NULL if this is the root device |
Simon Glass | 43f488a | 2014-11-11 10:46:19 -0700 | [diff] [blame] | 543 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 544 | struct udevice *dev_get_parent(const struct udevice *child); |
Simon Glass | 43f488a | 2014-11-11 10:46:19 -0700 | [diff] [blame] | 545 | |
| 546 | /** |
Simon Glass | 46227bd | 2015-03-25 12:21:55 -0600 | [diff] [blame] | 547 | * dev_get_driver_data() - get the driver data used to bind a device |
Simon Glass | 70c3a0e | 2014-11-11 10:46:18 -0700 | [diff] [blame] | 548 | * |
| 549 | * When a device is bound using a device tree node, it matches a |
Simon Glass | 1958eec | 2015-09-28 23:32:06 -0600 | [diff] [blame] | 550 | * particular compatible string in struct udevice_id. This function |
Simon Glass | 46227bd | 2015-03-25 12:21:55 -0600 | [diff] [blame] | 551 | * returns the associated data value for that compatible string. This is |
| 552 | * the 'data' field in struct udevice_id. |
| 553 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 554 | * As an example, consider this structure:: |
| 555 | * |
| 556 | * static const struct udevice_id tegra_i2c_ids[] = { |
| 557 | * { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 }, |
| 558 | * { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD }, |
| 559 | * { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC }, |
| 560 | * { } |
| 561 | * }; |
Simon Glass | 1958eec | 2015-09-28 23:32:06 -0600 | [diff] [blame] | 562 | * |
| 563 | * When driver model finds a driver for this it will store the 'data' value |
| 564 | * corresponding to the compatible string it matches. This function returns |
| 565 | * that value. This allows the driver to handle several variants of a device. |
| 566 | * |
Simon Glass | 46227bd | 2015-03-25 12:21:55 -0600 | [diff] [blame] | 567 | * For USB devices, this is the driver_info field in struct usb_device_id. |
| 568 | * |
| 569 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 570 | * Return: driver data (0 if none is provided) |
Simon Glass | 70c3a0e | 2014-11-11 10:46:18 -0700 | [diff] [blame] | 571 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 572 | ulong dev_get_driver_data(const struct udevice *dev); |
Simon Glass | 70c3a0e | 2014-11-11 10:46:18 -0700 | [diff] [blame] | 573 | |
Przemyslaw Marczak | d3ef0d7 | 2015-04-15 13:07:24 +0200 | [diff] [blame] | 574 | /** |
| 575 | * dev_get_driver_ops() - get the device's driver's operations |
| 576 | * |
| 577 | * This checks that dev is not NULL, and returns the pointer to device's |
| 578 | * driver's operations. |
| 579 | * |
| 580 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 581 | * Return: void pointer to driver's operations or NULL for NULL-dev or NULL-ops |
Przemyslaw Marczak | d3ef0d7 | 2015-04-15 13:07:24 +0200 | [diff] [blame] | 582 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 583 | const void *dev_get_driver_ops(const struct udevice *dev); |
Przemyslaw Marczak | d3ef0d7 | 2015-04-15 13:07:24 +0200 | [diff] [blame] | 584 | |
Simon Glass | 1958eec | 2015-09-28 23:32:06 -0600 | [diff] [blame] | 585 | /** |
Simon Glass | 98fd5d1 | 2015-01-25 08:27:04 -0700 | [diff] [blame] | 586 | * device_get_uclass_id() - return the uclass ID of a device |
| 587 | * |
| 588 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 589 | * Return: uclass ID for the device |
Simon Glass | 98fd5d1 | 2015-01-25 08:27:04 -0700 | [diff] [blame] | 590 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 591 | enum uclass_id device_get_uclass_id(const struct udevice *dev); |
Simon Glass | 98fd5d1 | 2015-01-25 08:27:04 -0700 | [diff] [blame] | 592 | |
Simon Glass | 1958eec | 2015-09-28 23:32:06 -0600 | [diff] [blame] | 593 | /** |
Przemyslaw Marczak | 5ed2e42 | 2015-04-15 13:07:25 +0200 | [diff] [blame] | 594 | * dev_get_uclass_name() - return the uclass name of a device |
| 595 | * |
| 596 | * This checks that dev is not NULL. |
| 597 | * |
| 598 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 599 | * Return: pointer to the uclass name for the device |
Przemyslaw Marczak | 5ed2e42 | 2015-04-15 13:07:25 +0200 | [diff] [blame] | 600 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 601 | const char *dev_get_uclass_name(const struct udevice *dev); |
Przemyslaw Marczak | 5ed2e42 | 2015-04-15 13:07:25 +0200 | [diff] [blame] | 602 | |
Simon Glass | 70c3a0e | 2014-11-11 10:46:18 -0700 | [diff] [blame] | 603 | /** |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 604 | * device_get_child() - Get the child of a device by index |
| 605 | * |
| 606 | * Returns the numbered child, 0 being the first. This does not use |
| 607 | * sequence numbers, only the natural order. |
| 608 | * |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 609 | * @parent: Parent device to check |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 610 | * @index: Child index |
| 611 | * @devp: Returns pointer to device |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 612 | * Return: |
| 613 | * 0 if OK, -ENODEV if no such device, other error if the device fails to probe |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 614 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 615 | int device_get_child(const struct udevice *parent, int index, |
| 616 | struct udevice **devp); |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 617 | |
| 618 | /** |
Simon Glass | 51608c9 | 2021-12-16 20:59:32 -0700 | [diff] [blame] | 619 | * device_get_child_count() - Get the child count of a device |
Lokesh Vutla | fa45a08 | 2019-09-04 16:01:26 +0530 | [diff] [blame] | 620 | * |
| 621 | * Returns the number of children to a device. |
| 622 | * |
| 623 | * @parent: Parent device to check |
| 624 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 625 | int device_get_child_count(const struct udevice *parent); |
Lokesh Vutla | fa45a08 | 2019-09-04 16:01:26 +0530 | [diff] [blame] | 626 | |
| 627 | /** |
Simon Glass | 51608c9 | 2021-12-16 20:59:32 -0700 | [diff] [blame] | 628 | * device_get_decendent_count() - Get the total number of decendents of a device |
| 629 | * |
| 630 | * Returns the total number of decendents, including all children |
| 631 | * |
| 632 | * @parent: Parent device to check |
| 633 | */ |
| 634 | int device_get_decendent_count(const struct udevice *parent); |
| 635 | |
| 636 | /** |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 637 | * device_find_child_by_seq() - Find a child device based on a sequence |
| 638 | * |
Simon Glass | 07e1338 | 2020-12-16 21:20:29 -0700 | [diff] [blame] | 639 | * This searches for a device with the given seq. |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 640 | * |
| 641 | * @parent: Parent device |
Simon Glass | 07e1338 | 2020-12-16 21:20:29 -0700 | [diff] [blame] | 642 | * @seq: Sequence number to find (0=first) |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 643 | * @devp: Returns pointer to device (there is only one per for each seq). |
| 644 | * Set to NULL if none is found |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 645 | * Return: 0 if OK, -ENODEV if not found |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 646 | */ |
Simon Glass | 07e1338 | 2020-12-16 21:20:29 -0700 | [diff] [blame] | 647 | int device_find_child_by_seq(const struct udevice *parent, int seq, |
| 648 | struct udevice **devp); |
Simon Glass | db6f020 | 2014-07-23 06:55:12 -0600 | [diff] [blame] | 649 | |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 650 | /** |
| 651 | * device_get_child_by_seq() - Get a child device based on a sequence |
| 652 | * |
| 653 | * If an active device has this sequence it will be returned. If there is no |
| 654 | * such device then this will check for a device that is requesting this |
| 655 | * sequence. |
| 656 | * |
| 657 | * The device is probed to activate it ready for use. |
| 658 | * |
| 659 | * @parent: Parent device |
| 660 | * @seq: Sequence number to find (0=first) |
| 661 | * @devp: Returns pointer to device (there is only one per for each seq) |
| 662 | * Set to NULL if none is found |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 663 | * Return: 0 if OK, -ve on error |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 664 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 665 | int device_get_child_by_seq(const struct udevice *parent, int seq, |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 666 | struct udevice **devp); |
| 667 | |
| 668 | /** |
| 669 | * device_find_child_by_of_offset() - Find a child device based on FDT offset |
| 670 | * |
| 671 | * Locates a child device by its device tree offset. |
| 672 | * |
| 673 | * @parent: Parent device |
| 674 | * @of_offset: Device tree offset to find |
| 675 | * @devp: Returns pointer to device if found, otherwise this is set to NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 676 | * Return: 0 if OK, -ve on error |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 677 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 678 | int device_find_child_by_of_offset(const struct udevice *parent, int of_offset, |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 679 | struct udevice **devp); |
| 680 | |
| 681 | /** |
| 682 | * device_get_child_by_of_offset() - Get a child device based on FDT offset |
| 683 | * |
| 684 | * Locates a child device by its device tree offset. |
| 685 | * |
| 686 | * The device is probed to activate it ready for use. |
| 687 | * |
| 688 | * @parent: Parent device |
| 689 | * @of_offset: Device tree offset to find |
| 690 | * @devp: Returns pointer to device if found, otherwise this is set to NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 691 | * Return: 0 if OK, -ve on error |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 692 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 693 | int device_get_child_by_of_offset(const struct udevice *parent, int of_offset, |
Simon Glass | 48d4e29 | 2014-07-23 06:55:19 -0600 | [diff] [blame] | 694 | struct udevice **devp); |
| 695 | |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 696 | /** |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 697 | * device_find_global_by_ofnode() - Get a device based on ofnode |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 698 | * |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 699 | * Locates a device by its device tree ofnode, searching globally throughout |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 700 | * the all driver model devices. |
| 701 | * |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 702 | * The device is NOT probed |
| 703 | * |
| 704 | * @node: Device tree ofnode to find |
| 705 | * @devp: Returns pointer to device if found, otherwise this is set to NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 706 | * Return: 0 if OK, -ve on error |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 707 | */ |
| 708 | |
| 709 | int device_find_global_by_ofnode(ofnode node, struct udevice **devp); |
| 710 | |
| 711 | /** |
| 712 | * device_get_global_by_ofnode() - Get a device based on ofnode |
| 713 | * |
| 714 | * Locates a device by its device tree ofnode, searching globally throughout |
| 715 | * the all driver model devices. |
| 716 | * |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 717 | * The device is probed to activate it ready for use. |
| 718 | * |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 719 | * @node: Device tree ofnode to find |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 720 | * @devp: Returns pointer to device if found, otherwise this is set to NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 721 | * Return: 0 if OK, -ve on error |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 722 | */ |
Jean-Jacques Hiblot | a7b0d6a | 2018-08-09 16:17:44 +0200 | [diff] [blame] | 723 | int device_get_global_by_ofnode(ofnode node, struct udevice **devp); |
Simon Glass | ae2efac | 2015-06-23 15:38:37 -0600 | [diff] [blame] | 724 | |
| 725 | /** |
Simon Glass | 0000e0d | 2021-03-15 17:25:28 +1300 | [diff] [blame] | 726 | * device_get_by_ofplat_idx() - Get a device based on of-platdata index |
Simon Glass | 5792f4b | 2020-10-03 11:31:40 -0600 | [diff] [blame] | 727 | * |
Simon Glass | 0000e0d | 2021-03-15 17:25:28 +1300 | [diff] [blame] | 728 | * Locates a device by either its struct driver_info index, or its |
| 729 | * struct udevice index. The latter is used with OF_PLATDATA_INST, since we have |
| 730 | * a list of build-time instantiated struct udevice records, The former is used |
| 731 | * with !OF_PLATDATA_INST since in that case we have a list of |
| 732 | * struct driver_info records. |
| 733 | * |
| 734 | * The index number is written into the idx field of struct phandle_1_arg, etc. |
| 735 | * It is the position of this driver_info/udevice in its linker list. |
Simon Glass | 5792f4b | 2020-10-03 11:31:40 -0600 | [diff] [blame] | 736 | * |
| 737 | * The device is probed to activate it ready for use. |
| 738 | * |
Simon Glass | 0000e0d | 2021-03-15 17:25:28 +1300 | [diff] [blame] | 739 | * @idx: Index number of the driver_info/udevice structure (0=first) |
Simon Glass | 5792f4b | 2020-10-03 11:31:40 -0600 | [diff] [blame] | 740 | * @devp: Returns pointer to device if found, otherwise this is set to NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 741 | * Return: 0 if OK, -ve on error |
Simon Glass | 5792f4b | 2020-10-03 11:31:40 -0600 | [diff] [blame] | 742 | */ |
Simon Glass | 0000e0d | 2021-03-15 17:25:28 +1300 | [diff] [blame] | 743 | int device_get_by_ofplat_idx(uint idx, struct udevice **devp); |
Simon Glass | 5792f4b | 2020-10-03 11:31:40 -0600 | [diff] [blame] | 744 | |
| 745 | /** |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 746 | * device_find_first_child() - Find the first child of a device |
| 747 | * |
| 748 | * @parent: Parent device to search |
| 749 | * @devp: Returns first child device, or NULL if none |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 750 | * Return: 0 |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 751 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 752 | int device_find_first_child(const struct udevice *parent, |
| 753 | struct udevice **devp); |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 754 | |
| 755 | /** |
Simon Glass | 147a560 | 2015-07-27 15:47:19 -0600 | [diff] [blame] | 756 | * device_find_next_child() - Find the next child of a device |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 757 | * |
| 758 | * @devp: Pointer to previous child device on entry. Returns pointer to next |
| 759 | * child device, or NULL if none |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 760 | * Return: 0 |
Simon Glass | 44da735 | 2014-10-13 23:41:49 -0600 | [diff] [blame] | 761 | */ |
| 762 | int device_find_next_child(struct udevice **devp); |
| 763 | |
Peng Fan | 99b7235 | 2015-02-10 14:46:32 +0800 | [diff] [blame] | 764 | /** |
Simon Glass | b775e87 | 2018-10-01 12:22:07 -0600 | [diff] [blame] | 765 | * device_find_first_inactive_child() - Find the first inactive child |
| 766 | * |
| 767 | * This is used to locate an existing child of a device which is of a given |
| 768 | * uclass. |
| 769 | * |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 770 | * The device is NOT probed |
| 771 | * |
Simon Glass | b775e87 | 2018-10-01 12:22:07 -0600 | [diff] [blame] | 772 | * @parent: Parent device to search |
| 773 | * @uclass_id: Uclass to look for |
Simon Glass | c44d5ab | 2021-08-18 21:40:29 -0600 | [diff] [blame] | 774 | * @devp: Returns device found, if any, else NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 775 | * Return: 0 if found, else -ENODEV |
Simon Glass | b775e87 | 2018-10-01 12:22:07 -0600 | [diff] [blame] | 776 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 777 | int device_find_first_inactive_child(const struct udevice *parent, |
Simon Glass | b775e87 | 2018-10-01 12:22:07 -0600 | [diff] [blame] | 778 | enum uclass_id uclass_id, |
| 779 | struct udevice **devp); |
| 780 | |
| 781 | /** |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 782 | * device_find_first_child_by_uclass() - Find the first child of a device in uc |
| 783 | * |
| 784 | * @parent: Parent device to search |
| 785 | * @uclass_id: Uclass to look for |
Simon Glass | c44d5ab | 2021-08-18 21:40:29 -0600 | [diff] [blame] | 786 | * @devp: Returns first child device in that uclass, if any, else NULL |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 787 | * Return: 0 if found, else -ENODEV |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 788 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 789 | int device_find_first_child_by_uclass(const struct udevice *parent, |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 790 | enum uclass_id uclass_id, |
| 791 | struct udevice **devp); |
| 792 | |
| 793 | /** |
| 794 | * device_find_child_by_name() - Find a child by device name |
| 795 | * |
| 796 | * @parent: Parent device to search |
| 797 | * @name: Name to look for |
Simon Glass | 4b23e45 | 2021-10-23 17:26:08 -0600 | [diff] [blame] | 798 | * @len: Length of the name |
| 799 | * @devp: Returns device found, if any |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 800 | * Return: 0 if found, else -ENODEV |
Simon Glass | 4b23e45 | 2021-10-23 17:26:08 -0600 | [diff] [blame] | 801 | */ |
| 802 | int device_find_child_by_namelen(const struct udevice *parent, const char *name, |
| 803 | int len, struct udevice **devp); |
| 804 | |
| 805 | /** |
| 806 | * device_find_child_by_name() - Find a child by device name |
| 807 | * |
| 808 | * @parent: Parent device to search |
| 809 | * @name: Name to look for |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 810 | * @devp: Returns device found, if any |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 811 | * Return: 0 if found, else -ENODEV |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 812 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 813 | int device_find_child_by_name(const struct udevice *parent, const char *name, |
Simon Glass | a11341a | 2018-11-18 08:14:31 -0700 | [diff] [blame] | 814 | struct udevice **devp); |
| 815 | |
| 816 | /** |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 817 | * device_first_child_ofdata_err() - Find the first child and reads its plat |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 818 | * |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 819 | * The of_to_plat() method is called on the child before it is returned, |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 820 | * but the child is not probed. |
| 821 | * |
| 822 | * @parent: Parent to check |
| 823 | * @devp: Returns child that was found, if any |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 824 | * Return: 0 on success, -ENODEV if no children, other -ve on error |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 825 | */ |
| 826 | int device_first_child_ofdata_err(struct udevice *parent, |
| 827 | struct udevice **devp); |
| 828 | |
| 829 | /* |
Simon Glass | 71fa5b4 | 2020-12-03 16:55:18 -0700 | [diff] [blame] | 830 | * device_next_child_ofdata_err() - Find the next child and read its plat |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 831 | * |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 832 | * The of_to_plat() method is called on the child before it is returned, |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 833 | * but the child is not probed. |
| 834 | * |
| 835 | * @devp: On entry, points to the previous child; on exit returns the child that |
| 836 | * was found, if any |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 837 | * Return: 0 on success, -ENODEV if no children, other -ve on error |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 838 | */ |
| 839 | int device_next_child_ofdata_err(struct udevice **devp); |
| 840 | |
| 841 | /** |
Simon Glass | 76db9b7 | 2020-01-27 08:49:48 -0700 | [diff] [blame] | 842 | * device_first_child_err() - Get the first child of a device |
| 843 | * |
| 844 | * The device returned is probed if necessary, and ready for use |
| 845 | * |
| 846 | * @parent: Parent device to search |
| 847 | * @devp: Returns device found, if any |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 848 | * Return: 0 if found, -ENODEV if not, -ve error if device failed to probe |
Simon Glass | 76db9b7 | 2020-01-27 08:49:48 -0700 | [diff] [blame] | 849 | */ |
| 850 | int device_first_child_err(struct udevice *parent, struct udevice **devp); |
| 851 | |
| 852 | /** |
| 853 | * device_next_child_err() - Get the next child of a parent device |
| 854 | * |
| 855 | * The device returned is probed if necessary, and ready for use |
| 856 | * |
| 857 | * @devp: On entry, pointer to device to lookup. On exit, returns pointer |
| 858 | * to the next sibling if no error occurred |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 859 | * Return: 0 if found, -ENODEV if not, -ve error if device failed to probe |
Simon Glass | 76db9b7 | 2020-01-27 08:49:48 -0700 | [diff] [blame] | 860 | */ |
| 861 | int device_next_child_err(struct udevice **devp); |
| 862 | |
| 863 | /** |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 864 | * device_has_children() - check if a device has any children |
| 865 | * |
| 866 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 867 | * Return: true if the device has one or more children |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 868 | */ |
Simon Glass | 2e5e5ec | 2018-10-01 12:22:06 -0600 | [diff] [blame] | 869 | bool device_has_children(const struct udevice *dev); |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 870 | |
| 871 | /** |
| 872 | * device_has_active_children() - check if a device has any active children |
| 873 | * |
| 874 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 875 | * Return: true if the device has one or more children and at least one of |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 876 | * them is active (probed). |
| 877 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 878 | bool device_has_active_children(const struct udevice *dev); |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 879 | |
| 880 | /** |
| 881 | * device_is_last_sibling() - check if a device is the last sibling |
| 882 | * |
| 883 | * This function can be useful for display purposes, when special action needs |
| 884 | * to be taken when displaying the last sibling. This can happen when a tree |
| 885 | * view of devices is being displayed. |
| 886 | * |
| 887 | * @dev: Device to check |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 888 | * Return: true if there are no more siblings after this one - i.e. is it |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 889 | * last in the list. |
| 890 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 891 | bool device_is_last_sibling(const struct udevice *dev); |
Simon Glass | 40f829a | 2015-03-25 12:21:57 -0600 | [diff] [blame] | 892 | |
Simon Glass | e3b23e2 | 2015-07-30 13:40:39 -0600 | [diff] [blame] | 893 | /** |
| 894 | * device_set_name() - set the name of a device |
| 895 | * |
| 896 | * This must be called in the device's bind() method and no later. Normally |
| 897 | * this is unnecessary but for probed devices which don't get a useful name |
| 898 | * this function can be helpful. |
| 899 | * |
Simon Glass | 7760ba2 | 2016-05-01 13:52:23 -0600 | [diff] [blame] | 900 | * The name is allocated and will be freed automatically when the device is |
| 901 | * unbound. |
| 902 | * |
Simon Glass | e3b23e2 | 2015-07-30 13:40:39 -0600 | [diff] [blame] | 903 | * @dev: Device to update |
| 904 | * @name: New name (this string is allocated new memory and attached to |
| 905 | * the device) |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 906 | * Return: 0 if OK, -ENOMEM if there is not enough memory to allocate the |
Simon Glass | e3b23e2 | 2015-07-30 13:40:39 -0600 | [diff] [blame] | 907 | * string |
| 908 | */ |
| 909 | int device_set_name(struct udevice *dev, const char *name); |
| 910 | |
Bin Meng | 05bedb1 | 2015-09-11 03:24:34 -0700 | [diff] [blame] | 911 | /** |
Simon Glass | 7760ba2 | 2016-05-01 13:52:23 -0600 | [diff] [blame] | 912 | * device_set_name_alloced() - note that a device name is allocated |
| 913 | * |
Simon Glass | 2d4c7dc | 2016-07-04 11:58:15 -0600 | [diff] [blame] | 914 | * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is |
Simon Glass | 7760ba2 | 2016-05-01 13:52:23 -0600 | [diff] [blame] | 915 | * unbound the name will be freed. This avoids memory leaks. |
| 916 | * |
| 917 | * @dev: Device to update |
| 918 | */ |
| 919 | void device_set_name_alloced(struct udevice *dev); |
| 920 | |
| 921 | /** |
Simon Glass | 54cbcc8 | 2017-05-18 20:08:57 -0600 | [diff] [blame] | 922 | * device_is_compatible() - check if the device is compatible with the compat |
Mugunthan V N | 4666bd9 | 2016-04-28 15:36:02 +0530 | [diff] [blame] | 923 | * |
| 924 | * This allows to check whether the device is comaptible with the compat. |
| 925 | * |
| 926 | * @dev: udevice pointer for which compatible needs to be verified. |
| 927 | * @compat: Compatible string which needs to verified in the given |
| 928 | * device |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 929 | * Return: true if OK, false if the compatible is not found |
Mugunthan V N | 4666bd9 | 2016-04-28 15:36:02 +0530 | [diff] [blame] | 930 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 931 | bool device_is_compatible(const struct udevice *dev, const char *compat); |
Mugunthan V N | 4666bd9 | 2016-04-28 15:36:02 +0530 | [diff] [blame] | 932 | |
| 933 | /** |
| 934 | * of_machine_is_compatible() - check if the machine is compatible with |
| 935 | * the compat |
| 936 | * |
| 937 | * This allows to check whether the machine is comaptible with the compat. |
| 938 | * |
| 939 | * @compat: Compatible string which needs to verified |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 940 | * Return: true if OK, false if the compatible is not found |
Mugunthan V N | 4666bd9 | 2016-04-28 15:36:02 +0530 | [diff] [blame] | 941 | */ |
| 942 | bool of_machine_is_compatible(const char *compat); |
| 943 | |
| 944 | /** |
Mario Six | 3bedfbe | 2018-06-26 08:46:50 +0200 | [diff] [blame] | 945 | * dev_disable_by_path() - Disable a device given its device tree path |
| 946 | * |
| 947 | * @path: The device tree path identifying the device to be disabled |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 948 | * Return: 0 on success, -ve on error |
Mario Six | 3bedfbe | 2018-06-26 08:46:50 +0200 | [diff] [blame] | 949 | */ |
| 950 | int dev_disable_by_path(const char *path); |
| 951 | |
| 952 | /** |
| 953 | * dev_enable_by_path() - Enable a device given its device tree path |
| 954 | * |
| 955 | * @path: The device tree path identifying the device to be enabled |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 956 | * Return: 0 on success, -ve on error |
Mario Six | 3bedfbe | 2018-06-26 08:46:50 +0200 | [diff] [blame] | 957 | */ |
| 958 | int dev_enable_by_path(const char *path); |
| 959 | |
| 960 | /** |
Bin Meng | 05bedb1 | 2015-09-11 03:24:34 -0700 | [diff] [blame] | 961 | * device_is_on_pci_bus - Test if a device is on a PCI bus |
| 962 | * |
| 963 | * @dev: device to test |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 964 | * Return: true if it is on a PCI bus, false otherwise |
Bin Meng | 05bedb1 | 2015-09-11 03:24:34 -0700 | [diff] [blame] | 965 | */ |
Simon Glass | 2a58088 | 2020-01-27 08:49:36 -0700 | [diff] [blame] | 966 | static inline bool device_is_on_pci_bus(const struct udevice *dev) |
Bin Meng | 05bedb1 | 2015-09-11 03:24:34 -0700 | [diff] [blame] | 967 | { |
Simon Glass | 6ad24f6 | 2020-07-07 13:12:10 -0600 | [diff] [blame] | 968 | return dev->parent && device_get_uclass_id(dev->parent) == UCLASS_PCI; |
Bin Meng | 05bedb1 | 2015-09-11 03:24:34 -0700 | [diff] [blame] | 969 | } |
| 970 | |
Simon Glass | 0a74c96 | 2015-11-08 23:47:52 -0700 | [diff] [blame] | 971 | /** |
| 972 | * device_foreach_child_safe() - iterate through child devices safely |
| 973 | * |
| 974 | * This allows the @pos child to be removed in the loop if required. |
| 975 | * |
| 976 | * @pos: struct udevice * for the current device |
| 977 | * @next: struct udevice * for the next device |
| 978 | * @parent: parent device to scan |
| 979 | */ |
| 980 | #define device_foreach_child_safe(pos, next, parent) \ |
| 981 | list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node) |
| 982 | |
Simon Glass | 5d5388d | 2016-07-05 17:10:08 -0600 | [diff] [blame] | 983 | /** |
Simon Glass | cfd7293 | 2019-09-25 08:55:56 -0600 | [diff] [blame] | 984 | * device_foreach_child() - iterate through child devices |
| 985 | * |
| 986 | * @pos: struct udevice * for the current device |
| 987 | * @parent: parent device to scan |
| 988 | */ |
| 989 | #define device_foreach_child(pos, parent) \ |
| 990 | list_for_each_entry(pos, &parent->child_head, sibling_node) |
| 991 | |
| 992 | /** |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 993 | * device_foreach_child_of_to_plat() - iterate through children |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 994 | * |
| 995 | * This stops when it gets an error, with @pos set to the device that failed to |
| 996 | * read ofdata. |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 997 | * |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 998 | * This creates a for() loop which works through the available children of |
| 999 | * a device in order from start to end. Device ofdata is read by calling |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 1000 | * device_of_to_plat() on each one. The devices are not probed. |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 1001 | * |
| 1002 | * @pos: struct udevice * for the current device |
| 1003 | * @parent: parent device to scan |
| 1004 | */ |
Simon Glass | aad29ae | 2020-12-03 16:55:21 -0700 | [diff] [blame] | 1005 | #define device_foreach_child_of_to_plat(pos, parent) \ |
AKASHI Takahiro | 4874c4d | 2021-12-10 15:49:36 +0900 | [diff] [blame] | 1006 | for (int _ret = device_first_child_ofdata_err(parent, &pos); !_ret; \ |
| 1007 | _ret = device_next_child_ofdata_err(&pos)) |
Simon Glass | 000676b | 2020-01-27 08:49:47 -0700 | [diff] [blame] | 1008 | |
| 1009 | /** |
Simon Glass | 76db9b7 | 2020-01-27 08:49:48 -0700 | [diff] [blame] | 1010 | * device_foreach_child_probe() - iterate through children, probing them |
| 1011 | * |
| 1012 | * This creates a for() loop which works through the available children of |
| 1013 | * a device in order from start to end. Devices are probed if necessary, |
| 1014 | * and ready for use. |
| 1015 | * |
| 1016 | * This stops when it gets an error, with @pos set to the device that failed to |
| 1017 | * probe |
| 1018 | * |
| 1019 | * @pos: struct udevice * for the current device |
| 1020 | * @parent: parent device to scan |
| 1021 | */ |
| 1022 | #define device_foreach_child_probe(pos, parent) \ |
AKASHI Takahiro | 4874c4d | 2021-12-10 15:49:36 +0900 | [diff] [blame] | 1023 | for (int _ret = device_first_child_err(parent, &pos); !_ret; \ |
| 1024 | _ret = device_next_child_err(&pos)) |
Simon Glass | 76db9b7 | 2020-01-27 08:49:48 -0700 | [diff] [blame] | 1025 | |
| 1026 | /** |
Dario Binacchi | 2698359 | 2020-10-11 14:27:07 +0200 | [diff] [blame] | 1027 | * dm_scan_fdt_dev() - Bind child device in the device tree |
Simon Glass | 5d5388d | 2016-07-05 17:10:08 -0600 | [diff] [blame] | 1028 | * |
| 1029 | * This handles device which have sub-nodes in the device tree. It scans all |
| 1030 | * sub-nodes and binds drivers for each node where a driver can be found. |
| 1031 | * |
| 1032 | * If this is called prior to relocation, only pre-relocation devices will be |
| 1033 | * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where |
| 1034 | * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will |
| 1035 | * be bound. |
| 1036 | * |
| 1037 | * @dev: Device to scan |
Patrick Delaunay | 4b8c70c | 2022-01-12 10:53:46 +0100 | [diff] [blame] | 1038 | * Return: 0 if OK, -ve on error |
Simon Glass | 5d5388d | 2016-07-05 17:10:08 -0600 | [diff] [blame] | 1039 | */ |
| 1040 | int dm_scan_fdt_dev(struct udevice *dev); |
| 1041 | |
Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 1042 | #endif |