reduced.c

/* HW reduced ACPI support
 *
 * Copyright (c) 2018 Intel Corportation
 * Copyright (C) 2013 Red Hat Inc
 * Copyright (c) 2015 HUAWEI TECHNOLOGIES CO.,LTD.
 * Copyright (C) 2008-2010  Kevin O'Connor <kevin@koconnor.net>
 * Copyright (C) 2006 Fabrice Bellard
 *
 * 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 "qapi/error.h"
#include "qemu/error-report.h"
#include "qemu-common.h"

#include "hw/acpi/acpi-defs.h"
#include "hw/acpi/acpi.h"
#include "hw/acpi/aml-build.h"
#include "hw/acpi/bios-linker-loader.h"
#include "hw/acpi/cpu.h"
#include "hw/acpi/pc-hotplug.h"
#include "hw/acpi/reduced.h"
#include "hw/acpi/memory_hotplug.h"
#include "hw/acpi/ged.h"
#include "qemu/range.h"
#include "hw/nvram/fw_cfg.h"

#include "hw/pci/pcie_host.h"
#include "hw/pci/pci.h"

#include "hw/loader.h"
#include "hw/hw.h"

#include "sysemu/numa.h"

#include "migration/vmstate.h"

static void acpi_dsdt_add_memory_hotplug(MachineState *ms, Aml *dsdt)
{
    uint32_t nr_mem = ms->ram_slots;

    build_memory_hotplug_aml(dsdt, nr_mem, "\\_SB", NULL);
}

static void acpi_dsdt_add_cpus(MachineState *ms, Aml *dsdt, int smp_cpus, AcpiConfiguration *conf)
{
    CPUHotplugFeatures opts = {
        .acpi_1_compatible = false,
        .has_legacy_cphp = false,
    };

    build_cpus_aml(dsdt, ms, opts, conf->cpu_hotplug_io_base,
                   "\\_SB", NULL);
}

static void acpi_dsdt_add_ged(Aml *scope, AcpiConfiguration *conf)
{
    if (!conf->ged_events || !conf->ged_events_size) {
        return;
    }

    build_ged_aml(scope, "\\_SB."GED_DEVICE, conf->ged_irq,
                  conf->ged_events, conf->ged_events_size);
}

static void acpi_dsdt_add_sleep_state(Aml *scope)
{
    Aml *pkg = aml_package(1);

    aml_append(pkg, aml_int(ACPI_REDUCED_SLEEP_LEVEL));
    aml_append(scope, aml_name_decl("\\_S5_", pkg));
}

/* DSDT */
static void build_dsdt(MachineState *ms, GArray *table_data, BIOSLinker *linker, AcpiPciBus *pci_host, AcpiConfiguration *conf)
{
    Aml *dsdt;

    dsdt = init_aml_allocator();
    /* Reserve space for header */
    acpi_data_push(dsdt->buf, sizeof(AcpiTableHeader));

    if (pci_host->pci_bus) {
        acpi_dsdt_add_pci_bus(dsdt, pci_host);
    }
    acpi_dsdt_add_memory_hotplug(ms, dsdt);
    acpi_dsdt_add_cpus(ms, dsdt, smp_cpus, conf);
    acpi_dsdt_add_ged(dsdt, conf);
    acpi_dsdt_add_sleep_state(dsdt);


    /* copy AML table into ACPI tables blob and patch header there */
    g_array_append_vals(table_data, dsdt->buf->data, dsdt->buf->len);
    build_header(linker, table_data,
        (void *)(table_data->data + table_data->len - dsdt->buf->len),
        "DSDT", dsdt->buf->len, 2, NULL, NULL);
    free_aml_allocator();
}


static void build_fadt_reduced(GArray *table_data, BIOSLinker *linker,
                               unsigned dsdt_tbl_offset)
{
    /* ACPI v5.1 */
    AcpiFadtData fadt = {
        .rev = 5,
        .minor_ver = 1,
        .flags = (1 << ACPI_FADT_F_HW_REDUCED_ACPI) |
                 (1 << ACPI_FADT_F_RESET_REG_SUP),
        .dsdt_tbl_offset = &dsdt_tbl_offset,
        .xdsdt_tbl_offset = &dsdt_tbl_offset,
        .arm_boot_arch = 0,
        .reset_reg = { .space_id = AML_AS_SYSTEM_IO,
                      .bit_width = 8, .bit_offset = 0,
                      .address = ACPI_REDUCED_RESET_IOPORT },
        .reset_val = ACPI_REDUCED_RESET_VALUE,
        .sleep_control_reg = { .space_id = AML_AS_SYSTEM_IO,
                              .bit_width = 8, .bit_offset = 0,
                              .address = ACPI_REDUCED_SLEEP_CONTROL_IOPORT },
        .sleep_status_reg = { .space_id = AML_AS_SYSTEM_IO,
                              .bit_width = 8, .bit_offset = 0,
                              .address = ACPI_REDUCED_SLEEP_STATUS_IOPORT },
        .pm_tmr = { .space_id = AML_AS_SYSTEM_IO,
                    .bit_width = 32, .bit_offset = 0,
                    .address = ACPI_REDUCED_PMTIMER_IOPORT },
    };

    build_fadt(table_data, linker, &fadt, NULL, NULL);
}

static void acpi_reduced_build(MachineState *ms, AcpiBuildTables *tables, AcpiConfiguration *conf)
{
    MachineClass *mc = MACHINE_GET_CLASS(ms);
    GArray *table_offsets;
    unsigned dsdt, xsdt;
    Object *pci_host;
    PCIBus *bus = NULL;
    Range pci_hole, pci_hole64;
    AcpiMcfgInfo mcfg;
    GArray *tables_blob = tables->table_data;

    acpi_get_pci_holes(&pci_hole, &pci_hole64);
    table_offsets = g_array_new(false, true /* clear */,
                                        sizeof(uint32_t));

    bios_linker_loader_alloc(tables->linker,
                             ACPI_BUILD_TABLE_FILE, tables_blob,
                             64, false /* high memory */);

    pci_host = acpi_get_pci_host();
    if (pci_host) {
        bus = PCI_HOST_BRIDGE(pci_host)->bus;
    }

    AcpiPciBus acpi_pci_host = {
        .pci_bus    = bus,
        .pci_hole   = &pci_hole,
        .pci_hole64 = &pci_hole64,
        .pci_segment = 0,
        .acpi_iobase_addr = VIRT_ACPI_PCI_HOTPLUG_IO_BASE,
    };

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

    /* FADT pointed to by RSDT */
    acpi_add_table(table_offsets, tables_blob);
    build_fadt_reduced(tables_blob, tables->linker, dsdt);

    /* MADT pointed to by RSDT */
    acpi_add_table(table_offsets, tables_blob);
    mc->firmware_build_methods.acpi.madt(tables_blob, tables->linker, ms, conf);

    if (conf->numa_nodes) {
        acpi_add_table(table_offsets, tables_blob);
        mc->firmware_build_methods.acpi.srat(tables_blob, tables->linker, ms, conf);
        if (have_numa_distance) {
            acpi_add_table(table_offsets, tables_blob);
            mc->firmware_build_methods.acpi.slit(tables_blob, tables->linker);
        }
    }

    if (acpi_get_mcfg(&mcfg)) {
        acpi_add_table(table_offsets, tables_blob);
        mc->firmware_build_methods.acpi.mcfg(tables_blob, tables->linker, &mcfg);
    }
    if (ms->nvdimms_state->is_enabled) {
        nvdimm_build_acpi(table_offsets, tables_blob, tables->linker,
                          ms->nvdimms_state, ms->ram_slots);
    }

    /* RSDT is pointed to by RSDP */
    xsdt = tables_blob->len;
    build_xsdt(tables_blob, tables->linker, table_offsets, NULL, NULL);

    AcpiRsdpData rsdp_data = {
        .revision = 2,
        .oem_id = ACPI_BUILD_APPNAME6,
        .xsdt_tbl_offset = &xsdt,
        .rsdt_tbl_offset = NULL,
    };
    /* RSDP is in FSEG memory, so allocate it separately */
    mc->firmware_build_methods.acpi.rsdp(tables->rsdp, tables->linker, &rsdp_data);
    acpi_align_size(tables->linker->cmd_blob, ACPI_BUILD_ALIGN_SIZE);

    /* Cleanup 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 acpi_reduced_build_update(void *build_opaque)
{
    MachineState *ms = MACHINE(build_opaque);
    AcpiBuildState *build_state = ms->firmware_build_state.acpi.state;
    AcpiConfiguration *conf = ms->firmware_build_state.acpi.conf;
    AcpiBuildTables tables;

    /* No ACPI configuration? Nothing to do. */
    if (!conf) {
        return;
    }

    /* 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);

    acpi_reduced_build(ms, &tables, conf);

    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 acpi_reduced_build_reset(void *build_opaque)
{
    MachineState *ms = MACHINE(build_opaque);
    AcpiBuildState *build_state = ms->firmware_build_state.acpi.state;

    build_state->patched = false;
}

static MemoryRegion *acpi_add_rom_blob(MachineState *ms,
                                       GArray *blob, const char *name,
                                       uint64_t max_size)
{
    return rom_add_blob(name, blob->data, acpi_data_len(blob), max_size, -1,
                        name, acpi_reduced_build_update, ms, NULL, true);
}

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

void acpi_reduced_setup(MachineState *machine, AcpiConfiguration *conf)
{
    AcpiBuildTables tables;
    AcpiBuildState *build_state;

    build_state = g_malloc0(sizeof(*build_state));
    machine->firmware_build_state.acpi.state = build_state;
    machine->firmware_build_state.acpi.conf = conf;

    acpi_build_tables_init(&tables);
    acpi_reduced_build(machine, &tables, conf);

    if (conf->fw_cfg) {
        /* Now expose it all to Guest */
        build_state->table_mr = acpi_add_rom_blob(machine, tables.table_data,
                                                  ACPI_BUILD_TABLE_FILE,
                                                  ACPI_BUILD_TABLE_MAX_SIZE);
        assert(build_state->table_mr != NULL);

        build_state->linker_mr =
            acpi_add_rom_blob(machine, tables.linker->cmd_blob,
                              "etc/table-loader", 0);

        fw_cfg_add_file(conf->fw_cfg, ACPI_BUILD_TPMLOG_FILE, tables.tcpalog->data,
                        acpi_data_len(tables.tcpalog));

        build_state->rsdp_mr = acpi_add_rom_blob(machine, tables.rsdp,
                                                 ACPI_BUILD_RSDP_FILE, 0);
    }

    qemu_register_reset(acpi_reduced_build_reset, machine);
    acpi_reduced_build_reset(machine);
    vmstate_register(NULL, 0, &vmstate_acpi_reduced_build, machine);

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