github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-23 01:37:44 +00:00
Code Issues Projects Releases Wiki Activity

doc: Change "configuration tool" to "ACRN configurator tool"

Browse Source 
- Change "configuration tool" to "ACRN configurator tool" to match the tool's UI
- Change "configuration toolset" to "ACRN configurator tool" in cases that clearly refer to the configurator and not the entire toolset, update cross-ref

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes
2021-10-05 11:27:57 -07:00
committed by David Kinder
parent 7bcfd58f05
commit b9cad70614
6 changed files with 21 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/tutorials/enable_ivshmem.rst
View File

@@ -13,14 +13,15 @@ Enable Ivshmem Support
**********************
The ``ivshmem`` solution is disabled by default in ACRN. You can enable
it using the :ref:`ACRN configuration toolset <acrn_config_workflow>` with these
it using the :ref:`ACRN configurator tool <acrn_configurator_tool>` with these
steps:
- Enable ``ivshmem`` via ACRN configuration tool GUI.
- Enable ``ivshmem`` via ACRN configurator tool GUI.
- Set :option:`hv.FEATURES.IVSHMEM.IVSHMEM_ENABLED` to ``y``
- Edit :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` to specify the shared memory name, size and
- Edit :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` to specify the shared
memory name, size and
communication VMs. The ``IVSHMEM_REGION`` format is ``shm_name,shm_size,VM IDs``:
- ``shm_name`` - Specify a shared memory name. The name needs to start
@@ -59,13 +60,15 @@ where
- ``shm_size`` - Shared memory size of selected ``shm_name``.
There are two ways to insert above boot parameter for ``acrn-dm``
There are two ways to insert the above boot parameter for ``acrn-dm``:
- Manually edit launch script file, in this case, user shall ensure that both
``shm_name`` and ``shm_size`` match with that are defined via configuration tool GUI.
- Manually edit the launch script file. In this case, ensure that both
``shm_name`` and ``shm_size`` match those defined via the ACRN configurator
tool.
- Use the command following below format to create a launch script, when IVSHMEM is enabled
and :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` is properly configured via configuration tool GUI.
- Use the following command to create a launch script, when IVSHMEM is enabled
and :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` is properly configured via
the ACRN configurator tool.
.. code-block:: none
:emphasize-lines: 5
@@ -73,7 +76,7 @@ There are two ways to insert above boot parameter for ``acrn-dm``
python3 misc/config_tools/launch_config/launch_cfg_gen.py \
--board <path_to_your_boardxml> \
--scenario <path_to_your_scenarioxml> \
--launch <path_to_your_launched_script_xml> \
--launch <path_to_your_launch_script_xml> \
--uosid <desired_single_vmid_or_0_for_all_vmids>
.. note:: This device can be used with real-time VM (RTVM) as well.

2
doc/tutorials/vuart_configuration.rst
View File

@@ -12,7 +12,7 @@ only works on a single function.
Only two vUART configurations are added to the predefined scenarios,
but you can customize the scenarios to enable more using the :ref:`ACRN
configuration toolset <acrn_config_workflow>`.
configurator tool <acrn_configurator_tool>`.
Console Enable List
===================