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