1 #ifndef CONSOLE_H 2 #define CONSOLE_H 3 4 #include "ui/qemu-pixman.h" 5 #include "qom/object.h" 6 #include "qapi/qmp/qdict.h" 7 #include "qemu/notify.h" 8 #include "qemu/typedefs.h" 9 #include "qapi-types.h" 10 #include "qemu/error-report.h" 11 #include "qapi/error.h" 12 13 #ifdef CONFIG_OPENGL 14 # include <epoxy/gl.h> 15 #endif 16 17 /* keyboard/mouse support */ 18 19 #define MOUSE_EVENT_LBUTTON 0x01 20 #define MOUSE_EVENT_RBUTTON 0x02 21 #define MOUSE_EVENT_MBUTTON 0x04 22 #define MOUSE_EVENT_WHEELUP 0x08 23 #define MOUSE_EVENT_WHEELDN 0x10 24 25 /* identical to the ps/2 keyboard bits */ 26 #define QEMU_SCROLL_LOCK_LED (1 << 0) 27 #define QEMU_NUM_LOCK_LED (1 << 1) 28 #define QEMU_CAPS_LOCK_LED (1 << 2) 29 30 /* in ms */ 31 #define GUI_REFRESH_INTERVAL_DEFAULT 30 32 #define GUI_REFRESH_INTERVAL_IDLE 3000 33 34 /* Color number is match to standard vga palette */ 35 enum qemu_color_names { 36 QEMU_COLOR_BLACK = 0, 37 QEMU_COLOR_BLUE = 1, 38 QEMU_COLOR_GREEN = 2, 39 QEMU_COLOR_CYAN = 3, 40 QEMU_COLOR_RED = 4, 41 QEMU_COLOR_MAGENTA = 5, 42 QEMU_COLOR_YELLOW = 6, 43 QEMU_COLOR_WHITE = 7 44 }; 45 /* Convert to curses char attributes */ 46 #define ATTR2CHTYPE(c, fg, bg, bold) \ 47 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c)) 48 49 typedef void QEMUPutKBDEvent(void *opaque, int keycode); 50 typedef void QEMUPutLEDEvent(void *opaque, int ledstate); 51 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state); 52 53 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry; 54 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry; 55 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry; 56 57 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, 58 void *opaque); 59 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func, 60 void *opaque, int absolute, 61 const char *name); 62 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry); 63 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry); 64 65 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque); 66 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry); 67 68 void kbd_put_ledstate(int ledstate); 69 70 struct MouseTransformInfo { 71 /* Touchscreen resolution */ 72 int x; 73 int y; 74 /* Calibration values as used/generated by tslib */ 75 int a[7]; 76 }; 77 78 void hmp_mouse_set(Monitor *mon, const QDict *qdict); 79 80 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx 81 constants) */ 82 #define QEMU_KEY_ESC1(c) ((c) | 0xe100) 83 #define QEMU_KEY_BACKSPACE 0x007f 84 #define QEMU_KEY_UP QEMU_KEY_ESC1('A') 85 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B') 86 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C') 87 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D') 88 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1) 89 #define QEMU_KEY_END QEMU_KEY_ESC1(4) 90 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5) 91 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6) 92 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3) 93 94 #define QEMU_KEY_CTRL_UP 0xe400 95 #define QEMU_KEY_CTRL_DOWN 0xe401 96 #define QEMU_KEY_CTRL_LEFT 0xe402 97 #define QEMU_KEY_CTRL_RIGHT 0xe403 98 #define QEMU_KEY_CTRL_HOME 0xe404 99 #define QEMU_KEY_CTRL_END 0xe405 100 #define QEMU_KEY_CTRL_PAGEUP 0xe406 101 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407 102 103 void kbd_put_keysym_console(QemuConsole *s, int keysym); 104 bool kbd_put_qcode_console(QemuConsole *s, int qcode); 105 void kbd_put_string_console(QemuConsole *s, const char *str, int len); 106 void kbd_put_keysym(int keysym); 107 108 /* consoles */ 109 110 #define TYPE_QEMU_CONSOLE "qemu-console" 111 #define QEMU_CONSOLE(obj) \ 112 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE) 113 #define QEMU_CONSOLE_GET_CLASS(obj) \ 114 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE) 115 #define QEMU_CONSOLE_CLASS(klass) \ 116 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE) 117 118 typedef struct QemuConsoleClass QemuConsoleClass; 119 120 struct QemuConsoleClass { 121 ObjectClass parent_class; 122 }; 123 124 #define QEMU_ALLOCATED_FLAG 0x01 125 126 struct PixelFormat { 127 uint8_t bits_per_pixel; 128 uint8_t bytes_per_pixel; 129 uint8_t depth; /* color depth in bits */ 130 uint32_t rmask, gmask, bmask, amask; 131 uint8_t rshift, gshift, bshift, ashift; 132 uint8_t rmax, gmax, bmax, amax; 133 uint8_t rbits, gbits, bbits, abits; 134 }; 135 136 struct DisplaySurface { 137 pixman_format_code_t format; 138 pixman_image_t *image; 139 uint8_t flags; 140 #ifdef CONFIG_OPENGL 141 GLenum glformat; 142 GLenum gltype; 143 GLuint texture; 144 #endif 145 }; 146 147 typedef struct QemuUIInfo { 148 /* geometry */ 149 int xoff; 150 int yoff; 151 uint32_t width; 152 uint32_t height; 153 } QemuUIInfo; 154 155 /* cursor data format is 32bit RGBA */ 156 typedef struct QEMUCursor { 157 int width, height; 158 int hot_x, hot_y; 159 int refcount; 160 uint32_t data[]; 161 } QEMUCursor; 162 163 QEMUCursor *cursor_alloc(int width, int height); 164 void cursor_get(QEMUCursor *c); 165 void cursor_put(QEMUCursor *c); 166 QEMUCursor *cursor_builtin_hidden(void); 167 QEMUCursor *cursor_builtin_left_ptr(void); 168 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 169 int cursor_get_mono_bpl(QEMUCursor *c); 170 void cursor_set_mono(QEMUCursor *c, 171 uint32_t foreground, uint32_t background, uint8_t *image, 172 int transparent, uint8_t *mask); 173 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 174 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 175 176 typedef void *QEMUGLContext; 177 typedef struct QEMUGLParams QEMUGLParams; 178 179 struct QEMUGLParams { 180 int major_ver; 181 int minor_ver; 182 }; 183 184 struct QemuDmaBuf { 185 int fd; 186 uint32_t width; 187 uint32_t height; 188 uint32_t stride; 189 uint32_t fourcc; 190 uint32_t texture; 191 }; 192 193 typedef struct DisplayChangeListenerOps { 194 const char *dpy_name; 195 196 void (*dpy_refresh)(DisplayChangeListener *dcl); 197 198 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 199 int x, int y, int w, int h); 200 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 201 struct DisplaySurface *new_surface); 202 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 203 pixman_format_code_t format); 204 205 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 206 int x, int y); 207 void (*dpy_text_resize)(DisplayChangeListener *dcl, 208 int w, int h); 209 void (*dpy_text_update)(DisplayChangeListener *dcl, 210 int x, int y, int w, int h); 211 212 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 213 int x, int y, int on); 214 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 215 QEMUCursor *cursor); 216 217 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl, 218 QEMUGLParams *params); 219 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl, 220 QEMUGLContext ctx); 221 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl, 222 QEMUGLContext ctx); 223 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl); 224 225 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 226 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, 227 uint32_t backing_id, 228 bool backing_y_0_top, 229 uint32_t backing_width, 230 uint32_t backing_height, 231 uint32_t x, uint32_t y, 232 uint32_t w, uint32_t h); 233 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 234 QemuDmaBuf *dmabuf); 235 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 236 QemuDmaBuf *dmabuf, 237 uint32_t pos_x, uint32_t pos_y); 238 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 239 QemuDmaBuf *dmabuf); 240 void (*dpy_gl_update)(DisplayChangeListener *dcl, 241 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 242 243 } DisplayChangeListenerOps; 244 245 struct DisplayChangeListener { 246 uint64_t update_interval; 247 const DisplayChangeListenerOps *ops; 248 DisplayState *ds; 249 QemuConsole *con; 250 251 QLIST_ENTRY(DisplayChangeListener) next; 252 }; 253 254 DisplayState *init_displaystate(void); 255 DisplaySurface *qemu_create_displaysurface_from(int width, int height, 256 pixman_format_code_t format, 257 int linesize, uint8_t *data); 258 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); 259 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height, 260 pixman_format_code_t format, 261 int linesize, 262 uint64_t addr); 263 PixelFormat qemu_default_pixelformat(int bpp); 264 265 DisplaySurface *qemu_create_displaysurface(int width, int height); 266 void qemu_free_displaysurface(DisplaySurface *surface); 267 268 static inline int is_surface_bgr(DisplaySurface *surface) 269 { 270 if (PIXMAN_FORMAT_BPP(surface->format) == 32 && 271 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) { 272 return 1; 273 } else { 274 return 0; 275 } 276 } 277 278 static inline int is_buffer_shared(DisplaySurface *surface) 279 { 280 return !(surface->flags & QEMU_ALLOCATED_FLAG); 281 } 282 283 void register_displaychangelistener(DisplayChangeListener *dcl); 284 void update_displaychangelistener(DisplayChangeListener *dcl, 285 uint64_t interval); 286 void unregister_displaychangelistener(DisplayChangeListener *dcl); 287 288 bool dpy_ui_info_supported(QemuConsole *con); 289 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info); 290 291 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); 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, 311 QemuDmaBuf *dmabuf, 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 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con); 323 324 bool console_has_gl(QemuConsole *con); 325 bool console_has_gl_dmabuf(QemuConsole *con); 326 327 static inline int surface_stride(DisplaySurface *s) 328 { 329 return pixman_image_get_stride(s->image); 330 } 331 332 static inline void *surface_data(DisplaySurface *s) 333 { 334 return pixman_image_get_data(s->image); 335 } 336 337 static inline int surface_width(DisplaySurface *s) 338 { 339 return pixman_image_get_width(s->image); 340 } 341 342 static inline int surface_height(DisplaySurface *s) 343 { 344 return pixman_image_get_height(s->image); 345 } 346 347 static inline int surface_bits_per_pixel(DisplaySurface *s) 348 { 349 int bits = PIXMAN_FORMAT_BPP(s->format); 350 return bits; 351 } 352 353 static inline int surface_bytes_per_pixel(DisplaySurface *s) 354 { 355 int bits = PIXMAN_FORMAT_BPP(s->format); 356 return DIV_ROUND_UP(bits, 8); 357 } 358 359 static inline pixman_format_code_t surface_format(DisplaySurface *s) 360 { 361 return s->format; 362 } 363 364 typedef uint32_t console_ch_t; 365 366 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 367 { 368 *dest = ch; 369 } 370 371 typedef struct GraphicHwOps { 372 void (*invalidate)(void *opaque); 373 void (*gfx_update)(void *opaque); 374 void (*text_update)(void *opaque, console_ch_t *text); 375 void (*update_interval)(void *opaque, uint64_t interval); 376 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info); 377 void (*gl_block)(void *opaque, bool block); 378 } GraphicHwOps; 379 380 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head, 381 const GraphicHwOps *ops, 382 void *opaque); 383 void graphic_console_set_hwops(QemuConsole *con, 384 const GraphicHwOps *hw_ops, 385 void *opaque); 386 387 void graphic_hw_update(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 QemuConsole *qemu_console_lookup_by_index(unsigned int index); 395 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); 396 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, 397 uint32_t head, Error **errp); 398 bool qemu_console_is_visible(QemuConsole *con); 399 bool qemu_console_is_graphic(QemuConsole *con); 400 bool qemu_console_is_fixedsize(QemuConsole *con); 401 bool qemu_console_is_gl_blocked(QemuConsole *con); 402 char *qemu_console_get_label(QemuConsole *con); 403 int qemu_console_get_index(QemuConsole *con); 404 uint32_t qemu_console_get_head(QemuConsole *con); 405 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con); 406 int qemu_console_get_width(QemuConsole *con, int fallback); 407 int qemu_console_get_height(QemuConsole *con, int fallback); 408 /* Return the low-level window id for the console */ 409 int qemu_console_get_window_id(QemuConsole *con); 410 /* Set the low-level window id for the console */ 411 void qemu_console_set_window_id(QemuConsole *con, int window_id); 412 413 void console_select(unsigned int index); 414 void qemu_console_resize(QemuConsole *con, int width, int height); 415 DisplaySurface *qemu_console_surface(QemuConsole *con); 416 417 /* console-gl.c */ 418 typedef struct ConsoleGLState ConsoleGLState; 419 #ifdef CONFIG_OPENGL 420 ConsoleGLState *console_gl_init_context(void); 421 void console_gl_fini_context(ConsoleGLState *gls); 422 bool console_gl_check_format(DisplayChangeListener *dcl, 423 pixman_format_code_t format); 424 void surface_gl_create_texture(ConsoleGLState *gls, 425 DisplaySurface *surface); 426 void surface_gl_update_texture(ConsoleGLState *gls, 427 DisplaySurface *surface, 428 int x, int y, int w, int h); 429 void surface_gl_render_texture(ConsoleGLState *gls, 430 DisplaySurface *surface); 431 void surface_gl_destroy_texture(ConsoleGLState *gls, 432 DisplaySurface *surface); 433 void surface_gl_setup_viewport(ConsoleGLState *gls, 434 DisplaySurface *surface, 435 int ww, int wh); 436 #endif 437 438 /* sdl.c */ 439 #ifdef CONFIG_SDL 440 void sdl_display_early_init(int opengl); 441 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame); 442 #else 443 static inline void sdl_display_early_init(int opengl) 444 { 445 /* This must never be called if CONFIG_SDL is disabled */ 446 error_report("SDL support is disabled"); 447 abort(); 448 } 449 static inline void sdl_display_init(DisplayState *ds, int full_screen, 450 int no_frame) 451 { 452 /* This must never be called if CONFIG_SDL is disabled */ 453 error_report("SDL support is disabled"); 454 abort(); 455 } 456 #endif 457 458 /* cocoa.m */ 459 #ifdef CONFIG_COCOA 460 void cocoa_display_init(DisplayState *ds, int full_screen); 461 #else 462 static inline void cocoa_display_init(DisplayState *ds, int full_screen) 463 { 464 /* This must never be called if CONFIG_COCOA is disabled */ 465 error_report("Cocoa support is disabled"); 466 abort(); 467 } 468 #endif 469 470 /* vnc.c */ 471 void vnc_display_init(const char *id); 472 void vnc_display_open(const char *id, Error **errp); 473 void vnc_display_add_client(const char *id, int csock, bool skipauth); 474 #ifdef CONFIG_VNC 475 int vnc_display_password(const char *id, const char *password); 476 int vnc_display_pw_expire(const char *id, time_t expires); 477 QemuOpts *vnc_parse(const char *str, Error **errp); 478 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 479 #else 480 static inline int vnc_display_password(const char *id, const char *password) 481 { 482 return -ENODEV; 483 } 484 static inline int vnc_display_pw_expire(const char *id, time_t expires) 485 { 486 return -ENODEV; 487 }; 488 static inline QemuOpts *vnc_parse(const char *str, Error **errp) 489 { 490 error_setg(errp, "VNC support is disabled"); 491 return NULL; 492 } 493 static inline int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp) 494 { 495 error_setg(errp, "VNC support is disabled"); 496 return -1; 497 } 498 #endif 499 500 /* curses.c */ 501 #ifdef CONFIG_CURSES 502 void curses_display_init(DisplayState *ds, int full_screen); 503 #else 504 static inline void curses_display_init(DisplayState *ds, int full_screen) 505 { 506 /* This must never be called if CONFIG_CURSES is disabled */ 507 error_report("curses support is disabled"); 508 abort(); 509 } 510 #endif 511 512 /* input.c */ 513 int index_from_key(const char *key, size_t key_length); 514 515 /* gtk.c */ 516 #ifdef CONFIG_GTK 517 void early_gtk_display_init(int opengl); 518 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover); 519 #else 520 static inline void gtk_display_init(DisplayState *ds, bool full_screen, 521 bool grab_on_hover) 522 { 523 /* This must never be called if CONFIG_GTK is disabled */ 524 error_report("GTK support is disabled"); 525 abort(); 526 } 527 528 static inline void early_gtk_display_init(int opengl) 529 { 530 /* This must never be called if CONFIG_GTK is disabled */ 531 error_report("GTK support is disabled"); 532 abort(); 533 } 534 #endif 535 536 /* egl-headless.c */ 537 void egl_headless_init(void); 538 539 #endif 540