console.h 12.2 KB
Newer Older
pbrook's avatar
pbrook committed
1 2 3 4
#ifndef CONSOLE_H
#define CONSOLE_H

#include "qemu-char.h"
5
#include "qdict.h"
6
#include "notify.h"
Jes Sorensen's avatar
Jes Sorensen committed
7
#include "monitor.h"
Alon Levy's avatar
Alon Levy committed
8
#include "trace.h"
9
#include "qapi-types.h"
10
#include "error.h"
pbrook's avatar
pbrook committed
11 12 13 14 15 16 17

/* keyboard/mouse support */

#define MOUSE_EVENT_LBUTTON 0x01
#define MOUSE_EVENT_RBUTTON 0x02
#define MOUSE_EVENT_MBUTTON 0x04

Gerd Hoffmann's avatar
Gerd Hoffmann committed
18 19 20 21 22
/* identical to the ps/2 keyboard bits */
#define QEMU_SCROLL_LOCK_LED (1 << 0)
#define QEMU_NUM_LOCK_LED    (1 << 1)
#define QEMU_CAPS_LOCK_LED   (1 << 2)

23 24 25
/* in ms */
#define GUI_REFRESH_INTERVAL 30

pbrook's avatar
pbrook committed
26
typedef void QEMUPutKBDEvent(void *opaque, int keycode);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
27
typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
pbrook's avatar
pbrook committed
28 29 30 31 32 33 34 35
typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);

typedef struct QEMUPutMouseEntry {
    QEMUPutMouseEvent *qemu_put_mouse_event;
    void *qemu_put_mouse_event_opaque;
    int qemu_put_mouse_event_absolute;
    char *qemu_put_mouse_event_name;

36 37
    int index;

pbrook's avatar
pbrook committed
38
    /* used internally by qemu for handling mice */
39
    QTAILQ_ENTRY(QEMUPutMouseEntry) node;
pbrook's avatar
pbrook committed
40 41
} QEMUPutMouseEntry;

Gerd Hoffmann's avatar
Gerd Hoffmann committed
42 43 44 45 46 47
typedef struct QEMUPutLEDEntry {
    QEMUPutLEDEvent *put_led;
    void *opaque;
    QTAILQ_ENTRY(QEMUPutLEDEntry) next;
} QEMUPutLEDEntry;

pbrook's avatar
pbrook committed
48
void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
49
void qemu_remove_kbd_event_handler(void);
pbrook's avatar
pbrook committed
50 51 52 53
QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
                                                void *opaque, int absolute,
                                                const char *name);
void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
54 55
void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);

Gerd Hoffmann's avatar
Gerd Hoffmann committed
56 57
QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
pbrook's avatar
pbrook committed
58 59

void kbd_put_keycode(int keycode);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
60
void kbd_put_ledstate(int ledstate);
pbrook's avatar
pbrook committed
61
void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
62 63

/* Does the current mouse generate absolute events */
pbrook's avatar
pbrook committed
64
int kbd_mouse_is_absolute(void);
65 66
void qemu_add_mouse_mode_change_notifier(Notifier *notify);
void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
pbrook's avatar
pbrook committed
67

68 69 70
/* Of all the mice, is there one that generates absolute events */
int kbd_mouse_has_absolute(void);

Paul Brook's avatar
Paul Brook committed
71
struct MouseTransformInfo {
72 73 74 75 76 77 78
    /* Touchscreen resolution */
    int x;
    int y;
    /* Calibration values as used/generated by tslib */
    int a[7];
};

79
void do_mouse_set(Monitor *mon, const QDict *qdict);
pbrook's avatar
pbrook committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
   constants) */
#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
#define QEMU_KEY_BACKSPACE  0x007f
#define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
#define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
#define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
#define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
#define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
#define QEMU_KEY_END        QEMU_KEY_ESC1(4)
#define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
#define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
#define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)

#define QEMU_KEY_CTRL_UP         0xe400
#define QEMU_KEY_CTRL_DOWN       0xe401
#define QEMU_KEY_CTRL_LEFT       0xe402
#define QEMU_KEY_CTRL_RIGHT      0xe403
#define QEMU_KEY_CTRL_HOME       0xe404
#define QEMU_KEY_CTRL_END        0xe405
#define QEMU_KEY_CTRL_PAGEUP     0xe406
#define QEMU_KEY_CTRL_PAGEDOWN   0xe407

void kbd_put_keysym(int keysym);

/* consoles */

108 109
#define QEMU_BIG_ENDIAN_FLAG    0x01
#define QEMU_ALLOCATED_FLAG     0x02
Stefano Stabellini's avatar
Stefano Stabellini committed
110
#define QEMU_REALPIXELS_FLAG    0x04
111 112 113 114 115 116 117 118

struct PixelFormat {
    uint8_t bits_per_pixel;
    uint8_t bytes_per_pixel;
    uint8_t depth; /* color depth in bits */
    uint32_t rmask, gmask, bmask, amask;
    uint8_t rshift, gshift, bshift, ashift;
    uint8_t rmax, gmax, bmax, amax;
119
    uint8_t rbits, gbits, bbits, abits;
120 121 122 123
};

struct DisplaySurface {
    uint8_t flags;
pbrook's avatar
pbrook committed
124 125
    int width;
    int height;
126 127 128 129 130 131
    int linesize;        /* bytes per line */
    uint8_t *data;

    struct PixelFormat pf;
};

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/* cursor data format is 32bit RGBA */
typedef struct QEMUCursor {
    int                 width, height;
    int                 hot_x, hot_y;
    int                 refcount;
    uint32_t            data[];
} QEMUCursor;

QEMUCursor *cursor_alloc(int width, int height);
void cursor_get(QEMUCursor *c);
void cursor_put(QEMUCursor *c);
QEMUCursor *cursor_builtin_hidden(void);
QEMUCursor *cursor_builtin_left_ptr(void);
void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
int cursor_get_mono_bpl(QEMUCursor *c);
void cursor_set_mono(QEMUCursor *c,
                     uint32_t foreground, uint32_t background, uint8_t *image,
                     int transparent, uint8_t *mask);
void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);

153 154
struct DisplayChangeListener {
    int idle;
aurel32's avatar
aurel32 committed
155
    uint64_t gui_timer_interval;
pbrook's avatar
pbrook committed
156 157

    void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
158 159
    void (*dpy_resize)(struct DisplayState *s);
    void (*dpy_setdata)(struct DisplayState *s);
pbrook's avatar
pbrook committed
160 161 162 163 164
    void (*dpy_refresh)(struct DisplayState *s);
    void (*dpy_copy)(struct DisplayState *s, int src_x, int src_y,
                     int dst_x, int dst_y, int w, int h);
    void (*dpy_fill)(struct DisplayState *s, int x, int y,
                     int w, int h, uint32_t c);
balrog's avatar
balrog committed
165
    void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
166 167 168 169

    struct DisplayChangeListener *next;
};

170 171 172 173 174 175
struct DisplayAllocator {
    DisplaySurface* (*create_displaysurface)(int width, int height);
    DisplaySurface* (*resize_displaysurface)(DisplaySurface *surface, int width, int height);
    void (*free_displaysurface)(DisplaySurface *surface);
};

176 177 178 179 180
struct DisplayState {
    struct DisplaySurface *surface;
    void *opaque;
    struct QEMUTimer *gui_timer;

181
    struct DisplayAllocator* allocator;
182 183
    struct DisplayChangeListener* listeners;

pbrook's avatar
pbrook committed
184
    void (*mouse_set)(int x, int y, int on);
185
    void (*cursor_define)(QEMUCursor *cursor);
186 187

    struct DisplayState *next;
pbrook's avatar
pbrook committed
188 189
};

190 191
void register_displaystate(DisplayState *ds);
DisplayState *get_displaystate(void);
192 193
DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
                                                int linesize, uint8_t *data);
194 195
void qemu_alloc_display(DisplaySurface *surface, int width, int height,
                        int linesize, PixelFormat pf, int newflags);
196 197
PixelFormat qemu_different_endianness_pixelformat(int bpp);
PixelFormat qemu_default_pixelformat(int bpp);
198

199 200 201 202 203 204 205 206 207
DisplayAllocator *register_displayallocator(DisplayState *ds, DisplayAllocator *da);

static inline DisplaySurface* qemu_create_displaysurface(DisplayState *ds, int width, int height)
{
    return ds->allocator->create_displaysurface(width, height);    
}

static inline DisplaySurface* qemu_resize_displaysurface(DisplayState *ds, int width, int height)
{
Alon Levy's avatar
Alon Levy committed
208
    trace_displaysurface_resize(ds, ds->surface, width, height);
209 210 211 212 213
    return ds->allocator->resize_displaysurface(ds->surface, width, height);
}

static inline void qemu_free_displaysurface(DisplayState *ds)
{
Alon Levy's avatar
Alon Levy committed
214
    trace_displaysurface_free(ds, ds->surface);
215 216 217 218 219 220 221 222 223 224 225
    ds->allocator->free_displaysurface(ds->surface);
}

static inline int is_surface_bgr(DisplaySurface *surface)
{
    if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
        return 1;
    else
        return 0;
}

226 227
static inline int is_buffer_shared(DisplaySurface *surface)
{
Stefano Stabellini's avatar
Stefano Stabellini committed
228 229
    return (!(surface->flags & QEMU_ALLOCATED_FLAG) &&
            !(surface->flags & QEMU_REALPIXELS_FLAG));
230 231 232 233 234 235 236 237
}

static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
{
    dcl->next = ds->listeners;
    ds->listeners = dcl;
}

pbrook's avatar
pbrook committed
238 239
static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
{
240 241 242 243 244
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        dcl->dpy_update(s, x, y, w, h);
        dcl = dcl->next;
    }
pbrook's avatar
pbrook committed
245 246
}

247
static inline void dpy_resize(DisplayState *s)
pbrook's avatar
pbrook committed
248
{
249 250 251 252 253
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        dcl->dpy_resize(s);
        dcl = dcl->next;
    }
pbrook's avatar
pbrook committed
254 255
}

256
static inline void dpy_setdata(DisplayState *s)
balrog's avatar
balrog committed
257
{
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        if (dcl->dpy_setdata) dcl->dpy_setdata(s);
        dcl = dcl->next;
    }
}

static inline void dpy_refresh(DisplayState *s)
{
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        if (dcl->dpy_refresh) dcl->dpy_refresh(s);
        dcl = dcl->next;
    }
}

static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
                             int dst_x, int dst_y, int w, int h) {
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        if (dcl->dpy_copy)
            dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
        else /* TODO */
            dcl->dpy_update(s, dst_x, dst_y, w, h);
        dcl = dcl->next;
    }
}

static inline void dpy_fill(struct DisplayState *s, int x, int y,
                             int w, int h, uint32_t c) {
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
        dcl = dcl->next;
    }
}

static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
    struct DisplayChangeListener *dcl = s->listeners;
    while (dcl != NULL) {
        if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
        dcl = dcl->next;
    }
balrog's avatar
balrog committed
301 302
}

303 304
static inline int ds_get_linesize(DisplayState *ds)
{
305
    return ds->surface->linesize;
306 307 308 309
}

static inline uint8_t* ds_get_data(DisplayState *ds)
{
310
    return ds->surface->data;
311 312 313 314
}

static inline int ds_get_width(DisplayState *ds)
{
315
    return ds->surface->width;
316 317 318 319
}

static inline int ds_get_height(DisplayState *ds)
{
320
    return ds->surface->height;
321 322 323 324
}

static inline int ds_get_bits_per_pixel(DisplayState *ds)
{
325
    return ds->surface->pf.bits_per_pixel;
326 327
}

aliguori's avatar
aliguori committed
328 329
static inline int ds_get_bytes_per_pixel(DisplayState *ds)
{
330
    return ds->surface->pf.bytes_per_pixel;
aliguori's avatar
aliguori committed
331 332
}

333 334 335 336
#ifdef CONFIG_CURSES
#include <curses.h>
typedef chtype console_ch_t;
#else
337
typedef unsigned long console_ch_t;
338
#endif
339
static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
balrog's avatar
balrog committed
340
{
341 342
    if (!(ch & 0xff))
        ch |= ' ';
343
    *dest = ch;
balrog's avatar
balrog committed
344 345
}

pbrook's avatar
pbrook committed
346 347
typedef void (*vga_hw_update_ptr)(void *);
typedef void (*vga_hw_invalidate_ptr)(void *);
348 349
typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch,
                                       Error **errp);
350
typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
pbrook's avatar
pbrook committed
351

352 353 354 355 356 357
DisplayState *graphic_console_init(vga_hw_update_ptr update,
                                   vga_hw_invalidate_ptr invalidate,
                                   vga_hw_screen_dump_ptr screen_dump,
                                   vga_hw_text_update_ptr text_update,
                                   void *opaque);

pbrook's avatar
pbrook committed
358 359
void vga_hw_update(void);
void vga_hw_invalidate(void);
360
void vga_hw_text_update(console_ch_t *chardata);
pbrook's avatar
pbrook committed
361 362

int is_graphic_console(void);
363
int is_fixedsize_console(void);
364
CharDriverState *text_console_init(QemuOpts *opts);
365
void text_consoles_set_display(DisplayState *ds);
pbrook's avatar
pbrook committed
366 367
void console_select(unsigned int index);
void console_color_init(DisplayState *ds);
368 369 370
void qemu_console_resize(DisplayState *ds, int width, int height);
void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
                       int dst_x, int dst_y, int w, int h);
pbrook's avatar
pbrook committed
371 372 373 374 375 376 377 378 379 380

/* sdl.c */
void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);

/* cocoa.m */
void cocoa_display_init(DisplayState *ds, int full_screen);

/* vnc.c */
void vnc_display_init(DisplayState *ds);
void vnc_display_close(DisplayState *ds);
381
void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
382
void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
383
int vnc_display_disable_login(DisplayState *ds);
Jes Sorensen's avatar
Jes Sorensen committed
384 385 386
char *vnc_display_local_addr(DisplayState *ds);
#ifdef CONFIG_VNC
int vnc_display_password(DisplayState *ds, const char *password);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
387
int vnc_display_pw_expire(DisplayState *ds, time_t expires);
Jes Sorensen's avatar
Jes Sorensen committed
388 389 390 391 392 393 394 395 396 397
#else
static inline int vnc_display_password(DisplayState *ds, const char *password)
{
    return -ENODEV;
}
static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
{
    return -ENODEV;
};
#endif
pbrook's avatar
pbrook committed
398

balrog's avatar
balrog committed
399 400 401
/* curses.c */
void curses_display_init(DisplayState *ds, int full_screen);

402 403 404 405
/* input.c */
int index_from_key(const char *key);
int index_from_keycode(int code);

pbrook's avatar
pbrook committed
406
#endif