acrn-hypervisor/devicemodel
Chris Ye 756083fefc align usage info with command line
pincpu and vmexit_pause both aligned to lower p, it is a bug, vmexit_pause should align with P(upper).
Missing enable_bvmcons usage so add -b in help prints.
remove redundant tab blank to keep same indentation.

Signed-off-by: Chris Ye <chris.ye@intel.com>
2018-06-12 10:28:18 +08:00
..
arch/x86 DM: cleanup for header inclusions 2018-06-07 14:35:30 +08:00
bios dm: add vSBL binary in bios directory 2018-06-05 21:51:50 +08:00
core align usage info with command line 2018-06-12 10:28:18 +08:00
hw DM USB: Fix potential crash issues. 2018-06-08 13:45:34 +08:00
include DM: implement emulated npk pci device 2018-06-07 16:11:49 +08:00
samples convert bridge creation to service 2018-06-11 16:36:43 +08:00
MAINTAINERS update home page information 2018-05-15 17:19:39 +08:00
Makefile DM: implement emulated npk pci device 2018-06-07 16:11:49 +08:00
README.rst DM USB: involve the libusb 2018-05-29 10:35:05 +08:00

README.rst

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 \
          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
.. _`Project ACRN documentation`: https://projectacrn.github.io/