xref: /qemu/hw/i386/fw_cfg.c (revision e3404e01)
1 /*
2  * QEMU fw_cfg helpers (X86 specific)
3  *
4  * Copyright (c) 2019 Red Hat, Inc.
5  *
6  * Author:
7  *   Philippe Mathieu-Daudé <philmd@redhat.com>
8  *
9  * SPDX-License-Identifier: GPL-2.0-or-later
10  *
11  * This work is licensed under the terms of the GNU GPL, version 2 or later.
12  * See the COPYING file in the top-level directory.
13  */
14 
15 #include "qemu/osdep.h"
16 #include "sysemu/numa.h"
17 #include "hw/acpi/acpi.h"
18 #include "hw/acpi/aml-build.h"
19 #include "hw/firmware/smbios.h"
20 #include "hw/i386/fw_cfg.h"
21 #include "hw/timer/hpet.h"
22 #include "hw/nvram/fw_cfg.h"
23 #include "e820_memory_layout.h"
24 #include "kvm/kvm_i386.h"
25 #include "qapi/error.h"
26 #include CONFIG_DEVICES
27 #include "target/i386/cpu.h"
28 
29 struct hpet_fw_config hpet_cfg = {.count = UINT8_MAX};
30 
31 const char *fw_cfg_arch_key_name(uint16_t key)
32 {
33     static const struct {
34         uint16_t key;
35         const char *name;
36     } fw_cfg_arch_wellknown_keys[] = {
37         {FW_CFG_ACPI_TABLES, "acpi_tables"},
38         {FW_CFG_SMBIOS_ENTRIES, "smbios_entries"},
39         {FW_CFG_IRQ0_OVERRIDE, "irq0_override"},
40         {FW_CFG_HPET, "hpet"},
41     };
42 
43     for (size_t i = 0; i < ARRAY_SIZE(fw_cfg_arch_wellknown_keys); i++) {
44         if (fw_cfg_arch_wellknown_keys[i].key == key) {
45             return fw_cfg_arch_wellknown_keys[i].name;
46         }
47     }
48     return NULL;
49 }
50 
51 void fw_cfg_build_smbios(PCMachineState *pcms, FWCfgState *fw_cfg,
52                          SmbiosEntryPointType ep_type)
53 {
54 #ifdef CONFIG_SMBIOS
55     uint8_t *smbios_tables, *smbios_anchor;
56     size_t smbios_tables_len, smbios_anchor_len;
57     struct smbios_phys_mem_area *mem_array;
58     unsigned i, array_count;
59     MachineState *ms = MACHINE(pcms);
60     PCMachineClass *pcmc = PC_MACHINE_GET_CLASS(pcms);
61     MachineClass *mc = MACHINE_GET_CLASS(pcms);
62     X86CPU *cpu = X86_CPU(ms->possible_cpus->cpus[0].cpu);
63 
64     if (pcmc->smbios_defaults) {
65         /* These values are guest ABI, do not change */
66         smbios_set_defaults("QEMU", mc->desc, mc->name,
67                             pcmc->smbios_uuid_encoded);
68     }
69 
70     /* tell smbios about cpuid version and features */
71     smbios_set_cpuid(cpu->env.cpuid_version, cpu->env.features[FEAT_1_EDX]);
72 
73     if (pcmc->smbios_legacy_mode) {
74         smbios_tables = smbios_get_table_legacy(&smbios_tables_len,
75                                                 &error_fatal);
76         fw_cfg_add_bytes(fw_cfg, FW_CFG_SMBIOS_ENTRIES,
77                          smbios_tables, smbios_tables_len);
78         return;
79     }
80 
81     /* build the array of physical mem area from e820 table */
82     mem_array = g_malloc0(sizeof(*mem_array) * e820_get_num_entries());
83     for (i = 0, array_count = 0; i < e820_get_num_entries(); i++) {
84         uint64_t addr, len;
85 
86         if (e820_get_entry(i, E820_RAM, &addr, &len)) {
87             mem_array[array_count].address = addr;
88             mem_array[array_count].length = len;
89             array_count++;
90         }
91     }
92     smbios_get_tables(ms, ep_type, mem_array, array_count,
93                       &smbios_tables, &smbios_tables_len,
94                       &smbios_anchor, &smbios_anchor_len,
95                       &error_fatal);
96     g_free(mem_array);
97 
98     if (smbios_anchor) {
99         fw_cfg_add_file(fw_cfg, "etc/smbios/smbios-tables",
100                         smbios_tables, smbios_tables_len);
101         fw_cfg_add_file(fw_cfg, "etc/smbios/smbios-anchor",
102                         smbios_anchor, smbios_anchor_len);
103     }
104 #endif
105 }
106 
107 FWCfgState *fw_cfg_arch_create(MachineState *ms,
108                                       uint16_t boot_cpus,
109                                       uint16_t apic_id_limit)
110 {
111     FWCfgState *fw_cfg;
112     uint64_t *numa_fw_cfg;
113     int i;
114     MachineClass *mc = MACHINE_GET_CLASS(ms);
115     const CPUArchIdList *cpus = mc->possible_cpu_arch_ids(ms);
116     int nb_numa_nodes = ms->numa_state->num_nodes;
117 
118     fw_cfg = fw_cfg_init_io_dma(FW_CFG_IO_BASE, FW_CFG_IO_BASE + 4,
119                                 &address_space_memory);
120     fw_cfg_add_i16(fw_cfg, FW_CFG_NB_CPUS, boot_cpus);
121 
122     /* FW_CFG_MAX_CPUS is a bit confusing/problematic on x86:
123      *
124      * For machine types prior to 1.8, SeaBIOS needs FW_CFG_MAX_CPUS for
125      * building MPTable, ACPI MADT, ACPI CPU hotplug and ACPI SRAT table,
126      * that tables are based on xAPIC ID and QEMU<->SeaBIOS interface
127      * for CPU hotplug also uses APIC ID and not "CPU index".
128      * This means that FW_CFG_MAX_CPUS is not the "maximum number of CPUs",
129      * but the "limit to the APIC ID values SeaBIOS may see".
130      *
131      * So for compatibility reasons with old BIOSes we are stuck with
132      * "etc/max-cpus" actually being apic_id_limit
133      */
134     fw_cfg_add_i16(fw_cfg, FW_CFG_MAX_CPUS, apic_id_limit);
135     fw_cfg_add_i64(fw_cfg, FW_CFG_RAM_SIZE, ms->ram_size);
136 #ifdef CONFIG_ACPI
137     fw_cfg_add_bytes(fw_cfg, FW_CFG_ACPI_TABLES,
138                      acpi_tables, acpi_tables_len);
139 #endif
140     fw_cfg_add_i32(fw_cfg, FW_CFG_IRQ0_OVERRIDE, 1);
141 
142     fw_cfg_add_file(fw_cfg, "etc/e820", e820_table,
143                     sizeof(struct e820_entry) * e820_get_num_entries());
144 
145     fw_cfg_add_bytes(fw_cfg, FW_CFG_HPET, &hpet_cfg, sizeof(hpet_cfg));
146     /* allocate memory for the NUMA channel: one (64bit) word for the number
147      * of nodes, one word for each VCPU->node and one word for each node to
148      * hold the amount of memory.
149      */
150     numa_fw_cfg = g_new0(uint64_t, 1 + apic_id_limit + nb_numa_nodes);
151     numa_fw_cfg[0] = cpu_to_le64(nb_numa_nodes);
152     for (i = 0; i < cpus->len; i++) {
153         unsigned int apic_id = cpus->cpus[i].arch_id;
154         assert(apic_id < apic_id_limit);
155         numa_fw_cfg[apic_id + 1] = cpu_to_le64(cpus->cpus[i].props.node_id);
156     }
157     for (i = 0; i < nb_numa_nodes; i++) {
158         numa_fw_cfg[apic_id_limit + 1 + i] =
159             cpu_to_le64(ms->numa_state->nodes[i].node_mem);
160     }
161     fw_cfg_add_bytes(fw_cfg, FW_CFG_NUMA, numa_fw_cfg,
162                      (1 + apic_id_limit + nb_numa_nodes) *
163                      sizeof(*numa_fw_cfg));
164 
165     return fw_cfg;
166 }
167 
168 void fw_cfg_build_feature_control(MachineState *ms, FWCfgState *fw_cfg)
169 {
170     X86CPU *cpu = X86_CPU(ms->possible_cpus->cpus[0].cpu);
171     CPUX86State *env = &cpu->env;
172     uint32_t unused, ebx, ecx, edx;
173     uint64_t feature_control_bits = 0;
174     uint64_t *val;
175 
176     cpu_x86_cpuid(env, 1, 0, &unused, &unused, &ecx, &edx);
177     if (ecx & CPUID_EXT_VMX) {
178         feature_control_bits |= FEATURE_CONTROL_VMXON_ENABLED_OUTSIDE_SMX;
179     }
180 
181     if ((edx & (CPUID_EXT2_MCE | CPUID_EXT2_MCA)) ==
182         (CPUID_EXT2_MCE | CPUID_EXT2_MCA) &&
183         (env->mcg_cap & MCG_LMCE_P)) {
184         feature_control_bits |= FEATURE_CONTROL_LMCE;
185     }
186 
187     if (env->cpuid_level >= 7) {
188         cpu_x86_cpuid(env, 0x7, 0, &unused, &ebx, &ecx, &unused);
189         if (ebx & CPUID_7_0_EBX_SGX) {
190             feature_control_bits |= FEATURE_CONTROL_SGX;
191         }
192         if (ecx & CPUID_7_0_ECX_SGX_LC) {
193             feature_control_bits |= FEATURE_CONTROL_SGX_LC;
194         }
195     }
196 
197     if (!feature_control_bits) {
198         return;
199     }
200 
201     val = g_malloc(sizeof(*val));
202     *val = cpu_to_le64(feature_control_bits | FEATURE_CONTROL_LOCKED);
203     fw_cfg_add_file(fw_cfg, "etc/msr_feature_control", val, sizeof(*val));
204 }
205 
206 void fw_cfg_add_acpi_dsdt(Aml *scope, FWCfgState *fw_cfg)
207 {
208     /*
209      * when using port i/o, the 8-bit data register *always* overlaps
210      * with half of the 16-bit control register. Hence, the total size
211      * of the i/o region used is FW_CFG_CTL_SIZE; when using DMA, the
212      * DMA control register is located at FW_CFG_DMA_IO_BASE + 4
213      */
214     Object *obj = OBJECT(fw_cfg);
215     uint8_t io_size = object_property_get_bool(obj, "dma_enabled", NULL) ?
216         ROUND_UP(FW_CFG_CTL_SIZE, 4) + sizeof(dma_addr_t) :
217         FW_CFG_CTL_SIZE;
218     Aml *dev = aml_device("FWCF");
219     Aml *crs = aml_resource_template();
220 
221     aml_append(dev, aml_name_decl("_HID", aml_string("QEMU0002")));
222 
223     /* device present, functioning, decoding, not shown in UI */
224     aml_append(dev, aml_name_decl("_STA", aml_int(0xB)));
225 
226     aml_append(crs,
227         aml_io(AML_DECODE16, FW_CFG_IO_BASE, FW_CFG_IO_BASE, 0x01, io_size));
228 
229     aml_append(dev, aml_name_decl("_CRS", crs));
230     aml_append(scope, dev);
231 }
232