kernel -- virtio: Implement virtio-layer lwkt_serializer for devices
[dragonfly.git] / sys / dev / virtual / virtio / virtio / virtio.h
1 /*-
2  * This header is BSD licensed so anyone can use the definitions to implement
3  * 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
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE 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  * $FreeBSD: src/sys/dev/virtio/virtio.h,v 1.2 2011/12/06 06:28:32 grehan Exp $
29  */
30
31 #ifndef _VIRTIO_H_
32 #define _VIRTIO_H_
33
34 #include <sys/types.h>
35 #include <sys/serialize.h>
36
37 struct vq_alloc_info;
38
39 /* VirtIO device IDs. */
40 #define VIRTIO_ID_NETWORK       0x01
41 #define VIRTIO_ID_BLOCK         0x02
42 #define VIRTIO_ID_CONSOLE       0x03
43 #define VIRTIO_ID_ENTROPY       0x04
44 #define VIRTIO_ID_BALLOON       0x05
45 #define VIRTIO_ID_IOMEMORY      0x06
46 #define VIRTIO_ID_9P            0x09
47
48 /* Status byte for guest to report progress. */
49 #define VIRTIO_CONFIG_STATUS_RESET      0x00
50 #define VIRTIO_CONFIG_STATUS_ACK        0x01
51 #define VIRTIO_CONFIG_STATUS_DRIVER     0x02
52 #define VIRTIO_CONFIG_STATUS_DRIVER_OK  0x04
53 #define VIRTIO_CONFIG_STATUS_FAILED     0x80
54
55 /*
56  * Generate interrupt when the virtqueue ring is
57  * completely used, even if we've suppressed them.
58  */
59 #define VIRTIO_F_NOTIFY_ON_EMPTY (1 << 24)
60
61 /*
62  * The guest should never negotiate this feature; it
63  * is used to detect faulty drivers.
64  */
65 #define VIRTIO_F_BAD_FEATURE (1 << 30)
66
67 /*
68  * Some VirtIO feature bits (currently bits 28 through 31) are
69  * reserved for the transport being used (eg. virtio_ring), the
70  * rest are per-device feature bits.
71  */
72 #define VIRTIO_TRANSPORT_F_START        28
73 #define VIRTIO_TRANSPORT_F_END          32
74
75 /*
76  * Maximum number of virtqueues per device.
77  */
78 #define VIRTIO_MAX_VIRTQUEUES 8
79
80 /*
81  * VirtIO instance variables indices.
82  */
83 #define VIRTIO_IVAR_DEVTYPE             1
84 #define VIRTIO_IVAR_FEATURE_DESC        2
85
86 struct virtio_feature_desc {
87         uint64_t         vfd_val;
88         char            *vfd_str;
89 };
90
91 const char *virtio_device_name(uint16_t devid);
92 int      virtio_get_device_type(device_t dev);
93 void     virtio_set_feature_desc(device_t dev,
94              struct virtio_feature_desc *feature_desc);
95 void     virtio_describe(device_t dev, const char *msg,
96              uint64_t features, struct virtio_feature_desc *feature_desc);
97
98 /*
99  * VirtIO Bus Methods.
100  */
101 uint64_t virtio_negotiate_features(device_t dev, uint64_t child_features);
102 int      virtio_alloc_virtqueues(device_t dev, int flags, int nvqs,
103              struct vq_alloc_info *info);
104 int      virtio_setup_intr(device_t dev, lwkt_serialize_t);
105 int      virtio_with_feature(device_t dev, uint64_t feature);
106 void     virtio_stop(device_t dev);
107 int      virtio_reinit(device_t dev, uint64_t features);
108 void     virtio_reinit_complete(device_t dev);
109
110 /*
111  * Read/write a variable amount from the device specific (ie, network)
112  * configuration region. This region is encoded in the same endian as
113  * the guest.
114  */
115 void     virtio_read_device_config(device_t dev, bus_size_t offset,
116              void *dst, int length);
117 void     virtio_write_device_config(device_t dev, bus_size_t offset,
118              void *src, int length);
119
120 /* Inlined device specific read/write functions for common lengths. */
121 #define VIRTIO_RDWR_DEVICE_CONFIG(size, type)                           \
122 static inline type                                                      \
123 __CONCAT(virtio_read_dev_config_,size)(device_t dev,                    \
124     bus_size_t offset)                                                  \
125 {                                                                       \
126         type val;                                                       \
127         virtio_read_device_config(dev, offset, &val, sizeof(type));     \
128         return (val);                                                   \
129 }                                                                       \
130                                                                         \
131 static inline void                                                      \
132 __CONCAT(virtio_write_dev_config_,size)(device_t dev,                   \
133     bus_size_t offset, type val)                                        \
134 {                                                                       \
135         virtio_write_device_config(dev, offset, &val, sizeof(type));    \
136 }
137
138 VIRTIO_RDWR_DEVICE_CONFIG(1, uint8_t);
139 VIRTIO_RDWR_DEVICE_CONFIG(2, uint16_t);
140 VIRTIO_RDWR_DEVICE_CONFIG(4, uint32_t);
141
142 #endif /* _VIRTIO_H_ */