xref: /openbmc/qemu/include/hw/boards.h (revision 39164c13)
1 /* Declarations for use by board files for creating devices.  */
2 
3 #ifndef HW_BOARDS_H
4 #define HW_BOARDS_H
5 
6 #include "sysemu/blockdev.h"
7 #include "sysemu/accel.h"
8 #include "hw/qdev.h"
9 #include "qom/object.h"
10 #include "qom/cpu.h"
11 
12 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner,
13                                           const char *name,
14                                           uint64_t ram_size);
15 
16 #define TYPE_MACHINE_SUFFIX "-machine"
17 
18 /* Machine class name that needs to be used for class-name-based machine
19  * type lookup to work.
20  */
21 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
22 
23 #define TYPE_MACHINE "machine"
24 #undef MACHINE  /* BSD defines it and QEMU does not use it */
25 #define MACHINE(obj) \
26     OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
27 #define MACHINE_GET_CLASS(obj) \
28     OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
29 #define MACHINE_CLASS(klass) \
30     OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
31 
32 MachineClass *find_default_machine(void);
33 extern MachineState *current_machine;
34 
35 bool machine_usb(MachineState *machine);
36 bool machine_kernel_irqchip_allowed(MachineState *machine);
37 bool machine_kernel_irqchip_required(MachineState *machine);
38 bool machine_kernel_irqchip_split(MachineState *machine);
39 int machine_kvm_shadow_mem(MachineState *machine);
40 int machine_phandle_start(MachineState *machine);
41 bool machine_dump_guest_core(MachineState *machine);
42 bool machine_mem_merge(MachineState *machine);
43 void machine_register_compat_props(MachineState *machine);
44 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
45 
46 /**
47  * CPUArchId:
48  * @arch_id - architecture-dependent CPU ID of present or possible CPU
49  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
50  * @props - CPU object properties, initialized by board
51  * #vcpus_count - number of threads provided by @cpu object
52  */
53 typedef struct {
54     uint64_t arch_id;
55     int64_t vcpus_count;
56     CpuInstanceProperties props;
57     Object *cpu;
58 } CPUArchId;
59 
60 /**
61  * CPUArchIdList:
62  * @len - number of @CPUArchId items in @cpus array
63  * @cpus - array of present or possible CPUs for current machine configuration
64  */
65 typedef struct {
66     int len;
67     CPUArchId cpus[0];
68 } CPUArchIdList;
69 
70 /**
71  * MachineClass:
72  * @get_hotplug_handler: this function is called during bus-less
73  *    device hotplug. If defined it returns pointer to an instance
74  *    of HotplugHandler object, which handles hotplug operation
75  *    for a given @dev. It may return NULL if @dev doesn't require
76  *    any actions to be performed by hotplug handler.
77  * @cpu_index_to_socket_id:
78  *    used to provide @cpu_index to socket number mapping, allowing
79  *    a machine to group CPU threads belonging to the same socket/package
80  *    Returns: socket number given cpu_index belongs to.
81  * @hw_version:
82  *    Value of QEMU_VERSION when the machine was added to QEMU.
83  *    Set only by old machines because they need to keep
84  *    compatibility on code that exposed QEMU_VERSION to guests in
85  *    the past (and now use qemu_hw_version()).
86  * @possible_cpu_arch_ids:
87  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
88  *    which includes CPU IDs for present and possible to hotplug CPUs.
89  *    Caller is responsible for freeing returned list.
90  * @has_hotpluggable_cpus:
91  *    If true, board supports CPUs creation with -device/device_add.
92  * @minimum_page_bits:
93  *    If non-zero, the board promises never to create a CPU with a page size
94  *    smaller than this, so QEMU can use a more efficient larger page
95  *    size than the target architecture's minimum. (Attempting to create
96  *    such a CPU will fail.) Note that changing this is a migration
97  *    compatibility break for the machine.
98  */
99 struct MachineClass {
100     /*< private >*/
101     ObjectClass parent_class;
102     /*< public >*/
103 
104     const char *family; /* NULL iff @name identifies a standalone machtype */
105     char *name;
106     const char *alias;
107     const char *desc;
108 
109     void (*init)(MachineState *state);
110     void (*reset)(void);
111     void (*hot_add_cpu)(const int64_t id, Error **errp);
112     int (*kvm_type)(const char *arg);
113 
114     BlockInterfaceType block_default_type;
115     int units_per_default_bus;
116     int max_cpus;
117     unsigned int no_serial:1,
118         no_parallel:1,
119         use_virtcon:1,
120         use_sclp:1,
121         no_floppy:1,
122         no_cdrom:1,
123         no_sdcard:1,
124         has_dynamic_sysbus:1,
125         pci_allow_0_address:1,
126         legacy_fw_cfg_order:1;
127     int is_default;
128     const char *default_machine_opts;
129     const char *default_boot_order;
130     const char *default_display;
131     GArray *compat_props;
132     const char *hw_version;
133     ram_addr_t default_ram_size;
134     bool option_rom_has_mr;
135     bool rom_file_has_mr;
136     int minimum_page_bits;
137     bool has_hotpluggable_cpus;
138 
139     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
140                                            DeviceState *dev);
141     unsigned (*cpu_index_to_socket_id)(unsigned cpu_index);
142     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
143 };
144 
145 /**
146  * MachineState:
147  */
148 struct MachineState {
149     /*< private >*/
150     Object parent_obj;
151     Notifier sysbus_notifier;
152 
153     /*< public >*/
154 
155     char *accel;
156     bool kernel_irqchip_allowed;
157     bool kernel_irqchip_required;
158     bool kernel_irqchip_split;
159     int kvm_shadow_mem;
160     char *dtb;
161     char *dumpdtb;
162     int phandle_start;
163     char *dt_compatible;
164     bool dump_guest_core;
165     bool mem_merge;
166     bool usb;
167     bool usb_disabled;
168     bool igd_gfx_passthru;
169     char *firmware;
170     bool iommu;
171     bool suppress_vmdesc;
172     bool enforce_config_section;
173     bool enable_graphics;
174 
175     ram_addr_t ram_size;
176     ram_addr_t maxram_size;
177     uint64_t   ram_slots;
178     const char *boot_order;
179     char *kernel_filename;
180     char *kernel_cmdline;
181     char *initrd_filename;
182     const char *cpu_model;
183     AccelState *accelerator;
184     CPUArchIdList *possible_cpus;
185 };
186 
187 #define DEFINE_MACHINE(namestr, machine_initfn) \
188     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
189     { \
190         MachineClass *mc = MACHINE_CLASS(oc); \
191         machine_initfn(mc); \
192     } \
193     static const TypeInfo machine_initfn##_typeinfo = { \
194         .name       = MACHINE_TYPE_NAME(namestr), \
195         .parent     = TYPE_MACHINE, \
196         .class_init = machine_initfn##_class_init, \
197     }; \
198     static void machine_initfn##_register_types(void) \
199     { \
200         type_register_static(&machine_initfn##_typeinfo); \
201     } \
202     type_init(machine_initfn##_register_types)
203 
204 #define SET_MACHINE_COMPAT(m, COMPAT) \
205     do {                              \
206         int i;                        \
207         static GlobalProperty props[] = {       \
208             COMPAT                              \
209             { /* end of list */ }               \
210         };                                      \
211         if (!m->compat_props) { \
212             m->compat_props = g_array_new(false, false, sizeof(void *)); \
213         } \
214         for (i = 0; props[i].driver != NULL; i++) {    \
215             GlobalProperty *prop = &props[i];          \
216             g_array_append_val(m->compat_props, prop); \
217         }                                              \
218     } while (0)
219 
220 #endif
221