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