Project ACRN hypervisor
Go to file
Liu Shuo 5a20b337d0 virtio-heci: Backend service for HECI virtualization
This patch implement HECI virtualization backend service based on virtio
userspace framework. This service introduce a virtio-heci device model
for DM, and can be enabled by DM parameter '-s [BUS NO],virtio-heci'.

The HECI virtualization need both backend service in device-model and
frontend driver in guest to work. Backend service mainly emulates HECI
device's behaviors to satisfy frontend driver. They are based on virtio
userspace framework. Currently, it is using two virtqueues, one is for
TX and another is for RX.

Signed-off-by: Liu Shuo <shuo.a.liu@intel.com>
Reviewed-by: Li Hao <hao.l.li@intel.com>
Reviewed-by: Wang Yu <yu1.wang@intel.com>
Reviewed-by: Zhao, Yakui <yakui.zhao@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-04-11 17:12:13 +08:00
.travis-dockerfiles Add 'findutils' to Fedora-based Docker images 2018-04-10 16:32:40 +08:00
core dm: sync common header file to DM 2018-04-10 14:39:19 +08:00
hw virtio-heci: Backend service for HECI virtualization 2018-04-11 17:12:13 +08:00
include Fix compilation on Ubuntu 14.04 2018-04-10 16:30:50 +08:00
samples Remove 'noxsave' bootarg in dm sample script 2018-04-04 10:48:26 +08:00
tools replace malloc with calloc 2018-04-10 14:28:21 +08:00
.gitignore add .gitignore 2018-03-16 21:45:43 +08:00
.travis.yml Enable Travis CI testing 2018-04-06 22:30:57 +08:00
license_header initial import 2018-03-07 21:07:43 +08:00
MAINTAINERS update home page information 2018-04-02 10:15:51 +08:00
Makefile virtio-heci: Backend service for HECI virtualization 2018-04-11 17:12:13 +08:00
README.rst README.rst: convert to ReST and add details 2018-03-09 16:13:57 +08: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/