2 * Copyright (c) 2013 Google, Inc
5 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 * SPDX-License-Identifier: GPL-2.0+
14 #include <dm/device.h>
15 #include <dm/device-internal.h>
17 #include <dm/uclass.h>
18 #include <dm/uclass-internal.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 struct uclass *uclass_find(enum uclass_id key)
30 * TODO(sjg@chromium.org): Optimise this, perhaps moving the found
31 * node to the start of the list, or creating a linear array mapping
34 list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
35 if (uc->uc_drv->id == key)
43 * uclass_add() - Create new uclass in list
44 * @id: Id number to create
45 * @ucp: Returns pointer to uclass, or NULL on error
46 * @return 0 on success, -ve on error
48 * The new uclass is added to the list. There must be only one uclass for
51 static int uclass_add(enum uclass_id id, struct uclass **ucp)
53 struct uclass_driver *uc_drv;
58 uc_drv = lists_uclass_lookup(id);
60 debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
63 * Use a strange error to make this case easier to find. When
64 * a uclass is not available it can prevent driver model from
65 * starting up and this failure is otherwise hard to debug.
69 uc = calloc(1, sizeof(*uc));
72 if (uc_drv->priv_auto_alloc_size) {
73 uc->priv = calloc(1, uc_drv->priv_auto_alloc_size);
80 INIT_LIST_HEAD(&uc->sibling_node);
81 INIT_LIST_HEAD(&uc->dev_head);
82 list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST);
85 ret = uc_drv->init(uc);
94 if (uc_drv->priv_auto_alloc_size) {
98 list_del(&uc->sibling_node);
105 int uclass_destroy(struct uclass *uc)
107 struct uclass_driver *uc_drv;
112 * We cannot use list_for_each_entry_safe() here. If a device in this
113 * uclass has a child device also in this uclass, it will be also be
114 * unbound (by the recursion in the call to device_unbind() below).
115 * We can loop until the list is empty.
117 while (!list_empty(&uc->dev_head)) {
118 dev = list_first_entry(&uc->dev_head, struct udevice,
120 ret = device_remove(dev, DM_REMOVE_NORMAL);
123 ret = device_unbind(dev);
131 list_del(&uc->sibling_node);
132 if (uc_drv->priv_auto_alloc_size)
139 int uclass_get(enum uclass_id id, struct uclass **ucp)
144 uc = uclass_find(id);
146 return uclass_add(id, ucp);
152 const char *uclass_get_name(enum uclass_id id)
156 if (uclass_get(id, &uc))
158 return uc->uc_drv->name;
161 enum uclass_id uclass_get_by_name(const char *name)
165 for (i = 0; i < UCLASS_COUNT; i++) {
166 struct uclass_driver *uc_drv = lists_uclass_lookup(i);
168 if (uc_drv && !strcmp(uc_drv->name, name))
172 return UCLASS_INVALID;
175 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
182 ret = uclass_get(id, &uc);
185 if (list_empty(&uc->dev_head))
188 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
198 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
204 ret = uclass_get(id, &uc);
207 if (list_empty(&uc->dev_head))
210 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
215 int uclass_find_next_device(struct udevice **devp)
217 struct udevice *dev = *devp;
220 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
223 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
228 int uclass_find_device_by_name(enum uclass_id id, const char *name,
229 struct udevice **devp)
238 ret = uclass_get(id, &uc);
242 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
243 if (!strncmp(dev->name, name, strlen(name))) {
252 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
253 bool find_req_seq, struct udevice **devp)
260 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
261 if (seq_or_req_seq == -1)
263 ret = uclass_get(id, &uc);
267 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
268 debug(" - %d %d '%s'\n", dev->req_seq, dev->seq, dev->name);
269 if ((find_req_seq ? dev->req_seq : dev->seq) ==
276 debug(" - not found\n");
281 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
282 struct udevice **devp)
291 ret = uclass_get(id, &uc);
295 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
296 if (dev_of_offset(dev) == node) {
305 int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
306 struct udevice **devp)
313 if (!ofnode_valid(node))
315 ret = uclass_get(id, &uc);
319 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
320 if (ofnode_equal(dev_ofnode(dev), node)) {
329 #if CONFIG_IS_ENABLED(OF_CONTROL)
330 static int uclass_find_device_by_phandle(enum uclass_id id,
331 struct udevice *parent,
333 struct udevice **devp)
341 find_phandle = dev_read_u32_default(parent, name, -1);
342 if (find_phandle <= 0)
344 ret = uclass_get(id, &uc);
348 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
351 phandle = dev_read_phandle(dev);
353 if (phandle == find_phandle) {
363 int uclass_get_device_by_driver(enum uclass_id id,
364 const struct driver *find_drv,
365 struct udevice **devp)
371 ret = uclass_get(id, &uc);
375 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
376 if (dev->driver == find_drv)
377 return uclass_get_device_tail(dev, 0, devp);
383 int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
389 ret = device_probe(dev);
398 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
404 ret = uclass_find_device(id, index, &dev);
405 return uclass_get_device_tail(dev, ret, devp);
408 int uclass_get_device_by_name(enum uclass_id id, const char *name,
409 struct udevice **devp)
415 ret = uclass_find_device_by_name(id, name, &dev);
416 return uclass_get_device_tail(dev, ret, devp);
419 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
425 ret = uclass_find_device_by_seq(id, seq, false, &dev);
426 if (ret == -ENODEV) {
428 * We didn't find it in probed devices. See if there is one
429 * that will request this seq if probed.
431 ret = uclass_find_device_by_seq(id, seq, true, &dev);
433 return uclass_get_device_tail(dev, ret, devp);
436 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
437 struct udevice **devp)
443 ret = uclass_find_device_by_of_offset(id, node, &dev);
444 return uclass_get_device_tail(dev, ret, devp);
447 int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
448 struct udevice **devp)
454 ret = uclass_find_device_by_ofnode(id, node, &dev);
456 return uclass_get_device_tail(dev, ret, devp);
459 #if CONFIG_IS_ENABLED(OF_CONTROL)
460 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
461 const char *name, struct udevice **devp)
467 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
468 return uclass_get_device_tail(dev, ret, devp);
472 int uclass_first_device(enum uclass_id id, struct udevice **devp)
478 ret = uclass_find_first_device(id, &dev);
481 return uclass_get_device_tail(dev, ret, devp);
484 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
488 ret = uclass_first_device(id, devp);
497 int uclass_next_device(struct udevice **devp)
499 struct udevice *dev = *devp;
503 ret = uclass_find_next_device(&dev);
506 return uclass_get_device_tail(dev, ret, devp);
509 int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
514 ret = uclass_find_first_device(id, devp);
520 return device_probe(*devp);
523 int uclass_next_device_check(struct udevice **devp)
527 ret = uclass_find_next_device(devp);
533 return device_probe(*devp);
536 int uclass_bind_device(struct udevice *dev)
542 list_add_tail(&dev->uclass_node, &uc->dev_head);
545 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
547 if (uc_drv->child_post_bind) {
548 ret = uc_drv->child_post_bind(dev);
556 /* There is no need to undo the parent's post_bind call */
557 list_del(&dev->uclass_node);
562 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
563 int uclass_unbind_device(struct udevice *dev)
569 if (uc->uc_drv->pre_unbind) {
570 ret = uc->uc_drv->pre_unbind(dev);
575 list_del(&dev->uclass_node);
580 int uclass_resolve_seq(struct udevice *dev)
586 assert(dev->seq == -1);
587 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
590 dm_warn("Device '%s': seq %d is in use by '%s'\n",
591 dev->name, dev->req_seq, dup->name);
592 } else if (ret == -ENODEV) {
593 /* Our requested sequence number is available */
594 if (dev->req_seq != -1)
600 for (seq = 0; seq < DM_MAX_SEQ; seq++) {
601 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
611 int uclass_pre_probe_device(struct udevice *dev)
613 struct uclass_driver *uc_drv;
616 uc_drv = dev->uclass->uc_drv;
617 if (uc_drv->pre_probe) {
618 ret = uc_drv->pre_probe(dev);
625 uc_drv = dev->parent->uclass->uc_drv;
626 if (uc_drv->child_pre_probe)
627 return uc_drv->child_pre_probe(dev);
632 int uclass_post_probe_device(struct udevice *dev)
634 struct uclass_driver *uc_drv = dev->uclass->uc_drv;
636 if (uc_drv->post_probe)
637 return uc_drv->post_probe(dev);
642 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
643 int uclass_pre_remove_device(struct udevice *dev)
649 if (uc->uc_drv->pre_remove) {
650 ret = uc->uc_drv->pre_remove(dev);