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