blob: 308e2096291f8f109185848f3baea431253161da [file] [log] [blame]
David Howells607ca462012-10-13 10:46:48 +01001#ifndef _UAPI_LINUX_VIRTIO_CONFIG_H
2#define _UAPI_LINUX_VIRTIO_CONFIG_H
3/* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
4 * anyone can use the definitions to implement compatible drivers/servers.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of IBM nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE. */
28
29/* Virtio devices use a standardized configuration space to define their
30 * features and pass configuration information, but each implementation can
31 * store and access that space differently. */
32#include <linux/types.h>
33
34/* Status byte for guest to report progress, and synchronize features. */
35/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
36#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
37/* We have found a driver for the device. */
38#define VIRTIO_CONFIG_S_DRIVER 2
39/* Driver has used its parts of the config, and is happy */
40#define VIRTIO_CONFIG_S_DRIVER_OK 4
Michael S. Tsirkincb3f6d92014-10-22 17:41:38 +030041/* Driver has finished configuring features */
42#define VIRTIO_CONFIG_S_FEATURES_OK 8
Stefan Hajnoczic00bbcf2016-03-29 16:43:45 +010043/* Device entered invalid state, driver must reset it */
44#define VIRTIO_CONFIG_S_NEEDS_RESET 0x40
David Howells607ca462012-10-13 10:46:48 +010045/* We've given up on this device. */
46#define VIRTIO_CONFIG_S_FAILED 0x80
47
Michael S. Tsirkin747ae342014-12-01 15:52:40 +020048/* Some virtio feature bits (currently bits 28 through 32) are reserved for the
David Howells607ca462012-10-13 10:46:48 +010049 * transport being used (eg. virtio_ring), the rest are per-device feature
50 * bits. */
51#define VIRTIO_TRANSPORT_F_START 28
Michael S. Tsirkin1a937692016-04-18 12:58:14 +030052#define VIRTIO_TRANSPORT_F_END 34
David Howells607ca462012-10-13 10:46:48 +010053
Rusty Russell6d96ee92015-02-11 15:01:14 +103054#ifndef VIRTIO_CONFIG_NO_LEGACY
David Howells607ca462012-10-13 10:46:48 +010055/* Do we get callbacks when the ring is completely used, even if we've
56 * suppressed them? */
57#define VIRTIO_F_NOTIFY_ON_EMPTY 24
58
Rusty Russell62525a02013-07-08 10:33:37 +093059/* Can the device handle any descriptor layout? */
60#define VIRTIO_F_ANY_LAYOUT 27
Rusty Russell6d96ee92015-02-11 15:01:14 +103061#endif /* VIRTIO_CONFIG_NO_LEGACY */
Rusty Russell62525a02013-07-08 10:33:37 +093062
Michael S. Tsirkin4ec22fa2014-10-22 15:49:34 +030063/* v1.0 compliant. */
64#define VIRTIO_F_VERSION_1 32
65
Michael S. Tsirkin1a937692016-04-18 12:58:14 +030066/*
67 * If clear - device has the IOMMU bypass quirk feature.
68 * If set - use platform tools to detect the IOMMU.
69 *
70 * Note the reverse polarity (compared to most other features),
71 * this is for compatibility with legacy systems.
72 */
73#define VIRTIO_F_IOMMU_PLATFORM 33
David Howells607ca462012-10-13 10:46:48 +010074#endif /* _UAPI_LINUX_VIRTIO_CONFIG_H */