xref: /rk3399_rockchip-uboot/include/dm/device-internal.h (revision 00606d7e39da4a8ecfbbc19d5af252bdfdd1fcc9)
16494d708SSimon Glass /*
26494d708SSimon Glass  * Copyright (C) 2013 Google, Inc
36494d708SSimon Glass  *
46494d708SSimon Glass  * (C) Copyright 2012
56494d708SSimon Glass  * Pavel Herrmann <morpheus.ibis@gmail.com>
66494d708SSimon Glass  * Marek Vasut <marex@denx.de>
76494d708SSimon Glass  *
86494d708SSimon Glass  * SPDX-License-Identifier:	GPL-2.0+
96494d708SSimon Glass  */
106494d708SSimon Glass 
116494d708SSimon Glass #ifndef _DM_DEVICE_INTERNAL_H
126494d708SSimon Glass #define _DM_DEVICE_INTERNAL_H
136494d708SSimon Glass 
1454c5d08aSHeiko Schocher struct udevice;
156494d708SSimon Glass 
166494d708SSimon Glass /**
176494d708SSimon Glass  * device_bind() - Create a device and bind it to a driver
186494d708SSimon Glass  *
196494d708SSimon Glass  * Called to set up a new device attached to a driver. The device will either
206494d708SSimon Glass  * have platdata, or a device tree node which can be used to create the
216494d708SSimon Glass  * platdata.
226494d708SSimon Glass  *
236494d708SSimon Glass  * Once bound a device exists but is not yet active until device_probe() is
246494d708SSimon Glass  * called.
256494d708SSimon Glass  *
266494d708SSimon Glass  * @parent: Pointer to device's parent, under which this driver will exist
276494d708SSimon Glass  * @drv: Device's driver
286494d708SSimon Glass  * @name: Name of device (e.g. device tree node name)
296494d708SSimon Glass  * @platdata: Pointer to data for this device - the structure is device-
306494d708SSimon Glass  * specific but may include the device's I/O address, etc.. This is NULL for
316494d708SSimon Glass  * devices which use device tree.
326494d708SSimon Glass  * @of_offset: Offset of device tree node for this device. This is -1 for
336494d708SSimon Glass  * devices which don't use device tree.
346494d708SSimon Glass  * @devp: Returns a pointer to the bound device
356494d708SSimon Glass  * @return 0 if OK, -ve on error
366494d708SSimon Glass  */
3754c5d08aSHeiko Schocher int device_bind(struct udevice *parent, struct driver *drv,
386494d708SSimon Glass 		const char *name, void *platdata, int of_offset,
3954c5d08aSHeiko Schocher 		struct udevice **devp);
406494d708SSimon Glass 
416494d708SSimon Glass /**
426494d708SSimon Glass  * device_bind_by_name: Create a device and bind it to a driver
436494d708SSimon Glass  *
446494d708SSimon Glass  * This is a helper function used to bind devices which do not use device
456494d708SSimon Glass  * tree.
466494d708SSimon Glass  *
476494d708SSimon Glass  * @parent: Pointer to device's parent
48*00606d7eSSimon Glass  * @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set.
49*00606d7eSSimon Glass  * If false bind the driver always.
506494d708SSimon Glass  * @info: Name and platdata for this device
516494d708SSimon Glass  * @devp: Returns a pointer to the bound device
526494d708SSimon Glass  * @return 0 if OK, -ve on error
536494d708SSimon Glass  */
54*00606d7eSSimon Glass int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
55*00606d7eSSimon Glass 			const struct driver_info *info, struct udevice **devp);
566494d708SSimon Glass 
576494d708SSimon Glass /**
586494d708SSimon Glass  * device_probe() - Probe a device, activating it
596494d708SSimon Glass  *
606494d708SSimon Glass  * Activate a device so that it is ready for use. All its parents are probed
616494d708SSimon Glass  * first.
626494d708SSimon Glass  *
636494d708SSimon Glass  * @dev: Pointer to device to probe
646494d708SSimon Glass  * @return 0 if OK, -ve on error
656494d708SSimon Glass  */
6654c5d08aSHeiko Schocher int device_probe(struct udevice *dev);
676494d708SSimon Glass 
686494d708SSimon Glass /**
696494d708SSimon Glass  * device_remove() - Remove a device, de-activating it
706494d708SSimon Glass  *
716494d708SSimon Glass  * De-activate a device so that it is no longer ready for use. All its
726494d708SSimon Glass  * children are deactivated first.
736494d708SSimon Glass  *
746494d708SSimon Glass  * @dev: Pointer to device to remove
756494d708SSimon Glass  * @return 0 if OK, -ve on error (an error here is normally a very bad thing)
766494d708SSimon Glass  */
7754c5d08aSHeiko Schocher int device_remove(struct udevice *dev);
786494d708SSimon Glass 
796494d708SSimon Glass /**
806494d708SSimon Glass  * device_unbind() - Unbind a device, destroying it
816494d708SSimon Glass  *
826494d708SSimon Glass  * Unbind a device and remove all memory used by it
836494d708SSimon Glass  *
846494d708SSimon Glass  * @dev: Pointer to device to unbind
856494d708SSimon Glass  * @return 0 if OK, -ve on error
866494d708SSimon Glass  */
8754c5d08aSHeiko Schocher int device_unbind(struct udevice *dev);
886494d708SSimon Glass 
8989876a55SSimon Glass /* Cast away any volatile pointer */
9089876a55SSimon Glass #define DM_ROOT_NON_CONST		(((gd_t *)gd)->dm_root)
9189876a55SSimon Glass #define DM_UCLASS_ROOT_NON_CONST	(((gd_t *)gd)->uclass_root)
9289876a55SSimon Glass 
936494d708SSimon Glass #endif
94