github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-03 18:46:33 +00:00
Code Issues Projects Releases Wiki Activity

doc: Update references to scenario options doc

Browse Source 
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
This commit is contained in:
Reyes, Amy 2022-09-01 10:11:07 -07:00 committed by Amy Reyes
parent c0e0c1a92a
commit 3eea8d6da8
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -131,6 +131,6 @@ Disable Split-Locked Access Detection
If the CPU supports Split-locked Access detection, the ACRN hypervisor If the CPU supports Split-locked Access detection, the ACRN hypervisor
uses it to prevent any VM running with potential system performance uses it to prevent any VM running with potential system performance
impacting split-locked instructions. This detection can be disabled impacting split-locked instructions. This detection can be disabled
(by changing the :option:`hv.FEATURES.ENFORCE_TURNOFF_AC` setting in (by deselecting the :term:`Enable split lock detection` option in
the ACRN Configurator tool) for customers not the ACRN Configurator tool) for customers not
caring about system performance. caring about system performance.

5
doc/tutorials/rtvm_performance_tips.rst
View File

@ -189,8 +189,9 @@ Tip: Disable the software workaround for Machine Check Error on Page Size Change
By default, the software workaround for Machine Check Error on Page Size By default, the software workaround for Machine Check Error on Page Size
Change is conditionally applied to the models that may be affected by the Change is conditionally applied to the models that may be affected by the
issue. However, the software workaround has a negative impact on issue. However, the software workaround has a negative impact on
performance. If all guest OS kernels are trusted, the performance. If all guest OS kernels are trusted, you can disable the
:option:`hv.FEATURES.MCE_ON_PSC_DISABLED` option could be set for performance. software workaround (by deselecting the :term:`Enable MCE workaround` option
in the ACRN Configurator tool) for performance.
.. note:: .. note::
The tips for preempt-RT Linux are mostly applicable to the Linux-based RTOS as well, such as Xenomai. The tips for preempt-RT Linux are mostly applicable to the Linux-based RTOS as well, such as Xenomai.

15
doc/tutorials/using_grub.rst
View File

@ -18,8 +18,8 @@ The ACRN hypervisor can boot from the `multiboot protocol
with the multiboot protocol, the multiboot2 protocol adds UEFI support. with the multiboot protocol, the multiboot2 protocol adds UEFI support.
The multiboot protocol is supported by the ACRN hypervisor natively. The The multiboot protocol is supported by the ACRN hypervisor natively. The
multiboot2 protocol is supported when :option:`hv.FEATURES.MULTIBOOT2` is multiboot2 protocol is supported when the :term:`Multiboot2` option is
enabled in the scenario configuration. The :option:`hv.FEATURES.MULTIBOOT2` is enabled in the scenario configuration. The :term:`Multiboot2` option is
enabled by default. To load the hypervisor with the multiboot protocol, run the enabled by default. To load the hypervisor with the multiboot protocol, run the
GRUB ``multiboot`` command. To load the hypervisor with the multiboot2 protocol, GRUB ``multiboot`` command. To load the hypervisor with the multiboot2 protocol,
run the ``multiboot2`` command. To load a VM kernel or ramdisk, run the run the ``multiboot2`` command. To load a VM kernel or ramdisk, run the
@ -29,13 +29,14 @@ for the multiboot2 protocol.
The ACRN hypervisor binary is built with two formats: ``acrn.32.out`` in The ACRN hypervisor binary is built with two formats: ``acrn.32.out`` in
ELF format and ``acrn.bin`` in RAW format. The GRUB ``multiboot`` ELF format and ``acrn.bin`` in RAW format. The GRUB ``multiboot``
command supports ELF format only and does not support binary relocation, command supports ELF format only and does not support binary relocation,
even if :option:`hv.FEATURES.RELOC` is set. The GRUB ``multiboot2`` even if the :term:`Hypervisor relocation` option is set in the scenario
command supports configuration. The GRUB ``multiboot2`` command supports
ELF format when :option:`hv.FEATURES.RELOC` is not set, or RAW format when ELF format when the :term:`Hypervisor relocation` option is not set, or RAW
:option:`hv.FEATURES.RELOC` is set. format when the :term:`Hypervisor relocation` option is set.
.. note:: .. note::
* :option:`hv.FEATURES.RELOC` is set by default, so use ``acrn.32.out`` in * The :term:`Hypervisor relocation` option is set by default, so use
``acrn.32.out`` in
the multiboot protocol and ``acrn.bin`` in the multiboot2 protocol. the multiboot protocol and ``acrn.bin`` in the multiboot2 protocol.
* Per ACPI specification, the RSDP pointer is described in the EFI System * Per ACPI specification, the RSDP pointer is described in the EFI System