xref: /openbmc/qemu/hw/i386/fw_cfg.c (revision b2580720)
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     }
68 
69     /* tell smbios about cpuid version and features */
70     smbios_set_cpuid(cpu->env.cpuid_version, cpu->env.features[FEAT_1_EDX]);
71 
72     if (pcmc->smbios_legacy_mode) {
73         smbios_tables = smbios_get_table_legacy(&smbios_tables_len,
74                                                 &error_fatal);
75         fw_cfg_add_bytes(fw_cfg, FW_CFG_SMBIOS_ENTRIES,
76                          smbios_tables, smbios_tables_len);
77         return;
78     }
79 
80     /* build the array of physical mem area from e820 table */
81     mem_array = g_malloc0(sizeof(*mem_array) * e820_get_num_entries());
82     for (i = 0, array_count = 0; i < e820_get_num_entries(); i++) {
83         uint64_t addr, len;
84 
85         if (e820_get_entry(i, E820_RAM, &addr, &len)) {
86             mem_array[array_count].address = addr;
87             mem_array[array_count].length = len;
88             array_count++;
89         }
90     }
91     smbios_get_tables(ms, ep_type, mem_array, array_count,
92                       &smbios_tables, &smbios_tables_len,
93                       &smbios_anchor, &smbios_anchor_len,
94                       &error_fatal);
95     g_free(mem_array);
96 
97     if (smbios_anchor) {
98         fw_cfg_add_file(fw_cfg, "etc/smbios/smbios-tables",
99                         smbios_tables, smbios_tables_len);
100         fw_cfg_add_file(fw_cfg, "etc/smbios/smbios-anchor",
101                         smbios_anchor, smbios_anchor_len);
102     }
103 #endif
104 }
105 
106 FWCfgState *fw_cfg_arch_create(MachineState *ms,
107                                       uint16_t boot_cpus,
108                                       uint16_t apic_id_limit)
109 {
110     FWCfgState *fw_cfg;
111     uint64_t *numa_fw_cfg;
112     int i;
113     MachineClass *mc = MACHINE_GET_CLASS(ms);
114     const CPUArchIdList *cpus = mc->possible_cpu_arch_ids(ms);
115     int nb_numa_nodes = ms->numa_state->num_nodes;
116 
117     fw_cfg = fw_cfg_init_io_dma(FW_CFG_IO_BASE, FW_CFG_IO_BASE + 4,
118                                 &address_space_memory);
119     fw_cfg_add_i16(fw_cfg, FW_CFG_NB_CPUS, boot_cpus);
120 
121     /* FW_CFG_MAX_CPUS is a bit confusing/problematic on x86:
122      *
123      * For machine types prior to 1.8, SeaBIOS needs FW_CFG_MAX_CPUS for
124      * building MPTable, ACPI MADT, ACPI CPU hotplug and ACPI SRAT table,
125      * that tables are based on xAPIC ID and QEMU<->SeaBIOS interface
126      * for CPU hotplug also uses APIC ID and not "CPU index".
127      * This means that FW_CFG_MAX_CPUS is not the "maximum number of CPUs",
128      * but the "limit to the APIC ID values SeaBIOS may see".
129      *
130      * So for compatibility reasons with old BIOSes we are stuck with
131      * "etc/max-cpus" actually being apic_id_limit
132      */
133     fw_cfg_add_i16(fw_cfg, FW_CFG_MAX_CPUS, apic_id_limit);
134     fw_cfg_add_i64(fw_cfg, FW_CFG_RAM_SIZE, ms->ram_size);
135 #ifdef CONFIG_ACPI
136     fw_cfg_add_bytes(fw_cfg, FW_CFG_ACPI_TABLES,
137                      acpi_tables, acpi_tables_len);
138 #endif
139     fw_cfg_add_i32(fw_cfg, FW_CFG_IRQ0_OVERRIDE, 1);
140 
141     fw_cfg_add_file(fw_cfg, "etc/e820", e820_table,
142                     sizeof(struct e820_entry) * e820_get_num_entries());
143 
144     fw_cfg_add_bytes(fw_cfg, FW_CFG_HPET, &hpet_cfg, sizeof(hpet_cfg));
145     /* allocate memory for the NUMA channel: one (64bit) word for the number
146      * of nodes, one word for each VCPU->node and one word for each node to
147      * hold the amount of memory.
148      */
149     numa_fw_cfg = g_new0(uint64_t, 1 + apic_id_limit + nb_numa_nodes);
150     numa_fw_cfg[0] = cpu_to_le64(nb_numa_nodes);
151     for (i = 0; i < cpus->len; i++) {
152         unsigned int apic_id = cpus->cpus[i].arch_id;
153         assert(apic_id < apic_id_limit);
154         numa_fw_cfg[apic_id + 1] = cpu_to_le64(cpus->cpus[i].props.node_id);
155     }
156     for (i = 0; i < nb_numa_nodes; i++) {
157         numa_fw_cfg[apic_id_limit + 1 + i] =
158             cpu_to_le64(ms->numa_state->nodes[i].node_mem);
159     }
160     fw_cfg_add_bytes(fw_cfg, FW_CFG_NUMA, numa_fw_cfg,
161                      (1 + apic_id_limit + nb_numa_nodes) *
162                      sizeof(*numa_fw_cfg));
163 
164     return fw_cfg;
165 }
166 
167 void fw_cfg_build_feature_control(MachineState *ms, FWCfgState *fw_cfg)
168 {
169     X86CPU *cpu = X86_CPU(ms->possible_cpus->cpus[0].cpu);
170     CPUX86State *env = &cpu->env;
171     uint32_t unused, ebx, ecx, edx;
172     uint64_t feature_control_bits = 0;
173     uint64_t *val;
174 
175     cpu_x86_cpuid(env, 1, 0, &unused, &unused, &ecx, &edx);
176     if (ecx & CPUID_EXT_VMX) {
177         feature_control_bits |= FEATURE_CONTROL_VMXON_ENABLED_OUTSIDE_SMX;
178     }
179 
180     if ((edx & (CPUID_EXT2_MCE | CPUID_EXT2_MCA)) ==
181         (CPUID_EXT2_MCE | CPUID_EXT2_MCA) &&
182         (env->mcg_cap & MCG_LMCE_P)) {
183         feature_control_bits |= FEATURE_CONTROL_LMCE;
184     }
185 
186     if (env->cpuid_level >= 7) {
187         cpu_x86_cpuid(env, 0x7, 0, &unused, &ebx, &ecx, &unused);
188         if (ebx & CPUID_7_0_EBX_SGX) {
189             feature_control_bits |= FEATURE_CONTROL_SGX;
190         }
191         if (ecx & CPUID_7_0_ECX_SGX_LC) {
192             feature_control_bits |= FEATURE_CONTROL_SGX_LC;
193         }
194     }
195 
196     if (!feature_control_bits) {
197         return;
198     }
199 
200     val = g_malloc(sizeof(*val));
201     *val = cpu_to_le64(feature_control_bits | FEATURE_CONTROL_LOCKED);
202     fw_cfg_add_file(fw_cfg, "etc/msr_feature_control", val, sizeof(*val));
203 }
204 
205 #ifdef CONFIG_ACPI
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 #endif
233