github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-28 20:16:09 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix all headings to use title case

Browse Source 
While we hoped to make the headings consistent over time while doing
other edits, we should instead just make the squirrels happy and do them
all at once or they'll likely never be made consistent.

A python script was used to find the headings, and then a call to
https://pypi.org/project/titlecase to transform the title.  A visual
inspection was used to tweak a few unexpected resulting titles.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2021-02-12 16:27:24 -08:00
committed by David Kinder
parent 6e655d098b
commit 0bd384d41b
119 changed files with 576 additions and 638 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/release_notes/release_notes_0.1.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.1:
ACRN v0.1 (July 2018)
ACRN V0.1 (July 2018)
#####################
We are pleased to announce the release of Project ACRN version 0.1.
@@ -14,7 +14,7 @@ The project ACRN reference code can be found on GitHub in
https://github.com/projectacrn. It includes the ACRN hypervisor, the
ACRN device model, and documentation.
Version 0.1 new features
Version 0.1 New Features
************************
Hardware Support
@@ -35,7 +35,7 @@ Virtual Graphics support added:
assigned to different display. The display ports supports eDP and HDMI.
- See :ref:`APL_GVT-G-hld` documentation for more information.
Virtio standard is supported
Virtio Standard Is Supported
============================
Virtio is a virtualization standard for
@@ -45,7 +45,7 @@ the hypervisor. The SOS and UOS can share physical LAN network
and physical eMMC storage device. (See :ref:`virtio-hld` for more
information.)
Device pass-through support
Device Pass-Through Support
===========================
Device pass-through to UOS support for:
@@ -54,13 +54,13 @@ Device pass-through to UOS support for:
- SD card (mount, read, and write directly in the UOS)
- Converged Security Engine (CSE)
Hypervisor configuration
Hypervisor Configuration
========================
Developers can configure hypervisor via Kconfig parameters. (See
documentation for configuration options.)
New ACRN tools
New ACRN Tools
==============
We've added a collection of support tools including acrnctl, acrntrace,

8
doc/release_notes/release_notes_0.2.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.2:
ACRN v0.2 (Sep 2018)
ACRN V0.2 (Sep 2018)
####################
We are pleased to announce the release of Project ACRN version 0.2.
@@ -31,7 +31,7 @@ https://projectacrn.github.io/0.2/. Documentation for the latest
(master) branch is found at https://projectacrn.github.io/latest/.
Version 0.2 new features
Version 0.2 New Features
************************
VT-x, VT-d
@@ -86,7 +86,7 @@ hotspot for 3rd party devices, provides 3rd party device applications
access to the vehicle, and provides access of 3rd party devices to the
TCU provided connectivity.
IPU (MIPI-CS2, HDMI-in)
IPU (MIPI-CS2, HDMI-In)
========================
ACRN hypervisor supports passthrough IPU assignment to Service OS or
guest OS, without sharing.
@@ -104,7 +104,7 @@ This is done to ensure performance of the most critical workload can be
achieved. Three different schedulers for the GPU are involved: i915 UOS
scheduler, Mediator GVT scheduler, and i915 SOS scheduler.
GPU - display surface sharing via Hyper DMA
GPU - Display Surface Sharing via Hyper DMA
============================================
Surface sharing is one typical automotive use case which requires
that the SOS accesses an individual surface or a set of surfaces

4
doc/release_notes/release_notes_0.3.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.3:
ACRN v0.3 (Nov 2018)
ACRN V0.3 (Nov 2018)
####################
We are pleased to announce the release of Project ACRN version 0.3.
@@ -31,7 +31,7 @@ https://projectacrn.github.io/0.3/. Documentation for the latest
(master) branch is found at https://projectacrn.github.io/latest/.
Version 0.3 new features
Version 0.3 New Features
************************

4
doc/release_notes/release_notes_0.4.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.4:
ACRN v0.4 (Dec 2018)
ACRN V0.4 (Dec 2018)
####################
We are pleased to announce the release of Project ACRN version 0.4.
@@ -31,7 +31,7 @@ https://projectacrn.github.io/0.4/. Documentation for the latest
(master) branch is found at https://projectacrn.github.io/latest/.
Version 0.4 new features
Version 0.4 New Features
************************
- :acrn-issue:`1824` - implement "wbinvd" emulation

4
doc/release_notes/release_notes_0.5.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.5:
ACRN v0.5 (Jan 2019)
ACRN V0.5 (Jan 2019)
####################
We are pleased to announce the release of Project ACRN version 0.5.
@@ -31,7 +31,7 @@ https://projectacrn.github.io/0.5/. Documentation for the latest
(master) branch is found at https://projectacrn.github.io/latest/.
Version 0.5 new features
Version 0.5 New Features
************************
**OVMF support initial patches merged in ACRN**:

4
doc/release_notes/release_notes_0.6.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.6:
ACRN v0.6 (Feb 2019)
ACRN V0.6 (Feb 2019)
####################
We are pleased to announce the release of Project ACRN version 0.6.
@@ -32,7 +32,7 @@ https://projectacrn.github.io/0.6/. Documentation for the latest
ACRN v0.6 requires Clear Linux OS version 27600.
Version 0.6 new features
Version 0.6 New Features
************************
**Enable Privileged VM support for real-time UOS in ACRN**:

21
doc/release_notes/release_notes_0.7.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.7:
ACRN v0.7 (Mar 2019)
ACRN V0.7 (Mar 2019)
####################
We are pleased to announce the release of Project ACRN version 0.7.
@@ -32,10 +32,10 @@ https://projectacrn.github.io/0.7/. Documentation for the latest
ACRN v0.7 requires Clear Linux OS version 28260.
Version 0.7 new features
Version 0.7 New Features
************************
Enable cache QOS with CAT
Enable Cache QOS With CAT
=========================
Cache Allocation Technology (CAT) is enabled on Apollo Lake (APL)
@@ -46,12 +46,12 @@ build time. For debugging and performance tuning, the CAT can also be
enabled and configured at runtime by writing proper values to certain
MSRs using the ``wrmsr`` command on ACRN shell.
Support ACPI power key mediator
Support ACPI Power Key Mediator
===============================
ACRN supports ACPI power/sleep key on the APL and KBL NUC platforms,
triggering S3/S5 flow, following the ACPI spec.
Document updates
Document Updates
================
Several new documents have been added in this release, including:
@@ -121,7 +121,6 @@ Known Issues
**Workaround:** Unplug and plug-in the unrecognized device after booting.
-----
:acrn-issue:`1991` - Input not accepted in UART Console for corner case
Input is useless in UART Console for a corner case, demonstrated with these steps:
@@ -136,7 +135,6 @@ Known Issues
**Workaround:** Enter other keys before typing :kbd:`Enter`.
-----
:acrn-issue:`1996` - There is an error log when using ``acrnd&`` to boot UOS
An error log is printed when starting ``acrnd`` as a background job
@@ -150,7 +148,6 @@ Known Issues
**Workaround:** None.
-----
:acrn-issue:`2267` - [APLUP2][LaaG] LaaG can't detect 4k monitor
After launching UOS on APL UP2 , 4k monitor cannot be detected.
@@ -159,7 +156,6 @@ Known Issues
**Workaround:** Use a monitor with less than 4k resolution.
-----
:acrn-issue:`2278` - [KBLNUC] Cx/Px is not supported on KBLNUC
C states and P states are not supported on KBL NUC.
@@ -169,7 +165,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2279` - [APLNUC] After exiting UOS with mediator
Usb_KeyBoard and Mouse, SOS cannot use the USB keyboard and mouse.
@@ -189,7 +184,6 @@ Known Issues
**Workaround:** Unplug and plug-in the USB keyboard and mouse after exiting UOS.
-----
:acrn-issue:`2522` - [NUC7i7BNH] After starting IAS in SOS, there is no display
On NUC7i7BNH, after starting IAS in SOS, there is no display if the monitor is
@@ -199,7 +193,6 @@ Known Issues
**Workaround:** None.
-----
:acrn-issue:`2523` - UOS monitor does not display when using IAS
There is no UOS display after starting IAS weston.
@@ -220,7 +213,6 @@ Known Issues
The issue will be fixed in the next release.
-----
:acrn-issue:`2524` - [UP2][SBL] Launching UOS hangs while weston is running in SOS
When using weston in SOS, it will hang during the UOS launch.
@@ -239,7 +231,6 @@ Known Issues
The issue will be fixed in the next release.
-----
:acrn-issue:`2527` - [KBLNUC][HV]System will crash when run ``crashme`` (SOS/UOS)
System will crash after a few minutes running stress test ``crashme`` tool in SOS/UOS.
@@ -248,7 +239,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2526` - Hypervisor crash when booting UOS with acrnlog running with mem loglevel=6
If we use ``loglevel 3 6`` to change the mem loglevel to 6, we may hit a page fault in HV.
@@ -257,7 +247,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2753` - UOS cannot resume after suspend by pressing power key
UOS cannot resume after suspend by pressing power key

19
doc/release_notes/release_notes_0.8.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_0.8:
ACRN v0.8 (Apr 2019)
ACRN V0.8 (Apr 2019)
####################
We are pleased to announce the release of Project ACRN version 0.8.
@@ -32,10 +32,10 @@ https://projectacrn.github.io/0.8/. Documentation for the latest
ACRN v0.8 requires Clear Linux OS version 28600.
Version 0.8 new features
Version 0.8 New Features
************************
GPIO virtualization
GPIO Virtualization
=========================
GPIO virtualization is supported as para-virtualization based on the
@@ -45,19 +45,19 @@ configuration via one virtual GPIO controller. In the Back-end, the GPIO
command line in the launch script can be modified to map native GPIO to
UOS.
Enable QoS based on runC container
Enable QoS Based on runC Container
==================================
ACRN supports Device-Model QoS based on runC container to control the SOS
resources (CPU, Storage, MEM, NET) by modifying the runC configuration file.
S5 support for RTVM
S5 Support for RTVM
===============================
ACRN supports a Real-time VM (RTVM) shutting itself down. A RTVM is a
kind of VM that the SOS can't interfere at runtime, and as such, can
only power itself off internally. All poweroff requests external to the
RTVM will be rejected to avoid any interference.
Document updates
Document Updates
================
Several new documents have been added in this release, including:
@@ -114,7 +114,6 @@ Known Issues
**Workaround:** Unplug and plug-in the unrecognized device after booting.
-----
:acrn-issue:`1991` - Input not accepted in UART Console for corner case
Input is useless in UART Console for a corner case, demonstrated with these steps:
@@ -129,7 +128,6 @@ Known Issues
**Workaround:** Enter other keys before typing :kbd:`Enter`.
-----
:acrn-issue:`2267` - [APLUP2][LaaG] LaaG can't detect 4k monitor
After launching UOS on APL UP2 , 4k monitor cannot be detected.
@@ -138,7 +136,6 @@ Known Issues
**Workaround:** Use a monitor with less than 4k resolution.
-----
:acrn-issue:`2278` - [KBLNUC] Cx/Px is not supported on KBLNUC
C states and P states are not supported on KBL NUC.
@@ -148,7 +145,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2279` - [APLNUC] After exiting UOS, SOS can't use USB keyboard and mouse
After exiting UOS with mediator
@@ -169,7 +165,6 @@ Known Issues
**Workaround:** Unplug and plug-in the USB keyboard and mouse after exiting UOS.
-----
:acrn-issue:`2527` - System will crash after a few minutes running stress test ``crashme`` tool in SOS/UOS.
System stress test may cause a system crash.
@@ -178,7 +173,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2526` - Hypervisor crash when booting UOS with acrnlog running with mem loglevel=6
If we use ``loglevel 3 6`` to change the mem loglevel to 6, we may hit a page fault in HV.
@@ -187,7 +181,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2753` - UOS cannot resume after suspend by pressing power key
UOS cannot resume after suspend by pressing power key

4
doc/release_notes/release_notes_1.0.1.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.0.1:
ACRN v1.0.1 (July 2019)
ACRN V1.0.1 (July 2019)
#######################
We are pleased to announce the release of ACRN version 1.0.1. This is a
@@ -27,7 +27,7 @@ There were no documentation changes in this update, so you can still
refer to the v1.0-specific documentation found at
https://projectacrn.github.io/1.0/.
Change Log in version 1.0.1 since version 1.0
Change Log in Version 1.0.1 Since Version 1.0
*********************************************
Primary changes are to fix several security and stability issues found

4
doc/release_notes/release_notes_1.0.2.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.0.2:
ACRN v1.0.2 (Nov 2019)
ACRN V1.0.2 (Nov 2019)
######################
We are pleased to announce the release of ACRN version 1.0.2. This is a
@@ -27,7 +27,7 @@ There were no documentation changes in this update, so you can still
refer to the v1.0-specific documentation found at
https://projectacrn.github.io/1.0/.
Change Log in v1.0.2 since v1.0.1
Change Log in V1.0.2 Since V1.0.1
*********************************
Primary changes are to fix several security and stability issues found

41
doc/release_notes/release_notes_1.0.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.0:
ACRN v1.0 (May 2019)
ACRN V1.0 (May 2019)
####################
We are pleased to announce the release of ACRN version 1.0, a key
@@ -33,7 +33,7 @@ with a specific release: generated v1.0 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.0 requires Clear Linux* OS version 29070.
Version 1.0 major features
Version 1.0 Major Features
**************************
Hardware Support
@@ -42,7 +42,7 @@ ACRN supports multiple x86 platforms and has been tested with Apollo
Lake and Kaby Lake NUCs, and the UP Squared board.
(See :ref:`hardware` for supported platform details.)
APL UP2 board with SBL firmware
APL UP2 Board With SBL Firmware
===============================
ACRN supports APL UP2 board with Slim Bootloader (SBL) firmware.
Slim Bootloader is a modern, flexible, light-weight,
@@ -51,13 +51,13 @@ customizable, and secure. An end-to-end reference build has been verified
on UP2/SBL board using ACRN hypervisor, Clear Linux OS as SOS, and Clear
Linux OS as UOS.
Enable post-launched RTVM support for real-time UOS in ACRN
Enable Post-Launched RTVM Support for Real-Time UOS in ACRN
===========================================================
This release provides initial patches enabling a User OS (UOS) running as a
virtual machine (VM) with real-time characteristics,
also called a "post-launched RTVM". More patches for ACRN real time support will continue.
Enable cache QOS with CAT
Enable Cache QOS With CAT
=========================
Cache Allocation Technology (CAT) is available on Apollo Lake (APL) platforms,
providing cache isolation between VMs mainly for real-time performance quality
@@ -66,27 +66,27 @@ the VM configuration determined at build time. For debugging and performance
tuning, the CAT can also be enabled and configured at runtime by writing proper
values to certain MSRs using the ``wrmsr`` command on ACRN shell.
Enable QoS based on runC container
Enable QoS Based on runC Container
==================================
ACRN supports Device-Model QoS based on runC container to control
the SOS resources (CPU, Storage, MEM, NET) by modifying the runC configuration file,
configuration guide will be published in next release.
S5 support for RTVM
S5 Support for RTVM
===================
ACRN supports a Real-time VM (RTVM) shutting itself down. A RTVM is a kind
of VM that the SOS can't interfere with at runtime, and as such, only the
RTVM can power itself off internally. All power-off requests external to the
RTVM will be rejected to avoid any interference.
OVMF support initial patches merged in ACRN
OVMF Support Initial Patches Merged in ACRN
===========================================
To support booting Windows as a Guest OS, we are using
Open source Virtual Machine Firmware (OVMF). Initial
patches to support OVMF have been merged in ACRN hypervisor. More patches for
ACRN and patches upstreaming to OVMF work will be continuing.
Support ACPI power key mediator
Support ACPI Power Key Mediator
===============================
ACRN supports ACPI power/sleep key on the APL and KBL NUC platforms, triggering
S3/S5 flow, following the ACPI spec.
@@ -135,7 +135,7 @@ a Guest VM (UOS), enables control of the Wi-Fi as an in-vehicle hotspot for thir
devices, provides third-party device applications access to the vehicle, and
provides access of third-party devices to the TCU (if applicable) provided connectivity.
IPU (MIPI CSI-2, HDMI-in)
IPU (MIPI CSI-2, HDMI-In)
=========================
ACRN hypervisor provide an IPU mediator to share with Guest OS. Alternatively, IPU
can also be configured as pass-through to Guest OS without sharing.
@@ -161,7 +161,7 @@ to ensure performance of the most critical workload can be achieved. Three
different schedulers for the GPU are involved: i915 UOS scheduler, Mediator
GVT scheduler, and i915 SOS scheduler.
GPU - display surface sharing via Hyper DMA
GPU - Display Surface Sharing via Hyper DMA
===========================================
Surface sharing is one typical automotive use case which requires that the
SOS accesses an individual surface or a set of surfaces from the UOS without
@@ -169,7 +169,7 @@ having to access the entire frame buffer of the UOS. It leverages hyper_DMABUF,
a Linux kernel driver running on multiple VMs and expands DMA-BUFFER sharing
capability to inter-VM.
Virtio standard is supported
Virtio Standard Is Supported
============================
Virtio framework is widely used in ACRN, allowing devices beyond network and
storage to be shared to UOS in a standard way. Many mediators in ACRN follow
@@ -179,11 +179,11 @@ the guest's device driver "knows" it is running in a virtual environment, and
cooperates with the hypervisor. The SOS and UOS can share physical LAN network
and physical eMMC storage device. (See :ref:`virtio-hld` for more information.)
Device pass-through support
Device Pass-Through Support
===========================
Device pass-through to UOS supported with help of VT-d.
GPIO virtualization
GPIO Virtualization
===================
GPIO virtualization is supported as para-virtualization based on the Virtual
I/O Device (VIRTIO) specification. The GPIO consumers of the Front-end are able
@@ -191,12 +191,12 @@ to set or get GPIO values, directions, and configuration via one virtual GPIO
controller. In the Back-end, the GPIO command line in the launch script can be
modified to map native GPIO to UOS. (See :ref:`virtio-hld` for more information.)
New ACRN tools
New ACRN Tools
==============
We've added a collection of support tools including ``acrnctl``, ``acrntrace``, ``acrnlog``,
``acrn-crashlog``, ``acrnprobe``. (See the `Tools` section under **User Guides** for details.)
Document updates
Document Updates
================
We have many reference documents `available
<https://projectacrn.github.io>`_, including:
@@ -390,7 +390,6 @@ Known Issues
**Workaround:** Unplug and plug-in the unrecognized device after booting.
-----
:acrn-issue:`1991` - Input not accepted in UART Console for corner case
Input is useless in UART Console for a corner case, demonstrated with these steps:
@@ -405,7 +404,6 @@ Known Issues
**Workaround:** Enter other keys before typing :kbd:`Enter`.
-----
:acrn-issue:`2267` - [APLUP2][LaaG] LaaG can't detect 4k monitor
After launching UOS on APL UP2 , 4k monitor cannot be detected.
@@ -414,7 +412,6 @@ Known Issues
**Workaround:** Use a monitor with less than 4k resolution.
-----
:acrn-issue:`2278` - [KBLNUC] Cx/Px is not supported on KBLNUC
C states and P states are not supported on KBL NUC.
@@ -424,7 +421,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2279` - [APLNUC] After exiting UOS, SOS can't use USB keyboard and mouse
After exiting UOS with mediator
@@ -445,7 +441,6 @@ Known Issues
**Workaround:** Unplug and plug-in the USB keyboard and mouse after exiting UOS.
-----
:acrn-issue:`2527` - System will crash after a few minutes running stress test ``crashme`` tool in SOS/UOS.
System stress test may cause a system crash.
@@ -454,7 +449,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2526` - Hypervisor crash when booting UOS with acrnlog running with mem loglevel=6
If we use ``loglevel 3 6`` to change the mem loglevel to 6, we may hit a page fault in HV.
@@ -463,7 +457,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2753` - UOS cannot resume after suspend by pressing power key
UOS cannot resume after suspend by pressing power key
@@ -472,7 +465,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2974` - Launching Zephyr RTOS as a real-time UOS takes too long
Launching Zephyr RTOS as a real-time UOS takes too long
@@ -488,7 +480,6 @@ Known Issues
**Workaround:** None
-----
Change Log
**********

17
doc/release_notes/release_notes_1.1.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.1:
ACRN v1.1 (Jun 2019)
ACRN V1.1 (Jun 2019)
####################
We are pleased to announce the release of ACRN version 1.1.
@@ -24,7 +24,7 @@ with a specific release: generated v1.1 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.1 requires Clear Linux* OS version 29970.
Version 1.1 major features
Version 1.1 Major Features
**************************
Hybrid Mode Introduced
@@ -33,14 +33,14 @@ In hybrid mode, a Zephyr OS is launched by the hypervisor even before the Servic
launched (pre-launched), with dedicated resources to achieve highest level of isolation.
This is designed to meet the needs of a FuSa certifiable safety OS.
Support for new guest Operating Systems
Support for New Guest Operating Systems
=======================================
* The `Zephyr RTOS <https://zephyrproject.org>`_ can be a pre-launched Safety OS in hybrid mode.
It can also be a post-launched (launched by Service OS, not the hypervisor) as a guest OS.
* VxWorks as a post-launched RTOS for industrial usages.
* Windows as a post-launched OS
Document updates
Document Updates
================
We have many `reference documents available <https://projectacrn.github.io>`_, including:
@@ -132,7 +132,6 @@ Known Issues
**Workaround:** Unplug and plug-in the unrecognized device after booting.
-----
:acrn-issue:`1991` - Input not accepted in UART Console for corner case
Input is useless in UART Console for a corner case, demonstrated with these steps:
@@ -147,7 +146,6 @@ Known Issues
**Workaround:** Enter other keys before typing :kbd:`Enter`.
-----
:acrn-issue:`2267` - [APLUP2][LaaG] LaaG can't detect 4k monitor
After launching UOS on APL UP2 , 4k monitor cannot be detected.
@@ -156,7 +154,6 @@ Known Issues
**Workaround:** Use a monitor with less than 4k resolution.
-----
:acrn-issue:`2279` - [APLNUC] After exiting UOS, SOS can't use USB keyboard and mouse
After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the USB keyboard and mouse.
@@ -176,7 +173,6 @@ Known Issues
**Workaround:** Unplug and plug-in the USB keyboard and mouse after exiting UOS.
-----
:acrn-issue:`2753` - UOS cannot resume after suspend by pressing power key
UOS cannot resume after suspend by pressing power key
@@ -185,7 +181,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`2974` - Launching Zephyr RTOS as a real-time UOS takes too long
Launching Zephyr RTOS as a real-time UOS takes too long
@@ -204,7 +199,6 @@ Known Issues
**Workaround:** A different version of Grub is known to work correctly
-----
:acrn-issue:`3268` - dm: add virtio-rnd device to command line
LaaG's network is unreachable with UOS kernel
@@ -222,7 +216,6 @@ Known Issues
**Workaround:** Add ``-s 7,virtio-rnd \`` to the launch_uos.sh script
-----
:acrn-issue:`3280` - AcrnGT holding forcewake lock causes high CPU usage in gvt workload thread.
The i915 forcewake mechanism is to keep the GPU from its low power state, in
@@ -233,7 +226,6 @@ Known Issues
**Workaround:** None
-----
:acrn-issue:`3279` - AcrnGT causes display flicker in some situations.
In current scaler ownership assignment logic, there's an issue that when SOS disables a plane,
@@ -244,7 +236,6 @@ Known Issues
**Workaround:** None
-----
Change Log
**********

15
doc/release_notes/release_notes_1.2.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.2:
ACRN v1.2 (Aug 2019)
ACRN V1.2 (Aug 2019)
####################
We are pleased to announce the release of ACRN version 1.2.
@@ -24,10 +24,10 @@ with a specific release: generated v1.2 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.2 requires Clear Linux* OS version 30690.
Version 1.2 major features
Version 1.2 Major Features
**************************
What's New in v1.2
What's New in V1.2
==================
* Support OVMF as virtual boot loader for Service VM to launch Clearlinux, VxWorks
or Windows, Secure boot is supported
@@ -36,7 +36,7 @@ What's New in v1.2
* Virtualization supports Always Running Timer (ART)
* Various bug fixes and enhancements
Document updates
Document Updates
================
We have many `reference documents available <https://projectacrn.github.io>`_, including:
@@ -105,7 +105,6 @@ Known Issues
**Workaround:** Issue resolved on ACRN tag: ``acrn-2019w33.1-140000p``
-----
:acrn-issue:`3520` - bundle of "VGPU unconformance guest" messages observed for "gvt" in SOS console while using UOS
After the need_force_wake is not removed in course of submitting VGPU workload,
@@ -118,7 +117,6 @@ Known Issues
**Workaround:** Need to rebuild and apply the latest Service VM kernel from the ``acrn-kernel`` source code.
-----
:acrn-issue:`3533` - NUC hang while repeating the cold boot
NUC will hang while repeating cold boot operation.
@@ -134,7 +132,6 @@ Known Issues
**Workaround:** Need to rebuild and apply the latest Service VM kernel from the ``acrn-kernel`` source code.
-----
:acrn-issue:`3576` - Expand default memory from 2G to 4G for WaaG
@@ -142,25 +139,21 @@ Known Issues
**Workaround:** Issue resolved on ACRN tag: ``acrn-2019w33.1-140000p``
-----
:acrn-issue:`3609` - Sometimes fail to boot os while repeating the cold boot operation
**Workaround:** Please refer the PR information in this git issue
-----
:acrn-issue:`3610` - LaaG hang while run some workloads loop with zephyr idle
**Workaround:** Revert commit ``bbb891728d82834ec450f6a61792f715f4ec3013`` from the kernel
-----
:acrn-issue:`3611` - OVMF launch UOS fail for Hybrid and industry scenario
**Workaround:** Please refer the PR information in this git issue
-----
Change Log

8
doc/release_notes/release_notes_1.3.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.3:
ACRN v1.3 (Sep 2019)
ACRN V1.3 (Sep 2019)
####################
We are pleased to announce the release of ACRN version 1.3.
@@ -24,10 +24,10 @@ with a specific release: generated v1.3 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.3 requires Clear Linux* OS version 31080.
Version 1.3 major features
Version 1.3 Major Features
**************************
What's New in v1.3
What's New in V1.3
==================
* OVMF supports Graphics Output Protocol (GOP), allowing Windows logo at guest
VM boot time.
@@ -38,7 +38,7 @@ What's New in v1.3
* Ethernet mediator now supports prioritization per VM.
* Features for real-time determinism, e.g. Cache Allocation Technology (CAT, only supported on Apollo Lake).
Document updates
Document Updates
================
We have many new `reference documents available <https://projectacrn.github.io>`_, including:

8
doc/release_notes/release_notes_1.4.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.4:
ACRN v1.4 (Oct 2019)
ACRN V1.4 (Oct 2019)
####################
We are pleased to announce the release of ACRN version 1.4.
@@ -24,17 +24,17 @@ with a specific release: generated v1.4 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.4 requires Clear Linux* OS version 31670.
Version 1.4 major features
Version 1.4 Major Features
**************************
What's New in v1.4
What's New in V1.4
==================
* ACRN now conforms to the Microsoft* Hypervisor Top-Level Functional Specification (TLFS).
* ACRN scheduler framework re-architected capabilities have been added.
* WaaG (Windows as a guest) stability and performance has been improved.
* Realtime performance of the RTVM (preempt-RT kernel-based) has been improved.
Document updates
Document Updates
================
Many new `reference documents <https://projectacrn.github.io>`_ are available, including:

8
doc/release_notes/release_notes_1.5.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.5:
ACRN v1.5 (Jan 2020)
ACRN V1.5 (Jan 2020)
####################
We are pleased to announce the release of ACRN version 1.5.
@@ -24,17 +24,17 @@ with a specific release: generated v1.5 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.5 requires Clear Linux* OS version 32030.
Version 1.5 major features
Version 1.5 Major Features
**************************
What's New in v1.5
What's New in V1.5
==================
* Basic CPU sharing: Fairness Round-Robin CPU Scheduling has been added to support basic CPU sharing (the Service VM and WaaG share one CPU core).
* 8th Gen Intel® Core™ Processors (code name Whiskey Lake) are now supported and validated.
* Overall stability and performance has been improved.
* An offline configuration tool has been created to help developers port ACRN to different hardware boards.
Document updates
Document Updates
================
Many new `reference documents <https://projectacrn.github.io>`_ are available, including:

8
doc/release_notes/release_notes_1.6.1.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.6.1:
ACRN v1.6.1 (May 2020)
ACRN V1.6.1 (May 2020)
######################
We are pleased to announce the release of ACRN version 1.6.1.
@@ -25,10 +25,10 @@ https://projectacrn.github.io/1.6.1/.
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.6.1 requires Clear Linux OS version 33050.
Version 1.6.1 major features
Version 1.6.1 Major Features
****************************
What's New in v1.6.1
What's New in V1.6.1
====================
* ACRN ensures libvirt supports VM orchestration based on OpenStack
@@ -49,7 +49,7 @@ What's New in v1.6.1
* Supported VT-d Posted Interrupts
Document updates
Document Updates
================
Many new and updated `reference documents <https://projectacrn.github.io>`_ are available, including:

8
doc/release_notes/release_notes_1.6.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_1.6:
ACRN v1.6 (Mar 2020)
ACRN V1.6 (Mar 2020)
####################
We are pleased to announce the release of ACRN version 1.6.
@@ -24,10 +24,10 @@ with a specific release: generated v1.6 documents can be found at https://projec
Documentation for the latest (master) branch is found at https://projectacrn.github.io/latest/.
ACRN v1.6 requires Clear Linux OS version 32680.
Version 1.6 major features
Version 1.6 Major Features
**************************
What's New in v1.6
What's New in V1.6
==================
* Graphics passthrough support
@@ -51,7 +51,7 @@ What's New in v1.6
* PCI bridge emulation in hypervisor
Document updates
Document Updates
================
Many new and updated `reference documents <https://projectacrn.github.io>`_ are available, including:

24
doc/release_notes/release_notes_2.0.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_2.0:
ACRN v2.0 (Jun 2020)
ACRN V2.0 (Jun 2020)
####################
We are pleased to announce the second major release of the Project ACRN
@@ -55,7 +55,7 @@ started with ACRN.
We recommend that all developers upgrade to ACRN release v2.0.
Version 2.0 Key Features (comparing with v1.0)
Version 2.0 Key Features (Comparing With V1.0)
**********************************************
.. contents::
@@ -101,7 +101,7 @@ New Hardware Platform Support
This release adds support for 8th Gen Intel® Core™ Processors (code
name: Whiskey Lake). (See :ref:`hardware` for platform details.)
Pre-launched Safety VM Support
Pre-Launched Safety VM Support
==============================
ACRN supports a pre-launched partitioned safety VM, isolated from the
@@ -111,21 +111,21 @@ For example, in the hybrid mode, a real-time Zephyr RTOS VM can be
and with its own dedicated resources to achieve a high level of
isolation. This is designed to meet the needs of a Functional Safety OS.
Post-launched VM support via OVMF
Post-Launched VM Support via OVMF
=================================
ACRN supports Open Virtual Machine Firmware (OVMF) as a virtual boot
loader for the Service VM to launch post-launched VMs such as Windows,
Linux, VxWorks, or Zephyr RTOS. Secure boot is also supported.
Post-launched real-time VM Support
Post-Launched Real-Time VM Support
==================================
ACRN supports a post-launched RTVM, which also uses partitioned hardware
resources to ensure adequate real-time performance, as required for
industrial use cases.
Real-time VM Performance Optimizations
Real-Time VM Performance Optimizations
======================================
ACRN 2.0 improves RTVM performance with these optimizations:
@@ -161,7 +161,7 @@ scheduler in the hypervisor to make sure the physical CPU can be shared
between VMs and support for yielding an idle vCPU when it's running a
'HLT' or 'PAUSE' instruction.
Large selection of OSs for User VMs
Large Selection of OSs for User VMs
===================================
ACRN now supports Windows* 10, Android*, Ubuntu*, Xenomai, VxWorks*,
@@ -170,7 +170,7 @@ to the Microsoft* Hypervisor Top-Level Functional Specification (TLFS).
ACRN 2.0 also improves overall Windows as a Guest (WaaG) stability and
performance.
GRUB bootloader
GRUB Bootloader
===============
The ACRN hypervisor can boot from the popular GRUB bootloader using
@@ -189,14 +189,14 @@ In this example, the ACRN Service VM supports a SR-IOV ethernet device
through the Physical Function (PF) driver, and ensures that the SR-IOV
Virtual Function (VF) device can passthrough to a post-launched VM.
Graphics passthrough support
Graphics Passthrough Support
============================
ACRN supports GPU passthrough to dedicated User VM based on Intel GVT-d
technology used to virtualize the GPU for multiple guest VMs,
effectively providing near-native graphics performance in the VM.
Shared memory based Inter-VM communication
Shared Memory Based Inter-Vm Communication
==========================================
ACRN supports Inter-VM communication based on shared memory for
@@ -213,7 +213,7 @@ Kata Containers Support
ACRN can launch a Kata container, a secure container runtime, as a User VM.
VM orchestration
VM Orchestration
================
Libvirt is an open-source API, daemon, and management tool as a layer to
@@ -221,7 +221,7 @@ decouple orchestrators and hypervisors. By adding a "ACRN driver", ACRN
supports libvirt-based tools and orchestrators to configure a User VM's CPU
configuration during VM creation.
Document updates
Document Updates
================
Many new and updated `reference documents <https://projectacrn.github.io>`_ are available, including:

4
doc/release_notes/release_notes_2.1.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_2.1:
ACRN v2.1 (Aug 2020)
ACRN V2.1 (Aug 2020)
####################
We are pleased to announce the release of the Project ACRN
@@ -33,7 +33,7 @@ ACRN v2.1 requires Ubuntu 18.04. Follow the instructions in the
We recommend that all developers upgrade to ACRN release v2.1.
What's new in v2.1
What's New in V2.1
******************
* Preempt-RT Linux has been validated as a pre-launched realtime VM. See

6
doc/release_notes/release_notes_2.2.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_2.2:
ACRN v2.2 (Sep 2020)
ACRN V2.2 (Sep 2020)
####################
We are pleased to announce the release of the Project ACRN
@@ -32,7 +32,7 @@ ACRN v2.2 requires Ubuntu 18.04. Follow the instructions in the
:ref:`rt_industry_ubuntu_setup` to get started with ACRN.
What's New in v2.2
What's New in V2.2
******************
Elkhart Lake and Tiger Lake processor support.
@@ -73,7 +73,7 @@ Staged removal of deprivileged boot mode support.
Clear Linux though, so we have chosen Ubuntu (and Yocto Project) as the
preferred Service VM OSs moving forward.
Document updates
Document Updates
****************
New and updated reference documents are available, including:

6
doc/release_notes/release_notes_2.3.rst
View File

@@ -1,6 +1,6 @@
.. _release_notes_2.3:
ACRN v2.3 (Dec 2020)
ACRN V2.3 (Dec 2020)
####################
We are pleased to announce the release of the Project ACRN
@@ -32,7 +32,7 @@ ACRN v2.3 requires Ubuntu 18.04. Follow the instructions in the
:ref:`rt_industry_ubuntu_setup` to get started with ACRN.
What's New in v2.3
What's New in V2.3
******************
Enhanced GPU passthrough (GVT-d)
@@ -65,7 +65,7 @@ Removed deprivileged boot mode support
Clear Linux so we have chosen Ubuntu (and Yocto Project) as the
preferred Service VM OSs moving forward.
Document updates
Document Updates
****************
New and updated reference documents are available, including: