dm: Support driver model prior to relocation
[platform/kernel/u-boot.git] / include / dm / root.h
1 /*
2  * Copyright (c) 2013 Google, Inc
3  *
4  * (C) Copyright 2012
5  * Pavel Herrmann <morpheus.ibis@gmail.com>
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  */
9
10 #ifndef _DM_ROOT_H_
11 #define _DM_ROOT_H_
12
13 struct udevice;
14
15 /**
16  * dm_root() - Return pointer to the top of the driver tree
17  *
18  * This function returns pointer to the root node of the driver tree,
19  *
20  * @return pointer to root device, or NULL if not inited yet
21  */
22 struct udevice *dm_root(void);
23
24 /**
25  * dm_scan_platdata() - Scan all platform data and bind drivers
26  *
27  * This scans all available platdata and creates drivers for each
28  *
29  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
30  * flag. If false bind all drivers.
31  * @return 0 if OK, -ve on error
32  */
33 int dm_scan_platdata(bool pre_reloc_only);
34
35 /**
36  * dm_scan_fdt() - Scan the device tree and bind drivers
37  *
38  * This scans the device tree and creates a driver for each node
39  *
40  * @blob: Pointer to device tree blob
41  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
42  * flag. If false bind all drivers.
43  * @return 0 if OK, -ve on error
44  */
45 int dm_scan_fdt(const void *blob, bool pre_reloc_only);
46
47 /**
48  * dm_init_and_scan() - Initialise Driver Model structures and scan for devices
49  *
50  * This function initialises the roots of the driver tree and uclass trees,
51  * then scans and binds available devices from platform data and the FDT.
52  * This calls dm_init() to set up Driver Model structures.
53  *
54  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
55  * flag. If false bind all drivers.
56  * @return 0 if OK, -ve on error
57  */
58 int dm_init_and_scan(bool pre_reloc_only);
59
60 /**
61  * dm_init() - Initialise Driver Model structures
62  *
63  * This function will initialize roots of driver tree and class tree.
64  * This needs to be called before anything uses the DM
65  *
66  * @return 0 if OK, -ve on error
67  */
68 int dm_init(void);
69
70 /**
71  * dm_uninit - Uninitialise Driver Model structures
72  *
73  * All devices will be removed and unbound
74  * @return 0 if OK, -ve on error
75  */
76 int dm_uninit(void);
77
78 #endif