help: Fix markup of heading "USB options" so it appears in -help
[qemu/pbrook.git] / include / sysemu / sysemu.h
blob1d9599e5f497e6d281fc32ac790efcf87152e316
1 #ifndef SYSEMU_H
2 #define SYSEMU_H
3 /* Misc. things related to the system emulator. */
5 #include "qemu/typedefs.h"
6 #include "qemu/option.h"
7 #include "qemu/queue.h"
8 #include "qemu/timer.h"
9 #include "qapi-types.h"
10 #include "qemu/notify.h"
11 #include "qemu/main-loop.h"
13 /* vl.c */
15 extern const char *bios_name;
17 extern const char *qemu_name;
18 extern uint8_t qemu_uuid[];
19 int qemu_uuid_parse(const char *str, uint8_t *uuid);
20 #define UUID_FMT "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
22 bool runstate_check(RunState state);
23 void runstate_set(RunState new_state);
24 int runstate_is_running(void);
25 typedef struct vm_change_state_entry VMChangeStateEntry;
26 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
28 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
29 void *opaque);
30 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
31 void vm_state_notify(int running, RunState state);
33 #define VMRESET_SILENT false
34 #define VMRESET_REPORT true
36 void vm_start(void);
37 void vm_stop(RunState state);
38 void vm_stop_force_state(RunState state);
40 typedef enum WakeupReason {
41 QEMU_WAKEUP_REASON_OTHER = 0,
42 QEMU_WAKEUP_REASON_RTC,
43 QEMU_WAKEUP_REASON_PMTIMER,
44 } WakeupReason;
46 void qemu_system_reset_request(void);
47 void qemu_system_suspend_request(void);
48 void qemu_register_suspend_notifier(Notifier *notifier);
49 void qemu_system_wakeup_request(WakeupReason reason);
50 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
51 void qemu_register_wakeup_notifier(Notifier *notifier);
52 void qemu_system_shutdown_request(void);
53 void qemu_system_powerdown_request(void);
54 void qemu_register_powerdown_notifier(Notifier *notifier);
55 void qemu_system_debug_request(void);
56 void qemu_system_vmstop_request(RunState reason);
57 int qemu_shutdown_requested_get(void);
58 int qemu_reset_requested_get(void);
59 void qemu_system_killed(int signal, pid_t pid);
60 void qemu_devices_reset(void);
61 void qemu_system_reset(bool report);
63 void qemu_add_exit_notifier(Notifier *notify);
64 void qemu_remove_exit_notifier(Notifier *notify);
66 void qemu_add_machine_init_done_notifier(Notifier *notify);
68 void do_savevm(Monitor *mon, const QDict *qdict);
69 int load_vmstate(const char *name);
70 void do_delvm(Monitor *mon, const QDict *qdict);
71 void do_info_snapshots(Monitor *mon, const QDict *qdict);
73 void qemu_announce_self(void);
75 bool qemu_savevm_state_blocked(Error **errp);
76 int qemu_savevm_state_begin(QEMUFile *f,
77 const MigrationParams *params);
78 int qemu_savevm_state_iterate(QEMUFile *f);
79 int qemu_savevm_state_complete(QEMUFile *f);
80 void qemu_savevm_state_cancel(void);
81 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size);
82 int qemu_loadvm_state(QEMUFile *f);
84 /* SLIRP */
85 void do_info_slirp(Monitor *mon);
87 typedef enum DisplayType
89 DT_DEFAULT,
90 DT_CURSES,
91 DT_SDL,
92 DT_NOGRAPHIC,
93 DT_NONE,
94 } DisplayType;
96 extern int autostart;
97 extern int bios_size;
99 typedef enum {
100 VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
101 } VGAInterfaceType;
103 extern int vga_interface_type;
104 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
105 #define qxl_enabled (vga_interface_type == VGA_QXL)
107 extern int graphic_width;
108 extern int graphic_height;
109 extern int graphic_depth;
110 extern DisplayType display_type;
111 extern const char *keyboard_layout;
112 extern int win2k_install_hack;
113 extern int alt_grab;
114 extern int ctrl_grab;
115 extern int smp_cpus;
116 extern int max_cpus;
117 extern int cursor_hide;
118 extern int graphic_rotate;
119 extern int no_quit;
120 extern int no_shutdown;
121 extern int semihosting_enabled;
122 extern int old_param;
123 extern int boot_menu;
124 extern uint8_t *boot_splash_filedata;
125 extern size_t boot_splash_filedata_size;
126 extern uint8_t qemu_extra_params_fw[2];
127 extern QEMUClock *rtc_clock;
129 #define MAX_NODES 64
130 #define MAX_CPUMASK_BITS 255
131 extern int nb_numa_nodes;
132 extern uint64_t node_mem[MAX_NODES];
133 extern unsigned long *node_cpumask[MAX_NODES];
135 #define MAX_OPTION_ROMS 16
136 typedef struct QEMUOptionRom {
137 const char *name;
138 int32_t bootindex;
139 } QEMUOptionRom;
140 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
141 extern int nb_option_roms;
143 #define MAX_PROM_ENVS 128
144 extern const char *prom_envs[MAX_PROM_ENVS];
145 extern unsigned int nb_prom_envs;
147 /* pci-hotplug */
148 void pci_device_hot_add(Monitor *mon, const QDict *qdict);
149 int pci_drive_hot_add(Monitor *mon, const QDict *qdict, DriveInfo *dinfo);
150 void do_pci_device_hot_remove(Monitor *mon, const QDict *qdict);
152 /* generic hotplug */
153 void drive_hot_add(Monitor *mon, const QDict *qdict);
155 /* pcie aer error injection */
156 void pcie_aer_inject_error_print(Monitor *mon, const QObject *data);
157 int do_pcie_aer_inject_error(Monitor *mon,
158 const QDict *qdict, QObject **ret_data);
160 /* serial ports */
162 #define MAX_SERIAL_PORTS 4
164 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
166 /* parallel ports */
168 #define MAX_PARALLEL_PORTS 3
170 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
172 void do_usb_add(Monitor *mon, const QDict *qdict);
173 void do_usb_del(Monitor *mon, const QDict *qdict);
174 void usb_info(Monitor *mon, const QDict *qdict);
176 void rtc_change_mon_event(struct tm *tm);
178 void register_devices(void);
180 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
181 const char *suffix);
182 char *get_boot_devices_list(size_t *size);
184 bool usb_enabled(bool default_usb);
186 extern QemuOptsList qemu_drive_opts;
187 extern QemuOptsList qemu_chardev_opts;
188 extern QemuOptsList qemu_device_opts;
189 extern QemuOptsList qemu_netdev_opts;
190 extern QemuOptsList qemu_net_opts;
191 extern QemuOptsList qemu_global_opts;
192 extern QemuOptsList qemu_mon_opts;
194 #endif