2 * This header is BSD licensed so anyone can use the definitions to implement
3 * compatible drivers/servers.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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
36 /* VirtIO device IDs. */
37 #define VIRTIO_ID_NETWORK 0x01
38 #define VIRTIO_ID_BLOCK 0x02
39 #define VIRTIO_ID_CONSOLE 0x03
40 #define VIRTIO_ID_ENTROPY 0x04
41 #define VIRTIO_ID_BALLOON 0x05
42 #define VIRTIO_ID_IOMEMORY 0x06
43 #define VIRTIO_ID_SCSI 0x08
44 #define VIRTIO_ID_9P 0x09
46 /* Status byte for guest to report progress. */
47 #define VIRTIO_CONFIG_STATUS_RESET 0x00
48 #define VIRTIO_CONFIG_STATUS_ACK 0x01
49 #define VIRTIO_CONFIG_STATUS_DRIVER 0x02
50 #define VIRTIO_CONFIG_STATUS_DRIVER_OK 0x04
51 #define VIRTIO_CONFIG_STATUS_FAILED 0x80
54 * Generate interrupt when the virtqueue ring is
55 * completely used, even if we've suppressed them.
57 #define VIRTIO_F_NOTIFY_ON_EMPTY (1 << 24)
60 * The guest should never negotiate this feature; it
61 * is used to detect faulty drivers.
63 #define VIRTIO_F_BAD_FEATURE (1 << 30)
66 * Some VirtIO feature bits (currently bits 28 through 31) are
67 * reserved for the transport being used (eg. virtio_ring), the
68 * rest are per-device feature bits.
70 #define VIRTIO_TRANSPORT_F_START 28
71 #define VIRTIO_TRANSPORT_F_END 32
74 * Each virtqueue indirect descriptor list must be physically contiguous.
75 * To allow us to malloc(9) each list individually, limit the number
76 * supported to what will fit in one page. With 4KB pages, this is a limit
77 * of 256 descriptors. If there is ever a need for more, we can switch to
78 * contigmalloc(9) for the larger allocations, similar to what
79 * bus_dmamem_alloc(9) does.
81 * Note the sizeof(struct vring_desc) is 16 bytes.
83 #define VIRTIO_MAX_INDIRECT ((int) (PAGE_SIZE / 16))
86 * VirtIO instance variables indices.
88 #define VIRTIO_IVAR_DEVTYPE 1
89 #define VIRTIO_IVAR_FEATURE_DESC 2
90 #define VIRTIO_IVAR_VENDOR 3
91 #define VIRTIO_IVAR_DEVICE 4
92 #define VIRTIO_IVAR_SUBVENDOR 5
93 #define VIRTIO_IVAR_SUBDEVICE 6
95 struct virtio_feature_desc {
100 const char *virtio_device_name(uint16_t devid);
101 void virtio_describe(device_t dev, const char *msg,
102 uint64_t features, struct virtio_feature_desc *feature_desc);
105 * VirtIO Bus Methods.
107 void virtio_read_ivar(device_t dev, int ivar, uintptr_t *val);
108 void virtio_write_ivar(device_t dev, int ivar, uintptr_t val);
109 uint64_t virtio_negotiate_features(device_t dev, uint64_t child_features);
110 int virtio_alloc_virtqueues(device_t dev, int flags, int nvqs,
111 struct vq_alloc_info *info);
112 int virtio_setup_intr(device_t dev, enum intr_type type);
113 int virtio_with_feature(device_t dev, uint64_t feature);
114 void virtio_stop(device_t dev);
115 int virtio_reinit(device_t dev, uint64_t features);
116 void virtio_reinit_complete(device_t dev);
119 * Read/write a variable amount from the device specific (ie, network)
120 * configuration region. This region is encoded in the same endian as
123 void virtio_read_device_config(device_t dev, bus_size_t offset,
124 void *dst, int length);
125 void virtio_write_device_config(device_t dev, bus_size_t offset,
126 void *src, int length);
128 /* Inlined device specific read/write functions for common lengths. */
129 #define VIRTIO_RDWR_DEVICE_CONFIG(size, type) \
131 __CONCAT(virtio_read_dev_config_,size)(device_t dev, \
135 virtio_read_device_config(dev, offset, &val, sizeof(type)); \
140 __CONCAT(virtio_write_dev_config_,size)(device_t dev, \
141 bus_size_t offset, type val) \
143 virtio_write_device_config(dev, offset, &val, sizeof(type)); \
146 VIRTIO_RDWR_DEVICE_CONFIG(1, uint8_t);
147 VIRTIO_RDWR_DEVICE_CONFIG(2, uint16_t);
148 VIRTIO_RDWR_DEVICE_CONFIG(4, uint32_t);
150 #undef VIRTIO_RDWR_DEVICE_CONFIG
152 #define VIRTIO_READ_IVAR(name, ivar) \
154 __CONCAT(virtio_get_,name)(device_t dev) \
157 virtio_read_ivar(dev, ivar, &val); \
158 return ((int) val); \
161 VIRTIO_READ_IVAR(device_type, VIRTIO_IVAR_DEVTYPE);
162 VIRTIO_READ_IVAR(vendor, VIRTIO_IVAR_VENDOR);
163 VIRTIO_READ_IVAR(device, VIRTIO_IVAR_DEVICE);
164 VIRTIO_READ_IVAR(subvendor, VIRTIO_IVAR_SUBVENDOR);
165 VIRTIO_READ_IVAR(subdevice, VIRTIO_IVAR_SUBDEVICE);
167 #undef VIRTIO_READ_IVAR
169 #define VIRTIO_WRITE_IVAR(name, ivar) \
171 __CONCAT(virtio_set_,name)(device_t dev, void *val) \
173 virtio_write_ivar(dev, ivar, (uintptr_t) val); \
176 VIRTIO_WRITE_IVAR(feature_desc, VIRTIO_IVAR_FEATURE_DESC);
178 #undef VIRTIO_WRITE_IVAR
180 #endif /* _VIRTIO_H_ */