palacios/include/devices/lnx_virtio_pci.h

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20
  21 #ifndef __DEVICES_LNX_VIRTIO_PCI_H__
  22 #define __DEVICES_LNX_VIRTIO_PCI_H__
  23
  24 #ifdef __V3VEE__
  25
  26
  27 /* PCI Vendor IDs (from Qemu) */
  28 #define VIRTIO_VENDOR_ID    0x1af4 // Redhat/Qumranet
  29 #define VIRTIO_SUBVENDOR_ID 0x1af4 // Redhat/Qumranet
  30 #define VIRTIO_SUBDEVICE_ID 0x1100 // Qemu
  31
  32 // PCI Device IDs
  33 #define VIRTIO_NET_DEV_ID         0x1000
  34 #define VIRTIO_BLOCK_DEV_ID       0x1001
  35 #define VIRTIO_BALLOON_DEV_ID     0x1002
  36 #define VIRTIO_CONSOLE_DEV_ID     0x1003
  37 #define VIRTIO_SYMBIOTIC_DEV_ID   0x100a
  38
  39 #define VIRTIO_BLOCK_SUBDEVICE_ID 2
  40 #define VIRTIO_BALLOON_SUBDEVICE_ID 5
  41 #define VIRTIO_SYMBIOTIC_SUBDEVICE_ID 10
  42
  43
  44 #define HOST_FEATURES_PORT 0
  45 #define GUEST_FEATURES_PORT 4
  46 #define VRING_PG_NUM_PORT 8
  47 #define VRING_SIZE_PORT 12
  48 #define VRING_Q_SEL_PORT 14
  49 #define VRING_Q_NOTIFY_PORT 16
  50 #define VIRTIO_STATUS_PORT 18
  51 #define VIRTIO_ISR_PORT 19
  52
  53 #define VIRTIO_PAGE_SHIFT 12
  54
  55
  56 /* Descriptor flags */
  57 /* This marks a buffer as continuing via the next field. */
  58 #define VIRTIO_NEXT_FLAG       0x1
  59 /* This marks a buffer as write-only (otherwise read-only). */
  60 #define VIRTIO_WR_ONLY_FLAG      0x2
  61
  62
  63 /* Used Flags */
  64 /* This means don't notify other side when buffer added. */
  65 #define VRING_NO_NOTIFY_FLAG  0x1
  66
  67
  68 /* Avail Flags */
  69 /* This means don't interrupt guest when buffer consumed. */
  70 #define VIRTIO_NO_IRQ_FLAG      0x1
  71
  72
  73 /* ISR Flags */
  74 #define VIRTIO_ISR_ACTIVE 0x1
  75 #define VIRTIO_ISR_CFG_CHANGED 0x2
  76
  77
  78
  79 /* The virtio configuration space is a hybrid io/memory mapped model
  80  * All IO is done via IO port accesses
  81  * The IO ports access fields in a virtio data structure, and the base io port
  82  *    coincides with the base address of the in memory structure
  83  * There is a standard virtio structure of 20 bytes, followed by a
  84  *    device specific structure of n bytes.
  85  *
  86  */
  87 struct virtio_config {
  88     uint32_t host_features;
  89     uint32_t guest_features;
  90     uint32_t vring_page_num;
  91     uint16_t vring_ring_size;
  92     uint16_t vring_queue_selector;
  93     uint16_t vring_queue_notifier;
  94     uint8_t status;
  95     uint8_t pci_isr;
  96 } __attribute__((packed));
  97
  98
  99 struct vring_desc {
 100     uint64_t addr_gpa;
 101     uint32_t length;
 102     uint16_t flags;
 103     uint16_t next;
 104 } __attribute__((packed));
 105
 106 struct vring_avail {
 107     uint16_t flags;
 108     uint16_t index;
 109     uint16_t ring[0];
 110 } __attribute__((packed));
 111
 112
 113 struct vring_used_elem {
 114     uint32_t id;
 115     uint32_t length;
 116 } __attribute__((packed));
 117
 118 struct vring_used {
 119     uint16_t flags;
 120     uint16_t index;
 121     struct vring_used_elem ring[0];
 122 } __attribute__((packed));
 123
 124
 125
 126 struct virtio_queue {
 127     uint16_t queue_size;
 128
 129     uint16_t cur_avail_idx;
 130
 131     addr_t ring_desc_addr;
 132     addr_t ring_avail_addr;
 133     addr_t ring_used_addr;
 134
 135
 136     struct vring_desc * desc; // We can treat this as an array...
 137     struct vring_avail * avail;
 138     struct vring_used * used;
 139
 140     uint32_t pfn;
 141 };
 142
 143
 144
 145 #endif
 146
 147 #endif