xref: /OK3568_Linux_fs/kernel/include/uapi/linux/virtio_config.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun #ifndef _UAPI_LINUX_VIRTIO_CONFIG_H
2*4882a593Smuzhiyun #define _UAPI_LINUX_VIRTIO_CONFIG_H
3*4882a593Smuzhiyun /* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
4*4882a593Smuzhiyun  * anyone can use the definitions to implement compatible drivers/servers.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Redistribution and use in source and binary forms, with or without
7*4882a593Smuzhiyun  * modification, are permitted provided that the following conditions
8*4882a593Smuzhiyun  * are met:
9*4882a593Smuzhiyun  * 1. Redistributions of source code must retain the above copyright
10*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer.
11*4882a593Smuzhiyun  * 2. Redistributions in binary form must reproduce the above copyright
12*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer in the
13*4882a593Smuzhiyun  *    documentation and/or other materials provided with the distribution.
14*4882a593Smuzhiyun  * 3. Neither the name of IBM nor the names of its contributors
15*4882a593Smuzhiyun  *    may be used to endorse or promote products derived from this software
16*4882a593Smuzhiyun  *    without specific prior written permission.
17*4882a593Smuzhiyun  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
18*4882a593Smuzhiyun  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*4882a593Smuzhiyun  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*4882a593Smuzhiyun  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21*4882a593Smuzhiyun  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*4882a593Smuzhiyun  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*4882a593Smuzhiyun  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*4882a593Smuzhiyun  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*4882a593Smuzhiyun  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*4882a593Smuzhiyun  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*4882a593Smuzhiyun  * SUCH DAMAGE. */
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /* Virtio devices use a standardized configuration space to define their
30*4882a593Smuzhiyun  * features and pass configuration information, but each implementation can
31*4882a593Smuzhiyun  * store and access that space differently. */
32*4882a593Smuzhiyun #include <linux/types.h>
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun /* Status byte for guest to report progress, and synchronize features. */
35*4882a593Smuzhiyun /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
36*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_ACKNOWLEDGE	1
37*4882a593Smuzhiyun /* We have found a driver for the device. */
38*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_DRIVER		2
39*4882a593Smuzhiyun /* Driver has used its parts of the config, and is happy */
40*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_DRIVER_OK	4
41*4882a593Smuzhiyun /* Driver has finished configuring features */
42*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_FEATURES_OK	8
43*4882a593Smuzhiyun /* Device entered invalid state, driver must reset it */
44*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_NEEDS_RESET	0x40
45*4882a593Smuzhiyun /* We've given up on this device. */
46*4882a593Smuzhiyun #define VIRTIO_CONFIG_S_FAILED		0x80
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun /*
49*4882a593Smuzhiyun  * Virtio feature bits VIRTIO_TRANSPORT_F_START through
50*4882a593Smuzhiyun  * VIRTIO_TRANSPORT_F_END are reserved for the transport
51*4882a593Smuzhiyun  * being used (e.g. virtio_ring, virtio_pci etc.), the
52*4882a593Smuzhiyun  * rest are per-device feature bits.
53*4882a593Smuzhiyun  */
54*4882a593Smuzhiyun #define VIRTIO_TRANSPORT_F_START	28
55*4882a593Smuzhiyun #define VIRTIO_TRANSPORT_F_END		38
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #ifndef VIRTIO_CONFIG_NO_LEGACY
58*4882a593Smuzhiyun /* Do we get callbacks when the ring is completely used, even if we've
59*4882a593Smuzhiyun  * suppressed them? */
60*4882a593Smuzhiyun #define VIRTIO_F_NOTIFY_ON_EMPTY	24
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /* Can the device handle any descriptor layout? */
63*4882a593Smuzhiyun #define VIRTIO_F_ANY_LAYOUT		27
64*4882a593Smuzhiyun #endif /* VIRTIO_CONFIG_NO_LEGACY */
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun /* v1.0 compliant. */
67*4882a593Smuzhiyun #define VIRTIO_F_VERSION_1		32
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /*
70*4882a593Smuzhiyun  * If clear - device has the platform DMA (e.g. IOMMU) bypass quirk feature.
71*4882a593Smuzhiyun  * If set - use platform DMA tools to access the memory.
72*4882a593Smuzhiyun  *
73*4882a593Smuzhiyun  * Note the reverse polarity (compared to most other features),
74*4882a593Smuzhiyun  * this is for compatibility with legacy systems.
75*4882a593Smuzhiyun  */
76*4882a593Smuzhiyun #define VIRTIO_F_ACCESS_PLATFORM	33
77*4882a593Smuzhiyun #ifndef __KERNEL__
78*4882a593Smuzhiyun /* Legacy name for VIRTIO_F_ACCESS_PLATFORM (for compatibility with old userspace) */
79*4882a593Smuzhiyun #define VIRTIO_F_IOMMU_PLATFORM		VIRTIO_F_ACCESS_PLATFORM
80*4882a593Smuzhiyun #endif /* __KERNEL__ */
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun /* This feature indicates support for the packed virtqueue layout. */
83*4882a593Smuzhiyun #define VIRTIO_F_RING_PACKED		34
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun /*
86*4882a593Smuzhiyun  * This feature indicates that memory accesses by the driver and the
87*4882a593Smuzhiyun  * device are ordered in a way described by the platform.
88*4882a593Smuzhiyun  */
89*4882a593Smuzhiyun #define VIRTIO_F_ORDER_PLATFORM		36
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun /*
92*4882a593Smuzhiyun  * Does the device support Single Root I/O Virtualization?
93*4882a593Smuzhiyun  */
94*4882a593Smuzhiyun #define VIRTIO_F_SR_IOV			37
95*4882a593Smuzhiyun #endif /* _UAPI_LINUX_VIRTIO_CONFIG_H */
96