From patchwork Sun Jan 19 22:00:50 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Dmitry Osipenko X-Patchwork-Id: 858669 Delivered-To: patch@linaro.org Received: by 2002:a05:6000:cc8:b0:385:e875:8a9e with SMTP id dq8csp1666222wrb; Sun, 19 Jan 2025 14:04:08 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCVDzyjzMjXcdHIWMG6/zjpvh0+Ot+MFV5x4cVkHS0/FvAEwUoDIDdZdNMKc7T1+RAhGXshrIg==@linaro.org X-Google-Smtp-Source: AGHT+IF9aA6IlgoHPApYe6JKf+rrWeUCA9eNHaC5VrDc1vG0OA0Ltr7PUsDPCppfau4XCXWR2A+A X-Received: by 2002:a05:622a:1104:b0:467:8734:994f with SMTP id d75a77b69052e-46e12874653mr166477001cf.0.1737324248166; Sun, 19 Jan 2025 14:04:08 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1737324248; cv=pass; d=google.com; s=arc-20240605; b=NgjKf4qTsDIZ+3PLlT4XLKo9tRQYona/PaPfVpbTrNRGpUOiZ1dnvKuGB6yqTphnFx RmKZqRP5Gwu83eS+8af7O4DYfbdDMPIYtarzqnfVPOElwVQK7vgSnEZjOOZSlK5N0QXA UpzcBFIrVpRA0ggbkcUcRXvLubAPJs46KioVcLmF/rJqDYUh2z6IInI2PymiFcJMuJSE mz7WZVQy5b91a3kBVlmSqACGAl0mgGtW+LWnxg5kQOsiZR7Ze+wxKAz7WFGQs6yMyX2Q r53uJdefve7DuWIyQBXs4EAo+mnGMkUtCCRxYgqo8FN0y9KgtzBJNX3a+BjSA+kbC1N9 ew+A== 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=E4PT0wmlHRKJpXGJ+7b/TX4o4/zJZJUFB/7QjAhc710=; fh=qYoSDApLgNJs8TuYcqYHcnVKd7dwrie/M7rCnAIDNJI=; b=GjB3Zok/K55bB2D9CF815zjCP0/nt9pq3MfxtOS4t8PmhUKMD4egDHKqT/wTu97aOA JfHSOy1iLKRjL9PZOfRDaE8nNVXuj3kW+dcy5b9TdyVrNA9ejZ44oNW/4QCYh1uqv4on Dt5aPL0vEYTcW+bNzo0xP8af0lISni75iiHDgd/Y7iPbDtQe5FBJImvA/ssOvTTXu8Vr oseZHigPeu+yJFBetPvQjitZfUHPiBAOWU+KZa70hZ/Wh+7rRMdJic8G+5ob765y1Nbm 8ZCajxu1AujYKSS2wMnlsM8ILrxrNJOcawgAfMayV1AiLV+jWUa2xa+SEf9FlE/NtY19 hPfg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=GMs+tmBj; 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 6a1803df08f44-6e1afbfafdesi83270956d6.82.2025.01.19.14.04.07 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Sun, 19 Jan 2025 14:04:08 -0800 (PST) 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=GMs+tmBj; 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 1tZdNj-00079j-IQ; Sun, 19 Jan 2025 17:02:59 -0500 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 1tZdNY-00072U-7K for qemu-devel@nongnu.org; Sun, 19 Jan 2025 17:02:52 -0500 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 1tZdNW-0008Bj-EV for qemu-devel@nongnu.org; Sun, 19 Jan 2025 17:02:47 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1737324156; cv=none; d=zohomail.com; s=zohoarc; b=lg9xK0Nx0osMbbP8vddK+2oN+uEyoR5MNUkRiG0qptVW9qmgsA6IgVz9gQoI+tNY10vBA5zbrCoSKwZN/T/M1V7l0RxDlEaufgyOHobMfS2zMSaeKMYh81T9yy4E9aAZb7Pb2dd1Ix7u5lrq22ANfLFdBR8wryw1rVByd3t2+IY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1737324156; 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=E4PT0wmlHRKJpXGJ+7b/TX4o4/zJZJUFB/7QjAhc710=; b=CIEWSigYWth1spiVLcfxXjTSmVd3KWxRn9609FH5CIyolCEiB+rVtYOiGA7fW6SdJKQKnJEz+Dw20fcPVPAelKT/ZF9Pch/ve9+jE8Uz0tUzNDZzdYCyAEIwO3CIACVFxce0NprCh4e0xs2vA1o+zKWuxYO1EBwYs0rTKGXKYIA= 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=1737324156; 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=E4PT0wmlHRKJpXGJ+7b/TX4o4/zJZJUFB/7QjAhc710=; b=GMs+tmBjIE8tKMZWUuk9PEdTUGuDkeTLJSZPbH37XXmqTAxa+WwarGbyNRUaRdGB JY8hKhE5gC13gKUPzTeuVff13TikexvPU0rDcFi7/BVY/VOAQSGWGcX7bsHXPuM1qIl H2pxLf77fydEgLWESs88hVPqCjIujeueHGTD14XA= Received: by mx.zohomail.com with SMTPS id 1737324153798380.37430422816954; Sun, 19 Jan 2025 14:02:33 -0800 (PST) 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?= , "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 , Pierre-Eric Pelloux-Prayer , Honglei Huang , Julia Zhang , Chen Jiqian , Rob Clark , Yiwei Zhang , Sergio Lopez Pascual Subject: [PATCH v5 8/8] docs/system: Expand the virtio-gpu documentation Date: Mon, 20 Jan 2025 01:00:50 +0300 Message-ID: <20250119220050.15167-9-dmitry.osipenko@collabora.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250119220050.15167-1-dmitry.osipenko@collabora.com> References: <20250119220050.15167-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_H2=-0.024, 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: Dmitry Osipenko 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, 88 insertions(+), 6 deletions(-) diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virtio-gpu.rst index f20c60016376..79af291a9316 100644 --- a/docs/system/devices/virtio-gpu.rst +++ b/docs/system/devices/virtio-gpu.rst @@ -4,14 +4,96 @@ virtio-gpu ========== -This document explains the setup and usage of the virtio-gpu device. -The virtio-gpu device paravirtualizes the GPU and display controller. - -Linux kernel support --------------------- +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. + +Dependencies +............ + +.. note:: + GPU virtualisation is still an evolving field. Depending on the mode + you are running you may need to override distribution supplied + libraries with more recent versions or enable build options. + +Host requirements +----------------- + +Depending on the mode there are a number of requirements the host must +meet to be able to be able to support guests. For 3D acceleration QEMU +must be able to access the hosts GPU and for the best performance be +able to reliably share GPU memory with the guest. + +.. list-table:: Host Requirements + :header-rows: 1 + + * - Mode + - Kernel + - Userspace + * - virtio-gpu + - framebuffer enabled + - GTK or SDL display + * - virtio-gpu-gl (OpenGL pass-through) + - GPU enabled + - libvirglrenderer (virgl support) + * - virtio-gpu-gl (rutabaga/gfxstream) + - GPU enabled + - aemu/rutabaga_gfx_ffi or vhost-user client with support + * - virtio-gpu-gl (Vulkan pass-through) + - Linux 6.13+ + - libvirglrenderer (>= 1.0.0, venus support) + * - virtio-gpu-gl (vDRM native context/AMD) + - Linux 6.13+ + - libvirglrenderer (>= 1.1.0, DRM renderer support) + * - virtio-gpu-gl (vDRM native context/Freedreno) + - Linux 6.13+ + - libvirglrenderer (>= 1.0.0, DRM renderer support) + * - virtio-gpu-gl (vDRM native context/Intel i915) + - Linux 6.13+ + - libvirglrenderer (`mr1384`_, DRM renderer support) + +.. _mr1384: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1384 + +Guest requirements +------------------ virtio-gpu requires a guest Linux kernel built with the -``CONFIG_DRM_VIRTIO_GPU`` option. +``CONFIG_DRM_VIRTIO_GPU`` option. Otherwise for 3D accelerations you +will need support from Mesa configured for whichever encapsulation you +need. + +.. list-table:: Guest Requirements + :header-rows: 1 + + * - Mode + - Mesa Version + - Mesa build flags + * - virtio-gpu + - n/a + - n/a + * - virtio-gpu-gl (OpenGL pass-through) + - 20.3.0+ + - -Dgallium-drivers=virgl + * - virtio-gpu-gl (rutabaga/gfxstream) + - 24.3.0+ + - -Dvulkan-drivers=gfxstream + * - virtio-gpu-gl (Vulkan pass-through) + - 24.2+ + - -Dvulkan-drivers=virtio + * - virtio-gpu-gl (vDRM native context/AMD) + - 25.0.0+ + - -Dgallium-drivers=radeonsi -Dvulkan-drivers=amd -Damdgpu-virtio=true + * - virtio-gpu-gl (vDRM native context/Freedreno) + - 23.1.0+ + - -Dgallium-drivers=freedreno -Dvulkan-drivers=freedreno + * - virtio-gpu-gl (vDRM native context/Intel i915) + - `mr29870`_ + - -Dgallium-drivers=iris -Dvulkan-drivers=intel -Dintel-virtio-experimental=true + +.. _mr29870: https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29870 + +Further information +................... QEMU virtio-gpu variants ------------------------