1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013 Google, Inc
9 #define LOG_CATEGORY LOGC_DM
15 #include <asm/global_data.h>
16 #include <dm/device.h>
17 #include <dm/device-internal.h>
19 #include <dm/uclass.h>
20 #include <dm/uclass-internal.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 struct uclass *uclass_find(enum uclass_id key)
33 * node to the start of the list, or creating a linear array mapping
36 list_for_each_entry(uc, gd->uclass_root, sibling_node) {
37 if (uc->uc_drv->id == key)
45 * uclass_add() - Create new uclass in list
46 * @id: Id number to create
47 * @ucp: Returns pointer to uclass, or NULL on error
48 * Return: 0 on success, -ve on error
50 * The new uclass is added to the list. There must be only one uclass for
53 static int uclass_add(enum uclass_id id, struct uclass **ucp)
55 struct uclass_driver *uc_drv;
60 uc_drv = lists_uclass_lookup(id);
62 dm_warn("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
65 * Use a strange error to make this case easier to find. When
66 * a uclass is not available it can prevent driver model from
67 * starting up and this failure is otherwise hard to debug.
71 uc = calloc(1, sizeof(*uc));
74 if (uc_drv->priv_auto) {
77 ptr = calloc(1, uc_drv->priv_auto);
82 uclass_set_priv(uc, ptr);
85 INIT_LIST_HEAD(&uc->sibling_node);
86 INIT_LIST_HEAD(&uc->dev_head);
87 list_add(&uc->sibling_node, DM_UCLASS_ROOT_NON_CONST);
90 ret = uc_drv->init(uc);
99 if (uc_drv->priv_auto) {
100 free(uclass_get_priv(uc));
101 uclass_set_priv(uc, NULL);
103 list_del(&uc->sibling_node);
110 int uclass_destroy(struct uclass *uc)
112 struct uclass_driver *uc_drv;
117 * We cannot use list_for_each_entry_safe() here. If a device in this
118 * uclass has a child device also in this uclass, it will be also be
119 * unbound (by the recursion in the call to device_unbind() below).
120 * We can loop until the list is empty.
122 while (!list_empty(&uc->dev_head)) {
123 dev = list_first_entry(&uc->dev_head, struct udevice,
125 ret = device_remove(dev, DM_REMOVE_NORMAL | DM_REMOVE_NO_PD);
127 return log_msg_ret("remove", ret);
128 ret = device_unbind(dev);
130 return log_msg_ret("unbind", ret);
136 list_del(&uc->sibling_node);
137 if (uc_drv->priv_auto)
138 free(uclass_get_priv(uc));
144 int uclass_get(enum uclass_id id, struct uclass **ucp)
148 /* Immediately fail if driver model is not set up */
149 if (!gd->uclass_root)
152 uc = uclass_find(id);
154 if (CONFIG_IS_ENABLED(OF_PLATDATA_INST))
156 return uclass_add(id, ucp);
163 const char *uclass_get_name(enum uclass_id id)
167 if (uclass_get(id, &uc))
169 return uc->uc_drv->name;
172 void *uclass_get_priv(const struct uclass *uc)
177 void uclass_set_priv(struct uclass *uc, void *priv)
182 enum uclass_id uclass_get_by_namelen(const char *name, int len)
186 for (i = 0; i < UCLASS_COUNT; i++) {
187 struct uclass_driver *uc_drv = lists_uclass_lookup(i);
189 if (uc_drv && !strncmp(uc_drv->name, name, len) &&
190 strlen(uc_drv->name) == len)
194 return UCLASS_INVALID;
197 enum uclass_id uclass_get_by_name(const char *name)
199 return uclass_get_by_namelen(name, strlen(name));
202 int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
204 struct udevice *iter;
205 struct uclass *uc = dev->uclass;
208 if (list_empty(&uc->dev_head))
211 uclass_foreach_dev(iter, uc) {
223 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
230 ret = uclass_get(id, &uc);
233 if (list_empty(&uc->dev_head))
236 uclass_foreach_dev(dev, uc) {
246 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
252 ret = uclass_get(id, &uc);
255 if (list_empty(&uc->dev_head))
258 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
263 int uclass_find_next_device(struct udevice **devp)
265 struct udevice *dev = *devp;
268 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
271 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
276 int uclass_find_device_by_namelen(enum uclass_id id, const char *name, int len,
277 struct udevice **devp)
286 ret = uclass_get(id, &uc);
290 uclass_foreach_dev(dev, uc) {
291 if (!strncmp(dev->name, name, len) &&
292 strlen(dev->name) == len) {
301 int uclass_find_device_by_name(enum uclass_id id, const char *name,
302 struct udevice **devp)
304 return uclass_find_device_by_namelen(id, name, strlen(name), devp);
307 struct udevice *uclass_try_first_device(enum uclass_id id)
311 uc = uclass_find(id);
312 if (!uc || list_empty(&uc->dev_head))
315 return list_first_entry(&uc->dev_head, struct udevice, uclass_node);
318 int uclass_find_next_free_seq(struct uclass *uc)
323 /* If using aliases, start with the highest alias value */
324 if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
325 (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS))
326 max = dev_read_alias_highest_id(uc->uc_drv->name);
328 /* Avoid conflict with existing devices */
329 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
334 * At this point, max will be -1 if there are no existing aliases or
341 int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
348 log_debug("%d\n", seq);
351 ret = uclass_get(id, &uc);
355 uclass_foreach_dev(dev, uc) {
356 log_debug(" - %d '%s'\n", dev->seq_, dev->name);
357 if (dev->seq_ == seq) {
359 log_debug(" - found\n");
363 log_debug(" - not found\n");
368 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
369 struct udevice **devp)
378 ret = uclass_get(id, &uc);
382 uclass_foreach_dev(dev, uc) {
383 if (dev_of_offset(dev) == node) {
392 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
393 struct udevice **devp)
399 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
401 if (!ofnode_valid(node))
403 ret = uclass_get(id, &uc);
407 uclass_foreach_dev(dev, uc) {
408 log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
410 if (ofnode_equal(dev_ofnode(dev), node)) {
418 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
419 ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
423 #if CONFIG_IS_ENABLED(OF_REAL)
424 static int uclass_find_device_by_phandle_id(enum uclass_id id,
426 struct udevice **devp)
432 ret = uclass_get(id, &uc);
436 uclass_foreach_dev(dev, uc) {
439 phandle = dev_read_phandle(dev);
441 if (phandle == find_phandle) {
450 int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
451 const char *name, struct udevice **devp)
456 find_phandle = dev_read_u32_default(parent, name, -1);
457 if (find_phandle <= 0)
460 return uclass_find_device_by_phandle_id(id, find_phandle, devp);
464 int uclass_get_device_by_driver(enum uclass_id id,
465 const struct driver *find_drv,
466 struct udevice **devp)
472 ret = uclass_get(id, &uc);
476 uclass_foreach_dev(dev, uc) {
477 if (dev->driver == find_drv)
478 return uclass_get_device_tail(dev, 0, devp);
484 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
490 ret = device_probe(dev);
499 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
505 ret = uclass_find_device(id, index, &dev);
506 return uclass_get_device_tail(dev, ret, devp);
509 int uclass_get_device_by_name(enum uclass_id id, const char *name,
510 struct udevice **devp)
516 ret = uclass_find_device_by_name(id, name, &dev);
517 return uclass_get_device_tail(dev, ret, devp);
520 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
526 ret = uclass_find_device_by_seq(id, seq, &dev);
528 return uclass_get_device_tail(dev, ret, devp);
531 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
532 struct udevice **devp)
538 ret = uclass_find_device_by_of_offset(id, node, &dev);
539 return uclass_get_device_tail(dev, ret, devp);
542 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
543 struct udevice **devp)
548 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
550 ret = uclass_find_device_by_ofnode(id, node, &dev);
551 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
552 ofnode_get_name(node), dev ? dev->name : "(none)", ret);
554 return uclass_get_device_tail(dev, ret, devp);
557 #if CONFIG_IS_ENABLED(OF_REAL)
558 int uclass_get_device_by_of_path(enum uclass_id id, const char *path,
559 struct udevice **devp)
561 return uclass_get_device_by_ofnode(id, ofnode_path(path), devp);
564 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
565 struct udevice **devp)
571 ret = uclass_find_device_by_phandle_id(id, phandle_id, &dev);
572 return uclass_get_device_tail(dev, ret, devp);
575 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
576 const char *name, struct udevice **devp)
582 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
583 return uclass_get_device_tail(dev, ret, devp);
588 * Starting from the given device @dev, return pointer to the first device in
589 * the uclass that probes successfully in @devp.
591 static void _uclass_next_device(struct udevice *dev, struct udevice **devp)
593 for (; dev; uclass_find_next_device(&dev)) {
594 if (!device_probe(dev))
600 void uclass_first_device(enum uclass_id id, struct udevice **devp)
605 ret = uclass_find_first_device(id, &dev);
606 _uclass_next_device(dev, devp);
609 void uclass_next_device(struct udevice **devp)
611 struct udevice *dev = *devp;
613 uclass_find_next_device(&dev);
614 _uclass_next_device(dev, devp);
617 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
621 ret = uclass_first_device_check(id, devp);
630 int uclass_next_device_err(struct udevice **devp)
634 ret = uclass_next_device_check(devp);
643 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
648 ret = uclass_find_first_device(id, devp);
654 return device_probe(*devp);
657 int uclass_next_device_check(struct udevice **devp)
661 ret = uclass_find_next_device(devp);
667 return device_probe(*devp);
670 int uclass_get_count(void)
672 const struct uclass *uc;
676 list_for_each_entry(uc, gd->uclass_root, sibling_node)
683 int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
684 struct udevice **devp)
689 uclass_id_foreach_dev(id, dev, uc) {
690 if (dev_get_driver_data(dev) == driver_data) {
693 return device_probe(dev);
700 int uclass_bind_device(struct udevice *dev)
706 list_add_tail(&dev->uclass_node, &uc->dev_head);
709 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
711 if (uc_drv->child_post_bind) {
712 ret = uc_drv->child_post_bind(dev);
720 /* There is no need to undo the parent's post_bind call */
721 list_del(&dev->uclass_node);
726 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
727 int uclass_pre_unbind_device(struct udevice *dev)
733 if (uc->uc_drv->pre_unbind) {
734 ret = uc->uc_drv->pre_unbind(dev);
742 int uclass_unbind_device(struct udevice *dev)
744 list_del(&dev->uclass_node);
750 int uclass_pre_probe_device(struct udevice *dev)
752 struct uclass_driver *uc_drv;
755 uc_drv = dev->uclass->uc_drv;
756 if (uc_drv->pre_probe) {
757 ret = uc_drv->pre_probe(dev);
764 uc_drv = dev->parent->uclass->uc_drv;
765 if (uc_drv->child_pre_probe) {
766 ret = uc_drv->child_pre_probe(dev);
774 int uclass_post_probe_device(struct udevice *dev)
776 struct uclass_driver *uc_drv;
780 uc_drv = dev->parent->uclass->uc_drv;
781 if (uc_drv->child_post_probe) {
782 ret = uc_drv->child_post_probe(dev);
788 uc_drv = dev->uclass->uc_drv;
789 if (uc_drv->post_probe) {
790 ret = uc_drv->post_probe(dev);
798 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
799 int uclass_pre_remove_device(struct udevice *dev)
805 if (uc->uc_drv->pre_remove) {
806 ret = uc->uc_drv->pre_remove(dev);
815 int uclass_probe_all(enum uclass_id id)
820 err = uclass_first_device_check(id, &dev);
822 /* Scanning uclass to probe all devices */
824 ret = uclass_next_device_check(&dev);
832 int uclass_id_count(enum uclass_id id)
838 uclass_id_foreach_dev(id, dev, uc)
844 UCLASS_DRIVER(nop) = {