4 * Copyright (c) 2013 Google, Inc
7 * Pavel Herrmann <morpheus.ibis@gmail.com>
9 * SPDX-License-Identifier: GPL-2.0+
15 #include <dm/device.h>
16 #include <dm/device-internal.h>
18 #include <dm/pinctrl.h>
19 #include <dm/platdata.h>
20 #include <dm/uclass.h>
21 #include <dm/uclass-internal.h>
23 #include <linux/err.h>
24 #include <linux/list.h>
26 DECLARE_GLOBAL_DATA_PTR;
28 int device_bind(struct udevice *parent, const struct driver *drv,
29 const char *name, void *platdata, int of_offset,
30 struct udevice **devp)
41 ret = uclass_get(drv->id, &uc);
43 debug("Missing uclass for driver %s\n", drv->name);
47 dev = calloc(1, sizeof(struct udevice));
51 INIT_LIST_HEAD(&dev->sibling_node);
52 INIT_LIST_HEAD(&dev->child_head);
53 INIT_LIST_HEAD(&dev->uclass_node);
55 INIT_LIST_HEAD(&dev->devres_head);
57 dev->platdata = platdata;
59 dev->of_offset = of_offset;
66 if (CONFIG_IS_ENABLED(OF_CONTROL) && IS_ENABLED(CONFIG_DM_SEQ_ALIAS)) {
68 * Some devices, such as a SPI bus, I2C bus and serial ports
69 * are numbered using aliases.
71 * This is just a 'requested' sequence, and will be
72 * resolved (and ->seq updated) when the device is probed.
74 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
75 if (uc->uc_drv->name && of_offset != -1) {
76 fdtdec_get_alias_seq(gd->fdt_blob,
77 uc->uc_drv->name, of_offset,
83 if (!dev->platdata && drv->platdata_auto_alloc_size) {
84 dev->flags |= DM_FLAG_ALLOC_PDATA;
85 dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
92 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
94 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
95 dev->uclass_platdata = calloc(1, size);
96 if (!dev->uclass_platdata) {
103 size = parent->driver->per_child_platdata_auto_alloc_size;
105 size = parent->uclass->uc_drv->
106 per_child_platdata_auto_alloc_size;
109 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
110 dev->parent_platdata = calloc(1, size);
111 if (!dev->parent_platdata) {
118 /* put dev into parent's successor list */
120 list_add_tail(&dev->sibling_node, &parent->child_head);
122 ret = uclass_bind_device(dev);
124 goto fail_uclass_bind;
126 /* if we fail to bind we remove device from successors and free it */
128 ret = drv->bind(dev);
132 if (parent && parent->driver->child_post_bind) {
133 ret = parent->driver->child_post_bind(dev);
135 goto fail_child_post_bind;
139 dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
143 dev->flags |= DM_FLAG_BOUND;
147 fail_child_post_bind:
148 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
149 if (drv->unbind && drv->unbind(dev)) {
150 dm_warn("unbind() method failed on dev '%s' on error path\n",
156 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
157 if (uclass_unbind_device(dev)) {
158 dm_warn("Failed to unbind dev '%s' on error path\n",
163 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
164 list_del(&dev->sibling_node);
165 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
166 free(dev->parent_platdata);
167 dev->parent_platdata = NULL;
171 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
172 free(dev->uclass_platdata);
173 dev->uclass_platdata = NULL;
176 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
178 dev->platdata = NULL;
181 devres_release_all(dev);
188 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
189 const struct driver_info *info, struct udevice **devp)
193 drv = lists_driver_lookup_name(info->name);
196 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
199 return device_bind(parent, drv, info->name, (void *)info->platdata,
203 static void *alloc_priv(int size, uint flags)
207 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
208 priv = memalign(ARCH_DMA_MINALIGN, size);
210 memset(priv, '\0', size);
212 priv = calloc(1, size);
218 int device_probe_child(struct udevice *dev, void *parent_priv)
220 const struct driver *drv;
228 if (dev->flags & DM_FLAG_ACTIVATED)
234 /* Allocate private data if requested and not reentered */
235 if (drv->priv_auto_alloc_size && !dev->priv) {
236 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
242 /* Allocate private data if requested and not reentered */
243 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
244 if (size && !dev->uclass_priv) {
245 dev->uclass_priv = calloc(1, size);
246 if (!dev->uclass_priv) {
252 /* Ensure all parents are probed */
254 size = dev->parent->driver->per_child_auto_alloc_size;
256 size = dev->parent->uclass->uc_drv->
257 per_child_auto_alloc_size;
259 if (size && !dev->parent_priv) {
260 dev->parent_priv = alloc_priv(size, drv->flags);
261 if (!dev->parent_priv) {
266 memcpy(dev->parent_priv, parent_priv, size);
269 ret = device_probe(dev->parent);
274 * The device might have already been probed during
275 * the call to device_probe() on its parent device
276 * (e.g. PCI bridge devices). Test the flags again
277 * so that we don't mess up the device.
279 if (dev->flags & DM_FLAG_ACTIVATED)
283 seq = uclass_resolve_seq(dev);
290 dev->flags |= DM_FLAG_ACTIVATED;
293 * Process pinctrl for everything except the root device, and
294 * continue regardless of the result of pinctrl.
297 pinctrl_select_state(dev, "default");
299 ret = uclass_pre_probe_device(dev);
303 if (dev->parent && dev->parent->driver->child_pre_probe) {
304 ret = dev->parent->driver->child_pre_probe(dev);
309 if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
310 ret = drv->ofdata_to_platdata(dev);
316 ret = drv->probe(dev);
318 dev->flags &= ~DM_FLAG_ACTIVATED;
323 ret = uclass_post_probe_device(dev);
329 if (device_remove(dev)) {
330 dm_warn("%s: Device '%s' failed to remove on error path\n",
331 __func__, dev->name);
334 dev->flags &= ~DM_FLAG_ACTIVATED;
342 int device_probe(struct udevice *dev)
344 return device_probe_child(dev, NULL);
347 void *dev_get_platdata(struct udevice *dev)
350 dm_warn("%s: null device\n", __func__);
354 return dev->platdata;
357 void *dev_get_parent_platdata(struct udevice *dev)
360 dm_warn("%s: null device\n", __func__);
364 return dev->parent_platdata;
367 void *dev_get_uclass_platdata(struct udevice *dev)
370 dm_warn("%s: null device\n", __func__);
374 return dev->uclass_platdata;
377 void *dev_get_priv(struct udevice *dev)
380 dm_warn("%s: null device\n", __func__);
387 void *dev_get_uclass_priv(struct udevice *dev)
390 dm_warn("%s: null device\n", __func__);
394 return dev->uclass_priv;
397 void *dev_get_parentdata(struct udevice *dev)
400 dm_warn("%s: null device\n", __func__);
404 return dev->parent_priv;
407 static int device_get_device_tail(struct udevice *dev, int ret,
408 struct udevice **devp)
413 ret = device_probe(dev);
422 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
426 list_for_each_entry(dev, &parent->child_head, sibling_node) {
428 return device_get_device_tail(dev, 0, devp);
434 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
435 bool find_req_seq, struct udevice **devp)
440 if (seq_or_req_seq == -1)
443 list_for_each_entry(dev, &parent->child_head, sibling_node) {
444 if ((find_req_seq ? dev->req_seq : dev->seq) ==
454 int device_get_child_by_seq(struct udevice *parent, int seq,
455 struct udevice **devp)
461 ret = device_find_child_by_seq(parent, seq, false, &dev);
462 if (ret == -ENODEV) {
464 * We didn't find it in probed devices. See if there is one
465 * that will request this seq if probed.
467 ret = device_find_child_by_seq(parent, seq, true, &dev);
469 return device_get_device_tail(dev, ret, devp);
472 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
473 struct udevice **devp)
479 list_for_each_entry(dev, &parent->child_head, sibling_node) {
480 if (dev->of_offset == of_offset) {
489 int device_get_child_by_of_offset(struct udevice *parent, int node,
490 struct udevice **devp)
496 ret = device_find_child_by_of_offset(parent, node, &dev);
497 return device_get_device_tail(dev, ret, devp);
500 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
503 struct udevice *dev, *found;
505 if (parent->of_offset == of_offset)
508 list_for_each_entry(dev, &parent->child_head, sibling_node) {
509 found = _device_find_global_by_of_offset(dev, of_offset);
517 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
521 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
522 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
525 int device_find_first_child(struct udevice *parent, struct udevice **devp)
527 if (list_empty(&parent->child_head)) {
530 *devp = list_first_entry(&parent->child_head, struct udevice,
537 int device_find_next_child(struct udevice **devp)
539 struct udevice *dev = *devp;
540 struct udevice *parent = dev->parent;
542 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
545 *devp = list_entry(dev->sibling_node.next, struct udevice,
552 struct udevice *dev_get_parent(struct udevice *child)
554 return child->parent;
557 ulong dev_get_driver_data(struct udevice *dev)
559 return dev->driver_data;
562 const void *dev_get_driver_ops(struct udevice *dev)
564 if (!dev || !dev->driver->ops)
567 return dev->driver->ops;
570 enum uclass_id device_get_uclass_id(struct udevice *dev)
572 return dev->uclass->uc_drv->id;
575 const char *dev_get_uclass_name(struct udevice *dev)
580 return dev->uclass->uc_drv->name;
583 fdt_addr_t dev_get_addr(struct udevice *dev)
585 #if CONFIG_IS_ENABLED(OF_CONTROL)
588 addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob,
589 dev->parent->of_offset,
590 dev->of_offset, "reg",
592 if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
593 if (device_get_uclass_id(dev->parent) == UCLASS_SIMPLE_BUS)
594 addr = simple_bus_translate(dev->parent, addr);
599 return FDT_ADDR_T_NONE;
603 bool device_has_children(struct udevice *dev)
605 return !list_empty(&dev->child_head);
608 bool device_has_active_children(struct udevice *dev)
610 struct udevice *child;
612 for (device_find_first_child(dev, &child);
614 device_find_next_child(&child)) {
615 if (device_active(child))
622 bool device_is_last_sibling(struct udevice *dev)
624 struct udevice *parent = dev->parent;
628 return list_is_last(&dev->sibling_node, &parent->child_head);
631 int device_set_name(struct udevice *dev, const char *name)