xref: /openbmc/qemu/include/hw/boards.h (revision 96d885b9)
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 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_iommu(MachineState *machine);
37 bool machine_kernel_irqchip_allowed(MachineState *machine);
38 bool machine_kernel_irqchip_required(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 
44 /**
45  * MachineClass:
46  * @get_hotplug_handler: this function is called during bus-less
47  *    device hotplug. If defined it returns pointer to an instance
48  *    of HotplugHandler object, which handles hotplug operation
49  *    for a given @dev. It may return NULL if @dev doesn't require
50  *    any actions to be performed by hotplug handler.
51  * @cpu_index_to_socket_id:
52  *    used to provide @cpu_index to socket number mapping, allowing
53  *    a machine to group CPU threads belonging to the same socket/package
54  *    Returns: socket number given cpu_index belongs to.
55  */
56 struct MachineClass {
57     /*< private >*/
58     ObjectClass parent_class;
59     /*< public >*/
60 
61     const char *family; /* NULL iff @name identifies a standalone machtype */
62     const char *name;
63     const char *alias;
64     const char *desc;
65 
66     void (*init)(MachineState *state);
67     void (*reset)(void);
68     void (*hot_add_cpu)(const int64_t id, Error **errp);
69     int (*kvm_type)(const char *arg);
70 
71     BlockInterfaceType block_default_type;
72     int units_per_default_bus;
73     int max_cpus;
74     unsigned int no_serial:1,
75         no_parallel:1,
76         use_virtcon:1,
77         use_sclp:1,
78         no_floppy:1,
79         no_cdrom:1,
80         no_sdcard:1,
81         has_dynamic_sysbus:1,
82         no_tco:1,
83         pci_allow_0_address:1;
84     int is_default;
85     const char *default_machine_opts;
86     const char *default_boot_order;
87     const char *default_display;
88     GlobalProperty *compat_props;
89     const char *hw_version;
90     ram_addr_t default_ram_size;
91 
92     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
93                                            DeviceState *dev);
94     unsigned (*cpu_index_to_socket_id)(unsigned cpu_index);
95 };
96 
97 /**
98  * MachineState:
99  */
100 struct MachineState {
101     /*< private >*/
102     Object parent_obj;
103     Notifier sysbus_notifier;
104 
105     /*< public >*/
106 
107     char *accel;
108     bool kernel_irqchip_allowed;
109     bool kernel_irqchip_required;
110     int kvm_shadow_mem;
111     char *dtb;
112     char *dumpdtb;
113     int phandle_start;
114     char *dt_compatible;
115     bool dump_guest_core;
116     bool mem_merge;
117     bool usb;
118     bool usb_disabled;
119     bool igd_gfx_passthru;
120     char *firmware;
121     bool iommu;
122     bool suppress_vmdesc;
123 
124     ram_addr_t ram_size;
125     ram_addr_t maxram_size;
126     uint64_t   ram_slots;
127     const char *boot_order;
128     char *kernel_filename;
129     char *kernel_cmdline;
130     char *initrd_filename;
131     const char *cpu_model;
132     AccelState *accelerator;
133 };
134 
135 #define DEFINE_MACHINE(namestr, machine_initfn) \
136     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
137     { \
138         MachineClass *mc = MACHINE_CLASS(oc); \
139         machine_initfn(mc); \
140     } \
141     static const TypeInfo machine_initfn##_typeinfo = { \
142         .name       = MACHINE_TYPE_NAME(namestr), \
143         .parent     = TYPE_MACHINE, \
144         .class_init = machine_initfn##_class_init, \
145     }; \
146     static void machine_initfn##_register_types(void) \
147     { \
148         type_register_static(&machine_initfn##_typeinfo); \
149     } \
150     machine_init(machine_initfn##_register_types)
151 
152 #endif
153