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