xref: /openbmc/qemu/include/ui/console.h (revision d0f0cd5b)
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 "qapi/qapi-types-ui.h"
8 #include "ui/input.h"
9 #include "ui/surface.h"
10 #include "ui/dmabuf.h"
11 
12 #define TYPE_QEMU_CONSOLE "qemu-console"
13 OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE)
14 
15 #define TYPE_QEMU_GRAPHIC_CONSOLE "qemu-graphic-console"
16 OBJECT_DECLARE_SIMPLE_TYPE(QemuGraphicConsole, QEMU_GRAPHIC_CONSOLE)
17 
18 #define TYPE_QEMU_TEXT_CONSOLE "qemu-text-console"
19 OBJECT_DECLARE_SIMPLE_TYPE(QemuTextConsole, QEMU_TEXT_CONSOLE)
20 
21 #define TYPE_QEMU_FIXED_TEXT_CONSOLE "qemu-fixed-text-console"
22 OBJECT_DECLARE_SIMPLE_TYPE(QemuFixedTextConsole, QEMU_FIXED_TEXT_CONSOLE)
23 
24 #define QEMU_IS_GRAPHIC_CONSOLE(c) \
25     object_dynamic_cast(OBJECT(c), TYPE_QEMU_GRAPHIC_CONSOLE)
26 
27 #define QEMU_IS_TEXT_CONSOLE(c) \
28     object_dynamic_cast(OBJECT(c), TYPE_QEMU_TEXT_CONSOLE)
29 
30 #define QEMU_IS_FIXED_TEXT_CONSOLE(c) \
31     object_dynamic_cast(OBJECT(c), TYPE_QEMU_FIXED_TEXT_CONSOLE)
32 
33 /* keyboard/mouse support */
34 
35 #define MOUSE_EVENT_LBUTTON 0x01
36 #define MOUSE_EVENT_RBUTTON 0x02
37 #define MOUSE_EVENT_MBUTTON 0x04
38 #define MOUSE_EVENT_WHEELUP 0x08
39 #define MOUSE_EVENT_WHEELDN 0x10
40 
41 /* identical to the ps/2 keyboard bits */
42 #define QEMU_SCROLL_LOCK_LED (1 << 0)
43 #define QEMU_NUM_LOCK_LED    (1 << 1)
44 #define QEMU_CAPS_LOCK_LED   (1 << 2)
45 
46 /* in ms */
47 #define GUI_REFRESH_INTERVAL_DEFAULT    30
48 #define GUI_REFRESH_INTERVAL_IDLE     3000
49 
50 /* Color number is match to standard vga palette */
51 enum qemu_color_names {
52     QEMU_COLOR_BLACK   = 0,
53     QEMU_COLOR_BLUE    = 1,
54     QEMU_COLOR_GREEN   = 2,
55     QEMU_COLOR_CYAN    = 3,
56     QEMU_COLOR_RED     = 4,
57     QEMU_COLOR_MAGENTA = 5,
58     QEMU_COLOR_YELLOW  = 6,
59     QEMU_COLOR_WHITE   = 7
60 };
61 /* Convert to curses char attributes */
62 #define ATTR2CHTYPE(c, fg, bg, bold) \
63     ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))
64 
65 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
66 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
67 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
68 
69 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
70 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
71 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
72 
73 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
74                                             void *opaque);
75 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
76                                                 void *opaque, int absolute,
77                                                 const char *name);
78 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
79 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
80 
81 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
82 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
83 
84 void kbd_put_ledstate(int ledstate);
85 
86 bool qemu_mouse_set(int index, Error **errp);
87 
88 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
89    constants) */
90 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
91 #define QEMU_KEY_TAB        0x0009
92 #define QEMU_KEY_BACKSPACE  0x007f
93 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
94 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
95 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
96 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
97 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
98 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
99 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
100 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
101 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
102 
103 #define QEMU_KEY_CTRL_UP         0xe400
104 #define QEMU_KEY_CTRL_DOWN       0xe401
105 #define QEMU_KEY_CTRL_LEFT       0xe402
106 #define QEMU_KEY_CTRL_RIGHT      0xe403
107 #define QEMU_KEY_CTRL_HOME       0xe404
108 #define QEMU_KEY_CTRL_END        0xe405
109 #define QEMU_KEY_CTRL_PAGEUP     0xe406
110 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
111 
112 void qemu_text_console_put_keysym(QemuTextConsole *s, int keysym);
113 bool qemu_text_console_put_qcode(QemuTextConsole *s, int qcode, bool ctrl);
114 void qemu_text_console_put_string(QemuTextConsole *s, const char *str, int len);
115 
116 /* Touch devices */
117 typedef struct touch_slot {
118     int x;
119     int y;
120     int tracking_id;
121 } touch_slot;
122 
123 void console_handle_touch_event(QemuConsole *con,
124                                 struct touch_slot touch_slots[INPUT_EVENT_SLOTS_MAX],
125                                 uint64_t num_slot,
126                                 int width, int height,
127                                 double x, double y,
128                                 InputMultiTouchType type,
129                                 Error **errp);
130 /* consoles */
131 
132 struct QemuConsoleClass {
133     ObjectClass parent_class;
134 };
135 
136 typedef struct ScanoutTexture {
137     uint32_t backing_id;
138     bool backing_y_0_top;
139     uint32_t backing_width;
140     uint32_t backing_height;
141     uint32_t x;
142     uint32_t y;
143     uint32_t width;
144     uint32_t height;
145     void *d3d_tex2d;
146 } ScanoutTexture;
147 
148 typedef struct QemuUIInfo {
149     /* physical dimension */
150     uint16_t width_mm;
151     uint16_t height_mm;
152     /* geometry */
153     int       xoff;
154     int       yoff;
155     uint32_t  width;
156     uint32_t  height;
157     uint32_t  refresh_rate;
158 } QemuUIInfo;
159 
160 /* cursor data format is 32bit RGBA */
161 typedef struct QEMUCursor {
162     uint16_t            width, height;
163     int                 hot_x, hot_y;
164     int                 refcount;
165     uint32_t            data[];
166 } QEMUCursor;
167 
168 QEMUCursor *cursor_alloc(uint16_t width, uint16_t height);
169 QEMUCursor *cursor_ref(QEMUCursor *c);
170 void cursor_unref(QEMUCursor *c);
171 QEMUCursor *cursor_builtin_hidden(void);
172 QEMUCursor *cursor_builtin_left_ptr(void);
173 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
174 int cursor_get_mono_bpl(QEMUCursor *c);
175 void cursor_set_mono(QEMUCursor *c,
176                      uint32_t foreground, uint32_t background, uint8_t *image,
177                      int transparent, uint8_t *mask);
178 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
179 
180 typedef void *QEMUGLContext;
181 typedef struct QEMUGLParams QEMUGLParams;
182 
183 struct QEMUGLParams {
184     int major_ver;
185     int minor_ver;
186 };
187 
188 enum display_scanout {
189     SCANOUT_NONE,
190     SCANOUT_SURFACE,
191     SCANOUT_TEXTURE,
192     SCANOUT_DMABUF,
193 };
194 
195 typedef struct DisplayScanout {
196     enum display_scanout kind;
197     union {
198         /* DisplaySurface *surface; is kept in QemuConsole */
199         ScanoutTexture texture;
200         QemuDmaBuf *dmabuf;
201     };
202 } DisplayScanout;
203 
204 typedef struct DisplayState DisplayState;
205 typedef struct DisplayGLCtx DisplayGLCtx;
206 
207 typedef struct DisplayChangeListenerOps {
208     const char *dpy_name;
209 
210     /* optional */
211     void (*dpy_refresh)(DisplayChangeListener *dcl);
212 
213     /* optional */
214     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
215                            int x, int y, int w, int h);
216     /* optional */
217     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
218                            struct DisplaySurface *new_surface);
219     /* optional */
220     bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
221                                  pixman_format_code_t format);
222 
223     /* optional */
224     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
225                             int x, int y);
226     /* optional */
227     void (*dpy_text_resize)(DisplayChangeListener *dcl,
228                             int w, int h);
229     /* optional */
230     void (*dpy_text_update)(DisplayChangeListener *dcl,
231                             int x, int y, int w, int h);
232 
233     /* optional */
234     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
235                           int x, int y, bool on);
236     /* optional */
237     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
238                               QEMUCursor *cursor);
239 
240     /* required if GL */
241     void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
242     /* required if GL */
243     void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
244                                    uint32_t backing_id,
245                                    bool backing_y_0_top,
246                                    uint32_t backing_width,
247                                    uint32_t backing_height,
248                                    uint32_t x, uint32_t y,
249                                    uint32_t w, uint32_t h,
250                                    void *d3d_tex2d);
251     /* optional (default to true if has dpy_gl_scanout_dmabuf) */
252     bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl);
253     /* optional */
254     void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
255                                   QemuDmaBuf *dmabuf);
256     /* optional */
257     void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
258                                  QemuDmaBuf *dmabuf, bool have_hot,
259                                  uint32_t hot_x, uint32_t hot_y);
260     /* optional */
261     void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
262                                    uint32_t pos_x, uint32_t pos_y);
263     /* optional */
264     void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
265                                   QemuDmaBuf *dmabuf);
266     /* required if GL */
267     void (*dpy_gl_update)(DisplayChangeListener *dcl,
268                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
269 
270 } DisplayChangeListenerOps;
271 
272 struct DisplayChangeListener {
273     uint64_t update_interval;
274     const DisplayChangeListenerOps *ops;
275     DisplayState *ds;
276     QemuConsole *con;
277 
278     QLIST_ENTRY(DisplayChangeListener) next;
279 };
280 
281 typedef struct DisplayGLCtxOps {
282     bool (*dpy_gl_ctx_is_compatible_dcl)(DisplayGLCtx *dgc,
283                                          DisplayChangeListener *dcl);
284     QEMUGLContext (*dpy_gl_ctx_create)(DisplayGLCtx *dgc,
285                                        QEMUGLParams *params);
286     void (*dpy_gl_ctx_destroy)(DisplayGLCtx *dgc,
287                                QEMUGLContext ctx);
288     int (*dpy_gl_ctx_make_current)(DisplayGLCtx *dgc,
289                                    QEMUGLContext ctx);
290     void (*dpy_gl_ctx_create_texture)(DisplayGLCtx *dgc,
291                                       DisplaySurface *surface);
292     void (*dpy_gl_ctx_destroy_texture)(DisplayGLCtx *dgc,
293                                       DisplaySurface *surface);
294     void (*dpy_gl_ctx_update_texture)(DisplayGLCtx *dgc,
295                                       DisplaySurface *surface,
296                                       int x, int y, int w, int h);
297 } DisplayGLCtxOps;
298 
299 struct DisplayGLCtx {
300     const DisplayGLCtxOps *ops;
301 #ifdef CONFIG_OPENGL
302     QemuGLShader *gls; /* optional shared shader */
303 #endif
304 };
305 
306 DisplayState *init_displaystate(void);
307 
308 void register_displaychangelistener(DisplayChangeListener *dcl);
309 void update_displaychangelistener(DisplayChangeListener *dcl,
310                                   uint64_t interval);
311 void unregister_displaychangelistener(DisplayChangeListener *dcl);
312 
313 bool dpy_ui_info_supported(const QemuConsole *con);
314 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con);
315 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info, bool delay);
316 
317 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
318 void dpy_gfx_update_full(QemuConsole *con);
319 void dpy_gfx_replace_surface(QemuConsole *con,
320                              DisplaySurface *surface);
321 void dpy_text_cursor(QemuConsole *con, int x, int y);
322 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
323 void dpy_text_resize(QemuConsole *con, int w, int h);
324 void dpy_mouse_set(QemuConsole *con, int x, int y, bool on);
325 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
326 bool dpy_gfx_check_format(QemuConsole *con,
327                           pixman_format_code_t format);
328 
329 void dpy_gl_scanout_disable(QemuConsole *con);
330 void dpy_gl_scanout_texture(QemuConsole *con,
331                             uint32_t backing_id, bool backing_y_0_top,
332                             uint32_t backing_width, uint32_t backing_height,
333                             uint32_t x, uint32_t y, uint32_t w, uint32_t h,
334                             void *d3d_tex2d);
335 void dpy_gl_scanout_dmabuf(QemuConsole *con,
336                            QemuDmaBuf *dmabuf);
337 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
338                           bool have_hot, uint32_t hot_x, uint32_t hot_y);
339 void dpy_gl_cursor_position(QemuConsole *con,
340                             uint32_t pos_x, uint32_t pos_y);
341 void dpy_gl_release_dmabuf(QemuConsole *con,
342                            QemuDmaBuf *dmabuf);
343 void dpy_gl_update(QemuConsole *con,
344                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
345 
346 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
347                                 QEMUGLParams *params);
348 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
349 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
350 
351 bool console_has_gl(QemuConsole *con);
352 
353 typedef uint32_t console_ch_t;
354 
355 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
356 {
357     *dest = ch;
358 }
359 
360 enum {
361     GRAPHIC_FLAGS_NONE     = 0,
362     /* require a console/display with GL callbacks */
363     GRAPHIC_FLAGS_GL       = 1 << 0,
364     /* require a console/display with DMABUF import */
365     GRAPHIC_FLAGS_DMABUF   = 1 << 1,
366 };
367 
368 typedef struct GraphicHwOps {
369     int (*get_flags)(void *opaque); /* optional, default 0 */
370     void (*invalidate)(void *opaque);
371     void (*gfx_update)(void *opaque);
372     bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
373     void (*text_update)(void *opaque, console_ch_t *text);
374     void (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
375     void (*gl_block)(void *opaque, bool block);
376 } GraphicHwOps;
377 
378 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
379                                   const GraphicHwOps *ops,
380                                   void *opaque);
381 void graphic_console_set_hwops(QemuConsole *con,
382                                const GraphicHwOps *hw_ops,
383                                void *opaque);
384 void graphic_console_close(QemuConsole *con);
385 
386 void graphic_hw_update(QemuConsole *con);
387 void graphic_hw_update_done(QemuConsole *con);
388 void graphic_hw_invalidate(QemuConsole *con);
389 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
390 void graphic_hw_gl_block(QemuConsole *con, bool block);
391 
392 void qemu_console_early_init(void);
393 
394 void qemu_console_set_display_gl_ctx(QemuConsole *con, DisplayGLCtx *ctx);
395 
396 QemuConsole *qemu_console_lookup_default(void);
397 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
398 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
399 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
400                                                 uint32_t head, Error **errp);
401 QEMUCursor *qemu_console_get_cursor(QemuConsole *con);
402 bool qemu_console_is_visible(QemuConsole *con);
403 bool qemu_console_is_graphic(QemuConsole *con);
404 bool qemu_console_is_fixedsize(QemuConsole *con);
405 bool qemu_console_is_gl_blocked(QemuConsole *con);
406 char *qemu_console_get_label(QemuConsole *con);
407 int qemu_console_get_index(QemuConsole *con);
408 uint32_t qemu_console_get_head(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 qemu_console_resize(QemuConsole *con, int width, int height);
417 DisplaySurface *qemu_console_surface(QemuConsole *con);
418 void coroutine_fn qemu_console_co_wait_update(QemuConsole *con);
419 int qemu_invalidate_text_consoles(void);
420 
421 /* console-gl.c */
422 #ifdef CONFIG_OPENGL
423 bool console_gl_check_format(DisplayChangeListener *dcl,
424                              pixman_format_code_t format);
425 void surface_gl_create_texture(QemuGLShader *gls,
426                                DisplaySurface *surface);
427 void surface_gl_update_texture(QemuGLShader *gls,
428                                DisplaySurface *surface,
429                                int x, int y, int w, int h);
430 void surface_gl_render_texture(QemuGLShader *gls,
431                                DisplaySurface *surface);
432 void surface_gl_destroy_texture(QemuGLShader *gls,
433                                DisplaySurface *surface);
434 void surface_gl_setup_viewport(QemuGLShader *gls,
435                                DisplaySurface *surface,
436                                int ww, int wh);
437 #endif
438 
439 typedef struct QemuDisplay QemuDisplay;
440 
441 struct QemuDisplay {
442     DisplayType type;
443     void (*early_init)(DisplayOptions *opts);
444     void (*init)(DisplayState *ds, DisplayOptions *opts);
445     const char *vc;
446 };
447 
448 void qemu_display_register(QemuDisplay *ui);
449 bool qemu_display_find_default(DisplayOptions *opts);
450 void qemu_display_early_init(DisplayOptions *opts);
451 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
452 const char *qemu_display_get_vc(DisplayOptions *opts);
453 void qemu_display_help(void);
454 
455 /* vnc.c */
456 void vnc_display_init(const char *id, Error **errp);
457 void vnc_display_open(const char *id, Error **errp);
458 void vnc_display_add_client(const char *id, int csock, bool skipauth);
459 int vnc_display_password(const char *id, const char *password);
460 int vnc_display_pw_expire(const char *id, time_t expires);
461 void vnc_parse(const char *str);
462 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
463 bool vnc_display_reload_certs(const char *id,  Error **errp);
464 bool vnc_display_update(DisplayUpdateOptionsVNC *arg, Error **errp);
465 
466 /* input.c */
467 int index_from_key(const char *key, size_t key_length);
468 
469 #ifdef CONFIG_LINUX
470 /* udmabuf.c */
471 int udmabuf_fd(void);
472 #endif
473 
474 /* util.c */
475 bool qemu_console_fill_device_address(QemuConsole *con,
476                                       char *device_address,
477                                       size_t size,
478                                       Error **errp);
479 
480 #endif
481