]> Git Repo - qemu.git/blame - include/ui/console.h
Merge remote-tracking branch 'remotes/stefanberger/tags/pull-tpm-2018-03-07-1' into...
[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
bc24a225 68struct MouseTransformInfo {
a5d7eb65
AZ
69 /* Touchscreen resolution */
70 int x;
71 int y;
72 /* Calibration values as used/generated by tslib */
73 int a[7];
74};
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);
50ef4679 102bool kbd_put_qcode_console(QemuConsole *s, int qcode);
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
GH
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
77bfcf28 122#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8
AL
123
124struct PixelFormat {
125 uint8_t bits_per_pixel;
126 uint8_t bytes_per_pixel;
127 uint8_t depth; /* color depth in bits */
128 uint32_t rmask, gmask, bmask, amask;
129 uint8_t rshift, gshift, bshift, ashift;
130 uint8_t rmax, gmax, bmax, amax;
90a1e3c0 131 uint8_t rbits, gbits, bbits, abits;
7d957bd8
AL
132};
133
134struct DisplaySurface {
69c77777
GH
135 pixman_format_code_t format;
136 pixman_image_t *image;
7d957bd8 137 uint8_t flags;
cd2bc889
GH
138#ifdef CONFIG_OPENGL
139 GLenum glformat;
140 GLenum gltype;
141 GLuint texture;
142#endif
7d957bd8
AL
143};
144
6f90f3d7
GH
145typedef struct QemuUIInfo {
146 /* geometry */
147 int xoff;
148 int yoff;
149 uint32_t width;
150 uint32_t height;
151} QemuUIInfo;
152
254e5950
GH
153/* cursor data format is 32bit RGBA */
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
06020b95
GH
174typedef void *QEMUGLContext;
175typedef struct QEMUGLParams QEMUGLParams;
176
177struct QEMUGLParams {
178 int major_ver;
179 int minor_ver;
180};
181
4133fa71
GH
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
7c20b4a3
GH
191typedef struct DisplayChangeListenerOps {
192 const char *dpy_name;
193
bc2ed970 194 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
195
196 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 197 int x, int y, int w, int h);
c12aeb86 198 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 199 struct DisplaySurface *new_surface);
49743df3
BH
200 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
201 pixman_format_code_t format);
a93a4a22 202
7c20b4a3 203 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
204 int x, int y);
205 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
206 int w, int h);
207 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
208 int x, int y, int w, int h);
209
210 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
211 int x, int y, int on);
212 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3 213 QEMUCursor *cursor);
06020b95
GH
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
eaa92c76 223 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
f4c36bda
GH
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);
4133fa71
GH
231 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
232 QemuDmaBuf *dmabuf);
233 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
6e1f2cb5
GH
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);
4133fa71
GH
238 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
239 QemuDmaBuf *dmabuf);
06020b95
GH
240 void (*dpy_gl_update)(DisplayChangeListener *dcl,
241 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
242
7c20b4a3 243} DisplayChangeListenerOps;
7d957bd8 244
7c20b4a3 245struct DisplayChangeListener {
0f7b2864 246 uint64_t update_interval;
7c20b4a3
GH
247 const DisplayChangeListenerOps *ops;
248 DisplayState *ds;
284d1c6b 249 QemuConsole *con;
bf2fde70 250
87e487a1 251 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
252};
253
64840c66 254DisplayState *init_displaystate(void);
30f1e661
GH
255DisplaySurface *qemu_create_displaysurface_from(int width, int height,
256 pixman_format_code_t format,
257 int linesize, uint8_t *data);
ca58b45f 258DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
a77549b3
GH
259DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
260 pixman_format_code_t format,
261 int linesize,
262 uint64_t addr);
0da2ea1b 263PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 264
da229ef3
GH
265DisplaySurface *qemu_create_displaysurface(int width, int height);
266void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da
AL
267
268static inline int is_surface_bgr(DisplaySurface *surface)
269{
30f1e661
GH
270 if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
271 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da 272 return 1;
30f1e661 273 } else {
7b5d76da 274 return 0;
30f1e661 275 }
7b5d76da
AL
276}
277
7d957bd8
AL
278static inline int is_buffer_shared(DisplaySurface *surface)
279{
187cd1d9 280 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
281}
282
5209089f 283void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864
GH
284void update_displaychangelistener(DisplayChangeListener *dcl,
285 uint64_t interval);
7c20b4a3
GH
286void unregister_displaychangelistener(DisplayChangeListener *dcl);
287
b7fb49f0 288bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7
GH
289int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
290
c78f7137
GH
291void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
292void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 293 DisplaySurface *surface);
c78f7137
GH
294void dpy_text_cursor(QemuConsole *con, int x, int y);
295void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
296void dpy_text_resize(QemuConsole *con, int w, int h);
297void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
298void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
299bool dpy_cursor_define_supported(QemuConsole *con);
49743df3
BH
300bool dpy_gfx_check_format(QemuConsole *con,
301 pixman_format_code_t format);
bf2fde70 302
eaa92c76 303void dpy_gl_scanout_disable(QemuConsole *con);
f4c36bda
GH
304void dpy_gl_scanout_texture(QemuConsole *con,
305 uint32_t backing_id, bool backing_y_0_top,
306 uint32_t backing_width, uint32_t backing_height,
307 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
4133fa71
GH
308void dpy_gl_scanout_dmabuf(QemuConsole *con,
309 QemuDmaBuf *dmabuf);
6e1f2cb5
GH
310void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
311 bool have_hot, uint32_t hot_x, uint32_t hot_y);
312void dpy_gl_cursor_position(QemuConsole *con,
313 uint32_t pos_x, uint32_t pos_y);
4133fa71
GH
314void dpy_gl_release_dmabuf(QemuConsole *con,
315 QemuDmaBuf *dmabuf);
06020b95
GH
316void dpy_gl_update(QemuConsole *con,
317 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
318
319QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
320 QEMUGLParams *params);
321void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
322int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
323QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
324
325bool console_has_gl(QemuConsole *con);
4133fa71 326bool console_has_gl_dmabuf(QemuConsole *con);
06020b95 327
626e3b34
GH
328static inline int surface_stride(DisplaySurface *s)
329{
330 return pixman_image_get_stride(s->image);
331}
332
333static inline void *surface_data(DisplaySurface *s)
334{
335 return pixman_image_get_data(s->image);
336}
337
338static inline int surface_width(DisplaySurface *s)
339{
340 return pixman_image_get_width(s->image);
341}
342
343static inline int surface_height(DisplaySurface *s)
344{
345 return pixman_image_get_height(s->image);
346}
347
348static inline int surface_bits_per_pixel(DisplaySurface *s)
349{
350 int bits = PIXMAN_FORMAT_BPP(s->format);
351 return bits;
352}
353
354static inline int surface_bytes_per_pixel(DisplaySurface *s)
355{
356 int bits = PIXMAN_FORMAT_BPP(s->format);
d1a0945f 357 return DIV_ROUND_UP(bits, 8);
626e3b34
GH
358}
359
e444ea34
HR
360static inline pixman_format_code_t surface_format(DisplaySurface *s)
361{
362 return s->format;
363}
364
e2f82e92
GH
365typedef uint32_t console_ch_t;
366
c227f099 367static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 368{
9ae19b65 369 *dest = ch;
4d3b6f6e
AZ
370}
371
380cd056
GH
372typedef struct GraphicHwOps {
373 void (*invalidate)(void *opaque);
374 void (*gfx_update)(void *opaque);
375 void (*text_update)(void *opaque, console_ch_t *text);
dea1b0bd 376 void (*update_interval)(void *opaque, uint64_t interval);
6f90f3d7 377 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
bba19b88 378 void (*gl_block)(void *opaque, bool block);
380cd056 379} GraphicHwOps;
87ecb68b 380
5643706a 381QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
aa2beaa1 382 const GraphicHwOps *ops,
c78f7137 383 void *opaque);
1c1f9498
GH
384void graphic_console_set_hwops(QemuConsole *con,
385 const GraphicHwOps *hw_ops,
386 void *opaque);
3023f332 387
1dbfa005
GH
388void graphic_hw_update(QemuConsole *con);
389void graphic_hw_invalidate(QemuConsole *con);
390void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
bba19b88 391void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b 392
777357d7
MAL
393void qemu_console_early_init(void);
394
284d1c6b 395QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a 396QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
f2c1d54c
GH
397QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
398 uint32_t head, Error **errp);
81c0d5a6
GH
399bool qemu_console_is_visible(QemuConsole *con);
400bool qemu_console_is_graphic(QemuConsole *con);
401bool qemu_console_is_fixedsize(QemuConsole *con);
f607867c 402bool qemu_console_is_gl_blocked(QemuConsole *con);
779ce88f 403char *qemu_console_get_label(QemuConsole *con);
d4c85337 404int qemu_console_get_index(QemuConsole *con);
5643706a 405uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7 406QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
d4c85337
GH
407int qemu_console_get_width(QemuConsole *con, int fallback);
408int qemu_console_get_height(QemuConsole *con, int fallback);
b3cb21b9
ST
409/* Return the low-level window id for the console */
410int qemu_console_get_window_id(QemuConsole *con);
411/* Set the low-level window id for the console */
412void qemu_console_set_window_id(QemuConsole *con, int window_id);
81c0d5a6 413
87ecb68b 414void console_select(unsigned int index);
c78f7137 415void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137 416DisplaySurface *qemu_console_surface(QemuConsole *con);
87ecb68b 417
cd2bc889 418/* console-gl.c */
cd2bc889 419#ifdef CONFIG_OPENGL
cd2bc889
GH
420bool console_gl_check_format(DisplayChangeListener *dcl,
421 pixman_format_code_t format);
46e19e14 422void surface_gl_create_texture(QemuGLShader *gls,
cd2bc889 423 DisplaySurface *surface);
46e19e14 424void surface_gl_update_texture(QemuGLShader *gls,
cd2bc889
GH
425 DisplaySurface *surface,
426 int x, int y, int w, int h);
46e19e14 427void surface_gl_render_texture(QemuGLShader *gls,
cd2bc889 428 DisplaySurface *surface);
46e19e14 429void surface_gl_destroy_texture(QemuGLShader *gls,
cd2bc889 430 DisplaySurface *surface);
46e19e14 431void surface_gl_setup_viewport(QemuGLShader *gls,
cd2bc889
GH
432 DisplaySurface *surface,
433 int ww, int wh);
434#endif
435
db71589f 436typedef struct QemuDisplay QemuDisplay;
87ecb68b 437
db71589f
GH
438struct QemuDisplay {
439 DisplayType type;
440 void (*early_init)(DisplayOptions *opts);
441 void (*init)(DisplayState *ds, DisplayOptions *opts);
442};
443
444void qemu_display_register(QemuDisplay *ui);
898f9d41 445bool qemu_display_find_default(DisplayOptions *opts);
db71589f
GH
446void qemu_display_early_init(DisplayOptions *opts);
447void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
87ecb68b
PB
448
449/* vnc.c */
14f7143e 450void vnc_display_init(const char *id);
4db14629 451void vnc_display_open(const char *id, Error **errp);
14f7143e 452void vnc_display_add_client(const char *id, int csock, bool skipauth);
14f7143e
GH
453int vnc_display_password(const char *id, const char *password);
454int vnc_display_pw_expire(const char *id, time_t expires);
70b94331 455QemuOpts *vnc_parse(const char *str, Error **errp);
28d0de7a 456int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
87ecb68b 457
1048c88f 458/* input.c */
64ffbe04 459int index_from_key(const char *key, size_t key_length);
1048c88f 460
87ecb68b 461#endif
This page took 0.67983 seconds and 4 git commands to generate.