Commit Graph

441 Commits

Author SHA1 Message Date
David B. Kinder 331c66bde8 doc: update configuration tool names
PR #6418 renames the board inspector tool cli.py to board_inspector.py
and the configuration tool app.py to acrn_configurator.py

Update the documentation to use these new names.  Note that the ROScube
GSG is validated with ACRN v2.1 and instructs the user to checkout that
branch where the tool is still called app.py

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-19 16:34:08 -07:00
Liu, Hang1 1f5a7e8b8d doc:add more explanation on parameter --windows
acrn-dm --windows parameter is used for specify
the Windows ORACLE virtio device driver,which is
used when enable secure boot in Windows, otherwise
the default REDHAT virtio device driver will be
used which is not certified by Microsoft

Signed-off-by: Liu, Hang1 <hang1.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-12 09:39:00 -07:00
Kunhui-Li e0f4a05df2 doc: update Kconfig related doc
Replace Kconfig related scheduler configuration with scenario XML
file configuration in tutorials because the Kconfig related files
have been removed in the other PR 6358.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-08-09 20:36:01 -07:00
David B. Kinder 1129fe1736 doc: update nested virtualization tutorial notation
Add notation description for VMCSxx introducted in the nested
virtualization tutorial.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-19 18:51:41 -07:00
David B. Kinder 86f9cda177 doc: add enable PTM tutorial
Restore PTM tutorial removed for the 2.5 release (it's tested as
working now)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-16 12:20:26 -07:00
Shuo A Liu 4c9e9b9e4a doc: Change VHM to HSM in documentations
Mainly do the renaming(VHM->HSM) in the Doc.

Tracked-On: #6282
Signed-off-by: Shuo A Liu <shuo.a.liu@intel.com>
2021-07-15 11:53:54 +08:00
David B. Kinder 24b555c75d doc: remove doc dependency on kerneldoc and acrn-kernel repo
We no longer need to generate API documentation for the upstreamed
gvt-g kernel additions so we can remove the doc generation dependency on
the acrn-kernel repo (and all use of the kerneldoc extension). We also
remove GVT-g API documentation and porting guide that are obsolete with
ACRN v2.6 and referenced this API documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-14 18:56:07 -07:00
David B. Kinder 4f0b86adf9 doc: fix doc reference using symbolic link
enable_s5.rst has a couple of literalinclude directives referencing
sample scripts that were moved and now go through a symbolic link to the
new folder.  Symbolic links don't work on Windows, so change the
references in enable_s5.rst to not go through the symbolic link.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-29 19:15:33 -07:00
David B. Kinder b82b8073a9 doc: remove PTM tutorial for now
PTM feature postponed to v2.6 so remove documentation about enabling
this feature.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 18:53:22 -07:00
David B. Kinder e60454f7b7 doc: remove obsolete tar.gz file
Delete a two-year old tar.gz file found in the tutorial folder that's no
longer needed.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 12:23:06 -07:00
Kunhui-Li 25c677dc39 doc: fix documentation's issue
1. Update the necessary libraries to consistent with the "Build ACRN From Source"
document in the "Getting Started Guide" document.
2. Delete the related introduction with acrngt.conf and launch_uos_id1.sh files in
"Getting Started Guide" document.
3. Update WHL-IPC-I7 board's processor in Supported HW document.
4. Add cpu_affinity element's description in ACRN Configuration Data.
5. Update the description for shm_region in Launch XML format.
6. Update configurable/readonly attributes values.
7. Update the description for hv.CAPACITIES.MAX_MSIX_TABLE_NUM in schema/config.xsd.

Tracked-On: #5692
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-06-23 19:25:22 -07:00
Zide Chen 9dc43de733 doc: update nested virtualization user guide
Tracked-On: #5923
Signed-off-by: Zide Chen <zide.chen@intel.com>
2021-06-23 13:43:15 -07:00
David B. Kinder 6cd8bcafdc doc: edit efi-stub tutorial
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-23 09:06:02 -07:00
Nishioka, Toshiki 5fffcdcbd9 doc: add acrn efi-stub user guide
Add user guide for ACRN EFI application for Secure Boot.

Tracked-On: #6078
Signed-off-by: Toshiki Nishioka <toshiki.nishioka@intel.com>
2021-06-23 09:00:32 -07:00
David B. Kinder f3dd19dea7 doc: fix renaming of getting started guide
Tweak references to account for renaming the getting started guide in
PR #6226 and create a redirect link from the previous filename.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-21 13:48:34 -07:00
Kunhui-Li 294f38212e config_tools: clean up the board folders
1. Remove apl-up2, apl-up2-n3350, apl-mrb, nuc6cayh board
   folders from the latest code base.
2. Copy tgl-rvp.xml to generic_board.xml.
3. Update the related documentation because we remove apl-up2,
   apl-up2-n3350, apl-mrb, nuc6cayh board folders.

Tracked-On: #6175

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-06-20 14:36:34 -07:00
Geoffroy Van Cutsem db88a529c5 doc: update the ACRN on QEMU tutorial with latest kernel config
Update the "Enable ACRN Over QEMU/KVM" tutorial:
* Remove the steps explaining how to add the Virtio blk driver
  to the Service VM kernel. It is now part of the default
  configuration
* Add a note to make it more obvious that the tutorial assumes
  that the compilation of ACRN and its kernel is done *inside*
  the QEMU VM that will serve as the Service VM for ACRN

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-06-16 10:46:10 -07:00
David B. Kinder 3a3dbfa08c doc: tweaks to nvmx virtualization doc
Additional clarity and formatting edits to #6198

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-16 10:25:47 -07:00
ZideChen0 e90fd8bc98 Update doc/tutorials/nvmx_virtualization.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-06-16 09:50:12 -07:00
ZideChen0 fee56f15ca Update doc/tutorials/nvmx_virtualization.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-06-16 09:50:12 -07:00
Zide Chen f41cc4ae35 doc: add nested virtualization user guide
Tracked-On: #5923
Signed-off-by: Zide Chen <zide.chen@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-16 09:50:12 -07:00
David B. Kinder 48c5fc5124 doc: update ivshmem user guide
Refine the guide to set up ivshmem for both hv-land and dm-land usage.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-14 14:32:32 -07:00
David B. Kinder 4ea0d49a74 doc: update doc guidlines for ACRN config options
Explain how ACRN configuration options are documented and generated

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Tracked-On: #5911
2021-06-10 19:03:52 -04:00
Yang,Yu-chu 5ec5d9f578 doc: add missing parameters description of launch script xml
Add allow_trigger_s5, enable_ptm, console_vuart and communication_vuart
descriptions.

Tracked-On: #6138
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2021-06-09 17:28:28 -04:00
Kunhui Li 2ce0b38486 doc: update the content about generating board xml
Update the content about getting board xml from native
enviroment in acrn_configuration_tool.rst and README.

Tracked-On: #6134
Signed-off-by: Kunhui Li <kunhuix.li@intel.com>
2021-06-09 17:17:09 -04:00
David B. Kinder 42dc49902b doc: add enabling PTM tutorial and PTM hld discussion
Tracked-On: #5915

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-09 17:10:34 -04:00
Geoffroy Van Cutsem 2ec0ee74e1 doc: update the ACRN on QEMU tutorial to v2.5
Update the "Running ACRN on QEMU" tutorial to be based on ACRN
v2.5 and Ubuntu 20.04.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Co-authored-by: David Kinder <david.b.kinder@intel.com>
2021-06-09 11:37:33 -04:00
Geoffroy Van Cutsem db2e986673 doc: update ACRN version QEMU tutorial
We missed a section during our last update to the QEMU tutorial
that references which version (tag) of ACRN to use.

Tracked-On: #5928
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-05-28 18:25:55 -04:00
Geoffroy Van Cutsem 68e4c66175 Update doc/tutorials/using_hybrid_mode_on_nuc.rst
Co-authored-by: David Kinder <david.b.kinder@intel.com>
2021-05-24 14:06:50 -04:00
Geoffroy Van Cutsem a9c4fb2039 Update doc/tutorials/using_hybrid_mode_on_nuc.rst
Co-authored-by: David Kinder <david.b.kinder@intel.com>
2021-05-24 14:06:50 -04:00
Geoffroy Van Cutsem d7c29968f0 doc: add more details to GSG for the hybrid scenario
Add a number of steps and details that were not called
out in the "Getting Started Guide for ACRN Hybrid Mode". Those
are not obvious to the first-time or novice user so the user
guide was hard to follow and confusing. At a high-level:
* How to build Zephyr
* How to install ACRN
* How to install the ACRN kernel

The hybrid scenario overview diagram has been updated too.

Tracked-On: #5992
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-05-24 14:06:50 -04:00
Peter Fang b068656e71 doc: add documentation for allow_trigger_s5 in pm_notify_channel
Tracked-On: #6034
Signed-off-by: Peter Fang <peter.fang@intel.com>
2021-05-21 12:08:24 -04:00
David B. Kinder b8ef1a87be doc: fix indenting issues in tutorial
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-05-20 17:18:44 -04:00
Benjamin Fitch c0fef0b1fb doc: editing in using_serial_port.rst
Signed-off-by: Benjamin Fitch <benjamin.fitch@intel.com>
2021-05-18 15:49:33 -07:00
fuzhongl d8443bedb0 Doc: update using serial port
Add PCIe serial port enabling part on NUC; which doesn't
have the internal serial console header.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2021-05-18 11:38:56 -07:00
Kunhui Li 15a9b854a6 doc: update ACRN qemu HV tag to v2.0
1. Add whitespace in the string "ubuntu18.04";
2. Update the Kernel version;
3. Update ACRN qemu HV tag format and add a note.

Tracked-On: #5928
Signed-off-by: Kunhui Li <kunhuix.li@intel.com>
2021-05-10 15:36:01 -07:00
David B. Kinder 4c676acb9b doc: fix missing codeblock directive
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-05-02 17:20:13 -07:00
David B. Kinder 82e3d8341c doc: fix malformed code block in acrn config docs
Fix incorrect code-block notation and code-block language

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-04-27 20:13:12 -07:00
David B. Kinder 0e317d56bf doc: clean up PDF generation for ACRN docs
PRs #5945 and #5949 introduced fixes to the doc building process to
support PDF generation of the documentation set.  This PR refines the
doc build process, cleaning up the Makefile, adding display of tool
version information, and updates the doc building documentation to
include additional dependencies needed for building the PDF and
instructions for how to build the PDF.  The latexpdf make target is
provided to just run the latex and PDF producing process that depends on
the HTML artifacts from a make html run.  A new make pdf target is
provided that combines the two steps into one.

A new know-issues pattern file is added that verifies the expected
output from the latexpdf process is returned, as it can't be completely
eliminated without losing potential error messages that need to be
resolved.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-04-26 19:50:44 -07:00
David B. Kinder f596b6df13 doc: tweaks for latexpdf build
Update missing captions on figures to remove remaining broken references
during latexpdf building.  Also, require doing a "make html" before
doing a "make latexpdf" to build all the artifacts needed for running
the latexpdf build.  (We might change that later if needed.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-04-22 11:12:07 -07:00
David B. Kinder b8e0ef3240 doc: update doc build instructions
We've validated doc build tool versions, so let's make sure those are
the versions the instructions say to install.  The version of doxygen
you get when you use ``sudo apt install doxygen`` may get a newer
version that may still work so let's tell them that.

Also, we no longer use kconfig files in the document build process, so
remove mentioning that in the build documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-04-13 14:21:05 -07:00
David B. Kinder 6d801d1740 doc: remove obsolete .txt file
The ACRN configuration option details are no longer maintained in a
checked-in document.  Instead they are generated during the
``make html`` from information in the schema .xsd files.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-04-08 08:17:17 -07:00
fuzhongl 377694682d Doc: Update Launch Windows as the Guest VM
To keep align with script, change Windows10.iso and winvirtio.iso image relative paths to full paths.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2021-04-01 11:02:22 -07:00
Yonghua Huang ebeb064d49 doc: update 'enable secure boot in windows'
- use one command to generate x509 cert file,
   remove the intermediate file.

 - remove the "Keycontainer" field in INF file,
   which is not mandatory.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2021-03-30 13:11:40 -07:00
li shuang f583af3747 DOC: Update-GSG-rt_industry_ubuntu
Remove the Power Management ('pm') parameters from the sample launch scripts,
and update the comments, At most one VM is allowed to use "--pm_notify_channel uart"
at a time, since only one socket connection to SOS life_mngr is allowed.
Remove it by default and allow user to add on demand
rt_industry_ubuntu.rst
enable_s5.rst

Signed-off-by: li shuang <shuangx.li@intel.com>
2021-03-29 19:47:56 -07:00
fuzhongl f94a43f98e Doc: Launch Windows as the Guest VM
Part of unsupported parameters for the latest ACRN-DM code are removed.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2021-03-29 19:45:34 -07:00
Geoffroy Van Cutsem 4e8ccd166f doc: create a copy of the scenario file before making modifications
Instruct the user to create a copy of the scenario XML file if modifications
are needed. That modified copy should subsequently be used for building ACRN.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-03-29 17:07:50 -07:00
guoqingxz 725f525f9f Update doc/tutorials/using_partition_mode_on_nuc.rst
Co-authored-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-03-29 17:07:50 -07:00
guoqingxz 682ffb5234 doc: update doc for hybrid and logical_partition mode:
using_hybrid_mode_on_nuc.rst
     using_partition_mode_on_nuc.rst

Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
2021-03-29 17:07:50 -07:00
Junjie Mao 7fed0b839f doc: add summary of config changes and upgrading guides
v2:
 * Add the complete instructions to upgrade Python
 * Add libxml2-utils as another additional tool required for building v2.4
 * Random typo fixes

Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Signed-off-by: Benjamin Fitch <benjamin.fitch@intel.com>
2021-03-29 11:42:52 -07:00