xref: /openbmc/qemu/include/hw/i386/pc.h (revision c4fc5695b770b597dfbed9271c7d7080311e0097)
1 #ifndef HW_PC_H
2 #define HW_PC_H
3 
4 #include "qemu-common.h"
5 #include "exec/memory.h"
6 #include "hw/boards.h"
7 #include "hw/isa/isa.h"
8 #include "hw/block/fdc.h"
9 #include "net/net.h"
10 #include "hw/i386/ioapic.h"
11 
12 #include "qemu/range.h"
13 #include "qemu/bitmap.h"
14 #include "sysemu/sysemu.h"
15 #include "hw/pci/pci.h"
16 #include "hw/compat.h"
17 #include "hw/mem/pc-dimm.h"
18 #include "hw/mem/nvdimm.h"
19 #include "hw/acpi/acpi_dev_interface.h"
20 
21 #define HPET_INTCAP "hpet-intcap"
22 
23 /**
24  * PCMachineState:
25  * @acpi_dev: link to ACPI PM device that performs ACPI hotplug handling
26  * @boot_cpus: number of present VCPUs
27  */
28 struct PCMachineState {
29     /*< private >*/
30     MachineState parent_obj;
31 
32     /* <public> */
33 
34     /* State for other subsystems/APIs: */
35     Notifier machine_done;
36 
37     /* Pointers to devices and objects: */
38     HotplugHandler *acpi_dev;
39     ISADevice *rtc;
40     PCIBus *bus;
41     FWCfgState *fw_cfg;
42     qemu_irq *gsi;
43 
44     /* Configuration options: */
45     uint64_t max_ram_below_4g;
46     OnOffAuto vmport;
47     OnOffAuto smm;
48 
49     AcpiNVDIMMState acpi_nvdimm_state;
50 
51     bool acpi_build_enabled;
52     bool smbus_enabled;
53     bool sata_enabled;
54     bool pit_enabled;
55 
56     /* RAM information (sizes, addresses, configuration): */
57     ram_addr_t below_4g_mem_size, above_4g_mem_size;
58 
59     /* CPU and apic information: */
60     bool apic_xrupt_override;
61     unsigned apic_id_limit;
62     uint16_t boot_cpus;
63 
64     /* NUMA information: */
65     uint64_t numa_nodes;
66     uint64_t *node_mem;
67 
68     /* Address space used by IOAPIC device. All IOAPIC interrupts
69      * will be translated to MSI messages in the address space. */
70     AddressSpace *ioapic_as;
71 };
72 
73 #define PC_MACHINE_ACPI_DEVICE_PROP "acpi-device"
74 #define PC_MACHINE_DEVMEM_REGION_SIZE "device-memory-region-size"
75 #define PC_MACHINE_MAX_RAM_BELOW_4G "max-ram-below-4g"
76 #define PC_MACHINE_VMPORT           "vmport"
77 #define PC_MACHINE_SMM              "smm"
78 #define PC_MACHINE_NVDIMM           "nvdimm"
79 #define PC_MACHINE_NVDIMM_PERSIST   "nvdimm-persistence"
80 #define PC_MACHINE_SMBUS            "smbus"
81 #define PC_MACHINE_SATA             "sata"
82 #define PC_MACHINE_PIT              "pit"
83 
84 /**
85  * PCMachineClass:
86  *
87  * Compat fields:
88  *
89  * @enforce_aligned_dimm: check that DIMM's address/size is aligned by
90  *                        backend's alignment value if provided
91  * @acpi_data_size: Size of the chunk of memory at the top of RAM
92  *                  for the BIOS ACPI tables and other BIOS
93  *                  datastructures.
94  * @gigabyte_align: Make sure that guest addresses aligned at
95  *                  1Gbyte boundaries get mapped to host
96  *                  addresses aligned at 1Gbyte boundaries. This
97  *                  way we can use 1GByte pages in the host.
98  *
99  */
100 struct PCMachineClass {
101     /*< private >*/
102     MachineClass parent_class;
103 
104     /*< public >*/
105 
106     /* Device configuration: */
107     bool pci_enabled;
108     bool kvmclock_enabled;
109     const char *default_nic_model;
110 
111     /* Compat options: */
112 
113     /* ACPI compat: */
114     bool has_acpi_build;
115     bool rsdp_in_ram;
116     int legacy_acpi_table_size;
117     unsigned acpi_data_size;
118 
119     /* SMBIOS compat: */
120     bool smbios_defaults;
121     bool smbios_legacy_mode;
122     bool smbios_uuid_encoded;
123 
124     /* RAM / address space compat: */
125     bool gigabyte_align;
126     bool has_reserved_memory;
127     bool enforce_aligned_dimm;
128     bool broken_reserved_end;
129 
130     /* TSC rate migration: */
131     bool save_tsc_khz;
132     /* generate legacy CPU hotplug AML */
133     bool legacy_cpu_hotplug;
134 
135     /* use DMA capable linuxboot option rom */
136     bool linuxboot_dma_enabled;
137 };
138 
139 #define TYPE_PC_MACHINE "generic-pc-machine"
140 #define PC_MACHINE(obj) \
141     OBJECT_CHECK(PCMachineState, (obj), TYPE_PC_MACHINE)
142 #define PC_MACHINE_GET_CLASS(obj) \
143     OBJECT_GET_CLASS(PCMachineClass, (obj), TYPE_PC_MACHINE)
144 #define PC_MACHINE_CLASS(klass) \
145     OBJECT_CLASS_CHECK(PCMachineClass, (klass), TYPE_PC_MACHINE)
146 
147 /* i8259.c */
148 
149 extern DeviceState *isa_pic;
150 qemu_irq *i8259_init(ISABus *bus, qemu_irq parent_irq);
151 qemu_irq *kvm_i8259_init(ISABus *bus);
152 int pic_read_irq(DeviceState *d);
153 int pic_get_output(DeviceState *d);
154 
155 /* ioapic.c */
156 
157 /* Global System Interrupts */
158 
159 #define GSI_NUM_PINS IOAPIC_NUM_PINS
160 
161 typedef struct GSIState {
162     qemu_irq i8259_irq[ISA_NUM_IRQS];
163     qemu_irq ioapic_irq[IOAPIC_NUM_PINS];
164 } GSIState;
165 
166 void gsi_handler(void *opaque, int n, int level);
167 
168 /* vmport.c */
169 #define TYPE_VMPORT "vmport"
170 typedef uint32_t (VMPortReadFunc)(void *opaque, uint32_t address);
171 
172 static inline void vmport_init(ISABus *bus)
173 {
174     isa_create_simple(bus, TYPE_VMPORT);
175 }
176 
177 void vmport_register(unsigned char command, VMPortReadFunc *func, void *opaque);
178 void vmmouse_get_data(uint32_t *data);
179 void vmmouse_set_data(const uint32_t *data);
180 
181 /* pc.c */
182 extern int fd_bootchk;
183 
184 bool pc_machine_is_smm_enabled(PCMachineState *pcms);
185 void pc_register_ferr_irq(qemu_irq irq);
186 void pc_acpi_smi_interrupt(void *opaque, int irq, int level);
187 
188 void pc_cpus_init(PCMachineState *pcms);
189 void pc_hot_add_cpu(const int64_t id, Error **errp);
190 void pc_acpi_init(const char *default_dsdt);
191 
192 void pc_guest_info_init(PCMachineState *pcms);
193 
194 #define PCI_HOST_PROP_PCI_HOLE_START   "pci-hole-start"
195 #define PCI_HOST_PROP_PCI_HOLE_END     "pci-hole-end"
196 #define PCI_HOST_PROP_PCI_HOLE64_START "pci-hole64-start"
197 #define PCI_HOST_PROP_PCI_HOLE64_END   "pci-hole64-end"
198 #define PCI_HOST_PROP_PCI_HOLE64_SIZE  "pci-hole64-size"
199 #define PCI_HOST_BELOW_4G_MEM_SIZE     "below-4g-mem-size"
200 #define PCI_HOST_ABOVE_4G_MEM_SIZE     "above-4g-mem-size"
201 
202 
203 void pc_pci_as_mapping_init(Object *owner, MemoryRegion *system_memory,
204                             MemoryRegion *pci_address_space);
205 
206 void xen_load_linux(PCMachineState *pcms);
207 void pc_memory_init(PCMachineState *pcms,
208                     MemoryRegion *system_memory,
209                     MemoryRegion *rom_memory,
210                     MemoryRegion **ram_memory);
211 uint64_t pc_pci_hole64_start(void);
212 qemu_irq pc_allocate_cpu_irq(void);
213 DeviceState *pc_vga_init(ISABus *isa_bus, PCIBus *pci_bus);
214 void pc_basic_device_init(ISABus *isa_bus, qemu_irq *gsi,
215                           ISADevice **rtc_state,
216                           bool create_fdctrl,
217                           bool no_vmport,
218                           bool has_pit,
219                           uint32_t hpet_irqs);
220 void pc_init_ne2k_isa(ISABus *bus, NICInfo *nd);
221 void pc_cmos_init(PCMachineState *pcms,
222                   BusState *ide0, BusState *ide1,
223                   ISADevice *s);
224 void pc_nic_init(PCMachineClass *pcmc, ISABus *isa_bus, PCIBus *pci_bus);
225 void pc_pci_device_init(PCIBus *pci_bus);
226 
227 typedef void (*cpu_set_smm_t)(int smm, void *arg);
228 
229 void ioapic_init_gsi(GSIState *gsi_state, const char *parent_name);
230 
231 ISADevice *pc_find_fdc0(void);
232 int cmos_get_fd_drive_type(FloppyDriveType fd0);
233 
234 #define FW_CFG_IO_BASE     0x510
235 
236 #define PORT92_A20_LINE "a20"
237 
238 /* acpi_piix.c */
239 
240 I2CBus *piix4_pm_init(PCIBus *bus, int devfn, uint32_t smb_io_base,
241                       qemu_irq sci_irq, qemu_irq smi_irq,
242                       int smm_enabled, DeviceState **piix4_pm);
243 
244 /* hpet.c */
245 extern int no_hpet;
246 
247 /* piix_pci.c */
248 struct PCII440FXState;
249 typedef struct PCII440FXState PCII440FXState;
250 
251 #define TYPE_I440FX_PCI_HOST_BRIDGE "i440FX-pcihost"
252 #define TYPE_I440FX_PCI_DEVICE "i440FX"
253 
254 #define TYPE_IGD_PASSTHROUGH_I440FX_PCI_DEVICE "igd-passthrough-i440FX"
255 
256 /*
257  * Reset Control Register: PCI-accessible ISA-Compatible Register at address
258  * 0xcf9, provided by the PCI/ISA bridge (PIIX3 PCI function 0, 8086:7000).
259  */
260 #define RCR_IOPORT 0xcf9
261 
262 PCIBus *i440fx_init(const char *host_type, const char *pci_type,
263                     PCII440FXState **pi440fx_state, int *piix_devfn,
264                     ISABus **isa_bus, qemu_irq *pic,
265                     MemoryRegion *address_space_mem,
266                     MemoryRegion *address_space_io,
267                     ram_addr_t ram_size,
268                     ram_addr_t below_4g_mem_size,
269                     ram_addr_t above_4g_mem_size,
270                     MemoryRegion *pci_memory,
271                     MemoryRegion *ram_memory);
272 
273 PCIBus *find_i440fx(void);
274 /* piix4.c */
275 extern PCIDevice *piix4_dev;
276 int piix4_init(PCIBus *bus, ISABus **isa_bus, int devfn);
277 
278 /* pc_sysfw.c */
279 void pc_system_firmware_init(MemoryRegion *rom_memory,
280                              bool isapc_ram_fw);
281 
282 /* acpi-build.c */
283 void pc_madt_cpu_entry(AcpiDeviceIf *adev, int uid,
284                        const CPUArchIdList *apic_ids, GArray *entry);
285 
286 /* e820 types */
287 #define E820_RAM        1
288 #define E820_RESERVED   2
289 #define E820_ACPI       3
290 #define E820_NVS        4
291 #define E820_UNUSABLE   5
292 
293 int e820_add_entry(uint64_t, uint64_t, uint32_t);
294 int e820_get_num_entries(void);
295 bool e820_get_entry(int, uint32_t, uint64_t *, uint64_t *);
296 
297 extern GlobalProperty pc_compat_3_1[];
298 extern const size_t pc_compat_3_1_len;
299 
300 extern GlobalProperty pc_compat_3_0[];
301 extern const size_t pc_compat_3_0_len;
302 
303 extern GlobalProperty pc_compat_2_12[];
304 extern const size_t pc_compat_2_12_len;
305 
306 extern GlobalProperty pc_compat_2_11[];
307 extern const size_t pc_compat_2_11_len;
308 
309 extern GlobalProperty pc_compat_2_10[];
310 extern const size_t pc_compat_2_10_len;
311 
312 extern GlobalProperty pc_compat_2_9[];
313 extern const size_t pc_compat_2_9_len;
314 
315 extern GlobalProperty pc_compat_2_8[];
316 extern const size_t pc_compat_2_8_len;
317 
318 extern GlobalProperty pc_compat_2_7[];
319 extern const size_t pc_compat_2_7_len;
320 
321 extern GlobalProperty pc_compat_2_6[];
322 extern const size_t pc_compat_2_6_len;
323 
324 extern GlobalProperty pc_compat_2_5[];
325 extern const size_t pc_compat_2_5_len;
326 
327 extern GlobalProperty pc_compat_2_4[];
328 extern const size_t pc_compat_2_4_len;
329 
330 extern GlobalProperty pc_compat_2_3[];
331 extern const size_t pc_compat_2_3_len;
332 
333 extern GlobalProperty pc_compat_2_2[];
334 extern const size_t pc_compat_2_2_len;
335 
336 extern GlobalProperty pc_compat_2_1[];
337 extern const size_t pc_compat_2_1_len;
338 
339 /* Helper for setting model-id for CPU models that changed model-id
340  * depending on QEMU versions up to QEMU 2.4.
341  */
342 #define PC_CPU_MODEL_IDS(v) \
343     {\
344         .driver   = "qemu32-" TYPE_X86_CPU,\
345         .property = "model-id",\
346         .value    = "QEMU Virtual CPU version " v,\
347     },\
348     {\
349         .driver   = "qemu64-" TYPE_X86_CPU,\
350         .property = "model-id",\
351         .value    = "QEMU Virtual CPU version " v,\
352     },\
353     {\
354         .driver   = "athlon-" TYPE_X86_CPU,\
355         .property = "model-id",\
356         .value    = "QEMU Virtual CPU version " v,\
357     },
358 
359 #define PC_COMPAT_2_0 \
360     PC_CPU_MODEL_IDS("2.0.0") \
361     {\
362         .driver   = "virtio-scsi-pci",\
363         .property = "any_layout",\
364         .value    = "off",\
365     },{\
366         .driver   = "PIIX4_PM",\
367         .property = "memory-hotplug-support",\
368         .value    = "off",\
369     },\
370     {\
371         .driver   = "apic",\
372         .property = "version",\
373         .value    = stringify(0x11),\
374     },\
375     {\
376         .driver   = "nec-usb-xhci",\
377         .property = "superspeed-ports-first",\
378         .value    = "off",\
379     },\
380     {\
381         .driver   = "nec-usb-xhci",\
382         .property = "force-pcie-endcap",\
383         .value    = "on",\
384     },\
385     {\
386         .driver   = "pci-serial",\
387         .property = "prog_if",\
388         .value    = stringify(0),\
389     },\
390     {\
391         .driver   = "pci-serial-2x",\
392         .property = "prog_if",\
393         .value    = stringify(0),\
394     },\
395     {\
396         .driver   = "pci-serial-4x",\
397         .property = "prog_if",\
398         .value    = stringify(0),\
399     },\
400     {\
401         .driver   = "virtio-net-pci",\
402         .property = "guest_announce",\
403         .value    = "off",\
404     },\
405     {\
406         .driver   = "ICH9-LPC",\
407         .property = "memory-hotplug-support",\
408         .value    = "off",\
409     },{\
410         .driver   = "xio3130-downstream",\
411         .property = COMPAT_PROP_PCP,\
412         .value    = "off",\
413     },{\
414         .driver   = "ioh3420",\
415         .property = COMPAT_PROP_PCP,\
416         .value    = "off",\
417     },
418 
419 #define PC_COMPAT_1_7 \
420     PC_CPU_MODEL_IDS("1.7.0") \
421     {\
422         .driver   = TYPE_USB_DEVICE,\
423         .property = "msos-desc",\
424         .value    = "no",\
425     },\
426     {\
427         .driver   = "PIIX4_PM",\
428         .property = "acpi-pci-hotplug-with-bridge-support",\
429         .value    = "off",\
430     },\
431     {\
432         .driver   = "hpet",\
433         .property = HPET_INTCAP,\
434         .value    = stringify(4),\
435     },
436 
437 #define PC_COMPAT_1_6 \
438     PC_CPU_MODEL_IDS("1.6.0") \
439     {\
440         .driver   = "e1000",\
441         .property = "mitigation",\
442         .value    = "off",\
443     },{\
444         .driver   = "qemu64-" TYPE_X86_CPU,\
445         .property = "model",\
446         .value    = stringify(2),\
447     },{\
448         .driver   = "qemu32-" TYPE_X86_CPU,\
449         .property = "model",\
450         .value    = stringify(3),\
451     },{\
452         .driver   = "i440FX-pcihost",\
453         .property = "short_root_bus",\
454         .value    = stringify(1),\
455     },{\
456         .driver   = "q35-pcihost",\
457         .property = "short_root_bus",\
458         .value    = stringify(1),\
459     },
460 
461 #define PC_COMPAT_1_5 \
462     PC_CPU_MODEL_IDS("1.5.0") \
463     {\
464         .driver   = "Conroe-" TYPE_X86_CPU,\
465         .property = "model",\
466         .value    = stringify(2),\
467     },{\
468         .driver   = "Conroe-" TYPE_X86_CPU,\
469         .property = "min-level",\
470         .value    = stringify(2),\
471     },{\
472         .driver   = "Penryn-" TYPE_X86_CPU,\
473         .property = "model",\
474         .value    = stringify(2),\
475     },{\
476         .driver   = "Penryn-" TYPE_X86_CPU,\
477         .property = "min-level",\
478         .value    = stringify(2),\
479     },{\
480         .driver   = "Nehalem-" TYPE_X86_CPU,\
481         .property = "model",\
482         .value    = stringify(2),\
483     },{\
484         .driver   = "Nehalem-" TYPE_X86_CPU,\
485         .property = "min-level",\
486         .value    = stringify(2),\
487     },{\
488         .driver   = "virtio-net-pci",\
489         .property = "any_layout",\
490         .value    = "off",\
491     },{\
492         .driver = TYPE_X86_CPU,\
493         .property = "pmu",\
494         .value = "on",\
495     },{\
496         .driver   = "i440FX-pcihost",\
497         .property = "short_root_bus",\
498         .value    = stringify(0),\
499     },{\
500         .driver   = "q35-pcihost",\
501         .property = "short_root_bus",\
502         .value    = stringify(0),\
503     },
504 
505 #define PC_COMPAT_1_4 \
506     PC_CPU_MODEL_IDS("1.4.0") \
507     {\
508         .driver   = "scsi-hd",\
509         .property = "discard_granularity",\
510         .value    = stringify(0),\
511     },{\
512         .driver   = "scsi-cd",\
513         .property = "discard_granularity",\
514         .value    = stringify(0),\
515     },{\
516         .driver   = "scsi-disk",\
517         .property = "discard_granularity",\
518         .value    = stringify(0),\
519     },{\
520         .driver   = "ide-hd",\
521         .property = "discard_granularity",\
522         .value    = stringify(0),\
523     },{\
524         .driver   = "ide-cd",\
525         .property = "discard_granularity",\
526         .value    = stringify(0),\
527     },{\
528         .driver   = "ide-drive",\
529         .property = "discard_granularity",\
530         .value    = stringify(0),\
531     },{\
532         .driver   = "virtio-blk-pci",\
533         .property = "discard_granularity",\
534         .value    = stringify(0),\
535     },{\
536         .driver   = "virtio-serial-pci",\
537         .property = "vectors",\
538         /* DEV_NVECTORS_UNSPECIFIED as a uint32_t string */\
539         .value    = stringify(0xFFFFFFFF),\
540     },{ \
541         .driver   = "virtio-net-pci", \
542         .property = "ctrl_guest_offloads", \
543         .value    = "off", \
544     },{\
545         .driver   = "e1000",\
546         .property = "romfile",\
547         .value    = "pxe-e1000.rom",\
548     },{\
549         .driver   = "ne2k_pci",\
550         .property = "romfile",\
551         .value    = "pxe-ne2k_pci.rom",\
552     },{\
553         .driver   = "pcnet",\
554         .property = "romfile",\
555         .value    = "pxe-pcnet.rom",\
556     },{\
557         .driver   = "rtl8139",\
558         .property = "romfile",\
559         .value    = "pxe-rtl8139.rom",\
560     },{\
561         .driver   = "virtio-net-pci",\
562         .property = "romfile",\
563         .value    = "pxe-virtio.rom",\
564     },{\
565         .driver   = "486-" TYPE_X86_CPU,\
566         .property = "model",\
567         .value    = stringify(0),\
568     },\
569     {\
570         .driver = "n270" "-" TYPE_X86_CPU,\
571         .property = "movbe",\
572         .value = "off",\
573     },\
574     {\
575         .driver = "Westmere" "-" TYPE_X86_CPU,\
576         .property = "pclmulqdq",\
577         .value = "off",\
578     },
579 
580 #define DEFINE_PC_MACHINE(suffix, namestr, initfn, optsfn) \
581     static void pc_machine_##suffix##_class_init(ObjectClass *oc, void *data) \
582     { \
583         MachineClass *mc = MACHINE_CLASS(oc); \
584         optsfn(mc); \
585         mc->init = initfn; \
586     } \
587     static const TypeInfo pc_machine_type_##suffix = { \
588         .name       = namestr TYPE_MACHINE_SUFFIX, \
589         .parent     = TYPE_PC_MACHINE, \
590         .class_init = pc_machine_##suffix##_class_init, \
591     }; \
592     static void pc_machine_init_##suffix(void) \
593     { \
594         type_register(&pc_machine_type_##suffix); \
595     } \
596     type_init(pc_machine_init_##suffix)
597 
598 extern void igd_passthrough_isa_bridge_create(PCIBus *bus, uint16_t gpu_dev_id);
599 #endif
600