| Simon Glass | dd6ab88 | 2014-02-26 15:59:18 -0700 | [diff] [blame] | 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 device; |
| 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: Returns a pointer to the bound device |
| 35 | * @return 0 if OK, -ve on error |
| 36 | */ |
| 37 | int device_bind(struct device *parent, struct driver *drv, |
| 38 | const char *name, void *platdata, int of_offset, |
| 39 | struct device **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 | * @info: Name and platdata for this device |
| 49 | * @devp: Returns a pointer to the bound device |
| 50 | * @return 0 if OK, -ve on error |
| 51 | */ |
| 52 | int device_bind_by_name(struct device *parent, const struct driver_info *info, |
| 53 | struct device **devp); |
| 54 | |
| 55 | /** |
| 56 | * device_probe() - Probe a device, activating it |
| 57 | * |
| 58 | * Activate a device so that it is ready for use. All its parents are probed |
| 59 | * first. |
| 60 | * |
| 61 | * @dev: Pointer to device to probe |
| 62 | * @return 0 if OK, -ve on error |
| 63 | */ |
| 64 | int device_probe(struct device *dev); |
| 65 | |
| 66 | /** |
| 67 | * device_remove() - Remove a device, de-activating it |
| 68 | * |
| 69 | * De-activate a device so that it is no longer ready for use. All its |
| 70 | * children are deactivated first. |
| 71 | * |
| 72 | * @dev: Pointer to device to remove |
| 73 | * @return 0 if OK, -ve on error (an error here is normally a very bad thing) |
| 74 | */ |
| 75 | int device_remove(struct device *dev); |
| 76 | |
| 77 | /** |
| 78 | * device_unbind() - Unbind a device, destroying it |
| 79 | * |
| 80 | * Unbind a device and remove all memory used by it |
| 81 | * |
| 82 | * @dev: Pointer to device to unbind |
| 83 | * @return 0 if OK, -ve on error |
| 84 | */ |
| 85 | int device_unbind(struct device *dev); |
| 86 | |
| 87 | #endif |