Commit Graph

169 Commits

Author SHA1 Message Date
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
David B. Kinder
e2cb6acba6 doc: add Trusty ACRN doc
Add the Trusty and Security Services in ACRN tutorial

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-30 16:18:09 -08:00
David B. Kinder
9c3c316f79 doc: add rt-linux tutorial
update tutorials with Using RT-Linux for real-time UOS

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-30 16:09:04 -08:00
David B. Kinder
0881bae738 doc: fix correct use of Clear Linux OS
Proper use of the Clear Linux name is with a noun, specifically "OS".
Also fixed some grammar edits along the way.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-30 15:17:33 -08:00
David B. Kinder
bb8f539017 doc: add AGL as VMs on ACRN doc
Add a tutorial explaining how to set up a demo using AGL as UOSes as
used in a CES automotive demo.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-23 22:28:57 -08:00
wenlingz
34b4294334 Doc: Update GSG for v0.5 version and launch and acrn.conf sample script
modify sbl_up2 version and scripts
2019-01-16 16:28:26 +08:00
Xie Zhengtian
623a91e58f doc: update the statement of "tag" 2019-01-10 17:09:17 -08:00
root
3bb791a633 doc: add 'checkout to release v0.5' 2019-01-10 17:09:17 -08:00
Xie Zhengtian
6d306c30d1 doc: modify the directories of files needed 2019-01-10 17:09:17 -08:00
root
f0f943bd9e doc: Update the steps for generating 'partition_desc.bin' 2019-01-10 17:09:17 -08:00
David B. Kinder
158ba62c33 doc: update SKL NUC patch download instructions
Include a line of script that download and untars the patch files

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-09 10:50:59 -08:00
David B. Kinder
7f9779b736 doc: add skylake NUC w/GPU passthrough doc
Document a community reference release for the Skylake NUC with GPU
passthrough as a one-time snapshot release, not supported or
maintained.  Includes a tar patch file.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-09 09:45:06 -08:00
David B. Kinder
4c541ba18c doc: spell check and formatting
Fix misspellings missed during regular reviews, and remove trailing
white space and Windows \r at end of lines.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-07 13:28:45 -08:00
root
fad44184a5 doc: Descriptions about Dupont Wire used added 2019-01-07 11:56:01 -08:00
root
7f00e26021 doc: license header updated 2019-01-07 11:56:01 -08:00
root
10566e01b9 doc: update the statement 2019-01-07 11:56:01 -08:00
root
e6d8ab2460 doc: update launch_uos.sh 2019-01-07 11:56:01 -08:00
root
6f1defcb31 doc: update the doc 2019-01-07 11:56:01 -08:00
Geoffroy Van Cutsem
9c97f6bec5 Documentation: split the build instructions into its own guide
Split the build instructions, and the hypervisor configuration instructions
into its own separate document.

Tracked-On: #2154
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-12-21 10:01:13 -08:00
Geoffroy Van Cutsem
01bc8e56f2 Documentation: fix formatting in partition mode tutorial
Fix the indentation to make a line part of the correct
paragraph (instead of having it erroneously displayed as
part of the previous code-block)

Tracked-On: #2031
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-12-21 08:46:27 -08:00
Minggui Cao
61f03dae81 DOC: change PCI uart description from mmio to bdf
HV code changed to configure PCI uart mmio@ to bdf@,
so change its description to match it.

Tracked-On: #2031
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2018-12-20 11:53:13 -08:00
Xie Zhengtian
302494cb80 doc: update some statements 2018-12-13 08:52:56 -08:00
Xie Zhengtian
07309fdc55 doc: update some statements 2018-12-13 08:52:56 -08:00
Xie Zhengtian
40f375b421 Doc: modify the note of UOS kernel modules 2018-12-13 08:52:56 -08:00
Xie Zhengtian
2d9e478c91 Doc: delete the step of downloading UOS's kernel 2018-12-13 08:52:56 -08:00
Xie Zhengtian
c3a4a5d44d Doc: add "$" for code 2018-12-13 08:52:56 -08:00
Xie Zhengtian
d56e2c29e0 Doc: update the steps 2018-12-13 08:52:56 -08:00
Xie Zhengtian
2be939f3d1 Doc: add "Deploy the UOS kernel modules for AGL" 2018-12-13 08:52:56 -08:00
Xie Zhengtian
73161f910f Update using_agl_as_uos.rst 2018-12-13 08:52:56 -08:00
Xie Zhengtian
c51394c39d doc: update the doc of AGL as UOS 2018-12-13 08:52:56 -08:00
coneypo
e574879501 doc: update the doc of using AGL as UOS 2018-12-13 08:52:56 -08:00
Xie Zhengtian
97c956977b doc: update code to "losetup -r" 2018-12-12 07:07:09 -08:00
Xie Zhengtian
4355b0dfe1 doc: update some statements 2018-12-12 07:07:09 -08:00
Xie Zhengtian
ad1ba2252f doc: update some statements 2018-12-12 07:07:09 -08:00
Xie Zhengtian
6bfbf1663a Doc: Update some statements 2018-12-12 07:07:09 -08:00
Xie Zhengtian
85b3068569 Doc: define swap partition with 1G 2018-12-12 07:07:09 -08:00
Xie Zhengtian
fae136c259 doc: remove "software-defined-cockpit" 2018-12-12 07:07:09 -08:00
Xie Zhengtian
33b8706452 Doc: Update the doc of "Build UOS from ClearLinux" 2018-12-12 07:07:09 -08:00
Xie Zhengtian
8b83caddb6 doc: update the layout of the doc 2018-12-12 07:07:09 -08:00
coneypo
71bf586e7a doc: upload tutorial of 'Build UOS from Clear Linux' 2018-12-12 07:07:09 -08:00
David B. Kinder
fe1ace4f56 doc: fix doc misspellings
Fix documentation misspellings missed during the regular review.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-05 17:07:39 -08:00
Xie Zhengtian
3b54dd2abd doc: add some "sudo" for code 2018-12-03 20:48:10 -08:00
Xie Zhengtian
945fdd8a4a doc: update the directory to "~/" 2018-12-03 20:48:10 -08:00
Xie Zhengtian
0ff74b1367 doc: delete "install build tool" about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
1a959d0f54 doc: Update note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
e2e9a3e9b9 doc: Add the note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
1052242319 doc: add note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
099c605eda doc: Modify to "/boot/efi"
1. No more mount needed, use the directory "/boot/efi"
2. The kernel of UOS stored in "~/uos-kernel-build"
3. (Pending) the image of UOS stored in "~/" or "/root"
2018-12-03 20:48:10 -08:00
Xie Zhengtian
ceed310661 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian
b1db77eb81 doc: Update the grub part and add code for NVMe 2018-12-03 20:48:10 -08:00
Xie Zhengtian
4b2e7f1123 Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
be70145f4c Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
96a2946d72 Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
6c8c46af8f delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
ce89d26e76 Delete using_AGL_as_uos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian
3d96e35643 Rename using_AGL_as_uos to using_AGL_as_uos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian
90c27157e4 Create using AGL as UOS 2018-12-03 20:48:10 -08:00
Xie Zhengtian
2bc24f8789 Upload the images for "using_AGL_as_uos" 2018-12-03 20:48:10 -08:00
coneypo
12e66b989a Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
ecff0bf9e8 Update the layout of packages 2018-12-03 20:48:10 -08:00
coneypo
50f1783200 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
1afb0f13c4 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
06b2ab55e3 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
e4941b2225 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
65f21a77e2 Update the version of Ubuntu to 18.04 2018-12-03 20:48:10 -08:00
coneypo
abfa1c1644 update the length of * 2018-12-03 20:48:10 -08:00
coneypo
1664ba5fa7 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
f3527c638c Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
e4b616d5fd Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
ab005bc8a8 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
2d685a13ee Update with Clear Linux 26440 2018-12-03 20:48:10 -08:00