acrn-hypervisor/hypervisor
Binbin Wu 973c616ab3 doc: passthru: add structure and API docs
This patch adds more comments to describe the structures and functions of vtd
that are public to the other components in the hypervisor. The comments are in
doxygen-style for document generation.

Tracked-On: #1595
Signed-off-by: Binbin Wu <binbin.wu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-11-21 09:27:51 +08:00
..
arch/x86 doc: passthru: add structure and API docs 2018-11-21 09:27:51 +08:00
boot hv: fix integer violations 2018-11-14 12:46:34 +08:00
bsp HV: For NUC, use 0x3F8/IRQ4 as the vuart port base address/IRQ and use ttyS0 accordingly 2018-11-16 10:24:48 +08:00
common hv: hypercall: clean up HV_DEBUG usage 2018-11-20 10:01:50 +08:00
debug hv: hypercall: clean up HV_DEBUG usage 2018-11-20 10:01:50 +08:00
dm hv: msix: corrently determine when the guest is changing Message Data/Addr 2018-11-20 12:59:09 +08:00
include doc: passthru: add structure and API docs 2018-11-21 09:27:51 +08:00
lib hv: Derive decryption key from Seed for Trusty to decrypt attestation keybox 2018-11-20 09:22:37 +08:00
partition hv: fix partition mode no console issue. 2018-11-08 14:41:31 +08:00
release hv: hypercall: clean up HV_DEBUG usage 2018-11-20 10:01:50 +08:00
scripts kconfig: use defconfig instead of default values in silentoldconfig 2018-10-30 10:49:12 +08:00
Kconfig
MAINTAINERS
Makefile hv: hypercall: clean up HV_DEBUG usage 2018-11-20 10:01:50 +08:00
README.rst Documentation: clean-up of isolated README.rst files 2018-11-20 11:09:53 -08:00

README.rst

ACRN Hypervisor
###############

The open source `Project ACRN`_ defines a device hypervisor reference stack and
an architecture for running multiple software subsystems, managed securely, on
a consolidated system by means of a virtual machine manager. It also defines a
reference framework implementation for virtual device emulation, called the
“ACRN Device Model”.

The ACRN Hypervisor is a Type 1 reference hypervisor stack, running directly on
the bare-metal hardware, and is suitable for a variety of IoT and embedded
device solutions. The ACRN hypervisor addresses the gap that currently exists
between datacenter hypervisors, and hard partitioning hypervisors. The ACRN
hypervisor architecture partitions the system into different functional
domains, with carefully selected guest OS sharing optimizations for IoT and
embedded devices.

You can find out more about Project ACRN on the `Project ACRN documentation`_
website.

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