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