console.h

   1 #ifndef CONSOLE_H
   2 #define CONSOLE_H
   3
   4 #include "qemu-char.h"
   5 #include "qemu-pixman.h"
   6 #include "qdict.h"
   7 #include "notify.h"
   8 #include "monitor.h"
   9 #include "trace.h"
  10 #include "qapi-types.h"
  11 #include "error.h"
  12
  13 /* keyboard/mouse support */
  14
  15 #define MOUSE_EVENT_LBUTTON 0x01
  16 #define MOUSE_EVENT_RBUTTON 0x02
  17 #define MOUSE_EVENT_MBUTTON 0x04
  18
  19 /* identical to the ps/2 keyboard bits */
  20 #define QEMU_SCROLL_LOCK_LED (1 << 0)
  21 #define QEMU_NUM_LOCK_LED    (1 << 1)
  22 #define QEMU_CAPS_LOCK_LED   (1 << 2)
  23
  24 /* in ms */
  25 #define GUI_REFRESH_INTERVAL 30
  26
  27 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
  28 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
  29 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
  30
  31 typedef struct QEMUPutMouseEntry {
  32     QEMUPutMouseEvent *qemu_put_mouse_event;
  33     void *qemu_put_mouse_event_opaque;
  34     int qemu_put_mouse_event_absolute;
  35     char *qemu_put_mouse_event_name;
  36
  37     int index;
  38
  39     /* used internally by qemu for handling mice */
  40     QTAILQ_ENTRY(QEMUPutMouseEntry) node;
  41 } QEMUPutMouseEntry;
  42
  43 typedef struct QEMUPutLEDEntry {
  44     QEMUPutLEDEvent *put_led;
  45     void *opaque;
  46     QTAILQ_ENTRY(QEMUPutLEDEntry) next;
  47 } QEMUPutLEDEntry;
  48
  49 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
  50 void qemu_remove_kbd_event_handler(void);
  51 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
  52                                                 void *opaque, int absolute,
  53                                                 const char *name);
  54 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
  55 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
  56
  57 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
  58 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
  59
  60 void kbd_put_keycode(int keycode);
  61 void kbd_put_ledstate(int ledstate);
  62 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
  63
  64 /* Does the current mouse generate absolute events */
  65 int kbd_mouse_is_absolute(void);
  66 void qemu_add_mouse_mode_change_notifier(Notifier *notify);
  67 void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
  68
  69 /* Of all the mice, is there one that generates absolute events */
  70 int kbd_mouse_has_absolute(void);
  71
  72 struct MouseTransformInfo {
  73     /* Touchscreen resolution */
  74     int x;
  75     int y;
  76     /* Calibration values as used/generated by tslib */
  77     int a[7];
  78 };
  79
  80 void do_mouse_set(Monitor *mon, const QDict *qdict);
  81
  82 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
  83    constants) */
  84 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
  85 #define QEMU_KEY_BACKSPACE  0x007f
  86 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
  87 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
  88 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
  89 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
  90 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
  91 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
  92 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
  93 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
  94 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
  95
  96 #define QEMU_KEY_CTRL_UP         0xe400
  97 #define QEMU_KEY_CTRL_DOWN       0xe401
  98 #define QEMU_KEY_CTRL_LEFT       0xe402
  99 #define QEMU_KEY_CTRL_RIGHT      0xe403
 100 #define QEMU_KEY_CTRL_HOME       0xe404
 101 #define QEMU_KEY_CTRL_END        0xe405
 102 #define QEMU_KEY_CTRL_PAGEUP     0xe406
 103 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
 104
 105 void kbd_put_keysym(int keysym);
 106
 107 /* consoles */
 108
 109 #define QEMU_BIG_ENDIAN_FLAG    0x01
 110 #define QEMU_ALLOCATED_FLAG     0x02
 111
 112 struct PixelFormat {
 113     uint8_t bits_per_pixel;
 114     uint8_t bytes_per_pixel;
 115     uint8_t depth; /* color depth in bits */
 116     uint32_t rmask, gmask, bmask, amask;
 117     uint8_t rshift, gshift, bshift, ashift;
 118     uint8_t rmax, gmax, bmax, amax;
 119     uint8_t rbits, gbits, bbits, abits;
 120 };
 121
 122 struct DisplaySurface {
 123     pixman_format_code_t format;
 124     pixman_image_t *image;
 125     uint8_t flags;
 126     int width;
 127     int height;
 128     int linesize;        /* bytes per line */
 129     uint8_t *data;
 130
 131     struct PixelFormat pf;
 132 };
 133
 134 /* cursor data format is 32bit RGBA */
 135 typedef struct QEMUCursor {
 136     int                 width, height;
 137     int                 hot_x, hot_y;
 138     int                 refcount;
 139     uint32_t            data[];
 140 } QEMUCursor;
 141
 142 QEMUCursor *cursor_alloc(int width, int height);
 143 void cursor_get(QEMUCursor *c);
 144 void cursor_put(QEMUCursor *c);
 145 QEMUCursor *cursor_builtin_hidden(void);
 146 QEMUCursor *cursor_builtin_left_ptr(void);
 147 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
 148 int cursor_get_mono_bpl(QEMUCursor *c);
 149 void cursor_set_mono(QEMUCursor *c,
 150                      uint32_t foreground, uint32_t background, uint8_t *image,
 151                      int transparent, uint8_t *mask);
 152 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
 153 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
 154
 155 struct DisplayChangeListener {
 156     int idle;
 157     uint64_t gui_timer_interval;
 158
 159     void (*dpy_refresh)(struct DisplayState *s);
 160
 161     void (*dpy_gfx_update)(struct DisplayState *s, int x, int y, int w, int h);
 162     void (*dpy_gfx_resize)(struct DisplayState *s);
 163     void (*dpy_gfx_setdata)(struct DisplayState *s);
 164     void (*dpy_gfx_copy)(struct DisplayState *s, int src_x, int src_y,
 165                          int dst_x, int dst_y, int w, int h);
 166
 167     void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
 168     void (*dpy_text_resize)(struct DisplayState *s, int w, int h);
 169     void (*dpy_text_update)(struct DisplayState *s, int x, int y, int w, int h);
 170
 171     void (*dpy_mouse_set)(struct DisplayState *s, int x, int y, int on);
 172     void (*dpy_cursor_define)(struct DisplayState *s, QEMUCursor *cursor);
 173
 174     QLIST_ENTRY(DisplayChangeListener) next;
 175 };
 176
 177 struct DisplayState {
 178     struct DisplaySurface *surface;
 179     void *opaque;
 180     struct QEMUTimer *gui_timer;
 181     bool have_gfx;
 182     bool have_text;
 183
 184     QLIST_HEAD(, DisplayChangeListener) listeners;
 185
 186     struct DisplayState *next;
 187 };
 188
 189 void register_displaystate(DisplayState *ds);
 190 DisplayState *get_displaystate(void);
 191 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
 192                                                 int linesize, uint8_t *data);
 193 PixelFormat qemu_different_endianness_pixelformat(int bpp);
 194 PixelFormat qemu_default_pixelformat(int bpp);
 195
 196 DisplaySurface *qemu_create_displaysurface(DisplayState *ds,
 197                                            int width, int height);
 198 DisplaySurface *qemu_resize_displaysurface(DisplayState *ds,
 199                                            int width, int height);
 200 void qemu_free_displaysurface(DisplayState *ds);
 201
 202 static inline int is_surface_bgr(DisplaySurface *surface)
 203 {
 204     if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
 205         return 1;
 206     else
 207         return 0;
 208 }
 209
 210 static inline int is_buffer_shared(DisplaySurface *surface)
 211 {
 212     return !(surface->flags & QEMU_ALLOCATED_FLAG);
 213 }
 214
 215 void gui_setup_refresh(DisplayState *ds);
 216
 217 static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
 218 {
 219     QLIST_INSERT_HEAD(&ds->listeners, dcl, next);
 220     gui_setup_refresh(ds);
 221     if (dcl->dpy_gfx_resize) {
 222         dcl->dpy_gfx_resize(ds);
 223     }
 224 }
 225
 226 static inline void unregister_displaychangelistener(DisplayState *ds,
 227                                                     DisplayChangeListener *dcl)
 228 {
 229     QLIST_REMOVE(dcl, next);
 230     gui_setup_refresh(ds);
 231 }
 232
 233 static inline void dpy_gfx_update(DisplayState *s, int x, int y, int w, int h)
 234 {
 235     struct DisplayChangeListener *dcl;
 236     QLIST_FOREACH(dcl, &s->listeners, next) {
 237         if (dcl->dpy_gfx_update) {
 238             dcl->dpy_gfx_update(s, x, y, w, h);
 239         }
 240     }
 241 }
 242
 243 static inline void dpy_gfx_resize(DisplayState *s)
 244 {
 245     struct DisplayChangeListener *dcl;
 246     QLIST_FOREACH(dcl, &s->listeners, next) {
 247         if (dcl->dpy_gfx_resize) {
 248             dcl->dpy_gfx_resize(s);
 249         }
 250     }
 251 }
 252
 253 static inline void dpy_gfx_setdata(DisplayState *s)
 254 {
 255     struct DisplayChangeListener *dcl;
 256     QLIST_FOREACH(dcl, &s->listeners, next) {
 257         if (dcl->dpy_gfx_setdata) {
 258             dcl->dpy_gfx_setdata(s);
 259         }
 260     }
 261 }
 262
 263 static inline void dpy_refresh(DisplayState *s)
 264 {
 265     struct DisplayChangeListener *dcl;
 266     QLIST_FOREACH(dcl, &s->listeners, next) {
 267         if (dcl->dpy_refresh) {
 268             dcl->dpy_refresh(s);
 269         }
 270     }
 271 }
 272
 273 static inline void dpy_gfx_copy(struct DisplayState *s, int src_x, int src_y,
 274                              int dst_x, int dst_y, int w, int h)
 275 {
 276     struct DisplayChangeListener *dcl;
 277     QLIST_FOREACH(dcl, &s->listeners, next) {
 278         if (dcl->dpy_gfx_copy) {
 279             dcl->dpy_gfx_copy(s, src_x, src_y, dst_x, dst_y, w, h);
 280         } else { /* TODO */
 281             dcl->dpy_gfx_update(s, dst_x, dst_y, w, h);
 282         }
 283     }
 284 }
 285
 286 static inline void dpy_text_cursor(struct DisplayState *s, int x, int y)
 287 {
 288     struct DisplayChangeListener *dcl;
 289     QLIST_FOREACH(dcl, &s->listeners, next) {
 290         if (dcl->dpy_text_cursor) {
 291             dcl->dpy_text_cursor(s, x, y);
 292         }
 293     }
 294 }
 295
 296 static inline void dpy_text_update(DisplayState *s, int x, int y, int w, int h)
 297 {
 298     struct DisplayChangeListener *dcl;
 299     QLIST_FOREACH(dcl, &s->listeners, next) {
 300         if (dcl->dpy_text_update) {
 301             dcl->dpy_text_update(s, x, y, w, h);
 302         }
 303     }
 304 }
 305
 306 static inline void dpy_text_resize(DisplayState *s, int w, int h)
 307 {
 308     struct DisplayChangeListener *dcl;
 309     QLIST_FOREACH(dcl, &s->listeners, next) {
 310         if (dcl->dpy_text_resize) {
 311             dcl->dpy_text_resize(s, w, h);
 312         }
 313     }
 314 }
 315
 316 static inline void dpy_mouse_set(struct DisplayState *s, int x, int y, int on)
 317 {
 318     struct DisplayChangeListener *dcl;
 319     QLIST_FOREACH(dcl, &s->listeners, next) {
 320         if (dcl->dpy_mouse_set) {
 321             dcl->dpy_mouse_set(s, x, y, on);
 322         }
 323     }
 324 }
 325
 326 static inline void dpy_cursor_define(struct DisplayState *s, QEMUCursor *cursor)
 327 {
 328     struct DisplayChangeListener *dcl;
 329     QLIST_FOREACH(dcl, &s->listeners, next) {
 330         if (dcl->dpy_cursor_define) {
 331             dcl->dpy_cursor_define(s, cursor);
 332         }
 333     }
 334 }
 335
 336 static inline bool dpy_cursor_define_supported(struct DisplayState *s)
 337 {
 338     struct DisplayChangeListener *dcl;
 339     QLIST_FOREACH(dcl, &s->listeners, next) {
 340         if (dcl->dpy_cursor_define) {
 341             return true;
 342         }
 343     }
 344     return false;
 345 }
 346
 347 static inline int ds_get_linesize(DisplayState *ds)
 348 {
 349     return ds->surface->linesize;
 350 }
 351
 352 static inline uint8_t* ds_get_data(DisplayState *ds)
 353 {
 354     return ds->surface->data;
 355 }
 356
 357 static inline int ds_get_width(DisplayState *ds)
 358 {
 359     return ds->surface->width;
 360 }
 361
 362 static inline int ds_get_height(DisplayState *ds)
 363 {
 364     return ds->surface->height;
 365 }
 366
 367 static inline int ds_get_bits_per_pixel(DisplayState *ds)
 368 {
 369     return ds->surface->pf.bits_per_pixel;
 370 }
 371
 372 static inline int ds_get_bytes_per_pixel(DisplayState *ds)
 373 {
 374     return ds->surface->pf.bytes_per_pixel;
 375 }
 376
 377 #ifdef CONFIG_CURSES
 378 #include <curses.h>
 379 typedef chtype console_ch_t;
 380 #else
 381 typedef unsigned long console_ch_t;
 382 #endif
 383 static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
 384 {
 385     if (!(ch & 0xff))
 386         ch |= ' ';
 387     *dest = ch;
 388 }
 389
 390 typedef void (*vga_hw_update_ptr)(void *);
 391 typedef void (*vga_hw_invalidate_ptr)(void *);
 392 typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch,
 393                                        Error **errp);
 394 typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
 395
 396 DisplayState *graphic_console_init(vga_hw_update_ptr update,
 397                                    vga_hw_invalidate_ptr invalidate,
 398                                    vga_hw_screen_dump_ptr screen_dump,
 399                                    vga_hw_text_update_ptr text_update,
 400                                    void *opaque);
 401
 402 void vga_hw_update(void);
 403 void vga_hw_invalidate(void);
 404 void vga_hw_text_update(console_ch_t *chardata);
 405
 406 int is_graphic_console(void);
 407 int is_fixedsize_console(void);
 408 CharDriverState *text_console_init(QemuOpts *opts);
 409 void text_consoles_set_display(DisplayState *ds);
 410 void console_select(unsigned int index);
 411 void console_color_init(DisplayState *ds);
 412 void qemu_console_resize(DisplayState *ds, int width, int height);
 413 void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
 414                        int dst_x, int dst_y, int w, int h);
 415
 416 /* sdl.c */
 417 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
 418
 419 /* cocoa.m */
 420 void cocoa_display_init(DisplayState *ds, int full_screen);
 421
 422 /* vnc.c */
 423 void vnc_display_init(DisplayState *ds);
 424 void vnc_display_close(DisplayState *ds);
 425 void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
 426 void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
 427 int vnc_display_disable_login(DisplayState *ds);
 428 char *vnc_display_local_addr(DisplayState *ds);
 429 #ifdef CONFIG_VNC
 430 int vnc_display_password(DisplayState *ds, const char *password);
 431 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
 432 #else
 433 static inline int vnc_display_password(DisplayState *ds, const char *password)
 434 {
 435     return -ENODEV;
 436 }
 437 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
 438 {
 439     return -ENODEV;
 440 };
 441 #endif
 442
 443 /* curses.c */
 444 void curses_display_init(DisplayState *ds, int full_screen);
 445
 446 /* input.c */
 447 int index_from_key(const char *key);
 448 int index_from_keycode(int code);
 449
 450 #endif