acrn-hypervisor/devicemodel
Geoffroy Van Cutsem d93066f769 Move ACRN Device Model code in a devicemodel/ folder
This is part of the short series of commits that will lead
to a unified repository for the ACRN hypervisor, device model
and the associated documentation.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-05-10 01:51:51 +02:00
..
.travis-dockerfiles Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
arch/x86 Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
core Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
hw Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
include Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
samples Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
tools Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
.travis.yml Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
license_header Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
MAINTAINERS Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
Makefile Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00
README.rst Move ACRN Device Model code in a devicemodel/ folder 2018-05-10 01:51:51 +02:00

ACRN Device Model
#################

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.


Building the Device Model
=========================

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

* For Fedora 27

.. code-block:: console

   sudo dnf install gcc \
          libuuid-devel \
          openssl-devel \
          libpciaccess-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

* On Fedora 27

.. code-block:: console

   sudo dnf install openssl-libs \
                    zlib \
                    libpciaccess \
                    libuuid

.. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor
.. _`Project ACRN documentation`: https://projectacrn.github.io/