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
68struct MouseTransformInfo {
69
70 int x;
71 int y;
72
73 int a[7];
74};
75
76void hmp_mouse_set(Monitor *mon, const QDict *qdict);
77
78
79
80#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
81#define QEMU_KEY_BACKSPACE 0x007f
82#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
83#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
84#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
85#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
86#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
87#define QEMU_KEY_END QEMU_KEY_ESC1(4)
88#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
89#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
90#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
91
92#define QEMU_KEY_CTRL_UP 0xe400
93#define QEMU_KEY_CTRL_DOWN 0xe401
94#define QEMU_KEY_CTRL_LEFT 0xe402
95#define QEMU_KEY_CTRL_RIGHT 0xe403
96#define QEMU_KEY_CTRL_HOME 0xe404
97#define QEMU_KEY_CTRL_END 0xe405
98#define QEMU_KEY_CTRL_PAGEUP 0xe406
99#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
100
101void kbd_put_keysym_console(QemuConsole *s, int keysym);
102bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
103void kbd_put_string_console(QemuConsole *s, const char *str, int len);
104void kbd_put_keysym(int keysym);
105
106
107
108#define TYPE_QEMU_CONSOLE "qemu-console"
109#define QEMU_CONSOLE(obj) \
110 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
111#define QEMU_CONSOLE_GET_CLASS(obj) \
112 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
113#define QEMU_CONSOLE_CLASS(klass) \
114 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
115
116typedef struct QemuConsoleClass QemuConsoleClass;
117
118struct QemuConsoleClass {
119 ObjectClass parent_class;
120};
121
122#define QEMU_ALLOCATED_FLAG 0x01
123
124struct PixelFormat {
125 uint8_t bits_per_pixel;
126 uint8_t bytes_per_pixel;
127 uint8_t depth;
128 uint32_t rmask, gmask, bmask, amask;
129 uint8_t rshift, gshift, bshift, ashift;
130 uint8_t rmax, gmax, bmax, amax;
131 uint8_t rbits, gbits, bbits, abits;
132};
133
134struct DisplaySurface {
135 pixman_format_code_t format;
136 pixman_image_t *image;
137 uint8_t flags;
138#ifdef CONFIG_OPENGL
139 GLenum glformat;
140 GLenum gltype;
141 GLuint texture;
142#endif
143};
144
145typedef struct QemuUIInfo {
146
147 int xoff;
148 int yoff;
149 uint32_t width;
150 uint32_t height;
151} QemuUIInfo;
152
153
154typedef struct QEMUCursor {
155 int width, height;
156 int hot_x, hot_y;
157 int refcount;
158 uint32_t data[];
159} QEMUCursor;
160
161QEMUCursor *cursor_alloc(int width, int height);
162void cursor_get(QEMUCursor *c);
163void cursor_put(QEMUCursor *c);
164QEMUCursor *cursor_builtin_hidden(void);
165QEMUCursor *cursor_builtin_left_ptr(void);
166void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
167int cursor_get_mono_bpl(QEMUCursor *c);
168void cursor_set_mono(QEMUCursor *c,
169 uint32_t foreground, uint32_t background, uint8_t *image,
170 int transparent, uint8_t *mask);
171void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
172void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
173
174typedef void *QEMUGLContext;
175typedef struct QEMUGLParams QEMUGLParams;
176
177struct QEMUGLParams {
178 int major_ver;
179 int minor_ver;
180};
181
182struct QemuDmaBuf {
183 int fd;
184 uint32_t width;
185 uint32_t height;
186 uint32_t stride;
187 uint32_t fourcc;
188 uint32_t texture;
189};
190
191typedef struct DisplayChangeListenerOps {
192 const char *dpy_name;
193
194 void (*dpy_refresh)(DisplayChangeListener *dcl);
195
196 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
197 int x, int y, int w, int h);
198 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
199 struct DisplaySurface *new_surface);
200 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
201 pixman_format_code_t format);
202
203 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
204 int x, int y);
205 void (*dpy_text_resize)(DisplayChangeListener *dcl,
206 int w, int h);
207 void (*dpy_text_update)(DisplayChangeListener *dcl,
208 int x, int y, int w, int h);
209
210 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
211 int x, int y, int on);
212 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
213 QEMUCursor *cursor);
214
215 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
216 QEMUGLParams *params);
217 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
218 QEMUGLContext ctx);
219 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
220 QEMUGLContext ctx);
221 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
222
223 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
224 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
225 uint32_t backing_id,
226 bool backing_y_0_top,
227 uint32_t backing_width,
228 uint32_t backing_height,
229 uint32_t x, uint32_t y,
230 uint32_t w, uint32_t h);
231 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
232 QemuDmaBuf *dmabuf);
233 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
234 QemuDmaBuf *dmabuf, bool have_hot,
235 uint32_t hot_x, uint32_t hot_y);
236 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
237 uint32_t pos_x, uint32_t pos_y);
238 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
239 QemuDmaBuf *dmabuf);
240 void (*dpy_gl_update)(DisplayChangeListener *dcl,
241 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
242
243} DisplayChangeListenerOps;
244
245struct DisplayChangeListener {
246 uint64_t update_interval;
247 const DisplayChangeListenerOps *ops;
248 DisplayState *ds;
249 QemuConsole *con;
250
251 QLIST_ENTRY(DisplayChangeListener) next;
252};
253
254DisplayState *init_displaystate(void);
255DisplaySurface *qemu_create_displaysurface_from(int width, int height,
256 pixman_format_code_t format,
257 int linesize, uint8_t *data);
258DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
259DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
260 pixman_format_code_t format,
261 int linesize,
262 uint64_t addr);
263DisplaySurface *qemu_create_message_surface(int w, int h,
264 const char *msg);
265PixelFormat qemu_default_pixelformat(int bpp);
266
267DisplaySurface *qemu_create_displaysurface(int width, int height);
268void qemu_free_displaysurface(DisplaySurface *surface);
269
270static inline int is_surface_bgr(DisplaySurface *surface)
271{
272 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
273 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
274 return 1;
275 } else {
276 return 0;
277 }
278}
279
280static inline int is_buffer_shared(DisplaySurface *surface)
281{
282 return !(surface->flags & QEMU_ALLOCATED_FLAG);
283}
284
285void register_displaychangelistener(DisplayChangeListener *dcl);
286void update_displaychangelistener(DisplayChangeListener *dcl,
287 uint64_t interval);
288void unregister_displaychangelistener(DisplayChangeListener *dcl);
289
290bool dpy_ui_info_supported(QemuConsole *con);
291int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
292
293void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
294void dpy_gfx_update_full(QemuConsole *con);
295void dpy_gfx_replace_surface(QemuConsole *con,
296 DisplaySurface *surface);
297void dpy_text_cursor(QemuConsole *con, int x, int y);
298void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
299void dpy_text_resize(QemuConsole *con, int w, int h);
300void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
301void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
302bool dpy_cursor_define_supported(QemuConsole *con);
303bool dpy_gfx_check_format(QemuConsole *con,
304 pixman_format_code_t format);
305
306void dpy_gl_scanout_disable(QemuConsole *con);
307void dpy_gl_scanout_texture(QemuConsole *con,
308 uint32_t backing_id, bool backing_y_0_top,
309 uint32_t backing_width, uint32_t backing_height,
310 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
311void dpy_gl_scanout_dmabuf(QemuConsole *con,
312 QemuDmaBuf *dmabuf);
313void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
314 bool have_hot, uint32_t hot_x, uint32_t hot_y);
315void dpy_gl_cursor_position(QemuConsole *con,
316 uint32_t pos_x, uint32_t pos_y);
317void dpy_gl_release_dmabuf(QemuConsole *con,
318 QemuDmaBuf *dmabuf);
319void dpy_gl_update(QemuConsole *con,
320 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
321
322QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
323 QEMUGLParams *params);
324void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
325int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
326QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
327
328bool console_has_gl(QemuConsole *con);
329bool console_has_gl_dmabuf(QemuConsole *con);
330
331static inline int surface_stride(DisplaySurface *s)
332{
333 return pixman_image_get_stride(s->image);
334}
335
336static inline void *surface_data(DisplaySurface *s)
337{
338 return pixman_image_get_data(s->image);
339}
340
341static inline int surface_width(DisplaySurface *s)
342{
343 return pixman_image_get_width(s->image);
344}
345
346static inline int surface_height(DisplaySurface *s)
347{
348 return pixman_image_get_height(s->image);
349}
350
351static inline int surface_bits_per_pixel(DisplaySurface *s)
352{
353 int bits = PIXMAN_FORMAT_BPP(s->format);
354 return bits;
355}
356
357static inline int surface_bytes_per_pixel(DisplaySurface *s)
358{
359 int bits = PIXMAN_FORMAT_BPP(s->format);
360 return DIV_ROUND_UP(bits, 8);
361}
362
363static inline pixman_format_code_t surface_format(DisplaySurface *s)
364{
365 return s->format;
366}
367
368typedef uint32_t console_ch_t;
369
370static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
371{
372 *dest = ch;
373}
374
375typedef struct GraphicHwOps {
376 void (*invalidate)(void *opaque);
377 void (*gfx_update)(void *opaque);
378 void (*text_update)(void *opaque, console_ch_t *text);
379 void (*update_interval)(void *opaque, uint64_t interval);
380 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
381 void (*gl_block)(void *opaque, bool block);
382} GraphicHwOps;
383
384QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
385 const GraphicHwOps *ops,
386 void *opaque);
387void graphic_console_set_hwops(QemuConsole *con,
388 const GraphicHwOps *hw_ops,
389 void *opaque);
390void graphic_console_close(QemuConsole *con);
391
392void graphic_hw_update(QemuConsole *con);
393void graphic_hw_invalidate(QemuConsole *con);
394void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
395void graphic_hw_gl_block(QemuConsole *con, bool block);
396
397void qemu_console_early_init(void);
398
399QemuConsole *qemu_console_lookup_by_index(unsigned int index);
400QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
401QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
402 uint32_t head, Error **errp);
403QemuConsole *qemu_console_lookup_unused(void);
404bool qemu_console_is_visible(QemuConsole *con);
405bool qemu_console_is_graphic(QemuConsole *con);
406bool qemu_console_is_fixedsize(QemuConsole *con);
407bool qemu_console_is_gl_blocked(QemuConsole *con);
408char *qemu_console_get_label(QemuConsole *con);
409int qemu_console_get_index(QemuConsole *con);
410uint32_t qemu_console_get_head(QemuConsole *con);
411QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
412int qemu_console_get_width(QemuConsole *con, int fallback);
413int qemu_console_get_height(QemuConsole *con, int fallback);
414
415int qemu_console_get_window_id(QemuConsole *con);
416
417void qemu_console_set_window_id(QemuConsole *con, int window_id);
418
419void console_select(unsigned int index);
420void qemu_console_resize(QemuConsole *con, int width, int height);
421DisplaySurface *qemu_console_surface(QemuConsole *con);
422
423
424#ifdef CONFIG_OPENGL
425bool console_gl_check_format(DisplayChangeListener *dcl,
426 pixman_format_code_t format);
427void surface_gl_create_texture(QemuGLShader *gls,
428 DisplaySurface *surface);
429void surface_gl_update_texture(QemuGLShader *gls,
430 DisplaySurface *surface,
431 int x, int y, int w, int h);
432void surface_gl_render_texture(QemuGLShader *gls,
433 DisplaySurface *surface);
434void surface_gl_destroy_texture(QemuGLShader *gls,
435 DisplaySurface *surface);
436void surface_gl_setup_viewport(QemuGLShader *gls,
437 DisplaySurface *surface,
438 int ww, int wh);
439#endif
440
441typedef struct QemuDisplay QemuDisplay;
442
443struct QemuDisplay {
444 DisplayType type;
445 void (*early_init)(DisplayOptions *opts);
446 void (*init)(DisplayState *ds, DisplayOptions *opts);
447};
448
449void qemu_display_register(QemuDisplay *ui);
450bool qemu_display_find_default(DisplayOptions *opts);
451void qemu_display_early_init(DisplayOptions *opts);
452void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
453
454
455void vnc_display_init(const char *id);
456void vnc_display_open(const char *id, Error **errp);
457void vnc_display_add_client(const char *id, int csock, bool skipauth);
458int vnc_display_password(const char *id, const char *password);
459int vnc_display_pw_expire(const char *id, time_t expires);
460QemuOpts *vnc_parse(const char *str, Error **errp);
461int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
462
463
464int index_from_key(const char *key, size_t key_length);
465
466#endif
467
