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