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