From nobody Sat Apr 20 06:59:00 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1568212511; cv=none; d=zoho.com; s=zohoarc; b=VkxLfpXSlkwPJbaA+3+R0T2oiMGT6tvywe/ClciBIblgqADybY3nABxphnnxwX4Z0pCyMsJlJkkwfSoKK5fctPPfRiz9Vb8cthqzRuLD2lUsENcdzKhumkDmn1Nq6oRuRdqvJ9Phd+/GpXQDUG0KOqrQ9Zl6nhK+f8Nb2ksBJSA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1568212511; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=36FEm0Pc37hridVXAboy9B5/UtHMUTJnSp9yIbkOhRk=; b=B2MmvP+H9diRwwZ2BnJDupDEM05jT3C75emuc3N6klEjx/gPs4MWWa32tAACog63zhIdrq6537D+DzblHkbR7pTQjs+4xktIzRRULZiIUCC7TZR8KUdiCJHqHtFR2yUY0efRVcAw3AMCoUt4B0ODj8Ik6ImFXNgihpOVRpf6qqs= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1568212511566526.6019531367266; Wed, 11 Sep 2019 07:35:11 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B346410C6993; Wed, 11 Sep 2019 14:35:08 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id AA35419C6A; Wed, 11 Sep 2019 14:35:07 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 49BAF24F30; Wed, 11 Sep 2019 14:35:04 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x8BEZ2cD006428 for ; Wed, 11 Sep 2019 10:35:02 -0400 Received: by smtp.corp.redhat.com (Postfix) id 1DC385D6D0; Wed, 11 Sep 2019 14:35:02 +0000 (UTC) Received: from paraplu.localdomain (unknown [10.36.118.107]) by smtp.corp.redhat.com (Postfix) with ESMTP id 26CCD5D6A5; Wed, 11 Sep 2019 14:34:58 +0000 (UTC) From: Kashyap Chamarthy To: libvir-list@redhat.com Date: Wed, 11 Sep 2019 16:34:54 +0200 Message-Id: <20190911143455.15229-1-kchamart@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com Cc: aspiers@suse.com Subject: [libvirt] [PATCH v1] docs: Expand the "BIOS bootloader" documentation for domainCaps X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.65]); Wed, 11 Sep 2019 14:35:10 +0000 (UTC) Content-Type: text/plain; charset="utf-8" Rewrite some parts for clarity, elaborate the meaning of some of the XML attributes. And where necessary, distinguish that we're dealing with two different XML documents here: - the domainCapabilities XML, to detect the host "hypervisor" (QEMU/KVM) capabilities, and what libvirt knows about them. - the guest XML definition, i.e. what features a guest can use, based on the capabilities (of QEMU and libvirt and the host) reported in the domainCapabilities XML. Signed-off-by: Kashyap Chamarthy --- docs/formatdomaincaps.html.in | 53 ++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 19 deletions(-) diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index bc99d378567a553afe682bc522e7a753b2d805fc..a8d970934df2c0ce8c41eb4958c= 94fbdf96ef8e0 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -127,7 +127,7 @@ <value>/usr/share/OVMF/OVMF_CODE.fd</value> <enum name=3D'type'> <value>rom</value> - <value>pflash</value> + <value>pflapsh</value> </enum> <enum name=3D'readonly'> <value>yes</value> @@ -143,38 +143,53 @@ <domainCapabilities> =20 -

The firmware enum corresponds to - firmware attribute of the os element. - Plain presence of this enum means that libvirt is capable of so - called firmware auto selection. The listed values then represent - accepted values for the domain attribute. Only values for which - there exists a firmware descriptor that matches machine type and - architecture are listed, i.e. those which won't cause a failure - on domain startup. +

The firmware enum corresponds to the + firmware attribute of the os element in + the domain XML. The presence of this enum means libvirt is capable + of the so-called firmware auto-selection feature. And the listed + firmware values 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 + -- a small JSON document that describes details about a given UEFI + binary on the host, e.g. the fimware binary path, its + architecture, supported machine type, NVRAM template, etc. This + ensures that the reported values won't cause a failure on guest + boot. (The firmware "descriptor files" are typically shipped + Linux distribution as part of the firmware package, + e.g. EDK2/OVMF.)

=20

For the loader element, the following can occur:

=20
value
-
List of known loader paths. Currently this is only used - to advertise known locations of OVMF binaries for qemu. Binaries - will only be listed if they actually exist on disk.
+
List of known firmware binary paths. Currently this is used + only to advertise the known location of OVMF binaries for + QEMU. OVMF binaries will only be listed if they actually exist on + host.
=20
type
-
Whether loader is a typical BIOS (rom) or - an UEFI binary (pflash). This refers to - type attribute of the <loader/> - element.
+
Whether the boot loader is a typical BIOS (rom) + or a UEFI firmware (pflash). Each value + sub-element under the type enum represents a possible + value for the type attribute for the <loader/> + element in the domain XML. E.g. the presence + of pfalsh under the type enum means that + a domain XML can use UEFI firmware via: <loader/> + type=3D"pflash" ...>/path/to/the/firmware/binary/</loader>. +
=20
readonly
Options for the readonly attribute of the - <loader/> element.
+ <loader/> element in the domain XML. =20
secure
Options for the secure attribute of the - <loader/> element. Note, that yes is listed - only if there is a firmware that supports it.
+ <loader/> element in the domain XML. Note that the + value yes is listed only if libvirt detects a + firmware descriptor file that has path to an OVMF binary that + supports Secure boot, and lists its architecture and supported + machine type.
=20

CPU configuration

--=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list