Commit Graph

621 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
Conghui Chen
87558b6f98 doc: remove vuart configuration in nuc and up2
As the vuart config option is not support anymore, remove it.

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
2019-07-19 12:13:11 -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
yunzha4x
be586b4959 doc:Update Getting started guide for Intel NUC
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-07-15 13:46:54 -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
Xiangyang Wu
4c3f298ed6 doc:add more description about application constraints
In the current design guidlines, it is not clear about
how to check application constraints and how to record
them.

Add description about it is optional to do error checking
for application constraints during hypversisor boot time;
Add reference about how to record design assumptions.

Signed-off-by: Xiangyang Wu <xiangyang.wu@linux.intel.com>
2019-07-01 12:15:13 -07:00
David B. Kinder
2376b3af5c doc: update doc version menu
Update the /latest/ (master) version of the docs to provide the menu
choice for the v1.1 release.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-27 14:56:41 -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
5bee933885 doc: Add v1.1 release note
v1.1 release note

Signed-off-by: ruix.li <ruix.li@intel.com>
2019-06-27 14:13:29 -07:00
Kaige Fu
217145e33b Doc: Update acrn-shell.rst for new 'version' cmd
This patch updates acrn-shell.rst for new 'version' cmd.

Tracked-On: #3310
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2019-06-23 21:57:12 -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
Lei Lu
030e7683ad doc: add systemd-networkd-autostart bundle in APL GSG
Clear Linux changed from systemd-networkd to NetworkManager as default
"network manager", We need to install "systemd-networkd-autostart"
bundle to enable systemd-networkd to create ACRN network bridges and Tap
devices.

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-06-17 13:54:02 -07:00
David B. Kinder
86d3065de1 doc: tweak doxygen precondition label
The doxygen-collected API information about function preconditions has a
uninspired title of "pre".  This change tweaks that to be
"preconditions" in the generated HTML output by editing the generated
xml output before it is processed by Sphinx/Breathe.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-17 11:19:44 -07:00
Li, Fei1
9960ff98c5 hv: ept: unify EPT API name to verb-object style
Rename ept_mr_add to ept_add_mr
Rename ept_mr_modify to ept_modify_mr
Rename ept_mr_del to ept_del_mr

Tracked-On: #1842
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2019-06-14 14:40:25 +08:00
David B. Kinder
cf6d6f1678 doc: remove (outdated) primer documents
The ACRN primer has be replaced by an updated set of ACRN High-Level Design
documents.  Remove the primer (and images), and replace a link to the
graphics mediation section (from API documentation) to the corresponding
section in the APL GVT-g document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-13 12:34:11 -07:00
David B. Kinder
c91a54882f doc: improve clarity of build-from-source intro
Rather than have the developer make edits, it was easier to merge
PR #3246 and submit a new PR with improvements.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-12 12:24:44 -07:00
Shiqing Gao
8c70871ff1 doc: add an introduction for building hypervisor
- add an introduction part for building ACRN hypervisor
- clarify why ACRN hypervisor does not support one binary
  for all platforms

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-06-11 17:30:40 -07:00
T
d145ac65a3 doc: fix typo in the "Build ACRN from Source" guide
Fixes a small typo. See also https://github.com/projectacrn/projectacrn.github.io/pull/18

Signed-off-by: shrmrf <shrmrf@users.noreply.github.com>
2019-06-11 09:18:19 -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
Geoffroy Van Cutsem
7c45f3b588 doc: remove 'reboot' command from ACRN shell user guide
The 'reboot' command from the ACRN shell has been removed. Remove the
corresponding documentation from the ACRN Shell user guide.

Tracked-On: #3210
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-06-07 13:19:05 -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
Shiqing Gao
a6bba6bc3d doc: update prefix format in coding guidelines
- update prefix format in coding guidelines

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-06-03 09:01:50 -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
yuhong.tao@intel.com
7f648d75bb Doc: Cleanup vmcfg in user guides
Tracked-On: #3192
Acked-by: Anthony Xu <anthony.xu@intel.com>
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2019-05-29 14:07:45 +08:00
yuhong.tao@intel.com
9aa06c6e86 Doc: Cleanup vmcfg in HLD
Clean vmcfg from doc/developer-guides/hld/hld-devicemodel.rst

Tracked-On: #3192
Acked-by: Anthony Xu <anthony.xu@intel.com>
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2019-05-29 14:07:45 +08:00
Shiqing Gao
b27360fd69 doc: update function naming convention
This patch updates coding guidelines about naming convention.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-05-28 16:13:50 -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
yliu79
8bca0b1ae9 DM: remove unused function mptable_add_oemtbl
Change-Id: Icf92fd5bbbfe935960dc47307822827092a46369
Tracked-On: #3123
Signed-off-by: Ying Liu <ying2.liu@intel.com>
Acked-by: Anthony Xu <anthony.xu@intel.com>
2019-05-24 11:51:00 +08:00
Shiqing Gao
7e52067575 doc: update coding guidelines
This patch updates coding guidelines about legal entity.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-05-23 10:45:07 -07:00
David B. Kinder
cb6a3e8f08 doc: prepare for sphinx 2.0 upgrade
Sphinx 2.0 reports some "expected errors" differently, so add the new
message patterns to our known-errors scanning.

Also, the kerneldoc tool has a problem with sphinx 2.0, but a fix was
available.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-05-22 12:43:11 -07:00
Shiqing Gao
474496fc0e doc: remove hard-coded interfaces in .rst files
This patch removes hard-coded interfaces in .rst files and
refers to the definition via doxygen style comments.

This patch mainly focus on Hypervisor part.
Other parts will be covered in seperate patches.

Tracked-On: #1595
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-05-22 12:40:52 -07:00
Geoffroy Van Cutsem
ffb924542b doc: add note to indicate that vSBL is only supported on APL platforms
Using vSBL is only supported on Apollo Lake (APL) platforms at the
present. It cannot be used on other platforms supported by ACRN such as
KBL. Make this explicit with an additional note in the documentation.

Tracked-On: #2798
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-05-22 12:36:25 -07:00
Geoffroy Van Cutsem
c561f2d626 doc: add <vm_id> parameter to the "vm_console" command description
Add the <vm_id> parameter to the documentation for the ACRN shell
"vm_console" command.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-05-22 11:05:30 -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
yliu79
fe4fcf491f xHV: remove unused function is_dbg_uart_enabled
Change-Id: I64b3e08818f1cb15ec7c41557900d6e462c4e107
Tracked-On: #3123
Signed-off-by: yliu79 <ying2.liu@intel.com>
Reviewed-by: Yin Fengwei <fengwei.yin@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-05-22 16:36:03 +08:00
Binbin Wu
5d19228814 Doc: virtio-blk: add description of boot device option
Add the description of option 'b' to indicate the boot device including
the bootable image.

Tracked-On: #1917
Signed-off-by: Binbin Wu <binbin.wu@intel.com>
2019-05-09 11:51:03 -07:00
ruix.li
c954ec57a0 doc: release note v1.0, correct some words.
Signed-off-by: ruix.li <ruix.li@intel.com>
2019-05-08 22:10:30 -07:00
Shiqing Gao
1f0ccd5f83 doc: add rules in C coding guidelines
This patch adds rules in C coding guidelines for function
naming convention.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-05-08 19:22:45 -07:00
David B. Kinder
5cbaafd717 doc: Update intro to 1.0 release notes
Update the high-level summary.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-05-08 12:16:10 -07:00