mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-08-12 21:37:38 +00:00
doc: remove trailing spaces
Remove trailing spaces on lines to avoid potential issues with git Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
f290f22344
commit
4b1dfe9632
@ -18,7 +18,7 @@ and about `Sphinx extensions`_ from their respective websites.
|
|||||||
|
|
||||||
.. _Sphinx extensions: https://www.sphinx-doc.org/en/stable/contents.html
|
.. _Sphinx extensions: https://www.sphinx-doc.org/en/stable/contents.html
|
||||||
.. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
|
.. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
|
||||||
.. _Sphinx Inline Markup: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
|
.. _Sphinx Inline Markup: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
|
||||||
.. _Project ACRN documentation: https://projectacrn.github.io
|
.. _Project ACRN documentation: https://projectacrn.github.io
|
||||||
|
|
||||||
This document provides a quick reference for commonly used reST and
|
This document provides a quick reference for commonly used reST and
|
||||||
|
@ -1192,5 +1192,5 @@ S3.
|
|||||||
Pass-through in Device Model
|
Pass-through in Device Model
|
||||||
****************************
|
****************************
|
||||||
|
|
||||||
You may refer to :ref:`hv-device-passthrough` for pass-through realization
|
You may refer to :ref:`hv-device-passthrough` for pass-through realization
|
||||||
in device model.
|
in device model.
|
||||||
|
@ -386,7 +386,7 @@ three typical solutions exist:
|
|||||||
may even require the hypervisor to flush the TLB. This solution won't
|
may even require the hypervisor to flush the TLB. This solution won't
|
||||||
be used by the ACRN hypervisor.
|
be used by the ACRN hypervisor.
|
||||||
|
|
||||||
#. **Use CR0.WP (write-protection) bit.**
|
#. **Use CR0.WP (write-protection) bit.**
|
||||||
|
|
||||||
This processor feature allows
|
This processor feature allows
|
||||||
pages to be protected from supervisor-mode write access.
|
pages to be protected from supervisor-mode write access.
|
||||||
|
@ -111,7 +111,7 @@ Efficient: batching operation is encouraged
|
|||||||
high-performance I/O, since notification between FE and BE driver
|
high-performance I/O, since notification between FE and BE driver
|
||||||
usually involves an expensive exit of the guest. Therefore batching
|
usually involves an expensive exit of the guest. Therefore batching
|
||||||
operating and notification suppression are highly encouraged if
|
operating and notification suppression are highly encouraged if
|
||||||
possible. This will give an efficient implementation for
|
possible. This will give an efficient implementation for
|
||||||
performance-critical devices.
|
performance-critical devices.
|
||||||
|
|
||||||
Standard: virtqueue
|
Standard: virtqueue
|
||||||
@ -120,7 +120,7 @@ Standard: virtqueue
|
|||||||
queue of scatter-gather buffers. There are three important methods on
|
queue of scatter-gather buffers. There are three important methods on
|
||||||
virtqueues:
|
virtqueues:
|
||||||
|
|
||||||
- **add_buf** is for adding a request/response buffer in a virtqueue,
|
- **add_buf** is for adding a request/response buffer in a virtqueue,
|
||||||
- **get_buf** is for getting a response/request in a virtqueue, and
|
- **get_buf** is for getting a response/request in a virtqueue, and
|
||||||
- **kick** is for notifying the other side for a virtqueue to consume buffers.
|
- **kick** is for notifying the other side for a virtqueue to consume buffers.
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ power state transition:
|
|||||||
- Pauses Service VM.
|
- Pauses Service VM.
|
||||||
- Wait all other guests enter low power state.
|
- Wait all other guests enter low power state.
|
||||||
- Offlines all physical APs.
|
- Offlines all physical APs.
|
||||||
- Save the context of console, ioapic of Service VM, I/O MMU, lapic of
|
- Save the context of console, ioapic of Service VM, I/O MMU, lapic of
|
||||||
Service VM, virtual BSP.
|
Service VM, virtual BSP.
|
||||||
- Save the context of physical BSP.
|
- Save the context of physical BSP.
|
||||||
|
|
||||||
|
@ -150,7 +150,7 @@ How to build ACRN on Fedora 29?
|
|||||||
There is a known issue when attempting to build ACRN on Fedora 29
|
There is a known issue when attempting to build ACRN on Fedora 29
|
||||||
because of how ``gnu-efi`` is packaged in this Fedora release.
|
because of how ``gnu-efi`` is packaged in this Fedora release.
|
||||||
(See the `ACRN GitHub issue
|
(See the `ACRN GitHub issue
|
||||||
<https://github.com/projectacrn/acrn-hypervisor/issues/2457>`_
|
<https://github.com/projectacrn/acrn-hypervisor/issues/2457>`_
|
||||||
for more information.) The following patch to ``/efi-stub/Makefile``
|
for more information.) The following patch to ``/efi-stub/Makefile``
|
||||||
fixes the problem on Fedora 29 development systems (but should
|
fixes the problem on Fedora 29 development systems (but should
|
||||||
not be used on other Linux distros)::
|
not be used on other Linux distros)::
|
||||||
|
@ -616,10 +616,10 @@ ACRN Device model incorporates these three aspects:
|
|||||||
from the User VM device, the I/O dispatcher sends this request to the
|
from the User VM device, the I/O dispatcher sends this request to the
|
||||||
corresponding device emulation routine.
|
corresponding device emulation routine.
|
||||||
|
|
||||||
**I/O Path**:
|
**I/O Path**:
|
||||||
see `ACRN-io-mediator`_ below
|
see `ACRN-io-mediator`_ below
|
||||||
|
|
||||||
**VHM**:
|
**VHM**:
|
||||||
The Virtio and Hypervisor Service Module is a kernel module in the
|
The Virtio and Hypervisor Service Module is a kernel module in the
|
||||||
Service VM acting as a middle layer to support the device model. The VHM
|
Service VM acting as a middle layer to support the device model. The VHM
|
||||||
and its client handling flow is described below:
|
and its client handling flow is described below:
|
||||||
@ -747,7 +747,7 @@ Following along with the numbered items in :numref:`io-emulation-path`:
|
|||||||
the module is invoked to execute its processing APIs.
|
the module is invoked to execute its processing APIs.
|
||||||
6. After the ACRN device module completes the emulation (port IO 20h access
|
6. After the ACRN device module completes the emulation (port IO 20h access
|
||||||
in this example), (say uDev1 here), uDev1 puts the result into the
|
in this example), (say uDev1 here), uDev1 puts the result into the
|
||||||
shared page (in register AL in this example).
|
shared page (in register AL in this example).
|
||||||
7. ACRN device model then returns control to ACRN hypervisor to indicate the
|
7. ACRN device model then returns control to ACRN hypervisor to indicate the
|
||||||
completion of an IO instruction emulation, typically thru VHM/hypercall.
|
completion of an IO instruction emulation, typically thru VHM/hypercall.
|
||||||
8. The ACRN hypervisor then knows IO emulation is complete, and copies
|
8. The ACRN hypervisor then knows IO emulation is complete, and copies
|
||||||
|
@ -34,7 +34,7 @@ https://projectacrn.github.io/0.4/. Documentation for the latest
|
|||||||
Version 0.4 new features
|
Version 0.4 new features
|
||||||
************************
|
************************
|
||||||
|
|
||||||
- :acrn-issue:`1824` - implement "wbinvd" emulation
|
- :acrn-issue:`1824` - implement "wbinvd" emulation
|
||||||
- :acrn-issue:`1859` - Doc: update GSG guide to avoid issue "black screen"
|
- :acrn-issue:`1859` - Doc: update GSG guide to avoid issue "black screen"
|
||||||
- :acrn-issue:`1878` - The "Using Ubuntu as the Service OS" tutorial is outdated and needs to be refreshed
|
- :acrn-issue:`1878` - The "Using Ubuntu as the Service OS" tutorial is outdated and needs to be refreshed
|
||||||
- :acrn-issue:`1926` - `kernel-doc` causing `make doc` failure (because of upcoming Perl changes)
|
- :acrn-issue:`1926` - `kernel-doc` causing `make doc` failure (because of upcoming Perl changes)
|
||||||
@ -147,7 +147,7 @@ Known Issues
|
|||||||
**Impact:** Failed to use UART for input in corner case.
|
**Impact:** Failed to use UART for input in corner case.
|
||||||
|
|
||||||
**Workaround:** Enter other keys before typing :kbd:`Enter`.
|
**Workaround:** Enter other keys before typing :kbd:`Enter`.
|
||||||
|
|
||||||
:acrn-issue:`1996` - There is an error log when using "acrnd&" to boot UOS
|
: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
|
An error log is printed when starting acrnd as a background job
|
||||||
(``acrnd&``) to boot UOS. The UOS still boots up
|
(``acrnd&``) to boot UOS. The UOS still boots up
|
||||||
|
@ -34,16 +34,16 @@ https://projectacrn.github.io/0.5/. Documentation for the latest
|
|||||||
Version 0.5 new features
|
Version 0.5 new features
|
||||||
************************
|
************************
|
||||||
|
|
||||||
**OVMF support initial patches merged in ACRN**:
|
**OVMF support initial patches merged in ACRN**:
|
||||||
To support booting Windows as a Guest OS, we are
|
To support booting Windows as a Guest OS, we are
|
||||||
using Open source Virtual Machine Firmware (OVMF).
|
using Open source Virtual Machine Firmware (OVMF).
|
||||||
Initial patches to support OVMF have been merged in ACRN hypervisor.
|
Initial patches to support OVMF have been merged in ACRN hypervisor.
|
||||||
More patches for ACRN and patches upstreaming to OVMF work will be continuing.
|
More patches for ACRN and patches upstreaming to OVMF work will be continuing.
|
||||||
|
|
||||||
**UP2 board serial port support**:
|
**UP2 board serial port support**:
|
||||||
This release enables serial port debugging on UP2 boards during SOS and UOS boot.
|
This release enables serial port debugging on UP2 boards during SOS and UOS boot.
|
||||||
|
|
||||||
**One E2E binary to support all UEFI platform**:
|
**One E2E binary to support all UEFI platform**:
|
||||||
ACRN can support both Apollo Lake (APL) and Kaby Lake (KBL) NUCs.
|
ACRN can support both Apollo Lake (APL) and Kaby Lake (KBL) NUCs.
|
||||||
Instead of having separate builds, this release offers community
|
Instead of having separate builds, this release offers community
|
||||||
developers a single end-to-end reference build that supports both
|
developers a single end-to-end reference build that supports both
|
||||||
@ -52,11 +52,11 @@ See :ref:`getting_started` for more information.
|
|||||||
|
|
||||||
**APL UP2 board with SBL firmware**: With this 0.5 release, ACRN
|
**APL UP2 board with SBL firmware**: With this 0.5 release, ACRN
|
||||||
now supports APL UP2 board with slim Bootloader (SBL) firmware.
|
now supports APL UP2 board with slim Bootloader (SBL) firmware.
|
||||||
Slim Bootloader is a modern, flexible, light-weight, open source
|
Slim Bootloader is a modern, flexible, light-weight, open source
|
||||||
reference boot loader with key benefits such as being fast, small,
|
reference boot loader with key benefits such as being fast, small,
|
||||||
customizable, and secure. An end-to-end reference build with
|
customizable, and secure. An end-to-end reference build with
|
||||||
ACRN hypervisor, Clear Linux OS as SOS, and Clear Linux OS as UOS has been
|
ACRN hypervisor, Clear Linux OS as SOS, and Clear Linux OS as UOS has been
|
||||||
verified on UP2/SBL board. See the :ref:`using-sbl-up2` documentation
|
verified on UP2/SBL board. See the :ref:`using-sbl-up2` documentation
|
||||||
for step-by-step instructions.
|
for step-by-step instructions.
|
||||||
|
|
||||||
**Document updates**: Several new documents have been added in this release, including:
|
**Document updates**: Several new documents have been added in this release, including:
|
||||||
@ -68,35 +68,35 @@ for step-by-step instructions.
|
|||||||
- :acrn-issue:`892` - Power Management: VMM control
|
- :acrn-issue:`892` - Power Management: VMM control
|
||||||
- :acrn-issue:`894` - Power Management: S5
|
- :acrn-issue:`894` - Power Management: S5
|
||||||
- :acrn-issue:`914` - GPU Passthrough
|
- :acrn-issue:`914` - GPU Passthrough
|
||||||
- :acrn-issue:`1124` - MMU code reshuffle
|
- :acrn-issue:`1124` - MMU code reshuffle
|
||||||
- :acrn-issue:`1179` - RPMB key passing
|
- :acrn-issue:`1179` - RPMB key passing
|
||||||
- :acrn-issue:`1180` - vFastboot release version 0.9
|
- :acrn-issue:`1180` - vFastboot release version 0.9
|
||||||
- :acrn-issue:`1181` - Integrate enabling Crash OS feature as default in VSBL debugversion
|
- :acrn-issue:`1181` - Integrate enabling Crash OS feature as default in VSBL debugversion
|
||||||
- :acrn-issue:`1182` - vSBL to support ACPI customization
|
- :acrn-issue:`1182` - vSBL to support ACPI customization
|
||||||
- :acrn-issue:`1240` - [APL][IO Mediator] Enable VHOST_NET & VHOST to accelerate guest networking with virtio_net.
|
- :acrn-issue:`1240` - [APL][IO Mediator] Enable VHOST_NET & VHOST to accelerate guest networking with virtio_net.
|
||||||
- :acrn-issue:`1284` - [DeviceModel]Enable NHLT table in DM for audio passthrough
|
- :acrn-issue:`1284` - [DeviceModel]Enable NHLT table in DM for audio passthrough
|
||||||
- :acrn-issue:`1313` - [APL][IO Mediator] Remove unused netmap/vale in virtio-net
|
- :acrn-issue:`1313` - [APL][IO Mediator] Remove unused netmap/vale in virtio-net
|
||||||
- :acrn-issue:`1330` - combine VM creating and ioreq shared page setup
|
- :acrn-issue:`1330` - combine VM creating and ioreq shared page setup
|
||||||
- :acrn-issue:`1364` - [APL][IO Mediator] virtio code reshuffle
|
- :acrn-issue:`1364` - [APL][IO Mediator] virtio code reshuffle
|
||||||
- :acrn-issue:`1496` - provide a string convert api and remove banned function for virtio-blk
|
- :acrn-issue:`1496` - provide a string convert api and remove banned function for virtio-blk
|
||||||
- :acrn-issue:`1546` - hv: timer: add debug information for add_timer
|
- :acrn-issue:`1546` - hv: timer: add debug information for add_timer
|
||||||
- :acrn-issue:`1579` - vSBL to Support Ramoops
|
- :acrn-issue:`1579` - vSBL to Support Ramoops
|
||||||
- :acrn-issue:`1580` - vSBL to support crash mode with vFastboot
|
- :acrn-issue:`1580` - vSBL to support crash mode with vFastboot
|
||||||
- :acrn-issue:`1626` - support x2APIC mode for ACRN guests
|
- :acrn-issue:`1626` - support x2APIC mode for ACRN guests
|
||||||
- :acrn-issue:`1672` - L1TF mitigation
|
- :acrn-issue:`1672` - L1TF mitigation
|
||||||
- :acrn-issue:`1747` - Replace function like macro with inline function
|
- :acrn-issue:`1747` - Replace function like macro with inline function
|
||||||
- :acrn-issue:`1821` - Optimize IO request path
|
- :acrn-issue:`1821` - Optimize IO request path
|
||||||
- :acrn-issue:`1832` - Add OVMF booting support for booting as an alternative to vSBL.
|
- :acrn-issue:`1832` - Add OVMF booting support for booting as an alternative to vSBL.
|
||||||
- :acrn-issue:`1882` - Extend the SOS CMA range from 64M to 128M
|
- :acrn-issue:`1882` - Extend the SOS CMA range from 64M to 128M
|
||||||
- :acrn-issue:`1995` - Support SBL firmware as boot loader on Apollo Lake UP2.
|
- :acrn-issue:`1995` - Support SBL firmware as boot loader on Apollo Lake UP2.
|
||||||
- :acrn-issue:`2011` - support DISCARD command for virtio-blk
|
- :acrn-issue:`2011` - support DISCARD command for virtio-blk
|
||||||
- :acrn-issue:`2036` - Update and complete `acrn-dm` parameters description in the user guide and HLD
|
- :acrn-issue:`2036` - Update and complete `acrn-dm` parameters description in the user guide and HLD
|
||||||
- :acrn-issue:`2037` - Set correct name for each pthread in DM
|
- :acrn-issue:`2037` - Set correct name for each pthread in DM
|
||||||
- :acrn-issue:`2079` - Replace banned API with permitted API function in a crn device-model
|
- :acrn-issue:`2079` - Replace banned API with permitted API function in a crn device-model
|
||||||
- :acrn-issue:`2120` - Optimize trusty logic to meet MISRA-C rules
|
- :acrn-issue:`2120` - Optimize trusty logic to meet MISRA-C rules
|
||||||
- :acrn-issue:`2145` - Reuse linux common virtio header file for virtio
|
- :acrn-issue:`2145` - Reuse linux common virtio header file for virtio
|
||||||
- :acrn-issue:`2170` - For UEFI based hardware platforms, one Clear Linux OS E2E build binary can be used for all platform's installation
|
- :acrn-issue:`2170` - For UEFI based hardware platforms, one Clear Linux OS E2E build binary can be used for all platform's installation
|
||||||
- :acrn-issue:`2187` - Complete the cleanup of unbounded APIs usage
|
- :acrn-issue:`2187` - Complete the cleanup of unbounded APIs usage
|
||||||
|
|
||||||
Fixed Issues
|
Fixed Issues
|
||||||
************
|
************
|
||||||
@ -187,7 +187,7 @@ Known Issues
|
|||||||
**Impact:** Failed to use UART for input in corner case.
|
**Impact:** Failed to use UART for input in corner case.
|
||||||
|
|
||||||
**Workaround:** Enter other keys before typing :kbd:`Enter`.
|
**Workaround:** Enter other keys before typing :kbd:`Enter`.
|
||||||
|
|
||||||
:acrn-issue:`1996` - There is an error log when using "acrnd&" to boot UOS
|
: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
|
An error log is printed when starting acrnd as a background job
|
||||||
(``acrnd&``) to boot UOS. The UOS still boots up
|
(``acrnd&``) to boot UOS. The UOS still boots up
|
||||||
@ -198,7 +198,7 @@ Known Issues
|
|||||||
|
|
||||||
**Workaround:** None.
|
**Workaround:** None.
|
||||||
|
|
||||||
:acrn-issue:`2267` - [APLUP2][LaaG]LaaG can't detect 4k monitor
|
:acrn-issue:`2267` - [APLUP2][LaaG]LaaG can't detect 4k monitor
|
||||||
After launching UOS on APL UP2 , 4k monitor cannot be detected.
|
After launching UOS on APL UP2 , 4k monitor cannot be detected.
|
||||||
|
|
||||||
**Impact:** UOS hasn't display with 4k monitor.
|
**Impact:** UOS hasn't display with 4k monitor.
|
||||||
@ -206,7 +206,7 @@ Known Issues
|
|||||||
**Workaround:** None.
|
**Workaround:** None.
|
||||||
|
|
||||||
:acrn-issue:`2276` - OVMF failed to launch UOS on UP2.
|
:acrn-issue:`2276` - OVMF failed to launch UOS on UP2.
|
||||||
UP2 failed to launch UOS using OVMF as virtual bootloader with acrn-dm.
|
UP2 failed to launch UOS using OVMF as virtual bootloader with acrn-dm.
|
||||||
|
|
||||||
**Impact:** UOS cannot boot up using OVMF
|
**Impact:** UOS cannot boot up using OVMF
|
||||||
|
|
||||||
@ -224,9 +224,9 @@ Known Issues
|
|||||||
|
|
||||||
**Impact:** Power Management states related operations cannot be using in SOS/UOS on KBLNUC
|
**Impact:** Power Management states related operations cannot be using in SOS/UOS on KBLNUC
|
||||||
|
|
||||||
**Workaround:** None
|
**Workaround:** None
|
||||||
|
|
||||||
:acrn-issue:`2279` - [APLNUC]After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the
|
:acrn-issue:`2279` - [APLNUC]After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the
|
||||||
Usb_KeyBoard and Mouse
|
Usb_KeyBoard and Mouse
|
||||||
After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse.
|
After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse.
|
||||||
Reproduce Steps as below:
|
Reproduce Steps as below:
|
||||||
@ -240,7 +240,7 @@ Known Issues
|
|||||||
|
|
||||||
4) Exit UOS.
|
4) Exit UOS.
|
||||||
|
|
||||||
5) SOS access USB keyboard and mouse.
|
5) SOS access USB keyboard and mouse.
|
||||||
|
|
||||||
**Impact:** SOS cannot use USB keyboard and mouse in such case.
|
**Impact:** SOS cannot use USB keyboard and mouse in such case.
|
||||||
|
|
||||||
|
@ -153,7 +153,7 @@ Known Issues
|
|||||||
|
|
||||||
**Workaround:** None.
|
**Workaround:** None.
|
||||||
|
|
||||||
:acrn-issue:`2267` - [APLUP2][LaaG]LaaG can't detect 4k monitor
|
:acrn-issue:`2267` - [APLUP2][LaaG]LaaG can't detect 4k monitor
|
||||||
After launching UOS on APL UP2 , 4k monitor cannot be detected.
|
After launching UOS on APL UP2 , 4k monitor cannot be detected.
|
||||||
|
|
||||||
**Impact:** UOS can't display on a 4k monitor.
|
**Impact:** UOS can't display on a 4k monitor.
|
||||||
@ -161,7 +161,7 @@ Known Issues
|
|||||||
**Workaround:** Use a monitor with less than 4k resolution.
|
**Workaround:** Use a monitor with less than 4k resolution.
|
||||||
|
|
||||||
:acrn-issue:`2276` - OVMF failed to launch UOS on UP2.
|
:acrn-issue:`2276` - OVMF failed to launch UOS on UP2.
|
||||||
UP2 failed to launch UOS using OVMF as virtual bootloader with acrn-dm.
|
UP2 failed to launch UOS using OVMF as virtual bootloader with acrn-dm.
|
||||||
|
|
||||||
**Impact:** UOS cannot boot up using OVMF
|
**Impact:** UOS cannot boot up using OVMF
|
||||||
|
|
||||||
@ -172,7 +172,7 @@ Known Issues
|
|||||||
|
|
||||||
**Impact:** Power Management states related operations cannot be using in SOS/UOS on KBLNUC
|
**Impact:** Power Management states related operations cannot be using in SOS/UOS on KBLNUC
|
||||||
|
|
||||||
**Workaround:** None
|
**Workaround:** None
|
||||||
|
|
||||||
:acrn-issue:`2279` - [APLNUC]After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse
|
:acrn-issue:`2279` - [APLNUC]After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse
|
||||||
After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse.
|
After exiting UOS with mediator Usb_KeyBoard and Mouse, SOS cannot use the Usb_KeyBoard and Mouse.
|
||||||
@ -188,7 +188,7 @@ Known Issues
|
|||||||
|
|
||||||
4) Exit UOS.
|
4) Exit UOS.
|
||||||
|
|
||||||
5) SOS access USB keyboard and mouse.
|
5) SOS access USB keyboard and mouse.
|
||||||
|
|
||||||
**Impact:** SOS cannot use USB keyboard and mouse in such case.
|
**Impact:** SOS cannot use USB keyboard and mouse in such case.
|
||||||
|
|
||||||
@ -208,9 +208,9 @@ Known Issues
|
|||||||
|
|
||||||
**Workaround:** Remove enable_initial_modeset for UP2 platform. You can apply :acrn-commit:`4b53ed67` to rebuild UP2 images.
|
**Workaround:** Remove enable_initial_modeset for UP2 platform. You can apply :acrn-commit:`4b53ed67` to rebuild UP2 images.
|
||||||
|
|
||||||
:acrn-issue:`2522` - [NUC7i7BNH]After starting ias in SOS, there is no display
|
: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
|
On NUC7i7BNH, after starting IAS in SOS, there is no display if the monitor is
|
||||||
connected with a TPC to VGA connector.
|
connected with a TPC to VGA connector.
|
||||||
|
|
||||||
**Impact:** Special model [NUC7i7BNH] has no display in SOS.
|
**Impact:** Special model [NUC7i7BNH] has no display in SOS.
|
||||||
|
|
||||||
@ -221,7 +221,7 @@ Known Issues
|
|||||||
|
|
||||||
**Impact:** Cannot use ias weston in UOS.
|
**Impact:** Cannot use ias weston in UOS.
|
||||||
|
|
||||||
**Workaround:**
|
**Workaround:**
|
||||||
|
|
||||||
1) Use weston instead of IAS weston: ``swupd install x11-server``
|
1) Use weston instead of IAS weston: ``swupd install x11-server``
|
||||||
2) Use acrn-kernel to rebuild SOS kernel to replace integrated kernel. To confirm "DRM_FBDEV_EMULATION" related configs in kernel_config_sos should as below:
|
2) Use acrn-kernel to rebuild SOS kernel to replace integrated kernel. To confirm "DRM_FBDEV_EMULATION" related configs in kernel_config_sos should as below:
|
||||||
@ -240,7 +240,7 @@ Known Issues
|
|||||||
**Impact:** launching UOS hang, and then no display in UOS.
|
**Impact:** launching UOS hang, and then no display in UOS.
|
||||||
|
|
||||||
**Workaround:** Use acrn-kernel to rebuild SOS kernel to replace the
|
**Workaround:** Use acrn-kernel to rebuild SOS kernel to replace the
|
||||||
integrated kernel. Confirm "DRM_FBDEV_EMULATION" related
|
integrated kernel. Confirm "DRM_FBDEV_EMULATION" related
|
||||||
configs in kernel_config_sos are as below:
|
configs in kernel_config_sos are as below:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
@ -254,14 +254,14 @@ Known Issues
|
|||||||
:acrn-issue:`2527` - [KBLNUC][HV]System will crash when run crashme (SOS/UOS)
|
: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.
|
System will crash after a few minutes running stress test crashme tool in SOS/UOS.
|
||||||
|
|
||||||
**Impact:** System may crash in some stress situation.
|
**Impact:** System may crash in some stress situation.
|
||||||
|
|
||||||
**Workaround:** None
|
**Workaround:** None
|
||||||
|
|
||||||
:acrn-issue:`2528` - [APLUP2] SBL (built by SBL latest code) failed to boot ACRN hypervisor
|
:acrn-issue:`2528` - [APLUP2] SBL (built by SBL latest code) failed to boot ACRN hypervisor
|
||||||
SBL built by latest slimbootloader code (HEAD->ad42a2bd6e4a6364358b9c712cb54e821ee7ee42) failed to boot acrn hypervisor.
|
SBL built by latest slimbootloader code (HEAD->ad42a2bd6e4a6364358b9c712cb54e821ee7ee42) failed to boot acrn hypervisor.
|
||||||
|
|
||||||
**Impact:** UP2 with SBL cannot boot acrn hypervisor.
|
**Impact:** UP2 with SBL cannot boot acrn hypervisor.
|
||||||
|
|
||||||
**Workaround:** Use SBL built by earlier slimbootloader code (commit id:edc112328cf3e414523162dd75dc3614e42579fe).
|
**Workaround:** Use SBL built by earlier slimbootloader code (commit id:edc112328cf3e414523162dd75dc3614e42579fe).
|
||||||
This folder version can boot acrn hypervisor normally.
|
This folder version can boot acrn hypervisor normally.
|
||||||
|
@ -68,7 +68,7 @@ New Features Details
|
|||||||
- :acrn-issue:`3497` - Inject exception for invalid vmcall
|
- :acrn-issue:`3497` - Inject exception for invalid vmcall
|
||||||
- :acrn-issue:`3498` - Return extended info in vCPUID leaf 0x40000001
|
- :acrn-issue:`3498` - Return extended info in vCPUID leaf 0x40000001
|
||||||
- :acrn-issue:`2934` - Use virtual APIC IDs for Pre-launched VMs
|
- :acrn-issue:`2934` - Use virtual APIC IDs for Pre-launched VMs
|
||||||
- :acrn-issue:`3459` - dm: support VMs communication with virtio-console
|
- :acrn-issue:`3459` - dm: support VMs communication with virtio-console
|
||||||
- :acrn-issue:`3190` - DM: handle SIGPIPE signal
|
- :acrn-issue:`3190` - DM: handle SIGPIPE signal
|
||||||
|
|
||||||
Fixed Issues Details
|
Fixed Issues Details
|
||||||
|
@ -52,8 +52,8 @@ We recommend that all developers upgrade to this v1.4 release, which
|
|||||||
addresses the following security issues that were discovered in previous releases:
|
addresses the following security issues that were discovered in previous releases:
|
||||||
|
|
||||||
Mitigation for Machine Check Error on Page Size Change
|
Mitigation for Machine Check Error on Page Size Change
|
||||||
Improper invalidation for page table updates by a virtual guest operating system for multiple
|
Improper invalidation for page table updates by a virtual guest operating system for multiple
|
||||||
Intel |reg| Processors may allow an authenticated user to potentially enable denial of service
|
Intel |reg| Processors may allow an authenticated user to potentially enable denial of service
|
||||||
of the host system via local access. Malicious guest kernel could trigger this issue, CVE-2018-12207.
|
of the host system via local access. Malicious guest kernel could trigger this issue, CVE-2018-12207.
|
||||||
|
|
||||||
AP Trampoline Is Accessible to the Service VM
|
AP Trampoline Is Accessible to the Service VM
|
||||||
|
@ -72,7 +72,7 @@ folder setup for documentation contributions and generation:
|
|||||||
The parent projectacrn folder is there because we'll also be creating a
|
The parent projectacrn folder is there because we'll also be creating a
|
||||||
publishing area later in these steps. For API doc generation, we'll also
|
publishing area later in these steps. For API doc generation, we'll also
|
||||||
need the acrn-kernel repo contents in a sibling folder to the
|
need the acrn-kernel repo contents in a sibling folder to the
|
||||||
acrn-hypervisor repo contents.
|
acrn-hypervisor repo contents.
|
||||||
|
|
||||||
It's best if the acrn-hypervisor
|
It's best if the acrn-hypervisor
|
||||||
folder is an ssh clone of your personal fork of the upstream project
|
folder is an ssh clone of your personal fork of the upstream project
|
||||||
|
@ -34,7 +34,7 @@ We will use the ``qemu-img`` tool to increase the size of the virtual disk
|
|||||||
|
|
||||||
$ sudo swupd bundle-add clr-installer
|
$ sudo swupd bundle-add clr-installer
|
||||||
|
|
||||||
As an example, let us add 10GB of storage to our virtual disk image called
|
As an example, let us add 10GB of storage to our virtual disk image called
|
||||||
``uos.img``.
|
``uos.img``.
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
@ -78,23 +78,23 @@ Here is what the sequence looks like:
|
|||||||
GNU Parted 3.2
|
GNU Parted 3.2
|
||||||
Using /home/gvancuts/uos/uos.img
|
Using /home/gvancuts/uos/uos.img
|
||||||
Welcome to GNU Parted! Type 'help' to view a list of commands.
|
Welcome to GNU Parted! Type 'help' to view a list of commands.
|
||||||
(parted) p
|
(parted) p
|
||||||
Warning: Not all of the space available to /home/gvancuts/uos/uos.img appears to be used, you can fix the GPT to use all of the space (an extra 20971520 blocks) or continue with the current setting?
|
Warning: Not all of the space available to /home/gvancuts/uos/uos.img appears to be used, you can fix the GPT to use all of the space (an extra 20971520 blocks) or continue with the current setting?
|
||||||
Fix/Ignore? Fix
|
Fix/Ignore? Fix
|
||||||
Model: (file)
|
Model: (file)
|
||||||
Disk /home/gvancuts/uos/uos.img: 19.9GB
|
Disk /home/gvancuts/uos/uos.img: 19.9GB
|
||||||
Sector size (logical/physical): 512B/512B
|
Sector size (logical/physical): 512B/512B
|
||||||
Partition Table: gpt
|
Partition Table: gpt
|
||||||
Disk Flags:
|
Disk Flags:
|
||||||
|
|
||||||
Number Start End Size File system Name Flags
|
Number Start End Size File system Name Flags
|
||||||
1 1049kB 537MB 536MB fat16 primary boot, esp
|
1 1049kB 537MB 536MB fat16 primary boot, esp
|
||||||
2 537MB 570MB 33.6MB linux-swap(v1) primary
|
2 537MB 570MB 33.6MB linux-swap(v1) primary
|
||||||
3 570MB 9160MB 8590MB ext4 primary
|
3 570MB 9160MB 8590MB ext4 primary
|
||||||
|
|
||||||
(parted) resizepart 3
|
(parted) resizepart 3
|
||||||
End? [9160MB]? 19.9GB
|
End? [9160MB]? 19.9GB
|
||||||
(parted) q
|
(parted) q
|
||||||
|
|
||||||
Resize the filesystem
|
Resize the filesystem
|
||||||
*********************
|
*********************
|
||||||
|
@ -90,7 +90,7 @@ Follow these steps:
|
|||||||
|
|
||||||
#. Open a terminal.
|
#. Open a terminal.
|
||||||
|
|
||||||
#. Download the ``acrn_quick_setup.sh`` script to set up the Service VM.
|
#. Download the ``acrn_quick_setup.sh`` script to set up the Service VM.
|
||||||
(If you don't need a proxy to get the script, skip the ``export`` command.)
|
(If you don't need a proxy to get the script, skip the ``export`` command.)
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
@ -113,7 +113,7 @@ Follow these steps:
|
|||||||
Service OS setup done!
|
Service OS setup done!
|
||||||
Rebooting Service OS to take effects.
|
Rebooting Service OS to take effects.
|
||||||
Rebooting.
|
Rebooting.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
This script is using ``/dev/sda1`` as the default EFI System Partition
|
This script is using ``/dev/sda1`` as the default EFI System Partition
|
||||||
ESP). If the ESP is different based on your hardware, you can specify
|
ESP). If the ESP is different based on your hardware, you can specify
|
||||||
@ -127,7 +127,7 @@ Follow these steps:
|
|||||||
|
|
||||||
``sudo sh acrn_quick_setup.sh -s 32080 -e /dev/nvme0n1p1 -d``
|
``sudo sh acrn_quick_setup.sh -s 32080 -e /dev/nvme0n1p1 -d``
|
||||||
|
|
||||||
#. After the system reboots, log in as the **clear** user. Verify that the Service VM
|
#. After the system reboots, log in as the **clear** user. Verify that the Service VM
|
||||||
booted successfully by checking the ``dmesg`` log:
|
booted successfully by checking the ``dmesg`` log:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
@ -180,7 +180,7 @@ Follow these steps:
|
|||||||
|
|
||||||
clr-a632ec84744d4e02974fe1891130002e login:
|
clr-a632ec84744d4e02974fe1891130002e login:
|
||||||
|
|
||||||
#. Log in as root. Specify the new password. Verify that you are running in the User VM
|
#. Log in as root. Specify the new password. Verify that you are running in the User VM
|
||||||
by checking the kernel release version or seeing if acrn devices are visible:
|
by checking the kernel release version or seeing if acrn devices are visible:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
@ -214,7 +214,7 @@ and User VM manually. Follow these steps:
|
|||||||
#. Install Clear Linux on the NUC, log in as the **clear** user,
|
#. Install Clear Linux on the NUC, log in as the **clear** user,
|
||||||
and open a terminal window.
|
and open a terminal window.
|
||||||
|
|
||||||
#. Disable the auto-update feature. Clear Linux OS is set to automatically update itself.
|
#. Disable the auto-update feature. Clear Linux OS is set to automatically update itself.
|
||||||
We recommend that you disable this feature to have more control over when updates happen. Use this command:
|
We recommend that you disable this feature to have more control over when updates happen. Use this command:
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
@ -222,8 +222,8 @@ and User VM manually. Follow these steps:
|
|||||||
$ sudo swupd autoupdate --disable
|
$ sudo swupd autoupdate --disable
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
When enabled, the Clear Linux OS installer automatically checks for updates and installs the latest version
|
When enabled, the Clear Linux OS installer automatically checks for updates and installs the latest version
|
||||||
available on your system. To use a specific version (such as 32080), enter the following command after the
|
available on your system. To use a specific version (such as 32080), enter the following command after the
|
||||||
installation is complete:
|
installation is complete:
|
||||||
|
|
||||||
``sudo swupd repair --picky -V 32080``
|
``sudo swupd repair --picky -V 32080``
|
||||||
@ -408,7 +408,7 @@ ACRN Network Bridge
|
|||||||
===================
|
===================
|
||||||
|
|
||||||
The ACRN bridge has been set up as a part of systemd services for device
|
The ACRN bridge has been set up as a part of systemd services for device
|
||||||
communication. The default bridge creates ``acrn_br0`` which is the bridge and ``tap0`` as an initial setup.
|
communication. The default bridge creates ``acrn_br0`` which is the bridge and ``tap0`` as an initial setup.
|
||||||
The files can be found in ``/usr/lib/systemd/network``. No additional setup is needed since **systemd-networkd** is
|
The files can be found in ``/usr/lib/systemd/network``. No additional setup is needed since **systemd-networkd** is
|
||||||
automatically enabled after a system restart.
|
automatically enabled after a system restart.
|
||||||
|
|
||||||
@ -425,8 +425,8 @@ Set up Reference User VM
|
|||||||
$ cd uos
|
$ cd uos
|
||||||
$ curl https://download.clearlinux.org/releases/32080/clear/clear-32080-kvm.img.xz -o uos.img.xz
|
$ curl https://download.clearlinux.org/releases/32080/clear/clear-32080-kvm.img.xz -o uos.img.xz
|
||||||
|
|
||||||
Note that if you want to use or try out a newer version of Clear Linux OS as the User VM, download the
|
Note that if you want to use or try out a newer version of Clear Linux OS as the User VM, download the
|
||||||
latest from `http://download.clearlinux.org/image/`.
|
latest from `http://download.clearlinux.org/image/`.
|
||||||
Make sure to adjust the steps described below accordingly (image file name and kernel modules version).
|
Make sure to adjust the steps described below accordingly (image file name and kernel modules version).
|
||||||
|
|
||||||
#. Uncompress it:
|
#. Uncompress it:
|
||||||
@ -435,7 +435,7 @@ Set up Reference User VM
|
|||||||
|
|
||||||
$ unxz uos.img.xz
|
$ unxz uos.img.xz
|
||||||
|
|
||||||
#. Deploy the User VM kernel modules to the User VM virtual disk image (note that you'll need to
|
#. Deploy the User VM kernel modules to the User VM virtual disk image (note that you'll need to
|
||||||
use the same **iot-lts2018** image version number noted in Step 1 above):
|
use the same **iot-lts2018** image version number noted in Step 1 above):
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
@ -250,7 +250,7 @@ section, we'll focus on two major components:
|
|||||||
|
|
||||||
* one is the basic idea of
|
* one is the basic idea of
|
||||||
secure world and insecure world isolation (so called one-vm,
|
secure world and insecure world isolation (so called one-vm,
|
||||||
two-worlds),
|
two-worlds),
|
||||||
* the other one is the secure storage virtualization in ACRN.
|
* the other one is the secure storage virtualization in ACRN.
|
||||||
|
|
||||||
See :ref:`trusty_tee` for additional details of Trusty implementation in
|
See :ref:`trusty_tee` for additional details of Trusty implementation in
|
||||||
|
@ -19,26 +19,26 @@ SoCs. Both have been confirmed to work with ACRN.
|
|||||||
Connecting to the serial port
|
Connecting to the serial port
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
The UP2 board has two serial ports. The following figure shows the UP2 board's
|
The UP2 board has two serial ports. The following figure shows the UP2 board's
|
||||||
40-pin HAT connector we'll be using as documented in the `UP2 Datasheet
|
40-pin HAT connector we'll be using as documented in the `UP2 Datasheet
|
||||||
<https://up-board.org/wp-content/uploads/datasheets/UP-Square-DatasheetV0.5.pdf>`_.
|
<https://up-board.org/wp-content/uploads/datasheets/UP-Square-DatasheetV0.5.pdf>`_.
|
||||||
|
|
||||||
.. image:: images/the-bottom-side-of-UP2-board.png
|
.. image:: images/the-bottom-side-of-UP2-board.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
We'll access the serial port through the I/O pins in the
|
We'll access the serial port through the I/O pins in the
|
||||||
40-pin HAT connector using a `USB TTL serial cable
|
40-pin HAT connector using a `USB TTL serial cable
|
||||||
<http://www.ftdichip.com/Products/USBTTLSerial.htm>`_,
|
<http://www.ftdichip.com/Products/USBTTLSerial.htm>`_,
|
||||||
and show how to connect a serial port with
|
and show how to connect a serial port with
|
||||||
``PL2303TA USB to TTL serial cable`` for example:
|
``PL2303TA USB to TTL serial cable`` for example:
|
||||||
|
|
||||||
.. image:: images/USB-to-TTL-serial-cable.png
|
.. image:: images/USB-to-TTL-serial-cable.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Connect pin 6 (``Ground``), pin 8 (``UART_TXD``) and pin 10 (``UART_RXD``) of the HAT
|
Connect pin 6 (``Ground``), pin 8 (``UART_TXD``) and pin 10 (``UART_RXD``) of the HAT
|
||||||
connector to respectively the ``GND``, ``RX`` and ``TX`` pins of your
|
connector to respectively the ``GND``, ``RX`` and ``TX`` pins of your
|
||||||
USB serial cable. Plug the USB TTL serial cable into your PC and use a
|
USB serial cable. Plug the USB TTL serial cable into your PC and use a
|
||||||
console emulation tool such as ``minicom`` or ``putty`` to communicate
|
console emulation tool such as ``minicom`` or ``putty`` to communicate
|
||||||
with the UP2 board for debugging.
|
with the UP2 board for debugging.
|
||||||
|
|
||||||
.. image:: images/the-connection-of-serial-port.png
|
.. image:: images/the-connection-of-serial-port.png
|
||||||
|
@ -257,12 +257,12 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
|
|||||||
uses ``/usr/share/acrn/bios/OVMF.fd`` as the OVMF image
|
uses ``/usr/share/acrn/bios/OVMF.fd`` as the OVMF image
|
||||||
|
|
||||||
ACRN supports option "w" of OVMF. To preserve any change of OVMF NV data
|
ACRN supports option "w" of OVMF. To preserve any change of OVMF NV data
|
||||||
store section, using this option to enable NV data store section writeback.
|
store section, using this option to enable NV data store section writeback.
|
||||||
|
|
||||||
usage::
|
usage::
|
||||||
|
|
||||||
--ovmf w,/usr/share/acrn/bios/OVMF.fd
|
--ovmf w,/usr/share/acrn/bios/OVMF.fd
|
||||||
|
|
||||||
|
|
||||||
* - :kbd:`--virtio_poll <poll_interval>`
|
* - :kbd:`--virtio_poll <poll_interval>`
|
||||||
- Enable virtio poll mode with poll interval xxx ns.
|
- Enable virtio poll mode with poll interval xxx ns.
|
||||||
|
Loading…
Reference in New Issue
Block a user