Revert "Merge tag 'dm-pull-20jul20' of git://git.denx.de/u-boot-dm"
[platform/kernel/u-boot.git] / test / dm / acpi.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Tests for ACPI table generation
4  *
5  * Copyright 2019 Google LLC
6  * Written by Simon Glass <sjg@chromium.org>
7  */
8
9 #include <common.h>
10 #include <console.h>
11 #include <dm.h>
12 #include <malloc.h>
13 #include <mapmem.h>
14 #include <version.h>
15 #include <tables_csum.h>
16 #include <version.h>
17 #include <acpi/acpigen.h>
18 #include <acpi/acpi_device.h>
19 #include <acpi/acpi_table.h>
20 #include <dm/acpi.h>
21 #include <dm/test.h>
22 #include <test/ut.h>
23 #include "acpi.h"
24
25 #define BUF_SIZE                4096
26
27 /**
28  * struct testacpi_platdata - Platform data for the test ACPI device
29  *
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
32  */
33 struct testacpi_platdata {
34         bool return_error;
35         bool no_name;
36 };
37
38 static int testacpi_write_tables(const struct udevice *dev,
39                                  struct acpi_ctx *ctx)
40 {
41         struct acpi_dmar *dmar;
42         int ret;
43
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);
48         if (ret)
49                 return log_msg_ret("add", ret);
50
51         return 0;
52 }
53
54 static int testacpi_get_name(const struct udevice *dev, char *out_name)
55 {
56         struct testacpi_platdata *plat = dev_get_platdata(dev);
57
58         if (plat->return_error)
59                 return -EINVAL;
60         if (plat->no_name) {
61                 *out_name = '\0';
62                 return 0;
63         }
64         if (device_get_uclass_id(dev->parent) == UCLASS_TEST_ACPI)
65                 return acpi_copy_name(out_name, ACPI_TEST_CHILD_NAME);
66         else
67                 return acpi_copy_name(out_name, ACPI_TEST_DEV_NAME);
68 }
69
70 static int testacpi_fill_ssdt(const struct udevice *dev, struct acpi_ctx *ctx)
71 {
72         const char *data;
73
74         data = dev_read_string(dev, "acpi-ssdt-test-data");
75         if (data) {
76                 while (*data)
77                         acpigen_emit_byte(ctx, *data++);
78         }
79
80         return 0;
81 }
82
83 static int testacpi_inject_dsdt(const struct udevice *dev, struct acpi_ctx *ctx)
84 {
85         const char *data;
86
87         data = dev_read_string(dev, "acpi-dsdt-test-data");
88         if (data) {
89                 while (*data)
90                         acpigen_emit_byte(ctx, *data++);
91         }
92
93         return 0;
94 }
95
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,
101 };
102
103 static const struct udevice_id testacpi_ids[] = {
104         { .compatible = "denx,u-boot-acpi-test" },
105         { }
106 };
107
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)
115 };
116
117 UCLASS_DRIVER(testacpi) = {
118         .name           = "testacpi",
119         .id             = UCLASS_TEST_ACPI,
120 };
121
122 /* Test ACPI get_name() */
123 static int dm_test_acpi_get_name(struct unit_test_state *uts)
124 {
125         char name[ACPI_NAME_MAX];
126         struct udevice *dev, *dev2, *i2c, *spi, *serial, *timer, *sound;
127         struct udevice *pci, *root;
128
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);
133
134         /* Test getting the name from the device tree */
135         ut_assertok(uclass_get_device_by_name(UCLASS_TEST_FDT, "a-test",
136                                               &dev2));
137         ut_assertok(acpi_get_name(dev2, name));
138         ut_asserteq_str("GHIJ", name);
139
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);
144
145         ut_assertok(uclass_first_device(UCLASS_SPI, &spi));
146         ut_assertok(acpi_get_name(spi, name));
147         ut_asserteq_str("SPI0", name);
148
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));
152
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));
156
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);
161
162         ut_assertok(uclass_first_device(UCLASS_PCI, &pci));
163         ut_assertok(acpi_get_name(pci, name));
164         ut_asserteq_str("PCI0", name);
165
166         ut_assertok(uclass_first_device(UCLASS_ROOT, &root));
167         ut_assertok(acpi_get_name(root, name));
168         ut_asserteq_str("\\_SB", name);
169
170         /* Note that we don't have tests for acpi_name_from_id() */
171
172         return 0;
173 }
174 DM_TEST(dm_test_acpi_get_name, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
175
176 /* Test acpi_get_table_revision() */
177 static int dm_test_acpi_get_table_revision(struct unit_test_state *uts)
178 {
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));
183
184         return 0;
185 }
186 DM_TEST(dm_test_acpi_get_table_revision,
187         DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
188
189 /* Test acpi_create_dmar() */
190 static int dm_test_acpi_create_dmar(struct unit_test_state *uts)
191 {
192         struct acpi_dmar dmar;
193
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);
197
198         return 0;
199 }
200 DM_TEST(dm_test_acpi_create_dmar, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
201
202 /* Test acpi_fill_header() */
203 static int dm_test_acpi_fill_header(struct unit_test_state *uts)
204 {
205         struct acpi_table_header hdr;
206
207         /* Make sure these 5 fields are not changed */
208         hdr.length = 0x11;
209         hdr.revision = 0x22;
210         hdr.checksum = 0x33;
211         hdr.aslc_revision = 0x44;
212         acpi_fill_header(&hdr, "ABCD");
213
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);
224
225         return 0;
226 }
227 DM_TEST(dm_test_acpi_fill_header, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
228
229 /* Test ACPI write_tables() */
230 static int dm_test_acpi_write_tables(struct unit_test_state *uts)
231 {
232         struct acpi_dmar *dmar;
233         struct acpi_ctx ctx;
234         void *buf;
235         int i;
236
237         buf = malloc(BUF_SIZE);
238         ut_assertnonnull(buf);
239
240         acpi_setup_base_tables(&ctx, buf);
241         dmar = ctx.current;
242         ut_assertok(acpi_write_dev_tables(&ctx));
243
244         /*
245          * We should have three dmar tables, one for each
246          * "denx,u-boot-acpi-test" device
247          */
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);
251
252         ut_asserteq(DMAR_INTR_REMAP, dmar[1].flags);
253         ut_asserteq(32 - 1, dmar[1].host_address_width);
254
255         ut_asserteq(DMAR_INTR_REMAP, dmar[2].flags);
256         ut_asserteq(32 - 1, dmar[2].host_address_width);
257
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]);
262         }
263         ut_asserteq(0, ctx.rsdt->entry[3]);
264         ut_asserteq(0, ctx.xsdt->entry[3]);
265
266         return 0;
267 }
268 DM_TEST(dm_test_acpi_write_tables, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
269
270 /* Test basic ACPI functions */
271 static int dm_test_acpi_basic(struct unit_test_state *uts)
272 {
273         struct acpi_ctx ctx;
274
275         /* Check align works */
276         ctx.current = (void *)5;
277         acpi_align(&ctx);
278         ut_asserteq_ptr((void *)16, ctx.current);
279
280         /* Check that align does nothing if already aligned */
281         acpi_align(&ctx);
282         ut_asserteq_ptr((void *)16, ctx.current);
283         acpi_align64(&ctx);
284         ut_asserteq_ptr((void *)64, ctx.current);
285         acpi_align64(&ctx);
286         ut_asserteq_ptr((void *)64, ctx.current);
287
288         /* Check incrementing */
289         acpi_inc(&ctx, 3);
290         ut_asserteq_ptr((void *)67, ctx.current);
291         acpi_inc_align(&ctx, 3);
292         ut_asserteq_ptr((void *)80, ctx.current);
293
294         return 0;
295 }
296 DM_TEST(dm_test_acpi_basic, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
297
298 /* Test acpi_setup_base_tables */
299 static int dm_test_acpi_setup_base_tables(struct unit_test_state *uts)
300 {
301         struct acpi_rsdp *rsdp;
302         struct acpi_rsdt *rsdt;
303         struct acpi_xsdt *xsdt;
304         struct acpi_ctx ctx;
305         void *buf, *end;
306
307         /*
308          * Use an unaligned address deliberately, by allocating an aligned
309          * address and then adding 4 to it
310          */
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);
315
316         rsdp = buf + 16;
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)));
322
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)));
328
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)));
334
335         end = PTR_ALIGN((void *)xsdt + sizeof(*xsdt), 64);
336         ut_asserteq_ptr(end, ctx.current);
337
338         ut_asserteq(map_to_sysmem(rsdt), rsdp->rsdt_address);
339         ut_asserteq(map_to_sysmem(xsdt), rsdp->xsdt_address);
340
341         return 0;
342 }
343 DM_TEST(dm_test_acpi_setup_base_tables,
344         DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
345
346 /* Test 'acpi list' command */
347 static int dm_test_acpi_cmd_list(struct unit_test_state *uts)
348 {
349         struct acpi_ctx ctx;
350         ulong addr;
351         void *buf;
352
353         buf = memalign(16, BUF_SIZE);
354         ut_assertnonnull(buf);
355         acpi_setup_base_tables(&ctx, buf);
356
357         ut_assertok(acpi_write_dev_tables(&ctx));
358
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 %u 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 %u 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 %u 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 %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         ut_assert_console_end();
383
384         return 0;
385 }
386 DM_TEST(dm_test_acpi_cmd_list, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
387
388 /* Test 'acpi dump' command */
389 static int dm_test_acpi_cmd_dump(struct unit_test_state *uts)
390 {
391         struct acpi_ctx ctx;
392         ulong addr;
393         void *buf;
394
395         buf = memalign(16, BUF_SIZE);
396         ut_assertnonnull(buf);
397         acpi_setup_base_tables(&ctx, buf);
398
399         ut_assertok(acpi_write_dev_tables(&ctx));
400
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();
406
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();
414
415         return 0;
416 }
417 DM_TEST(dm_test_acpi_cmd_dump, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
418
419 /* Test acpi_device_path() */
420 static int dm_test_acpi_device_path(struct unit_test_state *uts)
421 {
422         struct testacpi_platdata *plat;
423         char buf[ACPI_PATH_MAX];
424         struct udevice *dev, *child;
425
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);
429
430         /* Test running out of space */
431         buf[5] = '\0';
432         ut_asserteq(-ENOSPC, acpi_device_path(dev, buf, 5));
433         ut_asserteq('\0', buf[5]);
434
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,
439                         buf);
440
441         /* Test handling of a device which doesn't produce a name */
442         plat = dev_get_platdata(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);
446
447         /* Test handling of a device which returns an error */
448         plat = dev_get_platdata(dev);
449         plat->return_error = true;
450         ut_asserteq(-EINVAL, acpi_device_path(child, buf, sizeof(buf)));
451
452         return 0;
453 }
454 DM_TEST(dm_test_acpi_device_path, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
455
456 /* Test acpi_device_status() */
457 static int dm_test_acpi_device_status(struct unit_test_state *uts)
458 {
459         struct udevice *dev;
460
461         ut_assertok(uclass_first_device_err(UCLASS_TEST_ACPI, &dev));
462         ut_asserteq(ACPI_DSTATUS_ALL_ON, acpi_device_status(dev));
463
464         return 0;
465 }
466 DM_TEST(dm_test_acpi_device_status, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
467
468 /* Test acpi_fill_ssdt() */
469 static int dm_test_acpi_fill_ssdt(struct unit_test_state *uts)
470 {
471         struct acpi_ctx ctx;
472         u8 *buf;
473
474         buf = malloc(BUF_SIZE);
475         ut_assertnonnull(buf);
476
477         ctx.current = buf;
478         buf[4] = 'z';   /* sentinel */
479         ut_assertok(acpi_fill_ssdt(&ctx));
480
481         /*
482          * These values come from acpi-test2's acpi-ssdt-test-data property.
483          * This device comes first because of u-boot,acpi-ssdt-order
484          */
485         ut_asserteq('c', buf[0]);
486         ut_asserteq('d', buf[1]);
487
488         /* These values come from acpi-test's acpi-ssdt-test-data property */
489         ut_asserteq('a', buf[2]);
490         ut_asserteq('b', buf[3]);
491
492         ut_asserteq('z', buf[4]);
493
494         return 0;
495 }
496 DM_TEST(dm_test_acpi_fill_ssdt, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
497
498 /* Test acpi_inject_dsdt() */
499 static int dm_test_acpi_inject_dsdt(struct unit_test_state *uts)
500 {
501         struct acpi_ctx ctx;
502         u8 *buf;
503
504         buf = malloc(BUF_SIZE);
505         ut_assertnonnull(buf);
506
507         ctx.current = buf;
508         buf[4] = 'z';   /* sentinel */
509         ut_assertok(acpi_inject_dsdt(&ctx));
510
511         /*
512          * These values come from acpi-test's acpi-dsdt-test-data property.
513          * There is no u-boot,acpi-dsdt-order so device-tree order is used.
514          */
515         ut_asserteq('h', buf[0]);
516         ut_asserteq('i', buf[1]);
517
518         /* These values come from acpi-test's acpi-dsdt-test-data property */
519         ut_asserteq('j', buf[2]);
520         ut_asserteq('k', buf[3]);
521
522         ut_asserteq('z', buf[4]);
523
524         return 0;
525 }
526 DM_TEST(dm_test_acpi_inject_dsdt, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);
527
528 /* Test 'acpi items' command */
529 static int dm_test_acpi_cmd_items(struct unit_test_state *uts)
530 {
531         struct acpi_ctx ctx;
532         void *buf;
533
534         buf = malloc(BUF_SIZE);
535         ut_assertnonnull(buf);
536
537         ctx.current = buf;
538         ut_assertok(acpi_fill_ssdt(&ctx));
539         console_record_reset();
540         run_command("acpi items", 0);
541         ut_assert_nextline("dev 'acpi-test', type 1, size 2");
542         ut_assert_nextline("dev 'acpi-test2', type 1, size 2");
543         ut_assert_console_end();
544
545         ctx.current = buf;
546         ut_assertok(acpi_inject_dsdt(&ctx));
547         console_record_reset();
548         run_command("acpi items", 0);
549         ut_assert_nextline("dev 'acpi-test', type 2, size 2");
550         ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
551         ut_assert_console_end();
552
553         console_record_reset();
554         run_command("acpi items -d", 0);
555         ut_assert_nextline("dev 'acpi-test', type 2, size 2");
556         ut_assert_nextlines_are_dump(2);
557         ut_assert_nextline("%s", "");
558         ut_assert_nextline("dev 'acpi-test2', type 2, size 2");
559         ut_assert_nextlines_are_dump(2);
560         ut_assert_nextline("%s", "");
561         ut_assert_console_end();
562
563         return 0;
564 }
565 DM_TEST(dm_test_acpi_cmd_items, DM_TESTF_SCAN_PDATA | DM_TESTF_SCAN_FDT);