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".
20 #include <palacios/vmm.h>
21 #include <palacios/vmm_dev_mgr.h>
22 #include <palacios/vm_guest_mem.h>
23 #include <devices/lnx_virtio_pci.h>
25 #include <devices/pci.h>
28 #define SYM_MAGIC_PORT 20
29 #define SYM_SWAP_BASE_PORT 24
30 #define SYM_SWAP_SIZE_PORT 32
33 #define QUEUE_SIZE 128
39 } __attribute__((packed));
43 struct virtio_sym_state {
44 struct sym_config sym_cfg;
45 struct virtio_config virtio_cfg;
48 struct vm_device * pci_bus;
49 struct pci_device * pci_dev;
51 struct virtio_queue queue[1];
53 struct virtio_queue * cur_queue;
62 static int virtio_reset(struct vm_device * dev) {
63 struct virtio_sym_state * virtio = (struct virtio_sym_state *)dev->private_data;
65 memset(virtio->queue, 0, sizeof(struct virtio_queue));
67 virtio->cur_queue = &(virtio->queue[0]);
70 virtio->virtio_cfg.status = 0;
71 virtio->virtio_cfg.pci_isr = 0;
73 virtio->queue[1].queue_size = QUEUE_SIZE;
76 memset(&(virtio->sym_cfg), 0, sizeof(struct sym_config));
82 static int get_desc_count(struct virtio_queue * q, int index) {
83 struct vring_desc * tmp_desc = &(q->desc[index]);
86 while (tmp_desc->flags & VIRTIO_NEXT_FLAG) {
87 tmp_desc = &(q->desc[tmp_desc->next]);
95 static int handle_kick(struct vm_device * dev) {
96 struct virtio_sym_state * virtio = (struct virtio_sym_state *)dev->private_data;
97 struct virtio_queue * q = virtio->cur_queue;
101 PrintDebug("VIRTIO Symbiotic KICK: cur_index=%d (mod=%d), avail_index=%d\n",
102 q->cur_avail_idx, q->cur_avail_idx % QUEUE_SIZE, q->avail->index);
104 while (q->cur_avail_idx < q->avail->index) {
105 struct vring_desc * tmp_desc = NULL;
106 uint16_t desc_idx = q->avail->ring[q->cur_avail_idx % QUEUE_SIZE];
107 int desc_cnt = get_desc_count(q, desc_idx);
109 uint32_t req_len = 0;
112 PrintDebug("Descriptor Count=%d, index=%d\n", desc_cnt, q->cur_avail_idx % QUEUE_SIZE);
114 for (i = 0; i < desc_cnt; i++) {
116 tmp_desc = &(q->desc[desc_idx]);
118 PrintDebug("Header Descriptor (ptr=%p) gpa=%p, len=%d, flags=%x, next=%d\n", tmp_desc,
119 (void *)(tmp_desc->addr_gpa), tmp_desc->length,
120 tmp_desc->flags, tmp_desc->next);
123 if (guest_pa_to_host_va(dev->vm, tmp_desc->addr_gpa, (addr_t *)&(page_addr)) == -1) {
124 PrintError("Could not translate block header address\n");
129 if (handle_sym_op(dev, tmp_desc, buf_desc, status_desc) == -1) {
130 PrintError("Error handling symbiotic operation\n");
135 PrintDebug("Symbiotic Device Currently Ignored\n");
138 req_len += tmp_desc->length;
139 desc_idx = tmp_desc->next;
142 q->used->ring[q->used->index % QUEUE_SIZE].id = q->avail->ring[q->cur_avail_idx % QUEUE_SIZE];
143 q->used->ring[q->used->index % QUEUE_SIZE].length = req_len; // What do we set this to????
149 if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
150 PrintDebug("Raising IRQ %d\n", virtio->pci_dev->config_header.intr_line);
151 v3_pci_raise_irq(virtio->pci_bus, 0, virtio->pci_dev);
152 virtio->virtio_cfg.pci_isr = VIRTIO_ISR_ACTIVE;
159 static int virtio_io_write(uint16_t port, void * src, uint_t length, void * private_data) {
160 struct vm_device * dev = (struct vm_device *)private_data;
161 struct virtio_sym_state * virtio = (struct virtio_sym_state *)dev->private_data;
162 int port_idx = port % virtio->io_range_size;
165 PrintDebug("VIRTIO SYMBIOTIC Write for port %d (index=%d) len=%d, value=%x\n",
166 port, port_idx, length, *(uint32_t *)src);
171 case GUEST_FEATURES_PORT:
173 PrintError("Illegal write length for guest features\n");
177 virtio->virtio_cfg.guest_features = *(uint32_t *)src;
180 case VRING_PG_NUM_PORT:
182 addr_t pfn = *(uint32_t *)src;
183 addr_t page_addr = (pfn << VIRTIO_PAGE_SHIFT);
186 virtio->cur_queue->pfn = pfn;
188 virtio->cur_queue->ring_desc_addr = page_addr ;
189 virtio->cur_queue->ring_avail_addr = page_addr + (QUEUE_SIZE * sizeof(struct vring_desc));
190 virtio->cur_queue->ring_used_addr = ( virtio->cur_queue->ring_avail_addr + \
191 sizeof(struct vring_avail) + \
192 (QUEUE_SIZE * sizeof(uint16_t)));
194 // round up to next page boundary.
195 virtio->cur_queue->ring_used_addr = (virtio->cur_queue->ring_used_addr + 0xfff) & ~0xfff;
197 if (guest_pa_to_host_va(dev->vm, virtio->cur_queue->ring_desc_addr, (addr_t *)&(virtio->cur_queue->desc)) == -1) {
198 PrintError("Could not translate ring descriptor address\n");
203 if (guest_pa_to_host_va(dev->vm, virtio->cur_queue->ring_avail_addr, (addr_t *)&(virtio->cur_queue->avail)) == -1) {
204 PrintError("Could not translate ring available address\n");
209 if (guest_pa_to_host_va(dev->vm, virtio->cur_queue->ring_used_addr, (addr_t *)&(virtio->cur_queue->used)) == -1) {
210 PrintError("Could not translate ring used address\n");
214 PrintDebug("RingDesc_addr=%p, Avail_addr=%p, Used_addr=%p\n",
215 (void *)(virtio->cur_queue->ring_desc_addr),
216 (void *)(virtio->cur_queue->ring_avail_addr),
217 (void *)(virtio->cur_queue->ring_used_addr));
219 PrintDebug("RingDesc=%p, Avail=%p, Used=%p\n",
220 virtio->cur_queue->desc, virtio->cur_queue->avail, virtio->cur_queue->used);
223 PrintError("Illegal write length for page frame number\n");
227 case VRING_Q_SEL_PORT:
228 virtio->virtio_cfg.vring_queue_selector = *(uint16_t *)src;
230 if (virtio->virtio_cfg.vring_queue_selector > 0) {
231 PrintError("Virtio Symbiotic device has not qeueues. Selected %d\n",
232 virtio->virtio_cfg.vring_queue_selector);
236 virtio->cur_queue = &(virtio->queue[virtio->virtio_cfg.vring_queue_selector]);
239 case VRING_Q_NOTIFY_PORT:
240 PrintDebug("Handling Kick\n");
241 if (handle_kick(dev) == -1) {
242 PrintError("Could not handle Symbiotic Notification\n");
246 case VIRTIO_STATUS_PORT:
247 virtio->virtio_cfg.status = *(uint8_t *)src;
249 if (virtio->virtio_cfg.status == 0) {
250 PrintDebug("Resetting device\n");
256 case VIRTIO_ISR_PORT:
257 virtio->virtio_cfg.pci_isr = *(uint8_t *)src;
268 static int virtio_io_read(uint16_t port, void * dst, uint_t length, void * private_data) {
269 struct vm_device * dev = (struct vm_device *)private_data;
270 struct virtio_sym_state * virtio = (struct virtio_sym_state *)dev->private_data;
271 int port_idx = port % virtio->io_range_size;
274 PrintDebug("VIRTIO SYMBIOTIC Read for port %d (index =%d), length=%d\n",
275 port, port_idx, length);
278 case HOST_FEATURES_PORT:
280 PrintError("Illegal read length for host features\n");
284 *(uint32_t *)dst = virtio->virtio_cfg.host_features;
287 case VRING_PG_NUM_PORT:
289 PrintError("Illegal read length for page frame number\n");
293 *(uint32_t *)dst = virtio->cur_queue->pfn;
296 case VRING_SIZE_PORT:
298 PrintError("Illegal read length for vring size\n");
302 *(uint16_t *)dst = virtio->cur_queue->queue_size;
306 case VIRTIO_STATUS_PORT:
308 PrintError("Illegal read length for status\n");
312 *(uint8_t *)dst = virtio->virtio_cfg.status;
315 case VIRTIO_ISR_PORT:
316 *(uint8_t *)dst = virtio->virtio_cfg.pci_isr;
317 virtio->virtio_cfg.pci_isr = 0;
318 v3_pci_lower_irq(virtio->pci_bus, 0, virtio->pci_dev);
322 if ( (port_idx >= sizeof(struct virtio_config)) &&
323 (port_idx < (sizeof(struct virtio_config) + sizeof(struct sym_config))) ) {
324 int cfg_offset = port_idx - sizeof(struct virtio_config);
325 uint8_t * cfg_ptr = (uint8_t *)&(virtio->sym_cfg);
327 memcpy(dst, cfg_ptr + cfg_offset, length);
330 PrintError("Read of Unhandled Virtio Read\n");
344 static struct v3_device_ops dev_ops = {
354 static int virtio_init(struct guest_info * vm, v3_cfg_tree_t * cfg) {
355 struct vm_device * pci_bus = v3_find_dev(vm, v3_cfg_val(cfg, "bus"));
356 struct virtio_sym_state * virtio_state = NULL;
357 struct pci_device * pci_dev = NULL;
358 char * name = v3_cfg_val(cfg, "name");
360 PrintDebug("Initializing VIRTIO Symbiotic device\n");
362 if (pci_bus == NULL) {
363 PrintError("VirtIO devices require a PCI Bus");
368 virtio_state = (struct virtio_sym_state *)V3_Malloc(sizeof(struct virtio_sym_state));
369 memset(virtio_state, 0, sizeof(struct virtio_sym_state));
372 struct vm_device * dev = v3_allocate_device(name, &dev_ops, virtio_state);
373 if (v3_attach_device(vm, dev) == -1) {
374 PrintError("Could not attach device %s\n", name);
379 // PCI initialization
381 struct v3_pci_bar bars[6];
382 int num_ports = sizeof(struct virtio_config) + sizeof(struct sym_config);
383 int tmp_ports = num_ports;
388 // This gets the number of ports, rounded up to a power of 2
389 virtio_state->io_range_size = 1; // must be a power of 2
391 while (tmp_ports > 0) {
393 virtio_state->io_range_size <<= 1;
396 // this is to account for any low order bits being set in num_ports
397 // if there are none, then num_ports was already a power of 2 so we shift right to reset it
398 if ((num_ports & ((virtio_state->io_range_size >> 1) - 1)) == 0) {
399 virtio_state->io_range_size >>= 1;
403 for (i = 0; i < 6; i++) {
404 bars[i].type = PCI_BAR_NONE;
407 bars[0].type = PCI_BAR_IO;
408 bars[0].default_base_port = -1;
409 bars[0].num_ports = virtio_state->io_range_size;
411 bars[0].io_read = virtio_io_read;
412 bars[0].io_write = virtio_io_write;
413 bars[0].private_data = dev;
415 pci_dev = v3_pci_register_device(pci_bus, PCI_STD_DEVICE,
416 0, PCI_AUTO_DEV_NUM, 0,
417 "LNX_VIRTIO_SYM", bars,
418 NULL, NULL, NULL, dev);
421 PrintError("Could not register PCI Device\n");
425 pci_dev->config_header.vendor_id = VIRTIO_VENDOR_ID;
426 pci_dev->config_header.subsystem_vendor_id = VIRTIO_SUBVENDOR_ID;
429 pci_dev->config_header.device_id = VIRTIO_SYMBIOTIC_DEV_ID;
430 pci_dev->config_header.class = PCI_CLASS_MEMORY;
431 pci_dev->config_header.subclass = PCI_MEM_SUBCLASS_RAM;
433 pci_dev->config_header.subsystem_id = VIRTIO_SYMBIOTIC_SUBDEVICE_ID;
436 pci_dev->config_header.intr_pin = 1;
438 pci_dev->config_header.max_latency = 1; // ?? (qemu does it...)
441 virtio_state->pci_dev = pci_dev;
442 virtio_state->pci_bus = pci_bus;
452 device_register("LNX_VIRTIO_SYM", virtio_init)