xref: /openbmc/u-boot/drivers/core/root.c (revision cbd2fba1)
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 #include <common.h>
10 #include <errno.h>
11 #include <fdtdec.h>
12 #include <malloc.h>
13 #include <linux/libfdt.h>
14 #include <dm/device.h>
15 #include <dm/device-internal.h>
16 #include <dm/lists.h>
17 #include <dm/of.h>
18 #include <dm/of_access.h>
19 #include <dm/platdata.h>
20 #include <dm/read.h>
21 #include <dm/root.h>
22 #include <dm/uclass.h>
23 #include <dm/util.h>
24 #include <linux/list.h>
25 
26 DECLARE_GLOBAL_DATA_PTR;
27 
28 struct root_priv {
29 	fdt_addr_t translation_offset;	/* optional translation offset */
30 };
31 
32 static const struct driver_info root_info = {
33 	.name		= "root_driver",
34 };
35 
36 struct udevice *dm_root(void)
37 {
38 	if (!gd->dm_root) {
39 		dm_warn("Virtual root driver does not exist!\n");
40 		return NULL;
41 	}
42 
43 	return gd->dm_root;
44 }
45 
46 void dm_fixup_for_gd_move(struct global_data *new_gd)
47 {
48 	/* The sentinel node has moved, so update things that point to it */
49 	if (gd->dm_root) {
50 		new_gd->uclass_root.next->prev = &new_gd->uclass_root;
51 		new_gd->uclass_root.prev->next = &new_gd->uclass_root;
52 	}
53 }
54 
55 fdt_addr_t dm_get_translation_offset(void)
56 {
57 	struct udevice *root = dm_root();
58 	struct root_priv *priv = dev_get_priv(root);
59 
60 	return priv->translation_offset;
61 }
62 
63 void dm_set_translation_offset(fdt_addr_t offs)
64 {
65 	struct udevice *root = dm_root();
66 	struct root_priv *priv = dev_get_priv(root);
67 
68 	priv->translation_offset = offs;
69 }
70 
71 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
72 void fix_drivers(void)
73 {
74 	struct driver *drv =
75 		ll_entry_start(struct driver, driver);
76 	const int n_ents = ll_entry_count(struct driver, driver);
77 	struct driver *entry;
78 
79 	for (entry = drv; entry != drv + n_ents; entry++) {
80 		if (entry->of_match)
81 			entry->of_match = (const struct udevice_id *)
82 				((u32)entry->of_match + gd->reloc_off);
83 		if (entry->bind)
84 			entry->bind += gd->reloc_off;
85 		if (entry->probe)
86 			entry->probe += gd->reloc_off;
87 		if (entry->remove)
88 			entry->remove += gd->reloc_off;
89 		if (entry->unbind)
90 			entry->unbind += gd->reloc_off;
91 		if (entry->ofdata_to_platdata)
92 			entry->ofdata_to_platdata += gd->reloc_off;
93 		if (entry->child_post_bind)
94 			entry->child_post_bind += gd->reloc_off;
95 		if (entry->child_pre_probe)
96 			entry->child_pre_probe += gd->reloc_off;
97 		if (entry->child_post_remove)
98 			entry->child_post_remove += gd->reloc_off;
99 		/* OPS are fixed in every uclass post_probe function */
100 		if (entry->ops)
101 			entry->ops += gd->reloc_off;
102 	}
103 }
104 
105 void fix_uclass(void)
106 {
107 	struct uclass_driver *uclass =
108 		ll_entry_start(struct uclass_driver, uclass);
109 	const int n_ents = ll_entry_count(struct uclass_driver, uclass);
110 	struct uclass_driver *entry;
111 
112 	for (entry = uclass; entry != uclass + n_ents; entry++) {
113 		if (entry->post_bind)
114 			entry->post_bind += gd->reloc_off;
115 		if (entry->pre_unbind)
116 			entry->pre_unbind += gd->reloc_off;
117 		if (entry->pre_probe)
118 			entry->pre_probe += gd->reloc_off;
119 		if (entry->post_probe)
120 			entry->post_probe += gd->reloc_off;
121 		if (entry->pre_remove)
122 			entry->pre_remove += gd->reloc_off;
123 		if (entry->child_post_bind)
124 			entry->child_post_bind += gd->reloc_off;
125 		if (entry->child_pre_probe)
126 			entry->child_pre_probe += gd->reloc_off;
127 		if (entry->init)
128 			entry->init += gd->reloc_off;
129 		if (entry->destroy)
130 			entry->destroy += gd->reloc_off;
131 		/* FIXME maybe also need to fix these ops */
132 		if (entry->ops)
133 			entry->ops += gd->reloc_off;
134 	}
135 }
136 
137 void fix_devices(void)
138 {
139 	struct driver_info *dev =
140 		ll_entry_start(struct driver_info, driver_info);
141 	const int n_ents = ll_entry_count(struct driver_info, driver_info);
142 	struct driver_info *entry;
143 
144 	for (entry = dev; entry != dev + n_ents; entry++) {
145 		if (entry->platdata)
146 			entry->platdata += gd->reloc_off;
147 	}
148 }
149 
150 #endif
151 
152 int dm_init(bool of_live)
153 {
154 	int ret;
155 
156 	if (gd->dm_root) {
157 		dm_warn("Virtual root driver already exists!\n");
158 		return -EINVAL;
159 	}
160 	INIT_LIST_HEAD(&DM_UCLASS_ROOT_NON_CONST);
161 
162 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
163 	fix_drivers();
164 	fix_uclass();
165 	fix_devices();
166 #endif
167 
168 	ret = device_bind_by_name(NULL, false, &root_info, &DM_ROOT_NON_CONST);
169 	if (ret)
170 		return ret;
171 #if CONFIG_IS_ENABLED(OF_CONTROL)
172 # if CONFIG_IS_ENABLED(OF_LIVE)
173 	if (of_live)
174 		DM_ROOT_NON_CONST->node = np_to_ofnode(gd->of_root);
175 	else
176 #endif
177 		DM_ROOT_NON_CONST->node = offset_to_ofnode(0);
178 #endif
179 	ret = device_probe(DM_ROOT_NON_CONST);
180 	if (ret)
181 		return ret;
182 
183 	return 0;
184 }
185 
186 int dm_uninit(void)
187 {
188 	device_remove(dm_root(), DM_REMOVE_NORMAL);
189 	device_unbind(dm_root());
190 
191 	return 0;
192 }
193 
194 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
195 int dm_remove_devices_flags(uint flags)
196 {
197 	device_remove(dm_root(), flags);
198 
199 	return 0;
200 }
201 #endif
202 
203 int dm_scan_platdata(bool pre_reloc_only)
204 {
205 	int ret;
206 
207 	ret = lists_bind_drivers(DM_ROOT_NON_CONST, pre_reloc_only);
208 	if (ret == -ENOENT) {
209 		dm_warn("Some drivers were not found\n");
210 		ret = 0;
211 	}
212 
213 	return ret;
214 }
215 
216 #if CONFIG_IS_ENABLED(OF_LIVE)
217 static int dm_scan_fdt_live(struct udevice *parent,
218 			    const struct device_node *node_parent,
219 			    bool pre_reloc_only)
220 {
221 	struct device_node *np;
222 	int ret = 0, err;
223 
224 	for (np = node_parent->child; np; np = np->sibling) {
225 		/* "chosen" node isn't a device itself but may contain some: */
226 		if (!strcmp(np->name, "chosen")) {
227 			pr_debug("parsing subnodes of \"chosen\"\n");
228 
229 			err = dm_scan_fdt_live(parent, np, pre_reloc_only);
230 			if (err && !ret)
231 				ret = err;
232 			continue;
233 		}
234 
235 		if (!of_device_is_available(np)) {
236 			pr_debug("   - ignoring disabled device\n");
237 			continue;
238 		}
239 		err = lists_bind_fdt(parent, np_to_ofnode(np), NULL,
240 				     pre_reloc_only);
241 		if (err && !ret) {
242 			ret = err;
243 			debug("%s: ret=%d\n", np->name, ret);
244 		}
245 	}
246 
247 	if (ret)
248 		dm_warn("Some drivers failed to bind\n");
249 
250 	return ret;
251 }
252 #endif /* CONFIG_IS_ENABLED(OF_LIVE) */
253 
254 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
255 /**
256  * dm_scan_fdt_node() - Scan the device tree and bind drivers for a node
257  *
258  * This scans the subnodes of a device tree node and and creates a driver
259  * for each one.
260  *
261  * @parent: Parent device for the devices that will be created
262  * @blob: Pointer to device tree blob
263  * @offset: Offset of node to scan
264  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
265  * flag. If false bind all drivers.
266  * @return 0 if OK, -ve on error
267  */
268 static int dm_scan_fdt_node(struct udevice *parent, const void *blob,
269 			    int offset, bool pre_reloc_only)
270 {
271 	int ret = 0, err;
272 
273 	for (offset = fdt_first_subnode(blob, offset);
274 	     offset > 0;
275 	     offset = fdt_next_subnode(blob, offset)) {
276 		const char *node_name = fdt_get_name(blob, offset, NULL);
277 
278 		/*
279 		 * The "chosen" and "firmware" nodes aren't devices
280 		 * themselves but may contain some:
281 		 */
282 		if (!strcmp(node_name, "chosen") ||
283 		    !strcmp(node_name, "firmware")) {
284 			pr_debug("parsing subnodes of \"%s\"\n", node_name);
285 
286 			err = dm_scan_fdt_node(parent, blob, offset,
287 					       pre_reloc_only);
288 			if (err && !ret)
289 				ret = err;
290 			continue;
291 		}
292 
293 		if (!fdtdec_get_is_enabled(blob, offset)) {
294 			pr_debug("   - ignoring disabled device\n");
295 			continue;
296 		}
297 		err = lists_bind_fdt(parent, offset_to_ofnode(offset), NULL,
298 				     pre_reloc_only);
299 		if (err && !ret) {
300 			ret = err;
301 			debug("%s: ret=%d\n", node_name, ret);
302 		}
303 	}
304 
305 	if (ret)
306 		dm_warn("Some drivers failed to bind\n");
307 
308 	return ret;
309 }
310 
311 int dm_scan_fdt_dev(struct udevice *dev)
312 {
313 	if (!dev_of_valid(dev))
314 		return 0;
315 
316 #if CONFIG_IS_ENABLED(OF_LIVE)
317 	if (of_live_active())
318 		return dm_scan_fdt_live(dev, dev_np(dev),
319 				gd->flags & GD_FLG_RELOC ? false : true);
320 	else
321 #endif
322 	return dm_scan_fdt_node(dev, gd->fdt_blob, dev_of_offset(dev),
323 				gd->flags & GD_FLG_RELOC ? false : true);
324 }
325 
326 int dm_scan_fdt(const void *blob, bool pre_reloc_only)
327 {
328 #if CONFIG_IS_ENABLED(OF_LIVE)
329 	if (of_live_active())
330 		return dm_scan_fdt_live(gd->dm_root, gd->of_root,
331 					pre_reloc_only);
332 	else
333 #endif
334 	return dm_scan_fdt_node(gd->dm_root, blob, 0, pre_reloc_only);
335 }
336 #else
337 static int dm_scan_fdt_node(struct udevice *parent, const void *blob,
338 			    int offset, bool pre_reloc_only)
339 {
340 	return 0;
341 }
342 #endif
343 
344 static int dm_scan_fdt_ofnode_path(const char *path, bool pre_reloc_only)
345 {
346 	ofnode node;
347 
348 	node = ofnode_path(path);
349 	if (!ofnode_valid(node))
350 		return 0;
351 
352 #if CONFIG_IS_ENABLED(OF_LIVE)
353 	if (of_live_active())
354 		return dm_scan_fdt_live(gd->dm_root, node.np, pre_reloc_only);
355 #endif
356 	return dm_scan_fdt_node(gd->dm_root, gd->fdt_blob, node.of_offset,
357 				pre_reloc_only);
358 }
359 
360 int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only)
361 {
362 	int ret;
363 
364 	ret = dm_scan_fdt(gd->fdt_blob, pre_reloc_only);
365 	if (ret) {
366 		debug("dm_scan_fdt() failed: %d\n", ret);
367 		return ret;
368 	}
369 
370 	ret = dm_scan_fdt_ofnode_path("/clocks", pre_reloc_only);
371 	if (ret) {
372 		debug("scan for /clocks failed: %d\n", ret);
373 		return ret;
374 	}
375 
376 	ret = dm_scan_fdt_ofnode_path("/firmware", pre_reloc_only);
377 	if (ret)
378 		debug("scan for /firmware failed: %d\n", ret);
379 
380 	return ret;
381 }
382 
383 __weak int dm_scan_other(bool pre_reloc_only)
384 {
385 	return 0;
386 }
387 
388 int dm_init_and_scan(bool pre_reloc_only)
389 {
390 	int ret;
391 
392 	ret = dm_init(IS_ENABLED(CONFIG_OF_LIVE));
393 	if (ret) {
394 		debug("dm_init() failed: %d\n", ret);
395 		return ret;
396 	}
397 	ret = dm_scan_platdata(pre_reloc_only);
398 	if (ret) {
399 		debug("dm_scan_platdata() failed: %d\n", ret);
400 		return ret;
401 	}
402 
403 	if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
404 		ret = dm_extended_scan_fdt(gd->fdt_blob, pre_reloc_only);
405 		if (ret) {
406 			debug("dm_extended_scan_dt() failed: %d\n", ret);
407 			return ret;
408 		}
409 	}
410 
411 	ret = dm_scan_other(pre_reloc_only);
412 	if (ret)
413 		return ret;
414 
415 	return 0;
416 }
417 
418 /* This is the root driver - all drivers are children of this */
419 U_BOOT_DRIVER(root_driver) = {
420 	.name	= "root_driver",
421 	.id	= UCLASS_ROOT,
422 	.priv_auto_alloc_size = sizeof(struct root_priv),
423 };
424 
425 /* This is the root uclass */
426 UCLASS_DRIVER(root) = {
427 	.name	= "root",
428 	.id	= UCLASS_ROOT,
429 };
430