From b068656e719a0809a0341f51cb24cc18fe9f4f7e Mon Sep 17 00:00:00 2001 From: Peter Fang Date: Thu, 20 May 2021 03:02:55 -0700 Subject: [PATCH] doc: add documentation for allow_trigger_s5 in pm_notify_channel Tracked-On: #6034 Signed-off-by: Peter Fang --- doc/developer-guides/hld/hld-devicemodel.rst | 2 +- doc/tutorials/enable_s5.rst | 5 +++-- doc/user-guides/acrn-dm-parameters.rst | 8 ++++++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/developer-guides/hld/hld-devicemodel.rst b/doc/developer-guides/hld/hld-devicemodel.rst index 649e1d39f..a418e0348 100644 --- a/doc/developer-guides/hld/hld-devicemodel.rst +++ b/doc/developer-guides/hld/hld-devicemodel.rst @@ -59,7 +59,7 @@ options: [--acpidev_pt HID] [--mmiodev_pt MMIO_regions] [--vtpm2 sock_path] [--virtio_poll interval] [--mac_seed seed_string] [--cpu_affinity pCPUs] [--lapic_pt] [--rtvm] [--windows] - [--debugexit] [--logger-setting param_setting] [--pm_notify_channel] + [--debugexit] [--logger-setting param_setting] [--pm_notify_channel channel] [--pm_by_vuart vuart_node] [--ssram] -A: create ACPI tables -B: bootargs for kernel diff --git a/doc/tutorials/enable_s5.rst b/doc/tutorials/enable_s5.rst index c81186af8..5af3c44a0 100644 --- a/doc/tutorials/enable_s5.rst +++ b/doc/tutorials/enable_s5.rst @@ -58,9 +58,10 @@ the request via vUART to the lifecycle manager in the Service VM which in turn a the request and trigger the following flow. .. note:: The User VM need to be authorized to be able to request a Shutdown, this is achieved by adding - "``--pm_notify_channel uart``" in the launch script of that VM. + "``--pm_notify_channel uart,allow_trigger_s5``" in the launch script of that VM. And, there is only one VM in the system can be configured to request a shutdown. If there is a second User - VM launched with "``--pm_notify_channel uart``", ACRN will stop launching it and throw out below error message: + VM launched with "``--pm_notify_channel uart,allow_trigger_s5``", ACRN will stop launching it and throw + out below error message: ``initiate a connection on a socket error`` ``create socket to connect life-cycle manager failed`` diff --git a/doc/user-guides/acrn-dm-parameters.rst b/doc/user-guides/acrn-dm-parameters.rst index 1c0d43ecd..8ff1569ee 100644 --- a/doc/user-guides/acrn-dm-parameters.rst +++ b/doc/user-guides/acrn-dm-parameters.rst @@ -417,13 +417,17 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters: This option is used to define which channel could be used DM to communicate with VM about power management event. - ACRN supports three channels: ``ioc``, ``power button`` and ``uart``. + ACRN supports three channels: ``ioc``, ``power_button`` and ``uart``. + + For ``uart``, an additional option, ``,allow_trigger_s5``, can be added. + A user can use this option to indicate the User VM is allowed to trigger + system S5. usage:: --pm_notify_channel ioc - Use ioc as power management event motify channel. + Use ioc as power management event notify channel. ----