1 | #ifndef CONSOLE_H |
2 | #define CONSOLE_H |
3 | |
4 | #include "ui/qemu-pixman.h" |
5 | #include "qom/object.h" |
6 | #include "qemu/notify.h" |
7 | #include "qemu/error-report.h" |
8 | #include "qapi/qapi-types-ui.h" |
9 | |
10 | #ifdef CONFIG_OPENGL |
11 | # include <epoxy/gl.h> |
12 | # include "ui/shader.h" |
13 | #endif |
14 | |
15 | /* keyboard/mouse support */ |
16 | |
17 | #define MOUSE_EVENT_LBUTTON 0x01 |
18 | #define MOUSE_EVENT_RBUTTON 0x02 |
19 | #define MOUSE_EVENT_MBUTTON 0x04 |
20 | #define MOUSE_EVENT_WHEELUP 0x08 |
21 | #define MOUSE_EVENT_WHEELDN 0x10 |
22 | |
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 | |
28 | /* in ms */ |
29 | #define GUI_REFRESH_INTERVAL_DEFAULT 30 |
30 | #define GUI_REFRESH_INTERVAL_IDLE 3000 |
31 | |
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 | |
47 | typedef void QEMUPutKBDEvent(void *opaque, int keycode); |
48 | typedef void QEMUPutLEDEvent(void *opaque, int ledstate); |
49 | typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state); |
50 | |
51 | typedef struct QEMUPutMouseEntry QEMUPutMouseEntry; |
52 | typedef struct QEMUPutKbdEntry QEMUPutKbdEntry; |
53 | typedef struct QEMUPutLEDEntry QEMUPutLEDEntry; |
54 | |
55 | QEMUPutKbdEntry *qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, |
56 | void *opaque); |
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); |
61 | void qemu_activate_mouse_event_handler(QEMUPutMouseEntry *entry); |
62 | |
63 | QEMUPutLEDEntry *qemu_add_led_event_handler(QEMUPutLEDEvent *func, void *opaque); |
64 | void qemu_remove_led_event_handler(QEMUPutLEDEntry *entry); |
65 | |
66 | void kbd_put_ledstate(int ledstate); |
67 | |
68 | typedef struct MouseTransformInfo { |
69 | /* Touchscreen resolution */ |
70 | int x; |
71 | int y; |
72 | /* Calibration values as used/generated by tslib */ |
73 | int a[7]; |
74 | } MouseTransformInfo; |
75 | |
76 | void hmp_mouse_set(Monitor *mon, const QDict *qdict); |
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 | |
101 | void kbd_put_keysym_console(QemuConsole *s, int keysym); |
102 | bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl); |
103 | void kbd_put_string_console(QemuConsole *s, const char *str, int len); |
104 | void kbd_put_keysym(int keysym); |
105 | |
106 | /* consoles */ |
107 | |
108 | #define TYPE_QEMU_CONSOLE "qemu-console" |
109 | #define QEMU_CONSOLE(obj) \ |
110 | OBJECT_CHECK(QemuConsole, (obj), TYPE_QEMU_CONSOLE) |
111 | #define QEMU_CONSOLE_GET_CLASS(obj) \ |
112 | OBJECT_GET_CLASS(QemuConsoleClass, (obj), TYPE_QEMU_CONSOLE) |
113 | #define QEMU_CONSOLE_CLASS(klass) \ |
114 | OBJECT_CLASS_CHECK(QemuConsoleClass, (klass), TYPE_QEMU_CONSOLE) |
115 | |
116 | typedef struct QemuConsoleClass QemuConsoleClass; |
117 | |
118 | struct QemuConsoleClass { |
119 | ObjectClass parent_class; |
120 | }; |
121 | |
122 | #define QEMU_ALLOCATED_FLAG 0x01 |
123 | |
124 | typedef struct DisplaySurface { |
125 | pixman_format_code_t format; |
126 | pixman_image_t *image; |
127 | uint8_t flags; |
128 | #ifdef CONFIG_OPENGL |
129 | GLenum glformat; |
130 | GLenum gltype; |
131 | GLuint texture; |
132 | #endif |
133 | } DisplaySurface; |
134 | |
135 | typedef struct QemuUIInfo { |
136 | /* geometry */ |
137 | int xoff; |
138 | int yoff; |
139 | uint32_t width; |
140 | uint32_t height; |
141 | } QemuUIInfo; |
142 | |
143 | /* cursor data format is 32bit RGBA */ |
144 | typedef struct QEMUCursor { |
145 | int width, height; |
146 | int hot_x, hot_y; |
147 | int refcount; |
148 | uint32_t data[]; |
149 | } QEMUCursor; |
150 | |
151 | QEMUCursor *cursor_alloc(int width, int height); |
152 | void cursor_get(QEMUCursor *c); |
153 | void cursor_put(QEMUCursor *c); |
154 | QEMUCursor *cursor_builtin_hidden(void); |
155 | QEMUCursor *cursor_builtin_left_ptr(void); |
156 | void cursor_print_ascii_art(QEMUCursor *c, const char *prefix); |
157 | int cursor_get_mono_bpl(QEMUCursor *c); |
158 | void cursor_set_mono(QEMUCursor *c, |
159 | uint32_t foreground, uint32_t background, uint8_t *image, |
160 | int transparent, uint8_t *mask); |
161 | void cursor_get_mono_image(QEMUCursor *c, int foreground, uint8_t *mask); |
162 | void cursor_get_mono_mask(QEMUCursor *c, int transparent, uint8_t *mask); |
163 | |
164 | typedef void *QEMUGLContext; |
165 | typedef struct QEMUGLParams QEMUGLParams; |
166 | |
167 | struct QEMUGLParams { |
168 | int major_ver; |
169 | int minor_ver; |
170 | }; |
171 | |
172 | typedef struct QemuDmaBuf { |
173 | int fd; |
174 | uint32_t width; |
175 | uint32_t height; |
176 | uint32_t stride; |
177 | uint32_t fourcc; |
178 | uint64_t modifier; |
179 | uint32_t texture; |
180 | bool y0_top; |
181 | } QemuDmaBuf; |
182 | |
183 | typedef struct DisplayState DisplayState; |
184 | |
185 | typedef struct DisplayChangeListenerOps { |
186 | const char *dpy_name; |
187 | |
188 | void (*dpy_refresh)(DisplayChangeListener *dcl); |
189 | |
190 | void (*dpy_gfx_update)(DisplayChangeListener *dcl, |
191 | int x, int y, int w, int h); |
192 | void (*dpy_gfx_switch)(DisplayChangeListener *dcl, |
193 | struct DisplaySurface *new_surface); |
194 | bool (*dpy_gfx_check_format)(DisplayChangeListener *dcl, |
195 | pixman_format_code_t format); |
196 | |
197 | void (*dpy_text_cursor)(DisplayChangeListener *dcl, |
198 | int x, int y); |
199 | void (*dpy_text_resize)(DisplayChangeListener *dcl, |
200 | int w, int h); |
201 | void (*dpy_text_update)(DisplayChangeListener *dcl, |
202 | int x, int y, int w, int h); |
203 | |
204 | void (*dpy_mouse_set)(DisplayChangeListener *dcl, |
205 | int x, int y, int on); |
206 | void (*dpy_cursor_define)(DisplayChangeListener *dcl, |
207 | QEMUCursor *cursor); |
208 | |
209 | QEMUGLContext (*dpy_gl_ctx_create)(DisplayChangeListener *dcl, |
210 | QEMUGLParams *params); |
211 | void (*dpy_gl_ctx_destroy)(DisplayChangeListener *dcl, |
212 | QEMUGLContext ctx); |
213 | int (*dpy_gl_ctx_make_current)(DisplayChangeListener *dcl, |
214 | QEMUGLContext ctx); |
215 | QEMUGLContext (*dpy_gl_ctx_get_current)(DisplayChangeListener *dcl); |
216 | |
217 | void (*dpy_gl_scanout_disable)(DisplayChangeListener *dcl); |
218 | void (*dpy_gl_scanout_texture)(DisplayChangeListener *dcl, |
219 | uint32_t backing_id, |
220 | bool backing_y_0_top, |
221 | uint32_t backing_width, |
222 | uint32_t backing_height, |
223 | uint32_t x, uint32_t y, |
224 | uint32_t w, uint32_t h); |
225 | void (*dpy_gl_scanout_dmabuf)(DisplayChangeListener *dcl, |
226 | QemuDmaBuf *dmabuf); |
227 | void (*dpy_gl_cursor_dmabuf)(DisplayChangeListener *dcl, |
228 | QemuDmaBuf *dmabuf, bool have_hot, |
229 | uint32_t hot_x, uint32_t hot_y); |
230 | void (*dpy_gl_cursor_position)(DisplayChangeListener *dcl, |
231 | uint32_t pos_x, uint32_t pos_y); |
232 | void (*dpy_gl_release_dmabuf)(DisplayChangeListener *dcl, |
233 | QemuDmaBuf *dmabuf); |
234 | void (*dpy_gl_update)(DisplayChangeListener *dcl, |
235 | uint32_t x, uint32_t y, uint32_t w, uint32_t h); |
236 | |
237 | } DisplayChangeListenerOps; |
238 | |
239 | struct DisplayChangeListener { |
240 | uint64_t update_interval; |
241 | const DisplayChangeListenerOps *ops; |
242 | DisplayState *ds; |
243 | QemuConsole *con; |
244 | |
245 | QLIST_ENTRY(DisplayChangeListener) next; |
246 | }; |
247 | |
248 | DisplayState *init_displaystate(void); |
249 | DisplaySurface *qemu_create_displaysurface_from(int width, int height, |
250 | pixman_format_code_t format, |
251 | int linesize, uint8_t *data); |
252 | DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image); |
253 | DisplaySurface *qemu_create_message_surface(int w, int h, |
254 | const char *msg); |
255 | PixelFormat qemu_default_pixelformat(int bpp); |
256 | |
257 | DisplaySurface *qemu_create_displaysurface(int width, int height); |
258 | void qemu_free_displaysurface(DisplaySurface *surface); |
259 | |
260 | static inline int is_surface_bgr(DisplaySurface *surface) |
261 | { |
262 | if (PIXMAN_FORMAT_BPP(surface->format) == 32 && |
263 | PIXMAN_FORMAT_TYPE(surface->format) == PIXMAN_TYPE_ABGR) { |
264 | return 1; |
265 | } else { |
266 | return 0; |
267 | } |
268 | } |
269 | |
270 | static inline int is_buffer_shared(DisplaySurface *surface) |
271 | { |
272 | return !(surface->flags & QEMU_ALLOCATED_FLAG); |
273 | } |
274 | |
275 | void register_displaychangelistener(DisplayChangeListener *dcl); |
276 | void update_displaychangelistener(DisplayChangeListener *dcl, |
277 | uint64_t interval); |
278 | void unregister_displaychangelistener(DisplayChangeListener *dcl); |
279 | |
280 | bool dpy_ui_info_supported(QemuConsole *con); |
281 | int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info); |
282 | |
283 | void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h); |
284 | void dpy_gfx_update_full(QemuConsole *con); |
285 | void dpy_gfx_replace_surface(QemuConsole *con, |
286 | DisplaySurface *surface); |
287 | void dpy_text_cursor(QemuConsole *con, int x, int y); |
288 | void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); |
289 | void dpy_text_resize(QemuConsole *con, int w, int h); |
290 | void dpy_mouse_set(QemuConsole *con, int x, int y, int on); |
291 | void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); |
292 | bool dpy_cursor_define_supported(QemuConsole *con); |
293 | bool dpy_gfx_check_format(QemuConsole *con, |
294 | pixman_format_code_t format); |
295 | |
296 | void dpy_gl_scanout_disable(QemuConsole *con); |
297 | void dpy_gl_scanout_texture(QemuConsole *con, |
298 | uint32_t backing_id, bool backing_y_0_top, |
299 | uint32_t backing_width, uint32_t backing_height, |
300 | uint32_t x, uint32_t y, uint32_t w, uint32_t h); |
301 | void dpy_gl_scanout_dmabuf(QemuConsole *con, |
302 | QemuDmaBuf *dmabuf); |
303 | void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf, |
304 | bool have_hot, uint32_t hot_x, uint32_t hot_y); |
305 | void dpy_gl_cursor_position(QemuConsole *con, |
306 | uint32_t pos_x, uint32_t pos_y); |
307 | void dpy_gl_release_dmabuf(QemuConsole *con, |
308 | QemuDmaBuf *dmabuf); |
309 | void dpy_gl_update(QemuConsole *con, |
310 | uint32_t x, uint32_t y, uint32_t w, uint32_t h); |
311 | |
312 | QEMUGLContext dpy_gl_ctx_create(QemuConsole *con, |
313 | QEMUGLParams *params); |
314 | void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx); |
315 | int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx); |
316 | QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con); |
317 | |
318 | bool console_has_gl(QemuConsole *con); |
319 | bool console_has_gl_dmabuf(QemuConsole *con); |
320 | |
321 | static inline int surface_stride(DisplaySurface *s) |
322 | { |
323 | return pixman_image_get_stride(s->image); |
324 | } |
325 | |
326 | static inline void *surface_data(DisplaySurface *s) |
327 | { |
328 | return pixman_image_get_data(s->image); |
329 | } |
330 | |
331 | static inline int surface_width(DisplaySurface *s) |
332 | { |
333 | return pixman_image_get_width(s->image); |
334 | } |
335 | |
336 | static inline int surface_height(DisplaySurface *s) |
337 | { |
338 | return pixman_image_get_height(s->image); |
339 | } |
340 | |
341 | static inline int surface_bits_per_pixel(DisplaySurface *s) |
342 | { |
343 | int bits = PIXMAN_FORMAT_BPP(s->format); |
344 | return bits; |
345 | } |
346 | |
347 | static inline int surface_bytes_per_pixel(DisplaySurface *s) |
348 | { |
349 | int bits = PIXMAN_FORMAT_BPP(s->format); |
350 | return DIV_ROUND_UP(bits, 8); |
351 | } |
352 | |
353 | static inline pixman_format_code_t surface_format(DisplaySurface *s) |
354 | { |
355 | return s->format; |
356 | } |
357 | |
358 | typedef uint32_t console_ch_t; |
359 | |
360 | static inline void console_write_ch(console_ch_t *dest, uint32_t ch) |
361 | { |
362 | *dest = ch; |
363 | } |
364 | |
365 | typedef struct GraphicHwOps { |
366 | void (*invalidate)(void *opaque); |
367 | void (*gfx_update)(void *opaque); |
368 | void (*text_update)(void *opaque, console_ch_t *text); |
369 | void (*update_interval)(void *opaque, uint64_t interval); |
370 | int (*ui_info)(void *opaque, uint32_t head, QemuUIInfo *info); |
371 | void (*gl_block)(void *opaque, bool block); |
372 | } GraphicHwOps; |
373 | |
374 | QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head, |
375 | const GraphicHwOps *ops, |
376 | void *opaque); |
377 | void graphic_console_set_hwops(QemuConsole *con, |
378 | const GraphicHwOps *hw_ops, |
379 | void *opaque); |
380 | void graphic_console_close(QemuConsole *con); |
381 | |
382 | void graphic_hw_update(QemuConsole *con); |
383 | void graphic_hw_invalidate(QemuConsole *con); |
384 | void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); |
385 | void graphic_hw_gl_block(QemuConsole *con, bool block); |
386 | |
387 | void qemu_console_early_init(void); |
388 | |
389 | QemuConsole *qemu_console_lookup_by_index(unsigned int index); |
390 | QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head); |
391 | QemuConsole *qemu_console_lookup_by_device_name(const char *device_id, |
392 | uint32_t head, Error **errp); |
393 | QemuConsole *qemu_console_lookup_unused(void); |
394 | bool qemu_console_is_visible(QemuConsole *con); |
395 | bool qemu_console_is_graphic(QemuConsole *con); |
396 | bool qemu_console_is_fixedsize(QemuConsole *con); |
397 | bool qemu_console_is_gl_blocked(QemuConsole *con); |
398 | char *qemu_console_get_label(QemuConsole *con); |
399 | int qemu_console_get_index(QemuConsole *con); |
400 | uint32_t qemu_console_get_head(QemuConsole *con); |
401 | QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con); |
402 | int qemu_console_get_width(QemuConsole *con, int fallback); |
403 | int qemu_console_get_height(QemuConsole *con, int fallback); |
404 | /* Return the low-level window id for the console */ |
405 | int qemu_console_get_window_id(QemuConsole *con); |
406 | /* Set the low-level window id for the console */ |
407 | void qemu_console_set_window_id(QemuConsole *con, int window_id); |
408 | |
409 | void console_select(unsigned int index); |
410 | void qemu_console_resize(QemuConsole *con, int width, int height); |
411 | DisplaySurface *qemu_console_surface(QemuConsole *con); |
412 | |
413 | /* console-gl.c */ |
414 | #ifdef CONFIG_OPENGL |
415 | bool console_gl_check_format(DisplayChangeListener *dcl, |
416 | pixman_format_code_t format); |
417 | void surface_gl_create_texture(QemuGLShader *gls, |
418 | DisplaySurface *surface); |
419 | void surface_gl_update_texture(QemuGLShader *gls, |
420 | DisplaySurface *surface, |
421 | int x, int y, int w, int h); |
422 | void surface_gl_render_texture(QemuGLShader *gls, |
423 | DisplaySurface *surface); |
424 | void surface_gl_destroy_texture(QemuGLShader *gls, |
425 | DisplaySurface *surface); |
426 | void surface_gl_setup_viewport(QemuGLShader *gls, |
427 | DisplaySurface *surface, |
428 | int ww, int wh); |
429 | #endif |
430 | |
431 | typedef struct QemuDisplay QemuDisplay; |
432 | |
433 | struct QemuDisplay { |
434 | DisplayType type; |
435 | void (*early_init)(DisplayOptions *opts); |
436 | void (*init)(DisplayState *ds, DisplayOptions *opts); |
437 | }; |
438 | |
439 | void qemu_display_register(QemuDisplay *ui); |
440 | bool qemu_display_find_default(DisplayOptions *opts); |
441 | void qemu_display_early_init(DisplayOptions *opts); |
442 | void qemu_display_init(DisplayState *ds, DisplayOptions *opts); |
443 | |
444 | /* vnc.c */ |
445 | void vnc_display_init(const char *id, Error **errp); |
446 | void vnc_display_open(const char *id, Error **errp); |
447 | void vnc_display_add_client(const char *id, int csock, bool skipauth); |
448 | int vnc_display_password(const char *id, const char *password); |
449 | int vnc_display_pw_expire(const char *id, time_t expires); |
450 | QemuOpts *vnc_parse(const char *str, Error **errp); |
451 | int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp); |
452 | |
453 | /* input.c */ |
454 | int index_from_key(const char *key, size_t key_length); |
455 | |
456 | #endif |
457 | |