xref: /openbmc/qemu/include/ui/console.h (revision bfb27e60) 
1 #ifndef CONSOLE_H
2 #define CONSOLE_H
3 
4 #include "ui/qemu-pixman.h"
5 #include "qom/object.h"
6 #include "qapi/qmp/qdict.h"
7 #include "qemu/notify.h"
8 #include "monitor/monitor.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 #define MOUSE_EVENT_WHEELUP 0x08
18 #define MOUSE_EVENT_WHEELDN 0x10
19 
20 /* identical to the ps/2 keyboard bits */
21 #define QEMU_SCROLL_LOCK_LED (1 << 0)
22 #define QEMU_NUM_LOCK_LED    (1 << 1)
23 #define QEMU_CAPS_LOCK_LED   (1 << 2)
24 
25 /* in ms */
26 #define GUI_REFRESH_INTERVAL_DEFAULT    30
27 #define GUI_REFRESH_INTERVAL_IDLE     3000
28 
29 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
30 typedef void QEMUPutLEDEvent(void *opaque, int ledstate);
31 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
32 
33 typedef struct QEMUPutMouseEntry QEMUPutMouseEntry;
34 typedef struct QEMUPutKbdEntry QEMUPutKbdEntry;
35 typedef struct QEMUPutLEDEntry QEMUPutLEDEntry;
36 
37 QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func,
38                                             void *opaque);
39 void qemu_remove_kbd_event_handler(QEMUPutKbdEntry *entry);
40 QEMUPutMouseEntry *qemu_add_mouse_event_handler(QEMUPutMouseEvent *func,
41                                                 void *opaque, int absolute,
42                                                 const char *name);
43 void qemu_remove_mouse_event_handler(QEMUPutMouseEntry *entry);
44 void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry);
45 
46 QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque);
47 void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry);
48 
49 void kbd_put_ledstate(int ledstate);
50 
51 struct MouseTransformInfo {
52     /* Touchscreen resolution */
53     int x;
54     int y;
55     /* Calibration values as used/generated by tslib */
56     int a[7];
57 };
58 
59 void do_mouse_set(Monitor *mon, const QDict *qdict);
60 
61 /* keysym is a unicode code except for special keys (see QEMU_KEY_xxx
62    constants) */
63 #define QEMU_KEY_ESC1(c) ((c) | 0xe100)
64 #define QEMU_KEY_BACKSPACE  0x007f
65 #define QEMU_KEY_UP         QEMU_KEY_ESC1('A')
66 #define QEMU_KEY_DOWN       QEMU_KEY_ESC1('B')
67 #define QEMU_KEY_RIGHT      QEMU_KEY_ESC1('C')
68 #define QEMU_KEY_LEFT       QEMU_KEY_ESC1('D')
69 #define QEMU_KEY_HOME       QEMU_KEY_ESC1(1)
70 #define QEMU_KEY_END        QEMU_KEY_ESC1(4)
71 #define QEMU_KEY_PAGEUP     QEMU_KEY_ESC1(5)
72 #define QEMU_KEY_PAGEDOWN   QEMU_KEY_ESC1(6)
73 #define QEMU_KEY_DELETE     QEMU_KEY_ESC1(3)
74 
75 #define QEMU_KEY_CTRL_UP         0xe400
76 #define QEMU_KEY_CTRL_DOWN       0xe401
77 #define QEMU_KEY_CTRL_LEFT       0xe402
78 #define QEMU_KEY_CTRL_RIGHT      0xe403
79 #define QEMU_KEY_CTRL_HOME       0xe404
80 #define QEMU_KEY_CTRL_END        0xe405
81 #define QEMU_KEY_CTRL_PAGEUP     0xe406
82 #define QEMU_KEY_CTRL_PAGEDOWN   0xe407
83 
84 void kbd_put_keysym_console(QemuConsole *s, int keysym);
85 bool kbd_put_qcode_console(QemuConsole *s, int qcode);
86 void kbd_put_string_console(QemuConsole *s, const char *str, int len);
87 void kbd_put_keysym(int keysym);
88 
89 /* consoles */
90 
91 #define TYPE_QEMU_CONSOLE "qemu-console"
92 #define QEMU_CONSOLE(obj) \
93     OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE)
94 #define QEMU_CONSOLE_GET_CLASS(obj) \
95     OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE)
96 #define QEMU_CONSOLE_CLASS(klass) \
97     OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE)
98 
99 typedef struct QemuConsoleClass QemuConsoleClass;
100 
101 struct QemuConsoleClass {
102     ObjectClass parent_class;
103 };
104 
105 #define QEMU_ALLOCATED_FLAG     0x01
106 
107 struct PixelFormat {
108     uint8_t bits_per_pixel;
109     uint8_t bytes_per_pixel;
110     uint8_t depth; /* color depth in bits */
111     uint32_t rmask, gmask, bmask, amask;
112     uint8_t rshift, gshift, bshift, ashift;
113     uint8_t rmax, gmax, bmax, amax;
114     uint8_t rbits, gbits, bbits, abits;
115 };
116 
117 struct DisplaySurface {
118     pixman_format_code_t format;
119     pixman_image_t *image;
120     uint8_t flags;
121 };
122 
123 typedef struct QemuUIInfo {
124     /* geometry */
125     int       xoff;
126     int       yoff;
127     uint32_t  width;
128     uint32_t  height;
129 } QemuUIInfo;
130 
131 /* cursor data format is 32bit RGBA */
132 typedef struct QEMUCursor {
133     int                 width, height;
134     int                 hot_x, hot_y;
135     int                 refcount;
136     uint32_t            data[];
137 } QEMUCursor;
138 
139 QEMUCursor *cursor_alloc(int width, int height);
140 void cursor_get(QEMUCursor *c);
141 void cursor_put(QEMUCursor *c);
142 QEMUCursor *cursor_builtin_hidden(void);
143 QEMUCursor *cursor_builtin_left_ptr(void);
144 void cursor_print_ascii_art(QEMUCursor *c, const char *prefix);
145 int cursor_get_mono_bpl(QEMUCursor *c);
146 void cursor_set_mono(QEMUCursor *c,
147                      uint32_t foreground, uint32_t background, uint8_t *image,
148                      int transparent, uint8_t *mask);
149 void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask);
150 void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask);
151 
152 typedef struct DisplayChangeListenerOps {
153     const char *dpy_name;
154 
155     void (*dpy_refresh)(DisplayChangeListener *dcl);
156 
157     void (*dpy_gfx_update)(DisplayChangeListener *dcl,
158                            int x, int y, int w, int h);
159     void (*dpy_gfx_switch)(DisplayChangeListener *dcl,
160                            struct DisplaySurface *new_surface);
161     void (*dpy_gfx_copy)(DisplayChangeListener *dcl,
162                          int src_x, int src_y,
163                          int dst_x, int dst_y, int w, int h);
164 
165     void (*dpy_text_cursor)(DisplayChangeListener *dcl,
166                             int x, int y);
167     void (*dpy_text_resize)(DisplayChangeListener *dcl,
168                             int w, int h);
169     void (*dpy_text_update)(DisplayChangeListener *dcl,
170                             int x, int y, int w, int h);
171 
172     void (*dpy_mouse_set)(DisplayChangeListener *dcl,
173                           int x, int y, int on);
174     void (*dpy_cursor_define)(DisplayChangeListener *dcl,
175                               QEMUCursor *cursor);
176 } DisplayChangeListenerOps;
177 
178 struct DisplayChangeListener {
179     uint64_t update_interval;
180     const DisplayChangeListenerOps *ops;
181     DisplayState *ds;
182     QemuConsole *con;
183 
184     QLIST_ENTRY(DisplayChangeListener) next;
185 };
186 
187 DisplayState *init_displaystate(void);
188 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
189                                                 pixman_format_code_t format,
190                                                 int linesize, uint8_t *data);
191 DisplaySurface *qemu_create_displaysurface_guestmem(int width, int height,
192                                                     pixman_format_code_t format,
193                                                     int linesize,
194                                                     uint64_t addr);
195 PixelFormat qemu_different_endianness_pixelformat(int bpp);
196 PixelFormat qemu_default_pixelformat(int bpp);
197 
198 DisplaySurface *qemu_create_displaysurface(int width, int height);
199 void qemu_free_displaysurface(DisplaySurface *surface);
200 
201 static inline int is_surface_bgr(DisplaySurface *surface)
202 {
203     if (PIXMAN_FORMAT_BPP(surface->format) == 32 &&
204         PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) {
205         return 1;
206     } else {
207         return 0;
208     }
209 }
210 
211 static inline int is_buffer_shared(DisplaySurface *surface)
212 {
213     return !(surface->flags & QEMU_ALLOCATED_FLAG);
214 }
215 
216 void register_displaychangelistener(DisplayChangeListener *dcl);
217 void update_displaychangelistener(DisplayChangeListener *dcl,
218                                   uint64_t interval);
219 void unregister_displaychangelistener(DisplayChangeListener *dcl);
220 
221 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info);
222 
223 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h);
224 void dpy_gfx_replace_surface(QemuConsole *con,
225                              DisplaySurface *surface);
226 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
227                   int dst_x, int dst_y, int w, int h);
228 void dpy_text_cursor(QemuConsole *con, int x, int y);
229 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h);
230 void dpy_text_resize(QemuConsole *con, int w, int h);
231 void dpy_mouse_set(QemuConsole *con, int x, int y, int on);
232 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor);
233 bool dpy_cursor_define_supported(QemuConsole *con);
234 void dpy_gfx_update_dirty(QemuConsole *con,
235                           MemoryRegion *address_space,
236                           uint64_t base,
237                           bool invalidate);
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 struct GraphicHwOps {
285     void (*invalidate)(void *opaque);
286     void (*gfx_update)(void *opaque);
287     void (*text_update)(void *opaque, console_ch_t *text);
288     void (*update_interval)(void *opaque, uint64_t interval);
289     int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info);
290 } GraphicHwOps;
291 
292 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
293                                   const GraphicHwOps *ops,
294                                   void *opaque);
295 
296 void graphic_hw_update(QemuConsole *con);
297 void graphic_hw_invalidate(QemuConsole *con);
298 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata);
299 
300 QemuConsole *qemu_console_lookup_by_index(unsigned int index);
301 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head);
302 bool qemu_console_is_visible(QemuConsole *con);
303 bool qemu_console_is_graphic(QemuConsole *con);
304 bool qemu_console_is_fixedsize(QemuConsole *con);
305 int qemu_console_get_index(QemuConsole *con);
306 uint32_t qemu_console_get_head(QemuConsole *con);
307 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con);
308 int qemu_console_get_width(QemuConsole *con, int fallback);
309 int qemu_console_get_height(QemuConsole *con, int fallback);
310 
311 void text_consoles_set_display(DisplayState *ds);
312 void console_select(unsigned int index);
313 void console_color_init(DisplayState *ds);
314 void qemu_console_resize(QemuConsole *con, int width, int height);
315 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
316                        int dst_x, int dst_y, int w, int h);
317 DisplaySurface *qemu_console_surface(QemuConsole *con);
318 DisplayState *qemu_console_displaystate(QemuConsole *console);
319 
320 /* sdl.c */
321 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame);
322 
323 /* cocoa.m */
324 void cocoa_display_init(DisplayState *ds, int full_screen);
325 
326 /* vnc.c */
327 void vnc_display_init(DisplayState *ds);
328 void vnc_display_open(DisplayState *ds, const char *display, Error **errp);
329 void vnc_display_add_client(DisplayState *ds, int csock, bool skipauth);
330 char *vnc_display_local_addr(DisplayState *ds);
331 #ifdef CONFIG_VNC
332 int vnc_display_password(DisplayState *ds, const char *password);
333 int vnc_display_pw_expire(DisplayState *ds, time_t expires);
334 #else
335 static inline int vnc_display_password(DisplayState *ds, const char *password)
336 {
337     return -ENODEV;
338 }
339 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires)
340 {
341     return -ENODEV;
342 };
343 #endif
344 
345 /* curses.c */
346 void curses_display_init(DisplayState *ds, int full_screen);
347 
348 /* input.c */
349 int index_from_key(const char *key);
350 
351 /* gtk.c */
352 void early_gtk_display_init(void);
353 void gtk_display_init(DisplayState *ds, bool full_screen, bool grab_on_hover);
354 
355 #endif
356