From ee2b7567bdffcc8a8dff3fbf1e1ce2e1da83269b Mon Sep 17 00:00:00 2001 From: Kunhui-Li Date: Wed, 29 Jun 2022 01:35:51 +0800 Subject: [PATCH] doc: update release notes for v3.0 This patch updates recommendations to upgrade from a prior ACRN version for v3.0. Signed-off-by: Kunhui-Li --- doc/release_notes/release_notes_3.0.rst | 85 +++++++++++++++++++++++-- 1 file changed, 80 insertions(+), 5 deletions(-) diff --git a/doc/release_notes/release_notes_3.0.rst b/doc/release_notes/release_notes_3.0.rst index 53aa7c34d..8adea2ad5 100644 --- a/doc/release_notes/release_notes_3.0.rst +++ b/doc/release_notes/release_notes_3.0.rst @@ -35,6 +35,26 @@ ACRN v3.0 requires Ubuntu 20.04. Follow the instructions in the What's New in v3.0 ****************** +Redesigned ACRN Configurator + Brand new UI, including reduced and simplified parameters, provides intuitive + flow to help users configure. + hypervisor and VM capabilities and settings. +Intel® TCC Tools Cache Configurator support + RTVM can reserve a portion of cache (L2 or L3) as software SRAM regions on + Tiger Lake platform to achieve extreme low latency. For more about Intel TCC tools, + check out https://www.intel.com/content/www/us/en/develop/documentation/tcc-tools-2022-1-developer-guide/top/real-time-configuration-and-optimization-tools/cache-allocation/cache-configurator.html +Commercial off-the-shelf Tiger Lake machine support + 11th Generation Intel® Core™ Processor (codenamed Tiger Lake) has been supported + by ACRN hypervisor since v2.3 release. Now a commercially off-the-shelf complete + system is validated and supported. +Refined shutdown & reset sequence + User can shutdown or reset the system gracefully from the Windows User VM. + This is achieved by lifecycle managers in each VM which talks to each other + via the virtual UART channel. +Hypervisor Real Time Clock (RTC) + Each VM now has its own PC/AT-compatible RTC/CMOS device emulated by the hypervisor. + In this way, a sudden jump in VM’s system clock can be avoided which may confuse + certain applications. Upgrading to v3.0 From Previous Releases **************************************** @@ -47,20 +67,71 @@ Generate New Board XML Board XML files, generated by ACRN board inspector, contain board information that is essential to build ACRN. Compared to previous versions, ACRN v3.0 adds -the following hardware information to board XMLs to support new features and -fixes. +the following information to board XMLs to support new features and fixes. - - TBD + - Add ``--add-llc-cat`` :ref:`board_inspector_cl` to Board Inspector Tool, reference + PR `#7331 `_. + - Collect all information about SR-IOV devices, reference PR `#7302 `_. + - Extract all serial ttys and virtio input devices, reference PR `#7219 `_. + - Extract common ioapic information such as ioapic id, address, gsi base and gsi num, + reference PR `#6987 `_. + - Add another level of `die` node even though the hardware reports die topology in CPUID, + reference PR `#7080 `_. + - Bringing up all cores online so tool can run cpuid to extract all available cores + information, reference PR `#7120 `_. + - Add CPU capability and BIOS invalid setting checks, reference PR `#7216 `_. + - Summary board inspector log based on the different log levels, reference PR + `#7429 `_. The new board XML can be generated using the ACRN board inspector in the same -way as ACRN v2.7. Refer to :ref:`acrn_config_workflow` for a complete list of +way as ACRN v2.7. Refer to :ref:`board_inspector_tool` for a complete list of steps to deploy and run the tool. Update Configuration Options ============================ -Complete overhaul of configurator in v3.0... +In v3.0, data in a launch XML are merged into the scenario XML for the new configurator. +The highly recommended way to use upgrader tool to upgrade a pair of scenario XML and +launch XML files into a merged file, introduced in https://projectacrn.github.io/latest/tutorials/upgrading_configuration.html. +Then use the ACRN Configurator to open the upgraded file for further edits in case +any meaningful data is lost. In detail, the following elements +are refined in the scenario XML file for user-friendly experience. +- ``RDT`` +- ``vUART`` +- ``IVSHMEM`` +- ``Memory`` +- ``virtio devices`` + +The following elements are added to scenario XML files. + +- ``vm.lapic_passthrough`` +- ``vm.io_completion_polling`` +- ``vm.nested_virtualization_support`` +- ``vm.virtual_cat_support`` +- ``vm.secure_world_support`` +- ``vm.hide_mtrr_support`` +- ``vm.security_vm`` + +The following elements were removed. + +- ``hv.FEATURES.NVMX_ENABLED`` +- ``hv.DEBUG_OPTIONS.LOG_BUF_SIZE`` +- ``hv.MEMORY.PLATFORM_RAM_SIZE`` +- ``hv.MEMORY.LOW_RAM_SIZE`` +- ``hv.CAPACITIES.MAX_IR_ENTRIES`` +- ``hv.CAPACITIES.IOMMU_BUS_NUM`` +- ``vm.guest_flags`` +- ``vm.board_private`` + +In v3.0, we refine the structure of the generated scripts so that PCI functions +are identified only by their BDF. This change serves as a mandatory step to align +the way how passthrough devices are configured for pre-launched and post-launched VMs, +which eventually allows us to present a unified view in the the ACRN Configurator for +assigning passthrough device. Then we remove some obsolete dynamic parameters and update the +usage of the `--cpu_affinity` parameter in launch script generation logic to use the lapic ID +instead of pCPU ID. (see the `Device Model parameters +`_) Document Updates **************** @@ -79,3 +150,7 @@ Fixed Issues Details Known Issues ************ +- :acrn-issue:`6631` - [KATA] Kata support is broken since v2.7 +- :acrn-issue:`6978` - [TGL] openstack failed since ACRN v2.7 +- :acrn-issue:`7827` - [Configurator]Pre_launched standard VMs cannot share CPU with Service VM +- :acrn-issue:`7831` - [Configurator] Need to save twice to generate vUART and IVSHMEM addresses