From patchwork Mon Mar 10 11:12:34 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Dmitry Osipenko X-Patchwork-Id: 872192 Delivered-To: patch@linaro.org Received: by 2002:a5d:64ce:0:b0:38f:210b:807b with SMTP id f14csp936032wri; Mon, 10 Mar 2025 04:42:11 -0700 (PDT) X-Forwarded-Encrypted: i=3; AJvYcCWkQMDnH1cVUK6D3Wjoi2SaNarc69cRoKTNa/LE+d8ZMreRA60+n/nwNwSpCvgAan+vjrsp8Q==@linaro.org X-Google-Smtp-Source: AGHT+IHkTClMrDZwoeYTww8UtrM7oeforS6lrdzPFKC5tEY06P0jPf6dO+66DJK+9tUIYRoTNLSa X-Received: by 2002:a05:620a:284e:b0:7c3:d529:43f3 with SMTP id af79cd13be357-7c4e61b9520mr2039124685a.55.1741606931608; Mon, 10 Mar 2025 04:42:11 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1741606931; cv=pass; d=google.com; s=arc-20240605; b=GaUWTEnVnyIwy1fNcU2aS5NFfrFG6aSKmw4wXWx5vLCf3UdBEpO+l/3GMK7sx3FJut BHxQ2iz8jAiiPQU3huP579aJPuBRbZiPZB5bgaZHTjfRed0axknVDZijx77bULEz7WtQ d9WNuR2xzTsQ11ssRb0XmhpviXLbi5e0XifHy5ntTAqj/gMiWOcuvrFwE7mionPgkxmE N/joDGqm6DHZIcsH3AV1GQvsC6TmnP4zLRmEnh8dF3AljF8Ko6yT/jZte3HPzy+1MsFC OGNN8ubL2P+TkNHAJP7ftFPblx4OWm0h63i4TP9Fw3t24iMrjrkICsYXQSLFgwakMCfN +KQA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; 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=o0nO8wgEsy007jxFJPgqgdWru9rnWTAVfjzhQ4uSOPc=; fh=j2ngPnbUv+er2uRoyxJ/dvQ7gYZ2LB4w1UTG25rpeFs=; b=VM2M5QrjYv44tY05CBWto5BgbdjFOD7V0B+QsdW9zvhfF/00Hu5eBJx6l9d8U9w2P3 iBdOpqgv/0PzgMk3z7+Z1LKgRLN3csgA+ccvZo5CdeMTXievhGkwZ3A+aonz5PD2SYM/ 5F6SiSDlqbnGM7y7vAwgPAGGSG0cTmbFtFUzkYCcOMB7rFVYS8H3wVVgQsJKNNbmRfq/ 1xpgSVlnAh3mhD826tssrZ55miQA5GQAGKc95V1mNSuhDgTd1ur7vNXoXzENoWcA5GN9 W3Ayx7wXUhkR7/zDGisXaxJSImo6Rn9e0kSO8899cYDV3TeZo6186HrIJI9N8n771VTo ksDw==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=CE8nwzZb; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com>); 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=collabora.com Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id af79cd13be357-7c3e536d365si869415885a.189.2025.03.10.04.42.11 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 10 Mar 2025 04:42:11 -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=@collabora.com header.s=zohomail header.b=CE8nwzZb; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com>); 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=collabora.com Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1trb5z-0007hh-7H; Mon, 10 Mar 2025 07:14:56 -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 1trb5v-0007co-GV for qemu-devel@nongnu.org; Mon, 10 Mar 2025 07:14:51 -0400 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1trb5s-0001T0-Vi for qemu-devel@nongnu.org; Mon, 10 Mar 2025 07:14:51 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1741605275; cv=none; d=zohomail.com; s=zohoarc; b=giBLIHPNcwm0QS4j6OG6W+YlrjVnjmx0K9Oo+VEU16/AEc/ek9CfYh/GvKFCeI3TeNY9+UnFtAYDAljnIZFWjolyBoegrYZR3+Tt4htBaNkOApGrP7oCKLS0vtzMzstZIq5yvA3k82ohi18XQi28wt/UAG4iI7VcaA4/tUwooPs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1741605275; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=o0nO8wgEsy007jxFJPgqgdWru9rnWTAVfjzhQ4uSOPc=; b=cWVKUKpgCu0b2m4lQD0ulampNLpwpD+uNTCyxDKFgwYb3BSIawLzuvNNmA8fsU0W7gn7unEWiClDQjvRwR71EocnpzANjJQhLmyN/MnLICYfSmGcO1n3kCKcXG3IEXDz5269dIrAWUOrK1KdICud++RZbthu9CGU6xXyh1OdI+k= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=collabora.com; spf=pass smtp.mailfrom=dmitry.osipenko@collabora.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1741605275; s=zohomail; d=collabora.com; i=dmitry.osipenko@collabora.com; h=From:From:To:To:Cc:Cc:Subject:Subject:Date:Date:Message-ID:In-Reply-To:References:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Reply-To; bh=o0nO8wgEsy007jxFJPgqgdWru9rnWTAVfjzhQ4uSOPc=; b=CE8nwzZbRf1Pgl+UE6OMF+2rMm7xzwMghQY0k/cYl+ybWvJiquNm/twgeCt/ooM2 XgTf7bDsqzathsWdYv4iduSdOQuVw1Hh+ZI9NgZPW1xcvFLNUF5qbSiAzsMY7DygdA2 dfeakIbhf+iiS0g7yFx8h5hhHT1uYUK1oR5obaXs= Received: by mx.zohomail.com with SMTPS id 1741605273382226.80200354697752; Mon, 10 Mar 2025 04:14:33 -0700 (PDT) From: Dmitry Osipenko To: Akihiko Odaki , Huang Rui , =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Gerd Hoffmann , =?utf-8?q?Alex_Benn=C3=A9e?= , Pierre-Eric Pelloux-Prayer , "Michael S . Tsirkin" , Paolo Bonzini Cc: Gert Wollny , qemu-devel@nongnu.org, Gurchetan Singh , Alyssa Ross , =?utf-8?q?Roger_Pau_Monn=C3=A9?= , Alex Deucher , Stefano Stabellini , =?utf-8?q?Christian_K?= =?utf-8?q?=C3=B6nig?= , Xenia Ragiadakou , Honglei Huang , Julia Zhang , Chen Jiqian , Rob Clark , Yiwei Zhang , Sergio Lopez Pascual Subject: [PATCH v10 10/10] docs/system: virtio-gpu: Document host/guest requirements Date: Mon, 10 Mar 2025 14:12:34 +0300 Message-ID: <20250310111234.145891-11-dmitry.osipenko@collabora.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250310111234.145891-1-dmitry.osipenko@collabora.com> References: <20250310111234.145891-1-dmitry.osipenko@collabora.com> MIME-Version: 1.0 X-ZohoMailClient: External Received-SPF: pass client-ip=136.143.188.112; envelope-from=dmitry.osipenko@collabora.com; helo=sender4-pp-f112.zoho.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, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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 From: Alex Bennée This attempts to tidy up the VirtIO GPU documentation to make the list of requirements clearer. There are still a lot of moving parts and the distros have some catching up to do before this is all handled automatically. Signed-off-by: Alex Bennée Cc: Sergio Lopez Pascual Signed-off-by: Dmitry Osipenko [dmitry.osipenko@collabora.com: Extended and corrected doc] --- docs/system/devices/virtio-gpu.rst | 94 +++++++++++++++++++++++++++++- 1 file changed, 91 insertions(+), 3 deletions(-) diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virtio-gpu.rst index ea3eb052df3c..3e4a1e2c87a0 100644 --- a/docs/system/devices/virtio-gpu.rst +++ b/docs/system/devices/virtio-gpu.rst @@ -5,14 +5,28 @@ virtio-gpu ========== This document explains the setup and usage of the virtio-gpu device. -The virtio-gpu device paravirtualizes the GPU and display controller. +The virtio-gpu device provides a GPU and display controller +paravirtualized using VirtIO. It supports a number of different modes +from simple 2D displays to fully accelerated 3D graphics. -Linux kernel support --------------------- +Linux guest kernel support +-------------------------- virtio-gpu requires a guest Linux kernel built with the ``CONFIG_DRM_VIRTIO_GPU`` option. +3D acceleration +--------------- + +3D acceleration of a virtualized GPU is still an evolving field. +Depending on the 3D mode you are running you may need to override +distribution supplied libraries with more recent versions or enable +build options. There are a number of requirements the host must meet +to be able to be able to support guests. QEMU must be able to access the +host's GPU and for the best performance be able to reliably share GPU +memory with the guest. Details of 3D acceleration requirements are +described in a further sections. + QEMU virtio-gpu variants ------------------------ @@ -65,8 +79,14 @@ intermediate representation is communicated to the host and the `virglrenderer`_ library on the host translates the intermediate representation back to OpenGL API calls. +By default OpenGL version on guest is limited to 4.3. In order to enable +OpenGL 4.6 support, virtio-gpu host blobs feature (``hostmem`` and ``blob`` +fields) should be enabled. The ``hostmem`` field specifies the size of +virtio-gpu host memory window. This is typically between 256M and 8G. + .. parsed-literal:: -device virtio-gpu-gl + -device virtio-gpu-gl,hostmem=8G,blob=true .. _virgl: https://docs.mesa3d.org/drivers/virgl.html .. _Gallium3D: https://www.freedesktop.org/wiki/Software/gallium/ @@ -94,6 +114,56 @@ of virtio-gpu host memory window. This is typically between 256M and 8G. .. _drm: https://gitlab.freedesktop.org/virgl/virglrenderer/-/tree/main/src/drm +.. list-table:: Linux Host Requirements + :header-rows: 1 + + * - Capability + - Kernel Version + * - OpenGL pass-through + - Any Linux version compatible with QEMU if not using host blobs feature, + Linux 6.13+ otherwise + * - Vulkan pass-through + - Linux 6.13+ + * - AMDGPU DRM native context + - Linux 6.13+ + * - Freedreno DRM native context + - Linux 6.4+ + * - Intel i915 DRM native context `mr1384`_ + - Linux 6.13+ + * - Asahi DRM native context `mr1274`_ + - `Downstream version`_ of Asahi Linux kernel + +.. _mr1384: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1384 +.. _mr1274: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1274 +.. _Downstream version: https://gitlab.freedesktop.org/asahi/linux + +.. list-table:: Linux Guest Requirements + :header-rows: 1 + + * - Capability + - Kernel Version + - Mesa Version + * - OpenGL pass-through + - Any Linux version supporting virtio-gpu + - 16.0.0+ + * - Vulkan pass-through + - Linux 5.16+ + - 24.2.0+ + * - AMDGPU DRM native context + - Linux 6.14+ + - 25.0.0+ + * - Freedreno DRM native context + - Linux 6.14+ + - 23.1.0+ + * - Intel i915 DRM native context + - Linux 6.14+ + - `mr29870`_ + * - Asahi DRM native context + - Linux 6.14+ + - 24.2.0+ + +.. _mr29870: https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29870 + virtio-gpu rutabaga ------------------- @@ -133,3 +203,21 @@ Surfaceless is the default if ``wsi`` is not specified. .. _Wayland display passthrough: https://www.youtube.com/watch?v=OZJiHMtIQ2M .. _gfxstream-enabled rutabaga: https://crosvm.dev/book/appendix/rutabaga_gfx.html .. _guest Wayland proxy: https://crosvm.dev/book/devices/wayland.html + +.. list-table:: Linux Host Requirements + :header-rows: 1 + + * - Capability + - Kernel version + * - Vulkan+Wayland pass-through + - Linux 6.13+ + +.. list-table:: Linux Guest Requirements + :header-rows: 1 + + * - Capability + - Kernel Version + - Mesa Version + * - Vulkan+Wayland pass-through + - Linux 5.16+ + - 24.3.0+