Commit Graph

729 Commits

Author SHA1 Message Date
Tonny Tzeng
fd8b9c58ee 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-04 08:58:23 -05:00
Tonny Tzeng
bd23e50642 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-04 08:56:15 -05:00
Yang, Yu-chu
086ec45725 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-04 08:55:25 -05:00
Yin Fengwei
98fa9a81cd Doc: Update system power management doc
Signed-off-by: Yin Fengwei <fengwei.yin@intel.com>
2019-10-31 18:54:51 -04:00
Yin Fengwei
3a4af4b096 doc: Update hv power management doc
Signed-off-by: Yin Fengwei <fengwei.yin@intel.com>
2019-10-31 18:52:20 -04:00
Jason Chen CJ
b2ef980260 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-10-31 18:44:27 -04:00
Jason Chen CJ
700d54e817 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-10-31 18:41:31 -04:00
David B. Kinder
52304348d6 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-10-29 17:28:26 -07:00
David B. Kinder
c1cc3040a4 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-10-29 17:26:21 -07:00
David B. Kinder
a7a0852faa 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-10-29 17:11:02 -07:00
Deb Taylor
04d88e4b7d Doc: remove broken links in RNs.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-29 20:06:25 -04:00
David B. Kinder
5a7237b3ff 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-10-29 16:38:45 -07:00
David B. Kinder
be91d87d36 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-10-29 16:38:24 -07:00
lirui34
dab14856c2 doc: Add industry argument for auto setup script
Also fix efibootmgr not set correct issue.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-10-29 10:24:24 +08:00
Gao Junhao
4d8ca9c54a doc: add atkbdc emulation doc
add AT keyboard controller emulation doc and entry

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-28 18:06:36 -04:00
yuhong.tao@intel.com
ca9adf7ddd 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-10-28 18:04:04 -04:00
Jason Chen CJ
c43e70b544 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-10-28 17:59:31 -04:00
Yan, Like
cfcdd8ad09 hv: update virtual interrupts HLD
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-10-28 17:50:34 -04:00
Yan, Like
922b39ed20 Doc: update physical interrupt HLD
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-10-28 17:50:34 -04:00
Yuan Liu
f5ca793c8c doc: add system timer virtualization
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-10-28 07:00:02 -04:00
Sainath Grandhi
4fcedc4329 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-10-28 13:44:32 +08:00
Gao Junhao
70f2ee398b doc: add hostbridge emulation doc
add hostbridge emulation doc and entry

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-27 10:14:06 -04:00
Gao Junhao
a7e34644d7 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-10-27 09:58:17 -04:00
Gao Junhao
bdc4a96f82 doc: add virtio-gpio doc
add virtio-gpio doc

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-27 09:18:02 -04:00
Deb Taylor
339e959962 Doc: remove tutorials/rt_linux.rst file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-25 21:34:26 -04:00
lirui34
8695545d5a 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-10-25 16:58:33 -04:00
Gao Junhao
5e11b47d9d doc: add entry for passthru realization
add entry for passthru realization in device model

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-25 10:39:53 -04:00
Gao Junhao
016c624b4e doc: modify virtio-i2c doc path
move virtio-i2c doc from tutorials to developer-guilders/hld and add
entry for virtio-i2c in hld-virtio-devices

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-25 10:38:25 -04:00
Gao Junhao
69e7649560 doc: add UART emulation in hypervisor doc
add UART emulation in hypervisor doc

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-25 10:37:11 -04:00
Yuan Liu
395e54b1bc doc: add ahci virtualization introduction
Signed-off-by: Yuan Liu <yuan1.liu@intel.com>
2019-10-25 10:33:35 -04:00
Jason Chen CJ
0b00bbd65f document: update HLD for vm management
add VM state transition, and make this chapter into
part of hypervisor hld, the user level vm management
should be introduced in ACRN tools.

Tracked-On: #3882
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-10-25 10:31:51 -04:00
Mingqiang Chi
343aabca4b doc:Update hypercall and upcall
update hld for hypercall and upcall

Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
2019-10-23 20:35:30 -04:00
Kaige Fu
6f9367a50c Doc: Add ART virtualization hld
This patch adds ART virtualization hld.

Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-10-23 20:33:48 -04:00
Yonghua Huang
b3142e1600 doc: update hld-security verified boot section
1. Remove vSBL and ABL descriptions, which are absolete.
2. Add UEFI bootflow description.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-10-23 20:32:09 -04:00
Tw
edffde4e3c doc: update MSR virtualization in HLD
add some missing MSR virtualizations.

Tracked-On: #3882
Signed-off-by: Tw <wei.tan@intel.com>
2019-10-23 18:13:34 -04:00
Tw
227ee64b3b doc: update IO/MMIO HLD
remove unexisted APIs.

Tracked-On: #3882
Signed-off-by: Tw <wei.tan@intel.com>
2019-10-23 18:13:34 -04:00
Tw
d541ee90a6 doc: update CR HLD
add missing bits in CR4 virtualization.

Tracked-On: #3882
Signed-off-by: Tw <wei.tan@intel.com>
2019-10-23 18:13:34 -04:00
Tw
050c0880c2 doc: update CPUID HLD
SGX virtualization has been implemented, update according CPUID leaf.

Tracked-On: #3882
Signed-off-by: Tw <wei.tan@intel.com>
2019-10-23 18:13:34 -04:00
Deb Taylor
3072b6fc6d Doc: Grammar add for config tool doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-22 19:34:01 -04:00
lirui34
6f5dd2da20 doc: acrn_configuration_tool add one more scenario xml element description
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-10-22 16:30:13 -04:00
Deb Taylor
9c67d9b9c5 grammar edits for the hld security document 2019-10-21 18:31:09 -04:00
Yonghua Huang
15e8130fcb doc: hld-security hypervisor enhancement section update
Update some content for hypervisor enhancement section
 to keep it consistent with the design.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-10-21 14:13:45 -04:00
Yonghua Huang
2727263422 doc: hld-security memory management enhancement update
Remove some obsolete descriptions and update content
  that is not consistent with the design.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-10-21 14:10:49 -04:00
Yonghua Huang
81a7666292 doc: hld-security introduction update
update the 'Introduction' section.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2019-10-21 14:03:48 -04:00
Gao Junhao
38d706902d doc: add description for usb-virt-hld
add description of supporting WaaG USB camera and headset.

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-21 13:57:17 -04:00
Kaige Fu
8a2a56e87d Doc: Update hld-trace-log.rst
1) removed the earlylog section as we have remove
     the earlylog support from acrn hypervisor.
  2) updated SOS ACRN Log Module section as the size
     and base address of acrn log buffer are configured
     by kernel option now instead of hardcoding.

Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-10-21 13:55:09 -04:00
lirui34
988c1e483b doc: Align CL version for RT GSG and NUC GSG
Align CL version for RT GSG and NUC GSG

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-10-18 15:42:21 -04:00
Deb Taylor
712dfa9589 minor content edits to virtio-rnd doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-17 22:49:27 -04:00
Gao Junhao
89ec29e1ee doc: merge random device doc to virtio-rnd doc
deleted random device virtualization document, and merge it to
virtio-rnd document.

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-17 20:12:27 -04:00
Gao Junhao
f2fb227b05 doc: detail change for hld-devicemodel
update code in hld-devicemodel to latest.

Signed-off-by: Gao Junhao <junhao.gao@intel.com>
2019-10-17 20:07:40 -04:00