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