xref: /openbmc/u-boot/drivers/core/device.c (revision fc5ad477) 
1 /*
2  * Device manager
3  *
4  * Copyright (c) 2013 Google, Inc
5  *
6  * (C) Copyright 2012
7  * Pavel Herrmann <morpheus.ibis@gmail.com>
8  *
9  * SPDX-License-Identifier:	GPL-2.0+
10  */
11 
12 #include <common.h>
13 #include <fdtdec.h>
14 #include <fdt_support.h>
15 #include <malloc.h>
16 #include <dm/device.h>
17 #include <dm/device-internal.h>
18 #include <dm/lists.h>
19 #include <dm/pinctrl.h>
20 #include <dm/platdata.h>
21 #include <dm/uclass.h>
22 #include <dm/uclass-internal.h>
23 #include <dm/util.h>
24 #include <linux/err.h>
25 #include <linux/list.h>
26 
27 DECLARE_GLOBAL_DATA_PTR;
28 
29 int device_bind(struct udevice *parent, const struct driver *drv,
30 		const char *name, void *platdata, int of_offset,
31 		struct udevice **devp)
32 {
33 	struct udevice *dev;
34 	struct uclass *uc;
35 	int size, ret = 0;
36 
37 	if (devp)
38 		*devp = NULL;
39 	if (!name)
40 		return -EINVAL;
41 
42 	ret = uclass_get(drv->id, &uc);
43 	if (ret) {
44 		debug("Missing uclass for driver %s\n", drv->name);
45 		return ret;
46 	}
47 
48 	dev = calloc(1, sizeof(struct udevice));
49 	if (!dev)
50 		return -ENOMEM;
51 
52 	INIT_LIST_HEAD(&dev->sibling_node);
53 	INIT_LIST_HEAD(&dev->child_head);
54 	INIT_LIST_HEAD(&dev->uclass_node);
55 #ifdef CONFIG_DEVRES
56 	INIT_LIST_HEAD(&dev->devres_head);
57 #endif
58 	dev->platdata = platdata;
59 	dev->name = name;
60 	dev->of_offset = of_offset;
61 	dev->parent = parent;
62 	dev->driver = drv;
63 	dev->uclass = uc;
64 
65 	dev->seq = -1;
66 	dev->req_seq = -1;
67 	if (CONFIG_IS_ENABLED(OF_CONTROL) && IS_ENABLED(CONFIG_DM_SEQ_ALIAS)) {
68 		/*
69 		* Some devices, such as a SPI bus, I2C bus and serial ports
70 		* are numbered using aliases.
71 		*
72 		* This is just a 'requested' sequence, and will be
73 		* resolved (and ->seq updated) when the device is probed.
74 		*/
75 		if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
76 			if (uc->uc_drv->name && of_offset != -1) {
77 				fdtdec_get_alias_seq(gd->fdt_blob,
78 						uc->uc_drv->name, of_offset,
79 						&dev->req_seq);
80 			}
81 		}
82 	}
83 
84 	if (!dev->platdata && drv->platdata_auto_alloc_size) {
85 		dev->flags |= DM_FLAG_ALLOC_PDATA;
86 		dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
87 		if (!dev->platdata) {
88 			ret = -ENOMEM;
89 			goto fail_alloc1;
90 		}
91 	}
92 
93 	size = uc->uc_drv->per_device_platdata_auto_alloc_size;
94 	if (size) {
95 		dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
96 		dev->uclass_platdata = calloc(1, size);
97 		if (!dev->uclass_platdata) {
98 			ret = -ENOMEM;
99 			goto fail_alloc2;
100 		}
101 	}
102 
103 	if (parent) {
104 		size = parent->driver->per_child_platdata_auto_alloc_size;
105 		if (!size) {
106 			size = parent->uclass->uc_drv->
107 					per_child_platdata_auto_alloc_size;
108 		}
109 		if (size) {
110 			dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
111 			dev->parent_platdata = calloc(1, size);
112 			if (!dev->parent_platdata) {
113 				ret = -ENOMEM;
114 				goto fail_alloc3;
115 			}
116 		}
117 	}
118 
119 	/* put dev into parent's successor list */
120 	if (parent)
121 		list_add_tail(&dev->sibling_node, &parent->child_head);
122 
123 	ret = uclass_bind_device(dev);
124 	if (ret)
125 		goto fail_uclass_bind;
126 
127 	/* if we fail to bind we remove device from successors and free it */
128 	if (drv->bind) {
129 		ret = drv->bind(dev);
130 		if (ret)
131 			goto fail_bind;
132 	}
133 	if (parent && parent->driver->child_post_bind) {
134 		ret = parent->driver->child_post_bind(dev);
135 		if (ret)
136 			goto fail_child_post_bind;
137 	}
138 
139 	if (parent)
140 		dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
141 	if (devp)
142 		*devp = dev;
143 
144 	dev->flags |= DM_FLAG_BOUND;
145 
146 	return 0;
147 
148 fail_child_post_bind:
149 	if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
150 		if (drv->unbind && drv->unbind(dev)) {
151 			dm_warn("unbind() method failed on dev '%s' on error path\n",
152 				dev->name);
153 		}
154 	}
155 
156 fail_bind:
157 	if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
158 		if (uclass_unbind_device(dev)) {
159 			dm_warn("Failed to unbind dev '%s' on error path\n",
160 				dev->name);
161 		}
162 	}
163 fail_uclass_bind:
164 	if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
165 		list_del(&dev->sibling_node);
166 		if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
167 			free(dev->parent_platdata);
168 			dev->parent_platdata = NULL;
169 		}
170 	}
171 fail_alloc3:
172 	if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
173 		free(dev->uclass_platdata);
174 		dev->uclass_platdata = NULL;
175 	}
176 fail_alloc2:
177 	if (dev->flags & DM_FLAG_ALLOC_PDATA) {
178 		free(dev->platdata);
179 		dev->platdata = NULL;
180 	}
181 fail_alloc1:
182 	devres_release_all(dev);
183 
184 	free(dev);
185 
186 	return ret;
187 }
188 
189 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
190 			const struct driver_info *info, struct udevice **devp)
191 {
192 	struct driver *drv;
193 
194 	drv = lists_driver_lookup_name(info->name);
195 	if (!drv)
196 		return -ENOENT;
197 	if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
198 		return -EPERM;
199 
200 	return device_bind(parent, drv, info->name, (void *)info->platdata,
201 			   -1, devp);
202 }
203 
204 static void *alloc_priv(int size, uint flags)
205 {
206 	void *priv;
207 
208 	if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
209 		priv = memalign(ARCH_DMA_MINALIGN, size);
210 		if (priv)
211 			memset(priv, '\0', size);
212 	} else {
213 		priv = calloc(1, size);
214 	}
215 
216 	return priv;
217 }
218 
219 int device_probe_child(struct udevice *dev, void *parent_priv)
220 {
221 	const struct driver *drv;
222 	int size = 0;
223 	int ret;
224 	int seq;
225 
226 	if (!dev)
227 		return -EINVAL;
228 
229 	if (dev->flags & DM_FLAG_ACTIVATED)
230 		return 0;
231 
232 	drv = dev->driver;
233 	assert(drv);
234 
235 	/* Allocate private data if requested and not reentered */
236 	if (drv->priv_auto_alloc_size && !dev->priv) {
237 		dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
238 		if (!dev->priv) {
239 			ret = -ENOMEM;
240 			goto fail;
241 		}
242 	}
243 	/* Allocate private data if requested and not reentered */
244 	size = dev->uclass->uc_drv->per_device_auto_alloc_size;
245 	if (size && !dev->uclass_priv) {
246 		dev->uclass_priv = calloc(1, size);
247 		if (!dev->uclass_priv) {
248 			ret = -ENOMEM;
249 			goto fail;
250 		}
251 	}
252 
253 	/* Ensure all parents are probed */
254 	if (dev->parent) {
255 		size = dev->parent->driver->per_child_auto_alloc_size;
256 		if (!size) {
257 			size = dev->parent->uclass->uc_drv->
258 					per_child_auto_alloc_size;
259 		}
260 		if (size && !dev->parent_priv) {
261 			dev->parent_priv = alloc_priv(size, drv->flags);
262 			if (!dev->parent_priv) {
263 				ret = -ENOMEM;
264 				goto fail;
265 			}
266 			if (parent_priv)
267 				memcpy(dev->parent_priv, parent_priv, size);
268 		}
269 
270 		ret = device_probe(dev->parent);
271 		if (ret)
272 			goto fail;
273 
274 		/*
275 		 * The device might have already been probed during
276 		 * the call to device_probe() on its parent device
277 		 * (e.g. PCI bridge devices). Test the flags again
278 		 * so that we don't mess up the device.
279 		 */
280 		if (dev->flags & DM_FLAG_ACTIVATED)
281 			return 0;
282 	}
283 
284 	seq = uclass_resolve_seq(dev);
285 	if (seq < 0) {
286 		ret = seq;
287 		goto fail;
288 	}
289 	dev->seq = seq;
290 
291 	dev->flags |= DM_FLAG_ACTIVATED;
292 
293 	/*
294 	 * Process pinctrl for everything except the root device, and
295 	 * continue regardless of the result of pinctrl.
296 	 */
297 	if (dev->parent)
298 		pinctrl_select_state(dev, "default");
299 
300 	ret = uclass_pre_probe_device(dev);
301 	if (ret)
302 		goto fail;
303 
304 	if (dev->parent && dev->parent->driver->child_pre_probe) {
305 		ret = dev->parent->driver->child_pre_probe(dev);
306 		if (ret)
307 			goto fail;
308 	}
309 
310 	if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
311 		ret = drv->ofdata_to_platdata(dev);
312 		if (ret)
313 			goto fail;
314 	}
315 
316 	if (drv->probe) {
317 		ret = drv->probe(dev);
318 		if (ret) {
319 			dev->flags &= ~DM_FLAG_ACTIVATED;
320 			goto fail;
321 		}
322 	}
323 
324 	ret = uclass_post_probe_device(dev);
325 	if (ret)
326 		goto fail_uclass;
327 
328 	return 0;
329 fail_uclass:
330 	if (device_remove(dev)) {
331 		dm_warn("%s: Device '%s' failed to remove on error path\n",
332 			__func__, dev->name);
333 	}
334 fail:
335 	dev->flags &= ~DM_FLAG_ACTIVATED;
336 
337 	dev->seq = -1;
338 	device_free(dev);
339 
340 	return ret;
341 }
342 
343 int device_probe(struct udevice *dev)
344 {
345 	return device_probe_child(dev, NULL);
346 }
347 
348 void *dev_get_platdata(struct udevice *dev)
349 {
350 	if (!dev) {
351 		dm_warn("%s: null device\n", __func__);
352 		return NULL;
353 	}
354 
355 	return dev->platdata;
356 }
357 
358 void *dev_get_parent_platdata(struct udevice *dev)
359 {
360 	if (!dev) {
361 		dm_warn("%s: null device\n", __func__);
362 		return NULL;
363 	}
364 
365 	return dev->parent_platdata;
366 }
367 
368 void *dev_get_uclass_platdata(struct udevice *dev)
369 {
370 	if (!dev) {
371 		dm_warn("%s: null device\n", __func__);
372 		return NULL;
373 	}
374 
375 	return dev->uclass_platdata;
376 }
377 
378 void *dev_get_priv(struct udevice *dev)
379 {
380 	if (!dev) {
381 		dm_warn("%s: null device\n", __func__);
382 		return NULL;
383 	}
384 
385 	return dev->priv;
386 }
387 
388 void *dev_get_uclass_priv(struct udevice *dev)
389 {
390 	if (!dev) {
391 		dm_warn("%s: null device\n", __func__);
392 		return NULL;
393 	}
394 
395 	return dev->uclass_priv;
396 }
397 
398 void *dev_get_parent_priv(struct udevice *dev)
399 {
400 	if (!dev) {
401 		dm_warn("%s: null device\n", __func__);
402 		return NULL;
403 	}
404 
405 	return dev->parent_priv;
406 }
407 
408 static int device_get_device_tail(struct udevice *dev, int ret,
409 				  struct udevice **devp)
410 {
411 	if (ret)
412 		return ret;
413 
414 	ret = device_probe(dev);
415 	if (ret)
416 		return ret;
417 
418 	*devp = dev;
419 
420 	return 0;
421 }
422 
423 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
424 {
425 	struct udevice *dev;
426 
427 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
428 		if (!index--)
429 			return device_get_device_tail(dev, 0, devp);
430 	}
431 
432 	return -ENODEV;
433 }
434 
435 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
436 			     bool find_req_seq, struct udevice **devp)
437 {
438 	struct udevice *dev;
439 
440 	*devp = NULL;
441 	if (seq_or_req_seq == -1)
442 		return -ENODEV;
443 
444 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
445 		if ((find_req_seq ? dev->req_seq : dev->seq) ==
446 				seq_or_req_seq) {
447 			*devp = dev;
448 			return 0;
449 		}
450 	}
451 
452 	return -ENODEV;
453 }
454 
455 int device_get_child_by_seq(struct udevice *parent, int seq,
456 			    struct udevice **devp)
457 {
458 	struct udevice *dev;
459 	int ret;
460 
461 	*devp = NULL;
462 	ret = device_find_child_by_seq(parent, seq, false, &dev);
463 	if (ret == -ENODEV) {
464 		/*
465 		 * We didn't find it in probed devices. See if there is one
466 		 * that will request this seq if probed.
467 		 */
468 		ret = device_find_child_by_seq(parent, seq, true, &dev);
469 	}
470 	return device_get_device_tail(dev, ret, devp);
471 }
472 
473 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
474 				   struct udevice **devp)
475 {
476 	struct udevice *dev;
477 
478 	*devp = NULL;
479 
480 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
481 		if (dev->of_offset == of_offset) {
482 			*devp = dev;
483 			return 0;
484 		}
485 	}
486 
487 	return -ENODEV;
488 }
489 
490 int device_get_child_by_of_offset(struct udevice *parent, int node,
491 				  struct udevice **devp)
492 {
493 	struct udevice *dev;
494 	int ret;
495 
496 	*devp = NULL;
497 	ret = device_find_child_by_of_offset(parent, node, &dev);
498 	return device_get_device_tail(dev, ret, devp);
499 }
500 
501 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
502 							int of_offset)
503 {
504 	struct udevice *dev, *found;
505 
506 	if (parent->of_offset == of_offset)
507 		return parent;
508 
509 	list_for_each_entry(dev, &parent->child_head, sibling_node) {
510 		found = _device_find_global_by_of_offset(dev, of_offset);
511 		if (found)
512 			return found;
513 	}
514 
515 	return NULL;
516 }
517 
518 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
519 {
520 	struct udevice *dev;
521 
522 	dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
523 	return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
524 }
525 
526 int device_find_first_child(struct udevice *parent, struct udevice **devp)
527 {
528 	if (list_empty(&parent->child_head)) {
529 		*devp = NULL;
530 	} else {
531 		*devp = list_first_entry(&parent->child_head, struct udevice,
532 					 sibling_node);
533 	}
534 
535 	return 0;
536 }
537 
538 int device_find_next_child(struct udevice **devp)
539 {
540 	struct udevice *dev = *devp;
541 	struct udevice *parent = dev->parent;
542 
543 	if (list_is_last(&dev->sibling_node, &parent->child_head)) {
544 		*devp = NULL;
545 	} else {
546 		*devp = list_entry(dev->sibling_node.next, struct udevice,
547 				   sibling_node);
548 	}
549 
550 	return 0;
551 }
552 
553 struct udevice *dev_get_parent(struct udevice *child)
554 {
555 	return child->parent;
556 }
557 
558 ulong dev_get_driver_data(struct udevice *dev)
559 {
560 	return dev->driver_data;
561 }
562 
563 const void *dev_get_driver_ops(struct udevice *dev)
564 {
565 	if (!dev || !dev->driver->ops)
566 		return NULL;
567 
568 	return dev->driver->ops;
569 }
570 
571 enum uclass_id device_get_uclass_id(struct udevice *dev)
572 {
573 	return dev->uclass->uc_drv->id;
574 }
575 
576 const char *dev_get_uclass_name(struct udevice *dev)
577 {
578 	if (!dev)
579 		return NULL;
580 
581 	return dev->uclass->uc_drv->name;
582 }
583 
584 fdt_addr_t dev_get_addr(struct udevice *dev)
585 {
586 #if CONFIG_IS_ENABLED(OF_CONTROL)
587 	fdt_addr_t addr;
588 
589 	if (CONFIG_IS_ENABLED(OF_TRANSLATE)) {
590 		const fdt32_t *reg;
591 
592 		reg = fdt_getprop(gd->fdt_blob, dev->of_offset, "reg", NULL);
593 		if (!reg)
594 			return FDT_ADDR_T_NONE;
595 
596 		/*
597 		 * Use the full-fledged translate function for complex
598 		 * bus setups.
599 		 */
600 		return fdt_translate_address((void *)gd->fdt_blob,
601 					     dev->of_offset, reg);
602 	}
603 
604 	/*
605 	 * Use the "simple" translate function for less complex
606 	 * bus setups.
607 	 */
608 	addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob,
609 						dev->parent->of_offset,
610 						dev->of_offset, "reg",
611 						0, NULL);
612 	if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
613 		if (device_get_uclass_id(dev->parent) == UCLASS_SIMPLE_BUS)
614 			addr = simple_bus_translate(dev->parent, addr);
615 	}
616 
617 	return addr;
618 #else
619 	return FDT_ADDR_T_NONE;
620 #endif
621 }
622 
623 bool device_has_children(struct udevice *dev)
624 {
625 	return !list_empty(&dev->child_head);
626 }
627 
628 bool device_has_active_children(struct udevice *dev)
629 {
630 	struct udevice *child;
631 
632 	for (device_find_first_child(dev, &child);
633 	     child;
634 	     device_find_next_child(&child)) {
635 		if (device_active(child))
636 			return true;
637 	}
638 
639 	return false;
640 }
641 
642 bool device_is_last_sibling(struct udevice *dev)
643 {
644 	struct udevice *parent = dev->parent;
645 
646 	if (!parent)
647 		return false;
648 	return list_is_last(&dev->sibling_node, &parent->child_head);
649 }
650 
651 int device_set_name(struct udevice *dev, const char *name)
652 {
653 	name = strdup(name);
654 	if (!name)
655 		return -ENOMEM;
656 	dev->name = name;
657 
658 	return 0;
659 }
660