2 * QEMU graphical console
4 * Copyright (c) 2004 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "ui/console.h"
27 #include "hw/qdev-core.h"
28 #include "qapi/error.h"
29 #include "qapi/qapi-commands-ui.h"
30 #include "qemu/module.h"
31 #include "qemu/option.h"
32 #include "qemu/timer.h"
33 #include "chardev/char-fe.h"
35 #include "exec/memory.h"
36 #include "io/channel-file.h"
37 #include "qom/object.h"
39 #define DEFAULT_BACKSCROLL 512
40 #define CONSOLE_CURSOR_PERIOD 500
42 typedef struct TextAttributes {
52 typedef struct TextCell {
54 TextAttributes t_attrib;
57 #define MAX_ESC_PARAMS 3
65 typedef struct QEMUFIFO {
68 int count, wptr, rptr;
71 static int qemu_fifo_write(QEMUFIFO *f, const uint8_t *buf, int len1)
75 l = f->buf_size - f->count;
80 l = f->buf_size - f->wptr;
83 memcpy(f->buf + f->wptr, buf, l);
85 if (f->wptr >= f->buf_size)
94 static int qemu_fifo_read(QEMUFIFO *f, uint8_t *buf, int len1)
102 l = f->buf_size - f->rptr;
105 memcpy(buf, f->buf + f->rptr, l);
107 if (f->rptr >= f->buf_size)
119 TEXT_CONSOLE_FIXED_SIZE
126 console_type_t console_type;
128 DisplaySurface *surface;
130 DisplayChangeListener *gl;
134 /* Graphic console state. */
139 const GraphicHwOps *hw_ops;
142 /* Text console state */
146 int backscroll_height;
148 int x_saved, y_saved;
151 TextAttributes t_attrib_default; /* default text attributes */
152 TextAttributes t_attrib; /* currently active text attributes */
154 int text_x[2], text_y[2], cursor_invalidate;
163 int esc_params[MAX_ESC_PARAMS];
167 /* fifo for key pressed */
169 uint8_t out_fifo_buf[16];
170 QEMUTimer *kbd_timer;
173 QTAILQ_ENTRY(QemuConsole) next;
176 struct DisplayState {
177 QEMUTimer *gui_timer;
178 uint64_t last_update;
179 uint64_t update_interval;
184 QLIST_HEAD(, DisplayChangeListener) listeners;
187 static DisplayState *display_state;
188 static QemuConsole *active_console;
189 static QTAILQ_HEAD(, QemuConsole) consoles =
190 QTAILQ_HEAD_INITIALIZER(consoles);
191 static bool cursor_visible_phase;
192 static QEMUTimer *cursor_timer;
194 static void text_console_do_init(Chardev *chr, DisplayState *ds);
195 static void dpy_refresh(DisplayState *s);
196 static DisplayState *get_alloc_displaystate(void);
197 static void text_console_update_cursor_timer(void);
198 static void text_console_update_cursor(void *opaque);
200 static void gui_update(void *opaque)
202 uint64_t interval = GUI_REFRESH_INTERVAL_IDLE;
203 uint64_t dcl_interval;
204 DisplayState *ds = opaque;
205 DisplayChangeListener *dcl;
208 ds->refreshing = true;
210 ds->refreshing = false;
212 QLIST_FOREACH(dcl, &ds->listeners, next) {
213 dcl_interval = dcl->update_interval ?
214 dcl->update_interval : GUI_REFRESH_INTERVAL_DEFAULT;
215 if (interval > dcl_interval) {
216 interval = dcl_interval;
219 if (ds->update_interval != interval) {
220 ds->update_interval = interval;
221 QTAILQ_FOREACH(con, &consoles, next) {
222 if (con->hw_ops->update_interval) {
223 con->hw_ops->update_interval(con->hw, interval);
226 trace_console_refresh(interval);
228 ds->last_update = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
229 timer_mod(ds->gui_timer, ds->last_update + interval);
232 static void gui_setup_refresh(DisplayState *ds)
234 DisplayChangeListener *dcl;
235 bool need_timer = false;
236 bool have_gfx = false;
237 bool have_text = false;
239 QLIST_FOREACH(dcl, &ds->listeners, next) {
240 if (dcl->ops->dpy_refresh != NULL) {
243 if (dcl->ops->dpy_gfx_update != NULL) {
246 if (dcl->ops->dpy_text_update != NULL) {
251 if (need_timer && ds->gui_timer == NULL) {
252 ds->gui_timer = timer_new_ms(QEMU_CLOCK_REALTIME, gui_update, ds);
253 timer_mod(ds->gui_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME));
255 if (!need_timer && ds->gui_timer != NULL) {
256 timer_free(ds->gui_timer);
257 ds->gui_timer = NULL;
260 ds->have_gfx = have_gfx;
261 ds->have_text = have_text;
264 void graphic_hw_update_done(QemuConsole *con)
267 qemu_co_queue_restart_all(&con->dump_queue);
271 void graphic_hw_update(QemuConsole *con)
274 con = con ? con : active_console;
278 if (con->hw_ops->gfx_update) {
279 con->hw_ops->gfx_update(con->hw);
280 async = con->hw_ops->gfx_update_async;
283 graphic_hw_update_done(con);
287 void graphic_hw_gl_block(QemuConsole *con, bool block)
291 con->gl_block = block;
292 if (con->hw_ops->gl_block) {
293 con->hw_ops->gl_block(con->hw, block);
297 void graphic_hw_gl_flushed(QemuConsole *con)
301 if (con->hw_ops->gl_flushed) {
302 con->hw_ops->gl_flushed(con->hw);
306 int qemu_console_get_window_id(QemuConsole *con)
308 return con->window_id;
311 void qemu_console_set_window_id(QemuConsole *con, int window_id)
313 con->window_id = window_id;
316 void graphic_hw_invalidate(QemuConsole *con)
319 con = active_console;
321 if (con && con->hw_ops->invalidate) {
322 con->hw_ops->invalidate(con->hw);
326 static bool ppm_save(int fd, pixman_image_t *image, Error **errp)
328 int width = pixman_image_get_width(image);
329 int height = pixman_image_get_height(image);
330 g_autoptr(Object) ioc = OBJECT(qio_channel_file_new_fd(fd));
331 g_autofree char *header = NULL;
332 g_autoptr(pixman_image_t) linebuf = NULL;
335 trace_ppm_save(fd, image);
337 header = g_strdup_printf("P6\n%d %d\n%d\n", width, height, 255);
338 if (qio_channel_write_all(QIO_CHANNEL(ioc),
339 header, strlen(header), errp) < 0) {
343 linebuf = qemu_pixman_linebuf_create(PIXMAN_BE_r8g8b8, width);
344 for (y = 0; y < height; y++) {
345 qemu_pixman_linebuf_fill(linebuf, image, width, 0, y);
346 if (qio_channel_write_all(QIO_CHANNEL(ioc),
347 (char *)pixman_image_get_data(linebuf),
348 pixman_image_get_stride(linebuf), errp) < 0) {
356 static void graphic_hw_update_bh(void *con)
358 graphic_hw_update(con);
361 /* Safety: coroutine-only, concurrent-coroutine safe, main thread only */
363 qmp_screendump(const char *filename, bool has_device, const char *device,
364 bool has_head, int64_t head, Error **errp)
366 g_autoptr(pixman_image_t) image = NULL;
368 DisplaySurface *surface;
372 con = qemu_console_lookup_by_device_name(device, has_head ? head : 0,
379 error_setg(errp, "'head' must be specified together with 'device'");
382 con = qemu_console_lookup_by_index(0);
384 error_setg(errp, "There is no console to take a screendump from");
389 if (qemu_co_queue_empty(&con->dump_queue)) {
390 /* Defer the update, it will restart the pending coroutines */
391 aio_bh_schedule_oneshot(qemu_get_aio_context(),
392 graphic_hw_update_bh, con);
394 qemu_co_queue_wait(&con->dump_queue, NULL);
397 * All pending coroutines are woken up, while the BQL is held. No
398 * further graphic update are possible until it is released. Take
399 * an image ref before that.
401 surface = qemu_console_surface(con);
403 error_setg(errp, "no surface");
406 image = pixman_image_ref(surface->image);
408 fd = qemu_open_old(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666);
410 error_setg(errp, "failed to open file '%s': %s", filename,
416 * The image content could potentially be updated as the coroutine
417 * yields and releases the BQL. It could produce corrupted dump, but
418 * it should be otherwise safe.
420 if (!ppm_save(fd, image, errp)) {
421 qemu_unlink(filename);
425 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata)
428 con = active_console;
430 if (con && con->hw_ops->text_update) {
431 con->hw_ops->text_update(con->hw, chardata);
435 static void vga_fill_rect(QemuConsole *con,
436 int posx, int posy, int width, int height,
437 pixman_color_t color)
439 DisplaySurface *surface = qemu_console_surface(con);
440 pixman_rectangle16_t rect = {
441 .x = posx, .y = posy, .width = width, .height = height
444 pixman_image_fill_rectangles(PIXMAN_OP_SRC, surface->image,
448 /* copy from (xs, ys) to (xd, yd) a rectangle of size (w, h) */
449 static void vga_bitblt(QemuConsole *con,
450 int xs, int ys, int xd, int yd, int w, int h)
452 DisplaySurface *surface = qemu_console_surface(con);
454 pixman_image_composite(PIXMAN_OP_SRC,
455 surface->image, NULL, surface->image,
456 xs, ys, 0, 0, xd, yd, w, h);
459 /***********************************************************/
460 /* basic char display */
462 #define FONT_HEIGHT 16
467 #define QEMU_RGB(r, g, b) \
468 { .red = r << 8, .green = g << 8, .blue = b << 8, .alpha = 0xffff }
470 static const pixman_color_t color_table_rgb[2][8] = {
472 [QEMU_COLOR_BLACK] = QEMU_RGB(0x00, 0x00, 0x00), /* black */
473 [QEMU_COLOR_BLUE] = QEMU_RGB(0x00, 0x00, 0xaa), /* blue */
474 [QEMU_COLOR_GREEN] = QEMU_RGB(0x00, 0xaa, 0x00), /* green */
475 [QEMU_COLOR_CYAN] = QEMU_RGB(0x00, 0xaa, 0xaa), /* cyan */
476 [QEMU_COLOR_RED] = QEMU_RGB(0xaa, 0x00, 0x00), /* red */
477 [QEMU_COLOR_MAGENTA] = QEMU_RGB(0xaa, 0x00, 0xaa), /* magenta */
478 [QEMU_COLOR_YELLOW] = QEMU_RGB(0xaa, 0xaa, 0x00), /* yellow */
479 [QEMU_COLOR_WHITE] = QEMU_RGB(0xaa, 0xaa, 0xaa), /* white */
482 [QEMU_COLOR_BLACK] = QEMU_RGB(0x00, 0x00, 0x00), /* black */
483 [QEMU_COLOR_BLUE] = QEMU_RGB(0x00, 0x00, 0xff), /* blue */
484 [QEMU_COLOR_GREEN] = QEMU_RGB(0x00, 0xff, 0x00), /* green */
485 [QEMU_COLOR_CYAN] = QEMU_RGB(0x00, 0xff, 0xff), /* cyan */
486 [QEMU_COLOR_RED] = QEMU_RGB(0xff, 0x00, 0x00), /* red */
487 [QEMU_COLOR_MAGENTA] = QEMU_RGB(0xff, 0x00, 0xff), /* magenta */
488 [QEMU_COLOR_YELLOW] = QEMU_RGB(0xff, 0xff, 0x00), /* yellow */
489 [QEMU_COLOR_WHITE] = QEMU_RGB(0xff, 0xff, 0xff), /* white */
493 static void vga_putcharxy(QemuConsole *s, int x, int y, int ch,
494 TextAttributes *t_attrib)
496 static pixman_image_t *glyphs[256];
497 DisplaySurface *surface = qemu_console_surface(s);
498 pixman_color_t fgcol, bgcol;
500 if (t_attrib->invers) {
501 bgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
502 fgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
504 fgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
505 bgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
509 glyphs[ch] = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, ch);
511 qemu_pixman_glyph_render(glyphs[ch], surface->image,
512 &fgcol, &bgcol, x, y, FONT_WIDTH, FONT_HEIGHT);
515 static void text_console_resize(QemuConsole *s)
517 TextCell *cells, *c, *c1;
518 int w1, x, y, last_width;
520 last_width = s->width;
521 s->width = surface_width(s->surface) / FONT_WIDTH;
522 s->height = surface_height(s->surface) / FONT_HEIGHT;
528 cells = g_new(TextCell, s->width * s->total_height + 1);
529 for(y = 0; y < s->total_height; y++) {
530 c = &cells[y * s->width];
532 c1 = &s->cells[y * last_width];
533 for(x = 0; x < w1; x++) {
537 for(x = w1; x < s->width; x++) {
539 c->t_attrib = s->t_attrib_default;
547 static inline void text_update_xy(QemuConsole *s, int x, int y)
549 s->text_x[0] = MIN(s->text_x[0], x);
550 s->text_x[1] = MAX(s->text_x[1], x);
551 s->text_y[0] = MIN(s->text_y[0], y);
552 s->text_y[1] = MAX(s->text_y[1], y);
555 static void invalidate_xy(QemuConsole *s, int x, int y)
557 if (!qemu_console_is_visible(s)) {
560 if (s->update_x0 > x * FONT_WIDTH)
561 s->update_x0 = x * FONT_WIDTH;
562 if (s->update_y0 > y * FONT_HEIGHT)
563 s->update_y0 = y * FONT_HEIGHT;
564 if (s->update_x1 < (x + 1) * FONT_WIDTH)
565 s->update_x1 = (x + 1) * FONT_WIDTH;
566 if (s->update_y1 < (y + 1) * FONT_HEIGHT)
567 s->update_y1 = (y + 1) * FONT_HEIGHT;
570 static void update_xy(QemuConsole *s, int x, int y)
575 if (s->ds->have_text) {
576 text_update_xy(s, x, y);
579 y1 = (s->y_base + y) % s->total_height;
580 y2 = y1 - s->y_displayed;
582 y2 += s->total_height;
584 if (y2 < s->height) {
588 c = &s->cells[y1 * s->width + x];
589 vga_putcharxy(s, x, y2, c->ch,
591 invalidate_xy(s, x, y2);
595 static void console_show_cursor(QemuConsole *s, int show)
601 if (s->ds->have_text) {
602 s->cursor_invalidate = 1;
608 y1 = (s->y_base + s->y) % s->total_height;
609 y = y1 - s->y_displayed;
611 y += s->total_height;
614 c = &s->cells[y1 * s->width + x];
615 if (show && cursor_visible_phase) {
616 TextAttributes t_attrib = s->t_attrib_default;
617 t_attrib.invers = !(t_attrib.invers); /* invert fg and bg */
618 vga_putcharxy(s, x, y, c->ch, &t_attrib);
620 vga_putcharxy(s, x, y, c->ch, &(c->t_attrib));
622 invalidate_xy(s, x, y);
626 static void console_refresh(QemuConsole *s)
628 DisplaySurface *surface = qemu_console_surface(s);
632 if (s->ds->have_text) {
635 s->text_x[1] = s->width - 1;
636 s->text_y[1] = s->height - 1;
637 s->cursor_invalidate = 1;
640 vga_fill_rect(s, 0, 0, surface_width(surface), surface_height(surface),
641 color_table_rgb[0][QEMU_COLOR_BLACK]);
643 for (y = 0; y < s->height; y++) {
644 c = s->cells + y1 * s->width;
645 for (x = 0; x < s->width; x++) {
646 vga_putcharxy(s, x, y, c->ch,
650 if (++y1 == s->total_height) {
654 console_show_cursor(s, 1);
655 dpy_gfx_update(s, 0, 0,
656 surface_width(surface), surface_height(surface));
659 static void console_scroll(QemuConsole *s, int ydelta)
664 for(i = 0; i < ydelta; i++) {
665 if (s->y_displayed == s->y_base)
667 if (++s->y_displayed == s->total_height)
672 i = s->backscroll_height;
673 if (i > s->total_height - s->height)
674 i = s->total_height - s->height;
677 y1 += s->total_height;
678 for(i = 0; i < ydelta; i++) {
679 if (s->y_displayed == y1)
681 if (--s->y_displayed < 0)
682 s->y_displayed = s->total_height - 1;
688 static void console_put_lf(QemuConsole *s)
694 if (s->y >= s->height) {
695 s->y = s->height - 1;
697 if (s->y_displayed == s->y_base) {
698 if (++s->y_displayed == s->total_height)
701 if (++s->y_base == s->total_height)
703 if (s->backscroll_height < s->total_height)
704 s->backscroll_height++;
705 y1 = (s->y_base + s->height - 1) % s->total_height;
706 c = &s->cells[y1 * s->width];
707 for(x = 0; x < s->width; x++) {
709 c->t_attrib = s->t_attrib_default;
712 if (s->y_displayed == s->y_base) {
713 if (s->ds->have_text) {
716 s->text_x[1] = s->width - 1;
717 s->text_y[1] = s->height - 1;
720 vga_bitblt(s, 0, FONT_HEIGHT, 0, 0,
721 s->width * FONT_WIDTH,
722 (s->height - 1) * FONT_HEIGHT);
723 vga_fill_rect(s, 0, (s->height - 1) * FONT_HEIGHT,
724 s->width * FONT_WIDTH, FONT_HEIGHT,
725 color_table_rgb[0][s->t_attrib_default.bgcol]);
728 s->update_x1 = s->width * FONT_WIDTH;
729 s->update_y1 = s->height * FONT_HEIGHT;
734 /* Set console attributes depending on the current escape codes.
735 * NOTE: I know this code is not very efficient (checking every color for it
736 * self) but it is more readable and better maintainable.
738 static void console_handle_escape(QemuConsole *s)
742 for (i=0; i<s->nb_esc_params; i++) {
743 switch (s->esc_params[i]) {
744 case 0: /* reset all console attributes to default */
745 s->t_attrib = s->t_attrib_default;
748 s->t_attrib.bold = 1;
751 s->t_attrib.uline = 1;
754 s->t_attrib.blink = 1;
757 s->t_attrib.invers = 1;
760 s->t_attrib.unvisible = 1;
763 s->t_attrib.bold = 0;
766 s->t_attrib.uline = 0;
769 s->t_attrib.blink = 0;
772 s->t_attrib.invers = 0;
775 s->t_attrib.unvisible = 0;
777 /* set foreground color */
779 s->t_attrib.fgcol = QEMU_COLOR_BLACK;
782 s->t_attrib.fgcol = QEMU_COLOR_RED;
785 s->t_attrib.fgcol = QEMU_COLOR_GREEN;
788 s->t_attrib.fgcol = QEMU_COLOR_YELLOW;
791 s->t_attrib.fgcol = QEMU_COLOR_BLUE;
794 s->t_attrib.fgcol = QEMU_COLOR_MAGENTA;
797 s->t_attrib.fgcol = QEMU_COLOR_CYAN;
800 s->t_attrib.fgcol = QEMU_COLOR_WHITE;
802 /* set background color */
804 s->t_attrib.bgcol = QEMU_COLOR_BLACK;
807 s->t_attrib.bgcol = QEMU_COLOR_RED;
810 s->t_attrib.bgcol = QEMU_COLOR_GREEN;
813 s->t_attrib.bgcol = QEMU_COLOR_YELLOW;
816 s->t_attrib.bgcol = QEMU_COLOR_BLUE;
819 s->t_attrib.bgcol = QEMU_COLOR_MAGENTA;
822 s->t_attrib.bgcol = QEMU_COLOR_CYAN;
825 s->t_attrib.bgcol = QEMU_COLOR_WHITE;
831 static void console_clear_xy(QemuConsole *s, int x, int y)
833 int y1 = (s->y_base + y) % s->total_height;
837 TextCell *c = &s->cells[y1 * s->width + x];
839 c->t_attrib = s->t_attrib_default;
843 static void console_put_one(QemuConsole *s, int ch)
847 if (s->x >= s->width) {
852 y1 = (s->y_base + s->y) % s->total_height;
853 c = &s->cells[y1 * s->width + s->x];
855 c->t_attrib = s->t_attrib;
856 update_xy(s, s->x, s->y);
860 static void console_respond_str(QemuConsole *s, const char *buf)
863 console_put_one(s, *buf);
868 /* set cursor, checking bounds */
869 static void set_cursor(QemuConsole *s, int x, int y)
877 if (y >= s->height) {
888 static void console_putchar(QemuConsole *s, int ch)
897 case '\r': /* carriage return */
900 case '\n': /* newline */
903 case '\b': /* backspace */
907 case '\t': /* tabspace */
908 if (s->x + (8 - (s->x % 8)) > s->width) {
912 s->x = s->x + (8 - (s->x % 8));
915 case '\a': /* alert aka. bell */
916 /* TODO: has to be implemented */
919 /* SI (shift in), character set 0 (ignored) */
922 /* SO (shift out), character set 1 (ignored) */
924 case 27: /* esc (introducing an escape sequence) */
925 s->state = TTY_STATE_ESC;
928 console_put_one(s, ch);
932 case TTY_STATE_ESC: /* check if it is a terminal escape sequence */
934 for(i=0;i<MAX_ESC_PARAMS;i++)
935 s->esc_params[i] = 0;
936 s->nb_esc_params = 0;
937 s->state = TTY_STATE_CSI;
939 s->state = TTY_STATE_NORM;
942 case TTY_STATE_CSI: /* handle escape sequence parameters */
943 if (ch >= '0' && ch <= '9') {
944 if (s->nb_esc_params < MAX_ESC_PARAMS) {
945 int *param = &s->esc_params[s->nb_esc_params];
946 int digit = (ch - '0');
948 *param = (*param <= (INT_MAX - digit) / 10) ?
949 *param * 10 + digit : INT_MAX;
952 if (s->nb_esc_params < MAX_ESC_PARAMS)
954 if (ch == ';' || ch == '?') {
957 trace_console_putchar_csi(s->esc_params[0], s->esc_params[1],
958 ch, s->nb_esc_params);
959 s->state = TTY_STATE_NORM;
963 if (s->esc_params[0] == 0) {
964 s->esc_params[0] = 1;
966 set_cursor(s, s->x, s->y - s->esc_params[0]);
969 /* move cursor down */
970 if (s->esc_params[0] == 0) {
971 s->esc_params[0] = 1;
973 set_cursor(s, s->x, s->y + s->esc_params[0]);
976 /* move cursor right */
977 if (s->esc_params[0] == 0) {
978 s->esc_params[0] = 1;
980 set_cursor(s, s->x + s->esc_params[0], s->y);
983 /* move cursor left */
984 if (s->esc_params[0] == 0) {
985 s->esc_params[0] = 1;
987 set_cursor(s, s->x - s->esc_params[0], s->y);
990 /* move cursor to column */
991 set_cursor(s, s->esc_params[0] - 1, s->y);
995 /* move cursor to row, column */
996 set_cursor(s, s->esc_params[1] - 1, s->esc_params[0] - 1);
999 switch (s->esc_params[0]) {
1001 /* clear to end of screen */
1002 for (y = s->y; y < s->height; y++) {
1003 for (x = 0; x < s->width; x++) {
1004 if (y == s->y && x < s->x) {
1007 console_clear_xy(s, x, y);
1012 /* clear from beginning of screen */
1013 for (y = 0; y <= s->y; y++) {
1014 for (x = 0; x < s->width; x++) {
1015 if (y == s->y && x > s->x) {
1018 console_clear_xy(s, x, y);
1023 /* clear entire screen */
1024 for (y = 0; y <= s->height; y++) {
1025 for (x = 0; x < s->width; x++) {
1026 console_clear_xy(s, x, y);
1033 switch (s->esc_params[0]) {
1036 for(x = s->x; x < s->width; x++) {
1037 console_clear_xy(s, x, s->y);
1041 /* clear from beginning of line */
1042 for (x = 0; x <= s->x && x < s->width; x++) {
1043 console_clear_xy(s, x, s->y);
1047 /* clear entire line */
1048 for(x = 0; x < s->width; x++) {
1049 console_clear_xy(s, x, s->y);
1055 console_handle_escape(s);
1058 switch (s->esc_params[0]) {
1060 /* report console status (always succeed)*/
1061 console_respond_str(s, "\033[0n");
1064 /* report cursor position */
1065 sprintf(response, "\033[%d;%dR",
1066 (s->y_base + s->y) % s->total_height + 1,
1068 console_respond_str(s, response);
1073 /* save cursor position */
1078 /* restore cursor position */
1083 trace_console_putchar_unhandled(ch);
1091 void console_select(unsigned int index)
1093 DisplayChangeListener *dcl;
1096 trace_console_select(index);
1097 s = qemu_console_lookup_by_index(index);
1099 DisplayState *ds = s->ds;
1103 QLIST_FOREACH(dcl, &ds->listeners, next) {
1104 if (dcl->con != NULL) {
1107 if (dcl->ops->dpy_gfx_switch) {
1108 dcl->ops->dpy_gfx_switch(dcl, s->surface);
1112 dpy_gfx_update(s, 0, 0, surface_width(s->surface),
1113 surface_height(s->surface));
1116 if (ds->have_text) {
1117 dpy_text_resize(s, s->width, s->height);
1119 text_console_update_cursor(NULL);
1125 QemuConsole *console;
1127 typedef struct VCChardev VCChardev;
1129 #define TYPE_CHARDEV_VC "chardev-vc"
1130 DECLARE_INSTANCE_CHECKER(VCChardev, VC_CHARDEV,
1133 static int vc_chr_write(Chardev *chr, const uint8_t *buf, int len)
1135 VCChardev *drv = VC_CHARDEV(chr);
1136 QemuConsole *s = drv->console;
1143 s->update_x0 = s->width * FONT_WIDTH;
1144 s->update_y0 = s->height * FONT_HEIGHT;
1147 console_show_cursor(s, 0);
1148 for(i = 0; i < len; i++) {
1149 console_putchar(s, buf[i]);
1151 console_show_cursor(s, 1);
1152 if (s->ds->have_gfx && s->update_x0 < s->update_x1) {
1153 dpy_gfx_update(s, s->update_x0, s->update_y0,
1154 s->update_x1 - s->update_x0,
1155 s->update_y1 - s->update_y0);
1160 static void kbd_send_chars(void *opaque)
1162 QemuConsole *s = opaque;
1166 len = qemu_chr_be_can_write(s->chr);
1167 if (len > s->out_fifo.count)
1168 len = s->out_fifo.count;
1170 if (len > sizeof(buf))
1172 qemu_fifo_read(&s->out_fifo, buf, len);
1173 qemu_chr_be_write(s->chr, buf, len);
1175 /* characters are pending: we send them a bit later (XXX:
1176 horrible, should change char device API) */
1177 if (s->out_fifo.count > 0) {
1178 timer_mod(s->kbd_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 1);
1182 /* called when an ascii key is pressed */
1183 void kbd_put_keysym_console(QemuConsole *s, int keysym)
1185 uint8_t buf[16], *q;
1189 if (!s || (s->console_type == GRAPHIC_CONSOLE))
1193 case QEMU_KEY_CTRL_UP:
1194 console_scroll(s, -1);
1196 case QEMU_KEY_CTRL_DOWN:
1197 console_scroll(s, 1);
1199 case QEMU_KEY_CTRL_PAGEUP:
1200 console_scroll(s, -10);
1202 case QEMU_KEY_CTRL_PAGEDOWN:
1203 console_scroll(s, 10);
1206 /* convert the QEMU keysym to VT100 key string */
1208 if (keysym >= 0xe100 && keysym <= 0xe11f) {
1211 c = keysym - 0xe100;
1213 *q++ = '0' + (c / 10);
1214 *q++ = '0' + (c % 10);
1216 } else if (keysym >= 0xe120 && keysym <= 0xe17f) {
1219 *q++ = keysym & 0xff;
1220 } else if (s->echo && (keysym == '\r' || keysym == '\n')) {
1221 vc_chr_write(s->chr, (const uint8_t *) "\r", 1);
1227 vc_chr_write(s->chr, buf, q - buf);
1230 if (be && be->chr_read) {
1231 qemu_fifo_write(&s->out_fifo, buf, q - buf);
1238 static const int qcode_to_keysym[Q_KEY_CODE__MAX] = {
1239 [Q_KEY_CODE_UP] = QEMU_KEY_UP,
1240 [Q_KEY_CODE_DOWN] = QEMU_KEY_DOWN,
1241 [Q_KEY_CODE_RIGHT] = QEMU_KEY_RIGHT,
1242 [Q_KEY_CODE_LEFT] = QEMU_KEY_LEFT,
1243 [Q_KEY_CODE_HOME] = QEMU_KEY_HOME,
1244 [Q_KEY_CODE_END] = QEMU_KEY_END,
1245 [Q_KEY_CODE_PGUP] = QEMU_KEY_PAGEUP,
1246 [Q_KEY_CODE_PGDN] = QEMU_KEY_PAGEDOWN,
1247 [Q_KEY_CODE_DELETE] = QEMU_KEY_DELETE,
1248 [Q_KEY_CODE_BACKSPACE] = QEMU_KEY_BACKSPACE,
1251 static const int ctrl_qcode_to_keysym[Q_KEY_CODE__MAX] = {
1252 [Q_KEY_CODE_UP] = QEMU_KEY_CTRL_UP,
1253 [Q_KEY_CODE_DOWN] = QEMU_KEY_CTRL_DOWN,
1254 [Q_KEY_CODE_RIGHT] = QEMU_KEY_CTRL_RIGHT,
1255 [Q_KEY_CODE_LEFT] = QEMU_KEY_CTRL_LEFT,
1256 [Q_KEY_CODE_HOME] = QEMU_KEY_CTRL_HOME,
1257 [Q_KEY_CODE_END] = QEMU_KEY_CTRL_END,
1258 [Q_KEY_CODE_PGUP] = QEMU_KEY_CTRL_PAGEUP,
1259 [Q_KEY_CODE_PGDN] = QEMU_KEY_CTRL_PAGEDOWN,
1262 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl)
1266 keysym = ctrl ? ctrl_qcode_to_keysym[qcode] : qcode_to_keysym[qcode];
1270 kbd_put_keysym_console(s, keysym);
1274 void kbd_put_string_console(QemuConsole *s, const char *str, int len)
1278 for (i = 0; i < len && str[i]; i++) {
1279 kbd_put_keysym_console(s, str[i]);
1283 void kbd_put_keysym(int keysym)
1285 kbd_put_keysym_console(active_console, keysym);
1288 static void text_console_invalidate(void *opaque)
1290 QemuConsole *s = (QemuConsole *) opaque;
1292 if (s->ds->have_text && s->console_type == TEXT_CONSOLE) {
1293 text_console_resize(s);
1298 static void text_console_update(void *opaque, console_ch_t *chardata)
1300 QemuConsole *s = (QemuConsole *) opaque;
1303 if (s->text_x[0] <= s->text_x[1]) {
1304 src = (s->y_base + s->text_y[0]) * s->width;
1305 chardata += s->text_y[0] * s->width;
1306 for (i = s->text_y[0]; i <= s->text_y[1]; i ++)
1307 for (j = 0; j < s->width; j++, src++) {
1308 console_write_ch(chardata ++,
1309 ATTR2CHTYPE(s->cells[src].ch,
1310 s->cells[src].t_attrib.fgcol,
1311 s->cells[src].t_attrib.bgcol,
1312 s->cells[src].t_attrib.bold));
1314 dpy_text_update(s, s->text_x[0], s->text_y[0],
1315 s->text_x[1] - s->text_x[0], i - s->text_y[0]);
1316 s->text_x[0] = s->width;
1317 s->text_y[0] = s->height;
1321 if (s->cursor_invalidate) {
1322 dpy_text_cursor(s, s->x, s->y);
1323 s->cursor_invalidate = 0;
1327 static QemuConsole *new_console(DisplayState *ds, console_type_t console_type,
1334 obj = object_new(TYPE_QEMU_CONSOLE);
1335 s = QEMU_CONSOLE(obj);
1336 qemu_co_queue_init(&s->dump_queue);
1338 object_property_add_link(obj, "device", TYPE_DEVICE,
1339 (Object **)&s->device,
1340 object_property_allow_set_link,
1341 OBJ_PROP_LINK_STRONG);
1342 object_property_add_uint32_ptr(obj, "head", &s->head,
1343 OBJ_PROP_FLAG_READ);
1345 if (!active_console || ((active_console->console_type != GRAPHIC_CONSOLE) &&
1346 (console_type == GRAPHIC_CONSOLE))) {
1350 s->console_type = console_type;
1353 if (QTAILQ_EMPTY(&consoles)) {
1355 QTAILQ_INSERT_TAIL(&consoles, s, next);
1356 } else if (console_type != GRAPHIC_CONSOLE || phase_check(PHASE_MACHINE_READY)) {
1357 QemuConsole *last = QTAILQ_LAST(&consoles);
1358 s->index = last->index + 1;
1359 QTAILQ_INSERT_TAIL(&consoles, s, next);
1362 * HACK: Put graphical consoles before text consoles.
1364 * Only do that for coldplugged devices. After initial device
1365 * initialization we will not renumber the consoles any more.
1367 QemuConsole *c = QTAILQ_FIRST(&consoles);
1369 while (QTAILQ_NEXT(c, next) != NULL &&
1370 c->console_type == GRAPHIC_CONSOLE) {
1371 c = QTAILQ_NEXT(c, next);
1373 if (c->console_type == GRAPHIC_CONSOLE) {
1374 /* have no text consoles */
1375 s->index = c->index + 1;
1376 QTAILQ_INSERT_AFTER(&consoles, c, s, next);
1378 s->index = c->index;
1379 QTAILQ_INSERT_BEFORE(c, s, next);
1380 /* renumber text consoles */
1381 for (i = s->index + 1; c != NULL; c = QTAILQ_NEXT(c, next), i++) {
1389 static void qemu_alloc_display(DisplaySurface *surface, int width, int height)
1391 qemu_pixman_image_unref(surface->image);
1392 surface->image = NULL;
1394 surface->format = PIXMAN_x8r8g8b8;
1395 surface->image = pixman_image_create_bits(surface->format,
1398 assert(surface->image != NULL);
1400 surface->flags = QEMU_ALLOCATED_FLAG;
1403 DisplaySurface *qemu_create_displaysurface(int width, int height)
1405 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1407 trace_displaysurface_create(surface, width, height);
1408 qemu_alloc_display(surface, width, height);
1412 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
1413 pixman_format_code_t format,
1414 int linesize, uint8_t *data)
1416 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1418 trace_displaysurface_create_from(surface, width, height, format);
1419 surface->format = format;
1420 surface->image = pixman_image_create_bits(surface->format,
1422 (void *)data, linesize);
1423 assert(surface->image != NULL);
1428 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image)
1430 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1432 trace_displaysurface_create_pixman(surface);
1433 surface->format = pixman_image_get_format(image);
1434 surface->image = pixman_image_ref(image);
1439 DisplaySurface *qemu_create_message_surface(int w, int h,
1442 DisplaySurface *surface = qemu_create_displaysurface(w, h);
1443 pixman_color_t bg = color_table_rgb[0][QEMU_COLOR_BLACK];
1444 pixman_color_t fg = color_table_rgb[0][QEMU_COLOR_WHITE];
1445 pixman_image_t *glyph;
1449 x = (w / FONT_WIDTH - len) / 2;
1450 y = (h / FONT_HEIGHT - 1) / 2;
1451 for (i = 0; i < len; i++) {
1452 glyph = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, msg[i]);
1453 qemu_pixman_glyph_render(glyph, surface->image, &fg, &bg,
1454 x+i, y, FONT_WIDTH, FONT_HEIGHT);
1455 qemu_pixman_image_unref(glyph);
1460 void qemu_free_displaysurface(DisplaySurface *surface)
1462 if (surface == NULL) {
1465 trace_displaysurface_free(surface);
1466 qemu_pixman_image_unref(surface->image);
1470 bool console_has_gl(QemuConsole *con)
1472 return con->gl != NULL;
1475 static bool displaychangelistener_has_dmabuf(DisplayChangeListener *dcl)
1477 if (dcl->ops->dpy_has_dmabuf) {
1478 return dcl->ops->dpy_has_dmabuf(dcl);
1481 if (dcl->ops->dpy_gl_scanout_dmabuf) {
1488 static bool dpy_compatible_with(QemuConsole *con,
1489 DisplayChangeListener *dcl, Error **errp)
1494 flags = con->hw_ops->get_flags ? con->hw_ops->get_flags(con->hw) : 0;
1496 if (flags & GRAPHIC_FLAGS_GL &&
1497 !console_has_gl(con)) {
1498 error_setg(errp, "The console requires a GL context.");
1503 if (flags & GRAPHIC_FLAGS_DMABUF &&
1504 !displaychangelistener_has_dmabuf(dcl)) {
1505 error_setg(errp, "The console requires display DMABUF support.");
1512 void register_displaychangelistener(DisplayChangeListener *dcl)
1514 static const char nodev[] =
1515 "This VM has no graphic display device.";
1516 static DisplaySurface *dummy;
1522 if (dcl->ops->dpy_gl_ctx_create) {
1523 /* display has opengl support */
1526 fprintf(stderr, "can't register two opengl displays (%s, %s)\n",
1527 dcl->ops->dpy_name, dcl->con->gl->ops->dpy_name);
1533 if (dcl->con && !dpy_compatible_with(dcl->con, dcl, &err)) {
1534 error_report_err(err);
1538 trace_displaychangelistener_register(dcl, dcl->ops->dpy_name);
1539 dcl->ds = get_alloc_displaystate();
1540 QLIST_INSERT_HEAD(&dcl->ds->listeners, dcl, next);
1541 gui_setup_refresh(dcl->ds);
1546 con = active_console;
1548 if (dcl->ops->dpy_gfx_switch) {
1550 dcl->ops->dpy_gfx_switch(dcl, con->surface);
1553 dummy = qemu_create_message_surface(640, 480, nodev);
1555 dcl->ops->dpy_gfx_switch(dcl, dummy);
1558 text_console_update_cursor(NULL);
1561 void update_displaychangelistener(DisplayChangeListener *dcl,
1564 DisplayState *ds = dcl->ds;
1566 dcl->update_interval = interval;
1567 if (!ds->refreshing && ds->update_interval > interval) {
1568 timer_mod(ds->gui_timer, ds->last_update + interval);
1572 void unregister_displaychangelistener(DisplayChangeListener *dcl)
1574 DisplayState *ds = dcl->ds;
1575 trace_displaychangelistener_unregister(dcl, dcl->ops->dpy_name);
1579 QLIST_REMOVE(dcl, next);
1581 gui_setup_refresh(ds);
1584 static void dpy_set_ui_info_timer(void *opaque)
1586 QemuConsole *con = opaque;
1588 con->hw_ops->ui_info(con->hw, con->head, &con->ui_info);
1591 bool dpy_ui_info_supported(QemuConsole *con)
1594 con = active_console;
1597 return con->hw_ops->ui_info != NULL;
1600 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con)
1603 con = active_console;
1606 return &con->ui_info;
1609 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info)
1612 con = active_console;
1615 if (!dpy_ui_info_supported(con)) {
1618 if (memcmp(&con->ui_info, info, sizeof(con->ui_info)) == 0) {
1619 /* nothing changed -- ignore */
1624 * Typically we get a flood of these as the user resizes the window.
1625 * Wait until the dust has settled (one second without updates), then
1626 * go notify the guest.
1628 con->ui_info = *info;
1629 timer_mod(con->ui_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 1000);
1633 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h)
1635 DisplayState *s = con->ds;
1636 DisplayChangeListener *dcl;
1641 width = surface_width(con->surface);
1642 height = surface_height(con->surface);
1648 w = MIN(w, width - x);
1649 h = MIN(h, height - y);
1651 if (!qemu_console_is_visible(con)) {
1654 QLIST_FOREACH(dcl, &s->listeners, next) {
1655 if (con != (dcl->con ? dcl->con : active_console)) {
1658 if (dcl->ops->dpy_gfx_update) {
1659 dcl->ops->dpy_gfx_update(dcl, x, y, w, h);
1664 void dpy_gfx_update_full(QemuConsole *con)
1666 if (!con->surface) {
1669 dpy_gfx_update(con, 0, 0,
1670 surface_width(con->surface),
1671 surface_height(con->surface));
1674 void dpy_gfx_replace_surface(QemuConsole *con,
1675 DisplaySurface *surface)
1677 DisplayState *s = con->ds;
1678 DisplaySurface *old_surface = con->surface;
1679 DisplayChangeListener *dcl;
1681 assert(old_surface != surface || surface == NULL);
1683 con->surface = surface;
1684 QLIST_FOREACH(dcl, &s->listeners, next) {
1685 if (con != (dcl->con ? dcl->con : active_console)) {
1688 if (dcl->ops->dpy_gfx_switch) {
1689 dcl->ops->dpy_gfx_switch(dcl, surface);
1692 qemu_free_displaysurface(old_surface);
1695 bool dpy_gfx_check_format(QemuConsole *con,
1696 pixman_format_code_t format)
1698 DisplayChangeListener *dcl;
1699 DisplayState *s = con->ds;
1701 QLIST_FOREACH(dcl, &s->listeners, next) {
1702 if (dcl->con && dcl->con != con) {
1703 /* dcl bound to another console -> skip */
1706 if (dcl->ops->dpy_gfx_check_format) {
1707 if (!dcl->ops->dpy_gfx_check_format(dcl, format)) {
1711 /* default is to whitelist native 32 bpp only */
1712 if (format != qemu_default_pixman_format(32, true)) {
1720 static void dpy_refresh(DisplayState *s)
1722 DisplayChangeListener *dcl;
1724 QLIST_FOREACH(dcl, &s->listeners, next) {
1725 if (dcl->ops->dpy_refresh) {
1726 dcl->ops->dpy_refresh(dcl);
1731 void dpy_text_cursor(QemuConsole *con, int x, int y)
1733 DisplayState *s = con->ds;
1734 DisplayChangeListener *dcl;
1736 if (!qemu_console_is_visible(con)) {
1739 QLIST_FOREACH(dcl, &s->listeners, next) {
1740 if (con != (dcl->con ? dcl->con : active_console)) {
1743 if (dcl->ops->dpy_text_cursor) {
1744 dcl->ops->dpy_text_cursor(dcl, x, y);
1749 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h)
1751 DisplayState *s = con->ds;
1752 DisplayChangeListener *dcl;
1754 if (!qemu_console_is_visible(con)) {
1757 QLIST_FOREACH(dcl, &s->listeners, next) {
1758 if (con != (dcl->con ? dcl->con : active_console)) {
1761 if (dcl->ops->dpy_text_update) {
1762 dcl->ops->dpy_text_update(dcl, x, y, w, h);
1767 void dpy_text_resize(QemuConsole *con, int w, int h)
1769 DisplayState *s = con->ds;
1770 DisplayChangeListener *dcl;
1772 if (!qemu_console_is_visible(con)) {
1775 QLIST_FOREACH(dcl, &s->listeners, next) {
1776 if (con != (dcl->con ? dcl->con : active_console)) {
1779 if (dcl->ops->dpy_text_resize) {
1780 dcl->ops->dpy_text_resize(dcl, w, h);
1785 void dpy_mouse_set(QemuConsole *con, int x, int y, int on)
1787 DisplayState *s = con->ds;
1788 DisplayChangeListener *dcl;
1790 if (!qemu_console_is_visible(con)) {
1793 QLIST_FOREACH(dcl, &s->listeners, next) {
1794 if (con != (dcl->con ? dcl->con : active_console)) {
1797 if (dcl->ops->dpy_mouse_set) {
1798 dcl->ops->dpy_mouse_set(dcl, x, y, on);
1803 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor)
1805 DisplayState *s = con->ds;
1806 DisplayChangeListener *dcl;
1808 if (!qemu_console_is_visible(con)) {
1811 QLIST_FOREACH(dcl, &s->listeners, next) {
1812 if (con != (dcl->con ? dcl->con : active_console)) {
1815 if (dcl->ops->dpy_cursor_define) {
1816 dcl->ops->dpy_cursor_define(dcl, cursor);
1821 bool dpy_cursor_define_supported(QemuConsole *con)
1823 DisplayState *s = con->ds;
1824 DisplayChangeListener *dcl;
1826 QLIST_FOREACH(dcl, &s->listeners, next) {
1827 if (dcl->ops->dpy_cursor_define) {
1834 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
1835 struct QEMUGLParams *qparams)
1838 return con->gl->ops->dpy_gl_ctx_create(con->gl, qparams);
1841 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx)
1844 con->gl->ops->dpy_gl_ctx_destroy(con->gl, ctx);
1847 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx)
1850 return con->gl->ops->dpy_gl_ctx_make_current(con->gl, ctx);
1853 void dpy_gl_scanout_disable(QemuConsole *con)
1856 con->gl->ops->dpy_gl_scanout_disable(con->gl);
1859 void dpy_gl_scanout_texture(QemuConsole *con,
1860 uint32_t backing_id,
1861 bool backing_y_0_top,
1862 uint32_t backing_width,
1863 uint32_t backing_height,
1864 uint32_t x, uint32_t y,
1865 uint32_t width, uint32_t height)
1868 con->gl->ops->dpy_gl_scanout_texture(con->gl, backing_id,
1870 backing_width, backing_height,
1871 x, y, width, height);
1874 void dpy_gl_scanout_dmabuf(QemuConsole *con,
1878 con->gl->ops->dpy_gl_scanout_dmabuf(con->gl, dmabuf);
1881 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
1882 bool have_hot, uint32_t hot_x, uint32_t hot_y)
1886 if (con->gl->ops->dpy_gl_cursor_dmabuf) {
1887 con->gl->ops->dpy_gl_cursor_dmabuf(con->gl, dmabuf,
1888 have_hot, hot_x, hot_y);
1892 void dpy_gl_cursor_position(QemuConsole *con,
1893 uint32_t pos_x, uint32_t pos_y)
1897 if (con->gl->ops->dpy_gl_cursor_position) {
1898 con->gl->ops->dpy_gl_cursor_position(con->gl, pos_x, pos_y);
1902 void dpy_gl_release_dmabuf(QemuConsole *con,
1907 if (con->gl->ops->dpy_gl_release_dmabuf) {
1908 con->gl->ops->dpy_gl_release_dmabuf(con->gl, dmabuf);
1912 void dpy_gl_update(QemuConsole *con,
1913 uint32_t x, uint32_t y, uint32_t w, uint32_t h)
1916 con->gl->ops->dpy_gl_update(con->gl, x, y, w, h);
1919 /***********************************************************/
1920 /* register display */
1922 /* console.c internal use only */
1923 static DisplayState *get_alloc_displaystate(void)
1925 if (!display_state) {
1926 display_state = g_new0(DisplayState, 1);
1927 cursor_timer = timer_new_ms(QEMU_CLOCK_REALTIME,
1928 text_console_update_cursor, NULL);
1930 return display_state;
1934 * Called by main(), after creating QemuConsoles
1935 * and before initializing ui (sdl/vnc/...).
1937 DisplayState *init_displaystate(void)
1942 get_alloc_displaystate();
1943 QTAILQ_FOREACH(con, &consoles, next) {
1944 if (con->console_type != GRAPHIC_CONSOLE &&
1946 text_console_do_init(con->chr, display_state);
1949 /* Hook up into the qom tree here (not in new_console()), once
1950 * all QemuConsoles are created and the order / numbering
1951 * doesn't change any more */
1952 name = g_strdup_printf("console[%d]", con->index);
1953 object_property_add_child(container_get(object_get_root(), "/backend"),
1958 return display_state;
1961 void graphic_console_set_hwops(QemuConsole *con,
1962 const GraphicHwOps *hw_ops,
1965 con->hw_ops = hw_ops;
1969 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
1970 const GraphicHwOps *hw_ops,
1973 static const char noinit[] =
1974 "Guest has not initialized the display (yet).";
1979 DisplaySurface *surface;
1981 ds = get_alloc_displaystate();
1982 s = qemu_console_lookup_unused();
1984 trace_console_gfx_reuse(s->index);
1986 width = surface_width(s->surface);
1987 height = surface_height(s->surface);
1990 trace_console_gfx_new();
1991 s = new_console(ds, GRAPHIC_CONSOLE, head);
1992 s->ui_timer = timer_new_ms(QEMU_CLOCK_REALTIME,
1993 dpy_set_ui_info_timer, s);
1995 graphic_console_set_hwops(s, hw_ops, opaque);
1997 object_property_set_link(OBJECT(s), "device", OBJECT(dev),
2001 surface = qemu_create_message_surface(width, height, noinit);
2002 dpy_gfx_replace_surface(s, surface);
2006 static const GraphicHwOps unused_ops = {
2010 void graphic_console_close(QemuConsole *con)
2012 static const char unplugged[] =
2013 "Guest display has been unplugged";
2014 DisplaySurface *surface;
2019 width = surface_width(con->surface);
2020 height = surface_height(con->surface);
2023 trace_console_gfx_close(con->index);
2024 object_property_set_link(OBJECT(con), "device", NULL, &error_abort);
2025 graphic_console_set_hwops(con, &unused_ops, NULL);
2028 dpy_gl_scanout_disable(con);
2030 surface = qemu_create_message_surface(width, height, unplugged);
2031 dpy_gfx_replace_surface(con, surface);
2034 QemuConsole *qemu_console_lookup_by_index(unsigned int index)
2038 QTAILQ_FOREACH(con, &consoles, next) {
2039 if (con->index == index) {
2046 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head)
2052 QTAILQ_FOREACH(con, &consoles, next) {
2053 obj = object_property_get_link(OBJECT(con),
2054 "device", &error_abort);
2055 if (DEVICE(obj) != dev) {
2058 h = object_property_get_uint(OBJECT(con),
2059 "head", &error_abort);
2068 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
2069 uint32_t head, Error **errp)
2074 dev = qdev_find_recursive(sysbus_get_default(), device_id);
2076 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2077 "Device '%s' not found", device_id);
2081 con = qemu_console_lookup_by_device(dev, head);
2083 error_setg(errp, "Device %s (head %d) is not bound to a QemuConsole",
2091 QemuConsole *qemu_console_lookup_unused(void)
2096 QTAILQ_FOREACH(con, &consoles, next) {
2097 if (con->hw_ops != &unused_ops) {
2100 obj = object_property_get_link(OBJECT(con),
2101 "device", &error_abort);
2110 bool qemu_console_is_visible(QemuConsole *con)
2112 return (con == active_console) || (con->dcls > 0);
2115 bool qemu_console_is_graphic(QemuConsole *con)
2118 con = active_console;
2120 return con && (con->console_type == GRAPHIC_CONSOLE);
2123 bool qemu_console_is_fixedsize(QemuConsole *con)
2126 con = active_console;
2128 return con && (con->console_type != TEXT_CONSOLE);
2131 bool qemu_console_is_gl_blocked(QemuConsole *con)
2133 assert(con != NULL);
2134 return con->gl_block;
2137 char *qemu_console_get_label(QemuConsole *con)
2139 if (con->console_type == GRAPHIC_CONSOLE) {
2141 return g_strdup(object_get_typename(con->device));
2143 return g_strdup("VGA");
2145 if (con->chr && con->chr->label) {
2146 return g_strdup(con->chr->label);
2148 return g_strdup_printf("vc%d", con->index);
2152 int qemu_console_get_index(QemuConsole *con)
2155 con = active_console;
2157 return con ? con->index : -1;
2160 uint32_t qemu_console_get_head(QemuConsole *con)
2163 con = active_console;
2165 return con ? con->head : -1;
2168 int qemu_console_get_width(QemuConsole *con, int fallback)
2171 con = active_console;
2173 return con ? surface_width(con->surface) : fallback;
2176 int qemu_console_get_height(QemuConsole *con, int fallback)
2179 con = active_console;
2181 return con ? surface_height(con->surface) : fallback;
2184 static void vc_chr_set_echo(Chardev *chr, bool echo)
2186 VCChardev *drv = VC_CHARDEV(chr);
2187 QemuConsole *s = drv->console;
2192 static void text_console_update_cursor_timer(void)
2194 timer_mod(cursor_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME)
2195 + CONSOLE_CURSOR_PERIOD / 2);
2198 static void text_console_update_cursor(void *opaque)
2203 cursor_visible_phase = !cursor_visible_phase;
2205 QTAILQ_FOREACH(s, &consoles, next) {
2206 if (qemu_console_is_graphic(s) ||
2207 !qemu_console_is_visible(s)) {
2211 graphic_hw_invalidate(s);
2215 text_console_update_cursor_timer();
2219 static const GraphicHwOps text_console_ops = {
2220 .invalidate = text_console_invalidate,
2221 .text_update = text_console_update,
2224 static void text_console_do_init(Chardev *chr, DisplayState *ds)
2226 VCChardev *drv = VC_CHARDEV(chr);
2227 QemuConsole *s = drv->console;
2228 int g_width = 80 * FONT_WIDTH;
2229 int g_height = 24 * FONT_HEIGHT;
2231 s->out_fifo.buf = s->out_fifo_buf;
2232 s->out_fifo.buf_size = sizeof(s->out_fifo_buf);
2233 s->kbd_timer = timer_new_ms(QEMU_CLOCK_REALTIME, kbd_send_chars, s);
2238 s->total_height = DEFAULT_BACKSCROLL;
2242 if (active_console && active_console->surface) {
2243 g_width = surface_width(active_console->surface);
2244 g_height = surface_height(active_console->surface);
2246 s->surface = qemu_create_displaysurface(g_width, g_height);
2249 s->hw_ops = &text_console_ops;
2252 /* Set text attribute defaults */
2253 s->t_attrib_default.bold = 0;
2254 s->t_attrib_default.uline = 0;
2255 s->t_attrib_default.blink = 0;
2256 s->t_attrib_default.invers = 0;
2257 s->t_attrib_default.unvisible = 0;
2258 s->t_attrib_default.fgcol = QEMU_COLOR_WHITE;
2259 s->t_attrib_default.bgcol = QEMU_COLOR_BLACK;
2260 /* set current text attributes to default */
2261 s->t_attrib = s->t_attrib_default;
2262 text_console_resize(s);
2267 s->t_attrib.bgcol = QEMU_COLOR_BLUE;
2268 msg = g_strdup_printf("%s console\r\n", chr->label);
2269 vc_chr_write(chr, (uint8_t *)msg, strlen(msg));
2271 s->t_attrib = s->t_attrib_default;
2274 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
2277 static void vc_chr_open(Chardev *chr,
2278 ChardevBackend *backend,
2282 ChardevVC *vc = backend->u.vc.data;
2283 VCChardev *drv = VC_CHARDEV(chr);
2286 unsigned height = 0;
2288 if (vc->has_width) {
2290 } else if (vc->has_cols) {
2291 width = vc->cols * FONT_WIDTH;
2294 if (vc->has_height) {
2295 height = vc->height;
2296 } else if (vc->has_rows) {
2297 height = vc->rows * FONT_HEIGHT;
2300 trace_console_txt_new(width, height);
2301 if (width == 0 || height == 0) {
2302 s = new_console(NULL, TEXT_CONSOLE, 0);
2304 s = new_console(NULL, TEXT_CONSOLE_FIXED_SIZE, 0);
2305 s->surface = qemu_create_displaysurface(width, height);
2309 error_setg(errp, "cannot create text console");
2316 if (display_state) {
2317 text_console_do_init(chr, display_state);
2320 /* console/chardev init sometimes completes elsewhere in a 2nd
2321 * stage, so defer OPENED events until they are fully initialized
2326 void qemu_console_resize(QemuConsole *s, int width, int height)
2328 DisplaySurface *surface;
2330 assert(s->console_type == GRAPHIC_CONSOLE);
2332 if (s->surface && (s->surface->flags & QEMU_ALLOCATED_FLAG) &&
2333 pixman_image_get_width(s->surface->image) == width &&
2334 pixman_image_get_height(s->surface->image) == height) {
2338 surface = qemu_create_displaysurface(width, height);
2339 dpy_gfx_replace_surface(s, surface);
2342 DisplaySurface *qemu_console_surface(QemuConsole *console)
2344 return console->surface;
2347 PixelFormat qemu_default_pixelformat(int bpp)
2349 pixman_format_code_t fmt = qemu_default_pixman_format(bpp, true);
2350 PixelFormat pf = qemu_pixelformat_from_pixman(fmt);
2354 static QemuDisplay *dpys[DISPLAY_TYPE__MAX];
2356 void qemu_display_register(QemuDisplay *ui)
2358 assert(ui->type < DISPLAY_TYPE__MAX);
2359 dpys[ui->type] = ui;
2362 bool qemu_display_find_default(DisplayOptions *opts)
2364 static DisplayType prio[] = {
2371 for (i = 0; i < ARRAY_SIZE(prio); i++) {
2372 if (dpys[prio[i]] == NULL) {
2373 ui_module_load_one(DisplayType_str(prio[i]));
2375 if (dpys[prio[i]] == NULL) {
2378 opts->type = prio[i];
2384 void qemu_display_early_init(DisplayOptions *opts)
2386 assert(opts->type < DISPLAY_TYPE__MAX);
2387 if (opts->type == DISPLAY_TYPE_NONE) {
2390 if (dpys[opts->type] == NULL) {
2391 ui_module_load_one(DisplayType_str(opts->type));
2393 if (dpys[opts->type] == NULL) {
2394 error_report("Display '%s' is not available.",
2395 DisplayType_str(opts->type));
2398 if (dpys[opts->type]->early_init) {
2399 dpys[opts->type]->early_init(opts);
2403 void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
2405 assert(opts->type < DISPLAY_TYPE__MAX);
2406 if (opts->type == DISPLAY_TYPE_NONE) {
2409 assert(dpys[opts->type] != NULL);
2410 dpys[opts->type]->init(ds, opts);
2413 void qemu_display_help(void)
2417 printf("Available display backend types:\n");
2419 for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
2421 ui_module_load_one(DisplayType_str(idx));
2424 printf("%s\n", DisplayType_str(dpys[idx]->type));
2429 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
2434 backend->type = CHARDEV_BACKEND_KIND_VC;
2435 vc = backend->u.vc.data = g_new0(ChardevVC, 1);
2436 qemu_chr_parse_common(opts, qapi_ChardevVC_base(vc));
2438 val = qemu_opt_get_number(opts, "width", 0);
2440 vc->has_width = true;
2444 val = qemu_opt_get_number(opts, "height", 0);
2446 vc->has_height = true;
2450 val = qemu_opt_get_number(opts, "cols", 0);
2452 vc->has_cols = true;
2456 val = qemu_opt_get_number(opts, "rows", 0);
2458 vc->has_rows = true;
2463 static const TypeInfo qemu_console_info = {
2464 .name = TYPE_QEMU_CONSOLE,
2465 .parent = TYPE_OBJECT,
2466 .instance_size = sizeof(QemuConsole),
2467 .class_size = sizeof(QemuConsoleClass),
2470 static void char_vc_class_init(ObjectClass *oc, void *data)
2472 ChardevClass *cc = CHARDEV_CLASS(oc);
2474 cc->parse = qemu_chr_parse_vc;
2475 cc->open = vc_chr_open;
2476 cc->chr_write = vc_chr_write;
2477 cc->chr_set_echo = vc_chr_set_echo;
2480 static const TypeInfo char_vc_type_info = {
2481 .name = TYPE_CHARDEV_VC,
2482 .parent = TYPE_CHARDEV,
2483 .instance_size = sizeof(VCChardev),
2484 .class_init = char_vc_class_init,
2487 void qemu_console_early_init(void)
2489 /* set the default vc driver */
2490 if (!object_class_by_name(TYPE_CHARDEV_VC)) {
2491 type_register(&char_vc_type_info);
2495 static void register_types(void)
2497 type_register_static(&qemu_console_info);
2500 type_init(register_types);