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 struct udevice; 15 16 /** 17 * device_bind() - Create a device and bind it to a driver 18 * 19 * Called to set up a new device attached to a driver. The device will either 20 * have platdata, or a device tree node which can be used to create the 21 * platdata. 22 * 23 * Once bound a device exists but is not yet active until device_probe() is 24 * called. 25 * 26 * @parent: Pointer to device's parent, under which this driver will exist 27 * @drv: Device's driver 28 * @name: Name of device (e.g. device tree node name) 29 * @platdata: Pointer to data for this device - the structure is device- 30 * specific but may include the device's I/O address, etc.. This is NULL for 31 * devices which use device tree. 32 * @of_offset: Offset of device tree node for this device. This is -1 for 33 * devices which don't use device tree. 34 * @devp: if non-NULL, returns a pointer to the bound device 35 * @return 0 if OK, -ve on error 36 */ 37 int device_bind(struct udevice *parent, const struct driver *drv, 38 const char *name, void *platdata, int of_offset, 39 struct udevice **devp); 40 41 /** 42 * device_bind_by_name: Create a device and bind it to a driver 43 * 44 * This is a helper function used to bind devices which do not use device 45 * tree. 46 * 47 * @parent: Pointer to device's parent 48 * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set. 49 * If false bind the driver always. 50 * @info: Name and platdata for this device 51 * @devp: if non-NULL, returns a pointer to the bound device 52 * @return 0 if OK, -ve on error 53 */ 54 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, 55 const struct driver_info *info, struct udevice **devp); 56 57 /** 58 * device_probe() - Probe a device, activating it 59 * 60 * Activate a device so that it is ready for use. All its parents are probed 61 * first. 62 * 63 * @dev: Pointer to device to probe 64 * @return 0 if OK, -ve on error 65 */ 66 int device_probe(struct udevice *dev); 67 68 /** 69 * device_remove() - Remove a device, de-activating it 70 * 71 * De-activate a device so that it is no longer ready for use. All its 72 * children are deactivated first. 73 * 74 * @dev: Pointer to device to remove 75 * @return 0 if OK, -ve on error (an error here is normally a very bad thing) 76 */ 77 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 78 int device_remove(struct udevice *dev); 79 #else 80 static inline int device_remove(struct udevice *dev) { return 0; } 81 #endif 82 83 /** 84 * device_unbind() - Unbind a device, destroying it 85 * 86 * Unbind a device and remove all memory used by it 87 * 88 * @dev: Pointer to device to unbind 89 * @return 0 if OK, -ve on error 90 */ 91 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 92 int device_unbind(struct udevice *dev); 93 #else 94 static inline int device_unbind(struct udevice *dev) { return 0; } 95 #endif 96 97 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) 98 void device_free(struct udevice *dev); 99 #else 100 static inline void device_free(struct udevice *dev) {} 101 #endif 102 103 /** 104 * simple_bus_translate() - translate a bus address to a system address 105 * 106 * This handles the 'ranges' property in a simple bus. It translates the 107 * device address @addr to a system address using this property. 108 * 109 * @dev: Simple bus device (parent of target device) 110 * @addr: Address to translate 111 * @return new address 112 */ 113 fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr); 114 115 /* Cast away any volatile pointer */ 116 #define DM_ROOT_NON_CONST (((gd_t *)gd)->dm_root) 117 #define DM_UCLASS_ROOT_NON_CONST (((gd_t *)gd)->uclass_root) 118 119 /* device resource management */ 120 #ifdef CONFIG_DEVRES 121 122 /** 123 * devres_release_probe - Release managed resources allocated after probing 124 * @dev: Device to release resources for 125 * 126 * Release all resources allocated for @dev when it was probed or later. 127 * This function is called on driver removal. 128 */ 129 void devres_release_probe(struct udevice *dev); 130 131 /** 132 * devres_release_all - Release all managed resources 133 * @dev: Device to release resources for 134 * 135 * Release all resources associated with @dev. This function is 136 * called on driver unbinding. 137 */ 138 void devres_release_all(struct udevice *dev); 139 140 #else /* ! CONFIG_DEVRES */ 141 142 static inline void devres_release_probe(struct udevice *dev) 143 { 144 } 145 146 static inline void devres_release_all(struct udevice *dev) 147 { 148 } 149 150 #endif /* ! CONFIG_DEVRES */ 151 #endif 152