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>
28 * struct testacpi_platdata - Platform data for the test ACPI device
30 * @no_name: true to emit an empty ACPI name from testacpi_get_name()
31 * @return_error: true to return an error instead of a name
33 struct testacpi_platdata {
38 static int testacpi_write_tables(const struct udevice *dev,
41 struct acpi_dmar *dmar;
44 dmar = (struct acpi_dmar *)ctx->current;
45 acpi_create_dmar(dmar, DMAR_INTR_REMAP);
46 ctx->current += sizeof(struct acpi_dmar);
47 ret = acpi_add_table(ctx, dmar);
49 return log_msg_ret("add", ret);
54 static int testacpi_get_name(const struct udevice *dev, char *out_name)
56 struct testacpi_platdata *plat = dev_get_platdata(dev);
58 if (plat->return_error)
64 if (device_get_uclass_id(dev->parent) == UCLASS_TEST_ACPI)
65 return acpi_copy_name(out_name, ACPI_TEST_CHILD_NAME);
67 return acpi_copy_name(out_name, ACPI_TEST_DEV_NAME);
70 static int testacpi_fill_ssdt(const struct udevice *dev, struct acpi_ctx *ctx)
74 data = dev_read_string(dev, "acpi-ssdt-test-data");
77 acpigen_emit_byte(ctx, *data++);
83 static int testacpi_inject_dsdt(const struct udevice *dev, struct acpi_ctx *ctx)
87 data = dev_read_string(dev, "acpi-dsdt-test-data");
90 acpigen_emit_byte(ctx, *data++);
96 struct acpi_ops testacpi_ops = {
97 .get_name = testacpi_get_name,
98 .write_tables = testacpi_write_tables,
99 .fill_ssdt = testacpi_fill_ssdt,
100 .inject_dsdt = testacpi_inject_dsdt,
103 static const struct udevice_id testacpi_ids[] = {
104 { .compatible = "denx,u-boot-acpi-test" },
108 U_BOOT_DRIVER(testacpi_drv) = {
109 .name = "testacpi_drv",
110 .of_match = testacpi_ids,
111 .id = UCLASS_TEST_ACPI,
112 .bind = dm_scan_fdt_dev,
113 .platdata_auto_alloc_size = sizeof(struct testacpi_platdata),
114 ACPI_OPS_PTR(&testacpi_ops)
117 UCLASS_DRIVER(testacpi) = {
119 .id = UCLASS_TEST_ACPI,
122 /* Test ACPI get_name() */
123 static int dm_test_acpi_get_name(struct unit_test_state *uts)
125 char name[ACPI_NAME_MAX];
126 struct udevice *dev, *dev2, *i2c, *spi, *serial, *timer, *sound;
127 struct udevice *pci, *root;
129 /* Test getting the name from the driver */
130 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
131 ut_assertok(acpi_get_name(dev, name));
132 ut_asserteq_str(ACPI_TEST_DEV_NAME, name);
134 /* Test getting the name from the device tree */
135 ut_assertok(uclass_get_device_by_name(UCLASS_TEST_FDT, "a-test",
137 ut_assertok(acpi_get_name(dev2, name));
138 ut_asserteq_str("GHIJ", name);
140 /* Test getting the name from acpi_device_get_name() */
141 ut_assertok(uclass_first_device(UCLASS_I2C, &i2c));
142 ut_assertok(acpi_get_name(i2c, name));
143 ut_asserteq_str("I2C0", name);
145 ut_assertok(uclass_first_device(UCLASS_SPI, &spi));
146 ut_assertok(acpi_get_name(spi, name));
147 ut_asserteq_str("SPI0", name);
149 /* The uart has no sequence number, so this should fail */
150 ut_assertok(uclass_first_device(UCLASS_SERIAL, &serial));
151 ut_asserteq(-ENXIO, acpi_get_name(serial, name));
153 /* ACPI doesn't know about the timer */
154 ut_assertok(uclass_first_device(UCLASS_TIMER, &timer));
155 ut_asserteq(-ENOENT, acpi_get_name(timer, name));
157 /* May as well test the rest of the cases */
158 ut_assertok(uclass_first_device(UCLASS_SOUND, &sound));
159 ut_assertok(acpi_get_name(sound, name));
160 ut_asserteq_str("HDAS", name);
162 ut_assertok(uclass_first_device(UCLASS_PCI, &pci));
163 ut_assertok(acpi_get_name(pci, name));
164 ut_asserteq_str("PCI0", name);
166 ut_assertok(uclass_first_device(UCLASS_ROOT, &root));
167 ut_assertok(acpi_get_name(root, name));
168 ut_asserteq_str("\\_SB", name);
170 /* Note that we don't have tests for acpi_name_from_id() */
174 DM_TEST(dm_test_acpi_get_name, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
176 /* Test acpi_get_table_revision() */
177 static int dm_test_acpi_get_table_revision(struct unit_test_state *uts)
179 ut_asserteq(1, acpi_get_table_revision(ACPITAB_MCFG));
180 ut_asserteq(2, acpi_get_table_revision(ACPITAB_RSDP));
181 ut_asserteq(4, acpi_get_table_revision(ACPITAB_TPM2));
182 ut_asserteq(-EINVAL, acpi_get_table_revision(ACPITAB_COUNT));
186 DM_TEST(dm_test_acpi_get_table_revision,
187 DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
189 /* Test acpi_create_dmar() */
190 static int dm_test_acpi_create_dmar(struct unit_test_state *uts)
192 struct acpi_dmar dmar;
195 ut_assertok(uclass_first_device(UCLASS_CPU, &cpu));
196 ut_assertnonnull(cpu);
197 ut_assertok(acpi_create_dmar(&dmar, DMAR_INTR_REMAP));
198 ut_asserteq(DMAR_INTR_REMAP, dmar.flags);
199 ut_asserteq(32 - 1, dmar.host_address_width);
203 DM_TEST(dm_test_acpi_create_dmar, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
205 /* Test acpi_fill_header() */
206 static int dm_test_acpi_fill_header(struct unit_test_state *uts)
208 struct acpi_table_header hdr;
210 /* Make sure these 5 fields are not changed */
214 hdr.aslc_revision = 0x44;
215 acpi_fill_header(&hdr, "ABCD");
217 ut_asserteq_mem("ABCD", hdr.signature, sizeof(hdr.signature));
218 ut_asserteq(0x11, hdr.length);
219 ut_asserteq(0x22, hdr.revision);
220 ut_asserteq(0x33, hdr.checksum);
221 ut_asserteq_mem(OEM_ID, hdr.oem_id, sizeof(hdr.oem_id));
222 ut_asserteq_mem(OEM_TABLE_ID, hdr.oem_table_id,
223 sizeof(hdr.oem_table_id));
224 ut_asserteq(U_BOOT_BUILD_DATE, hdr.oem_revision);
225 ut_asserteq_mem(ASLC_ID, hdr.aslc_id, sizeof(hdr.aslc_id));
226 ut_asserteq(0x44, hdr.aslc_revision);
230 DM_TEST(dm_test_acpi_fill_header, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
232 /* Test ACPI write_tables() */
233 static int dm_test_acpi_write_tables(struct unit_test_state *uts)
235 struct acpi_dmar *dmar;
240 buf = malloc(BUF_SIZE);
241 ut_assertnonnull(buf);
243 acpi_setup_base_tables(&ctx, buf);
245 ut_assertok(acpi_write_dev_tables(&ctx));
248 * We should have three dmar tables, one for each
249 * "denx,u-boot-acpi-test" device
251 ut_asserteq_ptr(dmar + 3, ctx.current);
252 ut_asserteq(DMAR_INTR_REMAP, dmar->flags);
253 ut_asserteq(32 - 1, dmar->host_address_width);
255 ut_asserteq(DMAR_INTR_REMAP, dmar[1].flags);
256 ut_asserteq(32 - 1, dmar[1].host_address_width);
258 ut_asserteq(DMAR_INTR_REMAP, dmar[2].flags);
259 ut_asserteq(32 - 1, dmar[2].host_address_width);
261 /* Check that the pointers were added correctly */
262 for (i = 0; i < 3; i++) {
263 ut_asserteq(map_to_sysmem(dmar + i), ctx.rsdt->entry[i]);
264 ut_asserteq(map_to_sysmem(dmar + i), ctx.xsdt->entry[i]);
266 ut_asserteq(0, ctx.rsdt->entry[3]);
267 ut_asserteq(0, ctx.xsdt->entry[3]);
271 DM_TEST(dm_test_acpi_write_tables, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
273 /* Test basic ACPI functions */
274 static int dm_test_acpi_basic(struct unit_test_state *uts)
278 /* Check align works */
279 ctx.current = (void *)5;
281 ut_asserteq_ptr((void *)16, ctx.current);
283 /* Check that align does nothing if already aligned */
285 ut_asserteq_ptr((void *)16, ctx.current);
287 ut_asserteq_ptr((void *)64, ctx.current);
289 ut_asserteq_ptr((void *)64, ctx.current);
291 /* Check incrementing */
293 ut_asserteq_ptr((void *)67, ctx.current);
294 acpi_inc_align(&ctx, 3);
295 ut_asserteq_ptr((void *)80, ctx.current);
299 DM_TEST(dm_test_acpi_basic, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
301 /* Test acpi_setup_base_tables */
302 static int dm_test_acpi_setup_base_tables(struct unit_test_state *uts)
304 struct acpi_rsdp *rsdp;
305 struct acpi_rsdt *rsdt;
306 struct acpi_xsdt *xsdt;
311 * Use an unaligned address deliberately, by allocating an aligned
312 * address and then adding 4 to it
314 buf = memalign(64, BUF_SIZE);
315 ut_assertnonnull(buf);
316 acpi_setup_base_tables(&ctx, buf + 4);
317 ut_asserteq(map_to_sysmem(PTR_ALIGN(buf + 4, 16)), gd->arch.acpi_start);
320 ut_asserteq_ptr(rsdp, ctx.rsdp);
321 ut_asserteq_mem(RSDP_SIG, rsdp->signature, sizeof(rsdp->signature));
322 ut_asserteq(sizeof(*rsdp), rsdp->length);
323 ut_assertok(table_compute_checksum(rsdp, 20));
324 ut_assertok(table_compute_checksum(rsdp, sizeof(*rsdp)));
326 rsdt = PTR_ALIGN((void *)rsdp + sizeof(*rsdp), 16);
327 ut_asserteq_ptr(rsdt, ctx.rsdt);
328 ut_asserteq_mem("RSDT", rsdt->header.signature, ACPI_NAME_LEN);
329 ut_asserteq(sizeof(*rsdt), rsdt->header.length);
330 ut_assertok(table_compute_checksum(rsdt, sizeof(*rsdt)));
332 xsdt = PTR_ALIGN((void *)rsdt + sizeof(*rsdt), 16);
333 ut_asserteq_ptr(xsdt, ctx.xsdt);
334 ut_asserteq_mem("XSDT", xsdt->header.signature, ACPI_NAME_LEN);
335 ut_asserteq(sizeof(*xsdt), xsdt->header.length);
336 ut_assertok(table_compute_checksum(xsdt, sizeof(*xsdt)));
338 end = PTR_ALIGN((void *)xsdt + sizeof(*xsdt), 64);
339 ut_asserteq_ptr(end, ctx.current);
341 ut_asserteq(map_to_sysmem(rsdt), rsdp->rsdt_address);
342 ut_asserteq(map_to_sysmem(xsdt), rsdp->xsdt_address);
346 DM_TEST(dm_test_acpi_setup_base_tables,
347 DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
349 /* Test 'acpi list' command */
350 static int dm_test_acpi_cmd_list(struct unit_test_state *uts)
356 buf = memalign(16, BUF_SIZE);
357 ut_assertnonnull(buf);
358 acpi_setup_base_tables(&ctx, buf);
360 ut_assertok(acpi_write_dev_tables(&ctx));
362 console_record_reset();
363 run_command("acpi list", 0);
364 addr = (ulong)map_to_sysmem(buf);
365 ut_assert_nextline("ACPI tables start at %lx", addr);
366 ut_assert_nextline("RSDP %08lx %06lx (v02 U-BOOT)", addr,
367 sizeof(struct acpi_rsdp));
368 addr = ALIGN(addr + sizeof(struct acpi_rsdp), 16);
369 ut_assert_nextline("RSDT %08lx %06lx (v01 U-BOOT U-BOOTBL %u INTL 0)",
370 addr, sizeof(struct acpi_table_header) +
371 3 * sizeof(u32), U_BOOT_BUILD_DATE);
372 addr = ALIGN(addr + sizeof(struct acpi_rsdt), 16);
373 ut_assert_nextline("XSDT %08lx %06lx (v01 U-BOOT U-BOOTBL %u INTL 0)",
374 addr, sizeof(struct acpi_table_header) +
375 3 * sizeof(u64), U_BOOT_BUILD_DATE);
376 addr = ALIGN(addr + sizeof(struct acpi_xsdt), 64);
377 ut_assert_nextline("DMAR %08lx %06lx (v01 U-BOOT U-BOOTBL %u 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 %u INTL 0)",
381 addr, sizeof(struct acpi_dmar), U_BOOT_BUILD_DATE);
382 addr = ALIGN(addr + sizeof(struct acpi_dmar), 16);
383 ut_assert_nextline("DMAR %08lx %06lx (v01 U-BOOT U-BOOTBL %u INTL 0)",
384 addr, sizeof(struct acpi_dmar), U_BOOT_BUILD_DATE);
385 ut_assert_console_end();
389 DM_TEST(dm_test_acpi_cmd_list, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
391 /* Test 'acpi dump' command */
392 static int dm_test_acpi_cmd_dump(struct unit_test_state *uts)
398 buf = memalign(16, BUF_SIZE);
399 ut_assertnonnull(buf);
400 acpi_setup_base_tables(&ctx, buf);
402 ut_assertok(acpi_write_dev_tables(&ctx));
404 /* First search for a non-existent table */
405 console_record_reset();
406 run_command("acpi dump rdst", 0);
407 ut_assert_nextline("Table 'RDST' not found");
408 ut_assert_console_end();
410 /* Now a real table */
411 console_record_reset();
412 run_command("acpi dump dmar", 0);
413 addr = ALIGN(map_to_sysmem(ctx.xsdt) + sizeof(struct acpi_xsdt), 64);
414 ut_assert_nextline("DMAR @ %08lx", addr);
415 ut_assert_nextlines_are_dump(0x30);
416 ut_assert_console_end();
420 DM_TEST(dm_test_acpi_cmd_dump, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
422 /* Test acpi_device_path() */
423 static int dm_test_acpi_device_path(struct unit_test_state *uts)
425 struct testacpi_platdata *plat;
426 char buf[ACPI_PATH_MAX];
427 struct udevice *dev, *child;
429 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
430 ut_assertok(acpi_device_path(dev, buf, sizeof(buf)));
431 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME, buf);
433 /* Test running out of space */
435 ut_asserteq(-ENOSPC, acpi_device_path(dev, buf, 5));
436 ut_asserteq('\0', buf[5]);
438 /* Test a three-component name */
439 ut_assertok(device_first_child_err(dev, &child));
440 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
441 ut_asserteq_str("\\_SB." ACPI_TEST_DEV_NAME "." ACPI_TEST_CHILD_NAME,
444 /* Test handling of a device which doesn't produce a name */
445 plat = dev_get_platdata(dev);
446 plat->no_name = true;
447 ut_assertok(acpi_device_path(child, buf, sizeof(buf)));
448 ut_asserteq_str("\\_SB." ACPI_TEST_CHILD_NAME, buf);
450 /* Test handling of a device which returns an error */
451 plat = dev_get_platdata(dev);
452 plat->return_error = true;
453 ut_asserteq(-EINVAL, acpi_device_path(child, buf, sizeof(buf)));
457 DM_TEST(dm_test_acpi_device_path, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
459 /* Test acpi_device_status() */
460 static int dm_test_acpi_device_status(struct unit_test_state *uts)
464 ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
465 ut_asserteq(ACPI_DSTATUS_ALL_ON, acpi_device_status(dev));
469 DM_TEST(dm_test_acpi_device_status, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
471 /* Test acpi_fill_ssdt() */
472 static int dm_test_acpi_fill_ssdt(struct unit_test_state *uts)
477 buf = malloc(BUF_SIZE);
478 ut_assertnonnull(buf);
481 buf[4] = 'z'; /* sentinel */
482 ut_assertok(acpi_fill_ssdt(&ctx));
485 * These values come from acpi-test2's acpi-ssdt-test-data property.
486 * This device comes first because of u-boot,acpi-ssdt-order
488 ut_asserteq('c', buf[0]);
489 ut_asserteq('d', buf[1]);
491 /* These values come from acpi-test's acpi-ssdt-test-data property */
492 ut_asserteq('a', buf[2]);
493 ut_asserteq('b', buf[3]);
495 ut_asserteq('z', buf[4]);
499 DM_TEST(dm_test_acpi_fill_ssdt, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
501 /* Test acpi_inject_dsdt() */
502 static int dm_test_acpi_inject_dsdt(struct unit_test_state *uts)
507 buf = malloc(BUF_SIZE);
508 ut_assertnonnull(buf);
511 buf[4] = 'z'; /* sentinel */
512 ut_assertok(acpi_inject_dsdt(&ctx));
515 * These values come from acpi-test's acpi-dsdt-test-data property.
516 * There is no u-boot,acpi-dsdt-order so device-tree order is used.
518 ut_asserteq('h', buf[0]);
519 ut_asserteq('i', buf[1]);
521 /* These values come from acpi-test's acpi-dsdt-test-data property */
522 ut_asserteq('j', buf[2]);
523 ut_asserteq('k', buf[3]);
525 ut_asserteq('z', buf[4]);
529 DM_TEST(dm_test_acpi_inject_dsdt, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
531 /* Test 'acpi items' command */
532 static int dm_test_acpi_cmd_items(struct unit_test_state *uts)
537 buf = malloc(BUF_SIZE);
538 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();
549 ut_assertok(acpi_inject_dsdt(&ctx));
550 console_record_reset();
551 run_command("acpi items", 0);
552 ut_assert_nextline("dev 'acpi-test', type 2, size 2");
553 ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
554 ut_assert_console_end();
556 console_record_reset();
557 run_command("acpi items -d", 0);
558 ut_assert_nextline("dev 'acpi-test', type 2, size 2");
559 ut_assert_nextlines_are_dump(2);
560 ut_assert_nextline("%s", "");
561 ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
562 ut_assert_nextlines_are_dump(2);
563 ut_assert_nextline("%s", "");
564 ut_assert_console_end();
568 DM_TEST(dm_test_acpi_cmd_items, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);