1 // SPDX-License-Identifier: GPL-2.0+
3 * Tests for ACPI table generation
5 * Copyright 2019 Google LLC
15 #include <tables_csum.h>
17 #include <acpi/acpigen.h>
18 #include <acpi/acpi_device.h>
19 #include <acpi/acpi_table.h>
20 #include <asm/global_data.h>
29 * struct testacpi_plat - Platform data for the test ACPI device
31 * @no_name: true to emit an empty ACPI name from testacpi_get_name()
32 * @return_error: true to return an error instead of a name
34 struct testacpi_plat {
39 static int testacpi_write_tables(const struct udevice *dev,
42 struct acpi_dmar *dmar;
45 dmar = (struct acpi_dmar *)ctx->current;
46 acpi_create_dmar(dmar, DMAR_INTR_REMAP);
47 ctx->current += sizeof(struct acpi_dmar);
48 ret = acpi_add_table(ctx, dmar);
50 return log_msg_ret("add", ret);
55 static int testacpi_get_name(const struct udevice *dev, char *out_name)
57 struct testacpi_plat *plat = dev_get_plat(dev);
59 if (plat->return_error)
65 if (device_get_uclass_id(dev->parent) == UCLASS_TEST_ACPI)
66 return acpi_copy_name(out_name, ACPI_TEST_CHILD_NAME);
68 return acpi_copy_name(out_name, ACPI_TEST_DEV_NAME);
71 static int testacpi_fill_ssdt(const struct udevice *dev, struct acpi_ctx *ctx)
75 data = dev_read_string(dev, "acpi-ssdt-test-data");
78 acpigen_emit_byte(ctx, *data++);
84 static int testacpi_inject_dsdt(const struct udevice *dev, struct acpi_ctx *ctx)
88 data = dev_read_string(dev, "acpi-dsdt-test-data");
91 acpigen_emit_byte(ctx, *data++);
97 struct acpi_ops testacpi_ops = {
98 .get_name = testacpi_get_name,
99 .write_tables = testacpi_write_tables,
100 .fill_ssdt = testacpi_fill_ssdt,
101 .inject_dsdt = testacpi_inject_dsdt,
104 static const struct udevice_id testacpi_ids[] = {
105 { .compatible = "denx,u-boot-acpi-test" },
109 U_BOOT_DRIVER(testacpi_drv) = {
110 .name = "testacpi_drv",
111 .of_match = testacpi_ids,
112 .id = UCLASS_TEST_ACPI,
113 .bind = dm_scan_fdt_dev,
114 .plat_auto = sizeof(struct testacpi_plat),
115 ACPI_OPS_PTR(&testacpi_ops)
118 UCLASS_DRIVER(testacpi) = {
120 .id = UCLASS_TEST_ACPI,
123 /* Test ACPI get_name() */
124 static int dm_test_acpi_get_name(struct unit_test_state *uts)
126 char name[ACPI_NAME_MAX];
127 struct udevice *dev, *dev2, *i2c, *spi, *timer, *sound;
128 struct udevice *pci, *root;
130 /* Test getting the name from the driver */
131 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
132 ut_assertok(acpi_get_name(dev, name));
133 ut_asserteq_str(ACPI_TEST_DEV_NAME, name);
135 /* Test getting the name from the device tree */
136 ut_assertok(uclass_get_device_by_name(UCLASS_TEST_FDT, "a-test",
138 ut_assertok(acpi_get_name(dev2, name));
139 ut_asserteq_str("GHIJ", name);
141 /* Test getting the name from acpi_device_get_name() */
142 ut_assertok(uclass_first_device(UCLASS_I2C, &i2c));
143 ut_assertok(acpi_get_name(i2c, name));
144 ut_asserteq_str("I2C0", name);
146 ut_assertok(uclass_first_device(UCLASS_SPI, &spi));
147 ut_assertok(acpi_get_name(spi, name));
148 ut_asserteq_str("SPI0", name);
150 /* ACPI doesn't know about the timer */
151 ut_assertok(uclass_first_device(UCLASS_TIMER, &timer));
152 ut_asserteq(-ENOENT, acpi_get_name(timer, name));
154 /* May as well test the rest of the cases */
155 ut_assertok(uclass_first_device(UCLASS_SOUND, &sound));
156 ut_assertok(acpi_get_name(sound, name));
157 ut_asserteq_str("HDAS", name);
159 ut_assertok(uclass_first_device(UCLASS_PCI, &pci));
160 ut_assertok(acpi_get_name(pci, name));
161 ut_asserteq_str("PCI0", name);
163 ut_assertok(uclass_first_device(UCLASS_ROOT, &root));
164 ut_assertok(acpi_get_name(root, name));
165 ut_asserteq_str("\\_SB", name);
167 /* Note that we don't have tests for acpi_name_from_id() */
171 DM_TEST(dm_test_acpi_get_name, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
173 /* Test acpi_get_table_revision() */
174 static int dm_test_acpi_get_table_revision(struct unit_test_state *uts)
176 ut_asserteq(1, acpi_get_table_revision(ACPITAB_MCFG));
177 ut_asserteq(2, acpi_get_table_revision(ACPITAB_RSDP));
178 ut_asserteq(4, acpi_get_table_revision(ACPITAB_TPM2));
179 ut_asserteq(-EINVAL, acpi_get_table_revision(ACPITAB_COUNT));
183 DM_TEST(dm_test_acpi_get_table_revision,
184 UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
186 /* Test acpi_create_dmar() */
187 static int dm_test_acpi_create_dmar(struct unit_test_state *uts)
189 struct acpi_dmar dmar;
192 ut_assertok(uclass_first_device(UCLASS_CPU, &cpu));
193 ut_assertnonnull(cpu);
194 ut_assertok(acpi_create_dmar(&dmar, DMAR_INTR_REMAP));
195 ut_asserteq(DMAR_INTR_REMAP, dmar.flags);
196 ut_asserteq(32 - 1, dmar.host_address_width);
200 DM_TEST(dm_test_acpi_create_dmar, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
202 /* Test acpi_fill_header() */
203 static int dm_test_acpi_fill_header(struct unit_test_state *uts)
205 struct acpi_table_header hdr;
207 /* Make sure these 5 fields are not changed */
211 hdr.aslc_revision = 0x44;
212 acpi_fill_header(&hdr, "ABCD");
214 ut_asserteq_mem("ABCD", hdr.signature, sizeof(hdr.signature));
215 ut_asserteq(0x11, hdr.length);
216 ut_asserteq(0x22, hdr.revision);
217 ut_asserteq(0x33, hdr.checksum);
218 ut_asserteq_mem(OEM_ID, hdr.oem_id, sizeof(hdr.oem_id));
219 ut_asserteq_mem(OEM_TABLE_ID, hdr.oem_table_id,
220 sizeof(hdr.oem_table_id));
221 ut_asserteq(U_BOOT_BUILD_DATE, hdr.oem_revision);
222 ut_asserteq_mem(ASLC_ID, hdr.aslc_id, sizeof(hdr.aslc_id));
223 ut_asserteq(0x44, hdr.aslc_revision);
227 DM_TEST(dm_test_acpi_fill_header, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
229 /* Test ACPI write_tables() */
230 static int dm_test_acpi_write_tables(struct unit_test_state *uts)
232 struct acpi_dmar *dmar;
237 buf = malloc(BUF_SIZE);
238 ut_assertnonnull(buf);
240 acpi_setup_base_tables(&ctx, buf);
242 ut_assertok(acpi_write_dev_tables(&ctx));
245 * We should have three dmar tables, one for each
246 * "denx,u-boot-acpi-test" device
248 ut_asserteq_ptr(dmar + 3, ctx.current);
249 ut_asserteq(DMAR_INTR_REMAP, dmar->flags);
250 ut_asserteq(32 - 1, dmar->host_address_width);
252 ut_asserteq(DMAR_INTR_REMAP, dmar[1].flags);
253 ut_asserteq(32 - 1, dmar[1].host_address_width);
255 ut_asserteq(DMAR_INTR_REMAP, dmar[2].flags);
256 ut_asserteq(32 - 1, dmar[2].host_address_width);
258 /* Check that the pointers were added correctly */
259 for (i = 0; i < 3; i++) {
260 ut_asserteq(map_to_sysmem(dmar + i), ctx.rsdt->entry[i]);
261 ut_asserteq(map_to_sysmem(dmar + i), ctx.xsdt->entry[i]);
263 ut_asserteq(0, ctx.rsdt->entry[3]);
264 ut_asserteq(0, ctx.xsdt->entry[3]);
268 DM_TEST(dm_test_acpi_write_tables, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
270 /* Test basic ACPI functions */
271 static int dm_test_acpi_basic(struct unit_test_state *uts)
275 /* Check align works */
276 ctx.current = (void *)5;
278 ut_asserteq_ptr((void *)16, ctx.current);
280 /* Check that align does nothing if already aligned */
282 ut_asserteq_ptr((void *)16, ctx.current);
284 ut_asserteq_ptr((void *)64, ctx.current);
286 ut_asserteq_ptr((void *)64, ctx.current);
288 /* Check incrementing */
290 ut_asserteq_ptr((void *)67, ctx.current);
291 acpi_inc_align(&ctx, 3);
292 ut_asserteq_ptr((void *)80, ctx.current);
296 DM_TEST(dm_test_acpi_basic, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
298 /* Test acpi_setup_base_tables */
299 static int dm_test_acpi_setup_base_tables(struct unit_test_state *uts)
301 struct acpi_rsdp *rsdp;
302 struct acpi_rsdt *rsdt;
303 struct acpi_xsdt *xsdt;
308 * Use an unaligned address deliberately, by allocating an aligned
309 * address and then adding 4 to it
311 buf = memalign(64, BUF_SIZE);
312 ut_assertnonnull(buf);
313 acpi_setup_base_tables(&ctx, buf + 4);
314 ut_asserteq(map_to_sysmem(PTR_ALIGN(buf + 4, 16)), gd->arch.acpi_start);
317 ut_asserteq_ptr(rsdp, ctx.rsdp);
318 ut_asserteq_mem(RSDP_SIG, rsdp->signature, sizeof(rsdp->signature));
319 ut_asserteq(sizeof(*rsdp), rsdp->length);
320 ut_assertok(table_compute_checksum(rsdp, 20));
321 ut_assertok(table_compute_checksum(rsdp, sizeof(*rsdp)));
323 rsdt = PTR_ALIGN((void *)rsdp + sizeof(*rsdp), 16);
324 ut_asserteq_ptr(rsdt, ctx.rsdt);
325 ut_asserteq_mem("RSDT", rsdt->header.signature, ACPI_NAME_LEN);
326 ut_asserteq(sizeof(*rsdt), rsdt->header.length);
327 ut_assertok(table_compute_checksum(rsdt, sizeof(*rsdt)));
329 xsdt = PTR_ALIGN((void *)rsdt + sizeof(*rsdt), 16);
330 ut_asserteq_ptr(xsdt, ctx.xsdt);
331 ut_asserteq_mem("XSDT", xsdt->header.signature, ACPI_NAME_LEN);
332 ut_asserteq(sizeof(*xsdt), xsdt->header.length);
333 ut_assertok(table_compute_checksum(xsdt, sizeof(*xsdt)));
335 end = PTR_ALIGN((void *)xsdt + sizeof(*xsdt), 64);
336 ut_asserteq_ptr(end, ctx.current);
338 ut_asserteq(map_to_sysmem(rsdt), rsdp->rsdt_address);
339 ut_asserteq(map_to_sysmem(xsdt), rsdp->xsdt_address);
343 DM_TEST(dm_test_acpi_setup_base_tables,
344 UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
346 /* Test 'acpi list' command */
347 static int dm_test_acpi_cmd_list(struct unit_test_state *uts)
353 buf = memalign(16, BUF_SIZE);
354 ut_assertnonnull(buf);
355 acpi_setup_base_tables(&ctx, buf);
357 ut_assertok(acpi_write_dev_tables(&ctx));
359 console_record_reset();
360 run_command("acpi list", 0);
361 addr = (ulong)map_to_sysmem(buf);
362 ut_assert_nextline("ACPI tables start at %lx", addr);
363 ut_assert_nextline("RSDP %08lx %06lx (v02 U-BOOT)", addr,
364 sizeof(struct acpi_rsdp));
365 addr = ALIGN(addr + sizeof(struct acpi_rsdp), 16);
366 ut_assert_nextline("RSDT %08lx %06lx (v01 U-BOOT U-BOOTBL %x INTL 0)",
367 addr, sizeof(struct acpi_table_header) +
368 3 * sizeof(u32), U_BOOT_BUILD_DATE);
369 addr = ALIGN(addr + sizeof(struct acpi_rsdt), 16);
370 ut_assert_nextline("XSDT %08lx %06lx (v01 U-BOOT U-BOOTBL %x INTL 0)",
371 addr, sizeof(struct acpi_table_header) +
372 3 * sizeof(u64), U_BOOT_BUILD_DATE);
373 addr = ALIGN(addr + sizeof(struct acpi_xsdt), 64);
374 ut_assert_nextline("DMAR %08lx %06lx (v01 U-BOOT U-BOOTBL %x INTL 0)",
375 addr, sizeof(struct acpi_dmar), U_BOOT_BUILD_DATE);
376 addr = ALIGN(addr + sizeof(struct acpi_dmar), 16);
377 ut_assert_nextline("DMAR %08lx %06lx (v01 U-BOOT U-BOOTBL %x INTL 0)",
378 addr, sizeof(struct acpi_dmar), U_BOOT_BUILD_DATE);
379 addr = ALIGN(addr + sizeof(struct acpi_dmar), 16);
380 ut_assert_nextline("DMAR %08lx %06lx (v01 U-BOOT U-BOOTBL %x INTL 0)",
381 addr, sizeof(struct acpi_dmar), U_BOOT_BUILD_DATE);
382 ut_assert_console_end();
386 DM_TEST(dm_test_acpi_cmd_list, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
388 /* Test 'acpi dump' command */
389 static int dm_test_acpi_cmd_dump(struct unit_test_state *uts)
395 buf = memalign(16, BUF_SIZE);
396 ut_assertnonnull(buf);
397 acpi_setup_base_tables(&ctx, buf);
399 ut_assertok(acpi_write_dev_tables(&ctx));
401 /* First search for a non-existent table */
402 console_record_reset();
403 run_command("acpi dump rdst", 0);
404 ut_assert_nextline("Table 'RDST' not found");
405 ut_assert_console_end();
407 /* Now a real table */
408 console_record_reset();
409 run_command("acpi dump dmar", 0);
410 addr = ALIGN(map_to_sysmem(ctx.xsdt) + sizeof(struct acpi_xsdt), 64);
411 ut_assert_nextline("DMAR @ %08lx", addr);
412 ut_assert_nextlines_are_dump(0x30);
413 ut_assert_console_end();
417 DM_TEST(dm_test_acpi_cmd_dump, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
419 /* Test acpi_device_path() */
420 static int dm_test_acpi_device_path(struct unit_test_state *uts)
422 struct testacpi_plat *plat;
423 char buf[ACPI_PATH_MAX];
424 struct udevice *dev, *child;
426 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
427 ut_assertok(acpi_device_path(dev, buf, sizeof(buf)));
428 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME, buf);
430 /* Test running out of space */
432 ut_asserteq(-ENOSPC, acpi_device_path(dev, buf, 5));
433 ut_asserteq('\0', buf[5]);
435 /* Test a three-component name */
436 ut_assertok(device_first_child_err(dev, &child));
437 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
438 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME "." ACPI_TEST_CHILD_NAME,
441 /* Test handling of a device which doesn't produce a name */
442 plat = dev_get_plat(dev);
443 plat->no_name = true;
444 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
445 ut_asserteq_str("\\_SB." ACPI_TEST_CHILD_NAME, buf);
447 /* Test handling of a device which returns an error */
448 plat = dev_get_plat(dev);
449 plat->return_error = true;
450 ut_asserteq(-EINVAL, acpi_device_path(child, buf, sizeof(buf)));
454 DM_TEST(dm_test_acpi_device_path, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
456 /* Test acpi_device_status() */
457 static int dm_test_acpi_device_status(struct unit_test_state *uts)
461 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
462 ut_asserteq(ACPI_DSTATUS_ALL_ON, acpi_device_status(dev));
466 DM_TEST(dm_test_acpi_device_status, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
468 /* Test acpi_fill_ssdt() */
469 static int dm_test_acpi_fill_ssdt(struct unit_test_state *uts)
474 buf = malloc(BUF_SIZE);
475 ut_assertnonnull(buf);
479 buf[4] = 'z'; /* sentinel */
480 ut_assertok(acpi_fill_ssdt(&ctx));
483 * These values come from acpi-test2's acpi-ssdt-test-data property.
484 * This device comes first because of u-boot,acpi-ssdt-order
486 ut_asserteq('c', buf[0]);
487 ut_asserteq('d', buf[1]);
489 /* These values come from acpi-test's acpi-ssdt-test-data property */
490 ut_asserteq('a', buf[2]);
491 ut_asserteq('b', buf[3]);
493 ut_asserteq('z', buf[4]);
497 DM_TEST(dm_test_acpi_fill_ssdt, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
499 /* Test acpi_inject_dsdt() */
500 static int dm_test_acpi_inject_dsdt(struct unit_test_state *uts)
505 buf = malloc(BUF_SIZE);
506 ut_assertnonnull(buf);
510 buf[4] = 'z'; /* sentinel */
511 ut_assertok(acpi_inject_dsdt(&ctx));
514 * These values come from acpi-test's acpi-dsdt-test-data property.
515 * There is no u-boot,acpi-dsdt-order so device-tree order is used.
517 ut_asserteq('h', buf[0]);
518 ut_asserteq('i', buf[1]);
520 /* These values come from acpi-test's acpi-dsdt-test-data property */
521 ut_asserteq('j', buf[2]);
522 ut_asserteq('k', buf[3]);
524 ut_asserteq('z', buf[4]);
528 DM_TEST(dm_test_acpi_inject_dsdt, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
530 /* Test 'acpi items' command */
531 static int dm_test_acpi_cmd_items(struct unit_test_state *uts)
536 buf = malloc(BUF_SIZE);
537 ut_assertnonnull(buf);
541 ut_assertok(acpi_fill_ssdt(&ctx));
542 console_record_reset();
543 run_command("acpi items", 0);
544 ut_assert_nextline("dev 'acpi-test', type 1, size 2");
545 ut_assert_nextline("dev 'acpi-test2', type 1, size 2");
546 ut_assert_console_end();
550 ut_assertok(acpi_inject_dsdt(&ctx));
551 console_record_reset();
552 run_command("acpi items", 0);
553 ut_assert_nextline("dev 'acpi-test', type 2, size 2");
554 ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
555 ut_assert_console_end();
557 console_record_reset();
558 run_command("acpi items -d", 0);
559 ut_assert_nextline("dev 'acpi-test', type 2, size 2");
560 ut_assert_nextlines_are_dump(2);
561 ut_assert_nextline("%s", "");
562 ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
563 ut_assert_nextlines_are_dump(2);
564 ut_assert_nextline("%s", "");
565 ut_assert_console_end();
569 DM_TEST(dm_test_acpi_cmd_items, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);