VMM: Converted headers to use pragma once
[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 #include <linux/types.h>
42
43 #ifndef VIRTIO_PCI_NO_LEGACY
44
45 /* A 32-bit r/o bitmask of the features supported by the host */
46 #define VIRTIO_PCI_HOST_FEATURES        0
47
48 /* A 32-bit r/w bitmask of features activated by the guest */
49 #define VIRTIO_PCI_GUEST_FEATURES       4
50
51 /* A 32-bit r/w PFN for the currently selected queue */
52 #define VIRTIO_PCI_QUEUE_PFN            8
53
54 /* A 16-bit r/o queue size for the currently selected queue */
55 #define VIRTIO_PCI_QUEUE_NUM            12
56
57 /* A 16-bit r/w queue selector */
58 #define VIRTIO_PCI_QUEUE_SEL            14
59
60 /* A 16-bit r/w queue notifier */
61 #define VIRTIO_PCI_QUEUE_NOTIFY         16
62
63 /* An 8-bit device status register.  */
64 #define VIRTIO_PCI_STATUS               18
65
66 /* An 8-bit r/o interrupt status register.  Reading the value will return the
67  * current contents of the ISR and will also clear it.  This is effectively
68  * a read-and-acknowledge. */
69 #define VIRTIO_PCI_ISR                  19
70
71 /* MSI-X registers: only enabled if MSI-X is enabled. */
72 /* A 16-bit vector for configuration changes. */
73 #define VIRTIO_MSI_CONFIG_VECTOR        20
74 /* A 16-bit vector for selected queue notifications. */
75 #define VIRTIO_MSI_QUEUE_VECTOR         22
76
77 /* The remaining space is defined by each driver as the per-driver
78  * configuration space */
79 #define VIRTIO_PCI_CONFIG_OFF(msix_enabled)     ((msix_enabled) ? 24 : 20)
80 /* Deprecated: please use VIRTIO_PCI_CONFIG_OFF instead */
81 #define VIRTIO_PCI_CONFIG(dev)  VIRTIO_PCI_CONFIG_OFF((dev)->msix_enabled)
82
83 /* Virtio ABI version, this must match exactly */
84 #define VIRTIO_PCI_ABI_VERSION          0
85
86 /* How many bits to shift physical queue address written to QUEUE_PFN.
87  * 12 is historical, and due to x86 page size. */
88 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT     12
89
90 /* The alignment to use between consumer and producer parts of vring.
91  * x86 pagesize again. */
92 #define VIRTIO_PCI_VRING_ALIGN          4096
93
94 #endif /* VIRTIO_PCI_NO_LEGACY */
95
96 /* The bit of the ISR which indicates a device configuration change. */
97 #define VIRTIO_PCI_ISR_CONFIG           0x2
98 /* Vector value used to disable MSI for queue */
99 #define VIRTIO_MSI_NO_VECTOR            0xffff
100
101 #ifndef VIRTIO_PCI_NO_MODERN
102
103 /* IDs for different capabilities.  Must all exist. */
104
105 /* Common configuration */
106 #define VIRTIO_PCI_CAP_COMMON_CFG       1
107 /* Notifications */
108 #define VIRTIO_PCI_CAP_NOTIFY_CFG       2
109 /* ISR access */
110 #define VIRTIO_PCI_CAP_ISR_CFG          3
111 /* Device specific configuration */
112 #define VIRTIO_PCI_CAP_DEVICE_CFG       4
113 /* PCI configuration access */
114 #define VIRTIO_PCI_CAP_PCI_CFG          5
115
116 /* This is the PCI capability header: */
117 struct virtio_pci_cap {
118         __u8 cap_vndr;          /* Generic PCI field: PCI_CAP_ID_VNDR */
119         __u8 cap_next;          /* Generic PCI field: next ptr. */
120         __u8 cap_len;           /* Generic PCI field: capability length */
121         __u8 cfg_type;          /* Identifies the structure. */
122         __u8 bar;               /* Where to find it. */
123         __u8 padding[3];        /* Pad to full dword. */
124         __le32 offset;          /* Offset within bar. */
125         __le32 length;          /* Length of the structure, in bytes. */
126 };
127
128 struct virtio_pci_notify_cap {
129         struct virtio_pci_cap cap;
130         __le32 notify_off_multiplier;   /* Multiplier for queue_notify_off. */
131 };
132
133 /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
134 struct virtio_pci_common_cfg {
135         /* About the whole device. */
136         __le32 device_feature_select;   /* read-write */
137         __le32 device_feature;          /* read-only */
138         __le32 guest_feature_select;    /* read-write */
139         __le32 guest_feature;           /* read-write */
140         __le16 msix_config;             /* read-write */
141         __le16 num_queues;              /* read-only */
142         __u8 device_status;             /* read-write */
143         __u8 config_generation;         /* read-only */
144
145         /* About a specific virtqueue. */
146         __le16 queue_select;            /* read-write */
147         __le16 queue_size;              /* read-write, power of 2. */
148         __le16 queue_msix_vector;       /* read-write */
149         __le16 queue_enable;            /* read-write */
150         __le16 queue_notify_off;        /* read-only */
151         __le32 queue_desc_lo;           /* read-write */
152         __le32 queue_desc_hi;           /* read-write */
153         __le32 queue_avail_lo;          /* read-write */
154         __le32 queue_avail_hi;          /* read-write */
155         __le32 queue_used_lo;           /* read-write */
156         __le32 queue_used_hi;           /* read-write */
157 };
158
159 /* Fields in VIRTIO_PCI_CAP_PCI_CFG: */
160 struct virtio_pci_cfg_cap {
161         struct virtio_pci_cap cap;
162         __u8 pci_cfg_data[4]; /* Data for BAR access. */
163 };
164
165 /* Macro versions of offsets for the Old Timers! */
166 #define VIRTIO_PCI_CAP_VNDR             0
167 #define VIRTIO_PCI_CAP_NEXT             1
168 #define VIRTIO_PCI_CAP_LEN              2
169 #define VIRTIO_PCI_CAP_CFG_TYPE         3
170 #define VIRTIO_PCI_CAP_BAR              4
171 #define VIRTIO_PCI_CAP_OFFSET           8
172 #define VIRTIO_PCI_CAP_LENGTH           12
173
174 #define VIRTIO_PCI_NOTIFY_CAP_MULT      16
175
176 #define VIRTIO_PCI_COMMON_DFSELECT      0
177 #define VIRTIO_PCI_COMMON_DF            4
178 #define VIRTIO_PCI_COMMON_GFSELECT      8
179 #define VIRTIO_PCI_COMMON_GF            12
180 #define VIRTIO_PCI_COMMON_MSIX          16
181 #define VIRTIO_PCI_COMMON_NUMQ          18
182 #define VIRTIO_PCI_COMMON_STATUS        20
183 #define VIRTIO_PCI_COMMON_CFGGENERATION 21
184 #define VIRTIO_PCI_COMMON_Q_SELECT      22
185 #define VIRTIO_PCI_COMMON_Q_SIZE        24
186 #define VIRTIO_PCI_COMMON_Q_MSIX        26
187 #define VIRTIO_PCI_COMMON_Q_ENABLE      28
188 #define VIRTIO_PCI_COMMON_Q_NOFF        30
189 #define VIRTIO_PCI_COMMON_Q_DESCLO      32
190 #define VIRTIO_PCI_COMMON_Q_DESCHI      36
191 #define VIRTIO_PCI_COMMON_Q_AVAILLO     40
192 #define VIRTIO_PCI_COMMON_Q_AVAILHI     44
193 #define VIRTIO_PCI_COMMON_Q_USEDLO      48
194 #define VIRTIO_PCI_COMMON_Q_USEDHI      52
195
196 #endif /* VIRTIO_PCI_NO_MODERN */
197
198