OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Address review comments 

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes 2021-09-23 16:13:24 -07:00 committed by David Kinder
parent 0ac609b5d8
commit b203e7e958
5 changed files with 35 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/develop.rst
View File

@ -42,7 +42,7 @@ User VM Tutorials
tutorials/using_vxworks_as_uos
tutorials/using_zephyr_as_uos
Configuration and Tools
Configuration Tutorials
***********************
.. rst-class:: rst-columns2
@ -59,12 +59,8 @@ Configuration and Tools
reference/hv-make-options
user-guides/hv-parameters
user-guides/kernel-parameters
user-guides/acrn-shell
user-guides/acrn-dm-parameters
misc/debug_tools/acrn_crashlog/README
misc/packaging/README
misc/debug_tools/**
misc/services/acrn_manager/**
Advanced Features
********************
@ -100,9 +96,14 @@ Debug
.. rst-class:: rst-columns2
.. toctree::
:glob:
:maxdepth: 1
tutorials/using_serial_port
tutorials/debug
tutorials/realtime_performance_tuning
tutorials/rtvm_performance_tips
user-guides/acrn-shell
misc/debug_tools/acrn_crashlog/README
misc/debug_tools/**
misc/services/acrn_manager/**

11
doc/reference/config-options-launch.rst
View File

@ -7,8 +7,7 @@ As explained in :ref:`acrn_configuration_tool`, launch configuration files
define post-launched User VM settings. This document describes these option settings.
``uos``:
Specify the User VM with its relative ID to Service VM by the ``id``
attribute.
Specify the User VM ``id`` to the Service VM.
``uos_type``:
Specify the User VM type, such as ``CLEARLINUX``, ``ANDROID``, ``ALIOS``,
@ -22,10 +21,8 @@ define post-launched User VM settings. This document describes these option sett
Specify the User VM memory size in megabytes.
``gvt_args``:
GVT arguments for the VM. Set it to ``gvtd`` for GVT-d, otherwise it's
for GVT-g arguments. The GVT-g input format:
``low_gm_size high_gm_size fence_sz``,
The recommendation is ``64 448 8``. Leave it blank to disable the GVT.
GVT arguments for the VM. Set it to ``gvtd`` for GVT-d. Leave it blank
to disable the GVT.
``vbootloader``:
Virtual bootloader type; currently only supports OVMF.
@ -41,7 +38,7 @@ define post-launched User VM settings. This document describes these option sett
power button, or vUART.
``allow_trigger_s5``:
Allow VM to trigger s5 shutdown flow, this flag works with
Allow the VM to trigger S5 shutdown flow. This flag works with
``poweroff_channel``
``vuart1(pty)`` and ``vuart1(tty)`` only.

3
doc/reference/hv-make-options.rst
View File

@ -7,7 +7,8 @@ The ACRN hypervisor source code provides a makefile to build the ACRN
hypervisor binary and associated components.
Assuming that you are at the top level of the ``acrn-hypervisor`` directory,
you can run the ``make`` command to start the build. See :ref:`acrn_configuration_tool` for information about required input files.
you can run the ``make`` command to start the build. See
:ref:`acrn_configuration_tool` for information about required input files.
Build Options
*************

24
doc/tutorials/acrn_configuration_tool.rst
View File

@ -84,7 +84,8 @@ You can specify the following information in a scenario configuration:
- Settings of virtual devices, such as virtual UARTs.
You need a scenario configuration file to build an ACRN hypervisor. The
build process uses the file to build a hypervisor that can initialize its capabilities and set up the VMs at runtime.
build process uses the file to build a hypervisor that can initialize its
capabilities and set up the VMs at runtime.
The scenario configuration defines User VMs as follows:
@ -106,7 +107,8 @@ post-launched User VMs. The file defines certain attributes and
resources of the post-launched VMs specified in the scenario configuration
file. We call these settings "dynamic" because they are used at runtime.
You need a launch configuration file to generate a launch script (shell script) for each post-launched User VM. The launch script invokes the
You need a launch configuration file to generate a launch script (shell script)
for each post-launched User VM. The launch script invokes the
Service VM's :ref:`Device Model <hld-devicemodel>` ``acrn-dm`` to create
the VM. Unlike board and scenario configurations used at build time or by
ACRN hypervisor, launch configurations are used dynamically in the Service VM.
@ -122,18 +124,24 @@ and edit configuration data. The toolset consists of the following:
* :ref:`Board inspector tool <board_inspector_tool>`
* :ref:`ACRN configurator tool <acrn_configurator_tool>`
As introduced in :ref:`overview_dev`, configuration takes place at Steps 3 and 4 in the overall development process:
As introduced in :ref:`overview_dev`, configuration takes place at
:ref:`overview_dev_board_config` and :ref:`overview_dev_config_editor` in
the overall development process:
.. image:: ../getting-started/images/overview_flow.png
ACRN source also includes makefile targets to aid customization. See :ref:`hypervisor-make-options`.
ACRN source also includes makefile targets to aid customization. See
:ref:`hypervisor-make-options`.
.. _acrn_config_data:
ACRN Configuration Data
***********************
The following sections explain the format of the board, scenario, and launch configuration files. Although we recommend using the ACRN configuration toolset to create these files, this reference may be useful for advanced usage and troubleshooting.
The following sections explain the format of the board, scenario, and launch
configuration files. Although we recommend using the ACRN configuration toolset
to create these files, this reference may be useful for advanced usage and
troubleshooting.
ACRN source code offers predefined XMLs in the ``misc/config_tools/data/``
directory of the ``acrn-hypervisor`` repo.
@ -153,7 +161,8 @@ The ``board`` attribute defines the board name and must match the
configuration file. The file name of the board configuration file
(example: ``my_board.xml``) doesn’t affect the board name.
Board XML files are input to the ACRN configurator tool and the build system, and are not intended for end users to modify.
Board XML files are input to the ACRN configurator tool and the build system,
and are not intended for end users to modify.
Scenario XML Format
===================
@ -168,7 +177,8 @@ The scenario XML has an ``acrn-config`` root element as well as ``board`` and
The ``board`` attribute specifies the board name and must match the ``board``
attribute in the board configuration file.
The ``scenario`` attribute specifies the scenario name, followed by hypervisor and VM settings.
The ``scenario`` attribute specifies the scenario name, followed by hypervisor
and VM settings.
See :ref:`scenario-config-options` for a full explanation of available scenario
XML elements.

10
doc/tutorials/acrn_configurator_tool.rst
View File

@ -45,7 +45,8 @@ overview of what to expect:
Generate a Scenario Configuration File and Launch Scripts
*********************************************************
The following steps describe all options in the ACRN configurator for generating a custom scenario configuration file and launch scripts.
The following steps describe all options in the ACRN configurator for generating
a custom scenario configuration file and launch scripts.
#. Make sure the development computer is set up and ready to launch the ACRN
configurator, according to :ref:`gsg-dev-setup` in the Getting Started Guide.
@ -68,7 +69,7 @@ The following steps describe all options in the ACRN configurator for generating
#. Start the scenario configuration process by selecting an option from the
**Scenario Setting** menu on the top banner of the UI or by importing a
scenario configuration file via the **Import XML** button. The 4 options
scenario configuration file via the **Import XML** button. The four options
are described below:
* Click **Create a new scenario** from the **Scenario Setting** menu to
@ -131,7 +132,8 @@ The following steps describe all options in the ACRN configurator for generating
.. image:: images/err_acrn_configuration.png
:align: center
After the scenario is saved, the page automatically displays the saved scenario configuration file.
After the scenario is saved, the page automatically displays the saved
scenario configuration file.
#. To delete a scenario configuration file, click **Export XML** > **Remove**.
The configurator will delete the loaded file, even if you change the name of
@ -144,7 +146,7 @@ The following steps describe all options in the ACRN configurator for generating
#. Start the launch script configuration process by
selecting an option from the **Launch Setting** menu on the top banner of
the UI or by importing a launch configuration file via the **Import XML**
button. The 4 options are described below:
button. The four options are described below:
* Click **Create a new launch script** from the **Launch Setting** menu to
dynamically create a new launch configuration for the current board.