From: Michal Privoznik <mprivozn@redhat.com>
Date: Tue, 12 Jul 2022 14:10:08 +0000 (+0200)
Subject: docs: Document TPM portion of domcaps
X-Git-Tag: v8.6.0-rc1~107
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6a00c565c4d0f0ec970e043ea2686bd30396ed79;p=thirdparty%2Flibvirt.git

docs: Document TPM portion of domcaps

Surprisingly, we don't document TPM part of domain capabilities.
Fortunately, the information exposed is pretty much self
explanatory, but we should document it regardless.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
---

diff --git a/docs/formatdomaincaps.rst b/docs/formatdomaincaps.rst
index 933469b2a2..3c425a9a4a 100644
--- a/docs/formatdomaincaps.rst
+++ b/docs/formatdomaincaps.rst
@@ -494,6 +494,35 @@ instance:
 ``driverType``
    Options for the ``type`` attribute of the <filesystem><driver> element.
 
+TPM device
+^^^^^^^^^^
+
+TPM device capabilities are exposed under the ``tpm`` element. For instance:
+
+::
+
+  <domainCapabilities>
+    ...
+    <devices>
+      <tpm supported='yes'>
+        <enum name='model'>
+          <value>tpm-tis</value>
+          <value>tpm-crb</value>
+        </enum>
+        <enum name='backendModel'>
+          <value>passthrough</value>
+          <value>emulator</value>
+        </enum>
+      </tpm>
+      ...
+    </devices>
+  </domainCapabilities>
+
+``model``
+   Options for the ``model`` attribute of the ``<tpm/>`` element.
+``backendModel``
+   Options for the ``type`` attribute of the ``<tpm><backend/>`` element.
+
 Features
 ~~~~~~~~