1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Some very basic tests for fdtdec, accessed through test_fdtdec command.
3*4882a593Smuzhiyun * They are easiest to use with sandbox.
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (c) 2011 The Chromium OS Authors.
6*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
7*4882a593Smuzhiyun */
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <common.h>
10*4882a593Smuzhiyun #include <fdtdec.h>
11*4882a593Smuzhiyun #include <linux/libfdt.h>
12*4882a593Smuzhiyun #include <malloc.h>
13*4882a593Smuzhiyun #include <os.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun /* The size of our test fdt blob */
16*4882a593Smuzhiyun #define FDT_SIZE (16 * 1024)
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun /**
19*4882a593Smuzhiyun * Check if an operation failed, and if so, print an error
20*4882a593Smuzhiyun *
21*4882a593Smuzhiyun * @param oper_name Name of operation
22*4882a593Smuzhiyun * @param err Error code to check
23*4882a593Smuzhiyun *
24*4882a593Smuzhiyun * @return 0 if ok, -1 if there was an error
25*4882a593Smuzhiyun */
fdt_checkerr(const char * oper_name,int err)26*4882a593Smuzhiyun static int fdt_checkerr(const char *oper_name, int err)
27*4882a593Smuzhiyun {
28*4882a593Smuzhiyun if (err) {
29*4882a593Smuzhiyun printf("%s: %s: %s\n", __func__, oper_name, fdt_strerror(err));
30*4882a593Smuzhiyun return -1;
31*4882a593Smuzhiyun }
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun return 0;
34*4882a593Smuzhiyun }
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun /**
37*4882a593Smuzhiyun * Check the result of an operation and if incorrect, print an error
38*4882a593Smuzhiyun *
39*4882a593Smuzhiyun * @param oper_name Name of operation
40*4882a593Smuzhiyun * @param expected Expected value
41*4882a593Smuzhiyun * @param value Actual value
42*4882a593Smuzhiyun *
43*4882a593Smuzhiyun * @return 0 if ok, -1 if there was an error
44*4882a593Smuzhiyun */
checkval(const char * oper_name,int expected,int value)45*4882a593Smuzhiyun static int checkval(const char *oper_name, int expected, int value)
46*4882a593Smuzhiyun {
47*4882a593Smuzhiyun if (expected != value) {
48*4882a593Smuzhiyun printf("%s: %s: expected %d, but returned %d\n", __func__,
49*4882a593Smuzhiyun oper_name, expected, value);
50*4882a593Smuzhiyun return -1;
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun return 0;
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun #define CHECK(op) if (fdt_checkerr(#op, op)) return -1
57*4882a593Smuzhiyun #define CHECKVAL(op, expected) \
58*4882a593Smuzhiyun if (checkval(#op, expected, op)) \
59*4882a593Smuzhiyun return -1
60*4882a593Smuzhiyun #define CHECKOK(op) CHECKVAL(op, 0)
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun /* maximum number of nodes / aliases to generate */
63*4882a593Smuzhiyun #define MAX_NODES 20
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun /*
66*4882a593Smuzhiyun * Make a test fdt
67*4882a593Smuzhiyun *
68*4882a593Smuzhiyun * @param fdt Device tree pointer
69*4882a593Smuzhiyun * @param size Size of device tree blob
70*4882a593Smuzhiyun * @param aliases Specifies alias assignments. Format is a list of items
71*4882a593Smuzhiyun * separated by space. Items are #a where
72*4882a593Smuzhiyun * # is the alias number
73*4882a593Smuzhiyun * a is the node to point to
74*4882a593Smuzhiyun * @param nodes Specifies nodes to generate (a=0, b=1), upper case
75*4882a593Smuzhiyun * means to create a disabled node
76*4882a593Smuzhiyun */
make_fdt(void * fdt,int size,const char * aliases,const char * nodes)77*4882a593Smuzhiyun static int make_fdt(void *fdt, int size, const char *aliases,
78*4882a593Smuzhiyun const char *nodes)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun char name[20], value[20];
81*4882a593Smuzhiyun const char *s;
82*4882a593Smuzhiyun int fd;
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun CHECK(fdt_create(fdt, size));
85*4882a593Smuzhiyun CHECK(fdt_finish_reservemap(fdt));
86*4882a593Smuzhiyun CHECK(fdt_begin_node(fdt, ""));
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun CHECK(fdt_begin_node(fdt, "aliases"));
89*4882a593Smuzhiyun for (s = aliases; *s;) {
90*4882a593Smuzhiyun sprintf(name, "i2c%c", *s);
91*4882a593Smuzhiyun sprintf(value, "/i2c%d@0", s[1] - 'a');
92*4882a593Smuzhiyun CHECK(fdt_property_string(fdt, name, value));
93*4882a593Smuzhiyun s += 2 + (s[2] != '\0');
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun CHECK(fdt_end_node(fdt));
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun for (s = nodes; *s; s++) {
98*4882a593Smuzhiyun sprintf(value, "i2c%d@0", (*s & 0xdf) - 'A');
99*4882a593Smuzhiyun CHECK(fdt_begin_node(fdt, value));
100*4882a593Smuzhiyun CHECK(fdt_property_string(fdt, "compatible",
101*4882a593Smuzhiyun fdtdec_get_compatible(COMPAT_UNKNOWN)));
102*4882a593Smuzhiyun if (*s <= 'Z')
103*4882a593Smuzhiyun CHECK(fdt_property_string(fdt, "status", "disabled"));
104*4882a593Smuzhiyun CHECK(fdt_end_node(fdt));
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun CHECK(fdt_end_node(fdt));
108*4882a593Smuzhiyun CHECK(fdt_finish(fdt));
109*4882a593Smuzhiyun CHECK(fdt_pack(fdt));
110*4882a593Smuzhiyun #if defined(DEBUG) && defined(CONFIG_SANDBOX)
111*4882a593Smuzhiyun fd = os_open("/tmp/fdtdec-text.dtb", OS_O_CREAT | OS_O_WRONLY);
112*4882a593Smuzhiyun if (fd == -1) {
113*4882a593Smuzhiyun printf("Could not open .dtb file to write\n");
114*4882a593Smuzhiyun return -1;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun os_write(fd, fdt, size);
117*4882a593Smuzhiyun os_close(fd);
118*4882a593Smuzhiyun #endif
119*4882a593Smuzhiyun return 0;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun
run_test(const char * aliases,const char * nodes,const char * expect)122*4882a593Smuzhiyun static int run_test(const char *aliases, const char *nodes, const char *expect)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun int list[MAX_NODES];
125*4882a593Smuzhiyun const char *s;
126*4882a593Smuzhiyun void *blob;
127*4882a593Smuzhiyun int i;
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun blob = malloc(FDT_SIZE);
130*4882a593Smuzhiyun if (!blob) {
131*4882a593Smuzhiyun printf("%s: out of memory\n", __func__);
132*4882a593Smuzhiyun return 1;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun printf("aliases=%s, nodes=%s, expect=%s: ", aliases, nodes, expect);
136*4882a593Smuzhiyun CHECKVAL(make_fdt(blob, FDT_SIZE, aliases, nodes), 0);
137*4882a593Smuzhiyun CHECKVAL(fdtdec_find_aliases_for_id(blob, "i2c",
138*4882a593Smuzhiyun COMPAT_UNKNOWN,
139*4882a593Smuzhiyun list, ARRAY_SIZE(list)), strlen(expect));
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun /* Check we got the right ones */
142*4882a593Smuzhiyun for (i = 0, s = expect; *s; s++, i++) {
143*4882a593Smuzhiyun int want = *s;
144*4882a593Smuzhiyun const char *name;
145*4882a593Smuzhiyun int got = ' ';
146*4882a593Smuzhiyun
147*4882a593Smuzhiyun name = list[i] ? fdt_get_name(blob, list[i], NULL) : NULL;
148*4882a593Smuzhiyun if (name)
149*4882a593Smuzhiyun got = name[3] + 'a' - '0';
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun if (got != want) {
152*4882a593Smuzhiyun printf("Position %d: Expected '%c', got '%c' ('%s')\n",
153*4882a593Smuzhiyun i, want, got, name);
154*4882a593Smuzhiyun return 1;
155*4882a593Smuzhiyun }
156*4882a593Smuzhiyun }
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun printf("pass\n");
159*4882a593Smuzhiyun return 0;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
do_test_fdtdec(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])162*4882a593Smuzhiyun static int do_test_fdtdec(cmd_tbl_t *cmdtp, int flag, int argc,
163*4882a593Smuzhiyun char * const argv[])
164*4882a593Smuzhiyun {
165*4882a593Smuzhiyun /* basic tests */
166*4882a593Smuzhiyun CHECKOK(run_test("", "", ""));
167*4882a593Smuzhiyun CHECKOK(run_test("1e 3d", "", ""));
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun /*
170*4882a593Smuzhiyun * 'a' represents 0, 'b' represents 1, etc.
171*4882a593Smuzhiyun * The first character is the alias number, the second is the node
172*4882a593Smuzhiyun * number. So the params mean:
173*4882a593Smuzhiyun * 0a 1b : point alias 0 to node 0 (a), alias 1 to node 1(b)
174*4882a593Smuzhiyun * ab : to create nodes 0 and 1 (a and b)
175*4882a593Smuzhiyun * ab : we expect the function to return two nodes, in
176*4882a593Smuzhiyun * the order 0, 1
177*4882a593Smuzhiyun */
178*4882a593Smuzhiyun CHECKOK(run_test("0a 1b", "ab", "ab"));
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun CHECKOK(run_test("0a 1c", "ab", "ab"));
181*4882a593Smuzhiyun CHECKOK(run_test("1c", "ab", "ab"));
182*4882a593Smuzhiyun CHECKOK(run_test("1b", "ab", "ab"));
183*4882a593Smuzhiyun CHECKOK(run_test("0b", "ab", "ba"));
184*4882a593Smuzhiyun CHECKOK(run_test("0b 2d", "dbc", "bcd"));
185*4882a593Smuzhiyun CHECKOK(run_test("0d 3a 1c 2b", "dbac", "dcba"));
186*4882a593Smuzhiyun
187*4882a593Smuzhiyun /* things with holes */
188*4882a593Smuzhiyun CHECKOK(run_test("1b 3d", "dbc", "cb d"));
189*4882a593Smuzhiyun CHECKOK(run_test("1e 3d", "dbc", "bc d"));
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun /* no aliases */
192*4882a593Smuzhiyun CHECKOK(run_test("", "dbac", "dbac"));
193*4882a593Smuzhiyun
194*4882a593Smuzhiyun /* disabled nodes */
195*4882a593Smuzhiyun CHECKOK(run_test("0d 3a 1c 2b", "dBac", "dc a"));
196*4882a593Smuzhiyun CHECKOK(run_test("0b 2d", "DBc", "c"));
197*4882a593Smuzhiyun CHECKOK(run_test("0b 4d 2c", "DBc", " c"));
198*4882a593Smuzhiyun
199*4882a593Smuzhiyun /* conflicting aliases - first one gets it */
200*4882a593Smuzhiyun CHECKOK(run_test("2a 1a 0a", "a", " a"));
201*4882a593Smuzhiyun CHECKOK(run_test("0a 1a 2a", "a", "a"));
202*4882a593Smuzhiyun
203*4882a593Smuzhiyun printf("Test passed\n");
204*4882a593Smuzhiyun return 0;
205*4882a593Smuzhiyun }
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun U_BOOT_CMD(
208*4882a593Smuzhiyun test_fdtdec, 3, 1, do_test_fdtdec,
209*4882a593Smuzhiyun "test_fdtdec",
210*4882a593Smuzhiyun "Run tests for fdtdec library");
211