Commit Graph

782 Commits

Author SHA1 Message Date
Yuan Liu
c4e6924d66 doc: add windows 10 activation
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2020-01-03 13:22:09 +08:00
Jian Jun Chen
0d78ca597a doc: Update WaaG GSG to use ACRNGT GOP to install Windows
Signed-off-by: Jian Jun Chen <jian.jun.chen@intel.com>
2020-01-03 13:21:57 +08:00
Geoffroy Van Cutsem
a368512afe doc: add a little info on how to configure the boot options
Add a little information (at least pointers) as to how one can change the VM
(Pre-launched, Service or User) boot options.

Tracked-On: #3758
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-01-03 13:21:45 +08:00
Yonghua Huang
eed89a051f doc:debug feature is disabled by default
Update guidance to build ACRN from source,
as debug feature is disabled by default in Makefile.

 'RELEASE' shall be 0 if debug feature is required.

Tracked-On: #4222
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2020-01-03 13:21:33 +08:00
Geoffroy Van Cutsem
8956f6d8f7 doc: add new dependency to Clear Linux ACRN builder container
Since commit 9e9e1f61, a new build dependency on the NUMA library has been
introduced. We therefore need to add the `devpkg-numactl` bundle to our
Dockerfile used to build the Clear Linux "ACRN builder" container image.

Tracked-On: #4175
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-01-03 11:48:54 +08:00
Mingqiang Chi
acb5affd0b doc:update acrn-shell.rst
update this doc related with dump host & guest memory.

Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
2019-12-11 19:10:36 -05:00
Kaige Fu
413f098b11 Doc: Add libnuma dependency for acrntrace
"9e9e1f61 acrntrace: Add opt to specify the cpus where we should capture the data"
uses APIs of libnuma. So this patch adds dependency of libnuma in building-from-source.rst.

libnuma functions have been included in os-core-dev bundle of clearlinux.

Tracked-On: #4175
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-12-11 17:31:17 -05:00
Li Fei1
6ee076f7df hv: assign: rename ptirq_msix_remap to ptirq_prepare_msix_remap
ptirq_msix_remap doesn't do the real remap, that's the vmsi_remap and vmsix_remap_entry
does. ptirq_msix_remap only did the preparation.

Tracked-On: #3475
Signed-off-by: Li Fei1 <fei1.li@intel.com>
2019-11-29 08:53:07 +08:00
Sainath Grandhi
34c75a0b60 doc: Add multiple PCI segments as known limitation for hypervisor
ACRN does not support multiple PCI segments in its current form.
This patch adds support for mutliple PCI segments as a limitation
for ACRN in reference docs.

Tracked-On: #4134
Signed-off-by: Sainath Grandhi <sainath.grandhi@intel.com>
Reviewed-by: Eddie Dong <eddie.dong@intel.com>
Reviewed-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-11-27 09:49:32 +08:00
hongliang
9af4a62482 doc: edit using_ubuntu_as_sos.rst adjust to v1.4
Signed-off-by: hongliang <hongliangx.ye@intel.com>
2019-11-26 17:19:50 -08:00
lirui34
c2f9de95fb 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:30:14 +08:00
Lei, Lu
2d5fdecf41 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-21 10:17:28 -05:00
lirui34
ec6777ab09 doc: Update 1.4 versions and some words
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-21 10:15:46 -05:00
Deb Taylor
faa348ebdd Doc: Corrected title formatting in RN 1.0.2 doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-21 09:43:55 -05:00
wenlingz
2400f073d1 releasenote for release_1.0.2
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2019-11-21 08:51:25 -05:00
David B. Kinder
28e24c4198 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-20 09:02:37 -08:00
Deb Taylor
40439e1d84 Doc: Content edits to the AGL as VMs docs
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-19 13:07:54 -05:00
hongliang
1d8f16a2e9 doc: edit agl-vms.rst adjust to v1.3 2019-11-19 11:58:03 -05:00
Yonghua Huang
da469d9e3e 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-18 12:54:45 -05:00
Deb Taylor
bb3befa306 Doc: Grammatical edits to the 1.4 Release Notes.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-11 11:47:12 -05:00
lirui34
c1470c8a02 doc: Release notes v1.4
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-11 11:06:25 -05:00
Deb Taylor
d3d33ffce9 Doc: Grammatical edits to the Advisory doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-11 10:59:06 -05:00
lirui34
95d26da472 doc: Add Advisory notes
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-11 10:39:16 -05:00
Deb Taylor
3c50ae57cd Doc: Grammatical edits to the Enable S5 Guide.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-11 10:31:46 -05:00
lirui34
cb207b4383 doc: enable s5 guide
Add instruction of enabling s5.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-11 08:11:52 -05:00
Deb Taylor
4aad66ed6b Doc: Final edits for the HLD-Security doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 19:52:06 -05:00
David B. Kinder
f2098ee186 doc: add copyright/license header to doc scripts
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 15:29:23 -08:00
Deb Taylor
dec914f588 Doc: Final edits to the HV Hypercall doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 17:38:27 -05:00
Deb Taylor
a1dca993e8 Doc: Final edits to the CPU Virt doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 17:15:00 -05:00
David B. Kinder
8ccb21533e doc: review edits for rt_industry doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 14:07:24 -08:00
Deb Taylor
a578d15ad1 Doc: Final edits to the HLD Overview doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 16:36:50 -05:00
Deb Taylor
c4ecc92177 Doc: Final edits to Memory Mangt HLD doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 14:44:26 -05:00
David B. Kinder
2d810ea456 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-08 10:57:13 -08:00
David B. Kinder
38abceb761 doc: review edits for acrn_configuration_tool
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 10:02:48 -08:00
Xie Zhengtian
0d86951e46 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-08 12:45:40 -05:00
David B. Kinder
9c515aafed doc: fix error in building_from_source doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 08:55:02 -08:00
lirui34
705ba86da2 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-08 08:44:22 -08:00
huyuan3x
cc7bf1a506 doc: Update Using Windows as Guest VM on ACRN
Signed-off-by: huyuan3x <yuanx1.hu@intel.com>
2019-11-08 08:42:34 -08:00
wenlingz
f4d6af02b2 doc:modfiy ubuntu build on 18.04
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2019-11-08 08:29:18 -08:00
lirui34
958ea0f11b 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-08 08:28:46 -08:00
Deb Taylor
96edee5e03 Doc: update conf.py file to include v1.4
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-07 19:17:25 -05:00
David B. Kinder
7b9f2f643e 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-07 18:33:00 -05:00
Deb Taylor
1902cfd174 Doc: Minor grammatical edits on various files.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-07 18:30:17 -05:00
lirui34
ad9b96579f 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-07 14:10:51 -05:00
Yonghua Huang
d3cf6a55f2 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-07 14:09:46 -05:00
Li, Fei1
c3b4518357 doc: update timer hld
Add two new APIs interfaces design

Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2019-11-07 14:08:39 -05:00
Li, Fei1
8a99a66bd5 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-07 14:08:39 -05:00
Deb Taylor
f59932e3db Added entry for waag-secure-boot tutorial (added in #3883)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-07 13:26:27 -05:00
lkanx
95f485db51 doc:update acrn_configuration_tool
Signed-off-by: lkanx <lix.kan@intel.com>
2019-11-07 07:08:24 -05:00
Yuan Liu
434a746ccb doc: add waag secure boot enabling
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-11-07 07:05:29 -05:00