github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-09 12:08:30 +00:00
Code Issues Projects Releases Wiki Activity

doc: add documentation for allow_trigger_s5 in pm_notify_channel

Browse Source 
Tracked-On: #6034
Signed-off-by: Peter Fang <peter.fang@intel.com>
This commit is contained in:
Peter Fang 2021-05-20 03:02:55 -07:00 committed by David Kinder
parent c66bbe9e67
commit b068656e71
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/developer-guides/hld/hld-devicemodel.rst
View File

@ -59,7 +59,7 @@ options:
[--acpidev_pt HID] [--mmiodev_pt MMIO_regions] [--acpidev_pt HID] [--mmiodev_pt MMIO_regions]
[--vtpm2 sock_path] [--virtio_poll interval] [--mac_seed seed_string] [--vtpm2 sock_path] [--virtio_poll interval] [--mac_seed seed_string]
[--cpu_affinity pCPUs] [--lapic_pt] [--rtvm] [--windows] [--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] <vm> [--pm_by_vuart vuart_node] [--ssram] <vm>
-A: create ACPI tables -A: create ACPI tables
-B: bootargs for kernel -B: bootargs for kernel

5
doc/tutorials/enable_s5.rst
View File

@ -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. 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 .. 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 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`` ``initiate a connection on a socket error``
``create socket to connect life-cycle manager failed`` ``create socket to connect life-cycle manager failed``

8
doc/user-guides/acrn-dm-parameters.rst
View File

@ -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 This option is used to define which channel could be used DM to
communicate with VM about power management event. 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:: usage::
--pm_notify_channel ioc --pm_notify_channel ioc
Use ioc as power management event motify channel. Use ioc as power management event notify channel.
---- ----