drivers/of/selftest.c

   1 /*
   2  * Self tests for device tree subsystem
   3  */
   4
   5 #define pr_fmt(fmt) "### dt-test ### " fmt
   6
   7 #include <linux/clk.h>
   8 #include <linux/err.h>
   9 #include <linux/errno.h>
  10 #include <linux/module.h>
  11 #include <linux/of.h>
  12 #include <linux/list.h>
  13 #include <linux/mutex.h>
  14 #include <linux/slab.h>
  15 #include <linux/device.h>
  16
  17 static bool selftest_passed = true;
  18 #define selftest(result, fmt, ...) { \
  19         if (!(result)) { \
  20                 pr_err("FAIL %s:%i " fmt, __FILE__, __LINE__, ##__VA_ARGS__); \
  21                 selftest_passed = false; \
  22         } else { \
  23                 pr_info("pass %s:%i\n", __FILE__, __LINE__); \
  24         } \
  25 }
  26
  27 static void __init of_selftest_parse_phandle_with_args(void)
  28 {
  29         struct device_node *np;
  30         struct of_phandle_args args;
  31         int i, rc;
  32
  33         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
  34         if (!np) {
  35                 pr_err("missing testcase data\n");
  36                 return;
  37         }
  38
  39         rc = of_count_phandle_with_args(np, "phandle-list", "#phandle-cells");
  40         selftest(rc == 7, "of_count_phandle_with_args() returned %i, expected 7\n", rc);
  41
  42         for (i = 0; i < 8; i++) {
  43                 bool passed = true;
  44                 rc = of_parse_phandle_with_args(np, "phandle-list",
  45                                                 "#phandle-cells", i, &args);
  46
  47                 /* Test the values from tests-phandle.dtsi */
  48                 switch (i) {
  49                 case 0:
  50                         passed &= !rc;
  51                         passed &= (args.args_count == 1);
  52                         passed &= (args.args[0] == (i + 1));
  53                         break;
  54                 case 1:
  55                         passed &= !rc;
  56                         passed &= (args.args_count == 2);
  57                         passed &= (args.args[0] == (i + 1));
  58                         passed &= (args.args[1] == 0);
  59                         break;
  60                 case 2:
  61                         passed &= (rc == -ENOENT);
  62                         break;
  63                 case 3:
  64                         passed &= !rc;
  65                         passed &= (args.args_count == 3);
  66                         passed &= (args.args[0] == (i + 1));
  67                         passed &= (args.args[1] == 4);
  68                         passed &= (args.args[2] == 3);
  69                         break;
  70                 case 4:
  71                         passed &= !rc;
  72                         passed &= (args.args_count == 2);
  73                         passed &= (args.args[0] == (i + 1));
  74                         passed &= (args.args[1] == 100);
  75                         break;
  76                 case 5:
  77                         passed &= !rc;
  78                         passed &= (args.args_count == 0);
  79                         break;
  80                 case 6:
  81                         passed &= !rc;
  82                         passed &= (args.args_count == 1);
  83                         passed &= (args.args[0] == (i + 1));
  84                         break;
  85                 case 7:
  86                         passed &= (rc == -ENOENT);
  87                         break;
  88                 default:
  89                         passed = false;
  90                 }
  91
  92                 selftest(passed, "index %i - data error on node %s rc=%i\n",
  93                          i, args.np->full_name, rc);
  94         }
  95
  96         /* Check for missing list property */
  97         rc = of_parse_phandle_with_args(np, "phandle-list-missing",
  98                                         "#phandle-cells", 0, &args);
  99         selftest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 100         rc = of_count_phandle_with_args(np, "phandle-list-missing",
 101                                         "#phandle-cells");
 102         selftest(rc == -ENOENT, "expected:%i got:%i\n", -ENOENT, rc);
 103
 104         /* Check for missing cells property */
 105         rc = of_parse_phandle_with_args(np, "phandle-list",
 106                                         "#phandle-cells-missing", 0, &args);
 107         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 108         rc = of_count_phandle_with_args(np, "phandle-list",
 109                                         "#phandle-cells-missing");
 110         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 111
 112         /* Check for bad phandle in list */
 113         rc = of_parse_phandle_with_args(np, "phandle-list-bad-phandle",
 114                                         "#phandle-cells", 0, &args);
 115         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 116         rc = of_count_phandle_with_args(np, "phandle-list-bad-phandle",
 117                                         "#phandle-cells");
 118         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 119
 120         /* Check for incorrectly formed argument list */
 121         rc = of_parse_phandle_with_args(np, "phandle-list-bad-args",
 122                                         "#phandle-cells", 1, &args);
 123         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 124         rc = of_count_phandle_with_args(np, "phandle-list-bad-args",
 125                                         "#phandle-cells");
 126         selftest(rc == -EINVAL, "expected:%i got:%i\n", -EINVAL, rc);
 127 }
 128
 129 static void __init of_selftest_property_string(void)
 130 {
 131         const char *strings[4];
 132         struct device_node *np;
 133         int rc;
 134
 135         pr_info("start\n");
 136         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 137         if (!np) {
 138                 pr_err("No testcase data in device tree\n");
 139                 return;
 140         }
 141
 142         rc = of_property_match_string(np, "phandle-list-names", "first");
 143         selftest(rc == 0, "first expected:0 got:%i\n", rc);
 144         rc = of_property_match_string(np, "phandle-list-names", "second");
 145         selftest(rc == 1, "second expected:0 got:%i\n", rc);
 146         rc = of_property_match_string(np, "phandle-list-names", "third");
 147         selftest(rc == 2, "third expected:0 got:%i\n", rc);
 148         rc = of_property_match_string(np, "phandle-list-names", "fourth");
 149         selftest(rc == -ENODATA, "unmatched string; rc=%i\n", rc);
 150         rc = of_property_match_string(np, "missing-property", "blah");
 151         selftest(rc == -EINVAL, "missing property; rc=%i\n", rc);
 152         rc = of_property_match_string(np, "empty-property", "blah");
 153         selftest(rc == -ENODATA, "empty property; rc=%i\n", rc);
 154         rc = of_property_match_string(np, "unterminated-string", "blah");
 155         selftest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 156
 157         /* of_property_count_strings() tests */
 158         rc = of_property_count_strings(np, "string-property");
 159         selftest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 160         rc = of_property_count_strings(np, "phandle-list-names");
 161         selftest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 162         rc = of_property_count_strings(np, "unterminated-string");
 163         selftest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 164         rc = of_property_count_strings(np, "unterminated-string-list");
 165         selftest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 166
 167         /* of_property_read_string_index() tests */
 168         rc = of_property_read_string_index(np, "string-property", 0, strings);
 169         selftest(rc == 0 && !strcmp(strings[0], "foobar"), "of_property_read_string_index() failure; rc=%i\n", rc);
 170         strings[0] = NULL;
 171         rc = of_property_read_string_index(np, "string-property", 1, strings);
 172         selftest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 173         rc = of_property_read_string_index(np, "phandle-list-names", 0, strings);
 174         selftest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 175         rc = of_property_read_string_index(np, "phandle-list-names", 1, strings);
 176         selftest(rc == 0 && !strcmp(strings[0], "second"), "of_property_read_string_index() failure; rc=%i\n", rc);
 177         rc = of_property_read_string_index(np, "phandle-list-names", 2, strings);
 178         selftest(rc == 0 && !strcmp(strings[0], "third"), "of_property_read_string_index() failure; rc=%i\n", rc);
 179         strings[0] = NULL;
 180         rc = of_property_read_string_index(np, "phandle-list-names", 3, strings);
 181         selftest(rc == -ENODATA && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 182         strings[0] = NULL;
 183         rc = of_property_read_string_index(np, "unterminated-string", 0, strings);
 184         selftest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 185         rc = of_property_read_string_index(np, "unterminated-string-list", 0, strings);
 186         selftest(rc == 0 && !strcmp(strings[0], "first"), "of_property_read_string_index() failure; rc=%i\n", rc);
 187         strings[0] = NULL;
 188         rc = of_property_read_string_index(np, "unterminated-string-list", 2, strings); /* should fail */
 189         selftest(rc == -EILSEQ && strings[0] == NULL, "of_property_read_string_index() failure; rc=%i\n", rc);
 190         strings[1] = NULL;
 191
 192         /* of_property_read_string_array() tests */
 193         rc = of_property_read_string_array(np, "string-property", strings, 4);
 194         selftest(rc == 1, "Incorrect string count; rc=%i\n", rc);
 195         rc = of_property_read_string_array(np, "phandle-list-names", strings, 4);
 196         selftest(rc == 3, "Incorrect string count; rc=%i\n", rc);
 197         rc = of_property_read_string_array(np, "unterminated-string", strings, 4);
 198         selftest(rc == -EILSEQ, "unterminated string; rc=%i\n", rc);
 199         /* -- An incorrectly formed string should cause a failure */
 200         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 4);
 201         selftest(rc == -EILSEQ, "unterminated string array; rc=%i\n", rc);
 202         /* -- parsing the correctly formed strings should still work: */
 203         strings[2] = NULL;
 204         rc = of_property_read_string_array(np, "unterminated-string-list", strings, 2);
 205         selftest(rc == 2 && strings[2] == NULL, "of_property_read_string_array() failure; rc=%i\n", rc);
 206         strings[1] = NULL;
 207         rc = of_property_read_string_array(np, "phandle-list-names", strings, 1);
 208         selftest(rc == 1 && strings[1] == NULL, "Overwrote end of string array; rc=%i, str='%s'\n", rc, strings[1]);
 209 }
 210
 211 static int __init of_selftest(void)
 212 {
 213         struct device_node *np;
 214
 215         np = of_find_node_by_path("/testcase-data/phandle-tests/consumer-a");
 216         if (!np) {
 217                 pr_info("No testcase data in device tree; not running tests\n");
 218                 return 0;
 219         }
 220         of_node_put(np);
 221
 222         pr_info("start of selftest - you will see error messages\n");
 223         of_selftest_parse_phandle_with_args();
 224         of_selftest_property_string();
 225         pr_info("end of selftest - %s\n", selftest_passed ? "PASS" : "FAIL");
 226         return 0;
 227 }
 228 late_initcall(of_selftest);