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