include/ui/console.h

   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 void hmp_mouse_set(Monitor *mon, const QDict *qdict);
  69
  70 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
  71    constants) */
  72 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
  73 #define QEMU_KEY_BACKSPACE  0x007f
  74 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
  75 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
  76 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
  77 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
  78 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
  79 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
  80 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
  81 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
  82 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
  83
  84 #define QEMU_KEY_CTRL_UP         0xe400
  85 #define QEMU_KEY_CTRL_DOWN       0xe401
  86 #define QEMU_KEY_CTRL_LEFT       0xe402
  87 #define QEMU_KEY_CTRL_RIGHT      0xe403
  88 #define QEMU_KEY_CTRL_HOME       0xe404
  89 #define QEMU_KEY_CTRL_END        0xe405
  90 #define QEMU_KEY_CTRL_PAGEUP     0xe406
  91 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
  92
  93 void kbd_put_keysym_console(QemuConsole *s, int keysym);
  94 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
  95 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
  96 void kbd_put_keysym(int keysym);
  97
  98 /* consoles */
  99
 100 #define TYPE_QEMU_CONSOLE "qemu-console"
 101 OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE)
 102
 103
 104 struct QemuConsoleClass {
 105     ObjectClass parent_class;
 106 };
 107
 108 #define QEMU_ALLOCATED_FLAG     0x01
 109 #define QEMU_PLACEHOLDER_FLAG   0x02
 110
 111 typedef struct ScanoutTexture {
 112     uint32_t backing_id;
 113     bool backing_y_0_top;
 114     uint32_t backing_width;
 115     uint32_t backing_height;
 116     uint32_t x;
 117     uint32_t y;
 118     uint32_t width;
 119     uint32_t height;
 120 } ScanoutTexture;
 121
 122 typedef struct DisplaySurface {
 123     pixman_format_code_t format;
 124     pixman_image_t *image;
 125     uint8_t flags;
 126 #ifdef CONFIG_OPENGL
 127     GLenum glformat;
 128     GLenum gltype;
 129     GLuint texture;
 130 #endif
 131 } DisplaySurface;
 132
 133 typedef struct QemuUIInfo {
 134     /* physical dimension */
 135     uint16_t width_mm;
 136     uint16_t height_mm;
 137     /* geometry */
 138     int       xoff;
 139     int       yoff;
 140     uint32_t  width;
 141     uint32_t  height;
 142     uint32_t  refresh_rate;
 143 } QemuUIInfo;
 144
 145 /* cursor data format is 32bit RGBA */
 146 typedef struct QEMUCursor {
 147     int                 width, height;
 148     int                 hot_x, hot_y;
 149     int                 refcount;
 150     uint32_t            data[];
 151 } QEMUCursor;
 152
 153 QEMUCursor *cursor_alloc(int width, int height);
 154 void cursor_get(QEMUCursor *c);
 155 void cursor_put(QEMUCursor *c);
 156 QEMUCursor *cursor_builtin_hidden(void);
 157 QEMUCursor *cursor_builtin_left_ptr(void);
 158 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 159 int cursor_get_mono_bpl(QEMUCursor *c);
 160 void cursor_set_mono(QEMUCursor *c,
 161                      uint32_t foreground, uint32_t background, uint8_t *image,
 162                      int transparent, uint8_t *mask);
 163 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 164 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 165
 166 typedef void *QEMUGLContext;
 167 typedef struct QEMUGLParams QEMUGLParams;
 168
 169 struct QEMUGLParams {
 170     int major_ver;
 171     int minor_ver;
 172 };
 173
 174 typedef struct QemuDmaBuf {
 175     int       fd;
 176     uint32_t  width;
 177     uint32_t  height;
 178     uint32_t  stride;
 179     uint32_t  fourcc;
 180     uint64_t  modifier;
 181     uint32_t  texture;
 182     uint32_t  x;
 183     uint32_t  y;
 184     uint32_t  scanout_width;
 185     uint32_t  scanout_height;
 186     bool      y0_top;
 187     void      *sync;
 188     int       fence_fd;
 189     bool      allow_fences;
 190     bool      draw_submitted;
 191 } QemuDmaBuf;
 192
 193 enum display_scanout {
 194     SCANOUT_NONE,
 195     SCANOUT_SURFACE,
 196     SCANOUT_TEXTURE,
 197     SCANOUT_DMABUF,
 198 };
 199
 200 typedef struct DisplayScanout {
 201     enum display_scanout kind;
 202     union {
 203         /* DisplaySurface *surface; is kept in QemuConsole */
 204         ScanoutTexture texture;
 205         QemuDmaBuf *dmabuf;
 206     };
 207 } DisplayScanout;
 208
 209 typedef struct DisplayState DisplayState;
 210 typedef struct DisplayGLCtx DisplayGLCtx;
 211
 212 typedef struct DisplayChangeListenerOps {
 213     const char *dpy_name;
 214
 215     /* optional */
 216     void (*dpy_refresh)(DisplayChangeListener *dcl);
 217
 218     /* optional */
 219     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
 220                            int x, int y, int w, int h);
 221     /* optional */
 222     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
 223                            struct DisplaySurface *new_surface);
 224     /* optional */
 225     bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
 226                                  pixman_format_code_t format);
 227
 228     /* optional */
 229     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
 230                             int x, int y);
 231     /* optional */
 232     void (*dpy_text_resize)(DisplayChangeListener *dcl,
 233                             int w, int h);
 234     /* optional */
 235     void (*dpy_text_update)(DisplayChangeListener *dcl,
 236                             int x, int y, int w, int h);
 237
 238     /* optional */
 239     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
 240                           int x, int y, int on);
 241     /* optional */
 242     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
 243                               QEMUCursor *cursor);
 244
 245     /* required if GL */
 246     void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
 247     /* required if GL */
 248     void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
 249                                    uint32_t backing_id,
 250                                    bool backing_y_0_top,
 251                                    uint32_t backing_width,
 252                                    uint32_t backing_height,
 253                                    uint32_t x, uint32_t y,
 254                                    uint32_t w, uint32_t h);
 255     /* optional (default to true if has dpy_gl_scanout_dmabuf) */
 256     bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl);
 257     /* optional */
 258     void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
 259                                   QemuDmaBuf *dmabuf);
 260     /* optional */
 261     void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
 262                                  QemuDmaBuf *dmabuf, bool have_hot,
 263                                  uint32_t hot_x, uint32_t hot_y);
 264     /* optional */
 265     void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
 266                                    uint32_t pos_x, uint32_t pos_y);
 267     /* optional */
 268     void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
 269                                   QemuDmaBuf *dmabuf);
 270     /* required if GL */
 271     void (*dpy_gl_update)(DisplayChangeListener *dcl,
 272                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 273
 274 } DisplayChangeListenerOps;
 275
 276 struct DisplayChangeListener {
 277     uint64_t update_interval;
 278     const DisplayChangeListenerOps *ops;
 279     DisplayState *ds;
 280     QemuConsole *con;
 281
 282     QLIST_ENTRY(DisplayChangeListener) next;
 283 };
 284
 285 typedef struct DisplayGLCtxOps {
 286     bool (*dpy_gl_ctx_is_compatible_dcl)(DisplayGLCtx *dgc,
 287                                          DisplayChangeListener *dcl);
 288     QEMUGLContext (*dpy_gl_ctx_create)(DisplayGLCtx *dgc,
 289                                        QEMUGLParams *params);
 290     void (*dpy_gl_ctx_destroy)(DisplayGLCtx *dgc,
 291                                QEMUGLContext ctx);
 292     int (*dpy_gl_ctx_make_current)(DisplayGLCtx *dgc,
 293                                    QEMUGLContext ctx);
 294     void (*dpy_gl_ctx_create_texture)(DisplayGLCtx *dgc,
 295                                       DisplaySurface *surface);
 296     void (*dpy_gl_ctx_destroy_texture)(DisplayGLCtx *dgc,
 297                                       DisplaySurface *surface);
 298     void (*dpy_gl_ctx_update_texture)(DisplayGLCtx *dgc,
 299                                       DisplaySurface *surface,
 300                                       int x, int y, int w, int h);
 301 } DisplayGLCtxOps;
 302
 303 struct DisplayGLCtx {
 304     const DisplayGLCtxOps *ops;
 305 #ifdef CONFIG_OPENGL
 306     QemuGLShader *gls; /* optional shared shader */
 307 #endif
 308 };
 309
 310 DisplayState *init_displaystate(void);
 311 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
 312                                                 pixman_format_code_t format,
 313                                                 int linesize, uint8_t *data);
 314 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
 315 DisplaySurface *qemu_create_placeholder_surface(int w, int h,
 316                                                 const char *msg);
 317 PixelFormat qemu_default_pixelformat(int bpp);
 318
 319 DisplaySurface *qemu_create_displaysurface(int width, int height);
 320 void qemu_free_displaysurface(DisplaySurface *surface);
 321
 322 static inline int is_buffer_shared(DisplaySurface *surface)
 323 {
 324     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 325 }
 326
 327 static inline int is_placeholder(DisplaySurface *surface)
 328 {
 329     return surface->flags & QEMU_PLACEHOLDER_FLAG;
 330 }
 331
 332 void register_displaychangelistener(DisplayChangeListener *dcl);
 333 void update_displaychangelistener(DisplayChangeListener *dcl,
 334                                   uint64_t interval);
 335 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 336
 337 bool dpy_ui_info_supported(QemuConsole *con);
 338 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con);
 339 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info, bool delay);
 340
 341 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 342 void dpy_gfx_update_full(QemuConsole *con);
 343 void dpy_gfx_replace_surface(QemuConsole *con,
 344                              DisplaySurface *surface);
 345 void dpy_text_cursor(QemuConsole *con, int x, int y);
 346 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 347 void dpy_text_resize(QemuConsole *con, int w, int h);
 348 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 349 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 350 bool dpy_cursor_define_supported(QemuConsole *con);
 351 bool dpy_gfx_check_format(QemuConsole *con,
 352                           pixman_format_code_t format);
 353
 354 void dpy_gl_scanout_disable(QemuConsole *con);
 355 void dpy_gl_scanout_texture(QemuConsole *con,
 356                             uint32_t backing_id, bool backing_y_0_top,
 357                             uint32_t backing_width, uint32_t backing_height,
 358                             uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 359 void dpy_gl_scanout_dmabuf(QemuConsole *con,
 360                            QemuDmaBuf *dmabuf);
 361 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
 362                           bool have_hot, uint32_t hot_x, uint32_t hot_y);
 363 void dpy_gl_cursor_position(QemuConsole *con,
 364                             uint32_t pos_x, uint32_t pos_y);
 365 void dpy_gl_release_dmabuf(QemuConsole *con,
 366                            QemuDmaBuf *dmabuf);
 367 void dpy_gl_update(QemuConsole *con,
 368                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 369
 370 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
 371                                 QEMUGLParams *params);
 372 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
 373 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
 374
 375 bool console_has_gl(QemuConsole *con);
 376
 377 static inline int surface_stride(DisplaySurface *s)
 378 {
 379     return pixman_image_get_stride(s->image);
 380 }
 381
 382 static inline void *surface_data(DisplaySurface *s)
 383 {
 384     return pixman_image_get_data(s->image);
 385 }
 386
 387 static inline int surface_width(DisplaySurface *s)
 388 {
 389     return pixman_image_get_width(s->image);
 390 }
 391
 392 static inline int surface_height(DisplaySurface *s)
 393 {
 394     return pixman_image_get_height(s->image);
 395 }
 396
 397 static inline int surface_bits_per_pixel(DisplaySurface *s)
 398 {
 399     int bits = PIXMAN_FORMAT_BPP(s->format);
 400     return bits;
 401 }
 402
 403 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 404 {
 405     int bits = PIXMAN_FORMAT_BPP(s->format);
 406     return DIV_ROUND_UP(bits, 8);
 407 }
 408
 409 static inline pixman_format_code_t surface_format(DisplaySurface *s)
 410 {
 411     return s->format;
 412 }
 413
 414 typedef uint32_t console_ch_t;
 415
 416 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 417 {
 418     *dest = ch;
 419 }
 420
 421 enum {
 422     GRAPHIC_FLAGS_NONE     = 0,
 423     /* require a console/display with GL callbacks */
 424     GRAPHIC_FLAGS_GL       = 1 << 0,
 425     /* require a console/display with DMABUF import */
 426     GRAPHIC_FLAGS_DMABUF   = 1 << 1,
 427 };
 428
 429 typedef struct GraphicHwOps {
 430     int (*get_flags)(void *opaque); /* optional, default 0 */
 431     void (*invalidate)(void *opaque);
 432     void (*gfx_update)(void *opaque);
 433     bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
 434     void (*text_update)(void *opaque, console_ch_t *text);
 435     void (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 436     void (*gl_block)(void *opaque, bool block);
 437 } GraphicHwOps;
 438
 439 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 440                                   const GraphicHwOps *ops,
 441                                   void *opaque);
 442 void graphic_console_set_hwops(QemuConsole *con,
 443                                const GraphicHwOps *hw_ops,
 444                                void *opaque);
 445 void graphic_console_close(QemuConsole *con);
 446
 447 void graphic_hw_update(QemuConsole *con);
 448 void graphic_hw_update_done(QemuConsole *con);
 449 void graphic_hw_invalidate(QemuConsole *con);
 450 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 451 void graphic_hw_gl_block(QemuConsole *con, bool block);
 452
 453 void qemu_console_early_init(void);
 454
 455 void qemu_console_set_display_gl_ctx(QemuConsole *con, DisplayGLCtx *ctx);
 456
 457 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 458 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 459 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
 460                                                 uint32_t head, Error **errp);
 461 QemuConsole *qemu_console_lookup_unused(void);
 462 bool qemu_console_is_visible(QemuConsole *con);
 463 bool qemu_console_is_graphic(QemuConsole *con);
 464 bool qemu_console_is_fixedsize(QemuConsole *con);
 465 bool qemu_console_is_gl_blocked(QemuConsole *con);
 466 bool qemu_console_is_multihead(DeviceState *dev);
 467 char *qemu_console_get_label(QemuConsole *con);
 468 int qemu_console_get_index(QemuConsole *con);
 469 uint32_t qemu_console_get_head(QemuConsole *con);
 470 int qemu_console_get_width(QemuConsole *con, int fallback);
 471 int qemu_console_get_height(QemuConsole *con, int fallback);
 472 /* Return the low-level window id for the console */
 473 int qemu_console_get_window_id(QemuConsole *con);
 474 /* Set the low-level window id for the console */
 475 void qemu_console_set_window_id(QemuConsole *con, int window_id);
 476
 477 void console_select(unsigned int index);
 478 void qemu_console_resize(QemuConsole *con, int width, int height);
 479 DisplaySurface *qemu_console_surface(QemuConsole *con);
 480
 481 /* console-gl.c */
 482 #ifdef CONFIG_OPENGL
 483 bool console_gl_check_format(DisplayChangeListener *dcl,
 484                              pixman_format_code_t format);
 485 void surface_gl_create_texture(QemuGLShader *gls,
 486                                DisplaySurface *surface);
 487 void surface_gl_update_texture(QemuGLShader *gls,
 488                                DisplaySurface *surface,
 489                                int x, int y, int w, int h);
 490 void surface_gl_render_texture(QemuGLShader *gls,
 491                                DisplaySurface *surface);
 492 void surface_gl_destroy_texture(QemuGLShader *gls,
 493                                DisplaySurface *surface);
 494 void surface_gl_setup_viewport(QemuGLShader *gls,
 495                                DisplaySurface *surface,
 496                                int ww, int wh);
 497 #endif
 498
 499 typedef struct QemuDisplay QemuDisplay;
 500
 501 struct QemuDisplay {
 502     DisplayType type;
 503     void (*early_init)(DisplayOptions *opts);
 504     void (*init)(DisplayState *ds, DisplayOptions *opts);
 505 };
 506
 507 void qemu_display_register(QemuDisplay *ui);
 508 bool qemu_display_find_default(DisplayOptions *opts);
 509 void qemu_display_early_init(DisplayOptions *opts);
 510 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
 511 void qemu_display_help(void);
 512
 513 /* vnc.c */
 514 void vnc_display_init(const char *id, Error **errp);
 515 void vnc_display_open(const char *id, Error **errp);
 516 void vnc_display_add_client(const char *id, int csock, bool skipauth);
 517 int vnc_display_password(const char *id, const char *password);
 518 int vnc_display_pw_expire(const char *id, time_t expires);
 519 void vnc_parse(const char *str);
 520 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
 521 bool vnc_display_reload_certs(const char *id,  Error **errp);
 522 bool vnc_display_update(DisplayUpdateOptionsVNC *arg, Error **errp);
 523
 524 /* input.c */
 525 int index_from_key(const char *key, size_t key_length);
 526
 527 #ifdef CONFIG_LINUX
 528 /* udmabuf.c */
 529 int udmabuf_fd(void);
 530 #endif
 531
 532 /* util.c */
 533 bool qemu_console_fill_device_address(QemuConsole *con,
 534                                       char *device_address,
 535                                       size_t size,
 536                                       Error **errp);
 537
 538 #endif