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) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
25 #include <palacios/vmm_types.h>
26 #include <palacios/vmm_list.h>
27 #include <palacios/vmm_string.h>
28 #include <palacios/vmm_hashtable.h>
29 #include <palacios/vmm_msr.h>
30 #include <palacios/vmm_config.h>
37 typedef void * v3_dev_data_t;
46 struct v3_device_ops * ops;
48 struct v3_vm_info * vm;
50 struct list_head dev_link;
53 struct list_head res_hooks;
59 struct list_head dev_list;
60 struct hashtable * dev_table;
62 struct list_head blk_list;
63 struct hashtable * blk_table;
65 struct list_head net_list;
66 struct hashtable * net_table;
68 struct list_head char_list;
69 struct hashtable * char_table;
71 struct list_head cons_list;
72 struct hashtable * cons_table;
76 int v3_create_device(struct v3_vm_info * vm, const char * dev_name, v3_cfg_tree_t * cfg);
78 struct vm_device * v3_find_dev(struct v3_vm_info * info, const char * dev_name);
81 // Registration of devices
84 // The following device manager functions should only be called
85 // when the guest is stopped
90 int v3_init_dev_mgr(struct v3_vm_info * vm);
91 int v3_deinit_dev_mgr(struct v3_vm_info * vm);
93 int v3_free_vm_devices(struct v3_vm_info * vm);
101 int V3_init_devices();
102 int V3_deinit_devices();
105 struct v3_device_ops {
106 int (*free)(void * private_data);
108 //int (*save)(struct vm_device *dev, struct *iostream);
109 //int (*restore)(struct vm_device *dev, struct *iostream);
117 int v3_dev_hook_io(struct vm_device * dev,
119 int (*read)(struct guest_info * core, uint16_t port, void * dst, uint_t length, void * priv_data),
120 int (*write)(struct guest_info * core, uint16_t port, void * src, uint_t length, void * priv_data));
122 int v3_dev_unhook_io(struct vm_device * dev,
126 int v3_dev_hook_msr(struct vm_device * dev,
128 int (*read)(struct guest_info * core, uint32_t msr, struct v3_msr * dst, void * priv_data),
129 int (*write)(struct guest_info * core, uint32_t msr, struct v3_msr src, void * priv_data));
131 int v3_dev_unhook_msr(struct vm_device * dev,
137 struct vm_device * v3_add_device(struct v3_vm_info * vm, char * name,
138 struct v3_device_ops * ops, void * private_data);
139 int v3_remove_device(struct vm_device * dev);
142 int v3_attach_device(struct v3_vm_info * vm, struct vm_device * dev);
143 int v3_detach_device(struct vm_device * dev);
144 struct vm_device * v3_allocate_device(char * name, struct v3_device_ops * ops, void * private_data);
147 struct v3_device_info {
149 int (*init)(struct v3_vm_info * info, v3_cfg_tree_t * cfg);
153 #define device_register(name, init_dev_fn) \
154 static char _v3_device_name[] = name; \
155 static struct v3_device_info _v3_device \
156 __attribute__((__used__)) \
157 __attribute__((unused, __section__ ("_v3_devices"), \
158 aligned(sizeof(addr_t)))) \
159 = {_v3_device_name , init_dev_fn};
164 void v3_print_dev_mgr(struct v3_vm_info * vm);
167 struct v3_dev_blk_ops {
168 uint64_t (*get_capacity)(void * private_data);
169 // Reads always operate on 2048 byte blocks
170 int (*read)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
171 int (*write)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
174 struct v3_dev_net_ops {
175 /* Backend implemented functions */
176 int (*send)(uint8_t * buf, uint32_t count, void * private_data);
177 void (*start_rx)(void * back_data);
178 void (*stop_rx)(void * back_data);
180 /* Frontend implemented functions */
181 int (*recv)(uint8_t * buf, uint32_t count, void * frnt_data);
182 void (*poll)(struct v3_vm_info * vm, void * frnt_data);
183 void (*start_tx)(void * frnt_data);
184 void (*stop_tx)(void * frnt_data);
186 /* This is ugly... */
187 void * frontend_data;
190 struct v3_dev_console_ops {
191 int (*update_screen)(uint_t x, uint_t y, uint_t length, uint8_t * fb_data, void * private_data);
192 int (*update_cursor)(uint_t x, uint_t y, void * private_data);
193 int (*scroll)(int rows, void * private_data);
194 int (*set_text_resolution)(int cols, int rows, void * private_data);
196 /* frontend implemented functions */
197 int (*get_screen)(uint_t x, uint_t y, uint_t length, void * frontend_data);
201 struct v3_dev_char_ops {
202 /* Backend implemented functions */
203 int (*write)(uint8_t * buf, uint64_t len, void * private_data);
204 // int (*read)(uint8_t * buf, uint64_t len, void * private_data);
206 /* Frontend Implemented functions */
207 int (*push)(struct v3_vm_info * vm, uint8_t * buf, uint64_t len, void * private_data);
211 int v3_dev_add_blk_frontend(struct v3_vm_info * vm,
213 int (*connect)(struct v3_vm_info * vm,
214 void * frontend_data,
215 struct v3_dev_blk_ops * ops,
217 void * private_data),
220 int v3_dev_connect_blk(struct v3_vm_info * vm,
221 char * frontend_name,
222 struct v3_dev_blk_ops * ops,
224 void * private_data);
226 int v3_dev_add_net_frontend(struct v3_vm_info * vm,
228 int (*connect)(struct v3_vm_info * vm,
229 void * frontend_data,
230 struct v3_dev_net_ops * ops,
232 void * private_data),
235 int v3_dev_connect_net(struct v3_vm_info * vm,
236 char * frontend_name,
237 struct v3_dev_net_ops * ops,
239 void * private_data);
244 int v3_dev_add_console_frontend(struct v3_vm_info * vm,
246 int (*connect)(struct v3_vm_info * vm,
247 void * frontend_data,
248 struct v3_dev_console_ops * ops,
250 void * private_data),
253 int v3_dev_connect_console(struct v3_vm_info * vm,
254 char * frontend_name,
255 struct v3_dev_console_ops * ops,
257 void * private_data);
261 int v3_dev_add_char_frontend(struct v3_vm_info * vm,
263 int (*connect)(struct v3_vm_info * vm,
264 void * frontend_data,
265 struct v3_dev_char_ops * ops,
268 void ** push_fn_arg),
271 int v3_dev_connect_char(struct v3_vm_info * vm,
272 char * frontend_name,
273 struct v3_dev_char_ops * ops,
276 void ** push_fn_arg);
279 #endif // ! __V3VEE__