qemu/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
  44 /**
  45  * CPUArchId:
  46  * @arch_id - architecture-dependent CPU ID of present or possible CPU
  47  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
  48  */
  49 typedef struct {
  50     uint64_t arch_id;
  51     struct CPUState *cpu;
  52 } CPUArchId;
  53
  54 /**
  55  * CPUArchIdList:
  56  * @len - number of @CPUArchId items in @cpus array
  57  * @cpus - array of present or possible CPUs for current machine configuration
  58  */
  59 typedef struct {
  60     int len;
  61     CPUArchId cpus[0];
  62 } CPUArchIdList;
  63
  64 /**
  65  * MachineClass:
  66  * @get_hotplug_handler: this function is called during bus-less
  67  *    device hotplug. If defined it returns pointer to an instance
  68  *    of HotplugHandler object, which handles hotplug operation
  69  *    for a given @dev. It may return NULL if @dev doesn't require
  70  *    any actions to be performed by hotplug handler.
  71  * @cpu_index_to_socket_id:
  72  *    used to provide @cpu_index to socket number mapping, allowing
  73  *    a machine to group CPU threads belonging to the same socket/package
  74  *    Returns: socket number given cpu_index belongs to.
  75  * @hw_version:
  76  *    Value of QEMU_VERSION when the machine was added to QEMU.
  77  *    Set only by old machines because they need to keep
  78  *    compatibility on code that exposed QEMU_VERSION to guests in
  79  *    the past (and now use qemu_hw_version()).
  80  * @possible_cpu_arch_ids:
  81  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
  82  *    which includes CPU IDs for present and possible to hotplug CPUs.
  83  *    Caller is responsible for freeing returned list.
  84  */
  85 struct MachineClass {
  86     /*< private >*/
  87     ObjectClass parent_class;
  88     /*< public >*/
  89
  90     const char *family; /* NULL iff @name identifies a standalone machtype */
  91     const char *name;
  92     const char *alias;
  93     const char *desc;
  94
  95     void (*init)(MachineState *state);
  96     void (*reset)(void);
  97     void (*hot_add_cpu)(const int64_t id, Error **errp);
  98     int (*kvm_type)(const char *arg);
  99
 100     BlockInterfaceType block_default_type;
 101     int units_per_default_bus;
 102     int max_cpus;
 103     unsigned int no_serial:1,
 104         no_parallel:1,
 105         use_virtcon:1,
 106         use_sclp:1,
 107         no_floppy:1,
 108         no_cdrom:1,
 109         no_sdcard:1,
 110         has_dynamic_sysbus:1,
 111         pci_allow_0_address:1,
 112         legacy_fw_cfg_order:1;
 113     int is_default;
 114     const char *default_machine_opts;
 115     const char *default_boot_order;
 116     const char *default_display;
 117     GlobalProperty *compat_props;
 118     const char *hw_version;
 119     ram_addr_t default_ram_size;
 120     bool option_rom_has_mr;
 121     bool rom_file_has_mr;
 122
 123     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 124                                            DeviceState *dev);
 125     unsigned (*cpu_index_to_socket_id)(unsigned cpu_index);
 126     CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 127 };
 128
 129 /**
 130  * MachineState:
 131  */
 132 struct MachineState {
 133     /*< private >*/
 134     Object parent_obj;
 135     Notifier sysbus_notifier;
 136
 137     /*< public >*/
 138
 139     char *accel;
 140     bool kernel_irqchip_allowed;
 141     bool kernel_irqchip_required;
 142     bool kernel_irqchip_split;
 143     int kvm_shadow_mem;
 144     char *dtb;
 145     char *dumpdtb;
 146     int phandle_start;
 147     char *dt_compatible;
 148     bool dump_guest_core;
 149     bool mem_merge;
 150     bool usb;
 151     bool usb_disabled;
 152     bool igd_gfx_passthru;
 153     char *firmware;
 154     bool iommu;
 155     bool suppress_vmdesc;
 156     bool enforce_config_section;
 157
 158     ram_addr_t ram_size;
 159     ram_addr_t maxram_size;
 160     uint64_t   ram_slots;
 161     const char *boot_order;
 162     char *kernel_filename;
 163     char *kernel_cmdline;
 164     char *initrd_filename;
 165     const char *cpu_model;
 166     AccelState *accelerator;
 167 };
 168
 169 #define DEFINE_MACHINE(namestr, machine_initfn) \
 170     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 171     { \
 172         MachineClass *mc = MACHINE_CLASS(oc); \
 173         machine_initfn(mc); \
 174     } \
 175     static const TypeInfo machine_initfn##_typeinfo = { \
 176         .name       = MACHINE_TYPE_NAME(namestr), \
 177         .parent     = TYPE_MACHINE, \
 178         .class_init = machine_initfn##_class_init, \
 179     }; \
 180     static void machine_initfn##_register_types(void) \
 181     { \
 182         type_register_static(&machine_initfn##_typeinfo); \
 183     } \
 184     type_init(machine_initfn##_register_types)
 185
 186 #define SET_MACHINE_COMPAT(m, COMPAT) \
 187     do {                              \
 188         static GlobalProperty props[] = {       \
 189             COMPAT                              \
 190             { /* end of list */ }               \
 191         };                                      \
 192         (m)->compat_props = props;              \
 193     } while (0)
 194
 195 #endif