xref: /openbmc/qemu/include/hw/boards.h (revision b45c03f5)
1 /* Declarations for use by board files for creating devices.  */
2 
3 #ifndef HW_BOARDS_H
4 #define HW_BOARDS_H
5 
6 #include "qemu/typedefs.h"
7 #include "sysemu/blockdev.h"
8 #include "sysemu/accel.h"
9 #include "hw/qdev.h"
10 #include "qom/object.h"
11 
12 
13 typedef void QEMUMachineInitFunc(MachineState *ms);
14 
15 typedef void QEMUMachineResetFunc(void);
16 
17 typedef void QEMUMachineHotAddCPUFunc(const int64_t id, Error **errp);
18 
19 typedef int QEMUMachineGetKvmtypeFunc(const char *arg);
20 
21 struct QEMUMachine {
22     const char *name;
23     const char *desc;
24     QEMUMachineInitFunc *init;
25     QEMUMachineGetKvmtypeFunc *kvm_type;
26     BlockInterfaceType block_default_type;
27     int max_cpus;
28     unsigned int
29         no_sdcard:1,
30         has_dynamic_sysbus:1;
31     int is_default;
32     const char *default_machine_opts;
33     const char *default_boot_order;
34 };
35 
36 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner,
37                                           const char *name,
38                                           uint64_t ram_size);
39 
40 int qemu_register_machine(QEMUMachine *m);
41 
42 #define TYPE_MACHINE_SUFFIX "-machine"
43 #define TYPE_MACHINE "machine"
44 #undef MACHINE  /* BSD defines it and QEMU does not use it */
45 #define MACHINE(obj) \
46     OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
47 #define MACHINE_GET_CLASS(obj) \
48     OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
49 #define MACHINE_CLASS(klass) \
50     OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
51 
52 MachineClass *find_default_machine(void);
53 extern MachineState *current_machine;
54 
55 bool machine_usb(MachineState *machine);
56 bool machine_iommu(MachineState *machine);
57 bool machine_kernel_irqchip_allowed(MachineState *machine);
58 bool machine_kernel_irqchip_required(MachineState *machine);
59 int machine_kvm_shadow_mem(MachineState *machine);
60 int machine_phandle_start(MachineState *machine);
61 bool machine_dump_guest_core(MachineState *machine);
62 bool machine_mem_merge(MachineState *machine);
63 
64 /**
65  * MachineClass:
66  * @qemu_machine: #QEMUMachine
67  * @get_hotplug_handler: this function is called during bus-less
68  *    device hotplug. If defined it returns pointer to an instance
69  *    of HotplugHandler object, which handles hotplug operation
70  *    for a given @dev. It may return NULL if @dev doesn't require
71  *    any actions to be performed by hotplug handler.
72  * @cpu_index_to_socket_id:
73  *    used to provide @cpu_index to socket number mapping, allowing
74  *    a machine to group CPU threads belonging to the same socket/package
75  *    Returns: socket number given cpu_index belongs to.
76  */
77 struct MachineClass {
78     /*< private >*/
79     ObjectClass parent_class;
80     /*< public >*/
81 
82     const char *family; /* NULL iff @name identifies a standalone machtype */
83     const char *name;
84     const char *alias;
85     const char *desc;
86 
87     void (*init)(MachineState *state);
88     void (*reset)(void);
89     void (*hot_add_cpu)(const int64_t id, Error **errp);
90     int (*kvm_type)(const char *arg);
91 
92     BlockInterfaceType block_default_type;
93     int units_per_default_bus;
94     int max_cpus;
95     unsigned int no_serial:1,
96         no_parallel:1,
97         use_virtcon:1,
98         use_sclp:1,
99         no_floppy:1,
100         no_cdrom:1,
101         no_sdcard:1,
102         has_dynamic_sysbus:1,
103         no_tco:1,
104         pci_allow_0_address:1;
105     int is_default;
106     const char *default_machine_opts;
107     const char *default_boot_order;
108     const char *default_display;
109     GlobalProperty *compat_props;
110     const char *hw_version;
111     ram_addr_t default_ram_size;
112 
113     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
114                                            DeviceState *dev);
115     unsigned (*cpu_index_to_socket_id)(unsigned cpu_index);
116 };
117 
118 /**
119  * MachineState:
120  */
121 struct MachineState {
122     /*< private >*/
123     Object parent_obj;
124     Notifier sysbus_notifier;
125 
126     /*< public >*/
127 
128     char *accel;
129     bool kernel_irqchip_allowed;
130     bool kernel_irqchip_required;
131     int kvm_shadow_mem;
132     char *dtb;
133     char *dumpdtb;
134     int phandle_start;
135     char *dt_compatible;
136     bool dump_guest_core;
137     bool mem_merge;
138     bool usb;
139     bool usb_disabled;
140     char *firmware;
141     bool iommu;
142     bool suppress_vmdesc;
143 
144     ram_addr_t ram_size;
145     ram_addr_t maxram_size;
146     uint64_t   ram_slots;
147     const char *boot_order;
148     char *kernel_filename;
149     char *kernel_cmdline;
150     char *initrd_filename;
151     const char *cpu_model;
152     AccelState *accelerator;
153 };
154 
155 #endif
156