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 } QemuUIInfo; 143 144 /* cursor data format is 32bit RGBA */ 145 typedef struct QEMUCursor { 146 int width, height; 147 int hot_x, hot_y; 148 int refcount; 149 uint32_t data[]; 150 } QEMUCursor; 151 152 QEMUCursor *cursor_alloc(int width, int height); 153 void cursor_get(QEMUCursor *c); 154 void cursor_put(QEMUCursor *c); 155 QEMUCursor *cursor_builtin_hidden(void); 156 QEMUCursor *cursor_builtin_left_ptr(void); 157 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 158 int cursor_get_mono_bpl(QEMUCursor *c); 159 void cursor_set_mono(QEMUCursor *c, 160 uint32_t foreground, uint32_t background, uint8_t *image, 161 int transparent, uint8_t *mask); 162 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 163 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 164 165 typedef void *QEMUGLContext; 166 typedef struct QEMUGLParams QEMUGLParams; 167 168 struct QEMUGLParams { 169 int major_ver; 170 int minor_ver; 171 }; 172 173 typedef struct QemuDmaBuf { 174 int fd; 175 uint32_t width; 176 uint32_t height; 177 uint32_t stride; 178 uint32_t fourcc; 179 uint64_t modifier; 180 uint32_t texture; 181 uint32_t x; 182 uint32_t y; 183 uint32_t scanout_width; 184 uint32_t scanout_height; 185 bool y0_top; 186 void *sync; 187 int fence_fd; 188 bool allow_fences; 189 bool draw_submitted; 190 } QemuDmaBuf; 191 192 enum display_scanout { 193 SCANOUT_NONE, 194 SCANOUT_SURFACE, 195 SCANOUT_TEXTURE, 196 SCANOUT_DMABUF, 197 }; 198 199 typedef struct DisplayScanout { 200 enum display_scanout kind; 201 union { 202 /* DisplaySurface *surface; is kept in QemuConsole */ 203 ScanoutTexture texture; 204 QemuDmaBuf *dmabuf; 205 }; 206 } DisplayScanout; 207 208 typedef struct DisplayState DisplayState; 209 typedef struct DisplayGLCtx DisplayGLCtx; 210 211 typedef struct DisplayChangeListenerOps { 212 const char *dpy_name; 213 214 /* optional */ 215 void (*dpy_refresh)(DisplayChangeListener *dcl); 216 217 /* optional */ 218 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 219 int x, int y, int w, int h); 220 /* optional */ 221 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 222 struct DisplaySurface *new_surface); 223 /* optional */ 224 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 225 pixman_format_code_t format); 226 227 /* optional */ 228 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 229 int x, int y); 230 /* optional */ 231 void (*dpy_text_resize)(DisplayChangeListener *dcl, 232 int w, int h); 233 /* optional */ 234 void (*dpy_text_update)(DisplayChangeListener *dcl, 235 int x, int y, int w, int h); 236 237 /* optional */ 238 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 239 int x, int y, int on); 240 /* optional */ 241 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 242 QEMUCursor *cursor); 243 244 /* required if GL */ 245 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 246 /* required if GL */ 247 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, 248 uint32_t backing_id, 249 bool backing_y_0_top, 250 uint32_t backing_width, 251 uint32_t backing_height, 252 uint32_t x, uint32_t y, 253 uint32_t w, uint32_t h); 254 /* optional (default to true if has dpy_gl_scanout_dmabuf) */ 255 bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl); 256 /* optional */ 257 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 258 QemuDmaBuf *dmabuf); 259 /* optional */ 260 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 261 QemuDmaBuf *dmabuf, bool have_hot, 262 uint32_t hot_x, uint32_t hot_y); 263 /* optional */ 264 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, 265 uint32_t pos_x, uint32_t pos_y); 266 /* optional */ 267 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 268 QemuDmaBuf *dmabuf); 269 /* required if GL */ 270 void (*dpy_gl_update)(DisplayChangeListener *dcl, 271 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 272 273 } DisplayChangeListenerOps; 274 275 struct DisplayChangeListener { 276 uint64_t update_interval; 277 const DisplayChangeListenerOps *ops; 278 DisplayState *ds; 279 QemuConsole *con; 280 281 QLIST_ENTRY(DisplayChangeListener) next; 282 }; 283 284 typedef struct DisplayGLCtxOps { 285 bool (*dpy_gl_ctx_is_compatible_dcl)(DisplayGLCtx *dgc, 286 DisplayChangeListener *dcl); 287 QEMUGLContext (*dpy_gl_ctx_create)(DisplayGLCtx *dgc, 288 QEMUGLParams *params); 289 void (*dpy_gl_ctx_destroy)(DisplayGLCtx *dgc, 290 QEMUGLContext ctx); 291 int (*dpy_gl_ctx_make_current)(DisplayGLCtx *dgc, 292 QEMUGLContext ctx); 293 void (*dpy_gl_ctx_create_texture)(DisplayGLCtx *dgc, 294 DisplaySurface *surface); 295 void (*dpy_gl_ctx_destroy_texture)(DisplayGLCtx *dgc, 296 DisplaySurface *surface); 297 void (*dpy_gl_ctx_update_texture)(DisplayGLCtx *dgc, 298 DisplaySurface *surface, 299 int x, int y, int w, int h); 300 } DisplayGLCtxOps; 301 302 struct DisplayGLCtx { 303 const DisplayGLCtxOps *ops; 304 #ifdef CONFIG_OPENGL 305 QemuGLShader *gls; /* optional shared shader */ 306 #endif 307 }; 308 309 DisplayState *init_displaystate(void); 310 DisplaySurface *qemu_create_displaysurface_from(int width, int height, 311 pixman_format_code_t format, 312 int linesize, uint8_t *data); 313 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); 314 DisplaySurface *qemu_create_placeholder_surface(int w, int h, 315 const char *msg); 316 PixelFormat qemu_default_pixelformat(int bpp); 317 318 DisplaySurface *qemu_create_displaysurface(int width, int height); 319 void qemu_free_displaysurface(DisplaySurface *surface); 320 321 static inline int is_buffer_shared(DisplaySurface *surface) 322 { 323 return !(surface->flags & QEMU_ALLOCATED_FLAG); 324 } 325 326 static inline int is_placeholder(DisplaySurface *surface) 327 { 328 return surface->flags & QEMU_PLACEHOLDER_FLAG; 329 } 330 331 void register_displaychangelistener(DisplayChangeListener *dcl); 332 void update_displaychangelistener(DisplayChangeListener *dcl, 333 uint64_t interval); 334 void unregister_displaychangelistener(DisplayChangeListener *dcl); 335 336 bool dpy_ui_info_supported(QemuConsole *con); 337 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con); 338 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info, bool delay); 339 340 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); 341 void dpy_gfx_update_full(QemuConsole *con); 342 void dpy_gfx_replace_surface(QemuConsole *con, 343 DisplaySurface *surface); 344 void dpy_text_cursor(QemuConsole *con, int x, int y); 345 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 346 void dpy_text_resize(QemuConsole *con, int w, int h); 347 void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 348 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 349 bool dpy_cursor_define_supported(QemuConsole *con); 350 bool dpy_gfx_check_format(QemuConsole *con, 351 pixman_format_code_t format); 352 353 void dpy_gl_scanout_disable(QemuConsole *con); 354 void dpy_gl_scanout_texture(QemuConsole *con, 355 uint32_t backing_id, bool backing_y_0_top, 356 uint32_t backing_width, uint32_t backing_height, 357 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 358 void dpy_gl_scanout_dmabuf(QemuConsole *con, 359 QemuDmaBuf *dmabuf); 360 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, 361 bool have_hot, uint32_t hot_x, uint32_t hot_y); 362 void dpy_gl_cursor_position(QemuConsole *con, 363 uint32_t pos_x, uint32_t pos_y); 364 void dpy_gl_release_dmabuf(QemuConsole *con, 365 QemuDmaBuf *dmabuf); 366 void dpy_gl_update(QemuConsole *con, 367 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 368 369 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, 370 QEMUGLParams *params); 371 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); 372 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); 373 374 bool console_has_gl(QemuConsole *con); 375 376 static inline int surface_stride(DisplaySurface *s) 377 { 378 return pixman_image_get_stride(s->image); 379 } 380 381 static inline void *surface_data(DisplaySurface *s) 382 { 383 return pixman_image_get_data(s->image); 384 } 385 386 static inline int surface_width(DisplaySurface *s) 387 { 388 return pixman_image_get_width(s->image); 389 } 390 391 static inline int surface_height(DisplaySurface *s) 392 { 393 return pixman_image_get_height(s->image); 394 } 395 396 static inline int surface_bits_per_pixel(DisplaySurface *s) 397 { 398 int bits = PIXMAN_FORMAT_BPP(s->format); 399 return bits; 400 } 401 402 static inline int surface_bytes_per_pixel(DisplaySurface *s) 403 { 404 int bits = PIXMAN_FORMAT_BPP(s->format); 405 return DIV_ROUND_UP(bits, 8); 406 } 407 408 static inline pixman_format_code_t surface_format(DisplaySurface *s) 409 { 410 return s->format; 411 } 412 413 typedef uint32_t console_ch_t; 414 415 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 416 { 417 *dest = ch; 418 } 419 420 enum { 421 GRAPHIC_FLAGS_NONE = 0, 422 /* require a console/display with GL callbacks */ 423 GRAPHIC_FLAGS_GL = 1 << 0, 424 /* require a console/display with DMABUF import */ 425 GRAPHIC_FLAGS_DMABUF = 1 << 1, 426 }; 427 428 typedef struct GraphicHwOps { 429 int (*get_flags)(void *opaque); /* optional, default 0 */ 430 void (*invalidate)(void *opaque); 431 void (*gfx_update)(void *opaque); 432 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */ 433 void (*text_update)(void *opaque, console_ch_t *text); 434 void (*update_interval)(void *opaque, uint64_t interval); 435 int (*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 char *qemu_console_get_label(QemuConsole *con); 467 int qemu_console_get_index(QemuConsole *con); 468 uint32_t qemu_console_get_head(QemuConsole *con); 469 int qemu_console_get_width(QemuConsole *con, int fallback); 470 int qemu_console_get_height(QemuConsole *con, int fallback); 471 /* Return the low-level window id for the console */ 472 int qemu_console_get_window_id(QemuConsole *con); 473 /* Set the low-level window id for the console */ 474 void qemu_console_set_window_id(QemuConsole *con, int window_id); 475 476 void console_select(unsigned int index); 477 void qemu_console_resize(QemuConsole *con, int width, int height); 478 DisplaySurface *qemu_console_surface(QemuConsole *con); 479 480 /* console-gl.c */ 481 #ifdef CONFIG_OPENGL 482 bool console_gl_check_format(DisplayChangeListener *dcl, 483 pixman_format_code_t format); 484 void surface_gl_create_texture(QemuGLShader *gls, 485 DisplaySurface *surface); 486 void surface_gl_update_texture(QemuGLShader *gls, 487 DisplaySurface *surface, 488 int x, int y, int w, int h); 489 void surface_gl_render_texture(QemuGLShader *gls, 490 DisplaySurface *surface); 491 void surface_gl_destroy_texture(QemuGLShader *gls, 492 DisplaySurface *surface); 493 void surface_gl_setup_viewport(QemuGLShader *gls, 494 DisplaySurface *surface, 495 int ww, int wh); 496 #endif 497 498 typedef struct QemuDisplay QemuDisplay; 499 500 struct QemuDisplay { 501 DisplayType type; 502 void (*early_init)(DisplayOptions *opts); 503 void (*init)(DisplayState *ds, DisplayOptions *opts); 504 }; 505 506 void qemu_display_register(QemuDisplay *ui); 507 bool qemu_display_find_default(DisplayOptions *opts); 508 void qemu_display_early_init(DisplayOptions *opts); 509 void qemu_display_init(DisplayState *ds, DisplayOptions *opts); 510 void qemu_display_help(void); 511 512 /* vnc.c */ 513 void vnc_display_init(const char *id, Error **errp); 514 void vnc_display_open(const char *id, Error **errp); 515 void vnc_display_add_client(const char *id, int csock, bool skipauth); 516 int vnc_display_password(const char *id, const char *password); 517 int vnc_display_pw_expire(const char *id, time_t expires); 518 void vnc_parse(const char *str); 519 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 520 bool vnc_display_reload_certs(const char *id, Error **errp); 521 bool vnc_display_update(DisplayUpdateOptionsVNC *arg, Error **errp); 522 523 /* input.c */ 524 int index_from_key(const char *key, size_t key_length); 525 526 #ifdef CONFIG_LINUX 527 /* udmabuf.c */ 528 int udmabuf_fd(void); 529 #endif 530 531 /* util.c */ 532 bool qemu_console_fill_device_address(QemuConsole *con, 533 char *device_address, 534 size_t size, 535 Error **errp); 536 537 #endif 538