Commit Graph

4359 Commits

Author SHA1 Message Date
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
Junhao Gao
67c64522fd dm: fix memory free issue for xhci
remove uninitialized variable "dir", then make sure
"xfer->data","xfer->data[i].hcb","xfer->reqs" free correctly.

Tracked-On: #4034
Signed-off-by: Junhao Gao <junhao.gao@intel.com>
Reviewed-by: Yonghua Huang <yonghua.huang@intel.com>
Acked-by: Yu Wang <yu1.wang@intel.com>
2019-11-08 14:36:25 +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
David B. Kinder
2077d79daa doc: fix remaining masked doc build errors
This should get us back to a clean doc build now...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 09:22:04 +08:00
David B. Kinder
f3f638fa9c doc: doc build errors not being reported
PR #3665 moved all the doc build artifacts into the _build folder and
updated scripts and Makefile to account for this, except missed a fix in
the script that checks for known issues. This patch fixes that but shows
we've got a bunch of issues that have not been being reported so we'll
need to fix those problems to resolve failing doc builds.

Also fixed process of the VERSION file in conf.py since the path to that
file was changed by PR #3665 as well and was raising an exeception that
was being masked.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 09:21:44 +08:00
Deb Taylor
9e34a3fdb0 Doc: remove broken links in RNs.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 09:13:07 +08:00
David B. Kinder
97a0464a5b doc: fix broken include paths
PR #3665 moved the doc build folder, so files referenced via directives
had an incorrect path (need to add an additional ../../ to the front of
relative paths that were referencing files outside of the doc folder).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 09:12:49 +08:00
David B. Kinder
1a277f7524 doc: fix vuart-virt-hld errors
Fix "duplicate label" error (name of a figure collided with the name of
a document).  Also fixed very long lines, cleaned up some stray extra
spaces that were breaking up words, and some grammar issues.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-11-08 09:12:19 +08:00
lirui34
bbc228e6b3 doc: Add industry argument for auto setup script
Also fix efibootmgr not set correct issue.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 09:11:59 +08:00
Gao Junhao
fd821d55bc doc: add atkbdc emulation doc
add AT keyboard controller emulation doc and entry

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-11-08 09:11:38 +08:00
yuhong.tao@intel.com
6513db40d2 doc: add HLD for CAT
The hld of resource director technology, RDT. Should have CAT and
MBA. This is for CAT.

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2019-11-08 09:11:22 +08:00
Jason Chen CJ
b6007d05e1 document: update HLD for hypervisor startup
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:11:00 +08:00
Yan, Like
93c45f1a4e Doc: update physical interrupt HLD
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-11-08 09:10:42 +08:00
Yuan Liu
f3f48c3b1a doc: add system timer virtualization
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-11-08 09:10:21 +08:00
Sainath Grandhi
924f4007ee doc: Adding a section for ACRN requirements on a processor
Adds a new section in reference documentation that lists the
requirements from ACRN upon a processor to boot and function
successfully.
This patch is a starting point and can expect to add a lot
more requirements that would be a translation of
hypervisor/arch/x86/cpu_caps.c

Tracked-On: #3899
Signed-off-by: Sainath Grandhi <sainath.grandhi@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-11-08 09:09:58 +08:00
Gao Junhao
586a947de2 doc: add hostbridge emulation doc
add hostbridge emulation doc and entry

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-11-08 09:09:36 +08:00
Gao Junhao
2e2c3db5c3 doc: add RTC emulation in hypervisor doc
add RTC emulation in hypervisor doc and add entry in hld-emulated-devices

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-11-08 09:09:19 +08:00
Gao Junhao
b5491474d8 doc: add virtio-gpio doc
add virtio-gpio doc

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-11-08 09:09:03 +08:00
Deb Taylor
5466c8e40f Doc: remove tutorials/rt_linux.rst file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-08 09:08:34 +08:00
lirui34
d0e1f05efe doc: Align the updates of rt gsg with 1.3
Need to align the rt gsg updates with 1.3 branch.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 09:08:14 +08:00