acrn-hypervisor/hypervisor
Haiwei Li fa2b8fcfbe doc: add module design for some defines in hwmgmt_page
GAI Tooling Notice: These contents may have been developed with support from one
or more generative artificial intelligence solutions.

ACRN hypervisor is decomposed into a series of components and modules. The
module design in hypervisor is to add inline doxygen style comments above
functions, macros, structures, etc.

This patch is to add comments for some elements in hwmgmt_page module.

Tracked-On: #8665

Signed-off-by: Haiwei Li <haiwei.li@intel.com>
2024-08-01 14:50:27 +08:00
..
acpi_parser Update copyright year range in code headers 2022-07-15 11:48:35 +08:00
arch/x86 doc: add module design for some defines in hwmgmt_page 2024-08-01 14:50:27 +08:00
boot HV: boot/elf: Fix the wrong comments in elf.h 2024-07-10 15:26:02 +08:00
bsp/ld HV: fix MISRA violation of _ld_ram_xxx 2021-11-26 16:45:17 +08:00
common Change Service VM to supervisor role 2024-06-28 13:35:07 +08:00
debug config_tools: support vUART Timer pCPU configuration 2024-07-10 10:26:21 +08:00
dm hv: vrtc: remove the unused function `rtc_halted()` 2024-07-03 14:55:43 +08:00
hw hv: pci: use mmio_read/write directly 2022-10-26 01:02:20 +08:00
include doc: add module design for some defines in hwmgmt_page 2024-08-01 14:50:27 +08:00
lib Update copyright year range in code headers 2022-07-15 11:48:35 +08:00
quirks Update copyright year range in code headers 2022-07-15 11:48:35 +08:00
release release: fix the compilation error in release mode 2024-07-03 11:26:01 +08:00
scripts Makefile: do not try to figure out BOARD and SCENARIO for cleanup 2022-10-26 14:09:44 +08:00
Makefile hv: enable thermal lvt interrupt 2024-05-16 09:40:32 +08:00
README.rst doc: fix utf-8 punctuation, branding, spelling 2019-03-14 09:13:58 -07: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/