4f93fbd0f8759ca50ba1c8003822dd5ba74d6b7e
[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 #include <vmm/sched.h>
38
39 /*
40  * Control registers
41  */
42
43 /* Magic value ("virt" string) - Read Only */
44 #define VIRTIO_MMIO_MAGIC_VALUE         0x000
45
46 /* Virtio device version - Read Only */
47 #define VIRTIO_MMIO_VERSION             0x004
48
49 /* Virtio device ID - Read Only */
50 #define VIRTIO_MMIO_DEVICE_ID           0x008
51
52 /* Virtio vendor ID - Read Only */
53 #define VIRTIO_MMIO_VENDOR_ID           0x00c
54
55 /* Bitmask of the features supported by the device (host)
56  * (32 bits per set) - Read Only */
57 #define VIRTIO_MMIO_DEVICE_FEATURES     0x010
58
59 /* Device (host) features set selector - Write Only */
60 #define VIRTIO_MMIO_DEVICE_FEATURES_SEL 0x014
61
62 /* Bitmask of features activated by the driver (guest)
63  * (32 bits per set) - Write Only */
64 #define VIRTIO_MMIO_DRIVER_FEATURES     0x020
65
66 /* Activated features set selector - Write Only */
67 #define VIRTIO_MMIO_DRIVER_FEATURES_SEL 0x024
68
69
70 #ifndef VIRTIO_MMIO_NO_LEGACY /* LEGACY DEVICES ONLY! */
71
72 /* Guest's memory page size in bytes - Write Only */
73 #define VIRTIO_MMIO_GUEST_PAGE_SIZE     0x028
74
75 #endif
76
77
78 /* Queue selector - Write Only */
79 #define VIRTIO_MMIO_QUEUE_SEL           0x030
80
81 /* Maximum size of the currently selected queue - Read Only */
82 #define VIRTIO_MMIO_QUEUE_NUM_MAX       0x034
83
84 /* Queue size for the currently selected queue - Write Only */
85 #define VIRTIO_MMIO_QUEUE_NUM           0x038
86
87
88 #ifndef VIRTIO_MMIO_NO_LEGACY /* LEGACY DEVICES ONLY! */
89
90 /* Used Ring alignment for the currently selected queue - Write Only */
91 #define VIRTIO_MMIO_QUEUE_ALIGN         0x03c
92
93 /* Guest's PFN for the currently selected queue - Read Write */
94 #define VIRTIO_MMIO_QUEUE_PFN           0x040
95
96 #endif
97
98
99 /* Ready bit for the currently selected queue - Read Write */
100 #define VIRTIO_MMIO_QUEUE_READY         0x044
101
102 /* Queue notifier - Write Only */
103 #define VIRTIO_MMIO_QUEUE_NOTIFY        0x050
104
105 /* Interrupt status - Read Only */
106 #define VIRTIO_MMIO_INTERRUPT_STATUS    0x060
107
108 /* Interrupt acknowledge - Write Only */
109 #define VIRTIO_MMIO_INTERRUPT_ACK       0x064
110
111 /* Device status register - Read Write */
112 #define VIRTIO_MMIO_STATUS              0x070
113
114 /* Selected queue's Descriptor Table address, 64 bits in two halves */
115 #define VIRTIO_MMIO_QUEUE_DESC_LOW      0x080
116 #define VIRTIO_MMIO_QUEUE_DESC_HIGH     0x084
117
118 /* Selected queue's Available Ring address, 64 bits in two halves */
119 #define VIRTIO_MMIO_QUEUE_AVAIL_LOW     0x090
120 #define VIRTIO_MMIO_QUEUE_AVAIL_HIGH    0x094
121
122 /* Selected queue's Used Ring address, 64 bits in two halves */
123 #define VIRTIO_MMIO_QUEUE_USED_LOW      0x0a0
124 #define VIRTIO_MMIO_QUEUE_USED_HIGH     0x0a4
125
126 /* Configuration atomicity value */
127 #define VIRTIO_MMIO_CONFIG_GENERATION   0x0fc
128
129 /* The config space is defined by each driver as
130  * the per-driver configuration space - Read Write */
131 #define VIRTIO_MMIO_CONFIG              0x100
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 // A vq defines on queue attached to a device. It has a function, started as a thread;
141 // an arg, for arbitrary use; qnum, which is an indicator of how much memory is given
142 // to the queue; a pointer to the thread that gets started when the queue is notified;
143 // a physical frame number, which is process virtual to the vmm; an isr (not used yet);
144 // status; and a pointer to the virtio struct.
145 struct vq {
146         char *name;
147         /* Start this as a thread when a matching virtio is discovered. */
148         void (*func)(void *arg);
149         void *arg;
150         int maxqnum; // how many things the q gets? or something. 
151         int qnum; 
152         int qalign;
153         /* filled in by virtio probing. */
154         uint64_t pfn;
155         uint32_t isr; // not used yet but ...
156         uint32_t status;
157         uint64_t qdesc;
158         uint64_t qavail;
159         uint64_t qused;
160         void *virtio;
161 };
162
163 // a vqdev has a name; magic number; features ( we MUST have features);
164 // and an array of vqs.
165 struct vqdev {
166         /* Set up usually as a static initializer */
167         char *name;
168         uint32_t dev; // e.g. VIRTIO_ID_CONSOLE);
169         uint64_t device_features, driver_features;
170         int numvqs;
171         struct vq vqs[];
172 };
173
174
175 /* This struct is passed to a virtio thread when it is started. It includes
176  * needed info and the vqdev arg. This seems overkill but we may need to add to it.
177  */
178 struct virtio_threadarg {
179         struct vq *arg;
180 };
181
182 void dumpvirtio_mmio(FILE *f, uint64_t gpa);
183 void register_virtio_mmio(struct vqdev *v, uint64_t virtio_base);
184 int virtio_mmio(struct guest_thread *vm_thread, uint64_t gpa, int destreg,
185                 uint64_t *regp, int store);
186 void virtio_mmio_set_vring_irq(void);