Commit Graph

202 Commits

Author SHA1 Message Date
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
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
lirui34
f835fdef05 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-05 15:09:49 -05:00
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
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
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
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
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
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
lirui34
44d2a56ba2 doc: fix missing words issue in acrn configuration tool doc
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-10-15 07:23:16 -04:00
lidongwangx
051a8e4a45 doc: update Oracle driver install
Signed-off-by: lidongwangx <dongwangx.li@intel.com>
2019-10-14 17:42:31 -04:00
Geoffroy Van Cutsem
6f7ba36ea0 doc: move the "Building ACRN in Docker" user guide
Move the "Building ACRN in Docker" guide to the "Try using ACRN" section to be
more prominently visible. Reference it from the main "Build ACRN from Source"
user guide.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-14 17:33:20 -04:00
lirui34
018fed2c21 doc: Add introduction for using Preempt_RT VM with Industry scenario
This tutorial is introducing how to build service vm, preempt_rt kernel and
industry scenario hypervisor; Update built kernel and launch the preempt_rt vm.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-28 04:54:37 -04:00
Deb Taylor
96fc3fec10 Doc: content updates to ACRN Config Tool and Build frm Source
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-27 15:25:42 -04:00
lirui34
c17510d593 doc: update ACRN configuration tool document
- Remove the TBD parts;
- Add configuration tool UI app instructions;
- Update "Build from Source" for generating the hypervisor via configuration tool.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-26 08:53:13 -04:00
Geoffroy Van Cutsem
9c273cf33e doc: editorial tweaks to "Real-Time (RT) Performance Analysis on ACRN"
Editorial tweaks to the "Real-Time (RT) Performance Analysis on ACRN" document,
mostly to improve readibility, no technical content change.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-25 14:51:38 -04:00
Deb Taylor
7eb0dc1436 doc: content updates to RT perf tuning doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-25 09:39:20 -04:00
Deb Taylor
b16531257e doc: content updates for using SBL on UP2 board file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 20:23:10 -04:00
Deb Taylor
04dd9f97d2 doc: minor edits to using celadon as user os file
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 19:41:25 -04:00
lirui34
617a77d8fb doc: Add document of RT performance tuning.
Add document of RT performance tuning.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 09:57:07 -04:00
Lei, Lu
13b998f240 update using_sbl_on_up2 doc and create-up2-images.sh
1. Fix the broken link to dwonload UP2 Board BIOS
2. In Clear Linux 31030 the acrn.apl-up2.sbl name is changed to
   acrn.apl-up2.sbl.sdc.32.out, so we need to update the creaet-up2-imgages.sh
3. Command "swupd verify --install -m" has been superseded, use "swupd
   os-install -V" instead.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-24 09:53:59 -04:00
lirui34
01a1aeb69f doc: Add note to use a stable Celadon source tree
So far the patches are only suite for Celadon Android 9.
Need to specify the Android 9 repo branch to apply patches and
build Celadon image.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 09:53:02 -04:00
Geoffroy Van Cutsem
76da81370b doc: tweak vUART tutorial for improved rendering
Tweak the "vUART configuration" tutorial to fix a few typos and change some
formatting to improve its readability.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-24 08:47:07 -04:00
Deb Taylor
698ec4c4f4 Doc: Update image and text in Virtio-i2c doc
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 08:01:27 -04:00
Deb Taylor
960c508bab Doc: Initial vuart configuration doc and images--4979
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-24 07:10:51 -04:00
Deb Taylor
9e759bcfa0 Initial virtio i2c doc and images.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-23 11:13:30 -04:00
Geoffroy Van Cutsem
f5c8fbb281 DM: update launch scripts to use OVMF.fd directly from the rootfs
* Update the launch scripts provided as examples on how to launch a Zephyr,
VxWorks or Windows User VM to directly use the 'OVMF.fd' bios file installed
by default in '/usr/share/acrn/bios/'
* Remove the OVMF.fd that was kept under 'doc/tutorials' (no longer needed)
* Adapt the tutorials to reflect this change

Tracked-On: #3673
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-09-18 09:10:32 +08:00
Deb Taylor
32a75af1ea New tutorials for running deb or ubunt as user vms
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-17 14:56:18 -04:00
Deb Taylor
6045a5e54c Intitial doc for Running Debian as a Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 22:07:09 -04:00
Deb Taylor
64805b51b1 Language edits to the Building ACRN in Docker tutorial
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 12:00:33 -04:00
Lei, Lu
2628868ae0 doc: add build acrn in docker tutorial
Add a tutorial about how to build acrn in docker.

Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-12 10:36:39 -04:00
lirui34
a95a88c5b2 doc: Remove "or newer/higher" descriptions for other release notes and some tutorials.
ACRN tag is ONLY specific to one Clear Linux version.
For the tutorials, we just need to make sure the validated version is functional.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-11 12:56:42 -04:00
David B. Kinder
5083aba379 doc: review edits for config tool doc
Update material from PR #3559 with review and clarity edits.
Added review comments.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-10 18:21:20 -07:00
lirui34
edbec46dcd doc: Add ACRN configuration tool tutorial
An offline configure tool is designed to configure the BOARD and VM configurations.
Here is the tutorial to tell people how to use it.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-09 11:03:04 -07:00
Victor Sun
1399f47987 doc: update partition desc for up2 board
modify partition desc table of up2 board to make it consistent with
launch uos script.

Signed-off-by: Lei Lu <leix.lu@intel.com>
Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-08-22 09:10:38 +08:00
Deb Taylor
a5647e9edf Content edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-08-14 21:09:49 -07:00
David B. Kinder
9144c56771 doc: incorporate new scenario-based hardware doc
Changing from just describing the supported hardware to a new hardware
support matrix based on the usage scenarios.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-13 18:30:25 -07:00
Lei Lu
bf1a162c3e doc: update Using SBL on UP2 Board
1. The origin clearlinux version 29070 in this doucment example is not
   workable with acrn latest code, update the clearlinux version.
2. Replace the sos_console_login.png with vm_console_login.png

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-08-13 14:30:16 -07:00
Deb Taylor
13de9a4cf6 Formatting for new Hardware Support page 2019-08-09 16:58:20 -07:00
lirui34
70e1e8d154 doc: hybrid mode scenario introduction
Add introduction about how to enable hybrid mode scenario.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-09 16:32:13 -07:00
Li, Fei1
adbaaaf6cb hv: vpci: rename ptdev_config to pci_dev_config
pci_dev_config in VM configure stores all the PCI devices for a VM. Besides PT
devices, there're other type devices, like virtual host bridge. So rename ptdev
to pci_dev for these configure.

Tracked-On: #3475
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-08-06 11:51:02 +08:00
David B. Kinder
70fdde4230 doc: add the SDC2 scenario doc into the navigation
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 17:24:54 -07:00
David B. Kinder
9580a2131b doc: apply edits to SDC2 scenario doc
Update merged PR #3463 with format and wording improvements.
(Not linked yet into the document navigation)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 12:59:00 -07:00
Tonny Tzeng
0ab14fab39 doc: adding guide to launch 2 Linux UOSes using SDC2 scenario
Tracked-On: #3462
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Reviewed-by: Fuzhong Liu <fuzhong.liu@intel.com>
Reviewed-by: Nanlin Xie <nanlin.xie@intel.com>
2019-08-02 10:27:02 -07:00
David B. Kinder
0d07dad5cb doc: additional doc navigation restructuring
Adjust doc navigation organization based on additional feedback.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 21:30:22 -07:00
David B. Kinder
11d4f4159f doc: Reorganize documentation site content
Take the existing ACRN technical documentation and reorganize its
presentation to be persona and use-case based, in preparation for adding
new scenario/use-case based architecture introduction and getting
started documents.

Introduce a more graphical home page and theme color tweaks.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-31 18:29:22 -07:00
lirui34
52618d0a23 doc: Update WaaG tutorial launch script and OVMF binary
Change WaaG launch script to the default ``launch_win.sh``,
and also provide one OVMF.fd binary in order to launch WaaG.
Change SOS / UOS to Service VM / Guest VM.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-31 13:08:05 -07:00
David B. Kinder
8ee1615e51 doc: fix issues from moving tools to misc/tools
PR #3483 cleaned up the project root folder and moved stuff that was in
/tools into a new /misc folder.  There were a few references to
the old /tools folder missed in that update, addressed in this PR.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-29 14:23:04 -07:00