Commit Graph

139 Commits

Author SHA1 Message Date
Lei Lu
0887eecde8 doc: remove deprecated sos_bootargs
SOS bootargs is specified in vm_configurations.h in different scenarios.
  The files in devicemodel/samples/<board>/sos_bootargs_*.txt are removed.
  remove deprecated sos_bootargs in create-up2-images.sh

Tracked-On: #3443

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-07-23 17:41:29 -07:00
yunzha4x
2e79501e4d doc:udpate using_partition_mode_on_nuc nuc7i7bnh to nuc7i7dnb
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-07-23 09:46:09 -07:00
lirui34
e729b657c0 doc: Add ACRN tag or Clear Linux version info for some tutorials
Neither ACRN tag nor Clear Linux version is specified in some tutorials.
Declare those information for those tutorials.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-19 12:12:23 -07:00
lirui34
ffa7f80544 doc: Add tutorial to learn to sign binaries of a Clear Linux image.
This tutorial will describe steps to sign binaries of
a Clear Linux image that allows user to launch VM
throught the secure boot enabled OVMF.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-19 12:10:23 -07:00
David B. Kinder
be44e138fd doc: update WaaG doc
Update batch script documentation and add reference to source of
material.  Also some grammar cleanup in a few places.

Include an updated install_by_vga_gsg.tar.gz with an updated script with
copyright/licensing added.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-19 12:09:08 -07:00
David B. Kinder
ecc472f9b4 doc: fix format in WaaG document
Update WaaG document with Windows (upper case) and step numbering.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-17 09:35:32 -07:00
ruix.li
7990f52f59 doc: Add introduction of using Windows Guest OS
Add introduction of using Windows Guest OS

Tracked-On: #3341
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-17 09:10:10 -07:00
ruix.li
1aef5290ea doc: Add platform sos info and GUI screenshots against Celadon Guest OS
Add sos info and Celadon OS GUI screenshots for the Celadon UOS tutorial.

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-10 20:10:16 -07:00
David B. Kinder
44fc5fcbf0 doc: fix typos in rtvm workload design doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-09 17:28:29 -07:00
Jason Chen CJ
503b71a16e doc: add guideline for RTVM workload design
a quick guideline document help RTOS designer/developer to design
RT workload based on RTVM

Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-07-09 17:25:30 -07:00
ruix.li
93659f0160 doc: Add introduction of launching Celadon User OS
Add introduction of launching Celadon User OS

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-07-09 15:48:16 -07:00
ruix.li
680edd1d3c doc: Update acrn-manager README and QoS introduction
Modify 'launch_UOS.sh' to 'launch_uos.sh' and provide an example for
the script which is support '-C' option.

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-27 14:41:06 -07:00
ruix.li
f145cd490c doc: Instruction of enabling ACRN-DM QoS.
Add instruction of enabling ACRN-DM QoS based on runC container.

Tracked-On: #3131
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-19 09:34:08 -07:00
Victor Sun
e5a25749e5 doc: add multiboot module string parameter
The multiboot module string will be used to identify the usage of current
module, it must exactly match with "kernel_mod_tag" which configured in
VM configurations files;

Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-06-10 16:30:25 -07:00
Li, Wilson
115ba0e390 Added recommended BIOS settings for better real-time performance.
Signed-off-by: Li, Wilson <wilson.li@intel.com>
2019-06-08 05:57:23 -07:00
David B. Kinder
475b05da54 doc: fix formatting in partition doc
Fix formatting missed during regular review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-03 09:28:16 -07:00
Lei Lu
76346fd2b1 doc: setup logical partition scenario on nuc
This patch adds tutorial about how to setup logical partition scenario
on nuc

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-06-03 09:23:56 -07:00
ruix.li
6f61aa7d41 doc: add instruction of Open vSwitch
Add instruction to show user how to enable Open vSwitch on ACRN.

Tracked-On: #3132
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-03 09:03:06 -07:00
Zhang, Yun
011134d5da doc: Update Using PREEMPT_RT-Linux for real-time UOS
Signed-off-by: Zhang, Yun <yunx.zhang@intel.com>
2019-05-31 16:12:08 -07:00
Kaige Fu
26c7e372b1 Doc: Add tutorial about using VxWorks as uos
This patch adds tutorial about using VxWorks as guest.

Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-05-24 08:59:05 -07:00
ruix.li
214eb5e96b doc: Update clearlinux os installation guide link.
bare-metal-install is replaced with bare-metal-install-server.

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-05-22 11:04:41 -07:00
ruix.li
6b93de7438 doc: Add v1.0 release note
v1.0 release note

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-05-06 20:55:56 -07:00
Li, Wilson
e8242a797b Updated GSG of using RT Linux as RTVM in accordance with acrn-kernel v4.19.28
Signed-off-by: Li, Wilson <wilson.li@intel.com>
2019-05-01 11:24:52 -07:00
Geoffroy Van Cutsem
ee4e46cd07 doc: update "Using PREEMPT_RT-Linux for real-time UOS" to use RTVM term
Update the architectural diagram in the "Using PREEMPT_RT-Linux for
real-time UOS" tutorial to reflect the new name given to that type of
VM, i.e. from "Privileged VM" to "RTVM".

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-04-30 22:37:12 -07:00
Conghui Chen
af0b16e1a8 DOC: change hv shell cmd sos_console to vm_console
Change shell command 'sos_console' to 'vm_console' as it is not only
used to switch console to SOS.

Tracked-On: #2987
Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-04-29 15:14:59 -07:00
David B. Kinder
e7605fad7d doc: fix misspellings
Fix misspellings missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-11 15:45:41 -07:00
Geoffroy Van Cutsem
435b29af5f doc: update documentation to the latest TAP name (no acrn_ prefix)
Update the documentation, and associated scripts to reflect the fact
that the TAP device used by 'acrn-dm' no longer use the "acrn_" prefix.

Tracked-On: #2509
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-04-09 11:21:00 -07:00
Geoffroy Van Cutsem
a459ac97f8 doc: update the "ACRN Debugging Tools" tutorial
Update the "ACRN Debugging Tools" tutorial:
* Remove sections on how to build and install the hypervisor, refer to the
  corresponding user guides instead
* Simplify the flow for checking loglevel (console and mem)
* Add a little text to improve readability

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-04-09 11:18:27 -07:00
David B. Kinder
17b2a72555 doc: add the ACRN debug tutorial document
Add a new debugging tutorial and update the acrn_shell documentation
with additional details.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-08 20:01:16 -07:00
Tw
46e7fa8cf2 doc: minor changes according to one binary for SBL and UEFI
PLATFORM=xxx is no longer supported, use BOARD instead.

Tracked-On: #2708
Signed-off-by: Tw <wei.tan@intel.com>
2019-04-01 14:39:52 -07:00
yuhong.tao@intel.com
01b28c8e03 doc: Add tutorial about how to use CAT on UP2
Tracked-On: #2462
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2019-03-30 12:58:59 -04:00
Geoffroy Van Cutsem
d4ce780ec0 doc: update the instructions to increase the size of a UOS disk image
Update the instructions on how to increase the size of a UOS disk image so that
the entire operation can be performed on the development host. This has the
advantage that it can be done completely offline (the UOS must be powered off
in fact) and no extra tools need to be installed in the UOS to do this.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-03-22 10:18:34 -04:00
Lei Lu
fddc5b9154 doc: update UP2 sample directory name in create-up2-image.sh
Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-03-22 10:14:07 -04:00
Kaige Fu
f97ba34024 Doc: Add tutorial about using zephyr as uos
This patch add tutorial about using zephyr as guest.

Tracked-On: #2713
Signed-off-by: Kaige Fu <kaige.fu@intel.com>

---
v3 -> v4:
  - Addressed two minor comments from David

v2 -> v3:
  - Detail section `Build Zephyr`
  - Add missing sudo
  - Automatically boot zephyr
  - Other grammar, phrasing fix

v1 -> v2:
  - NUC7i5DNH -> NUC7i5DNHE.
  - Add note about doc to build acrn supported zephyr image.
  - Refine section `Boot Zephyr as User OS`.
  - Some minor fix.
2019-03-20 11:05:14 -04:00
Geoffroy Van Cutsem
5fdc7969fd doc: add tutorial on how to increase the UOS disk size
Add a tutorial on how to increase the disk size of a User OS (UOS)
based on Clear Linux. The tutorial is largely inspired from Clear Linux
tutorial and refers to it. It mostly explains how to resize the .img
file using the 'qemu-img' tool since ACRN does not have any dedicated
tool for manipulating virtual disk image files.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Co-Authored-By: David B. Kinder <david.b.kinder@intel.com>
2019-03-19 09:36:39 -04:00
David B. Kinder
e9335fcee6 doc: fix utf-8 punctuation, branding, spelling
Fix some stray UTF-8 punctuation and symbol characters, unnecessary
trademark symbols, and some misspellings missed during regular reviews.

Tracked-On: #2712

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-14 09:13:58 -07:00
Tonny Tzeng
e779982c6f doc: use the new board name for UP2 in create-up2-images.sh script
The board name for building images for UP2 has been changed from 'up2' to 'apl-up2' by the commit #f9b5e21.

Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
2019-03-07 22:04:04 -08:00
David B. Kinder
ff9ef2a19d doc: fix broken external links
Found some broken links to external sites in the documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-07 15:52:39 -08:00
David B. Kinder
ae34fdd843 doc: fix misspellings
Fix misspellings missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-27 13:45:45 -08:00
David B. Kinder
fb92d55bb5 doc: fix formatting of up2 doc
Update doc to remove trailing spaces on lines, wrap long lines, add
formatting missed during regular review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-22 11:29:58 +08:00
Victor Sun
4928be5f8b doc: update partition mode config on up2
Update the using_partition_mode_on_up2.rst to accormodate the latest
configuration method for up2 partition mode.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-02-21 09:24:08 -08:00
Geoffroy Van Cutsem
2638518349 acrn.conf: clean-up SOS kernel options (EFI platforms)
- Remove some i915 options that are obsolete and irrelevant for the
Service OS kernel
- Update the various tutorials that also used these obsolete parameters

Tracked-On: #2518
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-02-20 13:21:11 +08:00
wenlingz
ee35703750 use weston instead of ias by bundle add x11-server 2019-02-14 09:55:20 -08:00
David B. Kinder
00b1df6384 doc: fix typo in using_sbl doc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-11 21:08:22 -08:00
minxia.wang
39df560a1c modify create up2 image for changing uos default bootargs 2019-02-11 21:04:26 -08:00
wenlingz
66d9f913e5 add build option on the using_sbl_on_up2.rst 2019-02-11 20:58:12 -08:00
Geoffroy Van Cutsem
5c9f1662db Documentation: add caption to the "PREEMPT_RT VM on ACRN" figure
Add a caption to the figure describing the Real-Time Linux VM running
on ACRN. Without this text, the HTML output does not add the Figure
number below it. That figure number is still used in the paragraph
making it hard for the reader to understand which figure is really
referenced (except by clicking on the hyperlink)

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-01-31 08:47:46 -08:00
David B. Kinder
ea250c5147 doc: fixes to rt-linux tutorial
Fix a typo in the doc and add some formatting.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-30 21:48:52 -08:00
acrn si
1a4a1c3045 Need to delete '# CONFIG_BLK_DEV_NVME is not set' to enable NVME driver 2019-01-30 21:43:24 -08:00
wenlingz
37ce259fb9 modify create-up2-images scripts 2019-01-30 21:28:04 -08:00