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 int uclass_find_next_free_seq(struct uclass *uc)
312 /* If using aliases, start with the highest alias value */
313 if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
314 (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS))
315 max = dev_read_alias_highest_id(uc->uc_drv->name);
317 /* Avoid conflict with existing devices */
318 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
323 * At this point, max will be -1 if there are no existing aliases or
330 int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
337 log_debug("%d\n", seq);
340 ret = uclass_get(id, &uc);
344 uclass_foreach_dev(dev, uc) {
345 log_debug(" - %d '%s'\n", dev->seq_, dev->name);
346 if (dev->seq_ == seq) {
348 log_debug(" - found\n");
352 log_debug(" - not found\n");
357 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
358 struct udevice **devp)
367 ret = uclass_get(id, &uc);
371 uclass_foreach_dev(dev, uc) {
372 if (dev_of_offset(dev) == node) {
381 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
382 struct udevice **devp)
388 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
390 if (!ofnode_valid(node))
392 ret = uclass_get(id, &uc);
396 uclass_foreach_dev(dev, uc) {
397 log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
399 if (ofnode_equal(dev_ofnode(dev), node)) {
407 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
408 ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
412 #if CONFIG_IS_ENABLED(OF_REAL)
413 static int uclass_find_device_by_phandle_id(enum uclass_id id,
415 struct udevice **devp)
421 ret = uclass_get(id, &uc);
425 uclass_foreach_dev(dev, uc) {
428 phandle = dev_read_phandle(dev);
430 if (phandle == find_phandle) {
439 int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
440 const char *name, struct udevice **devp)
445 find_phandle = dev_read_u32_default(parent, name, -1);
446 if (find_phandle <= 0)
449 return uclass_find_device_by_phandle_id(id, find_phandle, devp);
453 int uclass_get_device_by_driver(enum uclass_id id,
454 const struct driver *find_drv,
455 struct udevice **devp)
461 ret = uclass_get(id, &uc);
465 uclass_foreach_dev(dev, uc) {
466 if (dev->driver == find_drv)
467 return uclass_get_device_tail(dev, 0, devp);
473 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
479 ret = device_probe(dev);
488 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
494 ret = uclass_find_device(id, index, &dev);
495 return uclass_get_device_tail(dev, ret, devp);
498 int uclass_get_device_by_name(enum uclass_id id, const char *name,
499 struct udevice **devp)
505 ret = uclass_find_device_by_name(id, name, &dev);
506 return uclass_get_device_tail(dev, ret, devp);
509 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
515 ret = uclass_find_device_by_seq(id, seq, &dev);
517 return uclass_get_device_tail(dev, ret, devp);
520 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
521 struct udevice **devp)
527 ret = uclass_find_device_by_of_offset(id, node, &dev);
528 return uclass_get_device_tail(dev, ret, devp);
531 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
532 struct udevice **devp)
537 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
539 ret = uclass_find_device_by_ofnode(id, node, &dev);
540 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
541 ofnode_get_name(node), dev ? dev->name : "(none)", ret);
543 return uclass_get_device_tail(dev, ret, devp);
546 #if CONFIG_IS_ENABLED(OF_REAL)
547 int uclass_get_device_by_of_path(enum uclass_id id, const char *path,
548 struct udevice **devp)
550 return uclass_get_device_by_ofnode(id, ofnode_path(path), devp);
553 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
554 struct udevice **devp)
560 ret = uclass_find_device_by_phandle_id(id, phandle_id, &dev);
561 return uclass_get_device_tail(dev, ret, devp);
564 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
565 const char *name, struct udevice **devp)
571 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
572 return uclass_get_device_tail(dev, ret, devp);
577 * Starting from the given device @dev, return pointer to the first device in
578 * the uclass that probes successfully in @devp.
580 static void _uclass_next_device(struct udevice *dev, struct udevice **devp)
582 for (; dev; uclass_find_next_device(&dev)) {
583 if (!device_probe(dev))
589 void uclass_first_device(enum uclass_id id, struct udevice **devp)
594 ret = uclass_find_first_device(id, &dev);
595 _uclass_next_device(dev, devp);
598 void uclass_next_device(struct udevice **devp)
600 struct udevice *dev = *devp;
602 uclass_find_next_device(&dev);
603 _uclass_next_device(dev, devp);
606 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
610 ret = uclass_first_device_check(id, devp);
619 int uclass_next_device_err(struct udevice **devp)
623 ret = uclass_next_device_check(devp);
632 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
637 ret = uclass_find_first_device(id, devp);
643 return device_probe(*devp);
646 int uclass_next_device_check(struct udevice **devp)
650 ret = uclass_find_next_device(devp);
656 return device_probe(*devp);
659 int uclass_get_count(void)
661 const struct uclass *uc;
665 list_for_each_entry(uc, gd->uclass_root, sibling_node)
672 int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
673 struct udevice **devp)
678 uclass_id_foreach_dev(id, dev, uc) {
679 if (dev_get_driver_data(dev) == driver_data) {
682 return device_probe(dev);
689 int uclass_bind_device(struct udevice *dev)
695 list_add_tail(&dev->uclass_node, &uc->dev_head);
698 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
700 if (uc_drv->child_post_bind) {
701 ret = uc_drv->child_post_bind(dev);
709 /* There is no need to undo the parent's post_bind call */
710 list_del(&dev->uclass_node);
715 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
716 int uclass_pre_unbind_device(struct udevice *dev)
722 if (uc->uc_drv->pre_unbind) {
723 ret = uc->uc_drv->pre_unbind(dev);
731 int uclass_unbind_device(struct udevice *dev)
733 list_del(&dev->uclass_node);
739 int uclass_pre_probe_device(struct udevice *dev)
741 struct uclass_driver *uc_drv;
744 uc_drv = dev->uclass->uc_drv;
745 if (uc_drv->pre_probe) {
746 ret = uc_drv->pre_probe(dev);
753 uc_drv = dev->parent->uclass->uc_drv;
754 if (uc_drv->child_pre_probe) {
755 ret = uc_drv->child_pre_probe(dev);
763 int uclass_post_probe_device(struct udevice *dev)
765 struct uclass_driver *uc_drv;
769 uc_drv = dev->parent->uclass->uc_drv;
770 if (uc_drv->child_post_probe) {
771 ret = uc_drv->child_post_probe(dev);
777 uc_drv = dev->uclass->uc_drv;
778 if (uc_drv->post_probe) {
779 ret = uc_drv->post_probe(dev);
787 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
788 int uclass_pre_remove_device(struct udevice *dev)
794 if (uc->uc_drv->pre_remove) {
795 ret = uc->uc_drv->pre_remove(dev);
804 int uclass_probe_all(enum uclass_id id)
809 err = uclass_first_device_check(id, &dev);
811 /* Scanning uclass to probe all devices */
813 ret = uclass_next_device_check(&dev);
821 int uclass_id_count(enum uclass_id id)
827 uclass_id_foreach_dev(id, dev, uc)
833 UCLASS_DRIVER(nop) = {