Commit Graph

1034 Commits

Author SHA1 Message Date
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 cd18a22faf doc: update virtio-i2c inclusive language
A previous update changed "slave" to "secondary", but the code comments
were changed to use "client", so update the documentation to match.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-02 14:35:14 -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
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 066744ce5d doc: update FAQ
Remove obsolete information and Clear Linux/UEFI references.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-25 17:50:37 -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
Geoffroy Van Cutsem 32fc0dc2a7 doc: add hybrid_rt to "What is ACRN"
Add description of the new Hybrid RT (hybrid_rt) scenario to the "What is ACRN"
documentation.

Tracked-On: #5203
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-08-25 17:08:31 -07:00
Zide Chen 456dd43187 doc: remove the vboot module design example from sw_design_guidelines.rst
Since de-privilege boot mode is removed and vboot module is completely
rewritten.

Tracked-On: #5197
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-08-25 14:42:26 -07:00
Geoffroy Van Cutsem 49711b48e3 doc: add explanation about ACRN modes and scenarios
Add more explanations about the various ACRN modes of operation and how they are
used to construct more complex scenarios.

Tracked-On: #5196
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-08-21 13:25:11 -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
Li Fei1 7b38829576 doc: update document for "--acpidev_pt" and "--mmiodev_pt" features
Add guild how to add ACPI device and MMIO device passthrough support through
the cmdline.

Signed-off-by: Li Fei1 <fei1.li@intel.com>
2020-08-19 15:52:02 -07:00
Shiqing Gao 24b89eb8c4 doc: update coding guidelines
- add a rule for pointer arithmetic operation
 - add a rule about ABI conformance
 - update GCC reference

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2020-08-19 15:49:35 -07:00
David B. Kinder 84601935a1 doc: use consistent month names in release notes
Some months were spelled out, others were abbreviated, making the list
of all release notes look a bit off.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-10 16:15:46 -07:00
David B. Kinder ba3b8e58a1 doc: add v2.1 to doc version menu
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 17:50:36 -07:00
David B. Kinder 7404fb08ff doc: update release notes about LAPIC timer in OVMF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 14:43:36 -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
Yonghua Huang c56fb35515 doc: update security advisory for v2.1 release
Add fixed security vulnerabilities for v2.1 release.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 08:35:44 -07:00
guoqingxz 98aaf23f5c doc: add known issue:5157 for building-from-source.rst
build with XML file, "TARGET_DIR=xxx" does not work

Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 08:23:25 -07:00
fuzhongl 3f7b6853ff Doc:release_notes_2.1 update
Add fixed issues and known issues.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 08:11:09 -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
Xiaoguang Wu 116c7f7823 doc: remove invalid kernel parameters for gvt-g
After change to IDV display solution for gvt-g, the kernel parameters:
i915.domain_plane_owners, i915.domain_plane_owners and i915.enable_pvmmio
related instruction is invalid and should be removed.

Signed-off-by: Xiaoguang Wu <xiaoguang.wu@intel.com>
2020-08-06 08:59:38 -07:00
David B. Kinder f788d2746f doc: draft v2.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-06 08:56:26 -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
David B. Kinder f6e978c795 doc: add copyright/license header to doc scripts
Tracked-On: #5113

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-29 19:08:02 -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 deec563361 doc: update virtio-net documentation with macvtap support.
Tracked-On: #4945
Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-28 15:00:18 -07:00
David B. Kinder a26a663041 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-28 14:38:04 -07:00
Li Fei1 e967fb327f doc: add mmio device passthrough introduction
Besides PCI passthru, ACRN can support passthru of a set of page-aligned
MMIO resources. One example is to passthru a TPM device which includes
a set of page aligned MMIO resources.

Signed-off-by: Li Fei1 <fei1.li@intel.com>
2020-07-28 13:29:11 -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
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 c455085f6d doc: update intro link to project roadmap
Instead of linking to a specific doc on projectacrn.org, update to just
link to the area on projectacrn.org/#resources where the roadmap doc can
be found.  Also remove mention of 2020 to keep it generic so it won't
need updating in 2021.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-13 15:40:34 -07:00
David B. Kinder 2fd1a79ef0 doc: keep doxygen group descriptions in doc output
Propagated fix from other doxygen/breathe project to keep the
description found in the doxygen comments for the group being displayed
(in case there actually is a nice description given).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-10 13:50:58 -07:00
Mostafa Naeem e43b6c7854 doc: Update Inter-VM Communication with Security Hardening Guidelines
ACRN 2.0 introduced Inter-VM communication feature by enabling the ivshmem v1.0 protocol/channel to communication
between VMs. To support the community's application Security Development Lifecycle (SDL), we provide a security hardening
guideline with some pointers to consider when using this channel by userspace application in case of additional security
requirments for Confidentiality, Integrity, or Authenticity.

Signed-off-by: Mostafa Naeem <mostafa.elsaid@intel.com>
2020-07-10 13:50:24 -07:00
David B. Kinder aa45937860 doc: Update contribution guide instructions
While changes to documentation can be submitted directly as PRs, changes
to code must be first submitted for approval to the developer mailing
list.  Update the contribution guidelines to talk about this.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-08 10:52:57 -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 055fe2c615 doc: update Ubuntu GSG with 2.0 fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 09:50:57 -07:00
David B. Kinder 7dd4061bcc doc: add 2.0 to doc version selector
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 09:32:28 -07:00
fuzhongl eabb512ded DOC: v2.0 release notes
Add fixed issues and known issues in release note.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 08:43:21 -07:00
fangfang.shen c2187f20c2 doc: update Ubuntu GSG for ACRN V2.0.
Signed-off-by: fangfang.shen <fangfang.shen@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 08:30:35 -07:00
Yuan Liu 215829fd7e doc: refine ivshmem architecture diagram
refine the dm-land and hypervisor-land flows

Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-06-22 11:30:21 -07:00