hw: acpi: support SPCR rev. 3 & UART clock freq in ARM SPCR
cover hw: acpi: support SPCR rev. 3 & UART clock freq in ARM SPCR
This series fixes erroneous building of ACPI SPCR tables in hw/acpi/aml-build.c, where the UART clock frequency field is omitted in revision 3 tables despite being present since revision 3 of the specification.
The last three patches update the SPCR table for the AArch64 virt machine to revision 3, exposing the UART clock frequency, which was not previously available via ACPI, to the guest.
Thanks,
Vadim
Vadim Chichikalyuk (4):
hw: acpi: add support for SPCR revision 3
tests: acpi: whitelist expected blobs
hw: arm: acpi: add UART clock frequency to SPCR table
tests: acpi: update expected blobs
hw/acpi/aml-build.c | 20 +++++++++++--------- hw/arm/virt-acpi-build.c | 5 +++-- tests/data/acpi/aarch64/virt/SPCR | Bin 80 -> 80 bytes 3 files changed, 14 insertions(+), 11 deletions(-)
Signature · 1 line
2.39.5 (Apple Git-154)
PATCH 1/4 hw: acpi: add support for SPCR revision 3
The UART clock frequency field of the SPCR table was added in revision 3. Currently, build_spcr() treats revision 3 tables the same as revision 2 and only includes this field in revision 4 tables.
Fix build_spcr() to include the clock frequency field in revision 3 tables. Per the specification, this is the only change between revisions 2 and 3.
--- hw/acpi/aml-build.c | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-)
hw/acpi/aml-build.c +11 -9
@@ -2123,20 +2123,22 @@ void build_spcr(GArray *table_data, BIOSLinker *linker,build_append_int_noprefix (table_data, f->pci_flags,4 );/* PCI Segment */ build_append_int_noprefix (table_data, f->pci_segment,1 ); -if (rev <4 ) { +if (rev <3 ) {/* Reserved */ build_append_int_noprefix (table_data,0 ,4 ); }else {/* UartClkFreq */ build_append_int_noprefix (table_data, f->uart_clk_freq,4 ); -/* PreciseBaudrate */ -build_append_int_noprefix (table_data, f->precise_baudrate,4 ); -/* NameSpaceStringLength */ -build_append_int_noprefix (table_data, f->namespace_string_length,2 ); -/* NameSpaceStringOffset */ -build_append_int_noprefix (table_data, f->namespace_string_offset,2 ); -/* NamespaceString[] */ -g_array_append_vals (table_data, name, f->namespace_string_length); +if (rev >=4 ) { +/* PreciseBaudrate */ +build_append_int_noprefix (table_data, f->precise_baudrate,4 ); +/* NameSpaceStringLength */ +build_append_int_noprefix (table_data, f->namespace_string_length,2 ); +/* NameSpaceStringOffset */ +build_append_int_noprefix (table_data, f->namespace_string_offset,2 ); +/* NamespaceString[] */ +g_array_append_vals (table_data, name, f->namespace_string_length); + } }acpi_table_end (linker, &table); }
Signature · 1 line
2.39.5 (Apple Git-154)
Re: [PATCH 1/4] hw: acpi: add support for SPCR revision 3
Quoted 3 lines · On Fri, 18 Jul 2025 19:20:42 +0300 Vadim Chichikalyuk <[email protected]>…
The UART clock frequency field of the SPCR table was added in revision 3. Currently,
build_spcr()treats revision 3 tables the same as revision 2 and only includes this field in revision 4 tables.
Given this isn't in the ACPI spec, I'd make sure you have a reference to the MS documentation for this. I think it is this one:
https://learn.microsoft.com/en-us/windows-hardware/drivers/bringup/serial-port-console-redirection-table
Quoted 3 lines
Fix
build_spcr()to include the clock frequency field in revision 3 tables. Per the specification, this is the only change between revisions 2 and 3.
Maybe say why this has never mattered - I think because no code actually uses revision 3. Prior to this series, arm-virt and loongarch were 2 and riscv-virt was 4.
Quoted 2 lines
Signed-off-by Vadim Chichikalyuk <[email protected]>
Code looks fine so with those additions to the description
Quoted 19 lines
--- hw/acpi/aml-build.c | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-)hw/acpi/aml-build.c +1
-1@@ -2123,20 +2123,22 @@ void build_spcr(GArray *table_data, BIOSLinker *linker,build_append_int_noprefix (table_data, f->pci_flags,4 );/* PCI Segment */ build_append_int_noprefix (table_data, f->pci_segment,1 ); -if (rev <4 ) { +if (rev <3 ) {/* Reserved */ build_append_int_noprefix (table_data,0 ,4 ); }else {/* UartClkFreq */ build_append_int_noprefix (table_data, f->uart_clk_freq,4 );
hw/acpi/aml-build.c void build_spcr(GArray *table_data, BIOSLinker *linker, · line 2133
Quoted 10 lines
hw/acpi/aml-build.c +2
-8-/* PreciseBaudrate */ -build_append_int_noprefix (table_data, f->precise_baudrate,4 ); -/* NameSpaceStringLength */ -build_append_int_noprefix (table_data, f->namespace_string_length,2 ); -/* NameSpaceStringOffset */ -build_append_int_noprefix (table_data, f->namespace_string_offset,2 ); -/* NamespaceString[] */ -g_array_append_vals (table_data, name, f->namespace_string_length); +if (rev >=4 ) { +/* PreciseBaudrate */
Obviously historical, but this does seem like a lot of unnecessary comments given the clear naming of the input parameters!
Quoted 11 lines
hw/acpi/aml-build.c +8
-0+build_append_int_noprefix (table_data, f->precise_baudrate,4 ); +/* NameSpaceStringLength */ +build_append_int_noprefix (table_data, f->namespace_string_length,2 ); +/* NameSpaceStringOffset */ +build_append_int_noprefix (table_data, f->namespace_string_offset,2 ); +/* NamespaceString[] */ +g_array_append_vals (table_data, name, f->namespace_string_length); + } }acpi_table_end (linker, &table); }
Re: [PATCH 1/4] hw: acpi: add support for SPCR revision 3
Quoted 6 lines · Jonathan Cameron via
On Fri, 18 Jul 2025 19:20:42 +0300
Vadim Chichikalyuk <[email protected]> wrote:
Quoted 7 lines
Quoted 3 lines
The UART clock frequency field of the SPCR table was added in revision 3. Currently,
build_spcr()treats revision 3 tables the same as revision 2 and only includes this field in revision 4 tables.Given this isn't in the ACPI spec, I'd make sure you have a reference to the MS documentation for this. I think it is this one:
https://learn.microsoft.com/en-us/windows-hardware/drivers/bringup/serial-port-console-redirection-table
I’m going off of the following line in the revision history table on that MS page, suggesting there was a revision 3 with just the clock frequency added:
"Changed Table Revision to 3 and created field for UART Clock Frequency. Edited formatting."
Quoted 25 lines
Quoted 25 lines
---
hw/acpi/aml-build.c| 20 +++++++++++---------1 file changed, 11 insertions(+), 9 deletions(-)hw/acpi/aml-build.c +1
-6@@ -2123,20 +2123,22 @@ void build_spcr(GArray *table_data, BIOSLinker *linker,build_append_int_noprefix (table_data, f->pci_flags,4 );/* PCI Segment */ build_append_int_noprefix (table_data, f->pci_segment,1 ); -if (rev <4 ) { +if (rev <3 ) {/* Reserved */ build_append_int_noprefix (table_data,0 ,4 ); }else {/* UartClkFreq */ build_append_int_noprefix (table_data, f->uart_clk_freq,4 ); -/* PreciseBaudrate */ -build_append_int_noprefix (table_data, f->precise_baudrate,4 ); -/* NameSpaceStringLength */ -build_append_int_noprefix (table_data, f->namespace_string_length,2 ); -/* NameSpaceStringOffset */
Quoted 9 lines
hw/acpi/aml-build.c void build_spcr(GArray *table_data, BIOSLinker *linker, · line 2133
Quoted 5 lines
hw/acpi/aml-build.c +2
-3-build_append_int_noprefix (table_data, f->namespace_string_offset,2 ); -/* NamespaceString[] */ -g_array_append_vals (table_data, name, f->namespace_string_length); +if (rev >=4 ) { +/* PreciseBaudrate */ Obviously historical, but this does seem like a lot of unnecessary comments given the clear naming of the input parameters!
Absolutely, I’ll remove those that don’t add any useful information in v2.
PATCH 2/4 tests: acpi: whitelist expected blobs
In reply to Vadim Chichikalyuk--- tests/qtest/bios-tables-test-allowed-diff.h | 1 + 1 file changed, 1 insertion(+)
tests/qtest/bios-tables-test-allowed-diff.h +1 -0
@@ -1 +1,2 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/aarch64/virt/SPCR",
Signature · 1 line
2.39.5 (Apple Git-154)
Re: [PATCH 2/4] tests: acpi: whitelist expected blobs
tests/qtest/bios-tables-test-allowed-diff.h line 2
Quoted 13 lines · On Fri, 18 Jul 2025 19:20:43 +0300 Vadim Chichikalyuk <[email protected]>…
Signed-off-by Vadim Chichikalyuk <[email protected]>--- tests/qtest/bios-tables-test-allowed-diff.h | 1 + 1 file changed, 1 insertion(+)tests/qtest/bios-tables-test-allowed-diff.h +1
-0@@ -1 +1,2 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/aarch64/virt/SPCR",
Fix that.
PATCH 3/4 hw: arm: acpi: add UART clock frequency to SPCR table
In reply to Vadim ChichikalyukOn the ARM virt machine, there is currently no way to programmatically discover the frequency of the UART reference clock solely through the use of UEFI/ACPI (without the DTB). The SPCR table can include this information as of revision 3.
Bump the revision to 3 and add the clock frequency of 24 MHz to the table.
--- hw/arm/virt-acpi-build.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
hw/arm/virt-acpi-build.c +3 -2
@@ -559,12 +559,13 @@ spcr_setup(GArray *table_data, BIOSLinker *linker, VirtMachineState *vms) .pci_function = 0, .pci_flags = 0, .pci_segment = 0, + .uart_clk_freq = 24000000, /* 24MHz */ };/* -* Passing NULL as the SPCR Table for Revision 2 doesn't support +* Passing NULL as the SPCR Table for Revision 3 doesn't support * NameSpaceString. */ -build_spcr (table_data, linker, &serial,2 , vms->oem_id, vms->oem_table_id, +build_spcr (table_data, linker, &serial,3 , vms->oem_id, vms->oem_table_id,NULL ); }
Signature · 1 line
2.39.5 (Apple Git-154)
Re: [PATCH 3/4] hw: arm: acpi: add UART clock frequency to SPCR table
Quoted 6 lines · On Fri, 18 Jul 2025 19:20:44 +0300 Vadim Chichikalyuk <[email protected]>…
On the ARM virt machine, there is currently no way to programmatically discover the frequency of the UART reference clock solely through the use of UEFI/ACPI (without the DTB). The SPCR table can include this information as of revision 3.
Bump the revision to 3 and add the clock frequency of 24 MHz to the table.
Maybe add something on why you aren't just skipping forwards to 4 and filling in the rest of the stuff?
Quoted 2 lines
Signed-off-by Vadim Chichikalyuk <[email protected]>
Quoted 24 lines
--- hw/arm/virt-acpi-build.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)hw/arm/virt-acpi-build.c +3
-2@@ -559,12 +559,13 @@ spcr_setup(GArray *table_data, BIOSLinker *linker, VirtMachineState *vms) .pci_function = 0, .pci_flags = 0, .pci_segment = 0, + .uart_clk_freq = 24000000, /* 24MHz */ };/* -* Passing NULL as the SPCR Table for Revision 2 doesn't support +* Passing NULL as the SPCR Table for Revision 3 doesn't support * NameSpaceString. */ -build_spcr (table_data, linker, &serial,2 , vms->oem_id, vms->oem_table_id, +build_spcr (table_data, linker, &serial,3 , vms->oem_id, vms->oem_table_id,NULL ); }
Re: [PATCH 3/4] hw: arm: acpi: add UART clock frequency to SPCR table
Quoted 11 lines · Jonathan Cameron
Quoted 5 lines · On Fri, 18 Jul 2025 19:20:44 +0300 Vadim Chichikalyuk <[email protected]>…
On the ARM virt machine, there is currently no way to programmatically discover the frequency of the UART reference clock solely through the use of UEFI/ACPI (without the DTB). The SPCR table can include this information as of revision 3.
Quoted 4 lines
Quoted 1 line
Bump the revision to 3 and add the clock frequency of 24 MHz to the table.
Maybe add something on why you aren't just skipping forwards to 4 and filling in the rest of the stuff?
Haven’t really considered that – you’re right, might as well upgrade it to revision 4.
Based on build_dsdt() and acpi_dsdt_add_uart(), the NamespaceString would be “\_SB.COM0”, right? Although, for some reason, it’s just “.” for RISC-V virt (indicating that there isn’t a corresponding device in the ACPI namespace), despite there being entries for the UART in the DSDT, just as for ARM?
The relevant lines, for reference (hw/arm/virt-acpi-build.c):
scope = aml_scope("\\_SB");acpi_dsdt_add_uart(scope, &memmap[VIRT_UART0], (irqmap[VIRT_UART0] + ARM_SPI_BASE), 0);
static void acpi_dsdt_add_uart(Aml *scope, const MemMapEntry *uart_memmap, uint32_t uart_irq) {
Aml *dev = aml_device("COM%d", uartidx);
...
}Thanks for the review,
Vadim
PATCH 4/4 tests: acpi: update expected blobs
In reply to Vadim ChichikalyukPrevious patch changed the SPCR ACPI table for AArch64 virt:
@@ -15,2 +15,2 @@
-[008h 0008 001h] Revision : 02 -[009h 0009 001h] Checksum : B1 +[008h 0008 001h] Revision : 03 +[009h 0009 001h] Checksum : 0B
@@ -49 +49 @@
-[04Ch 0076 004h] Reserved : 00000000
+[04Ch 0076 004h] Reserved : 016E3600
@@ -53 +53 @@
-0000: 53 50 43 52 50 00 00 00 02 B1 42 4F 43 48 53 20 // SPCRP.....BOCHS +0000: 53 50 43 52 50 00 00 00 03 0B 42 4F 43 48 53 20 // SPCRP.....BOCHS @@ -57 +57 @@
-0040: FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00 // ................ +0040: FF FF FF FF 00 00 00 00 00 00 00 00 00 36 6E 01 // .............6n.
In a revision 3 SPCR table, the "Reserved" field is the UART clock frequency field.
--- tests/data/acpi/aarch64/virt/SPCR | Bin 80 -> 80 bytes tests/qtest/bios-tables-test-allowed-diff.h | 1 - 2 files changed, 1 deletion(-)
tests/data/acpi/aarch64/virt/SPCR binary +0 -0
tests/qtest/bios-tables-test-allowed-diff.h +0 -1
@@ -1,2 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/aarch64/virt/SPCR",
Signature · 1 line
2.39.5 (Apple Git-154)
Re: [PATCH 4/4] tests: acpi: update expected blobs
Review line 49
Quoted 9 lines · On Fri, 18 Jul 2025 19:20:45 +0300 Vadim Chichikalyuk <[email protected]>…
Previous patch changed the SPCR ACPI table for AArch64 virt:
(quoted diff) +3
-3@@ -15,2 +15,2 @@ -[008h 0008 001h] Revision : 02 -[009h 0009 001h] Checksum : B1 +[008h 0008 001h] Revision : 03 +[009h 0009 001h] Checksum : 0B@@ -49 +49 @@ -[04Ch 0076 004h] Reserved : 00000000 +[04Ch 0076 004h] Reserved : 016E3600
Hmm. No support in acpi-tools? Old version maybe?
Looks like v4 support was added in this pull request last year
https://github.com/acpica/acpica/pull/931
Jonathan
Quoted 33 lines
(quoted diff) +2
-2@@ -53 +53 @@ -0000: 53 50 43 52 50 00 00 00 02 B1 42 4F 43 48 53 20 // SPCRP.....BOCHS +0000: 53 50 43 52 50 00 00 00 03 0B 42 4F 43 48 53 20 // SPCRP.....BOCHS@@ -57 +57 @@ -0040: FF FF FF FF 00 00 00 00 00 00 00 00 00 00 00 00 // ................ +0040: FF FF FF FF 00 00 00 00 00 00 00 00 00 36 6E 01 // .............6n.In a revision 3 SPCR table, the "Reserved" field is the UART clock frequency field.
Signed-off-by Vadim Chichikalyuk <[email protected]>--- tests/data/acpi/aarch64/virt/SPCR | Bin 80 -> 80 bytes tests/qtest/bios-tables-test-allowed-diff.h | 1 - 2 files changed, 1 deletion(-)tests/data/acpi/aarch64/virt/SPCR binary +0
-0tests/qtest/bios-tables-test-allowed-diff.h +0
-1@@ -1,2 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/aarch64/virt/SPCR",