hw/riscv/virt-acpi-build.c - qemu - Git at Google

 /*
  * Support for generating ACPI tables and passing them to Guests
  *
  * RISC-V virt ACPI generation
  *
  * Copyright (C) 2008-2010  Kevin O'Connor <kevin@koconnor.net>
  * Copyright (C) 2006 Fabrice Bellard
  * Copyright (C) 2013 Red Hat Inc
  * Copyright (c) 2015 HUAWEI TECHNOLOGIES CO.,LTD.
  * Copyright (C) 2021-2023 Ventana Micro Systems Inc
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.

  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.

  * You should have received a copy of the GNU General Public License along
  * with this program; if not, see <http://www.gnu.org/licenses/>.
  */

 #include "qemu/osdep.h"
 #include "hw/acpi/acpi-defs.h"
 #include "hw/acpi/acpi.h"
 #include "hw/acpi/aml-build.h"
 #include "hw/acpi/utils.h"
 #include "qapi/error.h"
 #include "sysemu/reset.h"
 #include "migration/vmstate.h"
 #include "hw/riscv/virt.h"
 #include "hw/riscv/numa.h"

 #define ACPI_BUILD_TABLE_SIZE             0x20000

 typedef struct AcpiBuildState {
     /* Copy of table in RAM (for patching) */
     MemoryRegion *table_mr;
     MemoryRegion *rsdp_mr;
     MemoryRegion *linker_mr;
     /* Is table patched? */
     bool patched;
 } AcpiBuildState;

 static void acpi_align_size(GArray *blob, unsigned align)
 {
     /*
      * Align size to multiple of given size. This reduces the chance
      * we need to change size in the future (breaking cross version migration).
      */
     g_array_set_size(blob, ROUND_UP(acpi_data_len(blob), align));
 }

 static void riscv_acpi_madt_add_rintc(uint32_t uid,
                                       const CPUArchIdList *arch_ids,
                                       GArray *entry)
 {
     uint64_t hart_id = arch_ids->cpus[uid].arch_id;

     build_append_int_noprefix(entry, 0x18, 1);       /* Type     */
     build_append_int_noprefix(entry, 20, 1);         /* Length   */
     build_append_int_noprefix(entry, 1, 1);          /* Version  */
     build_append_int_noprefix(entry, 0, 1);          /* Reserved */
     build_append_int_noprefix(entry, 0x1, 4);        /* Flags    */
     build_append_int_noprefix(entry, hart_id, 8);    /* Hart ID  */
     build_append_int_noprefix(entry, uid, 4);        /* ACPI Processor UID */
 }

 static void acpi_dsdt_add_cpus(Aml *scope, RISCVVirtState *s)
 {
     MachineClass *mc = MACHINE_GET_CLASS(s);
     MachineState *ms = MACHINE(s);
     const CPUArchIdList *arch_ids = mc->possible_cpu_arch_ids(ms);

     for (int i = 0; i < arch_ids->len; i++) {
             Aml *dev;
             GArray *madt_buf = g_array_new(0, 1, 1);

             dev = aml_device("C%.03X", i);
             aml_append(dev, aml_name_decl("_HID", aml_string("ACPI0007")));
             aml_append(dev, aml_name_decl("_UID",
                        aml_int(arch_ids->cpus[i].arch_id)));

             /* build _MAT object */
             riscv_acpi_madt_add_rintc(i, arch_ids, madt_buf);
             aml_append(dev, aml_name_decl("_MAT",
                                           aml_buffer(madt_buf->len,
                                           (uint8_t *)madt_buf->data)));
             g_array_free(madt_buf, true);

             aml_append(scope, dev);
     }
 }

 static void acpi_dsdt_add_fw_cfg(Aml *scope, const MemMapEntry *fw_cfg_memmap)
 {
     Aml *dev = aml_device("FWCF");
     aml_append(dev, aml_name_decl("_HID", aml_string("QEMU0002")));

     /* device present, functioning, decoding, not shown in UI */
     aml_append(dev, aml_name_decl("_STA", aml_int(0xB)));
     aml_append(dev, aml_name_decl("_CCA", aml_int(1)));

     Aml *crs = aml_resource_template();
     aml_append(crs, aml_memory32_fixed(fw_cfg_memmap->base,
                                        fw_cfg_memmap->size, AML_READ_WRITE));
     aml_append(dev, aml_name_decl("_CRS", crs));
     aml_append(scope, dev);
 }

 /* FADT */
 static void build_fadt_rev6(GArray *table_data,
                             BIOSLinker *linker,
                             RISCVVirtState *s,
                             unsigned dsdt_tbl_offset)
 {
     AcpiFadtData fadt = {
         .rev = 6,
         .minor_ver = 5,
         .flags = 1 << ACPI_FADT_F_HW_REDUCED_ACPI,
         .xdsdt_tbl_offset = &dsdt_tbl_offset,
     };

     build_fadt(table_data, linker, &fadt, s->oem_id, s->oem_table_id);
 }

 /* DSDT */
 static void build_dsdt(GArray *table_data,
                        BIOSLinker *linker,
                        RISCVVirtState *s)
 {
     Aml *scope, *dsdt;
     const MemMapEntry *memmap = s->memmap;
     AcpiTable table = { .sig = "DSDT", .rev = 2, .oem_id = s->oem_id,
                         .oem_table_id = s->oem_table_id };


     acpi_table_begin(&table, table_data);
     dsdt = init_aml_allocator();

     /*
      * When booting the VM with UEFI, UEFI takes ownership of the RTC hardware.
      * While UEFI can use libfdt to disable the RTC device node in the DTB that
      * it passes to the OS, it cannot modify AML. Therefore, we won't generate
      * the RTC ACPI device at all when using UEFI.
      */
     scope = aml_scope("\\_SB");
     acpi_dsdt_add_cpus(scope, s);

     acpi_dsdt_add_fw_cfg(scope, &memmap[VIRT_FW_CFG]);

     aml_append(dsdt, scope);

     /* copy AML table into ACPI tables blob and patch header there */
     g_array_append_vals(table_data, dsdt->buf->data, dsdt->buf->len);

     acpi_table_end(linker, &table);
     free_aml_allocator();
 }

 /*
  * ACPI spec, Revision 6.5+
  * 5.2.12 Multiple APIC Description Table (MADT)
  * REF: https://github.com/riscv-non-isa/riscv-acpi/issues/15
  *      https://drive.google.com/file/d/1R6k4MshhN3WTT-hwqAquu5nX6xSEqK2l/view
  */
 static void build_madt(GArray *table_data,
                        BIOSLinker *linker,
                        RISCVVirtState *s)
 {
     MachineClass *mc = MACHINE_GET_CLASS(s);
     MachineState *ms = MACHINE(s);
     const CPUArchIdList *arch_ids = mc->possible_cpu_arch_ids(ms);

     AcpiTable table = { .sig = "APIC", .rev = 6, .oem_id = s->oem_id,
                         .oem_table_id = s->oem_table_id };

     acpi_table_begin(&table, table_data);
     /* Local Interrupt Controller Address */
     build_append_int_noprefix(table_data, 0, 4);
     build_append_int_noprefix(table_data, 0, 4);   /* MADT Flags */

     /* RISC-V Local INTC structures per HART */
     for (int i = 0; i < arch_ids->len; i++) {
         riscv_acpi_madt_add_rintc(i, arch_ids, table_data);
     }

     acpi_table_end(linker, &table);
 }

 static void virt_acpi_build(RISCVVirtState *s, AcpiBuildTables *tables)
 {
     GArray *table_offsets;
     unsigned dsdt, xsdt;
     GArray *tables_blob = tables->table_data;

     table_offsets = g_array_new(false, true,
                                 sizeof(uint32_t));

     bios_linker_loader_alloc(tables->linker,
                              ACPI_BUILD_TABLE_FILE, tables_blob,
                              64, false);

     /* DSDT is pointed to by FADT */
     dsdt = tables_blob->len;
     build_dsdt(tables_blob, tables->linker, s);

     /* FADT and others pointed to by XSDT */
     acpi_add_table(table_offsets, tables_blob);
     build_fadt_rev6(tables_blob, tables->linker, s, dsdt);

     acpi_add_table(table_offsets, tables_blob);
     build_madt(tables_blob, tables->linker, s);

     /* XSDT is pointed to by RSDP */
     xsdt = tables_blob->len;
     build_xsdt(tables_blob, tables->linker, table_offsets, s->oem_id,
                 s->oem_table_id);

     /* RSDP is in FSEG memory, so allocate it separately */
     {
         AcpiRsdpData rsdp_data = {
             .revision = 2,
             .oem_id = s->oem_id,
             .xsdt_tbl_offset = &xsdt,
             .rsdt_tbl_offset = NULL,
         };
         build_rsdp(tables->rsdp, tables->linker, &rsdp_data);
     }

     /*
      * The align size is 128, warn if 64k is not enough therefore
      * the align size could be resized.
      */
     if (tables_blob->len > ACPI_BUILD_TABLE_SIZE / 2) {
         warn_report("ACPI table size %u exceeds %d bytes,"
                     " migration may not work",
                     tables_blob->len, ACPI_BUILD_TABLE_SIZE / 2);
         error_printf("Try removing some objects.");
     }

     acpi_align_size(tables_blob, ACPI_BUILD_TABLE_SIZE);

     /* Clean up memory that's no longer used */
     g_array_free(table_offsets, true);
 }

 static void acpi_ram_update(MemoryRegion *mr, GArray *data)
 {
     uint32_t size = acpi_data_len(data);

     /*
      * Make sure RAM size is correct - in case it got changed
      * e.g. by migration
      */
     memory_region_ram_resize(mr, size, &error_abort);

     memcpy(memory_region_get_ram_ptr(mr), data->data, size);
     memory_region_set_dirty(mr, 0, size);
 }

 static void virt_acpi_build_update(void *build_opaque)
 {
     AcpiBuildState *build_state = build_opaque;
     AcpiBuildTables tables;

     /* No state to update or already patched? Nothing to do. */
     if (!build_state || build_state->patched) {
         return;
     }

     build_state->patched = true;

     acpi_build_tables_init(&tables);

     virt_acpi_build(RISCV_VIRT_MACHINE(qdev_get_machine()), &tables);

     acpi_ram_update(build_state->table_mr, tables.table_data);
     acpi_ram_update(build_state->rsdp_mr, tables.rsdp);
     acpi_ram_update(build_state->linker_mr, tables.linker->cmd_blob);

     acpi_build_tables_cleanup(&tables, true);
 }

 static void virt_acpi_build_reset(void *build_opaque)
 {
     AcpiBuildState *build_state = build_opaque;
     build_state->patched = false;
 }

 static const VMStateDescription vmstate_virt_acpi_build = {
     .name = "virt_acpi_build",
     .version_id = 1,
     .minimum_version_id = 1,
     .fields = (VMStateField[]) {
         VMSTATE_BOOL(patched, AcpiBuildState),
         VMSTATE_END_OF_LIST()
     },
 };

 void virt_acpi_setup(RISCVVirtState *s)
 {
     AcpiBuildTables tables;
     AcpiBuildState *build_state;

     build_state = g_malloc0(sizeof *build_state);

     acpi_build_tables_init(&tables);
     virt_acpi_build(s, &tables);

     /* Now expose it all to Guest */
     build_state->table_mr = acpi_add_rom_blob(virt_acpi_build_update,
                                               build_state, tables.table_data,
                                               ACPI_BUILD_TABLE_FILE);
     assert(build_state->table_mr != NULL);

     build_state->linker_mr = acpi_add_rom_blob(virt_acpi_build_update,
                                                build_state,
                                                tables.linker->cmd_blob,
                                                ACPI_BUILD_LOADER_FILE);

     build_state->rsdp_mr = acpi_add_rom_blob(virt_acpi_build_update,
                                              build_state, tables.rsdp,
                                              ACPI_BUILD_RSDP_FILE);

     qemu_register_reset(virt_acpi_build_reset, build_state);
     virt_acpi_build_reset(build_state);
     vmstate_register(NULL, 0, &vmstate_virt_acpi_build, build_state);

     /*
      * Clean up tables but don't free the memory: we track it
      * in build_state.
      */
     acpi_build_tables_cleanup(&tables, false);
 }
	/*
	* Support for generating ACPI tables and passing them to Guests
	*
	* RISC-V virt ACPI generation
	*
	* Copyright (C) 2008-2010 Kevin O'Connor <kevin@koconnor.net>
	* Copyright (C) 2006 Fabrice Bellard
	* Copyright (C) 2013 Red Hat Inc
	* Copyright (c) 2015 HUAWEI TECHNOLOGIES CO.,LTD.
	* Copyright (C) 2021-2023 Ventana Micro Systems Inc
	*
	* This program is free software; you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation; either version 2 of the License, or
	* (at your option) any later version.

	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.

	* You should have received a copy of the GNU General Public License along
	* with this program; if not, see <http://www.gnu.org/licenses/>.
	*/

	#include "qemu/osdep.h"
	#include "hw/acpi/acpi-defs.h"
	#include "hw/acpi/acpi.h"
	#include "hw/acpi/aml-build.h"
	#include "hw/acpi/utils.h"
	#include "qapi/error.h"
	#include "sysemu/reset.h"
	#include "migration/vmstate.h"
	#include "hw/riscv/virt.h"
	#include "hw/riscv/numa.h"

	#define ACPI_BUILD_TABLE_SIZE 0x20000

	typedef struct AcpiBuildState {
	/* Copy of table in RAM (for patching) */
	MemoryRegion *table_mr;
	MemoryRegion *rsdp_mr;
	MemoryRegion *linker_mr;
	/* Is table patched? */
	bool patched;
	} AcpiBuildState;

	static void acpi_align_size(GArray *blob, unsigned align)
	{
	/*
	* Align size to multiple of given size. This reduces the chance
	* we need to change size in the future (breaking cross version migration).
	*/
	g_array_set_size(blob, ROUND_UP(acpi_data_len(blob), align));
	}

	static void riscv_acpi_madt_add_rintc(uint32_t uid,
	const CPUArchIdList *arch_ids,
	GArray *entry)
	{
	uint64_t hart_id = arch_ids->cpus[uid].arch_id;

	build_append_int_noprefix(entry, 0x18, 1); /* Type */
	build_append_int_noprefix(entry, 20, 1); /* Length */
	build_append_int_noprefix(entry, 1, 1); /* Version */
	build_append_int_noprefix(entry, 0, 1); /* Reserved */
	build_append_int_noprefix(entry, 0x1, 4); /* Flags */
	build_append_int_noprefix(entry, hart_id, 8); /* Hart ID */
	build_append_int_noprefix(entry, uid, 4); /* ACPI Processor UID */
	}

	static void acpi_dsdt_add_cpus(Aml scope, RISCVVirtState s)
	{
	MachineClass *mc = MACHINE_GET_CLASS(s);
	MachineState *ms = MACHINE(s);
	const CPUArchIdList *arch_ids = mc->possible_cpu_arch_ids(ms);

	for (int i = 0; i < arch_ids->len; i++) {
	Aml *dev;
	GArray *madt_buf = g_array_new(0, 1, 1);

	dev = aml_device("C%.03X", i);
	aml_append(dev, aml_name_decl("_HID", aml_string("ACPI0007")));
	aml_append(dev, aml_name_decl("_UID",
	aml_int(arch_ids->cpus[i].arch_id)));

	/* build _MAT object */
	riscv_acpi_madt_add_rintc(i, arch_ids, madt_buf);
	aml_append(dev, aml_name_decl("_MAT",
	aml_buffer(madt_buf->len,
	(uint8_t *)madt_buf->data)));
	g_array_free(madt_buf, true);

	aml_append(scope, dev);
	}
	}

	static void acpi_dsdt_add_fw_cfg(Aml scope, const MemMapEntry fw_cfg_memmap)
	{
	Aml *dev = aml_device("FWCF");
	aml_append(dev, aml_name_decl("_HID", aml_string("QEMU0002")));

	/* device present, functioning, decoding, not shown in UI */
	aml_append(dev, aml_name_decl("_STA", aml_int(0xB)));
	aml_append(dev, aml_name_decl("_CCA", aml_int(1)));

	Aml *crs = aml_resource_template();
	aml_append(crs, aml_memory32_fixed(fw_cfg_memmap->base,
	fw_cfg_memmap->size, AML_READ_WRITE));
	aml_append(dev, aml_name_decl("_CRS", crs));
	aml_append(scope, dev);
	}

	/* FADT */
	static void build_fadt_rev6(GArray *table_data,
	BIOSLinker *linker,
	RISCVVirtState *s,
	unsigned dsdt_tbl_offset)
	{
	AcpiFadtData fadt = {
	.rev = 6,
	.minor_ver = 5,
	.flags = 1 << ACPI_FADT_F_HW_REDUCED_ACPI,
	.xdsdt_tbl_offset = &dsdt_tbl_offset,
	};

	build_fadt(table_data, linker, &fadt, s->oem_id, s->oem_table_id);
	}

	/* DSDT */
	static void build_dsdt(GArray *table_data,
	BIOSLinker *linker,
	RISCVVirtState *s)
	{
	Aml scope, dsdt;
	const MemMapEntry *memmap = s->memmap;
	AcpiTable table = { .sig = "DSDT", .rev = 2, .oem_id = s->oem_id,
	.oem_table_id = s->oem_table_id };


	acpi_table_begin(&table, table_data);
	dsdt = init_aml_allocator();

	/*
	* When booting the VM with UEFI, UEFI takes ownership of the RTC hardware.
	* While UEFI can use libfdt to disable the RTC device node in the DTB that
	* it passes to the OS, it cannot modify AML. Therefore, we won't generate
	* the RTC ACPI device at all when using UEFI.
	*/
	scope = aml_scope("\\_SB");
	acpi_dsdt_add_cpus(scope, s);

	acpi_dsdt_add_fw_cfg(scope, &memmap[VIRT_FW_CFG]);

	aml_append(dsdt, scope);

	/* copy AML table into ACPI tables blob and patch header there */
	g_array_append_vals(table_data, dsdt->buf->data, dsdt->buf->len);

	acpi_table_end(linker, &table);
	free_aml_allocator();
	}

	/*
	* ACPI spec, Revision 6.5+
	* 5.2.12 Multiple APIC Description Table (MADT)
	* REF: https://github.com/riscv-non-isa/riscv-acpi/issues/15
	* https://drive.google.com/file/d/1R6k4MshhN3WTT-hwqAquu5nX6xSEqK2l/view
	*/
	static void build_madt(GArray *table_data,
	BIOSLinker *linker,
	RISCVVirtState *s)
	{
	MachineClass *mc = MACHINE_GET_CLASS(s);
	MachineState *ms = MACHINE(s);
	const CPUArchIdList *arch_ids = mc->possible_cpu_arch_ids(ms);

	AcpiTable table = { .sig = "APIC", .rev = 6, .oem_id = s->oem_id,
	.oem_table_id = s->oem_table_id };

	acpi_table_begin(&table, table_data);
	/* Local Interrupt Controller Address */
	build_append_int_noprefix(table_data, 0, 4);
	build_append_int_noprefix(table_data, 0, 4); /* MADT Flags */

	/* RISC-V Local INTC structures per HART */
	for (int i = 0; i < arch_ids->len; i++) {
	riscv_acpi_madt_add_rintc(i, arch_ids, table_data);
	}

	acpi_table_end(linker, &table);
	}

	static void virt_acpi_build(RISCVVirtState s, AcpiBuildTables tables)
	{
	GArray *table_offsets;
	unsigned dsdt, xsdt;
	GArray *tables_blob = tables->table_data;

	table_offsets = g_array_new(false, true,
	sizeof(uint32_t));

	bios_linker_loader_alloc(tables->linker,
	ACPI_BUILD_TABLE_FILE, tables_blob,
	64, false);

	/* DSDT is pointed to by FADT */
	dsdt = tables_blob->len;
	build_dsdt(tables_blob, tables->linker, s);

	/* FADT and others pointed to by XSDT */
	acpi_add_table(table_offsets, tables_blob);
	build_fadt_rev6(tables_blob, tables->linker, s, dsdt);

	acpi_add_table(table_offsets, tables_blob);
	build_madt(tables_blob, tables->linker, s);

	/* XSDT is pointed to by RSDP */
	xsdt = tables_blob->len;
	build_xsdt(tables_blob, tables->linker, table_offsets, s->oem_id,
	s->oem_table_id);

	/* RSDP is in FSEG memory, so allocate it separately */
	{
	AcpiRsdpData rsdp_data = {
	.revision = 2,
	.oem_id = s->oem_id,
	.xsdt_tbl_offset = &xsdt,
	.rsdt_tbl_offset = NULL,
	};
	build_rsdp(tables->rsdp, tables->linker, &rsdp_data);
	}

	/*
	* The align size is 128, warn if 64k is not enough therefore
	* the align size could be resized.
	*/
	if (tables_blob->len > ACPI_BUILD_TABLE_SIZE / 2) {
	warn_report("ACPI table size %u exceeds %d bytes,"
	" migration may not work",
	tables_blob->len, ACPI_BUILD_TABLE_SIZE / 2);
	error_printf("Try removing some objects.");
	}

	acpi_align_size(tables_blob, ACPI_BUILD_TABLE_SIZE);

	/* Clean up memory that's no longer used */
	g_array_free(table_offsets, true);
	}

	static void acpi_ram_update(MemoryRegion mr, GArray data)
	{
	uint32_t size = acpi_data_len(data);

	/*
	* Make sure RAM size is correct - in case it got changed
	* e.g. by migration
	*/
	memory_region_ram_resize(mr, size, &error_abort);

	memcpy(memory_region_get_ram_ptr(mr), data->data, size);
	memory_region_set_dirty(mr, 0, size);
	}

	static void virt_acpi_build_update(void *build_opaque)
	{
	AcpiBuildState *build_state = build_opaque;
	AcpiBuildTables tables;

	/* No state to update or already patched? Nothing to do. */
	if (!build_state \|\| build_state->patched) {
	return;
	}

	build_state->patched = true;

	acpi_build_tables_init(&tables);

	virt_acpi_build(RISCV_VIRT_MACHINE(qdev_get_machine()), &tables);

	acpi_ram_update(build_state->table_mr, tables.table_data);
	acpi_ram_update(build_state->rsdp_mr, tables.rsdp);
	acpi_ram_update(build_state->linker_mr, tables.linker->cmd_blob);

	acpi_build_tables_cleanup(&tables, true);
	}

	static void virt_acpi_build_reset(void *build_opaque)
	{
	AcpiBuildState *build_state = build_opaque;
	build_state->patched = false;
	}

	static const VMStateDescription vmstate_virt_acpi_build = {
	.name = "virt_acpi_build",
	.version_id = 1,
	.minimum_version_id = 1,
	.fields = (VMStateField[]) {
	VMSTATE_BOOL(patched, AcpiBuildState),
	VMSTATE_END_OF_LIST()
	},
	};

	void virt_acpi_setup(RISCVVirtState *s)
	{
	AcpiBuildTables tables;
	AcpiBuildState *build_state;

	build_state = g_malloc0(sizeof *build_state);

	acpi_build_tables_init(&tables);
	virt_acpi_build(s, &tables);

	/* Now expose it all to Guest */
	build_state->table_mr = acpi_add_rom_blob(virt_acpi_build_update,
	build_state, tables.table_data,
	ACPI_BUILD_TABLE_FILE);
	assert(build_state->table_mr != NULL);

	build_state->linker_mr = acpi_add_rom_blob(virt_acpi_build_update,
	build_state,
	tables.linker->cmd_blob,
	ACPI_BUILD_LOADER_FILE);

	build_state->rsdp_mr = acpi_add_rom_blob(virt_acpi_build_update,
	build_state, tables.rsdp,
	ACPI_BUILD_RSDP_FILE);

	qemu_register_reset(virt_acpi_build_reset, build_state);
	virt_acpi_build_reset(build_state);
	vmstate_register(NULL, 0, &vmstate_virt_acpi_build, build_state);

	/*
	* Clean up tables but don't free the memory: we track it
	* in build_state.
	*/
	acpi_build_tables_cleanup(&tables, false);
	}