Commit Graph

770 Commits

Author SHA1 Message Date
lirui34
8f59749ad5 doc: remove rt gsg kernel info
No need rt kernel info in gsg doc.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-22 11:25:18 +08:00
Lei, Lu
cf68b00ba8 doc: update acrn ootb doc
1. Update acrn.efi name in acrn ootb scripts
2. Add licenses to acrn ootb scripts
3. Add format U disk step
4. Add execute permission to ootb script
5. Fix wrong img name
6. update clearlinux version to 31600

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-11-22 09:11:47 +08:00
lirui34
2f679e4a51 doc: Update 1.4 versions and some words
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-22 09:11:32 +08:00
David B. Kinder
3c79f980b5 doc: put v1.0 docs back in version menu
We've been keeping the doc version choice list trimmed as new doc
version releases are made, but the v1.0 version should remain.  (Note
that the documents for all previously published versions are still
available on the server, but they were included in the menu choice).
This PR puts the 1.0 choice back in.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-21 14:02:05 +08:00
Deb Taylor
da2abd690b Doc: Content edits to the AGL as VMs docs
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-21 14:01:51 +08:00
hongliang
b8e706a953 doc: edit agl-vms.rst adjust to v1.3 2019-11-21 14:01:35 +08:00
Yonghua Huang
05a930529c doc: add mitigation description for CVE-2018-12207 in advisory
Mitigation for this vulnerability is applied in 1.4 release, update
 related notes in adviosry.

Tracked-On: #4101
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-11-21 14:01:21 +08:00
Deb Taylor
e0d14b70e6 Doc: Grammatical edits to the 1.4 Release Notes.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-12 09:31:02 +08:00
lirui34
d8bd508875 doc: Release notes v1.4
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-12 09:30:48 +08:00
Deb Taylor
90a611344b Doc: Grammatical edits to the Advisory doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-12 09:30:35 +08:00
lirui34
c6bccd5cea doc: Add Advisory notes
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-12 09:30:21 +08:00
Deb Taylor
94394ae98d Doc: Grammatical edits to the Enable S5 Guide.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-12 09:30:08 +08:00
lirui34
b16e598763 doc: enable s5 guide
Add instruction of enabling s5.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-12 09:29:53 +08:00
Deb Taylor
79294b394f Doc: Final edits for the HLD-Security doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-11 08:56:50 +08:00
Yonghua Huang
865d1a22e6 doc: add hld-security guest secure boot description
1. add guest secure boot with OVMF.
  2. delete obsolete content.
  3. SOS -> Service VM and UOS -> User VM.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-11-11 08:56:28 +08:00
David B. Kinder
a4713fce6f doc: add copyright/license header to doc scripts
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-09 23:59:27 +08:00
Deb Taylor
047670706b Doc: Final edits to the HV Hypercall doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-09 23:59:06 +08:00
Deb Taylor
dcfa758719 Doc: Final edits to the CPU Virt doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-09 23:58:44 +08:00
David B. Kinder
ce46f35db5 doc: review edits for rt_industry doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-09 23:58:25 +08:00
Deb Taylor
3298891fc4 Doc: Final edits to the HLD Overview doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-09 23:58:05 +08:00
Deb Taylor
a74a75514a Doc: Final edits to Memory Mangt HLD doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-09 23:57:44 +08:00
David B. Kinder
1c3f16f56d doc: review edit for enable_laag_secure_boot
Review update to PR #3938

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-09 23:57:25 +08:00
David B. Kinder
ae126bd5fb doc: review edits for acrn_configuration_tool
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-09 23:57:02 +08:00
Xie Zhengtian
9687d72e11 doc: add cores and threads for CPU of supported hardware
The default binary will not support 2 core/2 thread hardware from V1.3;
KBL NUC7i5DNH has serial port;
Add cores and threads for CPU of hardware listed;

Signed-off-by: Xie Zhengtian <zhengtian.xie@intel.com>
2019-11-09 23:56:41 +08:00
David B. Kinder
2d0739bfc8 doc: fix error in building_from_source doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-09 23:56:19 +08:00
lirui34
3b977eef4d doc: clean up the docs in try using acrn table.
Move acrn_ootb / building_acrn_in_docker / up2 gsg to the
develop using acrn guide;

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-09 23:55:55 +08:00
huyuan3x
2a3178aa0a doc: Update Using Windows as Guest VM on ACRN
Signed-off-by: huyuan3x <yuanx1.hu@intel.com>
2019-11-09 23:55:33 +08:00
wenlingz
9bd274ae40 doc:modfiy ubuntu build on 18.04
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2019-11-09 23:55:10 +08:00
lirui34
7d818c8272 doc: Stop using kconfig to make a customized efi.
Also fix some quick setup script issues.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-09 23:54:46 +08:00
Deb Taylor
3fb1021dbc Doc: Minor grammatical edits on various files.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 13:20:38 +08:00
David B. Kinder
72f7119246 doc: fix doc build errors previously masked
As reported in PR #3959, doc build errors were being masked by a script
error.  This PR fixes a chunk of them.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 13:20:04 +08:00
Yan, Like
2a6f2fa822 hv: update virtual interrupts HLD
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-11-08 13:19:17 +08:00
Deb Taylor
3314857a09 Doc: update conf.py file to include v1.4
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 09:29:15 +08:00
David B. Kinder
b20a67f839 doc: clean up waag-secure-boot doc
Cleaned up the presentation and formatting problems from the conversion
to ReST, along with English grammar and spelling edits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 09:29:00 +08:00
lirui34
9d01d8ad9e doc: instruction of enabling the laag secure boot
Add tutorial about how to enable the laag secure boot.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 09:28:09 +08:00
Li, Fei1
af61b486de doc: update timer hld
Add two new APIs interfaces design

Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2019-11-08 09:27:08 +08:00
Li, Fei1
ea601e4241 doc: update memory management hld
1. Some security features are added into ACRN HV memory management.
2. Dynamic memory allocation is removed. Instead, static memory page allocation is added.
3. The guest to host mapping is not static any more for Service OS after it begins running
since the Service OS support PCI BAR re-pregramming now.

Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2019-11-08 09:26:56 +08:00
Deb Taylor
c8abc7cbfb Added entry for waag-secure-boot tutorial (added in #3883)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 09:26:43 +08:00
lkanx
f34f87fa38 doc:update acrn_configuration_tool
Signed-off-by: lkanx <lix.kan@intel.com>
2019-11-08 09:26:25 +08:00
Yuan Liu
0e65254684 doc: add waag secure boot enabling
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-11-08 09:26:10 +08:00
Deb Taylor
0d2cdd95b8 Clean up language in the acrn_quick_setup script.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 09:25:57 +08:00
Jason Chen CJ
cc61ae7ce8 doc: schedule_vcpu was removed
schedule_vcpu should be replaced by launch_vcpu

Tracked-On: #3963
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-11-08 09:25:37 +08:00
lirui34
fbc54a18ab doc: Remove apl gsg and merge contents into rt gsg
Change APL getting started guide to KBL getting started guide;
Merge some of the contents into preempt-rt getting started guide;
Move the modified kbl getting started guide to the behind of the configuration tutorials;
Fix issues for acrn_quick_setup.sh script.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 09:25:24 +08:00
Tonny Tzeng
f76510095e doc: remove redundant copy of ovmf.fd firmware
Remove redundant copy of ovmf.fd firmware as the lunach script now
instructs the DM to user the OVMF.fd firmware directly from the rootfs.

Tracked-On: #3972
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2019-11-08 09:25:10 +08:00
Tonny Tzeng
67d4a38faa doc: remove the guest cpu number option '-c' from the document
This commit updates the DM parameters reference document to reflect
the removal of the guest cpu number option '-c' implementation.

Tracked-On: #3989
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2019-11-08 09:24:57 +08:00
Yang, Yu-chu
fe73b2dfa4 doc: OVMF high level description
Add OVMF HLD and boot flow graph

Signed-off-by: Yang, Yu-chu <yu-chu.yang@intel.com>
2019-11-08 09:24:41 +08:00
Yin Fengwei
625a6aab77 Doc: Update system power management doc
Signed-off-by: Yin Fengwei <fengwei.yin@intel.com>
2019-11-08 09:24:28 +08:00
Yin Fengwei
383d53b48d doc: Update hv power management doc
Signed-off-by: Yin Fengwei <fengwei.yin@intel.com>
2019-11-08 09:24:15 +08:00
Jason Chen CJ
4586acd49a document: update HLD for hypervisor overview
updated this chapter based on latest master
some part still need update:
- vSBL need be replaced by OVMF after removed all vSBL stuff

Tracked-On: #3882
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-11-08 09:23:55 +08:00
Jason Chen CJ
5583c864b2 document: update HLD for cpu virtualization
updated this chapter based on latest master

Tracked-On: #3882
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-11-08 09:23:41 +08:00