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