include/hw/boards.h

   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
  45 /**
  46  * CPUArchId:
  47  * @arch_id - architecture-dependent CPU ID of present or possible CPU
  48  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
  49  */
  50 typedef struct {
  51     uint64_t arch_id;
  52     struct CPUState *cpu;
  53 } CPUArchId;
  54
  55 /**
  56  * CPUArchIdList:
  57  * @len - number of @CPUArchId items in @cpus array
  58  * @cpus - array of present or possible CPUs for current machine configuration
  59  */
  60 typedef struct {
  61     int len;
  62     CPUArchId cpus[0];
  63 } CPUArchIdList;
  64
  65 /**
  66  * MachineClass:
  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  * @hw_version:
  77  *    Value of QEMU_VERSION when the machine was added to QEMU.
  78  *    Set only by old machines because they need to keep
  79  *    compatibility on code that exposed QEMU_VERSION to guests in
  80  *    the past (and now use qemu_hw_version()).
  81  * @possible_cpu_arch_ids:
  82  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
  83  *    which includes CPU IDs for present and possible to hotplug CPUs.
  84  *    Caller is responsible for freeing returned list.
  85  * @query_hotpluggable_cpus:
  86  *    Returns a @HotpluggableCPUList, which describes CPUs objects which
  87  *    could be added with -device/device_add.
  88  *    Caller is responsible for freeing returned list.
  89  * @minimum_page_bits:
  90  *    If non-zero, the board promises never to create a CPU with a page size
  91  *    smaller than this, so QEMU can use a more efficient larger page
  92  *    size than the target architecture's minimum. (Attempting to create
  93  *    such a CPU will fail.) Note that changing this is a migration
  94  *    compatibility break for the machine.
  95  */
  96 struct MachineClass {
  97     /*< private >*/
  98     ObjectClass parent_class;
  99     /*< public >*/
 100
 101     const char *family; /* NULL iff @name identifies a standalone machtype */
 102     char *name;
 103     const char *alias;
 104     const char *desc;
 105
 106     void (*init)(MachineState *state);
 107     void (*reset)(void);
 108     void (*hot_add_cpu)(const int64_t id, Error **errp);
 109     int (*kvm_type)(const char *arg);
 110
 111     BlockInterfaceType block_default_type;
 112     int units_per_default_bus;
 113     int max_cpus;
 114     unsigned int no_serial:1,
 115         no_parallel:1,
 116         use_virtcon:1,
 117         use_sclp:1,
 118         no_floppy:1,
 119         no_cdrom:1,
 120         no_sdcard:1,
 121         has_dynamic_sysbus:1,
 122         pci_allow_0_address:1,
 123         legacy_fw_cfg_order:1;
 124     int is_default;
 125     const char *default_machine_opts;
 126     const char *default_boot_order;
 127     const char *default_display;
 128     GArray *compat_props;
 129     const char *hw_version;
 130     ram_addr_t default_ram_size;
 131     bool option_rom_has_mr;
 132     bool rom_file_has_mr;
 133     int minimum_page_bits;
 134
 135     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 136                                            DeviceState *dev);
 137     unsigned (*cpu_index_to_socket_id)(unsigned cpu_index);
 138     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 139     HotpluggableCPUList *(*query_hotpluggable_cpus)(MachineState *machine);
 140 };
 141
 142 /**
 143  * MachineState:
 144  */
 145 struct MachineState {
 146     /*< private >*/
 147     Object parent_obj;
 148     Notifier sysbus_notifier;
 149
 150     /*< public >*/
 151
 152     char *accel;
 153     bool kernel_irqchip_allowed;
 154     bool kernel_irqchip_required;
 155     bool kernel_irqchip_split;
 156     int kvm_shadow_mem;
 157     char *dtb;
 158     char *dumpdtb;
 159     int phandle_start;
 160     char *dt_compatible;
 161     bool dump_guest_core;
 162     bool mem_merge;
 163     bool usb;
 164     bool usb_disabled;
 165     bool igd_gfx_passthru;
 166     char *firmware;
 167     bool iommu;
 168     bool suppress_vmdesc;
 169     bool enforce_config_section;
 170     bool enable_graphics;
 171
 172     ram_addr_t ram_size;
 173     ram_addr_t maxram_size;
 174     uint64_t   ram_slots;
 175     const char *boot_order;
 176     char *kernel_filename;
 177     char *kernel_cmdline;
 178     char *initrd_filename;
 179     const char *cpu_model;
 180     AccelState *accelerator;
 181 };
 182
 183 #define DEFINE_MACHINE(namestr, machine_initfn) \
 184     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 185     { \
 186         MachineClass *mc = MACHINE_CLASS(oc); \
 187         machine_initfn(mc); \
 188     } \
 189     static const TypeInfo machine_initfn##_typeinfo = { \
 190         .name       = MACHINE_TYPE_NAME(namestr), \
 191         .parent     = TYPE_MACHINE, \
 192         .class_init = machine_initfn##_class_init, \
 193     }; \
 194     static void machine_initfn##_register_types(void) \
 195     { \
 196         type_register_static(&machine_initfn##_typeinfo); \
 197     } \
 198     type_init(machine_initfn##_register_types)
 199
 200 #define SET_MACHINE_COMPAT(m, COMPAT) \
 201     do {                              \
 202         int i;                        \
 203         static GlobalProperty props[] = {       \
 204             COMPAT                              \
 205             { /* end of list */ }               \
 206         };                                      \
 207         if (!m->compat_props) { \
 208             m->compat_props = g_array_new(false, false, sizeof(void *)); \
 209         } \
 210         for (i = 0; props[i].driver != NULL; i++) {    \
 211             GlobalProperty *prop = &props[i];          \
 212             g_array_append_val(m->compat_props, prop); \
 213         }                                              \
 214     } while (0)
 215
 216 #endif