acrn-hypervisor/devicemodel
Yu Wang 8c06b69622 dm: Reorganize ACRN DM directory.
The current dm, all non-pci and non-acpi related files are put into
hw/platform directory. This is actually disturbed the meaning of
*platform*. The platform devices are mean of board and SoC specific
non-PCI devices, like usb devices, etc.

This patch refines the ACRN dm directory architecture.

For some common device logic files, likes block_if.c/uart_core.c or
usb_core.c. They will move to hw/ directly.

For platform architecture depended files, create arch/ under root dir.
And create sub-dir arch/x86 for x86 architecture, will create more
architectures in future. The pm.c will move to this new dir.

The hw/acpi will be moved to hw/platform/acpi due to acpi also be
considered as part of platform.

Signed-off-by: Yu Wang <yu1.wang@intel.com>
2018-05-15 17:25:58 +08:00
..
.travis-dockerfiles Add 'findutils' to Fedora-based Docker images 2018-05-15 17:25:26 +08:00
arch/x86 dm: Reorganize ACRN DM directory. 2018-05-15 17:25:58 +08:00
core DM: bug fix in handling signal 2018-05-15 17:25:58 +08:00
hw dm: Reorganize ACRN DM directory. 2018-05-15 17:25:58 +08:00
include DM: rename acrn_register to acpi_generic_address 2018-05-15 17:25:58 +08:00
samples Remove 'noxsave' bootarg in dm sample script 2018-05-15 17:25:24 +08:00
tools Bugfix: DM:tools:acrnctl launch script output is binary file 2018-05-15 17:25:56 +08:00
.gitignore add .gitignore 2018-05-15 17:19:36 +08:00
.travis.yml Enable Travis CI testing 2018-05-15 17:25:25 +08:00
MAINTAINERS update home page information 2018-05-15 17:19:39 +08:00
Makefile dm: Reorganize ACRN DM directory. 2018-05-15 17:25:58 +08:00
README.rst README.rst: convert to ReST and add details 2018-05-11 14:44:29 +08:00
license_header initial import 2018-05-11 14:44:28 +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

* 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/