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 *platdata,
38 ulong driver_data, ofnode node,
39 uint of_platdata_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);
66 dev->platdata = platdata;
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) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
86 if (uc->uc_drv->name && ofnode_valid(node))
87 dev_read_alias_seq(dev, &dev->req_seq);
88 #if CONFIG_IS_ENABLED(OF_PRIOR_STAGE)
89 if (dev->req_seq == -1)
91 uclass_find_next_free_req_seq(drv->id);
94 dev->req_seq = uclass_find_next_free_req_seq(drv->id);
98 if (drv->platdata_auto_alloc_size) {
99 bool alloc = !platdata;
101 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
102 if (of_platdata_size) {
103 dev->flags |= DM_FLAG_OF_PLATDATA;
104 if (of_platdata_size <
105 drv->platdata_auto_alloc_size)
110 dev->flags |= DM_FLAG_ALLOC_PDATA;
111 dev->platdata = calloc(1,
112 drv->platdata_auto_alloc_size);
113 if (!dev->platdata) {
117 if (CONFIG_IS_ENABLED(OF_PLATDATA) && platdata) {
118 memcpy(dev->platdata, platdata,
124 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
126 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
127 dev->uclass_platdata = calloc(1, size);
128 if (!dev->uclass_platdata) {
135 size = parent->driver->per_child_platdata_auto_alloc_size;
137 size = parent->uclass->uc_drv->
138 per_child_platdata_auto_alloc_size;
141 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
142 dev->parent_platdata = calloc(1, size);
143 if (!dev->parent_platdata) {
148 /* put dev into parent's successor list */
149 list_add_tail(&dev->sibling_node, &parent->child_head);
152 ret = uclass_bind_device(dev);
154 goto fail_uclass_bind;
156 /* if we fail to bind we remove device from successors and free it */
158 ret = drv->bind(dev);
162 if (parent && parent->driver->child_post_bind) {
163 ret = parent->driver->child_post_bind(dev);
165 goto fail_child_post_bind;
167 if (uc->uc_drv->post_bind) {
168 ret = uc->uc_drv->post_bind(dev);
170 goto fail_uclass_post_bind;
174 pr_debug("Bound device %s to %s\n", dev->name, parent->name);
178 dev->flags |= DM_FLAG_BOUND;
182 fail_uclass_post_bind:
183 /* There is no child unbind() method, so no clean-up required */
184 fail_child_post_bind:
185 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
186 if (drv->unbind && drv->unbind(dev)) {
187 dm_warn("unbind() method failed on dev '%s' on error path\n",
193 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
194 if (uclass_unbind_device(dev)) {
195 dm_warn("Failed to unbind dev '%s' on error path\n",
200 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
201 list_del(&dev->sibling_node);
202 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
203 free(dev->parent_platdata);
204 dev->parent_platdata = NULL;
208 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
209 free(dev->uclass_platdata);
210 dev->uclass_platdata = NULL;
213 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
215 dev->platdata = NULL;
218 devres_release_all(dev);
225 int device_bind_with_driver_data(struct udevice *parent,
226 const struct driver *drv, const char *name,
227 ulong driver_data, ofnode node,
228 struct udevice **devp)
230 return device_bind_common(parent, drv, name, NULL, driver_data, node,
234 int device_bind(struct udevice *parent, const struct driver *drv,
235 const char *name, void *platdata, int of_offset,
236 struct udevice **devp)
238 return device_bind_common(parent, drv, name, platdata, 0,
239 offset_to_ofnode(of_offset), 0, devp);
242 int device_bind_ofnode(struct udevice *parent, const struct driver *drv,
243 const char *name, void *platdata, ofnode node,
244 struct udevice **devp)
246 return device_bind_common(parent, drv, name, platdata, 0, node, 0,
250 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
251 struct driver_info *info, struct udevice **devp)
254 uint platdata_size = 0;
257 drv = lists_driver_lookup_name(info->name);
260 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
263 #if CONFIG_IS_ENABLED(OF_PLATDATA)
264 platdata_size = info->platdata_size;
266 ret = device_bind_common(parent, drv, info->name,
267 (void *)info->platdata, 0, ofnode_null(),
268 platdata_size, devp);
271 #if CONFIG_IS_ENABLED(OF_PLATDATA)
278 static void *alloc_priv(int size, uint flags)
282 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
283 size = ROUND(size, ARCH_DMA_MINALIGN);
284 priv = memalign(ARCH_DMA_MINALIGN, size);
286 memset(priv, '\0', size);
289 * Ensure that the zero bytes are flushed to memory.
290 * This prevents problems if the driver uses this as
291 * both an input and an output buffer:
293 * 1. Zeroes written to buffer (here) and sit in the
295 * 2. Driver issues a read command to DMA
296 * 3. CPU runs out of cache space and evicts some cache
297 * data in the buffer, writing zeroes to RAM from
300 * 5. Buffer now has some DMA data and some zeroes
301 * 6. Data being read is now incorrect
303 * To prevent this, ensure that the cache is clean
304 * within this range at the start. The driver can then
305 * use normal flush-after-write, invalidate-before-read
308 * TODO(sjg@chromium.org): Drop this microblaze
311 #ifndef CONFIG_MICROBLAZE
312 flush_dcache_range((ulong)priv, (ulong)priv + size);
316 priv = calloc(1, size);
322 int device_ofdata_to_platdata(struct udevice *dev)
324 const struct driver *drv;
331 if (dev->flags & DM_FLAG_PLATDATA_VALID)
334 /* Ensure all parents have ofdata */
336 ret = device_ofdata_to_platdata(dev->parent);
341 * The device might have already been probed during
342 * the call to device_probe() on its parent device
343 * (e.g. PCI bridge devices). Test the flags again
344 * so that we don't mess up the device.
346 if (dev->flags & DM_FLAG_PLATDATA_VALID)
353 /* Allocate private data if requested and not reentered */
354 if (drv->priv_auto_alloc_size && !dev->priv) {
355 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
361 /* Allocate private data if requested and not reentered */
362 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
363 if (size && !dev->uclass_priv) {
364 dev->uclass_priv = alloc_priv(size,
365 dev->uclass->uc_drv->flags);
366 if (!dev->uclass_priv) {
372 /* Allocate parent data for this child */
374 size = dev->parent->driver->per_child_auto_alloc_size;
376 size = dev->parent->uclass->uc_drv->
377 per_child_auto_alloc_size;
379 if (size && !dev->parent_priv) {
380 dev->parent_priv = alloc_priv(size, drv->flags);
381 if (!dev->parent_priv) {
388 if (drv->ofdata_to_platdata &&
389 (CONFIG_IS_ENABLED(OF_PLATDATA) || dev_has_of_node(dev))) {
390 ret = drv->ofdata_to_platdata(dev);
395 dev->flags |= DM_FLAG_PLATDATA_VALID;
404 int device_probe(struct udevice *dev)
406 const struct driver *drv;
413 if (dev->flags & DM_FLAG_ACTIVATED)
419 ret = device_ofdata_to_platdata(dev);
423 /* Ensure all parents are probed */
425 ret = device_probe(dev->parent);
430 * The device might have already been probed during
431 * the call to device_probe() on its parent device
432 * (e.g. PCI bridge devices). Test the flags again
433 * so that we don't mess up the device.
435 if (dev->flags & DM_FLAG_ACTIVATED)
439 seq = uclass_resolve_seq(dev);
446 dev->flags |= DM_FLAG_ACTIVATED;
449 * Process pinctrl for everything except the root device, and
450 * continue regardless of the result of pinctrl. Don't process pinctrl
451 * settings for pinctrl devices since the device may not yet be
454 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
455 pinctrl_select_state(dev, "default");
457 if (CONFIG_IS_ENABLED(POWER_DOMAIN) && dev->parent &&
458 (device_get_uclass_id(dev) != UCLASS_POWER_DOMAIN) &&
459 !(drv->flags & DM_FLAG_DEFAULT_PD_CTRL_OFF)) {
460 ret = dev_power_domain_on(dev);
465 ret = uclass_pre_probe_device(dev);
469 if (dev->parent && dev->parent->driver->child_pre_probe) {
470 ret = dev->parent->driver->child_pre_probe(dev);
475 /* Only handle devices that have a valid ofnode */
476 if (dev_of_valid(dev)) {
478 * Process 'assigned-{clocks/clock-parents/clock-rates}'
481 ret = clk_set_defaults(dev, 0);
487 ret = drv->probe(dev);
492 ret = uclass_post_probe_device(dev);
496 if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
497 pinctrl_select_state(dev, "default");
501 if (device_remove(dev, DM_REMOVE_NORMAL)) {
502 dm_warn("%s: Device '%s' failed to remove on error path\n",
503 __func__, dev->name);
506 dev->flags &= ~DM_FLAG_ACTIVATED;
514 void *dev_get_platdata(const struct udevice *dev)
517 dm_warn("%s: null device\n", __func__);
521 return dev->platdata;
524 void *dev_get_parent_platdata(const struct udevice *dev)
527 dm_warn("%s: null device\n", __func__);
531 return dev->parent_platdata;
534 void *dev_get_uclass_platdata(const struct udevice *dev)
537 dm_warn("%s: null device\n", __func__);
541 return dev->uclass_platdata;
544 void *dev_get_priv(const struct udevice *dev)
547 dm_warn("%s: null device\n", __func__);
554 void *dev_get_uclass_priv(const struct udevice *dev)
557 dm_warn("%s: null device\n", __func__);
561 return dev->uclass_priv;
564 void *dev_get_parent_priv(const struct udevice *dev)
567 dm_warn("%s: null device\n", __func__);
571 return dev->parent_priv;
574 static int device_get_device_tail(struct udevice *dev, int ret,
575 struct udevice **devp)
580 ret = device_probe(dev);
589 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
591 * device_find_by_ofnode() - Return device associated with given ofnode
593 * The returned device is *not* activated.
595 * @node: The ofnode for which a associated device should be looked up
596 * @devp: Pointer to structure to hold the found device
597 * Return: 0 if OK, -ve on error
599 static int device_find_by_ofnode(ofnode node, struct udevice **devp)
605 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
606 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node,
618 int device_get_child(const struct udevice *parent, int index,
619 struct udevice **devp)
623 list_for_each_entry(dev, &parent->child_head, sibling_node) {
625 return device_get_device_tail(dev, 0, devp);
631 int device_get_child_count(const struct udevice *parent)
636 list_for_each_entry(dev, &parent->child_head, sibling_node)
642 int device_find_child_by_seq(const struct udevice *parent, int seq_or_req_seq,
643 bool find_req_seq, struct udevice **devp)
648 if (seq_or_req_seq == -1)
651 list_for_each_entry(dev, &parent->child_head, sibling_node) {
652 if ((find_req_seq ? dev->req_seq : dev->seq) ==
662 int device_get_child_by_seq(const struct udevice *parent, int seq,
663 struct udevice **devp)
669 ret = device_find_child_by_seq(parent, seq, false, &dev);
670 if (ret == -ENODEV) {
672 * We didn't find it in probed devices. See if there is one
673 * that will request this seq if probed.
675 ret = device_find_child_by_seq(parent, seq, true, &dev);
677 return device_get_device_tail(dev, ret, devp);
680 int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
681 struct udevice **devp)
687 list_for_each_entry(dev, &parent->child_head, sibling_node) {
688 if (dev_of_offset(dev) == of_offset) {
697 int device_get_child_by_of_offset(const struct udevice *parent, int node,
698 struct udevice **devp)
704 ret = device_find_child_by_of_offset(parent, node, &dev);
705 return device_get_device_tail(dev, ret, devp);
708 static struct udevice *_device_find_global_by_ofnode(struct udevice *parent,
711 struct udevice *dev, *found;
713 if (ofnode_equal(dev_ofnode(parent), ofnode))
716 list_for_each_entry(dev, &parent->child_head, sibling_node) {
717 found = _device_find_global_by_ofnode(dev, ofnode);
725 int device_find_global_by_ofnode(ofnode ofnode, struct udevice **devp)
727 *devp = _device_find_global_by_ofnode(gd->dm_root, ofnode);
729 return *devp ? 0 : -ENOENT;
732 int device_get_global_by_ofnode(ofnode ofnode, struct udevice **devp)
736 dev = _device_find_global_by_ofnode(gd->dm_root, ofnode);
737 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
740 #if CONFIG_IS_ENABLED(OF_PLATDATA)
741 int device_get_by_driver_info(const struct driver_info *info,
742 struct udevice **devp)
748 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
752 int device_find_first_child(const struct udevice *parent, struct udevice **devp)
754 if (list_empty(&parent->child_head)) {
757 *devp = list_first_entry(&parent->child_head, struct udevice,
764 int device_find_next_child(struct udevice **devp)
766 struct udevice *dev = *devp;
767 struct udevice *parent = dev->parent;
769 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
772 *devp = list_entry(dev->sibling_node.next, struct udevice,
779 int device_find_first_inactive_child(const struct udevice *parent,
780 enum uclass_id uclass_id,
781 struct udevice **devp)
786 list_for_each_entry(dev, &parent->child_head, sibling_node) {
787 if (!device_active(dev) &&
788 device_get_uclass_id(dev) == uclass_id) {
797 int device_find_first_child_by_uclass(const struct udevice *parent,
798 enum uclass_id uclass_id,
799 struct udevice **devp)
804 list_for_each_entry(dev, &parent->child_head, sibling_node) {
805 if (device_get_uclass_id(dev) == uclass_id) {
814 int device_find_child_by_name(const struct udevice *parent, const char *name,
815 struct udevice **devp)
821 list_for_each_entry(dev, &parent->child_head, sibling_node) {
822 if (!strcmp(dev->name, name)) {
831 int device_first_child_err(struct udevice *parent, struct udevice **devp)
835 device_find_first_child(parent, &dev);
839 return device_get_device_tail(dev, 0, devp);
842 int device_next_child_err(struct udevice **devp)
844 struct udevice *dev = *devp;
846 device_find_next_child(&dev);
850 return device_get_device_tail(dev, 0, devp);
853 int device_first_child_ofdata_err(struct udevice *parent, struct udevice **devp)
858 device_find_first_child(parent, &dev);
862 ret = device_ofdata_to_platdata(dev);
871 int device_next_child_ofdata_err(struct udevice **devp)
873 struct udevice *dev = *devp;
876 device_find_next_child(&dev);
880 ret = device_ofdata_to_platdata(dev);
889 struct udevice *dev_get_parent(const struct udevice *child)
891 return child->parent;
894 ulong dev_get_driver_data(const struct udevice *dev)
896 return dev->driver_data;
899 const void *dev_get_driver_ops(const struct udevice *dev)
901 if (!dev || !dev->driver->ops)
904 return dev->driver->ops;
907 enum uclass_id device_get_uclass_id(const struct udevice *dev)
909 return dev->uclass->uc_drv->id;
912 const char *dev_get_uclass_name(const struct udevice *dev)
917 return dev->uclass->uc_drv->name;
920 bool device_has_children(const struct udevice *dev)
922 return !list_empty(&dev->child_head);
925 bool device_has_active_children(const struct udevice *dev)
927 struct udevice *child;
929 for (device_find_first_child(dev, &child);
931 device_find_next_child(&child)) {
932 if (device_active(child))
939 bool device_is_last_sibling(const struct udevice *dev)
941 struct udevice *parent = dev->parent;
945 return list_is_last(&dev->sibling_node, &parent->child_head);
948 void device_set_name_alloced(struct udevice *dev)
950 dev->flags |= DM_FLAG_NAME_ALLOCED;
953 int device_set_name(struct udevice *dev, const char *name)
959 device_set_name_alloced(dev);
964 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
965 bool device_is_compatible(const struct udevice *dev, const char *compat)
967 return ofnode_device_is_compatible(dev_ofnode(dev), compat);
970 bool of_machine_is_compatible(const char *compat)
972 const void *fdt = gd->fdt_blob;
974 return !fdt_node_check_compatible(fdt, 0, compat);
977 int dev_disable_by_path(const char *path)
980 ofnode node = ofnode_path(path);
984 if (!of_live_active())
987 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
988 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node, &dev);
996 ret = device_remove(dev, DM_REMOVE_NORMAL);
1000 ret = device_unbind(dev);
1004 return ofnode_set_enabled(node, false);
1007 int dev_enable_by_path(const char *path)
1009 ofnode node = ofnode_path(path);
1010 ofnode pnode = ofnode_get_parent(node);
1011 struct udevice *parent;
1014 if (!of_live_active())
1017 ret = device_find_by_ofnode(pnode, &parent);
1021 ret = ofnode_set_enabled(node, true);
1025 return lists_bind_fdt(parent, node, NULL, false);