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 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
158 ret = uclass_get(id, &uc);
161 if (list_empty(&uc->dev_head))
164 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
174 int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
180 ret = uclass_get(id, &uc);
183 if (list_empty(&uc->dev_head))
186 *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
191 int uclass_find_next_device(struct udevice **devp)
193 struct udevice *dev = *devp;
196 if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
199 *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
204 int uclass_find_device_by_name(enum uclass_id id, const char *name,
205 struct udevice **devp)
214 ret = uclass_get(id, &uc);
218 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
219 if (!strncmp(dev->name, name, strlen(name))) {
228 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
229 bool find_req_seq, struct udevice **devp)
236 debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
237 if (seq_or_req_seq == -1)
239 ret = uclass_get(id, &uc);
243 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
244 debug(" - %d %d\n", dev->req_seq, dev->seq);
245 if ((find_req_seq ? dev->req_seq : dev->seq) ==
252 debug(" - not found\n");
257 static int uclass_find_device_by_of_offset(enum uclass_id id, int node,
258 struct udevice **devp)
267 ret = uclass_get(id, &uc);
271 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
272 if (dev->of_offset == node) {
281 static int uclass_find_device_by_phandle(enum uclass_id id,
282 struct udevice *parent,
284 struct udevice **devp)
292 find_phandle = fdtdec_get_int(gd->fdt_blob, parent->of_offset, name,
294 if (find_phandle <= 0)
296 ret = uclass_get(id, &uc);
300 list_for_each_entry(dev, &uc->dev_head, uclass_node) {
301 uint phandle = fdt_get_phandle(gd->fdt_blob, dev->of_offset);
303 if (phandle == find_phandle) {
312 int uclass_get_device_tail(struct udevice *dev, int ret,
313 struct udevice **devp)
319 ret = device_probe(dev);
328 int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
334 ret = uclass_find_device(id, index, &dev);
335 return uclass_get_device_tail(dev, ret, devp);
338 int uclass_get_device_by_name(enum uclass_id id, const char *name,
339 struct udevice **devp)
345 ret = uclass_find_device_by_name(id, name, &dev);
346 return uclass_get_device_tail(dev, ret, devp);
349 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
355 ret = uclass_find_device_by_seq(id, seq, false, &dev);
356 if (ret == -ENODEV) {
358 * We didn't find it in probed devices. See if there is one
359 * that will request this seq if probed.
361 ret = uclass_find_device_by_seq(id, seq, true, &dev);
363 return uclass_get_device_tail(dev, ret, devp);
366 int uclass_get_device_by_of_offset(enum uclass_id id, int node,
367 struct udevice **devp)
373 ret = uclass_find_device_by_of_offset(id, node, &dev);
374 return uclass_get_device_tail(dev, ret, devp);
377 int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
378 const char *name, struct udevice **devp)
384 ret = uclass_find_device_by_phandle(id, parent, name, &dev);
385 return uclass_get_device_tail(dev, ret, devp);
388 int uclass_first_device(enum uclass_id id, struct udevice **devp)
394 ret = uclass_find_first_device(id, &dev);
397 return uclass_get_device_tail(dev, ret, devp);
400 int uclass_next_device(struct udevice **devp)
402 struct udevice *dev = *devp;
406 ret = uclass_find_next_device(&dev);
409 return uclass_get_device_tail(dev, ret, devp);
412 int uclass_bind_device(struct udevice *dev)
418 list_add_tail(&dev->uclass_node, &uc->dev_head);
421 struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
423 if (uc_drv->child_post_bind) {
424 ret = uc_drv->child_post_bind(dev);
429 if (uc->uc_drv->post_bind) {
430 ret = uc->uc_drv->post_bind(dev);
437 /* There is no need to undo the parent's post_bind call */
438 list_del(&dev->uclass_node);
443 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
444 int uclass_unbind_device(struct udevice *dev)
450 if (uc->uc_drv->pre_unbind) {
451 ret = uc->uc_drv->pre_unbind(dev);
456 list_del(&dev->uclass_node);
461 int uclass_resolve_seq(struct udevice *dev)
467 assert(dev->seq == -1);
468 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
471 dm_warn("Device '%s': seq %d is in use by '%s'\n",
472 dev->name, dev->req_seq, dup->name);
473 } else if (ret == -ENODEV) {
474 /* Our requested sequence number is available */
475 if (dev->req_seq != -1)
481 for (seq = 0; seq < DM_MAX_SEQ; seq++) {
482 ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
492 int uclass_pre_probe_device(struct udevice *dev)
494 struct uclass_driver *uc_drv;
497 uc_drv = dev->uclass->uc_drv;
498 if (uc_drv->pre_probe) {
499 ret = uc_drv->pre_probe(dev);
506 uc_drv = dev->parent->uclass->uc_drv;
507 if (uc_drv->child_pre_probe)
508 return uc_drv->child_pre_probe(dev);
513 int uclass_post_probe_device(struct udevice *dev)
515 struct uclass_driver *uc_drv = dev->uclass->uc_drv;
517 if (uc_drv->post_probe)
518 return uc_drv->post_probe(dev);
523 #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
524 int uclass_pre_remove_device(struct udevice *dev)
526 struct uclass_driver *uc_drv;
532 if (uc->uc_drv->pre_remove) {
533 ret = uc->uc_drv->pre_remove(dev);
537 if (uc_drv->per_device_auto_alloc_size) {
538 free(dev->uclass_priv);
539 dev->uclass_priv = NULL;