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 DisplaySurface { 112 pixman_format_code_t format; 113 pixman_image_t *image; 114 uint8_t flags; 115 #ifdef CONFIG_OPENGL 116 GLenum glformat; 117 GLenum gltype; 118 GLuint texture; 119 #endif 120 } DisplaySurface; 121 122 typedef struct QemuUIInfo { 123 /* physical dimension */ 124 uint16_t width_mm; 125 uint16_t height_mm; 126 /* geometry */ 127 int xoff; 128 int yoff; 129 uint32_t width; 130 uint32_t height; 131 } QemuUIInfo; 132 133 /* cursor data format is 32bit RGBA */ 134 typedef struct QEMUCursor { 135 int width, height; 136 int hot_x, hot_y; 137 int refcount; 138 uint32_t data[]; 139 } QEMUCursor; 140 141 QEMUCursor *cursor_alloc(int width, int height); 142 void cursor_get(QEMUCursor *c); 143 void cursor_put(QEMUCursor *c); 144 QEMUCursor *cursor_builtin_hidden(void); 145 QEMUCursor *cursor_builtin_left_ptr(void); 146 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 147 int cursor_get_mono_bpl(QEMUCursor *c); 148 void cursor_set_mono(QEMUCursor *c, 149 uint32_t foreground, uint32_t background, uint8_t *image, 150 int transparent, uint8_t *mask); 151 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 152 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 153 154 typedef void *QEMUGLContext; 155 typedef struct QEMUGLParams QEMUGLParams; 156 157 struct QEMUGLParams { 158 int major_ver; 159 int minor_ver; 160 }; 161 162 typedef struct QemuDmaBuf { 163 int fd; 164 uint32_t width; 165 uint32_t height; 166 uint32_t stride; 167 uint32_t fourcc; 168 uint64_t modifier; 169 uint32_t texture; 170 uint32_t x; 171 uint32_t y; 172 uint32_t scanout_width; 173 uint32_t scanout_height; 174 bool y0_top; 175 void *sync; 176 int fence_fd; 177 bool allow_fences; 178 bool draw_submitted; 179 } QemuDmaBuf; 180 181 typedef struct DisplayState DisplayState; 182 183 typedef struct DisplayChangeListenerOps { 184 const char *dpy_name; 185 186 /* optional */ 187 void (*dpy_refresh)(DisplayChangeListener *dcl); 188 189 /* optional */ 190 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 191 int x, int y, int w, int h); 192 /* optional */ 193 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 194 struct DisplaySurface *new_surface); 195 /* optional */ 196 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 197 pixman_format_code_t format); 198 199 /* optional */ 200 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 201 int x, int y); 202 /* optional */ 203 void (*dpy_text_resize)(DisplayChangeListener *dcl, 204 int w, int h); 205 /* optional */ 206 void (*dpy_text_update)(DisplayChangeListener *dcl, 207 int x, int y, int w, int h); 208 209 /* optional */ 210 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 211 int x, int y, int on); 212 /* optional */ 213 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 214 QEMUCursor *cursor); 215 216 /* required if GL */ 217 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl, 218 QEMUGLParams *params); 219 /* required if GL */ 220 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl, 221 QEMUGLContext ctx); 222 /* required if GL */ 223 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl, 224 QEMUGLContext ctx); 225 226 /* required if GL */ 227 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 228 /* required if GL */ 229 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, 230 uint32_t backing_id, 231 bool backing_y_0_top, 232 uint32_t backing_width, 233 uint32_t backing_height, 234 uint32_t x, uint32_t y, 235 uint32_t w, uint32_t h); 236 /* optional (default to true if has dpy_gl_scanout_dmabuf) */ 237 bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl); 238 /* optional */ 239 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 240 QemuDmaBuf *dmabuf); 241 /* optional */ 242 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 243 QemuDmaBuf *dmabuf, bool have_hot, 244 uint32_t hot_x, uint32_t hot_y); 245 /* optional */ 246 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, 247 uint32_t pos_x, uint32_t pos_y); 248 /* optional */ 249 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 250 QemuDmaBuf *dmabuf); 251 /* required if GL */ 252 void (*dpy_gl_update)(DisplayChangeListener *dcl, 253 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 254 255 } DisplayChangeListenerOps; 256 257 struct DisplayChangeListener { 258 uint64_t update_interval; 259 const DisplayChangeListenerOps *ops; 260 DisplayState *ds; 261 QemuConsole *con; 262 263 QLIST_ENTRY(DisplayChangeListener) next; 264 }; 265 266 DisplayState *init_displaystate(void); 267 DisplaySurface *qemu_create_displaysurface_from(int width, int height, 268 pixman_format_code_t format, 269 int linesize, uint8_t *data); 270 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); 271 DisplaySurface *qemu_create_placeholder_surface(int w, int h, 272 const char *msg); 273 PixelFormat qemu_default_pixelformat(int bpp); 274 275 DisplaySurface *qemu_create_displaysurface(int width, int height); 276 void qemu_free_displaysurface(DisplaySurface *surface); 277 278 static inline int is_buffer_shared(DisplaySurface *surface) 279 { 280 return !(surface->flags & QEMU_ALLOCATED_FLAG); 281 } 282 283 static inline int is_placeholder(DisplaySurface *surface) 284 { 285 return surface->flags & QEMU_PLACEHOLDER_FLAG; 286 } 287 288 void register_displaychangelistener(DisplayChangeListener *dcl); 289 void update_displaychangelistener(DisplayChangeListener *dcl, 290 uint64_t interval); 291 void unregister_displaychangelistener(DisplayChangeListener *dcl); 292 293 bool dpy_ui_info_supported(QemuConsole *con); 294 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con); 295 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info); 296 297 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); 298 void dpy_gfx_update_full(QemuConsole *con); 299 void dpy_gfx_replace_surface(QemuConsole *con, 300 DisplaySurface *surface); 301 void dpy_text_cursor(QemuConsole *con, int x, int y); 302 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 303 void dpy_text_resize(QemuConsole *con, int w, int h); 304 void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 305 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 306 bool dpy_cursor_define_supported(QemuConsole *con); 307 bool dpy_gfx_check_format(QemuConsole *con, 308 pixman_format_code_t format); 309 310 void dpy_gl_scanout_disable(QemuConsole *con); 311 void dpy_gl_scanout_texture(QemuConsole *con, 312 uint32_t backing_id, bool backing_y_0_top, 313 uint32_t backing_width, uint32_t backing_height, 314 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 315 void dpy_gl_scanout_dmabuf(QemuConsole *con, 316 QemuDmaBuf *dmabuf); 317 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, 318 bool have_hot, uint32_t hot_x, uint32_t hot_y); 319 void dpy_gl_cursor_position(QemuConsole *con, 320 uint32_t pos_x, uint32_t pos_y); 321 void dpy_gl_release_dmabuf(QemuConsole *con, 322 QemuDmaBuf *dmabuf); 323 void dpy_gl_update(QemuConsole *con, 324 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 325 326 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, 327 QEMUGLParams *params); 328 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); 329 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); 330 331 bool console_has_gl(QemuConsole *con); 332 333 static inline int surface_stride(DisplaySurface *s) 334 { 335 return pixman_image_get_stride(s->image); 336 } 337 338 static inline void *surface_data(DisplaySurface *s) 339 { 340 return pixman_image_get_data(s->image); 341 } 342 343 static inline int surface_width(DisplaySurface *s) 344 { 345 return pixman_image_get_width(s->image); 346 } 347 348 static inline int surface_height(DisplaySurface *s) 349 { 350 return pixman_image_get_height(s->image); 351 } 352 353 static inline int surface_bits_per_pixel(DisplaySurface *s) 354 { 355 int bits = PIXMAN_FORMAT_BPP(s->format); 356 return bits; 357 } 358 359 static inline int surface_bytes_per_pixel(DisplaySurface *s) 360 { 361 int bits = PIXMAN_FORMAT_BPP(s->format); 362 return DIV_ROUND_UP(bits, 8); 363 } 364 365 static inline pixman_format_code_t surface_format(DisplaySurface *s) 366 { 367 return s->format; 368 } 369 370 typedef uint32_t console_ch_t; 371 372 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 373 { 374 *dest = ch; 375 } 376 377 enum { 378 GRAPHIC_FLAGS_NONE = 0, 379 /* require a console/display with GL callbacks */ 380 GRAPHIC_FLAGS_GL = 1 << 0, 381 /* require a console/display with DMABUF import */ 382 GRAPHIC_FLAGS_DMABUF = 1 << 1, 383 }; 384 385 typedef struct GraphicHwOps { 386 int (*get_flags)(void *opaque); /* optional, default 0 */ 387 void (*invalidate)(void *opaque); 388 void (*gfx_update)(void *opaque); 389 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */ 390 void (*text_update)(void *opaque, console_ch_t *text); 391 void (*update_interval)(void *opaque, uint64_t interval); 392 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info); 393 void (*gl_block)(void *opaque, bool block); 394 void (*gl_flushed)(void *opaque); 395 } GraphicHwOps; 396 397 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head, 398 const GraphicHwOps *ops, 399 void *opaque); 400 void graphic_console_set_hwops(QemuConsole *con, 401 const GraphicHwOps *hw_ops, 402 void *opaque); 403 void graphic_console_close(QemuConsole *con); 404 405 void graphic_hw_update(QemuConsole *con); 406 void graphic_hw_update_done(QemuConsole *con); 407 void graphic_hw_invalidate(QemuConsole *con); 408 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); 409 void graphic_hw_gl_block(QemuConsole *con, bool block); 410 void graphic_hw_gl_flushed(QemuConsole *con); 411 412 void qemu_console_early_init(void); 413 414 QemuConsole *qemu_console_lookup_by_index(unsigned int index); 415 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); 416 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, 417 uint32_t head, Error **errp); 418 QemuConsole *qemu_console_lookup_unused(void); 419 bool qemu_console_is_visible(QemuConsole *con); 420 bool qemu_console_is_graphic(QemuConsole *con); 421 bool qemu_console_is_fixedsize(QemuConsole *con); 422 bool qemu_console_is_gl_blocked(QemuConsole *con); 423 char *qemu_console_get_label(QemuConsole *con); 424 int qemu_console_get_index(QemuConsole *con); 425 uint32_t qemu_console_get_head(QemuConsole *con); 426 int qemu_console_get_width(QemuConsole *con, int fallback); 427 int qemu_console_get_height(QemuConsole *con, int fallback); 428 /* Return the low-level window id for the console */ 429 int qemu_console_get_window_id(QemuConsole *con); 430 /* Set the low-level window id for the console */ 431 void qemu_console_set_window_id(QemuConsole *con, int window_id); 432 433 void console_select(unsigned int index); 434 void qemu_console_resize(QemuConsole *con, int width, int height); 435 DisplaySurface *qemu_console_surface(QemuConsole *con); 436 437 /* console-gl.c */ 438 #ifdef CONFIG_OPENGL 439 bool console_gl_check_format(DisplayChangeListener *dcl, 440 pixman_format_code_t format); 441 void surface_gl_create_texture(QemuGLShader *gls, 442 DisplaySurface *surface); 443 void surface_gl_update_texture(QemuGLShader *gls, 444 DisplaySurface *surface, 445 int x, int y, int w, int h); 446 void surface_gl_render_texture(QemuGLShader *gls, 447 DisplaySurface *surface); 448 void surface_gl_destroy_texture(QemuGLShader *gls, 449 DisplaySurface *surface); 450 void surface_gl_setup_viewport(QemuGLShader *gls, 451 DisplaySurface *surface, 452 int ww, int wh); 453 #endif 454 455 typedef struct QemuDisplay QemuDisplay; 456 457 struct QemuDisplay { 458 DisplayType type; 459 void (*early_init)(DisplayOptions *opts); 460 void (*init)(DisplayState *ds, DisplayOptions *opts); 461 }; 462 463 void qemu_display_register(QemuDisplay *ui); 464 bool qemu_display_find_default(DisplayOptions *opts); 465 void qemu_display_early_init(DisplayOptions *opts); 466 void qemu_display_init(DisplayState *ds, DisplayOptions *opts); 467 void qemu_display_help(void); 468 469 /* vnc.c */ 470 void vnc_display_init(const char *id, Error **errp); 471 void vnc_display_open(const char *id, Error **errp); 472 void vnc_display_add_client(const char *id, int csock, bool skipauth); 473 int vnc_display_password(const char *id, const char *password); 474 int vnc_display_pw_expire(const char *id, time_t expires); 475 void vnc_parse(const char *str); 476 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 477 bool vnc_display_reload_certs(const char *id, Error **errp); 478 479 /* input.c */ 480 int index_from_key(const char *key, size_t key_length); 481 482 #ifdef CONFIG_LINUX 483 /* udmabuf.c */ 484 int udmabuf_fd(void); 485 #endif 486 487 #endif 488