mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-06-24 06:29:19 +00:00
Address review feedback for launch config options, makefile options, intro
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
parent
b203e7e958
commit
6e4e619e17
@ -54,9 +54,9 @@ define post-launched User VM settings. This document describes these option sett
|
|||||||
List of shared memory regions for inter-VM communication.
|
List of shared memory regions for inter-VM communication.
|
||||||
|
|
||||||
``shm_region`` (a child node of ``shm_regions``):
|
``shm_region`` (a child node of ``shm_regions``):
|
||||||
configure the shared memory regions for current VM, input format:
|
Configure the shared memory regions for the current VM, input format:
|
||||||
``hv:/<;shm name>; (or dm:/<shm_name>;), <;shm size in MB>;``. Refer
|
``[hv|dm]:/<shm name>,<shm size in MB>``. Refer to :ref:`ivshmem-hld`
|
||||||
to :ref:`ivshmem-hld` for details.
|
for details.
|
||||||
|
|
||||||
``console_vuart``:
|
``console_vuart``:
|
||||||
Enable a PCI-based console vUART. Refer to :ref:`vuart_config` for details.
|
Enable a PCI-based console vUART. Refer to :ref:`vuart_config` for details.
|
||||||
@ -70,14 +70,14 @@ define post-launched User VM settings. This document describes these option sett
|
|||||||
:ref:`vuart_config` for details.
|
:ref:`vuart_config` for details.
|
||||||
|
|
||||||
``passthrough_devices``:
|
``passthrough_devices``:
|
||||||
Select the passthrough device from the lspci list. Currently we support:
|
Select the passthrough device from the PCI device list. Currently we support:
|
||||||
``usb_xdci``, ``audio``, ``audio_codec``, ``ipu``, ``ipu_i2c``,
|
``usb_xdci``, ``audio``, ``audio_codec``, ``ipu``, ``ipu_i2c``,
|
||||||
``cse``, ``wifi``, ``bluetooth``, ``sd_card``,
|
``cse``, ``wifi``, ``bluetooth``, ``sd_card``,
|
||||||
``ethernet``, ``sata``, and ``nvme``.
|
``ethernet``, ``sata``, and ``nvme``.
|
||||||
|
|
||||||
``network`` (a child node of ``virtio_devices``):
|
``network`` (a child node of ``virtio_devices``):
|
||||||
The virtio network device setting.
|
The virtio network device setting.
|
||||||
Input format: ``tap_name,[vhost],[mac=XX:XX:XX:XX:XX:XX]``.
|
Input format: ``[tap_name|macvtap_name],[vhost],[mac=XX:XX:XX:XX:XX:XX]``.
|
||||||
|
|
||||||
``block`` (a child node of ``virtio_devices``):
|
``block`` (a child node of ``virtio_devices``):
|
||||||
The virtio block device setting.
|
The virtio block device setting.
|
||||||
|
@ -3,15 +3,15 @@
|
|||||||
Hypervisor Makefile Options
|
Hypervisor Makefile Options
|
||||||
###########################
|
###########################
|
||||||
|
|
||||||
The ACRN hypervisor source code provides a makefile to build the ACRN
|
The ACRN hypervisor source code provides a ``Makefile`` to build the ACRN
|
||||||
hypervisor binary and associated components.
|
hypervisor binary and associated components.
|
||||||
|
|
||||||
Assuming that you are at the top level of the ``acrn-hypervisor`` directory,
|
Assuming that you are at the top level of the ``acrn-hypervisor`` directory,
|
||||||
you can run the ``make`` command to start the build. See
|
you can run the ``make`` command to start the build. See
|
||||||
:ref:`acrn_configuration_tool` for information about required input files.
|
:ref:`acrn_configuration_tool` for information about required input files.
|
||||||
|
|
||||||
Build Options
|
Build Options and Targets
|
||||||
*************
|
**************************
|
||||||
|
|
||||||
The following table shows ACRN-specific command-line options:
|
The following table shows ACRN-specific command-line options:
|
||||||
|
|
||||||
@ -33,19 +33,45 @@ The following table shows ACRN-specific command-line options:
|
|||||||
are ``y`` for release version or ``n`` for debug version. (Default
|
are ``y`` for release version or ``n`` for debug version. (Default
|
||||||
is ``n``.)
|
is ``n``.)
|
||||||
|
|
||||||
* - ``hypervisor``
|
* - ``ASL_COMPILER``
|
||||||
- Optional. Build the hypervisor only.
|
- Optional. Use an ``iasl`` compiler that is not in the default path
|
||||||
|
(``/usr/sbin``).
|
||||||
* - ``devicemodel``
|
|
||||||
- Optional. Build the Device Model only.
|
|
||||||
|
|
||||||
* - ``tools``
|
|
||||||
- Optional. Build the tools only.
|
|
||||||
|
|
||||||
* - ``O``
|
* - ``O``
|
||||||
- Optional. Path to the directory where the built files will be stored.
|
- Optional. Path to the directory where the built files will be stored.
|
||||||
(Default is the ``build`` directory.)
|
(Default is the ``build`` directory.)
|
||||||
|
|
||||||
|
The following table shows ACRN-specific targets:
|
||||||
|
|
||||||
|
.. list-table::
|
||||||
|
:widths: 33 77
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Makefile Target
|
||||||
|
- Description
|
||||||
|
|
||||||
|
* - ``hypervisor``
|
||||||
|
- Optional. Build the hypervisor.
|
||||||
|
|
||||||
|
* - ``devicemodel``
|
||||||
|
- Optional. Build the Device Model. The ``tools`` will also be built as
|
||||||
|
a dependency.
|
||||||
|
|
||||||
|
* - ``tools``
|
||||||
|
- Optional. Build the tools.
|
||||||
|
|
||||||
|
* - ``doc``
|
||||||
|
- Optional. Build the project's HTML documentation (using Sphinx), output
|
||||||
|
to the ``build/doc`` folder.
|
||||||
|
|
||||||
|
* - ``life_mngr``
|
||||||
|
- Optional. Build the Lifecycle Manager daemon that runs in the User VM
|
||||||
|
to manage power state transitions (S5).
|
||||||
|
|
||||||
|
* - ``targz-pkg``
|
||||||
|
- Optional. Create a compressed tarball (``acrn-$(FULL_VERSION).tar.gz``)
|
||||||
|
in the build folder (default: ``build``) with all the build artifacts.
|
||||||
|
|
||||||
Example of a command to build the debug version:
|
Example of a command to build the debug version:
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
@ -77,6 +103,12 @@ Example of a command to put the built files in the specified directory
|
|||||||
|
|
||||||
make O=build-nuc BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml
|
make O=build-nuc BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml
|
||||||
|
|
||||||
|
Example of a command that specifies ``iasl`` compiler:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml ASL_COMPILER=/usr/local/bin/iasl
|
||||||
|
|
||||||
ACRN uses XML files to summarize board characteristics and scenario settings.
|
ACRN uses XML files to summarize board characteristics and scenario settings.
|
||||||
The ``BOARD`` and ``SCENARIO`` variables accept board/scenario names as well
|
The ``BOARD`` and ``SCENARIO`` variables accept board/scenario names as well
|
||||||
as paths to XML files. When board/scenario names are given, the build system
|
as paths to XML files. When board/scenario names are given, the build system
|
||||||
@ -175,7 +207,8 @@ it to ``config.patch``:
|
|||||||
acrn-hypervisor$ make hvdiffconfig
|
acrn-hypervisor$ make hvdiffconfig
|
||||||
...
|
...
|
||||||
Diff on generated configuration files is available at /path/to/acrn-hypervisor/build/hypervisor/config.patch.
|
Diff on generated configuration files is available at /path/to/acrn-hypervisor/build/hypervisor/config.patch.
|
||||||
To make a patch effective, use 'applydiffconfig PATCH=/path/to/patch' to register it to a build.
|
To make a patch effective, use 'hvapplydiffconfig PATCH=/path/to/patch' to
|
||||||
|
register it to a build.
|
||||||
...
|
...
|
||||||
acrn-hypervisor$ cp build/hypervisor/config.patch config.patch
|
acrn-hypervisor$ cp build/hypervisor/config.patch config.patch
|
||||||
|
|
||||||
|
@ -143,8 +143,9 @@ configuration files. Although we recommend using the ACRN configuration toolset
|
|||||||
to create these files, this reference may be useful for advanced usage and
|
to create these files, this reference may be useful for advanced usage and
|
||||||
troubleshooting.
|
troubleshooting.
|
||||||
|
|
||||||
ACRN source code offers predefined XMLs in the ``misc/config_tools/data/``
|
ACRN source code offers predefined XMLs, and the generic templates used for
|
||||||
directory of the ``acrn-hypervisor`` repo.
|
new boards and scenarios, in the ``misc/config_tools/data/`` directory of
|
||||||
|
the ``acrn-hypervisor`` repo.
|
||||||
|
|
||||||
Board XML Format
|
Board XML Format
|
||||||
================
|
================
|
||||||
|
Loading…
Reference in New Issue
Block a user