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