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 static int device_bind_common(struct udevice *parent, const struct driver *drv,
30 const char *name, void *platdata,
31 ulong driver_data, int of_offset,
32 struct udevice **devp)
43 ret = uclass_get(drv->id, &uc);
45 debug("Missing uclass for driver %s\n", drv->name);
49 dev = calloc(1, sizeof(struct udevice));
53 INIT_LIST_HEAD(&dev->sibling_node);
54 INIT_LIST_HEAD(&dev->child_head);
55 INIT_LIST_HEAD(&dev->uclass_node);
57 INIT_LIST_HEAD(&dev->devres_head);
59 dev->platdata = platdata;
60 dev->driver_data = driver_data;
62 dev->of_offset = of_offset;
69 if (CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(DM_SEQ_ALIAS)) {
71 * Some devices, such as a SPI bus, I2C bus and serial ports
72 * are numbered using aliases.
74 * This is just a 'requested' sequence, and will be
75 * resolved (and ->seq updated) when the device is probed.
77 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
78 if (uc->uc_drv->name && of_offset != -1) {
79 fdtdec_get_alias_seq(gd->fdt_blob,
80 uc->uc_drv->name, of_offset,
86 if (!dev->platdata && drv->platdata_auto_alloc_size) {
87 dev->flags |= DM_FLAG_ALLOC_PDATA;
88 dev->platdata = calloc(1, drv->platdata_auto_alloc_size);
95 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
97 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
98 dev->uclass_platdata = calloc(1, size);
99 if (!dev->uclass_platdata) {
106 size = parent->driver->per_child_platdata_auto_alloc_size;
108 size = parent->uclass->uc_drv->
109 per_child_platdata_auto_alloc_size;
112 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
113 dev->parent_platdata = calloc(1, size);
114 if (!dev->parent_platdata) {
121 /* put dev into parent's successor list */
123 list_add_tail(&dev->sibling_node, &parent->child_head);
125 ret = uclass_bind_device(dev);
127 goto fail_uclass_bind;
129 /* if we fail to bind we remove device from successors and free it */
131 ret = drv->bind(dev);
135 if (parent && parent->driver->child_post_bind) {
136 ret = parent->driver->child_post_bind(dev);
138 goto fail_child_post_bind;
140 if (uc->uc_drv->post_bind) {
141 ret = uc->uc_drv->post_bind(dev);
143 goto fail_uclass_post_bind;
147 dm_dbg("Bound device %s to %s\n", dev->name, parent->name);
151 dev->flags |= DM_FLAG_BOUND;
155 fail_uclass_post_bind:
156 /* There is no child unbind() method, so no clean-up required */
157 fail_child_post_bind:
158 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
159 if (drv->unbind && drv->unbind(dev)) {
160 dm_warn("unbind() method failed on dev '%s' on error path\n",
166 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
167 if (uclass_unbind_device(dev)) {
168 dm_warn("Failed to unbind dev '%s' on error path\n",
173 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
174 list_del(&dev->sibling_node);
175 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
176 free(dev->parent_platdata);
177 dev->parent_platdata = NULL;
181 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
182 free(dev->uclass_platdata);
183 dev->uclass_platdata = NULL;
186 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
188 dev->platdata = NULL;
191 devres_release_all(dev);
198 int device_bind_with_driver_data(struct udevice *parent,
199 const struct driver *drv, const char *name,
200 ulong driver_data, int of_offset,
201 struct udevice **devp)
203 return device_bind_common(parent, drv, name, NULL, driver_data,
207 int device_bind(struct udevice *parent, const struct driver *drv,
208 const char *name, void *platdata, int of_offset,
209 struct udevice **devp)
211 return device_bind_common(parent, drv, name, platdata, 0, of_offset,
215 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
216 const struct driver_info *info, struct udevice **devp)
220 drv = lists_driver_lookup_name(info->name);
223 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
226 return device_bind(parent, drv, info->name, (void *)info->platdata,
230 static void *alloc_priv(int size, uint flags)
234 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
235 priv = memalign(ARCH_DMA_MINALIGN, size);
237 memset(priv, '\0', size);
239 priv = calloc(1, size);
245 int device_probe(struct udevice *dev)
247 const struct driver *drv;
255 if (dev->flags & DM_FLAG_ACTIVATED)
261 /* Allocate private data if requested and not reentered */
262 if (drv->priv_auto_alloc_size && !dev->priv) {
263 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
269 /* Allocate private data if requested and not reentered */
270 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
271 if (size && !dev->uclass_priv) {
272 dev->uclass_priv = calloc(1, size);
273 if (!dev->uclass_priv) {
279 /* Ensure all parents are probed */
281 size = dev->parent->driver->per_child_auto_alloc_size;
283 size = dev->parent->uclass->uc_drv->
284 per_child_auto_alloc_size;
286 if (size && !dev->parent_priv) {
287 dev->parent_priv = alloc_priv(size, drv->flags);
288 if (!dev->parent_priv) {
294 ret = device_probe(dev->parent);
299 * The device might have already been probed during
300 * the call to device_probe() on its parent device
301 * (e.g. PCI bridge devices). Test the flags again
302 * so that we don't mess up the device.
304 if (dev->flags & DM_FLAG_ACTIVATED)
308 seq = uclass_resolve_seq(dev);
315 dev->flags |= DM_FLAG_ACTIVATED;
318 * Process pinctrl for everything except the root device, and
319 * continue regardless of the result of pinctrl. Don't process pinctrl
320 * settings for pinctrl devices since the device may not yet be
323 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
324 pinctrl_select_state(dev, "default");
326 ret = uclass_pre_probe_device(dev);
330 if (dev->parent && dev->parent->driver->child_pre_probe) {
331 ret = dev->parent->driver->child_pre_probe(dev);
336 if (drv->ofdata_to_platdata && dev->of_offset >= 0) {
337 ret = drv->ofdata_to_platdata(dev);
343 ret = drv->probe(dev);
345 dev->flags &= ~DM_FLAG_ACTIVATED;
350 ret = uclass_post_probe_device(dev);
354 if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
355 pinctrl_select_state(dev, "default");
359 if (device_remove(dev)) {
360 dm_warn("%s: Device '%s' failed to remove on error path\n",
361 __func__, dev->name);
364 dev->flags &= ~DM_FLAG_ACTIVATED;
372 void *dev_get_platdata(struct udevice *dev)
375 dm_warn("%s: null device\n", __func__);
379 return dev->platdata;
382 void *dev_get_parent_platdata(struct udevice *dev)
385 dm_warn("%s: null device\n", __func__);
389 return dev->parent_platdata;
392 void *dev_get_uclass_platdata(struct udevice *dev)
395 dm_warn("%s: null device\n", __func__);
399 return dev->uclass_platdata;
402 void *dev_get_priv(struct udevice *dev)
405 dm_warn("%s: null device\n", __func__);
412 void *dev_get_uclass_priv(struct udevice *dev)
415 dm_warn("%s: null device\n", __func__);
419 return dev->uclass_priv;
422 void *dev_get_parent_priv(struct udevice *dev)
425 dm_warn("%s: null device\n", __func__);
429 return dev->parent_priv;
432 static int device_get_device_tail(struct udevice *dev, int ret,
433 struct udevice **devp)
438 ret = device_probe(dev);
447 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
451 list_for_each_entry(dev, &parent->child_head, sibling_node) {
453 return device_get_device_tail(dev, 0, devp);
459 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
460 bool find_req_seq, struct udevice **devp)
465 if (seq_or_req_seq == -1)
468 list_for_each_entry(dev, &parent->child_head, sibling_node) {
469 if ((find_req_seq ? dev->req_seq : dev->seq) ==
479 int device_get_child_by_seq(struct udevice *parent, int seq,
480 struct udevice **devp)
486 ret = device_find_child_by_seq(parent, seq, false, &dev);
487 if (ret == -ENODEV) {
489 * We didn't find it in probed devices. See if there is one
490 * that will request this seq if probed.
492 ret = device_find_child_by_seq(parent, seq, true, &dev);
494 return device_get_device_tail(dev, ret, devp);
497 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
498 struct udevice **devp)
504 list_for_each_entry(dev, &parent->child_head, sibling_node) {
505 if (dev->of_offset == of_offset) {
514 int device_get_child_by_of_offset(struct udevice *parent, int node,
515 struct udevice **devp)
521 ret = device_find_child_by_of_offset(parent, node, &dev);
522 return device_get_device_tail(dev, ret, devp);
525 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
528 struct udevice *dev, *found;
530 if (parent->of_offset == of_offset)
533 list_for_each_entry(dev, &parent->child_head, sibling_node) {
534 found = _device_find_global_by_of_offset(dev, of_offset);
542 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
546 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
547 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
550 int device_find_first_child(struct udevice *parent, struct udevice **devp)
552 if (list_empty(&parent->child_head)) {
555 *devp = list_first_entry(&parent->child_head, struct udevice,
562 int device_find_next_child(struct udevice **devp)
564 struct udevice *dev = *devp;
565 struct udevice *parent = dev->parent;
567 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
570 *devp = list_entry(dev->sibling_node.next, struct udevice,
577 struct udevice *dev_get_parent(struct udevice *child)
579 return child->parent;
582 ulong dev_get_driver_data(struct udevice *dev)
584 return dev->driver_data;
587 const void *dev_get_driver_ops(struct udevice *dev)
589 if (!dev || !dev->driver->ops)
592 return dev->driver->ops;
595 enum uclass_id device_get_uclass_id(struct udevice *dev)
597 return dev->uclass->uc_drv->id;
600 const char *dev_get_uclass_name(struct udevice *dev)
605 return dev->uclass->uc_drv->name;
608 fdt_addr_t dev_get_addr_index(struct udevice *dev, int index)
610 #if CONFIG_IS_ENABLED(OF_CONTROL)
613 if (CONFIG_IS_ENABLED(OF_TRANSLATE)) {
618 na = fdt_address_cells(gd->fdt_blob, dev->parent->of_offset);
620 debug("bad #address-cells\n");
621 return FDT_ADDR_T_NONE;
624 ns = fdt_size_cells(gd->fdt_blob, dev->parent->of_offset);
626 debug("bad #size-cells\n");
627 return FDT_ADDR_T_NONE;
630 reg = fdt_getprop(gd->fdt_blob, dev->of_offset, "reg", &len);
631 if (!reg || (len <= (index * sizeof(fdt32_t) * (na + ns)))) {
632 debug("Req index out of range\n");
633 return FDT_ADDR_T_NONE;
636 reg += index * (na + ns);
639 * Use the full-fledged translate function for complex
642 addr = fdt_translate_address((void *)gd->fdt_blob,
643 dev->of_offset, reg);
646 * Use the "simple" translate function for less complex
649 addr = fdtdec_get_addr_size_auto_parent(gd->fdt_blob,
650 dev->parent->of_offset,
651 dev->of_offset, "reg",
653 if (CONFIG_IS_ENABLED(SIMPLE_BUS) && addr != FDT_ADDR_T_NONE) {
654 if (device_get_uclass_id(dev->parent) ==
656 addr = simple_bus_translate(dev->parent, addr);
661 * Some platforms need a special address translation. Those
662 * platforms (e.g. mvebu in SPL) can configure a translation
663 * offset in the DM by calling dm_set_translation_offset() that
664 * will get added to all addresses returned by dev_get_addr().
666 addr += dm_get_translation_offset();
670 return FDT_ADDR_T_NONE;
674 fdt_addr_t dev_get_addr_name(struct udevice *dev, const char *name)
676 #if CONFIG_IS_ENABLED(OF_CONTROL)
679 index = fdt_find_string(gd->fdt_blob, dev->of_offset, "reg-names",
684 return dev_get_addr_index(dev, index);
686 return FDT_ADDR_T_NONE;
690 fdt_addr_t dev_get_addr(struct udevice *dev)
692 return dev_get_addr_index(dev, 0);
695 void *dev_get_addr_ptr(struct udevice *dev)
697 return (void *)(uintptr_t)dev_get_addr_index(dev, 0);
700 bool device_has_children(struct udevice *dev)
702 return !list_empty(&dev->child_head);
705 bool device_has_active_children(struct udevice *dev)
707 struct udevice *child;
709 for (device_find_first_child(dev, &child);
711 device_find_next_child(&child)) {
712 if (device_active(child))
719 bool device_is_last_sibling(struct udevice *dev)
721 struct udevice *parent = dev->parent;
725 return list_is_last(&dev->sibling_node, &parent->child_head);
728 void device_set_name_alloced(struct udevice *dev)
730 dev->flags |= DM_NAME_ALLOCED;
733 int device_set_name(struct udevice *dev, const char *name)
739 device_set_name_alloced(dev);
744 bool of_device_is_compatible(struct udevice *dev, const char *compat)
746 const void *fdt = gd->fdt_blob;
748 return !fdt_node_check_compatible(fdt, dev->of_offset, compat);
751 bool of_machine_is_compatible(const char *compat)
753 const void *fdt = gd->fdt_blob;
755 return !fdt_node_check_compatible(fdt, 0, compat);