github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-24 06:29:19 +00:00
Code Issues Projects Releases Wiki Activity

doc: Editorial changes to v3.1 release notes

Browse Source 
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
This commit is contained in:
Reyes, Amy 2022-09-23 14:44:13 -07:00 committed by Amy Reyes
parent 6cff9d8f30
commit 82413ca7ce
1 changed files with 34 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/release_notes/release_notes_3.1.rst
View File

@ -1,7 +1,7 @@
.. _release_notes_3.1: .. _release_notes_3.1:
ACRN v3.1 (Sep 2022) Draft ACRN v3.1 (Sep 2022)
########################## ####################
We are pleased to announce the release of the Project ACRN hypervisor We are pleased to announce the release of the Project ACRN hypervisor
version 3.1. version 3.1.
@ -48,7 +48,7 @@ More ACRN Configuration Improvements
If you have feedback on this, or other aspects of ACRN, please share them on If you have feedback on this, or other aspects of ACRN, please share them on
the `ACRN users mailing list <https://lists.projectacrn.org/g/acrn-users>`_. the `ACRN users mailing list <https://lists.projectacrn.org/g/acrn-users>`_.
As with the v3.0 release, We've simplified installation of the Configurator by providing a Debian As with the v3.0 release, we've simplified installation of the Configurator by providing a Debian
package that you can download from the `ACRN v3.1 tag assets package that you can download from the `ACRN v3.1 tag assets
<https://github.com/projectacrn/acrn-hypervisor/releases/download/v3.1/acrn-configurator-3.1.deb>`_ <https://github.com/projectacrn/acrn-hypervisor/releases/download/v3.1/acrn-configurator-3.1.deb>`_
and install. See the :ref:`gsg` for more information. and install. See the :ref:`gsg` for more information.
@ -73,21 +73,20 @@ Sample Application with Two Post-Launched VMs
launched on your target system running ACRN. One VM is a real-time VM running launched on your target system running ACRN. One VM is a real-time VM running
`cyclictest `cyclictest
<https://wiki.linuxfoundation.org/realtime/documentation/howto/tools/cyclictest/start>`__, <https://wiki.linuxfoundation.org/realtime/documentation/howto/tools/cyclictest/start>`__,
an open source application commonly used to measure latencies in real-time an open-source application commonly used to measure latencies in real-time
systems. This real-time VM (RT_VM) uses inter-VM shared memory (IVSHMEM) to systems. This real-time VM (RT_VM) uses inter-VM shared memory (IVSHMEM) to
send data to a second Human-Machine Interface VM (HMI_VM) that formats and send data to a second Human-Machine Interface VM (HMI_VM) that formats and
presents the collected data as a histogram on a web page shown by a browser. presents the collected data as a histogram on a web page shown by a browser.
This guide shows how to configure, create, and launch the two VM images that This guide shows how to configure, create, and launch the two VM images that
make up this application. Full code for the sample application is provided in make up this application. Full code for the sample application is provided in
the acrn-hypervisor GitHub repo :acrn_file:`misc/sample_application`. the ``acrn-hypervisor`` GitHub repo :acrn_file:`misc/sample_application`.
Multiple-Displays Support for VMs Multiple-Displays Support for VMs
The virtio-gpu mechanism is enhanced to support VMs with multiple displays. The virtio-gpu mechanism is enhanced to support VMs with multiple displays.
TODO: add reference to tutorial
Improved TSC frequency reporting Improved TSC Frequency Reporting
The hypervisor now reports TSC frequency in KHz so that VMs can get that number The hypervisor now reports Time Stamp Counter (TSC) frequency in KHz so that
without calibrating to a high precision timer. VMs can get that number without calibrating to a high precision timer.
Upgrading to v3.1 from Previous Releases Upgrading to v3.1 from Previous Releases
**************************************** ****************************************
@ -98,15 +97,15 @@ scenario XML file and launch scripts. Scenario XML files and launch scripts
created by previous ACRN versions will not work with the v3.1 ACRN hypervisor created by previous ACRN versions will not work with the v3.1 ACRN hypervisor
build process and could produce unexpected errors during the build. build process and could produce unexpected errors during the build.
Given the scope of changes for the v3.1 release, we have recommendations for Given the scope of changes for the v3.1 release, we have recommendations for how
how to upgrade from prior ACRN versions: to upgrade from prior ACRN versions:
1. Start fresh from our :ref:`gsg`. This is the best way to ensure you have a 1. Start fresh from our :ref:`gsg`. This is the best way to ensure you have a
v3.1-ready board XML file from your target system and generate a new scenario v3.1-ready board XML file from your target system and generate a new scenario
XML and launch scripts from the new ACRN Configurator that are consistent and XML and launch scripts from the new ACRN Configurator that are consistent and
will work for the v3.1 build system. will work for the v3.1 build system.
#. Use the :ref:`upgrade tool <upgrading_configuration>` to attempt upgrading #. Use the :ref:`upgrader tool <upgrading_configuration>` to attempt upgrading
configuration files that worked with a release before v3.1. You’ll need the configuration files that worked with a release before v3.1. You'll need the
matched pair of scenario XML and launch XML files from a prior configuration, matched pair of scenario XML and launch XML files from a prior configuration,
and use them to create a new merged scenario XML file. See and use them to create a new merged scenario XML file. See
:ref:`upgrading_configuration` for details. :ref:`upgrading_configuration` for details.
@ -118,16 +117,17 @@ Here are some additional details about upgrading to the v3.1 release.
Generate New Board XML Generate New Board XML
====================== ======================
Board XML files, generated by ACRN board inspector, contain board information Board XML files, generated by ACRN Board Inspector, contain board information
that is essential for building the ACRN hypervisor and setting up User VMs. that is essential for building the ACRN hypervisor and setting up User VMs.
Compared to previous versions, ACRN v3.1 adds the following information to the board Compared to previous versions, ACRN v3.1 adds the following information to the board
XML file for supporting new features and fixes: XML file for supporting new features and fixes:
* Add progress bar and timeout mechanism for Board Inspector * Add a progress bar and timeout mechanism to the Board Inspector
* Guess L3 CAT parameters if not reported via CPUID * Guess L3 CAT parameters if not reported via CPUID
* Refactors MSR utilities * Refactor MSR utilities
* Record all details from RTCT in board XML and generate vRTCT instead of copying a physical one * Record all details from RTCT in the board XML and generate vRTCT instead of
* Hide unnecessary log and fix typo in error message. copying a physical one
* Hide unnecessary logs and fix typos in error messages
See the :ref:`board_inspector_tool` documentation for a complete list of steps See the :ref:`board_inspector_tool` documentation for a complete list of steps
to install and run the tool. to install and run the tool.
@ -137,16 +137,16 @@ Update Configuration Options
As explained in this :ref:`upgrading_configuration` document, we do provide a As explained in this :ref:`upgrading_configuration` document, we do provide a
tool that can assist upgrading your existing pre-v3.1 scenario XML files in the tool that can assist upgrading your existing pre-v3.1 scenario XML files in the
new merged v3.1 format. From there, you can use the v3.1 ACRN Configurator to open new merged v3.1 format. From there, you can use the v3.1 ACRN Configurator to
upgraded scenario file for viewing and further editing if the upgrader tool lost open the upgraded scenario file for viewing and further editing if the upgrader
meaningful data during the conversion. tool lost meaningful data during the conversion.
As part of the developer experience improvements to ACRN configuration, the following XML elements As part of the developer experience improvements to ACRN configuration, the
were refined in the scenario XML file: following XML elements were refined in the scenario XML file:
* ENFORCE_TURNOFF_AC -> SPLIT_LOCK_DETECTION_ENABLED * ``ENFORCE_TURNOFF_AC`` is now ``SPLIT_LOCK_DETECTION_ENABLED``.
* ENFORCE_TURNOFF_GP -> UC_LOCK_DETECTION_ENABLED * ``ENFORCE_TURNOFF_GP`` is now ``UC_LOCK_DETECTION_ENABLED``.
* MCE_ON_PSC_DISABLED -> MCE_ON_PSC_ENABLED * ``MCE_ON_PSC_DISABLED`` is now ``MCE_ON_PSC_ENABLED``.
See the :ref:`scenario-config-options` documentation for details about all the See the :ref:`scenario-config-options` documentation for details about all the
available configuration options in the new Configurator. available configuration options in the new Configurator.
@ -170,10 +170,17 @@ are some of the more significant updates:
.. rst-class:: rst-columns2 .. rst-class:: rst-columns2
* :ref:`gsg` * :ref:`gsg`
* :ref:`GSG_sample_app`
* :ref:`rdt_configuration` * :ref:`rdt_configuration`
* :ref:`acrn-dm_parameters-and-launch-script` * :ref:`acrn-dm_parameters-and-launch-script`
* :ref:`scenario-config-options` * :ref:`scenario-config-options`
* :ref:`hv-hypercall`
* :ref:`hardware`
* :ref:`cpu_sharing`
* :ref:`enable-s5`
* :ref:`using_grub`
* :ref:`vuart_config`
* :ref:`acrnshell`
* :ref:`acrnctl`
Fixed Issues Details Fixed Issues Details
******************** ********************