xref: /openbmc/qemu/include/hw/i386/pc.h (revision 03b39fcf64bc958e3223e1d696f9de06de904fc6)
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/acpi/acpi_dev_interface.h"
13 #include "hw/hotplug.h"
14 #include "qom/object.h"
15 #include "hw/i386/sgx-epc.h"
16 #include "hw/firmware/smbios.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 } PCMachineState;
59 
60 #define PC_MACHINE_ACPI_DEVICE_PROP "acpi-device"
61 #define PC_MACHINE_MAX_RAM_BELOW_4G "max-ram-below-4g"
62 #define PC_MACHINE_DEVMEM_REGION_SIZE "device-memory-region-size"
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     const char *default_nic_model;
96 
97     /* Compat options: */
98 
99     /* Default CPU model version.  See x86_cpu_set_default_version(). */
100     int default_cpu_version;
101 
102     /* ACPI compat: */
103     bool has_acpi_build;
104     bool rsdp_in_ram;
105     int legacy_acpi_table_size;
106     unsigned acpi_data_size;
107     int pci_root_uid;
108 
109     /* SMBIOS compat: */
110     bool smbios_defaults;
111     bool smbios_legacy_mode;
112     bool smbios_uuid_encoded;
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 
120     /* generate legacy CPU hotplug AML */
121     bool legacy_cpu_hotplug;
122 
123     /* use PVH to load kernels that support this feature */
124     bool pvh_enabled;
125 
126     /* create kvmclock device even when KVM PV features are not exposed */
127     bool kvmclock_create_always;
128 };
129 
130 #define TYPE_PC_MACHINE "generic-pc-machine"
131 OBJECT_DECLARE_TYPE(PCMachineState, PCMachineClass, PC_MACHINE)
132 
133 /* ioapic.c */
134 
135 GSIState *pc_gsi_create(qemu_irq **irqs, bool pci_enabled);
136 
137 /* pc.c */
138 extern int fd_bootchk;
139 
140 void pc_acpi_smi_interrupt(void *opaque, int irq, int level);
141 
142 void pc_guest_info_init(PCMachineState *pcms);
143 
144 #define PCI_HOST_PROP_PCI_HOLE_START   "pci-hole-start"
145 #define PCI_HOST_PROP_PCI_HOLE_END     "pci-hole-end"
146 #define PCI_HOST_PROP_PCI_HOLE64_START "pci-hole64-start"
147 #define PCI_HOST_PROP_PCI_HOLE64_END   "pci-hole64-end"
148 #define PCI_HOST_PROP_PCI_HOLE64_SIZE  "pci-hole64-size"
149 #define PCI_HOST_BELOW_4G_MEM_SIZE     "below-4g-mem-size"
150 #define PCI_HOST_ABOVE_4G_MEM_SIZE     "above-4g-mem-size"
151 
152 
153 void pc_pci_as_mapping_init(Object *owner, MemoryRegion *system_memory,
154                             MemoryRegion *pci_address_space);
155 
156 void xen_load_linux(PCMachineState *pcms);
157 void pc_memory_init(PCMachineState *pcms,
158                     MemoryRegion *system_memory,
159                     MemoryRegion *rom_memory,
160                     MemoryRegion **ram_memory);
161 uint64_t pc_pci_hole64_start(void);
162 DeviceState *pc_vga_init(ISABus *isa_bus, PCIBus *pci_bus);
163 void pc_basic_device_init(struct PCMachineState *pcms,
164                           ISABus *isa_bus, qemu_irq *gsi,
165                           ISADevice **rtc_state,
166                           bool create_fdctrl,
167                           uint32_t hpet_irqs);
168 void pc_init_ne2k_isa(ISABus *bus, NICInfo *nd);
169 void pc_cmos_init(PCMachineState *pcms,
170                   BusState *ide0, BusState *ide1,
171                   ISADevice *s);
172 void pc_nic_init(PCMachineClass *pcmc, ISABus *isa_bus, PCIBus *pci_bus);
173 void pc_pci_device_init(PCIBus *pci_bus);
174 
175 typedef void (*cpu_set_smm_t)(int smm, void *arg);
176 
177 void pc_i8259_create(ISABus *isa_bus, qemu_irq *i8259_irqs);
178 
179 ISADevice *pc_find_fdc0(void);
180 
181 /* port92.c */
182 #define PORT92_A20_LINE "a20"
183 
184 #define TYPE_PORT92 "port92"
185 
186 /* pc_sysfw.c */
187 void pc_system_flash_create(PCMachineState *pcms);
188 void pc_system_flash_cleanup_unused(PCMachineState *pcms);
189 void pc_system_firmware_init(PCMachineState *pcms, MemoryRegion *rom_memory);
190 bool pc_system_ovmf_table_find(const char *entry, uint8_t **data,
191                                int *data_len);
192 void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size);
193 
194 /* hw/i386/acpi-common.c */
195 void pc_madt_cpu_entry(AcpiDeviceIf *adev, int uid,
196                        const CPUArchIdList *apic_ids, GArray *entry,
197                        bool force_enabled);
198 
199 /* sgx.c */
200 void pc_machine_init_sgx_epc(PCMachineState *pcms);
201 
202 extern GlobalProperty pc_compat_7_0[];
203 extern const size_t pc_compat_7_0_len;
204 
205 extern GlobalProperty pc_compat_6_2[];
206 extern const size_t pc_compat_6_2_len;
207 
208 extern GlobalProperty pc_compat_6_1[];
209 extern const size_t pc_compat_6_1_len;
210 
211 extern GlobalProperty pc_compat_6_0[];
212 extern const size_t pc_compat_6_0_len;
213 
214 extern GlobalProperty pc_compat_5_2[];
215 extern const size_t pc_compat_5_2_len;
216 
217 extern GlobalProperty pc_compat_5_1[];
218 extern const size_t pc_compat_5_1_len;
219 
220 extern GlobalProperty pc_compat_5_0[];
221 extern const size_t pc_compat_5_0_len;
222 
223 extern GlobalProperty pc_compat_4_2[];
224 extern const size_t pc_compat_4_2_len;
225 
226 extern GlobalProperty pc_compat_4_1[];
227 extern const size_t pc_compat_4_1_len;
228 
229 extern GlobalProperty pc_compat_4_0[];
230 extern const size_t pc_compat_4_0_len;
231 
232 extern GlobalProperty pc_compat_3_1[];
233 extern const size_t pc_compat_3_1_len;
234 
235 extern GlobalProperty pc_compat_3_0[];
236 extern const size_t pc_compat_3_0_len;
237 
238 extern GlobalProperty pc_compat_2_12[];
239 extern const size_t pc_compat_2_12_len;
240 
241 extern GlobalProperty pc_compat_2_11[];
242 extern const size_t pc_compat_2_11_len;
243 
244 extern GlobalProperty pc_compat_2_10[];
245 extern const size_t pc_compat_2_10_len;
246 
247 extern GlobalProperty pc_compat_2_9[];
248 extern const size_t pc_compat_2_9_len;
249 
250 extern GlobalProperty pc_compat_2_8[];
251 extern const size_t pc_compat_2_8_len;
252 
253 extern GlobalProperty pc_compat_2_7[];
254 extern const size_t pc_compat_2_7_len;
255 
256 extern GlobalProperty pc_compat_2_6[];
257 extern const size_t pc_compat_2_6_len;
258 
259 extern GlobalProperty pc_compat_2_5[];
260 extern const size_t pc_compat_2_5_len;
261 
262 extern GlobalProperty pc_compat_2_4[];
263 extern const size_t pc_compat_2_4_len;
264 
265 extern GlobalProperty pc_compat_2_3[];
266 extern const size_t pc_compat_2_3_len;
267 
268 extern GlobalProperty pc_compat_2_2[];
269 extern const size_t pc_compat_2_2_len;
270 
271 extern GlobalProperty pc_compat_2_1[];
272 extern const size_t pc_compat_2_1_len;
273 
274 extern GlobalProperty pc_compat_2_0[];
275 extern const size_t pc_compat_2_0_len;
276 
277 extern GlobalProperty pc_compat_1_7[];
278 extern const size_t pc_compat_1_7_len;
279 
280 extern GlobalProperty pc_compat_1_6[];
281 extern const size_t pc_compat_1_6_len;
282 
283 extern GlobalProperty pc_compat_1_5[];
284 extern const size_t pc_compat_1_5_len;
285 
286 extern GlobalProperty pc_compat_1_4[];
287 extern const size_t pc_compat_1_4_len;
288 
289 /* Helper for setting model-id for CPU models that changed model-id
290  * depending on QEMU versions up to QEMU 2.4.
291  */
292 #define PC_CPU_MODEL_IDS(v) \
293     { "qemu32-" TYPE_X86_CPU, "model-id", "QEMU Virtual CPU version " v, },\
294     { "qemu64-" TYPE_X86_CPU, "model-id", "QEMU Virtual CPU version " v, },\
295     { "athlon-" TYPE_X86_CPU, "model-id", "QEMU Virtual CPU version " v, },
296 
297 #define DEFINE_PC_MACHINE(suffix, namestr, initfn, optsfn) \
298     static void pc_machine_##suffix##_class_init(ObjectClass *oc, void *data) \
299     { \
300         MachineClass *mc = MACHINE_CLASS(oc); \
301         optsfn(mc); \
302         mc->init = initfn; \
303     } \
304     static const TypeInfo pc_machine_type_##suffix = { \
305         .name       = namestr TYPE_MACHINE_SUFFIX, \
306         .parent     = TYPE_PC_MACHINE, \
307         .class_init = pc_machine_##suffix##_class_init, \
308     }; \
309     static void pc_machine_init_##suffix(void) \
310     { \
311         type_register(&pc_machine_type_##suffix); \
312     } \
313     type_init(pc_machine_init_##suffix)
314 
315 #endif
316