Commit Graph

570 Commits

Author SHA1 Message Date
Reyes, Amy 6cff9d8f30 doc: Update S5 tutorial
- Update the S5 tutorial to align with new template and GSG scenario

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-23 09:57:03 -07:00
Amy Reyes f4dec5a554 doc: update draft 3.1 published docs to include changes on master
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2022-09-21 11:24:12 -07:00
zihengL1 59eb4f2963 config-tools: modified requirements.txt and update GSG
Modified misc/config_tools/configurator/requirements.txt
and misc/config_tools/requirements.txt. Updated getting-started.rst
and acrn_configurator_tool.rst.

Tracked-On: #7975
Signed-off-by: zihengL1 <ziheng.li@intel.com>
2022-08-26 13:12:14 +08:00
David B. Kinder f2dacfa30c doc: update rdt doc with real-time vCPU option clarification
Improve explanation of the Real-time vCPU option checkbox.

[External_System_ID] ACRN-9307

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-16 14:28:06 -07:00
zihengL1 b026238a69 config-tools: modified requirements.txt and update GSG
Modified requirements.txt in misc/config_tools/configurator
directory and add GSG requirements.txt inmisc/config_tools
directory.
Relevant python package installing steps in GSG.

Tracked-On: #7975
Reviewed-by: Junjie Mao junjie.mao@intel.com
Signed-off-by: Ziheng Li <ziheng.li@intel.com>
2022-08-16 17:20:23 +08:00
David B. Kinder cb91722dd5 doc: update rdt config tutorial
Add some clarification and updates for 3.1

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-08-09 14:26:25 -07:00
David B. Kinder ad0297ff02 doc: explain configurator error check and display model
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>
2022-07-26 09:33:51 -07:00
Chenli Wei ccf80a5ec2 doc: update vUART tutorials
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>
2022-07-19 10:25:34 -07:00
Kunhui-Li 69e1ec970c config_tools: update gpu passthru doc
add "i915.modeset=0" in kernel cmd line parameter for
allowing users to access a Ubuntu desktop.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-07-18 10:12:08 -07:00
Ziheng Li eb8bcb06b3 Update copyright year range in code headers
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>
2022-07-15 11:48:35 +08:00
Ziheng Li 1615c7346f doc: update upgrading_configuration.rst
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>
2022-07-05 10:35:54 -07:00
David B. Kinder 21af4e459b doc: remove images no longer referenced
We deleted documents but didn't delete the images they used.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-30 22:23:41 -07:00
David B. Kinder b787f3ba7d doc: update acrn-kernel repo tag
acrn-kernel tag (for v3.0 hypervisor) should be acrn-v3.0

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 12:49:49 -07:00
fuzhongl 08654c8e38 Doc: ACRN on Qemu Update
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
2022-06-28 16:30:47 -07:00
Reyes, Amy b594e1fbc7 doc: Update RDT/vCAT tutorial
* 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>
2022-06-28 16:28:09 -07:00
Reyes, Amy a42997e9e0 doc: Add note about Configurator IVSHMEM/vUART address issue
-  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>
2022-06-28 15:44:45 -07:00
David B. Kinder afa623ea06 doc: User VM guide
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>
2022-06-28 15:34:58 -07:00
Reyes, Amy cbe33ee750 doc: Update Configurator UI doc
- Update Debian file name
- Fix typos

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-28 10:47:37 -07:00
Reyes, Amy 0b95391357 doc: Update GVT-d tutorial
- 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>
2022-06-28 10:00:23 -07:00
Reyes, Amy 0380f8e907 doc: Update IVSHMEM tutorial
- 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>
2022-06-27 20:45:20 -07:00
jackwhich 8c0070a531 doc: Update GSG/Hybrid HW pic
Update GSG/Hybrid HW pic and release_3.0 version

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-06-24 17:29:57 -07:00
Reyes, Amy ad08ad87ea doc: Update vUART tutorial
- 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>
2022-06-24 11:22:26 -07:00
Reyes, Amy 452128a1ba doc: Remove OpenStack tutorial
- Outdated content, don't support OpenStack in v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-24 11:13:27 -07:00
Reyes, Amy 55e13ec91c doc: Update Configurator doc
- Update per comments in PR 7781

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-17 16:33:44 -07:00
Reyes, Amy 1accaaf2bb doc: Update Configurator
- 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>
2022-06-17 10:53:38 -07:00
Reyes, Amy 990ca9be06 doc: Update GSG
- 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>
2022-06-16 13:42:17 -07:00
Reyes, Amy 564aa5bde1 doc: Update Board Inspector
- Update prerequisites, commands, command-line options for v3.0 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-16 09:57:01 -07:00
Reyes, Amy 4e2ae9740f doc: Update Intro to ACRN Configuration
- Update to reflect configuration changes for v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-14 17:58:17 -07:00
Reyes, Amy 6eeef69433 doc: Remove Launch Configuration Options
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>
2022-06-07 09:48:17 -07:00
Reyes, Amy 762b8dc849 doc: Create doc for Configurator UI
- This doc describes the Configurator UI for v3.0

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-06-02 10:43:48 -07:00
Reyes, Amy 9e2b9ffa58 doc: Remove outdated nested virtualization tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-24 11:21:26 -07:00
David B. Kinder 8af0e9b9ef doc: remove unreferenced images in doc tree
Over time we've deleted or change documents but didn't remove
unreferenced images.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-12 15:41:51 -07:00
hangliu1 3afb222d90 [config tool][doc]: remove old configurator
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>
2022-05-12 15:42:26 +08:00
Reyes, Amy e1fc354c49 doc: Remove outdated RT tutorial
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-11 19:19:47 -07:00
Helmut Buchsbaum f5c63dd5ff doc: Adapt documentation to change of acrnlog log path
Tracked-On: #6688
Signed-off-by: Helmut Buchsbaum <helmut.buchsbaum@opensource.tttech-industrial.com>
2022-05-10 09:20:14 +08:00
Reyes, Amy c925d63dd9 doc: Copyedit upgrading_configuration.rst
- Grammatical and formatting cleanup

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 15:24:37 -07:00
David B. Kinder e491773f5e doc: remove obsolete (and orphaned) docs
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>
2022-05-03 15:16:46 -07:00
David B. Kinder f71c7a8032 doc: use DX-friendly names in configuration option documentation
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>
2022-04-28 07:56:35 -07:00
Junjie Mao 98f7dfd131 doc: add a tutorial on how to upgrade configuration files
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2022-04-20 09:47:30 -07:00
Reyes, Amy 89c15567b0 doc: Capitalize Board Inspector and ACRN Configurator
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-04-18 17:17:40 -07:00
Reyes, Amy 7f2175cdce doc: Fix links
- Fix broken software.intel.com links that moved to intel.com domain

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-04-18 17:16:15 -07:00
Reyes, Amy 9ef08d6021 doc: Remove outdated tutorials
- Remove SGX tutorial, partitioned mode GSG, and Trusty reference

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-04-13 14:20:23 -07:00
hangliu1 5c3e7a29ee config tool/doc:update SCHED_IORR in schema
hide SCHED_IORR and KERNEL_RAWIMAGE in schema
and update SCHED_IORR in doc

Tracked-On: #7256
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
2022-04-13 13:35:52 +08:00
Reyes, Amy 05cc6664ca doc: Remove outdated tutorials
- 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>
2022-03-22 13:30:33 -07:00
Chenli Wei 7dec39a9e8 doc: change the parameter of virtio-net
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
2022-03-20 20:21:56 -07:00
Reyes, Amy f5b021b1b5 doc: Minor style cleanup
- Remove "currently"
- Capitalize titles and Device Model

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-18 16:35:00 -07:00
Junjie Mao e88532b59d config_tools: refine console virtual UARTs
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>
2022-03-15 10:22:37 +08:00
Geoffroy Van Cutsem eb070491ee doc: fix the URL for projectacrn.github.io repo
Fix the URL used to clone the projectacrn.github.io repo.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-03-10 08:02:51 -08:00
David B. Kinder b72202e976 doc: update doc-build tutorial
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>
2022-03-09 17:35:44 -08:00
Xiangyang Wu 29b2fa2310 doc: configure yajl lib for acrn driver in libvirt
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>
2022-03-09 13:46:25 -08:00