1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013 Google, Inc
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
9 #define LOG_CATEGORY UCLASS_ROOT
16 #include <asm-generic/sections.h>
17 #include <asm/global_data.h>
18 #include <linux/libfdt.h>
20 #include <dm/device.h>
21 #include <dm/device-internal.h>
24 #include <dm/of_access.h>
25 #include <dm/platdata.h>
28 #include <dm/uclass.h>
29 #include <dm/uclass-internal.h>
31 #include <linux/list.h>
33 DECLARE_GLOBAL_DATA_PTR;
35 static struct driver_info root_info = {
36 .name = "root_driver",
39 struct udevice *dm_root(void)
42 dm_warn("Virtual root driver does not exist!\n");
49 void dm_fixup_for_gd_move(struct global_data *new_gd)
51 /* The sentinel node has moved, so update things that point to it */
53 new_gd->uclass_root->next->prev = new_gd->uclass_root;
54 new_gd->uclass_root->prev->next = new_gd->uclass_root;
58 void fix_drivers(void)
61 ll_entry_start(struct driver, driver);
62 const int n_ents = ll_entry_count(struct driver, driver);
65 for (entry = drv; entry != drv + n_ents; entry++) {
67 entry->of_match = (const struct udevice_id *)
68 ((ulong)entry->of_match + gd->reloc_off);
70 entry->bind += gd->reloc_off;
72 entry->probe += gd->reloc_off;
74 entry->remove += gd->reloc_off;
76 entry->unbind += gd->reloc_off;
77 if (entry->of_to_plat)
78 entry->of_to_plat += gd->reloc_off;
79 if (entry->child_post_bind)
80 entry->child_post_bind += gd->reloc_off;
81 if (entry->child_pre_probe)
82 entry->child_pre_probe += gd->reloc_off;
83 if (entry->child_post_remove)
84 entry->child_post_remove += gd->reloc_off;
85 /* OPS are fixed in every uclass post_probe function */
87 entry->ops += gd->reloc_off;
93 struct uclass_driver *uclass =
94 ll_entry_start(struct uclass_driver, uclass_driver);
95 const int n_ents = ll_entry_count(struct uclass_driver, uclass_driver);
96 struct uclass_driver *entry;
98 for (entry = uclass; entry != uclass + n_ents; entry++) {
100 entry->post_bind += gd->reloc_off;
101 if (entry->pre_unbind)
102 entry->pre_unbind += gd->reloc_off;
103 if (entry->pre_probe)
104 entry->pre_probe += gd->reloc_off;
105 if (entry->post_probe)
106 entry->post_probe += gd->reloc_off;
107 if (entry->pre_remove)
108 entry->pre_remove += gd->reloc_off;
109 if (entry->child_post_bind)
110 entry->child_post_bind += gd->reloc_off;
111 if (entry->child_pre_probe)
112 entry->child_pre_probe += gd->reloc_off;
114 entry->init += gd->reloc_off;
116 entry->destroy += gd->reloc_off;
120 void fix_devices(void)
122 struct driver_info *dev =
123 ll_entry_start(struct driver_info, driver_info);
124 const int n_ents = ll_entry_count(struct driver_info, driver_info);
125 struct driver_info *entry;
127 for (entry = dev; entry != dev + n_ents; entry++) {
129 entry->plat += gd->reloc_off;
133 static int dm_setup_inst(void)
135 DM_ROOT_NON_CONST = DM_DEVICE_GET(root);
137 if (CONFIG_IS_ENABLED(OF_PLATDATA_RT)) {
138 struct udevice_rt *urt;
145 /* Allocate the udevice_rt table */
146 each_size = dm_udevice_size();
147 start = ll_entry_start(struct udevice, udevice);
148 end = ll_entry_end(struct udevice, udevice);
150 n_ents = size / each_size;
151 urt = calloc(n_ents, sizeof(struct udevice_rt));
153 return log_msg_ret("urt", -ENOMEM);
154 gd_set_dm_udevice_rt(urt);
156 /* Now allocate space for the priv/plat data, and copy it in */
157 size = __priv_data_end - __priv_data_start;
159 base = calloc(1, size);
161 return log_msg_ret("priv", -ENOMEM);
162 memcpy(base, __priv_data_start, size);
163 gd_set_dm_priv_base(base);
169 int dm_init(bool of_live)
174 dm_warn("Virtual root driver already exists!\n");
177 if (CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
178 gd->uclass_root = &uclass_head;
180 gd->uclass_root = &DM_UCLASS_ROOT_S_NON_CONST;
181 INIT_LIST_HEAD(DM_UCLASS_ROOT_NON_CONST);
184 if (IS_ENABLED(CONFIG_NEEDS_MANUAL_RELOC)) {
190 if (CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
191 ret = dm_setup_inst();
193 log_debug("dm_setup_inst() failed: %d\n", ret);
197 ret = device_bind_by_name(NULL, false, &root_info,
201 if (CONFIG_IS_ENABLED(OF_CONTROL))
202 dev_set_ofnode(DM_ROOT_NON_CONST, ofnode_root());
203 ret = device_probe(DM_ROOT_NON_CONST);
208 INIT_LIST_HEAD((struct list_head *)&gd->dmtag_list);
215 /* Remove non-vital devices first */
216 device_remove(dm_root(), DM_REMOVE_NON_VITAL);
217 device_remove(dm_root(), DM_REMOVE_NORMAL);
218 device_unbind(dm_root());
224 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
225 int dm_remove_devices_flags(uint flags)
227 device_remove(dm_root(), flags);
233 int dm_scan_plat(bool pre_reloc_only)
237 if (CONFIG_IS_ENABLED(OF_PLATDATA_DRIVER_RT)) {
238 struct driver_rt *dyn;
241 n_ents = ll_entry_count(struct driver_info, driver_info);
242 dyn = calloc(n_ents, sizeof(struct driver_rt));
245 gd_set_dm_driver_rt(dyn);
248 ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
249 if (ret == -ENOENT) {
250 dm_warn("Some drivers were not found\n");
257 #if CONFIG_IS_ENABLED(OF_REAL)
259 * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
261 * This scans the subnodes of a device tree node and and creates a driver
264 * @parent: Parent device for the devices that will be created
265 * @node: Node to scan
266 * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
267 * flag. If false bind all drivers.
268 * Return: 0 if OK, -ve on error
270 static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node,
273 int ret = 0, err = 0;
276 if (!ofnode_valid(parent_node))
279 for (node = ofnode_first_subnode(parent_node);
281 node = ofnode_next_subnode(node)) {
282 const char *node_name = ofnode_get_name(node);
284 if (!ofnode_is_enabled(node)) {
285 pr_debug(" - ignoring disabled device\n");
288 err = lists_bind_fdt(parent, node, NULL, NULL, pre_reloc_only);
291 debug("%s: ret=%d\n", node_name, ret);
296 dm_warn("Some drivers failed to bind\n");
301 int dm_scan_fdt_dev(struct udevice *dev)
303 return dm_scan_fdt_node(dev, dev_ofnode(dev),
304 gd->flags & GD_FLG_RELOC ? false : true);
307 int dm_scan_fdt(bool pre_reloc_only)
309 return dm_scan_fdt_node(gd->dm_root, ofnode_root(), pre_reloc_only);
312 static int dm_scan_fdt_ofnode_path(const char *path, bool pre_reloc_only)
316 node = ofnode_path(path);
318 return dm_scan_fdt_node(gd->dm_root, node, pre_reloc_only);
321 int dm_extended_scan(bool pre_reloc_only)
324 const char * const nodes[] = {
330 ret = dm_scan_fdt(pre_reloc_only);
332 debug("dm_scan_fdt() failed: %d\n", ret);
336 /* Some nodes aren't devices themselves but may contain some */
337 for (i = 0; i < ARRAY_SIZE(nodes); i++) {
338 ret = dm_scan_fdt_ofnode_path(nodes[i], pre_reloc_only);
340 debug("dm_scan_fdt() scan for %s failed: %d\n",
350 __weak int dm_scan_other(bool pre_reloc_only)
355 #if CONFIG_IS_ENABLED(OF_PLATDATA_INST) && CONFIG_IS_ENABLED(READ_ONLY)
356 void *dm_priv_to_rw(void *priv)
358 long offset = priv - (void *)__priv_data_start;
360 return gd_dm_priv_base() + offset;
364 static int dm_probe_devices(struct udevice *dev, bool pre_reloc_only)
366 u32 mask = DM_FLAG_PROBE_AFTER_BIND;
367 u32 flags = dev_get_flags(dev);
368 struct udevice *child;
372 mask |= DM_FLAG_PRE_RELOC;
374 if ((flags & mask) == mask) {
375 ret = device_probe(dev);
380 list_for_each_entry(child, &dev->child_head, sibling_node)
381 dm_probe_devices(child, pre_reloc_only);
387 * dm_scan() - Scan tables to bind devices
389 * Runs through the driver_info tables and binds the devices it finds. Then runs
390 * through the devicetree nodes. Finally calls dm_scan_other() to add any
393 * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
394 * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
396 static int dm_scan(bool pre_reloc_only)
400 ret = dm_scan_plat(pre_reloc_only);
402 debug("dm_scan_plat() failed: %d\n", ret);
406 if (CONFIG_IS_ENABLED(OF_REAL)) {
407 ret = dm_extended_scan(pre_reloc_only);
409 debug("dm_extended_scan() failed: %d\n", ret);
414 ret = dm_scan_other(pre_reloc_only);
418 return dm_probe_devices(gd->dm_root, pre_reloc_only);
421 int dm_init_and_scan(bool pre_reloc_only)
425 ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
427 debug("dm_init() failed: %d\n", ret);
430 if (!CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
431 ret = dm_scan(pre_reloc_only);
433 log_debug("dm_scan() failed: %d\n", ret);
437 if (CONFIG_IS_ENABLED(DM_EVENT)) {
438 ret = event_notify_null(EVT_DM_POST_INIT);
440 return log_msg_ret("ev", ret);
446 void dm_get_stats(int *device_countp, int *uclass_countp)
448 *device_countp = device_get_decendent_count(gd->dm_root);
449 *uclass_countp = uclass_get_count();
452 void dev_collect_stats(struct dm_stats *stats, const struct udevice *parent)
454 const struct udevice *dev;
458 stats->dev_size += sizeof(struct udevice);
459 stats->dev_name_size += strlen(parent->name) + 1;
460 for (i = 0; i < DM_TAG_ATTACH_COUNT; i++) {
461 int size = dev_get_attach_size(parent, i);
464 (i == DM_TAG_DRIVER_DATA && parent->driver_data)) {
465 stats->attach_count[i]++;
466 stats->attach_size[i] += size;
467 stats->attach_count_total++;
468 stats->attach_size_total += size;
472 list_for_each_entry(dev, &parent->child_head, sibling_node)
473 dev_collect_stats(stats, dev);
476 void uclass_collect_stats(struct dm_stats *stats)
480 list_for_each_entry(uc, gd->uclass_root, sibling_node) {
484 stats->uc_size += sizeof(struct uclass);
485 size = uc->uc_drv->priv_auto;
487 stats->uc_attach_count++;
488 stats->uc_attach_size += size;
493 void dm_get_mem(struct dm_stats *stats)
495 memset(stats, '\0', sizeof(*stats));
496 dev_collect_stats(stats, gd->dm_root);
497 uclass_collect_stats(stats);
498 dev_tag_collect_stats(stats);
500 stats->total_size = stats->dev_size + stats->uc_size +
501 stats->attach_size_total + stats->uc_attach_size +
505 #ifdef CONFIG_ACPIGEN
506 static int root_acpi_get_name(const struct udevice *dev, char *out_name)
508 return acpi_copy_name(out_name, "\\_SB");
511 struct acpi_ops root_acpi_ops = {
512 .get_name = root_acpi_get_name,
516 /* This is the root driver - all drivers are children of this */
517 U_BOOT_DRIVER(root_driver) = {
518 .name = "root_driver",
520 ACPI_OPS_PTR(&root_acpi_ops)
523 /* This is the root uclass */
524 UCLASS_DRIVER(root) = {