Commit Graph

360 Commits

Author SHA1 Message Date
David B. Kinder
ad8a0cf737 doc: doc cleanup for v2.3 release
Remove some stray Clear Linux references, document labels, and update
the known issue filter patterns.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-01 15:37:06 -08:00
Yonghua Huang
eb4f335dab doc: update 'enable_ivshmem'
Add notification (doorbell) usage for ivshmem devices.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-01 09:12:29 -08:00
Tao Yuhong
e8c20e7a63 Doc: pci-vuart-guide
update tutorials/vuart_configuration.rst, add pci-vuart guide

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-30 18:35:19 -08:00
Yang,Yu-chu
73cd9e939c doc: update configuration tool description of vuarts
Acrn introduces pci based vuart. Update the existing vuarts and add the
pci based vuart description

1. rename existing vuarts to legacy_vuart
2. add console and communication vuarts general desciption
  - the console vuart is similar to legacy_vuart0 but only contains subtag "base"
  - the communication vuart is similar to legacy_vuart1 but only contains subtags
    "base", "target_vm_id" and "target_uart_id"

Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-30 18:14:02 -08:00
Geoffroy Van Cutsem
36e42c9fdf doc: correct typo (missing space)
Add missing space in the document describing how to use Ubuntu as a User VM OS.
2020-11-23 17:02:13 -08:00
Yang,Yu-chu
dc86cd8bff doc: update the steps of enable ivshmem
To enable the hv_land ivshmem for post-launched vm, the lanch script
needs to be cofigured accordingly.

Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2020-11-23 00:07:12 -08:00
fuzhongl
bb4fcae1b8 Doc: update document to remove CL Service VM dependency
Some document refer Clear Linux as Service VM; update them
to Ubuntu Service VM.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-11-23 00:02:58 -08:00
David B. Kinder
a2167ae93a doc: add extension to create files and raw links
Links to files in the GitHub repo's master branch should be to the files
within the branch being generated.  For example, in the v2.1
documentation, links should be to the v2.1 branch contents.  (Previously
links were being made to the master branch in all our archived content.)
This creates a problem when we want to remove an obsolete file in the
master branch but can't because older documentaiton incorrectly depends
on it.

This new extension defines a :acrn_file: and :acrn_raw: role that will
create links to the given file within the current commit branch.

This PR also replaces docs with hard-coded links to files in the master
branch with uses of these new roles to create links to files.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-05 09:17:05 -08:00
David B. Kinder
63fd853df3 doc: improve GSG navigation
Feedback suggests we add more top-level navigation to the getting
started guides, so let's include a local TOC as well as using the
"numbered-step" style to top-level steps.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-03 15:14:32 -08:00
fuzhongl
c94d628907 Doc: Update Debian as Service Vm
Update steps from de-privileged boot to direct boot.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-11-03 10:20:03 -08:00
David B. Kinder
62d0088565 doc: doc spelling and grammer fixing
Continuing with additional spelling and grammar fixes missed during
retular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-30 08:32:53 -07:00
David B. Kinder
576a3b5947 doc: spelling and grammar improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-01 18:08:00 -07:00
David B. Kinder
dd0fe54141 doc: Spelling and grammar tweaks
Did a partial run of ACRN documents through Acrolinx to catch additional
spelling and grammar fixes missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-26 08:50:49 -07:00
David B. Kinder
083c1298b6 doc: update IVSHMEM config detail
Slight wording tweak about the IVSHMEM_REGION description

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-22 12:44:35 -07:00
Shixiong Zhang
b964f5c2c4 doc: add IVSHMEM, mmio_resources, pt_intx in configuration tool
Add configration items: IVSHMEM, mmio_resources, pt_intx in
configuration tool documentation

Signed-off-by: Shixiong Zhang <shixiongx.zhang@intel.com>
2020-09-22 11:22:23 -07:00
Yuan Liu
a46aa9db4c doc: Add note about the maximum number of regions for hv-land
The maximum number of ivshmem shared memory regions cannot exceed 8

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-09-18 10:07:32 -07:00
David B. Kinder
8133ffad2e doc: continue CL cleanup
Removed additional references to Clear Linux

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-15 14:45:22 -07:00
David B. Kinder
1509826a29 doc: update pre-launched VMs with offline ACPI
Bring change made to release_2.2 branch back to the main (master)
branch.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-15 09:09:23 -07: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
Shuang Zheng
84c4c43833 acrn-config: fix csme passthrough issue for launch setting
minor_ver should be le 2 when major_ver == 2.

Tracked-On: #5276

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Acked-by: Victor Sun <victor.sun@intel.com>
2020-09-07 16:42:56 +08: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
David B. Kinder
fc1fc0eb8d doc: update inclusive language terms in docs
Replace white/black master/slave terms with alternatives.  We're not
changing "master" when used in the context of GitHub branches.  GitHub
advises they have a plan to help this transition.  In the text body we
rever to the "master" branch as the "main" branch, but leave any urls or
code-block commands still using "master".

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-01 10:47:42 -07:00
Zide Chen
f945fe27ab doc: remove UEFI/de-privilege boot mode from docs
Also clear Linux is no longer supported either as SOS or post-launched VM kernel.

- When it mentions clear Linux, mostly replaced by Ubuntu.
- remove all contents re/lated to "UEFI boot".
- remove the term de-privilege mode, and direct mode as well.

Tracked-On: #5197
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-08-26 16:37:41 -07:00
David B. Kinder
a32074cda1 doc: update docbuild instructions for 2.2 release
Remove mention of Clear Linux

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-25 17:13:43 -07:00
David B. Kinder
e74cf71eb7 doc: spelling and grammar fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-20 08:09:21 -07:00
David B. Kinder
21893b3335 doc: fix mismatched ACRN version
Document was updated to use v2.1 but left a references to v1.6

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 09:07:16 -07:00
David B. Kinder
99c855dd63 doc: use kbd consistently and fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-06 16:40:53 -07:00
Tao Yuhong
92f7a8a6a7 Doc: update user guide for Pre-Launched RT mode
The Release_2.1 use multiboot2, so update the example

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2020-08-06 10:44:05 -07:00
David B. Kinder
76e0461caa doc: fix more references to hypervisor folders
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-05 14:22:01 -07:00
David B. Kinder
97603adb0a doc: fix references to misc/vm_configs folder
As noticed in PR #5134 scenario configurations were moved out of the
hypervisor folder over to the misc folder (within the acrn-hypervisor
repo).  Fix references and make them all consistent (referencing
misc/vm_configs)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-05 13:39:31 -07:00
fuzhongl
2a8a1e4464 Doc: Update Using GRUB to boot ACRN
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-08-05 10:04:48 -07:00
fuzhongl
19f8cc9af3 Doc:Update Logical Partition Getting Started Guide
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-04 09:55:06 -07:00
Victor Sun
c6a28daebc doc: update vm configuration related path
After vm configurations moved to acrn-hypervisor/misc/vm_configs,
some documents need to be updated.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-08-04 09:26:26 -07:00
fuzhongl
aabcf94ebf Doc: Getting Started Guide Update for hybrid mode
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-08-03 18:22:45 -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
Vijay Dhanraj
cd1b133ac5 doc: update documentation for configuring ACRN RDT features
Given the recent changes in the way ACRN configures RDT features,
this patch updates the documentation as well to provide clear
guidelines to the user.

Tracked-On: #5063
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-07-28 13:27:46 -07:00
Henning Schroeder
a524148ca1 Doc: fixing the intel_pstate kernel command line setting
Signed-off-by: Henning Schroeder <henning.schroeder@intel.com>

There seems to be a typo in the documentation.
2020-07-28 13:26:05 -07:00
David B. Kinder
854d8fa46e doc: tweak link in waag tutorial
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-04 14:35:56 -07:00
fangfang.shen
880be9f7ef doc:update WaaG GSG based on Ubuntu.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
2020-07-04 14:05:10 -07:00
David B. Kinder
cfad047bd0 doc: update broken link to AGL download
Tracked-On: #4504

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-19 15:02:03 -07:00
David B. Kinder
d479894ce4 doc: restore lists inside of notes
Lists inside of a note are displayed properly now, thanks to #4966 so
let's put some back in.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 13:54:00 -07:00
David B. Kinder
922129cad4 doc: consistent spelling of passthrough
Attempt to replace all the variations of "pass-thru", "pass thru", "pass
through", and "pass-through" to be "passthrough" (except for doc labels
and in code or API uses)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 12:46:26 -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
Victor Sun
5119fa0673 doc: add using grub tutorial
The GRUB could be used to boot ACRN hypervisor in direct boot mode.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-06-17 21:10:42 -07:00
David B. Kinder
91cbe6c984 doc: fix presentation of kata containers tutorial
Fixed a few layout issues and added link to mailing list

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-16 12:24:47 -07:00
Geoffroy Van Cutsem
398d639fa5 doc: Update Kata Containers tutorial to ACRN v2.0
Update the "Run Kata Containers on a Service VM" tutorial to use ACRN v2.0. It
also uses Ubuntu 20.04 as the baseline instead of Ubuntu 18.04. The Kata
Containers installation method is different as there are no pre-built binaries
for Ubuntu 20.04 yet, so using the 'kata-deploy' approach instead which is more
generic.

Changed link to slideshare.net for the referenced TCM presentation.

Tracked-On: #4944
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-16 12:00:48 -07:00
David B. Kinder
0ad80d1f09 doc: fix misspelling
Fix misspellings in docs missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-12 16:54:32 -07:00
Deb Taylor
b896137afa Doc: Edits to the acrn configuration tool
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-12 15:27:57 -04:00
Wei Liu
19f629a2fa doc: update acrn_configuration_tool tutorial for RDT feature
update acrn_configuration_tool tutorial for RDT and update uos type
for launch configuration tutorial.

Signed-off-by: Wei Liu <weix.w.liu@intel.com>
2020-06-12 13:46:43 -04:00