6defe6535eda55e514b4ee8e884322574bea4ae9
[akaros.git] / user / vmm / include / vmm / virtio_config.h
1 #pragma once
2 /* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
3  * anyone can use the definitions to implement compatible drivers/servers.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of IBM nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE. */
27
28 /* Virtio devices use a standardized configuration space to define their
29  * features and pass configuration information, but each implementation can
30  * store and access that space differently. */
31
32 /* Status byte for guest to report progress, and synchronize features. */
33 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
34 #define VIRTIO_CONFIG_S_ACKNOWLEDGE     1
35 /* We have found a driver for the device. */
36 #define VIRTIO_CONFIG_S_DRIVER          2
37 /* Driver has used its parts of the config, and is happy */
38 #define VIRTIO_CONFIG_S_DRIVER_OK       4
39 /* Driver has finished configuring features */
40 #define VIRTIO_CONFIG_S_FEATURES_OK     8
41 /* We've given up on this device. */
42 #define VIRTIO_CONFIG_S_FAILED          0x80
43
44 /* Some virtio feature bits (currently bits 28 through 32) are reserved for the
45  * transport being used (eg. virtio_ring), the rest are per-device feature
46  * bits. */
47 #define VIRTIO_TRANSPORT_F_START        28
48 #define VIRTIO_TRANSPORT_F_END          33
49
50 #ifndef VIRTIO_CONFIG_NO_LEGACY
51 /* Do we get callbacks when the ring is completely used, even if we've
52  * suppressed them? */
53 #define VIRTIO_F_NOTIFY_ON_EMPTY        24
54
55 /* Can the device handle any descriptor layout? */
56 #define VIRTIO_F_ANY_LAYOUT             27
57 #endif /* VIRTIO_CONFIG_NO_LEGACY */
58
59 /* v1.0 compliant. */
60 #define VIRTIO_F_VERSION_1              32