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 uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
181 ret = uclass_get(id, &uc);
184 if (list_empty(&uc->dev_head))
187 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
197 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
203 ret = uclass_get(id, &uc);
206 if (list_empty(&uc->dev_head))
209 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
214 int uclass_find_next_device(struct udevice **devp)
216 struct udevice *dev = *devp;
219 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
222 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
227 int uclass_find_device_by_name(enum uclass_id id, const char *name,
228 struct udevice **devp)
237 ret = uclass_get(id, &uc);
241 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
242 if (!strncmp(dev->name, name, strlen(name))) {
251 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
252 bool find_req_seq, struct udevice **devp)
259 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
260 if (seq_or_req_seq == -1)
262 ret = uclass_get(id, &uc);
266 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
267 debug(" - %d %d '%s'\n", dev->req_seq, dev->seq, dev->name);
268 if ((find_req_seq ? dev->req_seq : dev->seq) ==
275 debug(" - not found\n");
280 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
281 struct udevice **devp)
290 ret = uclass_get(id, &uc);
294 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
295 if (dev_of_offset(dev) == node) {
304 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
305 struct udevice **devp)
311 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
313 if (!ofnode_valid(node))
315 ret = uclass_get(id, &uc);
319 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
320 log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
322 if (ofnode_equal(dev_ofnode(dev), node)) {
330 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
331 ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
335 #if CONFIG_IS_ENABLED(OF_CONTROL)
336 static int uclass_find_device_by_phandle(enum uclass_id id,
337 struct udevice *parent,
339 struct udevice **devp)
347 find_phandle = dev_read_u32_default(parent, name, -1);
348 if (find_phandle <= 0)
350 ret = uclass_get(id, &uc);
354 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
357 phandle = dev_read_phandle(dev);
359 if (phandle == find_phandle) {
369 int uclass_get_device_by_driver(enum uclass_id id,
370 const struct driver *find_drv,
371 struct udevice **devp)
377 ret = uclass_get(id, &uc);
381 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
382 if (dev->driver == find_drv)
383 return uclass_get_device_tail(dev, 0, devp);
389 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
395 ret = device_probe(dev);
404 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
410 ret = uclass_find_device(id, index, &dev);
411 return uclass_get_device_tail(dev, ret, devp);
414 int uclass_get_device_by_name(enum uclass_id id, const char *name,
415 struct udevice **devp)
421 ret = uclass_find_device_by_name(id, name, &dev);
422 return uclass_get_device_tail(dev, ret, devp);
425 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
431 ret = uclass_find_device_by_seq(id, seq, false, &dev);
432 if (ret == -ENODEV) {
434 * We didn't find it in probed devices. See if there is one
435 * that will request this seq if probed.
437 ret = uclass_find_device_by_seq(id, seq, true, &dev);
439 return uclass_get_device_tail(dev, ret, devp);
442 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
443 struct udevice **devp)
449 ret = uclass_find_device_by_of_offset(id, node, &dev);
450 return uclass_get_device_tail(dev, ret, devp);
453 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
454 struct udevice **devp)
459 log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
461 ret = uclass_find_device_by_ofnode(id, node, &dev);
462 log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
463 ofnode_get_name(node), dev ? dev->name : "(none)", ret);
465 return uclass_get_device_tail(dev, ret, devp);
468 #if CONFIG_IS_ENABLED(OF_CONTROL)
469 int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
470 struct udevice **devp)
477 ret = uclass_get(id, &uc);
481 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
484 phandle = dev_read_phandle(dev);
486 if (phandle == phandle_id) {
488 return uclass_get_device_tail(dev, ret, devp);
495 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
496 const char *name, struct udevice **devp)
502 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
503 return uclass_get_device_tail(dev, ret, devp);
507 int uclass_first_device(enum uclass_id id, struct udevice **devp)
513 ret = uclass_find_first_device(id, &dev);
516 return uclass_get_device_tail(dev, ret, devp);
519 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
523 ret = uclass_first_device(id, devp);
532 int uclass_next_device(struct udevice **devp)
534 struct udevice *dev = *devp;
538 ret = uclass_find_next_device(&dev);
541 return uclass_get_device_tail(dev, ret, devp);
544 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
549 ret = uclass_find_first_device(id, devp);
555 return device_probe(*devp);
558 int uclass_next_device_check(struct udevice **devp)
562 ret = uclass_find_next_device(devp);
568 return device_probe(*devp);
571 int uclass_bind_device(struct udevice *dev)
577 list_add_tail(&dev->uclass_node, &uc->dev_head);
580 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
582 if (uc_drv->child_post_bind) {
583 ret = uc_drv->child_post_bind(dev);
591 /* There is no need to undo the parent's post_bind call */
592 list_del(&dev->uclass_node);
597 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
598 int uclass_unbind_device(struct udevice *dev)
604 if (uc->uc_drv->pre_unbind) {
605 ret = uc->uc_drv->pre_unbind(dev);
610 list_del(&dev->uclass_node);
615 int uclass_resolve_seq(struct udevice *dev)
621 assert(dev->seq == -1);
622 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
625 dm_warn("Device '%s': seq %d is in use by '%s'\n",
626 dev->name, dev->req_seq, dup->name);
627 } else if (ret == -ENODEV) {
628 /* Our requested sequence number is available */
629 if (dev->req_seq != -1)
635 for (seq = 0; seq < DM_MAX_SEQ; seq++) {
636 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
646 int uclass_pre_probe_device(struct udevice *dev)
648 struct uclass_driver *uc_drv;
651 uc_drv = dev->uclass->uc_drv;
652 if (uc_drv->pre_probe) {
653 ret = uc_drv->pre_probe(dev);
660 uc_drv = dev->parent->uclass->uc_drv;
661 if (uc_drv->child_pre_probe)
662 return uc_drv->child_pre_probe(dev);
667 int uclass_post_probe_device(struct udevice *dev)
669 struct uclass_driver *uc_drv = dev->uclass->uc_drv;
671 if (uc_drv->post_probe)
672 return uc_drv->post_probe(dev);
677 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
678 int uclass_pre_remove_device(struct udevice *dev)
684 if (uc->uc_drv->pre_remove) {
685 ret = uc->uc_drv->pre_remove(dev);