From: Mi <krashmi...@gmail.com> Add a Virtio backend for SD/MMC devices. Confirmed interoperability with Linux.
Linux patch link: https://lore.kernel.org/linux-mmc/20240701120642.30001-1-krashmi...@gmail.com/ Signed-off-by: Mikhail Krasheninnikov <krashmi...@gmail.com> CC: Matwey Kornilov <matwey.korni...@gmail.com> CC: qemu-bl...@nongnu.org CC: Michael S. Tsirkin <m...@redhat.com> CC: Kevin Wolf <kw...@redhat.com> CC: Stefan Hajnoczi <stefa...@redhat.com> --- Changes from v3: - Many structs were moved to uapi in kernel patch (new link would be sent as response to this letter). This patch integrates them. - Since there's no corresponding patch to Virtio specification yet, this patch is marked as RFC. hw/block/Kconfig | 6 + hw/block/meson.build | 1 + hw/block/virtio-sdhci.c | 142 ++++++++++++++++++ hw/virtio/meson.build | 1 + hw/virtio/virtio-sdhci-pci.c | 86 +++++++++++ hw/virtio/virtio.c | 3 +- include/hw/virtio/virtio-sdhci.h | 22 +++ include/standard-headers/linux/virtio_ids.h | 1 + include/standard-headers/linux/virtio_sdhci.h | 39 +++++ 9 files changed, 300 insertions(+), 1 deletion(-) create mode 100644 hw/block/virtio-sdhci.c create mode 100644 hw/virtio/virtio-sdhci-pci.c create mode 100644 include/hw/virtio/virtio-sdhci.h create mode 100644 include/standard-headers/linux/virtio_sdhci.h diff --git a/hw/block/Kconfig b/hw/block/Kconfig index 9e8f28f982..5b5363da01 100644 --- a/hw/block/Kconfig +++ b/hw/block/Kconfig @@ -44,3 +44,9 @@ config VHOST_USER_BLK config SWIM bool + +config VIRTIO_SDHCI + bool + default y + select SD + depends on VIRTIO diff --git a/hw/block/meson.build b/hw/block/meson.build index 8aa4dc3893..82356c264e 100644 --- a/hw/block/meson.build +++ b/hw/block/meson.build @@ -19,5 +19,6 @@ system_ss.add(when: 'CONFIG_TC58128', if_true: files('tc58128.c')) specific_ss.add(when: 'CONFIG_VIRTIO_BLK', if_true: files('virtio-blk.c', 'virtio-blk-common.c')) specific_ss.add(when: 'CONFIG_VHOST_USER_BLK', if_true: files('vhost-user-blk.c', 'virtio-blk-common.c')) +specific_ss.add(when: 'CONFIG_VIRTIO_SDHCI', if_true: files('virtio-sdhci.c')) subdir('dataplane') diff --git a/hw/block/virtio-sdhci.c b/hw/block/virtio-sdhci.c new file mode 100644 index 0000000000..d3a90f7b5a --- /dev/null +++ b/hw/block/virtio-sdhci.c @@ -0,0 +1,142 @@ +#include "qemu/osdep.h" +#include "qapi/error.h" + +#include "hw/virtio/virtio.h" +#include "hw/virtio/virtio-sdhci.h" +#include "qemu/typedefs.h" +#include "sysemu/blockdev.h" +#include "standard-headers/linux/virtio_ids.h" +#include "standard-headers/linux/virtio_sdhci.h" + +static void send_command(SDBus *sdbus, struct mmc_req *mmc_request, uint8_t *response, + struct virtio_mmc_response *virtio_resp) +{ + SDRequest sdreq; + int resp_len; + + sdreq.cmd = (uint8_t)mmc_request->opcode; + sdreq.arg = mmc_request->arg; + resp_len = sdbus_do_command(sdbus, &sdreq, response); + virtio_resp->cmd_resp_len = resp_len; + + for (int i = 0; i < resp_len / sizeof(__le32); i++) { + virtio_resp->cmd_resp[i] = ldl_be_p(&virtio_resp->cmd_resp[i]); + } +} + +static void send_command_without_response(SDBus *sdbus, struct mmc_req *mmc_request) +{ + SDRequest sdreq; + uint8_t response[4]; + + sdreq.cmd = (uint8_t)mmc_request->opcode; + sdreq.arg = mmc_request->arg; + sdbus_do_command(sdbus, &sdreq, response); +} + +static void handle_mmc_request(VirtIODevice *vdev, struct virtio_mmc_request *virtio_req, + struct virtio_mmc_response *virtio_resp) +{ + VirtIOSDHCI *vsd = VIRTIO_SDHCI(vdev); + SDBus *sdbus = &vsd->sdbus; + + if (virtio_req->flags & VIRTIO_MMC_REQUEST_SBC) { + send_command_without_response(sdbus, &virtio_req->sbc_req); + } + + send_command(sdbus, &virtio_req->request, + (uint8_t *)virtio_resp->cmd_resp, virtio_resp); + + if (virtio_req->flags & VIRTIO_MMC_REQUEST_DATA) { + if (virtio_req->flags & VIRTIO_MMC_REQUEST_WRITE) { + sdbus_write_data(sdbus, virtio_req->buf, virtio_req->buf_len); + } else { + sdbus_read_data(sdbus, virtio_resp->buf, virtio_req->buf_len); + } + } + + if (virtio_req->flags & VIRTIO_MMC_REQUEST_STOP) { + send_command_without_response(sdbus, &virtio_req->stop_req); + } +} + +static void handle_request(VirtIODevice *vdev, VirtQueue *vq) +{ + VirtQueueElement *elem; + struct virtio_mmc_request virtio_req; + struct virtio_mmc_response virtio_resp; + + elem = virtqueue_pop(vq, sizeof(VirtQueueElement)); + + iov_to_buf(elem->out_sg, elem->out_num, 0, + &virtio_req, sizeof(struct virtio_mmc_request)); + + handle_mmc_request(vdev, &virtio_req, &virtio_resp); + + iov_from_buf(elem->in_sg, elem->in_num, 0, + &virtio_resp, sizeof(struct virtio_mmc_response)); + + virtqueue_push(vq, elem, 1); + + virtio_notify(vdev, vq); +} + +static void virtio_sdhci_realize(DeviceState *dev, Error **errp) +{ + VirtIODevice *vdev = VIRTIO_DEVICE(dev); + VirtIOSDHCI *vsd = VIRTIO_SDHCI(dev); + + virtio_init(vdev, VIRTIO_ID_SDHCI, 0); + + vsd->vq = virtio_add_queue(vdev, 1, handle_request); + + BlockBackend *blk = vsd->blk; + if (!blk) { + error_setg(errp, "Block backend not found"); + return; + } + + qbus_init(&vsd->sdbus, sizeof(vsd->sdbus), TYPE_SD_BUS, dev, "sd-bus"); + DeviceState *card = qdev_new(TYPE_SD_CARD); + qdev_prop_set_drive_err(card, "drive", blk, &error_fatal); + qdev_realize_and_unref(card, + qdev_get_child_bus(dev, "sd-bus"), &error_fatal); +} + +static void virtio_sdhci_unrealize(DeviceState *dev) +{ + VirtIODevice *vdev = VIRTIO_DEVICE(dev); + virtio_cleanup(vdev); +} + +static uint64_t virtio_sdhci_get_features(VirtIODevice *vdev, + uint64_t features, Error **errp) +{ + return features; +} + +static void virtio_sdhci_class_init(ObjectClass *klass, void *data) +{ + DeviceClass *dc = DEVICE_CLASS(klass); + VirtioDeviceClass *k = VIRTIO_DEVICE_CLASS(klass); + + set_bit(DEVICE_CATEGORY_STORAGE, dc->categories); + + k->realize = virtio_sdhci_realize; + k->unrealize = virtio_sdhci_unrealize; + k->get_features = virtio_sdhci_get_features; +} + +static const TypeInfo virtio_sdhci_info = { + .name = TYPE_VIRTIO_SDHCI, + .parent = TYPE_VIRTIO_DEVICE, + .instance_size = sizeof(VirtIOSDHCI), + .class_init = virtio_sdhci_class_init, +}; + +static void virtio_register_types(void) +{ + type_register_static(&virtio_sdhci_info); +} + +type_init(virtio_register_types) diff --git a/hw/virtio/meson.build b/hw/virtio/meson.build index 47baf00366..c7a8707ba6 100644 --- a/hw/virtio/meson.build +++ b/hw/virtio/meson.build @@ -68,6 +68,7 @@ virtio_pci_ss.add(when: 'CONFIG_VIRTIO_IOMMU', if_true: files('virtio-iommu-pci. virtio_pci_ss.add(when: 'CONFIG_VIRTIO_MEM', if_true: files('virtio-mem-pci.c')) virtio_pci_ss.add(when: 'CONFIG_VHOST_VDPA_DEV', if_true: files('vdpa-dev-pci.c')) virtio_pci_ss.add(when: 'CONFIG_VIRTIO_MD', if_true: files('virtio-md-pci.c')) +virtio_pci_ss.add(when: 'CONFIG_VIRTIO_SDHCI', if_true: files('virtio-sdhci-pci.c')) specific_virtio_ss.add_all(when: 'CONFIG_VIRTIO_PCI', if_true: virtio_pci_ss) diff --git a/hw/virtio/virtio-sdhci-pci.c b/hw/virtio/virtio-sdhci-pci.c new file mode 100644 index 0000000000..889352f577 --- /dev/null +++ b/hw/virtio/virtio-sdhci-pci.c @@ -0,0 +1,86 @@ +#include "qemu/osdep.h" + +#include "hw/virtio/virtio-pci.h" +#include "hw/virtio/virtio-sdhci.h" +#include "hw/qdev-properties-system.h" +#include "qemu/typedefs.h" +#include "qapi/error.h" +#include "sysemu/block-backend-global-state.h" + +typedef struct VirtIOSDHCIPCI VirtIOSDHCIPCI; + +/* + * virtio-mmc-pci: This extends VirtioPCIProxy. + */ +#define TYPE_VIRTIO_SDHCI_PCI "virtio-sdhci-pci-base" +DECLARE_INSTANCE_CHECKER(VirtIOSDHCIPCI, VIRTIO_SDHCI_PCI, + TYPE_VIRTIO_SDHCI_PCI) + +struct VirtIOSDHCIPCI { + VirtIOPCIProxy parent_obj; + VirtIOSDHCI vdev; + BlockBackend *blk; +}; + +static void virtio_sdhci_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp) +{ + VirtIOSDHCIPCI *vsd = VIRTIO_SDHCI_PCI(vpci_dev); + DeviceState *dev = DEVICE(&vsd->vdev); + VirtIOSDHCI *vsd_dev; + + if (!vsd->blk) { + error_setg(errp, "Drive property not set"); + return; + } + vsd_dev = &vsd->vdev; + vsd_dev->blk = vsd->blk; + blk_detach_dev(vsd->blk, DEVICE(vpci_dev)); + + qdev_set_parent_bus(dev, BUS(&vpci_dev->bus), errp); + + virtio_pci_force_virtio_1(vpci_dev); + object_property_set_bool(OBJECT(dev), "realized", true, errp); +} + +static Property virtio_sdhci_properties[] = { + DEFINE_PROP_DRIVE("drive", VirtIOSDHCIPCI, blk), + DEFINE_PROP_END_OF_LIST(), +}; + +static void virtio_sdhci_pci_class_init(ObjectClass *oc, void *data) +{ + DeviceClass *dc = DEVICE_CLASS(oc); + VirtioPCIClass *virtio_pci_class = VIRTIO_PCI_CLASS(oc); + PCIDeviceClass *pci_device_class = PCI_DEVICE_CLASS(oc); + + device_class_set_props(dc, virtio_sdhci_properties); + set_bit(DEVICE_CATEGORY_STORAGE, dc->categories); + + virtio_pci_class->realize = virtio_sdhci_pci_realize; + + pci_device_class->revision = VIRTIO_PCI_ABI_VERSION; + pci_device_class->class_id = PCI_CLASS_MEMORY_FLASH; +} + +static void virtio_sdhci_pci_instance_init(Object *obj) +{ + VirtIOSDHCIPCI *dev = VIRTIO_SDHCI_PCI(obj); + + virtio_instance_init_common(obj, &dev->vdev, sizeof(dev->vdev), + TYPE_VIRTIO_SDHCI); +} + +static const VirtioPCIDeviceTypeInfo virtio_sdhci_pci_info = { + .base_name = TYPE_VIRTIO_SDHCI_PCI, + .generic_name = "virtio-sdhci-pci", + .instance_size = sizeof(VirtIOSDHCIPCI), + .class_init = virtio_sdhci_pci_class_init, + .instance_init = virtio_sdhci_pci_instance_init, +}; + +static void virtio_sdhci_pci_register(void) +{ + virtio_pci_types_register(&virtio_sdhci_pci_info); +} + +type_init(virtio_sdhci_pci_register) diff --git a/hw/virtio/virtio.c b/hw/virtio/virtio.c index 7549094154..90a346dfc0 100644 --- a/hw/virtio/virtio.c +++ b/hw/virtio/virtio.c @@ -193,7 +193,8 @@ const char *virtio_device_names[] = { [VIRTIO_ID_PARAM_SERV] = "virtio-param-serv", [VIRTIO_ID_AUDIO_POLICY] = "virtio-audio-pol", [VIRTIO_ID_BT] = "virtio-bluetooth", - [VIRTIO_ID_GPIO] = "virtio-gpio" + [VIRTIO_ID_GPIO] = "virtio-gpio", + [VIRTIO_ID_SDHCI] = "virtio-sdhci", }; static const char *virtio_id_to_name(uint16_t device_id) diff --git a/include/hw/virtio/virtio-sdhci.h b/include/hw/virtio/virtio-sdhci.h new file mode 100644 index 0000000000..0d91f4a973 --- /dev/null +++ b/include/hw/virtio/virtio-sdhci.h @@ -0,0 +1,22 @@ +#ifndef QEMU_VIRTIO_SDHCI_H +#define QEMU_VIRTIO_SDHCI_H + +#include "hw/virtio/virtio.h" +#include "hw/sd/sd.h" +#include "qemu/typedefs.h" + +#define TYPE_VIRTIO_SDHCI "virtio-sdhci-device" +#define VIRTIO_SDHCI(obj) \ + OBJECT_CHECK(VirtIOSDHCI, (obj), TYPE_VIRTIO_SDHCI) +#define VIRTIO_SDHCI_GET_PARENT_CLASS(obj) \ + OBJECT_GET_PARENT_CLASS(VIRTIO_SDHCI(obj), TYPE_VIRTIO_SDHCI) + +typedef struct VirtIOSDHCI { + VirtIODevice parent_obj; + + VirtQueue *vq; + SDBus sdbus; + BlockBackend *blk; +} VirtIOSDHCI; + +#endif diff --git a/include/standard-headers/linux/virtio_ids.h b/include/standard-headers/linux/virtio_ids.h index 7aa2eb7662..7f13999359 100644 --- a/include/standard-headers/linux/virtio_ids.h +++ b/include/standard-headers/linux/virtio_ids.h @@ -68,6 +68,7 @@ #define VIRTIO_ID_AUDIO_POLICY 39 /* virtio audio policy */ #define VIRTIO_ID_BT 40 /* virtio bluetooth */ #define VIRTIO_ID_GPIO 41 /* virtio gpio */ +#define VIRTIO_ID_SDHCI 42 /* virtio sdhci */ /* * Virtio Transitional IDs diff --git a/include/standard-headers/linux/virtio_sdhci.h b/include/standard-headers/linux/virtio_sdhci.h new file mode 100644 index 0000000000..d620441c4a --- /dev/null +++ b/include/standard-headers/linux/virtio_sdhci.h @@ -0,0 +1,39 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later + * + * VirtIO SD/MMC driver + * + * Author: Mikhail Krasheninnikov <krashmi...@gmail.com> + */ +#ifndef _LINUX_VIRTIO_MMC_H +#define _LINUX_VIRTIO_MMC_H +#include <linux/types.h> + +struct mmc_req { + __le32 opcode; + __le32 arg; +}; + +struct virtio_mmc_request { + uint8_t flags; + +#define VIRTIO_MMC_REQUEST_DATA BIT(1) +#define VIRTIO_MMC_REQUEST_WRITE BIT(2) +#define VIRTIO_MMC_REQUEST_STOP BIT(3) +#define VIRTIO_MMC_REQUEST_SBC BIT(4) + + struct mmc_req request; + + uint8_t buf[4096]; + __le32 buf_len; + + struct mmc_req stop_req; + struct mmc_req sbc_req; +}; + +struct virtio_mmc_response { + __le32 cmd_resp[4]; + int cmd_resp_len; + uint8_t buf[4096]; +}; + +#endif /* _LINUX_VIRTIO_MMC_H */ -- 2.34.1
