xref: /openbmc/qemu/include/hw/i386/pc.h (revision dbdf841b)
1 #ifndef HW_PC_H
2 #define HW_PC_H
3 
4 #include "qemu/notify.h"
5 #include "qapi/qapi-types-common.h"
6 #include "qemu/uuid.h"
7 #include "hw/boards.h"
8 #include "hw/block/fdc.h"
9 #include "hw/block/flash.h"
10 #include "hw/i386/x86.h"
11 
12 #include "hw/hotplug.h"
13 #include "qom/object.h"
14 #include "hw/i386/sgx-epc.h"
15 #include "hw/firmware/smbios.h"
16 #include "hw/cxl/cxl.h"
17 
18 #define HPET_INTCAP "hpet-intcap"
19 
20 /**
21  * PCMachineState:
22  * @acpi_dev: link to ACPI PM device that performs ACPI hotplug handling
23  * @boot_cpus: number of present VCPUs
24  */
25 typedef struct PCMachineState {
26     /*< private >*/
27     X86MachineState parent_obj;
28 
29     /* <public> */
30 
31     /* State for other subsystems/APIs: */
32     Notifier machine_done;
33 
34     /* Pointers to devices and objects: */
35     PCIBus *bus;
36     I2CBus *smbus;
37     PFlashCFI01 *flash[2];
38     ISADevice *pcspk;
39     DeviceState *iommu;
40 
41     /* Configuration options: */
42     uint64_t max_ram_below_4g;
43     OnOffAuto vmport;
44     SmbiosEntryPointType smbios_entry_point_type;
45 
46     bool acpi_build_enabled;
47     bool smbus_enabled;
48     bool sata_enabled;
49     bool hpet_enabled;
50     bool i8042_enabled;
51     bool default_bus_bypass_iommu;
52     uint64_t max_fw_size;
53 
54     /* ACPI Memory hotplug IO base address */
55     hwaddr memhp_io_base;
56 
57     SGXEPCState sgx_epc;
58     CXLState cxl_devices_state;
59 } PCMachineState;
60 
61 #define PC_MACHINE_ACPI_DEVICE_PROP "acpi-device"
62 #define PC_MACHINE_MAX_RAM_BELOW_4G "max-ram-below-4g"
63 #define PC_MACHINE_VMPORT           "vmport"
64 #define PC_MACHINE_SMBUS            "smbus"
65 #define PC_MACHINE_SATA             "sata"
66 #define PC_MACHINE_I8042            "i8042"
67 #define PC_MACHINE_MAX_FW_SIZE      "max-fw-size"
68 #define PC_MACHINE_SMBIOS_EP        "smbios-entry-point-type"
69 
70 /**
71  * PCMachineClass:
72  *
73  * Compat fields:
74  *
75  * @enforce_aligned_dimm: check that DIMM's address/size is aligned by
76  *                        backend's alignment value if provided
77  * @acpi_data_size: Size of the chunk of memory at the top of RAM
78  *                  for the BIOS ACPI tables and other BIOS
79  *                  datastructures.
80  * @gigabyte_align: Make sure that guest addresses aligned at
81  *                  1Gbyte boundaries get mapped to host
82  *                  addresses aligned at 1Gbyte boundaries. This
83  *                  way we can use 1GByte pages in the host.
84  *
85  */
86 struct PCMachineClass {
87     /*< private >*/
88     X86MachineClass parent_class;
89 
90     /*< public >*/
91 
92     /* Device configuration: */
93     bool pci_enabled;
94     bool kvmclock_enabled;
95 
96     /* Compat options: */
97 
98     /* Default CPU model version.  See x86_cpu_set_default_version(). */
99     int default_cpu_version;
100 
101     /* ACPI compat: */
102     bool has_acpi_build;
103     bool rsdp_in_ram;
104     int legacy_acpi_table_size;
105     unsigned acpi_data_size;
106     int pci_root_uid;
107 
108     /* SMBIOS compat: */
109     bool smbios_defaults;
110     bool smbios_legacy_mode;
111     bool smbios_uuid_encoded;
112     SmbiosEntryPointType default_smbios_ep_type;
113 
114     /* RAM / address space compat: */
115     bool gigabyte_align;
116     bool has_reserved_memory;
117     bool enforce_aligned_dimm;
118     bool broken_reserved_end;
119     bool enforce_amd_1tb_hole;
120 
121     /* generate legacy CPU hotplug AML */
122     bool legacy_cpu_hotplug;
123 
124     /* use PVH to load kernels that support this feature */
125     bool pvh_enabled;
126 
127     /* create kvmclock device even when KVM PV features are not exposed */
128     bool kvmclock_create_always;
129 
130     /* resizable acpi blob compat */
131     bool resizable_acpi_blob;
132 };
133 
134 #define TYPE_PC_MACHINE "generic-pc-machine"
135 OBJECT_DECLARE_TYPE(PCMachineState, PCMachineClass, PC_MACHINE)
136 
137 /* ioapic.c */
138 
139 GSIState *pc_gsi_create(qemu_irq **irqs, bool pci_enabled);
140 
141 /* pc.c */
142 extern int fd_bootchk;
143 
144 void pc_acpi_smi_interrupt(void *opaque, int irq, int level);
145 
146 void pc_guest_info_init(PCMachineState *pcms);
147 
148 #define PCI_HOST_PROP_RAM_MEM          "ram-mem"
149 #define PCI_HOST_PROP_PCI_MEM          "pci-mem"
150 #define PCI_HOST_PROP_SYSTEM_MEM       "system-mem"
151 #define PCI_HOST_PROP_IO_MEM           "io-mem"
152 #define PCI_HOST_PROP_PCI_HOLE_START   "pci-hole-start"
153 #define PCI_HOST_PROP_PCI_HOLE_END     "pci-hole-end"
154 #define PCI_HOST_PROP_PCI_HOLE64_START "pci-hole64-start"
155 #define PCI_HOST_PROP_PCI_HOLE64_END   "pci-hole64-end"
156 #define PCI_HOST_PROP_PCI_HOLE64_SIZE  "pci-hole64-size"
157 #define PCI_HOST_BELOW_4G_MEM_SIZE     "below-4g-mem-size"
158 #define PCI_HOST_ABOVE_4G_MEM_SIZE     "above-4g-mem-size"
159 
160 
161 void pc_pci_as_mapping_init(MemoryRegion *system_memory,
162                             MemoryRegion *pci_address_space);
163 
164 void xen_load_linux(PCMachineState *pcms);
165 void pc_memory_init(PCMachineState *pcms,
166                     MemoryRegion *system_memory,
167                     MemoryRegion *rom_memory,
168                     uint64_t pci_hole64_size);
169 uint64_t pc_pci_hole64_start(void);
170 DeviceState *pc_vga_init(ISABus *isa_bus, PCIBus *pci_bus);
171 void pc_basic_device_init(struct PCMachineState *pcms,
172                           ISABus *isa_bus, qemu_irq *gsi,
173                           ISADevice *rtc_state,
174                           bool create_fdctrl,
175                           uint32_t hpet_irqs);
176 void pc_cmos_init(PCMachineState *pcms,
177                   BusState *ide0, BusState *ide1,
178                   ISADevice *s);
179 void pc_nic_init(PCMachineClass *pcmc, ISABus *isa_bus, PCIBus *pci_bus);
180 
181 void pc_i8259_create(ISABus *isa_bus, qemu_irq *i8259_irqs);
182 
183 /* port92.c */
184 #define PORT92_A20_LINE "a20"
185 
186 #define TYPE_PORT92 "port92"
187 
188 /* pc_sysfw.c */
189 void pc_system_flash_create(PCMachineState *pcms);
190 void pc_system_flash_cleanup_unused(PCMachineState *pcms);
191 void pc_system_firmware_init(PCMachineState *pcms, MemoryRegion *rom_memory);
192 bool pc_system_ovmf_table_find(const char *entry, uint8_t **data,
193                                int *data_len);
194 void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size);
195 
196 /* hw/i386/acpi-common.c */
197 void pc_madt_cpu_entry(int uid, const CPUArchIdList *apic_ids,
198                        GArray *entry, bool force_enabled);
199 
200 /* sgx.c */
201 void pc_machine_init_sgx_epc(PCMachineState *pcms);
202 
203 extern GlobalProperty pc_compat_8_0[];
204 extern const size_t pc_compat_8_0_len;
205 
206 extern GlobalProperty pc_compat_7_2[];
207 extern const size_t pc_compat_7_2_len;
208 
209 extern GlobalProperty pc_compat_7_1[];
210 extern const size_t pc_compat_7_1_len;
211 
212 extern GlobalProperty pc_compat_7_0[];
213 extern const size_t pc_compat_7_0_len;
214 
215 extern GlobalProperty pc_compat_6_2[];
216 extern const size_t pc_compat_6_2_len;
217 
218 extern GlobalProperty pc_compat_6_1[];
219 extern const size_t pc_compat_6_1_len;
220 
221 extern GlobalProperty pc_compat_6_0[];
222 extern const size_t pc_compat_6_0_len;
223 
224 extern GlobalProperty pc_compat_5_2[];
225 extern const size_t pc_compat_5_2_len;
226 
227 extern GlobalProperty pc_compat_5_1[];
228 extern const size_t pc_compat_5_1_len;
229 
230 extern GlobalProperty pc_compat_5_0[];
231 extern const size_t pc_compat_5_0_len;
232 
233 extern GlobalProperty pc_compat_4_2[];
234 extern const size_t pc_compat_4_2_len;
235 
236 extern GlobalProperty pc_compat_4_1[];
237 extern const size_t pc_compat_4_1_len;
238 
239 extern GlobalProperty pc_compat_4_0[];
240 extern const size_t pc_compat_4_0_len;
241 
242 extern GlobalProperty pc_compat_3_1[];
243 extern const size_t pc_compat_3_1_len;
244 
245 extern GlobalProperty pc_compat_3_0[];
246 extern const size_t pc_compat_3_0_len;
247 
248 extern GlobalProperty pc_compat_2_12[];
249 extern const size_t pc_compat_2_12_len;
250 
251 extern GlobalProperty pc_compat_2_11[];
252 extern const size_t pc_compat_2_11_len;
253 
254 extern GlobalProperty pc_compat_2_10[];
255 extern const size_t pc_compat_2_10_len;
256 
257 extern GlobalProperty pc_compat_2_9[];
258 extern const size_t pc_compat_2_9_len;
259 
260 extern GlobalProperty pc_compat_2_8[];
261 extern const size_t pc_compat_2_8_len;
262 
263 extern GlobalProperty pc_compat_2_7[];
264 extern const size_t pc_compat_2_7_len;
265 
266 extern GlobalProperty pc_compat_2_6[];
267 extern const size_t pc_compat_2_6_len;
268 
269 extern GlobalProperty pc_compat_2_5[];
270 extern const size_t pc_compat_2_5_len;
271 
272 extern GlobalProperty pc_compat_2_4[];
273 extern const size_t pc_compat_2_4_len;
274 
275 extern GlobalProperty pc_compat_2_3[];
276 extern const size_t pc_compat_2_3_len;
277 
278 extern GlobalProperty pc_compat_2_2[];
279 extern const size_t pc_compat_2_2_len;
280 
281 extern GlobalProperty pc_compat_2_1[];
282 extern const size_t pc_compat_2_1_len;
283 
284 extern GlobalProperty pc_compat_2_0[];
285 extern const size_t pc_compat_2_0_len;
286 
287 extern GlobalProperty pc_compat_1_7[];
288 extern const size_t pc_compat_1_7_len;
289 
290 extern GlobalProperty pc_compat_1_6[];
291 extern const size_t pc_compat_1_6_len;
292 
293 extern GlobalProperty pc_compat_1_5[];
294 extern const size_t pc_compat_1_5_len;
295 
296 extern GlobalProperty pc_compat_1_4[];
297 extern const size_t pc_compat_1_4_len;
298 
299 int pc_machine_kvm_type(MachineState *machine, const char *vm_type);
300 
301 #define DEFINE_PC_MACHINE(suffix, namestr, initfn, optsfn) \
302     static void pc_machine_##suffix##_class_init(ObjectClass *oc, void *data) \
303     { \
304         MachineClass *mc = MACHINE_CLASS(oc); \
305         optsfn(mc); \
306         mc->init = initfn; \
307         mc->kvm_type = pc_machine_kvm_type; \
308     } \
309     static const TypeInfo pc_machine_type_##suffix = { \
310         .name       = namestr TYPE_MACHINE_SUFFIX, \
311         .parent     = TYPE_PC_MACHINE, \
312         .class_init = pc_machine_##suffix##_class_init, \
313     }; \
314     static void pc_machine_init_##suffix(void) \
315     { \
316         type_register(&pc_machine_type_##suffix); \
317     } \
318     type_init(pc_machine_init_##suffix)
319 
320 #endif
321