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>
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>
- 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
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>
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>
modprobe msr has been added to board_parse.py in PR #6692.
Remove modprobe msr in gsg and board_inspector docs
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
PR #7115 removed ``IVSHMEM_ENABLED`` and ``IVSHMEM_REGION`` from
``types.xsd``. We'll need to update the documentation to reflect this
change, but for now we need to remove the doc build error.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Clarify that ``cpu-checker`` is the package that you install to get the
``kvm-ok`` tool used in these instructions.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
For platforms which have apicv post-interrupt capability;
ACRN would use posted-interrupt to notify another vCPU which in non-root mode;
or sync interrupt for itself when it in root-mode.However,QEMU could not handle this properly.
So, remove the post-interrupt capability in qemu cmdline.
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-By: Li, Fei <fei1.Li@intel.com>
Cpu affinty was set by pCPU ID which can't be obtained
explictly by user. Use lapic ID instead which can be easily
read from `/proc/cpuinfo` as `apicid`.
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
Update the instructions on how to start the ACRN Configurator tool
('acrn_configurator.py'). It is no longer require to use 'python3 ...'
since we've added a shebang header to the file and made it executable.
Tracked-On: #7057
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Remove the TARGET_DIR parameter from the "Enable Inter-VM Communication
Based on Ivshmem" tutorial as this is now an obsolete parameter that
will print out a warning.
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
I. Add three kinds of Inter-VM communication advantage and shortage:
1. Inter-VM vUART
2. Inter-VM network communication
3. Inter-VM shared memory device (ivshmem)
II.Add how to implement an Ivshmem application on ACRN.
Signed-off-by: Hu Fenglin <fenglin.hu@intel.com>
To launch User VM, cpu_affinity parameter is needed for v2.7.
Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
Reviewed-by: gvancuts <geoffroy.vancutsem@intel.com>
1. Update launch script and replace the apt-get command with apt in GSG documentation.
2. Update the tag to v2.7 in partitioned documentation.
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Currently, Service VM may fail to shut down due to some enabled
VFs. ACRN doesn't disable VFs automatically.
In this patch, add a note for user to disable VFs before Service
VM shuts down.
Tracked-On: #5921
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
For WaaG VM, the User VM name is hard coded in the
lifecycle manager, this User VM ("windows") is needed
for guest shutdown.
Note: libvirt will be used to do guest shutdown and
the WaaG VM name will be configurable in furture.
The lifecycle manager starup picture in WaaG VM is out
of data, update it in this patch.
Tracked-on: #6652
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
- Replace UOS or User OS with User VM
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
- Replace UOS or User OS with User VM
- Replace SOS or Service OS with Service VM
- Capitalize Board Inspector and ACRN Configurator
- Clean up some of the grammar
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
Add description for the IORR (IO sensitive Round Robin) scheduler
and the priority based scheduler.
Signed-off-by: Jie Deng <jie.deng@intel.com>
Signed-off-by: Yifan Liu <yifan1.liu@intel.com>
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator and Board Inspector
- Clean up some of the grammar
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
Since the PR #6787 has landed, we need to remove the uuid parameter
"-U" of "acrn-dm" and replace UUID with vm name to identify a VM
in document.
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Lifecycle Manager will be refined in v2.7, this patch will
refine enable s5 document to align with the latest code.
v1-->v2:
Remove the prompt from all instructions in this
document.
Tracked-On: #6652
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
- Change "configuration tool" to "ACRN configurator tool" to match the tool's UI
- Change "configuration toolset" to "ACRN configurator tool" in cases that clearly refer to the configurator and not the entire toolset, update cross-ref
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
Update the docs and images referencing ``industry`` and ``logical_partition`` scenarios to
``shared`` and ``partioned``.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Update the "Enable S5 in ACRN" tutorial to:
* Make the language clearer at places
* Consistent use of "Lifecycle Manager" and "life_mngr"
* Change "ACK" to "ACKED"
* Use a ReST reference to point at the architectural diagram
* Update build instructions
* Replace 'literalinclude' by static code-blocks to avoid the
content going out of date
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
- Create ACRN config tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create board inspector tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create launch config options doc based on info in existing "Intro to ACRN Configuration" doc, similar to existing scenario config options doc
- Update refs that no longer exist
- Create hypervisor makefile options doc, combining makefile info from "Intro to ACRN Configuration" doc and "Build ACRN from Source" doc
- Clarify why you need config files, difference between scenario vs. launch VM settings
- Updates are intended to reflect v2.6 code
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
1.Modified Intel Whiskey Lake to Intel NUC Kit NUC11TNBi5
2.Change the logical partition and mixed test motherboard name
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Enabling PTM requires some additional engineering work, so we're
removing these instructions for now.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1.Modify hybrid update ubuntu grub Note: The syntax is easy for users to understand.
2.Add to view the serial port number, enter the serial hybrid verification mode.
3.Delete the kernel, because the config_uos file has been abandoned for maintenance,
now the Ubuntu native kernel image is used and added to the document.
4.Add to view the serial port number, enter the serial port logic_partition verification method.
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
ACRN will not maintain User VM kernel config any more;
ovmf will be used to launch L2 guest by default.
Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
Reviewed-by: gvancuts <geoffroy.vancutsem@intel.com>
Over time, and after deleting or moving documents around, we've left
behind quite the collection of unreferenced images. It's time to clean
them out of the doc folders.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
When GVT-g support was removed from ACRN some documentation changes were
missed. Delete the GVT-g HLD docs and the images it used. Also fix
references in the old release notes so they don't depend on this deleted
document. (The original release notes are still in the archived release
docs.)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
* General scan for misspellings, "smart quotes", and formatting errors
missed during regular review. Also removed used of "please".
* Fix old XML examples that had desc="..." comments. These comments were
moved to to xsd files instead of being in the XML files themselves.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix an error in the documentation where the output from dmesg was
incorrect for the Service VM.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Now ACRN support booting pre-launched Zephyr VM kernel in ELF format
instead of previous raw image format, so update usage in related doc.
Signed-off-by: Victor Sun <victor.sun@intel.com>
Qemu HOST-passthrough has hardware dependency CPU feature;
which may block ACRN to boot up on QEMU;So change QEMU HOST-passthrough to CPU Named Model since v2.6.
Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
1. Update the images to match with the latest UI.
2. Update the path of the saved XML file when clicking Export XML to
save customized file.
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Update the Getting Started material with a DX-inspired rewrite and
simplification.
- Remove duplicate and out-of-date "Building from Source"
document, deferring to the new GSG.
- Add a development overview document.
- Move other GSGs to the advanced guides section.
- Update links in other documents to aim at the new GSG.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
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>
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>
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>
