xref: /openbmc/qemu/include/hw/i386/pc.h (revision 953ea14d)
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  */
28 struct PCMachineState {
29     /*< private >*/
30     MachineState parent_obj;
31 
32     /* <public> */
33     ram_addr_t hotplug_memory_base;
34     MemoryRegion hotplug_memory;
35 
36     HotplugHandler *acpi_dev;
37     ISADevice *rtc;
38 
39     uint64_t max_ram_below_4g;
40     bool vmport;
41 };
42 
43 #define PC_MACHINE_ACPI_DEVICE_PROP "acpi-device"
44 #define PC_MACHINE_MEMHP_REGION_SIZE "hotplug-memory-region-size"
45 #define PC_MACHINE_MAX_RAM_BELOW_4G "max-ram-below-4g"
46 #define PC_MACHINE_VMPORT           "vmport"
47 
48 /**
49  * PCMachineClass:
50  * @get_hotplug_handler: pointer to parent class callback @get_hotplug_handler
51  */
52 struct PCMachineClass {
53     /*< private >*/
54     MachineClass parent_class;
55 
56     /*< public >*/
57     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
58                                            DeviceState *dev);
59 };
60 
61 typedef struct PCMachineState PCMachineState;
62 typedef struct PCMachineClass PCMachineClass;
63 
64 #define TYPE_PC_MACHINE "generic-pc-machine"
65 #define PC_MACHINE(obj) \
66     OBJECT_CHECK(PCMachineState, (obj), TYPE_PC_MACHINE)
67 #define PC_MACHINE_GET_CLASS(obj) \
68     OBJECT_GET_CLASS(PCMachineClass, (obj), TYPE_PC_MACHINE)
69 #define PC_MACHINE_CLASS(klass) \
70     OBJECT_CLASS_CHECK(PCMachineClass, (klass), TYPE_PC_MACHINE)
71 
72 void qemu_register_pc_machine(QEMUMachine *m);
73 
74 /* PC-style peripherals (also used by other machines).  */
75 
76 typedef struct PcPciInfo {
77     Range w32;
78     Range w64;
79 } PcPciInfo;
80 
81 #define ACPI_PM_PROP_S3_DISABLED "disable_s3"
82 #define ACPI_PM_PROP_S4_DISABLED "disable_s4"
83 #define ACPI_PM_PROP_S4_VAL "s4_val"
84 #define ACPI_PM_PROP_SCI_INT "sci_int"
85 #define ACPI_PM_PROP_ACPI_ENABLE_CMD "acpi_enable_cmd"
86 #define ACPI_PM_PROP_ACPI_DISABLE_CMD "acpi_disable_cmd"
87 #define ACPI_PM_PROP_PM_IO_BASE "pm_io_base"
88 #define ACPI_PM_PROP_GPE0_BLK "gpe0_blk"
89 #define ACPI_PM_PROP_GPE0_BLK_LEN "gpe0_blk_len"
90 
91 struct PcGuestInfo {
92     bool isapc_ram_fw;
93     hwaddr ram_size, ram_size_below_4g;
94     unsigned apic_id_limit;
95     bool apic_xrupt_override;
96     uint64_t numa_nodes;
97     uint64_t *node_mem;
98     uint64_t *node_cpu;
99     FWCfgState *fw_cfg;
100     int legacy_acpi_table_size;
101     bool has_acpi_build;
102     bool has_reserved_memory;
103 };
104 
105 /* parallel.c */
106 static inline bool parallel_init(ISABus *bus, int index, CharDriverState *chr)
107 {
108     DeviceState *dev;
109     ISADevice *isadev;
110 
111     isadev = isa_try_create(bus, "isa-parallel");
112     if (!isadev) {
113         return false;
114     }
115     dev = DEVICE(isadev);
116     qdev_prop_set_uint32(dev, "index", index);
117     qdev_prop_set_chr(dev, "chardev", chr);
118     if (qdev_init(dev) < 0) {
119         return false;
120     }
121     return true;
122 }
123 
124 bool parallel_mm_init(MemoryRegion *address_space,
125                       hwaddr base, int it_shift, qemu_irq irq,
126                       CharDriverState *chr);
127 
128 /* i8259.c */
129 
130 extern DeviceState *isa_pic;
131 qemu_irq *i8259_init(ISABus *bus, qemu_irq parent_irq);
132 qemu_irq *kvm_i8259_init(ISABus *bus);
133 int pic_read_irq(DeviceState *d);
134 int pic_get_output(DeviceState *d);
135 void pic_info(Monitor *mon, const QDict *qdict);
136 void irq_info(Monitor *mon, const QDict *qdict);
137 
138 /* Global System Interrupts */
139 
140 #define GSI_NUM_PINS IOAPIC_NUM_PINS
141 
142 typedef struct GSIState {
143     qemu_irq i8259_irq[ISA_NUM_IRQS];
144     qemu_irq ioapic_irq[IOAPIC_NUM_PINS];
145 } GSIState;
146 
147 void gsi_handler(void *opaque, int n, int level);
148 
149 /* vmport.c */
150 typedef uint32_t (VMPortReadFunc)(void *opaque, uint32_t address);
151 
152 static inline void vmport_init(ISABus *bus)
153 {
154     isa_create_simple(bus, "vmport");
155 }
156 
157 void vmport_register(unsigned char command, VMPortReadFunc *func, void *opaque);
158 void vmmouse_get_data(uint32_t *data);
159 void vmmouse_set_data(const uint32_t *data);
160 
161 /* pckbd.c */
162 
163 void i8042_init(qemu_irq kbd_irq, qemu_irq mouse_irq, uint32_t io_base);
164 void i8042_mm_init(qemu_irq kbd_irq, qemu_irq mouse_irq,
165                    MemoryRegion *region, ram_addr_t size,
166                    hwaddr mask);
167 void i8042_isa_mouse_fake_event(void *opaque);
168 void i8042_setup_a20_line(ISADevice *dev, qemu_irq *a20_out);
169 
170 /* pc.c */
171 extern int fd_bootchk;
172 
173 void pc_register_ferr_irq(qemu_irq irq);
174 void pc_acpi_smi_interrupt(void *opaque, int irq, int level);
175 
176 void pc_cpus_init(const char *cpu_model, DeviceState *icc_bridge);
177 void pc_hot_add_cpu(const int64_t id, Error **errp);
178 void pc_acpi_init(const char *default_dsdt);
179 
180 PcGuestInfo *pc_guest_info_init(ram_addr_t below_4g_mem_size,
181                                 ram_addr_t above_4g_mem_size);
182 
183 void pc_set_legacy_acpi_data_size(void);
184 
185 #define PCI_HOST_PROP_PCI_HOLE_START   "pci-hole-start"
186 #define PCI_HOST_PROP_PCI_HOLE_END     "pci-hole-end"
187 #define PCI_HOST_PROP_PCI_HOLE64_START "pci-hole64-start"
188 #define PCI_HOST_PROP_PCI_HOLE64_END   "pci-hole64-end"
189 #define PCI_HOST_PROP_PCI_HOLE64_SIZE  "pci-hole64-size"
190 #define DEFAULT_PCI_HOLE64_SIZE (~0x0ULL)
191 
192 
193 void pc_pci_as_mapping_init(Object *owner, MemoryRegion *system_memory,
194                             MemoryRegion *pci_address_space);
195 
196 FWCfgState *xen_load_linux(const char *kernel_filename,
197                            const char *kernel_cmdline,
198                            const char *initrd_filename,
199                            ram_addr_t below_4g_mem_size,
200                            PcGuestInfo *guest_info);
201 FWCfgState *pc_memory_init(MachineState *machine,
202                            MemoryRegion *system_memory,
203                            ram_addr_t below_4g_mem_size,
204                            ram_addr_t above_4g_mem_size,
205                            MemoryRegion *rom_memory,
206                            MemoryRegion **ram_memory,
207                            PcGuestInfo *guest_info);
208 qemu_irq *pc_allocate_cpu_irq(void);
209 DeviceState *pc_vga_init(ISABus *isa_bus, PCIBus *pci_bus);
210 void pc_basic_device_init(ISABus *isa_bus, qemu_irq *gsi,
211                           ISADevice **rtc_state,
212                           ISADevice **floppy,
213                           bool no_vmport,
214                           uint32 hpet_irqs);
215 void pc_init_ne2k_isa(ISABus *bus, NICInfo *nd);
216 void pc_cmos_init(ram_addr_t ram_size, ram_addr_t above_4g_mem_size,
217                   const char *boot_device, MachineState *machine,
218                   ISADevice *floppy, BusState *ide0, BusState *ide1,
219                   ISADevice *s);
220 void pc_nic_init(ISABus *isa_bus, PCIBus *pci_bus);
221 void pc_pci_device_init(PCIBus *pci_bus);
222 
223 typedef void (*cpu_set_smm_t)(int smm, void *arg);
224 void cpu_smm_register(cpu_set_smm_t callback, void *arg);
225 
226 void ioapic_init_gsi(GSIState *gsi_state, const char *parent_name);
227 
228 /* acpi_piix.c */
229 
230 I2CBus *piix4_pm_init(PCIBus *bus, int devfn, uint32_t smb_io_base,
231                       qemu_irq sci_irq, qemu_irq smi_irq,
232                       int kvm_enabled, FWCfgState *fw_cfg,
233                       DeviceState **piix4_pm);
234 void piix4_smbus_register_device(SMBusDevice *dev, uint8_t addr);
235 
236 /* hpet.c */
237 extern int no_hpet;
238 
239 /* piix_pci.c */
240 struct PCII440FXState;
241 typedef struct PCII440FXState PCII440FXState;
242 
243 PCIBus *i440fx_init(PCII440FXState **pi440fx_state, int *piix_devfn,
244                     ISABus **isa_bus, qemu_irq *pic,
245                     MemoryRegion *address_space_mem,
246                     MemoryRegion *address_space_io,
247                     ram_addr_t ram_size,
248                     ram_addr_t below_4g_mem_size,
249                     ram_addr_t above_4g_mem_size,
250                     MemoryRegion *pci_memory,
251                     MemoryRegion *ram_memory);
252 
253 PCIBus *find_i440fx(void);
254 /* piix4.c */
255 extern PCIDevice *piix4_dev;
256 int piix4_init(PCIBus *bus, ISABus **isa_bus, int devfn);
257 
258 /* vga.c */
259 enum vga_retrace_method {
260     VGA_RETRACE_DUMB,
261     VGA_RETRACE_PRECISE
262 };
263 
264 extern enum vga_retrace_method vga_retrace_method;
265 
266 int isa_vga_mm_init(hwaddr vram_base,
267                     hwaddr ctrl_base, int it_shift,
268                     MemoryRegion *address_space);
269 
270 /* ne2000.c */
271 static inline bool isa_ne2000_init(ISABus *bus, int base, int irq, NICInfo *nd)
272 {
273     DeviceState *dev;
274     ISADevice *isadev;
275 
276     qemu_check_nic_model(nd, "ne2k_isa");
277 
278     isadev = isa_try_create(bus, "ne2k_isa");
279     if (!isadev) {
280         return false;
281     }
282     dev = DEVICE(isadev);
283     qdev_prop_set_uint32(dev, "iobase", base);
284     qdev_prop_set_uint32(dev, "irq",    irq);
285     qdev_set_nic_properties(dev, nd);
286     qdev_init_nofail(dev);
287     return true;
288 }
289 
290 /* pc_sysfw.c */
291 void pc_system_firmware_init(MemoryRegion *rom_memory,
292                              bool isapc_ram_fw);
293 
294 /* pvpanic.c */
295 uint16_t pvpanic_port(void);
296 
297 /* e820 types */
298 #define E820_RAM        1
299 #define E820_RESERVED   2
300 #define E820_ACPI       3
301 #define E820_NVS        4
302 #define E820_UNUSABLE   5
303 
304 int e820_add_entry(uint64_t, uint64_t, uint32_t);
305 int e820_get_num_entries(void);
306 bool e820_get_entry(int, uint32_t, uint64_t *, uint64_t *);
307 
308 #define PC_COMPAT_2_0 \
309         HW_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 #define PC_COMMON_MACHINE_OPTIONS \
520     .default_boot_order = "cad"
521 
522 #define PC_DEFAULT_MACHINE_OPTIONS \
523     PC_COMMON_MACHINE_OPTIONS, \
524     .hot_add_cpu = pc_hot_add_cpu, \
525     .max_cpus = 255
526 
527 #endif
528