net: ks8851: Pass around driver private data
[oweals/u-boot.git] / drivers / core / uclass.c
index 61ca17e564a25dff143da7c26b8d886dab90de04..2ab419cfe4da0171aee21d14d69a79d21d5d0f38 100644 (file)
@@ -1,14 +1,17 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright (c) 2013 Google, Inc
  *
  * (C) Copyright 2012
  * Pavel Herrmann <morpheus.ibis@gmail.com>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
+#define LOG_CATEGORY LOGC_DM
+
 #include <common.h>
+#include <dm.h>
 #include <errno.h>
+#include <log.h>
 #include <malloc.h>
 #include <dm/device.h>
 #include <dm/device-internal.h>
@@ -56,13 +59,14 @@ static int uclass_add(enum uclass_id id, struct uclass **ucp)
        *ucp = NULL;
        uc_drv = lists_uclass_lookup(id);
        if (!uc_drv) {
-               dm_warn("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
-                       id);
-               return -ENOENT;
-       }
-       if (uc_drv->ops) {
-               dm_warn("No ops for uclass id %d\n", id);
-               return -EINVAL;
+               debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
+                     id);
+               /*
+                * Use a strange error to make this case easier to find. When
+                * a uclass is not available it can prevent driver model from
+                * starting up and this failure is otherwise hard to debug.
+                */
+               return -EPFNOSUPPORT;
        }
        uc = calloc(1, sizeof(*uc));
        if (!uc)
@@ -103,16 +107,24 @@ fail_mem:
 int uclass_destroy(struct uclass *uc)
 {
        struct uclass_driver *uc_drv;
-       struct udevice *dev, *tmp;
+       struct udevice *dev;
        int ret;
 
-       list_for_each_entry_safe(dev, tmp, &uc->dev_head, uclass_node) {
-               ret = device_remove(dev);
+       /*
+        * We cannot use list_for_each_entry_safe() here. If a device in this
+        * uclass has a child device also in this uclass, it will be also be
+        * unbound (by the recursion in the call to device_unbind() below).
+        * We can loop until the list is empty.
+        */
+       while (!list_empty(&uc->dev_head)) {
+               dev = list_first_entry(&uc->dev_head, struct udevice,
+                                      uclass_node);
+               ret = device_remove(dev, DM_REMOVE_NORMAL | DM_REMOVE_NO_PD);
                if (ret)
-                       return ret;
+                       return log_msg_ret("remove", ret);
                ret = device_unbind(dev);
                if (ret)
-                       return ret;
+                       return log_msg_ret("unbind", ret);
        }
 
        uc_drv = uc->uc_drv;
@@ -139,6 +151,50 @@ int uclass_get(enum uclass_id id, struct uclass **ucp)
        return 0;
 }
 
+const char *uclass_get_name(enum uclass_id id)
+{
+       struct uclass *uc;
+
+       if (uclass_get(id, &uc))
+               return NULL;
+       return uc->uc_drv->name;
+}
+
+enum uclass_id uclass_get_by_name(const char *name)
+{
+       int i;
+
+       for (i = 0; i < UCLASS_COUNT; i++) {
+               struct uclass_driver *uc_drv = lists_uclass_lookup(i);
+
+               if (uc_drv && !strcmp(uc_drv->name, name))
+                       return i;
+       }
+
+       return UCLASS_INVALID;
+}
+
+int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
+{
+       struct udevice *iter;
+       struct uclass *uc = dev->uclass;
+       int i = 0;
+
+       if (list_empty(&uc->dev_head))
+               return -ENODEV;
+
+       uclass_foreach_dev(iter, uc) {
+               if (iter == dev) {
+                       if (ucp)
+                               *ucp = uc;
+                       return i;
+               }
+               i++;
+       }
+
+       return -ENODEV;
+}
+
 int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
 {
        struct uclass *uc;
@@ -149,8 +205,10 @@ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
        ret = uclass_get(id, &uc);
        if (ret)
                return ret;
+       if (list_empty(&uc->dev_head))
+               return -ENODEV;
 
-       list_for_each_entry(dev, &uc->dev_head, uclass_node) {
+       uclass_foreach_dev(dev, uc) {
                if (!index--) {
                        *devp = dev;
                        return 0;
@@ -160,6 +218,82 @@ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
        return -ENODEV;
 }
 
+int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
+{
+       struct uclass *uc;
+       int ret;
+
+       *devp = NULL;
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+       if (list_empty(&uc->dev_head))
+               return 0;
+
+       *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
+
+       return 0;
+}
+
+int uclass_find_next_device(struct udevice **devp)
+{
+       struct udevice *dev = *devp;
+
+       *devp = NULL;
+       if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
+               return 0;
+
+       *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
+
+       return 0;
+}
+
+int uclass_find_device_by_name(enum uclass_id id, const char *name,
+                              struct udevice **devp)
+{
+       struct uclass *uc;
+       struct udevice *dev;
+       int ret;
+
+       *devp = NULL;
+       if (!name)
+               return -EINVAL;
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+
+       uclass_foreach_dev(dev, uc) {
+               if (!strcmp(dev->name, name)) {
+                       *devp = dev;
+                       return 0;
+               }
+       }
+
+       return -ENODEV;
+}
+
+int uclass_find_next_free_req_seq(enum uclass_id id)
+{
+       struct uclass *uc;
+       struct udevice *dev;
+       int ret;
+       int max = -1;
+
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+
+       list_for_each_entry(dev, &uc->dev_head, uclass_node) {
+               if ((dev->req_seq != -1) && (dev->req_seq > max))
+                       max = dev->req_seq;
+       }
+
+       if (max == -1)
+               return 0;
+
+       return max + 1;
+}
+
 int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
                              bool find_req_seq, struct udevice **devp)
 {
@@ -168,29 +302,30 @@ int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
        int ret;
 
        *devp = NULL;
-       debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
+       log_debug("%d %d\n", find_req_seq, seq_or_req_seq);
        if (seq_or_req_seq == -1)
                return -ENODEV;
        ret = uclass_get(id, &uc);
        if (ret)
                return ret;
 
-       list_for_each_entry(dev, &uc->dev_head, uclass_node) {
-               debug("   - %d %d\n", dev->req_seq, dev->seq);
+       uclass_foreach_dev(dev, uc) {
+               log_debug("   - %d %d '%s'\n",
+                         dev->req_seq, dev->seq, dev->name);
                if ((find_req_seq ? dev->req_seq : dev->seq) ==
                                seq_or_req_seq) {
                        *devp = dev;
-                       debug("   - found\n");
+                       log_debug("   - found\n");
                        return 0;
                }
        }
-       debug("   - not found\n");
+       log_debug("   - not found\n");
 
        return -ENODEV;
 }
 
-static int uclass_find_device_by_of_offset(enum uclass_id id, int node,
-                                          struct udevice **devp)
+int uclass_find_device_by_of_offset(enum uclass_id id, int node,
+                                   struct udevice **devp)
 {
        struct uclass *uc;
        struct udevice *dev;
@@ -203,8 +338,8 @@ static int uclass_find_device_by_of_offset(enum uclass_id id, int node,
        if (ret)
                return ret;
 
-       list_for_each_entry(dev, &uc->dev_head, uclass_node) {
-               if (dev->of_offset == node) {
+       uclass_foreach_dev(dev, uc) {
+               if (dev_of_offset(dev) == node) {
                        *devp = dev;
                        return 0;
                }
@@ -213,22 +348,95 @@ static int uclass_find_device_by_of_offset(enum uclass_id id, int node,
        return -ENODEV;
 }
 
-/**
- * uclass_get_device_tail() - handle the end of a get_device call
- *
- * This handles returning an error or probing a device as needed.
- *
- * @dev: Device that needs to be probed
- * @ret: Error to return. If non-zero then the device is not probed
- * @devp: Returns the value of 'dev' if there is no error
- * @return ret, if non-zero, else the result of the device_probe() call
- */
-static int uclass_get_device_tail(struct udevice *dev, int ret,
-                                 struct udevice **devp)
+int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
+                                struct udevice **devp)
+{
+       struct uclass *uc;
+       struct udevice *dev;
+       int ret;
+
+       log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
+       *devp = NULL;
+       if (!ofnode_valid(node))
+               return -ENODEV;
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+
+       uclass_foreach_dev(dev, uc) {
+               log(LOGC_DM, LOGL_DEBUG_CONTENT, "      - checking %s\n",
+                   dev->name);
+               if (ofnode_equal(dev_ofnode(dev), node)) {
+                       *devp = dev;
+                       goto done;
+               }
+       }
+       ret = -ENODEV;
+
+done:
+       log(LOGC_DM, LOGL_DEBUG, "   - result for %s: %s (ret=%d)\n",
+           ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
+       return ret;
+}
+
+#if CONFIG_IS_ENABLED(OF_CONTROL)
+int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
+                                 const char *name, struct udevice **devp)
+{
+       struct udevice *dev;
+       struct uclass *uc;
+       int find_phandle;
+       int ret;
+
+       *devp = NULL;
+       find_phandle = dev_read_u32_default(parent, name, -1);
+       if (find_phandle <= 0)
+               return -ENOENT;
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+
+       uclass_foreach_dev(dev, uc) {
+               uint phandle;
+
+               phandle = dev_read_phandle(dev);
+
+               if (phandle == find_phandle) {
+                       *devp = dev;
+                       return 0;
+               }
+       }
+
+       return -ENODEV;
+}
+#endif
+
+int uclass_get_device_by_driver(enum uclass_id id,
+                               const struct driver *find_drv,
+                               struct udevice **devp)
+{
+       struct udevice *dev;
+       struct uclass *uc;
+       int ret;
+
+       ret = uclass_get(id, &uc);
+       if (ret)
+               return ret;
+
+       uclass_foreach_dev(dev, uc) {
+               if (dev->driver == find_drv)
+                       return uclass_get_device_tail(dev, 0, devp);
+       }
+
+       return -ENODEV;
+}
+
+int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
 {
        if (ret)
                return ret;
 
+       assert(dev);
        ret = device_probe(dev);
        if (ret)
                return ret;
@@ -248,6 +456,17 @@ int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
        return uclass_get_device_tail(dev, ret, devp);
 }
 
+int uclass_get_device_by_name(enum uclass_id id, const char *name,
+                             struct udevice **devp)
+{
+       struct udevice *dev;
+       int ret;
+
+       *devp = NULL;
+       ret = uclass_find_device_by_name(id, name, &dev);
+       return uclass_get_device_tail(dev, ret, devp);
+}
+
 int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
 {
        struct udevice *dev;
@@ -276,24 +495,81 @@ int uclass_get_device_by_of_offset(enum uclass_id id, int node,
        return uclass_get_device_tail(dev, ret, devp);
 }
 
-int uclass_first_device(enum uclass_id id, struct udevice **devp)
+int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
+                               struct udevice **devp)
+{
+       struct udevice *dev;
+       int ret;
+
+       log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
+       *devp = NULL;
+       ret = uclass_find_device_by_ofnode(id, node, &dev);
+       log(LOGC_DM, LOGL_DEBUG, "   - result for %s: %s (ret=%d)\n",
+           ofnode_get_name(node), dev ? dev->name : "(none)", ret);
+
+       return uclass_get_device_tail(dev, ret, devp);
+}
+
+#if CONFIG_IS_ENABLED(OF_CONTROL)
+int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
+                                   struct udevice **devp)
 {
-       struct uclass *uc;
        struct udevice *dev;
+       struct uclass *uc;
        int ret;
 
        *devp = NULL;
        ret = uclass_get(id, &uc);
        if (ret)
                return ret;
-       if (list_empty(&uc->dev_head))
+
+       uclass_foreach_dev(dev, uc) {
+               uint phandle;
+
+               phandle = dev_read_phandle(dev);
+
+               if (phandle == phandle_id) {
+                       *devp = dev;
+                       return uclass_get_device_tail(dev, ret, devp);
+               }
+       }
+
+       return -ENODEV;
+}
+
+int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
+                                const char *name, struct udevice **devp)
+{
+       struct udevice *dev;
+       int ret;
+
+       *devp = NULL;
+       ret = uclass_find_device_by_phandle(id, parent, name, &dev);
+       return uclass_get_device_tail(dev, ret, devp);
+}
+#endif
+
+int uclass_first_device(enum uclass_id id, struct udevice **devp)
+{
+       struct udevice *dev;
+       int ret;
+
+       *devp = NULL;
+       ret = uclass_find_first_device(id, &dev);
+       if (!dev)
                return 0;
+       return uclass_get_device_tail(dev, ret, devp);
+}
 
-       dev = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
-       ret = device_probe(dev);
+int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
+{
+       int ret;
+
+       ret = uclass_first_device(id, devp);
        if (ret)
                return ret;
-       *devp = dev;
+       else if (!*devp)
+               return -ENODEV;
 
        return 0;
 }
@@ -304,39 +580,96 @@ int uclass_next_device(struct udevice **devp)
        int ret;
 
        *devp = NULL;
-       if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
+       ret = uclass_find_next_device(&dev);
+       if (!dev)
                return 0;
+       return uclass_get_device_tail(dev, ret, devp);
+}
 
-       dev = list_entry(dev->uclass_node.next, struct udevice,
-                        uclass_node);
-       ret = device_probe(dev);
+int uclass_next_device_err(struct udevice **devp)
+{
+       int ret;
+
+       ret = uclass_next_device(devp);
        if (ret)
                return ret;
-       *devp = dev;
+       else if (!*devp)
+               return -ENODEV;
 
        return 0;
 }
 
+int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
+{
+       int ret;
+
+       *devp = NULL;
+       ret = uclass_find_first_device(id, devp);
+       if (ret)
+               return ret;
+       if (!*devp)
+               return 0;
+
+       return device_probe(*devp);
+}
+
+int uclass_next_device_check(struct udevice **devp)
+{
+       int ret;
+
+       ret = uclass_find_next_device(devp);
+       if (ret)
+               return ret;
+       if (!*devp)
+               return 0;
+
+       return device_probe(*devp);
+}
+
+int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
+                               struct udevice **devp)
+{
+       struct udevice *dev;
+       struct uclass *uc;
+
+       uclass_id_foreach_dev(id, dev, uc) {
+               if (dev_get_driver_data(dev) == driver_data) {
+                       *devp = dev;
+
+                       return device_probe(dev);
+               }
+       }
+
+       return -ENODEV;
+}
+
 int uclass_bind_device(struct udevice *dev)
 {
        struct uclass *uc;
        int ret;
 
        uc = dev->uclass;
-
        list_add_tail(&dev->uclass_node, &uc->dev_head);
 
-       if (uc->uc_drv->post_bind) {
-               ret = uc->uc_drv->post_bind(dev);
-               if (ret) {
-                       list_del(&dev->uclass_node);
-                       return ret;
+       if (dev->parent) {
+               struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
+
+               if (uc_drv->child_post_bind) {
+                       ret = uc_drv->child_post_bind(dev);
+                       if (ret)
+                               goto err;
                }
        }
 
        return 0;
+err:
+       /* There is no need to undo the parent's post_bind call */
+       list_del(&dev->uclass_node);
+
+       return ret;
 }
 
+#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 int uclass_unbind_device(struct udevice *dev)
 {
        struct uclass *uc;
@@ -352,6 +685,7 @@ int uclass_unbind_device(struct udevice *dev)
        list_del(&dev->uclass_node);
        return 0;
 }
+#endif
 
 int uclass_resolve_seq(struct udevice *dev)
 {
@@ -384,34 +718,72 @@ int uclass_resolve_seq(struct udevice *dev)
        return seq;
 }
 
+int uclass_pre_probe_device(struct udevice *dev)
+{
+       struct uclass_driver *uc_drv;
+       int ret;
+
+       uc_drv = dev->uclass->uc_drv;
+       if (uc_drv->pre_probe) {
+               ret = uc_drv->pre_probe(dev);
+               if (ret)
+                       return ret;
+       }
+
+       if (!dev->parent)
+               return 0;
+       uc_drv = dev->parent->uclass->uc_drv;
+       if (uc_drv->child_pre_probe) {
+               ret = uc_drv->child_pre_probe(dev);
+               if (ret)
+                       return ret;
+       }
+
+       return 0;
+}
+
 int uclass_post_probe_device(struct udevice *dev)
 {
-       struct uclass_driver *uc_drv = dev->uclass->uc_drv;
+       struct uclass_driver *uc_drv;
+       int ret;
 
-       if (uc_drv->post_probe)
-               return uc_drv->post_probe(dev);
+       if (dev->parent) {
+               uc_drv = dev->parent->uclass->uc_drv;
+               if (uc_drv->child_post_probe) {
+                       ret = uc_drv->child_post_probe(dev);
+                       if (ret)
+                               return ret;
+               }
+       }
+
+       uc_drv = dev->uclass->uc_drv;
+       if (uc_drv->post_probe) {
+               ret = uc_drv->post_probe(dev);
+               if (ret)
+                       return ret;
+       }
 
        return 0;
 }
 
+#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
 int uclass_pre_remove_device(struct udevice *dev)
 {
-       struct uclass_driver *uc_drv;
        struct uclass *uc;
        int ret;
 
        uc = dev->uclass;
-       uc_drv = uc->uc_drv;
        if (uc->uc_drv->pre_remove) {
                ret = uc->uc_drv->pre_remove(dev);
                if (ret)
                        return ret;
        }
-       if (uc_drv->per_device_auto_alloc_size) {
-               free(dev->uclass_priv);
-               dev->uclass_priv = NULL;
-       }
-       dev->seq = -1;
 
        return 0;
 }
+#endif
+
+UCLASS_DRIVER(nop) = {
+       .id             = UCLASS_NOP,
+       .name           = "nop",
+};