Previously the sample apps needed to be run as root, but with a recent
update they could be run as a normal (acrn) user. Update the sample app
to use sudo for running these sample app components in case the user
doesn't login as root. Also, split running the background app and the
foreground app into two commands to eliminate some confusion.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.
Also add a mention of the sample app guide at the end of the GSG.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Address comments from DX reviews, and update the cyclictest histogram
output (improvements from PR #8026)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The Getting Started Guide specifies that we need to install the Python packages lxml, xmlschema, and defusedxml.
However, a make clean involves the execution of the Python script manager.py. This script imports the package requests.py, which might not be installed if the developer follows the Getting Started Guide.
Add requests follow this command in GSG.
sudo pip3 install "elementpath==2.5.0" lxml "xmlschema==1.9.2" defusedxml tqdm requests
[External_System_ID] ACRN-9144
Tracked-On: #8029
Signed-off-by: Zhang Wei <wei6.zhang@intel.com>
* Fix preempt-rt patched kernel label on wrong VM
* Fix path copying hmi_vm.img and rt_vm.img (they're not in ~/acrn-work
directory)
* Rename png images to avoid potential conflicts with other images on the
system.
* Fix Ubuntu wecome message text after logging into RT_VM
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1. Add the move iasl binary to the /usr/sbin directory.
2. Modify login RT_VM user to root user.
Signed-off-by: Liu Long <long.liu@linux.intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
After review with engineering, we added material for showing what a
successful hmi_vm.img build ending looks like (and a hint of what to do
if it looks like the build failed. Also added using a dhclient commmand
to the instructions in case the HMI_VM didn't get an IP address.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
GSG was recently updated to use a requirements.txt for python
dependencies, but that file doesn't exist in the repo at the v3.0 tag
the instructions say to use. Revert to not use a requirements.txt until
we get this figured out.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Edits preparing for using a requirements.txt introduced an error in the
step order (using a directory before it was created).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The new acrn-kernel for v3.1 expects gelf.h that's installed with the libelf-dev
package that's not listed as a dependency in the GSG. Without this
package, building acrn-kernel fails.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update Getting Started Guide to clarify and improve descriptions of
steps, including adding example commands instead of just describing
them, adding more information about system requirements, making certain
steps explicit, squash the long list of packages to install into fewer
lines, and more.
Move cloning ACRN hypervisor and kernel earlier in the instructions
(anticipating use of a requirements.txt coming from the repo).
[External_System_ID] ACRN-9285
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
ACRN hypervisor shell has been improved to be bash-like shell, so update
its usage
Tracked-On: #7931
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
While we're waiting for a more complete list of specific package version
requirements, let's fix the xmlschema and elementpath version mismatch
now.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Updated the description of Security VM Features per review comments, and
made the option visible (again) in the configurator as an advanced
hypervisor option.
Created a new glossary entry for "Security VM", referenced by this new
description and tooltip.
Tweak wording of virtio console and input device descriptions.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Tracked-On: #7968
Remind readers that internet access from a corporate network typically
requires configuring proxy information.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
In the "Enable ACRN Secure Boot With EFI-Stub" guide, to build EFI-Stub
smoothly, the installation of "gnu-efi" package is added to GSG.
Tracked-On: #7935
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
Clarify description of CVE fix (only impacts ACRN implementation on
Alder Lake platforms), and improve description of the ACRN shell's new
vmexit command.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update security advisory for release_3.0.1
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
We aluready updated the GSG to discuss how to find and address errors
when using the configurator (specifically doing a save scenario to check
for errors or to verify all errors were resolved). Add a description of
this error interaction model to the configurator tool documentation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Documentation for the sample app isn't ready for the public, so let's
not add it to the toctree yet (use the :orphan: role to stop Sphinx from
complaining about an unreferenced .rst file)
Tracked-On: #7820
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add the ACRN Sample App document (README.rst) to the toctree
Convert the README.rst from Dos to Unix text file format
Tracked-On: #7820
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Explain that consistency and validation checks of the schema are done
when a schema is imported/created or when it's saved, and after you
resolve any errors, you need to save the scenario to force another
schema validation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The current code assign COM2 to S5 feature as a commutation vUART, so
the COM2's IO port which value is 0x2F8 could not assign to another
vUART connection.
This patch add a note and modify the legacy vUART sample, change the
default IO port to 0x3E8 which was known as COM3.
Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
Modified the copyright year range in code, and corrected "int32_tel"
into "Intel" in two "hypervisor/include/debug/profiling.h" and
"hypervisor/include/debug/profiling_internal.h".
Tracked-On: #7559
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
This patch updates the documentation according to the refinement on
the detection and the version verification of "iasl".
Tracked-On: #7880
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
Adjusted the order of <your scenario xml> and
--launch <your launch xml> when merged data from
the launch XML to the scenario XML.
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
You need to be in the acrn-kernel directory in order to ``run make
distclean`` Also, remove mention of 6 VMs ...
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1. add link for ACRN configurator
2. update deb name.
3. update the patch of launch script.
4. update Python package dependencies.
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Update the Service VM rootfs to Ubuntu 20.04
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com
* Merge RDT and vCAT tutorials
* Update overview, dependencies and constraints
* Update to match Configurator UI instead of manually editing XML files
* Remove architectural details and instead point to high-level design documentation
Tracked-On: #6081
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
- The release v3.0 ACRN Configurator has an issue where you need to save the configuration twice to see the generated I/O or BDF address.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
Create a new User VM OS guide with overview information about setting up
User VMs. Link to separate standard and RTVM guide for details. Most of
these separate guides need updating to reflect the new ACRN configurator and
the development system/target system development model.
Update titles of existing "using XXX as user vm" to be consistent.
Begin update of ubuntu uservm doc for direction review.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
What is ACRN introduction dives from the high level architecture
directly into the device model and device passthrough information. It
gets pretty deep relatively quickly. Move the Static Configuration Based
on Scenarios section came earlier in the document.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
below parameters are obsolete, reserve the code for potential use
but remove the description in document.
amd_hostbridge
virtio-ipu
virtio-hyper_dmabuf
virtio-audio
Tracked-On: #6690
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
Add launch script document so that customers could understand how an
User VM is launched by ACRN Device Model.
As launch script is a user friendly tool to set Device Model parameters,
append the contents to Device Model Parameters chapter.
Tracked-On: #7801
Signed-off-by: Qiang Zhang <qiang4.zhang@linux.intel.com>
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
- Regarding post-launched VMs, update the messaging about static vs. dynamic. Dynamic is more about creating a VM at runtime per PR 7802, not changing the configuration of an existing VM at runtime.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
Add v3.0 support for TGL Vecow system, starting at the maintenance level
of support. Transition NUC11TNHi5 from maintenance to community level
support for v3.0. Maintain all other boards at community level support.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Add Configurator Debian package build steps that were removed from GSG
- Add description of error icon on parameters tabs
- Mention that working folder name should be meaningful
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
systemctl won't run as a normal Linux user, requires sudo
Also augment the description information
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Update Configurator UI steps
- Emphasize connecting USB devices
- Use release_3.0 branch until tag is created
- Fix typos
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
"systemd-networkd" is required for acrn-dm to create bridge device.
Document it in GSG before acrn network deb package is ready.
Tracked-On: #7738
Signed-off-by: Qiang Zhang <qiang4.zhang@intel.com>
Merge python packages list into one 'requirements.txt'.
And modify related document.
Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
For config_tools use python to clear dirty files, add python dependence
while prepare development computer.
Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
Add a configuration parameter for the xsltproc processing to decide
whether to include hidden options.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Removing Launch Configuation Options doc because all the launch script options are part of the new combined scenario XML and covered in Scenario Configuration Options doc.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
The "make pdf" processing doesn't handle .svg files that were introduced
for the config option documentation. Change these images to .png
instead.
The "make pdf" processing tools produce slightly different log output.
Tweak the "known issue" processing script (that removes messages from
the sphinx_build output for known issues that we can safely ignore.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix how the config option doc scripts behave when encountering elements
with blank titles (used to remove extraneous headings in the
configurator UI).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The acrn:views processing for showing which tabs an option would display
on wasn't quite right when an element AND a parent both had a views
attribute (specifically when the parent had "basic, advanced" but the
element only had "basic" or "advanced").
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Edit the schema (.xsd) files to modify the order options are presented.
None of these changes invalidate existing scenario XML files, as they
only reorder elements within the existing parent element, or tweak the
acrn:views, acrn:title, or documentation content.
Move simple type elements before complex type options (under the same
parent element) to avoid the confusion where options look like they're
part of a section based on the title that's added before complex typed
options but not simple typed options.
* add acrn:title to pcpu (pCPU list)
* change documentation for binary option saying "checked" instead of 'y'
* move HYPERV_ENABLED before RDT (simple type before complex type)
* move vuart_connections before FEATURES
* move name before vm_type
* move console_vuart, os_type, vuart0, vbootloader, usb_xhci before
lapic_passthrough
* add acrn:title to epc_section
* add acrn:title to memory
* move gpu to top of virtio_devices (simple type before completx type)
Tracked-On: #5692
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The configurator today shows "Please Input" as the placeholder of input
widgets, which is far from informative.
This patch specifies element or type specific placeholders in the XML
schema by reusing the `acrn:widget-options` annotation mechanism. For
manually-designed widgets such as ivshmem or vUART the placeholders are
added in the corresponding vue directly.
Tracked-On: #6691
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
remove configurator in misc/config_tools/config_app, since
there is new configurator in misc/config_tools/configurator.
remove related document.
Tracked-On: #7466
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
The current code need python3.8-venv to build some modules, so we
should add these requirement to "Getting Started Guide".
This patch modify the getting-started.rst to generate new guide.
Signed-off-by: Chenli Wei <chenli.wei@intel.com>
We removed some documentation from the table of contents but left them
around in the published documentation. All of these documents are
obsolete and haven't been updated since they were last validated on
earlier versions of ACRN. (They all can still be referenced in the
older version archives if needed.)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Reduce expression complexity when searching for applicable-vms and views
annotations and increase ancestor search distance.
Don't sort glossary options to more closely mimic order found in the
configurator.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
When an element in the schema does not have an acrn:applicable-vms or
acrn:views (as opposed to having the attribute with an empty value,
acrn:views="") we need to look up the ancestors to see if any of them
have an element with such an attribute defined. If non of the ancestors
have that attribute defined, then the intrepretation is that the element
can be found for all VMs or for both basic and advanced tabs.
Tweak the xslt processing of the schema data to option config doc to
reflect these semantics.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Change the generated config option documentation to use the DX-friendly
names defined for the configurator UI (instead of the XML element name
hierarchy previously used).
Options are grouped by the top-level section (aka complex type) they
belong to and then sorted alphabetically with these groups.
Use badges to indicate where options can be found in the configurator UI
and whether they're applicable to the Hypervisor or Pre/Post/Service VM.
Add a custom css style for the config-option doc that puts the first
paragraph of a glossary item on the same line as the glossary term so
these badges look pretty.
Added a acrn-custom.js patch that copies the alt text for images into a
title property for images within the config-doc document. This provides
tooltip text when hovering over the badges.
Don't display options not visible in the configurator UI (elements with
acrn:views="").
A missing acrn:views or acrn:applicable-vm means we look for an
applicable value from an ancestor element.
Add processing of a second xs:documentation element within an
xs:annotation element. This second documentation element's content will
be appended as a new paragraph to the first xs:documentation content in
the generated documentation. Only the first xs:documentation element is
used by the Configurator for its tooltips.
Update documents that were referring to options by their XML names.
Because we're now using a glossary to provide links to config options,
we can't duplicate option names or glosary names anywhere in the doc
set.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The read-the-docs theme uses a reduced font size within tables. The CSS
used though is overly restrictive and doesn't properly handle tables
containing lists or other constructs where the paragraph tags don't have
the <td> tag within the table as the immediate parent. Add an
overriding style in our custom CSS to fix this so the font size on lists
within a table are the same as normal paragraphs within a table.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Many of the license and Intel copyright headers include the "All rights
reserved" string. It is not relevant in the context of the BSD-3-Clause
license that the code is released under. This patch removes those strings
throughout the code (hypervisor, devicemodel and misc).
Tracked-On: #7254
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Update the last_updated extension to correctly handle when new docs are
added and aren't yet commited into git vs. when the list of git folders
isn't correct. Previous PR #7251 incorrectly handled these as the same.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Instead of trying to maintain the release notes for old releases in the
current release, reference them in a previous archive. This eliminates
the need to fix doc build errors by editing old release notes that
reference material that no longer exists in the newer release.
We use the intersphinx extension to support references to
Sphinx-generated content from other projects. In our case, we're
referencing the archived version of v2.7 documents that was the last
release to generate release notes for all previous releases. This import
is done in conf.py.
(Alternatively we could reference the release notes for a release in
that specific release's archive, but that means fetchind the intersphinx
inventory file (objects.inv) for every release, and seems like
overkill.)
This modification still allows putting multiple release notes in the
doc/release_notes folder and they'll show up in the release notes index
as they have in the past. Update the separate "archived" release notes
section manually as needed.
Also, adds a draft of the v3.0 release notes to verify the new release
notes index page layout.
Fixes: #7171
Tracked-On: #7171
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
If a new document is added, the CI system fails because the new document
hasn't been checked into the branch yet so the last_updated.py script
complains with an error. Change to use the last_published date in this
situation.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
We use a post-processor to scan the output log from Sphinx to remove
known errors and warnings before deciding if the Sphinx build was
successful. If an exception happened during the Sphinx build, (see
about the error would appear. Update the Makefile to not stop on errors
for the Sphinx build. The post-processor will stop the make by returning
an error code if it finds unexpected errors in the log.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
When I added a new document that wasn't checked into GitHub yet, the doc
build failed with an unhanded exception:
Extension error (last_updated):
(exception: time data '' does not match format '%Y-%m-%d')
Problem is the git query looking up the last commit date for a file
returns an empty string for the date if the file exists but it's not in
the git repo (yet). The subsequent call to strptime raises an exception if passed
an empty string. This patch handles the exception.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix the formatting issue in the "ACRN Device Model parameters" document.
Add more details related to the 'virtio-net' device, specifically what
values can the 'device_type' take.
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Co-authored-by: David Kinder <david.b.kinder@intel.com>
Co-authored-by: Amy Reyes <amy.reyes@intel.com>
- Remove Ubuntu and Debian tutorials, as GSG is sufficient
- Remove Yocto tutorial, as it is just a reference to a repo that supports ACRN v2.4
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
Remove device name requirement for “tap” and "vmnet", change the
parameter format like:
"-s 4,virtio-net,tap/vmnet=dev_name".
change mac_seed to virtio-net sub-parameter
As a parameter of acrn-dm,the mac_seed is only used for virtio-net.
So this patch change it to the sub-parameter of virtio-net.
The final format is:
-s 4,virtio-net,tap/vmnet=dev_name,mac_seed=XXXX
Tracked-On: #6690
Signed-off-by: Chenli Wei chenli.wei@linux.intel.com
Remove the proof-of-concept shell script that post-processes the
generated HTML to add the git date when the corresponding .rst file as
the last modified date, augmenting the existing published date.
Instead, use a custom last_updated.py Sphinx extension that's integrated
into the Sphinx build itself. Remove the old fix-git-modified-date.sh
script and calls to it.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
As is recommended by UX/DX reviews, the per-VM console virtual UART is now
limited to the following choices:
- Disabled
- a COM port from COM1 to COM4
- PCI based
This patch converts the schema of scenario XMLs to integrate this
recommendation and add logic in the scenario upgrader to migrate data from
old scenario XMLs.
v1 -> v2:
* Update the static allocators and C source transformers according to the
new console vUART config item.
Tracked-On: #6690
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Instead of using a Boolean variable indicating whether a build is for debug
or release, it is more intuitive to specify the build types as "debug" or
"release".
This patch converts the config item RELEASE to BUILD_TYPE which takes
"debug" or "release" as of now.
The generated header and makefile still uses RELEASE, and the command line
option RELEASE=<y or n> is also preserved.
Tracked-On: #6690
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
We plan to add the following attributes to element definitions in the XML
schema:
- acrn:applicable-vms, which specify if an element applies to a
pre-launched VM, the service VM or a post-launched VM
- acrn:views, which specify if an element shall appear in the basic or
advanced tab in the configurator.
In order to reduce the attributes above to existing XML technologies, we
need to create new complex types that lists all config items that applies
to a pre-launched VM, the service VM or a post-launched VM, or that should
be shown in the basic or advanced view. Such types can then be used to
replace the original, all-in-one type during validation or configurator
rendering.
When unspecified, an element always applies under all possible
circumstances.
To realize this slicing mechanism, this patch adds a generic class
implementing the common part of slicing XML schema types and two
specific-purpose slicers according to the applicable VMs or views
attributes.
v2 -> v3:
* Update configdoc.xsl to recognize types in xs:alternative nodes.
Tracked-On: #6690
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Last year, GitHub announced the deprecation of the unsecured Git
protocol due to security reasons. This change will be made permanent on
March 15, 2022. Update the doc build tutorial to use https: instead of
git: protocol for cloning repos.
And while in here, clarify some of the doc build instructions.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Acrn driver in libvirt needs to handle JSON command or
JSON message to interact with command monitor in ACRN DM.
In libvirt, JSON APIs implementation depends on yajl lib.
So yajl should be configured for libvirt.
v1-->v2:
Remove description about checkout hypervisor tag
since libvirt can work on the latest hypervisor.
Libvirt doesn't depend on acrnd and acrnctl now,
remove acrnd and acrnctl installation in this document.
Tracked-On: #5921
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
PR #7167 removed configuration options that were referenced by
documentation. Remove those references.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Global parameter NVMX_ENABLE is removed from user interface,
and remove guest_flag
Tracked-On: #6690
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
when an XML option was removed, it will break documentation links to
that option information. We'll remove the link in the old release notes
to fix this problem.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The master branch is considered unstable and under development. We need
to remind developers of this and refer them to the available stable release
documentation.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
