1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013 Google, Inc
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
9 #define LOG_CATEGORY LOGC_DM
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)
32 * TODO(sjg@chromium.org): Optimise this, perhaps moving the found
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 debug("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)
149 uc = uclass_find(id);
151 return uclass_add(id, ucp);
157 const char *uclass_get_name(enum uclass_id id)
161 if (uclass_get(id, &uc))
163 return uc->uc_drv->name;
166 void *uclass_get_priv(const struct uclass *uc)
171 void uclass_set_priv(struct uclass *uc, void *priv)
176 enum uclass_id uclass_get_by_name(const char *name)
180 for (i = 0; i < UCLASS_COUNT; i++) {
181 struct uclass_driver *uc_drv = lists_uclass_lookup(i);
183 if (uc_drv && !strcmp(uc_drv->name, name))
187 return UCLASS_INVALID;
190 int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
192 struct udevice *iter;
193 struct uclass *uc = dev->uclass;
196 if (list_empty(&uc->dev_head))
199 uclass_foreach_dev(iter, uc) {
211 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
218 ret = uclass_get(id, &uc);
221 if (list_empty(&uc->dev_head))
224 uclass_foreach_dev(dev, uc) {
234 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
240 ret = uclass_get(id, &uc);
243 if (list_empty(&uc->dev_head))
246 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
251 int uclass_find_next_device(struct udevice **devp)
253 struct udevice *dev = *devp;
256 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
259 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
264 int uclass_find_device_by_name(enum uclass_id id, const char *name,
265 struct udevice **devp)
274 ret = uclass_get(id, &uc);
278 uclass_foreach_dev(dev, uc) {
279 if (!strcmp(dev->name, name)) {
288 int uclass_find_next_free_seq(struct uclass *uc)
293 /* If using aliases, start with the highest alias value */
294 if (CONFIG_IS_ENABLED(DM_SEQ_ALIAS) &&
295 (uc->uc_drv->flags & DM_UC_FLAG_SEQ_ALIAS))
296 max = dev_read_alias_highest_id(uc->uc_drv->name);
298 /* Avoid conflict with existing devices */
299 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
304 * At this point, max will be -1 if there are no existing aliases or
311 int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
318 log_debug("%d\n", seq);
321 ret = uclass_get(id, &uc);
325 uclass_foreach_dev(dev, uc) {
326 log_debug(" - %d '%s'\n", dev->seq_, dev->name);
327 if (dev->seq_ == seq) {
329 log_debug(" - found\n");
333 log_debug(" - not found\n");
338 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
339 struct udevice **devp)
348 ret = uclass_get(id, &uc);
352 uclass_foreach_dev(dev, uc) {
353 if (dev_of_offset(dev) == node) {
362 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
363 struct udevice **devp)
369 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
371 if (!ofnode_valid(node))
373 ret = uclass_get(id, &uc);
377 uclass_foreach_dev(dev, uc) {
378 log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
380 if (ofnode_equal(dev_ofnode(dev), node)) {
388 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
389 ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
393 #if CONFIG_IS_ENABLED(OF_CONTROL)
394 int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
395 const char *name, struct udevice **devp)
403 find_phandle = dev_read_u32_default(parent, name, -1);
404 if (find_phandle <= 0)
406 ret = uclass_get(id, &uc);
410 uclass_foreach_dev(dev, uc) {
413 phandle = dev_read_phandle(dev);
415 if (phandle == find_phandle) {
425 int uclass_get_device_by_driver(enum uclass_id id,
426 const struct driver *find_drv,
427 struct udevice **devp)
433 ret = uclass_get(id, &uc);
437 uclass_foreach_dev(dev, uc) {
438 if (dev->driver == find_drv)
439 return uclass_get_device_tail(dev, 0, devp);
445 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
451 ret = device_probe(dev);
460 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
466 ret = uclass_find_device(id, index, &dev);
467 return uclass_get_device_tail(dev, ret, devp);
470 int uclass_get_device_by_name(enum uclass_id id, const char *name,
471 struct udevice **devp)
477 ret = uclass_find_device_by_name(id, name, &dev);
478 return uclass_get_device_tail(dev, ret, devp);
481 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
487 ret = uclass_find_device_by_seq(id, seq, &dev);
489 return uclass_get_device_tail(dev, ret, devp);
492 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
493 struct udevice **devp)
499 ret = uclass_find_device_by_of_offset(id, node, &dev);
500 return uclass_get_device_tail(dev, ret, devp);
503 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
504 struct udevice **devp)
509 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
511 ret = uclass_find_device_by_ofnode(id, node, &dev);
512 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
513 ofnode_get_name(node), dev ? dev->name : "(none)", ret);
515 return uclass_get_device_tail(dev, ret, devp);
518 #if CONFIG_IS_ENABLED(OF_CONTROL)
519 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
520 struct udevice **devp)
527 ret = uclass_get(id, &uc);
531 uclass_foreach_dev(dev, uc) {
534 phandle = dev_read_phandle(dev);
536 if (phandle == phandle_id) {
538 return uclass_get_device_tail(dev, ret, devp);
545 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
546 const char *name, struct udevice **devp)
552 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
553 return uclass_get_device_tail(dev, ret, devp);
557 int uclass_first_device(enum uclass_id id, struct udevice **devp)
563 ret = uclass_find_first_device(id, &dev);
566 return uclass_get_device_tail(dev, ret, devp);
569 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
573 ret = uclass_first_device(id, devp);
582 int uclass_next_device(struct udevice **devp)
584 struct udevice *dev = *devp;
588 ret = uclass_find_next_device(&dev);
591 return uclass_get_device_tail(dev, ret, devp);
594 int uclass_next_device_err(struct udevice **devp)
598 ret = uclass_next_device(devp);
607 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
612 ret = uclass_find_first_device(id, devp);
618 return device_probe(*devp);
621 int uclass_next_device_check(struct udevice **devp)
625 ret = uclass_find_next_device(devp);
631 return device_probe(*devp);
634 int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
635 struct udevice **devp)
640 uclass_id_foreach_dev(id, dev, uc) {
641 if (dev_get_driver_data(dev) == driver_data) {
644 return device_probe(dev);
651 int uclass_bind_device(struct udevice *dev)
657 list_add_tail(&dev->uclass_node, &uc->dev_head);
660 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
662 if (uc_drv->child_post_bind) {
663 ret = uc_drv->child_post_bind(dev);
671 /* There is no need to undo the parent's post_bind call */
672 list_del(&dev->uclass_node);
677 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
678 int uclass_unbind_device(struct udevice *dev)
684 if (uc->uc_drv->pre_unbind) {
685 ret = uc->uc_drv->pre_unbind(dev);
690 list_del(&dev->uclass_node);
695 int uclass_pre_probe_device(struct udevice *dev)
697 struct uclass_driver *uc_drv;
700 uc_drv = dev->uclass->uc_drv;
701 if (uc_drv->pre_probe) {
702 ret = uc_drv->pre_probe(dev);
709 uc_drv = dev->parent->uclass->uc_drv;
710 if (uc_drv->child_pre_probe) {
711 ret = uc_drv->child_pre_probe(dev);
719 int uclass_post_probe_device(struct udevice *dev)
721 struct uclass_driver *uc_drv;
725 uc_drv = dev->parent->uclass->uc_drv;
726 if (uc_drv->child_post_probe) {
727 ret = uc_drv->child_post_probe(dev);
733 uc_drv = dev->uclass->uc_drv;
734 if (uc_drv->post_probe) {
735 ret = uc_drv->post_probe(dev);
743 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
744 int uclass_pre_remove_device(struct udevice *dev)
750 if (uc->uc_drv->pre_remove) {
751 ret = uc->uc_drv->pre_remove(dev);
760 int uclass_probe_all(enum uclass_id id)
765 ret = uclass_first_device(id, &dev);
769 /* Scanning uclass to probe all devices */
771 ret = uclass_next_device(&dev);
779 UCLASS_DRIVER(nop) = {