1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013 Google, Inc
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
13 #include <dm/device.h>
14 #include <dm/device-internal.h>
16 #include <dm/uclass.h>
17 #include <dm/uclass-internal.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 struct uclass *uclass_find(enum uclass_id key)
29 * TODO(sjg@chromium.org): Optimise this, perhaps moving the found
30 * node to the start of the list, or creating a linear array mapping
33 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
34 if (uc->uc_drv->id == key)
42 * uclass_add() - Create new uclass in list
43 * @id: Id number to create
44 * @ucp: Returns pointer to uclass, or NULL on error
45 * @return 0 on success, -ve on error
47 * The new uclass is added to the list. There must be only one uclass for
50 static int uclass_add(enum uclass_id id, struct uclass **ucp)
52 struct uclass_driver *uc_drv;
57 uc_drv = lists_uclass_lookup(id);
59 debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
62 * Use a strange error to make this case easier to find. When
63 * a uclass is not available it can prevent driver model from
64 * starting up and this failure is otherwise hard to debug.
68 uc = calloc(1, sizeof(*uc));
71 if (uc_drv->priv_auto_alloc_size) {
72 uc->priv = calloc(1, uc_drv->priv_auto_alloc_size);
79 INIT_LIST_HEAD(&uc->sibling_node);
80 INIT_LIST_HEAD(&uc->dev_head);
81 list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST);
84 ret = uc_drv->init(uc);
93 if (uc_drv->priv_auto_alloc_size) {
97 list_del(&uc->sibling_node);
104 int uclass_destroy(struct uclass *uc)
106 struct uclass_driver *uc_drv;
111 * We cannot use list_for_each_entry_safe() here. If a device in this
112 * uclass has a child device also in this uclass, it will be also be
113 * unbound (by the recursion in the call to device_unbind() below).
114 * We can loop until the list is empty.
116 while (!list_empty(&uc->dev_head)) {
117 dev = list_first_entry(&uc->dev_head, struct udevice,
119 ret = device_remove(dev, DM_REMOVE_NORMAL);
122 ret = device_unbind(dev);
130 list_del(&uc->sibling_node);
131 if (uc_drv->priv_auto_alloc_size)
138 int uclass_get(enum uclass_id id, struct uclass **ucp)
143 uc = uclass_find(id);
145 return uclass_add(id, ucp);
151 const char *uclass_get_name(enum uclass_id id)
155 if (uclass_get(id, &uc))
157 return uc->uc_drv->name;
160 enum uclass_id uclass_get_by_name(const char *name)
164 for (i = 0; i < UCLASS_COUNT; i++) {
165 struct uclass_driver *uc_drv = lists_uclass_lookup(i);
167 if (uc_drv && !strcmp(uc_drv->name, name))
171 return UCLASS_INVALID;
174 int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
176 struct udevice *iter;
177 struct uclass *uc = dev->uclass;
180 if (list_empty(&uc->dev_head))
183 uclass_foreach_dev(iter, uc) {
195 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
202 ret = uclass_get(id, &uc);
205 if (list_empty(&uc->dev_head))
208 uclass_foreach_dev(dev, uc) {
218 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
224 ret = uclass_get(id, &uc);
227 if (list_empty(&uc->dev_head))
230 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
235 int uclass_find_next_device(struct udevice **devp)
237 struct udevice *dev = *devp;
240 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
243 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
248 int uclass_find_device_by_name(enum uclass_id id, const char *name,
249 struct udevice **devp)
258 ret = uclass_get(id, &uc);
262 uclass_foreach_dev(dev, uc) {
263 if (!strncmp(dev->name, name, strlen(name))) {
272 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
273 bool find_req_seq, struct udevice **devp)
280 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
281 if (seq_or_req_seq == -1)
283 ret = uclass_get(id, &uc);
287 uclass_foreach_dev(dev, uc) {
288 debug(" - %d %d '%s'\n", dev->req_seq, dev->seq, dev->name);
289 if ((find_req_seq ? dev->req_seq : dev->seq) ==
296 debug(" - not found\n");
301 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
302 struct udevice **devp)
311 ret = uclass_get(id, &uc);
315 uclass_foreach_dev(dev, uc) {
316 if (dev_of_offset(dev) == node) {
325 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
326 struct udevice **devp)
332 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
334 if (!ofnode_valid(node))
336 ret = uclass_get(id, &uc);
340 uclass_foreach_dev(dev, uc) {
341 log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
343 if (ofnode_equal(dev_ofnode(dev), node)) {
351 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
352 ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
356 #if CONFIG_IS_ENABLED(OF_CONTROL)
357 int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
358 const char *name, struct udevice **devp)
366 find_phandle = dev_read_u32_default(parent, name, -1);
367 if (find_phandle <= 0)
369 ret = uclass_get(id, &uc);
373 uclass_foreach_dev(dev, uc) {
376 phandle = dev_read_phandle(dev);
378 if (phandle == find_phandle) {
388 int uclass_get_device_by_driver(enum uclass_id id,
389 const struct driver *find_drv,
390 struct udevice **devp)
396 ret = uclass_get(id, &uc);
400 uclass_foreach_dev(dev, uc) {
401 if (dev->driver == find_drv)
402 return uclass_get_device_tail(dev, 0, devp);
408 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
414 ret = device_probe(dev);
423 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
429 ret = uclass_find_device(id, index, &dev);
430 return uclass_get_device_tail(dev, ret, devp);
433 int uclass_get_device_by_name(enum uclass_id id, const char *name,
434 struct udevice **devp)
440 ret = uclass_find_device_by_name(id, name, &dev);
441 return uclass_get_device_tail(dev, ret, devp);
444 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
450 ret = uclass_find_device_by_seq(id, seq, false, &dev);
451 if (ret == -ENODEV) {
453 * We didn't find it in probed devices. See if there is one
454 * that will request this seq if probed.
456 ret = uclass_find_device_by_seq(id, seq, true, &dev);
458 return uclass_get_device_tail(dev, ret, devp);
461 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
462 struct udevice **devp)
468 ret = uclass_find_device_by_of_offset(id, node, &dev);
469 return uclass_get_device_tail(dev, ret, devp);
472 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
473 struct udevice **devp)
478 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
480 ret = uclass_find_device_by_ofnode(id, node, &dev);
481 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
482 ofnode_get_name(node), dev ? dev->name : "(none)", ret);
484 return uclass_get_device_tail(dev, ret, devp);
487 #if CONFIG_IS_ENABLED(OF_CONTROL)
488 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
489 struct udevice **devp)
496 ret = uclass_get(id, &uc);
500 uclass_foreach_dev(dev, uc) {
503 phandle = dev_read_phandle(dev);
505 if (phandle == phandle_id) {
507 return uclass_get_device_tail(dev, ret, devp);
514 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
515 const char *name, struct udevice **devp)
521 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
522 return uclass_get_device_tail(dev, ret, devp);
526 int uclass_first_device(enum uclass_id id, struct udevice **devp)
532 ret = uclass_find_first_device(id, &dev);
535 return uclass_get_device_tail(dev, ret, devp);
538 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
542 ret = uclass_first_device(id, devp);
551 int uclass_next_device(struct udevice **devp)
553 struct udevice *dev = *devp;
557 ret = uclass_find_next_device(&dev);
560 return uclass_get_device_tail(dev, ret, devp);
563 int uclass_next_device_err(struct udevice **devp)
567 ret = uclass_next_device(devp);
576 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
581 ret = uclass_find_first_device(id, devp);
587 return device_probe(*devp);
590 int uclass_next_device_check(struct udevice **devp)
594 ret = uclass_find_next_device(devp);
600 return device_probe(*devp);
603 int uclass_bind_device(struct udevice *dev)
609 list_add_tail(&dev->uclass_node, &uc->dev_head);
612 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
614 if (uc_drv->child_post_bind) {
615 ret = uc_drv->child_post_bind(dev);
623 /* There is no need to undo the parent's post_bind call */
624 list_del(&dev->uclass_node);
629 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
630 int uclass_unbind_device(struct udevice *dev)
636 if (uc->uc_drv->pre_unbind) {
637 ret = uc->uc_drv->pre_unbind(dev);
642 list_del(&dev->uclass_node);
647 int uclass_resolve_seq(struct udevice *dev)
653 assert(dev->seq == -1);
654 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
657 dm_warn("Device '%s': seq %d is in use by '%s'\n",
658 dev->name, dev->req_seq, dup->name);
659 } else if (ret == -ENODEV) {
660 /* Our requested sequence number is available */
661 if (dev->req_seq != -1)
667 for (seq = 0; seq < DM_MAX_SEQ; seq++) {
668 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
678 int uclass_pre_probe_device(struct udevice *dev)
680 struct uclass_driver *uc_drv;
683 uc_drv = dev->uclass->uc_drv;
684 if (uc_drv->pre_probe) {
685 ret = uc_drv->pre_probe(dev);
692 uc_drv = dev->parent->uclass->uc_drv;
693 if (uc_drv->child_pre_probe)
694 return uc_drv->child_pre_probe(dev);
699 int uclass_post_probe_device(struct udevice *dev)
701 struct uclass_driver *uc_drv;
705 uc_drv = dev->parent->uclass->uc_drv;
706 if (uc_drv->child_post_probe) {
707 ret = uc_drv->child_post_probe(dev);
713 uc_drv = dev->uclass->uc_drv;
714 if (uc_drv->post_probe)
715 return uc_drv->post_probe(dev);
720 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
721 int uclass_pre_remove_device(struct udevice *dev)
727 if (uc->uc_drv->pre_remove) {
728 ret = uc->uc_drv->pre_remove(dev);