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