From dd54ea500be80f347402d75f3e4e7061e7db78d2 Mon Sep 17 00:00:00 2001 From: Viresh Kumar Date: Wed, 14 Dec 2022 12:03:38 +0100 Subject: [PATCH] docs: add documentation for generic virtio devices This patch updates xl.cfg man page with details of generic Virtio device related information. Signed-off-by: Viresh Kumar Reviewed-by: Anthony PERARD Reviewed-by: Oleksandr Tyshchenko --- docs/man/xl.cfg.5.pod.in | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in index ec444fb2ba..024bceeb61 100644 --- a/docs/man/xl.cfg.5.pod.in +++ b/docs/man/xl.cfg.5.pod.in @@ -1585,6 +1585,39 @@ Set maximum height for pointer device. =back +=item B + +Specifies the Virtio devices to be provided to the guest. + +Each B is a comma-separated list of C settings +from the following list. As a special case, a single comma is allowed in the +VALUE of the "type" KEY, where the VALUE is set with "virtio,device". + +=over 4 + +=item B + +Specifies the backend domain name or id, defaults to dom0. + +=item B + +Specifies the compatible string for the specific Virtio device. The same will be +written in the Device Tree compatible property of the Virtio device. For +example, "type=virtio,device22" for the I2C device, whose device-tree binding is +present here: + +L + +For generic virtio devices, where we don't need to set special or compatible +properties in the Device Tree, the type field must be set to "virtio,device". + +=item B + +Specifies the transport mechanism for the Virtio device, only "mmio" is +supported for now. + +=back + =item B B Set TEE type for the guest. TEE is a Trusted Execution -- 2.39.5