From patchwork Fri Apr 14 16:04:33 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: 673140 Delivered-To: patch@linaro.org Received: by 2002:adf:fcce:0:0:0:0:0 with SMTP id f14csp263236wrs; Fri, 14 Apr 2023 09:07:05 -0700 (PDT) X-Google-Smtp-Source: AKy350YAj1SZdY00/7iEeW5J+Cyevw0nmrESQWW2NsSDG3nMjcV4d9/Evh6P4wRYNs64sLC75AIV X-Received: by 2002:a05:6214:4106:b0:5ac:fb9a:67a1 with SMTP id kc6-20020a056214410600b005acfb9a67a1mr4204359qvb.47.1681488425036; Fri, 14 Apr 2023 09:07:05 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1681488425; cv=none; d=google.com; s=arc-20160816; b=cqVBjyOBAaxube5TQWKMLwP82Q4frxll1ZoZJhGlUbMVuXj0iO3WkQcB1/xTYdmKi3 bOQ1R3jLvPAFuCKYcdyp/lafZk1vfbw9COY5umMy232aaIkO/HAbW5CNENgkbO2ytGpb CNWYzYHNlPI1MFvf/0U85wXHoDZUj17hRhuZ6vL3GNOCdGOGi+U7yotnFhhD9HVKvQXY QYrAyZa/jHdThOHuOcnPgRuChRaEtOeHO/AMmmNwHRA2W2iqfTsEQCBMB7eqg9DLoaG2 m6EW8WGMraQBNIvU6pNxV7om/0o/GaL6uYqWrJoJT1A5ks2dY9GWVCv6ayaPuLVnmkun v5sw== 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=+fMbxBkambXkAbitMf0yYS02jxY28hzasoKde2tZwkQ=; b=LOBpMwO6e8A1CkSSgonvc1Gufrs+n0cVUbqcDelhSyLUljMefQofXtnjpT/V0olNOi 5eLOuHhvRPWLTyge48/+ICR8ldNbQ0eysqJJZYVB2e0pyU6MYGJE9BIShm9fidBc65z7 08C1AvQcTxQfQqIjerKRlcg2nT7HFfPQ4U4BFxI7ZqZXKvLp0ilqQJuSWrVGENfxmzxq TzeuEs6LXcYYt1siKwdlaElejLKcFlHUd8glWKOZayjJ8eAvjuWSLGXmxqS2EvBSM6ma 1wpPG2k2kGhmCjTtjhAbGUP6aWuoe6VfPHoDmKYmaB9icOAVdlxu9v1TJikDs2mEggyh PXtA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=JzT83oWw; 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 u14-20020ad45aae000000b0056cbb225837si2739430qvg.274.2023.04.14.09.07.04 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 14 Apr 2023 09:07:05 -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=JzT83oWw; 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 1pnLvC-00071p-WE; Fri, 14 Apr 2023 12:05:11 -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 1pnLum-0006SI-8D for qemu-devel@nongnu.org; Fri, 14 Apr 2023 12:04:49 -0400 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pnLuj-00080C-Lb for qemu-devel@nongnu.org; Fri, 14 Apr 2023 12:04:43 -0400 Received: by mail-wr1-x434.google.com with SMTP id e7so7952801wrc.12 for ; Fri, 14 Apr 2023 09:04:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1681488280; x=1684080280; 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=+fMbxBkambXkAbitMf0yYS02jxY28hzasoKde2tZwkQ=; b=JzT83oWwmcqo5vxYHf7Q0VBydrgskgxPELCHECrV8WCxaWUzoW+ygyTWrZO1KT6jaV WhZ4NSBP07w2197lRXsJQ/8mxpxuLIb24HPgVVVwz59lobN+NRy4wIk2k5EnZZFqE0BC 1xUkBZUJ4m2bNzbp076SC7zV8B2HJRczuz1oMjJA7SijSMrCgIaJIGDuYqGi2u8QDozp Hp6i59+cRulDDQFMx+wto/9mHA0SP+dS4exQksC9TuiugH7FYigmhYPhmvuJCJV4guUG p60oVzJu0PnkfRDBuA7mpEZx0KZ8769JGl+4wTwSab/LZ3axpFysAcTF/DgnWD2BVeRm 3IzA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1681488280; x=1684080280; 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=+fMbxBkambXkAbitMf0yYS02jxY28hzasoKde2tZwkQ=; b=SeAmTFvk3Y+Qn89S6brg6wqLhV8XPVPI1RZ8OzUBTMjgwK+tQPtjdkSy+uMnFznHB1 eGsyT6QtJ9q6xaSPG/qiNSZOhprs8P/5INrM6uyzoFNRFbrOoOa4VyJzQ2aJ8182wU5x xHy8dY30u7YIjbC/CxwIqS3KKtXCUb6UUPSeKZWqAr6K555vVG/KjMkz1m77WeJN1xP7 LFZn3YvdqBr8niuGa9vAcuWZwG3P3h+2WR0JJvSKW2uCyLKqkV1Vj2BzyMxQ1JHmnC4l P25Q0dki/nGMtz8HaayemyfXLL0C6PbBOjlUF/RI4lCUfgviRhD8MP7S89rwHNQGAwbq yBnA== X-Gm-Message-State: AAQBX9doEba6k1mYJ/80nudeaoJNaid6zu1Yigzn1YVmQ2FDyGFipZg1 AoQMIR3IbrnFepVcIFQEdZxfag== X-Received: by 2002:adf:f312:0:b0:2f8:2d4:74ef with SMTP id i18-20020adff312000000b002f802d474efmr177006wro.43.1681488280161; Fri, 14 Apr 2023 09:04:40 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id f4-20020adff584000000b002f008477522sm3851238wro.24.2023.04.14.09.04.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 Apr 2023 09:04:39 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 359F31FFBB; Fri, 14 Apr 2023 17:04:35 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: "Gonglei (Arei)" , Paolo Bonzini , "Michael S. Tsirkin" , virtio-fs@redhat.com, Erik Schilling , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Marc-Andr?= =?utf-8?q?=C3=A9_Lureau?= , Eduardo Habkost , Stefan Hajnoczi , Eric Blake , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Jason Wang , Viresh Kumar , Mathieu Poirier , Gerd Hoffmann , Markus Armbruster Subject: [PATCH 12/12] docs/system: add a basic enumeration of vhost-user devices Date: Fri, 14 Apr 2023 17:04:33 +0100 Message-Id: <20230414160433.2096866-13-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230414160433.2096866-1-alex.bennee@linaro.org> References: <20230414160433.2096866-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::434; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x434.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 Signed-off-by: Alex Bennée --- 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 86128114fa..99b352823e 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 + - You must manually specify ``virtio-id`` and the correct ``num_vqs`` + * - 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 =================