VMM: Change virtio header include paths from linux to vmm
[akaros.git] / user / vmm / include / vmm / virtio_pci.h
1 /*
2  * Virtio PCI driver
3  *
4  * This module allows virtio devices to be used over a virtual PCI device.
5  * This can be used with QEMU based VMMs like KVM or Xen.
6  *
7  * Copyright IBM Corp. 2007
8  *
9  * Authors:
10  *  Anthony Liguori  <aliguori@us.ibm.com>
11  *
12  * This header is BSD licensed so anyone can use the definitions to implement
13  * compatible drivers/servers.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. Neither the name of IBM nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38
39 #pragma once
40
41 #ifndef VIRTIO_PCI_NO_LEGACY
42
43 /* A 32-bit r/o bitmask of the features supported by the host */
44 #define VIRTIO_PCI_HOST_FEATURES        0
45
46 /* A 32-bit r/w bitmask of features activated by the guest */
47 #define VIRTIO_PCI_GUEST_FEATURES       4
48
49 /* A 32-bit r/w PFN for the currently selected queue */
50 #define VIRTIO_PCI_QUEUE_PFN            8
51
52 /* A 16-bit r/o queue size for the currently selected queue */
53 #define VIRTIO_PCI_QUEUE_NUM            12
54
55 /* A 16-bit r/w queue selector */
56 #define VIRTIO_PCI_QUEUE_SEL            14
57
58 /* A 16-bit r/w queue notifier */
59 #define VIRTIO_PCI_QUEUE_NOTIFY         16
60
61 /* An 8-bit device status register.  */
62 #define VIRTIO_PCI_STATUS               18
63
64 /* An 8-bit r/o interrupt status register.  Reading the value will return the
65  * current contents of the ISR and will also clear it.  This is effectively
66  * a read-and-acknowledge. */
67 #define VIRTIO_PCI_ISR                  19
68
69 /* MSI-X registers: only enabled if MSI-X is enabled. */
70 /* A 16-bit vector for configuration changes. */
71 #define VIRTIO_MSI_CONFIG_VECTOR        20
72 /* A 16-bit vector for selected queue notifications. */
73 #define VIRTIO_MSI_QUEUE_VECTOR         22
74
75 /* The remaining space is defined by each driver as the per-driver
76  * configuration space */
77 #define VIRTIO_PCI_CONFIG_OFF(msix_enabled)     ((msix_enabled) ? 24 : 20)
78 /* Deprecated: please use VIRTIO_PCI_CONFIG_OFF instead */
79 #define VIRTIO_PCI_CONFIG(dev)  VIRTIO_PCI_CONFIG_OFF((dev)->msix_enabled)
80
81 /* Virtio ABI version, this must match exactly */
82 #define VIRTIO_PCI_ABI_VERSION          0
83
84 /* How many bits to shift physical queue address written to QUEUE_PFN.
85  * 12 is historical, and due to x86 page size. */
86 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT     12
87
88 /* The alignment to use between consumer and producer parts of vring.
89  * x86 pagesize again. */
90 #define VIRTIO_PCI_VRING_ALIGN          4096
91
92 #endif /* VIRTIO_PCI_NO_LEGACY */
93
94 /* The bit of the ISR which indicates a device configuration change. */
95 #define VIRTIO_PCI_ISR_CONFIG           0x2
96 /* Vector value used to disable MSI for queue */
97 #define VIRTIO_MSI_NO_VECTOR            0xffff
98
99 #ifndef VIRTIO_PCI_NO_MODERN
100
101 /* IDs for different capabilities.  Must all exist. */
102
103 /* Common configuration */
104 #define VIRTIO_PCI_CAP_COMMON_CFG       1
105 /* Notifications */
106 #define VIRTIO_PCI_CAP_NOTIFY_CFG       2
107 /* ISR access */
108 #define VIRTIO_PCI_CAP_ISR_CFG          3
109 /* Device specific configuration */
110 #define VIRTIO_PCI_CAP_DEVICE_CFG       4
111 /* PCI configuration access */
112 #define VIRTIO_PCI_CAP_PCI_CFG          5
113
114 /* This is the PCI capability header: */
115 struct virtio_pci_cap {
116         __u8 cap_vndr;          /* Generic PCI field: PCI_CAP_ID_VNDR */
117         __u8 cap_next;          /* Generic PCI field: next ptr. */
118         __u8 cap_len;           /* Generic PCI field: capability length */
119         __u8 cfg_type;          /* Identifies the structure. */
120         __u8 bar;               /* Where to find it. */
121         __u8 padding[3];        /* Pad to full dword. */
122         __le32 offset;          /* Offset within bar. */
123         __le32 length;          /* Length of the structure, in bytes. */
124 };
125
126 struct virtio_pci_notify_cap {
127         struct virtio_pci_cap cap;
128         __le32 notify_off_multiplier;   /* Multiplier for queue_notify_off. */
129 };
130
131 /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
132 struct virtio_pci_common_cfg {
133         /* About the whole device. */
134         __le32 device_feature_select;   /* read-write */
135         __le32 device_feature;          /* read-only */
136         __le32 guest_feature_select;    /* read-write */
137         __le32 guest_feature;           /* read-write */
138         __le16 msix_config;             /* read-write */
139         __le16 num_queues;              /* read-only */
140         __u8 device_status;             /* read-write */
141         __u8 config_generation;         /* read-only */
142
143         /* About a specific virtqueue. */
144         __le16 queue_select;            /* read-write */
145         __le16 queue_size;              /* read-write, power of 2. */
146         __le16 queue_msix_vector;       /* read-write */
147         __le16 queue_enable;            /* read-write */
148         __le16 queue_notify_off;        /* read-only */
149         __le32 queue_desc_lo;           /* read-write */
150         __le32 queue_desc_hi;           /* read-write */
151         __le32 queue_avail_lo;          /* read-write */
152         __le32 queue_avail_hi;          /* read-write */
153         __le32 queue_used_lo;           /* read-write */
154         __le32 queue_used_hi;           /* read-write */
155 };
156
157 /* Fields in VIRTIO_PCI_CAP_PCI_CFG: */
158 struct virtio_pci_cfg_cap {
159         struct virtio_pci_cap cap;
160         __u8 pci_cfg_data[4]; /* Data for BAR access. */
161 };
162
163 /* Macro versions of offsets for the Old Timers! */
164 #define VIRTIO_PCI_CAP_VNDR             0
165 #define VIRTIO_PCI_CAP_NEXT             1
166 #define VIRTIO_PCI_CAP_LEN              2
167 #define VIRTIO_PCI_CAP_CFG_TYPE         3
168 #define VIRTIO_PCI_CAP_BAR              4
169 #define VIRTIO_PCI_CAP_OFFSET           8
170 #define VIRTIO_PCI_CAP_LENGTH           12
171
172 #define VIRTIO_PCI_NOTIFY_CAP_MULT      16
173
174 #define VIRTIO_PCI_COMMON_DFSELECT      0
175 #define VIRTIO_PCI_COMMON_DF            4
176 #define VIRTIO_PCI_COMMON_GFSELECT      8
177 #define VIRTIO_PCI_COMMON_GF            12
178 #define VIRTIO_PCI_COMMON_MSIX          16
179 #define VIRTIO_PCI_COMMON_NUMQ          18
180 #define VIRTIO_PCI_COMMON_STATUS        20
181 #define VIRTIO_PCI_COMMON_CFGGENERATION 21
182 #define VIRTIO_PCI_COMMON_Q_SELECT      22
183 #define VIRTIO_PCI_COMMON_Q_SIZE        24
184 #define VIRTIO_PCI_COMMON_Q_MSIX        26
185 #define VIRTIO_PCI_COMMON_Q_ENABLE      28
186 #define VIRTIO_PCI_COMMON_Q_NOFF        30
187 #define VIRTIO_PCI_COMMON_Q_DESCLO      32
188 #define VIRTIO_PCI_COMMON_Q_DESCHI      36
189 #define VIRTIO_PCI_COMMON_Q_AVAILLO     40
190 #define VIRTIO_PCI_COMMON_Q_AVAILHI     44
191 #define VIRTIO_PCI_COMMON_Q_USEDLO      48
192 #define VIRTIO_PCI_COMMON_Q_USEDHI      52
193
194 #endif /* VIRTIO_PCI_NO_MODERN */
195
196