xref: /openbmc/qemu/include/hw/i386/pc.h (revision 4f4f6976)
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/boards.h"
17 #include "hw/compat.h"
18 #include "hw/mem/pc-dimm.h"
19 
20 #define HPET_INTCAP "hpet-intcap"
21 
22 /**
23  * PCMachineState:
24  * @acpi_dev: link to ACPI PM device that performs ACPI hotplug handling
25  * @enforce_aligned_dimm: check that DIMM's address/size is aligned by
26  *                        backend's alignment value if provided
27  */
28 struct PCMachineState {
29     /*< private >*/
30     MachineState parent_obj;
31 
32     /* <public> */
33     MemoryHotplugState hotplug_memory;
34 
35     HotplugHandler *acpi_dev;
36     ISADevice *rtc;
37 
38     uint64_t max_ram_below_4g;
39     OnOffAuto vmport;
40     OnOffAuto smm;
41     bool enforce_aligned_dimm;
42 };
43 
44 #define PC_MACHINE_ACPI_DEVICE_PROP "acpi-device"
45 #define PC_MACHINE_MEMHP_REGION_SIZE "hotplug-memory-region-size"
46 #define PC_MACHINE_MAX_RAM_BELOW_4G "max-ram-below-4g"
47 #define PC_MACHINE_VMPORT           "vmport"
48 #define PC_MACHINE_SMM              "smm"
49 #define PC_MACHINE_ENFORCE_ALIGNED_DIMM "enforce-aligned-dimm"
50 
51 /**
52  * PCMachineClass:
53  * @get_hotplug_handler: pointer to parent class callback @get_hotplug_handler
54  */
55 struct PCMachineClass {
56     /*< private >*/
57     MachineClass parent_class;
58 
59     /*< public >*/
60     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
61                                            DeviceState *dev);
62 };
63 
64 typedef struct PCMachineState PCMachineState;
65 typedef struct PCMachineClass PCMachineClass;
66 
67 #define TYPE_PC_MACHINE "generic-pc-machine"
68 #define PC_MACHINE(obj) \
69     OBJECT_CHECK(PCMachineState, (obj), TYPE_PC_MACHINE)
70 #define PC_MACHINE_GET_CLASS(obj) \
71     OBJECT_GET_CLASS(PCMachineClass, (obj), TYPE_PC_MACHINE)
72 #define PC_MACHINE_CLASS(klass) \
73     OBJECT_CLASS_CHECK(PCMachineClass, (klass), TYPE_PC_MACHINE)
74 
75 /* PC-style peripherals (also used by other machines).  */
76 
77 typedef struct PcPciInfo {
78     Range w32;
79     Range w64;
80 } PcPciInfo;
81 
82 #define ACPI_PM_PROP_S3_DISABLED "disable_s3"
83 #define ACPI_PM_PROP_S4_DISABLED "disable_s4"
84 #define ACPI_PM_PROP_S4_VAL "s4_val"
85 #define ACPI_PM_PROP_SCI_INT "sci_int"
86 #define ACPI_PM_PROP_ACPI_ENABLE_CMD "acpi_enable_cmd"
87 #define ACPI_PM_PROP_ACPI_DISABLE_CMD "acpi_disable_cmd"
88 #define ACPI_PM_PROP_PM_IO_BASE "pm_io_base"
89 #define ACPI_PM_PROP_GPE0_BLK "gpe0_blk"
90 #define ACPI_PM_PROP_GPE0_BLK_LEN "gpe0_blk_len"
91 #define ACPI_PM_PROP_TCO_ENABLED "enable_tco"
92 
93 struct PcGuestInfo {
94     bool isapc_ram_fw;
95     hwaddr ram_size, ram_size_below_4g;
96     unsigned apic_id_limit;
97     bool apic_xrupt_override;
98     uint64_t numa_nodes;
99     uint64_t *node_mem;
100     uint64_t *node_cpu;
101     FWCfgState *fw_cfg;
102     int legacy_acpi_table_size;
103     bool has_acpi_build;
104     bool has_reserved_memory;
105     bool rsdp_in_ram;
106 };
107 
108 /* parallel.c */
109 
110 void parallel_hds_isa_init(ISABus *bus, int n);
111 
112 bool parallel_mm_init(MemoryRegion *address_space,
113                       hwaddr base, int it_shift, qemu_irq irq,
114                       CharDriverState *chr);
115 
116 /* i8259.c */
117 
118 extern DeviceState *isa_pic;
119 qemu_irq *i8259_init(ISABus *bus, qemu_irq parent_irq);
120 qemu_irq *kvm_i8259_init(ISABus *bus);
121 int pic_read_irq(DeviceState *d);
122 int pic_get_output(DeviceState *d);
123 void hmp_info_pic(Monitor *mon, const QDict *qdict);
124 void hmp_info_irq(Monitor *mon, const QDict *qdict);
125 
126 /* Global System Interrupts */
127 
128 #define GSI_NUM_PINS IOAPIC_NUM_PINS
129 
130 typedef struct GSIState {
131     qemu_irq i8259_irq[ISA_NUM_IRQS];
132     qemu_irq ioapic_irq[IOAPIC_NUM_PINS];
133 } GSIState;
134 
135 void gsi_handler(void *opaque, int n, int level);
136 
137 /* vmport.c */
138 typedef uint32_t (VMPortReadFunc)(void *opaque, uint32_t address);
139 
140 static inline void vmport_init(ISABus *bus)
141 {
142     isa_create_simple(bus, "vmport");
143 }
144 
145 void vmport_register(unsigned char command, VMPortReadFunc *func, void *opaque);
146 void vmmouse_get_data(uint32_t *data);
147 void vmmouse_set_data(const uint32_t *data);
148 
149 /* pckbd.c */
150 
151 void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base);
152 void i8042_mm_init(qemu_irq kbd_irq, qemu_irq mouse_irq,
153                    MemoryRegion *region, ram_addr_t size,
154                    hwaddr mask);
155 void i8042_isa_mouse_fake_event(void *opaque);
156 void i8042_setup_a20_line(ISADevice *dev, qemu_irq *a20_out);
157 
158 /* pc.c */
159 extern int fd_bootchk;
160 
161 bool pc_machine_is_smm_enabled(PCMachineState *pcms);
162 void pc_register_ferr_irq(qemu_irq irq);
163 void pc_acpi_smi_interrupt(void *opaque, int irq, int level);
164 
165 void pc_cpus_init(const char *cpu_model, DeviceState *icc_bridge);
166 void pc_hot_add_cpu(const int64_t id, Error **errp);
167 void pc_acpi_init(const char *default_dsdt);
168 
169 PcGuestInfo *pc_guest_info_init(ram_addr_t below_4g_mem_size,
170                                 ram_addr_t above_4g_mem_size);
171 
172 void pc_set_legacy_acpi_data_size(void);
173 
174 #define PCI_HOST_PROP_PCI_HOLE_START   "pci-hole-start"
175 #define PCI_HOST_PROP_PCI_HOLE_END     "pci-hole-end"
176 #define PCI_HOST_PROP_PCI_HOLE64_START "pci-hole64-start"
177 #define PCI_HOST_PROP_PCI_HOLE64_END   "pci-hole64-end"
178 #define PCI_HOST_PROP_PCI_HOLE64_SIZE  "pci-hole64-size"
179 #define DEFAULT_PCI_HOLE64_SIZE (~0x0ULL)
180 
181 
182 void pc_pci_as_mapping_init(Object *owner, MemoryRegion *system_memory,
183                             MemoryRegion *pci_address_space);
184 
185 FWCfgState *xen_load_linux(const char *kernel_filename,
186                            const char *kernel_cmdline,
187                            const char *initrd_filename,
188                            ram_addr_t below_4g_mem_size,
189                            PcGuestInfo *guest_info);
190 FWCfgState *pc_memory_init(MachineState *machine,
191                            MemoryRegion *system_memory,
192                            ram_addr_t below_4g_mem_size,
193                            ram_addr_t above_4g_mem_size,
194                            MemoryRegion *rom_memory,
195                            MemoryRegion **ram_memory,
196                            PcGuestInfo *guest_info);
197 qemu_irq pc_allocate_cpu_irq(void);
198 DeviceState *pc_vga_init(ISABus *isa_bus, PCIBus *pci_bus);
199 void pc_basic_device_init(ISABus *isa_bus, qemu_irq *gsi,
200                           ISADevice **rtc_state,
201                           bool create_fdctrl,
202                           bool no_vmport,
203                           uint32 hpet_irqs);
204 void pc_init_ne2k_isa(ISABus *bus, NICInfo *nd);
205 void pc_cmos_init(ram_addr_t ram_size, ram_addr_t above_4g_mem_size,
206                   const char *boot_device, MachineState *machine,
207                   BusState *ide0, BusState *ide1,
208                   ISADevice *s);
209 void pc_nic_init(ISABus *isa_bus, PCIBus *pci_bus);
210 void pc_pci_device_init(PCIBus *pci_bus);
211 
212 typedef void (*cpu_set_smm_t)(int smm, void *arg);
213 
214 void ioapic_init_gsi(GSIState *gsi_state, const char *parent_name);
215 
216 /* acpi_piix.c */
217 
218 I2CBus *piix4_pm_init(PCIBus *bus, int devfn, uint32_t smb_io_base,
219                       qemu_irq sci_irq, qemu_irq smi_irq,
220                       int smm_enabled, DeviceState **piix4_pm);
221 void piix4_smbus_register_device(SMBusDevice *dev, uint8_t addr);
222 
223 /* hpet.c */
224 extern int no_hpet;
225 
226 /* piix_pci.c */
227 struct PCII440FXState;
228 typedef struct PCII440FXState PCII440FXState;
229 
230 PCIBus *i440fx_init(PCII440FXState **pi440fx_state, int *piix_devfn,
231                     ISABus **isa_bus, qemu_irq *pic,
232                     MemoryRegion *address_space_mem,
233                     MemoryRegion *address_space_io,
234                     ram_addr_t ram_size,
235                     ram_addr_t below_4g_mem_size,
236                     ram_addr_t above_4g_mem_size,
237                     MemoryRegion *pci_memory,
238                     MemoryRegion *ram_memory);
239 
240 PCIBus *find_i440fx(void);
241 /* piix4.c */
242 extern PCIDevice *piix4_dev;
243 int piix4_init(PCIBus *bus, ISABus **isa_bus, int devfn);
244 
245 /* vga.c */
246 enum vga_retrace_method {
247     VGA_RETRACE_DUMB,
248     VGA_RETRACE_PRECISE
249 };
250 
251 extern enum vga_retrace_method vga_retrace_method;
252 
253 int isa_vga_mm_init(hwaddr vram_base,
254                     hwaddr ctrl_base, int it_shift,
255                     MemoryRegion *address_space);
256 
257 /* ne2000.c */
258 static inline bool isa_ne2000_init(ISABus *bus, int base, int irq, NICInfo *nd)
259 {
260     DeviceState *dev;
261     ISADevice *isadev;
262 
263     qemu_check_nic_model(nd, "ne2k_isa");
264 
265     isadev = isa_try_create(bus, "ne2k_isa");
266     if (!isadev) {
267         return false;
268     }
269     dev = DEVICE(isadev);
270     qdev_prop_set_uint32(dev, "iobase", base);
271     qdev_prop_set_uint32(dev, "irq",    irq);
272     qdev_set_nic_properties(dev, nd);
273     qdev_init_nofail(dev);
274     return true;
275 }
276 
277 /* pc_sysfw.c */
278 void pc_system_firmware_init(MemoryRegion *rom_memory,
279                              bool isapc_ram_fw);
280 
281 /* pvpanic.c */
282 uint16_t pvpanic_port(void);
283 
284 /* e820 types */
285 #define E820_RAM        1
286 #define E820_RESERVED   2
287 #define E820_ACPI       3
288 #define E820_NVS        4
289 #define E820_UNUSABLE   5
290 
291 int e820_add_entry(uint64_t, uint64_t, uint32_t);
292 int e820_get_num_entries(void);
293 bool e820_get_entry(int, uint32_t, uint64_t *, uint64_t *);
294 
295 #define PC_COMPAT_2_3 \
296         HW_COMPAT_2_3 \
297         {\
298             .driver   = TYPE_X86_CPU,\
299             .property = "arat",\
300             .value    = "off",\
301         },
302 
303 #define PC_COMPAT_2_2 \
304         PC_COMPAT_2_3 \
305         HW_COMPAT_2_2
306 
307 #define PC_COMPAT_2_1 \
308         PC_COMPAT_2_2 \
309         HW_COMPAT_2_1
310 
311 #define PC_COMPAT_2_0 \
312         PC_COMPAT_2_1 \
313         {\
314             .driver   = "virtio-scsi-pci",\
315             .property = "any_layout",\
316             .value    = "off",\
317         },{\
318             .driver   = "PIIX4_PM",\
319             .property = "memory-hotplug-support",\
320             .value    = "off",\
321         },\
322         {\
323             .driver   = "apic",\
324             .property = "version",\
325             .value    = stringify(0x11),\
326         },\
327         {\
328             .driver   = "nec-usb-xhci",\
329             .property = "superspeed-ports-first",\
330             .value    = "off",\
331         },\
332         {\
333             .driver   = "nec-usb-xhci",\
334             .property = "force-pcie-endcap",\
335             .value    = "on",\
336         },\
337         {\
338             .driver   = "pci-serial",\
339             .property = "prog_if",\
340             .value    = stringify(0),\
341         },\
342         {\
343             .driver   = "pci-serial-2x",\
344             .property = "prog_if",\
345             .value    = stringify(0),\
346         },\
347         {\
348             .driver   = "pci-serial-4x",\
349             .property = "prog_if",\
350             .value    = stringify(0),\
351         },\
352         {\
353             .driver   = "virtio-net-pci",\
354             .property = "guest_announce",\
355             .value    = "off",\
356         },\
357         {\
358             .driver   = "ICH9-LPC",\
359             .property = "memory-hotplug-support",\
360             .value    = "off",\
361         },{\
362             .driver   = "xio3130-downstream",\
363             .property = COMPAT_PROP_PCP,\
364             .value    = "off",\
365         },{\
366             .driver   = "ioh3420",\
367             .property = COMPAT_PROP_PCP,\
368             .value    = "off",\
369         },
370 
371 #define PC_COMPAT_1_7 \
372         PC_COMPAT_2_0 \
373         {\
374             .driver   = TYPE_USB_DEVICE,\
375             .property = "msos-desc",\
376             .value    = "no",\
377         },\
378         {\
379             .driver   = "PIIX4_PM",\
380             .property = "acpi-pci-hotplug-with-bridge-support",\
381             .value    = "off",\
382         },\
383         {\
384             .driver   = "hpet",\
385             .property = HPET_INTCAP,\
386             .value    = stringify(4),\
387         },
388 
389 #define PC_COMPAT_1_6 \
390         PC_COMPAT_1_7 \
391         {\
392             .driver   = "e1000",\
393             .property = "mitigation",\
394             .value    = "off",\
395         },{\
396             .driver   = "qemu64-" TYPE_X86_CPU,\
397             .property = "model",\
398             .value    = stringify(2),\
399         },{\
400             .driver   = "qemu32-" TYPE_X86_CPU,\
401             .property = "model",\
402             .value    = stringify(3),\
403         },{\
404             .driver   = "i440FX-pcihost",\
405             .property = "short_root_bus",\
406             .value    = stringify(1),\
407         },{\
408             .driver   = "q35-pcihost",\
409             .property = "short_root_bus",\
410             .value    = stringify(1),\
411         },
412 
413 #define PC_COMPAT_1_5 \
414         PC_COMPAT_1_6 \
415         {\
416             .driver   = "Conroe-" TYPE_X86_CPU,\
417             .property = "model",\
418             .value    = stringify(2),\
419         },{\
420             .driver   = "Conroe-" TYPE_X86_CPU,\
421             .property = "level",\
422             .value    = stringify(2),\
423         },{\
424             .driver   = "Penryn-" TYPE_X86_CPU,\
425             .property = "model",\
426             .value    = stringify(2),\
427         },{\
428             .driver   = "Penryn-" TYPE_X86_CPU,\
429             .property = "level",\
430             .value    = stringify(2),\
431         },{\
432             .driver   = "Nehalem-" TYPE_X86_CPU,\
433             .property = "model",\
434             .value    = stringify(2),\
435         },{\
436             .driver   = "Nehalem-" TYPE_X86_CPU,\
437             .property = "level",\
438             .value    = stringify(2),\
439         },{\
440             .driver   = "virtio-net-pci",\
441             .property = "any_layout",\
442             .value    = "off",\
443         },{\
444             .driver = TYPE_X86_CPU,\
445             .property = "pmu",\
446             .value = "on",\
447         },{\
448             .driver   = "i440FX-pcihost",\
449             .property = "short_root_bus",\
450             .value    = stringify(0),\
451         },{\
452             .driver   = "q35-pcihost",\
453             .property = "short_root_bus",\
454             .value    = stringify(0),\
455         },
456 
457 #define PC_COMPAT_1_4 \
458         PC_COMPAT_1_5 \
459         {\
460             .driver   = "scsi-hd",\
461             .property = "discard_granularity",\
462             .value    = stringify(0),\
463         },{\
464             .driver   = "scsi-cd",\
465             .property = "discard_granularity",\
466             .value    = stringify(0),\
467         },{\
468             .driver   = "scsi-disk",\
469             .property = "discard_granularity",\
470             .value    = stringify(0),\
471         },{\
472             .driver   = "ide-hd",\
473             .property = "discard_granularity",\
474             .value    = stringify(0),\
475         },{\
476             .driver   = "ide-cd",\
477             .property = "discard_granularity",\
478             .value    = stringify(0),\
479         },{\
480             .driver   = "ide-drive",\
481             .property = "discard_granularity",\
482             .value    = stringify(0),\
483         },{\
484             .driver   = "virtio-blk-pci",\
485             .property = "discard_granularity",\
486             .value    = stringify(0),\
487         },{\
488             .driver   = "virtio-serial-pci",\
489             .property = "vectors",\
490             /* DEV_NVECTORS_UNSPECIFIED as a uint32_t string */\
491             .value    = stringify(0xFFFFFFFF),\
492         },{ \
493             .driver   = "virtio-net-pci", \
494             .property = "ctrl_guest_offloads", \
495             .value    = "off", \
496         },{\
497             .driver   = "e1000",\
498             .property = "romfile",\
499             .value    = "pxe-e1000.rom",\
500         },{\
501             .driver   = "ne2k_pci",\
502             .property = "romfile",\
503             .value    = "pxe-ne2k_pci.rom",\
504         },{\
505             .driver   = "pcnet",\
506             .property = "romfile",\
507             .value    = "pxe-pcnet.rom",\
508         },{\
509             .driver   = "rtl8139",\
510             .property = "romfile",\
511             .value    = "pxe-rtl8139.rom",\
512         },{\
513             .driver   = "virtio-net-pci",\
514             .property = "romfile",\
515             .value    = "pxe-virtio.rom",\
516         },{\
517             .driver   = "486-" TYPE_X86_CPU,\
518             .property = "model",\
519             .value    = stringify(0),\
520         },
521 
522 static inline void pc_common_machine_options(MachineClass *m)
523 {
524     m->default_boot_order = "cad";
525 }
526 
527 static inline void pc_default_machine_options(MachineClass *m)
528 {
529     pc_common_machine_options(m);
530     m->hot_add_cpu = pc_hot_add_cpu;
531     m->max_cpus = 255;
532 }
533 
534 #define DEFINE_PC_MACHINE(suffix, namestr, initfn, optsfn) \
535     static void pc_machine_##suffix##_class_init(ObjectClass *oc, void *data) \
536     { \
537         MachineClass *mc = MACHINE_CLASS(oc); \
538         optsfn(mc); \
539         mc->name = namestr; \
540         mc->init = initfn; \
541     } \
542     static const TypeInfo pc_machine_type_##suffix = { \
543         .name       = namestr TYPE_MACHINE_SUFFIX, \
544         .parent     = TYPE_PC_MACHINE, \
545         .class_init = pc_machine_##suffix##_class_init, \
546     }; \
547     static void pc_machine_init_##suffix(void) \
548     { \
549         type_register(&pc_machine_type_##suffix); \
550     } \
551     machine_init(pc_machine_init_##suffix)
552 
553 #define SET_MACHINE_COMPAT(m, COMPAT) do { \
554     static GlobalProperty props[] = { \
555         COMPAT \
556         { /* end of list */ } \
557     }; \
558     (m)->compat_props = props; \
559 } while (0)
560 
561 #endif
562