2014-09-01 14:07:54 +04:00
|
|
|
/*
|
|
|
|
* libqos virtio definitions
|
|
|
|
*
|
|
|
|
* Copyright (c) 2014 Marc Marí
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
|
|
* See the COPYING file in the top-level directory.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LIBQOS_VIRTIO_H
|
|
|
|
#define LIBQOS_VIRTIO_H
|
|
|
|
|
2022-08-24 12:40:03 +03:00
|
|
|
#include "libqos-malloc.h"
|
2016-05-09 15:47:38 +03:00
|
|
|
#include "standard-headers/linux/virtio_ring.h"
|
2014-09-01 14:07:56 +04:00
|
|
|
|
2019-10-23 13:04:12 +03:00
|
|
|
#define QVIRTIO_F_BAD_FEATURE 0x40000000ull
|
2014-09-01 14:07:57 +04:00
|
|
|
|
2016-10-17 13:30:21 +03:00
|
|
|
typedef struct QVirtioBus QVirtioBus;
|
|
|
|
|
2014-09-01 14:07:54 +04:00
|
|
|
typedef struct QVirtioDevice {
|
2016-10-17 13:30:21 +03:00
|
|
|
const QVirtioBus *bus;
|
2014-09-01 14:07:54 +04:00
|
|
|
/* Device type */
|
|
|
|
uint16_t device_type;
|
2018-07-30 23:21:42 +03:00
|
|
|
uint64_t features;
|
2018-10-07 10:37:44 +03:00
|
|
|
bool big_endian;
|
2019-10-23 13:04:16 +03:00
|
|
|
bool features_negotiated;
|
2014-09-01 14:07:54 +04:00
|
|
|
} QVirtioDevice;
|
|
|
|
|
2014-09-01 14:07:56 +04:00
|
|
|
typedef struct QVirtQueue {
|
2019-10-23 13:04:18 +03:00
|
|
|
QVirtioDevice *vdev;
|
2016-05-09 15:47:38 +03:00
|
|
|
uint64_t desc; /* This points to an array of struct vring_desc */
|
|
|
|
uint64_t avail; /* This points to a struct vring_avail */
|
2017-06-28 21:47:19 +03:00
|
|
|
uint64_t used; /* This points to a struct vring_used */
|
2014-09-01 14:07:56 +04:00
|
|
|
uint16_t index;
|
|
|
|
uint32_t size;
|
|
|
|
uint32_t free_head;
|
|
|
|
uint32_t num_free;
|
|
|
|
uint32_t align;
|
2017-06-28 21:47:20 +03:00
|
|
|
uint16_t last_used_idx;
|
2014-09-01 14:07:57 +04:00
|
|
|
bool indirect;
|
2014-09-01 14:08:00 +04:00
|
|
|
bool event;
|
2014-09-01 14:07:56 +04:00
|
|
|
} QVirtQueue;
|
|
|
|
|
2014-09-01 14:07:57 +04:00
|
|
|
typedef struct QVRingIndirectDesc {
|
2016-05-09 15:47:38 +03:00
|
|
|
uint64_t desc; /* This points to an array fo struct vring_desc */
|
2014-09-01 14:07:57 +04:00
|
|
|
uint16_t index;
|
|
|
|
uint16_t elem;
|
|
|
|
} QVRingIndirectDesc;
|
|
|
|
|
2016-10-17 13:30:21 +03:00
|
|
|
struct QVirtioBus {
|
2015-02-25 00:21:51 +03:00
|
|
|
uint8_t (*config_readb)(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint16_t (*config_readw)(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint32_t (*config_readl)(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint64_t (*config_readq)(QVirtioDevice *d, uint64_t addr);
|
2014-09-01 14:07:55 +04:00
|
|
|
|
2014-09-01 14:07:56 +04:00
|
|
|
/* Get features of the device */
|
2019-10-23 13:04:12 +03:00
|
|
|
uint64_t (*get_features)(QVirtioDevice *d);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
2014-09-01 14:07:57 +04:00
|
|
|
/* Set features of the device */
|
2019-10-23 13:04:12 +03:00
|
|
|
void (*set_features)(QVirtioDevice *d, uint64_t features);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
2014-09-01 14:07:57 +04:00
|
|
|
/* Get features of the guest */
|
2019-10-23 13:04:12 +03:00
|
|
|
uint64_t (*get_guest_features)(QVirtioDevice *d);
|
2014-09-01 14:07:57 +04:00
|
|
|
|
2014-09-01 14:07:55 +04:00
|
|
|
/* Get status of the device */
|
|
|
|
uint8_t (*get_status)(QVirtioDevice *d);
|
|
|
|
|
|
|
|
/* Set status of the device */
|
|
|
|
void (*set_status)(QVirtioDevice *d, uint8_t status);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
2014-09-01 14:07:59 +04:00
|
|
|
/* Get the queue ISR status of the device */
|
|
|
|
bool (*get_queue_isr_status)(QVirtioDevice *d, QVirtQueue *vq);
|
|
|
|
|
2019-09-03 09:18:46 +03:00
|
|
|
/* Wait for the configuration ISR status of the device */
|
|
|
|
void (*wait_config_isr_status)(QVirtioDevice *d, gint64 timeout_us);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
|
|
|
/* Select a queue to work on */
|
|
|
|
void (*queue_select)(QVirtioDevice *d, uint16_t index);
|
|
|
|
|
|
|
|
/* Get the size of the selected queue */
|
|
|
|
uint16_t (*get_queue_size)(QVirtioDevice *d);
|
|
|
|
|
|
|
|
/* Set the address of the selected queue */
|
2019-10-23 13:04:20 +03:00
|
|
|
void (*set_queue_address)(QVirtioDevice *d, QVirtQueue *vq);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
|
|
|
/* Setup the virtqueue specified by index */
|
|
|
|
QVirtQueue *(*virtqueue_setup)(QVirtioDevice *d, QGuestAllocator *alloc,
|
|
|
|
uint16_t index);
|
|
|
|
|
2016-05-05 18:53:35 +03:00
|
|
|
/* Free virtqueue resources */
|
|
|
|
void (*virtqueue_cleanup)(QVirtQueue *vq, QGuestAllocator *alloc);
|
|
|
|
|
2014-09-01 14:07:56 +04:00
|
|
|
/* Notify changes in virtqueue */
|
|
|
|
void (*virtqueue_kick)(QVirtioDevice *d, QVirtQueue *vq);
|
2016-10-17 13:30:21 +03:00
|
|
|
};
|
2014-09-01 14:07:55 +04:00
|
|
|
|
2014-09-01 14:07:56 +04:00
|
|
|
static inline uint32_t qvring_size(uint32_t num, uint32_t align)
|
|
|
|
{
|
2016-05-09 15:47:38 +03:00
|
|
|
return ((sizeof(struct vring_desc) * num + sizeof(uint16_t) * (3 + num)
|
2014-09-01 14:07:56 +04:00
|
|
|
+ align - 1) & ~(align - 1))
|
2016-05-09 15:47:38 +03:00
|
|
|
+ sizeof(uint16_t) * 3 + sizeof(struct vring_used_elem) * num;
|
2014-09-01 14:07:56 +04:00
|
|
|
}
|
|
|
|
|
2016-10-17 13:30:21 +03:00
|
|
|
uint8_t qvirtio_config_readb(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint16_t qvirtio_config_readw(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint32_t qvirtio_config_readl(QVirtioDevice *d, uint64_t addr);
|
|
|
|
uint64_t qvirtio_config_readq(QVirtioDevice *d, uint64_t addr);
|
2019-10-23 13:04:12 +03:00
|
|
|
uint64_t qvirtio_get_features(QVirtioDevice *d);
|
|
|
|
void qvirtio_set_features(QVirtioDevice *d, uint64_t features);
|
2018-10-07 10:37:44 +03:00
|
|
|
bool qvirtio_is_big_endian(QVirtioDevice *d);
|
2016-10-17 13:30:21 +03:00
|
|
|
|
|
|
|
void qvirtio_reset(QVirtioDevice *d);
|
|
|
|
void qvirtio_set_acknowledge(QVirtioDevice *d);
|
|
|
|
void qvirtio_set_driver(QVirtioDevice *d);
|
|
|
|
void qvirtio_set_driver_ok(QVirtioDevice *d);
|
|
|
|
|
2019-09-03 09:18:46 +03:00
|
|
|
void qvirtio_wait_queue_isr(QTestState *qts, QVirtioDevice *d,
|
2014-09-29 19:40:12 +04:00
|
|
|
QVirtQueue *vq, gint64 timeout_us);
|
2019-05-18 11:23:24 +03:00
|
|
|
uint8_t qvirtio_wait_status_byte_no_isr(QTestState *qts, QVirtioDevice *d,
|
2014-09-29 19:40:11 +04:00
|
|
|
QVirtQueue *vq,
|
|
|
|
uint64_t addr,
|
|
|
|
gint64 timeout_us);
|
2019-05-18 11:23:24 +03:00
|
|
|
void qvirtio_wait_used_elem(QTestState *qts, QVirtioDevice *d,
|
2017-06-28 21:47:20 +03:00
|
|
|
QVirtQueue *vq,
|
|
|
|
uint32_t desc_idx,
|
2018-02-01 23:21:28 +03:00
|
|
|
uint32_t *len,
|
2017-06-28 21:47:20 +03:00
|
|
|
gint64 timeout_us);
|
2016-10-17 13:30:21 +03:00
|
|
|
void qvirtio_wait_config_isr(QVirtioDevice *d, gint64 timeout_us);
|
|
|
|
QVirtQueue *qvirtqueue_setup(QVirtioDevice *d,
|
|
|
|
QGuestAllocator *alloc, uint16_t index);
|
2016-05-05 18:53:35 +03:00
|
|
|
void qvirtqueue_cleanup(const QVirtioBus *bus, QVirtQueue *vq,
|
|
|
|
QGuestAllocator *alloc);
|
2014-09-01 14:07:56 +04:00
|
|
|
|
2019-05-15 20:43:23 +03:00
|
|
|
void qvring_init(QTestState *qts, const QGuestAllocator *alloc, QVirtQueue *vq,
|
|
|
|
uint64_t addr);
|
2019-05-18 11:23:24 +03:00
|
|
|
QVRingIndirectDesc *qvring_indirect_desc_setup(QTestState *qs, QVirtioDevice *d,
|
|
|
|
QGuestAllocator *alloc,
|
|
|
|
uint16_t elem);
|
2019-10-23 13:04:18 +03:00
|
|
|
void qvring_indirect_desc_add(QVirtioDevice *d, QTestState *qts,
|
|
|
|
QVRingIndirectDesc *indirect,
|
2019-05-18 11:23:24 +03:00
|
|
|
uint64_t data, uint32_t len, bool write);
|
|
|
|
uint32_t qvirtqueue_add(QTestState *qts, QVirtQueue *vq, uint64_t data,
|
|
|
|
uint32_t len, bool write, bool next);
|
|
|
|
uint32_t qvirtqueue_add_indirect(QTestState *qts, QVirtQueue *vq,
|
|
|
|
QVRingIndirectDesc *indirect);
|
|
|
|
void qvirtqueue_kick(QTestState *qts, QVirtioDevice *d, QVirtQueue *vq,
|
|
|
|
uint32_t free_head);
|
|
|
|
bool qvirtqueue_get_buf(QTestState *qts, QVirtQueue *vq, uint32_t *desc_idx,
|
|
|
|
uint32_t *len);
|
|
|
|
|
|
|
|
void qvirtqueue_set_used_event(QTestState *qts, QVirtQueue *vq, uint16_t idx);
|
2017-08-31 17:40:08 +03:00
|
|
|
|
2018-07-25 17:25:43 +03:00
|
|
|
void qvirtio_start_device(QVirtioDevice *vdev);
|
2017-08-31 17:40:08 +03:00
|
|
|
|
2014-09-01 14:07:54 +04:00
|
|
|
#endif
|