2007-10-21 21:03:36 -04:00
|
|
|
#ifndef _LINUX_VIRTIO_CONFIG_H
|
|
|
|
#define _LINUX_VIRTIO_CONFIG_H
|
|
|
|
/* 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
|
|
|
|
|
|
|
|
#ifdef __KERNEL__
|
|
|
|
struct virtio_device;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* virtio_config_ops - operations for configuring a virtio device
|
2008-02-04 23:49:56 -05:00
|
|
|
* @feature: search for a feature in this config
|
2007-10-21 21:03:36 -04:00
|
|
|
* vdev: the virtio_device
|
2008-02-04 23:49:56 -05:00
|
|
|
* bit: the feature bit
|
|
|
|
* Returns true if the feature is supported. Acknowledges the feature
|
|
|
|
* so the host can see it.
|
|
|
|
* @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
|
2007-10-21 21:03:36 -04:00
|
|
|
* Note that contents are conventionally little-endian.
|
2008-02-04 23:49:56 -05:00
|
|
|
* @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
|
|
|
* Note that contents are conventionally little-endian.
|
|
|
|
* @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().
|
|
|
|
*/
|
|
|
|
struct virtio_config_ops
|
|
|
|
{
|
2008-02-04 23:49:56 -05:00
|
|
|
bool (*feature)(struct virtio_device *vdev, unsigned bit);
|
|
|
|
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-02-04 23:49:56 -05:00
|
|
|
* virtio_config_val - look for a feature and get a single virtio config.
|
|
|
|
* @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
|
|
|
|
* the value is endian-corrected and returned in v. */
|
|
|
|
#define virtio_config_val(vdev, fbit, offset, v) ({ \
|
|
|
|
int _err; \
|
|
|
|
if ((vdev)->config->feature((vdev), (fbit))) { \
|
|
|
|
__virtio_config_val((vdev), (offset), (v)); \
|
|
|
|
_err = 0; \
|
|
|
|
} else \
|
|
|
|
_err = -ENOENT; \
|
2007-10-21 21:03:36 -04:00
|
|
|
_err; \
|
|
|
|
})
|
|
|
|
|
|
|
|
/**
|
2008-02-04 23:49:56 -05:00
|
|
|
* __virtio_config_val - get a single virtio config without feature check.
|
|
|
|
* @vdev: the virtio device
|
|
|
|
* @offset: the type to search for.
|
|
|
|
* @val: a pointer to the value to fill in.
|
2007-10-21 21:03:36 -04:00
|
|
|
*
|
2008-02-04 23:49:56 -05:00
|
|
|
* The value is endian-corrected and returned in v. */
|
|
|
|
#define __virtio_config_val(vdev, offset, v) do { \
|
|
|
|
BUILD_BUG_ON(sizeof(*(v)) != 1 && sizeof(*(v)) != 2 \
|
|
|
|
&& sizeof(*(v)) != 4 && sizeof(*(v)) != 8); \
|
|
|
|
(vdev)->config->get((vdev), (offset), (v), sizeof(*(v))); \
|
|
|
|
switch (sizeof(*(v))) { \
|
|
|
|
case 2: le16_to_cpus((__u16 *) v); break; \
|
|
|
|
case 4: le32_to_cpus((__u32 *) v); break; \
|
|
|
|
case 8: le64_to_cpus((__u64 *) v); break; \
|
|
|
|
} \
|
|
|
|
} while(0)
|
2007-10-21 21:03:36 -04:00
|
|
|
#endif /* __KERNEL__ */
|
|
|
|
#endif /* _LINUX_VIRTIO_CONFIG_H */
|