diff --git a/doc/asa.rst b/doc/asa.rst index 9bd96d03a..e55b169f8 100644 --- a/doc/asa.rst +++ b/doc/asa.rst @@ -3,9 +3,24 @@ Security Advisory ################# +Addressed in ACRN v3.0.1 +************************ +We recommend that all developers upgrade to this v3.0.1 release (or later), which +addresses the following security issue discovered in previous releases: + +----- + +- Disable RRSBA on platforms using retpoline + For platforms that supports RRSBA (Restricted Return Stack Buffer + Alternate), using retpoline may not be sufficient to guard against branch + history injection or intra-mode branch target injection. RRSBA must + be disabled to prevent CPUs from using alternate predictors for RETs. + (Addresses security issue tracked by CVE-2022-29901 and CVE-2022-28693.) + + **Affected Release:** v3.0 and earlier + Addressed in ACRN v2.7 ************************ - We recommend that all developers upgrade to this v2.7 release (or later), which addresses the following security issue discovered in previous releases: diff --git a/doc/developer-guides/asm_coding_guidelines.rst b/doc/developer-guides/asm_coding_guidelines.rst index 97b9487c3..c3e0f5191 100644 --- a/doc/developer-guides/asm_coding_guidelines.rst +++ b/doc/developer-guides/asm_coding_guidelines.rst @@ -720,7 +720,7 @@ Compliant example:: -------------File Contents Start After This Line------------ /* - * Copyright (C) 2019 Intel Corporation. + * Copyright (C) 2019-2022 Intel Corporation. * * SPDX-License-Identifier: BSD-3-Clause */ diff --git a/doc/developer-guides/c_coding_guidelines.rst b/doc/developer-guides/c_coding_guidelines.rst index d15519361..183140b1b 100644 --- a/doc/developer-guides/c_coding_guidelines.rst +++ b/doc/developer-guides/c_coding_guidelines.rst @@ -3386,7 +3386,7 @@ Compliant example:: -------------File Contents Start After This Line------------ /* - * Copyright (C) 2019 Intel Corporation. + * Copyright (C) 2019-2022 Intel Corporation. * * SPDX-License-Identifier: BSD-3-Clause */ diff --git a/doc/extensions/kerneldoc.py b/doc/extensions/kerneldoc.py index 90d56fe7d..933b75a1f 100644 --- a/doc/extensions/kerneldoc.py +++ b/doc/extensions/kerneldoc.py @@ -1,6 +1,6 @@ # coding=utf-8 # -# Copyright © 2016 Intel Corporation +# Copyright © 2016-2022 Intel Corporation. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), diff --git a/doc/extensions/link_roles.py b/doc/extensions/link_roles.py index 570907060..b4ed894af 100644 --- a/doc/extensions/link_roles.py +++ b/doc/extensions/link_roles.py @@ -1,4 +1,4 @@ -# Copyright (c) 2019 Intel Corporation +# Copyright (c) 2019-2022 Intel Corporation. # # SPDX-License-Identifier: Apache-2.0 diff --git a/doc/getting-started/getting-started.rst b/doc/getting-started/getting-started.rst index 577fd4014..1667dfd9c 100644 --- a/doc/getting-started/getting-started.rst +++ b/doc/getting-started/getting-started.rst @@ -471,11 +471,26 @@ post-launched User VM. Each User VM has its own launch script. settings to meet your application's particular needs. But for now, you will update only a few settings for functional and educational purposes. + You may see some error messages from the configurator, such as shown here: + + .. image:: images/gsg-config-errors.png + :align: center + :class: drop-shadow + + The configurator does consistency and validation checks when you load or save + a scenario. Notice the Hypervisor and VM1 tabs both have an error icon, + meaning there are issues with configuration options in two areas. Since the + Hypervisor tab is currently highlighted, we're seeing an issue we can resolve + on the Hypervisor settings. Once we resolve all the errors and save the + scenario (forcing a full validation of the schema again), these error + indicators and messages will go away. + #. Click the **Hypervisor Global Settings > Basic Parameters** tab, select the ``Debug`` build type, and select the serial console port (the example shows ``/dev/ttyS0``, but yours may be different). If your board doesn't have a serial console port, select the ``Release`` build type. The Debug build type - requires a serial console port. + requires a serial console port (and is reporting an error because a serial + console port hasn't been configured yet). .. image:: images/configurator-buildtype.png :align: center @@ -501,7 +516,8 @@ post-launched User VM. Each User VM has its own launch script. Ubuntu 20.04 needs at least 1024 MB to boot. #. For **Physical CPU affinity**, select pCPU ID ``0``, then click **+** and - select pCPU ID ``1`` to affine the VM to CPU cores 0 and 1. + select pCPU ID ``1`` to affine (or pin) the VM to CPU cores 0 and 1. (That will + resolve the initial physical CPU affinity assignment error.) #. For **Virtio console device**, click **+** to add a device and keep the default options. This parameter specifies the console that you will use to diff --git a/doc/getting-started/images/gsg-config-errors.png b/doc/getting-started/images/gsg-config-errors.png new file mode 100644 index 000000000..77d086fed Binary files /dev/null and b/doc/getting-started/images/gsg-config-errors.png differ diff --git a/doc/reference/images/Advanced.svg b/doc/reference/images/Advanced.svg deleted file mode 100644 index ab87cdc5b..000000000 --- a/doc/reference/images/Advanced.svg +++ /dev/null @@ -1 +0,0 @@ -Advanced ParameterAdvanced Parameter \ No newline at end of file diff --git a/doc/reference/images/Basic.svg b/doc/reference/images/Basic.svg deleted file mode 100644 index d9b5a299b..000000000 --- a/doc/reference/images/Basic.svg +++ /dev/null @@ -1 +0,0 @@ -Basic ParameterBasic Parameter \ No newline at end of file diff --git a/doc/reference/images/Hypervisor.svg b/doc/reference/images/Hypervisor.svg deleted file mode 100644 index 0e4fa83c8..000000000 --- a/doc/reference/images/Hypervisor.svg +++ /dev/null @@ -1 +0,0 @@ -HypervisorHypervisor \ No newline at end of file diff --git a/doc/reference/images/Not-available.svg b/doc/reference/images/Not-available.svg deleted file mode 100644 index 490d214e2..000000000 --- a/doc/reference/images/Not-available.svg +++ /dev/null @@ -1 +0,0 @@ -Not available in Configurator UINot available in Configurator UI \ No newline at end of file diff --git a/doc/reference/images/Post-launched-VM.svg b/doc/reference/images/Post-launched-VM.svg deleted file mode 100644 index f2206aef6..000000000 --- a/doc/reference/images/Post-launched-VM.svg +++ /dev/null @@ -1 +0,0 @@ -Post-launched VMPost-launched VM \ No newline at end of file diff --git a/doc/reference/images/Pre-launched-VM.svg b/doc/reference/images/Pre-launched-VM.svg deleted file mode 100644 index 3e87e0b22..000000000 --- a/doc/reference/images/Pre-launched-VM.svg +++ /dev/null @@ -1 +0,0 @@ -Pre-launched VMPre-launched VM \ No newline at end of file diff --git a/doc/reference/images/Service-VM.svg b/doc/reference/images/Service-VM.svg deleted file mode 100644 index 6ca6bd34f..000000000 --- a/doc/reference/images/Service-VM.svg +++ /dev/null @@ -1 +0,0 @@ -Service VMService VM \ No newline at end of file diff --git a/doc/release_notes/release_notes_3.0.1.rst b/doc/release_notes/release_notes_3.0.1.rst new file mode 100644 index 000000000..14e6f05d7 --- /dev/null +++ b/doc/release_notes/release_notes_3.0.1.rst @@ -0,0 +1,54 @@ +.. _release_notes_3.0.1: + +ACRN v3.0.1 (Jul 2022) +###################### + +We are pleased to announce the release of the Project ACRN hypervisor +version 3.0.1 with hot fixes to the v3.0 release. + +ACRN is a flexible, lightweight reference hypervisor that is built with +real-time and safety-criticality in mind. It is optimized to streamline +embedded development through an open-source platform. See the +:ref:`introduction` introduction for more information. + +All project ACRN source code is maintained in the +https://github.com/projectacrn/acrn-hypervisor repository and includes +folders for the ACRN hypervisor, the ACRN device model, tools, and +documentation. You can download this source code either as a zip or +tar.gz file (see the `ACRN v3.0.1 GitHub release page +`_) or +use Git ``clone`` and ``checkout`` commands:: + + git clone https://github.com/projectacrn/acrn-hypervisor + cd acrn-hypervisor + git checkout v3.0.1 + +The project's online technical documentation is also tagged to +correspond with a specific release: generated v3.0 documents can be +found at https://projectacrn.github.io/3.0/. Documentation for the +latest development branch is found at https://projectacrn.github.io/latest/. + +ACRN v3.0.1 requires Ubuntu 20.04 (as does v3.0). Follow the instructions in the +:ref:`gsg` to get started with ACRN. + + +What's New in v3.0.1 +******************** + +Mitigation for Return Stack Buffer Underflow security vulnerability + For platforms that supports RRSBA (Restricted Return Stack Buffer + Alternate), using retpoline may not be sufficient to guard against branch + history injection or intra-mode branch target injection. RRSBA must + be disabled to prevent CPUs from using alternate predictors for RETs. + (Addresses security issue tracked by CVE-2022-29901 and CVE-2022-28693.) + +ACRN shell commands added for real-time performance profiling + ACRN shell commands were added to sample vmexit data per virtual CPU to + facilitate real-time performance profiling: + + * ``vmexit clear``: clears current vmexit buffer + * ``vmexit [vm_id]``: outputs vmexit info per vCPU + * ``vmexit enable | disable``: enabled by default + + +See :ref:`release_notes_3.0` for additional release information. diff --git a/doc/scorer.js b/doc/scorer.js index 9e51c46be..05e42b61e 100644 --- a/doc/scorer.js +++ b/doc/scorer.js @@ -2,7 +2,7 @@ * Simple search result scoring code. * * Copyright 2007-2018 by the Sphinx team - * Copyright (c) 2019, Intel + * Copyright (c) 2019-2022, Intel Corporation. * SPDX-License-Identifier: Apache-2.0 */ diff --git a/doc/scripts/extract_content.py b/doc/scripts/extract_content.py index a6f52114e..0c149af21 100755 --- a/doc/scripts/extract_content.py +++ b/doc/scripts/extract_content.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # # Copyright (c) 2018, Nordic Semiconductor ASA -# Copyright (c) 2017, Intel Corporation +# Copyright (c) 2017-2022, Intel Corporation # # SPDX-License-Identifier: Apache-2.0 diff --git a/doc/scripts/filter-doc-log.sh b/doc/scripts/filter-doc-log.sh index 12374b659..76c6708de 100755 --- a/doc/scripts/filter-doc-log.sh +++ b/doc/scripts/filter-doc-log.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright (C) 2019 Intel Corporation. +# Copyright (C) 2019-2022 Intel Corporation. # SPDX-License-Identifier: BSD-3-Clause # run the filter-known-issues.py script to remove "expected" warning diff --git a/doc/scripts/filter-known-issues.py b/doc/scripts/filter-known-issues.py index 459d79499..b60c9f0dc 100755 --- a/doc/scripts/filter-known-issues.py +++ b/doc/scripts/filter-known-issues.py @@ -1,5 +1,5 @@ #! /usr/bin/env python3 -# Copyright (c) 2017, Intel Corporation +# Copyright (c) 2017-2022, Intel Corporation # SPDX-License-Identifier: Apache-2.0 """ Filters a file, classifying output in errors, warnings and discarding diff --git a/doc/scripts/show-versions.py b/doc/scripts/show-versions.py index 63782b4d9..fe37ba26f 100755 --- a/doc/scripts/show-versions.py +++ b/doc/scripts/show-versions.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # -# Copyright (c) 2018, Intel Corporation +# Copyright (c) 2018-2022, Intel Corporation # # SPDX-License-Identifier: BSD-3-Clause # diff --git a/doc/tutorials/acrn_configurator_tool.rst b/doc/tutorials/acrn_configurator_tool.rst index 0a8855848..c83d710b4 100644 --- a/doc/tutorials/acrn_configurator_tool.rst +++ b/doc/tutorials/acrn_configurator_tool.rst @@ -36,6 +36,54 @@ The above Getting Started Guide steps use a prebuilt Debian package to install the ACRN Configurator. :ref:`acrn_configurator_tool_source` describes how to build the Debian package. +Scenario Error Checking +*********************** + +The configurator includes many validation checks that verify input values, ensure the consistency of +configuration options, and interactions between options. + +Simple data validation checks on values are detected immediately with red +text indicating the problem, or with an indicator within a data entry field. For +example, if you type in a value that is out of range, you'll see your value +crossed out: + +.. image:: images/config-out-of-range-error.png + :align: center + :class: drop-shadow + +If you delete a required value, you'll see an error message in red text: + +.. image:: images/config-required-value-error.png + :align: center + :class: drop-shadow + +More complex checks, including those that look for conflicting settings, are +done when you initially open a saved (or newly created) scenario, or when you +use the "Save Scenario" button. If problems are detected, the response window +from the save action will indicate that problems were found. The Hypervisor or +VM tabs will then display an error icon leading you to the configuration option +panels where you can resolve the errors. For example, both the Hypervisor and +VM1 tabs indicate an option setting problem: + +.. image:: images/config-tab-errors.png + :align: center + :class: drop-shadow + +Since we're on the Hypervisor (Basic Parameters) options, we see the Hypervisor +configuration error message. If we click on the VM1 tab, we'll see what the +issues are with that VM's configuration options: + +.. image:: images/config-tab-errors2.png + :align: center + :class: drop-shadow + +In both cases, you can scroll down to see the specific problem (on either the +basic or advanced parameters tab), fix the issues, +and then when all issues are resolved, click on the "Save Scenario" button to +validate the changes and save the settings. If all issues were resolved, the +save scenario response window will indicate no issues were found and all the +error indicators will be cleared. + Start with a New or Existing Configuration ****************************************** @@ -476,4 +524,4 @@ how to build the Debian package from source code. .. code-block:: bash - acrn-configurator \ No newline at end of file + acrn-configurator diff --git a/doc/tutorials/acrn_on_qemu.rst b/doc/tutorials/acrn_on_qemu.rst index cb78a50db..4211035bc 100644 --- a/doc/tutorials/acrn_on_qemu.rst +++ b/doc/tutorials/acrn_on_qemu.rst @@ -267,7 +267,7 @@ Bring Up User VM (L2 Guest) .. code-block:: none #!/bin/bash - # Copyright (C) 2020 Intel Corporation. + # Copyright (C) 2020-2022 Intel Corporation. # SPDX-License-Identifier: BSD-3-Clause function launch_ubuntu() { diff --git a/doc/tutorials/create-up2-images.sh b/doc/tutorials/create-up2-images.sh index 7240666e8..ea999ea1f 100755 --- a/doc/tutorials/create-up2-images.sh +++ b/doc/tutorials/create-up2-images.sh @@ -1,6 +1,6 @@ #!/bin/bash -# Copyright (C) 2018 Intel Corporation. +# Copyright (C) 2018-2022 Intel Corporation. # SPDX-License-Identifier: BSD-3-Clause diff --git a/doc/tutorials/gpt_ini2bin.py b/doc/tutorials/gpt_ini2bin.py index 892f36556..e0f4024e5 100755 --- a/doc/tutorials/gpt_ini2bin.py +++ b/doc/tutorials/gpt_ini2bin.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright (C) 2018 Intel Corporation. +# Copyright (C) 2018-2022 Intel Corporation. # SPDX-License-Identifier: BSD-3-Clause import ConfigParser diff --git a/doc/tutorials/gpu-passthru.rst b/doc/tutorials/gpu-passthru.rst index e7e00fdef..8ddeba946 100644 --- a/doc/tutorials/gpu-passthru.rst +++ b/doc/tutorials/gpu-passthru.rst @@ -61,6 +61,16 @@ The example extends the information provided in the :ref:`gsg`. #. In the ACRN Configurator, create a shared scenario with a Service VM and one post-launched User VM. +#. Select the Service VM and go to **Basic Parameters > Kernel + command-line parameters**. + +#. Append ``i915.modeset=0`` in **Kernel command-line parameters** to disable the + GPU driver loading for Intel GPU device. + + .. image:: images/kernel_cmd_line.png + :align: center + :class: drop-shadow + #. Select the post-launched User VM and go to **Basic Parameters > PCI devices**. diff --git a/doc/tutorials/images/OpenStack-01-login.png b/doc/tutorials/images/OpenStack-01-login.png deleted file mode 100644 index b2fc278d9..000000000 Binary files a/doc/tutorials/images/OpenStack-01-login.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-02-topology.png b/doc/tutorials/images/OpenStack-02-topology.png deleted file mode 100644 index 5c40f5904..000000000 Binary files a/doc/tutorials/images/OpenStack-02-topology.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-03-create-router.png b/doc/tutorials/images/OpenStack-03-create-router.png deleted file mode 100644 index 56a942296..000000000 Binary files a/doc/tutorials/images/OpenStack-03-create-router.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-03a-create-router.png b/doc/tutorials/images/OpenStack-03a-create-router.png deleted file mode 100644 index 8c9c4c9be..000000000 Binary files a/doc/tutorials/images/OpenStack-03a-create-router.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-03b-created-router.png b/doc/tutorials/images/OpenStack-03b-created-router.png deleted file mode 100644 index fe743b47d..000000000 Binary files a/doc/tutorials/images/OpenStack-03b-created-router.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-04a-add-interface.png b/doc/tutorials/images/OpenStack-04a-add-interface.png deleted file mode 100644 index 177dfb399..000000000 Binary files a/doc/tutorials/images/OpenStack-04a-add-interface.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-04b-add-interface.png b/doc/tutorials/images/OpenStack-04b-add-interface.png deleted file mode 100644 index 7407fcca5..000000000 Binary files a/doc/tutorials/images/OpenStack-04b-add-interface.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-04c-add-interface.png b/doc/tutorials/images/OpenStack-04c-add-interface.png deleted file mode 100644 index 7842ddede..000000000 Binary files a/doc/tutorials/images/OpenStack-04c-add-interface.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-05-topology.png b/doc/tutorials/images/OpenStack-05-topology.png deleted file mode 100644 index 725081c74..000000000 Binary files a/doc/tutorials/images/OpenStack-05-topology.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-06-create-image.png b/doc/tutorials/images/OpenStack-06-create-image.png deleted file mode 100644 index a695ae1e9..000000000 Binary files a/doc/tutorials/images/OpenStack-06-create-image.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-06a-create-image-browse.png b/doc/tutorials/images/OpenStack-06a-create-image-browse.png deleted file mode 100644 index f13b3b322..000000000 Binary files a/doc/tutorials/images/OpenStack-06a-create-image-browse.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-06b-create-image-select.png b/doc/tutorials/images/OpenStack-06b-create-image-select.png deleted file mode 100644 index fd29bf9cd..000000000 Binary files a/doc/tutorials/images/OpenStack-06b-create-image-select.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-06e-create-image.png b/doc/tutorials/images/OpenStack-06e-create-image.png deleted file mode 100644 index e0406a0d9..000000000 Binary files a/doc/tutorials/images/OpenStack-06e-create-image.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-07a-create-flavor.png b/doc/tutorials/images/OpenStack-07a-create-flavor.png deleted file mode 100644 index cb1d2ee5f..000000000 Binary files a/doc/tutorials/images/OpenStack-07a-create-flavor.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-07b-flavor-created.png b/doc/tutorials/images/OpenStack-07b-flavor-created.png deleted file mode 100644 index 49d59f53e..000000000 Binary files a/doc/tutorials/images/OpenStack-07b-flavor-created.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-08-security-group.png b/doc/tutorials/images/OpenStack-08-security-group.png deleted file mode 100644 index af9d75ee7..000000000 Binary files a/doc/tutorials/images/OpenStack-08-security-group.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-08a-create-security-group.png b/doc/tutorials/images/OpenStack-08a-create-security-group.png deleted file mode 100644 index 02f498c74..000000000 Binary files a/doc/tutorials/images/OpenStack-08a-create-security-group.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-08b-add-rule.png b/doc/tutorials/images/OpenStack-08b-add-rule.png deleted file mode 100644 index a91ccf1e7..000000000 Binary files a/doc/tutorials/images/OpenStack-08b-add-rule.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-08c-add-SSH-rule.png b/doc/tutorials/images/OpenStack-08c-add-SSH-rule.png deleted file mode 100644 index 618080642..000000000 Binary files a/doc/tutorials/images/OpenStack-08c-add-SSH-rule.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-08d-add-All-ICMP-rule.png b/doc/tutorials/images/OpenStack-08d-add-All-ICMP-rule.png deleted file mode 100644 index 0ee8e35a8..000000000 Binary files a/doc/tutorials/images/OpenStack-08d-add-All-ICMP-rule.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-09a-create-key-pair.png b/doc/tutorials/images/OpenStack-09a-create-key-pair.png deleted file mode 100644 index 1e0a5856c..000000000 Binary files a/doc/tutorials/images/OpenStack-09a-create-key-pair.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-09c-key-pair-private-key.png b/doc/tutorials/images/OpenStack-09c-key-pair-private-key.png deleted file mode 100644 index b66f68712..000000000 Binary files a/doc/tutorials/images/OpenStack-09c-key-pair-private-key.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10a-launch-instance-name.png b/doc/tutorials/images/OpenStack-10a-launch-instance-name.png deleted file mode 100644 index a06c153a4..000000000 Binary files a/doc/tutorials/images/OpenStack-10a-launch-instance-name.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10b-no-new-vol-select-allocated.png b/doc/tutorials/images/OpenStack-10b-no-new-vol-select-allocated.png deleted file mode 100644 index d95dc417c..000000000 Binary files a/doc/tutorials/images/OpenStack-10b-no-new-vol-select-allocated.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10c-select-flavor.png b/doc/tutorials/images/OpenStack-10c-select-flavor.png deleted file mode 100644 index b228a1a43..000000000 Binary files a/doc/tutorials/images/OpenStack-10c-select-flavor.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10d-flavor-selected.png b/doc/tutorials/images/OpenStack-10d-flavor-selected.png deleted file mode 100644 index 2ad6d7c4b..000000000 Binary files a/doc/tutorials/images/OpenStack-10d-flavor-selected.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10d-only-acrn-security-group.png b/doc/tutorials/images/OpenStack-10d-only-acrn-security-group.png deleted file mode 100644 index ca1d93166..000000000 Binary files a/doc/tutorials/images/OpenStack-10d-only-acrn-security-group.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10e-select-network.png b/doc/tutorials/images/OpenStack-10e-select-network.png deleted file mode 100644 index cee014637..000000000 Binary files a/doc/tutorials/images/OpenStack-10e-select-network.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-10g-show-keypair-launch.png b/doc/tutorials/images/OpenStack-10g-show-keypair-launch.png deleted file mode 100644 index 0dd9d1856..000000000 Binary files a/doc/tutorials/images/OpenStack-10g-show-keypair-launch.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-11-wait-for-running-create-snapshot.png b/doc/tutorials/images/OpenStack-11-wait-for-running-create-snapshot.png deleted file mode 100644 index 3e644adef..000000000 Binary files a/doc/tutorials/images/OpenStack-11-wait-for-running-create-snapshot.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-11a-manage-floating-ip.png b/doc/tutorials/images/OpenStack-11a-manage-floating-ip.png deleted file mode 100644 index a4ae9a91a..000000000 Binary files a/doc/tutorials/images/OpenStack-11a-manage-floating-ip.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-11b-allocate-floating-ip.png b/doc/tutorials/images/OpenStack-11b-allocate-floating-ip.png deleted file mode 100644 index c96ea62a3..000000000 Binary files a/doc/tutorials/images/OpenStack-11b-allocate-floating-ip.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-11c-allocate-floating-ip-success-associate.png b/doc/tutorials/images/OpenStack-11c-allocate-floating-ip-success-associate.png deleted file mode 100644 index e1e19dbd6..000000000 Binary files a/doc/tutorials/images/OpenStack-11c-allocate-floating-ip-success-associate.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-12b-running-topology-instance.png b/doc/tutorials/images/OpenStack-12b-running-topology-instance.png deleted file mode 100644 index 1fe52886a..000000000 Binary files a/doc/tutorials/images/OpenStack-12b-running-topology-instance.png and /dev/null differ diff --git a/doc/tutorials/images/OpenStack-12d-compute-hypervisor.png b/doc/tutorials/images/OpenStack-12d-compute-hypervisor.png deleted file mode 100644 index 5988421ca..000000000 Binary files a/doc/tutorials/images/OpenStack-12d-compute-hypervisor.png and /dev/null differ diff --git a/doc/tutorials/images/config-out-of-range-error.png b/doc/tutorials/images/config-out-of-range-error.png new file mode 100644 index 000000000..c4dcf57cb Binary files /dev/null and b/doc/tutorials/images/config-out-of-range-error.png differ diff --git a/doc/tutorials/images/config-required-value-error.png b/doc/tutorials/images/config-required-value-error.png new file mode 100644 index 000000000..9b1c0f623 Binary files /dev/null and b/doc/tutorials/images/config-required-value-error.png differ diff --git a/doc/tutorials/images/config-tab-errors.png b/doc/tutorials/images/config-tab-errors.png new file mode 100644 index 000000000..77d086fed Binary files /dev/null and b/doc/tutorials/images/config-tab-errors.png differ diff --git a/doc/tutorials/images/config-tab-errors2.png b/doc/tutorials/images/config-tab-errors2.png new file mode 100644 index 000000000..b7e42a7f9 Binary files /dev/null and b/doc/tutorials/images/config-tab-errors2.png differ diff --git a/doc/tutorials/images/configurator-rederror.png b/doc/tutorials/images/configurator-rederror.png deleted file mode 100644 index ba78b367e..000000000 Binary files a/doc/tutorials/images/configurator-rederror.png and /dev/null differ diff --git a/doc/tutorials/images/configurator-vuartconn01.png b/doc/tutorials/images/configurator-vuartconn01.png index f7458f333..fce9cd034 100644 Binary files a/doc/tutorials/images/configurator-vuartconn01.png and b/doc/tutorials/images/configurator-vuartconn01.png differ diff --git a/doc/tutorials/images/kernel_cmd_line.png b/doc/tutorials/images/kernel_cmd_line.png new file mode 100644 index 000000000..6b2f90840 Binary files /dev/null and b/doc/tutorials/images/kernel_cmd_line.png differ diff --git a/doc/tutorials/images/nvmx_1.png b/doc/tutorials/images/nvmx_1.png deleted file mode 100644 index c56ae5c54..000000000 Binary files a/doc/tutorials/images/nvmx_1.png and /dev/null differ diff --git a/doc/tutorials/images/nvmx_arch_1.png b/doc/tutorials/images/nvmx_arch_1.png deleted file mode 100644 index e9afba89c..000000000 Binary files a/doc/tutorials/images/nvmx_arch_1.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-0.png b/doc/tutorials/images/ubuntu-uservm-0.png deleted file mode 100644 index bfcf98d0a..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-0.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-1.png b/doc/tutorials/images/ubuntu-uservm-1.png deleted file mode 100644 index 763a26527..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-1.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-2.png b/doc/tutorials/images/ubuntu-uservm-2.png deleted file mode 100644 index 307c5a7c2..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-2.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-3.png b/doc/tutorials/images/ubuntu-uservm-3.png deleted file mode 100644 index 627258489..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-3.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-4.png b/doc/tutorials/images/ubuntu-uservm-4.png deleted file mode 100644 index a67f9948e..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-4.png and /dev/null differ diff --git a/doc/tutorials/images/ubuntu-uservm-5.png b/doc/tutorials/images/ubuntu-uservm-5.png deleted file mode 100644 index a57235add..000000000 Binary files a/doc/tutorials/images/ubuntu-uservm-5.png and /dev/null differ diff --git a/doc/tutorials/images/vuart-config-1.png b/doc/tutorials/images/vuart-config-1.png deleted file mode 100644 index 42b0e30a4..000000000 Binary files a/doc/tutorials/images/vuart-config-1.png and /dev/null differ diff --git a/doc/tutorials/images/vuart-config-2.png b/doc/tutorials/images/vuart-config-2.png deleted file mode 100644 index d86ceab66..000000000 Binary files a/doc/tutorials/images/vuart-config-2.png and /dev/null differ diff --git a/doc/tutorials/images/vuart-config-post-launch.png b/doc/tutorials/images/vuart-config-post-launch.png deleted file mode 100644 index fe0773ce5..000000000 Binary files a/doc/tutorials/images/vuart-config-post-launch.png and /dev/null differ diff --git a/doc/tutorials/launch_uos.sh b/doc/tutorials/launch_uos.sh index 57811d025..289b4ad12 100755 --- a/doc/tutorials/launch_uos.sh +++ b/doc/tutorials/launch_uos.sh @@ -1,7 +1,7 @@ #!/bin/bash -# Copyright (C) 2018 Intel Corporation. +# Copyright (C) 2018-2022 Intel Corporation. # SPDX-License-Identifier: BSD-3-Clause diff --git a/doc/tutorials/upgrading_configuration.rst b/doc/tutorials/upgrading_configuration.rst index 92df34b34..715dac714 100644 --- a/doc/tutorials/upgrading_configuration.rst +++ b/doc/tutorials/upgrading_configuration.rst @@ -68,7 +68,7 @@ XML files into the merged format: .. code-block:: bash - misc/config_tools/scenario_config/upgrader.py --launch + misc/config_tools/scenario_config/upgrader.py --launch The upgrader migrates all data in both XMLs into the ```` and shows messages about discarded data in the same way as upgrading a scenario XML alone. diff --git a/doc/tutorials/vuart_configuration.rst b/doc/tutorials/vuart_configuration.rst index c0fe95f59..36b88b1f9 100644 --- a/doc/tutorials/vuart_configuration.rst +++ b/doc/tutorials/vuart_configuration.rst @@ -84,10 +84,17 @@ For the connection: To add another connection, click **+** on the right side of an existing connection. Or click **-** to delete a connection. + .. note:: + + The release v3.0 ACRN Configurator assigns COM2 (I/O address ``0x2F8``) to + the S5 feature. A conflict will occur if you assign ``0x2F8`` to another + connection. In our example, we'll use COM3 (I/O address ``0x3F8``). + .. image:: images/configurator-vuartconn01.png :align: center :class: drop-shadow + Example Configuration ===================== @@ -108,7 +115,7 @@ connection between two VMs. The example extends the information provided in the #. For the vUART type, this example uses ``Legacy``. - #. For the virtual I/O address, this example uses ``0x2f8``. + #. For the virtual I/O address, this example uses ``0x3E8``. .. image:: images/configurator-vuartconn01.png :align: center @@ -134,7 +141,7 @@ connection between two VMs. The example extends the information provided in the [ 0.105303] printk: console [tty0] enabled [ 0.105319] printk: console [ttyS0] enabled [ 1.391979] 00:03: ttyS0 at I/O 0x3f8 (irq = 4, base_baud = 115200) is a 16550A - [ 1.649819] serial8250: ttyS1 at I/O 0x2f8 (irq = 3, base_baud = 115200) is a 16550A + [ 1.649819] serial8250: ttyS1 at I/O 0x3e8 (irq = 5, base_baud = 115200) is a 16550A [ 3.394543] systemd[1]: Created slice system-serial\x2dgetty.slice. #. Test vUART communication: @@ -164,4 +171,4 @@ For details on ACRN vUART high-level design, see: * :ref:`hv-console-shell-uart` * :ref:`vuart_virtualization` -* :ref:`uart_virtualization` \ No newline at end of file +* :ref:`uart_virtualization` diff --git a/doc/user-guides/kernel-parameters.rst b/doc/user-guides/kernel-parameters.rst index 64a6a98fe..5358a37d9 100644 --- a/doc/user-guides/kernel-parameters.rst +++ b/doc/user-guides/kernel-parameters.rst @@ -336,6 +336,19 @@ relevant for configuring or debugging ACRN-based systems. hugepages=10 hugepagesz=1G + * - ``i915.modeset`` + - Service VM + - GPU driver loading option. + + ``0``: + Disable the GPU driver loading for Intel GPU device. + + ``1``: + Enable the GPU driver loading for Intel GPU device. + - :: + + i915.modeset=0 + .. note:: The ``hugepages`` and ``hugepagesz`` parameters are automatically taken care of by the ACRN Configurator tool. If users have customized hugepage settings to satisfy their particular workloads in the Service VM, diff --git a/misc/hv_prebuild/README.rst b/misc/hv_prebuild/README.rst new file mode 100644 index 000000000..7b564d476 --- /dev/null +++ b/misc/hv_prebuild/README.rst @@ -0,0 +1,14 @@ +:orphan: + +Hypervisor Pre-Build Check Tool +############################### + +There are a number of configuration elements for the ACRN hypervisor that must +defined before building the binaries. Those configuration elements are set +by the user using the :ref:`ACRN Configurator tool `. + + +This folder holds the source to a tool that is used to ensure that the +configuration is coherent and valid. It is a tool used in the background by +the build system before compiling the hypervisor and other components. It is +not meant to be used as a stand-alone too.