2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2009, Robert Deloatch <rtdeloatch@gmail.com>
11 * Copyright (c) 2009, Steven Jaconette <stevenjaconette2007@u.northwestern.edu>
12 * Copyright (c) 2009, The V3VEE Project <http://www.v3vee.org>
13 * All rights reserved.
15 * Author: Erik van der Kouwe (vdkouwe@cs.vu.nl)
17 * This is free software. You are permitted to use,
18 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
21 /* Interface between virtual video card and console */
23 #include <palacios/vmm.h>
24 #include <palacios/vmm_console.h>
25 #include <palacios/vmm_dev_mgr.h>
26 #include <palacios/vmm_sprintf.h>
27 #include <palacios/vmm_host_events.h>
28 #include <palacios/vmm_lock.h>
29 #include <palacios/vmm_string.h>
30 #include <palacios/vm_guest.h>
32 #include <devices/console.h>
34 #ifndef DEBUG_CURSES_CONS
36 #define PrintDebug(fmt, args...)
39 #define BYTES_PER_COL 2
45 struct vm_device * frontend_dev;
48 static int screen_update(uint_t x, uint_t y, uint_t length, void *private_data);
50 static int screen_update_all(void * private_data) {
51 struct vm_device *dev = (struct vm_device *) private_data;
52 struct cons_state *state = (struct cons_state *)dev->private_data;
55 screen_size = state->cols * state->rows * BYTES_PER_COL;
56 return screen_update(0, 0, screen_size, private_data);
59 static int cursor_update(uint_t x, uint_t y, void *private_data)
61 struct vm_device *dev = (struct vm_device *) private_data;
62 struct cons_state *state = (struct cons_state *) dev->private_data;
65 PrintDebug("cursor_update(%d, %d, %p)\n", x, y, private_data);
67 /* avoid out-of-range coordinates */
70 if (x >= state->cols) x = state->cols - 1;
71 if (y >= state->rows) y = state->rows - 1;
72 offset = (x + y * state->cols) * BYTES_PER_COL;
75 if (v3_console_set_cursor(state->cons, x, y) < 0) {
76 PrintError("set cursor (0x%p, %d, %d) failed\n", state->cons, x, y);
80 /* done with console update */
81 if (v3_console_update(state->cons) < 0) {
82 PrintError("console update (0x%p) failed\n", state->cons);
89 static int screen_update(uint_t x, uint_t y, uint_t length, void * private_data) {
90 struct vm_device * dev = (struct vm_device *)private_data;
91 struct cons_state * state = (struct cons_state *)dev->private_data;
92 uint_t offset = (x + y * state->cols) * BYTES_PER_COL;
93 uint8_t fb_buf[length];
98 PrintDebug("screen_update(%d, %d, %d, %p)\n", x, y, length, private_data);
100 /* grab frame buffer */
101 v3_cons_get_fb(state->frontend_dev, fb_buf, offset, length);
103 /* update the screen */
104 for (i = 0; i < length; i += 2) {
105 uint_t col_index = i;
108 col[0] = fb_buf[col_index]; // Character
109 col[1] = fb_buf[col_index + 1]; // Attribute
111 /* update current character */
112 if (v3_console_set_char(state->cons, cur_x, cur_y, col[0], col[1]) < 0) {
113 PrintError("set cursor (0x%p, %d, %d, %d, %d) failed\n",
114 state->cons, cur_x, cur_y, col[1], col[0]);
118 // CAUTION: the order of these statements is critical
119 // cur_y depends on the previous value of cur_x
120 cur_y = cur_y + ((cur_x + 1) / state->cols);
121 cur_x = (cur_x + 1) % state->cols;
124 /* done with console update */
125 if (v3_console_update(state->cons) < 0) {
126 PrintError("console update(0x%p) failed\n", state->cons);
133 static int scroll(int rows, void * private_data) {
134 struct vm_device *dev = (struct vm_device *)private_data;
135 struct cons_state *state = (struct cons_state *)dev->private_data;
137 PrintDebug("scroll(%d, %p)\n", rows, private_data);
140 /* simply update the screen */
141 return screen_update_all(private_data);
145 /* scroll requested number of lines*/
146 if (v3_console_scroll(state->cons, rows) < 0) {
147 PrintError("console scroll (0x%p, %u) failed\n", state->cons, rows);
151 /* done with console update */
152 if (v3_console_update(state->cons) < 0) {
153 PrintError("console update (0x%p) failed\n", state->cons);
161 static int set_text_resolution(int cols, int rows, void * private_data) {
162 struct vm_device *dev = (struct vm_device *)private_data;
163 struct cons_state *state = (struct cons_state *)dev->private_data;
165 PrintDebug("set_text_resolution(%d, %d, %p)\n", cols, rows, private_data);
167 /* store resolution for internal use */
168 V3_ASSERT(cols >= 1);
169 V3_ASSERT(rows >= 1);
173 /* set notification regarding resolution change */
174 if (v3_console_set_text_resolution(state->cons, cols, rows) < 0) {
175 PrintError("console set_text_resolution (0x%p, %u, %u) failed\n", state->cons, cols, rows);
179 /* update the screen */
180 return screen_update_all(private_data);
183 static int cons_free(struct cons_state * state) {
184 v3_console_close(state->cons);
193 static int console_event_handler(struct v3_vm_info * vm,
194 struct v3_console_event * evt,
196 return screen_update_all(priv_data);
199 static struct v3_console_ops cons_ops = {
200 .update_screen = screen_update,
201 .update_cursor = cursor_update,
203 .set_text_resolution = set_text_resolution,
206 static struct v3_device_ops dev_ops = {
207 .free = (int (*)(void *))cons_free,
210 static int cons_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg)
212 struct cons_state * state = NULL;
213 v3_cfg_tree_t * frontend_cfg = v3_cfg_subtree(cfg, "frontend");
214 const char * frontend_tag = v3_cfg_val(frontend_cfg, "tag");
215 struct vm_device * frontend = v3_find_dev(vm, frontend_tag);
216 char * dev_id = v3_cfg_val(cfg, "ID");
218 /* read configuration */
219 V3_ASSERT(frontend_cfg);
220 V3_ASSERT(frontend_tag);
225 state = (struct cons_state *)V3_Malloc(sizeof(struct cons_state));
228 state->frontend_dev = frontend;
232 /* open tty for screen display */
233 state->cons = v3_console_open(vm, state->cols, state->rows);
236 PrintError("Could not open console\n");
241 /* allocate device */
242 struct vm_device * dev = v3_add_device(vm, dev_id, &dev_ops, state);
245 PrintError("Could not attach device %s\n", dev_id);
250 /* attach to front-end display adapter */
251 v3_console_register_cga(frontend, &cons_ops, dev);
253 v3_hook_host_event(vm, HOST_CONSOLE_EVT, V3_HOST_EVENT_HANDLER(console_event_handler), dev);
258 device_register("CURSES_CONSOLE", cons_init)