Commit Graph

5778 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem
686a1173f8
doc: fix typo in docbuild.rst
Fix a typo in the `docbuild.rst` file.
2021-01-04 10:49:29 +01:00
David B. Kinder
b74b4cd53d doc: upgrade doc-build tools
Update the documentation for how to build ACRN documents
(tutorial/docbuild.rst) and the scripts/requirements.txt that lists the
tested configuration of python tools being used.

Previous merged commits have already been made to handle doc builds with
the previous (2.3 documented configuration and the new v2.4
configuration.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-31 14:56:17 -08:00
David B. Kinder
c0707ab361 doc: prep for upgrading doc build tools
Update known-issues list to eliminate known warnings for duplicate
declaration warnings because of breathe/sphinx upgrades.

Update conf.py to check sphinx version and use appropriate way to
include extra javascript and css files depending on the version.

Both of these changes will allow the old and new doc tools to not show
unanticipated warnings or errors and allow for a smooth upgrade to the
CI system (and contributors local doc builds).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-31 13:04:27 -08:00
Jie Deng
b14c32a110 hv: Retain RIP only for fault exception.
We have trapped the #DB for split-lock emulation.
Only fault exception need RIP being retained.

Tracked-On: #5605
Signed-off-by: Jie Deng <jie.deng@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2020-12-31 11:12:33 +08:00
Jie Deng
977e862192 hv: Add split-lock emulation for xchg
xchg may also cause the #AC for split-lock check.
This patch adds this emulation.

 1. Kick other vcpus of the guest to stop execution
    if the guest has more than one vcpu.

 2. Emulate the xchg instruction.

 3. Notify other vcpus (if any) to restart execution.

Tracked-On: #5605
Signed-off-by: Jie Deng <jie.deng@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2020-12-31 11:12:33 +08:00
Jie Deng
47e193a7bb hv: Add split-lock emulation for LOCK prefix instruction
This patch adds the split-lock emulation.
If a #AC is caused by instruction with LOCK prefix then
emulate it, otherwise, inject it back as it used to be.

 1. Kick other vcpus of the guest to stop execution
    and set the TF flag to have #DB if the guest has more
    than one vcpu.

 2. Skip over the LOCK prefix and resume the current
    vcpu back to guest for execution.

 3. Notify other vcpus to restart exception at the end
    of handling the #DB since we have completed
    the LOCK prefix instruction emulation.

Tracked-On: #5605
Signed-off-by: Jie Deng <jie.deng@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2020-12-31 11:12:33 +08:00
David B. Kinder
69b207ac6a doc: spelling fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-28 15:02:06 -08:00
David B. Kinder
33901fd287 doc: fix formatting in windows as UOS doc
code-block content wasn't indented in a recent change so wasn't included
in the code-block formatting

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-24 11:07:28 -08:00
fuzhongl
703e0e2d52 Doc: update Debian and Ubuntu as the User VM
Pipe info isn't needed for IDV solution; so remove this part in
the document.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-12-23 09:27:19 -08:00
Shuang Zheng
529a2ac497 acrn-config: config the entry number of vcpu_clos same as that of pcpu_id
configure the entry number of vcpu_clos same as the entry number
of pcpu_id to avoid sanity check error.

Tracked-On: #5600
Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Acked-by: Victor Sun <victor.sun@intel.com>
2020-12-23 08:47:02 +08:00
David B. Kinder
35aba4ff21 doc: remove stray x attrib on png and rst files
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-21 09:57:19 -08:00
Yonghua Huang
df5e0bfe00 doc: remove exec attribute for 'acrn-secure-boot-with-grub.rst'
Remove 'x' attribute of this file and one more minor fix.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-21 09:45:43 -08:00
Geoffroy Van Cutsem
6fa0cb3758 doc: fix 'cp' command in instructions
Fix the 'cp' operation in the instructions explaining
how to build the kernels.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-21 09:37:54 -08:00
fuzhongl
2c5b7fcde8 Doc: update WaaG image creation with GVT-d GOP
Since GVT-g isn't enable for new platform (i.e TGL EHL CFL),
update the doc about using GVT-d GOP to create WaaG image.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
2020-12-21 09:37:12 -08:00
Geoffroy Van Cutsem
070be0aa99 doc: specify the version of 'sphinx-tabs' to install
Specify the version of 'sphinx-tabs' to be installed in order
to be able to build the documentation. Without this, the latest
is installed but is incompatible with 'sphinx==1.7.7' as specified
in our doc/scripts/requirements' file.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-21 09:35:18 -08:00
David B. Kinder
52d33f067e doc: tweak to copyright footer
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-18 08:40:31 -08:00
David B. Kinder
99d8f29617 doc: update LICENSE copyright years
LICENSE file copyright must reflect latest year of contributions
(before this update, it said 2017-2018).

Tracked-On: #5611

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-18 15:12:18 +08:00
Shuang Zheng
7e4b953185 acrn-config: add cfl-k700-i7 into tpm supported boards
add cfl-k700-i7 into tpm supprted boards to enable tpm
passthru to the pre-launched vm.

Tracked-On: #5614
Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Reviewed-by: Victor Sun <victor.sun@intel.com>
2020-12-18 13:22:08 +08:00
Yonghua Huang
655777e6ce ovmf: update OVMF.fd
Currently, OVMF sets CR4.MCE bit without
  any hardware support checking, this will cause
  User VM boot fails as MCE feature is not available
  for ACRN guest VM.

  This patch walk around this issue in OVMF.

Tracked-On: #5586
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-18 11:21:22 +08:00
Yonghua Huang
643bbcfe34 hv: check the availability of guest CR4 features
Check hardware support for all features in CR4,
 and hide bits from guest by vcpuid if they're not supported
 for guests OS.

Tracked-On: #5586
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2020-12-18 11:21:22 +08:00
Yonghua Huang
442fc30117 hv: refine virtualization flow for cr0 and cr4
- The current code to virtualize CR0/CR4 is not
   well designed, and hard to read.
   This patch reshuffle the logic to make it clear
   and classify those bits into PASSTHRU,
   TRAP_AND_PASSTHRU, TRAP_AND_EMULATE & reserved bits.

Tracked-On: #5586
Signed-off-by: Eddie Dong <eddie.dong@intel.com>
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-18 11:21:22 +08:00
Minggui Cao
f31be45df0 misc: add more boot arguments for EHL preempt-rt
some RT related boot arguments are needed for preempt-rt linux.
add them in configure file built in for EHL board.
  for EHL, it is booted with SBL, not like GRUB, extra boot arguments
can be added; so better to be built in.

Tracked-On: #5606
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2020-12-18 11:06:41 +08:00
David B. Kinder
61e5957129 doc: automate copyright year footer
Automatically update the copyright year on the page footers to be
2018-[current_year] when generating documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-17 10:59:57 -08:00
Steve Winslow
bdcfb5c83b doc: add ACRN lockup logo to README
As part of the trademark registration for ACRN, it is helpful to
ensure that the logo is displayed on the same page from which the
ACRN code can be downloaded.

This PR adds the logo and updates the README file to display it.

Tracked-On: #5601

Signed-off-by: Steve Winslow <steve@swinslow.net>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-15 10:36:42 -08:00
Yang,Yu-chu
371440754e acrn-config: fix the logic of get_vuart1_vmid
The function validate if the legacy vuart1 and its target_vm_id are
paired. However, it dynamically modifies the tracking list. It would try
to access an invalid keys which has been removed.

Refine the logic to add a valid paired legacy vuart1 to new list.

Tracked-On: #5592
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2020-12-14 13:00:51 +08:00
Geoffroy Van Cutsem
7a4b811a63 hv: set SHELL in top-level Makefile
Explicitly set the SHELL variable in the top-level Makefile. This ensures that
'echo -e' as used in the Makefile behaves correctly on various systems. It does
require /bin/bash to be present but that is probably true on many systems.

Tracked-On: #5588
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-11 09:46:21 +08:00
Geoffroy Van Cutsem
b87070f95a Revert "hv: fix formatting for cfg.log output"
This reverts commit e2590d88aa. It introdcues a
regression for systems that have '/bin/sh' pointing at '/bin/bash'.

Tracked-On: #5588
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-11 09:46:21 +08:00
ChenYing Kuo
ead26799ff Small updates to ROScube-I Installation Guide
* Add newline before `sudo reboot` in User VM section.
* Add `cd ~/acrn/tools/` before downloading script in User VM section.

Signed-off-by: ChenYing Kuo <chenying.kuo@adlinktech.com>
2020-12-10 09:23:49 -08:00
Geoffroy Van Cutsem
9264aeb77d doc: small updates to the GSG
Small updates to the Getting Started Guide:
* Add a missing command
* Add a note for the Grub configuration
* Make the 'blkid' hint consistent with the environment

Tracked-On: #5594
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-10 09:21:54 -08:00
David B. Kinder
2571314d77 doc: add ROScube GSG
Adding a new GSG contributed by ADLINK for installing an ACRN Industry
Scenario on their ROScube-I system.

Signed-off-by: ChenYing Kuo <chenying.kuo@adlinktech.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-08 11:08:58 -08:00
Shuang Zheng
b4249bd11c acrn-config: update function for xml.etree.ElementTree to compatible with python3.9
The function getchildren() is removed from xml.etree.ElementTree.Element
on python3.9, update the function to list() to make config tool
compatible with python3.9.

Tracked-On: #5570

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Acked-by: Victor Sun <victor.sun@intel.com>
2020-12-08 15:47:01 +08:00
Yonghua Huang
06e9220794 dm: rename ioctl command for hv-emulated management
Use add/remove device instead of create/destroy.

Tracked-On: #5586
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-07 16:25:17 +08:00
Yonghua Huang
08c42f91c9 hv: rename hypercall for hv-emulated device management
Coding style cleanup, use add/remove instead of create/destroy.

Tracked-On: #5586
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-07 16:25:17 +08:00
Yonghua Huang
d5bf1a76ff doc: update acrn secureboot enablement
- Format some section title
 - Add one more section.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-05 12:05:27 -08:00
Yonghua Huang
914ac534c0 doc: update HLD of HV-Land Ivshmem
Add a figure for HLD of HV-land doorbell design.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-12-05 11:25:31 -08:00
Shixiong Zhang
91fde59f41 acrn-config: modify the cmd args in pre-launched rt xml
add the right cmd args provided by Ronnie.

Tracked-On: #5501

Signed-off-by: Shixiong Zhang <shixiongx.zhang@intel.com>
2020-12-04 14:59:15 +08:00
Shuang Zheng
376b90d40a acrn-config: update tpm config source code for hybrid_rt on ehl
enable tpm2 config source code for hybrid_rt scenario on ehl board.

Tracked-On: #5506

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
2020-12-04 14:57:20 +08:00
Shuang Zheng
5ea9c55145 acrn-config: enable tpm for hybird_rt on ehl
enable tpm for hybrid_rt scenario on ehl board.

Tracked-On: #5506

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
2020-12-04 14:57:20 +08:00
David B. Kinder
8838f0e661 doc: tweak to 2.3 release notes
Added a couple of missing documents in the "changed doc" list, and fixed
spelling of passthrough

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-03 09:23:00 -08:00
David B. Kinder
dd05d7417a doc: update doc version selector for v2.3
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 17:46:23 -08:00
David B. Kinder
ef36eacb55 doc: release notes tweaks for v2.3
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 17:30:14 -08:00
fuzhongl
2e947496c2 Doc: release_notes_2.3 update
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-12-02 17:13:45 -08:00
David B. Kinder
5cd9eb43a9 doc: update v2.3 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 09:43:05 -08:00
Shuang Zheng
b87814ba36 doc: update the doc to setup openstack with ACRN
update ACRN version, update kernel boot args, and fix the issue in
the steps to set up libvirt.

Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 09:12:48 -08:00
Yonghua Huang
4759735c99 doc: Setup secureboot with GRUB
Add guide to enable grub secure boot on ACRN.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-02 08:59:52 -08:00
fuzhongl
124752fcf7 Doc: Update GSG and Build ACRN from Source for v2.3
Update Getting Started Guide for ACRN Industry Scenario with Ubuntu Service VM;
and Getting Started Guide for ACRN logical partition mode.
Also update Build ACRN from Source for EFI related part since it is
removed form v2.3

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
2020-12-02 08:52:50 -08:00
Peter Fang
3db34b3164 doc: add documentation for graceful system shutdown
Tracked-On: #5411
Signed-off-by: Peter Fang <peter.fang@intel.com>
2020-12-02 08:51:11 -08:00
Yang,Yu-chu
e6dc6dfe0d acrn-config: remove hardcoded device in launch script
The "virtio-hyper_dmabuf" is no longer needed for PREEMPT-RT LINUX.
Remove it from launch script.

Tracked-On: #5565
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2020-12-02 13:45:57 +08:00
Geoffroy Van Cutsem
e2590d88aa hv: fix formatting for cfg.log output
Fix the formatting for the cfg.log (build/hypervisor/cfg.log) generation. The
'echo' command uses '-e' but that gets put as-is into the log file. Removing
the '-e' argument fixes it.

Tracked-On: #5561
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-12-02 13:45:39 +08:00
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