[PATCH 1/7] docs: introduce crypto device
Introduce crypto device like:
<crypto model='virtio' type='qemu'>
<backend model='builtin' queues='1'/>
<address type='pci' domain='0x0000' bus='0x00'
slot='0x0a' function='0x0'/>
</crypto>
<crypto model='virtio' type='qemu'>
<backend model='lkcf'/>
<address type='pci' domain='0x0000' bus='0x00'
slot='0x0b' function='0x0'/>
</crypto>
Currently, crypto model supports virtio only, type supports qemu only
(vhost-user in the plan). For the qemu type, backend supports modle
builtin/lkcf, and the queues is optional.
Signed-off-by: zhenwei pi <pizhenwei(a)bytedance.com>
---
docs/formatdomain.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index d7fffc6e0b..2b46f6c966 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -8225,6 +8225,27 @@ The optional ``driver`` element allows to specify virtio options,
see
...
+Crypto
+~~~~~~
+
+A crypto device. The ``model`` attribute defaults to ``virtio``.
+:since:`Since v9.0.0` ``model`` supports ``virtio`` only. The ``type`` attribute
+defaults to ``qemu``. :since:`Since v9.0.0` ``type`` supports ``qemu`` only.
+The optional attribute ``backend`` is required if the ``type`` is ``qemu``, the
+``model`` attribute can be ``builtint`` and ``lkcf``, the optional attribute
+``queues`` specifies the number of virt queues for virtio crypto.
+
+::
+
+ ...
+ <devices>
+ <crypto model='virtio' type='qemu'>
+ <backend model='builtin' queues='1'/>
+ </crypto>
+ </devices>
+ ...
+
+
Security label
--------------
--
2.34.1