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