vmm: Added more syscalls and helpers to linuxemu
[akaros.git] / user / vmm / include / vmm / virtio_mmio.h
1 /*
2  * Virtio platform device driver
3  *
4  * Copyright 2011, ARM Ltd.
5  *
6  * Based on Virtio PCI driver by Anthony Liguori, copyright IBM Corp. 2007
7  *
8  * This header is BSD licensed so anyone can use the definitions to implement
9  * compatible drivers/servers.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of IBM nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 #pragma once
36
37 /*
38  * Control registers
39  */
40
41 /* Magic value ("virt" string) - Read Only */
42 #define VIRTIO_MMIO_MAGIC_VALUE         0x000
43
44 /* Virtio device version - Read Only */
45 #define VIRTIO_MMIO_VERSION             0x004
46
47 /* Virtio device ID - Read Only */
48 #define VIRTIO_MMIO_DEVICE_ID           0x008
49
50 /* Virtio vendor ID - Read Only */
51 #define VIRTIO_MMIO_VENDOR_ID           0x00c
52
53 /* Bitmask of the features supported by the device (host)
54  * (32 bits per set) - Read Only */
55 #define VIRTIO_MMIO_DEVICE_FEATURES     0x010
56
57 /* Device (host) features set selector - Write Only */
58 #define VIRTIO_MMIO_DEVICE_FEATURES_SEL 0x014
59
60 /* Bitmask of features activated by the driver (guest)
61  * (32 bits per set) - Write Only */
62 #define VIRTIO_MMIO_DRIVER_FEATURES     0x020
63
64 /* Activated features set selector - Write Only */
65 #define VIRTIO_MMIO_DRIVER_FEATURES_SEL 0x024
66
67
68 #ifndef VIRTIO_MMIO_NO_LEGACY /* LEGACY DEVICES ONLY! */
69
70 /* Guest's memory page size in bytes - Write Only */
71 #define VIRTIO_MMIO_GUEST_PAGE_SIZE     0x028
72
73 #endif
74
75
76 /* Queue selector - Write Only */
77 #define VIRTIO_MMIO_QUEUE_SEL           0x030
78
79 /* Maximum size of the currently selected queue - Read Only */
80 #define VIRTIO_MMIO_QUEUE_NUM_MAX       0x034
81
82 /* Queue size for the currently selected queue - Write Only */
83 #define VIRTIO_MMIO_QUEUE_NUM           0x038
84
85
86 #ifndef VIRTIO_MMIO_NO_LEGACY /* LEGACY DEVICES ONLY! */
87
88 /* Used Ring alignment for the currently selected queue - Write Only */
89 #define VIRTIO_MMIO_QUEUE_ALIGN         0x03c
90
91 /* Guest's PFN for the currently selected queue - Read Write */
92 #define VIRTIO_MMIO_QUEUE_PFN           0x040
93
94 #endif
95
96
97 /* Ready bit for the currently selected queue - Read Write */
98 #define VIRTIO_MMIO_QUEUE_READY         0x044
99
100 /* Queue notifier - Write Only */
101 #define VIRTIO_MMIO_QUEUE_NOTIFY        0x050
102
103 /* Interrupt status - Read Only */
104 #define VIRTIO_MMIO_INTERRUPT_STATUS    0x060
105
106 /* Interrupt acknowledge - Write Only */
107 #define VIRTIO_MMIO_INTERRUPT_ACK       0x064
108
109 /* Device status register - Read Write */
110 #define VIRTIO_MMIO_STATUS              0x070
111
112 /* Selected queue's Descriptor Table address, 64 bits in two halves */
113 #define VIRTIO_MMIO_QUEUE_DESC_LOW      0x080
114 #define VIRTIO_MMIO_QUEUE_DESC_HIGH     0x084
115
116 /* Selected queue's Available Ring address, 64 bits in two halves */
117 #define VIRTIO_MMIO_QUEUE_AVAIL_LOW     0x090
118 #define VIRTIO_MMIO_QUEUE_AVAIL_HIGH    0x094
119
120 /* Selected queue's Used Ring address, 64 bits in two halves */
121 #define VIRTIO_MMIO_QUEUE_USED_LOW      0x0a0
122 #define VIRTIO_MMIO_QUEUE_USED_HIGH     0x0a4
123
124 /* Configuration atomicity value */
125 #define VIRTIO_MMIO_CONFIG_GENERATION   0x0fc
126
127 /* The config space is defined by each driver as
128  * the per-driver configuration space - Read Write */
129 #define VIRTIO_MMIO_CONFIG              0x100
130
131
132
133 /*
134  * Interrupt flags (re: interrupt status & acknowledge registers)
135  */
136
137 #define VIRTIO_MMIO_INT_VRING           (1 << 0)
138 #define VIRTIO_MMIO_INT_CONFIG          (1 << 1)
139
140 // Code below this line was added for Akaros and is released
141 // under the following copyrights and license:
142
143 /* Virtio MMIO bindings
144  *
145  * Copyright (c) 2011 Linaro Limited
146  * Copyright (C) 1991-2016, the Linux Kernel authors
147  * Copyright (c) 2016 Google Inc.
148  *
149  * Author:
150  *  Peter Maydell <peter.maydell@linaro.org>
151  *  Rusty Russell <rusty@rustcorp.com.au>
152  *  Michael Taufen <mtaufen@gmail.com>
153  *
154  * This program is free software; you can redistribute it and/or
155  * modify it under the terms of the GNU General Public License as
156  * published by the Free Software Foundation; either version 2 of
157  * the License, or (at your option) any later version.
158  *
159  * This program is distributed in the hope that it will be useful,
160  * but WITHOUT ANY WARRANTY; without even the implied warranty of
161  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
162  * GNU General Public License for more details.
163  *
164  * Akaros's virtio_mmio (items in this file following this notice)
165  * is inspired by QEMU's virtio-mmio.c and Linux's lguest.c.
166  * Both of QEMU's virtio-mmio.c and Linux's lguest.c are released under the
167  * GNU General Public License version 2 or later.
168  * Their original files were heavily modified for Akaros.
169  *
170  * Original linux/tools/lguest/lguest.c:
171  *   https://github.com/torvalds/linux/blob/v4.5/tools/lguest/lguest.c
172  *   most recent hash on the file as of v4.5 tag:
173  *     e523caa601f4a7c2fa1ecd040db921baf7453798
174  *
175  * Original virtio-mmio.c:
176  *   https://github.com/qemu/qemu/blob/v2.5.0/hw/virtio/virtio-mmio.c
177  *   most recent hash on the file as of v2.5.0 tag:
178  *     ab223c9518e8c7eb542ef3133de1a34475b69790
179  */
180
181 #include <stdint.h>
182 #include <vmm/virtio.h>
183
184 // The virtio mmio transport device. Wraps a virtio_vq_dev.
185 struct virtio_mmio_dev {
186         // The base address of the virtio mmio device
187         // we save the same value here as we report to guest via kernel cmd line
188         uint64_t addr;
189
190         // Reads from vqdev.dev_feat are performed starting at bit 32 * dev_feat_sel
191         uint32_t dev_feat_sel;
192
193         // Writes to vqdev.dri_feat are performed starting at bit 32 * dri_feat_sel
194         uint32_t dri_feat_sel;
195
196         // Reads and writes to queue-specific registers target vqdev->vqs[qsel]
197         uint32_t qsel;
198
199         // Interrupt status register
200         uint32_t isr;
201
202         // This utility function will be called when the device needs to interrupt
203         // the guest. You can have it do whatever you want, but it is required.
204         void (*poke_guest)(uint8_t vec, uint32_t dest);
205
206         // Status flags for the device
207         uint8_t status;
208
209         // ConfigGeneration, used to check that access to device-specific
210         // configuration space was atomic
211         uint32_t cfg_gen;
212
213         // The generic vq device contained by this mmio transport
214         struct virtio_vq_dev *vqdev;
215
216         // The specific irq number for this device.
217         uint64_t irq;
218
219         // Actual vector the device will inject.
220         uint8_t vec;
221
222         // Destination the interrupt is routed to.
223         uint32_t dest;
224 };
225
226 // Sets the VIRTIO_MMIO_INT_VRING bit in the interrupt status
227 // register for the device
228 void virtio_mmio_set_vring_irq(struct virtio_mmio_dev *mmio_dev);
229
230 // Sets the VIRTIO_MMIO_INT_CONFIG bit in the interrupt status
231 // register for the device
232 void virtio_mmio_set_cfg_irq(struct virtio_mmio_dev *mmio_dev);
233
234 // virtio_mmio_rd and virtio_mmio_wr:
235 // Used to read and write to the mmio device registers.
236 // - gpa is the guest physical address that the driver tried to write to.
237 //   It is used to calculate the offset from the mmio device's base address,
238 //   and thus the target register of the access operation.
239 // - size is the width of the access operation in bytes.
240 uint32_t virtio_mmio_rd(struct virtual_machine *unused_vm,
241                         struct virtio_mmio_dev *mmio_dev,
242                         uint64_t gpa, uint8_t size);
243 void     virtio_mmio_wr(struct virtual_machine *vm,
244                         struct virtio_mmio_dev *mmio_dev,
245                         uint64_t gpa, uint8_t size, uint32_t *value);