tests/acpi-test.c

   1 /*
   2  * Boot order test cases.
   3  *
   4  * Copyright (c) 2013 Red Hat Inc.
   5  *
   6  * Authors:
   7  *  Michael S. Tsirkin <mst@redhat.com>,
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  10  * See the COPYING file in the top-level directory.
  11  */
  12
  13 #include <string.h>
  14 #include <stdio.h>
  15 #include <glib.h>
  16 #include "qemu-common.h"
  17 #include "libqtest.h"
  18 #include "qemu/compiler.h"
  19 #include "hw/i386/acpi-defs.h"
  20
  21 /* DSDT and SSDTs format */
  22 typedef struct {
  23     AcpiTableHeader header;
  24     uint8_t *aml;
  25     int aml_len;
  26 } AcpiSdtTable;
  27
  28 typedef struct {
  29     uint32_t rsdp_addr;
  30     AcpiRsdpDescriptor rsdp_table;
  31     AcpiRsdtDescriptorRev1 rsdt_table;
  32     AcpiFadtDescriptorRev1 fadt_table;
  33     AcpiFacsDescriptorRev1 facs_table;
  34     uint32_t *rsdt_tables_addr;
  35     int rsdt_tables_nr;
  36     AcpiSdtTable dsdt_table;
  37     GArray *ssdt_tables;
  38 } test_data;
  39
  40 #define LOW(x) ((x) & 0xff)
  41 #define HIGH(x) ((x) >> 8)
  42
  43 #define SIGNATURE 0xdead
  44 #define SIGNATURE_OFFSET 0x10
  45 #define BOOT_SECTOR_ADDRESS 0x7c00
  46
  47 #define ACPI_READ_FIELD(field, addr)           \
  48     do {                                       \
  49         switch (sizeof(field)) {               \
  50         case 1:                                \
  51             field = readb(addr);               \
  52             break;                             \
  53         case 2:                                \
  54             field = le16_to_cpu(readw(addr));  \
  55             break;                             \
  56         case 4:                                \
  57             field = le32_to_cpu(readl(addr));  \
  58             break;                             \
  59         case 8:                                \
  60             field = le64_to_cpu(readq(addr));  \
  61             break;                             \
  62         default:                               \
  63             g_assert(false);                   \
  64         }                                      \
  65         addr += sizeof(field);                  \
  66     } while (0);
  67
  68 #define ACPI_READ_ARRAY_PTR(arr, length, addr)  \
  69     do {                                        \
  70         int idx;                                \
  71         for (idx = 0; idx < length; ++idx) {    \
  72             ACPI_READ_FIELD(arr[idx], addr);    \
  73         }                                       \
  74     } while (0);
  75
  76 #define ACPI_READ_ARRAY(arr, addr)                               \
  77     ACPI_READ_ARRAY_PTR(arr, sizeof(arr)/sizeof(arr[0]), addr)
  78
  79 #define ACPI_READ_TABLE_HEADER(table, addr)                      \
  80     do {                                                         \
  81         ACPI_READ_FIELD((table)->signature, addr);               \
  82         ACPI_READ_FIELD((table)->length, addr);                  \
  83         ACPI_READ_FIELD((table)->revision, addr);                \
  84         ACPI_READ_FIELD((table)->checksum, addr);                \
  85         ACPI_READ_ARRAY((table)->oem_id, addr);                  \
  86         ACPI_READ_ARRAY((table)->oem_table_id, addr);            \
  87         ACPI_READ_FIELD((table)->oem_revision, addr);            \
  88         ACPI_READ_ARRAY((table)->asl_compiler_id, addr);         \
  89         ACPI_READ_FIELD((table)->asl_compiler_revision, addr);   \
  90     } while (0);
  91
  92 /* Boot sector code: write SIGNATURE into memory,
  93  * then halt.
  94  */
  95 static uint8_t boot_sector[0x200] = {
  96     /* 7c00: mov $0xdead,%ax */
  97     [0x00] = 0xb8,
  98     [0x01] = LOW(SIGNATURE),
  99     [0x02] = HIGH(SIGNATURE),
 100     /* 7c03:  mov %ax,0x7c10 */
 101     [0x03] = 0xa3,
 102     [0x04] = LOW(BOOT_SECTOR_ADDRESS + SIGNATURE_OFFSET),
 103     [0x05] = HIGH(BOOT_SECTOR_ADDRESS + SIGNATURE_OFFSET),
 104     /* 7c06: cli */
 105     [0x06] = 0xfa,
 106     /* 7c07: hlt */
 107     [0x07] = 0xf4,
 108     /* 7c08: jmp 0x7c07=0x7c0a-3 */
 109     [0x08] = 0xeb,
 110     [0x09] = LOW(-3),
 111     /* We mov 0xdead here: set value to make debugging easier */
 112     [SIGNATURE_OFFSET] = LOW(0xface),
 113     [SIGNATURE_OFFSET + 1] = HIGH(0xface),
 114     /* End of boot sector marker */
 115     [0x1FE] = 0x55,
 116     [0x1FF] = 0xAA,
 117 };
 118
 119 static const char *disk = "tests/acpi-test-disk.raw";
 120
 121 static void free_test_data(test_data *data)
 122 {
 123     int i;
 124
 125     g_free(data->rsdt_tables_addr);
 126     for (i = 0; i < data->ssdt_tables->len; ++i) {
 127         g_free(g_array_index(data->ssdt_tables, AcpiSdtTable, i).aml);
 128     }
 129     g_array_free(data->ssdt_tables, false);
 130     g_free(data->dsdt_table.aml);
 131 }
 132
 133 static uint8_t acpi_checksum(const uint8_t *data, int len)
 134 {
 135     int i;
 136     uint8_t sum = 0;
 137
 138     for (i = 0; i < len; i++) {
 139         sum += data[i];
 140     }
 141
 142     return sum;
 143 }
 144
 145 static void test_acpi_rsdp_address(test_data *data)
 146 {
 147     uint32_t off;
 148
 149     /* OK, now find RSDP */
 150     for (off = 0xf0000; off < 0x100000; off += 0x10) {
 151         uint8_t sig[] = "RSD PTR ";
 152         int i;
 153
 154         for (i = 0; i < sizeof sig - 1; ++i) {
 155             sig[i] = readb(off + i);
 156         }
 157
 158         if (!memcmp(sig, "RSD PTR ", sizeof sig)) {
 159             break;
 160         }
 161     }
 162
 163     g_assert_cmphex(off, <, 0x100000);
 164     data->rsdp_addr = off;
 165 }
 166
 167 static void test_acpi_rsdp_table(test_data *data)
 168 {
 169     AcpiRsdpDescriptor *rsdp_table = &data->rsdp_table;
 170     uint32_t addr = data->rsdp_addr;
 171
 172     ACPI_READ_FIELD(rsdp_table->signature, addr);
 173     g_assert_cmphex(rsdp_table->signature, ==, ACPI_RSDP_SIGNATURE);
 174
 175     ACPI_READ_FIELD(rsdp_table->checksum, addr);
 176     ACPI_READ_ARRAY(rsdp_table->oem_id, addr);
 177     ACPI_READ_FIELD(rsdp_table->revision, addr);
 178     ACPI_READ_FIELD(rsdp_table->rsdt_physical_address, addr);
 179     ACPI_READ_FIELD(rsdp_table->length, addr);
 180
 181     /* rsdp checksum is not for the whole table, but for the first 20 bytes */
 182     g_assert(!acpi_checksum((uint8_t *)rsdp_table, 20));
 183 }
 184
 185 static void test_acpi_rsdt_table(test_data *data)
 186 {
 187     AcpiRsdtDescriptorRev1 *rsdt_table = &data->rsdt_table;
 188     uint32_t addr = data->rsdp_table.rsdt_physical_address;
 189     uint32_t *tables;
 190     int tables_nr;
 191     uint8_t checksum;
 192
 193     /* read the header */
 194     ACPI_READ_TABLE_HEADER(rsdt_table, addr);
 195     g_assert_cmphex(rsdt_table->signature, ==, ACPI_RSDT_SIGNATURE);
 196
 197     /* compute the table entries in rsdt */
 198     tables_nr = (rsdt_table->length - sizeof(AcpiRsdtDescriptorRev1)) /
 199                 sizeof(uint32_t);
 200     g_assert_cmpint(tables_nr, >, 0);
 201
 202     /* get the addresses of the tables pointed by rsdt */
 203     tables = g_new0(uint32_t, tables_nr);
 204     ACPI_READ_ARRAY_PTR(tables, tables_nr, addr);
 205
 206     checksum = acpi_checksum((uint8_t *)rsdt_table, rsdt_table->length) +
 207                acpi_checksum((uint8_t *)tables, tables_nr * sizeof(uint32_t));
 208     g_assert(!checksum);
 209
 210    /* SSDT tables after FADT */
 211     data->rsdt_tables_addr = tables;
 212     data->rsdt_tables_nr = tables_nr;
 213 }
 214
 215 static void test_acpi_fadt_table(test_data *data)
 216 {
 217     AcpiFadtDescriptorRev1 *fadt_table = &data->fadt_table;
 218     uint32_t addr;
 219
 220     /* FADT table comes first */
 221     addr = data->rsdt_tables_addr[0];
 222     ACPI_READ_TABLE_HEADER(fadt_table, addr);
 223
 224     ACPI_READ_FIELD(fadt_table->firmware_ctrl, addr);
 225     ACPI_READ_FIELD(fadt_table->dsdt, addr);
 226     ACPI_READ_FIELD(fadt_table->model, addr);
 227     ACPI_READ_FIELD(fadt_table->reserved1, addr);
 228     ACPI_READ_FIELD(fadt_table->sci_int, addr);
 229     ACPI_READ_FIELD(fadt_table->smi_cmd, addr);
 230     ACPI_READ_FIELD(fadt_table->acpi_enable, addr);
 231     ACPI_READ_FIELD(fadt_table->acpi_disable, addr);
 232     ACPI_READ_FIELD(fadt_table->S4bios_req, addr);
 233     ACPI_READ_FIELD(fadt_table->reserved2, addr);
 234     ACPI_READ_FIELD(fadt_table->pm1a_evt_blk, addr);
 235     ACPI_READ_FIELD(fadt_table->pm1b_evt_blk, addr);
 236     ACPI_READ_FIELD(fadt_table->pm1a_cnt_blk, addr);
 237     ACPI_READ_FIELD(fadt_table->pm1b_cnt_blk, addr);
 238     ACPI_READ_FIELD(fadt_table->pm2_cnt_blk, addr);
 239     ACPI_READ_FIELD(fadt_table->pm_tmr_blk, addr);
 240     ACPI_READ_FIELD(fadt_table->gpe0_blk, addr);
 241     ACPI_READ_FIELD(fadt_table->gpe1_blk, addr);
 242     ACPI_READ_FIELD(fadt_table->pm1_evt_len, addr);
 243     ACPI_READ_FIELD(fadt_table->pm1_cnt_len, addr);
 244     ACPI_READ_FIELD(fadt_table->pm2_cnt_len, addr);
 245     ACPI_READ_FIELD(fadt_table->pm_tmr_len, addr);
 246     ACPI_READ_FIELD(fadt_table->gpe0_blk_len, addr);
 247     ACPI_READ_FIELD(fadt_table->gpe1_blk_len, addr);
 248     ACPI_READ_FIELD(fadt_table->gpe1_base, addr);
 249     ACPI_READ_FIELD(fadt_table->reserved3, addr);
 250     ACPI_READ_FIELD(fadt_table->plvl2_lat, addr);
 251     ACPI_READ_FIELD(fadt_table->plvl3_lat, addr);
 252     ACPI_READ_FIELD(fadt_table->flush_size, addr);
 253     ACPI_READ_FIELD(fadt_table->flush_stride, addr);
 254     ACPI_READ_FIELD(fadt_table->duty_offset, addr);
 255     ACPI_READ_FIELD(fadt_table->duty_width, addr);
 256     ACPI_READ_FIELD(fadt_table->day_alrm, addr);
 257     ACPI_READ_FIELD(fadt_table->mon_alrm, addr);
 258     ACPI_READ_FIELD(fadt_table->century, addr);
 259     ACPI_READ_FIELD(fadt_table->reserved4, addr);
 260     ACPI_READ_FIELD(fadt_table->reserved4a, addr);
 261     ACPI_READ_FIELD(fadt_table->reserved4b, addr);
 262     ACPI_READ_FIELD(fadt_table->flags, addr);
 263
 264     g_assert_cmphex(fadt_table->signature, ==, ACPI_FACP_SIGNATURE);
 265     g_assert(!acpi_checksum((uint8_t *)fadt_table, fadt_table->length));
 266 }
 267
 268 static void test_acpi_facs_table(test_data *data)
 269 {
 270     AcpiFacsDescriptorRev1 *facs_table = &data->facs_table;
 271     uint32_t addr = data->fadt_table.firmware_ctrl;
 272
 273     ACPI_READ_FIELD(facs_table->signature, addr);
 274     ACPI_READ_FIELD(facs_table->length, addr);
 275     ACPI_READ_FIELD(facs_table->hardware_signature, addr);
 276     ACPI_READ_FIELD(facs_table->firmware_waking_vector, addr);
 277     ACPI_READ_FIELD(facs_table->global_lock, addr);
 278     ACPI_READ_FIELD(facs_table->flags, addr);
 279     ACPI_READ_ARRAY(facs_table->resverved3, addr);
 280
 281     g_assert_cmphex(facs_table->signature, ==, ACPI_FACS_SIGNATURE);
 282 }
 283
 284 static void test_dst_table(AcpiSdtTable *sdt_table, uint32_t addr)
 285 {
 286     uint8_t checksum;
 287
 288     ACPI_READ_TABLE_HEADER(&sdt_table->header, addr);
 289
 290     sdt_table->aml_len = sdt_table->header.length - sizeof(AcpiTableHeader);
 291     sdt_table->aml = g_malloc0(sdt_table->aml_len);
 292     ACPI_READ_ARRAY_PTR(sdt_table->aml, sdt_table->aml_len, addr);
 293
 294     checksum = acpi_checksum((uint8_t *)sdt_table, sizeof(AcpiTableHeader)) +
 295                acpi_checksum(sdt_table->aml, sdt_table->aml_len);
 296     g_assert(!checksum);
 297 }
 298
 299 static void test_acpi_dsdt_table(test_data *data)
 300 {
 301     AcpiSdtTable *dsdt_table = &data->dsdt_table;
 302     uint32_t addr = data->fadt_table.dsdt;
 303
 304     test_dst_table(dsdt_table, addr);
 305     g_assert_cmphex(dsdt_table->header.signature, ==, ACPI_DSDT_SIGNATURE);
 306 }
 307
 308 static void test_acpi_ssdt_tables(test_data *data)
 309 {
 310     GArray *ssdt_tables;
 311     int ssdt_tables_nr = data->rsdt_tables_nr - 1; /* fadt is first */
 312     int i;
 313
 314     ssdt_tables = g_array_sized_new(false, true, sizeof(AcpiSdtTable),
 315                                     ssdt_tables_nr);
 316     for (i = 0; i < ssdt_tables_nr; i++) {
 317         AcpiSdtTable ssdt_table;
 318         uint32_t addr = data->rsdt_tables_addr[i + 1]; /* fadt is first */
 319         test_dst_table(&ssdt_table, addr);
 320         g_array_append_val(ssdt_tables, ssdt_table);
 321     }
 322     data->ssdt_tables = ssdt_tables;
 323 }
 324
 325 static void test_acpi_one(const char *params, test_data *data)
 326 {
 327     char *args;
 328     uint8_t signature_low;
 329     uint8_t signature_high;
 330     uint16_t signature;
 331     int i;
 332
 333     memset(data, 0, sizeof(*data));
 334     args = g_strdup_printf("-net none -display none %s %s",
 335                            params ? params : "", disk);
 336     qtest_start(args);
 337
 338    /* Wait at most 1 minute */
 339 #define TEST_DELAY (1 * G_USEC_PER_SEC / 10)
 340 #define TEST_CYCLES MAX((60 * G_USEC_PER_SEC / TEST_DELAY), 1)
 341
 342     /* Poll until code has run and modified memory.  Once it has we know BIOS
 343      * initialization is done.  TODO: check that IP reached the halt
 344      * instruction.
 345      */
 346     for (i = 0; i < TEST_CYCLES; ++i) {
 347         signature_low = readb(BOOT_SECTOR_ADDRESS + SIGNATURE_OFFSET);
 348         signature_high = readb(BOOT_SECTOR_ADDRESS + SIGNATURE_OFFSET + 1);
 349         signature = (signature_high << 8) | signature_low;
 350         if (signature == SIGNATURE) {
 351             break;
 352         }
 353         g_usleep(TEST_DELAY);
 354     }
 355     g_assert_cmphex(signature, ==, SIGNATURE);
 356
 357     test_acpi_rsdp_address(data);
 358     test_acpi_rsdp_table(data);
 359     test_acpi_rsdt_table(data);
 360     test_acpi_fadt_table(data);
 361     test_acpi_facs_table(data);
 362     test_acpi_dsdt_table(data);
 363     test_acpi_ssdt_tables(data);
 364
 365     qtest_quit(global_qtest);
 366     g_free(args);
 367 }
 368
 369 static void test_acpi_tcg(void)
 370 {
 371     test_data data;
 372
 373     /* Supplying -machine accel argument overrides the default (qtest).
 374      * This is to make guest actually run.
 375      */
 376     test_acpi_one("-machine accel=tcg", &data);
 377
 378     free_test_data(&data);
 379 }
 380
 381 int main(int argc, char *argv[])
 382 {
 383     const char *arch = qtest_get_arch();
 384     FILE *f = fopen(disk, "w");
 385     fwrite(boot_sector, 1, sizeof boot_sector, f);
 386     fclose(f);
 387
 388     g_test_init(&argc, &argv, NULL);
 389
 390     if (strcmp(arch, "i386") == 0 || strcmp(arch, "x86_64") == 0) {
 391         qtest_add_func("acpi/tcg", test_acpi_tcg);
 392     }
 393     return g_test_run();
 394 }