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
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
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
29#define GUI_REFRESH_INTERVAL_DEFAULT 30
30#define GUI_REFRESH_INTERVAL_IDLE 3000
31
32
33enum 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
44#define ATTR2CHTYPE(c, fg, bg, bold) \
45 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
46
47typedef void QEMUPutKBDEvent(void *opaque, int keycode);
48typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
49typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
50
51typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
52typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
53typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
54
55QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
56 void *opaque);
57QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
58 void *opaque, int absolute,
59 const char *name);
60void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
61void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
62
63QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
64void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
65
66void kbd_put_ledstate(int ledstate);
67
68void hmp_mouse_set(Monitor *mon, const QDict *qdict);
69
70
71
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
93void kbd_put_keysym_console(QemuConsole *s, int keysym);
94bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
95void kbd_put_string_console(QemuConsole *s, const char *str, int len);
96void kbd_put_keysym(int keysym);
97
98
99
100#define TYPE_QEMU_CONSOLE "qemu-console"
101OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE)
102
103
104struct QemuConsoleClass {
105 ObjectClass parent_class;
106};
107
108#define QEMU_ALLOCATED_FLAG 0x01
109#define QEMU_PLACEHOLDER_FLAG 0x02
110
111typedef struct ScanoutTexture {
112 uint32_t backing_id;
113 bool backing_y_0_top;
114 uint32_t backing_width;
115 uint32_t backing_height;
116 uint32_t x;
117 uint32_t y;
118 uint32_t width;
119 uint32_t height;
120} ScanoutTexture;
121
122typedef struct DisplaySurface {
123 pixman_format_code_t format;
124 pixman_image_t *image;
125 uint8_t flags;
126#ifdef CONFIG_OPENGL
127 GLenum glformat;
128 GLenum gltype;
129 GLuint texture;
130#endif
131} DisplaySurface;
132
133typedef struct QemuUIInfo {
134
135 uint16_t width_mm;
136 uint16_t height_mm;
137
138 int xoff;
139 int yoff;
140 uint32_t width;
141 uint32_t height;
142} QemuUIInfo;
143
144
145typedef struct QEMUCursor {
146 int width, height;
147 int hot_x, hot_y;
148 int refcount;
149 uint32_t data[];
150} QEMUCursor;
151
152QEMUCursor *cursor_alloc(int width, int height);
153void cursor_get(QEMUCursor *c);
154void cursor_put(QEMUCursor *c);
155QEMUCursor *cursor_builtin_hidden(void);
156QEMUCursor *cursor_builtin_left_ptr(void);
157void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
158int cursor_get_mono_bpl(QEMUCursor *c);
159void cursor_set_mono(QEMUCursor *c,
160 uint32_t foreground, uint32_t background, uint8_t *image,
161 int transparent, uint8_t *mask);
162void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
163void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
164
165typedef void *QEMUGLContext;
166typedef struct QEMUGLParams QEMUGLParams;
167
168struct QEMUGLParams {
169 int major_ver;
170 int minor_ver;
171};
172
173typedef struct QemuDmaBuf {
174 int fd;
175 uint32_t width;
176 uint32_t height;
177 uint32_t stride;
178 uint32_t fourcc;
179 uint64_t modifier;
180 uint32_t texture;
181 uint32_t x;
182 uint32_t y;
183 uint32_t scanout_width;
184 uint32_t scanout_height;
185 bool y0_top;
186 void *sync;
187 int fence_fd;
188 bool allow_fences;
189 bool draw_submitted;
190} QemuDmaBuf;
191
192enum display_scanout {
193 SCANOUT_NONE,
194 SCANOUT_SURFACE,
195 SCANOUT_TEXTURE,
196 SCANOUT_DMABUF,
197};
198
199typedef struct DisplayScanout {
200 enum display_scanout kind;
201 union {
202
203 ScanoutTexture texture;
204 QemuDmaBuf *dmabuf;
205 };
206} DisplayScanout;
207
208typedef struct DisplayState DisplayState;
209typedef struct DisplayGLCtx DisplayGLCtx;
210
211typedef struct DisplayChangeListenerOps {
212 const char *dpy_name;
213
214
215 void (*dpy_refresh)(DisplayChangeListener *dcl);
216
217
218 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
219 int x, int y, int w, int h);
220
221 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
222 struct DisplaySurface *new_surface);
223
224 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
225 pixman_format_code_t format);
226
227
228 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
229 int x, int y);
230
231 void (*dpy_text_resize)(DisplayChangeListener *dcl,
232 int w, int h);
233
234 void (*dpy_text_update)(DisplayChangeListener *dcl,
235 int x, int y, int w, int h);
236
237
238 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
239 int x, int y, int on);
240
241 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
242 QEMUCursor *cursor);
243
244
245 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
246
247 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
248 uint32_t backing_id,
249 bool backing_y_0_top,
250 uint32_t backing_width,
251 uint32_t backing_height,
252 uint32_t x, uint32_t y,
253 uint32_t w, uint32_t h);
254
255 bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl);
256
257 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
258 QemuDmaBuf *dmabuf);
259
260 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
261 QemuDmaBuf *dmabuf, bool have_hot,
262 uint32_t hot_x, uint32_t hot_y);
263
264 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
265 uint32_t pos_x, uint32_t pos_y);
266
267 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
268 QemuDmaBuf *dmabuf);
269
270 void (*dpy_gl_update)(DisplayChangeListener *dcl,
271 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
272
273} DisplayChangeListenerOps;
274
275struct DisplayChangeListener {
276 uint64_t update_interval;
277 const DisplayChangeListenerOps *ops;
278 DisplayState *ds;
279 QemuConsole *con;
280
281 QLIST_ENTRY(DisplayChangeListener) next;
282};
283
284typedef struct DisplayGLCtxOps {
285 bool (*dpy_gl_ctx_is_compatible_dcl)(DisplayGLCtx *dgc,
286 DisplayChangeListener *dcl);
287 QEMUGLContext (*dpy_gl_ctx_create)(DisplayGLCtx *dgc,
288 QEMUGLParams *params);
289 void (*dpy_gl_ctx_destroy)(DisplayGLCtx *dgc,
290 QEMUGLContext ctx);
291 int (*dpy_gl_ctx_make_current)(DisplayGLCtx *dgc,
292 QEMUGLContext ctx);
293 void (*dpy_gl_ctx_create_texture)(DisplayGLCtx *dgc,
294 DisplaySurface *surface);
295 void (*dpy_gl_ctx_destroy_texture)(DisplayGLCtx *dgc,
296 DisplaySurface *surface);
297 void (*dpy_gl_ctx_update_texture)(DisplayGLCtx *dgc,
298 DisplaySurface *surface,
299 int x, int y, int w, int h);
300} DisplayGLCtxOps;
301
302struct DisplayGLCtx {
303 const DisplayGLCtxOps *ops;
304#ifdef CONFIG_OPENGL
305 QemuGLShader *gls;
306#endif
307};
308
309DisplayState *init_displaystate(void);
310DisplaySurface *qemu_create_displaysurface_from(int width, int height,
311 pixman_format_code_t format,
312 int linesize, uint8_t *data);
313DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
314DisplaySurface *qemu_create_placeholder_surface(int w, int h,
315 const char *msg);
316PixelFormat qemu_default_pixelformat(int bpp);
317
318DisplaySurface *qemu_create_displaysurface(int width, int height);
319void qemu_free_displaysurface(DisplaySurface *surface);
320
321static inline int is_buffer_shared(DisplaySurface *surface)
322{
323 return !(surface->flags & QEMU_ALLOCATED_FLAG);
324}
325
326static inline int is_placeholder(DisplaySurface *surface)
327{
328 return surface->flags & QEMU_PLACEHOLDER_FLAG;
329}
330
331void register_displaychangelistener(DisplayChangeListener *dcl);
332void update_displaychangelistener(DisplayChangeListener *dcl,
333 uint64_t interval);
334void unregister_displaychangelistener(DisplayChangeListener *dcl);
335
336bool dpy_ui_info_supported(QemuConsole *con);
337const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con);
338int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info, bool delay);
339
340void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
341void dpy_gfx_update_full(QemuConsole *con);
342void dpy_gfx_replace_surface(QemuConsole *con,
343 DisplaySurface *surface);
344void dpy_text_cursor(QemuConsole *con, int x, int y);
345void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
346void dpy_text_resize(QemuConsole *con, int w, int h);
347void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
348void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
349bool dpy_cursor_define_supported(QemuConsole *con);
350bool dpy_gfx_check_format(QemuConsole *con,
351 pixman_format_code_t format);
352
353void dpy_gl_scanout_disable(QemuConsole *con);
354void dpy_gl_scanout_texture(QemuConsole *con,
355 uint32_t backing_id, bool backing_y_0_top,
356 uint32_t backing_width, uint32_t backing_height,
357 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
358void dpy_gl_scanout_dmabuf(QemuConsole *con,
359 QemuDmaBuf *dmabuf);
360void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
361 bool have_hot, uint32_t hot_x, uint32_t hot_y);
362void dpy_gl_cursor_position(QemuConsole *con,
363 uint32_t pos_x, uint32_t pos_y);
364void dpy_gl_release_dmabuf(QemuConsole *con,
365 QemuDmaBuf *dmabuf);
366void dpy_gl_update(QemuConsole *con,
367 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
368
369QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
370 QEMUGLParams *params);
371void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
372int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
373
374bool console_has_gl(QemuConsole *con);
375
376static inline int surface_stride(DisplaySurface *s)
377{
378 return pixman_image_get_stride(s->image);
379}
380
381static inline void *surface_data(DisplaySurface *s)
382{
383 return pixman_image_get_data(s->image);
384}
385
386static inline int surface_width(DisplaySurface *s)
387{
388 return pixman_image_get_width(s->image);
389}
390
391static inline int surface_height(DisplaySurface *s)
392{
393 return pixman_image_get_height(s->image);
394}
395
396static inline int surface_bits_per_pixel(DisplaySurface *s)
397{
398 int bits = PIXMAN_FORMAT_BPP(s->format);
399 return bits;
400}
401
402static inline int surface_bytes_per_pixel(DisplaySurface *s)
403{
404 int bits = PIXMAN_FORMAT_BPP(s->format);
405 return DIV_ROUND_UP(bits, 8);
406}
407
408static inline pixman_format_code_t surface_format(DisplaySurface *s)
409{
410 return s->format;
411}
412
413typedef uint32_t console_ch_t;
414
415static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
416{
417 *dest = ch;
418}
419
420enum {
421 GRAPHIC_FLAGS_NONE = 0,
422
423 GRAPHIC_FLAGS_GL = 1 << 0,
424
425 GRAPHIC_FLAGS_DMABUF = 1 << 1,
426};
427
428typedef struct GraphicHwOps {
429 int (*get_flags)(void *opaque);
430 void (*invalidate)(void *opaque);
431 void (*gfx_update)(void *opaque);
432 bool gfx_update_async;
433 void (*text_update)(void *opaque, console_ch_t *text);
434 void (*update_interval)(void *opaque, uint64_t interval);
435 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
436 void (*gl_block)(void *opaque, bool block);
437} GraphicHwOps;
438
439QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
440 const GraphicHwOps *ops,
441 void *opaque);
442void graphic_console_set_hwops(QemuConsole *con,
443 const GraphicHwOps *hw_ops,
444 void *opaque);
445void graphic_console_close(QemuConsole *con);
446
447void graphic_hw_update(QemuConsole *con);
448void graphic_hw_update_done(QemuConsole *con);
449void graphic_hw_invalidate(QemuConsole *con);
450void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
451void graphic_hw_gl_block(QemuConsole *con, bool block);
452
453void qemu_console_early_init(void);
454
455void qemu_console_set_display_gl_ctx(QemuConsole *con, DisplayGLCtx *ctx);
456
457QemuConsole *qemu_console_lookup_by_index(unsigned int index);
458QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
459QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
460 uint32_t head, Error **errp);
461QemuConsole *qemu_console_lookup_unused(void);
462bool qemu_console_is_visible(QemuConsole *con);
463bool qemu_console_is_graphic(QemuConsole *con);
464bool qemu_console_is_fixedsize(QemuConsole *con);
465bool qemu_console_is_gl_blocked(QemuConsole *con);
466char *qemu_console_get_label(QemuConsole *con);
467int qemu_console_get_index(QemuConsole *con);
468uint32_t qemu_console_get_head(QemuConsole *con);
469int qemu_console_get_width(QemuConsole *con, int fallback);
470int qemu_console_get_height(QemuConsole *con, int fallback);
471
472int qemu_console_get_window_id(QemuConsole *con);
473
474void qemu_console_set_window_id(QemuConsole *con, int window_id);
475
476void console_select(unsigned int index);
477void qemu_console_resize(QemuConsole *con, int width, int height);
478DisplaySurface *qemu_console_surface(QemuConsole *con);
479
480
481#ifdef CONFIG_OPENGL
482bool console_gl_check_format(DisplayChangeListener *dcl,
483 pixman_format_code_t format);
484void surface_gl_create_texture(QemuGLShader *gls,
485 DisplaySurface *surface);
486void surface_gl_update_texture(QemuGLShader *gls,
487 DisplaySurface *surface,
488 int x, int y, int w, int h);
489void surface_gl_render_texture(QemuGLShader *gls,
490 DisplaySurface *surface);
491void surface_gl_destroy_texture(QemuGLShader *gls,
492 DisplaySurface *surface);
493void surface_gl_setup_viewport(QemuGLShader *gls,
494 DisplaySurface *surface,
495 int ww, int wh);
496#endif
497
498typedef struct QemuDisplay QemuDisplay;
499
500struct QemuDisplay {
501 DisplayType type;
502 void (*early_init)(DisplayOptions *opts);
503 void (*init)(DisplayState *ds, DisplayOptions *opts);
504};
505
506void qemu_display_register(QemuDisplay *ui);
507bool qemu_display_find_default(DisplayOptions *opts);
508void qemu_display_early_init(DisplayOptions *opts);
509void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
510void qemu_display_help(void);
511
512
513void vnc_display_init(const char *id, Error **errp);
514void vnc_display_open(const char *id, Error **errp);
515void vnc_display_add_client(const char *id, int csock, bool skipauth);
516int vnc_display_password(const char *id, const char *password);
517int vnc_display_pw_expire(const char *id, time_t expires);
518void vnc_parse(const char *str);
519int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
520bool vnc_display_reload_certs(const char *id, Error **errp);
521
522
523int index_from_key(const char *key, size_t key_length);
524
525#ifdef CONFIG_LINUX
526
527int udmabuf_fd(void);
528#endif
529
530
531bool qemu_console_fill_device_address(QemuConsole *con,
532 char *device_address,
533 size_t size,
534 Error **errp);
535
536#endif
537
