2 * Copyright (c) 2013 Google, Inc
5 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 * SPDX-License-Identifier: GPL-2.0+
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);
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 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
167 ret = uclass_get(id, &uc);
170 if (list_empty(&uc->dev_head))
173 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
183 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
189 ret = uclass_get(id, &uc);
192 if (list_empty(&uc->dev_head))
195 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
200 int uclass_find_next_device(struct udevice **devp)
202 struct udevice *dev = *devp;
205 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
208 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
213 int uclass_find_device_by_name(enum uclass_id id, const char *name,
214 struct udevice **devp)
223 ret = uclass_get(id, &uc);
227 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
228 if (!strncmp(dev->name, name, strlen(name))) {
237 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
238 bool find_req_seq, struct udevice **devp)
245 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
246 if (seq_or_req_seq == -1)
248 ret = uclass_get(id, &uc);
252 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
253 debug(" - %d %d\n", dev->req_seq, dev->seq);
254 if ((find_req_seq ? dev->req_seq : dev->seq) ==
261 debug(" - not found\n");
266 int uclass_find_device_by_of_offset(enum uclass_id id, int node,
267 struct udevice **devp)
276 ret = uclass_get(id, &uc);
280 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
281 if (dev->of_offset == node) {
290 #if CONFIG_IS_ENABLED(OF_CONTROL)
291 static int uclass_find_device_by_phandle(enum uclass_id id,
292 struct udevice *parent,
294 struct udevice **devp)
302 find_phandle = fdtdec_get_int(gd->fdt_blob, parent->of_offset, name,
304 if (find_phandle <= 0)
306 ret = uclass_get(id, &uc);
310 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
311 uint phandle = fdt_get_phandle(gd->fdt_blob, dev->of_offset);
313 if (phandle == find_phandle) {
323 int uclass_get_device_by_driver(enum uclass_id id,
324 const struct driver *find_drv,
325 struct udevice **devp)
331 ret = uclass_get(id, &uc);
335 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
336 if (dev->driver == find_drv)
337 return uclass_get_device_tail(dev, 0, devp);
343 int uclass_get_device_tail(struct udevice *dev, int ret,
344 struct udevice **devp)
350 ret = device_probe(dev);
359 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
365 ret = uclass_find_device(id, index, &dev);
366 return uclass_get_device_tail(dev, ret, devp);
369 int uclass_get_device_by_name(enum uclass_id id, const char *name,
370 struct udevice **devp)
376 ret = uclass_find_device_by_name(id, name, &dev);
377 return uclass_get_device_tail(dev, ret, devp);
380 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
386 ret = uclass_find_device_by_seq(id, seq, false, &dev);
387 if (ret == -ENODEV) {
389 * We didn't find it in probed devices. See if there is one
390 * that will request this seq if probed.
392 ret = uclass_find_device_by_seq(id, seq, true, &dev);
394 return uclass_get_device_tail(dev, ret, devp);
397 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
398 struct udevice **devp)
404 ret = uclass_find_device_by_of_offset(id, node, &dev);
405 return uclass_get_device_tail(dev, ret, devp);
408 #if CONFIG_IS_ENABLED(OF_CONTROL)
409 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
410 const char *name, struct udevice **devp)
416 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
417 return uclass_get_device_tail(dev, ret, devp);
421 int uclass_first_device(enum uclass_id id, struct udevice **devp)
427 ret = uclass_find_first_device(id, &dev);
430 return uclass_get_device_tail(dev, ret, devp);
433 int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
437 ret = uclass_first_device(id, devp);
446 int uclass_next_device(struct udevice **devp)
448 struct udevice *dev = *devp;
452 ret = uclass_find_next_device(&dev);
455 return uclass_get_device_tail(dev, ret, devp);
458 int uclass_bind_device(struct udevice *dev)
464 list_add_tail(&dev->uclass_node, &uc->dev_head);
467 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
469 if (uc_drv->child_post_bind) {
470 ret = uc_drv->child_post_bind(dev);
478 /* There is no need to undo the parent's post_bind call */
479 list_del(&dev->uclass_node);
484 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
485 int uclass_unbind_device(struct udevice *dev)
491 if (uc->uc_drv->pre_unbind) {
492 ret = uc->uc_drv->pre_unbind(dev);
497 list_del(&dev->uclass_node);
502 int uclass_resolve_seq(struct udevice *dev)
508 assert(dev->seq == -1);
509 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
512 dm_warn("Device '%s': seq %d is in use by '%s'\n",
513 dev->name, dev->req_seq, dup->name);
514 } else if (ret == -ENODEV) {
515 /* Our requested sequence number is available */
516 if (dev->req_seq != -1)
522 for (seq = 0; seq < DM_MAX_SEQ; seq++) {
523 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
533 int uclass_pre_probe_device(struct udevice *dev)
535 struct uclass_driver *uc_drv;
538 uc_drv = dev->uclass->uc_drv;
539 if (uc_drv->pre_probe) {
540 ret = uc_drv->pre_probe(dev);
547 uc_drv = dev->parent->uclass->uc_drv;
548 if (uc_drv->child_pre_probe)
549 return uc_drv->child_pre_probe(dev);
554 int uclass_post_probe_device(struct udevice *dev)
556 struct uclass_driver *uc_drv = dev->uclass->uc_drv;
558 if (uc_drv->post_probe)
559 return uc_drv->post_probe(dev);
564 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
565 int uclass_pre_remove_device(struct udevice *dev)
571 if (uc->uc_drv->pre_remove) {
572 ret = uc->uc_drv->pre_remove(dev);