From patchwork Mon Oct 9 09:59:37 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: 1845160 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=BfXsAS1y; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=patchwork.ozlabs.org) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4S3vh91tV3z1yq7 for ; Mon, 9 Oct 2023 21:01:45 +1100 (AEDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qpn3N-0006YD-AI; Mon, 09 Oct 2023 05:59:57 -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 1qpn3I-0006W2-Ll for qemu-devel@nongnu.org; Mon, 09 Oct 2023 05:59:53 -0400 Received: from mail-wm1-x331.google.com ([2a00:1450:4864:20::331]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qpn3A-00081s-Go for qemu-devel@nongnu.org; Mon, 09 Oct 2023 05:59:52 -0400 Received: by mail-wm1-x331.google.com with SMTP id 5b1f17b1804b1-4053c6f0db8so39625505e9.3 for ; Mon, 09 Oct 2023 02:59:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1696845582; x=1697450382; darn=nongnu.org; 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=BfXsAS1yLf7PWlcK5eW9WMiTiYS/Bpqf7hupxQVJiKNxGoT3kfYYBoOE5qNd/shnZw WiZCz4stA4BTN4cqSKAzjvWDe1vy27W6wSMFgmhCMEgeHftt+km5Xwws3A72tgtn8D92 lhj/LJ+ACu4f1eMOoctsZtGZahNDwivPoBOB6uyGm2wDY3Z0gTxYpavu6Pv8BWvM3wfe YdzkdDuXXF9Cztq/kST13ZsqAeXie7db1XuVsMtKPdOWFiXtG3R3h4T0WU38FZRqZEP/ fTc440OK/7j/1+RSd360sjtk3rk/zRbKlPw73WGJ0Q6b7Xn9XTk+d2g/EH6UjoQIExSB 9Z/Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696845582; x=1697450382; 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=Fro6xf8mR7CaU3ggO6cv/04TnadgBNDeYETw6jQjPBK2ebB4NhpW9nsArZCEACcJ/H C/Svf8yqdN3k57RugAS6j/cbdyAOD0KySjQDoZjSPjda75PIQXgMUnX+3oNEfcz+2EsM Wm38PTUOcuez4fKddKmARyDKGYeDJG6XUSnCl7v+wRrNTQbDyDzCgK6mojEw7ULf6xlW Rb4E9zcdKJ3cdtx7EzYB+TuVbhSVUOypHqtpaMJ3vmfdsOkIJ6b363WQ2+oSOyTLUbMb pGtg0wbTr/X98mj9yechd7QBEA+MN6htVKnYrBfQ+4w5+sJ2NDk9z+c55Gpve8XT9+Wt ylTw== X-Gm-Message-State: AOJu0YxXpEg6el2FN0ZkV3iMEOPei5aXQsBz2jBQFi9bEE/RNK2lmm3v l4/BLseNAUG+gHoBVg2NXrxhTQ== X-Google-Smtp-Source: AGHT+IHIB3GMWmvvvfK6rgpZdV/gO0cMpR8mFDzuZzytA0h5Wb4qnN2DHerTFBXlAVsZnwKG/gdZoA== X-Received: by 2002:a05:600c:684:b0:406:8496:bd8c with SMTP id a4-20020a05600c068400b004068496bd8cmr12735162wmn.20.1696845581748; Mon, 09 Oct 2023 02:59:41 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id u7-20020a7bc047000000b004063cced50bsm10735289wmc.23.2023.10.09.02.59.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 09 Oct 2023 02:59:41 -0700 (PDT) Received: from zen.linaroharston (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id EC7331FFC1; Mon, 9 Oct 2023 10:59:38 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , Erik Schilling , Fam Zheng , Mathieu Poirier , Gerd Hoffmann , Hanna Reitz , Stefan Hajnoczi , =?utf-8?q?Alex_Benn=C3=A9e?= , Kevin Wolf , Eric Blake , "Michael S. Tsirkin" , qemu-block@nongnu.org, Eduardo Habkost , Paolo Bonzini , Mark Cave-Ayland , Viresh Kumar , virtio-fs@redhat.com, "Gonglei (Arei)" , Markus Armbruster , Jason Wang , Raphael Norwitz , =?utf-8?q?Daniel_P=2E_Berran?= =?utf-8?q?g=C3=A9?= Subject: [PATCH v4 6/6] docs/system: add a basic enumeration of vhost-user devices Date: Mon, 9 Oct 2023 10:59:37 +0100 Message-Id: <20231009095937.195728-7-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231009095937.195728-1-alex.bennee@linaro.org> References: <20231009095937.195728-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::331; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x331.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 autolearn=unavailable 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+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.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 =================