include/dm/device-internal.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   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>
   8  */
   9
  10 #ifndef _DM_DEVICE_INTERNAL_H
  11 #define _DM_DEVICE_INTERNAL_H
  12
  13 #include <linker_lists.h>
  14 #include <dm/ofnode.h>
  15
  16 struct device_node;
  17 struct udevice;
  18
  19 /*
  20  * These two macros DM_DEVICE_INST and DM_DEVICE_REF are only allowed in code
  21  * generated by dtoc, because the ordering is important and if other instances
  22  * creep in then they may mess up the ordering expected by dtoc.
  23  *
  24  * It is OK to use them with 'extern' though, since that does not actually
  25  * add a new record to the linker_list.
  26  */
  27
  28 /**
  29  * DM_DEVICE_INST() - Declare a bound device ready for run-time use
  30  *
  31  * This adds an actual struct udevice to a list which is found by driver model
  32  * on start-up.
  33  *
  34  * For example:
  35  *
  36  * extern U_BOOT_DRIVER(sandbox_fixed_clock);
  37  * extern DM_UCLASS_INST(clk);
  38  *
  39  * DM_DEVICE_INST(clk_fixed) = {
  40  *      .driver         = DM_DRIVER_REF(sandbox_fixed_clock),
  41  *      .name           = "sandbox_fixed_clock",
  42  *      .plat_          = &_sandbox_fixed_clock_plat_clk_fixed,
  43  *      .uclass         = DM_UCLASS_REF(clk),
  44  *      ...
  45  *      .seq_           = 0,
  46  * };
  47  *
  48  * @_name: Name of the udevice. This must be a valid C identifier, used by the
  49  *      linker_list.
  50  */
  51 #define DM_DEVICE_INST(_name)                                           \
  52         ll_entry_declare(struct udevice, _name, udevice)
  53
  54 /**
  55  * DM_DEVICE_REF() - Get a reference to a device
  56  *
  57  * This is useful in data structures and code for referencing a udevice at
  58  * build time. Before this is used, an extern DM_DEVICE_INST() must have been
  59  * declared.
  60  *
  61  * For example:
  62  *
  63  * extern DM_DEVICE_INST(clk_fixed);
  64  *
  65  * struct udevice *devs[] = {
  66  *      DM_DEVICE_REF(clk_fixed),
  67  * };
  68  *
  69  * @_name: Name of the udevice. This must be a valid C identifier, used by the
  70  *      linker_list
  71  * @returns struct udevice * for the device
  72  */
  73 #define DM_DEVICE_REF(_name)                                            \
  74         ll_entry_ref(struct udevice, _name, udevice)
  75
  76 /**
  77  * DM_DEVICE_GET() - Get a pointer to a given device
  78  *
  79  * This is similar to DM_DEVICE_REF() except that it does not need the extern
  80  * declaration before it. However it cannot be used in a data structures, only
  81  * in code within a function.
  82  *
  83  * For example:
  84  *
  85  * void some_function() {
  86  *      struct udevice *dev = DM_DEVICE_GET(clk_fixed);
  87  * ...
  88  * }
  89  */
  90 #define DM_DEVICE_GET(__name)                                           \
  91         ll_entry_get(struct udevice, __name, udevice)
  92
  93 /**
  94  * device_bind() - Create a device and bind it to a driver
  95  *
  96  * Called to set up a new device attached to a driver. The device will either
  97  * have plat, or a device tree node which can be used to create the
  98  * plat.
  99  *
 100  * Once bound a device exists but is not yet active until device_probe() is
 101  * called.
 102  *
 103  * @parent: Pointer to device's parent, under which this driver will exist
 104  * @drv: Device's driver
 105  * @name: Name of device (e.g. device tree node name)
 106  * @plat: Pointer to data for this device - the structure is device-
 107  * specific but may include the device's I/O address, etc.. This is NULL for
 108  * devices which use device tree.
 109  * @ofnode: Devicetree node for this device. This is ofnode_null() for
 110  * devices which don't use devicetree or don't have a node.
 111  * @devp: if non-NULL, returns a pointer to the bound device
 112  * @return 0 if OK, -ve on error
 113  */
 114 int device_bind(struct udevice *parent, const struct driver *drv,
 115                 const char *name, void *plat, ofnode node,
 116                 struct udevice **devp);
 117
 118 /**
 119  * device_bind_with_driver_data() - Create a device and bind it to a driver
 120  *
 121  * Called to set up a new device attached to a driver, in the case where the
 122  * driver was matched to the device by means of a match table that provides
 123  * driver_data.
 124  *
 125  * Once bound a device exists but is not yet active until device_probe() is
 126  * called.
 127  *
 128  * @parent: Pointer to device's parent, under which this driver will exist
 129  * @drv: Device's driver
 130  * @name: Name of device (e.g. device tree node name)
 131  * @driver_data: The driver_data field from the driver's match table.
 132  * @node: Device tree node for this device. This is invalid for devices which
 133  * don't use device tree.
 134  * @devp: if non-NULL, returns a pointer to the bound device
 135  * @return 0 if OK, -ve on error
 136  */
 137 int device_bind_with_driver_data(struct udevice *parent,
 138                                  const struct driver *drv, const char *name,
 139                                  ulong driver_data, ofnode node,
 140                                  struct udevice **devp);
 141 /**
 142  * device_bind_by_name: Create a device and bind it to a driver
 143  *
 144  * This is a helper function used to bind devices which do not use device
 145  * tree.
 146  *
 147  * @parent: Pointer to device's parent
 148  * @pre_reloc_only: If true, bind the driver only if its DM_FLAG_PRE_RELOC flag
 149  * is set. If false bind the driver always.
 150  * @info: Name and plat for this device
 151  * @devp: if non-NULL, returns a pointer to the bound device
 152  * @return 0 if OK, -ve on error
 153  */
 154 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
 155                         const struct driver_info *info, struct udevice **devp);
 156
 157 /**
 158  * device_reparent: reparent the device to a new parent
 159  *
 160  * @dev: pointer to device to be reparented
 161  * @new_parent: pointer to new parent device
 162  * @return 0 if OK, -ve on error
 163  */
 164 int device_reparent(struct udevice *dev, struct udevice *new_parent);
 165
 166 /**
 167  * device_of_to_plat() - Read platform data for a device
 168  *
 169  * Read platform data for a device (typically from the device tree) so that
 170  * the information needed to probe the device is present.
 171  *
 172  * This may cause some others devices to be probed if this one depends on them,
 173  * e.g. a GPIO line will cause a GPIO device to be probed.
 174  *
 175  * All private data associated with the device is allocated.
 176  *
 177  * @dev: Pointer to device to process
 178  * @return 0 if OK, -ve on error
 179  */
 180 int device_of_to_plat(struct udevice *dev);
 181
 182 /**
 183  * device_probe() - Probe a device, activating it
 184  *
 185  * Activate a device so that it is ready for use. All its parents are probed
 186  * first.
 187  *
 188  * @dev: Pointer to device to probe
 189  * @return 0 if OK, -ve on error
 190  */
 191 int device_probe(struct udevice *dev);
 192
 193 /**
 194  * device_remove() - Remove a device, de-activating it
 195  *
 196  * De-activate a device so that it is no longer ready for use. All its
 197  * children are deactivated first.
 198  *
 199  * @dev: Pointer to device to remove
 200  * @flags: Flags for selective device removal (DM_REMOVE_...)
 201  * @return 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if
 202  *      this is a vital device and flags is DM_REMOVE_NON_VITAL, other -ve on
 203  *      error (such an error here is normally a very bad thing)
 204  */
 205 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 206 int device_remove(struct udevice *dev, uint flags);
 207 #else
 208 static inline int device_remove(struct udevice *dev, uint flags) { return 0; }
 209 #endif
 210
 211 /**
 212  * device_unbind() - Unbind a device, destroying it
 213  *
 214  * Unbind a device and remove all memory used by it
 215  *
 216  * @dev: Pointer to device to unbind
 217  * @return 0 if OK, -ve on error
 218  */
 219 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 220 int device_unbind(struct udevice *dev);
 221 #else
 222 static inline int device_unbind(struct udevice *dev) { return 0; }
 223 #endif
 224
 225 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 226 void device_free(struct udevice *dev);
 227 #else
 228 static inline void device_free(struct udevice *dev) {}
 229 #endif
 230
 231 /**
 232  * device_chld_unbind() - Unbind all device's children from the device if bound
 233  *                        to drv
 234  *
 235  * On error, the function continues to unbind all children, and reports the
 236  * first error.
 237  *
 238  * @dev:        The device that is to be stripped of its children
 239  * @drv:        The targeted driver
 240  * @return 0 on success, -ve on error
 241  */
 242 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 243 int device_chld_unbind(struct udevice *dev, struct driver *drv);
 244 #else
 245 static inline int device_chld_unbind(struct udevice *dev, struct driver *drv)
 246 {
 247         return 0;
 248 }
 249 #endif
 250
 251 /**
 252  * device_chld_remove() - Stop all device's children
 253  *
 254  * This continues through all children recursively stopping part-way through if
 255  * an error occurs. Return values of -EKEYREJECTED are ignored and processing
 256  * continues, since they just indicate that the child did not elect to be
 257  * removed based on the value of @flags. Return values of -EPROBE_DEFER cause
 258  * processing of other children to continue, but the function will return
 259  * -EPROBE_DEFER.
 260  *
 261  * @dev:        The device whose children are to be removed
 262  * @drv:        The targeted driver
 263  * @flags:      Flag, if this functions is called in the pre-OS stage
 264  * @return 0 on success, -EPROBE_DEFER if any child failed to remove, other
 265  *      -ve on error
 266  */
 267 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 268 int device_chld_remove(struct udevice *dev, struct driver *drv,
 269                        uint flags);
 270 #else
 271 static inline int device_chld_remove(struct udevice *dev, struct driver *drv,
 272                                      uint flags)
 273 {
 274         return 0;
 275 }
 276 #endif
 277
 278 /**
 279  * dev_set_priv() - Set the private data for a device
 280  *
 281  * This is normally handled by driver model, which automatically allocates
 282  * private data when an 'auto' size if provided by the driver.
 283  *
 284  * Use this function to override normal operation for special situations, such
 285  * as needing to allocate a variable amount of data.
 286  *
 287  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 288  * model code, since the pointer must be within the gd->dm_priv_base region.
 289  *
 290  * @dev         Device to check
 291  * @priv        New private-data pointer
 292  */
 293 void dev_set_priv(struct udevice *dev, void *priv);
 294
 295 /**
 296  * dev_set_parent_priv() - Set the parent-private data for a device
 297  *
 298  * This is normally handled by driver model, which automatically allocates
 299  * parent-private data when an 'auto' size if provided by the driver.
 300  *
 301  * Use this function to override normal operation for special situations, such
 302  * as needing to allocate a variable amount of data.
 303  *
 304  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 305  * model code, since the pointer must be within the gd->dm_priv_base region.
 306  *
 307  * @dev:        Device to update
 308  * @parent_priv: New parent-private data
 309  */
 310 void dev_set_parent_priv(struct udevice *dev, void *parent_priv);
 311
 312 /**
 313  * dev_set_uclass_priv() - Set the uclass private data for a device
 314  *
 315  * This is normally handled by driver model, which automatically allocates
 316  * uclass-private data when an 'auto' size if provided by the driver.
 317  *
 318  * Use this function to override normal operation for special situations, such
 319  * as needing to allocate a variable amount of data.
 320  *
 321  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 322  * model code, since the pointer must be within the gd->dm_priv_base region.
 323  *
 324  * @dev:        Device to update
 325  * @uclass_priv: New uclass private data
 326  */
 327 void dev_set_uclass_priv(struct udevice *dev, void *uclass_priv);
 328
 329 /**
 330  * dev_set_plat() - Set the platform data for a device
 331  *
 332  * This is normally handled by driver model, which automatically allocates
 333  * platform data when an 'auto' size if provided by the driver.
 334  *
 335  * Use this function to override normal operation for special situations, such
 336  * as needing to allocate a variable amount of data.
 337  *
 338  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 339  * model code, since the pointer must be within the gd->dm_priv_base region.
 340  *
 341  * @dev         Device to check
 342  * @plat        New platform-data pointer
 343  */
 344 void dev_set_plat(struct udevice *dev, void *priv);
 345
 346 /**
 347  * dev_set_parent_plat() - Set the parent platform data for a device
 348  *
 349  * This is normally handled by driver model, which automatically allocates
 350  * parent platform data when an 'auto' size if provided by the driver.
 351  *
 352  * Use this function to override normal operation for special situations, such
 353  * as needing to allocate a variable amount of data.
 354  *
 355  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 356  * model code, since the pointer must be within the gd->dm_priv_base region.
 357  *
 358  * @dev:        Device to update
 359  * @parent_plat: New parent platform data
 360  */
 361 void dev_set_parent_plat(struct udevice *dev, void *parent_plat);
 362
 363 /**
 364  * dev_set_uclass_plat() - Set the uclass platform data for a device
 365  *
 366  * This is normally handled by driver model, which automatically allocates
 367  * uclass platform data when an 'auto' size if provided by the driver.
 368  *
 369  * Use this function to override normal operation for special situations, such
 370  * as needing to allocate a variable amount of data.
 371  *
 372  * If OF_PLATDATA_RT is enabled, this function cannot be used out of core driver
 373  * model code, since the pointer must be within the gd->dm_priv_base region.
 374  *
 375  * @dev:        Device to update
 376  * @uclass_plat: New uclass platform data
 377  */
 378 void dev_set_uclass_plat(struct udevice *dev, void *uclass_plat);
 379
 380 /**
 381  * simple_bus_translate() - translate a bus address to a system address
 382  *
 383  * This handles the 'ranges' property in a simple bus. It translates the
 384  * device address @addr to a system address using this property.
 385  *
 386  * @dev:        Simple bus device (parent of target device)
 387  * @addr:       Address to translate
 388  * @return new address
 389  */
 390 fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
 391
 392 /* Cast away any volatile pointer */
 393 #define DM_ROOT_NON_CONST               (((gd_t *)gd)->dm_root)
 394 #define DM_UCLASS_ROOT_NON_CONST        (((gd_t *)gd)->uclass_root)
 395 #define DM_UCLASS_ROOT_S_NON_CONST      (((gd_t *)gd)->uclass_root_s)
 396
 397 /* device resource management */
 398 #ifdef CONFIG_DEVRES
 399
 400 /**
 401  * devres_release_probe - Release managed resources allocated after probing
 402  * @dev: Device to release resources for
 403  *
 404  * Release all resources allocated for @dev when it was probed or later.
 405  * This function is called on driver removal.
 406  */
 407 void devres_release_probe(struct udevice *dev);
 408
 409 /**
 410  * devres_release_all - Release all managed resources
 411  * @dev: Device to release resources for
 412  *
 413  * Release all resources associated with @dev.  This function is
 414  * called on driver unbinding.
 415  */
 416 void devres_release_all(struct udevice *dev);
 417
 418 #else /* ! CONFIG_DEVRES */
 419
 420 static inline void devres_release_probe(struct udevice *dev)
 421 {
 422 }
 423
 424 static inline void devres_release_all(struct udevice *dev)
 425 {
 426 }
 427
 428 #endif /* ! CONFIG_DEVRES */
 429 #endif