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_NET_SUBDEVICE_ID 1
  40 #define VIRTIO_BLOCK_SUBDEVICE_ID 2
  41 #define VIRTIO_BALLOON_SUBDEVICE_ID 5
  42 #define VIRTIO_SYMBIOTIC_SUBDEVICE_ID 10
  43
  44
  45 #define HOST_FEATURES_PORT 0
  46 #define GUEST_FEATURES_PORT 4
  47 #define VRING_PG_NUM_PORT 8
  48 #define VRING_SIZE_PORT 12
  49 #define VRING_Q_SEL_PORT 14
  50 #define VRING_Q_NOTIFY_PORT 16
  51 #define VIRTIO_STATUS_PORT 18
  52 #define VIRTIO_ISR_PORT 19
  53
  54 #define VIRTIO_PAGE_SHIFT 12
  55
  56
  57 /* Descriptor flags */
  58 /* This marks a buffer as continuing via the next field. */
  59 #define VIRTIO_NEXT_FLAG       0x1
  60 /* This marks a buffer as write-only (otherwise read-only). */
  61 #define VIRTIO_WR_ONLY_FLAG      0x2
  62
  63
  64 /* Used Flags */
  65 /* This means don't notify other side when buffer added. */
  66 #define VRING_NO_NOTIFY_FLAG  0x1
  67
  68
  69 /* Avail Flags */
  70 /* This means don't interrupt guest when buffer consumed. */
  71 #define VIRTIO_NO_IRQ_FLAG      0x1
  72
  73
  74 /* ISR Flags */
  75 #define VIRTIO_ISR_ACTIVE 0x1
  76 #define VIRTIO_ISR_CFG_CHANGED 0x2
  77
  78
  79
  80 /* The virtio configuration space is a hybrid io/memory mapped model
  81  * All IO is done via IO port accesses
  82  * The IO ports access fields in a virtio data structure, and the base io port
  83  *    coincides with the base address of the in memory structure
  84  * There is a standard virtio structure of 20 bytes, followed by a
  85  *    device specific structure of n bytes.
  86  *
  87  */
  88 struct virtio_config {
  89     uint32_t host_features;
  90     uint32_t guest_features;
  91     uint32_t vring_page_num;
  92     uint16_t vring_ring_size;
  93     uint16_t vring_queue_selector;
  94     uint16_t vring_queue_notifier;
  95     uint8_t status;
  96     uint8_t pci_isr;
  97 } __attribute__((packed));
  98
  99
 100 struct vring_desc {
 101     uint64_t addr_gpa;
 102     uint32_t length;
 103     uint16_t flags;
 104     uint16_t next;
 105 } __attribute__((packed));
 106
 107 struct vring_avail {
 108     uint16_t flags;
 109     uint16_t index;
 110     uint16_t ring[0];
 111 } __attribute__((packed));
 112
 113
 114 struct vring_used_elem {
 115     uint32_t id;
 116     uint32_t length;
 117 } __attribute__((packed));
 118
 119 struct vring_used {
 120     uint16_t flags;
 121     uint16_t index;
 122     struct vring_used_elem ring[0];
 123 } __attribute__((packed));
 124
 125
 126
 127 struct virtio_queue {
 128     uint16_t queue_size;
 129
 130     uint16_t cur_avail_idx;
 131
 132     addr_t ring_desc_addr;
 133     addr_t ring_avail_addr;
 134     addr_t ring_used_addr;
 135
 136
 137     struct vring_desc * desc; // We can treat this as an array...
 138     struct vring_avail * avail;
 139     struct vring_used * used;
 140
 141     uint32_t pfn;
 142 };
 143
 144
 145
 146 #endif
 147
 148 #endif