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 194 DisplayState *init_displaystate(void); 195 DisplaySurface* qemu_create_displaysurface_from(int width, int height, int bpp, 196 int linesize, uint8_t *data, 197 bool byteswap); 198 PixelFormat qemu_different_endianness_pixelformat(int bpp); 199 PixelFormat qemu_default_pixelformat(int bpp); 200 201 DisplaySurface *qemu_create_displaysurface(int width, int height); 202 void qemu_free_displaysurface(DisplaySurface *surface); 203 204 static inline int is_surface_bgr(DisplaySurface *surface) 205 { 206 if (surface->pf.bits_per_pixel == 32 && surface->pf.rshift == 0) 207 return 1; 208 else 209 return 0; 210 } 211 212 static inline int is_buffer_shared(DisplaySurface *surface) 213 { 214 return !(surface->flags & QEMU_ALLOCATED_FLAG); 215 } 216 217 void gui_setup_refresh(DisplayState *ds); 218 219 void register_displaychangelistener(DisplayState *ds, 220 DisplayChangeListener *dcl); 221 void unregister_displaychangelistener(DisplayChangeListener *dcl); 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_refresh(DisplayState *s); 227 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y, 228 int dst_x, int dst_y, int w, int h); 229 void dpy_text_cursor(QemuConsole *con, int x, int y); 230 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h); 231 void dpy_text_resize(QemuConsole *con, int w, int h); 232 void dpy_mouse_set(QemuConsole *con, int x, int y, int on); 233 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor); 234 bool dpy_cursor_define_supported(QemuConsole *con); 235 236 static inline int surface_stride(DisplaySurface *s) 237 { 238 return pixman_image_get_stride(s->image); 239 } 240 241 static inline void *surface_data(DisplaySurface *s) 242 { 243 return pixman_image_get_data(s->image); 244 } 245 246 static inline int surface_width(DisplaySurface *s) 247 { 248 return pixman_image_get_width(s->image); 249 } 250 251 static inline int surface_height(DisplaySurface *s) 252 { 253 return pixman_image_get_height(s->image); 254 } 255 256 static inline int surface_bits_per_pixel(DisplaySurface *s) 257 { 258 int bits = PIXMAN_FORMAT_BPP(s->format); 259 return bits; 260 } 261 262 static inline int surface_bytes_per_pixel(DisplaySurface *s) 263 { 264 int bits = PIXMAN_FORMAT_BPP(s->format); 265 return (bits + 7) / 8; 266 } 267 268 #ifdef CONFIG_CURSES 269 #include <curses.h> 270 typedef chtype console_ch_t; 271 #else 272 typedef unsigned long console_ch_t; 273 #endif 274 static inline void console_write_ch(console_ch_t *dest, uint32_t ch) 275 { 276 if (!(ch & 0xff)) 277 ch |= ' '; 278 *dest = ch; 279 } 280 281 typedef void (*graphic_hw_update_ptr)(void *); 282 typedef void (*graphic_hw_invalidate_ptr)(void *); 283 typedef void (*graphic_hw_screen_dump_ptr)(void *, const char *, bool cswitch, 284 Error **errp); 285 typedef void (*graphic_hw_text_update_ptr)(void *, console_ch_t *); 286 287 QemuConsole *graphic_console_init(graphic_hw_update_ptr update, 288 graphic_hw_invalidate_ptr invalidate, 289 graphic_hw_screen_dump_ptr screen_dump, 290 graphic_hw_text_update_ptr text_update, 291 void *opaque); 292 293 void graphic_hw_update(QemuConsole *con); 294 void graphic_hw_invalidate(QemuConsole *con); 295 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata); 296 297 int is_graphic_console(void); 298 int is_fixedsize_console(void); 299 void text_consoles_set_display(DisplayState *ds); 300 void console_select(unsigned int index); 301 void console_color_init(DisplayState *ds); 302 void qemu_console_resize(QemuConsole *con, int width, int height); 303 void qemu_console_copy(QemuConsole *con, int src_x, int src_y, 304 int dst_x, int dst_y, int w, int h); 305 DisplaySurface *qemu_console_surface(QemuConsole *con); 306 DisplayState *qemu_console_displaystate(QemuConsole *console); 307 308 typedef CharDriverState *(VcHandler)(ChardevVC *vc); 309 310 CharDriverState *vc_init(ChardevVC *vc); 311 void register_vc_handler(VcHandler *handler); 312 313 /* sdl.c */ 314 void sdl_display_init(DisplayState *ds, int full_screen, int no_frame); 315 316 /* cocoa.m */ 317 void cocoa_display_init(DisplayState *ds, int full_screen); 318 319 /* vnc.c */ 320 void vnc_display_init(DisplayState *ds); 321 void vnc_display_open(DisplayState *ds, const char *display, Error **errp); 322 void vnc_display_add_client(DisplayState *ds, int csock, int skipauth); 323 char *vnc_display_local_addr(DisplayState *ds); 324 #ifdef CONFIG_VNC 325 int vnc_display_password(DisplayState *ds, const char *password); 326 int vnc_display_pw_expire(DisplayState *ds, time_t expires); 327 #else 328 static inline int vnc_display_password(DisplayState *ds, const char *password) 329 { 330 return -ENODEV; 331 } 332 static inline int vnc_display_pw_expire(DisplayState *ds, time_t expires) 333 { 334 return -ENODEV; 335 }; 336 #endif 337 338 /* curses.c */ 339 void curses_display_init(DisplayState *ds, int full_screen); 340 341 /* input.c */ 342 int index_from_key(const char *key); 343 int index_from_keycode(int code); 344 345 /* gtk.c */ 346 void early_gtk_display_init(void); 347 void gtk_display_init(DisplayState *ds); 348 349 #endif 350