601 lines
38 KiB
HTML
601 lines
38 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Project ACRN documentation — Project ACRN™ v 0.1 documentation</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="_static/ACRN-favicon-32x32.png"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/acrn-custom.css" type="text/css" />
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="Introduction to Project ACRN" href="introduction/index.html" />
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="#" class="icon icon-home"> Project ACRN™
|
|
|
|
|
|
|
|
|
|
<img src="_static/ACRN_Logo_200w.png" class="logo" alt="Logo"/>
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
v 0.1
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction to Project ACRN</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#automotive-use-case-example">Automotive Use Case Example</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#licensing">Licensing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#acrn-device-model-service-os-and-user-os">ACRN Device Model, Service OS, and User OS</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#boot-sequence">Boot Sequence</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#acrn-hypervisor-architecture">ACRN Hypervisor Architecture</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#acrn-device-model-architecture">ACRN Device Model Architecture</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#device-pass-through">Device pass through</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="introduction/index.html#hardware-support-for-device-passthrough">Hardware support for device passthrough</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="introduction/index.html#hypervisor-support-for-device-passthrough">Hypervisor support for device passthrough</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#acrn-i-o-mediator">ACRN I/O mediator</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#virtio-framework-architecture">Virtio framework architecture</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-started/index.html">Getting Started Guides</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started/hardware.html">Supported Hardware</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/hardware.html#intel-apollo-lake-nuc">Intel Apollo Lake NUC</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/hardware.html#up-squared-board">UP Squared board</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started/apl-nuc.html">Getting started guide for Intel NUC</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/apl-nuc.html#hardware-setup">Hardware setup</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#firmware-update-on-the-nuc">Firmware update on the NUC</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/apl-nuc.html#software-setup">Software setup</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#set-up-a-clear-linux-operating-system">Set up a Clear Linux Operating System</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#add-the-acrn-hypervisor-to-the-efi-partition">Add the ACRN hypervisor to the EFI Partition</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#acrn-network-bridge">ACRN Network Bridge</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#set-up-reference-uos">Set up Reference UOS</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#device-manager-memory-allocation-mechanism">Device Manager memory allocation mechanism</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/apl-nuc.html#build-acrn-from-source">Build ACRN from Source</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#install-build-tools-and-dependencies">Install build tools and dependencies</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#build-the-hypervisor-device-model-and-tools">Build the hypervisor, device model and tools</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#generate-the-hypervisor-configurations">Generate the hypervisor configurations</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#modify-the-hypervisor-configurations">Modify the hypervisor configurations</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/apl-nuc.html#create-a-new-default-configuration">Create a new default configuration</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started/up2.html">Getting started guide for UP2 board</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/up2.html#hardware-setup">Hardware setup</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/up2.html#connecting-to-the-serial-port">Connecting to the serial port</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/up2.html#software-setup">Software setup</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/up2.html#up2-serial-port-setting">UP2 serial port setting</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="getting-started/up2.html#up2-block-device">UP2 block device</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="getting-started/up2.html#running-the-hypervisor">Running the hypervisor</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="user-guides/index.html">User Guides</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="user-guides/acrn-shell.html">ACRN Shell Commands</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="user-guides/tools.html">Tools</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrn-crashlog/README.html">ACRN-Crashlog</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/README.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/README.html#building">Building</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/README.html#installing">Installing</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/README.html#source-code">Source Code</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html">Acrnprobe</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html#description">Description</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html#architecture">Architecture</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html#source-files">Source files</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/acrnprobe/README.html#configuration-files">Configuration files</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrn-crashlog/usercrash/README.html">Usercrash</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/usercrash/README.html#description">Description</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/usercrash/README.html#design">Design</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/usercrash/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-crashlog/usercrash/README.html#souce-code">Souce Code</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrn-manager/README.html">acrnctl</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-manager/README.html#description">Description</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-manager/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrn-manager/README.html#build-and-install">Build and Install</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrnlog/README.html">acrnlog</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrnlog/README.html#description">Description</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrnlog/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrnlog/README.html#build-and-install">Build and Install</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tools/acrntrace/README.html">acrntrace</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrntrace/README.html#description">Description</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrntrace/README.html#usage">Usage</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="tools/acrntrace/README.html#build-and-install">Build and Install</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="developer-guides/index.html">Developer Guides</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/primer.html">Developer Primer</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#source-tree-structure">Source Tree Structure</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#acrn-hypervisor-source-tree">ACRN hypervisor source tree</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#acrn-device-model-source-tree">ACRN Device Model source tree</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#acrn-tools-source-tree">ACRN Tools source tree</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#acrn-documentation-source-tree">ACRN documentation source tree</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#cpu-virtualization">CPU virtualization</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#host-gdt">Host GDT</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#host-idt">Host IDT</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#guest-smp-booting">Guest SMP Booting</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#vmx-configuration">VMX configuration</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#cpuid-and-guest-tsc-calibration">CPUID and Guest TSC calibration</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#rdtsc-rdtscp">RDTSC/RDTSCP</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#cr-register-virtualization">CR Register virtualization</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#msr-bitmap">MSR BITMAP</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#i-o-bitmap">I/O BITMAP</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#exceptions">Exceptions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#memory-virtualization">Memory virtualization</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#physical-memory-layout">Physical Memory Layout</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#pv-mmu-memory-mapping-in-the-hypervisor">PV (MMU) Memory Mapping in the Hypervisor</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#pv-mmu-memory-mapping-in-vms">PV (MMU) Memory Mapping in VMs</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#host-guest-ept-memory-mapping">Host-Guest (EPT) Memory Mapping</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#graphic-mediation">Graphic mediation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#i-o-emulation">I/O emulation</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#device-assignment-management">Device Assignment Management</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#pio-mmio-trap-flow">PIO/MMIO trap Flow</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#virtual-interrupt">Virtual interrupt</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtual-lapic">Virtual LAPIC</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtual-ioapic">Virtual IOAPIC</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtual-pic">Virtual PIC</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtual-interrupt-injection">Virtual Interrupt Injection</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#vt-x-and-vt-d">VT-x and VT-d</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#hypercall">Hypercall</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#device-emulation">Device emulation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/primer.html#virtio-devices">Virtio Devices</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtio-rnd">Virtio-rnd</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtio-blk">Virtio-blk</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtio-net">Virtio-net</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/primer.html#virtio-console">Virtio-console</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/memmgt-hld.html">Memory Management High-Level Design</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/memmgt-hld.html#overview">Overview</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/memmgt-hld.html#hypervisor-memory-management">Hypervisor Memory Management</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#physical-memory-layout-e820">Physical Memory Layout - E820</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#physical-to-virtual-mapping">Physical to Virtual Mapping</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/memmgt-hld.html#service-os-memory-management">Service OS Memory Management</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#guest-physical-memory-layout-e820">Guest Physical Memory Layout - E820</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#host-to-guest-mapping">Host to Guest Mapping</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/memmgt-hld.html#user-os-memory-management">User OS Memory Management</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#id1">Guest Physical Memory Layout - E820</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#id2">Host to Guest Mapping</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#trusty">Trusty</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/memmgt-hld.html#memory-interaction">Memory Interaction</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#access-gpa-from-hypervisor">Access GPA from Hypervisor</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/memmgt-hld.html#access-gva-from-hypervisor">Access GVA from Hypervisor</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/virtio-hld.html">Virtio High Level Design</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-device">Virtio Device</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#key-concepts">Key Concepts</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-frameworks">Virtio Frameworks</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-apis">Virtio APIs</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#dm-apis">DM APIs</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#vbs-apis">VBS APIs</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#current-virtio-devices">Current Virtio Devices</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-rnd">Virtio-rnd</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-blk">Virtio-blk</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-net">Virtio-net</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/virtio-hld.html#virtio-console">Virtio-console</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/ACPI-virt-hld.html">ACPI Virtualization High Level Design</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/ACPI-virt-hld.html#acpi-introduction">ACPI introduction</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/ACPI-virt-hld.html#acpi-virtualization">ACPI virtualization</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/ACPI-virt-hld.html#partitioning">Partitioning</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html">Apollo Lake Intel® GVT-G high-level design</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#introduction">Introduction</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#purpose-of-this-document">Purpose of this Document</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#audience">Audience</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#reference-documents">Reference Documents</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#background">Background</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#targeted-usages">Targeted Usages</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#existing-techniques">Existing Techniques</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#mediated-pass-through">Mediated Pass-Through</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#concept">Concept</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#virtualization-policies-for-gpu-resources">Virtualization Policies for GPU Resources</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#high-level-architecture">High Level Architecture</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#key-techniques">Key Techniques</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#vgpu-device-model">vGPU Device Model</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#graphics-memory-virtualization">Graphics Memory Virtualization</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#gpu-page-table-virtualization">GPU Page Table Virtualization</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#prioritized-rendering-and-preemption">Prioritized Rendering and Preemption</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#acrn-gt">ACRN-GT</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#acrn-gt-in-kernel">ACRN-GT in kernel</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/APL_GVT-g-hld.html#acrn-gt-in-dm">ACRN-GT in DM</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="api/index.html">API Documentation</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/hypercall_api.html">Hypercall APIs</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="api/devicemodel_api.html">Device Model APIs</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="reference/kconfig/index.html">Configuration Symbol Reference</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="reference/kconfig/index.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="reference/kconfig/index.html#supported-options">Supported Options</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/trusty.html">Trusty TEE on ACRN</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/trusty.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/trusty.html#trusty-architecture">Trusty Architecture</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/trusty.html#trusty-specific-hypercalls">Trusty specific Hypercalls</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/trusty.html#trusty-boot-flow">Trusty Boot flow</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/trusty.html#ept-hierarchy">EPT Hierarchy</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/trusty.html#design">Design</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/trusty.html#benefit">Benefit</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/trusty.html#api">API</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="developer-guides/index.html#contributing-to-the-project">Contributing to the project</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/contribute_guidelines.html">Contribution Guidelines</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#licensing">Licensing</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#developer-certification-of-origin-dco">Developer Certification of Origin (DCO)</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#prerequisites">Prerequisites</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#repository-layout">Repository layout</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#submitting-issues">Submitting Issues</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#contribution-tools-and-git-setup">Contribution Tools and Git Setup</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#coding-style">Coding Style</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#contribution-workflow">Contribution Workflow</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/contribute_guidelines.html#commit-guidelines">Commit Guidelines</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/doc_guidelines.html">Documentation Guidelines</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#headings">Headings</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#content-highlighting">Content Highlighting</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#lists">Lists</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#multi-column-lists">Multi-column lists</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#file-names-and-commands">File names and Commands</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#internal-cross-reference-linking">Internal Cross-Reference Linking</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#non-ascii-characters">Non-ASCII Characters</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#code-and-command-examples">Code and Command Examples</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#tabs-spaces-and-indenting">Tabs, spaces, and indenting</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/doc_guidelines.html#drawings">Drawings</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="developer-guides/graphviz.html">Drawings using graphviz</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/graphviz.html#simple-directed-graph">Simple directed graph</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/graphviz.html#adding-edge-labels">Adding edge labels</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/graphviz.html#tables">Tables</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="developer-guides/graphviz.html#finite-state-machine">Finite-State Machine</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="tutorials/docbuild.html">ACRN documentation generation</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#documentation-overview">Documentation overview</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#set-up-the-documentation-working-folders">Set up the documentation working folders</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#installing-the-documentation-tools">Installing the documentation tools</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#documentation-presentation-theme">Documentation presentation theme</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#running-the-documentation-processors">Running the documentation processors</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#publishing-content">Publishing content</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/docbuild.html#filtering-expected-warnings">Filtering expected warnings</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="tutorials/static-ip.html">Using a static IP address</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/static-ip.html#acrn-network-setup">ACRN Network Setup</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/static-ip.html#setting-up-the-static-ip-address">Setting up the static IP address</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/static-ip.html#activate-the-new-configuration">Activate the new configuration</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html">Using Ubuntu as the Service OS</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html#install-ubuntu-natively">Install Ubuntu (natively)</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html#install-acrn">Install ACRN</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html#install-the-service-os-kernel">Install the Service OS kernel</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html#prepare-the-user-os-uos">Prepare the User OS (UOS)</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_ubuntu_as_sos.html#start-the-user-os-uos">Start the User OS (UOS)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#version-0-1-release-july-2018">Version 0.1 release (July 2018)</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#version-0-1-new-features">Version 0.1 new features</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#hardware-support">Hardware Support</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#gvt-g-for-acrn">GVT-g for ACRN</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#virtio-standard-is-supported">Virtio standard is supported</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#device-pass-through-support">Device pass-through support</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#hypervisor-configuration">Hypervisor configuration</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="release_notes.html#new-acrn-tools">New ACRN tools</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#known-issues">Known Issues</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#change-log">Change Log</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="#">Project ACRN™</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="#">Docs</a> »</li>
|
|
|
|
<li>Project ACRN documentation</li>
|
|
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
<span class="fa fa-book"> Project ACRN</span>
|
|
version: v 0.1
|
|
<span class="fa fa-caret-down"></span>
|
|
</span>
|
|
<div class="rst-other-versions">
|
|
<dl>
|
|
<dt>Versions</dt>
|
|
|
|
<dd><a href="/latest/">latest</a></dd>
|
|
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="project-acrn-documentation">
|
|
<span id="acrn-home"></span><h1>Project ACRN documentation<a class="headerlink" href="#project-acrn-documentation" title="Permalink to this headline">¶</a></h1>
|
|
<p>Welcome to the Project ACRN (version v 0.1) documentation.</p>
|
|
<p>For information about the changes and additions for releases, please
|
|
consult the published <a class="reference internal" href="release_notes.html#release-notes"><span class="std std-ref">Release Notes</span></a> documentation.</p>
|
|
<p>Source code for Project ACRN is maintained in the
|
|
<a class="reference external" href="https://github.com/projectacrn">Project ACRN GitHub repo</a>, and is provided under the BSD 3-clause
|
|
license.</p>
|
|
<div class="section" id="sections">
|
|
<h2>Sections<a class="headerlink" href="#sections" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction to Project ACRN</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-started/index.html">Getting Started Guides</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="user-guides/index.html">User Guides</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="developer-guides/index.html">Developer Guides</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="indices-and-tables">
|
|
<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="glossary.html#glossary"><span class="std std-ref">Glossary of Terms</span></a></li>
|
|
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2018, Project ACRN.
|
|
Last updated on Jul 12, 2018.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'v 0.1',
|
|
LANGUAGE:'None',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |