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
19 static const uint8_t kernel_mcf5208[] = {
20 0x41, 0xf9, 0xfc, 0x06, 0x00, 0x00, /* lea 0xfc060000,%a0 */
21 0x10, 0x3c, 0x00, 0x54, /* move.b #'T',%d0 */
22 0x11, 0x7c, 0x00, 0x04, 0x00, 0x08, /* move.b #4,8(%a0) Enable TX */
23 0x11, 0x40, 0x00, 0x0c, /* move.b %d0,12(%a0) Print 'T' */
24 0x60, 0xfa /* bra.s loop */
25 };
26
27 static const uint8_t bios_nextcube[] = {
28 0x06, 0x00, 0x00, 0x00, /* Initial SP */
29 0x01, 0x00, 0x00, 0x08, /* Initial PC */
30 0x41, 0xf9, 0x02, 0x11, 0x80, 0x00, /* lea 0x02118000,%a0 */
31 0x10, 0x3c, 0x00, 0x54, /* move.b #'T',%d0 */
32 0x11, 0x7c, 0x00, 0x05, 0x00, 0x01, /* move.b #5,1(%a0) Sel TXCTRL */
33 0x11, 0x7c, 0x00, 0x68, 0x00, 0x01, /* move.b #0x68,1(%a0) Enable TX */
34 0x11, 0x40, 0x00, 0x03, /* move.b %d0,3(%a0) Print 'T' */
35 0x60, 0xfa /* bra.s loop */
36 };
37
38 static const uint8_t kernel_pls3adsp1800[] = {
39 0xb0, 0x00, 0x84, 0x00, /* imm 0x8400 */
40 0x30, 0x60, 0x00, 0x04, /* addik r3,r0,4 */
41 0x30, 0x80, 0x00, 0x54, /* addik r4,r0,'T' */
42 0xf0, 0x83, 0x00, 0x00, /* sbi r4,r3,0 */
43 0xb8, 0x00, 0xff, 0xfc /* bri -4 loop */
44 };
45
46 static const uint8_t kernel_plml605[] = {
47 0xe0, 0x83, 0x00, 0xb0, /* imm 0x83e0 */
48 0x00, 0x10, 0x60, 0x30, /* addik r3,r0,0x1000 */
49 0x54, 0x00, 0x80, 0x30, /* addik r4,r0,'T' */
50 0x00, 0x00, 0x83, 0xf0, /* sbi r4,r3,0 */
51 0xfc, 0xff, 0x00, 0xb8 /* bri -4 loop */
52 };
53
54 static const uint8_t bios_moxiesim[] = {
55 0x20, 0x10, 0x00, 0x00, 0x03, 0xf8, /* ldi.s r1,0x3f8 */
56 0x1b, 0x20, 0x00, 0x00, 0x00, 0x54, /* ldi.b r2,'T' */
57 0x1e, 0x12, /* st.b r1,r2 */
58 0x1a, 0x00, 0x00, 0x00, 0x10, 0x00 /* jmpa 0x1000 */
59 };
60
61 static const uint8_t bios_raspi2[] = {
62 0x08, 0x30, 0x9f, 0xe5, /* ldr r3,[pc,#8] Get base */
63 0x54, 0x20, 0xa0, 0xe3, /* mov r2,#'T' */
64 0x00, 0x20, 0xc3, 0xe5, /* strb r2,[r3] */
65 0xfb, 0xff, 0xff, 0xea, /* b loop */
66 0x00, 0x10, 0x20, 0x3f, /* 0x3f201000 = UART0 base addr */
67 };
68
69 static const uint8_t kernel_aarch64[] = {
70 0x81, 0x0a, 0x80, 0x52, /* mov w1, #0x54 */
71 0x02, 0x20, 0xa1, 0xd2, /* mov x2, #0x9000000 */
72 0x41, 0x00, 0x00, 0x39, /* strb w1, [x2] */
73 0xfd, 0xff, 0xff, 0x17, /* b -12 (loop) */
74 };
75
76 static const uint8_t kernel_nrf51[] = {
77 0x00, 0x00, 0x00, 0x00, /* Stack top address */
78 0x09, 0x00, 0x00, 0x00, /* Reset handler address */
79 0x04, 0x4a, /* ldr r2, [pc, #16] Get ENABLE */
80 0x04, 0x21, /* movs r1, #4 */
81 0x11, 0x60, /* str r1, [r2] */
82 0x04, 0x4a, /* ldr r2, [pc, #16] Get STARTTX */
83 0x01, 0x21, /* movs r1, #1 */
84 0x11, 0x60, /* str r1, [r2] */
85 0x03, 0x4a, /* ldr r2, [pc, #12] Get TXD */
86 0x54, 0x21, /* movs r1, 'T' */
87 0x11, 0x60, /* str r1, [r2] */
88 0xfe, 0xe7, /* b . */
89 0x00, 0x25, 0x00, 0x40, /* 0x40002500 = UART ENABLE */
90 0x08, 0x20, 0x00, 0x40, /* 0x40002008 = UART STARTTX */
91 0x1c, 0x25, 0x00, 0x40 /* 0x4000251c = UART TXD */
92 };
93
94 typedef struct testdef {
95 const char *arch; /* Target architecture */
96 const char *machine; /* Name of the machine */
97 const char *extra; /* Additional parameters */
98 const char *expect; /* Expected string in the serial output */
99 size_t codesize; /* Size of the kernel or bios data */
100 const uint8_t *kernel; /* Set in case we use our own mini kernel */
101 const uint8_t *bios; /* Set in case we use our own mini bios */
102 } testdef_t;
103
104 static testdef_t tests[] = {
105 { "alpha", "clipper", "", "PCI:" },
106 { "ppc", "ppce500", "", "U-Boot" },
107 { "ppc", "40p", "-vga none -boot d", "Trying cd:," },
108 { "ppc", "g3beige", "", "PowerPC,750" },
109 { "ppc", "mac99", "", "PowerPC,G4" },
110 { "ppc", "sam460ex", "-m 256", "DRAM: 256 MiB" },
111 { "ppc64", "ppce500", "", "U-Boot" },
112 { "ppc64", "40p", "-m 192", "Memory: 192M" },
113 { "ppc64", "mac99", "", "PowerPC,970FX" },
114 { "ppc64", "pseries",
115 "-machine cap-cfpc=broken,cap-sbbc=broken,cap-ibs=broken",
116 "Open Firmware" },
117 { "ppc64", "powernv8", "", "OPAL" },
118 { "ppc64", "powernv9", "", "OPAL" },
119 { "ppc64", "sam460ex", "-device e1000", "8086 100e" },
120 { "i386", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
121 { "i386", "pc", "-device sga", "SGABIOS" },
122 { "i386", "q35", "-device sga", "SGABIOS" },
123 { "x86_64", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
124 { "x86_64", "q35", "-device sga", "SGABIOS" },
125 { "sparc", "LX", "", "TMS390S10" },
126 { "sparc", "SS-4", "", "MB86904" },
127 { "sparc", "SS-600MP", "", "TMS390Z55" },
128 { "sparc64", "sun4u", "", "UltraSPARC" },
129 { "s390x", "s390-ccw-virtio", "", "device" },
130 { "m68k", "mcf5208evb", "", "TT", sizeof(kernel_mcf5208), kernel_mcf5208 },
131 { "m68k", "next-cube", "", "TT", sizeof(bios_nextcube), 0, bios_nextcube },
132 { "microblaze", "petalogix-s3adsp1800", "", "TT",
133 sizeof(kernel_pls3adsp1800), kernel_pls3adsp1800 },
134 { "microblazeel", "petalogix-ml605", "", "TT",
135 sizeof(kernel_plml605), kernel_plml605 },
136 { "moxie", "moxiesim", "", "TT", sizeof(bios_moxiesim), 0, bios_moxiesim },
137 { "arm", "raspi2", "", "TT", sizeof(bios_raspi2), 0, bios_raspi2 },
138 { "hppa", "hppa", "", "SeaBIOS wants SYSTEM HALT" },
139 { "aarch64", "virt", "-cpu cortex-a57", "TT", sizeof(kernel_aarch64),
140 kernel_aarch64 },
141 { "arm", "microbit", "", "T", sizeof(kernel_nrf51), kernel_nrf51 },
142
143 { NULL }
144 };
145
check_guest_output(QTestState * qts,const testdef_t * test,int fd)146 static bool check_guest_output(QTestState *qts, const testdef_t *test, int fd)
147 {
148 int nbr = 0, pos = 0, ccnt;
149 time_t now, start = time(NULL);
150 char ch;
151
152 /* Poll serial output... */
153 while (1) {
154 ccnt = 0;
155 while (ccnt++ < 512 && (nbr = read(fd, &ch, 1)) == 1) {
156 if (ch == test->expect[pos]) {
157 pos += 1;
158 if (test->expect[pos] == '\0') {
159 /* We've reached the end of the expected string! */
160 return true;
161 }
162 } else {
163 pos = 0;
164 }
165 }
166 g_assert(nbr >= 0);
167 /* Wait only if the child is still alive. */
168 if (!qtest_probe_child(qts)) {
169 break;
170 }
171 /* Wait at most 360 seconds. */
172 now = time(NULL);
173 if (now - start >= 360) {
174 break;
175 }
176 g_usleep(10000);
177 }
178
179 return false;
180 }
181
test_machine(const void * data)182 static void test_machine(const void *data)
183 {
184 const testdef_t *test = data;
185 char serialtmp[] = "/tmp/qtest-boot-serial-sXXXXXX";
186 char codetmp[] = "/tmp/qtest-boot-serial-cXXXXXX";
187 const char *codeparam = "";
188 const uint8_t *code = NULL;
189 QTestState *qts;
190 int ser_fd;
191
192 ser_fd = mkstemp(serialtmp);
193 g_assert(ser_fd != -1);
194
195 if (test->kernel) {
196 code = test->kernel;
197 codeparam = "-kernel";
198 } else if (test->bios) {
199 code = test->bios;
200 codeparam = "-bios";
201 }
202
203 if (code) {
204 ssize_t wlen;
205 int code_fd;
206
207 code_fd = mkstemp(codetmp);
208 g_assert(code_fd != -1);
209 wlen = write(code_fd, code, test->codesize);
210 g_assert(wlen == test->codesize);
211 close(code_fd);
212 }
213
214 /*
215 * Make sure that this test uses tcg if available: It is used as a
216 * fast-enough smoketest for that.
217 */
218 qts = qtest_initf("%s %s -M %s,accel=tcg:kvm -no-shutdown "
219 "-chardev file,id=serial0,path=%s "
220 "-serial chardev:serial0 %s",
221 codeparam, code ? codetmp : "", test->machine,
222 serialtmp, test->extra);
223 if (code) {
224 unlink(codetmp);
225 }
226
227 if (!check_guest_output(qts, test, ser_fd)) {
228 g_error("Failed to find expected string. Please check '%s'",
229 serialtmp);
230 }
231 unlink(serialtmp);
232
233 qtest_quit(qts);
234
235 close(ser_fd);
236 }
237
main(int argc,char * argv[])238 int main(int argc, char *argv[])
239 {
240 const char *arch = qtest_get_arch();
241 int i;
242
243 g_test_init(&argc, &argv, NULL);
244
245 for (i = 0; tests[i].arch != NULL; i++) {
246 if (strcmp(arch, tests[i].arch) == 0) {
247 char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
248 qtest_add_data_func(name, &tests[i], test_machine);
249 g_free(name);
250 }
251 }
252
253 return g_test_run();
254 }
255