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