[mirror_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"
typedef struct QemuConsoleClass QemuConsoleClass;
DECLARE_OBJ_CHECKERS(QemuConsole, QemuConsoleClass,
                     QEMU_CONSOLE, TYPE_QEMU_CONSOLE)


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;
    uint64_t  modifier;
    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);
    bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
    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_update_done(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);
void qemu_display_help(void);

/* 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	108	#define TYPE_QEMU_CONSOLE "qemu-console"
db1015e9	109	typedef struct QemuConsoleClass QemuConsoleClass;
8110fa1d EH	110	DECLARE_OBJ_CHECKERS(QemuConsole, QemuConsoleClass,
8110fa1d EH	111	QEMU_CONSOLE, TYPE_QEMU_CONSOLE)
95be0669	112
95be0669 GH	113
	114	struct QemuConsoleClass {
	115	ObjectClass parent_class;
	116	};
	117
77bfcf28	118	#define QEMU_ALLOCATED_FLAG 0x01
7d957bd8	119
7536587c	120	typedef struct DisplaySurface {
69c77777 GH	121	pixman_format_code_t format;
69c77777 GH	122	pixman_image_t *image;
7d957bd8	123	uint8_t flags;
cd2bc889 GH	124	#ifdef CONFIG_OPENGL
	125	GLenum glformat;
	126	GLenum gltype;
	127	GLuint texture;
	128	#endif
7536587c	129	} DisplaySurface;
7d957bd8	130
6f90f3d7 GH	131	typedef struct QemuUIInfo {
	132	/* geometry */
	133	int xoff;
	134	int yoff;
	135	uint32_t width;
	136	uint32_t height;
	137	} QemuUIInfo;
	138
254e5950 GH	139	/* cursor data format is 32bit RGBA */
	140	typedef struct QEMUCursor {
	141	int width, height;
	142	int hot_x, hot_y;
	143	int refcount;
	144	uint32_t data[];
	145	} QEMUCursor;
	146
	147	QEMUCursor *cursor_alloc(int width, int height);
	148	void cursor_get(QEMUCursor *c);
	149	void cursor_put(QEMUCursor *c);
	150	QEMUCursor *cursor_builtin_hidden(void);
	151	QEMUCursor *cursor_builtin_left_ptr(void);
	152	void cursor_print_ascii_art(QEMUCursor c, const char prefix);
	153	int cursor_get_mono_bpl(QEMUCursor *c);
	154	void cursor_set_mono(QEMUCursor *c,
	155	uint32_t foreground, uint32_t background, uint8_t *image,
	156	int transparent, uint8_t *mask);
	157	void cursor_get_mono_image(QEMUCursor c, int foreground, uint8_t mask);
	158	void cursor_get_mono_mask(QEMUCursor c, int transparent, uint8_t mask);
	159
06020b95 GH	160	typedef void *QEMUGLContext;
	161	typedef struct QEMUGLParams QEMUGLParams;
	162
	163	struct QEMUGLParams {
	164	int major_ver;
	165	int minor_ver;
	166	};
	167
dfbb251e	168	typedef struct QemuDmaBuf {
4133fa71 GH	169	int fd;
	170	uint32_t width;
	171	uint32_t height;
	172	uint32_t stride;
	173	uint32_t fourcc;
152b7af6	174	uint64_t modifier;
4133fa71	175	uint32_t texture;
242d0133	176	bool y0_top;
dfbb251e	177	} QemuDmaBuf;
4133fa71	178
7536587c PMD	179	typedef struct DisplayState DisplayState;
7536587c PMD	180
7c20b4a3 GH	181	typedef struct DisplayChangeListenerOps {
	182	const char *dpy_name;
	183
bc2ed970	184	void (dpy_refresh)(DisplayChangeListener dcl);
7c20b4a3 GH	185
7c20b4a3 GH	186	void (dpy_gfx_update)(DisplayChangeListener dcl,
7c20b4a3	187	int x, int y, int w, int h);
c12aeb86	188	void (dpy_gfx_switch)(DisplayChangeListener dcl,
c12aeb86	189	struct DisplaySurface *new_surface);
49743df3 BH	190	bool (dpy_gfx_check_format)(DisplayChangeListener dcl,
49743df3 BH	191	pixman_format_code_t format);
a93a4a22	192
7c20b4a3	193	void (dpy_text_cursor)(DisplayChangeListener dcl,
7c20b4a3 GH	194	int x, int y);
7c20b4a3 GH	195	void (dpy_text_resize)(DisplayChangeListener dcl,
7c20b4a3 GH	196	int w, int h);
7c20b4a3 GH	197	void (dpy_text_update)(DisplayChangeListener dcl,
7c20b4a3 GH	198	int x, int y, int w, int h);
	199
	200	void (dpy_mouse_set)(DisplayChangeListener dcl,
7c20b4a3 GH	201	int x, int y, int on);
7c20b4a3 GH	202	void (dpy_cursor_define)(DisplayChangeListener dcl,
7c20b4a3	203	QEMUCursor *cursor);
06020b95 GH	204
	205	QEMUGLContext (dpy_gl_ctx_create)(DisplayChangeListener dcl,
	206	QEMUGLParams *params);
	207	void (dpy_gl_ctx_destroy)(DisplayChangeListener dcl,
	208	QEMUGLContext ctx);
	209	int (dpy_gl_ctx_make_current)(DisplayChangeListener dcl,
	210	QEMUGLContext ctx);
	211	QEMUGLContext (dpy_gl_ctx_get_current)(DisplayChangeListener dcl);
	212
eaa92c76	213	void (dpy_gl_scanout_disable)(DisplayChangeListener dcl);
f4c36bda GH	214	void (dpy_gl_scanout_texture)(DisplayChangeListener dcl,
	215	uint32_t backing_id,
	216	bool backing_y_0_top,
	217	uint32_t backing_width,
	218	uint32_t backing_height,
	219	uint32_t x, uint32_t y,
	220	uint32_t w, uint32_t h);
4133fa71 GH	221	void (dpy_gl_scanout_dmabuf)(DisplayChangeListener dcl,
	222	QemuDmaBuf *dmabuf);
	223	void (dpy_gl_cursor_dmabuf)(DisplayChangeListener dcl,
6e1f2cb5 GH	224	QemuDmaBuf *dmabuf, bool have_hot,
	225	uint32_t hot_x, uint32_t hot_y);
	226	void (dpy_gl_cursor_position)(DisplayChangeListener dcl,
	227	uint32_t pos_x, uint32_t pos_y);
4133fa71 GH	228	void (dpy_gl_release_dmabuf)(DisplayChangeListener dcl,
4133fa71 GH	229	QemuDmaBuf *dmabuf);
06020b95 GH	230	void (dpy_gl_update)(DisplayChangeListener dcl,
	231	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	232
7c20b4a3	233	} DisplayChangeListenerOps;
7d957bd8	234
7c20b4a3	235	struct DisplayChangeListener {
0f7b2864	236	uint64_t update_interval;
7c20b4a3 GH	237	const DisplayChangeListenerOps *ops;
7c20b4a3 GH	238	DisplayState *ds;
284d1c6b	239	QemuConsole *con;
bf2fde70	240
87e487a1	241	QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8 AL	242	};
7d957bd8 AL	243
64840c66	244	DisplayState *init_displaystate(void);
30f1e661 GH	245	DisplaySurface *qemu_create_displaysurface_from(int width, int height,
	246	pixman_format_code_t format,
	247	int linesize, uint8_t *data);
ca58b45f	248	DisplaySurface qemu_create_displaysurface_pixman(pixman_image_t image);
2e5567c9 GH	249	DisplaySurface *qemu_create_message_surface(int w, int h,
2e5567c9 GH	250	const char *msg);
0da2ea1b	251	PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8	252
da229ef3 GH	253	DisplaySurface *qemu_create_displaysurface(int width, int height);
da229ef3 GH	254	void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da AL	255
	256	static inline int is_surface_bgr(DisplaySurface *surface)
	257	{
30f1e661 GH	258	if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
30f1e661 GH	259	PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
7b5d76da	260	return 1;
30f1e661	261	} else {
7b5d76da	262	return 0;
30f1e661	263	}
7b5d76da AL	264	}
7b5d76da AL	265
7d957bd8 AL	266	static inline int is_buffer_shared(DisplaySurface *surface)
7d957bd8 AL	267	{
187cd1d9	268	return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8 AL	269	}
7d957bd8 AL	270
5209089f	271	void register_displaychangelistener(DisplayChangeListener *dcl);
0f7b2864 GH	272	void update_displaychangelistener(DisplayChangeListener *dcl,
0f7b2864 GH	273	uint64_t interval);
7c20b4a3 GH	274	void unregister_displaychangelistener(DisplayChangeListener *dcl);
7c20b4a3 GH	275
b7fb49f0	276	bool dpy_ui_info_supported(QemuConsole *con);
6f90f3d7 GH	277	int dpy_set_ui_info(QemuConsole con, QemuUIInfo info);
6f90f3d7 GH	278
c78f7137	279	void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
7cd0afe6	280	void dpy_gfx_update_full(QemuConsole *con);
c78f7137	281	void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3	282	DisplaySurface *surface);
c78f7137 GH	283	void dpy_text_cursor(QemuConsole *con, int x, int y);
	284	void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
	285	void dpy_text_resize(QemuConsole *con, int w, int h);
	286	void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
	287	void dpy_cursor_define(QemuConsole con, QEMUCursor cursor);
	288	bool dpy_cursor_define_supported(QemuConsole *con);
49743df3 BH	289	bool dpy_gfx_check_format(QemuConsole *con,
49743df3 BH	290	pixman_format_code_t format);
bf2fde70	291
eaa92c76	292	void dpy_gl_scanout_disable(QemuConsole *con);
f4c36bda GH	293	void dpy_gl_scanout_texture(QemuConsole *con,
	294	uint32_t backing_id, bool backing_y_0_top,
	295	uint32_t backing_width, uint32_t backing_height,
	296	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
4133fa71 GH	297	void dpy_gl_scanout_dmabuf(QemuConsole *con,
4133fa71 GH	298	QemuDmaBuf *dmabuf);
6e1f2cb5 GH	299	void dpy_gl_cursor_dmabuf(QemuConsole con, QemuDmaBuf dmabuf,
	300	bool have_hot, uint32_t hot_x, uint32_t hot_y);
	301	void dpy_gl_cursor_position(QemuConsole *con,
	302	uint32_t pos_x, uint32_t pos_y);
4133fa71 GH	303	void dpy_gl_release_dmabuf(QemuConsole *con,
4133fa71 GH	304	QemuDmaBuf *dmabuf);
06020b95 GH	305	void dpy_gl_update(QemuConsole *con,
	306	uint32_t x, uint32_t y, uint32_t w, uint32_t h);
	307
	308	QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
	309	QEMUGLParams *params);
	310	void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx);
	311	int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx);
	312	QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con);
	313
	314	bool console_has_gl(QemuConsole *con);
4133fa71	315	bool console_has_gl_dmabuf(QemuConsole *con);
06020b95	316
626e3b34 GH	317	static inline int surface_stride(DisplaySurface *s)
	318	{
	319	return pixman_image_get_stride(s->image);
	320	}
	321
	322	static inline void surface_data(DisplaySurface s)
	323	{
	324	return pixman_image_get_data(s->image);
	325	}
	326
	327	static inline int surface_width(DisplaySurface *s)
	328	{
	329	return pixman_image_get_width(s->image);
	330	}
	331
	332	static inline int surface_height(DisplaySurface *s)
	333	{
	334	return pixman_image_get_height(s->image);
	335	}
	336
	337	static inline int surface_bits_per_pixel(DisplaySurface *s)
	338	{
	339	int bits = PIXMAN_FORMAT_BPP(s->format);
	340	return bits;
	341	}
	342
	343	static inline int surface_bytes_per_pixel(DisplaySurface *s)
	344	{
	345	int bits = PIXMAN_FORMAT_BPP(s->format);
d1a0945f	346	return DIV_ROUND_UP(bits, 8);
626e3b34 GH	347	}
626e3b34 GH	348
e444ea34 HR	349	static inline pixman_format_code_t surface_format(DisplaySurface *s)
	350	{
	351	return s->format;
	352	}
	353
e2f82e92 GH	354	typedef uint32_t console_ch_t;
e2f82e92 GH	355
c227f099	356	static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e	357	{
9ae19b65	358	*dest = ch;
4d3b6f6e AZ	359	}
4d3b6f6e AZ	360
380cd056 GH	361	typedef struct GraphicHwOps {
	362	void (invalidate)(void opaque);
	363	void (gfx_update)(void opaque);
4d631621	364	bool gfx_update_async; /* if true, calls graphic_hw_update_done() */
380cd056	365	void (text_update)(void opaque, console_ch_t *text);
dea1b0bd	366	void (update_interval)(void opaque, uint64_t interval);
6f90f3d7	367	int (ui_info)(void opaque, uint32_t head, QemuUIInfo *info);
bba19b88	368	void (gl_block)(void opaque, bool block);
380cd056	369	} GraphicHwOps;
87ecb68b	370
5643706a	371	QemuConsole graphic_console_init(DeviceState dev, uint32_t head,
aa2beaa1	372	const GraphicHwOps *ops,
c78f7137	373	void *opaque);
1c1f9498 GH	374	void graphic_console_set_hwops(QemuConsole *con,
	375	const GraphicHwOps *hw_ops,
	376	void *opaque);
9588d67e	377	void graphic_console_close(QemuConsole *con);
3023f332	378
1dbfa005	379	void graphic_hw_update(QemuConsole *con);
4d631621	380	void graphic_hw_update_done(QemuConsole *con);
1dbfa005 GH	381	void graphic_hw_invalidate(QemuConsole *con);
1dbfa005 GH	382	void graphic_hw_text_update(QemuConsole con, console_ch_t chardata);
bba19b88	383	void graphic_hw_gl_block(QemuConsole *con, bool block);
87ecb68b	384
777357d7 MAL	385	void qemu_console_early_init(void);
777357d7 MAL	386
284d1c6b	387	QemuConsole *qemu_console_lookup_by_index(unsigned int index);
5643706a	388	QemuConsole qemu_console_lookup_by_device(DeviceState dev, uint32_t head);
f2c1d54c GH	389	QemuConsole qemu_console_lookup_by_device_name(const char device_id,
f2c1d54c GH	390	uint32_t head, Error **errp);
9588d67e	391	QemuConsole *qemu_console_lookup_unused(void);
81c0d5a6 GH	392	bool qemu_console_is_visible(QemuConsole *con);
	393	bool qemu_console_is_graphic(QemuConsole *con);
	394	bool qemu_console_is_fixedsize(QemuConsole *con);
f607867c	395	bool qemu_console_is_gl_blocked(QemuConsole *con);
779ce88f	396	char qemu_console_get_label(QemuConsole con);
d4c85337	397	int qemu_console_get_index(QemuConsole *con);
5643706a	398	uint32_t qemu_console_get_head(QemuConsole *con);
6f90f3d7	399	QemuUIInfo qemu_console_get_ui_info(QemuConsole con);
d4c85337 GH	400	int qemu_console_get_width(QemuConsole *con, int fallback);
d4c85337 GH	401	int qemu_console_get_height(QemuConsole *con, int fallback);
b3cb21b9 ST	402	/* Return the low-level window id for the console */
	403	int qemu_console_get_window_id(QemuConsole *con);
	404	/* Set the low-level window id for the console */
	405	void qemu_console_set_window_id(QemuConsole *con, int window_id);
81c0d5a6	406
87ecb68b	407	void console_select(unsigned int index);
c78f7137	408	void qemu_console_resize(QemuConsole *con, int width, int height);
c78f7137	409	DisplaySurface qemu_console_surface(QemuConsole con);
87ecb68b	410
cd2bc889	411	/* console-gl.c */
cd2bc889	412	#ifdef CONFIG_OPENGL
cd2bc889 GH	413	bool console_gl_check_format(DisplayChangeListener *dcl,
cd2bc889 GH	414	pixman_format_code_t format);
46e19e14	415	void surface_gl_create_texture(QemuGLShader *gls,
cd2bc889	416	DisplaySurface *surface);
46e19e14	417	void surface_gl_update_texture(QemuGLShader *gls,
cd2bc889 GH	418	DisplaySurface *surface,
cd2bc889 GH	419	int x, int y, int w, int h);
46e19e14	420	void surface_gl_render_texture(QemuGLShader *gls,
cd2bc889	421	DisplaySurface *surface);
46e19e14	422	void surface_gl_destroy_texture(QemuGLShader *gls,
cd2bc889	423	DisplaySurface *surface);
46e19e14	424	void surface_gl_setup_viewport(QemuGLShader *gls,
cd2bc889 GH	425	DisplaySurface *surface,
	426	int ww, int wh);
	427	#endif
	428
db71589f	429	typedef struct QemuDisplay QemuDisplay;
87ecb68b	430
db71589f GH	431	struct QemuDisplay {
	432	DisplayType type;
	433	void (early_init)(DisplayOptions opts);
	434	void (init)(DisplayState ds, DisplayOptions *opts);
	435	};
	436
	437	void qemu_display_register(QemuDisplay *ui);
898f9d41	438	bool qemu_display_find_default(DisplayOptions *opts);
db71589f GH	439	void qemu_display_early_init(DisplayOptions *opts);
db71589f GH	440	void qemu_display_init(DisplayState ds, DisplayOptions opts);
c388f408	441	void qemu_display_help(void);
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