hw/virtio: add boilerplate for vhost-user-gpio device
This creates the QEMU side of the vhost-user-gpio device which connects to the remote daemon. It is based of vhost-user-i2c code. Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <5390324a748194a21bc99b1538e19761a8c64092.1641987128.git.viresh.kumar@linaro.org> [AJB: fixes for qtest, tweaks to feature bits] Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Cc: Vincent Whitchurch <vincent.whitchurch@axis.com> Message-Id: <20220802095010.3330793-13-alex.bennee@linaro.org> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
This commit is contained in:
Viresh Kumar
Michael S. Tsirkin
parent
b8f3e6a18d
commit
27ba7b027f
@ -2098,6 +2098,13 @@ F: hw/virtio/vhost-user-rng-pci.c
|
||||
F: include/hw/virtio/vhost-user-rng.h
|
||||
F: tools/vhost-user-rng/*
|
||||
|
||||
vhost-user-gpio
|
||||
M: Alex Bennée <alex.bennee@linaro.org>
|
||||
R: Viresh Kumar <viresh.kumar@linaro.org>
|
||||
S: Maintained
|
||||
F: hw/virtio/vhost-user-gpio.c
|
||||
F: include/hw/virtio/vhost-user-gpio.h
|
||||
|
||||
virtio-crypto
|
||||
M: Gonglei <arei.gonglei@huawei.com>
|
||||
S: Supported
|
||||
|
||||
@ -80,3 +80,8 @@ config VHOST_USER_FS
|
||||
bool
|
||||
default y
|
||||
depends on VIRTIO && VHOST_USER
|
||||
|
||||
config VHOST_USER_GPIO
|
||||
bool
|
||||
default y
|
||||
depends on VIRTIO && VHOST_USER
|
||||
|
||||
@ -29,6 +29,7 @@ virtio_ss.add(when: 'CONFIG_VIRTIO_IOMMU', if_true: files('virtio-iommu.c'))
|
||||
virtio_ss.add(when: 'CONFIG_VIRTIO_MEM', if_true: files('virtio-mem.c'))
|
||||
virtio_ss.add(when: 'CONFIG_VHOST_USER_I2C', if_true: files('vhost-user-i2c.c'))
|
||||
virtio_ss.add(when: 'CONFIG_VHOST_USER_RNG', if_true: files('vhost-user-rng.c'))
|
||||
virtio_ss.add(when: 'CONFIG_VHOST_USER_GPIO', if_true: files('vhost-user-gpio.c'))
|
||||
|
||||
virtio_pci_ss = ss.source_set()
|
||||
virtio_pci_ss.add(when: 'CONFIG_VHOST_VSOCK', if_true: files('vhost-vsock-pci.c'))
|
||||
|
||||
@ -144,3 +144,8 @@ virtio_mem_state_response(uint16_t state) "state=%" PRIu16
|
||||
virtio_pmem_flush_request(void) "flush request"
|
||||
virtio_pmem_response(void) "flush response"
|
||||
virtio_pmem_flush_done(int type) "fsync return=%d"
|
||||
|
||||
# virtio-gpio.c
|
||||
virtio_gpio_start(void) "start"
|
||||
virtio_gpio_stop(void) "stop"
|
||||
virtio_gpio_set_status(uint8_t status) "0x%x"
|
||||
|
||||
411
hw/virtio/vhost-user-gpio.c
Normal file
411
hw/virtio/vhost-user-gpio.c
Normal file
@ -0,0 +1,411 @@
|
||||
/*
|
||||
* Vhost-user GPIO virtio device
|
||||
*
|
||||
* Copyright (c) 2022 Viresh Kumar <viresh.kumar@linaro.org>
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-2.0-or-later
|
||||
*/
|
||||
|
||||
#include "qemu/osdep.h"
|
||||
#include "qapi/error.h"
|
||||
#include "hw/qdev-properties.h"
|
||||
#include "hw/virtio/virtio-bus.h"
|
||||
#include "hw/virtio/vhost-user-gpio.h"
|
||||
#include "qemu/error-report.h"
|
||||
#include "standard-headers/linux/virtio_ids.h"
|
||||
#include "trace.h"
|
||||
|
||||
#define REALIZE_CONNECTION_RETRIES 3
|
||||
|
||||
/* Features required from VirtIO */
|
||||
static const int feature_bits[] = {
|
||||
VIRTIO_F_VERSION_1,
|
||||
VIRTIO_F_NOTIFY_ON_EMPTY,
|
||||
VIRTIO_RING_F_INDIRECT_DESC,
|
||||
VIRTIO_RING_F_EVENT_IDX,
|
||||
VIRTIO_GPIO_F_IRQ,
|
||||
VHOST_INVALID_FEATURE_BIT
|
||||
};
|
||||
|
||||
static void vu_gpio_get_config(VirtIODevice *vdev, uint8_t *config)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
|
||||
memcpy(config, &gpio->config, sizeof(gpio->config));
|
||||
}
|
||||
|
||||
static int vu_gpio_config_notifier(struct vhost_dev *dev)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(dev->vdev);
|
||||
|
||||
memcpy(dev->vdev->config, &gpio->config, sizeof(gpio->config));
|
||||
virtio_notify_config(dev->vdev);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
const VhostDevConfigOps gpio_ops = {
|
||||
.vhost_dev_config_notifier = vu_gpio_config_notifier,
|
||||
};
|
||||
|
||||
static int vu_gpio_start(VirtIODevice *vdev)
|
||||
{
|
||||
BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
|
||||
VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
struct vhost_dev *vhost_dev = &gpio->vhost_dev;
|
||||
int ret, i;
|
||||
|
||||
if (!k->set_guest_notifiers) {
|
||||
error_report("binding does not support guest notifiers");
|
||||
return -ENOSYS;
|
||||
}
|
||||
|
||||
ret = vhost_dev_enable_notifiers(vhost_dev, vdev);
|
||||
if (ret < 0) {
|
||||
error_report("Error enabling host notifiers: %d", ret);
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = k->set_guest_notifiers(qbus->parent, vhost_dev->nvqs, true);
|
||||
if (ret < 0) {
|
||||
error_report("Error binding guest notifier: %d", ret);
|
||||
goto err_host_notifiers;
|
||||
}
|
||||
|
||||
/*
|
||||
* Before we start up we need to ensure we have the final feature
|
||||
* set needed for the vhost configuration. The backend may also
|
||||
* apply backend_features when the feature set is sent.
|
||||
*/
|
||||
vhost_ack_features(&gpio->vhost_dev, feature_bits, vdev->guest_features);
|
||||
|
||||
ret = vhost_dev_start(&gpio->vhost_dev, vdev);
|
||||
if (ret < 0) {
|
||||
error_report("Error starting vhost-user-gpio: %d", ret);
|
||||
goto err_guest_notifiers;
|
||||
}
|
||||
|
||||
/*
|
||||
* guest_notifier_mask/pending not used yet, so just unmask
|
||||
* everything here. virtio-pci will do the right thing by
|
||||
* enabling/disabling irqfd.
|
||||
*/
|
||||
for (i = 0; i < gpio->vhost_dev.nvqs; i++) {
|
||||
vhost_virtqueue_mask(&gpio->vhost_dev, vdev, i, false);
|
||||
}
|
||||
|
||||
/*
|
||||
* As we must have VHOST_USER_F_PROTOCOL_FEATURES (because
|
||||
* VHOST_USER_GET_CONFIG requires it) we need to explicitly enable
|
||||
* the vrings.
|
||||
*/
|
||||
g_assert(vhost_dev->vhost_ops &&
|
||||
vhost_dev->vhost_ops->vhost_set_vring_enable);
|
||||
ret = vhost_dev->vhost_ops->vhost_set_vring_enable(vhost_dev, true);
|
||||
if (ret == 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
error_report("Failed to start vrings for vhost-user-gpio: %d", ret);
|
||||
|
||||
err_guest_notifiers:
|
||||
k->set_guest_notifiers(qbus->parent, gpio->vhost_dev.nvqs, false);
|
||||
err_host_notifiers:
|
||||
vhost_dev_disable_notifiers(&gpio->vhost_dev, vdev);
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
static void vu_gpio_stop(VirtIODevice *vdev)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
|
||||
VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
|
||||
struct vhost_dev *vhost_dev = &gpio->vhost_dev;
|
||||
int ret;
|
||||
|
||||
if (!k->set_guest_notifiers) {
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
* We can call vu_gpio_stop multiple times, for example from
|
||||
* vm_state_notify and the final object finalisation. Check we
|
||||
* aren't already stopped before doing so.
|
||||
*/
|
||||
if (!vhost_dev_is_started(vhost_dev)) {
|
||||
return;
|
||||
}
|
||||
|
||||
vhost_dev_stop(vhost_dev, vdev);
|
||||
|
||||
ret = k->set_guest_notifiers(qbus->parent, vhost_dev->nvqs, false);
|
||||
if (ret < 0) {
|
||||
error_report("vhost guest notifier cleanup failed: %d", ret);
|
||||
return;
|
||||
}
|
||||
|
||||
vhost_dev_disable_notifiers(vhost_dev, vdev);
|
||||
}
|
||||
|
||||
static void vu_gpio_set_status(VirtIODevice *vdev, uint8_t status)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
bool should_start = virtio_device_started(vdev, status);
|
||||
|
||||
trace_virtio_gpio_set_status(status);
|
||||
|
||||
if (!gpio->connected) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (vhost_dev_is_started(&gpio->vhost_dev) == should_start) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (should_start) {
|
||||
if (vu_gpio_start(vdev)) {
|
||||
qemu_chr_fe_disconnect(&gpio->chardev);
|
||||
}
|
||||
} else {
|
||||
vu_gpio_stop(vdev);
|
||||
}
|
||||
}
|
||||
|
||||
static uint64_t vu_gpio_get_features(VirtIODevice *vdev, uint64_t features,
|
||||
Error **errp)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
|
||||
return vhost_get_features(&gpio->vhost_dev, feature_bits, features);
|
||||
}
|
||||
|
||||
static void vu_gpio_handle_output(VirtIODevice *vdev, VirtQueue *vq)
|
||||
{
|
||||
/*
|
||||
* Not normally called; it's the daemon that handles the queue;
|
||||
* however virtio's cleanup path can call this.
|
||||
*/
|
||||
}
|
||||
|
||||
static void vu_gpio_guest_notifier_mask(VirtIODevice *vdev, int idx, bool mask)
|
||||
{
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
|
||||
vhost_virtqueue_mask(&gpio->vhost_dev, vdev, idx, mask);
|
||||
}
|
||||
|
||||
static void do_vhost_user_cleanup(VirtIODevice *vdev, VHostUserGPIO *gpio)
|
||||
{
|
||||
virtio_delete_queue(gpio->command_vq);
|
||||
virtio_delete_queue(gpio->interrupt_vq);
|
||||
g_free(gpio->vhost_dev.vqs);
|
||||
gpio->vhost_dev.vqs = NULL;
|
||||
virtio_cleanup(vdev);
|
||||
vhost_user_cleanup(&gpio->vhost_user);
|
||||
}
|
||||
|
||||
static int vu_gpio_connect(DeviceState *dev, Error **errp)
|
||||
{
|
||||
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
struct vhost_dev *vhost_dev = &gpio->vhost_dev;
|
||||
int ret;
|
||||
|
||||
if (gpio->connected) {
|
||||
return 0;
|
||||
}
|
||||
gpio->connected = true;
|
||||
|
||||
vhost_dev_set_config_notifier(vhost_dev, &gpio_ops);
|
||||
gpio->vhost_user.supports_config = true;
|
||||
|
||||
ret = vhost_dev_init(vhost_dev, &gpio->vhost_user,
|
||||
VHOST_BACKEND_TYPE_USER, 0, errp);
|
||||
if (ret < 0) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
/* restore vhost state */
|
||||
if (virtio_device_started(vdev, vdev->status)) {
|
||||
vu_gpio_start(vdev);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void vu_gpio_disconnect(DeviceState *dev)
|
||||
{
|
||||
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
|
||||
if (!gpio->connected) {
|
||||
return;
|
||||
}
|
||||
gpio->connected = false;
|
||||
|
||||
vu_gpio_stop(vdev);
|
||||
vhost_dev_cleanup(&gpio->vhost_dev);
|
||||
}
|
||||
|
||||
static void vu_gpio_event(void *opaque, QEMUChrEvent event)
|
||||
{
|
||||
DeviceState *dev = opaque;
|
||||
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(vdev);
|
||||
Error *local_err = NULL;
|
||||
|
||||
switch (event) {
|
||||
case CHR_EVENT_OPENED:
|
||||
if (vu_gpio_connect(dev, &local_err) < 0) {
|
||||
qemu_chr_fe_disconnect(&gpio->chardev);
|
||||
return;
|
||||
}
|
||||
break;
|
||||
case CHR_EVENT_CLOSED:
|
||||
vu_gpio_disconnect(dev);
|
||||
break;
|
||||
case CHR_EVENT_BREAK:
|
||||
case CHR_EVENT_MUX_IN:
|
||||
case CHR_EVENT_MUX_OUT:
|
||||
/* Ignore */
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
static int vu_gpio_realize_connect(VHostUserGPIO *gpio, Error **errp)
|
||||
{
|
||||
VirtIODevice *vdev = &gpio->parent_obj;
|
||||
DeviceState *dev = &vdev->parent_obj;
|
||||
struct vhost_dev *vhost_dev = &gpio->vhost_dev;
|
||||
int ret;
|
||||
|
||||
ret = qemu_chr_fe_wait_connected(&gpio->chardev, errp);
|
||||
if (ret < 0) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*
|
||||
* vu_gpio_connect() may have already connected (via the event
|
||||
* callback) in which case it will just report success.
|
||||
*/
|
||||
ret = vu_gpio_connect(dev, errp);
|
||||
if (ret < 0) {
|
||||
qemu_chr_fe_disconnect(&gpio->chardev);
|
||||
return ret;
|
||||
}
|
||||
g_assert(gpio->connected);
|
||||
|
||||
ret = vhost_dev_get_config(vhost_dev, (uint8_t *)&gpio->config,
|
||||
sizeof(gpio->config), errp);
|
||||
|
||||
if (ret < 0) {
|
||||
error_report("vhost-user-gpio: get config failed");
|
||||
|
||||
qemu_chr_fe_disconnect(&gpio->chardev);
|
||||
vhost_dev_cleanup(vhost_dev);
|
||||
return ret;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void vu_gpio_device_realize(DeviceState *dev, Error **errp)
|
||||
{
|
||||
ERRP_GUARD();
|
||||
|
||||
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(dev);
|
||||
int retries, ret;
|
||||
|
||||
if (!gpio->chardev.chr) {
|
||||
error_setg(errp, "vhost-user-gpio: chardev is mandatory");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!vhost_user_init(&gpio->vhost_user, &gpio->chardev, errp)) {
|
||||
return;
|
||||
}
|
||||
|
||||
virtio_init(vdev, VIRTIO_ID_GPIO, sizeof(gpio->config));
|
||||
|
||||
gpio->vhost_dev.nvqs = 2;
|
||||
gpio->command_vq = virtio_add_queue(vdev, 256, vu_gpio_handle_output);
|
||||
gpio->interrupt_vq = virtio_add_queue(vdev, 256, vu_gpio_handle_output);
|
||||
gpio->vhost_dev.vqs = g_new0(struct vhost_virtqueue, gpio->vhost_dev.nvqs);
|
||||
|
||||
gpio->connected = false;
|
||||
|
||||
qemu_chr_fe_set_handlers(&gpio->chardev, NULL, NULL, vu_gpio_event, NULL,
|
||||
dev, NULL, true);
|
||||
|
||||
retries = REALIZE_CONNECTION_RETRIES;
|
||||
g_assert(!*errp);
|
||||
do {
|
||||
if (*errp) {
|
||||
error_prepend(errp, "Reconnecting after error: ");
|
||||
error_report_err(*errp);
|
||||
*errp = NULL;
|
||||
}
|
||||
ret = vu_gpio_realize_connect(gpio, errp);
|
||||
} while (ret < 0 && retries--);
|
||||
|
||||
if (ret < 0) {
|
||||
do_vhost_user_cleanup(vdev, gpio);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
static void vu_gpio_device_unrealize(DeviceState *dev)
|
||||
{
|
||||
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
||||
VHostUserGPIO *gpio = VHOST_USER_GPIO(dev);
|
||||
|
||||
vu_gpio_set_status(vdev, 0);
|
||||
qemu_chr_fe_set_handlers(&gpio->chardev, NULL, NULL, NULL, NULL, NULL, NULL,
|
||||
false);
|
||||
vhost_dev_cleanup(&gpio->vhost_dev);
|
||||
do_vhost_user_cleanup(vdev, gpio);
|
||||
}
|
||||
|
||||
static const VMStateDescription vu_gpio_vmstate = {
|
||||
.name = "vhost-user-gpio",
|
||||
.unmigratable = 1,
|
||||
};
|
||||
|
||||
static Property vu_gpio_properties[] = {
|
||||
DEFINE_PROP_CHR("chardev", VHostUserGPIO, chardev),
|
||||
DEFINE_PROP_END_OF_LIST(),
|
||||
};
|
||||
|
||||
static void vu_gpio_class_init(ObjectClass *klass, void *data)
|
||||
{
|
||||
DeviceClass *dc = DEVICE_CLASS(klass);
|
||||
VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
|
||||
|
||||
device_class_set_props(dc, vu_gpio_properties);
|
||||
dc->vmsd = &vu_gpio_vmstate;
|
||||
set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
|
||||
vdc->realize = vu_gpio_device_realize;
|
||||
vdc->unrealize = vu_gpio_device_unrealize;
|
||||
vdc->get_features = vu_gpio_get_features;
|
||||
vdc->get_config = vu_gpio_get_config;
|
||||
vdc->set_status = vu_gpio_set_status;
|
||||
vdc->guest_notifier_mask = vu_gpio_guest_notifier_mask;
|
||||
}
|
||||
|
||||
static const TypeInfo vu_gpio_info = {
|
||||
.name = TYPE_VHOST_USER_GPIO,
|
||||
.parent = TYPE_VIRTIO_DEVICE,
|
||||
.instance_size = sizeof(VHostUserGPIO),
|
||||
.class_init = vu_gpio_class_init,
|
||||
};
|
||||
|
||||
static void vu_gpio_register_types(void)
|
||||
{
|
||||
type_register_static(&vu_gpio_info);
|
||||
}
|
||||
|
||||
type_init(vu_gpio_register_types)
|
||||
35
include/hw/virtio/vhost-user-gpio.h
Normal file
35
include/hw/virtio/vhost-user-gpio.h
Normal file
@ -0,0 +1,35 @@
|
||||
/*
|
||||
* Vhost-user GPIO virtio device
|
||||
*
|
||||
* Copyright (c) 2021 Viresh Kumar <viresh.kumar@linaro.org>
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-2.0-or-later
|
||||
*/
|
||||
|
||||
#ifndef _QEMU_VHOST_USER_GPIO_H
|
||||
#define _QEMU_VHOST_USER_GPIO_H
|
||||
|
||||
#include "hw/virtio/virtio.h"
|
||||
#include "hw/virtio/vhost.h"
|
||||
#include "hw/virtio/vhost-user.h"
|
||||
#include "standard-headers/linux/virtio_gpio.h"
|
||||
#include "chardev/char-fe.h"
|
||||
|
||||
#define TYPE_VHOST_USER_GPIO "vhost-user-gpio-device"
|
||||
OBJECT_DECLARE_SIMPLE_TYPE(VHostUserGPIO, VHOST_USER_GPIO);
|
||||
|
||||
struct VHostUserGPIO {
|
||||
/*< private >*/
|
||||
VirtIODevice parent_obj;
|
||||
CharBackend chardev;
|
||||
struct virtio_gpio_config config;
|
||||
struct vhost_virtqueue *vhost_vq;
|
||||
struct vhost_dev vhost_dev;
|
||||
VhostUserState vhost_user;
|
||||
VirtQueue *command_vq;
|
||||
VirtQueue *interrupt_vq;
|
||||
bool connected;
|
||||
/*< public >*/
|
||||
};
|
||||
|
||||
#endif /* _QEMU_VHOST_USER_GPIO_H */
|
||||
Loading…
Reference in New Issue
Block a user