github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-04-28 03:41:29 +00:00
Code Issues Projects Releases Wiki Activity

doc: Upgrade the information about Release Notes

Browse Source 
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
This commit is contained in:
zhangrouyu 2022-09-22 22:35:50 -04:00 committed by Amy Reyes
parent 4844ae4772
commit 76d8fea2ff
1 changed files with 76 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -92,17 +92,9 @@ Improved TSC frequency reporting
Upgrading to v3.1 from Previous Releases
****************************************
As with the v3.0 release With the introduction of the Configurator UI tool, the need for manually editing
XML files is gone. While working on this improved Configurator, we've also made
many adjustments to available options in the underlying XML files, including
merging the previous scenario and launch XML files into a combined scenario XML
file. The board XML file generated by the v3.1 Board Inspector tool includes
more information about the target system that is needed by the v3.1
Configurator.
We recommend you generate a new board XML for your target system with the v3.1
Board Inspector and use the v3.1 Configurator to generate a new
scenario XML file and launch scripts. Board XML and Scenario XML files
Board Inspector. You should also use the v3.1 Configurator to generate a new
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
build process and could produce unexpected errors during the build.
@ -114,7 +106,9 @@ to upgrade from prior ACRN versions:
XML and launch scripts from the new ACRN Configurator that are consistent and
will work for the v3.1 build system.
#. Use the :ref:`upgrade tool <upgrading_configuration>` to attempt upgrading
configuration files that worked with a release before v3.1. See
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,
and use them to create a new merged scenario XML file. See
:ref:`upgrading_configuration` for details.
#. Manually edit your prior scenario XML and launch XML files to make them
compatible with v3.1. This is not our recommended approach.
@ -129,7 +123,11 @@ 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
XML file for supporting new features and fixes:
- <TODO: topic and PR reference>
* Add progress bar and timeout mechanism for Board Inspector
* Guess L3 CAT parameters if not reported via CPUID
* Refactors MSR utilities
* Record all details from RTCT in board XML and generate vRTCT instead of copying a physical one
* Hide unnecessary log and fix typo in error message.
See the :ref:`board_inspector_tool` documentation for a complete list of steps
to install and run the tool.
@ -137,20 +135,18 @@ to install and run the tool.
Update Configuration Options
============================
<TO DO>
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
new merged v3.1 format. From there, you can use the v3.1 ACRN Configurator to open
upgraded scenario file for viewing and further editing if the upgrader tool lost
meaningful data during the conversion.
As part of the developer experience improvements to ACRN configuration, the following XML elements
were refined in the scenario XML file:
- <TO DO>
The following elements are added to scenario XML files.
- <TO DO>
The following elements were removed.
- <TO DO>
* ENFORCE_TURNOFF_AC -> SPLIT_LOCK_DETECTION_ENABLED
* ENFORCE_TURNOFF_GP -> UC_LOCK_DETECTION_ENABLED
* MCE_ON_PSC_DISABLED -> MCE_ON_PSC_ENABLED
See the :ref:`scenario-config-options` documentation for details about all the
available configuration options in the new Configurator.
@ -185,7 +181,65 @@ Fixed Issues Details
.. comment example item
- :acrn-issue:`5626` - Host Call Trace once detected
- :acrn-issue:`8162` - dm: virtio-blk parameter error
- :acrn-issue:`8125` - [hypercube][ADL]Assertion'0' failed found during hypercube_PIO_SCAN testing
- :acrn-issue:`8111` - [life_mngr] Sync between SOS and RTVM failed when startup hence life_mngr cannot work
- :acrn-issue:`7948` - Tiger Lake product with CAT enabled needed
- :acrn-issue:`8063` - Need to generate config_summary.rst
- :acrn-issue:`8098` - configurator build has dependency on published release documentation
- :acrn-issue:`8087` - ACRN Configurator enable RDT and CDP after launch scenario
- :acrn-issue:`8066` - User VM doesn't have IP if launched by acrnd with virtio-net
- :acrn-issue:`7563` - [ADL-S][SSRAM]RTCM Unit run failed with 2G memory size
- :acrn-issue:`8068` - [config_tool] Imported scenarios not populating CAT widget
- :acrn-issue:`7973` - config-tools: User concern about the progress of generating board.xml and not sure whether need exit after waiting some time.
- :acrn-issue:`7975` - GSG python package xmlschema/elementpath incompatibility
- :acrn-issue:`8050` - config_tools: cpu affinity
- :acrn-issue:`8051` - ADL-S][S5]Can't shutdown WaaG with user VM name same as in launch script
- :acrn-issue:`8046` - [config_tool] Configurator creates duplicate VM name
- :acrn-issue:`8018` - config-tools: default value & MAX_PCI_BUS_NUM
- :acrn-issue:`7991` - [Workshop] Configurator create scenario popup window disappear sometimes.
- :acrn-issue:`8033` - [config_tool] vUART widget address for pre-launched VM doesn't update or display error
- :acrn-issue:`8000` - [config_tool] Real-time vCPU checkbox is confusing to users
- :acrn-issue:`7898` - [config_tool] Warning message when users attempt to create a new scenario or import an existing scenario for an existing configuration
- :acrn-issue:`5692` - Keep Open: Used when updating config option documentation in .xsd files
- :acrn-issue:`7914` - [config_tool] Focus change to new VM when added
- :acrn-issue:`7661` - config-tools: Change MCE AC and UC (GP) to enable
- :acrn-issue:`7927` - [acrn-configuration-tool] ACRN-Configurator does not consider L3 CAT config when opening an exiting configuration
- :acrn-issue:`7958` - [configurator] Need highlight success or fail status in the popup window of save scenario button
- :acrn-issue:`7913` - config-tools: build acrn successfully even set the same memory address between the pre vm 0 and hv
- :acrn-issue:`7931` - Improve HV console as a bash-like one
- :acrn-issue:`7960` - dm cannot stop correctly
- :acrn-issue:`7935` - Build EFI-Stub fail
- :acrn-issue:`7921` - [config_tool] Cache widget: Instructions missing for L2-only users
- :acrn-issue:`7925` - [configurator] invalid virtual bdf in ivshmem could be saved
- :acrn-issue:`7942` - [config_tool] vUART and IVSHMEM widgets don't generate address
- :acrn-issue:`7947` - Need optimize user flow to configure SSRAM for pre-launched RTVM
- :acrn-issue:`7944` - Service VM hang when reboot user VM
- :acrn-issue:`7940` - DM: add support for iothread
- :acrn-issue:`7933` - [config_tool] Add tooltips to CPU affinity virtio
- :acrn-issue:`7926` - [acrn-configuration-tool]Memory warning when build ACRN for WHL
- :acrn-issue:`7902` - coding style cleanup in pci.c
- :acrn-issue:`7917` - [config_tool] Order of plus and minus icons is inconsistent
- :acrn-issue:`7790` - User VM fail to get IP with vhost net
- :acrn-issue:`7759` - ERROR: LeakSanitizer: detected memory leaks found when run
- :acrn-issue:`7915` - [config_tool] Duplicate VM error message - add spacing
- :acrn-issue:`7906` - config-tools: Board inspector crashed when command line is too long in dmesg
- :acrn-issue:`7907` - RRSBA should be disabled on platform using retpoline if enumerated
- :acrn-issue:`7897` - [config_tool] Placement of plus icon for virtio
- :acrn-issue:`7582` - configurator: board name truncated incorrectly
- :acrn-issue:`7707` - configurator: IVSHMEM region name lacks pattern check
- :acrn-issue:`7886` - config-tools: need to hide the 'update-pciids: download failed' message
- :acrn-issue:`7559` - Copyright year range in code headers is not up to date
- :acrn-issue:`7884` - config_tool: Move "BIOS Revision" line in Configurator UI
- :acrn-issue:`7893` - [config_tool] Incompatibility with latest elementpath library
- :acrn-issue:`7887` - hv: Surges of external interrupts may cause guest hang
- :acrn-issue:`7880` - fail to run acrn-dm with wrong iasl path
Known Issues
************
- :acrn-issue:`6631` - [KATA] Kata support is broken since v2.7
- :acrn-issue:`6978` - openstack failed since ACRN v2.7
- :acrn-issue:`7827` - [Configurator] Pre_launched standard VMs cannot share CPU with Service VM
- :acrn-issue:`8202` - [HV][qemu0][v3.1]HV fail to boot acrn on qemu