xref: /openbmc/qemu/include/hw/boards.h (revision 64552b6b)
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 "qapi/qapi-types-machine.h"
10 #include "qemu/module.h"
11 #include "qom/object.h"
12 #include "qom/cpu.h"
13 
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
40  * be created via memory_region_init_ram().
41  */
42 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner,
43                                           const char *name,
44                                           uint64_t ram_size);
45 
46 #define TYPE_MACHINE_SUFFIX "-machine"
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 
53 #define TYPE_MACHINE "machine"
54 #undef MACHINE  /* BSD defines it and QEMU does not use it */
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 
62 extern MachineState *current_machine;
63 
64 void machine_run_board_init(MachineState *machine);
65 bool machine_usb(MachineState *machine);
66 bool machine_kernel_irqchip_allowed(MachineState *machine);
67 bool machine_kernel_irqchip_required(MachineState *machine);
68 bool machine_kernel_irqchip_split(MachineState *machine);
69 int machine_kvm_shadow_mem(MachineState *machine);
70 int machine_phandle_start(MachineState *machine);
71 bool machine_dump_guest_core(MachineState *machine);
72 bool machine_mem_merge(MachineState *machine);
73 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
74 void machine_set_cpu_numa_node(MachineState *machine,
75                                const CpuInstanceProperties *props,
76                                Error **errp);
77 
78 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type);
79 
80 
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
85  * @type - QOM class name of possible @cpu object
86  * @props - CPU object properties, initialized by board
87  * #vcpus_count - number of threads provided by @cpu object
88  */
89 typedef struct {
90     uint64_t arch_id;
91     int64_t vcpus_count;
92     CpuInstanceProperties props;
93     Object *cpu;
94     const char *type;
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 
107 /**
108  * MachineClass:
109  * @deprecation_reason: If set, the machine is marked as deprecated. The
110  *    string should provide some clear information about what to use instead.
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
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.
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.
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.
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()).
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.
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[]
138  * @has_hotpluggable_cpus:
139  *    If true, board supports CPUs creation with -device/device_add.
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
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.
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.
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.
163  * @numa_mem_supported:
164  *    true if '--numa node.mem' option is supported and false otherwise
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.
169  */
170 struct MachineClass {
171     /*< private >*/
172     ObjectClass parent_class;
173     /*< public >*/
174 
175     const char *family; /* NULL iff @name identifies a standalone machtype */
176     char *name;
177     const char *alias;
178     const char *desc;
179     const char *deprecation_reason;
180 
181     void (*init)(MachineState *state);
182     void (*reset)(MachineState *state);
183     void (*hot_add_cpu)(MachineState *state, const int64_t id, Error **errp);
184     int (*kvm_type)(MachineState *machine, const char *arg);
185     void (*smp_parse)(MachineState *ms, QemuOpts *opts);
186 
187     BlockInterfaceType block_default_type;
188     int units_per_default_bus;
189     int max_cpus;
190     int min_cpus;
191     int default_cpus;
192     unsigned int no_serial:1,
193         no_parallel:1,
194         no_floppy:1,
195         no_cdrom:1,
196         no_sdcard:1,
197         pci_allow_0_address:1,
198         legacy_fw_cfg_order:1;
199     int is_default;
200     const char *default_machine_opts;
201     const char *default_boot_order;
202     const char *default_display;
203     GPtrArray *compat_props;
204     const char *hw_version;
205     ram_addr_t default_ram_size;
206     const char *default_cpu_type;
207     bool default_kernel_irqchip_split;
208     bool option_rom_has_mr;
209     bool rom_file_has_mr;
210     int minimum_page_bits;
211     bool has_hotpluggable_cpus;
212     bool ignore_memory_transaction_failures;
213     int numa_mem_align_shift;
214     const char **valid_cpu_types;
215     strList *allowed_dynamic_sysbus_devices;
216     bool auto_enable_numa_with_memhp;
217     void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes,
218                                  int nb_nodes, ram_addr_t size);
219     bool ignore_boot_device_suffixes;
220     bool smbus_no_migration_support;
221     bool nvdimm_supported;
222     bool numa_mem_supported;
223 
224     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
225                                            DeviceState *dev);
226     CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
227                                                          unsigned cpu_index);
228     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
229     int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx);
230 };
231 
232 /**
233  * DeviceMemoryState:
234  * @base: address in guest physical address space where the memory
235  * address space for memory devices starts
236  * @mr: address space container for memory devices
237  */
238 typedef struct DeviceMemoryState {
239     hwaddr base;
240     MemoryRegion mr;
241 } DeviceMemoryState;
242 
243 /**
244  * CpuTopology:
245  * @cpus: the number of present logical processors on the machine
246  * @cores: the number of cores in one package
247  * @threads: the number of threads in one core
248  * @max_cpus: the maximum number of logical processors on the machine
249  */
250 typedef struct CpuTopology {
251     unsigned int cpus;
252     unsigned int cores;
253     unsigned int threads;
254     unsigned int max_cpus;
255 } CpuTopology;
256 
257 /**
258  * MachineState:
259  */
260 struct MachineState {
261     /*< private >*/
262     Object parent_obj;
263     Notifier sysbus_notifier;
264 
265     /*< public >*/
266 
267     char *accel;
268     bool kernel_irqchip_allowed;
269     bool kernel_irqchip_required;
270     bool kernel_irqchip_split;
271     int kvm_shadow_mem;
272     char *dtb;
273     char *dumpdtb;
274     int phandle_start;
275     char *dt_compatible;
276     bool dump_guest_core;
277     bool mem_merge;
278     bool usb;
279     bool usb_disabled;
280     bool igd_gfx_passthru;
281     char *firmware;
282     bool iommu;
283     bool suppress_vmdesc;
284     bool enforce_config_section;
285     bool enable_graphics;
286     char *memory_encryption;
287     DeviceMemoryState *device_memory;
288 
289     ram_addr_t ram_size;
290     ram_addr_t maxram_size;
291     uint64_t   ram_slots;
292     const char *boot_order;
293     char *kernel_filename;
294     char *kernel_cmdline;
295     char *initrd_filename;
296     const char *cpu_type;
297     AccelState *accelerator;
298     CPUArchIdList *possible_cpus;
299     CpuTopology smp;
300     struct NVDIMMState *nvdimms_state;
301 };
302 
303 #define DEFINE_MACHINE(namestr, machine_initfn) \
304     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
305     { \
306         MachineClass *mc = MACHINE_CLASS(oc); \
307         machine_initfn(mc); \
308     } \
309     static const TypeInfo machine_initfn##_typeinfo = { \
310         .name       = MACHINE_TYPE_NAME(namestr), \
311         .parent     = TYPE_MACHINE, \
312         .class_init = machine_initfn##_class_init, \
313     }; \
314     static void machine_initfn##_register_types(void) \
315     { \
316         type_register_static(&machine_initfn##_typeinfo); \
317     } \
318     type_init(machine_initfn##_register_types)
319 
320 extern GlobalProperty hw_compat_4_0[];
321 extern const size_t hw_compat_4_0_len;
322 
323 extern GlobalProperty hw_compat_3_1[];
324 extern const size_t hw_compat_3_1_len;
325 
326 extern GlobalProperty hw_compat_3_0[];
327 extern const size_t hw_compat_3_0_len;
328 
329 extern GlobalProperty hw_compat_2_12[];
330 extern const size_t hw_compat_2_12_len;
331 
332 extern GlobalProperty hw_compat_2_11[];
333 extern const size_t hw_compat_2_11_len;
334 
335 extern GlobalProperty hw_compat_2_10[];
336 extern const size_t hw_compat_2_10_len;
337 
338 extern GlobalProperty hw_compat_2_9[];
339 extern const size_t hw_compat_2_9_len;
340 
341 extern GlobalProperty hw_compat_2_8[];
342 extern const size_t hw_compat_2_8_len;
343 
344 extern GlobalProperty hw_compat_2_7[];
345 extern const size_t hw_compat_2_7_len;
346 
347 extern GlobalProperty hw_compat_2_6[];
348 extern const size_t hw_compat_2_6_len;
349 
350 extern GlobalProperty hw_compat_2_5[];
351 extern const size_t hw_compat_2_5_len;
352 
353 extern GlobalProperty hw_compat_2_4[];
354 extern const size_t hw_compat_2_4_len;
355 
356 extern GlobalProperty hw_compat_2_3[];
357 extern const size_t hw_compat_2_3_len;
358 
359 extern GlobalProperty hw_compat_2_2[];
360 extern const size_t hw_compat_2_2_len;
361 
362 extern GlobalProperty hw_compat_2_1[];
363 extern const size_t hw_compat_2_1_len;
364 
365 #endif
366