of: Add of_property_match_string() to find index into a string list

Add a helper function for finding the index of a string in a string
list property.  This helper is useful for bindings that use a separate
*-name property for attaching names to tuples in another property such
as 'reg' or 'gpios'.

Signed-off-by: Grant Likely <grant.likely@secretlab.ca>

2 files changed, 65 insertions, 0 deletions

diff --git a/drivers/of/base.c b/drivers/of/base.c
index 133908a6fd8d..13ba72875e25 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -761,6 +761,42 @@ int of_property_read_string_index(struct device_node *np, const char *propname,
 }
 EXPORT_SYMBOL_GPL(of_property_read_string_index);
 
+/**
+ * of_property_match_string() - Find string in a list and return index
+ * @np: pointer to node containing string list property
+ * @propname: string list property name
+ * @string: pointer to string to search for in string list
+ *
+ * This function searches a string list property and returns the index
+ * of a specific string value.
+ */
+int of_property_match_string(struct device_node *np, const char *propname,
+                             const char *string)
+{
+        struct property *prop = of_find_property(np, propname, NULL);
+        size_t l;
+        int i;
+        const char *p, *end;
+
+        if (!prop)
+                return -EINVAL;
+        if (!prop->value)
+                return -ENODATA;
+
+        p = prop->value;
+        end = p + prop->length;
+
+        for (i = 0; p < end; i++, p += l) {
+                l = strlen(p) + 1;
+                if (p + l > end)
+                        return -EILSEQ;
+                pr_debug("comparing %s with %s\n", string, p);
+                if (strcmp(string, p) == 0)
+                        return i; /* Found it; return index */
+        }
+        return -ENODATA;
+}
+EXPORT_SYMBOL_GPL(of_property_match_string);
 
 /**
  * of_property_count_strings - Find and return the number of strings from a
diff --git a/drivers/of/selftest.c b/drivers/of/selftest.c
index 9d2b4803a9d6..f24ffd7088d2 100644
--- a/drivers/of/selftest.c
+++ b/drivers/of/selftest.c
@@ -120,6 +120,34 @@ static void __init of_selftest_parse_phandle_with_args(void)
         pr_info("end - %s\n", passed_all ? "PASS" : "FAIL");
 }
 
+static void __init of_selftest_property_match_string(void)
+{
+        struct device_node *np;
+        int rc;
+
+        pr_info("start\n");
+        np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
+        if (!np) {
+                pr_err("No testcase data in device tree\n");
+                return;
+        }
+
+        rc = of_property_match_string(np, "phandle-list-names", "first");
+        selftest(rc == 0, "first expected:0 got:%i\n", rc);
+        rc = of_property_match_string(np, "phandle-list-names", "second");
+        selftest(rc == 1, "second expected:0 got:%i\n", rc);
+        rc = of_property_match_string(np, "phandle-list-names", "third");
+        selftest(rc == 2, "third expected:0 got:%i\n", rc);
+        rc = of_property_match_string(np, "phandle-list-names", "fourth");
+        selftest(rc == -ENODATA, "unmatched string; rc=%i", rc);
+        rc = of_property_match_string(np, "missing-property", "blah");
+        selftest(rc == -EINVAL, "missing property; rc=%i", rc);
+        rc = of_property_match_string(np, "empty-property", "blah");
+        selftest(rc == -ENODATA, "empty property; rc=%i", rc);
+        rc = of_property_match_string(np, "unterminated-string", "blah");
+        selftest(rc == -EILSEQ, "unterminated string; rc=%i", rc);
+}
+
 static int __init of_selftest(void)
 {
         struct device_node *np;
@@ -133,6 +161,7 @@ static int __init of_selftest(void)
 
         pr_info("start of selftest - you will see error messages\n");
         of_selftest_parse_phandle_with_args();
+        of_selftest_property_match_string();
         pr_info("end of selftest - %s\n", selftest_passed ? "PASS" : "FAIL");
         return 0;
 }