2007-10-21 21:03:36 -04:00
|
|
|
#ifndef _LINUX_VIRTIO_CONFIG_H
|
|
|
|
#define _LINUX_VIRTIO_CONFIG_H
|
2008-07-25 13:06:03 -04:00
|
|
|
/* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
|
|
|
|
* anyone can use the definitions to implement compatible drivers/servers. */
|
|
|
|
|
2007-10-21 21:03:36 -04:00
|
|
|
/* 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 <linux/types.h>
|
|
|
|
|
2008-02-04 23:49:56 -05:00
|
|
|
/* Status byte for guest to report progress, and synchronize features. */
|
2007-10-21 21:03:36 -04:00
|
|
|
/* 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
|
|
|
|
/* We've given up on this device. */
|
|
|
|
#define VIRTIO_CONFIG_S_FAILED 0x80
|
|
|
|
|
2008-07-25 13:06:07 -04:00
|
|
|
/* Some virtio feature bits (currently bits 28 through 31) are reserved for the
|
|
|
|
* transport being used (eg. virtio_ring), the rest are per-device feature
|
|
|
|
* bits. */
|
|
|
|
#define VIRTIO_TRANSPORT_F_START 28
|
|
|
|
#define VIRTIO_TRANSPORT_F_END 32
|
|
|
|
|
2008-05-30 16:09:45 -04:00
|
|
|
/* Do we get callbacks when the ring is completely used, even if we've
|
|
|
|
* suppressed them? */
|
|
|
|
#define VIRTIO_F_NOTIFY_ON_EMPTY 24
|
|
|
|
|
2007-10-21 21:03:36 -04:00
|
|
|
#ifdef __KERNEL__
|
2008-05-02 22:50:49 -04:00
|
|
|
#include <linux/virtio.h>
|
2007-10-21 21:03:36 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* virtio_config_ops - operations for configuring a virtio device
|
2008-02-04 23:49:56 -05:00
|
|
|
* @get: read the value of a configuration field
|
2007-10-21 21:03:36 -04:00
|
|
|
* vdev: the virtio_device
|
2008-02-04 23:49:56 -05:00
|
|
|
* offset: the offset of the configuration field
|
2007-10-21 21:03:36 -04:00
|
|
|
* buf: the buffer to write the field value into.
|
2008-02-04 23:49:56 -05:00
|
|
|
* len: the length of the buffer
|
|
|
|
* @set: write the value of a configuration field
|
2007-10-21 21:03:36 -04:00
|
|
|
* vdev: the virtio_device
|
2008-02-04 23:49:56 -05:00
|
|
|
* offset: the offset of the configuration field
|
2007-10-21 21:03:36 -04:00
|
|
|
* buf: the buffer to read the field value from.
|
2008-02-04 23:49:56 -05:00
|
|
|
* len: the length of the buffer
|
2007-10-21 21:03:36 -04:00
|
|
|
* @get_status: read the status byte
|
|
|
|
* vdev: the virtio_device
|
|
|
|
* Returns the status byte
|
|
|
|
* @set_status: write the status byte
|
|
|
|
* vdev: the virtio_device
|
|
|
|
* status: the new status byte
|
2008-02-04 23:50:03 -05:00
|
|
|
* @reset: reset the device
|
|
|
|
* vdev: the virtio device
|
|
|
|
* After this, status and feature negotiation must be done again
|
2008-02-04 23:49:56 -05:00
|
|
|
* @find_vq: find a virtqueue and instantiate it.
|
2007-10-21 21:03:36 -04:00
|
|
|
* vdev: the virtio_device
|
2008-02-04 23:49:56 -05:00
|
|
|
* index: the 0-based virtqueue number in case there's more than one.
|
2007-10-21 21:03:36 -04:00
|
|
|
* callback: the virqtueue callback
|
2008-02-04 23:49:56 -05:00
|
|
|
* Returns the new virtqueue or ERR_PTR() (eg. -ENOENT).
|
2007-10-21 21:03:36 -04:00
|
|
|
* @del_vq: free a virtqueue found by find_vq().
|
2008-05-02 22:50:50 -04:00
|
|
|
* @get_features: get the array of feature bits for this device.
|
|
|
|
* vdev: the virtio_device
|
|
|
|
* Returns the first 32 feature bits (all we currently need).
|
2008-07-25 13:06:07 -04:00
|
|
|
* @finalize_features: confirm what device features we'll be using.
|
2008-05-02 22:50:50 -04:00
|
|
|
* vdev: the virtio_device
|
2008-07-25 13:06:07 -04:00
|
|
|
* This gives the final feature bits for the device: it can change
|
|
|
|
* the dev->feature bits if it wants.
|
2007-10-21 21:03:36 -04:00
|
|
|
*/
|
|
|
|
struct virtio_config_ops
|
|
|
|
{
|
2008-02-04 23:49:56 -05:00
|
|
|
void (*get)(struct virtio_device *vdev, unsigned offset,
|
2007-10-21 21:03:36 -04:00
|
|
|
void *buf, unsigned len);
|
2008-02-04 23:49:56 -05:00
|
|
|
void (*set)(struct virtio_device *vdev, unsigned offset,
|
2007-10-21 21:03:36 -04:00
|
|
|
const void *buf, unsigned len);
|
|
|
|
u8 (*get_status)(struct virtio_device *vdev);
|
|
|
|
void (*set_status)(struct virtio_device *vdev, u8 status);
|
2008-02-04 23:50:03 -05:00
|
|
|
void (*reset)(struct virtio_device *vdev);
|
2007-10-21 21:03:36 -04:00
|
|
|
struct virtqueue *(*find_vq)(struct virtio_device *vdev,
|
2008-02-04 23:49:56 -05:00
|
|
|
unsigned index,
|
2008-02-04 23:49:57 -05:00
|
|
|
void (*callback)(struct virtqueue *));
|
2007-10-21 21:03:36 -04:00
|
|
|
void (*del_vq)(struct virtqueue *vq);
|
2008-05-02 22:50:50 -04:00
|
|
|
u32 (*get_features)(struct virtio_device *vdev);
|
2008-07-25 13:06:07 -04:00
|
|
|
void (*finalize_features)(struct virtio_device *vdev);
|
2007-10-21 21:03:36 -04:00
|
|
|
};
|
|
|
|
|
2008-05-02 22:50:50 -04:00
|
|
|
/* If driver didn't advertise the feature, it will never appear. */
|
|
|
|
void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
|
|
|
|
unsigned int fbit);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* virtio_has_feature - helper to determine if this device has this feature.
|
|
|
|
* @vdev: the device
|
|
|
|
* @fbit: the feature bit
|
|
|
|
*/
|
|
|
|
static inline bool virtio_has_feature(const struct virtio_device *vdev,
|
|
|
|
unsigned int fbit)
|
|
|
|
{
|
|
|
|
/* Did you forget to fix assumptions on max features? */
|
|
|
|
if (__builtin_constant_p(fbit))
|
|
|
|
BUILD_BUG_ON(fbit >= 32);
|
|
|
|
|
|
|
|
virtio_check_driver_offered_feature(vdev, fbit);
|
|
|
|
return test_bit(fbit, vdev->features);
|
|
|
|
}
|
|
|
|
|
2007-10-21 21:03:36 -04:00
|
|
|
/**
|
2008-05-02 22:50:49 -04:00
|
|
|
* virtio_config_val - look for a feature and get a virtio config entry.
|
2008-02-04 23:49:56 -05:00
|
|
|
* @vdev: the virtio device
|
|
|
|
* @fbit: the feature bit
|
|
|
|
* @offset: the type to search for.
|
2007-10-21 21:03:36 -04:00
|
|
|
* @val: a pointer to the value to fill in.
|
|
|
|
*
|
2008-02-04 23:49:56 -05:00
|
|
|
* The return value is -ENOENT if the feature doesn't exist. Otherwise
|
2008-05-02 22:50:49 -04:00
|
|
|
* the config value is copied into whatever is pointed to by v. */
|
|
|
|
#define virtio_config_val(vdev, fbit, offset, v) \
|
2008-05-29 05:08:01 -04:00
|
|
|
virtio_config_buf((vdev), (fbit), (offset), (v), sizeof(*v))
|
2007-10-21 21:03:36 -04:00
|
|
|
|
2008-05-02 22:50:49 -04:00
|
|
|
static inline int virtio_config_buf(struct virtio_device *vdev,
|
|
|
|
unsigned int fbit,
|
|
|
|
unsigned int offset,
|
|
|
|
void *buf, unsigned len)
|
|
|
|
{
|
2008-05-02 22:50:50 -04:00
|
|
|
if (!virtio_has_feature(vdev, fbit))
|
2008-05-02 22:50:49 -04:00
|
|
|
return -ENOENT;
|
|
|
|
|
|
|
|
vdev->config->get(vdev, offset, buf, len);
|
|
|
|
return 0;
|
|
|
|
}
|
2007-10-21 21:03:36 -04:00
|
|
|
#endif /* __KERNEL__ */
|
|
|
|
#endif /* _LINUX_VIRTIO_CONFIG_H */
|