1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2013 Google, Inc
8 * Pavel Herrmann <morpheus.ibis@gmail.com>
15 #include <fdt_support.h>
17 #include <dm/device.h>
18 #include <dm/device-internal.h>
20 #include <dm/of_access.h>
21 #include <dm/pinctrl.h>
22 #include <dm/platdata.h>
24 #include <dm/uclass.h>
25 #include <dm/uclass-internal.h>
27 #include <linux/err.h>
28 #include <linux/list.h>
29 #include <power-domain.h>
31 DECLARE_GLOBAL_DATA_PTR;
33 static int device_bind_common(struct udevice *parent, const struct driver *drv,
34 const char *name, void *platdata,
35 ulong driver_data, ofnode node,
36 uint of_platdata_size, struct udevice **devp)
47 ret = uclass_get(drv->id, &uc);
49 debug("Missing uclass for driver %s\n", drv->name);
53 dev = calloc(1, sizeof(struct udevice));
57 INIT_LIST_HEAD(&dev->sibling_node);
58 INIT_LIST_HEAD(&dev->child_head);
59 INIT_LIST_HEAD(&dev->uclass_node);
61 INIT_LIST_HEAD(&dev->devres_head);
63 dev->platdata = platdata;
64 dev->driver_data = driver_data;
73 if (CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(DM_SEQ_ALIAS)) {
75 * Some devices, such as a SPI bus, I2C bus and serial ports
76 * are numbered using aliases.
78 * This is just a 'requested' sequence, and will be
79 * resolved (and ->seq updated) when the device is probed.
81 if (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS) {
82 if (uc->uc_drv->name && ofnode_valid(node)) {
83 dev_read_alias_seq(dev, &dev->req_seq);
88 if (drv->platdata_auto_alloc_size) {
89 bool alloc = !platdata;
91 if (CONFIG_IS_ENABLED(OF_PLATDATA)) {
92 if (of_platdata_size) {
93 dev->flags |= DM_FLAG_OF_PLATDATA;
94 if (of_platdata_size <
95 drv->platdata_auto_alloc_size)
100 dev->flags |= DM_FLAG_ALLOC_PDATA;
101 dev->platdata = calloc(1,
102 drv->platdata_auto_alloc_size);
103 if (!dev->platdata) {
107 if (CONFIG_IS_ENABLED(OF_PLATDATA) && platdata) {
108 memcpy(dev->platdata, platdata,
114 size = uc->uc_drv->per_device_platdata_auto_alloc_size;
116 dev->flags |= DM_FLAG_ALLOC_UCLASS_PDATA;
117 dev->uclass_platdata = calloc(1, size);
118 if (!dev->uclass_platdata) {
125 size = parent->driver->per_child_platdata_auto_alloc_size;
127 size = parent->uclass->uc_drv->
128 per_child_platdata_auto_alloc_size;
131 dev->flags |= DM_FLAG_ALLOC_PARENT_PDATA;
132 dev->parent_platdata = calloc(1, size);
133 if (!dev->parent_platdata) {
140 /* put dev into parent's successor list */
142 list_add_tail(&dev->sibling_node, &parent->child_head);
144 ret = uclass_bind_device(dev);
146 goto fail_uclass_bind;
148 /* if we fail to bind we remove device from successors and free it */
150 ret = drv->bind(dev);
154 if (parent && parent->driver->child_post_bind) {
155 ret = parent->driver->child_post_bind(dev);
157 goto fail_child_post_bind;
159 if (uc->uc_drv->post_bind) {
160 ret = uc->uc_drv->post_bind(dev);
162 goto fail_uclass_post_bind;
166 pr_debug("Bound device %s to %s\n", dev->name, parent->name);
170 dev->flags |= DM_FLAG_BOUND;
174 fail_uclass_post_bind:
175 /* There is no child unbind() method, so no clean-up required */
176 fail_child_post_bind:
177 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
178 if (drv->unbind && drv->unbind(dev)) {
179 dm_warn("unbind() method failed on dev '%s' on error path\n",
185 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
186 if (uclass_unbind_device(dev)) {
187 dm_warn("Failed to unbind dev '%s' on error path\n",
192 if (CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)) {
193 list_del(&dev->sibling_node);
194 if (dev->flags & DM_FLAG_ALLOC_PARENT_PDATA) {
195 free(dev->parent_platdata);
196 dev->parent_platdata = NULL;
200 if (dev->flags & DM_FLAG_ALLOC_UCLASS_PDATA) {
201 free(dev->uclass_platdata);
202 dev->uclass_platdata = NULL;
205 if (dev->flags & DM_FLAG_ALLOC_PDATA) {
207 dev->platdata = NULL;
210 devres_release_all(dev);
217 int device_bind_with_driver_data(struct udevice *parent,
218 const struct driver *drv, const char *name,
219 ulong driver_data, ofnode node,
220 struct udevice **devp)
222 return device_bind_common(parent, drv, name, NULL, driver_data, node,
226 int device_bind(struct udevice *parent, const struct driver *drv,
227 const char *name, void *platdata, int of_offset,
228 struct udevice **devp)
230 return device_bind_common(parent, drv, name, platdata, 0,
231 offset_to_ofnode(of_offset), 0, devp);
234 int device_bind_ofnode(struct udevice *parent, const struct driver *drv,
235 const char *name, void *platdata, ofnode node,
236 struct udevice **devp)
238 return device_bind_common(parent, drv, name, platdata, 0, node, 0,
242 int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
243 const struct driver_info *info, struct udevice **devp)
246 uint platdata_size = 0;
248 drv = lists_driver_lookup_name(info->name);
251 if (pre_reloc_only && !(drv->flags & DM_FLAG_PRE_RELOC))
254 #if CONFIG_IS_ENABLED(OF_PLATDATA)
255 platdata_size = info->platdata_size;
257 return device_bind_common(parent, drv, info->name,
258 (void *)info->platdata, 0, ofnode_null(), platdata_size,
262 static void *alloc_priv(int size, uint flags)
266 if (flags & DM_FLAG_ALLOC_PRIV_DMA) {
267 size = ROUND(size, ARCH_DMA_MINALIGN);
268 priv = memalign(ARCH_DMA_MINALIGN, size);
270 memset(priv, '\0', size);
273 * Ensure that the zero bytes are flushed to memory.
274 * This prevents problems if the driver uses this as
275 * both an input and an output buffer:
277 * 1. Zeroes written to buffer (here) and sit in the
279 * 2. Driver issues a read command to DMA
280 * 3. CPU runs out of cache space and evicts some cache
281 * data in the buffer, writing zeroes to RAM from
284 * 5. Buffer now has some DMA data and some zeroes
285 * 6. Data being read is now incorrect
287 * To prevent this, ensure that the cache is clean
288 * within this range at the start. The driver can then
289 * use normal flush-after-write, invalidate-before-read
292 * TODO(sjg@chromium.org): Drop this microblaze
295 #ifndef CONFIG_MICROBLAZE
296 flush_dcache_range((ulong)priv, (ulong)priv + size);
300 priv = calloc(1, size);
306 int device_probe(struct udevice *dev)
308 struct power_domain pd;
309 const struct driver *drv;
317 if (dev->flags & DM_FLAG_ACTIVATED)
323 /* Allocate private data if requested and not reentered */
324 if (drv->priv_auto_alloc_size && !dev->priv) {
325 dev->priv = alloc_priv(drv->priv_auto_alloc_size, drv->flags);
331 /* Allocate private data if requested and not reentered */
332 size = dev->uclass->uc_drv->per_device_auto_alloc_size;
333 if (size && !dev->uclass_priv) {
334 dev->uclass_priv = calloc(1, size);
335 if (!dev->uclass_priv) {
341 /* Ensure all parents are probed */
343 size = dev->parent->driver->per_child_auto_alloc_size;
345 size = dev->parent->uclass->uc_drv->
346 per_child_auto_alloc_size;
348 if (size && !dev->parent_priv) {
349 dev->parent_priv = alloc_priv(size, drv->flags);
350 if (!dev->parent_priv) {
356 ret = device_probe(dev->parent);
361 * The device might have already been probed during
362 * the call to device_probe() on its parent device
363 * (e.g. PCI bridge devices). Test the flags again
364 * so that we don't mess up the device.
366 if (dev->flags & DM_FLAG_ACTIVATED)
370 seq = uclass_resolve_seq(dev);
377 dev->flags |= DM_FLAG_ACTIVATED;
380 * Process pinctrl for everything except the root device, and
381 * continue regardless of the result of pinctrl. Don't process pinctrl
382 * settings for pinctrl devices since the device may not yet be
385 if (dev->parent && device_get_uclass_id(dev) != UCLASS_PINCTRL)
386 pinctrl_select_state(dev, "default");
388 if (dev->parent && device_get_uclass_id(dev) != UCLASS_POWER_DOMAIN) {
389 if (!power_domain_get(dev, &pd))
390 power_domain_on(&pd);
393 ret = uclass_pre_probe_device(dev);
397 if (dev->parent && dev->parent->driver->child_pre_probe) {
398 ret = dev->parent->driver->child_pre_probe(dev);
403 if (drv->ofdata_to_platdata && dev_has_of_node(dev)) {
404 ret = drv->ofdata_to_platdata(dev);
409 /* Process 'assigned-{clocks/clock-parents/clock-rates}' properties */
410 ret = clk_set_defaults(dev);
415 ret = drv->probe(dev);
417 dev->flags &= ~DM_FLAG_ACTIVATED;
422 ret = uclass_post_probe_device(dev);
426 if (dev->parent && device_get_uclass_id(dev) == UCLASS_PINCTRL)
427 pinctrl_select_state(dev, "default");
431 if (device_remove(dev, DM_REMOVE_NORMAL)) {
432 dm_warn("%s: Device '%s' failed to remove on error path\n",
433 __func__, dev->name);
436 dev->flags &= ~DM_FLAG_ACTIVATED;
444 void *dev_get_platdata(struct udevice *dev)
447 dm_warn("%s: null device\n", __func__);
451 return dev->platdata;
454 void *dev_get_parent_platdata(struct udevice *dev)
457 dm_warn("%s: null device\n", __func__);
461 return dev->parent_platdata;
464 void *dev_get_uclass_platdata(struct udevice *dev)
467 dm_warn("%s: null device\n", __func__);
471 return dev->uclass_platdata;
474 void *dev_get_priv(struct udevice *dev)
477 dm_warn("%s: null device\n", __func__);
484 void *dev_get_uclass_priv(struct udevice *dev)
487 dm_warn("%s: null device\n", __func__);
491 return dev->uclass_priv;
494 void *dev_get_parent_priv(struct udevice *dev)
497 dm_warn("%s: null device\n", __func__);
501 return dev->parent_priv;
504 static int device_get_device_tail(struct udevice *dev, int ret,
505 struct udevice **devp)
510 ret = device_probe(dev);
519 int device_get_child(struct udevice *parent, int index, struct udevice **devp)
523 list_for_each_entry(dev, &parent->child_head, sibling_node) {
525 return device_get_device_tail(dev, 0, devp);
531 int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
532 bool find_req_seq, struct udevice **devp)
537 if (seq_or_req_seq == -1)
540 list_for_each_entry(dev, &parent->child_head, sibling_node) {
541 if ((find_req_seq ? dev->req_seq : dev->seq) ==
551 int device_get_child_by_seq(struct udevice *parent, int seq,
552 struct udevice **devp)
558 ret = device_find_child_by_seq(parent, seq, false, &dev);
559 if (ret == -ENODEV) {
561 * We didn't find it in probed devices. See if there is one
562 * that will request this seq if probed.
564 ret = device_find_child_by_seq(parent, seq, true, &dev);
566 return device_get_device_tail(dev, ret, devp);
569 int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
570 struct udevice **devp)
576 list_for_each_entry(dev, &parent->child_head, sibling_node) {
577 if (dev_of_offset(dev) == of_offset) {
586 int device_get_child_by_of_offset(struct udevice *parent, int node,
587 struct udevice **devp)
593 ret = device_find_child_by_of_offset(parent, node, &dev);
594 return device_get_device_tail(dev, ret, devp);
597 static struct udevice *_device_find_global_by_of_offset(struct udevice *parent,
600 struct udevice *dev, *found;
602 if (dev_of_offset(parent) == of_offset)
605 list_for_each_entry(dev, &parent->child_head, sibling_node) {
606 found = _device_find_global_by_of_offset(dev, of_offset);
614 int device_get_global_by_of_offset(int of_offset, struct udevice **devp)
618 dev = _device_find_global_by_of_offset(gd->dm_root, of_offset);
619 return device_get_device_tail(dev, dev ? 0 : -ENOENT, devp);
622 int device_find_first_child(struct udevice *parent, struct udevice **devp)
624 if (list_empty(&parent->child_head)) {
627 *devp = list_first_entry(&parent->child_head, struct udevice,
634 int device_find_next_child(struct udevice **devp)
636 struct udevice *dev = *devp;
637 struct udevice *parent = dev->parent;
639 if (list_is_last(&dev->sibling_node, &parent->child_head)) {
642 *devp = list_entry(dev->sibling_node.next, struct udevice,
649 struct udevice *dev_get_parent(struct udevice *child)
651 return child->parent;
654 ulong dev_get_driver_data(struct udevice *dev)
656 return dev->driver_data;
659 const void *dev_get_driver_ops(struct udevice *dev)
661 if (!dev || !dev->driver->ops)
664 return dev->driver->ops;
667 enum uclass_id device_get_uclass_id(struct udevice *dev)
669 return dev->uclass->uc_drv->id;
672 const char *dev_get_uclass_name(struct udevice *dev)
677 return dev->uclass->uc_drv->name;
680 bool device_has_children(struct udevice *dev)
682 return !list_empty(&dev->child_head);
685 bool device_has_active_children(struct udevice *dev)
687 struct udevice *child;
689 for (device_find_first_child(dev, &child);
691 device_find_next_child(&child)) {
692 if (device_active(child))
699 bool device_is_last_sibling(struct udevice *dev)
701 struct udevice *parent = dev->parent;
705 return list_is_last(&dev->sibling_node, &parent->child_head);
708 void device_set_name_alloced(struct udevice *dev)
710 dev->flags |= DM_FLAG_NAME_ALLOCED;
713 int device_set_name(struct udevice *dev, const char *name)
719 device_set_name_alloced(dev);
724 bool device_is_compatible(struct udevice *dev, const char *compat)
726 return ofnode_device_is_compatible(dev_ofnode(dev), compat);
729 bool of_machine_is_compatible(const char *compat)
731 const void *fdt = gd->fdt_blob;
733 return !fdt_node_check_compatible(fdt, 0, compat);