Commit Graph

523 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem
eb070491ee doc: fix the URL for projectacrn.github.io repo
Fix the URL used to clone the projectacrn.github.io repo.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-03-10 08:02:51 -08:00
David B. Kinder
b72202e976 doc: update doc-build tutorial
Last year, GitHub announced the deprecation of the unsecured Git
protocol due to security reasons. This change will be made permanent on
March 15, 2022. Update the doc build tutorial to use https: instead of
git: protocol for cloning repos.

And while in here, clarify some of the doc build instructions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-03-09 17:35:44 -08:00
Xiangyang Wu
29b2fa2310 doc: configure yajl lib for acrn driver in libvirt
Acrn driver in libvirt needs to handle JSON command or
JSON message to interact with command monitor in ACRN DM.

In libvirt, JSON APIs implementation depends on yajl lib.
So yajl should be configured for libvirt.

v1-->v2:
	Remove description about checkout hypervisor tag
	since libvirt can work on the latest hypervisor.
	Libvirt doesn't depend on acrnd and acrnctl now,
	remove acrnd and acrnctl installation in this document.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2022-03-09 13:46:25 -08:00
David B. Kinder
0aca3f5a7a doc: fix doc build error for removed options
PR #7167 removed configuration options that were referenced by
documentation.  Remove those references.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-03-02 22:39:45 -08:00
hangliu1
5e6341ee89 doc: remove guest_flag and NVMX_ENABLE
Global parameter NVMX_ENABLE is removed from user interface,
and remove guest_flag

Tracked-On: #6690
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-03-02 15:50:23 +08:00
David B. Kinder
0283202193 doc: fix docs with missing newline at EOF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-28 12:16:18 -08:00
Reyes, Amy
49e234129f doc: Tarball installation
- New document about building tarball files for ACRN installation.
- Steps are from GSG.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:39:21 -08:00
Reyes, Amy
72a9b7bae3 doc: Style cleanup in usercrash, trusty, vuart docs
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:33:21 -08:00
jackwhich
dad8834e23 doc: remove obsolete content in document
remove obsolete content in Document

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 21:06:43 -08:00
Reyes, Amy
7c304539b4 doc: Update terms in vUART tutorial
- Update scenario names

Tracked-On: #6701
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-22 09:50:39 -08:00
jackwhich
bd02de15b0 doc: Remove modprobe msr in gsg
modprobe msr has been added to board_parse.py in PR #6692.

Remove modprobe msr in gsg and board_inspector docs

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 09:45:29 -08:00
David B. Kinder
97855c54c2 doc: quick doc fix to remove build error from IVSHMEM changes
PR #7115 removed ``IVSHMEM_ENABLED`` and ``IVSHMEM_REGION`` from
``types.xsd``.  We'll need to update the documentation to reflect this
change, but for now we need to remove the doc build error.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-18 17:04:33 -08:00
Reyes, Amy
c952c00324 doc: Update terms in qemu tutorial
- Remove "sdc"
- Replace "sos" with "Service VM"
- Replace "uos" with "User VM"

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-16 16:51:36 -08:00
David B. Kinder
b5fc55090c doc: update cpu-checker instructions in qemu doc
Clarify that ``cpu-checker`` is the package that you install to get the
``kvm-ok`` tool used in these instructions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-14 16:22:08 -08:00
fuzhongl
c3f66210cf Doc: qemu cmdline update for acrn on qemu
For platforms which have apicv post-interrupt capability;
ACRN would use posted-interrupt to notify another vCPU which in non-root mode;
or sync interrupt for itself when it in root-mode.However,QEMU could not handle this properly.
So, remove the post-interrupt capability in qemu cmdline.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-By: Li, Fei <fei1.Li@intel.com>
2022-02-14 15:33:59 -08:00
Yuanyuan Zhao
8c046616c8 doc: dm cpu affinity dynamic param refine
Cpu affinty was set by pCPU ID which can't be obtained
explictly by user. Use lapic ID instead which can be easily
read from `/proc/cpuinfo` as `apicid`.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-26 09:37:23 -08:00
Geoffroy Van Cutsem
21d7b242c9 doc: update the method to run the acrn_configurator.py
Update the instructions on how to start the ACRN Configurator tool
('acrn_configurator.py'). It is no longer require to use 'python3 ...'
since we've added a shebang header to the file and made it executable.

Tracked-On: #7057
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-26 14:20:43 +08:00
Yuanyuan Zhao
75884af9ac doc: remove dm dynamic param '-A'
Update document to remove 'acrn-dm' dynamic param '-A'.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-21 16:07:37 -08:00
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