Commit Graph

1618 Commits

Author SHA1 Message Date
Reyes, Amy 42be836301 doc: Minor editorial update to GVT-d tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-19 10:21:55 -07:00
zhangrouyu 67a161c13e gtvd
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 10:04:33 -07:00
zhangrouyu 5a1e1fd6b4 supplement to revision
Signed-off-by: zhangrouyu <rouyu.zhang@intel.com>
2022-09-19 09:42:48 -07:00
Reyes, Amy 96baec68c0 doc: Minor GSG edits
- Minor editorial changes
- Improve image quality
- Delete unused image

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-16 15:38:11 -07:00
zhangrouyu 34776484df GSG document revision 2022-09-16 13:28:14 -07:00
Reyes, Amy 98886ae2a0 doc: Update CPU sharing tutorial
- Clarify blocked state

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-16 09:12:41 -07:00
Reyes, Amy d579a0be47 doc: Improve image quality - configurator
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 15:22:33 -07:00
Reyes, Amy 78609b0ba1 doc: Improve image quality - ivshmem
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:47:09 -07:00
Reyes, Amy d7404bb976 doc: Improve image quality
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:34:59 -07:00
Reyes, Amy 2238452c1d doc: Improve image quality
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 11:20:48 -07:00
Reyes, Amy eda363f28a doc: Update CPU sharing tutorial to match v3.1 Configurator
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-15 08:11:40 -07:00
Reyes, Amy 38294e6b81 doc: Minor edit to RDT tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 17:24:11 -07:00
Reyes, Amy 7c7326e166 doc: Update supported HW
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 17:23:54 -07:00
Reyes, Amy 13aa50b508 doc: Remove note about v3.0 Configurator issue
The issue has been fixed in v3.1.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-14 09:47:42 -07:00
Chenli Wei 71ccd8a5e5 doc: update vUART tutorials
The ACRN Configurator release 3.1 following the release 3.0 logic, so
the COM2 still used for S5.

This patch modify the "The release v3.0 ACRN Configurator assigns… …"
to "The release v3.0+ ACRN Configurator assigns… …" and refine a typo
issue.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@intel.com>
2022-09-14 09:47:14 -07:00
hangliu1 e5d45b94c9 [doc]remove some decription about hvlog
to avoid misleading for users, delete the description about
hypervisor relocation disabling, since it is not officially
supported by ACRN configurator now.

Tracked-On: #8133
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-09-13 17:20:22 -07:00
Reyes, Amy 3eea8d6da8 doc: Update references to scenario options doc
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-06 11:13:33 -07:00
David B. Kinder 212574a666 doc: clarify sample app instructions
Clarify commands that needed to be run on the target and not the dev
system

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 15:59:03 -07:00
David B. Kinder 2df52d9078 doc: v3.1 release notes draft update
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 11:57:56 -07:00
David B. Kinder 3b02e2ebe2 doc: add a doc helper script
changed-docs.sh (and the accompanying awk script) shows docs changed
between a previous release branch and the current master branch, in a format that
can be used for the releae notes (a list of :ref: items).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 11:45:35 -07:00
David B. Kinder 2eb6dc4e10 doc: update 3.1 release notes draft
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-30 09:56:40 -07:00
David B. Kinder 42d2ef6d5f doc: update 3.1 release notes draft
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-29 20:30:51 -07:00
David B. Kinder 478a550ba6 doc: tweak CSS to outdent numbered step icons
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-27 17:21:35 -07:00
David B. Kinder d96656e4ad doc: fix typo in GSG
missing a trailing backslash on a command continuation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-26 14:22:37 -07:00
zihengL1 b16fcda6b5 config-tools: modified requirements.txt and update GSG
Modified misc/config_tools/configurator/requirements.txt
and misc/config_tools/requirements.txt. Updated getting-started.rst
and acrn_configurator_tool.rst.

Tracked-On: #7975
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-26 16:56:16 +08:00
David B. Kinder 8ac707d244 doc: draft of 3.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 15:10:21 -07:00
David B. Kinder a1281b9085 doc: update GSG and sample app guide
* Fix missing /build folder in copy command in GSG
* Mention USB stick needs formatting for large files when used for the
  sample app (but we'll put that into GSG too).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 15:01:46 -07:00
David B. Kinder b7e4c4baa7 doc: fix typo in sample app doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-25 07:48:15 -07:00
David B. Kinder a8dd662635 doc: update sample app doc to use sudo
Previously the sample apps needed to be run as root, but with a recent
update they could be run as a normal (acrn) user.  Update the sample app
to use sudo for running these sample app components in case the user
doesn't login as root.  Also, split running the background app and the
foreground app into two commands to eliminate some confusion.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-24 20:46:35 -07:00
David B. Kinder 2addfe9ca1 doc: update GSG to include scp instructions
Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.

Also add a mention of the sample app guide at the end of the GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-24 17:27:00 -07:00
David B. Kinder 5a8339be25 doc: update sample app guide
Address comments from DX reviews, and update the cyclictest histogram
output (improvements from PR #8026)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-22 16:47:13 -07:00
Zhang Wei 31f92eba63 doc: Add a python package in GSG
The Getting Started Guide specifies that we need to install the Python packages lxml, xmlschema, and defusedxml.
However, a make clean involves the execution of the Python script manager.py. This script imports the package requests.py, which might not be installed if the developer follows the Getting Started Guide.

Add requests follow this command in GSG.
sudo pip3 install "elementpath==2.5.0" lxml "xmlschema==1.9.2" defusedxml tqdm requests

[External_System_ID] ACRN-9144
Tracked-On: #8029
Signed-off-by: Zhang Wei <wei6.zhang@intel.com>
2022-08-22 10:03:30 -07:00
David B. Kinder f4ef01dc2c doc: update sample app guide
* Fix preempt-rt patched kernel label on wrong VM
* Fix path copying hmi_vm.img and rt_vm.img (they're not in ~/acrn-work
  directory)
* Rename png images to avoid potential conflicts with other images on the
  system.
* Fix Ubuntu wecome message text after logging into RT_VM

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-19 11:39:54 -07:00
Liu Long b9c4d2622c ACRN: Doc: Modify the SampleApplication document
1. Add the move iasl binary to the /usr/sbin directory.
2. Modify login RT_VM user to root user.

Signed-off-by: Liu Long <long.liu@linux.intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 21:31:51 -07:00
David B. Kinder a7edf92ae4 doc: update sample app user guide
After review with engineering, we added material for showing what a
successful hmi_vm.img build ending looks like (and a hint of what to do
if it looks like the build failed.  Also added using a dhclient commmand
to the instructions in case the HMI_VM didn't get an IP address.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 18:03:40 -07:00
David B. Kinder 7c05b055d7 doc: fix typos in sample app guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 16:45:21 -07:00
David B. Kinder 0b938933db doc: add sample application user guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-18 15:36:29 -07:00
David B. Kinder c88076d9ef doc: revert to not using requirements.txt in the GSG
GSG was recently updated to use a requirements.txt for python
dependencies, but that file doesn't exist in the repo at the v3.0 tag
the instructions say to use.  Revert to not use a requirements.txt until
we get this figured out.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-17 16:58:00 -07:00
David B. Kinder f2dacfa30c doc: update rdt doc with real-time vCPU option clarification
Improve explanation of the Real-time vCPU option checkbox.

[External_System_ID] ACRN-9307

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-16 14:28:06 -07:00
zihengL1 b026238a69 config-tools: modified requirements.txt and update GSG
Modified requirements.txt in misc/config_tools/configurator
directory and add GSG requirements.txt inmisc/config_tools
directory.
Relevant python package installing steps in GSG.

Tracked-On: #7975
Reviewed-by: Junjie Mao junjie.mao@intel.com
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-16 17:20:23 +08:00
David B. Kinder a9bf1afc08 doc: fix order of steps in GSG setup
Edits preparing for using a requirements.txt introduced an error in the
step order (using a directory before it was created).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-15 20:25:40 -07:00
David B. Kinder 0d36e754e9 doc: add libelf-dev dependency to GSG
The new acrn-kernel for v3.1 expects gelf.h that's installed with the libelf-dev
package that's not listed as a dependency in the GSG.  Without this
package, building acrn-kernel fails.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-13 11:28:40 -07:00
David B. Kinder 5bc94cf08a doc: clarify and improve GSG
Update Getting Started Guide to clarify and improve descriptions of
steps, including adding example commands instead of just describing
them, adding more information about system requirements, making certain
steps explicit, squash the long list of packages to install into fewer
lines, and more.

Move cloning ACRN hypervisor and kernel earlier in the instructions
(anticipating use of a requirements.txt coming from the repo).

[External_System_ID] ACRN-9285

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-11 17:11:52 -07:00
Minggui Cao 0c47f4d04d doc: update hypervisor shell usage
ACRN hypervisor shell has been improved to be bash-like shell, so update
its usage

Tracked-On: #7931
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-10 13:51:12 -07:00
David B. Kinder 364295e0d8 doc: update GSG version for xmlschema
While we're waiting for a more complete list of specific package version
requirements, let's fix the xmlschema and elementpath version mismatch
now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-10 13:39:34 -07:00
David B. Kinder b8c85135d9 doc: update Security VM Features config option
Updated the description of Security VM Features per review comments, and
made the option visible (again) in the configurator as an advanced
hypervisor option.

Created a new glossary entry for "Security VM", referenced by this new
description and tooltip.

Tweak wording of virtio console and input device descriptions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Tracked-On: #7968
2022-08-10 10:09:58 +08:00
David B. Kinder cb91722dd5 doc: update rdt config tutorial
Add some clarification and updates for 3.1

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-09 14:26:25 -07:00
David B. Kinder 785ce3346c doc: add proxy note to GSG
Remind readers that internet access from a corporate network typically
requires configuring proxy information.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-09 09:22:29 -07:00
zihengL1 82d4f633ed doc: fix Build EFI-Stub fail problem
In the "Enable ACRN Secure Boot With EFI-Stub" guide, to build EFI-Stub
smoothly, the installation of "gnu-efi" package is added to GSG.

Tracked-On: #7935
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-09 09:20:16 -07:00
David B. Kinder c1a4b77a93 doc: update 3.0.1 release notes
Clarify description of CVE fix (only impacts ACRN implementation on
Alder Lake platforms), and improve description of the ACRN shell's new
vmexit command.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-04 22:00:05 -07:00