console.h

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