doc: add v0.1 release notes

Update text-formatted release notes as a reST document, but still needs
work to explain the features and is mising GitHub issue links for the
known issues list.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-07-08 20:58:58 -07:00 committed by David Kinder
parent 0bed25745b
commit bf5088eff4
2 changed files with 37 additions and 139 deletions

View File

@ -3,16 +3,9 @@
Release Notes
#############
Version 0.1 release (March 2018)
Version 0.1 release (July 2018)
********************************
In March 2018, Intel announced the open source Project ACRN at the
`Embedded Linux Conference and OpenIoT Summit North America 2018
<ELC18>`_.
.. _ELC18:
https://events.linuxfoundation.org/events/elc-openiot-north-america-2018/
ACRN is a flexible, lightweight reference hypervisor, built with
real-time and safety-criticality in mind, optimized to streamline
embedded development through an open source platform. Check out the
@ -36,23 +29,42 @@ This version 0.1 release has the following software components:
* The ACRN Hypervisor
* The ACRN Device Model
* The ACRN Virtio framework
* The ACRN Block & NIC & console Virtio drivers
* The ACRN Virtio Backend Service(VBS) & Virtio and Hypervisor Service Module(VHM).
* The ACRN Block, NIC, and console Virtio drivers
* The ACRN Virtio Backend Service(VBS) and the Virtio and Hypervisor Service Module (VHM).
Version 0.1 features include:
* ACRN hypervisor (Type 1 hypervisor)
* A hybrid VMM architecture implementation
* Multiple User OS supported
* VM management - such as VM start/stop/pause, virtual CPU pause/resume
* CPU virtualization
* Memory virtualization
* I/O emulation
* Virtual interrupt
* VT-x and VT-d support
* Hypercall for guest
* Device emulation
* Device pass-through mechanism
* Device Emulation mechanism
* Virtio console
* Virt-network
- Acrnctl
- Acrntrace
- Acrnlog
- SOS lifecycle
- vSBL
- virtio-blk
- virtio-net
- USB pass-thru
- CSE pass-thru
- IOC sharing (incl. cbc attach, cbc driver)
- IPU pass-thru
- BT pass-thru
- SD card pass-thru
- audio pass-thru
- surface sharing
- multi-plane, multi-pipe
- HDMI
- eDP
Known Issues
============
* GPU - Preemption (Prioritized Rendering,
* Batch Preemption, QoS Rendering)
* Preemption feature works, but performance is not optimized yet.
* Wifi not supported in guest OS
* Audio pass-through to guest OS, but can only be validated on driver level
using command line or alsa-player, and only supports limited formats
* CSME pass-through to guest OS
* GVT-g is available, need to perform features after configured properly
* Camera works in Android guest. But camera app may crash after 5 mins
* SD card works in Android guest, but does not support hot-plug.
* Surface Sharing: Sometimes the window setup on Service OS takes up to 30 second
* Sometimes system hangs, especially when workload is high (e.g. running benchmarks, playing videos)

View File

@ -1,114 +0,0 @@
ACRN V0.1 release note
Main features supported in this release:
Acrnctl
Acrntrace
Acrnlog
sos lifecycle
vSBL
virtio-blk
virtio-net
USB passthru
CSE passthru
IOC sharing (incl. cbc attach, cbc driver)
IPU passthru
BT passthru
SD card passthru
audio passthru
pre-emption
surface sharing
multi-plane, multi-pipe
HDMI
eDP
Commands Supported by ACRN Hypervisor:
Command
help
Provides helpful description about all available commands in hypervisor shell.
vm_list
Lists available VMs and displays the VM name, ID, and running state (“ON” for a running VM, and “OFF” otherwise).
vm_console
Switches the console from the hypervisor shell to a VMs shell.
set_loglevel
set_loglevel <console_loglevel> [mem_loglevel] - Set loglevel[0-6]
set log level so that people are able to get what they need from logout put, acrnlog defined 5 log levels, please refer to section 9.5 of Getting started guide
get_loglevel
get the log level
logdump
logdump <pcpu id>
dump log
vmexit
show vmexit profiling
dump_ioapic
show native ioapic info
vioapic
vioapic <vm_id>
show vioapic info
int
show interrupt info per CPU
lsreq
show ioreq info
pt
show pass-through device info
vcpu_dumpmem
vcpu_dumpmem <vm_id,vcpu_id, gva, length>
dump memory for a specific vcpu
vcpu_dumpreg
vcpu_dumpreg <vm_id, vcpu_id>
dump registers for a specific vcpu
vcpu_list
lists all VCPU in all VMs
Known Issues:
GPU Preemption (Prioritized Rendering,
Batch Preemption, QoS Rendering)
Preemption feature works, but performance is not optimized yet.
Wifi
Wifi not supported in guest OS
Audio
Audio pass-through to guest OS, but can only be validated on driver level, using command line or alsa-player, and only supports limited formats
CSME
CSME pass-through to guest OS
Graphic
GVT-g is available, need to perform features after configured properly
Camera/IPU
Camera works in Android guest. But camera app may crash after 5 mins
SD card
SD card works in Android guest, but does not support hot-plug.
Surface Sharing
Sometimes the window setup on Service OS takes up to 30 second
stability
Sometimes system hangs, especially when workload is high (e.g. running benchmarks, playing videos)
Change log: