Merge tag 'ti-v2020.07-rc3' of https://gitlab.denx.de/u-boot/custodians/u-boot-ti
[platform/kernel/u-boot.git] / lib / fdtdec_test.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Some very basic tests for fdtdec, accessed through test_fdtdec command.
4  * They are easiest to use with sandbox.
5  *
6  * Copyright (c) 2011 The Chromium OS Authors.
7  */
8
9 #include <common.h>
10 #include <command.h>
11 #include <fdtdec.h>
12 #include <linux/libfdt.h>
13 #include <malloc.h>
14 #include <os.h>
15
16 /* The size of our test fdt blob */
17 #define FDT_SIZE        (16 * 1024)
18
19 #define CHECK(op) ({                                                    \
20                 int err = op;                                           \
21                 if (err < 0) {                                          \
22                         printf("%s: %s: %s\n", __func__, #op,           \
23                                fdt_strerror(err));                      \
24                         return err;                                     \
25                 }                                                       \
26                                                                         \
27                 err;                                                    \
28         })
29
30 #define CHECKVAL(op, expected) ({                                       \
31                 int err = op;                                           \
32                 if (err != expected) {                                  \
33                         printf("%s: %s: expected %d, but returned %d\n",\
34                                __func__, #op, expected, err);           \
35                         return err;                                     \
36                 }                                                       \
37                                                                         \
38                 err;                                                    \
39         })
40
41 #define CHECKOK(op)     CHECKVAL(op, 0)
42
43 /* maximum number of nodes / aliases to generate */
44 #define MAX_NODES       20
45
46 /*
47  * Make a test fdt
48  *
49  * @param fdt           Device tree pointer
50  * @param size          Size of device tree blob
51  * @param aliases       Specifies alias assignments. Format is a list of items
52  *                      separated by space. Items are #a where
53  *                              # is the alias number
54  *                              a is the node to point to
55  * @param nodes         Specifies nodes to generate (a=0, b=1), upper case
56  *                      means to create a disabled node
57  */
58 static int make_fdt(void *fdt, int size, const char *aliases,
59                     const char *nodes)
60 {
61         char name[20], value[20];
62         const char *s;
63 #if defined(DEBUG) && defined(CONFIG_SANDBOX)
64         int fd;
65 #endif
66
67         CHECK(fdt_create(fdt, size));
68         CHECK(fdt_finish_reservemap(fdt));
69         CHECK(fdt_begin_node(fdt, ""));
70
71         CHECK(fdt_begin_node(fdt, "aliases"));
72         for (s = aliases; *s;) {
73                 sprintf(name, "i2c%c", *s);
74                 sprintf(value, "/i2c%d@0", s[1] - 'a');
75                 CHECK(fdt_property_string(fdt, name, value));
76                 s += 2 + (s[2] != '\0');
77         }
78         CHECK(fdt_end_node(fdt));
79
80         for (s = nodes; *s; s++) {
81                 sprintf(value, "i2c%d@0", (*s & 0xdf) - 'A');
82                 CHECK(fdt_begin_node(fdt, value));
83                 CHECK(fdt_property_string(fdt, "compatible",
84                         fdtdec_get_compatible(COMPAT_UNKNOWN)));
85                 if (*s <= 'Z')
86                         CHECK(fdt_property_string(fdt, "status", "disabled"));
87                 CHECK(fdt_end_node(fdt));
88         }
89
90         CHECK(fdt_end_node(fdt));
91         CHECK(fdt_finish(fdt));
92         CHECK(fdt_pack(fdt));
93 #if defined(DEBUG) && defined(CONFIG_SANDBOX)
94         fd = os_open("/tmp/fdtdec-text.dtb", OS_O_CREAT | OS_O_WRONLY);
95         if (fd == -1) {
96                 printf("Could not open .dtb file to write\n");
97                 return -1;
98         }
99         os_write(fd, fdt, size);
100         os_close(fd);
101 #endif
102         return 0;
103 }
104
105 static int run_test(const char *aliases, const char *nodes, const char *expect)
106 {
107         int list[MAX_NODES];
108         const char *s;
109         void *blob;
110         int i;
111
112         blob = malloc(FDT_SIZE);
113         if (!blob) {
114                 printf("%s: out of memory\n", __func__);
115                 return 1;
116         }
117
118         printf("aliases=%s, nodes=%s, expect=%s: ", aliases, nodes, expect);
119         CHECKVAL(make_fdt(blob, FDT_SIZE, aliases, nodes), 0);
120         CHECKVAL(fdtdec_find_aliases_for_id(blob, "i2c",
121                         COMPAT_UNKNOWN,
122                         list, ARRAY_SIZE(list)), (int)strlen(expect));
123
124         /* Check we got the right ones */
125         for (i = 0, s = expect; *s; s++, i++) {
126                 int want = *s;
127                 const char *name;
128                 int got = ' ';
129
130                 name = list[i] ? fdt_get_name(blob, list[i], NULL) : NULL;
131                 if (name)
132                         got = name[3] + 'a' - '0';
133
134                 if (got != want) {
135                         printf("Position %d: Expected '%c', got '%c' ('%s')\n",
136                                i, want, got, name);
137                         return 1;
138                 }
139         }
140
141         printf("pass\n");
142         free(blob);
143         return 0;
144 }
145
146 static int make_fdt_carveout_device(void *fdt, uint32_t na, uint32_t ns)
147 {
148         const char *basename = "/display";
149         struct fdt_memory carveout = {
150 #ifdef CONFIG_PHYS_64BIT
151                 .start = 0x180000000,
152                 .end = 0x18fffffff,
153 #else
154                 .start = 0x80000000,
155                 .end = 0x8fffffff,
156 #endif
157         };
158         fdt32_t cells[4], *ptr = cells;
159         uint32_t upper, lower;
160         fdt_size_t size;
161         char name[32];
162         int offset;
163
164         /* store one or two address cells */
165         upper = upper_32_bits(carveout.start);
166         lower = lower_32_bits(carveout.start);
167
168         if (na > 1 && upper > 0)
169                 snprintf(name, sizeof(name), "%s@%x,%x", basename, upper,
170                          lower);
171         else
172                 snprintf(name, sizeof(name), "%s@%x", basename, lower);
173
174         if (na > 1)
175                 *ptr++ = cpu_to_fdt32(upper);
176
177         *ptr++ = cpu_to_fdt32(lower);
178
179         /* store one or two size cells */
180         size = carveout.end - carveout.start + 1;
181         upper = upper_32_bits(size);
182         lower = lower_32_bits(size);
183
184         if (ns > 1)
185                 *ptr++ = cpu_to_fdt32(upper);
186
187         *ptr++ = cpu_to_fdt32(lower);
188
189         offset = CHECK(fdt_add_subnode(fdt, 0, name + 1));
190         CHECK(fdt_setprop(fdt, offset, "reg", cells, (na + ns) * sizeof(*cells)));
191
192         return fdtdec_set_carveout(fdt, name, "memory-region", 0,
193                                    "framebuffer", &carveout);
194 }
195
196 static int check_fdt_carveout(void *fdt, uint32_t address_cells,
197                               uint32_t size_cells)
198 {
199 #ifdef CONFIG_PHYS_64BIT
200         const char *name = "/display@1,80000000";
201         const struct fdt_memory expected = {
202                 .start = 0x180000000,
203                 .end = 0x18fffffff,
204         };
205 #else
206         const char *name = "/display@80000000";
207         const struct fdt_memory expected = {
208                 .start = 0x80000000,
209                 .end = 0x8fffffff,
210         };
211 #endif
212         struct fdt_memory carveout;
213
214         printf("carveout: %pap-%pap na=%u ns=%u: ", &expected.start,
215                &expected.end, address_cells, size_cells);
216
217         CHECK(fdtdec_get_carveout(fdt, name, "memory-region", 0, &carveout));
218
219         if ((carveout.start != expected.start) ||
220             (carveout.end != expected.end)) {
221                 printf("carveout: %pap-%pap, expected %pap-%pap\n",
222                        &carveout.start, &carveout.end,
223                        &expected.start, &expected.end);
224                 return 1;
225         }
226
227         printf("pass\n");
228         return 0;
229 }
230
231 static int make_fdt_carveout(void *fdt, int size, uint32_t address_cells,
232                              uint32_t size_cells)
233 {
234         fdt32_t na = cpu_to_fdt32(address_cells);
235         fdt32_t ns = cpu_to_fdt32(size_cells);
236 #if defined(DEBUG) && defined(CONFIG_SANDBOX)
237         char filename[512];
238         int fd;
239 #endif
240         int err;
241
242         CHECK(fdt_create(fdt, size));
243         CHECK(fdt_finish_reservemap(fdt));
244         CHECK(fdt_begin_node(fdt, ""));
245         CHECK(fdt_property(fdt, "#address-cells", &na, sizeof(na)));
246         CHECK(fdt_property(fdt, "#size-cells", &ns, sizeof(ns)));
247         CHECK(fdt_end_node(fdt));
248         CHECK(fdt_finish(fdt));
249         CHECK(fdt_pack(fdt));
250
251         CHECK(fdt_open_into(fdt, fdt, FDT_SIZE));
252
253         err = make_fdt_carveout_device(fdt, address_cells, size_cells);
254
255 #if defined(DEBUG) && defined(CONFIG_SANDBOX)
256         snprintf(filename, sizeof(filename), "/tmp/fdtdec-carveout-%u-%u.dtb",
257                  address_cells, size_cells);
258
259         fd = os_open(filename, OS_O_CREAT | OS_O_WRONLY);
260         if (fd < 0) {
261                 printf("could not open .dtb file to write\n");
262                 goto out;
263         }
264
265         os_write(fd, fdt, size);
266         os_close(fd);
267
268 out:
269 #endif
270         return err;
271 }
272
273 static int check_carveout(void)
274 {
275         void *fdt;
276
277         fdt = malloc(FDT_SIZE);
278         if (!fdt) {
279                 printf("%s: out of memory\n", __func__);
280                 return 1;
281         }
282
283 #ifndef CONFIG_PHYS_64BIT
284         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 1, 1), 0);
285         CHECKOK(check_fdt_carveout(fdt, 1, 1));
286         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 1, 2), 0);
287         CHECKOK(check_fdt_carveout(fdt, 1, 2));
288 #else
289         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 1, 1), -FDT_ERR_BADVALUE);
290         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 1, 2), -FDT_ERR_BADVALUE);
291 #endif
292         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 2, 1), 0);
293         CHECKOK(check_fdt_carveout(fdt, 2, 1));
294         CHECKVAL(make_fdt_carveout(fdt, FDT_SIZE, 2, 2), 0);
295         CHECKOK(check_fdt_carveout(fdt, 2, 2));
296
297         free(fdt);
298         return 0;
299 }
300
301 static int do_test_fdtdec(struct cmd_tbl *cmdtp, int flag, int argc,
302                           char *const argv[])
303 {
304         /* basic tests */
305         CHECKOK(run_test("", "", ""));
306         CHECKOK(run_test("1e 3d", "", ""));
307
308         /*
309          * 'a' represents 0, 'b' represents 1, etc.
310          * The first character is the alias number, the second is the node
311          * number. So the params mean:
312          * 0a 1b        : point alias 0 to node 0 (a), alias 1 to node 1(b)
313          * ab           : to create nodes 0 and 1 (a and b)
314          * ab           : we expect the function to return two nodes, in
315          *                the order 0, 1
316          */
317         CHECKOK(run_test("0a 1b", "ab", "ab"));
318
319         CHECKOK(run_test("0a 1c", "ab", "ab"));
320         CHECKOK(run_test("1c", "ab", "ab"));
321         CHECKOK(run_test("1b", "ab", "ab"));
322         CHECKOK(run_test("0b", "ab", "ba"));
323         CHECKOK(run_test("0b 2d", "dbc", "bcd"));
324         CHECKOK(run_test("0d 3a 1c 2b", "dbac", "dcba"));
325
326         /* things with holes */
327         CHECKOK(run_test("1b 3d", "dbc", "cb d"));
328         CHECKOK(run_test("1e 3d", "dbc", "bc d"));
329
330         /* no aliases */
331         CHECKOK(run_test("", "dbac", "dbac"));
332
333         /* disabled nodes */
334         CHECKOK(run_test("0d 3a 1c 2b", "dBac", "dc a"));
335         CHECKOK(run_test("0b 2d", "DBc", "c"));
336         CHECKOK(run_test("0b 4d 2c", "DBc", "  c"));
337
338         /* conflicting aliases - first one gets it */
339         CHECKOK(run_test("2a 1a 0a", "a", "  a"));
340         CHECKOK(run_test("0a 1a 2a", "a", "a"));
341
342         CHECKOK(check_carveout());
343
344         printf("Test passed\n");
345         return 0;
346 }
347
348 U_BOOT_CMD(
349         test_fdtdec, 3, 1, do_test_fdtdec,
350         "test_fdtdec",
351         "Run tests for fdtdec library");