[mirror_qemu.git] / include / hw / virtio / virtio.h

/*
 * Virtio Support
 *
 * Copyright IBM, Corp. 2007
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2.  See
 * the COPYING file in the top-level directory.
 *
 */

#ifndef QEMU_VIRTIO_H
#define QEMU_VIRTIO_H

#include "hw/hw.h"
#include "net/net.h"
#include "hw/qdev.h"
#include "sysemu/sysemu.h"
#include "qemu/event_notifier.h"
#include "standard-headers/linux/virtio_config.h"
#include "standard-headers/linux/virtio_ring.h"

/* A guest should never accept this.  It implies negotiation is broken. */
#define VIRTIO_F_BAD_FEATURE		30

#define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \
                                (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \
                                (0x1ULL << VIRTIO_F_ANY_LAYOUT))

struct VirtQueue;

static inline hwaddr vring_align(hwaddr addr,
                                             unsigned long align)
{
    return (addr + align - 1) & ~(align - 1);
}

typedef struct VirtQueue VirtQueue;

#define VIRTQUEUE_MAX_SIZE 1024

typedef struct VirtQueueElement
{
    unsigned int index;
    unsigned int out_num;
    unsigned int in_num;
    hwaddr *in_addr;
    hwaddr *out_addr;
    struct iovec *in_sg;
    struct iovec *out_sg;
} VirtQueueElement;

#define VIRTIO_QUEUE_MAX 1024

#define VIRTIO_NO_VECTOR 0xffff

#define TYPE_VIRTIO_DEVICE "virtio-device"
#define VIRTIO_DEVICE_GET_CLASS(obj) \
        OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
#define VIRTIO_DEVICE_CLASS(klass) \
        OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
#define VIRTIO_DEVICE(obj) \
        OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)

enum virtio_device_endian {
    VIRTIO_DEVICE_ENDIAN_UNKNOWN,
    VIRTIO_DEVICE_ENDIAN_LITTLE,
    VIRTIO_DEVICE_ENDIAN_BIG,
};

struct VirtIODevice
{
    DeviceState parent_obj;
    const char *name;
    uint8_t status;
    uint8_t isr;
    uint16_t queue_sel;
    uint64_t guest_features;
    uint64_t host_features;
    size_t config_len;
    void *config;
    uint16_t config_vector;
    uint32_t generation;
    int nvectors;
    VirtQueue *vq;
    uint16_t device_id;
    bool vm_running;
    VMChangeStateEntry *vmstate;
    char *bus_name;
    uint8_t device_endian;
    bool use_guest_notifier_mask;
    QLIST_HEAD(, VirtQueue) *vector_queues;
};

typedef struct VirtioDeviceClass {
    /*< private >*/
    DeviceClass parent;
    /*< public >*/

    /* This is what a VirtioDevice must implement */
    DeviceRealize realize;
    DeviceUnrealize unrealize;
    uint64_t (*get_features)(VirtIODevice *vdev,
                             uint64_t requested_features,
                             Error **errp);
    uint64_t (*bad_features)(VirtIODevice *vdev);
    void (*set_features)(VirtIODevice *vdev, uint64_t val);
    int (*validate_features)(VirtIODevice *vdev);
    void (*get_config)(VirtIODevice *vdev, uint8_t *config);
    void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
    void (*reset)(VirtIODevice *vdev);
    void (*set_status)(VirtIODevice *vdev, uint8_t val);
    /* Test and clear event pending status.
     * Should be called after unmask to avoid losing events.
     * If backend does not support masking,
     * must check in frontend instead.
     */
    bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
    /* Mask/unmask events from this vq. Any events reported
     * while masked will become pending.
     * If backend does not support masking,
     * must mask in frontend instead.
     */
    void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
    void (*save)(VirtIODevice *vdev, QEMUFile *f);
    int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
} VirtioDeviceClass;

void virtio_instance_init_common(Object *proxy_obj, void *data,
                                 size_t vdev_size, const char *vdev_name);

void virtio_init(VirtIODevice *vdev, const char *name,
                         uint16_t device_id, size_t config_size);
void virtio_cleanup(VirtIODevice *vdev);

/* Set the child bus name. */
void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);

typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *);

VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
                            VirtIOHandleOutput handle_output);

VirtQueue *virtio_add_queue_aio(VirtIODevice *vdev, int queue_size,
                                VirtIOHandleOutput handle_output);

void virtio_del_queue(VirtIODevice *vdev, int n);

void *virtqueue_alloc_element(size_t sz, unsigned out_num, unsigned in_num);
void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
                    unsigned int len);
void virtqueue_flush(VirtQueue *vq, unsigned int count);
void virtqueue_discard(VirtQueue *vq, const VirtQueueElement *elem,
                       unsigned int len);
bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
                    unsigned int len, unsigned int idx);

void virtqueue_map(VirtQueueElement *elem);
void *virtqueue_pop(VirtQueue *vq, size_t sz);
void *qemu_get_virtqueue_element(QEMUFile *f, size_t sz);
void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem);
int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
                          unsigned int out_bytes);
void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
                               unsigned int *out_bytes,
                               unsigned max_in_bytes, unsigned max_out_bytes);

bool virtio_should_notify(VirtIODevice *vdev, VirtQueue *vq);
void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);

void virtio_save(VirtIODevice *vdev, QEMUFile *f);
void virtio_vmstate_save(QEMUFile *f, void *opaque, size_t size);

#define VMSTATE_VIRTIO_DEVICE(devname, v, getf, putf) \
    static const VMStateDescription vmstate_virtio_ ## devname = { \
        .name = "virtio-" #devname ,          \
        .minimum_version_id = v,              \
        .version_id = v,                      \
        .fields = (VMStateField[]) {          \
            {                                 \
                .name = "virtio",             \
                .info = &(const VMStateInfo) {\
                        .name = "virtio",     \
                        .get = getf,          \
                        .put = putf,          \
                    },                        \
                .flags = VMS_SINGLE,          \
            },                                \
            VMSTATE_END_OF_LIST()             \
        }                                     \
    }

int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);

void virtio_notify_config(VirtIODevice *vdev);

void virtio_queue_set_notification(VirtQueue *vq, int enable);

int virtio_queue_ready(VirtQueue *vq);

int virtio_queue_empty(VirtQueue *vq);

/* Host binding interface.  */

uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
void virtio_config_modern_writeb(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data);
void virtio_config_modern_writew(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data);
void virtio_config_modern_writel(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data);
void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
int virtio_queue_get_num(VirtIODevice *vdev, int n);
int virtio_get_num_queues(VirtIODevice *vdev);
void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
                            hwaddr avail, hwaddr used);
void virtio_queue_update_rings(VirtIODevice *vdev, int n);
void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
void virtio_queue_notify(VirtIODevice *vdev, int n);
uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
int virtio_set_status(VirtIODevice *vdev, uint8_t val);
void virtio_reset(void *opaque);
void virtio_update_irq(VirtIODevice *vdev);
int virtio_set_features(VirtIODevice *vdev, uint64_t val);

/* Base devices.  */
typedef struct VirtIOBlkConf VirtIOBlkConf;
struct virtio_net_conf;
typedef struct virtio_serial_conf virtio_serial_conf;
typedef struct virtio_input_conf virtio_input_conf;
typedef struct VirtIOSCSIConf VirtIOSCSIConf;
typedef struct VirtIORNGConf VirtIORNGConf;

#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
    DEFINE_PROP_BIT64("indirect_desc", _state, _field,    \
                      VIRTIO_RING_F_INDIRECT_DESC, true), \
    DEFINE_PROP_BIT64("event_idx", _state, _field,        \
                      VIRTIO_RING_F_EVENT_IDX, true),     \
    DEFINE_PROP_BIT64("notify_on_empty", _state, _field,  \
                      VIRTIO_F_NOTIFY_ON_EMPTY, true), \
    DEFINE_PROP_BIT64("any_layout", _state, _field, \
                      VIRTIO_F_ANY_LAYOUT, true)

hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
uint16_t virtio_get_queue_index(VirtQueue *vq);
EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
                                                bool with_irqfd);
EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
                                               bool set_handler);
void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx,
                                                void (*fn)(VirtIODevice *,
                                                           VirtQueue *));
void virtio_irq(VirtQueue *vq);
VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
VirtQueue *virtio_vector_next_queue(VirtQueue *vq);

static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
{
    assert(fbit < 64);
    *features |= (1ULL << fbit);
}

static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
{
    assert(fbit < 64);
    *features &= ~(1ULL << fbit);
}

static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
{
    assert(fbit < 64);
    return !!(features & (1ULL << fbit));
}

static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
                                           unsigned int fbit)
{
    return virtio_has_feature(vdev->guest_features, fbit);
}

static inline bool virtio_host_has_feature(VirtIODevice *vdev,
                                           unsigned int fbit)
{
    return virtio_has_feature(vdev->host_features, fbit);
}

static inline bool virtio_is_big_endian(VirtIODevice *vdev)
{
    if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
        assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
        return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
    }
    /* Devices conforming to VIRTIO 1.0 or later are always LE. */
    return false;
}
#endif
Commit	Line	Data
967f97fa AL	1	/*
	2	* Virtio Support
	3	*
	4	* Copyright IBM, Corp. 2007
	5	*
	6	* Authors:
	7	* Anthony Liguori <aliguori@us.ibm.com>
	8	*
	9	* This work is licensed under the terms of the GNU GPL, version 2. See
	10	* the COPYING file in the top-level directory.
	11	*
	12	*/
	13
2a6a4076 MA	14	#ifndef QEMU_VIRTIO_H
2a6a4076 MA	15	#define QEMU_VIRTIO_H
967f97fa	16
83c9f4ca	17	#include "hw/hw.h"
1422e32d	18	#include "net/net.h"
83c9f4ca	19	#include "hw/qdev.h"
9c17d615	20	#include "sysemu/sysemu.h"
1de7afc9	21	#include "qemu/event_notifier.h"
e9600c6c MT	22	#include "standard-headers/linux/virtio_config.h"
e9600c6c MT	23	#include "standard-headers/linux/virtio_ring.h"
967f97fa	24
8eca6b1b AL	25	/* A guest should never accept this. It implies negotiation is broken. */
8eca6b1b AL	26	#define VIRTIO_F_BAD_FEATURE 30
967f97fa	27
5f456073 MT	28	#define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) \| \
	29	(0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) \| \
	30	(0x1ULL << VIRTIO_F_ANY_LAYOUT))
	31
967f97fa AL	32	struct VirtQueue;
967f97fa AL	33
a8170e5e	34	static inline hwaddr vring_align(hwaddr addr,
f46f15bc AL	35	unsigned long align)
	36	{
	37	return (addr + align - 1) & ~(align - 1);
	38	}
	39
967f97fa	40	typedef struct VirtQueue VirtQueue;
967f97fa AL	41
	42	#define VIRTQUEUE_MAX_SIZE 1024
	43
	44	typedef struct VirtQueueElement
	45	{
	46	unsigned int index;
	47	unsigned int out_num;
	48	unsigned int in_num;
3724650d PB	49	hwaddr *in_addr;
	50	hwaddr *out_addr;
	51	struct iovec *in_sg;
	52	struct iovec *out_sg;
967f97fa AL	53	} VirtQueueElement;
967f97fa AL	54
b829c2a9	55	#define VIRTIO_QUEUE_MAX 1024
967f97fa	56
7055e687 MT	57	#define VIRTIO_NO_VECTOR 0xffff
7055e687 MT	58
8e05db92 FK	59	#define TYPE_VIRTIO_DEVICE "virtio-device"
	60	#define VIRTIO_DEVICE_GET_CLASS(obj) \
	61	OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
	62	#define VIRTIO_DEVICE_CLASS(klass) \
	63	OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
	64	#define VIRTIO_DEVICE(obj) \
	65	OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
	66
616a6552 GK	67	enum virtio_device_endian {
	68	VIRTIO_DEVICE_ENDIAN_UNKNOWN,
	69	VIRTIO_DEVICE_ENDIAN_LITTLE,
	70	VIRTIO_DEVICE_ENDIAN_BIG,
	71	};
	72
967f97fa AL	73	struct VirtIODevice
967f97fa AL	74	{
8e05db92	75	DeviceState parent_obj;
967f97fa	76	const char *name;
967f97fa AL	77	uint8_t status;
	78	uint8_t isr;
	79	uint16_t queue_sel;
019a3edb GH	80	uint64_t guest_features;
019a3edb GH	81	uint64_t host_features;
967f97fa AL	82	size_t config_len;
967f97fa AL	83	void *config;
7055e687	84	uint16_t config_vector;
b8f05908	85	uint32_t generation;
7055e687	86	int nvectors;
967f97fa	87	VirtQueue *vq;
53c25cea	88	uint16_t device_id;
85cf2a8d MT	89	bool vm_running;
85cf2a8d MT	90	VMChangeStateEntry *vmstate;
1034e9cf	91	char *bus_name;
616a6552	92	uint8_t device_endian;
5669655a	93	bool use_guest_notifier_mask;
850d0070	94	QLIST_HEAD(, VirtQueue) *vector_queues;
967f97fa AL	95	};
967f97fa AL	96
8e05db92	97	typedef struct VirtioDeviceClass {
0ba94b6f	98	/< private >/
8e05db92	99	DeviceClass parent;
0ba94b6f	100	/< public >/
1d244b42 AF	101
1d244b42 AF	102	/* This is what a VirtioDevice must implement */
1d244b42	103	DeviceRealize realize;
306ec6c3	104	DeviceUnrealize unrealize;
9d5b731d JW	105	uint64_t (get_features)(VirtIODevice vdev,
	106	uint64_t requested_features,
	107	Error **errp);
019a3edb	108	uint64_t (bad_features)(VirtIODevice vdev);
d5aaa1b0	109	void (set_features)(VirtIODevice vdev, uint64_t val);
0b352fd6	110	int (validate_features)(VirtIODevice vdev);
8e05db92 FK	111	void (get_config)(VirtIODevice vdev, uint8_t *config);
	112	void (set_config)(VirtIODevice vdev, const uint8_t *config);
	113	void (reset)(VirtIODevice vdev);
	114	void (set_status)(VirtIODevice vdev, uint8_t val);
6a87acf7 FK	115	/* Test and clear event pending status.
	116	* Should be called after unmask to avoid losing events.
	117	* If backend does not support masking,
	118	* must check in frontend instead.
	119	*/
	120	bool (guest_notifier_pending)(VirtIODevice vdev, int n);
	121	/* Mask/unmask events from this vq. Any events reported
	122	* while masked will become pending.
	123	* If backend does not support masking,
	124	* must mask in frontend instead.
	125	*/
	126	void (guest_notifier_mask)(VirtIODevice vdev, int n, bool mask);
1b5fc0de GK	127	void (save)(VirtIODevice vdev, QEMUFile *f);
1b5fc0de GK	128	int (load)(VirtIODevice vdev, QEMUFile *f, int version_id);
8e05db92 FK	129	} VirtioDeviceClass;
8e05db92 FK	130
c8075caf GA	131	void virtio_instance_init_common(Object proxy_obj, void data,
	132	size_t vdev_size, const char *vdev_name);
	133
8e05db92 FK	134	void virtio_init(VirtIODevice vdev, const char name,
8e05db92 FK	135	uint16_t device_id, size_t config_size);
6a1a8cc7	136	void virtio_cleanup(VirtIODevice *vdev);
8e05db92	137
1034e9cf FK	138	/* Set the child bus name. */
	139	void virtio_device_set_child_bus_name(VirtIODevice vdev, char bus_name);
	140
bf1780b0 FZ	141	typedef void (VirtIOHandleOutput)(VirtIODevice , VirtQueue *);
bf1780b0 FZ	142
967f97fa	143	VirtQueue virtio_add_queue(VirtIODevice vdev, int queue_size,
bf1780b0	144	VirtIOHandleOutput handle_output);
967f97fa	145
872dd82c FZ	146	VirtQueue virtio_add_queue_aio(VirtIODevice vdev, int queue_size,
	147	VirtIOHandleOutput handle_output);
	148
f23fd811 JW	149	void virtio_del_queue(VirtIODevice *vdev, int n);
f23fd811 JW	150
3724650d	151	void *virtqueue_alloc_element(size_t sz, unsigned out_num, unsigned in_num);
967f97fa AL	152	void virtqueue_push(VirtQueue vq, const VirtQueueElement elem,
	153	unsigned int len);
	154	void virtqueue_flush(VirtQueue *vq, unsigned int count);
29b9f5ef JW	155	void virtqueue_discard(VirtQueue vq, const VirtQueueElement elem,
29b9f5ef JW	156	unsigned int len);
297a75e6	157	bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
967f97fa AL	158	void virtqueue_fill(VirtQueue vq, const VirtQueueElement elem,
	159	unsigned int len, unsigned int idx);
	160
8059feee	161	void virtqueue_map(VirtQueueElement *elem);
51b19ebe	162	void virtqueue_pop(VirtQueue vq, size_t sz);
ab281c17 PB	163	void qemu_get_virtqueue_element(QEMUFile f, size_t sz);
ab281c17 PB	164	void qemu_put_virtqueue_element(QEMUFile f, VirtQueueElement elem);
0d8d7690 AS	165	int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
	166	unsigned int out_bytes);
	167	void virtqueue_get_avail_bytes(VirtQueue vq, unsigned int in_bytes,
e1f7b481 MT	168	unsigned int *out_bytes,
e1f7b481 MT	169	unsigned max_in_bytes, unsigned max_out_bytes);
967f97fa	170
adb3feda	171	bool virtio_should_notify(VirtIODevice vdev, VirtQueue vq);
967f97fa AL	172	void virtio_notify(VirtIODevice vdev, VirtQueue vq);
	173
	174	void virtio_save(VirtIODevice vdev, QEMUFile f);
5943124c DDAG	175	void virtio_vmstate_save(QEMUFile f, void opaque, size_t size);
	176
	177	#define VMSTATE_VIRTIO_DEVICE(devname, v, getf, putf) \
	178	static const VMStateDescription vmstate_virtio_ ## devname = { \
	179	.name = "virtio-" #devname , \
	180	.minimum_version_id = v, \
	181	.version_id = v, \
	182	.fields = (VMStateField[]) { \
	183	{ \
	184	.name = "virtio", \
	185	.info = &(const VMStateInfo) {\
	186	.name = "virtio", \
	187	.get = getf, \
	188	.put = putf, \
	189	}, \
	190	.flags = VMS_SINGLE, \
	191	}, \
	192	VMSTATE_END_OF_LIST() \
	193	} \
	194	}
967f97fa	195
1b5fc0de	196	int virtio_load(VirtIODevice vdev, QEMUFile f, int version_id);
967f97fa AL	197
	198	void virtio_notify_config(VirtIODevice *vdev);
	199
	200	void virtio_queue_set_notification(VirtQueue *vq, int enable);
	201
	202	int virtio_queue_ready(VirtQueue *vq);
	203
	204	int virtio_queue_empty(VirtQueue *vq);
	205
53c25cea PB	206	/* Host binding interface. */
53c25cea PB	207
53c25cea PB	208	uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
	209	uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
	210	uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
	211	void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
	212	void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
	213	void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
adfb743c MT	214	uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
	215	uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
	216	uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
	217	void virtio_config_modern_writeb(VirtIODevice *vdev,
	218	uint32_t addr, uint32_t data);
	219	void virtio_config_modern_writew(VirtIODevice *vdev,
	220	uint32_t addr, uint32_t data);
	221	void virtio_config_modern_writel(VirtIODevice *vdev,
	222	uint32_t addr, uint32_t data);
a8170e5e AK	223	void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
a8170e5e AK	224	hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
e63c0ba1	225	void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
53c25cea	226	int virtio_queue_get_num(VirtIODevice *vdev, int n);
8ad176aa	227	int virtio_get_num_queues(VirtIODevice *vdev);
ab223c95 CH	228	void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
	229	hwaddr avail, hwaddr used);
	230	void virtio_queue_update_rings(VirtIODevice *vdev, int n);
6ce69d1c	231	void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
53c25cea	232	void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687 MT	233	uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
7055e687 MT	234	void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
0b352fd6	235	int virtio_set_status(VirtIODevice *vdev, uint8_t val);
53c25cea PB	236	void virtio_reset(void *opaque);
53c25cea PB	237	void virtio_update_irq(VirtIODevice *vdev);
d5aaa1b0	238	int virtio_set_features(VirtIODevice *vdev, uint64_t val);
53c25cea	239
53c25cea	240	/* Base devices. */
12c5674b	241	typedef struct VirtIOBlkConf VirtIOBlkConf;
f0c07c7c	242	struct virtio_net_conf;
6b331efb	243	typedef struct virtio_serial_conf virtio_serial_conf;
f73ddbad	244	typedef struct virtio_input_conf virtio_input_conf;
973abc7f	245	typedef struct VirtIOSCSIConf VirtIOSCSIConf;
16c915ba	246	typedef struct VirtIORNGConf VirtIORNGConf;
97b15621	247
8172539d	248	#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
019a3edb GH	249	DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
	250	VIRTIO_RING_F_INDIRECT_DESC, true), \
	251	DEFINE_PROP_BIT64("event_idx", _state, _field, \
	252	VIRTIO_RING_F_EVENT_IDX, true), \
	253	DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
09999a5f MT	254	VIRTIO_F_NOTIFY_ON_EMPTY, true), \
	255	DEFINE_PROP_BIT64("any_layout", _state, _field, \
	256	VIRTIO_F_ANY_LAYOUT, true)
8172539d	257
a8170e5e AK	258	hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
	259	hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
	260	hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
	261	hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
	262	hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
	263	hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
	264	hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
	265	hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
1cbdabe2 MT	266	uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
1cbdabe2 MT	267	void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
6793dfd1	268	void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
1cbdabe2	269	VirtQueue virtio_get_queue(VirtIODevice vdev, int n);
e78a2b42	270	uint16_t virtio_get_queue_index(VirtQueue *vq);
1cbdabe2	271	EventNotifier virtio_queue_get_guest_notifier(VirtQueue vq);
15b2bd18 PB	272	void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
15b2bd18 PB	273	bool with_irqfd);
1cbdabe2	274	EventNotifier virtio_queue_get_host_notifier(VirtQueue vq);
26b9b5fe PB	275	void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
26b9b5fe PB	276	bool set_handler);
a1afb606	277	void virtio_queue_aio_set_host_notifier_handler(VirtQueue vq, AioContext ctx,
a378b49a PB	278	void (fn)(VirtIODevice ,
a378b49a PB	279	VirtQueue *));
1cbdabe2	280	void virtio_irq(VirtQueue *vq);
e0d686bf JW	281	VirtQueue virtio_vector_first_queue(VirtIODevice vdev, uint16_t vector);
e0d686bf JW	282	VirtQueue virtio_vector_next_queue(VirtQueue vq);
98ed8ecf	283
019a3edb	284	static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
0cd09c3a	285	{
019a3edb	286	assert(fbit < 64);
d5aaa1b0	287	*features \|= (1ULL << fbit);
0cd09c3a CH	288	}
0cd09c3a CH	289
019a3edb	290	static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
0cd09c3a	291	{
019a3edb	292	assert(fbit < 64);
d5aaa1b0	293	*features &= ~(1ULL << fbit);
0cd09c3a CH	294	}
0cd09c3a CH	295
95129d6f	296	static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
ef546f12	297	{
019a3edb	298	assert(fbit < 64);
d5aaa1b0	299	return !!(features & (1ULL << fbit));
ef546f12 CH	300	}
ef546f12 CH	301
95129d6f CH	302	static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
95129d6f CH	303	unsigned int fbit)
ef546f12	304	{
95129d6f	305	return virtio_has_feature(vdev->guest_features, fbit);
ef546f12 CH	306	}
ef546f12 CH	307
74aae7b2 JW	308	static inline bool virtio_host_has_feature(VirtIODevice *vdev,
	309	unsigned int fbit)
	310	{
95129d6f	311	return virtio_has_feature(vdev->host_features, fbit);
74aae7b2 JW	312	}
74aae7b2 JW	313
616a6552	314	static inline bool virtio_is_big_endian(VirtIODevice *vdev)
98ed8ecf	315	{
95129d6f	316	if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
3c185597 CH	317	assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
	318	return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
	319	}
	320	/* Devices conforming to VIRTIO 1.0 or later are always LE. */
	321	return false;
98ed8ecf	322	}
967f97fa	323	#endif