OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/doc/developer-guides/hld/hld-hypervisor.rst

29 lines
692 B
ReStructuredText
Raw Normal View History

doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
.. _hld-hypervisor:
doc: fix all headings to use title case While we hoped to make the headings consistent over time while doing other edits, we should instead just make the squirrels happy and do them all at once or they'll likely never be made consistent. A python script was used to find the headings, and then a call to https://pypi.org/project/titlecase to transform the title. A visual inspection was used to tweak a few unexpected resulting titles. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-13 08:27:24 +08:00
Hypervisor High-Level Design
doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
############################
.. toctree::
:maxdepth: 1
doc: HV startup and CPU virtualization sections transcode, edit, and upload HLD 0.7 sections 3.1 and 3.2 Tracked-on: #1533 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 07:53:43 +08:00
hv-startup
document: update HLD for vm management add VM state transition, and make this chapter into part of hypervisor hld, the user level vm management should be introduced in ACRN tools. Tracked-On: #3882 Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-10-22 23:58:31 +08:00
hv-vm-management
doc: HV startup and CPU virtualization sections transcode, edit, and upload HLD 0.7 sections 3.1 and 3.2 Tracked-on: #1533 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 07:53:43 +08:00
hv-cpu-virt
doc: update HLD Timer section transcode, edit, and upload HLD 0.7 section 3.6 (Timer) Also, fix the hv sections file names to be consistent. Tracked-on: #1623 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-27 06:00:16 +08:00
Memory management <hv-memmgt>
I/O Emulation <hv-io-emulation>
doc: add IOC virtualization HLD Convert and edit IOC virtualization doc to add to ACRN documentation. Add a note that IOC virtualization is not supported on the NUC or UP2 platforms. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-27 05:50:01 +08:00
IOC Virtualization <hv-ioc-virt>
doc: update HLD Timer section transcode, edit, and upload HLD 0.7 section 3.6 (Timer) Also, fix the hv sections file names to be consistent. Tracked-on: #1623 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-27 06:00:16 +08:00
Physical Interrupt <hv-interrupt>
Timer <hv-timer>
doc: update HLD VT-d transcode, edit, and upload HLD 0.7 section 3.8 (VT-d) Tracked-on: #1643 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 03:31:41 +08:00
Virtual Interrupt <hv-virt-interrupt>
VT-d <hv-vt-d>
doc: update HLD Device passthrough transcode, edit, and upload HLD 0.7 section 3.9 (Device passthrough) Tracked-on: #1645 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 07:27:31 +08:00
Device Passthrough <hv-dev-passthrough>
doc: add mmio-dev-passthrough to TOC Doc was merged but not included in the TOC (CI indicated a pass on that PR even though doc build failed). This fixes that undetected error. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-29 05:16:07 +08:00
mmio-dev-passthrough
doc: add partition mode hld Partition mode HLD content added to hypervisor hld. Add target links in referenced docs. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-14 07:19:14 +08:00
hv-partitionmode
doc: update rest of hypervisor HLD sections Transcode, edit, and upload HLD 0.7 section 3.10 (PM in hypervisor), 3.11 (Console, shell, vUART), 3.12 (Hypercall/VHM upcall), and 3.13 (Compile-time config) Also scan/replace UTF-8 punctuation missed in previous PRs. Add anchor targets in referenced docs. Tracked-on: #1648 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-31 02:02:29 +08:00
Power Management <hv-pm>
Console, Shell, and vUART <hv-console>
Hypercall / VHM upcall <hv-hypercall>
Compile-time configuration <hv-config>
doc: fix misspellings Fix misspellings missed during regular reviews Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-10 05:50:30 +08:00
RDT support <hv-rdt>
Doc: HLD for Split-locked Access Handling Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2020-04-22 23:05:32 +08:00
Split-locked Access handling <hld-splitlock>