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_del(ds->gui_timer);
257 timer_free(ds->gui_timer);
258 ds->gui_timer = NULL;
261 ds->have_gfx = have_gfx;
262 ds->have_text = have_text;
265 void graphic_hw_update_done(QemuConsole *con)
268 qemu_co_queue_restart_all(&con->dump_queue);
272 void graphic_hw_update(QemuConsole *con)
275 con = con ? con : active_console;
279 if (con->hw_ops->gfx_update) {
280 con->hw_ops->gfx_update(con->hw);
281 async = con->hw_ops->gfx_update_async;
284 graphic_hw_update_done(con);
288 void graphic_hw_gl_block(QemuConsole *con, bool block)
292 con->gl_block = block;
293 if (con->hw_ops->gl_block) {
294 con->hw_ops->gl_block(con->hw, block);
298 int qemu_console_get_window_id(QemuConsole *con)
300 return con->window_id;
303 void qemu_console_set_window_id(QemuConsole *con, int window_id)
305 con->window_id = window_id;
308 void graphic_hw_invalidate(QemuConsole *con)
311 con = active_console;
313 if (con && con->hw_ops->invalidate) {
314 con->hw_ops->invalidate(con->hw);
318 static bool ppm_save(int fd, pixman_image_t *image, Error **errp)
320 int width = pixman_image_get_width(image);
321 int height = pixman_image_get_height(image);
322 g_autoptr(Object) ioc = OBJECT(qio_channel_file_new_fd(fd));
323 g_autofree char *header = NULL;
324 g_autoptr(pixman_image_t) linebuf = NULL;
327 trace_ppm_save(fd, image);
329 header = g_strdup_printf("P6\n%d %d\n%d\n", width, height, 255);
330 if (qio_channel_write_all(QIO_CHANNEL(ioc),
331 header, strlen(header), errp) < 0) {
335 linebuf = qemu_pixman_linebuf_create(PIXMAN_BE_r8g8b8, width);
336 for (y = 0; y < height; y++) {
337 qemu_pixman_linebuf_fill(linebuf, image, width, 0, y);
338 if (qio_channel_write_all(QIO_CHANNEL(ioc),
339 (char *)pixman_image_get_data(linebuf),
340 pixman_image_get_stride(linebuf), errp) < 0) {
348 static void graphic_hw_update_bh(void *con)
350 graphic_hw_update(con);
353 /* Safety: coroutine-only, concurrent-coroutine safe, main thread only */
355 qmp_screendump(const char *filename, bool has_device, const char *device,
356 bool has_head, int64_t head, Error **errp)
358 g_autoptr(pixman_image_t) image = NULL;
360 DisplaySurface *surface;
364 con = qemu_console_lookup_by_device_name(device, has_head ? head : 0,
371 error_setg(errp, "'head' must be specified together with 'device'");
374 con = qemu_console_lookup_by_index(0);
376 error_setg(errp, "There is no console to take a screendump from");
381 if (qemu_co_queue_empty(&con->dump_queue)) {
382 /* Defer the update, it will restart the pending coroutines */
383 aio_bh_schedule_oneshot(qemu_get_aio_context(),
384 graphic_hw_update_bh, con);
386 qemu_co_queue_wait(&con->dump_queue, NULL);
389 * All pending coroutines are woken up, while the BQL is held. No
390 * further graphic update are possible until it is released. Take
391 * an image ref before that.
393 surface = qemu_console_surface(con);
395 error_setg(errp, "no surface");
398 image = pixman_image_ref(surface->image);
400 fd = qemu_open_old(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666);
402 error_setg(errp, "failed to open file '%s': %s", filename,
408 * The image content could potentially be updated as the coroutine
409 * yields and releases the BQL. It could produce corrupted dump, but
410 * it should be otherwise safe.
412 if (!ppm_save(fd, image, errp)) {
413 qemu_unlink(filename);
417 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata)
420 con = active_console;
422 if (con && con->hw_ops->text_update) {
423 con->hw_ops->text_update(con->hw, chardata);
427 static void vga_fill_rect(QemuConsole *con,
428 int posx, int posy, int width, int height,
429 pixman_color_t color)
431 DisplaySurface *surface = qemu_console_surface(con);
432 pixman_rectangle16_t rect = {
433 .x = posx, .y = posy, .width = width, .height = height
436 pixman_image_fill_rectangles(PIXMAN_OP_SRC, surface->image,
440 /* copy from (xs, ys) to (xd, yd) a rectangle of size (w, h) */
441 static void vga_bitblt(QemuConsole *con,
442 int xs, int ys, int xd, int yd, int w, int h)
444 DisplaySurface *surface = qemu_console_surface(con);
446 pixman_image_composite(PIXMAN_OP_SRC,
447 surface->image, NULL, surface->image,
448 xs, ys, 0, 0, xd, yd, w, h);
451 /***********************************************************/
452 /* basic char display */
454 #define FONT_HEIGHT 16
459 #define QEMU_RGB(r, g, b) \
460 { .red = r << 8, .green = g << 8, .blue = b << 8, .alpha = 0xffff }
462 static const pixman_color_t color_table_rgb[2][8] = {
464 [QEMU_COLOR_BLACK] = QEMU_RGB(0x00, 0x00, 0x00), /* black */
465 [QEMU_COLOR_BLUE] = QEMU_RGB(0x00, 0x00, 0xaa), /* blue */
466 [QEMU_COLOR_GREEN] = QEMU_RGB(0x00, 0xaa, 0x00), /* green */
467 [QEMU_COLOR_CYAN] = QEMU_RGB(0x00, 0xaa, 0xaa), /* cyan */
468 [QEMU_COLOR_RED] = QEMU_RGB(0xaa, 0x00, 0x00), /* red */
469 [QEMU_COLOR_MAGENTA] = QEMU_RGB(0xaa, 0x00, 0xaa), /* magenta */
470 [QEMU_COLOR_YELLOW] = QEMU_RGB(0xaa, 0xaa, 0x00), /* yellow */
471 [QEMU_COLOR_WHITE] = QEMU_RGB(0xaa, 0xaa, 0xaa), /* white */
474 [QEMU_COLOR_BLACK] = QEMU_RGB(0x00, 0x00, 0x00), /* black */
475 [QEMU_COLOR_BLUE] = QEMU_RGB(0x00, 0x00, 0xff), /* blue */
476 [QEMU_COLOR_GREEN] = QEMU_RGB(0x00, 0xff, 0x00), /* green */
477 [QEMU_COLOR_CYAN] = QEMU_RGB(0x00, 0xff, 0xff), /* cyan */
478 [QEMU_COLOR_RED] = QEMU_RGB(0xff, 0x00, 0x00), /* red */
479 [QEMU_COLOR_MAGENTA] = QEMU_RGB(0xff, 0x00, 0xff), /* magenta */
480 [QEMU_COLOR_YELLOW] = QEMU_RGB(0xff, 0xff, 0x00), /* yellow */
481 [QEMU_COLOR_WHITE] = QEMU_RGB(0xff, 0xff, 0xff), /* white */
485 static void vga_putcharxy(QemuConsole *s, int x, int y, int ch,
486 TextAttributes *t_attrib)
488 static pixman_image_t *glyphs[256];
489 DisplaySurface *surface = qemu_console_surface(s);
490 pixman_color_t fgcol, bgcol;
492 if (t_attrib->invers) {
493 bgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
494 fgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
496 fgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
497 bgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
501 glyphs[ch] = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, ch);
503 qemu_pixman_glyph_render(glyphs[ch], surface->image,
504 &fgcol, &bgcol, x, y, FONT_WIDTH, FONT_HEIGHT);
507 static void text_console_resize(QemuConsole *s)
509 TextCell *cells, *c, *c1;
510 int w1, x, y, last_width;
512 last_width = s->width;
513 s->width = surface_width(s->surface) / FONT_WIDTH;
514 s->height = surface_height(s->surface) / FONT_HEIGHT;
520 cells = g_new(TextCell, s->width * s->total_height + 1);
521 for(y = 0; y < s->total_height; y++) {
522 c = &cells[y * s->width];
524 c1 = &s->cells[y * last_width];
525 for(x = 0; x < w1; x++) {
529 for(x = w1; x < s->width; x++) {
531 c->t_attrib = s->t_attrib_default;
539 static inline void text_update_xy(QemuConsole *s, int x, int y)
541 s->text_x[0] = MIN(s->text_x[0], x);
542 s->text_x[1] = MAX(s->text_x[1], x);
543 s->text_y[0] = MIN(s->text_y[0], y);
544 s->text_y[1] = MAX(s->text_y[1], y);
547 static void invalidate_xy(QemuConsole *s, int x, int y)
549 if (!qemu_console_is_visible(s)) {
552 if (s->update_x0 > x * FONT_WIDTH)
553 s->update_x0 = x * FONT_WIDTH;
554 if (s->update_y0 > y * FONT_HEIGHT)
555 s->update_y0 = y * FONT_HEIGHT;
556 if (s->update_x1 < (x + 1) * FONT_WIDTH)
557 s->update_x1 = (x + 1) * FONT_WIDTH;
558 if (s->update_y1 < (y + 1) * FONT_HEIGHT)
559 s->update_y1 = (y + 1) * FONT_HEIGHT;
562 static void update_xy(QemuConsole *s, int x, int y)
567 if (s->ds->have_text) {
568 text_update_xy(s, x, y);
571 y1 = (s->y_base + y) % s->total_height;
572 y2 = y1 - s->y_displayed;
574 y2 += s->total_height;
576 if (y2 < s->height) {
580 c = &s->cells[y1 * s->width + x];
581 vga_putcharxy(s, x, y2, c->ch,
583 invalidate_xy(s, x, y2);
587 static void console_show_cursor(QemuConsole *s, int show)
593 if (s->ds->have_text) {
594 s->cursor_invalidate = 1;
600 y1 = (s->y_base + s->y) % s->total_height;
601 y = y1 - s->y_displayed;
603 y += s->total_height;
606 c = &s->cells[y1 * s->width + x];
607 if (show && cursor_visible_phase) {
608 TextAttributes t_attrib = s->t_attrib_default;
609 t_attrib.invers = !(t_attrib.invers); /* invert fg and bg */
610 vga_putcharxy(s, x, y, c->ch, &t_attrib);
612 vga_putcharxy(s, x, y, c->ch, &(c->t_attrib));
614 invalidate_xy(s, x, y);
618 static void console_refresh(QemuConsole *s)
620 DisplaySurface *surface = qemu_console_surface(s);
624 if (s->ds->have_text) {
627 s->text_x[1] = s->width - 1;
628 s->text_y[1] = s->height - 1;
629 s->cursor_invalidate = 1;
632 vga_fill_rect(s, 0, 0, surface_width(surface), surface_height(surface),
633 color_table_rgb[0][QEMU_COLOR_BLACK]);
635 for (y = 0; y < s->height; y++) {
636 c = s->cells + y1 * s->width;
637 for (x = 0; x < s->width; x++) {
638 vga_putcharxy(s, x, y, c->ch,
642 if (++y1 == s->total_height) {
646 console_show_cursor(s, 1);
647 dpy_gfx_update(s, 0, 0,
648 surface_width(surface), surface_height(surface));
651 static void console_scroll(QemuConsole *s, int ydelta)
656 for(i = 0; i < ydelta; i++) {
657 if (s->y_displayed == s->y_base)
659 if (++s->y_displayed == s->total_height)
664 i = s->backscroll_height;
665 if (i > s->total_height - s->height)
666 i = s->total_height - s->height;
669 y1 += s->total_height;
670 for(i = 0; i < ydelta; i++) {
671 if (s->y_displayed == y1)
673 if (--s->y_displayed < 0)
674 s->y_displayed = s->total_height - 1;
680 static void console_put_lf(QemuConsole *s)
686 if (s->y >= s->height) {
687 s->y = s->height - 1;
689 if (s->y_displayed == s->y_base) {
690 if (++s->y_displayed == s->total_height)
693 if (++s->y_base == s->total_height)
695 if (s->backscroll_height < s->total_height)
696 s->backscroll_height++;
697 y1 = (s->y_base + s->height - 1) % s->total_height;
698 c = &s->cells[y1 * s->width];
699 for(x = 0; x < s->width; x++) {
701 c->t_attrib = s->t_attrib_default;
704 if (s->y_displayed == s->y_base) {
705 if (s->ds->have_text) {
708 s->text_x[1] = s->width - 1;
709 s->text_y[1] = s->height - 1;
712 vga_bitblt(s, 0, FONT_HEIGHT, 0, 0,
713 s->width * FONT_WIDTH,
714 (s->height - 1) * FONT_HEIGHT);
715 vga_fill_rect(s, 0, (s->height - 1) * FONT_HEIGHT,
716 s->width * FONT_WIDTH, FONT_HEIGHT,
717 color_table_rgb[0][s->t_attrib_default.bgcol]);
720 s->update_x1 = s->width * FONT_WIDTH;
721 s->update_y1 = s->height * FONT_HEIGHT;
726 /* Set console attributes depending on the current escape codes.
727 * NOTE: I know this code is not very efficient (checking every color for it
728 * self) but it is more readable and better maintainable.
730 static void console_handle_escape(QemuConsole *s)
734 for (i=0; i<s->nb_esc_params; i++) {
735 switch (s->esc_params[i]) {
736 case 0: /* reset all console attributes to default */
737 s->t_attrib = s->t_attrib_default;
740 s->t_attrib.bold = 1;
743 s->t_attrib.uline = 1;
746 s->t_attrib.blink = 1;
749 s->t_attrib.invers = 1;
752 s->t_attrib.unvisible = 1;
755 s->t_attrib.bold = 0;
758 s->t_attrib.uline = 0;
761 s->t_attrib.blink = 0;
764 s->t_attrib.invers = 0;
767 s->t_attrib.unvisible = 0;
769 /* set foreground color */
771 s->t_attrib.fgcol = QEMU_COLOR_BLACK;
774 s->t_attrib.fgcol = QEMU_COLOR_RED;
777 s->t_attrib.fgcol = QEMU_COLOR_GREEN;
780 s->t_attrib.fgcol = QEMU_COLOR_YELLOW;
783 s->t_attrib.fgcol = QEMU_COLOR_BLUE;
786 s->t_attrib.fgcol = QEMU_COLOR_MAGENTA;
789 s->t_attrib.fgcol = QEMU_COLOR_CYAN;
792 s->t_attrib.fgcol = QEMU_COLOR_WHITE;
794 /* set background color */
796 s->t_attrib.bgcol = QEMU_COLOR_BLACK;
799 s->t_attrib.bgcol = QEMU_COLOR_RED;
802 s->t_attrib.bgcol = QEMU_COLOR_GREEN;
805 s->t_attrib.bgcol = QEMU_COLOR_YELLOW;
808 s->t_attrib.bgcol = QEMU_COLOR_BLUE;
811 s->t_attrib.bgcol = QEMU_COLOR_MAGENTA;
814 s->t_attrib.bgcol = QEMU_COLOR_CYAN;
817 s->t_attrib.bgcol = QEMU_COLOR_WHITE;
823 static void console_clear_xy(QemuConsole *s, int x, int y)
825 int y1 = (s->y_base + y) % s->total_height;
829 TextCell *c = &s->cells[y1 * s->width + x];
831 c->t_attrib = s->t_attrib_default;
835 static void console_put_one(QemuConsole *s, int ch)
839 if (s->x >= s->width) {
844 y1 = (s->y_base + s->y) % s->total_height;
845 c = &s->cells[y1 * s->width + s->x];
847 c->t_attrib = s->t_attrib;
848 update_xy(s, s->x, s->y);
852 static void console_respond_str(QemuConsole *s, const char *buf)
855 console_put_one(s, *buf);
860 /* set cursor, checking bounds */
861 static void set_cursor(QemuConsole *s, int x, int y)
869 if (y >= s->height) {
880 static void console_putchar(QemuConsole *s, int ch)
889 case '\r': /* carriage return */
892 case '\n': /* newline */
895 case '\b': /* backspace */
899 case '\t': /* tabspace */
900 if (s->x + (8 - (s->x % 8)) > s->width) {
904 s->x = s->x + (8 - (s->x % 8));
907 case '\a': /* alert aka. bell */
908 /* TODO: has to be implemented */
911 /* SI (shift in), character set 0 (ignored) */
914 /* SO (shift out), character set 1 (ignored) */
916 case 27: /* esc (introducing an escape sequence) */
917 s->state = TTY_STATE_ESC;
920 console_put_one(s, ch);
924 case TTY_STATE_ESC: /* check if it is a terminal escape sequence */
926 for(i=0;i<MAX_ESC_PARAMS;i++)
927 s->esc_params[i] = 0;
928 s->nb_esc_params = 0;
929 s->state = TTY_STATE_CSI;
931 s->state = TTY_STATE_NORM;
934 case TTY_STATE_CSI: /* handle escape sequence parameters */
935 if (ch >= '0' && ch <= '9') {
936 if (s->nb_esc_params < MAX_ESC_PARAMS) {
937 int *param = &s->esc_params[s->nb_esc_params];
938 int digit = (ch - '0');
940 *param = (*param <= (INT_MAX - digit) / 10) ?
941 *param * 10 + digit : INT_MAX;
944 if (s->nb_esc_params < MAX_ESC_PARAMS)
946 if (ch == ';' || ch == '?') {
949 trace_console_putchar_csi(s->esc_params[0], s->esc_params[1],
950 ch, s->nb_esc_params);
951 s->state = TTY_STATE_NORM;
955 if (s->esc_params[0] == 0) {
956 s->esc_params[0] = 1;
958 set_cursor(s, s->x, s->y - s->esc_params[0]);
961 /* move cursor down */
962 if (s->esc_params[0] == 0) {
963 s->esc_params[0] = 1;
965 set_cursor(s, s->x, s->y + s->esc_params[0]);
968 /* move cursor right */
969 if (s->esc_params[0] == 0) {
970 s->esc_params[0] = 1;
972 set_cursor(s, s->x + s->esc_params[0], s->y);
975 /* move cursor left */
976 if (s->esc_params[0] == 0) {
977 s->esc_params[0] = 1;
979 set_cursor(s, s->x - s->esc_params[0], s->y);
982 /* move cursor to column */
983 set_cursor(s, s->esc_params[0] - 1, s->y);
987 /* move cursor to row, column */
988 set_cursor(s, s->esc_params[1] - 1, s->esc_params[0] - 1);
991 switch (s->esc_params[0]) {
993 /* clear to end of screen */
994 for (y = s->y; y < s->height; y++) {
995 for (x = 0; x < s->width; x++) {
996 if (y == s->y && x < s->x) {
999 console_clear_xy(s, x, y);
1004 /* clear from beginning of screen */
1005 for (y = 0; y <= s->y; y++) {
1006 for (x = 0; x < s->width; x++) {
1007 if (y == s->y && x > s->x) {
1010 console_clear_xy(s, x, y);
1015 /* clear entire screen */
1016 for (y = 0; y <= s->height; y++) {
1017 for (x = 0; x < s->width; x++) {
1018 console_clear_xy(s, x, y);
1025 switch (s->esc_params[0]) {
1028 for(x = s->x; x < s->width; x++) {
1029 console_clear_xy(s, x, s->y);
1033 /* clear from beginning of line */
1034 for (x = 0; x <= s->x && x < s->width; x++) {
1035 console_clear_xy(s, x, s->y);
1039 /* clear entire line */
1040 for(x = 0; x < s->width; x++) {
1041 console_clear_xy(s, x, s->y);
1047 console_handle_escape(s);
1050 switch (s->esc_params[0]) {
1052 /* report console status (always succeed)*/
1053 console_respond_str(s, "\033[0n");
1056 /* report cursor position */
1057 sprintf(response, "\033[%d;%dR",
1058 (s->y_base + s->y) % s->total_height + 1,
1060 console_respond_str(s, response);
1065 /* save cursor position */
1070 /* restore cursor position */
1075 trace_console_putchar_unhandled(ch);
1083 void console_select(unsigned int index)
1085 DisplayChangeListener *dcl;
1088 trace_console_select(index);
1089 s = qemu_console_lookup_by_index(index);
1091 DisplayState *ds = s->ds;
1095 QLIST_FOREACH(dcl, &ds->listeners, next) {
1096 if (dcl->con != NULL) {
1099 if (dcl->ops->dpy_gfx_switch) {
1100 dcl->ops->dpy_gfx_switch(dcl, s->surface);
1104 dpy_gfx_update(s, 0, 0, surface_width(s->surface),
1105 surface_height(s->surface));
1108 if (ds->have_text) {
1109 dpy_text_resize(s, s->width, s->height);
1111 text_console_update_cursor(NULL);
1117 QemuConsole *console;
1119 typedef struct VCChardev VCChardev;
1121 #define TYPE_CHARDEV_VC "chardev-vc"
1122 DECLARE_INSTANCE_CHECKER(VCChardev, VC_CHARDEV,
1125 static int vc_chr_write(Chardev *chr, const uint8_t *buf, int len)
1127 VCChardev *drv = VC_CHARDEV(chr);
1128 QemuConsole *s = drv->console;
1135 s->update_x0 = s->width * FONT_WIDTH;
1136 s->update_y0 = s->height * FONT_HEIGHT;
1139 console_show_cursor(s, 0);
1140 for(i = 0; i < len; i++) {
1141 console_putchar(s, buf[i]);
1143 console_show_cursor(s, 1);
1144 if (s->ds->have_gfx && s->update_x0 < s->update_x1) {
1145 dpy_gfx_update(s, s->update_x0, s->update_y0,
1146 s->update_x1 - s->update_x0,
1147 s->update_y1 - s->update_y0);
1152 static void kbd_send_chars(void *opaque)
1154 QemuConsole *s = opaque;
1158 len = qemu_chr_be_can_write(s->chr);
1159 if (len > s->out_fifo.count)
1160 len = s->out_fifo.count;
1162 if (len > sizeof(buf))
1164 qemu_fifo_read(&s->out_fifo, buf, len);
1165 qemu_chr_be_write(s->chr, buf, len);
1167 /* characters are pending: we send them a bit later (XXX:
1168 horrible, should change char device API) */
1169 if (s->out_fifo.count > 0) {
1170 timer_mod(s->kbd_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 1);
1174 /* called when an ascii key is pressed */
1175 void kbd_put_keysym_console(QemuConsole *s, int keysym)
1177 uint8_t buf[16], *q;
1181 if (!s || (s->console_type == GRAPHIC_CONSOLE))
1185 case QEMU_KEY_CTRL_UP:
1186 console_scroll(s, -1);
1188 case QEMU_KEY_CTRL_DOWN:
1189 console_scroll(s, 1);
1191 case QEMU_KEY_CTRL_PAGEUP:
1192 console_scroll(s, -10);
1194 case QEMU_KEY_CTRL_PAGEDOWN:
1195 console_scroll(s, 10);
1198 /* convert the QEMU keysym to VT100 key string */
1200 if (keysym >= 0xe100 && keysym <= 0xe11f) {
1203 c = keysym - 0xe100;
1205 *q++ = '0' + (c / 10);
1206 *q++ = '0' + (c % 10);
1208 } else if (keysym >= 0xe120 && keysym <= 0xe17f) {
1211 *q++ = keysym & 0xff;
1212 } else if (s->echo && (keysym == '\r' || keysym == '\n')) {
1213 vc_chr_write(s->chr, (const uint8_t *) "\r", 1);
1219 vc_chr_write(s->chr, buf, q - buf);
1222 if (be && be->chr_read) {
1223 qemu_fifo_write(&s->out_fifo, buf, q - buf);
1230 static const int qcode_to_keysym[Q_KEY_CODE__MAX] = {
1231 [Q_KEY_CODE_UP] = QEMU_KEY_UP,
1232 [Q_KEY_CODE_DOWN] = QEMU_KEY_DOWN,
1233 [Q_KEY_CODE_RIGHT] = QEMU_KEY_RIGHT,
1234 [Q_KEY_CODE_LEFT] = QEMU_KEY_LEFT,
1235 [Q_KEY_CODE_HOME] = QEMU_KEY_HOME,
1236 [Q_KEY_CODE_END] = QEMU_KEY_END,
1237 [Q_KEY_CODE_PGUP] = QEMU_KEY_PAGEUP,
1238 [Q_KEY_CODE_PGDN] = QEMU_KEY_PAGEDOWN,
1239 [Q_KEY_CODE_DELETE] = QEMU_KEY_DELETE,
1240 [Q_KEY_CODE_BACKSPACE] = QEMU_KEY_BACKSPACE,
1243 static const int ctrl_qcode_to_keysym[Q_KEY_CODE__MAX] = {
1244 [Q_KEY_CODE_UP] = QEMU_KEY_CTRL_UP,
1245 [Q_KEY_CODE_DOWN] = QEMU_KEY_CTRL_DOWN,
1246 [Q_KEY_CODE_RIGHT] = QEMU_KEY_CTRL_RIGHT,
1247 [Q_KEY_CODE_LEFT] = QEMU_KEY_CTRL_LEFT,
1248 [Q_KEY_CODE_HOME] = QEMU_KEY_CTRL_HOME,
1249 [Q_KEY_CODE_END] = QEMU_KEY_CTRL_END,
1250 [Q_KEY_CODE_PGUP] = QEMU_KEY_CTRL_PAGEUP,
1251 [Q_KEY_CODE_PGDN] = QEMU_KEY_CTRL_PAGEDOWN,
1254 bool kbd_put_qcode_console(QemuConsole *s, int qcode, bool ctrl)
1258 keysym = ctrl ? ctrl_qcode_to_keysym[qcode] : qcode_to_keysym[qcode];
1262 kbd_put_keysym_console(s, keysym);
1266 void kbd_put_string_console(QemuConsole *s, const char *str, int len)
1270 for (i = 0; i < len && str[i]; i++) {
1271 kbd_put_keysym_console(s, str[i]);
1275 void kbd_put_keysym(int keysym)
1277 kbd_put_keysym_console(active_console, keysym);
1280 static void text_console_invalidate(void *opaque)
1282 QemuConsole *s = (QemuConsole *) opaque;
1284 if (s->ds->have_text && s->console_type == TEXT_CONSOLE) {
1285 text_console_resize(s);
1290 static void text_console_update(void *opaque, console_ch_t *chardata)
1292 QemuConsole *s = (QemuConsole *) opaque;
1295 if (s->text_x[0] <= s->text_x[1]) {
1296 src = (s->y_base + s->text_y[0]) * s->width;
1297 chardata += s->text_y[0] * s->width;
1298 for (i = s->text_y[0]; i <= s->text_y[1]; i ++)
1299 for (j = 0; j < s->width; j++, src++) {
1300 console_write_ch(chardata ++,
1301 ATTR2CHTYPE(s->cells[src].ch,
1302 s->cells[src].t_attrib.fgcol,
1303 s->cells[src].t_attrib.bgcol,
1304 s->cells[src].t_attrib.bold));
1306 dpy_text_update(s, s->text_x[0], s->text_y[0],
1307 s->text_x[1] - s->text_x[0], i - s->text_y[0]);
1308 s->text_x[0] = s->width;
1309 s->text_y[0] = s->height;
1313 if (s->cursor_invalidate) {
1314 dpy_text_cursor(s, s->x, s->y);
1315 s->cursor_invalidate = 0;
1319 static QemuConsole *new_console(DisplayState *ds, console_type_t console_type,
1326 obj = object_new(TYPE_QEMU_CONSOLE);
1327 s = QEMU_CONSOLE(obj);
1328 qemu_co_queue_init(&s->dump_queue);
1330 object_property_add_link(obj, "device", TYPE_DEVICE,
1331 (Object **)&s->device,
1332 object_property_allow_set_link,
1333 OBJ_PROP_LINK_STRONG);
1334 object_property_add_uint32_ptr(obj, "head", &s->head,
1335 OBJ_PROP_FLAG_READ);
1337 if (!active_console || ((active_console->console_type != GRAPHIC_CONSOLE) &&
1338 (console_type == GRAPHIC_CONSOLE))) {
1342 s->console_type = console_type;
1345 if (QTAILQ_EMPTY(&consoles)) {
1347 QTAILQ_INSERT_TAIL(&consoles, s, next);
1348 } else if (console_type != GRAPHIC_CONSOLE || qdev_hotplug) {
1349 QemuConsole *last = QTAILQ_LAST(&consoles);
1350 s->index = last->index + 1;
1351 QTAILQ_INSERT_TAIL(&consoles, s, next);
1354 * HACK: Put graphical consoles before text consoles.
1356 * Only do that for coldplugged devices. After initial device
1357 * initialization we will not renumber the consoles any more.
1359 QemuConsole *c = QTAILQ_FIRST(&consoles);
1361 while (QTAILQ_NEXT(c, next) != NULL &&
1362 c->console_type == GRAPHIC_CONSOLE) {
1363 c = QTAILQ_NEXT(c, next);
1365 if (c->console_type == GRAPHIC_CONSOLE) {
1366 /* have no text consoles */
1367 s->index = c->index + 1;
1368 QTAILQ_INSERT_AFTER(&consoles, c, s, next);
1370 s->index = c->index;
1371 QTAILQ_INSERT_BEFORE(c, s, next);
1372 /* renumber text consoles */
1373 for (i = s->index + 1; c != NULL; c = QTAILQ_NEXT(c, next), i++) {
1381 static void qemu_alloc_display(DisplaySurface *surface, int width, int height)
1383 qemu_pixman_image_unref(surface->image);
1384 surface->image = NULL;
1386 surface->format = PIXMAN_x8r8g8b8;
1387 surface->image = pixman_image_create_bits(surface->format,
1390 assert(surface->image != NULL);
1392 surface->flags = QEMU_ALLOCATED_FLAG;
1395 DisplaySurface *qemu_create_displaysurface(int width, int height)
1397 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1399 trace_displaysurface_create(surface, width, height);
1400 qemu_alloc_display(surface, width, height);
1404 DisplaySurface *qemu_create_displaysurface_from(int width, int height,
1405 pixman_format_code_t format,
1406 int linesize, uint8_t *data)
1408 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1410 trace_displaysurface_create_from(surface, width, height, format);
1411 surface->format = format;
1412 surface->image = pixman_image_create_bits(surface->format,
1414 (void *)data, linesize);
1415 assert(surface->image != NULL);
1420 DisplaySurface *qemu_create_displaysurface_pixman(pixman_image_t *image)
1422 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1424 trace_displaysurface_create_pixman(surface);
1425 surface->format = pixman_image_get_format(image);
1426 surface->image = pixman_image_ref(image);
1431 DisplaySurface *qemu_create_message_surface(int w, int h,
1434 DisplaySurface *surface = qemu_create_displaysurface(w, h);
1435 pixman_color_t bg = color_table_rgb[0][QEMU_COLOR_BLACK];
1436 pixman_color_t fg = color_table_rgb[0][QEMU_COLOR_WHITE];
1437 pixman_image_t *glyph;
1441 x = (w / FONT_WIDTH - len) / 2;
1442 y = (h / FONT_HEIGHT - 1) / 2;
1443 for (i = 0; i < len; i++) {
1444 glyph = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, msg[i]);
1445 qemu_pixman_glyph_render(glyph, surface->image, &fg, &bg,
1446 x+i, y, FONT_WIDTH, FONT_HEIGHT);
1447 qemu_pixman_image_unref(glyph);
1452 void qemu_free_displaysurface(DisplaySurface *surface)
1454 if (surface == NULL) {
1457 trace_displaysurface_free(surface);
1458 qemu_pixman_image_unref(surface->image);
1462 bool console_has_gl(QemuConsole *con)
1464 return con->gl != NULL;
1467 bool console_has_gl_dmabuf(QemuConsole *con)
1469 return con->gl != NULL && con->gl->ops->dpy_gl_scanout_dmabuf != NULL;
1472 void register_displaychangelistener(DisplayChangeListener *dcl)
1474 static const char nodev[] =
1475 "This VM has no graphic display device.";
1476 static DisplaySurface *dummy;
1481 if (dcl->ops->dpy_gl_ctx_create) {
1482 /* display has opengl support */
1485 fprintf(stderr, "can't register two opengl displays (%s, %s)\n",
1486 dcl->ops->dpy_name, dcl->con->gl->ops->dpy_name);
1492 trace_displaychangelistener_register(dcl, dcl->ops->dpy_name);
1493 dcl->ds = get_alloc_displaystate();
1494 QLIST_INSERT_HEAD(&dcl->ds->listeners, dcl, next);
1495 gui_setup_refresh(dcl->ds);
1500 con = active_console;
1502 if (dcl->ops->dpy_gfx_switch) {
1504 dcl->ops->dpy_gfx_switch(dcl, con->surface);
1507 dummy = qemu_create_message_surface(640, 480, nodev);
1509 dcl->ops->dpy_gfx_switch(dcl, dummy);
1512 text_console_update_cursor(NULL);
1515 void update_displaychangelistener(DisplayChangeListener *dcl,
1518 DisplayState *ds = dcl->ds;
1520 dcl->update_interval = interval;
1521 if (!ds->refreshing && ds->update_interval > interval) {
1522 timer_mod(ds->gui_timer, ds->last_update + interval);
1526 void unregister_displaychangelistener(DisplayChangeListener *dcl)
1528 DisplayState *ds = dcl->ds;
1529 trace_displaychangelistener_unregister(dcl, dcl->ops->dpy_name);
1533 QLIST_REMOVE(dcl, next);
1535 gui_setup_refresh(ds);
1538 static void dpy_set_ui_info_timer(void *opaque)
1540 QemuConsole *con = opaque;
1542 con->hw_ops->ui_info(con->hw, con->head, &con->ui_info);
1545 bool dpy_ui_info_supported(QemuConsole *con)
1548 con = active_console;
1551 return con->hw_ops->ui_info != NULL;
1554 const QemuUIInfo *dpy_get_ui_info(const QemuConsole *con)
1557 con = active_console;
1560 return &con->ui_info;
1563 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info)
1566 con = active_console;
1569 if (!dpy_ui_info_supported(con)) {
1572 if (memcmp(&con->ui_info, info, sizeof(con->ui_info)) == 0) {
1573 /* nothing changed -- ignore */
1578 * Typically we get a flood of these as the user resizes the window.
1579 * Wait until the dust has settled (one second without updates), then
1580 * go notify the guest.
1582 con->ui_info = *info;
1583 timer_mod(con->ui_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 1000);
1587 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h)
1589 DisplayState *s = con->ds;
1590 DisplayChangeListener *dcl;
1595 width = surface_width(con->surface);
1596 height = surface_height(con->surface);
1602 w = MIN(w, width - x);
1603 h = MIN(h, height - y);
1605 if (!qemu_console_is_visible(con)) {
1608 QLIST_FOREACH(dcl, &s->listeners, next) {
1609 if (con != (dcl->con ? dcl->con : active_console)) {
1612 if (dcl->ops->dpy_gfx_update) {
1613 dcl->ops->dpy_gfx_update(dcl, x, y, w, h);
1618 void dpy_gfx_update_full(QemuConsole *con)
1620 if (!con->surface) {
1623 dpy_gfx_update(con, 0, 0,
1624 surface_width(con->surface),
1625 surface_height(con->surface));
1628 void dpy_gfx_replace_surface(QemuConsole *con,
1629 DisplaySurface *surface)
1631 DisplayState *s = con->ds;
1632 DisplaySurface *old_surface = con->surface;
1633 DisplayChangeListener *dcl;
1635 assert(old_surface != surface || surface == NULL);
1637 con->surface = surface;
1638 QLIST_FOREACH(dcl, &s->listeners, next) {
1639 if (con != (dcl->con ? dcl->con : active_console)) {
1642 if (dcl->ops->dpy_gfx_switch) {
1643 dcl->ops->dpy_gfx_switch(dcl, surface);
1646 qemu_free_displaysurface(old_surface);
1649 bool dpy_gfx_check_format(QemuConsole *con,
1650 pixman_format_code_t format)
1652 DisplayChangeListener *dcl;
1653 DisplayState *s = con->ds;
1655 QLIST_FOREACH(dcl, &s->listeners, next) {
1656 if (dcl->con && dcl->con != con) {
1657 /* dcl bound to another console -> skip */
1660 if (dcl->ops->dpy_gfx_check_format) {
1661 if (!dcl->ops->dpy_gfx_check_format(dcl, format)) {
1665 /* default is to whitelist native 32 bpp only */
1666 if (format != qemu_default_pixman_format(32, true)) {
1674 static void dpy_refresh(DisplayState *s)
1676 DisplayChangeListener *dcl;
1678 QLIST_FOREACH(dcl, &s->listeners, next) {
1679 if (dcl->ops->dpy_refresh) {
1680 dcl->ops->dpy_refresh(dcl);
1685 void dpy_text_cursor(QemuConsole *con, int x, int y)
1687 DisplayState *s = con->ds;
1688 DisplayChangeListener *dcl;
1690 if (!qemu_console_is_visible(con)) {
1693 QLIST_FOREACH(dcl, &s->listeners, next) {
1694 if (con != (dcl->con ? dcl->con : active_console)) {
1697 if (dcl->ops->dpy_text_cursor) {
1698 dcl->ops->dpy_text_cursor(dcl, x, y);
1703 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h)
1705 DisplayState *s = con->ds;
1706 DisplayChangeListener *dcl;
1708 if (!qemu_console_is_visible(con)) {
1711 QLIST_FOREACH(dcl, &s->listeners, next) {
1712 if (con != (dcl->con ? dcl->con : active_console)) {
1715 if (dcl->ops->dpy_text_update) {
1716 dcl->ops->dpy_text_update(dcl, x, y, w, h);
1721 void dpy_text_resize(QemuConsole *con, int w, int h)
1723 DisplayState *s = con->ds;
1724 DisplayChangeListener *dcl;
1726 if (!qemu_console_is_visible(con)) {
1729 QLIST_FOREACH(dcl, &s->listeners, next) {
1730 if (con != (dcl->con ? dcl->con : active_console)) {
1733 if (dcl->ops->dpy_text_resize) {
1734 dcl->ops->dpy_text_resize(dcl, w, h);
1739 void dpy_mouse_set(QemuConsole *con, int x, int y, int on)
1741 DisplayState *s = con->ds;
1742 DisplayChangeListener *dcl;
1744 if (!qemu_console_is_visible(con)) {
1747 QLIST_FOREACH(dcl, &s->listeners, next) {
1748 if (con != (dcl->con ? dcl->con : active_console)) {
1751 if (dcl->ops->dpy_mouse_set) {
1752 dcl->ops->dpy_mouse_set(dcl, x, y, on);
1757 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor)
1759 DisplayState *s = con->ds;
1760 DisplayChangeListener *dcl;
1762 if (!qemu_console_is_visible(con)) {
1765 QLIST_FOREACH(dcl, &s->listeners, next) {
1766 if (con != (dcl->con ? dcl->con : active_console)) {
1769 if (dcl->ops->dpy_cursor_define) {
1770 dcl->ops->dpy_cursor_define(dcl, cursor);
1775 bool dpy_cursor_define_supported(QemuConsole *con)
1777 DisplayState *s = con->ds;
1778 DisplayChangeListener *dcl;
1780 QLIST_FOREACH(dcl, &s->listeners, next) {
1781 if (dcl->ops->dpy_cursor_define) {
1788 QEMUGLContext dpy_gl_ctx_create(QemuConsole *con,
1789 struct QEMUGLParams *qparams)
1792 return con->gl->ops->dpy_gl_ctx_create(con->gl, qparams);
1795 void dpy_gl_ctx_destroy(QemuConsole *con, QEMUGLContext ctx)
1798 con->gl->ops->dpy_gl_ctx_destroy(con->gl, ctx);
1801 int dpy_gl_ctx_make_current(QemuConsole *con, QEMUGLContext ctx)
1804 return con->gl->ops->dpy_gl_ctx_make_current(con->gl, ctx);
1807 QEMUGLContext dpy_gl_ctx_get_current(QemuConsole *con)
1810 return con->gl->ops->dpy_gl_ctx_get_current(con->gl);
1813 void dpy_gl_scanout_disable(QemuConsole *con)
1816 if (con->gl->ops->dpy_gl_scanout_disable) {
1817 con->gl->ops->dpy_gl_scanout_disable(con->gl);
1819 con->gl->ops->dpy_gl_scanout_texture(con->gl, 0, false, 0, 0,
1824 void dpy_gl_scanout_texture(QemuConsole *con,
1825 uint32_t backing_id,
1826 bool backing_y_0_top,
1827 uint32_t backing_width,
1828 uint32_t backing_height,
1829 uint32_t x, uint32_t y,
1830 uint32_t width, uint32_t height)
1833 con->gl->ops->dpy_gl_scanout_texture(con->gl, backing_id,
1835 backing_width, backing_height,
1836 x, y, width, height);
1839 void dpy_gl_scanout_dmabuf(QemuConsole *con,
1843 con->gl->ops->dpy_gl_scanout_dmabuf(con->gl, dmabuf);
1846 void dpy_gl_cursor_dmabuf(QemuConsole *con, QemuDmaBuf *dmabuf,
1847 bool have_hot, uint32_t hot_x, uint32_t hot_y)
1851 if (con->gl->ops->dpy_gl_cursor_dmabuf) {
1852 con->gl->ops->dpy_gl_cursor_dmabuf(con->gl, dmabuf,
1853 have_hot, hot_x, hot_y);
1857 void dpy_gl_cursor_position(QemuConsole *con,
1858 uint32_t pos_x, uint32_t pos_y)
1862 if (con->gl->ops->dpy_gl_cursor_position) {
1863 con->gl->ops->dpy_gl_cursor_position(con->gl, pos_x, pos_y);
1867 void dpy_gl_release_dmabuf(QemuConsole *con,
1872 if (con->gl->ops->dpy_gl_release_dmabuf) {
1873 con->gl->ops->dpy_gl_release_dmabuf(con->gl, dmabuf);
1877 void dpy_gl_update(QemuConsole *con,
1878 uint32_t x, uint32_t y, uint32_t w, uint32_t h)
1881 con->gl->ops->dpy_gl_update(con->gl, x, y, w, h);
1884 /***********************************************************/
1885 /* register display */
1887 /* console.c internal use only */
1888 static DisplayState *get_alloc_displaystate(void)
1890 if (!display_state) {
1891 display_state = g_new0(DisplayState, 1);
1892 cursor_timer = timer_new_ms(QEMU_CLOCK_REALTIME,
1893 text_console_update_cursor, NULL);
1895 return display_state;
1899 * Called by main(), after creating QemuConsoles
1900 * and before initializing ui (sdl/vnc/...).
1902 DisplayState *init_displaystate(void)
1907 get_alloc_displaystate();
1908 QTAILQ_FOREACH(con, &consoles, next) {
1909 if (con->console_type != GRAPHIC_CONSOLE &&
1911 text_console_do_init(con->chr, display_state);
1914 /* Hook up into the qom tree here (not in new_console()), once
1915 * all QemuConsoles are created and the order / numbering
1916 * doesn't change any more */
1917 name = g_strdup_printf("console[%d]", con->index);
1918 object_property_add_child(container_get(object_get_root(), "/backend"),
1923 return display_state;
1926 void graphic_console_set_hwops(QemuConsole *con,
1927 const GraphicHwOps *hw_ops,
1930 con->hw_ops = hw_ops;
1934 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
1935 const GraphicHwOps *hw_ops,
1938 static const char noinit[] =
1939 "Guest has not initialized the display (yet).";
1944 DisplaySurface *surface;
1946 ds = get_alloc_displaystate();
1947 s = qemu_console_lookup_unused();
1949 trace_console_gfx_reuse(s->index);
1951 width = surface_width(s->surface);
1952 height = surface_height(s->surface);
1955 trace_console_gfx_new();
1956 s = new_console(ds, GRAPHIC_CONSOLE, head);
1957 s->ui_timer = timer_new_ms(QEMU_CLOCK_REALTIME,
1958 dpy_set_ui_info_timer, s);
1960 graphic_console_set_hwops(s, hw_ops, opaque);
1962 object_property_set_link(OBJECT(s), "device", OBJECT(dev),
1966 surface = qemu_create_message_surface(width, height, noinit);
1967 dpy_gfx_replace_surface(s, surface);
1971 static const GraphicHwOps unused_ops = {
1975 void graphic_console_close(QemuConsole *con)
1977 static const char unplugged[] =
1978 "Guest display has been unplugged";
1979 DisplaySurface *surface;
1984 width = surface_width(con->surface);
1985 height = surface_height(con->surface);
1988 trace_console_gfx_close(con->index);
1989 object_property_set_link(OBJECT(con), "device", NULL, &error_abort);
1990 graphic_console_set_hwops(con, &unused_ops, NULL);
1993 dpy_gl_scanout_disable(con);
1995 surface = qemu_create_message_surface(width, height, unplugged);
1996 dpy_gfx_replace_surface(con, surface);
1999 QemuConsole *qemu_console_lookup_by_index(unsigned int index)
2003 QTAILQ_FOREACH(con, &consoles, next) {
2004 if (con->index == index) {
2011 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head)
2017 QTAILQ_FOREACH(con, &consoles, next) {
2018 obj = object_property_get_link(OBJECT(con),
2019 "device", &error_abort);
2020 if (DEVICE(obj) != dev) {
2023 h = object_property_get_uint(OBJECT(con),
2024 "head", &error_abort);
2033 QemuConsole *qemu_console_lookup_by_device_name(const char *device_id,
2034 uint32_t head, Error **errp)
2039 dev = qdev_find_recursive(sysbus_get_default(), device_id);
2041 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2042 "Device '%s' not found", device_id);
2046 con = qemu_console_lookup_by_device(dev, head);
2048 error_setg(errp, "Device %s (head %d) is not bound to a QemuConsole",
2056 QemuConsole *qemu_console_lookup_unused(void)
2061 QTAILQ_FOREACH(con, &consoles, next) {
2062 if (con->hw_ops != &unused_ops) {
2065 obj = object_property_get_link(OBJECT(con),
2066 "device", &error_abort);
2075 bool qemu_console_is_visible(QemuConsole *con)
2077 return (con == active_console) || (con->dcls > 0);
2080 bool qemu_console_is_graphic(QemuConsole *con)
2083 con = active_console;
2085 return con && (con->console_type == GRAPHIC_CONSOLE);
2088 bool qemu_console_is_fixedsize(QemuConsole *con)
2091 con = active_console;
2093 return con && (con->console_type != TEXT_CONSOLE);
2096 bool qemu_console_is_gl_blocked(QemuConsole *con)
2098 assert(con != NULL);
2099 return con->gl_block;
2102 char *qemu_console_get_label(QemuConsole *con)
2104 if (con->console_type == GRAPHIC_CONSOLE) {
2106 return g_strdup(object_get_typename(con->device));
2108 return g_strdup("VGA");
2110 if (con->chr && con->chr->label) {
2111 return g_strdup(con->chr->label);
2113 return g_strdup_printf("vc%d", con->index);
2117 int qemu_console_get_index(QemuConsole *con)
2120 con = active_console;
2122 return con ? con->index : -1;
2125 uint32_t qemu_console_get_head(QemuConsole *con)
2128 con = active_console;
2130 return con ? con->head : -1;
2133 int qemu_console_get_width(QemuConsole *con, int fallback)
2136 con = active_console;
2138 return con ? surface_width(con->surface) : fallback;
2141 int qemu_console_get_height(QemuConsole *con, int fallback)
2144 con = active_console;
2146 return con ? surface_height(con->surface) : fallback;
2149 static void vc_chr_set_echo(Chardev *chr, bool echo)
2151 VCChardev *drv = VC_CHARDEV(chr);
2152 QemuConsole *s = drv->console;
2157 static void text_console_update_cursor_timer(void)
2159 timer_mod(cursor_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME)
2160 + CONSOLE_CURSOR_PERIOD / 2);
2163 static void text_console_update_cursor(void *opaque)
2168 cursor_visible_phase = !cursor_visible_phase;
2170 QTAILQ_FOREACH(s, &consoles, next) {
2171 if (qemu_console_is_graphic(s) ||
2172 !qemu_console_is_visible(s)) {
2176 graphic_hw_invalidate(s);
2180 text_console_update_cursor_timer();
2184 static const GraphicHwOps text_console_ops = {
2185 .invalidate = text_console_invalidate,
2186 .text_update = text_console_update,
2189 static void text_console_do_init(Chardev *chr, DisplayState *ds)
2191 VCChardev *drv = VC_CHARDEV(chr);
2192 QemuConsole *s = drv->console;
2193 int g_width = 80 * FONT_WIDTH;
2194 int g_height = 24 * FONT_HEIGHT;
2196 s->out_fifo.buf = s->out_fifo_buf;
2197 s->out_fifo.buf_size = sizeof(s->out_fifo_buf);
2198 s->kbd_timer = timer_new_ms(QEMU_CLOCK_REALTIME, kbd_send_chars, s);
2203 s->total_height = DEFAULT_BACKSCROLL;
2207 if (active_console && active_console->surface) {
2208 g_width = surface_width(active_console->surface);
2209 g_height = surface_height(active_console->surface);
2211 s->surface = qemu_create_displaysurface(g_width, g_height);
2214 s->hw_ops = &text_console_ops;
2217 /* Set text attribute defaults */
2218 s->t_attrib_default.bold = 0;
2219 s->t_attrib_default.uline = 0;
2220 s->t_attrib_default.blink = 0;
2221 s->t_attrib_default.invers = 0;
2222 s->t_attrib_default.unvisible = 0;
2223 s->t_attrib_default.fgcol = QEMU_COLOR_WHITE;
2224 s->t_attrib_default.bgcol = QEMU_COLOR_BLACK;
2225 /* set current text attributes to default */
2226 s->t_attrib = s->t_attrib_default;
2227 text_console_resize(s);
2232 s->t_attrib.bgcol = QEMU_COLOR_BLUE;
2233 msg = g_strdup_printf("%s console\r\n", chr->label);
2234 vc_chr_write(chr, (uint8_t *)msg, strlen(msg));
2236 s->t_attrib = s->t_attrib_default;
2239 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
2242 static void vc_chr_open(Chardev *chr,
2243 ChardevBackend *backend,
2247 ChardevVC *vc = backend->u.vc.data;
2248 VCChardev *drv = VC_CHARDEV(chr);
2251 unsigned height = 0;
2253 if (vc->has_width) {
2255 } else if (vc->has_cols) {
2256 width = vc->cols * FONT_WIDTH;
2259 if (vc->has_height) {
2260 height = vc->height;
2261 } else if (vc->has_rows) {
2262 height = vc->rows * FONT_HEIGHT;
2265 trace_console_txt_new(width, height);
2266 if (width == 0 || height == 0) {
2267 s = new_console(NULL, TEXT_CONSOLE, 0);
2269 s = new_console(NULL, TEXT_CONSOLE_FIXED_SIZE, 0);
2270 s->surface = qemu_create_displaysurface(width, height);
2274 error_setg(errp, "cannot create text console");
2281 if (display_state) {
2282 text_console_do_init(chr, display_state);
2285 /* console/chardev init sometimes completes elsewhere in a 2nd
2286 * stage, so defer OPENED events until they are fully initialized
2291 void qemu_console_resize(QemuConsole *s, int width, int height)
2293 DisplaySurface *surface;
2295 assert(s->console_type == GRAPHIC_CONSOLE);
2297 if (s->surface && (s->surface->flags & QEMU_ALLOCATED_FLAG) &&
2298 pixman_image_get_width(s->surface->image) == width &&
2299 pixman_image_get_height(s->surface->image) == height) {
2303 surface = qemu_create_displaysurface(width, height);
2304 dpy_gfx_replace_surface(s, surface);
2307 DisplaySurface *qemu_console_surface(QemuConsole *console)
2309 return console->surface;
2312 PixelFormat qemu_default_pixelformat(int bpp)
2314 pixman_format_code_t fmt = qemu_default_pixman_format(bpp, true);
2315 PixelFormat pf = qemu_pixelformat_from_pixman(fmt);
2319 static QemuDisplay *dpys[DISPLAY_TYPE__MAX];
2321 void qemu_display_register(QemuDisplay *ui)
2323 assert(ui->type < DISPLAY_TYPE__MAX);
2324 dpys[ui->type] = ui;
2327 bool qemu_display_find_default(DisplayOptions *opts)
2329 static DisplayType prio[] = {
2336 for (i = 0; i < ARRAY_SIZE(prio); i++) {
2337 if (dpys[prio[i]] == NULL) {
2338 ui_module_load_one(DisplayType_str(prio[i]));
2340 if (dpys[prio[i]] == NULL) {
2343 opts->type = prio[i];
2349 void qemu_display_early_init(DisplayOptions *opts)
2351 assert(opts->type < DISPLAY_TYPE__MAX);
2352 if (opts->type == DISPLAY_TYPE_NONE) {
2355 if (dpys[opts->type] == NULL) {
2356 ui_module_load_one(DisplayType_str(opts->type));
2358 if (dpys[opts->type] == NULL) {
2359 error_report("Display '%s' is not available.",
2360 DisplayType_str(opts->type));
2363 if (dpys[opts->type]->early_init) {
2364 dpys[opts->type]->early_init(opts);
2368 void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
2370 assert(opts->type < DISPLAY_TYPE__MAX);
2371 if (opts->type == DISPLAY_TYPE_NONE) {
2374 assert(dpys[opts->type] != NULL);
2375 dpys[opts->type]->init(ds, opts);
2378 void qemu_display_help(void)
2382 printf("Available display backend types:\n");
2384 for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
2386 ui_module_load_one(DisplayType_str(idx));
2389 printf("%s\n", DisplayType_str(dpys[idx]->type));
2394 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
2399 backend->type = CHARDEV_BACKEND_KIND_VC;
2400 vc = backend->u.vc.data = g_new0(ChardevVC, 1);
2401 qemu_chr_parse_common(opts, qapi_ChardevVC_base(vc));
2403 val = qemu_opt_get_number(opts, "width", 0);
2405 vc->has_width = true;
2409 val = qemu_opt_get_number(opts, "height", 0);
2411 vc->has_height = true;
2415 val = qemu_opt_get_number(opts, "cols", 0);
2417 vc->has_cols = true;
2421 val = qemu_opt_get_number(opts, "rows", 0);
2423 vc->has_rows = true;
2428 static const TypeInfo qemu_console_info = {
2429 .name = TYPE_QEMU_CONSOLE,
2430 .parent = TYPE_OBJECT,
2431 .instance_size = sizeof(QemuConsole),
2432 .class_size = sizeof(QemuConsoleClass),
2435 static void char_vc_class_init(ObjectClass *oc, void *data)
2437 ChardevClass *cc = CHARDEV_CLASS(oc);
2439 cc->parse = qemu_chr_parse_vc;
2440 cc->open = vc_chr_open;
2441 cc->chr_write = vc_chr_write;
2442 cc->chr_set_echo = vc_chr_set_echo;
2445 static const TypeInfo char_vc_type_info = {
2446 .name = TYPE_CHARDEV_VC,
2447 .parent = TYPE_CHARDEV,
2448 .instance_size = sizeof(VCChardev),
2449 .class_init = char_vc_class_init,
2452 void qemu_console_early_init(void)
2454 /* set the default vc driver */
2455 if (!object_class_by_name(TYPE_CHARDEV_VC)) {
2456 type_register(&char_vc_type_info);
2460 static void register_types(void)
2462 type_register_static(&qemu_console_info);
2465 type_init(register_types);