[qemu.git] / include / ui / console.h

#ifndef CONSOLE_H
#define CONSOLE_H

#include "ui/qemu-pixman.h"
#include "qom/object.h"
#include "qemu/notify.h"
#include "qemu/error-report.h"
#include "qapi/qapi-types-ui.h"

#ifdef CONFIG_OPENGL
# include <epoxy/gl.h>
# include "ui/shader.h"
#endif

/* keyboard/mouse support */

#define MOUSE_EVENT_LBUTTON 0x01
#define MOUSE_EVENT_RBUTTON 0x02
#define MOUSE_EVENT_MBUTTON 0x04
#define MOUSE_EVENT_WHEELUP 0x08
#define MOUSE_EVENT_WHEELDN 0x10

/* 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)

/* in ms */
#define GUI_REFRESH_INTERVAL_DEFAULT    30
#define GUI_REFRESH_INTERVAL_IDLE     3000

/* Color number is match to standard vga palette */
enum qemu_color_names {
    QEMU_COLOR_BLACK   = 0,
    QEMU_COLOR_BLUE    = 1,
    QEMU_COLOR_GREEN   = 2,
    QEMU_COLOR_CYAN    = 3,
    QEMU_COLOR_RED     = 4,
    QEMU_COLOR_MAGENTA = 5,
    QEMU_COLOR_YELLOW  = 6,
    QEMU_COLOR_WHITE   = 7
};
/* Convert to curses char attributes */
#define ATTR2CHTYPE(c, fg, bg, bold) \
    ((bold) << 21 | (bg) << 11 | (fg) << 8 | (c))

typedef void QEMUPutKBDEvent(void *opaque, int keycode);
typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);

typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;

QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
                                            void *opaque);
QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
                                                void *opaque, int absolute,
                                                const char *name);
void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);

QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);

void kbd_put_ledstate(int ledstate);

typedef struct MouseTransformInfo {
    /* Touchscreen resolution */
    int x;
    int y;
    /* Calibration values as used/generated by tslib */
    int a[7];
} MouseTransformInfo;

void hmp_mouse_set(Monitor *mon, const QDict *qdict);

/* 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_console(QemuConsole *s, int keysym);
bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
void kbd_put_string_console(QemuConsole *s, const char *str, int len);
void kbd_put_keysym(int keysym);

/* consoles */

#define TYPE_QEMU_CONSOLE "qemu-console"
#define QEMU_CONSOLE(obj) \
    OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_GET_CLASS(obj) \
    OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
#define QEMU_CONSOLE_CLASS(klass) \
    OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)

typedef struct QemuConsoleClass QemuConsoleClass;

struct QemuConsoleClass {
    ObjectClass parent_class;
};

#define QEMU_ALLOCATED_FLAG     0x01

typedef struct DisplaySurface {
    pixman_format_code_t format;
    pixman_image_t *image;
    uint8_t flags;
#ifdef CONFIG_OPENGL
    GLenum glformat;
    GLenum gltype;
    GLuint texture;
#endif
} DisplaySurface;

typedef struct QemuUIInfo {
    /* geometry */
    int       xoff;
    int       yoff;
    uint32_t  width;
    uint32_t  height;
} QemuUIInfo;

/* 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);

typedef void *QEMUGLContext;
typedef struct QEMUGLParams QEMUGLParams;

struct QEMUGLParams {
    int major_ver;
    int minor_ver;
};

typedef struct QemuDmaBuf {
    int       fd;
    uint32_t  width;
    uint32_t  height;
    uint32_t  stride;
    uint32_t  fourcc;
    uint32_t  texture;
    bool      y0_top;
} QemuDmaBuf;

typedef struct DisplayState DisplayState;

typedef struct DisplayChangeListenerOps {
    const char *dpy_name;

    void (*dpy_refresh)(DisplayChangeListener *dcl);

    void (*dpy_gfx_update)(DisplayChangeListener *dcl,
                           int x, int y, int w, int h);
    void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
                           struct DisplaySurface *new_surface);
    bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl,
                                 pixman_format_code_t format);

    void (*dpy_text_cursor)(DisplayChangeListener *dcl,
                            int x, int y);
    void (*dpy_text_resize)(DisplayChangeListener *dcl,
                            int w, int h);
    void (*dpy_text_update)(DisplayChangeListener *dcl,
                            int x, int y, int w, int h);

    void (*dpy_mouse_set)(DisplayChangeListener *dcl,
                          int x, int y, int on);
    void (*dpy_cursor_define)(DisplayChangeListener *dcl,
                              QEMUCursor *cursor);

    QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl,
                                       QEMUGLParams *params);
    void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl,
                               QEMUGLContext ctx);
    int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl,
                                   QEMUGLContext ctx);
    QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl);

    void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl);
    void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl,
                                   uint32_t backing_id,
                                   bool backing_y_0_top,
                                   uint32_t backing_width,
                                   uint32_t backing_height,
                                   uint32_t x, uint32_t y,
                                   uint32_t w, uint32_t h);
    void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl,
                                  QemuDmaBuf *dmabuf);
    void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl,
                                 QemuDmaBuf *dmabuf, bool have_hot,
                                 uint32_t hot_x, uint32_t hot_y);
    void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl,
                                   uint32_t pos_x, uint32_t pos_y);
    void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl,
                                  QemuDmaBuf *dmabuf);
    void (*dpy_gl_update)(DisplayChangeListener *dcl,
                          uint32_t x, uint32_t y, uint32_t w, uint32_t h);

} DisplayChangeListenerOps;

struct DisplayChangeListener {
    uint64_t update_interval;
    const DisplayChangeListenerOps *ops;
    DisplayState *ds;
    QemuConsole *con;

    QLIST_ENTRY(DisplayChangeListener) next;
};

DisplayState *init_displaystate(void);
DisplaySurface *qemu_create_displaysurface_from(int width, int height,
                                                pixman_format_code_t format,
                                                int linesize, uint8_t *data);
DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image);
DisplaySurface *qemu_create_message_surface(int w, int h,
                                            const char *msg);
PixelFormat qemu_default_pixelformat(int bpp);

DisplaySurface *qemu_create_displaysurface(int width, int height);
void qemu_free_displaysurface(DisplaySurface *surface);

static inline int is_surface_bgr(DisplaySurface *surface)
{
    if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
        PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
        return 1;
    } else {
        return 0;
    }
}

static inline int is_buffer_shared(DisplaySurface *surface)
{
    return !(surface->flags & QEMU_ALLOCATED_FLAG);
}

void register_displaychangelistener(DisplayChangeListener *dcl);
void update_displaychangelistener(DisplayChangeListener *dcl,
                                  uint64_t interval);
void unregister_displaychangelistener(DisplayChangeListener *dcl);

bool dpy_ui_info_supported(QemuConsole *con);
int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);

void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_gfx_update_full(QemuConsole *con);
void dpy_gfx_replace_surface(QemuConsole *con,
                             DisplaySurface *surface);
void dpy_text_cursor(QemuConsole *con, int x, int y);
void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
void dpy_text_resize(QemuConsole *con, int w, int h);
void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
bool dpy_cursor_define_supported(QemuConsole *con);
bool dpy_gfx_check_format(QemuConsole *con,
                          pixman_format_code_t format);

void dpy_gl_scanout_disable(QemuConsole *con);
void dpy_gl_scanout_texture(QemuConsole *con,
                            uint32_t backing_id, bool backing_y_0_top,
                            uint32_t backing_width, uint32_t backing_height,
                            uint32_t x, uint32_t y, uint32_t w, uint32_t h);
void dpy_gl_scanout_dmabuf(QemuConsole *con,
                           QemuDmaBuf *dmabuf);
void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
                          bool have_hot, uint32_t hot_x, uint32_t hot_y);
void dpy_gl_cursor_position(QemuConsole *con,
                            uint32_t pos_x, uint32_t pos_y);
void dpy_gl_release_dmabuf(QemuConsole *con,
                           QemuDmaBuf *dmabuf);
void dpy_gl_update(QemuConsole *con,
                   uint32_t x, uint32_t y, uint32_t w, uint32_t h);

QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
                                QEMUGLParams *params);
void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);

bool console_has_gl(QemuConsole *con);
bool console_has_gl_dmabuf(QemuConsole *con);

static inline int surface_stride(DisplaySurface *s)
{
    return pixman_image_get_stride(s->image);
}

static inline void *surface_data(DisplaySurface *s)
{
    return pixman_image_get_data(s->image);
}

static inline int surface_width(DisplaySurface *s)
{
    return pixman_image_get_width(s->image);
}

static inline int surface_height(DisplaySurface *s)
{
    return pixman_image_get_height(s->image);
}

static inline int surface_bits_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return bits;
}

static inline int surface_bytes_per_pixel(DisplaySurface *s)
{
    int bits = PIXMAN_FORMAT_BPP(s->format);
    return DIV_ROUND_UP(bits, 8);
}

static inline pixman_format_code_t surface_format(DisplaySurface *s)
{
    return s->format;
}

typedef uint32_t console_ch_t;

static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
{
    *dest = ch;
}

typedef struct GraphicHwOps {
    void (*invalidate)(void *opaque);
    void (*gfx_update)(void *opaque);
    void (*text_update)(void *opaque, console_ch_t *text);
    void (*update_interval)(void *opaque, uint64_t interval);
    int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
    void (*gl_block)(void *opaque, bool block);
} GraphicHwOps;

QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
                                  const GraphicHwOps *ops,
                                  void *opaque);
void graphic_console_set_hwops(QemuConsole *con,
                               const GraphicHwOps *hw_ops,
                               void *opaque);
void graphic_console_close(QemuConsole *con);

void graphic_hw_update(QemuConsole *con);
void graphic_hw_invalidate(QemuConsole *con);
void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
void graphic_hw_gl_block(QemuConsole *con, bool block);

void qemu_console_early_init(void);

QemuConsole *qemu_console_lookup_by_index(unsigned int index);
QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
                                                uint32_t head, Error **errp);
QemuConsole *qemu_console_lookup_unused(void);
bool qemu_console_is_visible(QemuConsole *con);
bool qemu_console_is_graphic(QemuConsole *con);
bool qemu_console_is_fixedsize(QemuConsole *con);
bool qemu_console_is_gl_blocked(QemuConsole *con);
char *qemu_console_get_label(QemuConsole *con);
int qemu_console_get_index(QemuConsole *con);
uint32_t qemu_console_get_head(QemuConsole *con);
QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
int qemu_console_get_width(QemuConsole *con, int fallback);
int qemu_console_get_height(QemuConsole *con, int fallback);
/* Return the low-level window id for the console */
int qemu_console_get_window_id(QemuConsole *con);
/* Set the low-level window id for the console */
void qemu_console_set_window_id(QemuConsole *con, int window_id);

void console_select(unsigned int index);
void qemu_console_resize(QemuConsole *con, int width, int height);
DisplaySurface *qemu_console_surface(QemuConsole *con);

/* console-gl.c */
#ifdef CONFIG_OPENGL
bool console_gl_check_format(DisplayChangeListener *dcl,
                             pixman_format_code_t format);
void surface_gl_create_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_update_texture(QemuGLShader *gls,
                               DisplaySurface *surface,
                               int x, int y, int w, int h);
void surface_gl_render_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_destroy_texture(QemuGLShader *gls,
                               DisplaySurface *surface);
void surface_gl_setup_viewport(QemuGLShader *gls,
                               DisplaySurface *surface,
                               int ww, int wh);
#endif

typedef struct QemuDisplay QemuDisplay;

struct QemuDisplay {
    DisplayType type;
    void (*early_init)(DisplayOptions *opts);
    void (*init)(DisplayState *ds, DisplayOptions *opts);
};

void qemu_display_register(QemuDisplay *ui);
bool qemu_display_find_default(DisplayOptions *opts);
void qemu_display_early_init(DisplayOptions *opts);
void qemu_display_init(DisplayState *ds, DisplayOptions *opts);

/* vnc.c */
void vnc_display_init(const char *id, Error **errp);
void vnc_display_open(const char *id, Error **errp);
void vnc_display_add_client(const char *id, int csock, bool skipauth);
int vnc_display_password(const char *id, const char *password);
int vnc_display_pw_expire(const char *id, time_t expires);
QemuOpts *vnc_parse(const char *str, Error **errp);
int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp);

/* input.c */
int index_from_key(const char *key, size_t key_length);

#endif
Commit	Line	Data
87ecb68b PB	1	#ifndef CONSOLE_H
	2	#define CONSOLE_H
	3
28ecbaee	4	#include "ui/qemu-pixman.h"
95be0669	5	#include "qom/object.h"
1de7afc9	6	#include "qemu/notify.h"
f8c75b24	7	#include "qemu/error-report.h"
9af23989	8	#include "qapi/qapi-types-ui.h"
87ecb68b	9
cd2bc889	10	#ifdef CONFIG_OPENGL
dcf30025	11	# include <epoxy/gl.h>
46e19e14	12	# include "ui/shader.h"
cd2bc889 GH	13	#endif
cd2bc889 GH	14
87ecb68b PB	15	/* keyboard/mouse support */
	16
	17	#define MOUSE_EVENT_LBUTTON 0x01
	18	#define MOUSE_EVENT_RBUTTON 0x02
	19	#define MOUSE_EVENT_MBUTTON 0x04
21bae11a GH	20	#define MOUSE_EVENT_WHEELUP 0x08
21bae11a GH	21	#define MOUSE_EVENT_WHEELDN 0x10
87ecb68b	22
03a23a85 GH	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
7ed9eba3	28	/* in ms */
0f7b2864 GH	29	#define GUI_REFRESH_INTERVAL_DEFAULT 30
0f7b2864 GH	30	#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3	31
4083733d OH	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
87ecb68b	47	typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85	48	typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b PB	49	typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
87ecb68b PB	50
72711efb	51	typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
5a37532d	52	typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
72711efb	53	typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
03a23a85	54
5a37532d GH	55	QEMUPutKbdEntry qemu_add_kbd_event_handler(QEMUPutKBDEvent func,
5a37532d GH	56	void *opaque);
87ecb68b PB	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);
6fef28ee AL	61	void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee AL	62
03a23a85 GH	63	QEMUPutLEDEntry qemu_add_led_event_handler(QEMUPutLEDEvent func, void *opaque);
03a23a85 GH	64	void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b	65
03a23a85	66	void kbd_put_ledstate(int ledstate);
eb2e259d	67
5a4c2e59	68	typedef struct MouseTransformInfo {
a5d7eb65 AZ	69	/* Touchscreen resolution */
	70	int x;
	71	int y;
	72	/* Calibration values as used/generated by tslib */
	73	int a[7];
5a4c2e59	74	} MouseTransformInfo;
a5d7eb65	75
3e5a50d6	76	void hmp_mouse_set(Monitor mon, const QDict qdict);
87ecb68b PB	77
	78	/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
	79	constants) */
	80	#define QEMU_KEY_ESC1(c) ((c) \| 0xe100)
	81	#define QEMU_KEY_BACKSPACE 0x007f
	82	#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
	83	#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
	84	#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
	85	#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
	86	#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
	87	#define QEMU_KEY_END QEMU_KEY_ESC1(4)
	88	#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
	89	#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
	90	#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
	91
	92	#define QEMU_KEY_CTRL_UP 0xe400
	93	#define QEMU_KEY_CTRL_DOWN 0xe401
	94	#define QEMU_KEY_CTRL_LEFT 0xe402
	95	#define QEMU_KEY_CTRL_RIGHT 0xe403
	96	#define QEMU_KEY_CTRL_HOME 0xe404
	97	#define QEMU_KEY_CTRL_END 0xe405
	98	#define QEMU_KEY_CTRL_PAGEUP 0xe406
	99	#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
	100
3f9a6e85	101	void kbd_put_keysym_console(QemuConsole *s, int keysym);
da024b1e	102	bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl);
bdef9724	103	void kbd_put_string_console(QemuConsole s, const char str, int len);
87ecb68b PB	104	void kbd_put_keysym(int keysym);
	105
	106	/* consoles */
	107
95be0669 GH	108	#define TYPE_QEMU_CONSOLE "qemu-console"
	109	#define QEMU_CONSOLE(obj) \
	110	OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
	111	#define QEMU_CONSOLE_GET_CLASS(obj) \
	112	OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
	113	#define QEMU_CONSOLE_CLASS(klass) \
	114	OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
	115
	116	typedef struct QemuConsoleClass QemuConsoleClass;
	117
	118	struct QemuConsoleClass {
	119	ObjectClass parent_class;
	120	};
	121
77bfcf28	122	#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8	123
7536587c	124	typedef struct DisplaySurface {
69c77777 GH	125	pixman_format_code_t format;
69c77777 GH	126	pixman_image_t *image;
7d957bd8	127	uint8_t flags;
cd2bc889 GH	128	#ifdef CONFIG_OPENGL
	129	GLenum glformat;
	130	GLenum gltype;
	131	GLuint texture;
	132	#endif
7536587c	133	} DisplaySurface;
7d957bd8	134
6f90f3d7 GH	135	typedef struct QemuUIInfo {
	136	/* geometry */
	137	int xoff;
	138	int yoff;
	139	uint32_t width;
	140	uint32_t height;
	141	} QemuUIInfo;
	142
254e5950 GH	143	/* cursor data format is 32bit RGBA */
	144	typedef struct QEMUCursor {
	145	int width, height;
	146	int hot_x, hot_y;
	147	int refcount;
	148	uint32_t data[];
	149	} QEMUCursor;
	150
	151	QEMUCursor *cursor_alloc(int width, int height);
	152	void cursor_get(QEMUCursor *c);
	153	void cursor_put(QEMUCursor *c);
	154	QEMUCursor *cursor_builtin_hidden(void);
	155	QEMUCursor *cursor_builtin_left_ptr(void);
	156	void cursor_print_ascii_art(QEMUCursor c, const char prefix);
	157	int cursor_get_mono_bpl(QEMUCursor *c);
	158	void cursor_set_mono(QEMUCursor *c,
	159	uint32_t foreground, uint32_t background, uint8_t *image,
	160	int transparent, uint8_t *mask);
	161	void cursor_get_mono_image(QEMUCursor c, int foreground, uint8_t mask);
	162	void cursor_get_mono_mask(QEMUCursor c, int transparent, uint8_t mask);
	163
06020b95 GH	164	typedef void *QEMUGLContext;
	165	typedef struct QEMUGLParams QEMUGLParams;
	166
	167	struct QEMUGLParams {
	168	int major_ver;
	169	int minor_ver;
	170	};
	171
dfbb251e	172	typedef struct QemuDmaBuf {
4133fa71 GH	173	int fd;
	174	uint32_t width;
	175	uint32_t height;
	176	uint32_t stride;
	177	uint32_t fourcc;
	178	uint32_t texture;
242d0133	179	bool y0_top;
dfbb251e	180	} QemuDmaBuf;
4133fa71	181
7536587c PMD	182	typedef struct DisplayState DisplayState;
7536587c PMD	183
7c20b4a3 GH	184	typedef struct DisplayChangeListenerOps {
	185	const char *dpy_name;
	186
bc2ed970	187	void (dpy_refresh)(DisplayChangeListener dcl);
7c20b4a3 GH	188
7c20b4a3 GH	189	void (dpy_gfx_update)(DisplayChangeListener dcl,
7c20b4a3	190	int x, int y, int w, int h);
c12aeb86	191	void (dpy_gfx_switch)(DisplayChangeListener dcl,
c12aeb86	192	struct DisplaySurface *new_surface);
49743df3 BH	193	bool (dpy_gfx_check_format)(DisplayChangeListener dcl,
49743df3 BH	194	pixman_format_code_t format);
a93a4a22	195
7c20b4a3	196	void (dpy_text_cursor)(DisplayChangeListener dcl,
7c20b4a3 GH	197	int x, int y);
7c20b4a3 GH	198	void (dpy_text_resize)(DisplayChangeListener dcl,
7c20b4a3 GH	199	int w, int h);
7c20b4a3 GH	200	void (dpy_text_update)(DisplayChangeListener dcl,
7c20b4a3 GH	201	int x, int y, int w, int h);
	202
	203	void (dpy_mouse_set)(DisplayChangeListener dcl,
7c20b4a3 GH	204	int x, int y, int on);
7c20b4a3 GH	205	void (dpy_cursor_define)(DisplayChangeListener dcl,
7c20b4a3	206	QEMUCursor *cursor);
06020b95 GH	207
	208	QEMUGLContext (dpy_gl_ctx_create)(DisplayChangeListener dcl,
	209	QEMUGLParams *params);
	210	void (dpy_gl_ctx_destroy)(DisplayChangeListener dcl,
	211	QEMUGLContext ctx);
	212	int (dpy_gl_ctx_make_current)(DisplayChangeListener dcl,
	213	QEMUGLContext ctx);
	214	QEMUGLContext (dpy_gl_ctx_get_current)(DisplayChangeListener dcl);
	215
eaa92c76	216	void (dpy_gl_scanout_disable)(DisplayChangeListener dcl);
f4c36bda GH	217	void (dpy_gl_scanout_texture)(DisplayChangeListener dcl,
	218	uint32_t backing_id,
	219	bool backing_y_0_top,
	220	uint32_t backing_width,
	221	uint32_t backing_height,
	222	uint32_t x, uint32_t y,
	223	uint32_t w, uint32_t h);
4133fa71 GH	224	void (dpy_gl_scanout_dmabuf)(DisplayChangeListener dcl,
	225	QemuDmaBuf *dmabuf);
	226	void (dpy_gl_cursor_dmabuf)(DisplayChangeListener dcl,
6e1f2cb5 GH	227	QemuDmaBuf *dmabuf, bool have_hot,
	228	uint32_t hot_x, uint32_t hot_y);
	229	void (dpy_gl_cursor_position)(DisplayChangeListener dcl,
	230	uint32_t pos_x, uint32_t pos_y);
4133fa71 GH	231	void (dpy_gl_release_dmabuf)(DisplayChangeListener dcl,
4133fa71 GH	232	QemuDmaBuf *dmabuf);
06020b95 GH	233	void (dpy_gl_update)(DisplayChangeListener dcl,
	234	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	235
7c20b4a3	236	} DisplayChangeListenerOps;
7d957bd8	237
7c20b4a3	238	struct DisplayChangeListener {
0f7b2864	239	uint64_t update_interval;
7c20b4a3 GH	240	const DisplayChangeListenerOps *ops;
7c20b4a3 GH	241	DisplayState *ds;
284d1c6b	242	QemuConsole *con;
bf2fde70	243
87e487a1	244	QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8 AL	245	};
7d957bd8 AL	246
64840c66	247	DisplayState *init_displaystate(void);
30f1e661 GH	248	DisplaySurface *qemu_create_displaysurface_from(int width, int height,
	249	pixman_format_code_t format,
	250	int linesize, uint8_t *data);
ca58b45f	251	DisplaySurface qemu_create_displaysurface_pixman(pixman_image_t image);
2e5567c9 GH	252	DisplaySurface *qemu_create_message_surface(int w, int h,
2e5567c9 GH	253	const char *msg);
0da2ea1b	254	PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8	255
da229ef3 GH	256	DisplaySurface *qemu_create_displaysurface(int width, int height);
da229ef3 GH	257	void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da AL	258
	259	static inline int is_surface_bgr(DisplaySurface *surface)
	260	{
30f1e661 GH	261	if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
30f1e661 GH	262	PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da	263	return 1;
30f1e661	264	} else {
7b5d76da	265	return 0;
30f1e661	266	}
7b5d76da AL	267	}
7b5d76da AL	268
7d957bd8 AL	269	static inline int is_buffer_shared(DisplaySurface *surface)
7d957bd8 AL	270	{
187cd1d9	271	return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8 AL	272	}
7d957bd8 AL	273
5209089f	274	void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864 GH	275	void update_displaychangelistener(DisplayChangeListener *dcl,
0f7b2864 GH	276	uint64_t interval);
7c20b4a3 GH	277	void unregister_displaychangelistener(DisplayChangeListener *dcl);
7c20b4a3 GH	278
b7fb49f0	279	bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7 GH	280	int dpy_set_ui_info(QemuConsole con, QemuUIInfo info);
6f90f3d7 GH	281
c78f7137	282	void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
7cd0afe6	283	void dpy_gfx_update_full(QemuConsole *con);
c78f7137	284	void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3	285	DisplaySurface *surface);
c78f7137 GH	286	void dpy_text_cursor(QemuConsole *con, int x, int y);
	287	void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
	288	void dpy_text_resize(QemuConsole *con, int w, int h);
	289	void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
	290	void dpy_cursor_define(QemuConsole con, QEMUCursor cursor);
	291	bool dpy_cursor_define_supported(QemuConsole *con);
49743df3 BH	292	bool dpy_gfx_check_format(QemuConsole *con,
49743df3 BH	293	pixman_format_code_t format);
bf2fde70	294
eaa92c76	295	void dpy_gl_scanout_disable(QemuConsole *con);
f4c36bda GH	296	void dpy_gl_scanout_texture(QemuConsole *con,
	297	uint32_t backing_id, bool backing_y_0_top,
	298	uint32_t backing_width, uint32_t backing_height,
	299	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
4133fa71 GH	300	void dpy_gl_scanout_dmabuf(QemuConsole *con,
4133fa71 GH	301	QemuDmaBuf *dmabuf);
6e1f2cb5 GH	302	void dpy_gl_cursor_dmabuf(QemuConsole con, QemuDmaBuf dmabuf,
	303	bool have_hot, uint32_t hot_x, uint32_t hot_y);
	304	void dpy_gl_cursor_position(QemuConsole *con,
	305	uint32_t pos_x, uint32_t pos_y);
4133fa71 GH	306	void dpy_gl_release_dmabuf(QemuConsole *con,
4133fa71 GH	307	QemuDmaBuf *dmabuf);
06020b95 GH	308	void dpy_gl_update(QemuConsole *con,
	309	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	310
	311	QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
	312	QEMUGLParams *params);
	313	void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
	314	int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
	315	QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
	316
	317	bool console_has_gl(QemuConsole *con);
4133fa71	318	bool console_has_gl_dmabuf(QemuConsole *con);
06020b95	319
626e3b34 GH	320	static inline int surface_stride(DisplaySurface *s)
	321	{
	322	return pixman_image_get_stride(s->image);
	323	}
	324
	325	static inline void surface_data(DisplaySurface s)
	326	{
	327	return pixman_image_get_data(s->image);
	328	}
	329
	330	static inline int surface_width(DisplaySurface *s)
	331	{
	332	return pixman_image_get_width(s->image);
	333	}
	334
	335	static inline int surface_height(DisplaySurface *s)
	336	{
	337	return pixman_image_get_height(s->image);
	338	}
	339
	340	static inline int surface_bits_per_pixel(DisplaySurface *s)
	341	{
	342	int bits = PIXMAN_FORMAT_BPP(s->format);
	343	return bits;
	344	}
	345
	346	static inline int surface_bytes_per_pixel(DisplaySurface *s)
	347	{
	348	int bits = PIXMAN_FORMAT_BPP(s->format);
d1a0945f	349	return DIV_ROUND_UP(bits, 8);
626e3b34 GH	350	}
626e3b34 GH	351
e444ea34 HR	352	static inline pixman_format_code_t surface_format(DisplaySurface *s)
	353	{
	354	return s->format;
	355	}
	356
e2f82e92 GH	357	typedef uint32_t console_ch_t;
e2f82e92 GH	358
c227f099	359	static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e	360	{
9ae19b65	361	*dest = ch;
4d3b6f6e AZ	362	}
4d3b6f6e AZ	363
380cd056 GH	364	typedef struct GraphicHwOps {
	365	void (invalidate)(void opaque);
	366	void (gfx_update)(void opaque);
	367	void (text_update)(void opaque, console_ch_t *text);
dea1b0bd	368	void (update_interval)(void opaque, uint64_t interval);
6f90f3d7	369	int (ui_info)(void opaque, uint32_t head, QemuUIInfo *info);
bba19b88	370	void (gl_block)(void opaque, bool block);
380cd056	371	} GraphicHwOps;
87ecb68b	372
5643706a	373	QemuConsole graphic_console_init(DeviceState dev, uint32_t head,
aa2beaa1	374	const GraphicHwOps *ops,
c78f7137	375	void *opaque);
1c1f9498 GH	376	void graphic_console_set_hwops(QemuConsole *con,
	377	const GraphicHwOps *hw_ops,
	378	void *opaque);
9588d67e	379	void graphic_console_close(QemuConsole *con);
3023f332	380
1dbfa005 GH	381	void graphic_hw_update(QemuConsole *con);
	382	void graphic_hw_invalidate(QemuConsole *con);
	383	void graphic_hw_text_update(QemuConsole con, console_ch_t chardata);
bba19b88	384	void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b	385
777357d7 MAL	386	void qemu_console_early_init(void);
777357d7 MAL	387
284d1c6b	388	QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a	389	QemuConsole qemu_console_lookup_by_device(DeviceState dev, uint32_t head);
f2c1d54c GH	390	QemuConsole qemu_console_lookup_by_device_name(const char device_id,
f2c1d54c GH	391	uint32_t head, Error **errp);
9588d67e	392	QemuConsole *qemu_console_lookup_unused(void);
81c0d5a6 GH	393	bool qemu_console_is_visible(QemuConsole *con);
	394	bool qemu_console_is_graphic(QemuConsole *con);
	395	bool qemu_console_is_fixedsize(QemuConsole *con);
f607867c	396	bool qemu_console_is_gl_blocked(QemuConsole *con);
779ce88f	397	char qemu_console_get_label(QemuConsole con);
d4c85337	398	int qemu_console_get_index(QemuConsole *con);
5643706a	399	uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7	400	QemuUIInfo qemu_console_get_ui_info(QemuConsole con);
d4c85337 GH	401	int qemu_console_get_width(QemuConsole *con, int fallback);
d4c85337 GH	402	int qemu_console_get_height(QemuConsole *con, int fallback);
b3cb21b9 ST	403	/* Return the low-level window id for the console */
	404	int qemu_console_get_window_id(QemuConsole *con);
	405	/* Set the low-level window id for the console */
	406	void qemu_console_set_window_id(QemuConsole *con, int window_id);
81c0d5a6	407
87ecb68b	408	void console_select(unsigned int index);
c78f7137	409	void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137	410	DisplaySurface qemu_console_surface(QemuConsole con);
87ecb68b	411
cd2bc889	412	/* console-gl.c */
cd2bc889	413	#ifdef CONFIG_OPENGL
cd2bc889 GH	414	bool console_gl_check_format(DisplayChangeListener *dcl,
cd2bc889 GH	415	pixman_format_code_t format);
46e19e14	416	void surface_gl_create_texture(QemuGLShader *gls,
cd2bc889	417	DisplaySurface *surface);
46e19e14	418	void surface_gl_update_texture(QemuGLShader *gls,
cd2bc889 GH	419	DisplaySurface *surface,
cd2bc889 GH	420	int x, int y, int w, int h);
46e19e14	421	void surface_gl_render_texture(QemuGLShader *gls,
cd2bc889	422	DisplaySurface *surface);
46e19e14	423	void surface_gl_destroy_texture(QemuGLShader *gls,
cd2bc889	424	DisplaySurface *surface);
46e19e14	425	void surface_gl_setup_viewport(QemuGLShader *gls,
cd2bc889 GH	426	DisplaySurface *surface,
	427	int ww, int wh);
	428	#endif
	429
db71589f	430	typedef struct QemuDisplay QemuDisplay;
87ecb68b	431
db71589f GH	432	struct QemuDisplay {
	433	DisplayType type;
	434	void (early_init)(DisplayOptions opts);
	435	void (init)(DisplayState ds, DisplayOptions *opts);
	436	};
	437
	438	void qemu_display_register(QemuDisplay *ui);
898f9d41	439	bool qemu_display_find_default(DisplayOptions *opts);
db71589f GH	440	void qemu_display_early_init(DisplayOptions *opts);
db71589f GH	441	void qemu_display_init(DisplayState ds, DisplayOptions opts);
87ecb68b PB	442
87ecb68b PB	443	/* vnc.c */
ab4f931e	444	void vnc_display_init(const char id, Error *errp);
4db14629	445	void vnc_display_open(const char id, Error *errp);
14f7143e	446	void vnc_display_add_client(const char *id, int csock, bool skipauth);
14f7143e GH	447	int vnc_display_password(const char id, const char password);
14f7143e GH	448	int vnc_display_pw_expire(const char *id, time_t expires);
70b94331	449	QemuOpts vnc_parse(const char str, Error **errp);
28d0de7a	450	int vnc_init_func(void opaque, QemuOpts opts, Error **errp);
87ecb68b	451
1048c88f	452	/* input.c */
64ffbe04	453	int index_from_key(const char *key, size_t key_length);
1048c88f	454
87ecb68b	455	#endif