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 struct MouseTransformInfo { 69 /* Touchscreen resolution */ 70 int x; 71 int y; 72 /* Calibration values as used/generated by tslib */ 73 int a[7]; 74 }; 75 76 void hmp_mouse_set(Monitor *mon, const QDict *qdict); 77 78 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx 79 constants) */ 80 #define QEMU_KEY_ESC1(c) ((c) | 0xe100) 81 #define QEMU_KEY_BACKSPACE 0x007f 82 #define QEMU_KEY_UP QEMU_KEY_ESC1('A') 83 #define QEMU_KEY_DOWN QEMU_KEY_ESC1('B') 84 #define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C') 85 #define QEMU_KEY_LEFT QEMU_KEY_ESC1('D') 86 #define QEMU_KEY_HOME QEMU_KEY_ESC1(1) 87 #define QEMU_KEY_END QEMU_KEY_ESC1(4) 88 #define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5) 89 #define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6) 90 #define QEMU_KEY_DELETE QEMU_KEY_ESC1(3) 91 92 #define QEMU_KEY_CTRL_UP 0xe400 93 #define QEMU_KEY_CTRL_DOWN 0xe401 94 #define QEMU_KEY_CTRL_LEFT 0xe402 95 #define QEMU_KEY_CTRL_RIGHT 0xe403 96 #define QEMU_KEY_CTRL_HOME 0xe404 97 #define QEMU_KEY_CTRL_END 0xe405 98 #define QEMU_KEY_CTRL_PAGEUP 0xe406 99 #define QEMU_KEY_CTRL_PAGEDOWN 0xe407 100 101 void kbd_put_keysym_console(QemuConsole *s, int keysym); 102 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl); 103 void kbd_put_string_console(QemuConsole *s, const char *str, int len); 104 void kbd_put_keysym(int keysym); 105 106 /* consoles */ 107 108 #define TYPE_QEMU_CONSOLE "qemu-console" 109 #define QEMU_CONSOLE(obj) \ 110 OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE) 111 #define QEMU_CONSOLE_GET_CLASS(obj) \ 112 OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE) 113 #define QEMU_CONSOLE_CLASS(klass) \ 114 OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE) 115 116 typedef struct QemuConsoleClass QemuConsoleClass; 117 118 struct QemuConsoleClass { 119 ObjectClass parent_class; 120 }; 121 122 #define QEMU_ALLOCATED_FLAG 0x01 123 124 struct PixelFormat { 125 uint8_t bits_per_pixel; 126 uint8_t bytes_per_pixel; 127 uint8_t depth; /* color depth in bits */ 128 uint32_t rmask, gmask, bmask, amask; 129 uint8_t rshift, gshift, bshift, ashift; 130 uint8_t rmax, gmax, bmax, amax; 131 uint8_t rbits, gbits, bbits, abits; 132 }; 133 134 struct DisplaySurface { 135 pixman_format_code_t format; 136 pixman_image_t *image; 137 uint8_t flags; 138 #ifdef CONFIG_OPENGL 139 GLenum glformat; 140 GLenum gltype; 141 GLuint texture; 142 #endif 143 }; 144 145 typedef struct QemuUIInfo { 146 /* geometry */ 147 int xoff; 148 int yoff; 149 uint32_t width; 150 uint32_t height; 151 } QemuUIInfo; 152 153 /* cursor data format is 32bit RGBA */ 154 typedef struct QEMUCursor { 155 int width, height; 156 int hot_x, hot_y; 157 int refcount; 158 uint32_t data[]; 159 } QEMUCursor; 160 161 QEMUCursor *cursor_alloc(int width, int height); 162 void cursor_get(QEMUCursor *c); 163 void cursor_put(QEMUCursor *c); 164 QEMUCursor *cursor_builtin_hidden(void); 165 QEMUCursor *cursor_builtin_left_ptr(void); 166 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 167 int cursor_get_mono_bpl(QEMUCursor *c); 168 void cursor_set_mono(QEMUCursor *c, 169 uint32_t foreground, uint32_t background, uint8_t *image, 170 int transparent, uint8_t *mask); 171 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 172 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 173 174 typedef void *QEMUGLContext; 175 typedef struct QEMUGLParams QEMUGLParams; 176 177 struct QEMUGLParams { 178 int major_ver; 179 int minor_ver; 180 }; 181 182 struct QemuDmaBuf { 183 int fd; 184 uint32_t width; 185 uint32_t height; 186 uint32_t stride; 187 uint32_t fourcc; 188 uint32_t texture; 189 }; 190 191 typedef struct DisplayChangeListenerOps { 192 const char *dpy_name; 193 194 void (*dpy_refresh)(DisplayChangeListener *dcl); 195 196 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 197 int x, int y, int w, int h); 198 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 199 struct DisplaySurface *new_surface); 200 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 201 pixman_format_code_t format); 202 203 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 204 int x, int y); 205 void (*dpy_text_resize)(DisplayChangeListener *dcl, 206 int w, int h); 207 void (*dpy_text_update)(DisplayChangeListener *dcl, 208 int x, int y, int w, int h); 209 210 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 211 int x, int y, int on); 212 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 213 QEMUCursor *cursor); 214 215 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl, 216 QEMUGLParams *params); 217 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl, 218 QEMUGLContext ctx); 219 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl, 220 QEMUGLContext ctx); 221 QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl); 222 223 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 224 void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, 225 uint32_t backing_id, 226 bool backing_y_0_top, 227 uint32_t backing_width, 228 uint32_t backing_height, 229 uint32_t x, uint32_t y, 230 uint32_t w, uint32_t h); 231 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 232 QemuDmaBuf *dmabuf); 233 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 234 QemuDmaBuf *dmabuf, bool have_hot, 235 uint32_t hot_x, uint32_t hot_y); 236 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, 237 uint32_t pos_x, uint32_t pos_y); 238 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 239 QemuDmaBuf *dmabuf); 240 void (*dpy_gl_update)(DisplayChangeListener *dcl, 241 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 242 243 } DisplayChangeListenerOps; 244 245 struct DisplayChangeListener { 246 uint64_t update_interval; 247 const DisplayChangeListenerOps *ops; 248 DisplayState *ds; 249 QemuConsole *con; 250 251 QLIST_ENTRY(DisplayChangeListener) next; 252 }; 253 254 DisplayState *init_displaystate(void); 255 DisplaySurface *qemu_create_displaysurface_from(int width, int height, 256 pixman_format_code_t format, 257 int linesize, uint8_t *data); 258 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); 259 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height, 260 pixman_format_code_t format, 261 int linesize, 262 uint64_t addr); 263 DisplaySurface *qemu_create_message_surface(int w, int h, 264 const char *msg); 265 PixelFormat qemu_default_pixelformat(int bpp); 266 267 DisplaySurface *qemu_create_displaysurface(int width, int height); 268 void qemu_free_displaysurface(DisplaySurface *surface); 269 270 static inline int is_surface_bgr(DisplaySurface *surface) 271 { 272 if (PIXMAN_FORMAT_BPP(surface->format) == 32 && 273 PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) { 274 return 1; 275 } else { 276 return 0; 277 } 278 } 279 280 static inline int is_buffer_shared(DisplaySurface *surface) 281 { 282 return !(surface->flags & QEMU_ALLOCATED_FLAG); 283 } 284 285 void register_displaychangelistener(DisplayChangeListener *dcl); 286 void update_displaychangelistener(DisplayChangeListener *dcl, 287 uint64_t interval); 288 void unregister_displaychangelistener(DisplayChangeListener *dcl); 289 290 bool dpy_ui_info_supported(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_replace_surface(QemuConsole *con, 295 DisplaySurface *surface); 296 void dpy_text_cursor(QemuConsole *con, int x, int y); 297 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 298 void dpy_text_resize(QemuConsole *con, int w, int h); 299 void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 300 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 301 bool dpy_cursor_define_supported(QemuConsole *con); 302 bool dpy_gfx_check_format(QemuConsole *con, 303 pixman_format_code_t format); 304 305 void dpy_gl_scanout_disable(QemuConsole *con); 306 void dpy_gl_scanout_texture(QemuConsole *con, 307 uint32_t backing_id, bool backing_y_0_top, 308 uint32_t backing_width, uint32_t backing_height, 309 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 310 void dpy_gl_scanout_dmabuf(QemuConsole *con, 311 QemuDmaBuf *dmabuf); 312 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, 313 bool have_hot, uint32_t hot_x, uint32_t hot_y); 314 void dpy_gl_cursor_position(QemuConsole *con, 315 uint32_t pos_x, uint32_t pos_y); 316 void dpy_gl_release_dmabuf(QemuConsole *con, 317 QemuDmaBuf *dmabuf); 318 void dpy_gl_update(QemuConsole *con, 319 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 320 321 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, 322 QEMUGLParams *params); 323 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); 324 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); 325 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con); 326 327 bool console_has_gl(QemuConsole *con); 328 bool console_has_gl_dmabuf(QemuConsole *con); 329 330 static inline int surface_stride(DisplaySurface *s) 331 { 332 return pixman_image_get_stride(s->image); 333 } 334 335 static inline void *surface_data(DisplaySurface *s) 336 { 337 return pixman_image_get_data(s->image); 338 } 339 340 static inline int surface_width(DisplaySurface *s) 341 { 342 return pixman_image_get_width(s->image); 343 } 344 345 static inline int surface_height(DisplaySurface *s) 346 { 347 return pixman_image_get_height(s->image); 348 } 349 350 static inline int surface_bits_per_pixel(DisplaySurface *s) 351 { 352 int bits = PIXMAN_FORMAT_BPP(s->format); 353 return bits; 354 } 355 356 static inline int surface_bytes_per_pixel(DisplaySurface *s) 357 { 358 int bits = PIXMAN_FORMAT_BPP(s->format); 359 return DIV_ROUND_UP(bits, 8); 360 } 361 362 static inline pixman_format_code_t surface_format(DisplaySurface *s) 363 { 364 return s->format; 365 } 366 367 typedef uint32_t console_ch_t; 368 369 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 370 { 371 *dest = ch; 372 } 373 374 typedef struct GraphicHwOps { 375 void (*invalidate)(void *opaque); 376 void (*gfx_update)(void *opaque); 377 void (*text_update)(void *opaque, console_ch_t *text); 378 void (*update_interval)(void *opaque, uint64_t interval); 379 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info); 380 void (*gl_block)(void *opaque, bool block); 381 } GraphicHwOps; 382 383 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head, 384 const GraphicHwOps *ops, 385 void *opaque); 386 void graphic_console_set_hwops(QemuConsole *con, 387 const GraphicHwOps *hw_ops, 388 void *opaque); 389 void graphic_console_close(QemuConsole *con); 390 391 void graphic_hw_update(QemuConsole *con); 392 void graphic_hw_invalidate(QemuConsole *con); 393 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); 394 void graphic_hw_gl_block(QemuConsole *con, bool block); 395 396 void qemu_console_early_init(void); 397 398 QemuConsole *qemu_console_lookup_by_index(unsigned int index); 399 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); 400 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, 401 uint32_t head, Error **errp); 402 QemuConsole *qemu_console_lookup_unused(void); 403 bool qemu_console_is_visible(QemuConsole *con); 404 bool qemu_console_is_graphic(QemuConsole *con); 405 bool qemu_console_is_fixedsize(QemuConsole *con); 406 bool qemu_console_is_gl_blocked(QemuConsole *con); 407 char *qemu_console_get_label(QemuConsole *con); 408 int qemu_console_get_index(QemuConsole *con); 409 uint32_t qemu_console_get_head(QemuConsole *con); 410 QemuUIInfo *qemu_console_get_ui_info(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 console_select(unsigned int index); 419 void qemu_console_resize(QemuConsole *con, int width, int height); 420 DisplaySurface *qemu_console_surface(QemuConsole *con); 421 422 /* console-gl.c */ 423 #ifdef CONFIG_OPENGL 424 bool console_gl_check_format(DisplayChangeListener *dcl, 425 pixman_format_code_t format); 426 void surface_gl_create_texture(QemuGLShader *gls, 427 DisplaySurface *surface); 428 void surface_gl_update_texture(QemuGLShader *gls, 429 DisplaySurface *surface, 430 int x, int y, int w, int h); 431 void surface_gl_render_texture(QemuGLShader *gls, 432 DisplaySurface *surface); 433 void surface_gl_destroy_texture(QemuGLShader *gls, 434 DisplaySurface *surface); 435 void surface_gl_setup_viewport(QemuGLShader *gls, 436 DisplaySurface *surface, 437 int ww, int wh); 438 #endif 439 440 typedef struct QemuDisplay QemuDisplay; 441 442 struct QemuDisplay { 443 DisplayType type; 444 void (*early_init)(DisplayOptions *opts); 445 void (*init)(DisplayState *ds, DisplayOptions *opts); 446 }; 447 448 void qemu_display_register(QemuDisplay *ui); 449 bool qemu_display_find_default(DisplayOptions *opts); 450 void qemu_display_early_init(DisplayOptions *opts); 451 void qemu_display_init(DisplayState *ds, DisplayOptions *opts); 452 453 /* vnc.c */ 454 void vnc_display_init(const char *id); 455 void vnc_display_open(const char *id, Error **errp); 456 void vnc_display_add_client(const char *id, int csock, bool skipauth); 457 int vnc_display_password(const char *id, const char *password); 458 int vnc_display_pw_expire(const char *id, time_t expires); 459 QemuOpts *vnc_parse(const char *str, Error **errp); 460 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 461 462 /* input.c */ 463 int index_from_key(const char *key, size_t key_length); 464 465 #endif 466