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) &&
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(drv->id);
95 dev->req_seq = uclass_find_next_free_req_seq(drv->id);
99 if (drv->platdata_auto_alloc_size) {
100 bool alloc = !platdata;
102 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
103 if (of_platdata_size) {
104 dev->flags |= DM_FLAG_OF_PLATDATA;
105 if (of_platdata_size <
106 drv->platdata_auto_alloc_size)
111 dev->flags |= DM_FLAG_ALLOC_PDATA;
112 dev->platdata = calloc(1,
113 drv->platdata_auto_alloc_size);
114 if (!dev->platdata) {
118 if (CONFIG_IS_ENABLED(OF_PLATDATA) && platdata) {
119 memcpy(dev->platdata, platdata,
125 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
127 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
128 dev->uclass_platdata = calloc(1, size);
129 if (!dev->uclass_platdata) {
136 size = parent->driver->per_child_platdata_auto_alloc_size;
138 size = parent->uclass->uc_drv->
139 per_child_platdata_auto_alloc_size;
142 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
143 dev->parent_platdata = calloc(1, size);
144 if (!dev->parent_platdata) {
149 /* put dev into parent's successor list */
150 list_add_tail(&dev->sibling_node, &parent->child_head);
153 ret = uclass_bind_device(dev);
155 goto fail_uclass_bind;
157 /* if we fail to bind we remove device from successors and free it */
159 ret = drv->bind(dev);
163 if (parent && parent->driver->child_post_bind) {
164 ret = parent->driver->child_post_bind(dev);
166 goto fail_child_post_bind;
168 if (uc->uc_drv->post_bind) {
169 ret = uc->uc_drv->post_bind(dev);
171 goto fail_uclass_post_bind;
175 pr_debug("Bound device %s to %s\n", dev->name, parent->name);
179 dev->flags |= DM_FLAG_BOUND;
183 fail_uclass_post_bind:
184 /* There is no child unbind() method, so no clean-up required */
185 fail_child_post_bind:
186 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
187 if (drv->unbind && drv->unbind(dev)) {
188 dm_warn("unbind() method failed on dev '%s' on error path\n",
194 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
195 if (uclass_unbind_device(dev)) {
196 dm_warn("Failed to unbind dev '%s' on error path\n",
201 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
202 list_del(&dev->sibling_node);
203 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
204 free(dev->parent_platdata);
205 dev->parent_platdata = NULL;
209 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
210 free(dev->uclass_platdata);
211 dev->uclass_platdata = NULL;
214 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
216 dev->platdata = NULL;
219 devres_release_all(dev);
226 int device_bind_with_driver_data(struct udevice *parent,
227 const struct driver *drv, const char *name,
228 ulong driver_data, ofnode node,
229 struct udevice **devp)
231 return device_bind_common(parent, drv, name, NULL, driver_data, node,
235 int device_bind(struct udevice *parent, const struct driver *drv,
236 const char *name, void *platdata, int of_offset,
237 struct udevice **devp)
239 return device_bind_common(parent, drv, name, platdata, 0,
240 offset_to_ofnode(of_offset), 0, devp);
243 int device_bind_ofnode(struct udevice *parent, const struct driver *drv,
244 const char *name, void *platdata, ofnode node,
245 struct udevice **devp)
247 return device_bind_common(parent, drv, name, platdata, 0, node, 0,
251 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
252 struct driver_info *info, struct udevice **devp)
255 uint platdata_size = 0;
258 drv = lists_driver_lookup_name(info->name);
261 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
264 #if CONFIG_IS_ENABLED(OF_PLATDATA)
265 platdata_size = info->platdata_size;
267 ret = device_bind_common(parent, drv, info->name,
268 (void *)info->platdata, 0, ofnode_null(),
269 platdata_size, devp);
272 #if CONFIG_IS_ENABLED(OF_PLATDATA)
279 static void *alloc_priv(int size, uint flags)
283 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
284 size = ROUND(size, ARCH_DMA_MINALIGN);
285 priv = memalign(ARCH_DMA_MINALIGN, size);
287 memset(priv, '\0', size);
290 * Ensure that the zero bytes are flushed to memory.
291 * This prevents problems if the driver uses this as
292 * both an input and an output buffer:
294 * 1. Zeroes written to buffer (here) and sit in the
296 * 2. Driver issues a read command to DMA
297 * 3. CPU runs out of cache space and evicts some cache
298 * data in the buffer, writing zeroes to RAM from
301 * 5. Buffer now has some DMA data and some zeroes
302 * 6. Data being read is now incorrect
304 * To prevent this, ensure that the cache is clean
305 * within this range at the start. The driver can then
306 * use normal flush-after-write, invalidate-before-read
309 * TODO(sjg@chromium.org): Drop this microblaze
312 #ifndef CONFIG_MICROBLAZE
313 flush_dcache_range((ulong)priv, (ulong)priv + size);
317 priv = calloc(1, size);
323 int device_ofdata_to_platdata(struct udevice *dev)
325 const struct driver *drv;
332 if (dev->flags & DM_FLAG_PLATDATA_VALID)
335 /* Ensure all parents have ofdata */
337 ret = device_ofdata_to_platdata(dev->parent);
342 * The device might have already been probed during
343 * the call to device_probe() on its parent device
344 * (e.g. PCI bridge devices). Test the flags again
345 * so that we don't mess up the device.
347 if (dev->flags & DM_FLAG_PLATDATA_VALID)
354 /* Allocate private data if requested and not reentered */
355 if (drv->priv_auto_alloc_size && !dev->priv) {
356 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
362 /* Allocate private data if requested and not reentered */
363 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
364 if (size && !dev->uclass_priv) {
365 dev->uclass_priv = alloc_priv(size,
366 dev->uclass->uc_drv->flags);
367 if (!dev->uclass_priv) {
373 /* Allocate parent data for this child */
375 size = dev->parent->driver->per_child_auto_alloc_size;
377 size = dev->parent->uclass->uc_drv->
378 per_child_auto_alloc_size;
380 if (size && !dev->parent_priv) {
381 dev->parent_priv = alloc_priv(size, drv->flags);
382 if (!dev->parent_priv) {
389 if (drv->ofdata_to_platdata &&
390 (CONFIG_IS_ENABLED(OF_PLATDATA) || dev_has_of_node(dev))) {
391 ret = drv->ofdata_to_platdata(dev);
396 dev->flags |= DM_FLAG_PLATDATA_VALID;
405 int device_probe(struct udevice *dev)
407 const struct driver *drv;
414 if (dev->flags & DM_FLAG_ACTIVATED)
420 ret = device_ofdata_to_platdata(dev);
424 /* Ensure all parents are probed */
426 ret = device_probe(dev->parent);
431 * The device might have already been probed during
432 * the call to device_probe() on its parent device
433 * (e.g. PCI bridge devices). Test the flags again
434 * so that we don't mess up the device.
436 if (dev->flags & DM_FLAG_ACTIVATED)
440 seq = uclass_resolve_seq(dev);
447 dev->flags |= DM_FLAG_ACTIVATED;
450 * Process pinctrl for everything except the root device, and
451 * continue regardless of the result of pinctrl. Don't process pinctrl
452 * settings for pinctrl devices since the device may not yet be
455 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
456 pinctrl_select_state(dev, "default");
458 if (CONFIG_IS_ENABLED(POWER_DOMAIN) && dev->parent &&
459 (device_get_uclass_id(dev) != UCLASS_POWER_DOMAIN) &&
460 !(drv->flags & DM_FLAG_DEFAULT_PD_CTRL_OFF)) {
461 ret = dev_power_domain_on(dev);
466 ret = uclass_pre_probe_device(dev);
470 if (dev->parent && dev->parent->driver->child_pre_probe) {
471 ret = dev->parent->driver->child_pre_probe(dev);
476 /* Only handle devices that have a valid ofnode */
477 if (dev_of_valid(dev)) {
479 * Process 'assigned-{clocks/clock-parents/clock-rates}'
482 ret = clk_set_defaults(dev, 0);
488 ret = drv->probe(dev);
493 ret = uclass_post_probe_device(dev);
497 if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
498 pinctrl_select_state(dev, "default");
502 if (device_remove(dev, DM_REMOVE_NORMAL)) {
503 dm_warn("%s: Device '%s' failed to remove on error path\n",
504 __func__, dev->name);
507 dev->flags &= ~DM_FLAG_ACTIVATED;
515 void *dev_get_platdata(const struct udevice *dev)
518 dm_warn("%s: null device\n", __func__);
522 return dev->platdata;
525 void *dev_get_parent_platdata(const struct udevice *dev)
528 dm_warn("%s: null device\n", __func__);
532 return dev->parent_platdata;
535 void *dev_get_uclass_platdata(const struct udevice *dev)
538 dm_warn("%s: null device\n", __func__);
542 return dev->uclass_platdata;
545 void *dev_get_priv(const struct udevice *dev)
548 dm_warn("%s: null device\n", __func__);
555 void *dev_get_uclass_priv(const struct udevice *dev)
558 dm_warn("%s: null device\n", __func__);
562 return dev->uclass_priv;
565 void *dev_get_parent_priv(const struct udevice *dev)
568 dm_warn("%s: null device\n", __func__);
572 return dev->parent_priv;
575 static int device_get_device_tail(struct udevice *dev, int ret,
576 struct udevice **devp)
581 ret = device_probe(dev);
590 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
592 * device_find_by_ofnode() - Return device associated with given ofnode
594 * The returned device is *not* activated.
596 * @node: The ofnode for which a associated device should be looked up
597 * @devp: Pointer to structure to hold the found device
598 * Return: 0 if OK, -ve on error
600 static int device_find_by_ofnode(ofnode node, struct udevice **devp)
606 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
607 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node,
619 int device_get_child(const struct udevice *parent, int index,
620 struct udevice **devp)
624 list_for_each_entry(dev, &parent->child_head, sibling_node) {
626 return device_get_device_tail(dev, 0, devp);
632 int device_get_child_count(const struct udevice *parent)
637 list_for_each_entry(dev, &parent->child_head, sibling_node)
643 int device_find_child_by_seq(const struct udevice *parent, int seq_or_req_seq,
644 bool find_req_seq, struct udevice **devp)
649 if (seq_or_req_seq == -1)
652 list_for_each_entry(dev, &parent->child_head, sibling_node) {
653 if ((find_req_seq ? dev->req_seq : dev->seq) ==
663 int device_get_child_by_seq(const struct udevice *parent, int seq,
664 struct udevice **devp)
670 ret = device_find_child_by_seq(parent, seq, false, &dev);
671 if (ret == -ENODEV) {
673 * We didn't find it in probed devices. See if there is one
674 * that will request this seq if probed.
676 ret = device_find_child_by_seq(parent, seq, true, &dev);
678 return device_get_device_tail(dev, ret, devp);
681 int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
682 struct udevice **devp)
688 list_for_each_entry(dev, &parent->child_head, sibling_node) {
689 if (dev_of_offset(dev) == of_offset) {
698 int device_get_child_by_of_offset(const struct udevice *parent, int node,
699 struct udevice **devp)
705 ret = device_find_child_by_of_offset(parent, node, &dev);
706 return device_get_device_tail(dev, ret, devp);
709 static struct udevice *_device_find_global_by_ofnode(struct udevice *parent,
712 struct udevice *dev, *found;
714 if (ofnode_equal(dev_ofnode(parent), ofnode))
717 list_for_each_entry(dev, &parent->child_head, sibling_node) {
718 found = _device_find_global_by_ofnode(dev, ofnode);
726 int device_find_global_by_ofnode(ofnode ofnode, struct udevice **devp)
728 *devp = _device_find_global_by_ofnode(gd->dm_root, ofnode);
730 return *devp ? 0 : -ENOENT;
733 int device_get_global_by_ofnode(ofnode ofnode, struct udevice **devp)
737 dev = _device_find_global_by_ofnode(gd->dm_root, ofnode);
738 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
741 #if CONFIG_IS_ENABLED(OF_PLATDATA)
742 int device_get_by_driver_info(const struct driver_info *info,
743 struct udevice **devp)
749 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
753 int device_find_first_child(const struct udevice *parent, struct udevice **devp)
755 if (list_empty(&parent->child_head)) {
758 *devp = list_first_entry(&parent->child_head, struct udevice,
765 int device_find_next_child(struct udevice **devp)
767 struct udevice *dev = *devp;
768 struct udevice *parent = dev->parent;
770 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
773 *devp = list_entry(dev->sibling_node.next, struct udevice,
780 int device_find_first_inactive_child(const struct udevice *parent,
781 enum uclass_id uclass_id,
782 struct udevice **devp)
787 list_for_each_entry(dev, &parent->child_head, sibling_node) {
788 if (!device_active(dev) &&
789 device_get_uclass_id(dev) == uclass_id) {
798 int device_find_first_child_by_uclass(const struct udevice *parent,
799 enum uclass_id uclass_id,
800 struct udevice **devp)
805 list_for_each_entry(dev, &parent->child_head, sibling_node) {
806 if (device_get_uclass_id(dev) == uclass_id) {
815 int device_find_child_by_name(const struct udevice *parent, const char *name,
816 struct udevice **devp)
822 list_for_each_entry(dev, &parent->child_head, sibling_node) {
823 if (!strcmp(dev->name, name)) {
832 int device_first_child_err(struct udevice *parent, struct udevice **devp)
836 device_find_first_child(parent, &dev);
840 return device_get_device_tail(dev, 0, devp);
843 int device_next_child_err(struct udevice **devp)
845 struct udevice *dev = *devp;
847 device_find_next_child(&dev);
851 return device_get_device_tail(dev, 0, devp);
854 int device_first_child_ofdata_err(struct udevice *parent, struct udevice **devp)
859 device_find_first_child(parent, &dev);
863 ret = device_ofdata_to_platdata(dev);
872 int device_next_child_ofdata_err(struct udevice **devp)
874 struct udevice *dev = *devp;
877 device_find_next_child(&dev);
881 ret = device_ofdata_to_platdata(dev);
890 struct udevice *dev_get_parent(const struct udevice *child)
892 return child->parent;
895 ulong dev_get_driver_data(const struct udevice *dev)
897 return dev->driver_data;
900 const void *dev_get_driver_ops(const struct udevice *dev)
902 if (!dev || !dev->driver->ops)
905 return dev->driver->ops;
908 enum uclass_id device_get_uclass_id(const struct udevice *dev)
910 return dev->uclass->uc_drv->id;
913 const char *dev_get_uclass_name(const struct udevice *dev)
918 return dev->uclass->uc_drv->name;
921 bool device_has_children(const struct udevice *dev)
923 return !list_empty(&dev->child_head);
926 bool device_has_active_children(const struct udevice *dev)
928 struct udevice *child;
930 for (device_find_first_child(dev, &child);
932 device_find_next_child(&child)) {
933 if (device_active(child))
940 bool device_is_last_sibling(const struct udevice *dev)
942 struct udevice *parent = dev->parent;
946 return list_is_last(&dev->sibling_node, &parent->child_head);
949 void device_set_name_alloced(struct udevice *dev)
951 dev->flags |= DM_FLAG_NAME_ALLOCED;
954 int device_set_name(struct udevice *dev, const char *name)
960 device_set_name_alloced(dev);
965 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
966 bool device_is_compatible(const struct udevice *dev, const char *compat)
968 return ofnode_device_is_compatible(dev_ofnode(dev), compat);
971 bool of_machine_is_compatible(const char *compat)
973 const void *fdt = gd->fdt_blob;
975 return !fdt_node_check_compatible(fdt, 0, compat);
978 int dev_disable_by_path(const char *path)
981 ofnode node = ofnode_path(path);
985 if (!of_live_active())
988 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
989 ret = uclass_find_device_by_ofnode(uc->uc_drv->id, node, &dev);
997 ret = device_remove(dev, DM_REMOVE_NORMAL);
1001 ret = device_unbind(dev);
1005 return ofnode_set_enabled(node, false);
1008 int dev_enable_by_path(const char *path)
1010 ofnode node = ofnode_path(path);
1011 ofnode pnode = ofnode_get_parent(node);
1012 struct udevice *parent;
1015 if (!of_live_active())
1018 ret = device_find_by_ofnode(pnode, &parent);
1022 ret = ofnode_set_enabled(node, true);
1026 return lists_bind_fdt(parent, node, NULL, false);