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 #include "ui/surface.h" 10 #include "ui/dmabuf.h" 11 12 #define TYPE_QEMU_CONSOLE "qemu-console" 13 OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE) 14 15 #define TYPE_QEMU_GRAPHIC_CONSOLE "qemu-graphic-console" 16 OBJECT_DECLARE_SIMPLE_TYPE(QemuGraphicConsole, QEMU_GRAPHIC_CONSOLE) 17 18 #define TYPE_QEMU_TEXT_CONSOLE "qemu-text-console" 19 OBJECT_DECLARE_SIMPLE_TYPE(QemuTextConsole, QEMU_TEXT_CONSOLE) 20 21 #define TYPE_QEMU_FIXED_TEXT_CONSOLE "qemu-fixed-text-console" 22 OBJECT_DECLARE_SIMPLE_TYPE(QemuFixedTextConsole, QEMU_FIXED_TEXT_CONSOLE) 23 24 #define QEMU_IS_GRAPHIC_CONSOLE(c) \ 25 object_dynamic_cast(OBJECT(c), TYPE_QEMU_GRAPHIC_CONSOLE) 26 27 #define QEMU_IS_TEXT_CONSOLE(c) \ 28 object_dynamic_cast(OBJECT(c), TYPE_QEMU_TEXT_CONSOLE) 29 30 #define QEMU_IS_FIXED_TEXT_CONSOLE(c) \ 31 object_dynamic_cast(OBJECT(c), TYPE_QEMU_FIXED_TEXT_CONSOLE) 32 33 /* keyboard/mouse support */ 34 35 #define MOUSE_EVENT_LBUTTON 0x01 36 #define MOUSE_EVENT_RBUTTON 0x02 37 #define MOUSE_EVENT_MBUTTON 0x04 38 #define MOUSE_EVENT_WHEELUP 0x08 39 #define MOUSE_EVENT_WHEELDN 0x10 40 41 /* identical to the ps/2 keyboard bits */ 42 #define QEMU_SCROLL_LOCK_LED (1 << 0) 43 #define QEMU_NUM_LOCK_LED (1 << 1) 44 #define QEMU_CAPS_LOCK_LED (1 << 2) 45 46 /* in ms */ 47 #define GUI_REFRESH_INTERVAL_DEFAULT 30 48 #define GUI_REFRESH_INTERVAL_IDLE 3000 49 50 /* Color number is match to standard vga palette */ 51 enum qemu_color_names { 52 QEMU_COLOR_BLACK = 0, 53 QEMU_COLOR_BLUE = 1, 54 QEMU_COLOR_GREEN = 2, 55 QEMU_COLOR_CYAN = 3, 56 QEMU_COLOR_RED = 4, 57 QEMU_COLOR_MAGENTA = 5, 58 QEMU_COLOR_YELLOW = 6, 59 QEMU_COLOR_WHITE = 7 60 }; 61 /* Convert to curses char attributes */ 62 #define ATTR2CHTYPE(c, fg, bg, bold) \ 63 ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c)) 64 65 typedef void QEMUPutKBDEvent(void *opaque, int keycode); 66 typedef void QEMUPutLEDEvent(void *opaque, int ledstate); 67 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state); 68 69 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry; 70 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry; 71 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry; 72 73 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, 74 void *opaque); 75 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func, 76 void *opaque, int absolute, 77 const char *name); 78 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry); 79 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry); 80 81 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque); 82 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry); 83 84 void kbd_put_ledstate(int ledstate); 85 86 bool qemu_mouse_set(int index, Error **errp); 87 88 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx 89 constants) */ 90 #define QEMU_KEY_ESC1(c) ((c) | 0xe100) 91 #define QEMU_KEY_TAB 0x0009 92 #define QEMU_KEY_BACKSPACE 0x007f 93 #define QEMU_KEY_UP QEMU_KEY_ESC1('A') 94 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B') 95 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C') 96 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D') 97 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1) 98 #define QEMU_KEY_END QEMU_KEY_ESC1(4) 99 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5) 100 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6) 101 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3) 102 103 #define QEMU_KEY_CTRL_UP 0xe400 104 #define QEMU_KEY_CTRL_DOWN 0xe401 105 #define QEMU_KEY_CTRL_LEFT 0xe402 106 #define QEMU_KEY_CTRL_RIGHT 0xe403 107 #define QEMU_KEY_CTRL_HOME 0xe404 108 #define QEMU_KEY_CTRL_END 0xe405 109 #define QEMU_KEY_CTRL_PAGEUP 0xe406 110 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407 111 112 void qemu_text_console_put_keysym(QemuTextConsole *s, int keysym); 113 bool qemu_text_console_put_qcode(QemuTextConsole *s, int qcode, bool ctrl); 114 void qemu_text_console_put_string(QemuTextConsole *s, const char *str, int len); 115 116 /* Touch devices */ 117 typedef struct touch_slot { 118 int x; 119 int y; 120 int tracking_id; 121 } touch_slot; 122 123 void console_handle_touch_event(QemuConsole *con, 124 struct touch_slot touch_slots[INPUT_EVENT_SLOTS_MAX], 125 uint64_t num_slot, 126 int width, int height, 127 double x, double y, 128 InputMultiTouchType type, 129 Error **errp); 130 /* consoles */ 131 132 struct QemuConsoleClass { 133 ObjectClass parent_class; 134 }; 135 136 typedef struct ScanoutTexture { 137 uint32_t backing_id; 138 bool backing_y_0_top; 139 uint32_t backing_width; 140 uint32_t backing_height; 141 uint32_t x; 142 uint32_t y; 143 uint32_t width; 144 uint32_t height; 145 void *d3d_tex2d; 146 } ScanoutTexture; 147 148 typedef struct QemuUIInfo { 149 /* physical dimension */ 150 uint16_t width_mm; 151 uint16_t height_mm; 152 /* geometry */ 153 int xoff; 154 int yoff; 155 uint32_t width; 156 uint32_t height; 157 uint32_t refresh_rate; 158 } QemuUIInfo; 159 160 /* cursor data format is 32bit RGBA */ 161 typedef struct QEMUCursor { 162 uint16_t width, height; 163 int hot_x, hot_y; 164 int refcount; 165 uint32_t data[]; 166 } QEMUCursor; 167 168 QEMUCursor *cursor_alloc(uint16_t width, uint16_t height); 169 QEMUCursor *cursor_ref(QEMUCursor *c); 170 void cursor_unref(QEMUCursor *c); 171 QEMUCursor *cursor_builtin_hidden(void); 172 QEMUCursor *cursor_builtin_left_ptr(void); 173 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 174 int cursor_get_mono_bpl(QEMUCursor *c); 175 void cursor_set_mono(QEMUCursor *c, 176 uint32_t foreground, uint32_t background, uint8_t *image, 177 int transparent, uint8_t *mask); 178 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 179 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 180 181 typedef void *QEMUGLContext; 182 typedef struct QEMUGLParams QEMUGLParams; 183 184 struct QEMUGLParams { 185 int major_ver; 186 int minor_ver; 187 }; 188 189 enum display_scanout { 190 SCANOUT_NONE, 191 SCANOUT_SURFACE, 192 SCANOUT_TEXTURE, 193 SCANOUT_DMABUF, 194 }; 195 196 typedef struct DisplayScanout { 197 enum display_scanout kind; 198 union { 199 /* DisplaySurface *surface; is kept in QemuConsole */ 200 ScanoutTexture texture; 201 QemuDmaBuf *dmabuf; 202 }; 203 } DisplayScanout; 204 205 typedef struct DisplayState DisplayState; 206 typedef struct DisplayGLCtx DisplayGLCtx; 207 208 typedef struct DisplayChangeListenerOps { 209 const char *dpy_name; 210 211 /* optional */ 212 void (*dpy_refresh)(DisplayChangeListener *dcl); 213 214 /* optional */ 215 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 216 int x, int y, int w, int h); 217 /* optional */ 218 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 219 struct DisplaySurface *new_surface); 220 /* optional */ 221 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 222 pixman_format_code_t format); 223 224 /* optional */ 225 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 226 int x, int y); 227 /* optional */ 228 void (*dpy_text_resize)(DisplayChangeListener *dcl, 229 int w, int h); 230 /* optional */ 231 void (*dpy_text_update)(DisplayChangeListener *dcl, 232 int x, int y, int w, int h); 233 234 /* optional */ 235 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 236 int x, int y, int on); 237 /* optional */ 238 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 239 QEMUCursor *cursor); 240 241 /* required if GL */ 242 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 243 /* required if GL */ 244 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, 245 uint32_t backing_id, 246 bool backing_y_0_top, 247 uint32_t backing_width, 248 uint32_t backing_height, 249 uint32_t x, uint32_t y, 250 uint32_t w, uint32_t h, 251 void *d3d_tex2d); 252 /* optional (default to true if has dpy_gl_scanout_dmabuf) */ 253 bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl); 254 /* optional */ 255 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 256 QemuDmaBuf *dmabuf); 257 /* optional */ 258 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 259 QemuDmaBuf *dmabuf, bool have_hot, 260 uint32_t hot_x, uint32_t hot_y); 261 /* optional */ 262 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, 263 uint32_t pos_x, uint32_t pos_y); 264 /* optional */ 265 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 266 QemuDmaBuf *dmabuf); 267 /* required if GL */ 268 void (*dpy_gl_update)(DisplayChangeListener *dcl, 269 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 270 271 } DisplayChangeListenerOps; 272 273 struct DisplayChangeListener { 274 uint64_t update_interval; 275 const DisplayChangeListenerOps *ops; 276 DisplayState *ds; 277 QemuConsole *con; 278 279 QLIST_ENTRY(DisplayChangeListener) next; 280 }; 281 282 typedef struct DisplayGLCtxOps { 283 bool (*dpy_gl_ctx_is_compatible_dcl)(DisplayGLCtx *dgc, 284 DisplayChangeListener *dcl); 285 QEMUGLContext (*dpy_gl_ctx_create)(DisplayGLCtx *dgc, 286 QEMUGLParams *params); 287 void (*dpy_gl_ctx_destroy)(DisplayGLCtx *dgc, 288 QEMUGLContext ctx); 289 int (*dpy_gl_ctx_make_current)(DisplayGLCtx *dgc, 290 QEMUGLContext ctx); 291 void (*dpy_gl_ctx_create_texture)(DisplayGLCtx *dgc, 292 DisplaySurface *surface); 293 void (*dpy_gl_ctx_destroy_texture)(DisplayGLCtx *dgc, 294 DisplaySurface *surface); 295 void (*dpy_gl_ctx_update_texture)(DisplayGLCtx *dgc, 296 DisplaySurface *surface, 297 int x, int y, int w, int h); 298 } DisplayGLCtxOps; 299 300 struct DisplayGLCtx { 301 const DisplayGLCtxOps *ops; 302 #ifdef CONFIG_OPENGL 303 QemuGLShader *gls; /* optional shared shader */ 304 #endif 305 }; 306 307 DisplayState *init_displaystate(void); 308 309 void register_displaychangelistener(DisplayChangeListener *dcl); 310 void update_displaychangelistener(DisplayChangeListener *dcl, 311 uint64_t interval); 312 void unregister_displaychangelistener(DisplayChangeListener *dcl); 313 314 bool dpy_ui_info_supported(const QemuConsole *con); 315 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con); 316 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info, bool delay); 317 318 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); 319 void dpy_gfx_update_full(QemuConsole *con); 320 void dpy_gfx_replace_surface(QemuConsole *con, 321 DisplaySurface *surface); 322 void dpy_text_cursor(QemuConsole *con, int x, int y); 323 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 324 void dpy_text_resize(QemuConsole *con, int w, int h); 325 void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 326 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 327 bool dpy_cursor_define_supported(QemuConsole *con); 328 bool dpy_gfx_check_format(QemuConsole *con, 329 pixman_format_code_t format); 330 331 void dpy_gl_scanout_disable(QemuConsole *con); 332 void dpy_gl_scanout_texture(QemuConsole *con, 333 uint32_t backing_id, bool backing_y_0_top, 334 uint32_t backing_width, uint32_t backing_height, 335 uint32_t x, uint32_t y, uint32_t w, uint32_t h, 336 void *d3d_tex2d); 337 void dpy_gl_scanout_dmabuf(QemuConsole *con, 338 QemuDmaBuf *dmabuf); 339 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, 340 bool have_hot, uint32_t hot_x, uint32_t hot_y); 341 void dpy_gl_cursor_position(QemuConsole *con, 342 uint32_t pos_x, uint32_t pos_y); 343 void dpy_gl_release_dmabuf(QemuConsole *con, 344 QemuDmaBuf *dmabuf); 345 void dpy_gl_update(QemuConsole *con, 346 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 347 348 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, 349 QEMUGLParams *params); 350 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); 351 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); 352 353 bool console_has_gl(QemuConsole *con); 354 355 typedef uint32_t console_ch_t; 356 357 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 358 { 359 *dest = ch; 360 } 361 362 enum { 363 GRAPHIC_FLAGS_NONE = 0, 364 /* require a console/display with GL callbacks */ 365 GRAPHIC_FLAGS_GL = 1 << 0, 366 /* require a console/display with DMABUF import */ 367 GRAPHIC_FLAGS_DMABUF = 1 << 1, 368 }; 369 370 typedef struct GraphicHwOps { 371 int (*get_flags)(void *opaque); /* optional, default 0 */ 372 void (*invalidate)(void *opaque); 373 void (*gfx_update)(void *opaque); 374 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */ 375 void (*text_update)(void *opaque, console_ch_t *text); 376 void (*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 void graphic_console_close(QemuConsole *con); 387 388 void graphic_hw_update(QemuConsole *con); 389 void graphic_hw_update_done(QemuConsole *con); 390 void graphic_hw_invalidate(QemuConsole *con); 391 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); 392 void graphic_hw_gl_block(QemuConsole *con, bool block); 393 394 void qemu_console_early_init(void); 395 396 void qemu_console_set_display_gl_ctx(QemuConsole *con, DisplayGLCtx *ctx); 397 398 QemuConsole *qemu_console_lookup_default(void); 399 QemuConsole *qemu_console_lookup_by_index(unsigned int index); 400 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); 401 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, 402 uint32_t head, Error **errp); 403 QEMUCursor *qemu_console_get_cursor(QemuConsole *con); 404 bool qemu_console_is_visible(QemuConsole *con); 405 bool qemu_console_is_graphic(QemuConsole *con); 406 bool qemu_console_is_fixedsize(QemuConsole *con); 407 bool qemu_console_is_gl_blocked(QemuConsole *con); 408 char *qemu_console_get_label(QemuConsole *con); 409 int qemu_console_get_index(QemuConsole *con); 410 uint32_t qemu_console_get_head(QemuConsole *con); 411 int qemu_console_get_width(QemuConsole *con, int fallback); 412 int qemu_console_get_height(QemuConsole *con, int fallback); 413 /* Return the low-level window id for the console */ 414 int qemu_console_get_window_id(QemuConsole *con); 415 /* Set the low-level window id for the console */ 416 void qemu_console_set_window_id(QemuConsole *con, int window_id); 417 418 void qemu_console_resize(QemuConsole *con, int width, int height); 419 DisplaySurface *qemu_console_surface(QemuConsole *con); 420 void coroutine_fn qemu_console_co_wait_update(QemuConsole *con); 421 int qemu_invalidate_text_consoles(void); 422 423 /* console-gl.c */ 424 #ifdef CONFIG_OPENGL 425 bool console_gl_check_format(DisplayChangeListener *dcl, 426 pixman_format_code_t format); 427 void surface_gl_create_texture(QemuGLShader *gls, 428 DisplaySurface *surface); 429 void surface_gl_update_texture(QemuGLShader *gls, 430 DisplaySurface *surface, 431 int x, int y, int w, int h); 432 void surface_gl_render_texture(QemuGLShader *gls, 433 DisplaySurface *surface); 434 void surface_gl_destroy_texture(QemuGLShader *gls, 435 DisplaySurface *surface); 436 void surface_gl_setup_viewport(QemuGLShader *gls, 437 DisplaySurface *surface, 438 int ww, int wh); 439 #endif 440 441 typedef struct QemuDisplay QemuDisplay; 442 443 struct QemuDisplay { 444 DisplayType type; 445 void (*early_init)(DisplayOptions *opts); 446 void (*init)(DisplayState *ds, DisplayOptions *opts); 447 const char *vc; 448 }; 449 450 void qemu_display_register(QemuDisplay *ui); 451 bool qemu_display_find_default(DisplayOptions *opts); 452 void qemu_display_early_init(DisplayOptions *opts); 453 void qemu_display_init(DisplayState *ds, DisplayOptions *opts); 454 const char *qemu_display_get_vc(DisplayOptions *opts); 455 void qemu_display_help(void); 456 457 /* vnc.c */ 458 void vnc_display_init(const char *id, Error **errp); 459 void vnc_display_open(const char *id, Error **errp); 460 void vnc_display_add_client(const char *id, int csock, bool skipauth); 461 int vnc_display_password(const char *id, const char *password); 462 int vnc_display_pw_expire(const char *id, time_t expires); 463 void vnc_parse(const char *str); 464 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 465 bool vnc_display_reload_certs(const char *id, Error **errp); 466 bool vnc_display_update(DisplayUpdateOptionsVNC *arg, Error **errp); 467 468 /* input.c */ 469 int index_from_key(const char *key, size_t key_length); 470 471 #ifdef CONFIG_LINUX 472 /* udmabuf.c */ 473 int udmabuf_fd(void); 474 #endif 475 476 /* util.c */ 477 bool qemu_console_fill_device_address(QemuConsole *con, 478 char *device_address, 479 size_t size, 480 Error **errp); 481 482 #endif 483