]>
Commit | Line | Data |
---|---|---|
87ecb68b PB |
1 | /* Declarations for use by board files for creating devices. */ |
2 | ||
3 | #ifndef HW_BOARDS_H | |
4 | #define HW_BOARDS_H | |
5 | ||
d4842052 | 6 | #include "exec/memory.h" |
9c17d615 | 7 | #include "sysemu/blockdev.h" |
ac2da55e | 8 | #include "sysemu/accel.h" |
8ac25c84 | 9 | #include "qapi/qapi-types-machine.h" |
0b8fa32f | 10 | #include "qemu/module.h" |
36d20cb2 | 11 | #include "qom/object.h" |
2e5b09fd | 12 | #include "hw/core/cpu.h" |
b6b61144 | 13 | |
09ad6438 PM |
14 | /** |
15 | * memory_region_allocate_system_memory - Allocate a board's main memory | |
16 | * @mr: the #MemoryRegion to be initialized | |
17 | * @owner: the object that tracks the region's reference count | |
18 | * @name: name of the memory region | |
19 | * @ram_size: size of the region in bytes | |
20 | * | |
21 | * This function allocates the main memory for a board model, and | |
22 | * initializes @mr appropriately. It also arranges for the memory | |
23 | * to be migrated (by calling vmstate_register_ram_global()). | |
24 | * | |
25 | * Memory allocated via this function will be backed with the memory | |
26 | * backend the user provided using "-mem-path" or "-numa node,memdev=..." | |
27 | * if appropriate; this is typically used to cause host huge pages to be | |
28 | * used. This function should therefore be called by a board exactly once, | |
29 | * for the primary or largest RAM area it implements. | |
30 | * | |
31 | * For boards where the major RAM is split into two parts in the memory | |
32 | * map, you can deal with this by calling memory_region_allocate_system_memory() | |
33 | * once to get a MemoryRegion with enough RAM for both parts, and then | |
34 | * creating alias MemoryRegions via memory_region_init_alias() which | |
35 | * alias into different parts of the RAM MemoryRegion and can be mapped | |
36 | * into the memory map in the appropriate places. | |
37 | * | |
38 | * Smaller pieces of memory (display RAM, static RAMs, etc) don't need | |
39 | * to be backed via the -mem-path memory backend and can simply | |
5bd366b4 | 40 | * be created via memory_region_init_ram(). |
09ad6438 | 41 | */ |
dfabb8b9 PB |
42 | void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, |
43 | const char *name, | |
44 | uint64_t ram_size); | |
45 | ||
dfabb8b9 | 46 | #define TYPE_MACHINE_SUFFIX "-machine" |
c84a8f01 EH |
47 | |
48 | /* Machine class name that needs to be used for class-name-based machine | |
49 | * type lookup to work. | |
50 | */ | |
51 | #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX) | |
52 | ||
36d20cb2 | 53 | #define TYPE_MACHINE "machine" |
c8897e8e | 54 | #undef MACHINE /* BSD defines it and QEMU does not use it */ |
36d20cb2 MA |
55 | #define MACHINE(obj) \ |
56 | OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE) | |
57 | #define MACHINE_GET_CLASS(obj) \ | |
58 | OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE) | |
59 | #define MACHINE_CLASS(klass) \ | |
60 | OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE) | |
61 | ||
0056ae24 MA |
62 | extern MachineState *current_machine; |
63 | ||
482dfe9a | 64 | void machine_run_board_init(MachineState *machine); |
5e97b623 | 65 | bool machine_usb(MachineState *machine); |
d8870d02 MA |
66 | bool machine_kernel_irqchip_allowed(MachineState *machine); |
67 | bool machine_kernel_irqchip_required(MachineState *machine); | |
32c18a2d | 68 | bool machine_kernel_irqchip_split(MachineState *machine); |
4689b77b | 69 | int machine_kvm_shadow_mem(MachineState *machine); |
6cabe7fa | 70 | int machine_phandle_start(MachineState *machine); |
47c8ca53 | 71 | bool machine_dump_guest_core(MachineState *machine); |
75cc7f01 | 72 | bool machine_mem_merge(MachineState *machine); |
f2d672c2 | 73 | HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine); |
7c88e65d IM |
74 | void machine_set_cpu_numa_node(MachineState *machine, |
75 | const CpuInstanceProperties *props, | |
76 | Error **errp); | |
5e97b623 | 77 | |
0bd1909d EH |
78 | void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type); |
79 | ||
80 | ||
3811ef14 IM |
81 | /** |
82 | * CPUArchId: | |
83 | * @arch_id - architecture-dependent CPU ID of present or possible CPU | |
84 | * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise | |
d342eb76 | 85 | * @type - QOM class name of possible @cpu object |
c67ae933 | 86 | * @props - CPU object properties, initialized by board |
f2d672c2 | 87 | * #vcpus_count - number of threads provided by @cpu object |
3811ef14 | 88 | */ |
a44432b4 | 89 | typedef struct CPUArchId { |
3811ef14 | 90 | uint64_t arch_id; |
f2d672c2 | 91 | int64_t vcpus_count; |
c67ae933 | 92 | CpuInstanceProperties props; |
8aba3842 | 93 | Object *cpu; |
d342eb76 | 94 | const char *type; |
3811ef14 IM |
95 | } CPUArchId; |
96 | ||
97 | /** | |
98 | * CPUArchIdList: | |
99 | * @len - number of @CPUArchId items in @cpus array | |
100 | * @cpus - array of present or possible CPUs for current machine configuration | |
101 | */ | |
102 | typedef struct { | |
103 | int len; | |
104 | CPUArchId cpus[0]; | |
105 | } CPUArchIdList; | |
106 | ||
36d20cb2 MA |
107 | /** |
108 | * MachineClass: | |
08fe6824 TH |
109 | * @deprecation_reason: If set, the machine is marked as deprecated. The |
110 | * string should provide some clear information about what to use instead. | |
72649619 EC |
111 | * @max_cpus: maximum number of CPUs supported. Default: 1 |
112 | * @min_cpus: minimum number of CPUs supported. Default: 1 | |
113 | * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 | |
b7454548 IM |
114 | * @get_hotplug_handler: this function is called during bus-less |
115 | * device hotplug. If defined it returns pointer to an instance | |
116 | * of HotplugHandler object, which handles hotplug operation | |
117 | * for a given @dev. It may return NULL if @dev doesn't require | |
118 | * any actions to be performed by hotplug handler. | |
ea089eeb IM |
119 | * @cpu_index_to_instance_props: |
120 | * used to provide @cpu_index to socket/core/thread number mapping, allowing | |
121 | * legacy code to perform maping from cpu_index to topology properties | |
122 | * Returns: tuple of socket/core/thread ids given cpu_index belongs to. | |
57924bcd IM |
123 | * used to provide @cpu_index to socket number mapping, allowing |
124 | * a machine to group CPU threads belonging to the same socket/package | |
125 | * Returns: socket number given cpu_index belongs to. | |
fac862ff EH |
126 | * @hw_version: |
127 | * Value of QEMU_VERSION when the machine was added to QEMU. | |
128 | * Set only by old machines because they need to keep | |
129 | * compatibility on code that exposed QEMU_VERSION to guests in | |
130 | * the past (and now use qemu_hw_version()). | |
3811ef14 IM |
131 | * @possible_cpu_arch_ids: |
132 | * Returns an array of @CPUArchId architecture-dependent CPU IDs | |
133 | * which includes CPU IDs for present and possible to hotplug CPUs. | |
134 | * Caller is responsible for freeing returned list. | |
79e07936 IM |
135 | * @get_default_cpu_node_id: |
136 | * returns default board specific node_id value for CPU slot specified by | |
137 | * index @idx in @ms->possible_cpus[] | |
c5514d0e IM |
138 | * @has_hotpluggable_cpus: |
139 | * If true, board supports CPUs creation with -device/device_add. | |
6063d4c0 IM |
140 | * @default_cpu_type: |
141 | * specifies default CPU_TYPE, which will be used for parsing target | |
142 | * specific features and for creating CPUs if CPU name wasn't provided | |
143 | * explicitly at CLI | |
20bccb82 PM |
144 | * @minimum_page_bits: |
145 | * If non-zero, the board promises never to create a CPU with a page size | |
146 | * smaller than this, so QEMU can use a more efficient larger page | |
147 | * size than the target architecture's minimum. (Attempting to create | |
148 | * such a CPU will fail.) Note that changing this is a migration | |
149 | * compatibility break for the machine. | |
ed860129 PM |
150 | * @ignore_memory_transaction_failures: |
151 | * If this is flag is true then the CPU will ignore memory transaction | |
152 | * failures which should cause the CPU to take an exception due to an | |
153 | * access to an unassigned physical address; the transaction will instead | |
154 | * return zero (for a read) or be ignored (for a write). This should be | |
155 | * set only by legacy board models which rely on the old RAZ/WI behaviour | |
156 | * for handling devices that QEMU does not yet model. New board models | |
157 | * should instead use "unimplemented-device" for all memory ranges where | |
158 | * the guest will attempt to probe for a device that QEMU doesn't | |
159 | * implement and a stub device is required. | |
dc0ca80e EA |
160 | * @kvm_type: |
161 | * Return the type of KVM corresponding to the kvm-type string option or | |
162 | * computed based on other criteria such as the host kernel capabilities. | |
cd5ff833 IM |
163 | * @numa_mem_supported: |
164 | * true if '--numa node.mem' option is supported and false otherwise | |
6f479566 LX |
165 | * @smp_parse: |
166 | * The function pointer to hook different machine specific functions for | |
167 | * parsing "smp-opts" from QemuOpts to MachineState::CpuTopology and more | |
168 | * machine specific topology fields, such as smp_dies for PCMachine. | |
36d20cb2 MA |
169 | */ |
170 | struct MachineClass { | |
171 | /*< private >*/ | |
172 | ObjectClass parent_class; | |
173 | /*< public >*/ | |
174 | ||
2709f263 | 175 | const char *family; /* NULL iff @name identifies a standalone machtype */ |
8ea75371 | 176 | char *name; |
00b4fbe2 MA |
177 | const char *alias; |
178 | const char *desc; | |
08fe6824 | 179 | const char *deprecation_reason; |
00b4fbe2 | 180 | |
3ef96221 | 181 | void (*init)(MachineState *state); |
a0628599 | 182 | void (*reset)(MachineState *state); |
4b5e06c9 | 183 | void (*wakeup)(MachineState *state); |
a0628599 | 184 | void (*hot_add_cpu)(MachineState *state, const int64_t id, Error **errp); |
dc0ca80e | 185 | int (*kvm_type)(MachineState *machine, const char *arg); |
6f479566 | 186 | void (*smp_parse)(MachineState *ms, QemuOpts *opts); |
00b4fbe2 MA |
187 | |
188 | BlockInterfaceType block_default_type; | |
16026518 | 189 | int units_per_default_bus; |
00b4fbe2 | 190 | int max_cpus; |
72649619 EC |
191 | int min_cpus; |
192 | int default_cpus; | |
00b4fbe2 MA |
193 | unsigned int no_serial:1, |
194 | no_parallel:1, | |
00b4fbe2 MA |
195 | no_floppy:1, |
196 | no_cdrom:1, | |
33cd52b5 | 197 | no_sdcard:1, |
bab47d9a GH |
198 | pci_allow_0_address:1, |
199 | legacy_fw_cfg_order:1; | |
00b4fbe2 MA |
200 | int is_default; |
201 | const char *default_machine_opts; | |
202 | const char *default_boot_order; | |
6f00494a | 203 | const char *default_display; |
b66bbee3 | 204 | GPtrArray *compat_props; |
00b4fbe2 | 205 | const char *hw_version; |
076b35b5 | 206 | ram_addr_t default_ram_size; |
6063d4c0 | 207 | const char *default_cpu_type; |
b2fc91db | 208 | bool default_kernel_irqchip_split; |
71ae9e94 EH |
209 | bool option_rom_has_mr; |
210 | bool rom_file_has_mr; | |
20bccb82 | 211 | int minimum_page_bits; |
c5514d0e | 212 | bool has_hotpluggable_cpus; |
ed860129 | 213 | bool ignore_memory_transaction_failures; |
55641213 | 214 | int numa_mem_align_shift; |
c9cf636d | 215 | const char **valid_cpu_types; |
0bd1909d | 216 | strList *allowed_dynamic_sysbus_devices; |
7b8be49d | 217 | bool auto_enable_numa_with_memhp; |
3bfe5716 LV |
218 | void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes, |
219 | int nb_nodes, ram_addr_t size); | |
907aac2f | 220 | bool ignore_boot_device_suffixes; |
7fccf2a0 | 221 | bool smbus_no_migration_support; |
f6a0d06b | 222 | bool nvdimm_supported; |
cd5ff833 | 223 | bool numa_mem_supported; |
b7454548 IM |
224 | |
225 | HotplugHandler *(*get_hotplug_handler)(MachineState *machine, | |
226 | DeviceState *dev); | |
ea089eeb IM |
227 | CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine, |
228 | unsigned cpu_index); | |
80e5db30 | 229 | const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine); |
79e07936 | 230 | int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx); |
36d20cb2 MA |
231 | }; |
232 | ||
b0c14ec4 | 233 | /** |
e017da37 | 234 | * DeviceMemoryState: |
b0c14ec4 DH |
235 | * @base: address in guest physical address space where the memory |
236 | * address space for memory devices starts | |
237 | * @mr: address space container for memory devices | |
238 | */ | |
e017da37 | 239 | typedef struct DeviceMemoryState { |
b0c14ec4 DH |
240 | hwaddr base; |
241 | MemoryRegion mr; | |
e017da37 | 242 | } DeviceMemoryState; |
b0c14ec4 | 243 | |
edeeec91 LX |
244 | /** |
245 | * CpuTopology: | |
246 | * @cpus: the number of present logical processors on the machine | |
247 | * @cores: the number of cores in one package | |
248 | * @threads: the number of threads in one core | |
249 | * @max_cpus: the maximum number of logical processors on the machine | |
250 | */ | |
251 | typedef struct CpuTopology { | |
252 | unsigned int cpus; | |
253 | unsigned int cores; | |
254 | unsigned int threads; | |
255 | unsigned int max_cpus; | |
256 | } CpuTopology; | |
257 | ||
36d20cb2 MA |
258 | /** |
259 | * MachineState: | |
260 | */ | |
261 | struct MachineState { | |
262 | /*< private >*/ | |
263 | Object parent_obj; | |
33cd52b5 AG |
264 | Notifier sysbus_notifier; |
265 | ||
36d20cb2 MA |
266 | /*< public >*/ |
267 | ||
268 | char *accel; | |
d8870d02 MA |
269 | bool kernel_irqchip_allowed; |
270 | bool kernel_irqchip_required; | |
32c18a2d | 271 | bool kernel_irqchip_split; |
36d20cb2 | 272 | int kvm_shadow_mem; |
36d20cb2 MA |
273 | char *dtb; |
274 | char *dumpdtb; | |
275 | int phandle_start; | |
276 | char *dt_compatible; | |
277 | bool dump_guest_core; | |
278 | bool mem_merge; | |
279 | bool usb; | |
c6e76503 | 280 | bool usb_disabled; |
79814179 | 281 | bool igd_gfx_passthru; |
36d20cb2 | 282 | char *firmware; |
a52a7fdf | 283 | bool iommu; |
9850c604 | 284 | bool suppress_vmdesc; |
902c053d | 285 | bool enforce_config_section; |
cfc58cf3 | 286 | bool enable_graphics; |
db588194 | 287 | char *memory_encryption; |
e017da37 | 288 | DeviceMemoryState *device_memory; |
36d20cb2 | 289 | |
3ef96221 | 290 | ram_addr_t ram_size; |
c270fb9e IM |
291 | ram_addr_t maxram_size; |
292 | uint64_t ram_slots; | |
3ef96221 | 293 | const char *boot_order; |
6b1b1440 MA |
294 | char *kernel_filename; |
295 | char *kernel_cmdline; | |
296 | char *initrd_filename; | |
6063d4c0 | 297 | const char *cpu_type; |
ac2da55e | 298 | AccelState *accelerator; |
38690a1c | 299 | CPUArchIdList *possible_cpus; |
edeeec91 | 300 | CpuTopology smp; |
f6a0d06b | 301 | struct NVDIMMState *nvdimms_state; |
36d20cb2 MA |
302 | }; |
303 | ||
ed0b6de3 EH |
304 | #define DEFINE_MACHINE(namestr, machine_initfn) \ |
305 | static void machine_initfn##_class_init(ObjectClass *oc, void *data) \ | |
306 | { \ | |
307 | MachineClass *mc = MACHINE_CLASS(oc); \ | |
308 | machine_initfn(mc); \ | |
309 | } \ | |
310 | static const TypeInfo machine_initfn##_typeinfo = { \ | |
311 | .name = MACHINE_TYPE_NAME(namestr), \ | |
312 | .parent = TYPE_MACHINE, \ | |
313 | .class_init = machine_initfn##_class_init, \ | |
314 | }; \ | |
315 | static void machine_initfn##_register_types(void) \ | |
316 | { \ | |
317 | type_register_static(&machine_initfn##_typeinfo); \ | |
318 | } \ | |
0e6aac87 | 319 | type_init(machine_initfn##_register_types) |
ed0b6de3 | 320 | |
9aec2e52 CH |
321 | extern GlobalProperty hw_compat_4_1[]; |
322 | extern const size_t hw_compat_4_1_len; | |
323 | ||
9bf2650b CH |
324 | extern GlobalProperty hw_compat_4_0[]; |
325 | extern const size_t hw_compat_4_0_len; | |
326 | ||
abd93cc7 MAL |
327 | extern GlobalProperty hw_compat_3_1[]; |
328 | extern const size_t hw_compat_3_1_len; | |
329 | ||
ddb3235d MAL |
330 | extern GlobalProperty hw_compat_3_0[]; |
331 | extern const size_t hw_compat_3_0_len; | |
332 | ||
0d47310b MAL |
333 | extern GlobalProperty hw_compat_2_12[]; |
334 | extern const size_t hw_compat_2_12_len; | |
335 | ||
43df70a9 MAL |
336 | extern GlobalProperty hw_compat_2_11[]; |
337 | extern const size_t hw_compat_2_11_len; | |
338 | ||
503224f4 MAL |
339 | extern GlobalProperty hw_compat_2_10[]; |
340 | extern const size_t hw_compat_2_10_len; | |
341 | ||
3e803152 MAL |
342 | extern GlobalProperty hw_compat_2_9[]; |
343 | extern const size_t hw_compat_2_9_len; | |
344 | ||
edc24ccd MAL |
345 | extern GlobalProperty hw_compat_2_8[]; |
346 | extern const size_t hw_compat_2_8_len; | |
347 | ||
5a995064 MAL |
348 | extern GlobalProperty hw_compat_2_7[]; |
349 | extern const size_t hw_compat_2_7_len; | |
350 | ||
ff8f261f MAL |
351 | extern GlobalProperty hw_compat_2_6[]; |
352 | extern const size_t hw_compat_2_6_len; | |
353 | ||
fe759610 MAL |
354 | extern GlobalProperty hw_compat_2_5[]; |
355 | extern const size_t hw_compat_2_5_len; | |
356 | ||
2f99b9c2 MAL |
357 | extern GlobalProperty hw_compat_2_4[]; |
358 | extern const size_t hw_compat_2_4_len; | |
359 | ||
8995dd90 MAL |
360 | extern GlobalProperty hw_compat_2_3[]; |
361 | extern const size_t hw_compat_2_3_len; | |
362 | ||
1c30044e MAL |
363 | extern GlobalProperty hw_compat_2_2[]; |
364 | extern const size_t hw_compat_2_2_len; | |
365 | ||
c4fc5695 MAL |
366 | extern GlobalProperty hw_compat_2_1[]; |
367 | extern const size_t hw_compat_2_1_len; | |
368 | ||
87ecb68b | 369 | #endif |