From 7b3882957685db12f87d7ef3526e585e795efc81 Mon Sep 17 00:00:00 2001 From: Li Fei1 Date: Wed, 12 Aug 2020 12:56:15 +0800 Subject: [PATCH] doc: update document for "--acpidev_pt" and "--mmiodev_pt" features Add guild how to add ACPI device and MMIO device passthrough support through the cmdline. Signed-off-by: Li Fei1 --- doc/user-guides/acrn-dm-parameters.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/user-guides/acrn-dm-parameters.rst b/doc/user-guides/acrn-dm-parameters.rst index 926e0e024..a5f1a4f7d 100644 --- a/doc/user-guides/acrn-dm-parameters.rst +++ b/doc/user-guides/acrn-dm-parameters.rst @@ -276,6 +276,31 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters: enable virtio poll mode with poll interval 1ms. + * - :kbd:`--acpidev_pt ` + - This option is to enable ACPI device passthrough support. The ``HID`` is a + mandatory parameter for this option which is the Hardware ID of the ACPI + device. + + Example:: + + --acpidev_pt MSFT0101 + + To pass through a TPM (which HID is MSFT0101) ACPI device to a User VM. + + * - :kbd:`--mmiodev_pt ` + - This option is to enable MMIO device passthrough support. The ``MMIO_Region`` + is a mandatory parameter for this option which is the MMIO resource of the + MMIO device. The ``MMIO_Region`` needs to be the base address followed by + the length of the region, both separated by a comma. + + Example:: + + --mmiodev_pt 0xFED40000,0x00005000 + + To pass through a MMIO device to a User VM. The MMIO device has a MMIO region. + The base address of this region is 0xFED40000 and the size of the region + is 0x00005000. + * - :kbd:`--vtpm2 ` - This option is to enable virtual TPM support. The sock_path is a mandatory parameter for this option which is the path of swtpm socket fd.