From 5ec5d9f57887bcd8031fb9bbe3a63b66c5e7122f Mon Sep 17 00:00:00 2001 From: "Yang,Yu-chu" Date: Tue, 8 Jun 2021 15:13:55 -0700 Subject: [PATCH] doc: add missing parameters description of launch script xml Add allow_trigger_s5, enable_ptm, console_vuart and communication_vuart descriptions. Tracked-On: #6138 Signed-off-by: Yang,Yu-chu --- doc/tutorials/acrn_configuration_tool.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/tutorials/acrn_configuration_tool.rst b/doc/tutorials/acrn_configuration_tool.rst index ca53a0f23..eb640e1e0 100644 --- a/doc/tutorials/acrn_configuration_tool.rst +++ b/doc/tutorials/acrn_configuration_tool.rst @@ -322,6 +322,13 @@ current scenario has: Specify whether the User VM power off channel is through the IOC, power button, or vUART. +``allow_trigger_s5``: + Allow VM to trigger s5 shutdown flow, this flag works with ``poweroff_channel`` + ``vuart1(pty)`` and ``vuart1(tty)`` only. + +``enable_ptm``: + Enable the Precision Timing Measurement (PTM) feature. + ``usb_xhci``: USB xHCI mediator configuration. Input format: ``bus#-port#[:bus#-port#: ...]``, e.g.: ``1-2:2-4``. @@ -334,6 +341,15 @@ current scenario has: configure the shared memory regions for current VM, input format: ``hv:/<;shm name>;, <;shm size in MB>;``. Refer to :ref:`ivshmem-hld` for details. +``console_vuart``: + Enable a PCI-based console vUART. Refer to :ref:`vuart_config` for details. + +``communication_vuarts``: + List of PCI-based communication vUARTs. Refer to :ref:`vuart_config` for details. + +``communication_vuart`` (a child node of ``communication_vuarts``): + Enable a PCI-based communication vUART with its ID. Refer to :ref:`vuart_config` for details. + ``passthrough_devices``: Select the passthrough device from the lspci list. Currently we support: ``usb_xdci``, ``audio``, ``audio_codec``, ``ipu``, ``ipu_i2c``,