block/export: Add query-block-exports
[qemu.git] / include / ui / console.h
1 #ifndef CONSOLE_H
2 #define CONSOLE_H
3
4 #include "ui/qemu-pixman.h"
5 #include "qom/object.h"
6 #include "qemu/notify.h"
7 #include "qemu/error-report.h"
8 #include "qapi/qapi-types-ui.h"
9
10 #ifdef CONFIG_OPENGL
11 # include <epoxy/gl.h>
12 # include "ui/shader.h"
13 #endif
14
15 /* keyboard/mouse support */
16
17 #define MOUSE_EVENT_LBUTTON 0x01
18 #define MOUSE_EVENT_RBUTTON 0x02
19 #define MOUSE_EVENT_MBUTTON 0x04
20 #define MOUSE_EVENT_WHEELUP 0x08
21 #define MOUSE_EVENT_WHEELDN 0x10
22
23 /* identical to the ps/2 keyboard bits */
24 #define QEMU_SCROLL_LOCK_LED (1 << 0)
25 #define QEMU_NUM_LOCK_LED (1 << 1)
26 #define QEMU_CAPS_LOCK_LED (1 << 2)
27
28 /* in ms */
29 #define GUI_REFRESH_INTERVAL_DEFAULT 30
30 #define GUI_REFRESH_INTERVAL_IDLE 3000
31
32 /* Color number is match to standard vga palette */
33 enum qemu_color_names {
34 QEMU_COLOR_BLACK = 0,
35 QEMU_COLOR_BLUE = 1,
36 QEMU_COLOR_GREEN = 2,
37 QEMU_COLOR_CYAN = 3,
38 QEMU_COLOR_RED = 4,
39 QEMU_COLOR_MAGENTA = 5,
40 QEMU_COLOR_YELLOW = 6,
41 QEMU_COLOR_WHITE = 7
42 };
43 /* Convert to curses char attributes */
44 #define ATTR2CHTYPE(c, fg, bg, bold) \
45 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
46
47 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
48 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
49 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
50
51 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
52 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
53 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
54
55 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
56 void *opaque);
57 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
58 void *opaque, int absolute,
59 const char *name);
60 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
61 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
62
63 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
64 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
65
66 void kbd_put_ledstate(int ledstate);
67
68 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
69
70 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
71 constants) */
72 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
73 #define QEMU_KEY_BACKSPACE 0x007f
74 #define QEMU_KEY_UP QEMU_KEY_ESC1('A')
75 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
76 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
77 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
78 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
79 #define QEMU_KEY_END QEMU_KEY_ESC1(4)
80 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
81 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
82 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
83
84 #define QEMU_KEY_CTRL_UP 0xe400
85 #define QEMU_KEY_CTRL_DOWN 0xe401
86 #define QEMU_KEY_CTRL_LEFT 0xe402
87 #define QEMU_KEY_CTRL_RIGHT 0xe403
88 #define QEMU_KEY_CTRL_HOME 0xe404
89 #define QEMU_KEY_CTRL_END 0xe405
90 #define QEMU_KEY_CTRL_PAGEUP 0xe406
91 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407
92
93 void kbd_put_keysym_console(QemuConsole *s, int keysym);
94 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
95 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
96 void kbd_put_keysym(int keysym);
97
98 /* consoles */
99
100 #define TYPE_QEMU_CONSOLE "qemu-console"
101 OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE)
102
103
104 struct QemuConsoleClass {
105 ObjectClass parent_class;
106 };
107
108 #define QEMU_ALLOCATED_FLAG 0x01
109
110 typedef struct DisplaySurface {
111 pixman_format_code_t format;
112 pixman_image_t *image;
113 uint8_t flags;
114 #ifdef CONFIG_OPENGL
115 GLenum glformat;
116 GLenum gltype;
117 GLuint texture;
118 #endif
119 } DisplaySurface;
120
121 typedef struct QemuUIInfo {
122 /* physical dimension */
123 uint16_t width_mm;
124 uint16_t height_mm;
125 /* geometry */
126 int xoff;
127 int yoff;
128 uint32_t width;
129 uint32_t height;
130 } QemuUIInfo;
131
132 /* cursor data format is 32bit RGBA */
133 typedef struct QEMUCursor {
134 int width, height;
135 int hot_x, hot_y;
136 int refcount;
137 uint32_t data[];
138 } QEMUCursor;
139
140 QEMUCursor *cursor_alloc(int width, int height);
141 void cursor_get(QEMUCursor *c);
142 void cursor_put(QEMUCursor *c);
143 QEMUCursor *cursor_builtin_hidden(void);
144 QEMUCursor *cursor_builtin_left_ptr(void);
145 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
146 int cursor_get_mono_bpl(QEMUCursor *c);
147 void cursor_set_mono(QEMUCursor *c,
148 uint32_t foreground, uint32_t background, uint8_t *image,
149 int transparent, uint8_t *mask);
150 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
151 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
152
153 typedef void *QEMUGLContext;
154 typedef struct QEMUGLParams QEMUGLParams;
155
156 struct QEMUGLParams {
157 int major_ver;
158 int minor_ver;
159 };
160
161 typedef struct QemuDmaBuf {
162 int fd;
163 uint32_t width;
164 uint32_t height;
165 uint32_t stride;
166 uint32_t fourcc;
167 uint64_t modifier;
168 uint32_t texture;
169 bool y0_top;
170 } QemuDmaBuf;
171
172 typedef struct DisplayState DisplayState;
173
174 typedef struct DisplayChangeListenerOps {
175 const char *dpy_name;
176
177 void (*dpy_refresh)(DisplayChangeListener *dcl);
178
179 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
180 int x, int y, int w, int h);
181 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
182 struct DisplaySurface *new_surface);
183 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
184 pixman_format_code_t format);
185
186 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
187 int x, int y);
188 void (*dpy_text_resize)(DisplayChangeListener *dcl,
189 int w, int h);
190 void (*dpy_text_update)(DisplayChangeListener *dcl,
191 int x, int y, int w, int h);
192
193 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
194 int x, int y, int on);
195 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
196 QEMUCursor *cursor);
197
198 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
199 QEMUGLParams *params);
200 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
201 QEMUGLContext ctx);
202 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
203 QEMUGLContext ctx);
204 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
205
206 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
207 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
208 uint32_t backing_id,
209 bool backing_y_0_top,
210 uint32_t backing_width,
211 uint32_t backing_height,
212 uint32_t x, uint32_t y,
213 uint32_t w, uint32_t h);
214 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
215 QemuDmaBuf *dmabuf);
216 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
217 QemuDmaBuf *dmabuf, bool have_hot,
218 uint32_t hot_x, uint32_t hot_y);
219 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
220 uint32_t pos_x, uint32_t pos_y);
221 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
222 QemuDmaBuf *dmabuf);
223 void (*dpy_gl_update)(DisplayChangeListener *dcl,
224 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
225
226 } DisplayChangeListenerOps;
227
228 struct DisplayChangeListener {
229 uint64_t update_interval;
230 const DisplayChangeListenerOps *ops;
231 DisplayState *ds;
232 QemuConsole *con;
233
234 QLIST_ENTRY(DisplayChangeListener) next;
235 };
236
237 DisplayState *init_displaystate(void);
238 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
239 pixman_format_code_t format,
240 int linesize, uint8_t *data);
241 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
242 DisplaySurface *qemu_create_message_surface(int w, int h,
243 const char *msg);
244 PixelFormat qemu_default_pixelformat(int bpp);
245
246 DisplaySurface *qemu_create_displaysurface(int width, int height);
247 void qemu_free_displaysurface(DisplaySurface *surface);
248
249 static inline int is_surface_bgr(DisplaySurface *surface)
250 {
251 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
252 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
253 return 1;
254 } else {
255 return 0;
256 }
257 }
258
259 static inline int is_buffer_shared(DisplaySurface *surface)
260 {
261 return !(surface->flags & QEMU_ALLOCATED_FLAG);
262 }
263
264 void register_displaychangelistener(DisplayChangeListener *dcl);
265 void update_displaychangelistener(DisplayChangeListener *dcl,
266 uint64_t interval);
267 void unregister_displaychangelistener(DisplayChangeListener *dcl);
268
269 bool dpy_ui_info_supported(QemuConsole *con);
270 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con);
271 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
272
273 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
274 void dpy_gfx_update_full(QemuConsole *con);
275 void dpy_gfx_replace_surface(QemuConsole *con,
276 DisplaySurface *surface);
277 void dpy_text_cursor(QemuConsole *con, int x, int y);
278 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
279 void dpy_text_resize(QemuConsole *con, int w, int h);
280 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
281 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
282 bool dpy_cursor_define_supported(QemuConsole *con);
283 bool dpy_gfx_check_format(QemuConsole *con,
284 pixman_format_code_t format);
285
286 void dpy_gl_scanout_disable(QemuConsole *con);
287 void dpy_gl_scanout_texture(QemuConsole *con,
288 uint32_t backing_id, bool backing_y_0_top,
289 uint32_t backing_width, uint32_t backing_height,
290 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
291 void dpy_gl_scanout_dmabuf(QemuConsole *con,
292 QemuDmaBuf *dmabuf);
293 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
294 bool have_hot, uint32_t hot_x, uint32_t hot_y);
295 void dpy_gl_cursor_position(QemuConsole *con,
296 uint32_t pos_x, uint32_t pos_y);
297 void dpy_gl_release_dmabuf(QemuConsole *con,
298 QemuDmaBuf *dmabuf);
299 void dpy_gl_update(QemuConsole *con,
300 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
301
302 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
303 QEMUGLParams *params);
304 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
305 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
306 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
307
308 bool console_has_gl(QemuConsole *con);
309 bool console_has_gl_dmabuf(QemuConsole *con);
310
311 static inline int surface_stride(DisplaySurface *s)
312 {
313 return pixman_image_get_stride(s->image);
314 }
315
316 static inline void *surface_data(DisplaySurface *s)
317 {
318 return pixman_image_get_data(s->image);
319 }
320
321 static inline int surface_width(DisplaySurface *s)
322 {
323 return pixman_image_get_width(s->image);
324 }
325
326 static inline int surface_height(DisplaySurface *s)
327 {
328 return pixman_image_get_height(s->image);
329 }
330
331 static inline int surface_bits_per_pixel(DisplaySurface *s)
332 {
333 int bits = PIXMAN_FORMAT_BPP(s->format);
334 return bits;
335 }
336
337 static inline int surface_bytes_per_pixel(DisplaySurface *s)
338 {
339 int bits = PIXMAN_FORMAT_BPP(s->format);
340 return DIV_ROUND_UP(bits, 8);
341 }
342
343 static inline pixman_format_code_t surface_format(DisplaySurface *s)
344 {
345 return s->format;
346 }
347
348 typedef uint32_t console_ch_t;
349
350 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
351 {
352 *dest = ch;
353 }
354
355 typedef struct GraphicHwOps {
356 void (*invalidate)(void *opaque);
357 void (*gfx_update)(void *opaque);
358 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
359 void (*text_update)(void *opaque, console_ch_t *text);
360 void (*update_interval)(void *opaque, uint64_t interval);
361 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
362 void (*gl_block)(void *opaque, bool block);
363 } GraphicHwOps;
364
365 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
366 const GraphicHwOps *ops,
367 void *opaque);
368 void graphic_console_set_hwops(QemuConsole *con,
369 const GraphicHwOps *hw_ops,
370 void *opaque);
371 void graphic_console_close(QemuConsole *con);
372
373 void graphic_hw_update(QemuConsole *con);
374 void graphic_hw_update_done(QemuConsole *con);
375 void graphic_hw_invalidate(QemuConsole *con);
376 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
377 void graphic_hw_gl_block(QemuConsole *con, bool block);
378
379 void qemu_console_early_init(void);
380
381 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
382 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
383 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
384 uint32_t head, Error **errp);
385 QemuConsole *qemu_console_lookup_unused(void);
386 bool qemu_console_is_visible(QemuConsole *con);
387 bool qemu_console_is_graphic(QemuConsole *con);
388 bool qemu_console_is_fixedsize(QemuConsole *con);
389 bool qemu_console_is_gl_blocked(QemuConsole *con);
390 char *qemu_console_get_label(QemuConsole *con);
391 int qemu_console_get_index(QemuConsole *con);
392 uint32_t qemu_console_get_head(QemuConsole *con);
393 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
394 int qemu_console_get_width(QemuConsole *con, int fallback);
395 int qemu_console_get_height(QemuConsole *con, int fallback);
396 /* Return the low-level window id for the console */
397 int qemu_console_get_window_id(QemuConsole *con);
398 /* Set the low-level window id for the console */
399 void qemu_console_set_window_id(QemuConsole *con, int window_id);
400
401 void console_select(unsigned int index);
402 void qemu_console_resize(QemuConsole *con, int width, int height);
403 DisplaySurface *qemu_console_surface(QemuConsole *con);
404
405 /* console-gl.c */
406 #ifdef CONFIG_OPENGL
407 bool console_gl_check_format(DisplayChangeListener *dcl,
408 pixman_format_code_t format);
409 void surface_gl_create_texture(QemuGLShader *gls,
410 DisplaySurface *surface);
411 void surface_gl_update_texture(QemuGLShader *gls,
412 DisplaySurface *surface,
413 int x, int y, int w, int h);
414 void surface_gl_render_texture(QemuGLShader *gls,
415 DisplaySurface *surface);
416 void surface_gl_destroy_texture(QemuGLShader *gls,
417 DisplaySurface *surface);
418 void surface_gl_setup_viewport(QemuGLShader *gls,
419 DisplaySurface *surface,
420 int ww, int wh);
421 #endif
422
423 typedef struct QemuDisplay QemuDisplay;
424
425 struct QemuDisplay {
426 DisplayType type;
427 void (*early_init)(DisplayOptions *opts);
428 void (*init)(DisplayState *ds, DisplayOptions *opts);
429 };
430
431 void qemu_display_register(QemuDisplay *ui);
432 bool qemu_display_find_default(DisplayOptions *opts);
433 void qemu_display_early_init(DisplayOptions *opts);
434 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
435 void qemu_display_help(void);
436
437 /* vnc.c */
438 void vnc_display_init(const char *id, Error **errp);
439 void vnc_display_open(const char *id, Error **errp);
440 void vnc_display_add_client(const char *id, int csock, bool skipauth);
441 int vnc_display_password(const char *id, const char *password);
442 int vnc_display_pw_expire(const char *id, time_t expires);
443 QemuOpts *vnc_parse(const char *str, Error **errp);
444 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
445
446 /* input.c */
447 int index_from_key(const char *key, size_t key_length);
448
449 #endif