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
24 #include "qemu-common.h"
25 #include "ui/console.h"
26 #include "hw/qdev-core.h"
27 #include "qemu/timer.h"
28 #include "qmp-commands.h"
29 #include "sysemu/char.h"
32 #define DEFAULT_BACKSCROLL 512
33 #define MAX_CONSOLES 12
34 #define CONSOLE_CURSOR_PERIOD 500
36 typedef struct TextAttributes {
46 typedef struct TextCell {
48 TextAttributes t_attrib;
51 #define MAX_ESC_PARAMS 3
59 typedef struct QEMUFIFO {
62 int count, wptr, rptr;
65 static int qemu_fifo_write(QEMUFIFO *f, const uint8_t *buf, int len1)
69 l = f->buf_size - f->count;
74 l = f->buf_size - f->wptr;
77 memcpy(f->buf + f->wptr, buf, l);
79 if (f->wptr >= f->buf_size)
88 static int qemu_fifo_read(QEMUFIFO *f, uint8_t *buf, int len1)
96 l = f->buf_size - f->rptr;
99 memcpy(buf, f->buf + f->rptr, l);
101 if (f->rptr >= f->buf_size)
113 TEXT_CONSOLE_FIXED_SIZE
120 console_type_t console_type;
122 DisplaySurface *surface;
125 /* Graphic console state. */
129 const GraphicHwOps *hw_ops;
132 /* Text console state */
136 int backscroll_height;
138 int x_saved, y_saved;
141 TextAttributes t_attrib_default; /* default text attributes */
142 TextAttributes t_attrib; /* currently active text attributes */
144 int text_x[2], text_y[2], cursor_invalidate;
153 int esc_params[MAX_ESC_PARAMS];
156 CharDriverState *chr;
157 /* fifo for key pressed */
159 uint8_t out_fifo_buf[16];
160 QEMUTimer *kbd_timer;
163 struct DisplayState {
164 QEMUTimer *gui_timer;
165 uint64_t last_update;
166 uint64_t update_interval;
171 QLIST_HEAD(, DisplayChangeListener) listeners;
174 static DisplayState *display_state;
175 static QemuConsole *active_console;
176 static QemuConsole *consoles[MAX_CONSOLES];
177 static int nb_consoles = 0;
178 static bool cursor_visible_phase;
179 static QEMUTimer *cursor_timer;
181 static void text_console_do_init(CharDriverState *chr, DisplayState *ds);
182 static void dpy_refresh(DisplayState *s);
183 static DisplayState *get_alloc_displaystate(void);
184 static void text_console_update_cursor_timer(void);
185 static void text_console_update_cursor(void *opaque);
187 static void gui_update(void *opaque)
189 uint64_t interval = GUI_REFRESH_INTERVAL_IDLE;
190 uint64_t dcl_interval;
191 DisplayState *ds = opaque;
192 DisplayChangeListener *dcl;
195 ds->refreshing = true;
197 ds->refreshing = false;
199 QLIST_FOREACH(dcl, &ds->listeners, next) {
200 dcl_interval = dcl->update_interval ?
201 dcl->update_interval : GUI_REFRESH_INTERVAL_DEFAULT;
202 if (interval > dcl_interval) {
203 interval = dcl_interval;
206 if (ds->update_interval != interval) {
207 ds->update_interval = interval;
208 for (i = 0; i < nb_consoles; i++) {
209 if (consoles[i]->hw_ops->update_interval) {
210 consoles[i]->hw_ops->update_interval(consoles[i]->hw, interval);
213 trace_console_refresh(interval);
215 ds->last_update = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
216 timer_mod(ds->gui_timer, ds->last_update + interval);
219 static void gui_setup_refresh(DisplayState *ds)
221 DisplayChangeListener *dcl;
222 bool need_timer = false;
223 bool have_gfx = false;
224 bool have_text = false;
226 QLIST_FOREACH(dcl, &ds->listeners, next) {
227 if (dcl->ops->dpy_refresh != NULL) {
230 if (dcl->ops->dpy_gfx_update != NULL) {
233 if (dcl->ops->dpy_text_update != NULL) {
238 if (need_timer && ds->gui_timer == NULL) {
239 ds->gui_timer = timer_new_ms(QEMU_CLOCK_REALTIME, gui_update, ds);
240 timer_mod(ds->gui_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME));
242 if (!need_timer && ds->gui_timer != NULL) {
243 timer_del(ds->gui_timer);
244 timer_free(ds->gui_timer);
245 ds->gui_timer = NULL;
248 ds->have_gfx = have_gfx;
249 ds->have_text = have_text;
252 void graphic_hw_update(QemuConsole *con)
255 con = active_console;
257 if (con && con->hw_ops->gfx_update) {
258 con->hw_ops->gfx_update(con->hw);
262 void graphic_hw_invalidate(QemuConsole *con)
265 con = active_console;
267 if (con && con->hw_ops->invalidate) {
268 con->hw_ops->invalidate(con->hw);
272 static void ppm_save(const char *filename, struct DisplaySurface *ds,
275 int width = pixman_image_get_width(ds->image);
276 int height = pixman_image_get_height(ds->image);
281 pixman_image_t *linebuf;
283 trace_ppm_save(filename, ds);
284 fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0666);
286 error_setg(errp, "failed to open file '%s': %s", filename,
290 f = fdopen(fd, "wb");
291 ret = fprintf(f, "P6\n%d %d\n%d\n", width, height, 255);
296 linebuf = qemu_pixman_linebuf_create(PIXMAN_BE_r8g8b8, width);
297 for (y = 0; y < height; y++) {
298 qemu_pixman_linebuf_fill(linebuf, ds->image, width, 0, y);
300 ret = fwrite(pixman_image_get_data(linebuf), 1,
301 pixman_image_get_stride(linebuf), f);
309 qemu_pixman_image_unref(linebuf);
314 error_setg(errp, "failed to write to file '%s': %s", filename,
320 void qmp_screendump(const char *filename, Error **errp)
322 QemuConsole *con = qemu_console_lookup_by_index(0);
323 DisplaySurface *surface;
326 error_setg(errp, "There is no QemuConsole I can screendump from.");
330 graphic_hw_update(con);
331 surface = qemu_console_surface(con);
332 ppm_save(filename, surface, errp);
335 void graphic_hw_text_update(QemuConsole *con, console_ch_t *chardata)
338 con = active_console;
340 if (con && con->hw_ops->text_update) {
341 con->hw_ops->text_update(con->hw, chardata);
345 static void vga_fill_rect(QemuConsole *con,
346 int posx, int posy, int width, int height,
347 pixman_color_t color)
349 DisplaySurface *surface = qemu_console_surface(con);
350 pixman_rectangle16_t rect = {
351 .x = posx, .y = posy, .width = width, .height = height
354 pixman_image_fill_rectangles(PIXMAN_OP_SRC, surface->image,
358 /* copy from (xs, ys) to (xd, yd) a rectangle of size (w, h) */
359 static void vga_bitblt(QemuConsole *con,
360 int xs, int ys, int xd, int yd, int w, int h)
362 DisplaySurface *surface = qemu_console_surface(con);
364 pixman_image_composite(PIXMAN_OP_SRC,
365 surface->image, NULL, surface->image,
366 xs, ys, 0, 0, xd, yd, w, h);
369 /***********************************************************/
370 /* basic char display */
372 #define FONT_HEIGHT 16
377 #ifndef CONFIG_CURSES
390 #define QEMU_RGB(r, g, b) \
391 { .red = r << 8, .green = g << 8, .blue = b << 8, .alpha = 0xffff }
393 static const pixman_color_t color_table_rgb[2][8] = {
395 QEMU_RGB(0x00, 0x00, 0x00), /* black */
396 QEMU_RGB(0xaa, 0x00, 0x00), /* red */
397 QEMU_RGB(0x00, 0xaa, 0x00), /* green */
398 QEMU_RGB(0xaa, 0xaa, 0x00), /* yellow */
399 QEMU_RGB(0x00, 0x00, 0xaa), /* blue */
400 QEMU_RGB(0xaa, 0x00, 0xaa), /* magenta */
401 QEMU_RGB(0x00, 0xaa, 0xaa), /* cyan */
402 QEMU_RGB(0xaa, 0xaa, 0xaa), /* white */
405 QEMU_RGB(0x00, 0x00, 0x00), /* black */
406 QEMU_RGB(0xff, 0x00, 0x00), /* red */
407 QEMU_RGB(0x00, 0xff, 0x00), /* green */
408 QEMU_RGB(0xff, 0xff, 0x00), /* yellow */
409 QEMU_RGB(0x00, 0x00, 0xff), /* blue */
410 QEMU_RGB(0xff, 0x00, 0xff), /* magenta */
411 QEMU_RGB(0x00, 0xff, 0xff), /* cyan */
412 QEMU_RGB(0xff, 0xff, 0xff), /* white */
416 static void vga_putcharxy(QemuConsole *s, int x, int y, int ch,
417 TextAttributes *t_attrib)
419 static pixman_image_t *glyphs[256];
420 DisplaySurface *surface = qemu_console_surface(s);
421 pixman_color_t fgcol, bgcol;
423 if (t_attrib->invers) {
424 bgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
425 fgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
427 fgcol = color_table_rgb[t_attrib->bold][t_attrib->fgcol];
428 bgcol = color_table_rgb[t_attrib->bold][t_attrib->bgcol];
432 glyphs[ch] = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, ch);
434 qemu_pixman_glyph_render(glyphs[ch], surface->image,
435 &fgcol, &bgcol, x, y, FONT_WIDTH, FONT_HEIGHT);
438 static void text_console_resize(QemuConsole *s)
440 TextCell *cells, *c, *c1;
441 int w1, x, y, last_width;
443 last_width = s->width;
444 s->width = surface_width(s->surface) / FONT_WIDTH;
445 s->height = surface_height(s->surface) / FONT_HEIGHT;
451 cells = g_malloc(s->width * s->total_height * sizeof(TextCell));
452 for(y = 0; y < s->total_height; y++) {
453 c = &cells[y * s->width];
455 c1 = &s->cells[y * last_width];
456 for(x = 0; x < w1; x++) {
460 for(x = w1; x < s->width; x++) {
462 c->t_attrib = s->t_attrib_default;
470 static inline void text_update_xy(QemuConsole *s, int x, int y)
472 s->text_x[0] = MIN(s->text_x[0], x);
473 s->text_x[1] = MAX(s->text_x[1], x);
474 s->text_y[0] = MIN(s->text_y[0], y);
475 s->text_y[1] = MAX(s->text_y[1], y);
478 static void invalidate_xy(QemuConsole *s, int x, int y)
480 if (!qemu_console_is_visible(s)) {
483 if (s->update_x0 > x * FONT_WIDTH)
484 s->update_x0 = x * FONT_WIDTH;
485 if (s->update_y0 > y * FONT_HEIGHT)
486 s->update_y0 = y * FONT_HEIGHT;
487 if (s->update_x1 < (x + 1) * FONT_WIDTH)
488 s->update_x1 = (x + 1) * FONT_WIDTH;
489 if (s->update_y1 < (y + 1) * FONT_HEIGHT)
490 s->update_y1 = (y + 1) * FONT_HEIGHT;
493 static void update_xy(QemuConsole *s, int x, int y)
498 if (s->ds->have_text) {
499 text_update_xy(s, x, y);
502 y1 = (s->y_base + y) % s->total_height;
503 y2 = y1 - s->y_displayed;
505 y2 += s->total_height;
507 if (y2 < s->height) {
508 c = &s->cells[y1 * s->width + x];
509 vga_putcharxy(s, x, y2, c->ch,
511 invalidate_xy(s, x, y2);
515 static void console_show_cursor(QemuConsole *s, int show)
521 if (s->ds->have_text) {
522 s->cursor_invalidate = 1;
528 y1 = (s->y_base + s->y) % s->total_height;
529 y = y1 - s->y_displayed;
531 y += s->total_height;
534 c = &s->cells[y1 * s->width + x];
535 if (show && cursor_visible_phase) {
536 TextAttributes t_attrib = s->t_attrib_default;
537 t_attrib.invers = !(t_attrib.invers); /* invert fg and bg */
538 vga_putcharxy(s, x, y, c->ch, &t_attrib);
540 vga_putcharxy(s, x, y, c->ch, &(c->t_attrib));
542 invalidate_xy(s, x, y);
546 static void console_refresh(QemuConsole *s)
548 DisplaySurface *surface = qemu_console_surface(s);
552 if (s->ds->have_text) {
555 s->text_x[1] = s->width - 1;
556 s->text_y[1] = s->height - 1;
557 s->cursor_invalidate = 1;
560 vga_fill_rect(s, 0, 0, surface_width(surface), surface_height(surface),
561 color_table_rgb[0][COLOR_BLACK]);
563 for (y = 0; y < s->height; y++) {
564 c = s->cells + y1 * s->width;
565 for (x = 0; x < s->width; x++) {
566 vga_putcharxy(s, x, y, c->ch,
570 if (++y1 == s->total_height) {
574 console_show_cursor(s, 1);
575 dpy_gfx_update(s, 0, 0,
576 surface_width(surface), surface_height(surface));
579 static void console_scroll(QemuConsole *s, int ydelta)
584 for(i = 0; i < ydelta; i++) {
585 if (s->y_displayed == s->y_base)
587 if (++s->y_displayed == s->total_height)
592 i = s->backscroll_height;
593 if (i > s->total_height - s->height)
594 i = s->total_height - s->height;
597 y1 += s->total_height;
598 for(i = 0; i < ydelta; i++) {
599 if (s->y_displayed == y1)
601 if (--s->y_displayed < 0)
602 s->y_displayed = s->total_height - 1;
608 static void console_put_lf(QemuConsole *s)
614 if (s->y >= s->height) {
615 s->y = s->height - 1;
617 if (s->y_displayed == s->y_base) {
618 if (++s->y_displayed == s->total_height)
621 if (++s->y_base == s->total_height)
623 if (s->backscroll_height < s->total_height)
624 s->backscroll_height++;
625 y1 = (s->y_base + s->height - 1) % s->total_height;
626 c = &s->cells[y1 * s->width];
627 for(x = 0; x < s->width; x++) {
629 c->t_attrib = s->t_attrib_default;
632 if (s->y_displayed == s->y_base) {
633 if (s->ds->have_text) {
636 s->text_x[1] = s->width - 1;
637 s->text_y[1] = s->height - 1;
640 vga_bitblt(s, 0, FONT_HEIGHT, 0, 0,
641 s->width * FONT_WIDTH,
642 (s->height - 1) * FONT_HEIGHT);
643 vga_fill_rect(s, 0, (s->height - 1) * FONT_HEIGHT,
644 s->width * FONT_WIDTH, FONT_HEIGHT,
645 color_table_rgb[0][s->t_attrib_default.bgcol]);
648 s->update_x1 = s->width * FONT_WIDTH;
649 s->update_y1 = s->height * FONT_HEIGHT;
654 /* Set console attributes depending on the current escape codes.
655 * NOTE: I know this code is not very efficient (checking every color for it
656 * self) but it is more readable and better maintainable.
658 static void console_handle_escape(QemuConsole *s)
662 for (i=0; i<s->nb_esc_params; i++) {
663 switch (s->esc_params[i]) {
664 case 0: /* reset all console attributes to default */
665 s->t_attrib = s->t_attrib_default;
668 s->t_attrib.bold = 1;
671 s->t_attrib.uline = 1;
674 s->t_attrib.blink = 1;
677 s->t_attrib.invers = 1;
680 s->t_attrib.unvisible = 1;
683 s->t_attrib.bold = 0;
686 s->t_attrib.uline = 0;
689 s->t_attrib.blink = 0;
692 s->t_attrib.invers = 0;
695 s->t_attrib.unvisible = 0;
697 /* set foreground color */
699 s->t_attrib.fgcol=COLOR_BLACK;
702 s->t_attrib.fgcol=COLOR_RED;
705 s->t_attrib.fgcol=COLOR_GREEN;
708 s->t_attrib.fgcol=COLOR_YELLOW;
711 s->t_attrib.fgcol=COLOR_BLUE;
714 s->t_attrib.fgcol=COLOR_MAGENTA;
717 s->t_attrib.fgcol=COLOR_CYAN;
720 s->t_attrib.fgcol=COLOR_WHITE;
722 /* set background color */
724 s->t_attrib.bgcol=COLOR_BLACK;
727 s->t_attrib.bgcol=COLOR_RED;
730 s->t_attrib.bgcol=COLOR_GREEN;
733 s->t_attrib.bgcol=COLOR_YELLOW;
736 s->t_attrib.bgcol=COLOR_BLUE;
739 s->t_attrib.bgcol=COLOR_MAGENTA;
742 s->t_attrib.bgcol=COLOR_CYAN;
745 s->t_attrib.bgcol=COLOR_WHITE;
751 static void console_clear_xy(QemuConsole *s, int x, int y)
753 int y1 = (s->y_base + y) % s->total_height;
754 TextCell *c = &s->cells[y1 * s->width + x];
756 c->t_attrib = s->t_attrib_default;
760 /* set cursor, checking bounds */
761 static void set_cursor(QemuConsole *s, int x, int y)
769 if (y >= s->height) {
780 static void console_putchar(QemuConsole *s, int ch)
789 case '\r': /* carriage return */
792 case '\n': /* newline */
795 case '\b': /* backspace */
799 case '\t': /* tabspace */
800 if (s->x + (8 - (s->x % 8)) > s->width) {
804 s->x = s->x + (8 - (s->x % 8));
807 case '\a': /* alert aka. bell */
808 /* TODO: has to be implemented */
811 /* SI (shift in), character set 0 (ignored) */
814 /* SO (shift out), character set 1 (ignored) */
816 case 27: /* esc (introducing an escape sequence) */
817 s->state = TTY_STATE_ESC;
820 if (s->x >= s->width) {
825 y1 = (s->y_base + s->y) % s->total_height;
826 c = &s->cells[y1 * s->width + s->x];
828 c->t_attrib = s->t_attrib;
829 update_xy(s, s->x, s->y);
834 case TTY_STATE_ESC: /* check if it is a terminal escape sequence */
836 for(i=0;i<MAX_ESC_PARAMS;i++)
837 s->esc_params[i] = 0;
838 s->nb_esc_params = 0;
839 s->state = TTY_STATE_CSI;
841 s->state = TTY_STATE_NORM;
844 case TTY_STATE_CSI: /* handle escape sequence parameters */
845 if (ch >= '0' && ch <= '9') {
846 if (s->nb_esc_params < MAX_ESC_PARAMS) {
847 int *param = &s->esc_params[s->nb_esc_params];
848 int digit = (ch - '0');
850 *param = (*param <= (INT_MAX - digit) / 10) ?
851 *param * 10 + digit : INT_MAX;
854 if (s->nb_esc_params < MAX_ESC_PARAMS)
858 trace_console_putchar_csi(s->esc_params[0], s->esc_params[1],
859 ch, s->nb_esc_params);
860 s->state = TTY_STATE_NORM;
864 if (s->esc_params[0] == 0) {
865 s->esc_params[0] = 1;
867 set_cursor(s, s->x, s->y - s->esc_params[0]);
870 /* move cursor down */
871 if (s->esc_params[0] == 0) {
872 s->esc_params[0] = 1;
874 set_cursor(s, s->x, s->y + s->esc_params[0]);
877 /* move cursor right */
878 if (s->esc_params[0] == 0) {
879 s->esc_params[0] = 1;
881 set_cursor(s, s->x + s->esc_params[0], s->y);
884 /* move cursor left */
885 if (s->esc_params[0] == 0) {
886 s->esc_params[0] = 1;
888 set_cursor(s, s->x - s->esc_params[0], s->y);
891 /* move cursor to column */
892 set_cursor(s, s->esc_params[0] - 1, s->y);
896 /* move cursor to row, column */
897 set_cursor(s, s->esc_params[1] - 1, s->esc_params[0] - 1);
900 switch (s->esc_params[0]) {
902 /* clear to end of screen */
903 for (y = s->y; y < s->height; y++) {
904 for (x = 0; x < s->width; x++) {
905 if (y == s->y && x < s->x) {
908 console_clear_xy(s, x, y);
913 /* clear from beginning of screen */
914 for (y = 0; y <= s->y; y++) {
915 for (x = 0; x < s->width; x++) {
916 if (y == s->y && x > s->x) {
919 console_clear_xy(s, x, y);
924 /* clear entire screen */
925 for (y = 0; y <= s->height; y++) {
926 for (x = 0; x < s->width; x++) {
927 console_clear_xy(s, x, y);
934 switch (s->esc_params[0]) {
937 for(x = s->x; x < s->width; x++) {
938 console_clear_xy(s, x, s->y);
942 /* clear from beginning of line */
943 for (x = 0; x <= s->x; x++) {
944 console_clear_xy(s, x, s->y);
948 /* clear entire line */
949 for(x = 0; x < s->width; x++) {
950 console_clear_xy(s, x, s->y);
956 console_handle_escape(s);
959 /* report cursor position */
960 /* TODO: send ESC[row;colR */
963 /* save cursor position */
968 /* restore cursor position */
973 trace_console_putchar_unhandled(ch);
981 void console_select(unsigned int index)
983 DisplayChangeListener *dcl;
986 if (index >= MAX_CONSOLES)
989 trace_console_select(index);
990 s = qemu_console_lookup_by_index(index);
992 DisplayState *ds = s->ds;
996 QLIST_FOREACH(dcl, &ds->listeners, next) {
997 if (dcl->con != NULL) {
1000 if (dcl->ops->dpy_gfx_switch) {
1001 dcl->ops->dpy_gfx_switch(dcl, s->surface);
1004 dpy_gfx_update(s, 0, 0, surface_width(s->surface),
1005 surface_height(s->surface));
1007 if (ds->have_text) {
1008 dpy_text_resize(s, s->width, s->height);
1010 text_console_update_cursor(NULL);
1014 static int console_puts(CharDriverState *chr, const uint8_t *buf, int len)
1016 QemuConsole *s = chr->opaque;
1019 s->update_x0 = s->width * FONT_WIDTH;
1020 s->update_y0 = s->height * FONT_HEIGHT;
1023 console_show_cursor(s, 0);
1024 for(i = 0; i < len; i++) {
1025 console_putchar(s, buf[i]);
1027 console_show_cursor(s, 1);
1028 if (s->ds->have_gfx && s->update_x0 < s->update_x1) {
1029 dpy_gfx_update(s, s->update_x0, s->update_y0,
1030 s->update_x1 - s->update_x0,
1031 s->update_y1 - s->update_y0);
1036 static void kbd_send_chars(void *opaque)
1038 QemuConsole *s = opaque;
1042 len = qemu_chr_be_can_write(s->chr);
1043 if (len > s->out_fifo.count)
1044 len = s->out_fifo.count;
1046 if (len > sizeof(buf))
1048 qemu_fifo_read(&s->out_fifo, buf, len);
1049 qemu_chr_be_write(s->chr, buf, len);
1051 /* characters are pending: we send them a bit later (XXX:
1052 horrible, should change char device API) */
1053 if (s->out_fifo.count > 0) {
1054 timer_mod(s->kbd_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 1);
1058 /* called when an ascii key is pressed */
1059 void kbd_put_keysym(int keysym)
1062 uint8_t buf[16], *q;
1066 if (!s || (s->console_type == GRAPHIC_CONSOLE))
1070 case QEMU_KEY_CTRL_UP:
1071 console_scroll(s, -1);
1073 case QEMU_KEY_CTRL_DOWN:
1074 console_scroll(s, 1);
1076 case QEMU_KEY_CTRL_PAGEUP:
1077 console_scroll(s, -10);
1079 case QEMU_KEY_CTRL_PAGEDOWN:
1080 console_scroll(s, 10);
1083 /* convert the QEMU keysym to VT100 key string */
1085 if (keysym >= 0xe100 && keysym <= 0xe11f) {
1088 c = keysym - 0xe100;
1090 *q++ = '0' + (c / 10);
1091 *q++ = '0' + (c % 10);
1093 } else if (keysym >= 0xe120 && keysym <= 0xe17f) {
1096 *q++ = keysym & 0xff;
1097 } else if (s->echo && (keysym == '\r' || keysym == '\n')) {
1098 console_puts(s->chr, (const uint8_t *) "\r", 1);
1104 console_puts(s->chr, buf, q - buf);
1106 if (s->chr->chr_read) {
1107 qemu_fifo_write(&s->out_fifo, buf, q - buf);
1114 static void text_console_invalidate(void *opaque)
1116 QemuConsole *s = (QemuConsole *) opaque;
1118 if (s->ds->have_text && s->console_type == TEXT_CONSOLE) {
1119 text_console_resize(s);
1124 static void text_console_update(void *opaque, console_ch_t *chardata)
1126 QemuConsole *s = (QemuConsole *) opaque;
1129 if (s->text_x[0] <= s->text_x[1]) {
1130 src = (s->y_base + s->text_y[0]) * s->width;
1131 chardata += s->text_y[0] * s->width;
1132 for (i = s->text_y[0]; i <= s->text_y[1]; i ++)
1133 for (j = 0; j < s->width; j ++, src ++)
1134 console_write_ch(chardata ++, s->cells[src].ch |
1135 (s->cells[src].t_attrib.fgcol << 12) |
1136 (s->cells[src].t_attrib.bgcol << 8) |
1137 (s->cells[src].t_attrib.bold << 21));
1138 dpy_text_update(s, s->text_x[0], s->text_y[0],
1139 s->text_x[1] - s->text_x[0], i - s->text_y[0]);
1140 s->text_x[0] = s->width;
1141 s->text_y[0] = s->height;
1145 if (s->cursor_invalidate) {
1146 dpy_text_cursor(s, s->x, s->y);
1147 s->cursor_invalidate = 0;
1151 static QemuConsole *new_console(DisplayState *ds, console_type_t console_type,
1158 if (nb_consoles >= MAX_CONSOLES)
1161 obj = object_new(TYPE_QEMU_CONSOLE);
1162 s = QEMU_CONSOLE(obj);
1164 object_property_add_link(obj, "device", TYPE_DEVICE,
1165 (Object **)&s->device,
1166 object_property_allow_set_link,
1167 OBJ_PROP_LINK_UNREF_ON_RELEASE,
1169 object_property_add_uint32_ptr(obj, "head",
1170 &s->head, &error_abort);
1172 if (!active_console || ((active_console->console_type != GRAPHIC_CONSOLE) &&
1173 (console_type == GRAPHIC_CONSOLE))) {
1177 s->console_type = console_type;
1178 if (console_type != GRAPHIC_CONSOLE) {
1179 s->index = nb_consoles;
1180 consoles[nb_consoles++] = s;
1182 /* HACK: Put graphical consoles before text consoles. */
1183 for (i = nb_consoles; i > 0; i--) {
1184 if (consoles[i - 1]->console_type == GRAPHIC_CONSOLE)
1186 consoles[i] = consoles[i - 1];
1187 consoles[i]->index = i;
1196 static void qemu_alloc_display(DisplaySurface *surface, int width, int height,
1197 int linesize, PixelFormat pf, int newflags)
1201 qemu_pixman_image_unref(surface->image);
1202 surface->image = NULL;
1204 surface->format = qemu_pixman_get_format(&pf);
1205 assert(surface->format != 0);
1206 surface->image = pixman_image_create_bits(surface->format,
1209 assert(surface->image != NULL);
1211 surface->flags = newflags | QEMU_ALLOCATED_FLAG;
1212 #ifdef HOST_WORDS_BIGENDIAN
1213 surface->flags |= QEMU_BIG_ENDIAN_FLAG;
1217 DisplaySurface *qemu_create_displaysurface(int width, int height)
1219 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1220 int linesize = width * 4;
1222 trace_displaysurface_create(surface, width, height);
1223 qemu_alloc_display(surface, width, height, linesize,
1224 qemu_default_pixelformat(32), 0);
1228 DisplaySurface *qemu_create_displaysurface_from(int width, int height, int bpp,
1229 int linesize, uint8_t *data,
1232 DisplaySurface *surface = g_new0(DisplaySurface, 1);
1234 trace_displaysurface_create_from(surface, width, height, bpp, byteswap);
1236 surface->pf = qemu_different_endianness_pixelformat(bpp);
1238 surface->pf = qemu_default_pixelformat(bpp);
1241 surface->format = qemu_pixman_get_format(&surface->pf);
1242 assert(surface->format != 0);
1243 surface->image = pixman_image_create_bits(surface->format,
1245 (void *)data, linesize);
1246 assert(surface->image != NULL);
1248 #ifdef HOST_WORDS_BIGENDIAN
1249 surface->flags = QEMU_BIG_ENDIAN_FLAG;
1255 static DisplaySurface *qemu_create_message_surface(int w, int h,
1258 DisplaySurface *surface = qemu_create_displaysurface(w, h);
1259 pixman_color_t bg = color_table_rgb[0][COLOR_BLACK];
1260 pixman_color_t fg = color_table_rgb[0][COLOR_WHITE];
1261 pixman_image_t *glyph;
1265 x = (w / FONT_WIDTH - len) / 2;
1266 y = (h / FONT_HEIGHT - 1) / 2;
1267 for (i = 0; i < len; i++) {
1268 glyph = qemu_pixman_glyph_from_vgafont(FONT_HEIGHT, vgafont16, msg[i]);
1269 qemu_pixman_glyph_render(glyph, surface->image, &fg, &bg,
1270 x+i, y, FONT_WIDTH, FONT_HEIGHT);
1271 qemu_pixman_image_unref(glyph);
1276 void qemu_free_displaysurface(DisplaySurface *surface)
1278 if (surface == NULL) {
1281 trace_displaysurface_free(surface);
1282 qemu_pixman_image_unref(surface->image);
1286 void register_displaychangelistener(DisplayChangeListener *dcl)
1288 static const char nodev[] =
1289 "This VM has no graphic display device.";
1290 static DisplaySurface *dummy;
1293 trace_displaychangelistener_register(dcl, dcl->ops->dpy_name);
1294 dcl->ds = get_alloc_displaystate();
1295 QLIST_INSERT_HEAD(&dcl->ds->listeners, dcl, next);
1296 gui_setup_refresh(dcl->ds);
1301 con = active_console;
1303 if (dcl->ops->dpy_gfx_switch) {
1305 dcl->ops->dpy_gfx_switch(dcl, con->surface);
1308 dummy = qemu_create_message_surface(640, 480, nodev);
1310 dcl->ops->dpy_gfx_switch(dcl, dummy);
1313 text_console_update_cursor(NULL);
1316 void update_displaychangelistener(DisplayChangeListener *dcl,
1319 DisplayState *ds = dcl->ds;
1321 dcl->update_interval = interval;
1322 if (!ds->refreshing && ds->update_interval > interval) {
1323 timer_mod(ds->gui_timer, ds->last_update + interval);
1327 void unregister_displaychangelistener(DisplayChangeListener *dcl)
1329 DisplayState *ds = dcl->ds;
1330 trace_displaychangelistener_unregister(dcl, dcl->ops->dpy_name);
1334 QLIST_REMOVE(dcl, next);
1335 gui_setup_refresh(ds);
1338 int dpy_set_ui_info(QemuConsole *con, QemuUIInfo *info)
1340 assert(con != NULL);
1341 con->ui_info = *info;
1342 if (con->hw_ops->ui_info) {
1343 return con->hw_ops->ui_info(con->hw, con->head, info);
1348 void dpy_gfx_update(QemuConsole *con, int x, int y, int w, int h)
1350 DisplayState *s = con->ds;
1351 DisplayChangeListener *dcl;
1352 int width = surface_width(con->surface);
1353 int height = surface_height(con->surface);
1359 w = MIN(w, width - x);
1360 h = MIN(h, height - y);
1362 if (!qemu_console_is_visible(con)) {
1365 QLIST_FOREACH(dcl, &s->listeners, next) {
1366 if (con != (dcl->con ? dcl->con : active_console)) {
1369 if (dcl->ops->dpy_gfx_update) {
1370 dcl->ops->dpy_gfx_update(dcl, x, y, w, h);
1375 void dpy_gfx_replace_surface(QemuConsole *con,
1376 DisplaySurface *surface)
1378 DisplayState *s = con->ds;
1379 DisplaySurface *old_surface = con->surface;
1380 DisplayChangeListener *dcl;
1382 con->surface = surface;
1383 QLIST_FOREACH(dcl, &s->listeners, next) {
1384 if (con != (dcl->con ? dcl->con : active_console)) {
1387 if (dcl->ops->dpy_gfx_switch) {
1388 dcl->ops->dpy_gfx_switch(dcl, surface);
1391 qemu_free_displaysurface(old_surface);
1394 static void dpy_refresh(DisplayState *s)
1396 DisplayChangeListener *dcl;
1398 QLIST_FOREACH(dcl, &s->listeners, next) {
1399 if (dcl->ops->dpy_refresh) {
1400 dcl->ops->dpy_refresh(dcl);
1405 void dpy_gfx_copy(QemuConsole *con, int src_x, int src_y,
1406 int dst_x, int dst_y, int w, int h)
1408 DisplayState *s = con->ds;
1409 DisplayChangeListener *dcl;
1411 if (!qemu_console_is_visible(con)) {
1414 QLIST_FOREACH(dcl, &s->listeners, next) {
1415 if (con != (dcl->con ? dcl->con : active_console)) {
1418 if (dcl->ops->dpy_gfx_copy) {
1419 dcl->ops->dpy_gfx_copy(dcl, src_x, src_y, dst_x, dst_y, w, h);
1421 dcl->ops->dpy_gfx_update(dcl, dst_x, dst_y, w, h);
1426 void dpy_text_cursor(QemuConsole *con, int x, int y)
1428 DisplayState *s = con->ds;
1429 DisplayChangeListener *dcl;
1431 if (!qemu_console_is_visible(con)) {
1434 QLIST_FOREACH(dcl, &s->listeners, next) {
1435 if (con != (dcl->con ? dcl->con : active_console)) {
1438 if (dcl->ops->dpy_text_cursor) {
1439 dcl->ops->dpy_text_cursor(dcl, x, y);
1444 void dpy_text_update(QemuConsole *con, int x, int y, int w, int h)
1446 DisplayState *s = con->ds;
1447 DisplayChangeListener *dcl;
1449 if (!qemu_console_is_visible(con)) {
1452 QLIST_FOREACH(dcl, &s->listeners, next) {
1453 if (con != (dcl->con ? dcl->con : active_console)) {
1456 if (dcl->ops->dpy_text_update) {
1457 dcl->ops->dpy_text_update(dcl, x, y, w, h);
1462 void dpy_text_resize(QemuConsole *con, int w, int h)
1464 DisplayState *s = con->ds;
1465 struct DisplayChangeListener *dcl;
1467 if (!qemu_console_is_visible(con)) {
1470 QLIST_FOREACH(dcl, &s->listeners, next) {
1471 if (con != (dcl->con ? dcl->con : active_console)) {
1474 if (dcl->ops->dpy_text_resize) {
1475 dcl->ops->dpy_text_resize(dcl, w, h);
1480 void dpy_mouse_set(QemuConsole *con, int x, int y, int on)
1482 DisplayState *s = con->ds;
1483 DisplayChangeListener *dcl;
1485 if (!qemu_console_is_visible(con)) {
1488 QLIST_FOREACH(dcl, &s->listeners, next) {
1489 if (con != (dcl->con ? dcl->con : active_console)) {
1492 if (dcl->ops->dpy_mouse_set) {
1493 dcl->ops->dpy_mouse_set(dcl, x, y, on);
1498 void dpy_cursor_define(QemuConsole *con, QEMUCursor *cursor)
1500 DisplayState *s = con->ds;
1501 DisplayChangeListener *dcl;
1503 if (!qemu_console_is_visible(con)) {
1506 QLIST_FOREACH(dcl, &s->listeners, next) {
1507 if (con != (dcl->con ? dcl->con : active_console)) {
1510 if (dcl->ops->dpy_cursor_define) {
1511 dcl->ops->dpy_cursor_define(dcl, cursor);
1516 bool dpy_cursor_define_supported(QemuConsole *con)
1518 DisplayState *s = con->ds;
1519 DisplayChangeListener *dcl;
1521 QLIST_FOREACH(dcl, &s->listeners, next) {
1522 if (dcl->ops->dpy_cursor_define) {
1529 /***********************************************************/
1530 /* register display */
1532 /* console.c internal use only */
1533 static DisplayState *get_alloc_displaystate(void)
1535 if (!display_state) {
1536 display_state = g_new0(DisplayState, 1);
1537 cursor_timer = timer_new_ms(QEMU_CLOCK_REALTIME,
1538 text_console_update_cursor, NULL);
1540 return display_state;
1544 * Called by main(), after creating QemuConsoles
1545 * and before initializing ui (sdl/vnc/...).
1547 DisplayState *init_displaystate(void)
1552 if (!display_state) {
1553 display_state = g_new0(DisplayState, 1);
1556 for (i = 0; i < nb_consoles; i++) {
1557 if (consoles[i]->console_type != GRAPHIC_CONSOLE &&
1558 consoles[i]->ds == NULL) {
1559 text_console_do_init(consoles[i]->chr, display_state);
1562 /* Hook up into the qom tree here (not in new_console()), once
1563 * all QemuConsoles are created and the order / numbering
1564 * doesn't change any more */
1565 name = g_strdup_printf("console[%d]", i);
1566 object_property_add_child(container_get(object_get_root(), "/backend"),
1567 name, OBJECT(consoles[i]), &error_abort);
1571 return display_state;
1574 QemuConsole *graphic_console_init(DeviceState *dev, uint32_t head,
1575 const GraphicHwOps *hw_ops,
1578 static const char noinit[] =
1579 "Guest has not initialized the display (yet).";
1585 ds = get_alloc_displaystate();
1586 trace_console_gfx_new();
1587 s = new_console(ds, GRAPHIC_CONSOLE, head);
1591 object_property_set_link(OBJECT(s), OBJECT(dev), "device",
1595 s->surface = qemu_create_message_surface(width, height, noinit);
1599 QemuConsole *qemu_console_lookup_by_index(unsigned int index)
1601 if (index >= MAX_CONSOLES) {
1604 return consoles[index];
1607 QemuConsole *qemu_console_lookup_by_device(DeviceState *dev, uint32_t head)
1613 for (i = 0; i < nb_consoles; i++) {
1617 obj = object_property_get_link(OBJECT(consoles[i]),
1618 "device", &error_abort);
1619 if (DEVICE(obj) != dev) {
1622 h = object_property_get_int(OBJECT(consoles[i]),
1623 "head", &error_abort);
1632 bool qemu_console_is_visible(QemuConsole *con)
1634 return (con == active_console) || (con->dcls > 0);
1637 bool qemu_console_is_graphic(QemuConsole *con)
1640 con = active_console;
1642 return con && (con->console_type == GRAPHIC_CONSOLE);
1645 bool qemu_console_is_fixedsize(QemuConsole *con)
1648 con = active_console;
1650 return con && (con->console_type != TEXT_CONSOLE);
1653 int qemu_console_get_index(QemuConsole *con)
1656 con = active_console;
1658 return con ? con->index : -1;
1661 uint32_t qemu_console_get_head(QemuConsole *con)
1664 con = active_console;
1666 return con ? con->head : -1;
1669 QemuUIInfo *qemu_console_get_ui_info(QemuConsole *con)
1671 assert(con != NULL);
1672 return &con->ui_info;
1675 int qemu_console_get_width(QemuConsole *con, int fallback)
1678 con = active_console;
1680 return con ? surface_width(con->surface) : fallback;
1683 int qemu_console_get_height(QemuConsole *con, int fallback)
1686 con = active_console;
1688 return con ? surface_height(con->surface) : fallback;
1691 static void text_console_set_echo(CharDriverState *chr, bool echo)
1693 QemuConsole *s = chr->opaque;
1698 static void text_console_update_cursor_timer(void)
1700 timer_mod(cursor_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME)
1701 + CONSOLE_CURSOR_PERIOD / 2);
1704 static void text_console_update_cursor(void *opaque)
1709 cursor_visible_phase = !cursor_visible_phase;
1711 for (i = 0; i < nb_consoles; i++) {
1713 if (qemu_console_is_graphic(s) ||
1714 !qemu_console_is_visible(s)) {
1718 graphic_hw_invalidate(s);
1722 text_console_update_cursor_timer();
1726 static const GraphicHwOps text_console_ops = {
1727 .invalidate = text_console_invalidate,
1728 .text_update = text_console_update,
1731 static void text_console_do_init(CharDriverState *chr, DisplayState *ds)
1734 int g_width = 80 * FONT_WIDTH;
1735 int g_height = 24 * FONT_HEIGHT;
1739 chr->chr_write = console_puts;
1741 s->out_fifo.buf = s->out_fifo_buf;
1742 s->out_fifo.buf_size = sizeof(s->out_fifo_buf);
1743 s->kbd_timer = timer_new_ms(QEMU_CLOCK_REALTIME, kbd_send_chars, s);
1748 s->total_height = DEFAULT_BACKSCROLL;
1752 if (active_console && active_console->surface) {
1753 g_width = surface_width(active_console->surface);
1754 g_height = surface_height(active_console->surface);
1756 s->surface = qemu_create_displaysurface(g_width, g_height);
1759 s->hw_ops = &text_console_ops;
1762 /* Set text attribute defaults */
1763 s->t_attrib_default.bold = 0;
1764 s->t_attrib_default.uline = 0;
1765 s->t_attrib_default.blink = 0;
1766 s->t_attrib_default.invers = 0;
1767 s->t_attrib_default.unvisible = 0;
1768 s->t_attrib_default.fgcol = COLOR_WHITE;
1769 s->t_attrib_default.bgcol = COLOR_BLACK;
1770 /* set current text attributes to default */
1771 s->t_attrib = s->t_attrib_default;
1772 text_console_resize(s);
1778 s->t_attrib.bgcol = COLOR_BLUE;
1779 len = snprintf(msg, sizeof(msg), "%s console\r\n", chr->label);
1780 console_puts(chr, (uint8_t*)msg, len);
1781 s->t_attrib = s->t_attrib_default;
1784 qemu_chr_be_generic_open(chr);
1789 static CharDriverState *text_console_init(ChardevVC *vc)
1791 CharDriverState *chr;
1794 unsigned height = 0;
1796 chr = g_malloc0(sizeof(CharDriverState));
1798 if (vc->has_width) {
1800 } else if (vc->has_cols) {
1801 width = vc->cols * FONT_WIDTH;
1804 if (vc->has_height) {
1805 height = vc->height;
1806 } else if (vc->has_rows) {
1807 height = vc->rows * FONT_HEIGHT;
1810 trace_console_txt_new(width, height);
1811 if (width == 0 || height == 0) {
1812 s = new_console(NULL, TEXT_CONSOLE, 0);
1814 s = new_console(NULL, TEXT_CONSOLE_FIXED_SIZE, 0);
1815 s->surface = qemu_create_displaysurface(width, height);
1825 chr->chr_set_echo = text_console_set_echo;
1826 /* console/chardev init sometimes completes elsewhere in a 2nd
1827 * stage, so defer OPENED events until they are fully initialized
1829 chr->explicit_be_open = true;
1831 if (display_state) {
1832 text_console_do_init(chr, display_state);
1837 static VcHandler *vc_handler = text_console_init;
1839 CharDriverState *vc_init(ChardevVC *vc)
1841 return vc_handler(vc);
1844 void register_vc_handler(VcHandler *handler)
1846 vc_handler = handler;
1849 void qemu_console_resize(QemuConsole *s, int width, int height)
1851 DisplaySurface *surface;
1853 assert(s->console_type == GRAPHIC_CONSOLE);
1854 surface = qemu_create_displaysurface(width, height);
1855 dpy_gfx_replace_surface(s, surface);
1858 void qemu_console_copy(QemuConsole *con, int src_x, int src_y,
1859 int dst_x, int dst_y, int w, int h)
1861 assert(con->console_type == GRAPHIC_CONSOLE);
1862 dpy_gfx_copy(con, src_x, src_y, dst_x, dst_y, w, h);
1865 DisplaySurface *qemu_console_surface(QemuConsole *console)
1867 return console->surface;
1870 DisplayState *qemu_console_displaystate(QemuConsole *console)
1875 PixelFormat qemu_different_endianness_pixelformat(int bpp)
1879 memset(&pf, 0x00, sizeof(PixelFormat));
1881 pf.bits_per_pixel = bpp;
1882 pf.bytes_per_pixel = DIV_ROUND_UP(bpp, 8);
1883 pf.depth = bpp == 32 ? 24 : bpp;
1887 pf.rmask = 0x000000FF;
1888 pf.gmask = 0x0000FF00;
1889 pf.bmask = 0x00FF0000;
1901 pf.rmask = 0x0000FF00;
1902 pf.gmask = 0x00FF0000;
1903 pf.bmask = 0xFF000000;
1904 pf.amask = 0x00000000;
1924 PixelFormat qemu_default_pixelformat(int bpp)
1928 memset(&pf, 0x00, sizeof(PixelFormat));
1930 pf.bits_per_pixel = bpp;
1931 pf.bytes_per_pixel = DIV_ROUND_UP(bpp, 8);
1932 pf.depth = bpp == 32 ? 24 : bpp;
1936 pf.bits_per_pixel = 16;
1937 pf.rmask = 0x00007c00;
1938 pf.gmask = 0x000003E0;
1939 pf.bmask = 0x0000001F;
1951 pf.rmask = 0x0000F800;
1952 pf.gmask = 0x000007E0;
1953 pf.bmask = 0x0000001F;
1965 pf.rmask = 0x00FF0000;
1966 pf.gmask = 0x0000FF00;
1967 pf.bmask = 0x000000FF;
1979 pf.rmask = 0x00FF0000;
1980 pf.gmask = 0x0000FF00;
1981 pf.bmask = 0x000000FF;
1998 static void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend,
2003 backend->vc = g_new0(ChardevVC, 1);
2005 val = qemu_opt_get_number(opts, "width", 0);
2007 backend->vc->has_width = true;
2008 backend->vc->width = val;
2011 val = qemu_opt_get_number(opts, "height", 0);
2013 backend->vc->has_height = true;
2014 backend->vc->height = val;
2017 val = qemu_opt_get_number(opts, "cols", 0);
2019 backend->vc->has_cols = true;
2020 backend->vc->cols = val;
2023 val = qemu_opt_get_number(opts, "rows", 0);
2025 backend->vc->has_rows = true;
2026 backend->vc->rows = val;
2030 static const TypeInfo qemu_console_info = {
2031 .name = TYPE_QEMU_CONSOLE,
2032 .parent = TYPE_OBJECT,
2033 .instance_size = sizeof(QemuConsole),
2034 .class_size = sizeof(QemuConsoleClass),
2038 static void register_types(void)
2040 type_register_static(&qemu_console_info);
2041 register_char_driver_qapi("vc", CHARDEV_BACKEND_KIND_VC,
2045 type_init(register_types);