Commit Graph

505 Commits

Author SHA1 Message Date
Reyes, Amy
a62e468aab doc: Update images
- Update images to align better with ACRN branding

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-21 16:04:45 -08:00
Reyes, Amy
19831b0a9b doc: Update debug tools path
- Update file path to acrn_trace files

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-20 14:00:35 -08:00
Chenli Wei
fa8837b5ff doc: remove some dynamic parameters from acrn-dm usage
The following parameters have not used by new design:

1.  --vsbl <vsbl_file_path>
2.  --part_info <part_info_name>
3.  -G, --gvtargs <GVT_args>
4.  -s <slot>,pci-gvt
5.  -Y, --mptgen
6.  -s <slot>,virtio-hdcp
7.  -s <slot>,npk
8.  -s <slot>,virtio-coreu
9.  -i, --ioc_node <ioc_mediator_parameters>
10. --pm_by_vuart [pty|tty],<node_path>
11. --pm_notify_channel <channel>

This patch remove these parameters from doc.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-01-14 10:53:26 -08:00
Reyes, Amy
ad7ccc28a9 doc: editorial cleanup in enable s5 guide
- Address grammar and formatting comments from PR #6814
- General grammar cleanup

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-12 17:19:32 -08:00
Geoffroy Van Cutsem
31a5a907ba doc: remove obsolete TARGET_DIR Makefile parameter from tutorial
Remove the TARGET_DIR parameter from the "Enable Inter-VM Communication
Based on Ivshmem" tutorial as this is now an obsolete parameter that
will print out a warning.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-12 10:03:47 -08:00
Hu Fenglin
3545af5f8a doc: ACRN Inter-VM Communication
I. Add three kinds of Inter-VM communication advantage and shortage:
    1. Inter-VM vUART
    2. Inter-VM network communication
    3. Inter-VM shared memory device (ivshmem)
II.Add how to implement an Ivshmem application on ACRN.

Signed-off-by: Hu Fenglin <fenglin.hu@intel.com>
2022-01-12 09:53:15 -08:00
fuzhongl
32e853ccf0 Doc: Launch script update for acrn on qemu
To launch User VM, cpu_affinity parameter is needed for v2.7.

Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
Reviewed-by:   gvancuts <geoffroy.vancutsem@intel.com>
2021-12-15 18:58:04 -08:00
jackwhich
ad5cf0ea3e doc: update GSG and partitioned documentation
1. Update launch script and replace the apt-get command with apt in GSG documentation.
2. Update the tag to v2.7 in partitioned documentation.

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-15 13:37:42 -08:00
Xiangyang Wu
097afee832 doc: add note about SRIOV disable
Currently, Service VM may fail to shut down due to some enabled
VFs. ACRN doesn't disable VFs automatically.

In this patch, add a note for user to disable VFs before Service
VM shuts down.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-12-13 09:38:23 -08:00
Shiqing Gao
90c987b600 doc: simplify the command to build Zephyr for ACRN
Simplify the build command using the west tool.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2021-12-08 18:23:42 -08:00
Xiangyang Wu
0b3fedee86 doc: update s5 document
For WaaG VM, the User VM name is hard coded in the
lifecycle manager, this User VM ("windows") is needed
for guest shutdown.
Note: libvirt will be used to do guest shutdown and
the WaaG VM name will be configurable in furture.

The lifecycle manager starup picture in WaaG VM is out
of data, update it in this patch.

Tracked-on: #6652
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-12-08 16:56:58 -08:00
Amy Reyes
22f4041d48 doc: terminology cleanup in hld/tutorial images
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-06 10:05:07 -08:00
Amy Reyes
28560c1db7 doc: terminology cleanup in RTVM tutorial
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-02 10:37:07 -08:00
Amy Reyes
30875208a6 doc: terminology cleanup in openstack and hld images
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 11:25:11 -08:00
Amy Reyes
8cbadb488f doc: terminology cleanup in secure boot GRUB
- Replace UOS or User OS with User VM
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 10:21:54 -08:00
Amy Reyes
db1a6ee961 doc: terminology cleanup in Hybrid GSG, tutorials
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 10:17:14 -08:00
Amy Reyes
091c355b5d doc: terminology cleanup in ACRN Configurator Tool
- Replace UOS or User OS with User VM
- Replace SOS or Service OS with Service VM
- Capitalize Board Inspector and ACRN Configurator
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-29 16:46:10 -08:00
Amy Reyes
8530a32c4b doc: minor updates to board inspector
- Update success message per PR https://github.com/projectacrn/acrn-hypervisor/pull/6672

- Capitalize Board Inspector

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-29 16:39:06 -08:00
Jie Deng
a085b1eaaf doc: update two scheduling algorithm
Add description for the IORR (IO sensitive Round Robin) scheduler
and the priority based scheduler.

Signed-off-by: Jie Deng <jie.deng@intel.com>
Signed-off-by: Yifan Liu <yifan1.liu@intel.com>
2021-11-25 17:19:14 -08:00
Amy Reyes
1ba9070d40 doc: terminology cleanup in config intro
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator and Board Inspector
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-25 05:56:27 -08:00
Amy Reyes
c6f60dc9e6 doc: terminology cleanup in ivshmem
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-25 05:52:42 -08:00
Kunhui-Li
a3015d3973 doc: replace UUID with vmname to identify a vm
Since the PR #6787 has landed, we need to remove the uuid parameter
"-U" of "acrn-dm" and replace UUID with vm name to identify a VM
in document.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-11-25 05:41:08 -08:00
Amy Reyes
8e077ac5ff doc: terminology cleanup in sgx
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-24 17:33:42 -08:00
dongshen
066856d6f9 doc: add vCAT documentation
This patch adds user guide and high level design for vCAT

Tracked-On: #5917
Signed-off-by: dongshen <dongsheng.x.zhang@intel.com>
2021-11-24 06:31:56 -08:00
Amy Reyes
caf893c449 doc: terminology cleanup in partitioned GSG
- Replace User OS
- Remove command prompts
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-24 06:22:34 -08:00
Amy Reyes
41c552dea8 doc: terminology cleanup in file names, labels
- Replace SOS with Service VM
- Replace UOS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:57:47 -08:00
Amy Reyes
d65bd0b85c doc: terminology cleanup in images (sriov)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:41:03 -08:00
Amy Reyes
ff44b1c7c2 doc: terminology cleanup in images (trusty tutorial)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:37:40 -08:00
Xiangyang Wu
1d26695626 doc: refine enable s5 document
Lifecycle Manager will be refined in v2.7, this patch will
refine enable s5 document to align with the latest code.

v1-->v2:
	Remove the prompt from all instructions in this
	document.

Tracked-On: #6652

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-11-19 07:07:32 -08:00
jackwhich
279f129f2d doc: Update nuc11 partitioned document and Scenario xml
Rename logical_partition to partitioned;
Use acrn hypervisor commit instead of tag v2.6;
Add partitioned.xml ramdisk parameter.

Tracked-On: #6709
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2021-11-12 16:25:21 +08:00
Amy Reyes
a68d9266a7 doc: terminology cleanup in nvmx tutorial
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-09 10:17:55 -08:00
David B. Kinder
2554c8f8cc doc: fix broken links
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-29 11:33:02 -07:00
Amy Reyes
8587f73919 Remove prompts in commands
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
377a3b9d49 Update per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
a5a4c112d1 doc: terminology cleanup in using_grub.rst
- Replace SOS with Service VM
- Replace guest with VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
6f92eef2be Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
208fcece20 Replace ACRNSOS with ServiceVM in commands
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
a2dae1e1a9 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
8d572e7319 doc: terminology cleanup in acrn_on_qemu.rst
- Replace SOS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
ae5fc5e494 doc: Update config tool doc and gsg per UI changes
- Update text and screenshots per UI changes in PR 6549

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-13 11:31:45 -07:00
David B. Kinder
0c677fd3b4 doc: remove unreferenced images
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-11 18:20:12 -07:00
Amy Reyes
b9cad70614 doc: Change "configuration tool" to "ACRN configurator tool"
- Change "configuration tool" to "ACRN configurator tool" to match the tool's UI
- Change "configuration toolset" to "ACRN configurator tool" in cases that clearly refer to the configurator and not the entire toolset, update cross-ref

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-11 13:01:50 -07:00
David B. Kinder
e03f0045dc doc: update docs and images to match scenario names
Update the docs and images referencing ``industry`` and ``logical_partition`` scenarios to
``shared`` and ``partioned``.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-04 15:53:45 -07:00
Geoffroy Van Cutsem
e18d99ef65 doc: Update "Enable S5 in ACRN" tutorial
Update the "Enable S5 in ACRN" tutorial to:
* Make the language clearer at places
* Consistent use of "Lifecycle Manager" and "life_mngr"
* Change "ACK" to "ACKED"
* Use a ReST reference to point at the architectural diagram
* Update build instructions
* Replace 'literalinclude' by static code-blocks to avoid the
  content going out of date

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-09-30 11:08:27 -07:00
David B. Kinder
732a399215 doc: fix utf8 chars and missing EOF newlines
Fix some stray and missing characters, and extra newlines.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-28 09:34:41 -07:00
Amy Reyes
6e4e619e17 Address review feedback for launch config options, makefile options, intro
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-09-28 08:59:08 -07:00
Amy Reyes
b203e7e958 Address review comments
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-09-28 08:59:08 -07:00
Amy Reyes
0ac609b5d8 doc: create ACRN config tool/board inspector docs
- Create ACRN config tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create board inspector tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create launch config options doc based on info in existing "Intro to ACRN Configuration" doc, similar to existing scenario config options doc
- Update refs that no longer exist
- Create hypervisor makefile options doc, combining makefile info from "Intro to ACRN Configuration" doc and "Build ACRN from Source" doc
- Clarify why you need config files, difference between scenario vs. launch VM settings
- Updates are intended to reflect v2.6 code

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-09-28 08:59:08 -07:00
jackwhich
0f05204cbc doc: Update logical_partition documentation
1.Modified Intel Whiskey Lake to Intel NUC Kit NUC11TNBi5
2.Change the logical partition and mixed test motherboard name

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2021-09-27 10:26:03 -07:00
David B. Kinder
ce8d69333a doc: remove enable ptm tutorial
Enabling PTM requires some additional engineering work, so we're
removing these instructions for now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-24 16:08:10 -07:00