[mirror_qemu.git] / include / standard-headers / linux / virtio_config.h

#ifndef _LINUX_VIRTIO_CONFIG_H
#define _LINUX_VIRTIO_CONFIG_H
/* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
 * anyone can use the definitions to implement compatible drivers/servers.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of IBM nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE. */

/* Virtio devices use a standardized configuration space to define their
 * features and pass configuration information, but each implementation can
 * store and access that space differently. */
#include "standard-headers/linux/types.h"

/* Status byte for guest to report progress, and synchronize features. */
/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
#define VIRTIO_CONFIG_S_ACKNOWLEDGE	1
/* We have found a driver for the device. */
#define VIRTIO_CONFIG_S_DRIVER		2
/* Driver has used its parts of the config, and is happy */
#define VIRTIO_CONFIG_S_DRIVER_OK	4
/* Driver has finished configuring features */
#define VIRTIO_CONFIG_S_FEATURES_OK	8
/* Device entered invalid state, driver must reset it */
#define VIRTIO_CONFIG_S_NEEDS_RESET	0x40
/* We've given up on this device. */
#define VIRTIO_CONFIG_S_FAILED		0x80

/*
 * Virtio feature bits VIRTIO_TRANSPORT_F_START through
 * VIRTIO_TRANSPORT_F_END are reserved for the transport
 * being used (e.g. virtio_ring, virtio_pci etc.), the
 * rest are per-device feature bits.
 */
#define VIRTIO_TRANSPORT_F_START	28
#define VIRTIO_TRANSPORT_F_END		38

#ifndef VIRTIO_CONFIG_NO_LEGACY
/* Do we get callbacks when the ring is completely used, even if we've
 * suppressed them? */
#define VIRTIO_F_NOTIFY_ON_EMPTY	24

/* Can the device handle any descriptor layout? */
#define VIRTIO_F_ANY_LAYOUT		27
#endif /* VIRTIO_CONFIG_NO_LEGACY */

/* v1.0 compliant. */
#define VIRTIO_F_VERSION_1		32

/*
 * If clear - device has the IOMMU bypass quirk feature.
 * If set - use platform tools to detect the IOMMU.
 *
 * Note the reverse polarity (compared to most other features),
 * this is for compatibility with legacy systems.
 */
#define VIRTIO_F_IOMMU_PLATFORM		33

/* This feature indicates support for the packed virtqueue layout. */
#define VIRTIO_F_RING_PACKED		34

/*
 * Does the device support Single Root I/O Virtualization?
 */
#define VIRTIO_F_SR_IOV			37
#endif /* _LINUX_VIRTIO_CONFIG_H */
Commit	Line	Data
9fbe302b MT	1	#ifndef _LINUX_VIRTIO_CONFIG_H
	2	#define _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 "standard-headers/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
	41	/* Driver has finished configuring features */
	42	#define VIRTIO_CONFIG_S_FEATURES_OK 8
ff804f15 CH	43	/* Device entered invalid state, driver must reset it */
ff804f15 CH	44	#define VIRTIO_CONFIG_S_NEEDS_RESET 0x40
9fbe302b MT	45	/* We've given up on this device. */
	46	#define VIRTIO_CONFIG_S_FAILED 0x80
	47
d36f7de8 CH	48	/*
	49	* Virtio feature bits VIRTIO_TRANSPORT_F_START through
	50	* VIRTIO_TRANSPORT_F_END are reserved for the transport
	51	* being used (e.g. virtio_ring, virtio_pci etc.), the
	52	* rest are per-device feature bits.
	53	*/
9fbe302b	54	#define VIRTIO_TRANSPORT_F_START 28
d36f7de8	55	#define VIRTIO_TRANSPORT_F_END 38
9fbe302b MT	56
	57	#ifndef VIRTIO_CONFIG_NO_LEGACY
	58	/* Do we get callbacks when the ring is completely used, even if we've
	59	* suppressed them? */
	60	#define VIRTIO_F_NOTIFY_ON_EMPTY 24
	61
	62	/* Can the device handle any descriptor layout? */
	63	#define VIRTIO_F_ANY_LAYOUT 27
	64	#endif /* VIRTIO_CONFIG_NO_LEGACY */
	65
	66	/* v1.0 compliant. */
	67	#define VIRTIO_F_VERSION_1 32
	68
dbdfea92 CH	69	/*
	70	* If clear - device has the IOMMU bypass quirk feature.
	71	* If set - use platform tools to detect the IOMMU.
	72	*
	73	* Note the reverse polarity (compared to most other features),
	74	* this is for compatibility with legacy systems.
	75	*/
	76	#define VIRTIO_F_IOMMU_PLATFORM 33
d36f7de8	77
da054c64 PB	78	/* This feature indicates support for the packed virtqueue layout. */
	79	#define VIRTIO_F_RING_PACKED 34
	80
d36f7de8 CH	81	/*
	82	* Does the device support Single Root I/O Virtualization?
	83	*/
	84	#define VIRTIO_F_SR_IOV 37
9fbe302b	85	#endif /* _LINUX_VIRTIO_CONFIG_H */