| Message ID | 1622225659-16847-4-git-send-email-eric.devolder@oracle.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | acpi: Error Record Serialization Table, ERST, support for QEMU | expand |
On Fri, 28 May 2021 14:14:15 -0400 Eric DeVolder <eric.devolder@oracle.com> wrote: > This change implements the support for the ACPI ERST feature[1,2]. > > The size of the ACPI ERST storage is declared via the QEMU > global parameter acpi-erst.size. The size can range from 64KiB > to to 64MiB. The default is 64KiB. > > The location of the ACPI ERST storage backing file is declared > via the QEMU global parameter acpi-erst.file. The default > is acpi-erst.backing. > > [1] "Advanced Configuration and Power Interface Specification", > version 6.2, May 2017. > https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf > > [2] "Unified Extensible Firmware Interface Specification", > version 2.8, March 2019. > https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf > > Signed-off-by: Eric DeVolder <eric.devolder@oracle.com> > --- > hw/acpi/erst.c | 902 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 902 insertions(+) > create mode 100644 hw/acpi/erst.c > > diff --git a/hw/acpi/erst.c b/hw/acpi/erst.c > new file mode 100644 > index 0000000..645a904 > --- /dev/null > +++ b/hw/acpi/erst.c > @@ -0,0 +1,902 @@ > +/* > + * ACPI Error Record Serialization Table, ERST, Implementation > + * > + * Copyright (c) 2021 Oracle and/or its affiliates. > + * > + * See ACPI specification, > + * "ACPI Platform Error Interfaces" : "Error Serialization" > + * > + * This library is free software; you can redistribute it and/or > + * modify it under the terms of the GNU Lesser General Public > + * License as published by the Free Software Foundation; > + * version 2 of the License. > + * > + * This library 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 > + * Lesser General Public License for more details. > + * > + * You should have received a copy of the GNU Lesser General Public > + * License along with this library; if not, see <http://www.gnu.org/licenses/> > + */ > + > +#include <sys/types.h> > +#include <sys/stat.h> > +#include <unistd.h> > + > +#include "qemu/osdep.h" > +#include "qapi/error.h" > +#include "hw/sysbus.h" > +#include "qom/object_interfaces.h" > +#include "qemu/error-report.h" > +#include "migration/vmstate.h" > +#include "hw/qdev-properties.h" > +#include "hw/acpi/acpi.h" > +#include "hw/acpi/acpi-defs.h" > +#include "hw/acpi/aml-build.h" > +#include "hw/acpi/bios-linker-loader.h" > +#include "exec/address-spaces.h" > +#include "sysemu/hostmem.h" > +#include "hw/acpi/erst.h" > + > +#ifdef _ERST_DEBUG > +#define erst_debug(fmt, ...) \ > + do { fprintf(stderr, fmt, ## __VA_ARGS__); fflush(stderr); } while (0) > +#else > +#define erst_debug(fmt, ...) do { } while (0) > +#endif > + > +/* See UEFI spec, Appendix N Common Platform Error Record */ > +/* UEFI CPER allows for an OSPM book keeping area in the record */ > +#define UEFI_CPER_RECORD_MIN_SIZE 128U > +#define UEFI_CPER_SIZE_OFFSET 20U > +#define UEFI_CPER_RECORD_ID_OFFSET 96U > +#define IS_UEFI_CPER_RECORD(ptr) \ > + (((ptr)[0] == 'C') && \ > + ((ptr)[1] == 'P') && \ > + ((ptr)[2] == 'E') && \ > + ((ptr)[3] == 'R')) > +#define THE_UEFI_CPER_RECORD_ID(ptr) \ > + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) > + > +#define ERST_INVALID_RECORD_ID (~0UL) > +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL > +#define ERST_CSR_ACTION (0UL << 3) /* action (cmd) */ > +#define ERST_CSR_VALUE (1UL << 3) /* argument/value (data) */ > + > +/* > + * As ERST_IOMEM_SIZE is used to map the ERST into the guest, > + * it should/must be an integer multiple of PAGE_SIZE. > + * NOTE that any change to this value will make any pre- > + * existing backing files, not of the same ERST_IOMEM_SIZE, > + * unusable to the guest. > + */ > +#define ERST_IOMEM_SIZE (2UL * 4096) > + > +/* > + * This implementation is an ACTION (cmd) and VALUE (data) > + * interface consisting of just two 64-bit registers. > + */ > +#define ERST_REG_LEN (2UL * sizeof(uint64_t)) > + > +/* > + * The space not utilized by the register interface is the > + * buffer for exchanging ERST record contents. > + */ > +#define ERST_RECORD_SIZE (ERST_IOMEM_SIZE - ERST_REG_LEN) > + > +/* > + * Mode to be used for backing file > + */ > +#define ACPIERST(obj) \ > + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) > +#define ACPIERST_CLASS(oc) \ > + OBJECT_CLASS_CHECK(ERSTDeviceStateClass, (oc), TYPE_ACPI_ERST) > +#define ACPIERST_GET_CLASS(obj) \ > + OBJECT_GET_CLASS(ERSTDeviceStateClass, (obj), TYPE_ACPI_ERST) > + > +typedef struct { > + SysBusDevice parent_obj; > + Object *hostmem_obj; > + HostMemoryBackend *hostmem; > + > + MemoryRegion iomem; > + uint32_t prop_size; > + hwaddr prop_base; > + char *prop_path; > + > + uint8_t operation; > + uint8_t busy_status; > + uint8_t command_status; > + uint32_t record_offset; > + uint32_t record_count; > + uint64_t reg_action; > + uint64_t reg_value; > + uint64_t record_identifier; > + > + unsigned next_record_index; > + uint8_t record[ERST_RECORD_SIZE]; /* read/written directly by guest */ > + uint8_t tmp_record[ERST_RECORD_SIZE]; /* intermediate manipulation buffer */ > + > +} ERSTDeviceState; > + > +static unsigned copy_from_nvram_by_index(ERSTDeviceState *s, unsigned index) > +{ > + /* Read an nvram entry into tmp_record */ > + unsigned rc = ACPI_ERST_STATUS_FAILED; > + off_t offset = (index * ERST_RECORD_SIZE); > + > + if ((offset + ERST_RECORD_SIZE) <= s->prop_size) { > + MemoryRegion *mr; > + mr = host_memory_backend_get_memory(s->hostmem); > + if (mr) { > + uint8_t *p = (uint8_t *)memory_region_get_ram_ptr(mr); > + memcpy(s->tmp_record, p + offset, ERST_RECORD_SIZE); > + rc = ACPI_ERST_STATUS_SUCCESS; > + } > + } > + return rc; > +} > + > +static unsigned copy_to_nvram_by_index(ERSTDeviceState *s, unsigned index) > +{ > + /* Write entry in tmp_record into nvram, and backing file */ > + unsigned rc = ACPI_ERST_STATUS_FAILED; > + off_t offset = (index * ERST_RECORD_SIZE); > + > + if ((offset + ERST_RECORD_SIZE) <= s->prop_size) { > + MemoryRegion *mr; > + mr = host_memory_backend_get_memory(s->hostmem); > + if (mr) { > + uint8_t *p = (uint8_t *)memory_region_get_ram_ptr(mr); > + memcpy(p + offset, s->tmp_record, ERST_RECORD_SIZE); > + rc = ACPI_ERST_STATUS_SUCCESS; > + } > + } > + return rc; > +} > + > +static int lookup_erst_record_by_identifier(ERSTDeviceState *s, > + uint64_t record_identifier, bool *record_found, bool alloc_for_write) > +{ > + int rc = -1; > + int empty_index = -1; > + int index = 0; > + unsigned rrc; > + > + *record_found = 0; > + > + do { > + rrc = copy_from_nvram_by_index(s, (unsigned)index); > + if (rrc == ACPI_ERST_STATUS_SUCCESS) { > + uint64_t this_identifier; > + this_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record); > + if (IS_UEFI_CPER_RECORD(s->tmp_record) && > + (this_identifier == record_identifier)) { > + rc = index; > + *record_found = 1; > + break; > + } > + if ((this_identifier == ERST_INVALID_RECORD_ID) && > + (empty_index < 0)) { > + empty_index = index; /* first available for write */ > + } > + } > + ++index; > + } while (rrc == ACPI_ERST_STATUS_SUCCESS); > + > + /* Record not found, allocate for writing */ > + if ((rc < 0) && alloc_for_write) { > + rc = empty_index; > + } > + > + return rc; > +} > + > +static unsigned clear_erst_record(ERSTDeviceState *s) > +{ > + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; > + bool record_found; > + int index; > + > + index = lookup_erst_record_by_identifier(s, > + s->record_identifier, &record_found, 0); > + if (record_found) { > + memset(s->tmp_record, 0xFF, ERST_RECORD_SIZE); > + rc = copy_to_nvram_by_index(s, (unsigned)index); > + if (rc == ACPI_ERST_STATUS_SUCCESS) { > + s->record_count -= 1; > + } > + } > + > + return rc; > +} > + > +static unsigned write_erst_record(ERSTDeviceState *s) > +{ > + unsigned rc = ACPI_ERST_STATUS_FAILED; > + > + if (s->record_offset < (ERST_RECORD_SIZE - UEFI_CPER_RECORD_MIN_SIZE)) { > + uint64_t record_identifier; > + uint8_t *record = &s->record[s->record_offset]; > + bool record_found; > + int index; > + > + record_identifier = (s->record_identifier == ERST_INVALID_RECORD_ID) > + ? THE_UEFI_CPER_RECORD_ID(record) : s->record_identifier; > + > + index = lookup_erst_record_by_identifier(s, > + record_identifier, &record_found, 1); > + if (index < 0) { > + rc = ACPI_ERST_STATUS_NOT_ENOUGH_SPACE; > + } else { > + if (0 != s->record_offset) { > + memset(&s->tmp_record[ERST_RECORD_SIZE - s->record_offset], > + 0xFF, s->record_offset); > + } > + memcpy(s->tmp_record, record, ERST_RECORD_SIZE - s->record_offset); > + rc = copy_to_nvram_by_index(s, (unsigned)index); > + if (rc == ACPI_ERST_STATUS_SUCCESS) { > + if (!record_found) { /* not overwriting existing record */ > + s->record_count += 1; /* writing new record */ > + } > + } > + } > + } > + > + return rc; > +} > + > +static unsigned next_erst_record(ERSTDeviceState *s, > + uint64_t *record_identifier) > +{ > + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; > + unsigned index; > + unsigned rrc; > + > + *record_identifier = ERST_INVALID_RECORD_ID; > + > + index = s->next_record_index; > + do { > + rrc = copy_from_nvram_by_index(s, (unsigned)index); > + if (rrc == ACPI_ERST_STATUS_SUCCESS) { > + if (IS_UEFI_CPER_RECORD(s->tmp_record)) { > + s->next_record_index = index + 1; /* where to start next time */ > + *record_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record); > + rc = ACPI_ERST_STATUS_SUCCESS; > + break; > + } > + ++index; > + } else { > + if (s->next_record_index == 0) { > + rc = ACPI_ERST_STATUS_RECORD_STORE_EMPTY; > + } > + s->next_record_index = 0; /* at end, reset */ > + } > + } while (rrc == ACPI_ERST_STATUS_SUCCESS); > + > + return rc; > +} > + > +static unsigned read_erst_record(ERSTDeviceState *s) > +{ > + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; > + bool record_found; > + int index; > + > + index = lookup_erst_record_by_identifier(s, > + s->record_identifier, &record_found, 0); > + if (record_found) { > + rc = copy_from_nvram_by_index(s, (unsigned)index); > + if (rc == ACPI_ERST_STATUS_SUCCESS) { > + if (s->record_offset < ERST_RECORD_SIZE) { > + memcpy(&s->record[s->record_offset], s->tmp_record, > + ERST_RECORD_SIZE - s->record_offset); > + } > + } > + } > + > + return rc; > +} > + > +static unsigned get_erst_record_count(ERSTDeviceState *s) > +{ > + /* Compute record_count */ > + unsigned index = 0; > + > + s->record_count = 0; > + while (copy_from_nvram_by_index(s, index) == ACPI_ERST_STATUS_SUCCESS) { > + uint8_t *ptr = &s->tmp_record[0]; > + uint64_t record_identifier = THE_UEFI_CPER_RECORD_ID(ptr); > + if (IS_UEFI_CPER_RECORD(ptr) && > + (ERST_INVALID_RECORD_ID != record_identifier)) { > + s->record_count += 1; > + } > + ++index; > + } > + return s->record_count; > +} > + > +static uint64_t erst_rd_reg64(hwaddr addr, > + uint64_t reg, unsigned size) > +{ > + uint64_t rdval; > + uint64_t mask; > + unsigned shift; > + > + if (size == sizeof(uint64_t)) { > + /* 64b access */ > + mask = 0xFFFFFFFFFFFFFFFFUL; > + shift = 0; > + } else { > + /* 32b access */ > + mask = 0x00000000FFFFFFFFUL; > + shift = ((addr & 0x4) == 0x4) ? 32 : 0; > + } > + > + rdval = reg; > + rdval >>= shift; > + rdval &= mask; > + > + return rdval; > +} > + > +static uint64_t erst_wr_reg64(hwaddr addr, > + uint64_t reg, uint64_t val, unsigned size) > +{ > + uint64_t wrval; > + uint64_t mask; > + unsigned shift; > + > + if (size == sizeof(uint64_t)) { > + /* 64b access */ > + mask = 0xFFFFFFFFFFFFFFFFUL; > + shift = 0; > + } else { > + /* 32b access */ > + mask = 0x00000000FFFFFFFFUL; > + shift = ((addr & 0x4) == 0x4) ? 32 : 0; > + } > + > + val &= mask; > + val <<= shift; > + mask <<= shift; > + wrval = reg; > + wrval &= ~mask; > + wrval |= val; > + > + return wrval; > +} > + > +static void erst_write(void *opaque, hwaddr addr, > + uint64_t val, unsigned size) > +{ > + ERSTDeviceState *s = (ERSTDeviceState *)opaque; > + > + if (addr < ERST_REG_LEN) { > + /* > + * NOTE: All actions/operations/side effects happen on the WRITE, > + * by design. The READs simply return the reg_value contents. > + */ > + erst_debug("ERST write %016lx: val %016lx sz %u\n", addr, val, size); > + /* The REGISTER region */ > + switch (addr) { > + case ERST_CSR_VALUE + 0: > + case ERST_CSR_VALUE + 4: > + s->reg_value = erst_wr_reg64(addr, s->reg_value, val, size); > + break; > + case ERST_CSR_ACTION + 0: > +/* case ERST_CSR_ACTION+4: as coded, not really a 64b register */ > + switch (val) { > + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: > + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: > + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: > + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: > + case ACPI_ERST_ACTION_END_OPERATION: > + s->operation = val; > + break; > + case ACPI_ERST_ACTION_SET_RECORD_OFFSET: > + s->record_offset = s->reg_value; > + break; > + case ACPI_ERST_ACTION_EXECUTE_OPERATION: > + if ((uint8_t)s->reg_value == ERST_EXECUTE_OPERATION_MAGIC) { > + s->busy_status = 1; > + switch (s->operation) { > + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: > + s->command_status = write_erst_record(s); > + break; > + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: > + s->command_status = read_erst_record(s); > + break; > + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: > + s->command_status = clear_erst_record(s); > + break; > + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: > + s->command_status = ACPI_ERST_STATUS_SUCCESS; > + break; > + case ACPI_ERST_ACTION_END_OPERATION: > + s->command_status = ACPI_ERST_STATUS_SUCCESS; > + break; > + default: > + s->command_status = ACPI_ERST_STATUS_FAILED; > + break; > + } > + s->record_identifier = ERST_INVALID_RECORD_ID; > + s->busy_status = 0; > + } > + break; > + case ACPI_ERST_ACTION_CHECK_BUSY_STATUS: > + s->reg_value = s->busy_status; > + break; > + case ACPI_ERST_ACTION_GET_COMMAND_STATUS: > + s->reg_value = s->command_status; > + break; > + case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER: > + s->command_status = next_erst_record(s, &s->reg_value); > + break; > + case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER: > + s->record_identifier = s->reg_value; > + break; > + case ACPI_ERST_ACTION_GET_RECORD_COUNT: > + s->reg_value = s->record_count; > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE: > + s->reg_value = s->prop_base + ERST_REG_LEN; > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH: > + s->reg_value = ERST_RECORD_SIZE; > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES: > + s->reg_value = 0; /* correct/intended value */ > + break; > + case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS: > + /* > + * 100UL is max, 10UL is nominal > + */ > + s->reg_value = ((100UL << 32) | (10UL << 0)); > + break; > + case ACPI_ERST_ACTION_RESERVED: > + default: > + /* > + * NOP > + */ > + break; > + } > + break; > + default: > + /* > + * All other register writes are NO-OPs > + */ > + break; > + } > + } else { > + /* The RECORD region */ > + unsigned offset = addr - ERST_REG_LEN; > + uint8_t *ptr = &s->record[offset]; > + switch (size) { > + default: > + case sizeof(uint8_t): > + *(uint8_t *)ptr = (uint8_t)val; > + break; > + case sizeof(uint16_t): > + *(uint16_t *)ptr = (uint16_t)val; > + break; > + case sizeof(uint32_t): > + *(uint32_t *)ptr = (uint32_t)val; > + break; > + case sizeof(uint64_t): > + *(uint64_t *)ptr = (uint64_t)val; > + break; > + } > + } > +} > + > +static uint64_t erst_read(void *opaque, hwaddr addr, > + unsigned size) > +{ > + ERSTDeviceState *s = (ERSTDeviceState *)opaque; > + uint64_t val = 0; > + > + if (addr < ERST_REG_LEN) { > + switch (addr) { > + case ERST_CSR_ACTION + 0: > + case ERST_CSR_ACTION + 4: > + val = erst_rd_reg64(addr, s->reg_action, size); > + break; > + case ERST_CSR_VALUE + 0: > + case ERST_CSR_VALUE + 4: > + val = erst_rd_reg64(addr, s->reg_value, size); > + break; > + default: > + break; > + } > + } else { > + /* > + * The RECORD region > + */ > + uint8_t *ptr = &s->record[addr - ERST_REG_LEN]; > + switch (size) { > + default: > + case sizeof(uint8_t): > + val = *(uint8_t *)ptr; > + break; > + case sizeof(uint16_t): > + val = *(uint16_t *)ptr; > + break; > + case sizeof(uint32_t): > + val = *(uint32_t *)ptr; > + break; > + case sizeof(uint64_t): > + val = *(uint64_t *)ptr; > + break; > + } > + } > + erst_debug("ERST read %016lx: val %016lx sz %u\n", addr, val, size); > + return val; > +} > + > +static size_t build_erst_action(GArray *table_data, > + uint8_t serialization_action, > + uint8_t instruction, > + uint8_t flags, > + uint8_t width, > + uint64_t address, > + uint64_t value, > + uint64_t mask) > +{ > + /* See ACPI spec, Error Serialization */ > + uint8_t access_width = 0; > + build_append_int_noprefix(table_data, serialization_action, 1); > + build_append_int_noprefix(table_data, instruction , 1); > + build_append_int_noprefix(table_data, flags , 1); > + build_append_int_noprefix(table_data, 0 , 1); > + /* GAS space_id */ > + build_append_int_noprefix(table_data, AML_SYSTEM_MEMORY , 1); > + /* GAS bit_width */ > + build_append_int_noprefix(table_data, width , 1); > + /* GAS bit_offset */ > + build_append_int_noprefix(table_data, 0 , 1); > + /* GAS access_width */ > + switch (width) { > + case 8: > + access_width = 1; > + break; > + case 16: > + access_width = 2; > + break; > + case 32: > + access_width = 3; > + break; > + case 64: > + access_width = 4; > + break; > + default: > + access_width = 0; > + break; > + } > + build_append_int_noprefix(table_data, access_width , 1); > + /* GAS address */ > + build_append_int_noprefix(table_data, address, 8); > + /* value */ > + build_append_int_noprefix(table_data, value , 8); > + /* mask */ > + build_append_int_noprefix(table_data, mask , 8); > + > + return 1; > +} > + > +static const MemoryRegionOps erst_rw_ops = { > + .read = erst_read, > + .write = erst_write, > + .endianness = DEVICE_NATIVE_ENDIAN, > +}; > + > +void build_erst(GArray *table_data, BIOSLinker *linker, > + const char *oem_id, const char *oem_table_id) > +{ > + unsigned action, insns = 0; > + unsigned erst_start = table_data->len; > + unsigned iec_offset = 0; > + Object *obj; > + hwaddr base = 0x0UL; > + > + obj = object_resolve_path_type("", TYPE_ACPI_ERST, NULL); > + if (obj) { > + base = ACPIERST(obj)->prop_base; > + } > + > + /* See ACPI spec, Error Serialization */ > + acpi_data_push(table_data, sizeof(AcpiTableHeader)); > + /* serialization_header_length */ > + build_append_int_noprefix(table_data, 48, 4); > + /* reserved */ > + build_append_int_noprefix(table_data, 0, 4); > + iec_offset = table_data->len; > + /* instruction_entry_count (placeholder) */ > + build_append_int_noprefix(table_data, 0, 4); > + > +#define BEA(I, F, W, ADDR, VAL, MASK) \ > + build_erst_action(table_data, action, \ > + ACPI_ERST_INST_##I, F, W, base + ADDR, VAL, MASK) > +#define MASK8 0x00000000000000FFUL > +#define MASK16 0x000000000000FFFFUL > +#define MASK32 0x00000000FFFFFFFFUL > +#define MASK64 0xFFFFFFFFFFFFFFFFUL > + > + for (action = 0; action < ACPI_ERST_MAX_ACTIONS; ++action) { > + switch (action) { > + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_END_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_SET_RECORD_OFFSET: > + insns += BEA(WRITE_REGISTER , 0, 32, > + ERST_CSR_VALUE , 0, MASK32); > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_EXECUTE_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_VALUE , ERST_EXECUTE_OPERATION_MAGIC, MASK8); > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_CHECK_BUSY_STATUS: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER_VALUE , 0, 32, > + ERST_CSR_VALUE, 0x01, MASK8); > + break; > + case ACPI_ERST_ACTION_GET_COMMAND_STATUS: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 32, > + ERST_CSR_VALUE, 0, MASK8); > + break; > + case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 64, > + ERST_CSR_VALUE, 0, MASK64); > + break; > + case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER: > + insns += BEA(WRITE_REGISTER , 0, 64, > + ERST_CSR_VALUE , 0, MASK64); > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_GET_RECORD_COUNT: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 32, > + ERST_CSR_VALUE, 0, MASK32); > + break; > + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_RESERVED: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 64, > + ERST_CSR_VALUE, 0, MASK64); > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 64, > + ERST_CSR_VALUE, 0, MASK32); > + break; > + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 32, > + ERST_CSR_VALUE, 0, MASK32); > + break; > + case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS: > + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, > + ERST_CSR_ACTION, action, MASK8); > + insns += BEA(READ_REGISTER , 0, 64, > + ERST_CSR_VALUE, 0, MASK64); > + default: > + insns += BEA(NOOP, 0, 0, 0, action, 0); > + break; > + } > + } > + > + /* acpi_data_push() within BEA() can result in new GArray pointer */ > + *(uint32_t *)(table_data->data + iec_offset) = cpu_to_le32(insns); > + > + build_header(linker, table_data, > + (void *)(table_data->data + erst_start), > + "ERST", table_data->len - erst_start, > + 1, oem_id, oem_table_id); > +} > + > +/*******************************************************************/ > +/*******************************************************************/ > +static int erst_post_load(void *opaque, int version_id) > +{ > + /*ERSTDeviceState *s = opaque;*/ > + erst_debug("+erst_post_load(%d)\n", version_id); > + /* Ensure nvram persists into backing file */ > + erst_debug("-erst_post_load()\n"); > + return 0; > +} > + > +static const VMStateDescription erst_vmstate = { > + .name = "acpi-erst", > + .version_id = 1, > + .minimum_version_id = 1, > + .post_load = erst_post_load, > + .fields = (VMStateField[]) { > + VMSTATE_UINT8(operation, ERSTDeviceState), > + VMSTATE_UINT8(busy_status, ERSTDeviceState), > + VMSTATE_UINT8(command_status, ERSTDeviceState), > + VMSTATE_UINT32(record_offset, ERSTDeviceState), > + VMSTATE_UINT32(record_count, ERSTDeviceState), > + VMSTATE_UINT64(reg_action, ERSTDeviceState), > + VMSTATE_UINT64(reg_value, ERSTDeviceState), > + VMSTATE_UINT64(record_identifier, ERSTDeviceState), > + VMSTATE_UINT8_ARRAY(record, ERSTDeviceState, ERST_RECORD_SIZE), > + VMSTATE_UINT8_ARRAY(tmp_record, ERSTDeviceState, ERST_RECORD_SIZE), > + VMSTATE_END_OF_LIST() > + } > +}; > + > +static void erst_realizefn(DeviceState *dev, Error **errp) > +{ > + SysBusDevice *d = SYS_BUS_DEVICE(dev); > + ERSTDeviceState *s = ACPIERST(dev); > + unsigned index = 0; > + > + erst_debug("+erst_realizefn()\n"); > + > + if (!(s->prop_size > ERST_RECORD_SIZE) && > + (s->prop_size <= 0x04000000)) { > + error_setg(errp, "'size' property %d is not set properly", > + s->prop_size); > + return; > + } > + > + if (!s->prop_path) { > + s->prop_path = (char *)(TYPE_ACPI_ERST ".backing"); > + } > + > + s->hostmem = NULL; > + s->hostmem_obj = object_new(TYPE_MEMORY_BACKEND_FILE); > + object_property_set_str(s->hostmem_obj, "mem-path", s->prop_path, &error_fatal); > + object_property_set_bool(s->hostmem_obj, "share", true, &error_fatal); > + > + /* MemoryBackend upsizes to a PAGE_SIZE multiple for prop_size */ > + object_property_set_int(s->hostmem_obj, "size", s->prop_size, &error_fatal); > + user_creatable_complete(USER_CREATABLE(s->hostmem_obj), &error_fatal); instead of manually creating backend, let user to specify it. i.e. -object memory-backend-file,id=erst_backend,mem-path=/foo[,size=x] \ -device acpi-erst,backend=erst_backend that way way you should be able to drop above hunk + code that duplicates back-end's properties (i.e. path and size) > + s->hostmem = MEMORY_BACKEND(s->hostmem_obj); see hw/mem/pc-dimm.c for an example how to work with user provided back-end, i.e: 1: DEFINE_PROP_LINK(PC_DIMM_MEMDEV_PROP, PCDIMMDevice, hostmem, 2: host_memory_backend_get_memory(dimm->hostmem); > + > + /* Convert prop_size to integer multiple of ERST_RECORD_SIZE */ > + s->prop_size -= (s->prop_size % ERST_RECORD_SIZE); > + > + /* > + * MemoryBackend initializes contents to zero, but we actually > + * want contents initialized to 0xFF. > + */ > + if (copy_from_nvram_by_index(s, 0) == ACPI_ERST_STATUS_SUCCESS) { > + if (s->tmp_record[0] == 0x00) { > + memset(s->tmp_record, 0xFF, ERST_RECORD_SIZE); > + index = 0; > + while (copy_to_nvram_by_index(s, index) == ACPI_ERST_STATUS_SUCCESS) { > + ++index; > + } > + } > + } > + > + /* Initialize record_count */ > + get_erst_record_count(s); > + > + erst_debug(ACPI_ERST_BASE_PROP" %016llx\n", (unsigned long long)s->prop_base); > + erst_debug(ACPI_ERST_SIZE_PROP" %x\n", s->prop_size); > + erst_debug(ACPI_ERST_FILE_PROP" %s\n", s->prop_path); > + > + memory_region_init_io(&s->iomem, OBJECT(s), &erst_rw_ops, s, > + TYPE_ACPI_ERST, ERST_IOMEM_SIZE); > + sysbus_init_mmio(d, &s->iomem); > + erst_debug("-erst_realizefn()\n"); > +} > + > +static void erst_unrealizefn(DeviceState *dev) > +{ > + ERSTDeviceState *s = ACPIERST(dev); > + > + erst_debug("+erst_unrealizefn()\n"); > + > + if (s->hostmem_obj) { > + object_unref(s->hostmem_obj); > + } > + > + erst_debug("-erst_unrealizefn()\n"); > +} > + > +static void erst_reset(DeviceState *dev) > +{ > + ERSTDeviceState *s = ACPIERST(dev); > + > + erst_debug("+erst_reset(%p) %d\n", s, s->record_count); > + s->operation = 0; > + s->busy_status = 0; > + s->command_status = ACPI_ERST_STATUS_SUCCESS; > + /* indicate empty/no-more until further notice */ > + s->record_identifier = ERST_INVALID_RECORD_ID; > + s->record_offset = 0; > + s->next_record_index = 0; > + /* NOTE: record_count and nvram are initialized elsewhere */ > + erst_debug("-erst_reset()\n"); > +} > + > +void setup_erst_dev(hwaddr base, Error *error_fatal) > +{ > + SysBusDevice *s; > + DeviceState *dev; > + ERSTDeviceState *e; > + > + dev = qdev_try_new(TYPE_ACPI_ERST); > + if (!dev) { > + error_report("couldn't create ERST device"); > + exit(1); > + } > + e = ACPIERST(dev); > + e->prop_base = base; > + s = SYS_BUS_DEVICE(dev); > + sysbus_realize_and_unref(s, &error_fatal); > + sysbus_mmio_map(s, 0, base); This approach hasn't been addressed from v2 review (so all issues brings are still here) Have you tried using PCI device instead of SYSBUS one, as was suggested earlier? > +} > + > +static Property erst_properties[] = { > + DEFINE_PROP_UINT32(ACPI_ERST_SIZE_PROP, ERSTDeviceState, prop_size, 0x00010000), > + DEFINE_PROP_STRING(ACPI_ERST_FILE_PROP, ERSTDeviceState, prop_path), > + DEFINE_PROP_END_OF_LIST(), > +}; > + > +static void erst_class_init(ObjectClass *klass, void *data) > +{ > + DeviceClass *dc = DEVICE_CLASS(klass); > + > + erst_debug("+erst_class_init()\n"); > + dc->realize = erst_realizefn; > + dc->unrealize = erst_unrealizefn; > + dc->reset = erst_reset; > + dc->vmsd = &erst_vmstate; > + device_class_set_props(dc, erst_properties); > + dc->desc = "ACPI Error Record Serialization Table (ERST) device"; > + set_bit(DEVICE_CATEGORY_MISC, dc->categories); > + erst_debug("-erst_class_init()\n"); > +} > + > +static const TypeInfo erst_type_info = { > + .name = TYPE_ACPI_ERST, > + .parent = TYPE_SYS_BUS_DEVICE, > + .class_init = erst_class_init, > + .instance_size = sizeof(ERSTDeviceState), > +}; > + > +static void erst_register_types(void) > +{ > + type_register_static(&erst_type_info); > +} > + > +type_init(erst_register_types)
diff --git a/hw/acpi/erst.c b/hw/acpi/erst.c new file mode 100644 index 0000000..645a904 --- /dev/null +++ b/hw/acpi/erst.c @@ -0,0 +1,902 @@ +/* + * ACPI Error Record Serialization Table, ERST, Implementation + * + * Copyright (c) 2021 Oracle and/or its affiliates. + * + * See ACPI specification, + * "ACPI Platform Error Interfaces" : "Error Serialization" + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2 of the License. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see <http://www.gnu.org/licenses/> + */ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/sysbus.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" + +#ifdef _ERST_DEBUG +#define erst_debug(fmt, ...) \ + do { fprintf(stderr, fmt, ## __VA_ARGS__); fflush(stderr); } while (0) +#else +#define erst_debug(fmt, ...) do { } while (0) +#endif + +/* See UEFI spec, Appendix N Common Platform Error Record */ +/* UEFI CPER allows for an OSPM book keeping area in the record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_SIZE_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD(ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID(ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +#define ERST_INVALID_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_CSR_ACTION (0UL << 3) /* action (cmd) */ +#define ERST_CSR_VALUE (1UL << 3) /* argument/value (data) */ + +/* + * As ERST_IOMEM_SIZE is used to map the ERST into the guest, + * it should/must be an integer multiple of PAGE_SIZE. + * NOTE that any change to this value will make any pre- + * existing backing files, not of the same ERST_IOMEM_SIZE, + * unusable to the guest. + */ +#define ERST_IOMEM_SIZE (2UL * 4096) + +/* + * This implementation is an ACTION (cmd) and VALUE (data) + * interface consisting of just two 64-bit registers. + */ +#define ERST_REG_LEN (2UL * sizeof(uint64_t)) + +/* + * The space not utilized by the register interface is the + * buffer for exchanging ERST record contents. + */ +#define ERST_RECORD_SIZE (ERST_IOMEM_SIZE - ERST_REG_LEN) + +/* + * Mode to be used for backing file + */ +#define ACPIERST(obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) +#define ACPIERST_CLASS(oc) \ + OBJECT_CLASS_CHECK(ERSTDeviceStateClass, (oc), TYPE_ACPI_ERST) +#define ACPIERST_GET_CLASS(obj) \ + OBJECT_GET_CLASS(ERSTDeviceStateClass, (obj), TYPE_ACPI_ERST) + +typedef struct { + SysBusDevice parent_obj; + Object *hostmem_obj; + HostMemoryBackend *hostmem; + + MemoryRegion iomem; + uint32_t prop_size; + hwaddr prop_base; + char *prop_path; + + uint8_t operation; + uint8_t busy_status; + uint8_t command_status; + uint32_t record_offset; + uint32_t record_count; + uint64_t reg_action; + uint64_t reg_value; + uint64_t record_identifier; + + unsigned next_record_index; + uint8_t record[ERST_RECORD_SIZE]; /* read/written directly by guest */ + uint8_t tmp_record[ERST_RECORD_SIZE]; /* intermediate manipulation buffer */ + +} ERSTDeviceState; + +static unsigned copy_from_nvram_by_index(ERSTDeviceState *s, unsigned index) +{ + /* Read an nvram entry into tmp_record */ + unsigned rc = ACPI_ERST_STATUS_FAILED; + off_t offset = (index * ERST_RECORD_SIZE); + + if ((offset + ERST_RECORD_SIZE) <= s->prop_size) { + MemoryRegion *mr; + mr = host_memory_backend_get_memory(s->hostmem); + if (mr) { + uint8_t *p = (uint8_t *)memory_region_get_ram_ptr(mr); + memcpy(s->tmp_record, p + offset, ERST_RECORD_SIZE); + rc = ACPI_ERST_STATUS_SUCCESS; + } + } + return rc; +} + +static unsigned copy_to_nvram_by_index(ERSTDeviceState *s, unsigned index) +{ + /* Write entry in tmp_record into nvram, and backing file */ + unsigned rc = ACPI_ERST_STATUS_FAILED; + off_t offset = (index * ERST_RECORD_SIZE); + + if ((offset + ERST_RECORD_SIZE) <= s->prop_size) { + MemoryRegion *mr; + mr = host_memory_backend_get_memory(s->hostmem); + if (mr) { + uint8_t *p = (uint8_t *)memory_region_get_ram_ptr(mr); + memcpy(p + offset, s->tmp_record, ERST_RECORD_SIZE); + rc = ACPI_ERST_STATUS_SUCCESS; + } + } + return rc; +} + +static int lookup_erst_record_by_identifier(ERSTDeviceState *s, + uint64_t record_identifier, bool *record_found, bool alloc_for_write) +{ + int rc = -1; + int empty_index = -1; + int index = 0; + unsigned rrc; + + *record_found = 0; + + do { + rrc = copy_from_nvram_by_index(s, (unsigned)index); + if (rrc == ACPI_ERST_STATUS_SUCCESS) { + uint64_t this_identifier; + this_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record); + if (IS_UEFI_CPER_RECORD(s->tmp_record) && + (this_identifier == record_identifier)) { + rc = index; + *record_found = 1; + break; + } + if ((this_identifier == ERST_INVALID_RECORD_ID) && + (empty_index < 0)) { + empty_index = index; /* first available for write */ + } + } + ++index; + } while (rrc == ACPI_ERST_STATUS_SUCCESS); + + /* Record not found, allocate for writing */ + if ((rc < 0) && alloc_for_write) { + rc = empty_index; + } + + return rc; +} + +static unsigned clear_erst_record(ERSTDeviceState *s) +{ + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; + bool record_found; + int index; + + index = lookup_erst_record_by_identifier(s, + s->record_identifier, &record_found, 0); + if (record_found) { + memset(s->tmp_record, 0xFF, ERST_RECORD_SIZE); + rc = copy_to_nvram_by_index(s, (unsigned)index); + if (rc == ACPI_ERST_STATUS_SUCCESS) { + s->record_count -= 1; + } + } + + return rc; +} + +static unsigned write_erst_record(ERSTDeviceState *s) +{ + unsigned rc = ACPI_ERST_STATUS_FAILED; + + if (s->record_offset < (ERST_RECORD_SIZE - UEFI_CPER_RECORD_MIN_SIZE)) { + uint64_t record_identifier; + uint8_t *record = &s->record[s->record_offset]; + bool record_found; + int index; + + record_identifier = (s->record_identifier == ERST_INVALID_RECORD_ID) + ? THE_UEFI_CPER_RECORD_ID(record) : s->record_identifier; + + index = lookup_erst_record_by_identifier(s, + record_identifier, &record_found, 1); + if (index < 0) { + rc = ACPI_ERST_STATUS_NOT_ENOUGH_SPACE; + } else { + if (0 != s->record_offset) { + memset(&s->tmp_record[ERST_RECORD_SIZE - s->record_offset], + 0xFF, s->record_offset); + } + memcpy(s->tmp_record, record, ERST_RECORD_SIZE - s->record_offset); + rc = copy_to_nvram_by_index(s, (unsigned)index); + if (rc == ACPI_ERST_STATUS_SUCCESS) { + if (!record_found) { /* not overwriting existing record */ + s->record_count += 1; /* writing new record */ + } + } + } + } + + return rc; +} + +static unsigned next_erst_record(ERSTDeviceState *s, + uint64_t *record_identifier) +{ + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; + unsigned index; + unsigned rrc; + + *record_identifier = ERST_INVALID_RECORD_ID; + + index = s->next_record_index; + do { + rrc = copy_from_nvram_by_index(s, (unsigned)index); + if (rrc == ACPI_ERST_STATUS_SUCCESS) { + if (IS_UEFI_CPER_RECORD(s->tmp_record)) { + s->next_record_index = index + 1; /* where to start next time */ + *record_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record); + rc = ACPI_ERST_STATUS_SUCCESS; + break; + } + ++index; + } else { + if (s->next_record_index == 0) { + rc = ACPI_ERST_STATUS_RECORD_STORE_EMPTY; + } + s->next_record_index = 0; /* at end, reset */ + } + } while (rrc == ACPI_ERST_STATUS_SUCCESS); + + return rc; +} + +static unsigned read_erst_record(ERSTDeviceState *s) +{ + unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND; + bool record_found; + int index; + + index = lookup_erst_record_by_identifier(s, + s->record_identifier, &record_found, 0); + if (record_found) { + rc = copy_from_nvram_by_index(s, (unsigned)index); + if (rc == ACPI_ERST_STATUS_SUCCESS) { + if (s->record_offset < ERST_RECORD_SIZE) { + memcpy(&s->record[s->record_offset], s->tmp_record, + ERST_RECORD_SIZE - s->record_offset); + } + } + } + + return rc; +} + +static unsigned get_erst_record_count(ERSTDeviceState *s) +{ + /* Compute record_count */ + unsigned index = 0; + + s->record_count = 0; + while (copy_from_nvram_by_index(s, index) == ACPI_ERST_STATUS_SUCCESS) { + uint8_t *ptr = &s->tmp_record[0]; + uint64_t record_identifier = THE_UEFI_CPER_RECORD_ID(ptr); + if (IS_UEFI_CPER_RECORD(ptr) && + (ERST_INVALID_RECORD_ID != record_identifier)) { + s->record_count += 1; + } + ++index; + } + return s->record_count; +} + +static uint64_t erst_rd_reg64(hwaddr addr, + uint64_t reg, unsigned size) +{ + uint64_t rdval; + uint64_t mask; + unsigned shift; + + if (size == sizeof(uint64_t)) { + /* 64b access */ + mask = 0xFFFFFFFFFFFFFFFFUL; + shift = 0; + } else { + /* 32b access */ + mask = 0x00000000FFFFFFFFUL; + shift = ((addr & 0x4) == 0x4) ? 32 : 0; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + + return rdval; +} + +static uint64_t erst_wr_reg64(hwaddr addr, + uint64_t reg, uint64_t val, unsigned size) +{ + uint64_t wrval; + uint64_t mask; + unsigned shift; + + if (size == sizeof(uint64_t)) { + /* 64b access */ + mask = 0xFFFFFFFFFFFFFFFFUL; + shift = 0; + } else { + /* 32b access */ + mask = 0x00000000FFFFFFFFUL; + shift = ((addr & 0x4) == 0x4) ? 32 : 0; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + + return wrval; +} + +static void erst_write(void *opaque, hwaddr addr, + uint64_t val, unsigned size) +{ + ERSTDeviceState *s = (ERSTDeviceState *)opaque; + + if (addr < ERST_REG_LEN) { + /* + * NOTE: All actions/operations/side effects happen on the WRITE, + * by design. The READs simply return the reg_value contents. + */ + erst_debug("ERST write %016lx: val %016lx sz %u\n", addr, val, size); + /* The REGISTER region */ + switch (addr) { + case ERST_CSR_VALUE + 0: + case ERST_CSR_VALUE + 4: + s->reg_value = erst_wr_reg64(addr, s->reg_value, val, size); + break; + case ERST_CSR_ACTION + 0: +/* case ERST_CSR_ACTION+4: as coded, not really a 64b register */ + switch (val) { + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: + case ACPI_ERST_ACTION_END_OPERATION: + s->operation = val; + break; + case ACPI_ERST_ACTION_SET_RECORD_OFFSET: + s->record_offset = s->reg_value; + break; + case ACPI_ERST_ACTION_EXECUTE_OPERATION: + if ((uint8_t)s->reg_value == ERST_EXECUTE_OPERATION_MAGIC) { + s->busy_status = 1; + switch (s->operation) { + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: + s->command_status = write_erst_record(s); + break; + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: + s->command_status = read_erst_record(s); + break; + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: + s->command_status = clear_erst_record(s); + break; + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: + s->command_status = ACPI_ERST_STATUS_SUCCESS; + break; + case ACPI_ERST_ACTION_END_OPERATION: + s->command_status = ACPI_ERST_STATUS_SUCCESS; + break; + default: + s->command_status = ACPI_ERST_STATUS_FAILED; + break; + } + s->record_identifier = ERST_INVALID_RECORD_ID; + s->busy_status = 0; + } + break; + case ACPI_ERST_ACTION_CHECK_BUSY_STATUS: + s->reg_value = s->busy_status; + break; + case ACPI_ERST_ACTION_GET_COMMAND_STATUS: + s->reg_value = s->command_status; + break; + case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER: + s->command_status = next_erst_record(s, &s->reg_value); + break; + case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER: + s->record_identifier = s->reg_value; + break; + case ACPI_ERST_ACTION_GET_RECORD_COUNT: + s->reg_value = s->record_count; + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE: + s->reg_value = s->prop_base + ERST_REG_LEN; + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH: + s->reg_value = ERST_RECORD_SIZE; + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES: + s->reg_value = 0; /* correct/intended value */ + break; + case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS: + /* + * 100UL is max, 10UL is nominal + */ + s->reg_value = ((100UL << 32) | (10UL << 0)); + break; + case ACPI_ERST_ACTION_RESERVED: + default: + /* + * NOP + */ + break; + } + break; + default: + /* + * All other register writes are NO-OPs + */ + break; + } + } else { + /* The RECORD region */ + unsigned offset = addr - ERST_REG_LEN; + uint8_t *ptr = &s->record[offset]; + switch (size) { + default: + case sizeof(uint8_t): + *(uint8_t *)ptr = (uint8_t)val; + break; + case sizeof(uint16_t): + *(uint16_t *)ptr = (uint16_t)val; + break; + case sizeof(uint32_t): + *(uint32_t *)ptr = (uint32_t)val; + break; + case sizeof(uint64_t): + *(uint64_t *)ptr = (uint64_t)val; + break; + } + } +} + +static uint64_t erst_read(void *opaque, hwaddr addr, + unsigned size) +{ + ERSTDeviceState *s = (ERSTDeviceState *)opaque; + uint64_t val = 0; + + if (addr < ERST_REG_LEN) { + switch (addr) { + case ERST_CSR_ACTION + 0: + case ERST_CSR_ACTION + 4: + val = erst_rd_reg64(addr, s->reg_action, size); + break; + case ERST_CSR_VALUE + 0: + case ERST_CSR_VALUE + 4: + val = erst_rd_reg64(addr, s->reg_value, size); + break; + default: + break; + } + } else { + /* + * The RECORD region + */ + uint8_t *ptr = &s->record[addr - ERST_REG_LEN]; + switch (size) { + default: + case sizeof(uint8_t): + val = *(uint8_t *)ptr; + break; + case sizeof(uint16_t): + val = *(uint16_t *)ptr; + break; + case sizeof(uint32_t): + val = *(uint32_t *)ptr; + break; + case sizeof(uint64_t): + val = *(uint64_t *)ptr; + break; + } + } + erst_debug("ERST read %016lx: val %016lx sz %u\n", addr, val, size); + return val; +} + +static size_t build_erst_action(GArray *table_data, + uint8_t serialization_action, + uint8_t instruction, + uint8_t flags, + uint8_t width, + uint64_t address, + uint64_t value, + uint64_t mask) +{ + /* See ACPI spec, Error Serialization */ + uint8_t access_width = 0; + build_append_int_noprefix(table_data, serialization_action, 1); + build_append_int_noprefix(table_data, instruction , 1); + build_append_int_noprefix(table_data, flags , 1); + build_append_int_noprefix(table_data, 0 , 1); + /* GAS space_id */ + build_append_int_noprefix(table_data, AML_SYSTEM_MEMORY , 1); + /* GAS bit_width */ + build_append_int_noprefix(table_data, width , 1); + /* GAS bit_offset */ + build_append_int_noprefix(table_data, 0 , 1); + /* GAS access_width */ + switch (width) { + case 8: + access_width = 1; + break; + case 16: + access_width = 2; + break; + case 32: + access_width = 3; + break; + case 64: + access_width = 4; + break; + default: + access_width = 0; + break; + } + build_append_int_noprefix(table_data, access_width , 1); + /* GAS address */ + build_append_int_noprefix(table_data, address, 8); + /* value */ + build_append_int_noprefix(table_data, value , 8); + /* mask */ + build_append_int_noprefix(table_data, mask , 8); + + return 1; +} + +static const MemoryRegionOps erst_rw_ops = { + .read = erst_read, + .write = erst_write, + .endianness = DEVICE_NATIVE_ENDIAN, +}; + +void build_erst(GArray *table_data, BIOSLinker *linker, + const char *oem_id, const char *oem_table_id) +{ + unsigned action, insns = 0; + unsigned erst_start = table_data->len; + unsigned iec_offset = 0; + Object *obj; + hwaddr base = 0x0UL; + + obj = object_resolve_path_type("", TYPE_ACPI_ERST, NULL); + if (obj) { + base = ACPIERST(obj)->prop_base; + } + + /* See ACPI spec, Error Serialization */ + acpi_data_push(table_data, sizeof(AcpiTableHeader)); + /* serialization_header_length */ + build_append_int_noprefix(table_data, 48, 4); + /* reserved */ + build_append_int_noprefix(table_data, 0, 4); + iec_offset = table_data->len; + /* instruction_entry_count (placeholder) */ + build_append_int_noprefix(table_data, 0, 4); + +#define BEA(I, F, W, ADDR, VAL, MASK) \ + build_erst_action(table_data, action, \ + ACPI_ERST_INST_##I, F, W, base + ADDR, VAL, MASK) +#define MASK8 0x00000000000000FFUL +#define MASK16 0x000000000000FFFFUL +#define MASK32 0x00000000FFFFFFFFUL +#define MASK64 0xFFFFFFFFFFFFFFFFUL + + for (action = 0; action < ACPI_ERST_MAX_ACTIONS; ++action) { + switch (action) { + case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_BEGIN_READ_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_END_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_SET_RECORD_OFFSET: + insns += BEA(WRITE_REGISTER , 0, 32, + ERST_CSR_VALUE , 0, MASK32); + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_EXECUTE_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_VALUE , ERST_EXECUTE_OPERATION_MAGIC, MASK8); + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_CHECK_BUSY_STATUS: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER_VALUE , 0, 32, + ERST_CSR_VALUE, 0x01, MASK8); + break; + case ACPI_ERST_ACTION_GET_COMMAND_STATUS: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 32, + ERST_CSR_VALUE, 0, MASK8); + break; + case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 64, + ERST_CSR_VALUE, 0, MASK64); + break; + case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER: + insns += BEA(WRITE_REGISTER , 0, 64, + ERST_CSR_VALUE , 0, MASK64); + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_GET_RECORD_COUNT: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 32, + ERST_CSR_VALUE, 0, MASK32); + break; + case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_RESERVED: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 64, + ERST_CSR_VALUE, 0, MASK64); + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 64, + ERST_CSR_VALUE, 0, MASK32); + break; + case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 32, + ERST_CSR_VALUE, 0, MASK32); + break; + case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS: + insns += BEA(WRITE_REGISTER_VALUE, 0, 32, + ERST_CSR_ACTION, action, MASK8); + insns += BEA(READ_REGISTER , 0, 64, + ERST_CSR_VALUE, 0, MASK64); + default: + insns += BEA(NOOP, 0, 0, 0, action, 0); + break; + } + } + + /* acpi_data_push() within BEA() can result in new GArray pointer */ + *(uint32_t *)(table_data->data + iec_offset) = cpu_to_le32(insns); + + build_header(linker, table_data, + (void *)(table_data->data + erst_start), + "ERST", table_data->len - erst_start, + 1, oem_id, oem_table_id); +} + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load(void *opaque, int version_id) +{ + /*ERSTDeviceState *s = opaque;*/ + erst_debug("+erst_post_load(%d)\n", version_id); + /* Ensure nvram persists into backing file */ + erst_debug("-erst_post_load()\n"); + return 0; +} + +static const VMStateDescription erst_vmstate = { + .name = "acpi-erst", + .version_id = 1, + .minimum_version_id = 1, + .post_load = erst_post_load, + .fields = (VMStateField[]) { + VMSTATE_UINT8(operation, ERSTDeviceState), + VMSTATE_UINT8(busy_status, ERSTDeviceState), + VMSTATE_UINT8(command_status, ERSTDeviceState), + VMSTATE_UINT32(record_offset, ERSTDeviceState), + VMSTATE_UINT32(record_count, ERSTDeviceState), + VMSTATE_UINT64(reg_action, ERSTDeviceState), + VMSTATE_UINT64(reg_value, ERSTDeviceState), + VMSTATE_UINT64(record_identifier, ERSTDeviceState), + VMSTATE_UINT8_ARRAY(record, ERSTDeviceState, ERST_RECORD_SIZE), + VMSTATE_UINT8_ARRAY(tmp_record, ERSTDeviceState, ERST_RECORD_SIZE), + VMSTATE_END_OF_LIST() + } +}; + +static void erst_realizefn(DeviceState *dev, Error **errp) +{ + SysBusDevice *d = SYS_BUS_DEVICE(dev); + ERSTDeviceState *s = ACPIERST(dev); + unsigned index = 0; + + erst_debug("+erst_realizefn()\n"); + + if (!(s->prop_size > ERST_RECORD_SIZE) && + (s->prop_size <= 0x04000000)) { + error_setg(errp, "'size' property %d is not set properly", + s->prop_size); + return; + } + + if (!s->prop_path) { + s->prop_path = (char *)(TYPE_ACPI_ERST ".backing"); + } + + s->hostmem = NULL; + s->hostmem_obj = object_new(TYPE_MEMORY_BACKEND_FILE); + object_property_set_str(s->hostmem_obj, "mem-path", s->prop_path, &error_fatal); + object_property_set_bool(s->hostmem_obj, "share", true, &error_fatal); + + /* MemoryBackend upsizes to a PAGE_SIZE multiple for prop_size */ + object_property_set_int(s->hostmem_obj, "size", s->prop_size, &error_fatal); + user_creatable_complete(USER_CREATABLE(s->hostmem_obj), &error_fatal); + s->hostmem = MEMORY_BACKEND(s->hostmem_obj); + + /* Convert prop_size to integer multiple of ERST_RECORD_SIZE */ + s->prop_size -= (s->prop_size % ERST_RECORD_SIZE); + + /* + * MemoryBackend initializes contents to zero, but we actually + * want contents initialized to 0xFF. + */ + if (copy_from_nvram_by_index(s, 0) == ACPI_ERST_STATUS_SUCCESS) { + if (s->tmp_record[0] == 0x00) { + memset(s->tmp_record, 0xFF, ERST_RECORD_SIZE); + index = 0; + while (copy_to_nvram_by_index(s, index) == ACPI_ERST_STATUS_SUCCESS) { + ++index; + } + } + } + + /* Initialize record_count */ + get_erst_record_count(s); + + erst_debug(ACPI_ERST_BASE_PROP" %016llx\n", (unsigned long long)s->prop_base); + erst_debug(ACPI_ERST_SIZE_PROP" %x\n", s->prop_size); + erst_debug(ACPI_ERST_FILE_PROP" %s\n", s->prop_path); + + memory_region_init_io(&s->iomem, OBJECT(s), &erst_rw_ops, s, + TYPE_ACPI_ERST, ERST_IOMEM_SIZE); + sysbus_init_mmio(d, &s->iomem); + erst_debug("-erst_realizefn()\n"); +} + +static void erst_unrealizefn(DeviceState *dev) +{ + ERSTDeviceState *s = ACPIERST(dev); + + erst_debug("+erst_unrealizefn()\n"); + + if (s->hostmem_obj) { + object_unref(s->hostmem_obj); + } + + erst_debug("-erst_unrealizefn()\n"); +} + +static void erst_reset(DeviceState *dev) +{ + ERSTDeviceState *s = ACPIERST(dev); + + erst_debug("+erst_reset(%p) %d\n", s, s->record_count); + s->operation = 0; + s->busy_status = 0; + s->command_status = ACPI_ERST_STATUS_SUCCESS; + /* indicate empty/no-more until further notice */ + s->record_identifier = ERST_INVALID_RECORD_ID; + s->record_offset = 0; + s->next_record_index = 0; + /* NOTE: record_count and nvram are initialized elsewhere */ + erst_debug("-erst_reset()\n"); +} + +void setup_erst_dev(hwaddr base, Error *error_fatal) +{ + SysBusDevice *s; + DeviceState *dev; + ERSTDeviceState *e; + + dev = qdev_try_new(TYPE_ACPI_ERST); + if (!dev) { + error_report("couldn't create ERST device"); + exit(1); + } + e = ACPIERST(dev); + e->prop_base = base; + s = SYS_BUS_DEVICE(dev); + sysbus_realize_and_unref(s, &error_fatal); + sysbus_mmio_map(s, 0, base); +} + +static Property erst_properties[] = { + DEFINE_PROP_UINT32(ACPI_ERST_SIZE_PROP, ERSTDeviceState, prop_size, 0x00010000), + DEFINE_PROP_STRING(ACPI_ERST_FILE_PROP, ERSTDeviceState, prop_path), + DEFINE_PROP_END_OF_LIST(), +}; + +static void erst_class_init(ObjectClass *klass, void *data) +{ + DeviceClass *dc = DEVICE_CLASS(klass); + + erst_debug("+erst_class_init()\n"); + dc->realize = erst_realizefn; + dc->unrealize = erst_unrealizefn; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + device_class_set_props(dc, erst_properties); + dc->desc = "ACPI Error Record Serialization Table (ERST) device"; + set_bit(DEVICE_CATEGORY_MISC, dc->categories); + erst_debug("-erst_class_init()\n"); +} + +static const TypeInfo erst_type_info = { + .name = TYPE_ACPI_ERST, + .parent = TYPE_SYS_BUS_DEVICE, + .class_init = erst_class_init, + .instance_size = sizeof(ERSTDeviceState), +}; + +static void erst_register_types(void) +{ + type_register_static(&erst_type_info); +} + +type_init(erst_register_types)
This change implements the support for the ACPI ERST feature[1,2]. The size of the ACPI ERST storage is declared via the QEMU global parameter acpi-erst.size. The size can range from 64KiB to to 64MiB. The default is 64KiB. The location of the ACPI ERST storage backing file is declared via the QEMU global parameter acpi-erst.file. The default is acpi-erst.backing. [1] "Advanced Configuration and Power Interface Specification", version 6.2, May 2017. https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf [2] "Unified Extensible Firmware Interface Specification", version 2.8, March 2019. https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf Signed-off-by: Eric DeVolder <eric.devolder@oracle.com> --- hw/acpi/erst.c | 902 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 902 insertions(+) create mode 100644 hw/acpi/erst.c