console.h (17105B)
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 */ 33enum 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 47typedef void QEMUPutKBDEvent(void *opaque, int keycode); 48typedef void QEMUPutLEDEvent(void *opaque, int ledstate); 49typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state); 50 51typedef struct QEMUPutMouseEntry QEMUPutMouseEntry; 52typedef struct QEMUPutKbdEntry QEMUPutKbdEntry; 53typedef struct QEMUPutLEDEntry QEMUPutLEDEntry; 54 55QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, 56 void *opaque); 57QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func, 58 void *opaque, int absolute, 59 const char *name); 60void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry); 61void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry); 62 63QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque); 64void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry); 65 66void kbd_put_ledstate(int ledstate); 67 68void 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 93void kbd_put_keysym_console(QemuConsole *s, int keysym); 94bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl); 95void kbd_put_string_console(QemuConsole *s, const char *str, int len); 96void kbd_put_keysym(int keysym); 97 98/* consoles */ 99 100#define TYPE_QEMU_CONSOLE "qemu-console" 101OBJECT_DECLARE_TYPE(QemuConsole, QemuConsoleClass, QEMU_CONSOLE) 102 103 104struct QemuConsoleClass { 105 ObjectClass parent_class; 106}; 107 108#define QEMU_ALLOCATED_FLAG 0x01 109#define QEMU_PLACEHOLDER_FLAG 0x02 110 111typedef 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 122typedef 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 */ 134typedef struct QEMUCursor { 135 int width, height; 136 int hot_x, hot_y; 137 int refcount; 138 uint32_t data[]; 139} QEMUCursor; 140 141QEMUCursor *cursor_alloc(int width, int height); 142void cursor_get(QEMUCursor *c); 143void cursor_put(QEMUCursor *c); 144QEMUCursor *cursor_builtin_hidden(void); 145QEMUCursor *cursor_builtin_left_ptr(void); 146void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); 147int cursor_get_mono_bpl(QEMUCursor *c); 148void cursor_set_mono(QEMUCursor *c, 149 uint32_t foreground, uint32_t background, uint8_t *image, 150 int transparent, uint8_t *mask); 151void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); 152void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); 153 154typedef void *QEMUGLContext; 155typedef struct QEMUGLParams QEMUGLParams; 156 157struct QEMUGLParams { 158 int major_ver; 159 int minor_ver; 160}; 161 162typedef 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} QemuDmaBuf; 175 176typedef struct DisplayState DisplayState; 177 178typedef struct DisplayChangeListenerOps { 179 const char *dpy_name; 180 181 /* optional */ 182 void (*dpy_refresh)(DisplayChangeListener *dcl); 183 184 /* optional */ 185 void (*dpy_gfx_update)(DisplayChangeListener *dcl, 186 int x, int y, int w, int h); 187 /* optional */ 188 void (*dpy_gfx_switch)(DisplayChangeListener *dcl, 189 struct DisplaySurface *new_surface); 190 /* optional */ 191 bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, 192 pixman_format_code_t format); 193 194 /* optional */ 195 void (*dpy_text_cursor)(DisplayChangeListener *dcl, 196 int x, int y); 197 /* optional */ 198 void (*dpy_text_resize)(DisplayChangeListener *dcl, 199 int w, int h); 200 /* optional */ 201 void (*dpy_text_update)(DisplayChangeListener *dcl, 202 int x, int y, int w, int h); 203 204 /* optional */ 205 void (*dpy_mouse_set)(DisplayChangeListener *dcl, 206 int x, int y, int on); 207 /* optional */ 208 void (*dpy_cursor_define)(DisplayChangeListener *dcl, 209 QEMUCursor *cursor); 210 211 /* required if GL */ 212 QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl, 213 QEMUGLParams *params); 214 /* required if GL */ 215 void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl, 216 QEMUGLContext ctx); 217 /* required if GL */ 218 int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl, 219 QEMUGLContext ctx); 220 221 /* required if GL */ 222 void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); 223 /* required if GL */ 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 /* optional (default to true if has dpy_gl_scanout_dmabuf) */ 232 bool (*dpy_has_dmabuf)(DisplayChangeListener *dcl); 233 /* optional */ 234 void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, 235 QemuDmaBuf *dmabuf); 236 /* optional */ 237 void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, 238 QemuDmaBuf *dmabuf, bool have_hot, 239 uint32_t hot_x, uint32_t hot_y); 240 /* optional */ 241 void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, 242 uint32_t pos_x, uint32_t pos_y); 243 /* optional */ 244 void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, 245 QemuDmaBuf *dmabuf); 246 /* required if GL */ 247 void (*dpy_gl_update)(DisplayChangeListener *dcl, 248 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 249 250} DisplayChangeListenerOps; 251 252struct DisplayChangeListener { 253 uint64_t update_interval; 254 const DisplayChangeListenerOps *ops; 255 DisplayState *ds; 256 QemuConsole *con; 257 258 QLIST_ENTRY(DisplayChangeListener) next; 259}; 260 261DisplayState *init_displaystate(void); 262DisplaySurface *qemu_create_displaysurface_from(int width, int height, 263 pixman_format_code_t format, 264 int linesize, uint8_t *data); 265DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); 266DisplaySurface *qemu_create_placeholder_surface(int w, int h, 267 const char *msg); 268PixelFormat qemu_default_pixelformat(int bpp); 269 270DisplaySurface *qemu_create_displaysurface(int width, int height); 271void qemu_free_displaysurface(DisplaySurface *surface); 272 273static inline int is_buffer_shared(DisplaySurface *surface) 274{ 275 return !(surface->flags & QEMU_ALLOCATED_FLAG); 276} 277 278static inline int is_placeholder(DisplaySurface *surface) 279{ 280 return surface->flags & QEMU_PLACEHOLDER_FLAG; 281} 282 283void register_displaychangelistener(DisplayChangeListener *dcl); 284void update_displaychangelistener(DisplayChangeListener *dcl, 285 uint64_t interval); 286void unregister_displaychangelistener(DisplayChangeListener *dcl); 287 288bool dpy_ui_info_supported(QemuConsole *con); 289const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con); 290int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info); 291 292void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); 293void dpy_gfx_update_full(QemuConsole *con); 294void dpy_gfx_replace_surface(QemuConsole *con, 295 DisplaySurface *surface); 296void dpy_text_cursor(QemuConsole *con, int x, int y); 297void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 298void dpy_text_resize(QemuConsole *con, int w, int h); 299void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 300void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 301bool dpy_cursor_define_supported(QemuConsole *con); 302bool dpy_gfx_check_format(QemuConsole *con, 303 pixman_format_code_t format); 304 305void dpy_gl_scanout_disable(QemuConsole *con); 306void 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); 310void dpy_gl_scanout_dmabuf(QemuConsole *con, 311 QemuDmaBuf *dmabuf); 312void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, 313 bool have_hot, uint32_t hot_x, uint32_t hot_y); 314void dpy_gl_cursor_position(QemuConsole *con, 315 uint32_t pos_x, uint32_t pos_y); 316void dpy_gl_release_dmabuf(QemuConsole *con, 317 QemuDmaBuf *dmabuf); 318void dpy_gl_update(QemuConsole *con, 319 uint32_t x, uint32_t y, uint32_t w, uint32_t h); 320 321QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, 322 QEMUGLParams *params); 323void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); 324int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); 325 326bool console_has_gl(QemuConsole *con); 327 328static inline int surface_stride(DisplaySurface *s) 329{ 330 return pixman_image_get_stride(s->image); 331} 332 333static inline void *surface_data(DisplaySurface *s) 334{ 335 return pixman_image_get_data(s->image); 336} 337 338static inline int surface_width(DisplaySurface *s) 339{ 340 return pixman_image_get_width(s->image); 341} 342 343static inline int surface_height(DisplaySurface *s) 344{ 345 return pixman_image_get_height(s->image); 346} 347 348static inline int surface_bits_per_pixel(DisplaySurface *s) 349{ 350 int bits = PIXMAN_FORMAT_BPP(s->format); 351 return bits; 352} 353 354static inline int surface_bytes_per_pixel(DisplaySurface *s) 355{ 356 int bits = PIXMAN_FORMAT_BPP(s->format); 357 return DIV_ROUND_UP(bits, 8); 358} 359 360static inline pixman_format_code_t surface_format(DisplaySurface *s) 361{ 362 return s->format; 363} 364 365typedef uint32_t console_ch_t; 366 367static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 368{ 369 *dest = ch; 370} 371 372enum { 373 GRAPHIC_FLAGS_NONE = 0, 374 /* require a console/display with GL callbacks */ 375 GRAPHIC_FLAGS_GL = 1 << 0, 376 /* require a console/display with DMABUF import */ 377 GRAPHIC_FLAGS_DMABUF = 1 << 1, 378}; 379 380typedef struct GraphicHwOps { 381 int (*get_flags)(void *opaque); /* optional, default 0 */ 382 void (*invalidate)(void *opaque); 383 void (*gfx_update)(void *opaque); 384 bool gfx_update_async; /* if true, calls graphic_hw_update_done() */ 385 void (*text_update)(void *opaque, console_ch_t *text); 386 void (*update_interval)(void *opaque, uint64_t interval); 387 int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info); 388 void (*gl_block)(void *opaque, bool block); 389 void (*gl_flushed)(void *opaque); 390} GraphicHwOps; 391 392QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head, 393 const GraphicHwOps *ops, 394 void *opaque); 395void graphic_console_set_hwops(QemuConsole *con, 396 const GraphicHwOps *hw_ops, 397 void *opaque); 398void graphic_console_close(QemuConsole *con); 399 400void graphic_hw_update(QemuConsole *con); 401void graphic_hw_update_done(QemuConsole *con); 402void graphic_hw_invalidate(QemuConsole *con); 403void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); 404void graphic_hw_gl_block(QemuConsole *con, bool block); 405void graphic_hw_gl_flushed(QemuConsole *con); 406 407void qemu_console_early_init(void); 408 409QemuConsole *qemu_console_lookup_by_index(unsigned int index); 410QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); 411QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, 412 uint32_t head, Error **errp); 413QemuConsole *qemu_console_lookup_unused(void); 414bool qemu_console_is_visible(QemuConsole *con); 415bool qemu_console_is_graphic(QemuConsole *con); 416bool qemu_console_is_fixedsize(QemuConsole *con); 417bool qemu_console_is_gl_blocked(QemuConsole *con); 418char *qemu_console_get_label(QemuConsole *con); 419int qemu_console_get_index(QemuConsole *con); 420uint32_t qemu_console_get_head(QemuConsole *con); 421int qemu_console_get_width(QemuConsole *con, int fallback); 422int qemu_console_get_height(QemuConsole *con, int fallback); 423/* Return the low-level window id for the console */ 424int qemu_console_get_window_id(QemuConsole *con); 425/* Set the low-level window id for the console */ 426void qemu_console_set_window_id(QemuConsole *con, int window_id); 427 428void console_select(unsigned int index); 429void qemu_console_resize(QemuConsole *con, int width, int height); 430DisplaySurface *qemu_console_surface(QemuConsole *con); 431 432/* console-gl.c */ 433#ifdef CONFIG_OPENGL 434bool console_gl_check_format(DisplayChangeListener *dcl, 435 pixman_format_code_t format); 436void surface_gl_create_texture(QemuGLShader *gls, 437 DisplaySurface *surface); 438void surface_gl_update_texture(QemuGLShader *gls, 439 DisplaySurface *surface, 440 int x, int y, int w, int h); 441void surface_gl_render_texture(QemuGLShader *gls, 442 DisplaySurface *surface); 443void surface_gl_destroy_texture(QemuGLShader *gls, 444 DisplaySurface *surface); 445void surface_gl_setup_viewport(QemuGLShader *gls, 446 DisplaySurface *surface, 447 int ww, int wh); 448#endif 449 450typedef struct QemuDisplay QemuDisplay; 451 452struct QemuDisplay { 453 DisplayType type; 454 void (*early_init)(DisplayOptions *opts); 455 void (*init)(DisplayState *ds, DisplayOptions *opts); 456}; 457 458void qemu_display_register(QemuDisplay *ui); 459bool qemu_display_find_default(DisplayOptions *opts); 460void qemu_display_early_init(DisplayOptions *opts); 461void qemu_display_init(DisplayState *ds, DisplayOptions *opts); 462void qemu_display_help(void); 463 464/* vnc.c */ 465void vnc_display_init(const char *id, Error **errp); 466void vnc_display_open(const char *id, Error **errp); 467void vnc_display_add_client(const char *id, int csock, bool skipauth); 468int vnc_display_password(const char *id, const char *password); 469int vnc_display_pw_expire(const char *id, time_t expires); 470void vnc_parse(const char *str); 471int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); 472bool vnc_display_reload_certs(const char *id, Error **errp); 473 474/* input.c */ 475int index_from_key(const char *key, size_t key_length); 476 477#ifdef CONFIG_LINUX 478/* udmabuf.c */ 479int udmabuf_fd(void); 480#endif 481 482#endif