1 // SPDX-License-Identifier: GPL-2.0+
3 * Tests for ACPI table generation
5 * Copyright 2019 Google LLC
14 #include <timestamp.h>
16 #include <tables_csum.h>
18 #include <acpi/acpigen.h>
19 #include <acpi/acpi_device.h>
20 #include <acpi/acpi_table.h>
21 #include <asm/global_data.h>
29 #define OEM_REVISION ((((U_BOOT_VERSION_NUM / 1000) % 10) << 28) | \
30 (((U_BOOT_VERSION_NUM / 100) % 10) << 24) | \
31 (((U_BOOT_VERSION_NUM / 10) % 10) << 20) | \
32 ((U_BOOT_VERSION_NUM % 10) << 16) | \
33 (((U_BOOT_VERSION_NUM_PATCH / 10) % 10) << 12) | \
34 ((U_BOOT_VERSION_NUM_PATCH % 10) << 8) | \
38 * struct testacpi_plat - Platform data for the test ACPI device
40 * @no_name: true to emit an empty ACPI name from testacpi_get_name()
41 * @return_error: true to return an error instead of a name
43 struct testacpi_plat {
49 * setup_ctx_and_base_tables() - Set up context along with RSDP, RSDT and XSDT
51 * Set up the context with the given start position. Some basic tables are
52 * always needed, so set them up as well.
54 * @ctx: Context to set up
56 static int setup_ctx_and_base_tables(struct unit_test_state *uts,
57 struct acpi_ctx *ctx, ulong start)
59 struct acpi_writer *entry = ACPI_WRITER_GET(0base);
61 acpi_setup_ctx(ctx, start);
63 ctx->tab_start = ctx->current;
64 ut_assertok(acpi_write_one(ctx, entry));
69 static int testacpi_write_tables(const struct udevice *dev,
72 struct acpi_dmar *dmar;
75 dmar = (struct acpi_dmar *)ctx->current;
76 acpi_create_dmar(dmar, DMAR_INTR_REMAP);
77 ctx->current += sizeof(struct acpi_dmar);
78 ret = acpi_add_table(ctx, dmar);
80 return log_msg_ret("add", ret);
85 static int testacpi_get_name(const struct udevice *dev, char *out_name)
87 struct testacpi_plat *plat = dev_get_plat(dev);
89 if (plat->return_error)
95 if (device_get_uclass_id(dev->parent) == UCLASS_TEST_ACPI)
96 return acpi_copy_name(out_name, ACPI_TEST_CHILD_NAME);
98 return acpi_copy_name(out_name, ACPI_TEST_DEV_NAME);
101 static int testacpi_fill_ssdt(const struct udevice *dev, struct acpi_ctx *ctx)
105 data = dev_read_string(dev, "acpi-ssdt-test-data");
108 acpigen_emit_byte(ctx, *data++);
114 static int testacpi_inject_dsdt(const struct udevice *dev, struct acpi_ctx *ctx)
118 data = dev_read_string(dev, "acpi-dsdt-test-data");
121 acpigen_emit_byte(ctx, *data++);
127 struct acpi_ops testacpi_ops = {
128 .get_name = testacpi_get_name,
129 .write_tables = testacpi_write_tables,
130 .fill_ssdt = testacpi_fill_ssdt,
131 .inject_dsdt = testacpi_inject_dsdt,
134 static const struct udevice_id testacpi_ids[] = {
135 { .compatible = "denx,u-boot-acpi-test" },
139 U_BOOT_DRIVER(testacpi_drv) = {
140 .name = "testacpi_drv",
141 .of_match = testacpi_ids,
142 .id = UCLASS_TEST_ACPI,
143 .bind = dm_scan_fdt_dev,
144 .plat_auto = sizeof(struct testacpi_plat),
145 ACPI_OPS_PTR(&testacpi_ops)
148 UCLASS_DRIVER(testacpi) = {
150 .id = UCLASS_TEST_ACPI,
153 /* Test ACPI get_name() */
154 static int dm_test_acpi_get_name(struct unit_test_state *uts)
156 char name[ACPI_NAME_MAX];
157 struct udevice *dev, *dev2, *i2c, *spi, *timer, *sound;
158 struct udevice *pci, *root;
160 /* Test getting the name from the driver */
161 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
162 ut_assertok(acpi_get_name(dev, name));
163 ut_asserteq_str(ACPI_TEST_DEV_NAME, name);
165 /* Test getting the name from the device tree */
166 ut_assertok(uclass_get_device_by_name(UCLASS_TEST_FDT, "a-test",
168 ut_assertok(acpi_get_name(dev2, name));
169 ut_asserteq_str("GHIJ", name);
171 /* Test getting the name from acpi_device_get_name() */
172 ut_assertok(uclass_first_device_err(UCLASS_I2C, &i2c));
173 ut_assertok(acpi_get_name(i2c, name));
174 ut_asserteq_str("I2C0", name);
176 ut_assertok(uclass_first_device_err(UCLASS_SPI, &spi));
177 ut_assertok(acpi_get_name(spi, name));
178 ut_asserteq_str("SPI0", name);
180 /* ACPI doesn't know about the timer */
181 ut_assertok(uclass_first_device_err(UCLASS_TIMER, &timer));
182 ut_asserteq(-ENOENT, acpi_get_name(timer, name));
184 /* May as well test the rest of the cases */
185 ut_assertok(uclass_first_device_err(UCLASS_SOUND, &sound));
186 ut_assertok(acpi_get_name(sound, name));
187 ut_asserteq_str("HDAS", name);
189 ut_assertok(uclass_first_device_err(UCLASS_PCI, &pci));
190 ut_assertok(acpi_get_name(pci, name));
191 ut_asserteq_str("PCI0", name);
193 ut_assertok(uclass_first_device_err(UCLASS_ROOT, &root));
194 ut_assertok(acpi_get_name(root, name));
195 ut_asserteq_str("\\_SB", name);
197 /* Note that we don't have tests for acpi_name_from_id() */
201 DM_TEST(dm_test_acpi_get_name, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
203 /* Test acpi_get_table_revision() */
204 static int dm_test_acpi_get_table_revision(struct unit_test_state *uts)
206 ut_asserteq(1, acpi_get_table_revision(ACPITAB_MCFG));
207 ut_asserteq(2, acpi_get_table_revision(ACPITAB_RSDP));
208 ut_asserteq(4, acpi_get_table_revision(ACPITAB_TPM2));
209 ut_asserteq(-EINVAL, acpi_get_table_revision(ACPITAB_COUNT));
213 DM_TEST(dm_test_acpi_get_table_revision,
214 UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
216 /* Test acpi_create_dmar() */
217 static int dm_test_acpi_create_dmar(struct unit_test_state *uts)
219 struct acpi_dmar dmar;
222 ut_assertok(uclass_first_device_err(UCLASS_CPU, &cpu));
223 ut_assertnonnull(cpu);
224 ut_assertok(acpi_create_dmar(&dmar, DMAR_INTR_REMAP));
225 ut_asserteq(DMAR_INTR_REMAP, dmar.flags);
226 ut_asserteq(32 - 1, dmar.host_address_width);
230 DM_TEST(dm_test_acpi_create_dmar, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
232 /* Test acpi_fill_header() */
233 static int dm_test_acpi_fill_header(struct unit_test_state *uts)
235 struct acpi_table_header hdr;
237 /* Make sure these 5 fields are not changed */
241 hdr.aslc_revision = 0x44;
242 acpi_fill_header(&hdr, "ABCD");
244 ut_asserteq_mem("ABCD", hdr.signature, sizeof(hdr.signature));
245 ut_asserteq(0x11, hdr.length);
246 ut_asserteq(0x22, hdr.revision);
247 ut_asserteq(0x33, hdr.checksum);
248 ut_asserteq_mem(OEM_ID, hdr.oem_id, sizeof(hdr.oem_id));
249 ut_asserteq_mem(OEM_TABLE_ID, hdr.oem_table_id,
250 sizeof(hdr.oem_table_id));
251 ut_asserteq(OEM_REVISION, hdr.oem_revision);
252 ut_asserteq_mem(ASLC_ID, hdr.aslc_id, sizeof(hdr.aslc_id));
253 ut_asserteq(0x44, hdr.aslc_revision);
257 DM_TEST(dm_test_acpi_fill_header, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
259 /* Test ACPI write_tables() */
260 static int dm_test_acpi_write_tables(struct unit_test_state *uts)
262 struct acpi_dmar *dmar;
268 buf = malloc(BUF_SIZE);
269 ut_assertnonnull(buf);
270 addr = map_to_sysmem(buf);
272 ut_assertok(setup_ctx_and_base_tables(uts, &ctx, addr));
274 ut_assertok(acpi_write_dev_tables(&ctx));
277 * We should have three dmar tables, one for each
278 * "denx,u-boot-acpi-test" device
280 ut_asserteq_ptr(dmar + 3, ctx.current);
281 ut_asserteq(DMAR_INTR_REMAP, dmar->flags);
282 ut_asserteq(32 - 1, dmar->host_address_width);
284 ut_asserteq(DMAR_INTR_REMAP, dmar[1].flags);
285 ut_asserteq(32 - 1, dmar[1].host_address_width);
287 ut_asserteq(DMAR_INTR_REMAP, dmar[2].flags);
288 ut_asserteq(32 - 1, dmar[2].host_address_width);
290 /* Check that the pointers were added correctly */
291 for (i = 0; i < 3; i++) {
292 ut_asserteq(map_to_sysmem(dmar + i), ctx.rsdt->entry[i]);
293 ut_asserteq(map_to_sysmem(dmar + i), ctx.xsdt->entry[i]);
295 ut_asserteq(0, ctx.rsdt->entry[3]);
296 ut_asserteq(0, ctx.xsdt->entry[3]);
300 DM_TEST(dm_test_acpi_write_tables, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
302 /* Test basic ACPI functions */
303 static int dm_test_acpi_basic(struct unit_test_state *uts)
307 /* Check align works */
308 ctx.current = (void *)5;
310 ut_asserteq_ptr((void *)16, ctx.current);
312 /* Check that align does nothing if already aligned */
314 ut_asserteq_ptr((void *)16, ctx.current);
316 ut_asserteq_ptr((void *)64, ctx.current);
318 ut_asserteq_ptr((void *)64, ctx.current);
320 /* Check incrementing */
322 ut_asserteq_ptr((void *)67, ctx.current);
323 acpi_inc_align(&ctx, 3);
324 ut_asserteq_ptr((void *)80, ctx.current);
328 DM_TEST(dm_test_acpi_basic, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
330 /* Test setup_ctx_and_base_tables */
331 static int dm_test_setup_ctx_and_base_tables(struct unit_test_state *uts)
333 struct acpi_rsdp *rsdp;
334 struct acpi_rsdt *rsdt;
335 struct acpi_xsdt *xsdt;
341 * Use an unaligned address deliberately, by allocating an aligned
342 * address and then adding 4 to it
344 buf = memalign(64, BUF_SIZE);
345 ut_assertnonnull(buf);
346 addr = map_to_sysmem(buf);
347 ut_assertok(setup_ctx_and_base_tables(uts, &ctx, addr + 4));
348 ut_asserteq(map_to_sysmem(PTR_ALIGN(buf + 4, 16)), gd_acpi_start());
351 ut_asserteq_ptr(rsdp, ctx.rsdp);
352 ut_asserteq_mem(RSDP_SIG, rsdp->signature, sizeof(rsdp->signature));
353 ut_asserteq(sizeof(*rsdp), rsdp->length);
354 ut_assertok(table_compute_checksum(rsdp, 20));
355 ut_assertok(table_compute_checksum(rsdp, sizeof(*rsdp)));
357 rsdt = PTR_ALIGN((void *)rsdp + sizeof(*rsdp), 16);
358 ut_asserteq_ptr(rsdt, ctx.rsdt);
359 ut_asserteq_mem("RSDT", rsdt->header.signature, ACPI_NAME_LEN);
360 ut_asserteq(sizeof(*rsdt), rsdt->header.length);
361 ut_assertok(table_compute_checksum(rsdt, sizeof(*rsdt)));
363 xsdt = PTR_ALIGN((void *)rsdt + sizeof(*rsdt), 16);
364 ut_asserteq_ptr(xsdt, ctx.xsdt);
365 ut_asserteq_mem("XSDT", xsdt->header.signature, ACPI_NAME_LEN);
366 ut_asserteq(sizeof(*xsdt), xsdt->header.length);
367 ut_assertok(table_compute_checksum(xsdt, sizeof(*xsdt)));
369 end = PTR_ALIGN((void *)xsdt + sizeof(*xsdt), 64);
370 ut_asserteq_ptr(end, ctx.current);
372 ut_asserteq(map_to_sysmem(rsdt), rsdp->rsdt_address);
373 ut_asserteq(map_to_sysmem(xsdt), rsdp->xsdt_address);
377 DM_TEST(dm_test_setup_ctx_and_base_tables,
378 UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
380 /* Test 'acpi list' command */
381 static int dm_test_acpi_cmd_list(struct unit_test_state *uts)
387 buf = memalign(16, BUF_SIZE);
388 ut_assertnonnull(buf);
389 addr = map_to_sysmem(buf);
390 ut_assertok(setup_ctx_and_base_tables(uts, &ctx, addr));
392 ut_assertok(acpi_write_dev_tables(&ctx));
394 console_record_reset();
395 run_command("acpi list", 0);
396 ut_assert_nextline("Name Base Size Detail");
397 ut_assert_nextline("---- -------- ----- ------");
398 ut_assert_nextline("RSDP %08lx %5zx v02 U-BOOT", addr,
399 sizeof(struct acpi_rsdp));
400 addr = ALIGN(addr + sizeof(struct acpi_rsdp), 16);
401 ut_assert_nextline("RSDT %08lx %5zx v01 U-BOOT U-BOOTBL %x INTL 0",
402 addr, sizeof(struct acpi_table_header) +
403 3 * sizeof(u32), OEM_REVISION);
404 addr = ALIGN(addr + sizeof(struct acpi_rsdt), 16);
405 ut_assert_nextline("XSDT %08lx %5zx v01 U-BOOT U-BOOTBL %x INTL 0",
406 addr, sizeof(struct acpi_table_header) +
407 3 * sizeof(u64), OEM_REVISION);
408 addr = ALIGN(addr + sizeof(struct acpi_xsdt), 64);
409 ut_assert_nextline("DMAR %08lx %5zx v01 U-BOOT U-BOOTBL %x INTL 0",
410 addr, sizeof(struct acpi_dmar), OEM_REVISION);
411 addr = ALIGN(addr + sizeof(struct acpi_dmar), 16);
412 ut_assert_nextline("DMAR %08lx %5zx v01 U-BOOT U-BOOTBL %x INTL 0",
413 addr, sizeof(struct acpi_dmar), OEM_REVISION);
414 addr = ALIGN(addr + sizeof(struct acpi_dmar), 16);
415 ut_assert_nextline("DMAR %08lx %5zx v01 U-BOOT U-BOOTBL %x INTL 0",
416 addr, sizeof(struct acpi_dmar), OEM_REVISION);
417 ut_assert_console_end();
421 DM_TEST(dm_test_acpi_cmd_list, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
423 /* Test 'acpi dump' command */
424 static int dm_test_acpi_cmd_dump(struct unit_test_state *uts)
430 buf = memalign(16, BUF_SIZE);
431 ut_assertnonnull(buf);
432 addr = map_to_sysmem(buf);
433 ut_assertok(setup_ctx_and_base_tables(uts, &ctx, addr));
435 ut_assertok(acpi_write_dev_tables(&ctx));
437 /* First search for a non-existent table */
438 console_record_reset();
439 run_command("acpi dump rdst", 0);
440 ut_assert_nextline("Table 'RDST' not found");
441 ut_assert_console_end();
443 /* Now a real table */
444 console_record_reset();
445 run_command("acpi dump dmar", 0);
446 addr = ALIGN(map_to_sysmem(ctx.xsdt) + sizeof(struct acpi_xsdt), 64);
447 ut_assert_nextline("DMAR @ %08lx", addr);
448 ut_assert_nextlines_are_dump(0x30);
449 ut_assert_console_end();
453 DM_TEST(dm_test_acpi_cmd_dump, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
455 /* Test acpi_device_path() */
456 static int dm_test_acpi_device_path(struct unit_test_state *uts)
458 struct testacpi_plat *plat;
459 char buf[ACPI_PATH_MAX];
460 struct udevice *dev, *child;
462 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
463 ut_assertok(acpi_device_path(dev, buf, sizeof(buf)));
464 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME, buf);
466 /* Test running out of space */
468 ut_asserteq(-ENOSPC, acpi_device_path(dev, buf, 5));
469 ut_asserteq('\0', buf[5]);
471 /* Test a three-component name */
472 ut_assertok(device_first_child_err(dev, &child));
473 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
474 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME "." ACPI_TEST_CHILD_NAME,
477 /* Test handling of a device which doesn't produce a name */
478 plat = dev_get_plat(dev);
479 plat->no_name = true;
480 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
481 ut_asserteq_str("\\_SB." ACPI_TEST_CHILD_NAME, buf);
483 /* Test handling of a device which returns an error */
484 plat = dev_get_plat(dev);
485 plat->return_error = true;
486 ut_asserteq(-EINVAL, acpi_device_path(child, buf, sizeof(buf)));
490 DM_TEST(dm_test_acpi_device_path, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
492 /* Test acpi_device_status() */
493 static int dm_test_acpi_device_status(struct unit_test_state *uts)
497 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
498 ut_asserteq(ACPI_DSTATUS_ALL_ON, acpi_device_status(dev));
502 DM_TEST(dm_test_acpi_device_status, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
504 /* Test acpi_fill_ssdt() */
505 static int dm_test_acpi_fill_ssdt(struct unit_test_state *uts)
510 buf = malloc(BUF_SIZE);
511 ut_assertnonnull(buf);
515 buf[4] = 'z'; /* sentinel */
516 ut_assertok(acpi_fill_ssdt(&ctx));
519 * These values come from acpi-test2's acpi-ssdt-test-data property.
520 * This device comes first because of u-boot,acpi-ssdt-order
522 ut_asserteq('c', buf[0]);
523 ut_asserteq('d', buf[1]);
525 /* These values come from acpi-test's acpi-ssdt-test-data property */
526 ut_asserteq('a', buf[2]);
527 ut_asserteq('b', buf[3]);
529 ut_asserteq('z', buf[4]);
533 DM_TEST(dm_test_acpi_fill_ssdt, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
535 /* Test acpi_inject_dsdt() */
536 static int dm_test_acpi_inject_dsdt(struct unit_test_state *uts)
541 buf = malloc(BUF_SIZE);
542 ut_assertnonnull(buf);
546 buf[4] = 'z'; /* sentinel */
547 ut_assertok(acpi_inject_dsdt(&ctx));
550 * These values come from acpi-test's acpi-dsdt-test-data property.
551 * There is no u-boot,acpi-dsdt-order so device-tree order is used.
553 ut_asserteq('h', buf[0]);
554 ut_asserteq('i', buf[1]);
556 /* These values come from acpi-test's acpi-dsdt-test-data property */
557 ut_asserteq('j', buf[2]);
558 ut_asserteq('k', buf[3]);
560 ut_asserteq('z', buf[4]);
564 DM_TEST(dm_test_acpi_inject_dsdt, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
566 /* Test 'acpi items' command */
567 static int dm_test_acpi_cmd_items(struct unit_test_state *uts)
573 buf = malloc(BUF_SIZE);
574 ut_assertnonnull(buf);
575 addr = map_to_sysmem(buf);
579 ut_assertok(acpi_fill_ssdt(&ctx));
580 console_record_reset();
581 run_command("acpi items", 0);
582 ut_assert_nextline("Seq Type Base Size Device/Writer");
583 ut_assert_nextline("--- ----- -------- ---- -------------");
584 ut_assert_nextline(" 0 ssdt %8lx 2 acpi-test", addr);
585 ut_assert_nextline(" 1 ssdt %8lx 2 acpi-test2", addr + 2);
586 ut_assert_console_end();
590 ut_assertok(acpi_inject_dsdt(&ctx));
591 console_record_reset();
592 run_command("acpi items", 0);
593 ut_assert_nextlinen("Seq");
594 ut_assert_nextlinen("---");
595 ut_assert_nextline(" 0 dsdt %8lx 2 acpi-test", addr);
596 ut_assert_nextline(" 1 dsdt %8lx 2 acpi-test2", addr + 2);
597 ut_assert_console_end();
599 console_record_reset();
600 run_command("acpi items -d", 0);
601 ut_assert_nextlinen("Seq");
602 ut_assert_nextlinen("---");
603 ut_assert_nextline(" 0 dsdt %8lx 2 acpi-test", addr);
604 ut_assert_nextlines_are_dump(2);
605 ut_assert_nextline("%s", "");
606 ut_assert_nextline(" 1 dsdt %8lx 2 acpi-test2", addr + 2);
607 ut_assert_nextlines_are_dump(2);
608 ut_assert_nextline("%s", "");
609 ut_assert_console_end();
613 DM_TEST(dm_test_acpi_cmd_items, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);