xref: /openbmc/qemu/tests/qtest/boot-serial-test.c (revision 6016b7b4)
1 /*
2  * Test serial output of some machines.
3  *
4  * Copyright 2016 Thomas Huth, Red Hat Inc.
5  *
6  * This work is licensed under the terms of the GNU GPL, version 2
7  * or later. See the COPYING file in the top-level directory.
8  *
9  * This test is used to check that the serial output of the firmware
10  * (that we provide for some machines) or some small mini-kernels that
11  * we provide here contains an expected string. Thus we check that the
12  * firmware/kernel still boots at least to a certain point and so we
13  * know that the machine is not completely broken.
14  */
15 
16 #include "qemu/osdep.h"
17 #include "libqos/libqtest.h"
18 #include "libqos/libqos-spapr.h"
19 
20 static const uint8_t bios_avr[] = {
21     0x88, 0xe0,             /* ldi r24, 0x08   */
22     0x80, 0x93, 0xc1, 0x00, /* sts 0x00C1, r24 ; Enable tx */
23     0x86, 0xe0,             /* ldi r24, 0x06   */
24     0x80, 0x93, 0xc2, 0x00, /* sts 0x00C2, r24 ; Set the data bits to 8 */
25     0x84, 0xe5,             /* ldi r24, 0x54   */
26     0x80, 0x93, 0xc6, 0x00, /* sts 0x00C6, r24 ; Output 'T' */
27 };
28 
29 static const uint8_t kernel_mcf5208[] = {
30     0x41, 0xf9, 0xfc, 0x06, 0x00, 0x00,     /* lea 0xfc060000,%a0 */
31     0x10, 0x3c, 0x00, 0x54,                 /* move.b #'T',%d0 */
32     0x11, 0x7c, 0x00, 0x04, 0x00, 0x08,     /* move.b #4,8(%a0)     Enable TX */
33     0x11, 0x40, 0x00, 0x0c,                 /* move.b %d0,12(%a0)   Print 'T' */
34     0x60, 0xfa                              /* bra.s  loop */
35 };
36 
37 static const uint8_t bios_nextcube[] = {
38     0x06, 0x00, 0x00, 0x00,                 /* Initial SP */
39     0x01, 0x00, 0x00, 0x08,                 /* Initial PC */
40     0x41, 0xf9, 0x02, 0x11, 0x80, 0x00,     /* lea 0x02118000,%a0 */
41     0x10, 0x3c, 0x00, 0x54,                 /* move.b #'T',%d0 */
42     0x11, 0x7c, 0x00, 0x05, 0x00, 0x01,     /* move.b #5,1(%a0)    Sel TXCTRL */
43     0x11, 0x7c, 0x00, 0x68, 0x00, 0x01,     /* move.b #0x68,1(%a0) Enable TX */
44     0x11, 0x40, 0x00, 0x03,                 /* move.b %d0,3(%a0)   Print 'T' */
45     0x60, 0xfa                              /* bra.s  loop */
46 };
47 
48 static const uint8_t kernel_pls3adsp1800[] = {
49     0xb0, 0x00, 0x84, 0x00,                 /* imm   0x8400 */
50     0x30, 0x60, 0x00, 0x04,                 /* addik r3,r0,4 */
51     0x30, 0x80, 0x00, 0x54,                 /* addik r4,r0,'T' */
52     0xf0, 0x83, 0x00, 0x00,                 /* sbi   r4,r3,0 */
53     0xb8, 0x00, 0xff, 0xfc                  /* bri   -4  loop */
54 };
55 
56 static const uint8_t kernel_plml605[] = {
57     0xe0, 0x83, 0x00, 0xb0,                 /* imm   0x83e0 */
58     0x00, 0x10, 0x60, 0x30,                 /* addik r3,r0,0x1000 */
59     0x54, 0x00, 0x80, 0x30,                 /* addik r4,r0,'T' */
60     0x00, 0x00, 0x83, 0xf0,                 /* sbi   r4,r3,0 */
61     0xfc, 0xff, 0x00, 0xb8                  /* bri   -4  loop */
62 };
63 
64 static const uint8_t bios_raspi2[] = {
65     0x08, 0x30, 0x9f, 0xe5,                 /* ldr   r3,[pc,#8]    Get base */
66     0x54, 0x20, 0xa0, 0xe3,                 /* mov     r2,#'T' */
67     0x00, 0x20, 0xc3, 0xe5,                 /* strb    r2,[r3] */
68     0xfb, 0xff, 0xff, 0xea,                 /* b       loop */
69     0x00, 0x10, 0x20, 0x3f,                 /* 0x3f201000 = UART0 base addr */
70 };
71 
72 static const uint8_t kernel_aarch64[] = {
73     0x81, 0x0a, 0x80, 0x52,                 /* mov     w1, #0x54 */
74     0x02, 0x20, 0xa1, 0xd2,                 /* mov     x2, #0x9000000 */
75     0x41, 0x00, 0x00, 0x39,                 /* strb    w1, [x2] */
76     0xfd, 0xff, 0xff, 0x17,                 /* b       -12 (loop) */
77 };
78 
79 static const uint8_t kernel_nrf51[] = {
80     0x00, 0x00, 0x00, 0x00,                 /* Stack top address */
81     0x09, 0x00, 0x00, 0x00,                 /* Reset handler address */
82     0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get ENABLE */
83     0x04, 0x21,                             /* movs r1, #4 */
84     0x11, 0x60,                             /* str  r1, [r2] */
85     0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get STARTTX */
86     0x01, 0x21,                             /* movs r1, #1 */
87     0x11, 0x60,                             /* str  r1, [r2] */
88     0x03, 0x4a,                             /* ldr  r2, [pc, #12] Get TXD */
89     0x54, 0x21,                             /* movs r1, 'T' */
90     0x11, 0x60,                             /* str  r1, [r2] */
91     0xfe, 0xe7,                             /* b    . */
92     0x00, 0x25, 0x00, 0x40,                 /* 0x40002500 = UART ENABLE */
93     0x08, 0x20, 0x00, 0x40,                 /* 0x40002008 = UART STARTTX */
94     0x1c, 0x25, 0x00, 0x40                  /* 0x4000251c = UART TXD */
95 };
96 
97 static const uint8_t kernel_stm32vldiscovery[] = {
98     0x00, 0x00, 0x00, 0x00,                 /* Stack top address */
99     0x1d, 0x00, 0x00, 0x00,                 /* Reset handler address */
100     0x00, 0x00, 0x00, 0x00,                 /* NMI */
101     0x00, 0x00, 0x00, 0x00,                 /* Hard fault */
102     0x00, 0x00, 0x00, 0x00,                 /* Memory management fault */
103     0x00, 0x00, 0x00, 0x00,                 /* Bus fault */
104     0x00, 0x00, 0x00, 0x00,                 /* Usage fault */
105     0x0b, 0x4b,                             /* ldr  r3, [pc, #44] Get RCC */
106     0x44, 0xf2, 0x04, 0x02,                 /* movw r2, #16388 */
107     0x1a, 0x60,                             /* str  r2, [r3] */
108     0x0a, 0x4b,                             /* ldr  r3, [pc, #40] Get GPIOA */
109     0x1a, 0x68,                             /* ldr  r2, [r3] */
110     0x22, 0xf0, 0xf0, 0x02,                 /* bic  r2, r2, #240 */
111     0x1a, 0x60,                             /* str  r2, [r3] */
112     0x1a, 0x68,                             /* ldr  r2, [r3] */
113     0x42, 0xf0, 0xb0, 0x02,                 /* orr  r2, r2, #176 */
114     0x1a, 0x60,                             /* str  r2, [r3] */
115     0x07, 0x4b,                             /* ldr  r3, [pc, #26] Get BAUD */
116     0x45, 0x22,                             /* movs r2, #69 */
117     0x1a, 0x60,                             /* str  r2, [r3] */
118     0x06, 0x4b,                             /* ldr  r3, [pc, #24] Get ENABLE */
119     0x42, 0xf2, 0x08, 0x02,                 /* movw r2, #8200 */
120     0x1a, 0x60,                             /* str  r2, [r3] */
121     0x05, 0x4b,                             /* ldr  r3, [pc, #20] Get TXD */
122     0x54, 0x22,                             /* movs r2, 'T' */
123     0x1a, 0x60,                             /* str  r2, [r3] */
124     0xfe, 0xe7,                             /* b    . */
125     0x18, 0x10, 0x02, 0x40,                 /* 0x40021018 = RCC */
126     0x04, 0x08, 0x01, 0x40,                 /* 0x40010804 = GPIOA */
127     0x08, 0x38, 0x01, 0x40,                 /* 0x40013808 = USART1 BAUD */
128     0x0c, 0x38, 0x01, 0x40,                 /* 0x4001380c = USART1 ENABLE */
129     0x04, 0x38, 0x01, 0x40                  /* 0x40013804 = USART1 TXD */
130 };
131 
132 typedef struct testdef {
133     const char *arch;       /* Target architecture */
134     const char *machine;    /* Name of the machine */
135     const char *extra;      /* Additional parameters */
136     const char *expect;     /* Expected string in the serial output */
137     size_t codesize;        /* Size of the kernel or bios data */
138     const uint8_t *kernel;  /* Set in case we use our own mini kernel */
139     const uint8_t *bios;    /* Set in case we use our own mini bios */
140 } testdef_t;
141 
142 static testdef_t tests[] = {
143     { "alpha", "clipper", "", "PCI:" },
144     { "avr", "arduino-duemilanove", "", "T", sizeof(bios_avr), NULL, bios_avr },
145     { "avr", "arduino-mega-2560-v3", "", "T", sizeof(bios_avr), NULL, bios_avr},
146     { "ppc", "ppce500", "", "U-Boot" },
147     { "ppc", "40p", "-vga none -boot d", "Trying cd:," },
148     { "ppc", "g3beige", "", "PowerPC,750" },
149     { "ppc", "mac99", "", "PowerPC,G4" },
150     { "ppc", "sam460ex", "-m 256", "DRAM:  256 MiB" },
151     { "ppc64", "ppce500", "", "U-Boot" },
152     { "ppc64", "40p", "-m 192", "Memory: 192M" },
153     { "ppc64", "mac99", "", "PowerPC,970FX" },
154     { "ppc64", "pseries",
155       "-machine " PSERIES_DEFAULT_CAPABILITIES,
156       "Open Firmware" },
157     { "ppc64", "powernv8", "", "OPAL" },
158     { "ppc64", "powernv9", "", "OPAL" },
159     { "ppc64", "sam460ex", "-device e1000", "8086  100e" },
160     { "i386", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
161     { "i386", "pc", "-device sga", "SGABIOS" },
162     { "i386", "q35", "-device sga", "SGABIOS" },
163     { "x86_64", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
164     { "x86_64", "q35", "-device sga", "SGABIOS" },
165     { "sparc", "LX", "", "TMS390S10" },
166     { "sparc", "SS-4", "", "MB86904" },
167     { "sparc", "SS-600MP", "", "TMS390Z55" },
168     { "sparc64", "sun4u", "", "UltraSPARC" },
169     { "s390x", "s390-ccw-virtio", "", "device" },
170     { "m68k", "mcf5208evb", "", "TT", sizeof(kernel_mcf5208), kernel_mcf5208 },
171     { "m68k", "next-cube", "", "TT", sizeof(bios_nextcube), 0, bios_nextcube },
172     { "microblaze", "petalogix-s3adsp1800", "", "TT",
173       sizeof(kernel_pls3adsp1800), kernel_pls3adsp1800 },
174     { "microblazeel", "petalogix-ml605", "", "TT",
175       sizeof(kernel_plml605), kernel_plml605 },
176     { "arm", "raspi2b", "", "TT", sizeof(bios_raspi2), 0, bios_raspi2 },
177     /* For hppa, force bios to output to serial by disabling graphics. */
178     { "hppa", "hppa", "-vga none", "SeaBIOS wants SYSTEM HALT" },
179     { "aarch64", "virt", "-cpu max", "TT", sizeof(kernel_aarch64),
180       kernel_aarch64 },
181     { "arm", "microbit", "", "T", sizeof(kernel_nrf51), kernel_nrf51 },
182     { "arm", "stm32vldiscovery", "", "T",
183       sizeof(kernel_stm32vldiscovery), kernel_stm32vldiscovery },
184 
185     { NULL }
186 };
187 
188 static bool check_guest_output(QTestState *qts, const testdef_t *test, int fd)
189 {
190     int nbr = 0, pos = 0, ccnt;
191     time_t now, start = time(NULL);
192     char ch;
193 
194     /* Poll serial output... */
195     while (1) {
196         ccnt = 0;
197         while (ccnt++ < 512 && (nbr = read(fd, &ch, 1)) == 1) {
198             if (ch == test->expect[pos]) {
199                 pos += 1;
200                 if (test->expect[pos] == '\0') {
201                     /* We've reached the end of the expected string! */
202                     return true;
203                 }
204             } else {
205                 pos = 0;
206             }
207         }
208         g_assert(nbr >= 0);
209         /* Wait only if the child is still alive.  */
210         if (!qtest_probe_child(qts)) {
211             break;
212         }
213         /* Wait at most 360 seconds.  */
214         now = time(NULL);
215         if (now - start >= 360) {
216             break;
217         }
218         g_usleep(10000);
219     }
220 
221     return false;
222 }
223 
224 static void test_machine(const void *data)
225 {
226     const testdef_t *test = data;
227     char serialtmp[] = "/tmp/qtest-boot-serial-sXXXXXX";
228     char codetmp[] = "/tmp/qtest-boot-serial-cXXXXXX";
229     const char *codeparam = "";
230     const uint8_t *code = NULL;
231     QTestState *qts;
232     int ser_fd;
233 
234     ser_fd = mkstemp(serialtmp);
235     g_assert(ser_fd != -1);
236 
237     if (test->kernel) {
238         code = test->kernel;
239         codeparam = "-kernel";
240     } else if (test->bios) {
241         code = test->bios;
242         codeparam = "-bios";
243     }
244 
245     if (code) {
246         ssize_t wlen;
247         int code_fd;
248 
249         code_fd = mkstemp(codetmp);
250         g_assert(code_fd != -1);
251         wlen = write(code_fd, code, test->codesize);
252         g_assert(wlen == test->codesize);
253         close(code_fd);
254     }
255 
256     /*
257      * Make sure that this test uses tcg if available: It is used as a
258      * fast-enough smoketest for that.
259      */
260     qts = qtest_initf("%s %s -M %s -no-shutdown "
261                       "-chardev file,id=serial0,path=%s "
262                       "-serial chardev:serial0 -accel tcg -accel kvm %s",
263                       codeparam, code ? codetmp : "", test->machine,
264                       serialtmp, test->extra);
265     if (code) {
266         unlink(codetmp);
267     }
268 
269     if (!check_guest_output(qts, test, ser_fd)) {
270         g_error("Failed to find expected string. Please check '%s'",
271                 serialtmp);
272     }
273     unlink(serialtmp);
274 
275     qtest_quit(qts);
276 
277     close(ser_fd);
278 }
279 
280 int main(int argc, char *argv[])
281 {
282     const char *arch = qtest_get_arch();
283     int i;
284 
285     g_test_init(&argc, &argv, NULL);
286 
287     for (i = 0; tests[i].arch != NULL; i++) {
288         if (g_str_equal(arch, tests[i].arch) &&
289             qtest_has_machine(tests[i].machine)) {
290             char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
291             qtest_add_data_func(name, &tests[i], test_machine);
292             g_free(name);
293         }
294     }
295 
296     return g_test_run();
297 }
298