[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;
    bool broken; /* device in invalid state, needs reset */
    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);

void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3);

/* 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_detach_element(VirtQueue *vq, const VirtQueueElement *elem,
                              unsigned int len);
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);

extern const VMStateInfo virtio_vmstate_info;

#ifdef VMSTATE_VIRTIO_DEVICE_USE_NEW

#define VMSTATE_VIRTIO_DEVICE \
    {                                         \
        .name = "virtio",                     \
        .info = &virtio_vmstate_info,         \
        .flags = VMS_SINGLE,                  \
    }

#else
/* TODO remove conditional as soon as all users are converted */

#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()             \
        }                                     \
    }

#endif

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	89	bool vm_running;
f5ed3663	90	bool broken; /* device in invalid state, needs reset */
85cf2a8d	91	VMChangeStateEntry *vmstate;
1034e9cf	92	char *bus_name;
616a6552	93	uint8_t device_endian;
5669655a	94	bool use_guest_notifier_mask;
850d0070	95	QLIST_HEAD(, VirtQueue) *vector_queues;
967f97fa AL	96	};
967f97fa AL	97
8e05db92	98	typedef struct VirtioDeviceClass {
0ba94b6f	99	/< private >/
8e05db92	100	DeviceClass parent;
0ba94b6f	101	/< public >/
1d244b42 AF	102
1d244b42 AF	103	/* This is what a VirtioDevice must implement */
1d244b42	104	DeviceRealize realize;
306ec6c3	105	DeviceUnrealize unrealize;
9d5b731d JW	106	uint64_t (get_features)(VirtIODevice vdev,
	107	uint64_t requested_features,
	108	Error **errp);
019a3edb	109	uint64_t (bad_features)(VirtIODevice vdev);
d5aaa1b0	110	void (set_features)(VirtIODevice vdev, uint64_t val);
0b352fd6	111	int (validate_features)(VirtIODevice vdev);
8e05db92 FK	112	void (get_config)(VirtIODevice vdev, uint8_t *config);
	113	void (set_config)(VirtIODevice vdev, const uint8_t *config);
	114	void (reset)(VirtIODevice vdev);
	115	void (set_status)(VirtIODevice vdev, uint8_t val);
6a87acf7 FK	116	/* Test and clear event pending status.
	117	* Should be called after unmask to avoid losing events.
	118	* If backend does not support masking,
	119	* must check in frontend instead.
	120	*/
	121	bool (guest_notifier_pending)(VirtIODevice vdev, int n);
	122	/* Mask/unmask events from this vq. Any events reported
	123	* while masked will become pending.
	124	* If backend does not support masking,
	125	* must mask in frontend instead.
	126	*/
	127	void (guest_notifier_mask)(VirtIODevice vdev, int n, bool mask);
1b5fc0de GK	128	void (save)(VirtIODevice vdev, QEMUFile *f);
1b5fc0de GK	129	int (load)(VirtIODevice vdev, QEMUFile *f, int version_id);
8e05db92 FK	130	} VirtioDeviceClass;
8e05db92 FK	131
c8075caf GA	132	void virtio_instance_init_common(Object proxy_obj, void data,
	133	size_t vdev_size, const char *vdev_name);
	134
8e05db92 FK	135	void virtio_init(VirtIODevice vdev, const char name,
8e05db92 FK	136	uint16_t device_id, size_t config_size);
6a1a8cc7	137	void virtio_cleanup(VirtIODevice *vdev);
8e05db92	138
f5ed3663 SH	139	void virtio_error(VirtIODevice vdev, const char fmt, ...) GCC_FMT_ATTR(2, 3);
f5ed3663 SH	140
1034e9cf FK	141	/* Set the child bus name. */
	142	void virtio_device_set_child_bus_name(VirtIODevice vdev, char bus_name);
	143
bf1780b0 FZ	144	typedef void (VirtIOHandleOutput)(VirtIODevice , VirtQueue *);
bf1780b0 FZ	145
967f97fa	146	VirtQueue virtio_add_queue(VirtIODevice vdev, int queue_size,
bf1780b0	147	VirtIOHandleOutput handle_output);
967f97fa	148
872dd82c FZ	149	VirtQueue virtio_add_queue_aio(VirtIODevice vdev, int queue_size,
	150	VirtIOHandleOutput handle_output);
	151
f23fd811 JW	152	void virtio_del_queue(VirtIODevice *vdev, int n);
f23fd811 JW	153
3724650d	154	void *virtqueue_alloc_element(size_t sz, unsigned out_num, unsigned in_num);
967f97fa AL	155	void virtqueue_push(VirtQueue vq, const VirtQueueElement elem,
	156	unsigned int len);
	157	void virtqueue_flush(VirtQueue *vq, unsigned int count);
2640d2a5 SH	158	void virtqueue_detach_element(VirtQueue vq, const VirtQueueElement elem,
2640d2a5 SH	159	unsigned int len);
29b9f5ef JW	160	void virtqueue_discard(VirtQueue vq, const VirtQueueElement elem,
29b9f5ef JW	161	unsigned int len);
297a75e6	162	bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
967f97fa AL	163	void virtqueue_fill(VirtQueue vq, const VirtQueueElement elem,
	164	unsigned int len, unsigned int idx);
	165
8059feee	166	void virtqueue_map(VirtQueueElement *elem);
51b19ebe	167	void virtqueue_pop(VirtQueue vq, size_t sz);
ab281c17 PB	168	void qemu_get_virtqueue_element(QEMUFile f, size_t sz);
ab281c17 PB	169	void qemu_put_virtqueue_element(QEMUFile f, VirtQueueElement elem);
0d8d7690 AS	170	int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
	171	unsigned int out_bytes);
	172	void virtqueue_get_avail_bytes(VirtQueue vq, unsigned int in_bytes,
e1f7b481 MT	173	unsigned int *out_bytes,
e1f7b481 MT	174	unsigned max_in_bytes, unsigned max_out_bytes);
967f97fa	175
adb3feda	176	bool virtio_should_notify(VirtIODevice vdev, VirtQueue vq);
967f97fa AL	177	void virtio_notify(VirtIODevice vdev, VirtQueue vq);
	178
	179	void virtio_save(VirtIODevice vdev, QEMUFile f);
5943124c DDAG	180	void virtio_vmstate_save(QEMUFile f, void opaque, size_t size);
5943124c DDAG	181
1a665855 HP	182	extern const VMStateInfo virtio_vmstate_info;
	183
	184	#ifdef VMSTATE_VIRTIO_DEVICE_USE_NEW
	185
	186	#define VMSTATE_VIRTIO_DEVICE \
	187	{ \
	188	.name = "virtio", \
	189	.info = &virtio_vmstate_info, \
	190	.flags = VMS_SINGLE, \
	191	}
	192
	193	#else
	194	/* TODO remove conditional as soon as all users are converted */
	195
5943124c DDAG	196	#define VMSTATE_VIRTIO_DEVICE(devname, v, getf, putf) \
	197	static const VMStateDescription vmstate_virtio_ ## devname = { \
	198	.name = "virtio-" #devname , \
	199	.minimum_version_id = v, \
	200	.version_id = v, \
	201	.fields = (VMStateField[]) { \
	202	{ \
	203	.name = "virtio", \
	204	.info = &(const VMStateInfo) {\
	205	.name = "virtio", \
	206	.get = getf, \
	207	.put = putf, \
	208	}, \
	209	.flags = VMS_SINGLE, \
	210	}, \
	211	VMSTATE_END_OF_LIST() \
	212	} \
	213	}
967f97fa	214
1a665855 HP	215	#endif
1a665855 HP	216
1b5fc0de	217	int virtio_load(VirtIODevice vdev, QEMUFile f, int version_id);
967f97fa AL	218
	219	void virtio_notify_config(VirtIODevice *vdev);
	220
	221	void virtio_queue_set_notification(VirtQueue *vq, int enable);
	222
	223	int virtio_queue_ready(VirtQueue *vq);
	224
	225	int virtio_queue_empty(VirtQueue *vq);
	226
53c25cea PB	227	/* Host binding interface. */
53c25cea PB	228
53c25cea PB	229	uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
	230	uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
	231	uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
	232	void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
	233	void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
	234	void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
adfb743c MT	235	uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
	236	uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
	237	uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
	238	void virtio_config_modern_writeb(VirtIODevice *vdev,
	239	uint32_t addr, uint32_t data);
	240	void virtio_config_modern_writew(VirtIODevice *vdev,
	241	uint32_t addr, uint32_t data);
	242	void virtio_config_modern_writel(VirtIODevice *vdev,
	243	uint32_t addr, uint32_t data);
a8170e5e AK	244	void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
a8170e5e AK	245	hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
e63c0ba1	246	void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
53c25cea	247	int virtio_queue_get_num(VirtIODevice *vdev, int n);
8ad176aa	248	int virtio_get_num_queues(VirtIODevice *vdev);
ab223c95 CH	249	void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
	250	hwaddr avail, hwaddr used);
	251	void virtio_queue_update_rings(VirtIODevice *vdev, int n);
6ce69d1c	252	void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
53c25cea	253	void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687 MT	254	uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
7055e687 MT	255	void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
0b352fd6	256	int virtio_set_status(VirtIODevice *vdev, uint8_t val);
53c25cea PB	257	void virtio_reset(void *opaque);
53c25cea PB	258	void virtio_update_irq(VirtIODevice *vdev);
d5aaa1b0	259	int virtio_set_features(VirtIODevice *vdev, uint64_t val);
53c25cea	260
53c25cea	261	/* Base devices. */
12c5674b	262	typedef struct VirtIOBlkConf VirtIOBlkConf;
f0c07c7c	263	struct virtio_net_conf;
6b331efb	264	typedef struct virtio_serial_conf virtio_serial_conf;
f73ddbad	265	typedef struct virtio_input_conf virtio_input_conf;
973abc7f	266	typedef struct VirtIOSCSIConf VirtIOSCSIConf;
16c915ba	267	typedef struct VirtIORNGConf VirtIORNGConf;
97b15621	268
8172539d	269	#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
019a3edb GH	270	DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
	271	VIRTIO_RING_F_INDIRECT_DESC, true), \
	272	DEFINE_PROP_BIT64("event_idx", _state, _field, \
	273	VIRTIO_RING_F_EVENT_IDX, true), \
	274	DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
09999a5f MT	275	VIRTIO_F_NOTIFY_ON_EMPTY, true), \
	276	DEFINE_PROP_BIT64("any_layout", _state, _field, \
	277	VIRTIO_F_ANY_LAYOUT, true)
8172539d	278
a8170e5e AK	279	hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
	280	hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
	281	hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
	282	hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
	283	hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
	284	hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
	285	hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
	286	hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
1cbdabe2 MT	287	uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
1cbdabe2 MT	288	void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
6793dfd1	289	void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
1cbdabe2	290	VirtQueue virtio_get_queue(VirtIODevice vdev, int n);
e78a2b42	291	uint16_t virtio_get_queue_index(VirtQueue *vq);
1cbdabe2	292	EventNotifier virtio_queue_get_guest_notifier(VirtQueue vq);
15b2bd18 PB	293	void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
15b2bd18 PB	294	bool with_irqfd);
1cbdabe2	295	EventNotifier virtio_queue_get_host_notifier(VirtQueue vq);
26b9b5fe PB	296	void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
26b9b5fe PB	297	bool set_handler);
a1afb606	298	void virtio_queue_aio_set_host_notifier_handler(VirtQueue vq, AioContext ctx,
a378b49a PB	299	void (fn)(VirtIODevice ,
a378b49a PB	300	VirtQueue *));
1cbdabe2	301	void virtio_irq(VirtQueue *vq);
e0d686bf JW	302	VirtQueue virtio_vector_first_queue(VirtIODevice vdev, uint16_t vector);
e0d686bf JW	303	VirtQueue virtio_vector_next_queue(VirtQueue vq);
98ed8ecf	304
019a3edb	305	static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
0cd09c3a	306	{
019a3edb	307	assert(fbit < 64);
d5aaa1b0	308	*features \|= (1ULL << fbit);
0cd09c3a CH	309	}
0cd09c3a CH	310
019a3edb	311	static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
0cd09c3a	312	{
019a3edb	313	assert(fbit < 64);
d5aaa1b0	314	*features &= ~(1ULL << fbit);
0cd09c3a CH	315	}
0cd09c3a CH	316
95129d6f	317	static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
ef546f12	318	{
019a3edb	319	assert(fbit < 64);
d5aaa1b0	320	return !!(features & (1ULL << fbit));
ef546f12 CH	321	}
ef546f12 CH	322
95129d6f CH	323	static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
95129d6f CH	324	unsigned int fbit)
ef546f12	325	{
95129d6f	326	return virtio_has_feature(vdev->guest_features, fbit);
ef546f12 CH	327	}
ef546f12 CH	328
74aae7b2 JW	329	static inline bool virtio_host_has_feature(VirtIODevice *vdev,
	330	unsigned int fbit)
	331	{
95129d6f	332	return virtio_has_feature(vdev->host_features, fbit);
74aae7b2 JW	333	}
74aae7b2 JW	334
616a6552	335	static inline bool virtio_is_big_endian(VirtIODevice *vdev)
98ed8ecf	336	{
95129d6f	337	if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
3c185597 CH	338	assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
	339	return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
	340	}
	341	/* Devices conforming to VIRTIO 1.0 or later are always LE. */
	342	return false;
98ed8ecf	343	}
967f97fa	344	#endif