4 * Copyright (c) 2013 Google, Inc
7 * Pavel Herrmann <morpheus.ibis@gmail.com>
9 * SPDX-License-Identifier: GPL-2.0+
14 #include <fdt_support.h>
16 #include <dm/device.h>
17 #include <dm/device-internal.h>
19 #include <dm/pinctrl.h>
20 #include <dm/platdata.h>
21 #include <dm/uclass.h>
22 #include <dm/uclass-internal.h>
24 #include <linux/err.h>
25 #include <linux/list.h>
27 DECLARE_GLOBAL_DATA_PTR;
29 int device_bind(struct udevice *parent, const struct driver *drv,
30 const char *name, void *platdata, int of_offset,
31 struct udevice **devp)
42 ret = uclass_get(drv->id, &uc);
44 debug("Missing uclass for driver %s\n", drv->name);
48 dev = calloc(1, sizeof(struct udevice));
52 INIT_LIST_HEAD(&dev->sibling_node);
53 INIT_LIST_HEAD(&dev->child_head);
54 INIT_LIST_HEAD(&dev->uclass_node);
56 INIT_LIST_HEAD(&dev->devres_head);
58 dev->platdata = platdata;
60 dev->of_offset = of_offset;
67 if (CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(DM_SEQ_ALIAS)) {
69 * Some devices, such as a SPI bus, I2C bus and serial ports
70 * are numbered using aliases.
72 * This is just a 'requested' sequence, and will be
73 * resolved (and ->seq updated) when the device is probed.
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,
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);
93 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
95 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
96 dev->uclass_platdata = calloc(1, size);
97 if (!dev->uclass_platdata) {
104 size = parent->driver->per_child_platdata_auto_alloc_size;
106 size = parent->uclass->uc_drv->
107 per_child_platdata_auto_alloc_size;
110 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
111 dev->parent_platdata = calloc(1, size);
112 if (!dev->parent_platdata) {
119 /* put dev into parent's successor list */
121 list_add_tail(&dev->sibling_node, &parent->child_head);
123 ret = uclass_bind_device(dev);
125 goto fail_uclass_bind;
127 /* if we fail to bind we remove device from successors and free it */
129 ret = drv->bind(dev);
133 if (parent && parent->driver->child_post_bind) {
134 ret = parent->driver->child_post_bind(dev);
136 goto fail_child_post_bind;
138 if (uc->uc_drv->post_bind) {
139 ret = uc->uc_drv->post_bind(dev);
141 goto fail_uclass_post_bind;
145 dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
149 dev->flags |= DM_FLAG_BOUND;
153 fail_uclass_post_bind:
154 /* There is no child unbind() method, so no clean-up required */
155 fail_child_post_bind:
156 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
157 if (drv->unbind && drv->unbind(dev)) {
158 dm_warn("unbind() method failed on dev '%s' on error path\n",
164 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
165 if (uclass_unbind_device(dev)) {
166 dm_warn("Failed to unbind dev '%s' on error path\n",
171 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
172 list_del(&dev->sibling_node);
173 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
174 free(dev->parent_platdata);
175 dev->parent_platdata = NULL;
179 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
180 free(dev->uclass_platdata);
181 dev->uclass_platdata = NULL;
184 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
186 dev->platdata = NULL;
189 devres_release_all(dev);
196 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
197 const struct driver_info *info, struct udevice **devp)
201 drv = lists_driver_lookup_name(info->name);
204 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
207 return device_bind(parent, drv, info->name, (void *)info->platdata,
211 static void *alloc_priv(int size, uint flags)
215 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
216 priv = memalign(ARCH_DMA_MINALIGN, size);
218 memset(priv, '\0', size);
220 priv = calloc(1, size);
226 int device_probe_child(struct udevice *dev, void *parent_priv)
228 const struct driver *drv;
236 if (dev->flags & DM_FLAG_ACTIVATED)
242 /* Allocate private data if requested and not reentered */
243 if (drv->priv_auto_alloc_size && !dev->priv) {
244 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
250 /* Allocate private data if requested and not reentered */
251 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
252 if (size && !dev->uclass_priv) {
253 dev->uclass_priv = calloc(1, size);
254 if (!dev->uclass_priv) {
260 /* Ensure all parents are probed */
262 size = dev->parent->driver->per_child_auto_alloc_size;
264 size = dev->parent->uclass->uc_drv->
265 per_child_auto_alloc_size;
267 if (size && !dev->parent_priv) {
268 dev->parent_priv = alloc_priv(size, drv->flags);
269 if (!dev->parent_priv) {
274 memcpy(dev->parent_priv, parent_priv, size);
277 ret = device_probe(dev->parent);
282 * The device might have already been probed during
283 * the call to device_probe() on its parent device
284 * (e.g. PCI bridge devices). Test the flags again
285 * so that we don't mess up the device.
287 if (dev->flags & DM_FLAG_ACTIVATED)
291 seq = uclass_resolve_seq(dev);
298 dev->flags |= DM_FLAG_ACTIVATED;
301 * Process pinctrl for everything except the root device, and
302 * continue regardless of the result of pinctrl. Don't process pinctrl
303 * settings for pinctrl devices since the device may not yet be
306 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
307 pinctrl_select_state(dev, "default");
309 ret = uclass_pre_probe_device(dev);
313 if (dev->parent && dev->parent->driver->child_pre_probe) {
314 ret = dev->parent->driver->child_pre_probe(dev);
319 if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
320 ret = drv->ofdata_to_platdata(dev);
326 ret = drv->probe(dev);
328 dev->flags &= ~DM_FLAG_ACTIVATED;
333 ret = uclass_post_probe_device(dev);
339 if (device_remove(dev)) {
340 dm_warn("%s: Device '%s' failed to remove on error path\n",
341 __func__, dev->name);
344 dev->flags &= ~DM_FLAG_ACTIVATED;
352 int device_probe(struct udevice *dev)
354 return device_probe_child(dev, NULL);
357 void *dev_get_platdata(struct udevice *dev)
360 dm_warn("%s: null device\n", __func__);
364 return dev->platdata;
367 void *dev_get_parent_platdata(struct udevice *dev)
370 dm_warn("%s: null device\n", __func__);
374 return dev->parent_platdata;
377 void *dev_get_uclass_platdata(struct udevice *dev)
380 dm_warn("%s: null device\n", __func__);
384 return dev->uclass_platdata;
387 void *dev_get_priv(struct udevice *dev)
390 dm_warn("%s: null device\n", __func__);
397 void *dev_get_uclass_priv(struct udevice *dev)
400 dm_warn("%s: null device\n", __func__);
404 return dev->uclass_priv;
407 void *dev_get_parent_priv(struct udevice *dev)
410 dm_warn("%s: null device\n", __func__);
414 return dev->parent_priv;
417 static int device_get_device_tail(struct udevice *dev, int ret,
418 struct udevice **devp)
423 ret = device_probe(dev);
432 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
436 list_for_each_entry(dev, &parent->child_head, sibling_node) {
438 return device_get_device_tail(dev, 0, devp);
444 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
445 bool find_req_seq, struct udevice **devp)
450 if (seq_or_req_seq == -1)
453 list_for_each_entry(dev, &parent->child_head, sibling_node) {
454 if ((find_req_seq ? dev->req_seq : dev->seq) ==
464 int device_get_child_by_seq(struct udevice *parent, int seq,
465 struct udevice **devp)
471 ret = device_find_child_by_seq(parent, seq, false, &dev);
472 if (ret == -ENODEV) {
474 * We didn't find it in probed devices. See if there is one
475 * that will request this seq if probed.
477 ret = device_find_child_by_seq(parent, seq, true, &dev);
479 return device_get_device_tail(dev, ret, devp);
482 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
483 struct udevice **devp)
489 list_for_each_entry(dev, &parent->child_head, sibling_node) {
490 if (dev->of_offset == of_offset) {
499 int device_get_child_by_of_offset(struct udevice *parent, int node,
500 struct udevice **devp)
506 ret = device_find_child_by_of_offset(parent, node, &dev);
507 return device_get_device_tail(dev, ret, devp);
510 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
513 struct udevice *dev, *found;
515 if (parent->of_offset == of_offset)
518 list_for_each_entry(dev, &parent->child_head, sibling_node) {
519 found = _device_find_global_by_of_offset(dev, of_offset);
527 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
531 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
532 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
535 int device_find_first_child(struct udevice *parent, struct udevice **devp)
537 if (list_empty(&parent->child_head)) {
540 *devp = list_first_entry(&parent->child_head, struct udevice,
547 int device_find_next_child(struct udevice **devp)
549 struct udevice *dev = *devp;
550 struct udevice *parent = dev->parent;
552 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
555 *devp = list_entry(dev->sibling_node.next, struct udevice,
562 struct udevice *dev_get_parent(struct udevice *child)
564 return child->parent;
567 ulong dev_get_driver_data(struct udevice *dev)
569 return dev->driver_data;
572 const void *dev_get_driver_ops(struct udevice *dev)
574 if (!dev || !dev->driver->ops)
577 return dev->driver->ops;
580 enum uclass_id device_get_uclass_id(struct udevice *dev)
582 return dev->uclass->uc_drv->id;
585 const char *dev_get_uclass_name(struct udevice *dev)
590 return dev->uclass->uc_drv->name;
593 fdt_addr_t dev_get_addr_index(struct udevice *dev, int index)
595 #if CONFIG_IS_ENABLED(OF_CONTROL)
598 if (CONFIG_IS_ENABLED(OF_TRANSLATE)) {
603 na = fdt_address_cells(gd->fdt_blob, dev->parent->of_offset);
605 debug("bad #address-cells\n");
606 return FDT_ADDR_T_NONE;
609 ns = fdt_size_cells(gd->fdt_blob, dev->parent->of_offset);
611 debug("bad #size-cells\n");
612 return FDT_ADDR_T_NONE;
615 reg = fdt_getprop(gd->fdt_blob, dev->of_offset, "reg", &len);
616 if (!reg || (len <= (index * sizeof(fdt32_t) * (na + ns)))) {
617 debug("Req index out of range\n");
618 return FDT_ADDR_T_NONE;
621 reg += index * (na + ns);
624 * Use the full-fledged translate function for complex
627 addr = fdt_translate_address((void *)gd->fdt_blob,
628 dev->of_offset, reg);
631 * Use the "simple" translate function for less complex
634 addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob,
635 dev->parent->of_offset,
636 dev->of_offset, "reg",
638 if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
639 if (device_get_uclass_id(dev->parent) ==
641 addr = simple_bus_translate(dev->parent, addr);
646 * Some platforms need a special address translation. Those
647 * platforms (e.g. mvebu in SPL) can configure a translation
648 * offset in the DM by calling dm_set_translation_offset() that
649 * will get added to all addresses returned by dev_get_addr().
651 addr += dm_get_translation_offset();
655 return FDT_ADDR_T_NONE;
659 fdt_addr_t dev_get_addr(struct udevice *dev)
661 return dev_get_addr_index(dev, 0);
664 bool device_has_children(struct udevice *dev)
666 return !list_empty(&dev->child_head);
669 bool device_has_active_children(struct udevice *dev)
671 struct udevice *child;
673 for (device_find_first_child(dev, &child);
675 device_find_next_child(&child)) {
676 if (device_active(child))
683 bool device_is_last_sibling(struct udevice *dev)
685 struct udevice *parent = dev->parent;
689 return list_is_last(&dev->sibling_node, &parent->child_head);
692 int device_set_name(struct udevice *dev, const char *name)