From nobody Tue Mar 3 04:53:03 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1771871724; cv=none; d=zohomail.com; s=zohoarc; b=Flv5h30oXfH+uMbKxCo/UUjaXoSLKKajLJZ71oiKScGA5GUKcvykgQWJ5CW9J0qQKgJapm28jRKPBHoDhzGOyx5gfDcyAiRR5Mq6A1c+Jh9FzC5NFhDsKfsED2REbvFgNSQ55YSK4oye2Eb8l0MsIKEmRGMjBxHmqmKdMbJ8LfE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1771871724; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=+8bRe8ccxhh0YgPR91m84D7Ubk5bWIyzV/NXW3kt4ws=; b=W2/sz6fLtSug2fZzFVwT5vDVcZ7Urxpit7NvLjXozN4URBW368ahps9eS7g2Vd1f8FyaO0tqau06F5kAU9pWGfnIiGGti8/FRQYbIIHD4vPtD1rkFdTOYaKmFhKGp+CPK1odny4HHugQxQpLo8brSEG/ojGldcZYV5z69zANhZk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1771871723907231.2848353986285; Mon, 23 Feb 2026 10:35:23 -0800 (PST) Received: by lists.libvirt.org (Postfix, from userid 993) id 210E241BE8; Mon, 23 Feb 2026 13:35:23 -0500 (EST) Received: from [172.19.199.9] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id BD01B41C04; Mon, 23 Feb 2026 13:31:56 -0500 (EST) Received: by lists.libvirt.org (Postfix, from userid 993) id 05461419C9; Mon, 23 Feb 2026 13:31:52 -0500 (EST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 7B74F41A55 for ; Mon, 23 Feb 2026 13:31:32 -0500 (EST) Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-696-SZjh6Jg0PuO4UkkQKC91hg-1; Mon, 23 Feb 2026 13:31:30 -0500 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A32481956094 for ; Mon, 23 Feb 2026 18:31:29 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.44.32.20]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5E2421955D71 for ; Mon, 23 Feb 2026 18:31:27 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HELO_MISC_IP,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1771871492; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=+8bRe8ccxhh0YgPR91m84D7Ubk5bWIyzV/NXW3kt4ws=; b=PN1ShiqbvNuoelqP1f37zI/B2aDrVzOUGSTw3/Njc1phEMpziwo6VnYKH7mJ32yJpUGypI K4oiaxQp+7IhCqMbOKGnd4C4zGyQkdltqlsvnr6+WUUBnRC4hBAGNflLKXbe9qvpEf07dA HbYsLpPM3WS/QPbd7wWpFLZWB5FMdMA= X-MC-Unique: SZjh6Jg0PuO4UkkQKC91hg-1 X-Mimecast-MFC-AGG-ID: SZjh6Jg0PuO4UkkQKC91hg_1771871489 To: devel@lists.libvirt.org Subject: [PATCH v4 02/36] docs: Improvement related to firmware selection Date: Mon, 23 Feb 2026 19:30:45 +0100 Message-ID: <20260223183119.501349-3-abologna@redhat.com> In-Reply-To: <20260223183119.501349-1-abologna@redhat.com> References: <20260223183119.501349-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: Py7fjhlscfvDFWTK8R4OtBJNP6mA7ud1bihPNMzDQdY_1771871489 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: WPI3J6DMI74AESOVDSQUGTZQEBVDVDOE X-Message-ID-Hash: WPI3J6DMI74AESOVDSQUGTZQEBVDVDOE X-MailFrom: abologna@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Andrea Bolognani via Devel Reply-To: Andrea Bolognani X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1771871726206158500 Content-Type: text/plain; charset="utf-8"; x-default="true" Recommend that users take advantage of firmware autoselection and discourage providing paths manually. Signed-off-by: Andrea Bolognani Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/formatdomaincaps.rst | 59 ++++++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 25 deletions(-) diff --git a/docs/formatdomaincaps.rst b/docs/formatdomaincaps.rst index 22a6d5d067..3426b7c9cd 100644 --- a/docs/formatdomaincaps.rst +++ b/docs/formatdomaincaps.rst @@ -145,15 +145,17 @@ domains. ... =20 -The ``firmware`` enum corresponds to the ``firmware`` attribute of the ``o= s`` -element in the domain XML. The presence of this enum means libvirt is capa= ble of -the so-called firmware auto-selection feature. And the listed firmware val= ues -represent the accepted input in the domain XML. Note that the ``firmware``= enum -reports only those values for which a firmware "descriptor file" exists on= the -host. Firmware descriptor file is a small JSON document that describes det= ails -about a given BIOS or UEFI binary on the host, e.g. the firmware binary pa= th, -its architecture, supported machine types, NVRAM template, etc. This ensur= es -that the reported values won't cause a failure on guest boot. +The presence of the ``firmware`` enum means that libvirt can perform firmw= are +autoselection, and each of the values is guaranteed to be usable. In the +domain XML, firmware autoselection is enabled as follows: + +:: + + + ... + +Autoselection is the recommended mechanism for configuring the guest firmw= are. +Providing paths and other information manually is discouraged. =20 The ```` element :since:`(since 12.1.0)` contains one enum for each of the features that can be used to fine-tune the firmware @@ -196,27 +198,34 @@ such as: would not work, since ``no`` is not one of the valid values advertised by the ``secureBoot`` enum. =20 -For the ``loader`` element, the following can occur: +The information contained in the ```` element is not relevant when +using firmware autoselection, which is the recommended approach to guest +firmware configuration, and as such can largely be ignored. Its subelements +are the following: =20 ``value`` - List of known firmware binary paths. Currently this is used only to adv= ertise - the known location of OVMF binaries for QEMU. OVMF binaries will only be - listed if they actually exist on host. + One element for each known firmware binary present on the system. + + Note that a binary being present here indicates that the file exists an= d it + is compatible with the architecture/machine type, but does not provide = any + insight into which mechanism (see ``type`` below) should be used to loa= d it. ``type`` - Whether the boot loader is a typical BIOS (``rom``) or a UEFI firmware - (``pflash``). Each ``value`` sub-element under the ``type`` enum repres= ents a - possible value for the ``type`` attribute for the element in = the - domain XML. E.g. the presence of ``pfalsh`` under the ``type`` enum mea= ns - that a domain XML can use UEFI firmware via: type=3D"pflash" - ...>/path/to/the/firmware/binary/. + Whether firmware can be loaded using a ``pflash`` device (UEFI only) or= as + a ``rom`` (either UEFI or BIOS). ``readonly`` - Options for the ``readonly`` attribute of the element in the = domain - XML. + Supported values for the ``readonly`` attribute of the ```` el= ement + in the domain XML. ``secure`` - Options for the ``secure`` attribute of the element in the do= main - XML. Note that the value ``yes`` is listed only if libvirt detects a fi= rmware - descriptor file that has path to an OVMF binary that supports Secure bo= ot, - and lists its architecture and supported machine type. + Supported values for the ``secure`` attribute of the ```` elem= ent + in the domain XML. + + Note that the value ``yes`` is listed if libvirt detects a firmware + descriptor file that points to a firmware binary that implements Secure + Boot and is compatible with the architecture/machine type, but the UEFI + variable store template associated with it might not have the usual set= of + Secure Boot certificates enrolled. To figure out whether it's actually + possible to enforce Secure Boot, look at the ``enrolledKeys`` enum insi= de + the ```` element instead. =20 CPU configuration ~~~~~~~~~~~~~~~~~ --=20 2.53.0