xref: /qemu/include/ui/console.h (revision 56cdca1d) 
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 /* keyboard/mouse support */
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 /* 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 
28 /* in ms */
29 #define GUI_REFRESH_INTERVAL_DEFAULT    30
30 #define GUI_REFRESH_INTERVAL_IDLE     3000
31 
32 /* Color number is match to standard vga palette */
33 enum 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 
47 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
48 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
49 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
50 
51 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
52 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
53 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
54 
55 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
56                                             void *opaque);
57 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
58                                                 void *opaque, int absolute,
59                                                 const char *name);
60 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
61 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
62 
63 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
64 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
65 
66 void kbd_put_ledstate(int ledstate);
67 
68 struct MouseTransformInfo {
69     /* Touchscreen resolution */
70     int x;
71     int y;
72     /* Calibration values as used/generated by tslib */
73     int a[7];
74 };
75 
76 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
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 
101 void kbd_put_keysym_console(QemuConsole *s, int keysym);
102 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
103 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
104 void kbd_put_keysym(int keysym);
105 
106 /* consoles */
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 
116 typedef struct QemuConsoleClass QemuConsoleClass;
117 
118 struct QemuConsoleClass {
119     ObjectClass parent_class;
120 };
121 
122 #define QEMU_ALLOCATED_FLAG     0x01
123 
124 struct 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;
131     uint8_t rbits, gbits, bbits, abits;
132 };
133 
134 struct 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 
145 typedef struct QemuUIInfo {
146     /* geometry */
147     int       xoff;
148     int       yoff;
149     uint32_t  width;
150     uint32_t  height;
151 } QemuUIInfo;
152 
153 /* cursor data format is 32bit RGBA */
154 typedef struct QEMUCursor {
155     int                 width, height;
156     int                 hot_x, hot_y;
157     int                 refcount;
158     uint32_t            data[];
159 } QEMUCursor;
160 
161 QEMUCursor *cursor_alloc(int width, int height);
162 void cursor_get(QEMUCursor *c);
163 void cursor_put(QEMUCursor *c);
164 QEMUCursor *cursor_builtin_hidden(void);
165 QEMUCursor *cursor_builtin_left_ptr(void);
166 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
167 int cursor_get_mono_bpl(QEMUCursor *c);
168 void cursor_set_mono(QEMUCursor *c,
169                      uint32_t foreground, uint32_t background, uint8_t *image,
170                      int transparent, uint8_t *mask);
171 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
172 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
173 
174 typedef void *QEMUGLContext;
175 typedef struct QEMUGLParams QEMUGLParams;
176 
177 struct QEMUGLParams {
178     int major_ver;
179     int minor_ver;
180 };
181 
182 struct 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 
192 typedef 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 
246 struct DisplayChangeListener {
247     uint64_t update_interval;
248     const DisplayChangeListenerOps *ops;
249     DisplayState *ds;
250     QemuConsole *con;
251 
252     QLIST_ENTRY(DisplayChangeListener) next;
253 };
254 
255 DisplayState *init_displaystate(void);
256 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
257                                                 pixman_format_code_t format,
258                                                 int linesize, uint8_t *data);
259 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
260 DisplaySurface *qemu_create_message_surface(int w, int h,
261                                             const char *msg);
262 PixelFormat qemu_default_pixelformat(int bpp);
263 
264 DisplaySurface *qemu_create_displaysurface(int width, int height);
265 void qemu_free_displaysurface(DisplaySurface *surface);
266 
267 static inline int is_surface_bgr(DisplaySurface *surface)
268 {
269     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
270         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
271         return 1;
272     } else {
273         return 0;
274     }
275 }
276 
277 static inline int is_buffer_shared(DisplaySurface *surface)
278 {
279     return !(surface->flags & QEMU_ALLOCATED_FLAG);
280 }
281 
282 void register_displaychangelistener(DisplayChangeListener *dcl);
283 void update_displaychangelistener(DisplayChangeListener *dcl,
284                                   uint64_t interval);
285 void unregister_displaychangelistener(DisplayChangeListener *dcl);
286 
287 bool dpy_ui_info_supported(QemuConsole *con);
288 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
289 
290 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
291 void dpy_gfx_update_full(QemuConsole *con);
292 void dpy_gfx_replace_surface(QemuConsole *con,
293                              DisplaySurface *surface);
294 void dpy_text_cursor(QemuConsole *con, int x, int y);
295 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
296 void dpy_text_resize(QemuConsole *con, int w, int h);
297 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
298 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
299 bool dpy_cursor_define_supported(QemuConsole *con);
300 bool dpy_gfx_check_format(QemuConsole *con,
301                           pixman_format_code_t format);
302 
303 void dpy_gl_scanout_disable(QemuConsole *con);
304 void 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);
308 void dpy_gl_scanout_dmabuf(QemuConsole *con,
309                            QemuDmaBuf *dmabuf);
310 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
311                           bool have_hot, uint32_t hot_x, uint32_t hot_y);
312 void dpy_gl_cursor_position(QemuConsole *con,
313                             uint32_t pos_x, uint32_t pos_y);
314 void dpy_gl_release_dmabuf(QemuConsole *con,
315                            QemuDmaBuf *dmabuf);
316 void dpy_gl_update(QemuConsole *con,
317                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
318 
319 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
320                                 QEMUGLParams *params);
321 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
322 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
323 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
324 
325 bool console_has_gl(QemuConsole *con);
326 bool console_has_gl_dmabuf(QemuConsole *con);
327 
328 static inline int surface_stride(DisplaySurface *s)
329 {
330     return pixman_image_get_stride(s->image);
331 }
332 
333 static inline void *surface_data(DisplaySurface *s)
334 {
335     return pixman_image_get_data(s->image);
336 }
337 
338 static inline int surface_width(DisplaySurface *s)
339 {
340     return pixman_image_get_width(s->image);
341 }
342 
343 static inline int surface_height(DisplaySurface *s)
344 {
345     return pixman_image_get_height(s->image);
346 }
347 
348 static inline int surface_bits_per_pixel(DisplaySurface *s)
349 {
350     int bits = PIXMAN_FORMAT_BPP(s->format);
351     return bits;
352 }
353 
354 static inline int surface_bytes_per_pixel(DisplaySurface *s)
355 {
356     int bits = PIXMAN_FORMAT_BPP(s->format);
357     return DIV_ROUND_UP(bits, 8);
358 }
359 
360 static inline pixman_format_code_t surface_format(DisplaySurface *s)
361 {
362     return s->format;
363 }
364 
365 typedef uint32_t console_ch_t;
366 
367 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
368 {
369     *dest = ch;
370 }
371 
372 typedef struct GraphicHwOps {
373     void (*invalidate)(void *opaque);
374     void (*gfx_update)(void *opaque);
375     void (*text_update)(void *opaque, console_ch_t *text);
376     void (*update_interval)(void *opaque, uint64_t interval);
377     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
378     void (*gl_block)(void *opaque, bool block);
379 } GraphicHwOps;
380 
381 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
382                                   const GraphicHwOps *ops,
383                                   void *opaque);
384 void graphic_console_set_hwops(QemuConsole *con,
385                                const GraphicHwOps *hw_ops,
386                                void *opaque);
387 void graphic_console_close(QemuConsole *con);
388 
389 void graphic_hw_update(QemuConsole *con);
390 void graphic_hw_invalidate(QemuConsole *con);
391 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
392 void graphic_hw_gl_block(QemuConsole *con, bool block);
393 
394 void qemu_console_early_init(void);
395 
396 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
397 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
398 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
399                                                 uint32_t head, Error **errp);
400 QemuConsole *qemu_console_lookup_unused(void);
401 bool qemu_console_is_visible(QemuConsole *con);
402 bool qemu_console_is_graphic(QemuConsole *con);
403 bool qemu_console_is_fixedsize(QemuConsole *con);
404 bool qemu_console_is_gl_blocked(QemuConsole *con);
405 char *qemu_console_get_label(QemuConsole *con);
406 int qemu_console_get_index(QemuConsole *con);
407 uint32_t qemu_console_get_head(QemuConsole *con);
408 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
409 int qemu_console_get_width(QemuConsole *con, int fallback);
410 int qemu_console_get_height(QemuConsole *con, int fallback);
411 /* Return the low-level window id for the console */
412 int qemu_console_get_window_id(QemuConsole *con);
413 /* Set the low-level window id for the console */
414 void qemu_console_set_window_id(QemuConsole *con, int window_id);
415 
416 void console_select(unsigned int index);
417 void qemu_console_resize(QemuConsole *con, int width, int height);
418 DisplaySurface *qemu_console_surface(QemuConsole *con);
419 
420 /* console-gl.c */
421 #ifdef CONFIG_OPENGL
422 bool console_gl_check_format(DisplayChangeListener *dcl,
423                              pixman_format_code_t format);
424 void surface_gl_create_texture(QemuGLShader *gls,
425                                DisplaySurface *surface);
426 void surface_gl_update_texture(QemuGLShader *gls,
427                                DisplaySurface *surface,
428                                int x, int y, int w, int h);
429 void surface_gl_render_texture(QemuGLShader *gls,
430                                DisplaySurface *surface);
431 void surface_gl_destroy_texture(QemuGLShader *gls,
432                                DisplaySurface *surface);
433 void surface_gl_setup_viewport(QemuGLShader *gls,
434                                DisplaySurface *surface,
435                                int ww, int wh);
436 #endif
437 
438 typedef struct QemuDisplay QemuDisplay;
439 
440 struct QemuDisplay {
441     DisplayType type;
442     void (*early_init)(DisplayOptions *opts);
443     void (*init)(DisplayState *ds, DisplayOptions *opts);
444 };
445 
446 void qemu_display_register(QemuDisplay *ui);
447 bool qemu_display_find_default(DisplayOptions *opts);
448 void qemu_display_early_init(DisplayOptions *opts);
449 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
450 
451 /* vnc.c */
452 void vnc_display_init(const char *id, Error **errp);
453 void vnc_display_open(const char *id, Error **errp);
454 void vnc_display_add_client(const char *id, int csock, bool skipauth);
455 int vnc_display_password(const char *id, const char *password);
456 int vnc_display_pw_expire(const char *id, time_t expires);
457 QemuOpts *vnc_parse(const char *str, Error **errp);
458 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
459 
460 /* input.c */
461 int index_from_key(const char *key, size_t key_length);
462 
463 #endif
464