From patchwork Mon Jul 10 15:35:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 701040 Delivered-To: patch@linaro.org Received: by 2002:adf:fcc5:0:0:0:0:0 with SMTP id f5csp5246531wrs; Mon, 10 Jul 2023 08:44:35 -0700 (PDT) X-Google-Smtp-Source: APBJJlH32YJkQ7onBw95RX8F9PXUEiU2hxdRBTZZouUHq+oqyW5aYaU3yPUXXNLWpH6OE4rQfGm4 X-Received: by 2002:a67:ead2:0:b0:443:4f72:fd35 with SMTP id s18-20020a67ead2000000b004434f72fd35mr6273963vso.1.1689003875681; Mon, 10 Jul 2023 08:44:35 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689003875; cv=none; d=google.com; s=arc-20160816; b=fe99hMIqlvstiOk9hBg0Tk0Wp2E5z2IL5Oar4/wEs7ZxXdGzIv2q5PqjujtahD5RzS GMnKYss67ZJtueHAWkW07Xt2zdvqbrFKY3cODXxibvb00rZcQjZDSU2vtLfbDjbfaqJ1 OBPrYHke/9ClkzMokK1mYGopI/dT8AnkxzXTsgqMPG5wpQ97weZiui+HyPpSEpoDs4i2 Tkx68nrR3QcOMp9WlJ431mQ/Paro4ThIQMSHiTwcg15u+LrtuYPxlKruPZzBSk8vTwp8 jYL2PDrzRgoDCETywfzRKQB/iTFBf0SkNb2vGfy/TZnXBWehMm2Ued361rk4tcoQNf6+ A9Rw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=AJso+7/SyOzlPSfGsjFdKvvog0Z+6+yUR2hdcAwaBfc=; fh=pHpVzH22N3up2JSv0jV3vGkBG2/OCgsTpbbdQUlofss=; b=EclKfq16N5ohEv6OvTkxcDNe1gWo0Jf5yIcV/m072mPBlzAa0DCvBPUXPXAV776opC DjGaE7BDHrwWWwog8PcKPbnzQF9dLbM3JRew8ahsLuZlHxKiHmpRP0HuFbGEVYvelOO5 Djf5r5q/3RfYJQGh1Shw5qwkj6gxom+5bHDjecuwnmCZ1KQWPJFrzCGnYm1aUE4GiCN7 rBwv2DplgDhEOlclv6r4zWYbZXeR/X+sJf9fwY9R5CxykXr0bdRNq1W5XHZ5i47wCwYv lA1T/Mv1VdZyzG9ann2fph9S6szvh4tJT6FBKTBukX/0zDorm+r/GFdt4CVVDkOyPy3i UU/Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=MutJX7em; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id x3-20020a0ce243000000b00626291257a6si5569109qvl.305.2023.07.10.08.44.35 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 10 Jul 2023 08:44:35 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=MutJX7em; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qIt2v-0002XX-4w; Mon, 10 Jul 2023 11:43:29 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qIt2t-0002WU-Bk for qemu-devel@nongnu.org; Mon, 10 Jul 2023 11:43:27 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qIt2q-0006Lv-M9 for qemu-devel@nongnu.org; Mon, 10 Jul 2023 11:43:27 -0400 Received: by mail-wr1-x436.google.com with SMTP id ffacd0b85a97d-31438512cafso5037494f8f.2 for ; Mon, 10 Jul 2023 08:43:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1689003802; x=1691595802; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=AJso+7/SyOzlPSfGsjFdKvvog0Z+6+yUR2hdcAwaBfc=; b=MutJX7emGU8QPyPA59RtM1I5kKlSSAidzSGGfKrRgsv11216aNl7PXId0QQU0m6W9J kHL4Eb2rXMOQqQTZgcLmLeTksnZRcvY1ErYZBDeBOySKM/ww0rU2Rr3smYl1FhJN0Ty7 QJrFU9oocvL+vmc/Bx7Z/KJ3CTzdoDFaCBgcwvTnFEegXYES6XbkJEQLXgiUnNMq1Ysc 1AZF9EOnlU1Uvz/M5uFTWDDzYjRveuU/vJzNhFy/huSrObmQQQepk3UYUs9f63mxO86E MJovmWlhQQ8kwXuW9WuhWTxkIH+8r9xN8D+8Ug2UJy7MexKFU8FutQUpxEEreiFj7qNs AeZg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689003802; x=1691595802; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=AJso+7/SyOzlPSfGsjFdKvvog0Z+6+yUR2hdcAwaBfc=; b=GnPSr3VXDRxk03FIZGlJJdKLpNoflqj5edJ0tMJFipAXJ1zMNnHLurDVcC+YQ1obZU z49zYUseTbvA2gEfm4GaXu2b3ZzgyABKM31D4VlYJ9woLSN0Fuw5bDH0fs9whHt/17d+ J4+FSpNoB2X6NkaHyTC3PLtAx/RruD3B/xYqcrDypdPNfbWSI827+p60jT5mbuq3fAym O9JiZ//NNArMHspVmCDQAfli6EpwfhF98nJ7yYOGvrq065ZniGEMR1G0JWnMHv/MXJw3 jAUCsGxgd8X6t1kAIPnpP/HBxS2O+pPgv0rcJhj32HiQzc//QNJYAlwQRQ1KDNfyZQtm APzw== X-Gm-Message-State: ABy/qLbHY73PGlDpiHWemYUDH5vBVPytHummZKEZwBwViqGFPl2/vfBq oQQ4LM1+RXZhXS5SqB4htQicDQ== X-Received: by 2002:a5d:5749:0:b0:313:e741:1caa with SMTP id q9-20020a5d5749000000b00313e7411caamr14204318wrw.25.1689003802026; Mon, 10 Jul 2023 08:43:22 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id 24-20020a05600c22d800b003fbaade072dsm191143wmg.23.2023.07.10.08.43.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Jul 2023 08:43:21 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id B26E01FFC8; Mon, 10 Jul 2023 16:35:23 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , Jason Wang , Viresh Kumar , Raphael Norwitz , Paolo Bonzini , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , qemu-block@nongnu.org, Eric Blake , "Michael S. Tsirkin" , Mark Cave-Ayland , Kevin Wolf , Markus Armbruster , Gerd Hoffmann , Mathieu Poirier , Hanna Reitz , =?utf-8?q?Alex_Benn=C3=A9e?= , Erik Schilling , "Gonglei (Arei)" , Eduardo Habkost , Fam Zheng , virtio-fs@redhat.com, Stefan Hajnoczi Subject: [RFC PATCH v3 13/20] docs/system: add a basic enumeration of vhost-user devices Date: Mon, 10 Jul 2023 16:35:15 +0100 Message-Id: <20230710153522.3469097-14-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230710153522.3469097-1-alex.bennee@linaro.org> References: <20230710153522.3469097-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x436.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org Make it clear the vhost-user-device is intended for expert use only. Signed-off-by: Alex Bennée --- v2 - make clear vhost-user-device for expert use --- docs/system/devices/vhost-user-rng.rst | 2 ++ docs/system/devices/vhost-user.rst | 41 ++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/docs/system/devices/vhost-user-rng.rst b/docs/system/devices/vhost-user-rng.rst index a145d4105c..ead1405326 100644 --- a/docs/system/devices/vhost-user-rng.rst +++ b/docs/system/devices/vhost-user-rng.rst @@ -1,3 +1,5 @@ +.. _vhost_user_rng: + QEMU vhost-user-rng - RNG emulation =================================== diff --git a/docs/system/devices/vhost-user.rst b/docs/system/devices/vhost-user.rst index a80e95a48a..0f9eec3f00 100644 --- a/docs/system/devices/vhost-user.rst +++ b/docs/system/devices/vhost-user.rst @@ -15,6 +15,47 @@ to the guest. The code is mostly boilerplate although each device has a ``chardev`` option which specifies the ID of the ``--chardev`` device that connects via a socket to the vhost-user *daemon*. +Each device will have an virtio-mmio and virtio-pci variant. See your +platform details for what sort of virtio bus to use. + +.. list-table:: vhost-user devices + :widths: 20 20 60 + :header-rows: 1 + + * - Device + - Type + - Notes + * - vhost-user-device + - Generic Development Device + - You must manually specify ``virtio-id`` and the correct ``num_vqs``. Intended for expert use. + * - vhost-user-blk + - Block storage + - + * - vhost-user-fs + - File based storage driver + - See https://gitlab.com/virtio-fs/virtiofsd + * - vhost-user-scsi + - SCSI based storage + - See contrib/vhost-user/scsi + * - vhost-user-gpio + - Proxy gpio pins to host + - See https://github.com/rust-vmm/vhost-device + * - vhost-user-i2c + - Proxy i2c devices to host + - See https://github.com/rust-vmm/vhost-device + * - vhost-user-input + - Generic input driver + - See contrib/vhost-user-input + * - vhost-user-rng + - Entropy driver + - :ref:`vhost_user_rng` + * - vhost-user-gpu + - GPU driver + - + * - vhost-user-vsock + - Socket based communication + - See https://github.com/rust-vmm/vhost-device + vhost-user daemon =================