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 DisplaySurface {
 112     pixman_format_code_t format;
 113     pixman_image_t *image;
 114     uint8_t flags;
 115 #ifdef CONFIG_OPENGL
 116     GLenum glformat;
 117     GLenum gltype;
 118     GLuint texture;
 119 #endif
 120 } DisplaySurface;
 121
 122 typedef struct QemuUIInfo {
 123     /* physical dimension */
 124     uint16_t width_mm;
 125     uint16_t height_mm;
 126     /* geometry */
 127     int       xoff;
 128     int       yoff;
 129     uint32_t  width;
 130     uint32_t  height;
 131 } QemuUIInfo;
 132
 133 /* cursor data format is 32bit RGBA */
 134 typedef struct QEMUCursor {
 135     int                 width, height;
 136     int                 hot_x, hot_y;
 137     int                 refcount;
 138     uint32_t            data[];
 139 } QEMUCursor;
 140
 141 QEMUCursor *cursor_alloc(int width, int height);
 142 void cursor_get(QEMUCursor *c);
 143 void cursor_put(QEMUCursor *c);
 144 QEMUCursor *cursor_builtin_hidden(void);
 145 QEMUCursor *cursor_builtin_left_ptr(void);
 146 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 147 int cursor_get_mono_bpl(QEMUCursor *c);
 148 void cursor_set_mono(QEMUCursor *c,
 149                      uint32_t foreground, uint32_t background, uint8_t *image,
 150                      int transparent, uint8_t *mask);
 151 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 152 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 153
 154 typedef void *QEMUGLContext;
 155 typedef struct QEMUGLParams QEMUGLParams;
 156
 157 struct QEMUGLParams {
 158     int major_ver;
 159     int minor_ver;
 160 };
 161
 162 typedef struct QemuDmaBuf {
 163     int       fd;
 164     uint32_t  width;
 165     uint32_t  height;
 166     uint32_t  stride;
 167     uint32_t  fourcc;
 168     uint64_t  modifier;
 169     uint32_t  texture;
 170     bool      y0_top;
 171 } QemuDmaBuf;
 172
 173 typedef struct DisplayState DisplayState;
 174
 175 typedef struct DisplayChangeListenerOps {
 176     const char *dpy_name;
 177
 178     /* optional */
 179     void (*dpy_refresh)(DisplayChangeListener *dcl);
 180
 181     /* optional */
 182     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
 183                            int x, int y, int w, int h);
 184     /* optional */
 185     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
 186                            struct DisplaySurface *new_surface);
 187     /* optional */
 188     bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
 189                                  pixman_format_code_t format);
 190
 191     /* optional */
 192     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
 193                             int x, int y);
 194     /* optional */
 195     void (*dpy_text_resize)(DisplayChangeListener *dcl,
 196                             int w, int h);
 197     /* optional */
 198     void (*dpy_text_update)(DisplayChangeListener *dcl,
 199                             int x, int y, int w, int h);
 200
 201     /* optional */
 202     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
 203                           int x, int y, int on);
 204     /* optional */
 205     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
 206                               QEMUCursor *cursor);
 207
 208     /* required if GL */
 209     QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
 210                                        QEMUGLParams *params);
 211     /* required if GL */
 212     void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
 213                                QEMUGLContext ctx);
 214     /* required if GL */
 215     int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
 216                                    QEMUGLContext ctx);
 217
 218     /* required if GL */
 219     void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
 220     /* required if GL */
 221     void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
 222                                    uint32_t backing_id,
 223                                    bool backing_y_0_top,
 224                                    uint32_t backing_width,
 225                                    uint32_t backing_height,
 226                                    uint32_t x, uint32_t y,
 227                                    uint32_t w, uint32_t h);
 228     /* optional (default to true if has dpy_gl_scanout_dmabuf) */
 229     bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl);
 230     /* optional */
 231     void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
 232                                   QemuDmaBuf *dmabuf);
 233     /* optional */
 234     void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
 235                                  QemuDmaBuf *dmabuf, bool have_hot,
 236                                  uint32_t hot_x, uint32_t hot_y);
 237     /* optional */
 238     void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
 239                                    uint32_t pos_x, uint32_t pos_y);
 240     /* optional */
 241     void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
 242                                   QemuDmaBuf *dmabuf);
 243     /* required if GL */
 244     void (*dpy_gl_update)(DisplayChangeListener *dcl,
 245                           uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 246
 247 } DisplayChangeListenerOps;
 248
 249 struct DisplayChangeListener {
 250     uint64_t update_interval;
 251     const DisplayChangeListenerOps *ops;
 252     DisplayState *ds;
 253     QemuConsole *con;
 254
 255     QLIST_ENTRY(DisplayChangeListener) next;
 256 };
 257
 258 DisplayState *init_displaystate(void);
 259 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
 260                                                 pixman_format_code_t format,
 261                                                 int linesize, uint8_t *data);
 262 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
 263 DisplaySurface *qemu_create_placeholder_surface(int w, int h,
 264                                                 const char *msg);
 265 PixelFormat qemu_default_pixelformat(int bpp);
 266
 267 DisplaySurface *qemu_create_displaysurface(int width, int height);
 268 void qemu_free_displaysurface(DisplaySurface *surface);
 269
 270 static inline int is_buffer_shared(DisplaySurface *surface)
 271 {
 272     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 273 }
 274
 275 static inline int is_placeholder(DisplaySurface *surface)
 276 {
 277     return surface->flags & QEMU_PLACEHOLDER_FLAG;
 278 }
 279
 280 void register_displaychangelistener(DisplayChangeListener *dcl);
 281 void update_displaychangelistener(DisplayChangeListener *dcl,
 282                                   uint64_t interval);
 283 void unregister_displaychangelistener(DisplayChangeListener *dcl);
 284
 285 bool dpy_ui_info_supported(QemuConsole *con);
 286 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con);
 287 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
 288
 289 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
 290 void dpy_gfx_update_full(QemuConsole *con);
 291 void dpy_gfx_replace_surface(QemuConsole *con,
 292                              DisplaySurface *surface);
 293 void dpy_text_cursor(QemuConsole *con, int x, int y);
 294 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
 295 void dpy_text_resize(QemuConsole *con, int w, int h);
 296 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
 297 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
 298 bool dpy_cursor_define_supported(QemuConsole *con);
 299 bool dpy_gfx_check_format(QemuConsole *con,
 300                           pixman_format_code_t format);
 301
 302 void dpy_gl_scanout_disable(QemuConsole *con);
 303 void dpy_gl_scanout_texture(QemuConsole *con,
 304                             uint32_t backing_id, bool backing_y_0_top,
 305                             uint32_t backing_width, uint32_t backing_height,
 306                             uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 307 void dpy_gl_scanout_dmabuf(QemuConsole *con,
 308                            QemuDmaBuf *dmabuf);
 309 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
 310                           bool have_hot, uint32_t hot_x, uint32_t hot_y);
 311 void dpy_gl_cursor_position(QemuConsole *con,
 312                             uint32_t pos_x, uint32_t pos_y);
 313 void dpy_gl_release_dmabuf(QemuConsole *con,
 314                            QemuDmaBuf *dmabuf);
 315 void dpy_gl_update(QemuConsole *con,
 316                    uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 317
 318 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
 319                                 QEMUGLParams *params);
 320 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
 321 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
 322
 323 bool console_has_gl(QemuConsole *con);
 324
 325 static inline int surface_stride(DisplaySurface *s)
 326 {
 327     return pixman_image_get_stride(s->image);
 328 }
 329
 330 static inline void *surface_data(DisplaySurface *s)
 331 {
 332     return pixman_image_get_data(s->image);
 333 }
 334
 335 static inline int surface_width(DisplaySurface *s)
 336 {
 337     return pixman_image_get_width(s->image);
 338 }
 339
 340 static inline int surface_height(DisplaySurface *s)
 341 {
 342     return pixman_image_get_height(s->image);
 343 }
 344
 345 static inline int surface_bits_per_pixel(DisplaySurface *s)
 346 {
 347     int bits = PIXMAN_FORMAT_BPP(s->format);
 348     return bits;
 349 }
 350
 351 static inline int surface_bytes_per_pixel(DisplaySurface *s)
 352 {
 353     int bits = PIXMAN_FORMAT_BPP(s->format);
 354     return DIV_ROUND_UP(bits, 8);
 355 }
 356
 357 static inline pixman_format_code_t surface_format(DisplaySurface *s)
 358 {
 359     return s->format;
 360 }
 361
 362 typedef uint32_t console_ch_t;
 363
 364 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 365 {
 366     *dest = ch;
 367 }
 368
 369 enum {
 370     GRAPHIC_FLAGS_NONE     = 0,
 371     /* require a console/display with GL callbacks */
 372     GRAPHIC_FLAGS_GL       = 1 << 0,
 373     /* require a console/display with DMABUF import */
 374     GRAPHIC_FLAGS_DMABUF   = 1 << 1,
 375 };
 376
 377 typedef struct GraphicHwOps {
 378     int (*get_flags)(void *opaque); /* optional, default 0 */
 379     void (*invalidate)(void *opaque);
 380     void (*gfx_update)(void *opaque);
 381     bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
 382     void (*text_update)(void *opaque, console_ch_t *text);
 383     void (*update_interval)(void *opaque, uint64_t interval);
 384     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
 385     void (*gl_block)(void *opaque, bool block);
 386     void (*gl_flushed)(void *opaque);
 387 } GraphicHwOps;
 388
 389 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
 390                                   const GraphicHwOps *ops,
 391                                   void *opaque);
 392 void graphic_console_set_hwops(QemuConsole *con,
 393                                const GraphicHwOps *hw_ops,
 394                                void *opaque);
 395 void graphic_console_close(QemuConsole *con);
 396
 397 void graphic_hw_update(QemuConsole *con);
 398 void graphic_hw_update_done(QemuConsole *con);
 399 void graphic_hw_invalidate(QemuConsole *con);
 400 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
 401 void graphic_hw_gl_block(QemuConsole *con, bool block);
 402 void graphic_hw_gl_flushed(QemuConsole *con);
 403
 404 void qemu_console_early_init(void);
 405
 406 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
 407 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
 408 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
 409                                                 uint32_t head, Error **errp);
 410 QemuConsole *qemu_console_lookup_unused(void);
 411 bool qemu_console_is_visible(QemuConsole *con);
 412 bool qemu_console_is_graphic(QemuConsole *con);
 413 bool qemu_console_is_fixedsize(QemuConsole *con);
 414 bool qemu_console_is_gl_blocked(QemuConsole *con);
 415 char *qemu_console_get_label(QemuConsole *con);
 416 int qemu_console_get_index(QemuConsole *con);
 417 uint32_t qemu_console_get_head(QemuConsole *con);
 418 int qemu_console_get_width(QemuConsole *con, int fallback);
 419 int qemu_console_get_height(QemuConsole *con, int fallback);
 420 /* Return the low-level window id for the console */
 421 int qemu_console_get_window_id(QemuConsole *con);
 422 /* Set the low-level window id for the console */
 423 void qemu_console_set_window_id(QemuConsole *con, int window_id);
 424
 425 void console_select(unsigned int index);
 426 void qemu_console_resize(QemuConsole *con, int width, int height);
 427 DisplaySurface *qemu_console_surface(QemuConsole *con);
 428
 429 /* console-gl.c */
 430 #ifdef CONFIG_OPENGL
 431 bool console_gl_check_format(DisplayChangeListener *dcl,
 432                              pixman_format_code_t format);
 433 void surface_gl_create_texture(QemuGLShader *gls,
 434                                DisplaySurface *surface);
 435 void surface_gl_update_texture(QemuGLShader *gls,
 436                                DisplaySurface *surface,
 437                                int x, int y, int w, int h);
 438 void surface_gl_render_texture(QemuGLShader *gls,
 439                                DisplaySurface *surface);
 440 void surface_gl_destroy_texture(QemuGLShader *gls,
 441                                DisplaySurface *surface);
 442 void surface_gl_setup_viewport(QemuGLShader *gls,
 443                                DisplaySurface *surface,
 444                                int ww, int wh);
 445 #endif
 446
 447 typedef struct QemuDisplay QemuDisplay;
 448
 449 struct QemuDisplay {
 450     DisplayType type;
 451     void (*early_init)(DisplayOptions *opts);
 452     void (*init)(DisplayState *ds, DisplayOptions *opts);
 453 };
 454
 455 void qemu_display_register(QemuDisplay *ui);
 456 bool qemu_display_find_default(DisplayOptions *opts);
 457 void qemu_display_early_init(DisplayOptions *opts);
 458 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
 459 void qemu_display_help(void);
 460
 461 /* vnc.c */
 462 void vnc_display_init(const char *id, Error **errp);
 463 void vnc_display_open(const char *id, Error **errp);
 464 void vnc_display_add_client(const char *id, int csock, bool skipauth);
 465 int vnc_display_password(const char *id, const char *password);
 466 int vnc_display_pw_expire(const char *id, time_t expires);
 467 void vnc_parse(const char *str);
 468 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);
 469 bool vnc_display_reload_certs(const char *id,  Error **errp);
 470
 471 /* input.c */
 472 int index_from_key(const char *key, size_t key_length);
 473
 474 #endif