github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-20 12:42:54 +00:00
Code Issues Projects Releases Wiki Activity

Documentation: clean-up of isolated README.rst files

Browse Source 
Clean up of a couple of README.rst files located respectively under hypervisor/
and devicemodel/ to remove obsolete and unmaintained information. Both hold a
basic introduction about the folder content and refer to the official
documentation website for more detailed information.

Tracked-On: #1827
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2018-11-14 16:04:21 +01:00 committed by David Kinder
parent 29f9502152
commit 4ec4ddc0cc
2 changed files with 23 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
devicemodel/README.rst
View File

@ -3,78 +3,10 @@ ACRN Device Model
Introduction Introduction
============ ============
The ACRN Device Model provides **device sharing** capabilities between the Service OS and Guest OSs. It is a component that is used in conjunction with the `ACRN Hypervisor`_ and this is installed within the Service OS. You can find out more about Project ACRN on the `Project ACRN documentation`_ website. The ACRN Device Model provides **device sharing** capabilities between the
Service OS and Guest OSs. It is a component that is used in conjunction with
the `ACRN Hypervisor`_ and this is installed within the Service OS. You can
Building the Device Model find out more about Project ACRN on the `Project ACRN documentation`_ website.
=========================
Build dependencies
******************
* For Clear Linux
.. code-block:: console
sudo swupd bundle-add os-clr-on-clr \
os-utils-gui-dev
* For CentOS
.. code-block:: console
sudo yum install gcc \
libuuid-devel \
openssl-devel \
libpciaccess-devel \
libusb-devel
* For Fedora 27
.. code-block:: console
sudo dnf install gcc \
libuuid-devel \
openssl-devel \
libpciaccess-devel \
libusb-devel
Build
*****
To build the Device Model
.. code-block:: console
make
To clean the build artefacts
.. code-block:: console
make clean
Runtime dependencies
********************
* On CentOS
.. code-block:: console
sudo yum install openssl-libs \
zlib \
libpciaccess \
libuuid \
libusb
* On Fedora 27
.. code-block:: console
sudo dnf install openssl-libs \
zlib \
libpciaccess \
libuuid \
libusb
.. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor .. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor
.. _`Project ACRN documentation`: https://projectacrn.github.io/ .. _`Project ACRN documentation`: https://projectacrn.github.io/

40
hypervisor/README.rst
View File

@ -1,25 +1,23 @@
Embedded-Hypervisor ACRN Hypervisor
################### ###############
This open source embedded hypervisor defines a software architecture for The open source `Project ACRN`_ defines a device hypervisor reference stack and
running multiple software subsystems managed securely on a consolidated an architecture for running multiple software subsystems, managed securely, on
system (by means of a virtual machine manager), and defines a reference a consolidated system by means of a virtual machine manager. It also defines a
framework Device Model implementation for devices emulation reference framework implementation for virtual device emulation, called the
“ACRN Device Model”.
This embedded hypervisor is type-1 reference hypervisor, running The ACRN Hypervisor is a Type 1 reference hypervisor stack, running directly on
directly on the system hardware. It can be used for building software the bare-metal hardware, and is suitable for a variety of IoT and embedded
defined cockpit (SDC) or In-Vehicle Experience (IVE) solutions running device solutions. The ACRN hypervisor addresses the gap that currently exists
on Intel Architecture Apollo Lake platforms. As a reference between datacenter hypervisors, and hard partitioning hypervisors. The ACRN
implementation, it provides the basis for embedded hypervisor vendors to hypervisor architecture partitions the system into different functional
build solutions with an open source reference I/O mediation solution, domains, with carefully selected guest OS sharing optimizations for IoT and
and provides auto makers a reference software stack for SDC usage. embedded devices.
This embedded hypervisor is able to support both Linux* and Android* as You can find out more about Project ACRN on the `Project ACRN documentation`_
a Guest OS, managed by the hypervisor, where applications can run. website.
This embedded hypervisor is a partitioning hypervisor reference stack, .. _`Project ACRN`: https://projectacrn.org
also suitable for non-automotive IoT & embedded device solutions. It .. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor
will be addressing the gap that currently exists between datacenter .. _`Project ACRN documentation`: https://projectacrn.github.io/
hypervisors, hard partitioning hypervisors, and select industrial
applications. Extending the scope of this open source embedded
hypervisor relies on the involvement of community developers like you!