include/dm/device-internal.h

   1 /*
   2  * Copyright (C) 2013 Google, Inc
   3  *
   4  * (C) Copyright 2012
   5  * Pavel Herrmann <morpheus.ibis@gmail.com>
   6  * Marek Vasut <marex@denx.de>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #ifndef _DM_DEVICE_INTERNAL_H
  12 #define _DM_DEVICE_INTERNAL_H
  13
  14 #include <dm/ofnode.h>
  15
  16 struct device_node;
  17 struct udevice;
  18
  19 /**
  20  * device_bind() - Create a device and bind it to a driver
  21  *
  22  * Called to set up a new device attached to a driver. The device will either
  23  * have platdata, or a device tree node which can be used to create the
  24  * platdata.
  25  *
  26  * Once bound a device exists but is not yet active until device_probe() is
  27  * called.
  28  *
  29  * @parent: Pointer to device's parent, under which this driver will exist
  30  * @drv: Device's driver
  31  * @name: Name of device (e.g. device tree node name)
  32  * @platdata: Pointer to data for this device - the structure is device-
  33  * specific but may include the device's I/O address, etc.. This is NULL for
  34  * devices which use device tree.
  35  * @of_offset: Offset of device tree node for this device. This is -1 for
  36  * devices which don't use device tree.
  37  * @devp: if non-NULL, returns a pointer to the bound device
  38  * @return 0 if OK, -ve on error
  39  */
  40 int device_bind(struct udevice *parent, const struct driver *drv,
  41                 const char *name, void *platdata, int of_offset,
  42                 struct udevice **devp);
  43
  44 /**
  45  * device_bind_with_driver_data() - Create a device and bind it to a driver
  46  *
  47  * Called to set up a new device attached to a driver, in the case where the
  48  * driver was matched to the device by means of a match table that provides
  49  * driver_data.
  50  *
  51  * Once bound a device exists but is not yet active until device_probe() is
  52  * called.
  53  *
  54  * @parent: Pointer to device's parent, under which this driver will exist
  55  * @drv: Device's driver
  56  * @name: Name of device (e.g. device tree node name)
  57  * @driver_data: The driver_data field from the driver's match table.
  58  * @node: Device tree node for this device. This is invalid for devices which
  59  * don't use device tree.
  60  * @devp: if non-NULL, returns a pointer to the bound device
  61  * @return 0 if OK, -ve on error
  62  */
  63 int device_bind_with_driver_data(struct udevice *parent,
  64                                  const struct driver *drv, const char *name,
  65                                  ulong driver_data, ofnode node,
  66                                  struct udevice **devp);
  67 /**
  68  * device_bind_by_name: Create a device and bind it to a driver
  69  *
  70  * This is a helper function used to bind devices which do not use device
  71  * tree.
  72  *
  73  * @parent: Pointer to device's parent
  74  * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set.
  75  * If false bind the driver always.
  76  * @info: Name and platdata for this device
  77  * @devp: if non-NULL, returns a pointer to the bound device
  78  * @return 0 if OK, -ve on error
  79  */
  80 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
  81                         const struct driver_info *info, struct udevice **devp);
  82
  83 /**
  84  * device_probe() - Probe a device, activating it
  85  *
  86  * Activate a device so that it is ready for use. All its parents are probed
  87  * first.
  88  *
  89  * @dev: Pointer to device to probe
  90  * @return 0 if OK, -ve on error
  91  */
  92 int device_probe(struct udevice *dev);
  93
  94 /**
  95  * device_remove() - Remove a device, de-activating it
  96  *
  97  * De-activate a device so that it is no longer ready for use. All its
  98  * children are deactivated first.
  99  *
 100  * @dev: Pointer to device to remove
 101  * @flags: Flags for selective device removal (DM_REMOVE_...)
 102  * @return 0 if OK, -ve on error (an error here is normally a very bad thing)
 103  */
 104 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 105 int device_remove(struct udevice *dev, uint flags);
 106 #else
 107 static inline int device_remove(struct udevice *dev, uint flags) { return 0; }
 108 #endif
 109
 110 /**
 111  * device_unbind() - Unbind a device, destroying it
 112  *
 113  * Unbind a device and remove all memory used by it
 114  *
 115  * @dev: Pointer to device to unbind
 116  * @return 0 if OK, -ve on error
 117  */
 118 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 119 int device_unbind(struct udevice *dev);
 120 #else
 121 static inline int device_unbind(struct udevice *dev) { return 0; }
 122 #endif
 123
 124 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 125 void device_free(struct udevice *dev);
 126 #else
 127 static inline void device_free(struct udevice *dev) {}
 128 #endif
 129
 130 /**
 131  * simple_bus_translate() - translate a bus address to a system address
 132  *
 133  * This handles the 'ranges' property in a simple bus. It translates the
 134  * device address @addr to a system address using this property.
 135  *
 136  * @dev:        Simple bus device (parent of target device)
 137  * @addr:       Address to translate
 138  * @return new address
 139  */
 140 fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
 141
 142 /* Cast away any volatile pointer */
 143 #define DM_ROOT_NON_CONST               (((gd_t *)gd)->dm_root)
 144 #define DM_UCLASS_ROOT_NON_CONST        (((gd_t *)gd)->uclass_root)
 145
 146 /* device resource management */
 147 #ifdef CONFIG_DEVRES
 148
 149 /**
 150  * devres_release_probe - Release managed resources allocated after probing
 151  * @dev: Device to release resources for
 152  *
 153  * Release all resources allocated for @dev when it was probed or later.
 154  * This function is called on driver removal.
 155  */
 156 void devres_release_probe(struct udevice *dev);
 157
 158 /**
 159  * devres_release_all - Release all managed resources
 160  * @dev: Device to release resources for
 161  *
 162  * Release all resources associated with @dev.  This function is
 163  * called on driver unbinding.
 164  */
 165 void devres_release_all(struct udevice *dev);
 166
 167 #else /* ! CONFIG_DEVRES */
 168
 169 static inline void devres_release_probe(struct udevice *dev)
 170 {
 171 }
 172
 173 static inline void devres_release_all(struct udevice *dev)
 174 {
 175 }
 176
 177 #endif /* ! CONFIG_DEVRES */
 178 #endif