blob: 4334db5ca5f0be872cfacfc5c85800a0ab947217 [file] [log] [blame]
pbrook87ecb682007-11-17 17:14:51 +00001#ifndef CONSOLE_H
2#define CONSOLE_H
3
4#include "qemu-char.h"
Luiz Capitulinod54908a2009-08-28 15:27:13 -03005#include "qdict.h"
Anthony Liguori7e581fb2010-03-09 13:25:00 -06006#include "notify.h"
Jes Sorensen821601e2011-03-16 13:33:36 +01007#include "monitor.h"
Alon Levycdbc19d2012-03-11 18:11:26 +02008#include "trace.h"
pbrook87ecb682007-11-17 17:14:51 +00009
10/* keyboard/mouse support */
11
12#define MOUSE_EVENT_LBUTTON 0x01
13#define MOUSE_EVENT_RBUTTON 0x02
14#define MOUSE_EVENT_MBUTTON 0x04
15
Gerd Hoffmann03a23a82010-02-26 17:17:36 +010016/* identical to the ps/2 keyboard bits */
17#define QEMU_SCROLL_LOCK_LED (1 << 0)
18#define QEMU_NUM_LOCK_LED (1 << 1)
19#define QEMU_CAPS_LOCK_LED (1 << 2)
20
aliguori7ed9eba2008-08-21 20:12:05 +000021/* in ms */
22#define GUI_REFRESH_INTERVAL 30
23
pbrook87ecb682007-11-17 17:14:51 +000024typedef void QEMUPutKBDEvent(void *opaque, int keycode);
Gerd Hoffmann03a23a82010-02-26 17:17:36 +010025typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
pbrook87ecb682007-11-17 17:14:51 +000026typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
27
28typedef struct QEMUPutMouseEntry {
29 QEMUPutMouseEvent *qemu_put_mouse_event;
30 void *qemu_put_mouse_event_opaque;
31 int qemu_put_mouse_event_absolute;
32 char *qemu_put_mouse_event_name;
33
Anthony Liguori6fef28e2010-03-09 20:52:22 -060034 int index;
35
pbrook87ecb682007-11-17 17:14:51 +000036 /* used internally by qemu for handling mice */
Anthony Liguori6fef28e2010-03-09 20:52:22 -060037 QTAILQ_ENTRY(QEMUPutMouseEntry) node;
pbrook87ecb682007-11-17 17:14:51 +000038} QEMUPutMouseEntry;
39
Gerd Hoffmann03a23a82010-02-26 17:17:36 +010040typedef struct QEMUPutLEDEntry {
41 QEMUPutLEDEvent *put_led;
42 void *opaque;
43 QTAILQ_ENTRY(QEMUPutLEDEntry) next;
44} QEMUPutLEDEntry;
45
pbrook87ecb682007-11-17 17:14:51 +000046void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
Jes Sorensen46aaebf2010-06-08 15:12:18 +020047void qemu_remove_kbd_event_handler(void);
pbrook87ecb682007-11-17 17:14:51 +000048QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
49 void *opaque, int absolute,
50 const char *name);
51void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
Anthony Liguori6fef28e2010-03-09 20:52:22 -060052void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
53
Gerd Hoffmann03a23a82010-02-26 17:17:36 +010054QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
55void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
pbrook87ecb682007-11-17 17:14:51 +000056
57void kbd_put_keycode(int keycode);
Gerd Hoffmann03a23a82010-02-26 17:17:36 +010058void kbd_put_ledstate(int ledstate);
pbrook87ecb682007-11-17 17:14:51 +000059void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
Anthony Liguorieb2e2592010-03-09 14:26:40 -060060
61/* Does the current mouse generate absolute events */
pbrook87ecb682007-11-17 17:14:51 +000062int kbd_mouse_is_absolute(void);
Anthony Liguori7e581fb2010-03-09 13:25:00 -060063void qemu_add_mouse_mode_change_notifier(Notifier *notify);
64void qemu_remove_mouse_mode_change_notifier(Notifier *notify);
pbrook87ecb682007-11-17 17:14:51 +000065
Anthony Liguorieb2e2592010-03-09 14:26:40 -060066/* Of all the mice, is there one that generates absolute events */
67int kbd_mouse_has_absolute(void);
68
Paul Brookbc24a222009-05-10 01:44:56 +010069struct MouseTransformInfo {
balroga5d7eb62008-04-14 21:28:11 +000070 /* Touchscreen resolution */
71 int x;
72 int y;
73 /* Calibration values as used/generated by tslib */
74 int a[7];
75};
76
Luiz Capitulinod54908a2009-08-28 15:27:13 -030077void do_mouse_set(Monitor *mon, const QDict *qdict);
pbrook87ecb682007-11-17 17:14:51 +000078
79/* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
80 constants) */
81#define QEMU_KEY_ESC1(c) ((c) | 0xe100)
82#define QEMU_KEY_BACKSPACE 0x007f
83#define QEMU_KEY_UP QEMU_KEY_ESC1('A')
84#define QEMU_KEY_DOWN QEMU_KEY_ESC1('B')
85#define QEMU_KEY_RIGHT QEMU_KEY_ESC1('C')
86#define QEMU_KEY_LEFT QEMU_KEY_ESC1('D')
87#define QEMU_KEY_HOME QEMU_KEY_ESC1(1)
88#define QEMU_KEY_END QEMU_KEY_ESC1(4)
89#define QEMU_KEY_PAGEUP QEMU_KEY_ESC1(5)
90#define QEMU_KEY_PAGEDOWN QEMU_KEY_ESC1(6)
91#define QEMU_KEY_DELETE QEMU_KEY_ESC1(3)
92
93#define QEMU_KEY_CTRL_UP 0xe400
94#define QEMU_KEY_CTRL_DOWN 0xe401
95#define QEMU_KEY_CTRL_LEFT 0xe402
96#define QEMU_KEY_CTRL_RIGHT 0xe403
97#define QEMU_KEY_CTRL_HOME 0xe404
98#define QEMU_KEY_CTRL_END 0xe405
99#define QEMU_KEY_CTRL_PAGEUP 0xe406
100#define QEMU_KEY_CTRL_PAGEDOWN 0xe407
101
102void kbd_put_keysym(int keysym);
103
104/* consoles */
105
aliguori7d957bd2009-01-15 22:14:11 +0000106#define QEMU_BIG_ENDIAN_FLAG 0x01
107#define QEMU_ALLOCATED_FLAG 0x02
Stefano Stabellinic18a2c32009-06-24 11:58:25 +0100108#define QEMU_REALPIXELS_FLAG 0x04
aliguori7d957bd2009-01-15 22:14:11 +0000109
110struct PixelFormat {
111 uint8_t bits_per_pixel;
112 uint8_t bytes_per_pixel;
113 uint8_t depth; /* color depth in bits */
114 uint32_t rmask, gmask, bmask, amask;
115 uint8_t rshift, gshift, bshift, ashift;
116 uint8_t rmax, gmax, bmax, amax;
aliguori90a1e3c2009-01-26 15:37:30 +0000117 uint8_t rbits, gbits, bbits, abits;
aliguori7d957bd2009-01-15 22:14:11 +0000118};
119
120struct DisplaySurface {
121 uint8_t flags;
pbrook87ecb682007-11-17 17:14:51 +0000122 int width;
123 int height;
aliguori7d957bd2009-01-15 22:14:11 +0000124 int linesize; /* bytes per line */
125 uint8_t *data;
126
127 struct PixelFormat pf;
128};
129
Gerd Hoffmann254e5952010-05-21 11:54:32 +0200130/* 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
aliguori7d957bd2009-01-15 22:14:11 +0000151struct DisplayChangeListener {
152 int idle;
aurel32f442e082008-03-13 19:20:33 +0000153 uint64_t gui_timer_interval;
pbrook87ecb682007-11-17 17:14:51 +0000154
155 void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
aliguori7d957bd2009-01-15 22:14:11 +0000156 void (*dpy_resize)(struct DisplayState *s);
157 void (*dpy_setdata)(struct DisplayState *s);
pbrook87ecb682007-11-17 17:14:51 +0000158 void (*dpy_refresh)(struct DisplayState *s);
159 void (*dpy_copy)(struct DisplayState *s, int src_x, int src_y,
160 int dst_x, int dst_y, int w, int h);
161 void (*dpy_fill)(struct DisplayState *s, int x, int y,
162 int w, int h, uint32_t c);
balrog4d3b6f62008-02-10 16:33:14 +0000163 void (*dpy_text_cursor)(struct DisplayState *s, int x, int y);
aliguori7d957bd2009-01-15 22:14:11 +0000164
165 struct DisplayChangeListener *next;
166};
167
aliguori7b5d76d2009-03-13 15:02:13 +0000168struct DisplayAllocator {
169 DisplaySurface* (*create_displaysurface)(int width, int height);
170 DisplaySurface* (*resize_displaysurface)(DisplaySurface *surface, int width, int height);
171 void (*free_displaysurface)(DisplaySurface *surface);
172};
173
aliguori7d957bd2009-01-15 22:14:11 +0000174struct DisplayState {
175 struct DisplaySurface *surface;
176 void *opaque;
177 struct QEMUTimer *gui_timer;
178
aliguori7b5d76d2009-03-13 15:02:13 +0000179 struct DisplayAllocator* allocator;
aliguori7d957bd2009-01-15 22:14:11 +0000180 struct DisplayChangeListener* listeners;
181
pbrook87ecb682007-11-17 17:14:51 +0000182 void (*mouse_set)(int x, int y, int on);
Gerd Hoffmann254e5952010-05-21 11:54:32 +0200183 void (*cursor_define)(QEMUCursor *cursor);
aliguori3023f332009-01-16 19:04:14 +0000184
185 struct DisplayState *next;
pbrook87ecb682007-11-17 17:14:51 +0000186};
187
aliguori3023f332009-01-16 19:04:14 +0000188void register_displaystate(DisplayState *ds);
189DisplayState *get_displaystate(void);
aliguori7d957bd2009-01-15 22:14:11 +0000190DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp,
191 int linesize, uint8_t *data);
Jes Sorensenffe8b822011-03-16 13:33:30 +0100192void qemu_alloc_display(DisplaySurface *surface, int width, int height,
193 int linesize, PixelFormat pf, int newflags);
malc0da2ea12009-01-23 19:56:19 +0000194PixelFormat qemu_different_endianness_pixelformat(int bpp);
195PixelFormat qemu_default_pixelformat(int bpp);
aliguori7d957bd2009-01-15 22:14:11 +0000196
aliguori7b5d76d2009-03-13 15:02:13 +0000197DisplayAllocator *register_displayallocator(DisplayState *ds, DisplayAllocator *da);
aliguori7b5d76d2009-03-13 15:02:13 +0000198
199static inline DisplaySurface* qemu_create_displaysurface(DisplayState *ds, int width, int height)
200{
201 return ds->allocator->create_displaysurface(width, height);
202}
203
204static inline DisplaySurface* qemu_resize_displaysurface(DisplayState *ds, int width, int height)
205{
Alon Levycdbc19d2012-03-11 18:11:26 +0200206 trace_displaysurface_resize(ds, ds->surface, width, height);
aliguori7b5d76d2009-03-13 15:02:13 +0000207 return ds->allocator->resize_displaysurface(ds->surface, width, height);
208}
209
210static inline void qemu_free_displaysurface(DisplayState *ds)
211{
Alon Levycdbc19d2012-03-11 18:11:26 +0200212 trace_displaysurface_free(ds, ds->surface);
aliguori7b5d76d2009-03-13 15:02:13 +0000213 ds->allocator->free_displaysurface(ds->surface);
214}
215
216static inline int is_surface_bgr(DisplaySurface *surface)
217{
218 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0)
219 return 1;
220 else
221 return 0;
222}
223
aliguori7d957bd2009-01-15 22:14:11 +0000224static inline int is_buffer_shared(DisplaySurface *surface)
225{
Stefano Stabellinic18a2c32009-06-24 11:58:25 +0100226 return (!(surface->flags & QEMU_ALLOCATED_FLAG) &&
227 !(surface->flags & QEMU_REALPIXELS_FLAG));
aliguori7d957bd2009-01-15 22:14:11 +0000228}
229
230static inline void register_displaychangelistener(DisplayState *ds, DisplayChangeListener *dcl)
231{
232 dcl->next = ds->listeners;
233 ds->listeners = dcl;
234}
235
pbrook87ecb682007-11-17 17:14:51 +0000236static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
237{
aliguori7d957bd2009-01-15 22:14:11 +0000238 struct DisplayChangeListener *dcl = s->listeners;
239 while (dcl != NULL) {
240 dcl->dpy_update(s, x, y, w, h);
241 dcl = dcl->next;
242 }
pbrook87ecb682007-11-17 17:14:51 +0000243}
244
aliguori7d957bd2009-01-15 22:14:11 +0000245static inline void dpy_resize(DisplayState *s)
pbrook87ecb682007-11-17 17:14:51 +0000246{
aliguori7d957bd2009-01-15 22:14:11 +0000247 struct DisplayChangeListener *dcl = s->listeners;
248 while (dcl != NULL) {
249 dcl->dpy_resize(s);
250 dcl = dcl->next;
251 }
pbrook87ecb682007-11-17 17:14:51 +0000252}
253
aliguori7d957bd2009-01-15 22:14:11 +0000254static inline void dpy_setdata(DisplayState *s)
balrog4d3b6f62008-02-10 16:33:14 +0000255{
aliguori7d957bd2009-01-15 22:14:11 +0000256 struct DisplayChangeListener *dcl = s->listeners;
257 while (dcl != NULL) {
258 if (dcl->dpy_setdata) dcl->dpy_setdata(s);
259 dcl = dcl->next;
260 }
261}
262
263static inline void dpy_refresh(DisplayState *s)
264{
265 struct DisplayChangeListener *dcl = s->listeners;
266 while (dcl != NULL) {
267 if (dcl->dpy_refresh) dcl->dpy_refresh(s);
268 dcl = dcl->next;
269 }
270}
271
272static inline void dpy_copy(struct DisplayState *s, int src_x, int src_y,
273 int dst_x, int dst_y, int w, int h) {
274 struct DisplayChangeListener *dcl = s->listeners;
275 while (dcl != NULL) {
276 if (dcl->dpy_copy)
277 dcl->dpy_copy(s, src_x, src_y, dst_x, dst_y, w, h);
278 else /* TODO */
279 dcl->dpy_update(s, dst_x, dst_y, w, h);
280 dcl = dcl->next;
281 }
282}
283
284static inline void dpy_fill(struct DisplayState *s, int x, int y,
285 int w, int h, uint32_t c) {
286 struct DisplayChangeListener *dcl = s->listeners;
287 while (dcl != NULL) {
288 if (dcl->dpy_fill) dcl->dpy_fill(s, x, y, w, h, c);
289 dcl = dcl->next;
290 }
291}
292
293static inline void dpy_cursor(struct DisplayState *s, int x, int y) {
294 struct DisplayChangeListener *dcl = s->listeners;
295 while (dcl != NULL) {
296 if (dcl->dpy_text_cursor) dcl->dpy_text_cursor(s, x, y);
297 dcl = dcl->next;
298 }
balrog4d3b6f62008-02-10 16:33:14 +0000299}
300
aliguori0e1f5a02008-11-24 19:29:13 +0000301static inline int ds_get_linesize(DisplayState *ds)
302{
aliguori7d957bd2009-01-15 22:14:11 +0000303 return ds->surface->linesize;
aliguori0e1f5a02008-11-24 19:29:13 +0000304}
305
306static inline uint8_t* ds_get_data(DisplayState *ds)
307{
aliguori7d957bd2009-01-15 22:14:11 +0000308 return ds->surface->data;
aliguori0e1f5a02008-11-24 19:29:13 +0000309}
310
311static inline int ds_get_width(DisplayState *ds)
312{
aliguori7d957bd2009-01-15 22:14:11 +0000313 return ds->surface->width;
aliguori0e1f5a02008-11-24 19:29:13 +0000314}
315
316static inline int ds_get_height(DisplayState *ds)
317{
aliguori7d957bd2009-01-15 22:14:11 +0000318 return ds->surface->height;
aliguori0e1f5a02008-11-24 19:29:13 +0000319}
320
321static inline int ds_get_bits_per_pixel(DisplayState *ds)
322{
aliguori7d957bd2009-01-15 22:14:11 +0000323 return ds->surface->pf.bits_per_pixel;
aliguori0e1f5a02008-11-24 19:29:13 +0000324}
325
aliguori8927bcf2009-01-15 22:07:16 +0000326static inline int ds_get_bytes_per_pixel(DisplayState *ds)
327{
aliguori7d957bd2009-01-15 22:14:11 +0000328 return ds->surface->pf.bytes_per_pixel;
aliguori8927bcf2009-01-15 22:07:16 +0000329}
330
Devin J. Pohlydf00bed2011-09-07 15:44:36 -0400331#ifdef CONFIG_CURSES
332#include <curses.h>
333typedef chtype console_ch_t;
334#else
Anthony Liguoric227f092009-10-01 16:12:16 -0500335typedef unsigned long console_ch_t;
Devin J. Pohlydf00bed2011-09-07 15:44:36 -0400336#endif
Anthony Liguoric227f092009-10-01 16:12:16 -0500337static inline void console_write_ch(console_ch_t *dest, uint32_t ch)
balrog4d3b6f62008-02-10 16:33:14 +0000338{
Bernhard Kauerf6d20d02010-05-21 14:05:55 +0200339 if (!(ch & 0xff))
340 ch |= ' ';
Aurelien Jarno9ae19b62011-01-04 21:58:24 +0100341 *dest = ch;
balrog4d3b6f62008-02-10 16:33:14 +0000342}
343
pbrook87ecb682007-11-17 17:14:51 +0000344typedef void (*vga_hw_update_ptr)(void *);
345typedef void (*vga_hw_invalidate_ptr)(void *);
Gerd Hoffmann45efb162012-02-24 12:43:45 +0100346typedef void (*vga_hw_screen_dump_ptr)(void *, const char *, bool cswitch);
Anthony Liguoric227f092009-10-01 16:12:16 -0500347typedef void (*vga_hw_text_update_ptr)(void *, console_ch_t *);
pbrook87ecb682007-11-17 17:14:51 +0000348
aliguori3023f332009-01-16 19:04:14 +0000349DisplayState *graphic_console_init(vga_hw_update_ptr update,
350 vga_hw_invalidate_ptr invalidate,
351 vga_hw_screen_dump_ptr screen_dump,
352 vga_hw_text_update_ptr text_update,
353 void *opaque);
354
pbrook87ecb682007-11-17 17:14:51 +0000355void vga_hw_update(void);
356void vga_hw_invalidate(void);
357void vga_hw_screen_dump(const char *filename);
Anthony Liguoric227f092009-10-01 16:12:16 -0500358void vga_hw_text_update(console_ch_t *chardata);
pbrook87ecb682007-11-17 17:14:51 +0000359
360int is_graphic_console(void);
balrogc21bbcf2008-09-24 03:32:33 +0000361int is_fixedsize_console(void);
Markus Armbruster1f514702012-02-07 15:09:08 +0100362CharDriverState *text_console_init(QemuOpts *opts);
aliguori2796dae2009-01-16 20:23:27 +0000363void text_consoles_set_display(DisplayState *ds);
pbrook87ecb682007-11-17 17:14:51 +0000364void console_select(unsigned int index);
365void console_color_init(DisplayState *ds);
aliguori3023f332009-01-16 19:04:14 +0000366void qemu_console_resize(DisplayState *ds, int width, int height);
367void qemu_console_copy(DisplayState *ds, int src_x, int src_y,
368 int dst_x, int dst_y, int w, int h);
pbrook87ecb682007-11-17 17:14:51 +0000369
370/* sdl.c */
371void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
372
373/* cocoa.m */
374void cocoa_display_init(DisplayState *ds, int full_screen);
375
376/* vnc.c */
377void vnc_display_init(DisplayState *ds);
378void vnc_display_close(DisplayState *ds);
379int vnc_display_open(DisplayState *ds, const char *display);
Daniel P. Berrange13661082011-06-23 13:31:42 +0100380void vnc_display_add_client(DisplayState *ds, int csock, int skipauth);
Anthony Liguori1cd20f82011-01-31 14:27:36 -0600381int vnc_display_disable_login(DisplayState *ds);
Jes Sorensen821601e2011-03-16 13:33:36 +0100382char *vnc_display_local_addr(DisplayState *ds);
383#ifdef CONFIG_VNC
384int vnc_display_password(DisplayState *ds, const char *password);
Gerd Hoffmann3c9405a2010-10-07 11:50:45 +0200385int vnc_display_pw_expire(DisplayState *ds, time_t expires);
Jes Sorensen821601e2011-03-16 13:33:36 +0100386#else
387static inline int vnc_display_password(DisplayState *ds, const char *password)
388{
Jes Sorensen821601e2011-03-16 13:33:36 +0100389 return -ENODEV;
390}
391static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
392{
Jes Sorensen821601e2011-03-16 13:33:36 +0100393 return -ENODEV;
394};
Jes Sorensen821601e2011-03-16 13:33:36 +0100395#endif
pbrook87ecb682007-11-17 17:14:51 +0000396
balrog4d3b6f62008-02-10 16:33:14 +0000397/* curses.c */
398void curses_display_init(DisplayState *ds, int full_screen);
399
pbrook87ecb682007-11-17 17:14:51 +0000400#endif