]> git.proxmox.com Git - mirror_qemu.git/blame - include/ui/console.h
Use DECLARE_*CHECKER* macros
[mirror_qemu.git] / include / ui / console.h
CommitLineData
87ecb68b
PB
1#ifndef CONSOLE_H
2#define CONSOLE_H
3
28ecbaee 4#include "ui/qemu-pixman.h"
95be0669 5#include "qom/object.h"
1de7afc9 6#include "qemu/notify.h"
f8c75b24 7#include "qemu/error-report.h"
9af23989 8#include "qapi/qapi-types-ui.h"
87ecb68b 9
cd2bc889 10#ifdef CONFIG_OPENGL
dcf30025 11# include <epoxy/gl.h>
46e19e14 12# include "ui/shader.h"
cd2bc889
GH
13#endif
14
87ecb68b
PB
15/* keyboard/mouse support */
16
17#define MOUSE_EVENT_LBUTTON 0x01
18#define MOUSE_EVENT_RBUTTON 0x02
19#define MOUSE_EVENT_MBUTTON 0x04
21bae11a
GH
20#define MOUSE_EVENT_WHEELUP 0x08
21#define MOUSE_EVENT_WHEELDN 0x10
87ecb68b 22
03a23a85
GH
23/* identical to the ps/2 keyboard bits */
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
7ed9eba3 28/* in ms */
0f7b2864
GH
29#define GUI_REFRESH_INTERVAL_DEFAULT 30
30#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3 31
4083733d
OH
32/* Color number is match to standard vga palette */
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/* Convert to curses char attributes */
44#define ATTR2CHTYPE(c, fg, bg, bold) \
45 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
46
87ecb68b 47typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85 48typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b
PB
49typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
50
72711efb 51typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d 52typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb 53typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85 54
5a37532d
GH
55QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
56 void *opaque);
87ecb68b
PB
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);
6fef28ee
AL
61void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
62
03a23a85
GH
63QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
64void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b 65
03a23a85 66void kbd_put_ledstate(int ledstate);
eb2e259d 67
5a4c2e59 68typedef struct MouseTransformInfo {
a5d7eb65
AZ
69 /* Touchscreen resolution */
70 int x;
71 int y;
72 /* Calibration values as used/generated by tslib */
73 int a[7];
5a4c2e59 74} MouseTransformInfo;
a5d7eb65 75
3e5a50d6 76void hmp_mouse_set(Monitor *mon, const QDict *qdict);
87ecb68b
PB
77
78/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
79 constants) */
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
3f9a6e85 101void kbd_put_keysym_console(QemuConsole *s, int keysym);
da024b1e 102bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
bdef9724 103void kbd_put_string_console(QemuConsole *s, const char *str, int len);
87ecb68b
PB
104void kbd_put_keysym(int keysym);
105
106/* consoles */
107
95be0669 108#define TYPE_QEMU_CONSOLE "qemu-console"
db1015e9 109typedef struct QemuConsoleClass QemuConsoleClass;
8110fa1d
EH
110DECLARE_OBJ_CHECKERS(QemuConsole, QemuConsoleClass,
111 QEMU_CONSOLE, TYPE_QEMU_CONSOLE)
95be0669 112
95be0669
GH
113
114struct QemuConsoleClass {
115 ObjectClass parent_class;
116};
117
77bfcf28 118#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8 119
7536587c 120typedef struct DisplaySurface {
69c77777
GH
121 pixman_format_code_t format;
122 pixman_image_t *image;
7d957bd8 123 uint8_t flags;
cd2bc889
GH
124#ifdef CONFIG_OPENGL
125 GLenum glformat;
126 GLenum gltype;
127 GLuint texture;
128#endif
7536587c 129} DisplaySurface;
7d957bd8 130
6f90f3d7
GH
131typedef struct QemuUIInfo {
132 /* geometry */
133 int xoff;
134 int yoff;
135 uint32_t width;
136 uint32_t height;
137} QemuUIInfo;
138
254e5950
GH
139/* cursor data format is 32bit RGBA */
140typedef struct QEMUCursor {
141 int width, height;
142 int hot_x, hot_y;
143 int refcount;
144 uint32_t data[];
145} QEMUCursor;
146
147QEMUCursor *cursor_alloc(int width, int height);
148void cursor_get(QEMUCursor *c);
149void cursor_put(QEMUCursor *c);
150QEMUCursor *cursor_builtin_hidden(void);
151QEMUCursor *cursor_builtin_left_ptr(void);
152void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
153int cursor_get_mono_bpl(QEMUCursor *c);
154void cursor_set_mono(QEMUCursor *c,
155 uint32_t foreground, uint32_t background, uint8_t *image,
156 int transparent, uint8_t *mask);
157void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
158void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
159
06020b95
GH
160typedef void *QEMUGLContext;
161typedef struct QEMUGLParams QEMUGLParams;
162
163struct QEMUGLParams {
164 int major_ver;
165 int minor_ver;
166};
167
dfbb251e 168typedef struct QemuDmaBuf {
4133fa71
GH
169 int fd;
170 uint32_t width;
171 uint32_t height;
172 uint32_t stride;
173 uint32_t fourcc;
152b7af6 174 uint64_t modifier;
4133fa71 175 uint32_t texture;
242d0133 176 bool y0_top;
dfbb251e 177} QemuDmaBuf;
4133fa71 178
7536587c
PMD
179typedef struct DisplayState DisplayState;
180
7c20b4a3
GH
181typedef struct DisplayChangeListenerOps {
182 const char *dpy_name;
183
bc2ed970 184 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
185
186 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 187 int x, int y, int w, int h);
c12aeb86 188 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 189 struct DisplaySurface *new_surface);
49743df3
BH
190 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
191 pixman_format_code_t format);
a93a4a22 192
7c20b4a3 193 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
194 int x, int y);
195 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
196 int w, int h);
197 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
198 int x, int y, int w, int h);
199
200 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
201 int x, int y, int on);
202 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3 203 QEMUCursor *cursor);
06020b95
GH
204
205 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
206 QEMUGLParams *params);
207 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
208 QEMUGLContext ctx);
209 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
210 QEMUGLContext ctx);
211 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);
212
eaa92c76 213 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
f4c36bda
GH
214 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
215 uint32_t backing_id,
216 bool backing_y_0_top,
217 uint32_t backing_width,
218 uint32_t backing_height,
219 uint32_t x, uint32_t y,
220 uint32_t w, uint32_t h);
4133fa71
GH
221 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
222 QemuDmaBuf *dmabuf);
223 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
6e1f2cb5
GH
224 QemuDmaBuf *dmabuf, bool have_hot,
225 uint32_t hot_x, uint32_t hot_y);
226 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
227 uint32_t pos_x, uint32_t pos_y);
4133fa71
GH
228 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
229 QemuDmaBuf *dmabuf);
06020b95
GH
230 void (*dpy_gl_update)(DisplayChangeListener *dcl,
231 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
232
7c20b4a3 233} DisplayChangeListenerOps;
7d957bd8 234
7c20b4a3 235struct DisplayChangeListener {
0f7b2864 236 uint64_t update_interval;
7c20b4a3
GH
237 const DisplayChangeListenerOps *ops;
238 DisplayState *ds;
284d1c6b 239 QemuConsole *con;
bf2fde70 240
87e487a1 241 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
242};
243
64840c66 244DisplayState *init_displaystate(void);
30f1e661
GH
245DisplaySurface *qemu_create_displaysurface_from(int width, int height,
246 pixman_format_code_t format,
247 int linesize, uint8_t *data);
ca58b45f 248DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
2e5567c9
GH
249DisplaySurface *qemu_create_message_surface(int w, int h,
250 const char *msg);
0da2ea1b 251PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 252
da229ef3
GH
253DisplaySurface *qemu_create_displaysurface(int width, int height);
254void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da
AL
255
256static inline int is_surface_bgr(DisplaySurface *surface)
257{
30f1e661
GH
258 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
259 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da 260 return 1;
30f1e661 261 } else {
7b5d76da 262 return 0;
30f1e661 263 }
7b5d76da
AL
264}
265
7d957bd8
AL
266static inline int is_buffer_shared(DisplaySurface *surface)
267{
187cd1d9 268 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
269}
270
5209089f 271void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864
GH
272void update_displaychangelistener(DisplayChangeListener *dcl,
273 uint64_t interval);
7c20b4a3
GH
274void unregister_displaychangelistener(DisplayChangeListener *dcl);
275
b7fb49f0 276bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7
GH
277int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
278
c78f7137 279void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
7cd0afe6 280void dpy_gfx_update_full(QemuConsole *con);
c78f7137 281void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 282 DisplaySurface *surface);
c78f7137
GH
283void dpy_text_cursor(QemuConsole *con, int x, int y);
284void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
285void dpy_text_resize(QemuConsole *con, int w, int h);
286void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
287void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
288bool dpy_cursor_define_supported(QemuConsole *con);
49743df3
BH
289bool dpy_gfx_check_format(QemuConsole *con,
290 pixman_format_code_t format);
bf2fde70 291
eaa92c76 292void dpy_gl_scanout_disable(QemuConsole *con);
f4c36bda
GH
293void dpy_gl_scanout_texture(QemuConsole *con,
294 uint32_t backing_id, bool backing_y_0_top,
295 uint32_t backing_width, uint32_t backing_height,
296 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
4133fa71
GH
297void dpy_gl_scanout_dmabuf(QemuConsole *con,
298 QemuDmaBuf *dmabuf);
6e1f2cb5
GH
299void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
300 bool have_hot, uint32_t hot_x, uint32_t hot_y);
301void dpy_gl_cursor_position(QemuConsole *con,
302 uint32_t pos_x, uint32_t pos_y);
4133fa71
GH
303void dpy_gl_release_dmabuf(QemuConsole *con,
304 QemuDmaBuf *dmabuf);
06020b95
GH
305void dpy_gl_update(QemuConsole *con,
306 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
307
308QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
309 QEMUGLParams *params);
310void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
311int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
312QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
313
314bool console_has_gl(QemuConsole *con);
4133fa71 315bool console_has_gl_dmabuf(QemuConsole *con);
06020b95 316
626e3b34
GH
317static inline int surface_stride(DisplaySurface *s)
318{
319 return pixman_image_get_stride(s->image);
320}
321
322static inline void *surface_data(DisplaySurface *s)
323{
324 return pixman_image_get_data(s->image);
325}
326
327static inline int surface_width(DisplaySurface *s)
328{
329 return pixman_image_get_width(s->image);
330}
331
332static inline int surface_height(DisplaySurface *s)
333{
334 return pixman_image_get_height(s->image);
335}
336
337static inline int surface_bits_per_pixel(DisplaySurface *s)
338{
339 int bits = PIXMAN_FORMAT_BPP(s->format);
340 return bits;
341}
342
343static inline int surface_bytes_per_pixel(DisplaySurface *s)
344{
345 int bits = PIXMAN_FORMAT_BPP(s->format);
d1a0945f 346 return DIV_ROUND_UP(bits, 8);
626e3b34
GH
347}
348
e444ea34
HR
349static inline pixman_format_code_t surface_format(DisplaySurface *s)
350{
351 return s->format;
352}
353
e2f82e92
GH
354typedef uint32_t console_ch_t;
355
c227f099 356static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 357{
9ae19b65 358 *dest = ch;
4d3b6f6e
AZ
359}
360
380cd056
GH
361typedef struct GraphicHwOps {
362 void (*invalidate)(void *opaque);
363 void (*gfx_update)(void *opaque);
4d631621 364 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
380cd056 365 void (*text_update)(void *opaque, console_ch_t *text);
dea1b0bd 366 void (*update_interval)(void *opaque, uint64_t interval);
6f90f3d7 367 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
bba19b88 368 void (*gl_block)(void *opaque, bool block);
380cd056 369} GraphicHwOps;
87ecb68b 370
5643706a 371QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
aa2beaa1 372 const GraphicHwOps *ops,
c78f7137 373 void *opaque);
1c1f9498
GH
374void graphic_console_set_hwops(QemuConsole *con,
375 const GraphicHwOps *hw_ops,
376 void *opaque);
9588d67e 377void graphic_console_close(QemuConsole *con);
3023f332 378
1dbfa005 379void graphic_hw_update(QemuConsole *con);
4d631621 380void graphic_hw_update_done(QemuConsole *con);
1dbfa005
GH
381void graphic_hw_invalidate(QemuConsole *con);
382void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
bba19b88 383void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b 384
777357d7
MAL
385void qemu_console_early_init(void);
386
284d1c6b 387QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a 388QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
f2c1d54c
GH
389QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
390 uint32_t head, Error **errp);
9588d67e 391QemuConsole *qemu_console_lookup_unused(void);
81c0d5a6
GH
392bool qemu_console_is_visible(QemuConsole *con);
393bool qemu_console_is_graphic(QemuConsole *con);
394bool qemu_console_is_fixedsize(QemuConsole *con);
f607867c 395bool qemu_console_is_gl_blocked(QemuConsole *con);
779ce88f 396char *qemu_console_get_label(QemuConsole *con);
d4c85337 397int qemu_console_get_index(QemuConsole *con);
5643706a 398uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7 399QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
d4c85337
GH
400int qemu_console_get_width(QemuConsole *con, int fallback);
401int qemu_console_get_height(QemuConsole *con, int fallback);
b3cb21b9
ST
402/* Return the low-level window id for the console */
403int qemu_console_get_window_id(QemuConsole *con);
404/* Set the low-level window id for the console */
405void qemu_console_set_window_id(QemuConsole *con, int window_id);
81c0d5a6 406
87ecb68b 407void console_select(unsigned int index);
c78f7137 408void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137 409DisplaySurface *qemu_console_surface(QemuConsole *con);
87ecb68b 410
cd2bc889 411/* console-gl.c */
cd2bc889 412#ifdef CONFIG_OPENGL
cd2bc889
GH
413bool console_gl_check_format(DisplayChangeListener *dcl,
414 pixman_format_code_t format);
46e19e14 415void surface_gl_create_texture(QemuGLShader *gls,
cd2bc889 416 DisplaySurface *surface);
46e19e14 417void surface_gl_update_texture(QemuGLShader *gls,
cd2bc889
GH
418 DisplaySurface *surface,
419 int x, int y, int w, int h);
46e19e14 420void surface_gl_render_texture(QemuGLShader *gls,
cd2bc889 421 DisplaySurface *surface);
46e19e14 422void surface_gl_destroy_texture(QemuGLShader *gls,
cd2bc889 423 DisplaySurface *surface);
46e19e14 424void surface_gl_setup_viewport(QemuGLShader *gls,
cd2bc889
GH
425 DisplaySurface *surface,
426 int ww, int wh);
427#endif
428
db71589f 429typedef struct QemuDisplay QemuDisplay;
87ecb68b 430
db71589f
GH
431struct QemuDisplay {
432 DisplayType type;
433 void (*early_init)(DisplayOptions *opts);
434 void (*init)(DisplayState *ds, DisplayOptions *opts);
435};
436
437void qemu_display_register(QemuDisplay *ui);
898f9d41 438bool qemu_display_find_default(DisplayOptions *opts);
db71589f
GH
439void qemu_display_early_init(DisplayOptions *opts);
440void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
c388f408 441void qemu_display_help(void);
87ecb68b
PB
442
443/* vnc.c */
ab4f931e 444void vnc_display_init(const char *id, Error **errp);
4db14629 445void vnc_display_open(const char *id, Error **errp);
14f7143e 446void vnc_display_add_client(const char *id, int csock, bool skipauth);
14f7143e
GH
447int vnc_display_password(const char *id, const char *password);
448int vnc_display_pw_expire(const char *id, time_t expires);
70b94331 449QemuOpts *vnc_parse(const char *str, Error **errp);
28d0de7a 450int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
87ecb68b 451
1048c88f 452/* input.c */
64ffbe04 453int index_from_key(const char *key, size_t key_length);
1048c88f 454
87ecb68b 455#endif