]> git.proxmox.com Git - qemu.git/blame - include/ui/console.h
ich9: kill cmos_s3
[qemu.git] / include / ui / console.h
CommitLineData
87ecb68b
PB
1#ifndef CONSOLE_H
2#define CONSOLE_H
3
28ecbaee 4#include "ui/qemu-pixman.h"
7b1b5d19 5#include "qapi/qmp/qdict.h"
1de7afc9 6#include "qemu/notify.h"
83c9089e 7#include "monitor/monitor.h"
cdbc19dd 8#include "trace.h"
1048c88f 9#include "qapi-types.h"
7b1b5d19 10#include "qapi/error.h"
87ecb68b
PB
11
12/* keyboard/mouse support */
13
14#define MOUSE_EVENT_LBUTTON 0x01
15#define MOUSE_EVENT_RBUTTON 0x02
16#define MOUSE_EVENT_MBUTTON 0x04
17
03a23a85
GH
18/* identical to the ps/2 keyboard bits */
19#define QEMU_SCROLL_LOCK_LED (1 << 0)
20#define QEMU_NUM_LOCK_LED (1 << 1)
21#define QEMU_CAPS_LOCK_LED (1 << 2)
22
7ed9eba3 23/* in ms */
0f7b2864
GH
24#define GUI_REFRESH_INTERVAL_DEFAULT 30
25#define GUI_REFRESH_INTERVAL_IDLE 3000
7ed9eba3 26
87ecb68b 27typedef void QEMUPutKBDEvent(void *opaque, int keycode);
03a23a85 28typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
87ecb68b
PB
29typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
30
31typedef struct QEMUPutMouseEntry {
32 QEMUPutMouseEvent *qemu_put_mouse_event;
33 void *qemu_put_mouse_event_opaque;
34 int qemu_put_mouse_event_absolute;
35 char *qemu_put_mouse_event_name;
36
6fef28ee
AL
37 int index;
38
87ecb68b 39 /* used internally by qemu for handling mice */
6fef28ee 40 QTAILQ_ENTRY(QEMUPutMouseEntry) node;
87ecb68b
PB
41} QEMUPutMouseEntry;
42
03a23a85
GH
43typedef struct QEMUPutLEDEntry {
44 QEMUPutLEDEvent *put_led;
45 void *opaque;
46 QTAILQ_ENTRY(QEMUPutLEDEntry) next;
47} QEMUPutLEDEntry;
48
87ecb68b 49void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
46aaebff 50void qemu_remove_kbd_event_handler(void);
87ecb68b
PB
51QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
52 void *opaque, int absolute,
53 const char *name);
54void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
6fef28ee
AL
55void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
56
03a23a85
GH
57QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
58void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
87ecb68b
PB
59
60void kbd_put_keycode(int keycode);
03a23a85 61void kbd_put_ledstate(int ledstate);
87ecb68b 62void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
eb2e259d
AL
63
64/* Does the current mouse generate absolute events */
87ecb68b 65int kbd_mouse_is_absolute(void);
7e581fb3
AL
66void qemu_add_mouse_mode_change_notifier(Notifier *notify);
67void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
87ecb68b 68
eb2e259d
AL
69/* Of all the mice, is there one that generates absolute events */
70int kbd_mouse_has_absolute(void);
71
bc24a225 72struct MouseTransformInfo {
a5d7eb65
AZ
73 /* Touchscreen resolution */
74 int x;
75 int y;
76 /* Calibration values as used/generated by tslib */
77 int a[7];
78};
79
d54908a5 80void do_mouse_set(Monitor *mon, const QDict *qdict);
87ecb68b
PB
81
82/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
83 constants) */
84#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
85#define QEMU_KEY_BACKSPACE 0x007f
86#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
87#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
88#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
89#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
90#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
91#define QEMU_KEY_END QEMU_KEY_ESC1(4)
92#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
93#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
94#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
95
96#define QEMU_KEY_CTRL_UP 0xe400
97#define QEMU_KEY_CTRL_DOWN 0xe401
98#define QEMU_KEY_CTRL_LEFT 0xe402
99#define QEMU_KEY_CTRL_RIGHT 0xe403
100#define QEMU_KEY_CTRL_HOME 0xe404
101#define QEMU_KEY_CTRL_END 0xe405
102#define QEMU_KEY_CTRL_PAGEUP 0xe406
103#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
104
105void kbd_put_keysym(int keysym);
106
107/* consoles */
108
7d957bd8
AL
109#define QEMU_BIG_ENDIAN_FLAG 0x01
110#define QEMU_ALLOCATED_FLAG 0x02
111
112struct PixelFormat {
113 uint8_t bits_per_pixel;
114 uint8_t bytes_per_pixel;
115 uint8_t depth; /* color depth in bits */
116 uint32_t rmask, gmask, bmask, amask;
117 uint8_t rshift, gshift, bshift, ashift;
118 uint8_t rmax, gmax, bmax, amax;
90a1e3c0 119 uint8_t rbits, gbits, bbits, abits;
7d957bd8
AL
120};
121
122struct DisplaySurface {
69c77777
GH
123 pixman_format_code_t format;
124 pixman_image_t *image;
7d957bd8 125 uint8_t flags;
7d957bd8
AL
126
127 struct PixelFormat pf;
128};
129
254e5950
GH
130/* cursor data format is 32bit RGBA */
131typedef struct QEMUCursor {
132 int width, height;
133 int hot_x, hot_y;
134 int refcount;
135 uint32_t data[];
136} QEMUCursor;
137
138QEMUCursor *cursor_alloc(int width, int height);
139void cursor_get(QEMUCursor *c);
140void cursor_put(QEMUCursor *c);
141QEMUCursor *cursor_builtin_hidden(void);
142QEMUCursor *cursor_builtin_left_ptr(void);
143void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
144int cursor_get_mono_bpl(QEMUCursor *c);
145void cursor_set_mono(QEMUCursor *c,
146 uint32_t foreground, uint32_t background, uint8_t *image,
147 int transparent, uint8_t *mask);
148void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
149void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
150
7c20b4a3
GH
151typedef struct DisplayChangeListenerOps {
152 const char *dpy_name;
153
bc2ed970 154 void (*dpy_refresh)(DisplayChangeListener *dcl);
7c20b4a3
GH
155
156 void (*dpy_gfx_update)(DisplayChangeListener *dcl,
7c20b4a3 157 int x, int y, int w, int h);
c12aeb86 158 void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
c12aeb86 159 struct DisplaySurface *new_surface);
7c20b4a3 160 void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
bc2ed970 161 int src_x, int src_y,
a93a4a22 162 int dst_x, int dst_y, int w, int h);
a93a4a22 163
7c20b4a3 164 void (*dpy_text_cursor)(DisplayChangeListener *dcl,
7c20b4a3
GH
165 int x, int y);
166 void (*dpy_text_resize)(DisplayChangeListener *dcl,
7c20b4a3
GH
167 int w, int h);
168 void (*dpy_text_update)(DisplayChangeListener *dcl,
7c20b4a3
GH
169 int x, int y, int w, int h);
170
171 void (*dpy_mouse_set)(DisplayChangeListener *dcl,
7c20b4a3
GH
172 int x, int y, int on);
173 void (*dpy_cursor_define)(DisplayChangeListener *dcl,
7c20b4a3
GH
174 QEMUCursor *cursor);
175} DisplayChangeListenerOps;
7d957bd8 176
7c20b4a3 177struct DisplayChangeListener {
0f7b2864 178 uint64_t update_interval;
7c20b4a3
GH
179 const DisplayChangeListenerOps *ops;
180 DisplayState *ds;
284d1c6b 181 QemuConsole *con;
bf2fde70 182
87e487a1 183 QLIST_ENTRY(DisplayChangeListener) next;
7d957bd8
AL
184};
185
64840c66 186DisplayState *init_displaystate(void);
7d957bd8 187DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
b1424e03
GH
188 int linesize, uint8_t *data,
189 bool byteswap);
0da2ea1b 190PixelFormat qemu_different_endianness_pixelformat(int bpp);
191PixelFormat qemu_default_pixelformat(int bpp);
7d957bd8 192
da229ef3
GH
193DisplaySurface *qemu_create_displaysurface(int width, int height);
194void qemu_free_displaysurface(DisplaySurface *surface);
7b5d76da
AL
195
196static inline int is_surface_bgr(DisplaySurface *surface)
197{
198 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
199 return 1;
200 else
201 return 0;
202}
203
7d957bd8
AL
204static inline int is_buffer_shared(DisplaySurface *surface)
205{
187cd1d9 206 return !(surface->flags & QEMU_ALLOCATED_FLAG);
7d957bd8
AL
207}
208
7c20b4a3
GH
209void register_displaychangelistener(DisplayState *ds,
210 DisplayChangeListener *dcl);
0f7b2864
GH
211void update_displaychangelistener(DisplayChangeListener *dcl,
212 uint64_t interval);
7c20b4a3
GH
213void unregister_displaychangelistener(DisplayChangeListener *dcl);
214
c78f7137
GH
215void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
216void dpy_gfx_replace_surface(QemuConsole *con,
da229ef3 217 DisplaySurface *surface);
c78f7137 218void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
7c20b4a3 219 int dst_x, int dst_y, int w, int h);
c78f7137
GH
220void dpy_text_cursor(QemuConsole *con, int x, int y);
221void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
222void dpy_text_resize(QemuConsole *con, int w, int h);
223void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
224void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
225bool dpy_cursor_define_supported(QemuConsole *con);
bf2fde70 226
626e3b34
GH
227static inline int surface_stride(DisplaySurface *s)
228{
229 return pixman_image_get_stride(s->image);
230}
231
232static inline void *surface_data(DisplaySurface *s)
233{
234 return pixman_image_get_data(s->image);
235}
236
237static inline int surface_width(DisplaySurface *s)
238{
239 return pixman_image_get_width(s->image);
240}
241
242static inline int surface_height(DisplaySurface *s)
243{
244 return pixman_image_get_height(s->image);
245}
246
247static inline int surface_bits_per_pixel(DisplaySurface *s)
248{
249 int bits = PIXMAN_FORMAT_BPP(s->format);
250 return bits;
251}
252
253static inline int surface_bytes_per_pixel(DisplaySurface *s)
254{
255 int bits = PIXMAN_FORMAT_BPP(s->format);
256 return (bits + 7) / 8;
257}
258
df00bed0
DP
259#ifdef CONFIG_CURSES
260#include <curses.h>
261typedef chtype console_ch_t;
262#else
c227f099 263typedef unsigned long console_ch_t;
df00bed0 264#endif
c227f099 265static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
4d3b6f6e 266{
f6d20d0f
BK
267 if (!(ch & 0xff))
268 ch |= ' ';
9ae19b65 269 *dest = ch;
4d3b6f6e
AZ
270}
271
380cd056
GH
272typedef struct GraphicHwOps {
273 void (*invalidate)(void *opaque);
274 void (*gfx_update)(void *opaque);
275 void (*text_update)(void *opaque, console_ch_t *text);
dea1b0bd 276 void (*update_interval)(void *opaque, uint64_t interval);
380cd056 277} GraphicHwOps;
87ecb68b 278
380cd056 279QemuConsole *graphic_console_init(const GraphicHwOps *ops,
c78f7137 280 void *opaque);
3023f332 281
1dbfa005
GH
282void graphic_hw_update(QemuConsole *con);
283void graphic_hw_invalidate(QemuConsole *con);
284void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
87ecb68b 285
284d1c6b 286QemuConsole *qemu_console_lookup_by_index(unsigned int index);
81c0d5a6
GH
287bool qemu_console_is_visible(QemuConsole *con);
288bool qemu_console_is_graphic(QemuConsole *con);
289bool qemu_console_is_fixedsize(QemuConsole *con);
290
2796dae0 291void text_consoles_set_display(DisplayState *ds);
87ecb68b
PB
292void console_select(unsigned int index);
293void console_color_init(DisplayState *ds);
c78f7137
GH
294void qemu_console_resize(QemuConsole *con, int width, int height);
295void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
3023f332 296 int dst_x, int dst_y, int w, int h);
c78f7137
GH
297DisplaySurface *qemu_console_surface(QemuConsole *con);
298DisplayState *qemu_console_displaystate(QemuConsole *console);
87ecb68b 299
702ec69c 300typedef CharDriverState *(VcHandler)(ChardevVC *vc);
d82831db 301
702ec69c 302CharDriverState *vc_init(ChardevVC *vc);
d82831db
AL
303void register_vc_handler(VcHandler *handler);
304
87ecb68b
PB
305/* sdl.c */
306void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
307
308/* cocoa.m */
309void cocoa_display_init(DisplayState *ds, int full_screen);
310
311/* vnc.c */
312void vnc_display_init(DisplayState *ds);
007fcd3e 313void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
13661089 314void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
821601ea
JS
315char *vnc_display_local_addr(DisplayState *ds);
316#ifdef CONFIG_VNC
317int vnc_display_password(DisplayState *ds, const char *password);
3c9405a0 318int vnc_display_pw_expire(DisplayState *ds, time_t expires);
821601ea
JS
319#else
320static inline int vnc_display_password(DisplayState *ds, const char *password)
321{
821601ea
JS
322 return -ENODEV;
323}
324static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
325{
821601ea
JS
326 return -ENODEV;
327};
821601ea 328#endif
87ecb68b 329
4d3b6f6e
AZ
330/* curses.c */
331void curses_display_init(DisplayState *ds, int full_screen);
332
1048c88f 333/* input.c */
1048c88f
AK
334int index_from_key(const char *key);
335int index_from_keycode(int code);
336
a4ccabcf
AL
337/* gtk.c */
338void early_gtk_display_init(void);
339void gtk_display_init(DisplayState *ds);
340
87ecb68b 341#endif