1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * Copyright (c) 2013 Google, Inc
4 *
5 * (C) Copyright 2012
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 */
8
9 #ifndef _DM_ROOT_H_
10 #define _DM_ROOT_H_
11
12 struct udevice;
13
14 /**
15 * dm_root() - Return pointer to the top of the driver tree
16 *
17 * This function returns pointer to the root node of the driver tree,
18 *
19 * @return pointer to root device, or NULL if not inited yet
20 */
21 struct udevice *dm_root(void);
22
23 struct global_data;
24 /**
25 * dm_fixup_for_gd_move() - Handle global_data moving to a new place
26 *
27 * The uclass list is part of global_data. Due to the way lists work, moving
28 * the list will cause it to become invalid. This function fixes that up so
29 * that the uclass list will work correctly.
30 */
31 void dm_fixup_for_gd_move(struct global_data *new_gd);
32
33 /**
34 * dm_scan_plat() - Scan all platform data and bind drivers
35 *
36 * This scans all available plat and creates drivers for each
37 *
38 * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
39 * flag. If false bind all drivers.
40 * @return 0 if OK, -ve on error
41 */
42 int dm_scan_plat(bool pre_reloc_only);
43
44 /**
45 * dm_scan_fdt() - Scan the device tree and bind drivers
46 *
47 * This scans the device tree and creates a driver for each node. Only
48 * the top-level subnodes are examined.
49 *
50 * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
51 * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
52 * @return 0 if OK, -ve on error
53 */
54 int dm_scan_fdt(bool pre_reloc_only);
55
56 /**
57 * dm_extended_scan() - Scan the device tree and bind drivers
58 *
59 * This calls dm_scna_dft() which scans the device tree and creates a driver
60 * for each node. the top-level subnodes are examined and also all sub-nodes
61 * of "clocks" node.
62 *
63 * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
64 * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
65 * @return 0 if OK, -ve on error
66 */
67 int dm_extended_scan(bool pre_reloc_only);
68
69 /**
70 * dm_scan_other() - Scan for other devices
71 *
72 * Some devices may not be visible to Driver Model. This weak function can
73 * be provided by boards which wish to create their own devices
74 * programmaticaly. They should do this by calling device_bind() on each
75 * device.
76 *
77 * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
78 * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
79 * @return 0 if OK, -ve on error
80 */
81 int dm_scan_other(bool pre_reloc_only);
82
83 /**
84 * dm_init_and_scan() - Initialise Driver Model structures and scan for devices
85 *
86 * This function initialises the roots of the driver tree and uclass trees,
87 * then scans and binds available devices from platform data and the FDT.
88 * This calls dm_init() to set up Driver Model structures.
89 *
90 * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
91 * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
92 * @return 0 if OK, -ve on error
93 */
94 int dm_init_and_scan(bool pre_reloc_only);
95
96 /**
97 * dm_init() - Initialise Driver Model structures
98 *
99 * This function will initialize roots of driver tree and class tree.
100 * This needs to be called before anything uses the DM
101 *
102 * @of_live: Enable live device tree
103 * @return 0 if OK, -ve on error
104 */
105 int dm_init(bool of_live);
106
107 /**
108 * dm_uninit - Uninitialise Driver Model structures
109 *
110 * All devices will be removed and unbound
111 * @return 0 if OK, -ve on error
112 */
113 int dm_uninit(void);
114
115 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
116 /**
117 * dm_remove_devices_flags - Call remove function of all drivers with
118 * specific removal flags set to selectively
119 * remove drivers
120 *
121 * All devices with the matching flags set will be removed
122 *
123 * @flags: Flags for selective device removal
124 * @return 0 if OK, -ve on error
125 */
126 int dm_remove_devices_flags(uint flags);
127 #else
dm_remove_devices_flags(uint flags)128 static inline int dm_remove_devices_flags(uint flags) { return 0; }
129 #endif
130
131 #endif
132