Commit Graph

56 Commits

Author SHA1 Message Date
David B. Kinder
b82b8073a9 doc: remove PTM tutorial for now
PTM feature postponed to v2.6 so remove documentation about enabling
this feature.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 18:53:22 -07:00
Nishioka, Toshiki
5fffcdcbd9 doc: add acrn efi-stub user guide
Add user guide for ACRN EFI application for Secure Boot.

Tracked-On: #6078
Signed-off-by: Toshiki Nishioka <toshiki.nishioka@intel.com>
2021-06-23 09:00:32 -07:00
Zide Chen
f41cc4ae35 doc: add nested virtualization user guide
Tracked-On: #5923
Signed-off-by: Zide Chen <zide.chen@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-16 09:50:12 -07:00
David B. Kinder
42dc49902b doc: add enabling PTM tutorial and PTM hld discussion
Tracked-On: #5915

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-09 17:10:34 -04:00
David B. Kinder
c741468b9c doc: remove Kconfig reference documentation
With the new ACRN configuration architecture, we no longer use Kconfig
files.  Remove the Kconfig option documentation scripting (genrest.py)
Python dependencies, and Makefile commands, and change references in the
documentation from the Kconfig option (such as
:option:`CONFIG_MEM_LOGLEVEL`) to the new schema definition-based option
documentation (:option:`hv.DEBUG_OPTION.MEM_LOGLEVEL`).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-03 09:01:40 -08:00
Yang, Yu-chu
f1c339df2a doc: integrate config xsl transform into doc build
Documentation for the scenario XML configuration options is pulled from the
schema definition files (xsd) maintained in the misc/config_tools/schema
folder.  Update the doc build process to generate and incorporate the
option documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-01 09:27:02 +08:00
Xie, nanlin
97c9b24030 acrn-config: Reorg config tool folder
Remove vm_configs folder and move all the XML files and generic code example into config_tools/data

Tracked-On: #5644
Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2021-01-27 11:08:28 +08:00
Yonghua Huang
4759735c99 doc: Setup secureboot with GRUB
Add guide to enable grub secure boot on ACRN.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 08:59:52 -08:00
Yuan Liu
12557d2e2b doc: add ivhshmem hv-land introduction
Ivshmem hv-land solution emulates the ivshmem device in hypervisor
and the shared memory is reserved in the hypervisor's memory space.
And it can provide inter-vm communication for both pre-launched and
post-launched VMs.

This patch introduces the ivshmem hv-land solution including what
ivshmem hv-land is and how to use it.

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-09-14 10:20:39 -07:00
David B. Kinder
d7e34acfe1 doc: add pointers to meta-acrn layer repo docs
meta-acrn is a Yocto Project layer repo with recipes for building a
Service and User VM OS using Yocto Project.  While the information there
is sparse, for the experienced YP developer is might be enough.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-09 08:19:31 -07:00
David B. Kinder
54975e4629 doc: remove docs referencing Clear Linux
ACRN 2.1 supports two virtual boot modes, deprivilege boot mode and
direct boot mode. The deprivilege boot mode’s main purpose is to support
booting Clear Linux Service VM with UEFI service support, but this
brings scalability problems when porting ACRN to new Intel platforms.
For the 2.2 release, deprivilege mode is removed, and only direct boot
is supported, and with this we've removed support for Clear Linux as the
service VM, which impacts over 50 ACRN documents.  This PR removes
documents we don't intend to update, and fixes broken links that would
occur from references to these deleted docs.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-01 11:46:41 -07:00
Tao Yuhong
b1ca987650 Doc: The user guide for Pre-Launched RT mode
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-29 10:14:46 -07:00
zhanqi
288efd31b4 create acrn hypervisor/kernel deb packaging
Tracked-On: #5022

Signed-off-by: zhanqi <sherry.qi.zhang@intel.com>
2020-07-20 11:44:07 +08:00
David B. Kinder
b82e6146c4 doc: more release notes 2.0 edits
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-22 10:14:09 -07:00
Victor Sun
780c87d9da doc: add hv parameter usage
The hv parameter could be configured in GRUB menu, currently we support
"uart=" parameter to override uart settings.

The patch also has modifications on tutorial of using_grub.

Signed-off-by: Victor Sun <victor.sun@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-17 21:10:42 -07:00
David B. Kinder
764d7c1332 doc: rename rt_industry GSG
Move the rt_industry GST into a tutorial for using Clear Linux as the
Service VM.  Also drop a redirect to avoid 404 errors reference the
moved doc (redirect list maintained in conf.py)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-04 08:10:02 -07:00
Vijay Dhanraj
a81f6e2c62 doc: Enabling ACRN on top of QEMU/KVM
Tracked-On: #3198
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-05-29 09:10:42 -07:00
David B. Kinder
4db42c1c7f doc: fix rst-columns display
Using ``.. rst-class:: rst-columns`` wasn't processed correctly because
of an error in the acrn-custom.css file.  Fix that, update the
documentation guidelines, and make use of the multi-column display in
documents where the toctree created a long list.  Now it will
appear in columns.

Also tweaked the toctree listing to use bold for the first-level items
(making a multi-column display look better, particularly when it has
subsections).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-21 15:08:15 -07:00
Junming Liu
3ccbb20087 doc:add tutorial about enabling GVT-d
Previous tutorial "Enable GPU Passthrough on the Skylake NUC"
is out of date, so delete it here.

v2 -> v1:
add attached file

Signed-off-by: Junming Liu <junming.liu@intel.com>
2020-05-20 11:58:19 -04:00
David B. Kinder
5850f00880 doc: update libvirt guide
Clean up command-line formatting, reduce line length, prepare for
further technical review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-08 08:32:41 -07:00
Deb Taylor
bfe2a1c525 Doc: Initial file: Config ACRN using OpenStack & libvert
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-07 16:12:10 -04:00
Deb Taylor
1df539b76c Doc: Updated "Advanced Guides" titles for naming consistency
Updated WaaG file

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-05-04 13:17:02 -04:00
Deb Taylor
b514eba9d6 Doc: Modify Getting Started and Advanced Guides sections (navigation)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-24 13:03:54 -04:00
Deb Taylor
decd89e48d Doc: Initial version of ARCN RTVM Perf Tips
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-16 20:44:09 -04:00
David B. Kinder
1e8269b5f7 doc: fix misspellings
Fix misspellings missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-10 08:58:54 -07:00
Vijay Dhanraj
a2763ab7f0 doc: Add MBA documentation and update doc for CAT
This patch updates CAT documentation as well as adds
documentation support for newly added MBA feature.

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-03-27 16:58:20 -04:00
Tw
0f9e9ee0c4 Doc: add instructions for using Xenomai as UOS
Signed-off-by: Tw <wei.tan@intel.com>
2020-03-27 16:39:39 -04:00
Yuan Liu
7b3c3c6bcf doc: introduce SR-IOV virtualization
The SR-IOV virtualization document

Tracked-On: #4433
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-03-18 12:15:49 -04:00
Deb Taylor
b09f07e200 doc: More re-org updates
Add ACRN Open Source Roadmap 2020 link to Intro/What is ACRN page
Add ACRN blog link to ACRN Intro page (under Roadmap)
Move ACRN Shell Commands to 'Tools' under Advanced Guides page

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-17 11:28:26 -04:00
Deb Taylor
1f50b07405 Doc: Update re-org'd ACRN index page and What is ACRN.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-16 17:16:00 -04:00
Deb Taylor
a5f9ef402e Doc: Fix tool ref tag on develop.rst page
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 22:26:14 -04:00
Deb Taylor
9a85e27430 Doc: Re-org documentation to improve user experience; see Nav Bar
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 21:54:36 -04:00
lirui34
17f6344ce2 doc: Add tutorial about how to launch kata vm.
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-12-20 07:13:48 -05:00
Conghui Chen
7edf8ed798 doc: add document for cpu sharing
Add document and usage for cpu sharing.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-12-20 07:11:40 -05:00
lirui34
cb207b4383 doc: enable s5 guide
Add instruction of enabling s5.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-11 08:11:52 -05:00
lirui34
705ba86da2 doc: clean up the docs in try using acrn table.
Move acrn_ootb / building_acrn_in_docker / up2 gsg to the
develop using acrn guide;

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 08:44:22 -08:00
lirui34
ad9b96579f doc: instruction of enabling the laag secure boot
Add tutorial about how to enable the laag secure boot.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-07 14:10:51 -05:00
Deb Taylor
f59932e3db Added entry for waag-secure-boot tutorial (added in #3883)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-07 13:26:27 -05:00
lirui34
f835fdef05 doc: Remove apl gsg and merge contents into rt gsg
Change APL getting started guide to KBL getting started guide;
Merge some of the contents into preempt-rt getting started guide;
Move the modified kbl getting started guide to the behind of the configuration tutorials;
Fix issues for acrn_quick_setup.sh script.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-05 15:09:49 -05:00
David B. Kinder
c1cc3040a4 doc: fix remaining masked doc build errors
This should get us back to a clean doc build now...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-10-29 17:26:21 -07:00
Deb Taylor
339e959962 Doc: remove tutorials/rt_linux.rst file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-25 21:34:26 -04:00
Geoffroy Van Cutsem
6f7ba36ea0 doc: move the "Building ACRN in Docker" user guide
Move the "Building ACRN in Docker" guide to the "Try using ACRN" section to be
more prominently visible. Reference it from the main "Build ACRN from Source"
user guide.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-14 17:33:20 -04:00
lirui34
617a77d8fb doc: Add document of RT performance tuning.
Add document of RT performance tuning.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 09:57:07 -04:00
Deb Taylor
960c508bab Doc: Initial vuart configuration doc and images--4979
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 07:10:51 -04:00
Deb Taylor
9e759bcfa0 Initial virtio i2c doc and images.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-23 11:13:30 -04:00
Deb Taylor
32a75af1ea New tutorials for running deb or ubunt as user vms
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-17 14:56:18 -04:00
Deb Taylor
6045a5e54c Intitial doc for Running Debian as a Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 22:07:09 -04:00
Lei, Lu
2628868ae0 doc: add build acrn in docker tutorial
Add a tutorial about how to build acrn in docker.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-12 10:36:39 -04:00
David B. Kinder
5083aba379 doc: review edits for config tool doc
Update material from PR #3559 with review and clarity edits.
Added review comments.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-10 18:21:20 -07:00
lirui34
edbec46dcd doc: Add ACRN configuration tool tutorial
An offline configure tool is designed to configure the BOARD and VM configurations.
Here is the tutorial to tell people how to use it.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-09 11:03:04 -07:00