1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2013 Google, Inc
8 * Pavel Herrmann <morpheus.ibis@gmail.com>
17 #include <fdt_support.h>
19 #include <asm/cache.h>
20 #include <dm/device.h>
21 #include <dm/device-internal.h>
23 #include <dm/of_access.h>
24 #include <dm/pinctrl.h>
25 #include <dm/platdata.h>
27 #include <dm/uclass.h>
28 #include <dm/uclass-internal.h>
30 #include <linux/err.h>
31 #include <linux/list.h>
32 #include <power-domain.h>
34 DECLARE_GLOBAL_DATA_PTR;
36 static int device_bind_common(struct udevice *parent, const struct driver *drv,
37 const char *name, void *plat,
38 ulong driver_data, ofnode node,
39 uint of_plat_size, struct udevice **devp)
50 ret = uclass_get(drv->id, &uc);
52 debug("Missing uclass for driver %s\n", drv->name);
56 dev = calloc(1, sizeof(struct udevice));
60 INIT_LIST_HEAD(&dev->sibling_node);
61 INIT_LIST_HEAD(&dev->child_head);
62 INIT_LIST_HEAD(&dev->uclass_node);
64 INIT_LIST_HEAD(&dev->devres_head);
67 dev->driver_data = driver_data;
76 if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
77 (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS)) {
79 * Some devices, such as a SPI bus, I2C bus and serial ports
80 * are numbered using aliases.
82 * This is just a 'requested' sequence, and will be
83 * resolved (and ->seq updated) when the device is probed.
85 if (CONFIG_IS_ENABLED(OF_CONTROL) &&
86 !CONFIG_IS_ENABLED(OF_PLATDATA)) {
87 if (uc->uc_drv->name && ofnode_valid(node))
88 dev_read_alias_seq(dev, &dev->req_seq);
89 #if CONFIG_IS_ENABLED(OF_PRIOR_STAGE)
90 if (dev->req_seq == -1)
92 uclass_find_next_free_req_seq(uc);
95 dev->req_seq = uclass_find_next_free_req_seq(uc);
102 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
104 dev->flags |= DM_FLAG_OF_PLATDATA;
105 if (of_plat_size < drv->plat_auto)
110 dev->flags |= DM_FLAG_ALLOC_PDATA;
111 dev->plat = calloc(1, drv->plat_auto);
116 if (CONFIG_IS_ENABLED(OF_PLATDATA) && plat) {
117 memcpy(dev->plat, plat, of_plat_size);
122 size = uc->uc_drv->per_device_plat_auto;
124 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
125 dev->uclass_plat = calloc(1, size);
126 if (!dev->uclass_plat) {
133 size = parent->driver->per_child_plat_auto;
135 size = parent->uclass->uc_drv->per_child_plat_auto;
138 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
139 dev->parent_plat = calloc(1, size);
140 if (!dev->parent_plat) {
145 /* put dev into parent's successor list */
146 list_add_tail(&dev->sibling_node, &parent->child_head);
149 ret = uclass_bind_device(dev);
151 goto fail_uclass_bind;
153 /* if we fail to bind we remove device from successors and free it */
155 ret = drv->bind(dev);
159 if (parent && parent->driver->child_post_bind) {
160 ret = parent->driver->child_post_bind(dev);
162 goto fail_child_post_bind;
164 if (uc->uc_drv->post_bind) {
165 ret = uc->uc_drv->post_bind(dev);
167 goto fail_uclass_post_bind;
171 pr_debug("Bound device %s to %s\n", dev->name, parent->name);
175 dev->flags |= DM_FLAG_BOUND;
179 fail_uclass_post_bind:
180 /* There is no child unbind() method, so no clean-up required */
181 fail_child_post_bind:
182 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
183 if (drv->unbind && drv->unbind(dev)) {
184 dm_warn("unbind() method failed on dev '%s' on error path\n",
190 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
191 if (uclass_unbind_device(dev)) {
192 dm_warn("Failed to unbind dev '%s' on error path\n",
197 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
198 list_del(&dev->sibling_node);
199 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
200 free(dev->parent_plat);
201 dev->parent_plat = NULL;
205 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
206 free(dev->uclass_plat);
207 dev->uclass_plat = NULL;
210 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
215 devres_release_all(dev);
222 int device_bind_with_driver_data(struct udevice *parent,
223 const struct driver *drv, const char *name,
224 ulong driver_data, ofnode node,
225 struct udevice **devp)
227 return device_bind_common(parent, drv, name, NULL, driver_data, node,
231 int device_bind(struct udevice *parent, const struct driver *drv,
232 const char *name, void *plat, ofnode node,
233 struct udevice **devp)
235 return device_bind_common(parent, drv, name, plat, 0, node, 0,
239 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
240 const struct driver_info *info, struct udevice **devp)
246 drv = lists_driver_lookup_name(info->name);
249 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
252 #if CONFIG_IS_ENABLED(OF_PLATDATA)
253 plat_size = info->plat_size;
255 ret = device_bind_common(parent, drv, info->name, (void *)info->plat, 0,
256 ofnode_null(), plat_size, devp);
263 int device_reparent(struct udevice *dev, struct udevice *new_parent)
265 struct udevice *pos, *n;
270 list_for_each_entry_safe(pos, n, &dev->parent->child_head,
272 if (pos->driver != dev->driver)
275 list_del(&dev->sibling_node);
276 list_add_tail(&dev->sibling_node, &new_parent->child_head);
277 dev->parent = new_parent;
285 static void *alloc_priv(int size, uint flags)
289 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
290 size = ROUND(size, ARCH_DMA_MINALIGN);
291 priv = memalign(ARCH_DMA_MINALIGN, size);
293 memset(priv, '\0', size);
296 * Ensure that the zero bytes are flushed to memory.
297 * This prevents problems if the driver uses this as
298 * both an input and an output buffer:
300 * 1. Zeroes written to buffer (here) and sit in the
302 * 2. Driver issues a read command to DMA
303 * 3. CPU runs out of cache space and evicts some cache
304 * data in the buffer, writing zeroes to RAM from
307 * 5. Buffer now has some DMA data and some zeroes
308 * 6. Data being read is now incorrect
310 * To prevent this, ensure that the cache is clean
311 * within this range at the start. The driver can then
312 * use normal flush-after-write, invalidate-before-read
315 * TODO(sjg@chromium.org): Drop this microblaze
318 #ifndef CONFIG_MICROBLAZE
319 flush_dcache_range((ulong)priv, (ulong)priv + size);
323 priv = calloc(1, size);
329 int device_of_to_plat(struct udevice *dev)
331 const struct driver *drv;
338 if (dev->flags & DM_FLAG_PLATDATA_VALID)
341 /* Ensure all parents have ofdata */
343 ret = device_of_to_plat(dev->parent);
348 * The device might have already been probed during
349 * the call to device_probe() on its parent device
350 * (e.g. PCI bridge devices). Test the flags again
351 * so that we don't mess up the device.
353 if (dev->flags & DM_FLAG_PLATDATA_VALID)
360 /* Allocate private data if requested and not reentered */
361 if (drv->priv_auto && !dev->priv) {
362 dev->priv = alloc_priv(drv->priv_auto, drv->flags);
368 /* Allocate private data if requested and not reentered */
369 size = dev->uclass->uc_drv->per_device_auto;
370 if (size && !dev->uclass_priv) {
371 dev->uclass_priv = alloc_priv(size,
372 dev->uclass->uc_drv->flags);
373 if (!dev->uclass_priv) {
379 /* Allocate parent data for this child */
381 size = dev->parent->driver->per_child_auto;
383 size = dev->parent->uclass->uc_drv->per_child_auto;
385 if (size && !dev->parent_priv) {
386 dev->parent_priv = alloc_priv(size, drv->flags);
387 if (!dev->parent_priv) {
394 if (drv->of_to_plat &&
395 (CONFIG_IS_ENABLED(OF_PLATDATA) || dev_has_of_node(dev))) {
396 ret = drv->of_to_plat(dev);
401 dev->flags |= DM_FLAG_PLATDATA_VALID;
410 int device_probe(struct udevice *dev)
412 const struct driver *drv;
419 if (dev->flags & DM_FLAG_ACTIVATED)
425 ret = device_of_to_plat(dev);
429 /* Ensure all parents are probed */
431 ret = device_probe(dev->parent);
436 * The device might have already been probed during
437 * the call to device_probe() on its parent device
438 * (e.g. PCI bridge devices). Test the flags again
439 * so that we don't mess up the device.
441 if (dev->flags & DM_FLAG_ACTIVATED)
445 seq = uclass_resolve_seq(dev);
452 dev->flags |= DM_FLAG_ACTIVATED;
455 * Process pinctrl for everything except the root device, and
456 * continue regardless of the result of pinctrl. Don't process pinctrl
457 * settings for pinctrl devices since the device may not yet be
460 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
461 pinctrl_select_state(dev, "default");
463 if (CONFIG_IS_ENABLED(POWER_DOMAIN) && dev->parent &&
464 (device_get_uclass_id(dev) != UCLASS_POWER_DOMAIN) &&
465 !(drv->flags & DM_FLAG_DEFAULT_PD_CTRL_OFF)) {
466 ret = dev_power_domain_on(dev);
471 ret = uclass_pre_probe_device(dev);
475 if (dev->parent && dev->parent->driver->child_pre_probe) {
476 ret = dev->parent->driver->child_pre_probe(dev);
481 /* Only handle devices that have a valid ofnode */
482 if (dev_of_valid(dev)) {
484 * Process 'assigned-{clocks/clock-parents/clock-rates}'
487 ret = clk_set_defaults(dev, 0);
493 ret = drv->probe(dev);
498 ret = uclass_post_probe_device(dev);
502 if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
503 pinctrl_select_state(dev, "default");
507 if (device_remove(dev, DM_REMOVE_NORMAL)) {
508 dm_warn("%s: Device '%s' failed to remove on error path\n",
509 __func__, dev->name);
512 dev->flags &= ~DM_FLAG_ACTIVATED;
520 void *dev_get_plat(const struct udevice *dev)
523 dm_warn("%s: null device\n", __func__);
530 void *dev_get_parent_plat(const struct udevice *dev)
533 dm_warn("%s: null device\n", __func__);
537 return dev->parent_plat;
540 void *dev_get_uclass_plat(const struct udevice *dev)
543 dm_warn("%s: null device\n", __func__);
547 return dev->uclass_plat;
550 void *dev_get_priv(const struct udevice *dev)
553 dm_warn("%s: null device\n", __func__);
560 void *dev_get_uclass_priv(const struct udevice *dev)
563 dm_warn("%s: null device\n", __func__);
567 return dev->uclass_priv;
570 void *dev_get_parent_priv(const struct udevice *dev)
573 dm_warn("%s: null device\n", __func__);
577 return dev->parent_priv;
580 static int device_get_device_tail(struct udevice *dev, int ret,
581 struct udevice **devp)
586 ret = device_probe(dev);
595 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
597 * device_find_by_ofnode() - Return device associated with given ofnode
599 * The returned device is *not* activated.
601 * @node: The ofnode for which a associated device should be looked up
602 * @devp: Pointer to structure to hold the found device
603 * Return: 0 if OK, -ve on error
605 static int device_find_by_ofnode(ofnode node, struct udevice **devp)
611 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
612 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node,
624 int device_get_child(const struct udevice *parent, int index,
625 struct udevice **devp)
629 list_for_each_entry(dev, &parent->child_head, sibling_node) {
631 return device_get_device_tail(dev, 0, devp);
637 int device_get_child_count(const struct udevice *parent)
642 list_for_each_entry(dev, &parent->child_head, sibling_node)
648 int device_find_child_by_seq(const struct udevice *parent, int seq_or_req_seq,
649 bool find_req_seq, struct udevice **devp)
654 if (seq_or_req_seq == -1)
657 list_for_each_entry(dev, &parent->child_head, sibling_node) {
658 if ((find_req_seq ? dev->req_seq : dev_seq(dev)) ==
668 int device_get_child_by_seq(const struct udevice *parent, int seq,
669 struct udevice **devp)
675 ret = device_find_child_by_seq(parent, seq, false, &dev);
676 if (ret == -ENODEV) {
678 * We didn't find it in probed devices. See if there is one
679 * that will request this seq if probed.
681 ret = device_find_child_by_seq(parent, seq, true, &dev);
683 return device_get_device_tail(dev, ret, devp);
686 int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
687 struct udevice **devp)
693 list_for_each_entry(dev, &parent->child_head, sibling_node) {
694 if (dev_of_offset(dev) == of_offset) {
703 int device_get_child_by_of_offset(const struct udevice *parent, int node,
704 struct udevice **devp)
710 ret = device_find_child_by_of_offset(parent, node, &dev);
711 return device_get_device_tail(dev, ret, devp);
714 static struct udevice *_device_find_global_by_ofnode(struct udevice *parent,
717 struct udevice *dev, *found;
719 if (ofnode_equal(dev_ofnode(parent), ofnode))
722 list_for_each_entry(dev, &parent->child_head, sibling_node) {
723 found = _device_find_global_by_ofnode(dev, ofnode);
731 int device_find_global_by_ofnode(ofnode ofnode, struct udevice **devp)
733 *devp = _device_find_global_by_ofnode(gd->dm_root, ofnode);
735 return *devp ? 0 : -ENOENT;
738 int device_get_global_by_ofnode(ofnode ofnode, struct udevice **devp)
742 dev = _device_find_global_by_ofnode(gd->dm_root, ofnode);
743 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
746 #if CONFIG_IS_ENABLED(OF_PLATDATA)
747 int device_get_by_driver_info(const struct driver_info *info,
748 struct udevice **devp)
750 struct driver_info *info_base =
751 ll_entry_start(struct driver_info, driver_info);
752 int idx = info - info_base;
753 struct driver_rt *drt = gd_dm_driver_rt() + idx;
759 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
762 int device_get_by_driver_info_idx(uint idx, struct udevice **devp)
764 struct driver_rt *drt = gd_dm_driver_rt() + idx;
770 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
774 int device_find_first_child(const struct udevice *parent, struct udevice **devp)
776 if (list_empty(&parent->child_head)) {
779 *devp = list_first_entry(&parent->child_head, struct udevice,
786 int device_find_next_child(struct udevice **devp)
788 struct udevice *dev = *devp;
789 struct udevice *parent = dev->parent;
791 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
794 *devp = list_entry(dev->sibling_node.next, struct udevice,
801 int device_find_first_inactive_child(const struct udevice *parent,
802 enum uclass_id uclass_id,
803 struct udevice **devp)
808 list_for_each_entry(dev, &parent->child_head, sibling_node) {
809 if (!device_active(dev) &&
810 device_get_uclass_id(dev) == uclass_id) {
819 int device_find_first_child_by_uclass(const struct udevice *parent,
820 enum uclass_id uclass_id,
821 struct udevice **devp)
826 list_for_each_entry(dev, &parent->child_head, sibling_node) {
827 if (device_get_uclass_id(dev) == uclass_id) {
836 int device_find_child_by_name(const struct udevice *parent, const char *name,
837 struct udevice **devp)
843 list_for_each_entry(dev, &parent->child_head, sibling_node) {
844 if (!strcmp(dev->name, name)) {
853 int device_first_child_err(struct udevice *parent, struct udevice **devp)
857 device_find_first_child(parent, &dev);
861 return device_get_device_tail(dev, 0, devp);
864 int device_next_child_err(struct udevice **devp)
866 struct udevice *dev = *devp;
868 device_find_next_child(&dev);
872 return device_get_device_tail(dev, 0, devp);
875 int device_first_child_ofdata_err(struct udevice *parent, struct udevice **devp)
880 device_find_first_child(parent, &dev);
884 ret = device_of_to_plat(dev);
893 int device_next_child_ofdata_err(struct udevice **devp)
895 struct udevice *dev = *devp;
898 device_find_next_child(&dev);
902 ret = device_of_to_plat(dev);
911 struct udevice *dev_get_parent(const struct udevice *child)
913 return child->parent;
916 ulong dev_get_driver_data(const struct udevice *dev)
918 return dev->driver_data;
921 const void *dev_get_driver_ops(const struct udevice *dev)
923 if (!dev || !dev->driver->ops)
926 return dev->driver->ops;
929 enum uclass_id device_get_uclass_id(const struct udevice *dev)
931 return dev->uclass->uc_drv->id;
934 const char *dev_get_uclass_name(const struct udevice *dev)
939 return dev->uclass->uc_drv->name;
942 bool device_has_children(const struct udevice *dev)
944 return !list_empty(&dev->child_head);
947 bool device_has_active_children(const struct udevice *dev)
949 struct udevice *child;
951 for (device_find_first_child(dev, &child);
953 device_find_next_child(&child)) {
954 if (device_active(child))
961 bool device_is_last_sibling(const struct udevice *dev)
963 struct udevice *parent = dev->parent;
967 return list_is_last(&dev->sibling_node, &parent->child_head);
970 void device_set_name_alloced(struct udevice *dev)
972 dev->flags |= DM_FLAG_NAME_ALLOCED;
975 int device_set_name(struct udevice *dev, const char *name)
981 device_set_name_alloced(dev);
986 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
987 bool device_is_compatible(const struct udevice *dev, const char *compat)
989 return ofnode_device_is_compatible(dev_ofnode(dev), compat);
992 bool of_machine_is_compatible(const char *compat)
994 const void *fdt = gd->fdt_blob;
996 return !fdt_node_check_compatible(fdt, 0, compat);
999 int dev_disable_by_path(const char *path)
1002 ofnode node = ofnode_path(path);
1003 struct udevice *dev;
1006 if (!of_live_active())
1009 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
1010 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node, &dev);
1018 ret = device_remove(dev, DM_REMOVE_NORMAL);
1022 ret = device_unbind(dev);
1026 return ofnode_set_enabled(node, false);
1029 int dev_enable_by_path(const char *path)
1031 ofnode node = ofnode_path(path);
1032 ofnode pnode = ofnode_get_parent(node);
1033 struct udevice *parent;
1036 if (!of_live_active())
1039 ret = device_find_by_ofnode(pnode, &parent);
1043 ret = ofnode_set_enabled(node, true);
1047 return lists_bind_fdt(parent, node, NULL, false);