doc: terminology cleanup in RTVM tutorial

- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes 2021-11-15 22:40:51 -08:00 committed by David Kinder
parent 638027fca1
commit 28560c1db7
2 changed files with 31 additions and 31 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -1,13 +1,13 @@
.. _pre_launched_rt:
Pre-Launched Preempt-Rt Linux Mode in ACRN
Pre-Launched Preempt-RT Linux Mode in ACRN
##########################################
The Pre-Launched Preempt-RT Linux Mode of ACRN, abbreviated as
Pre-Launched RT mode, is an ACRN configuration scenario. Pre-Launched RT
mode allows you to boot ACRN with a preempt-rt Linux running in VM0, and
the Service VM running in VM1. VM0 and VM1 are both pre-launched VMs,
and their resources are partitioned from those on the physical platform.
mode enables you to create a pre-launched real-time VM (RTVM) running
Preempt-RT Linux (VM0) and a Service VM (VM1). Their resources are partitioned
from those on the physical platform.
.. figure:: images/pre_launched_rt.png
:align: center
@ -15,12 +15,12 @@ and their resources are partitioned from those on the physical platform.
Prerequisites
*************
Because the Pre-Launched RT VM and Service VM are physically isolated
Because the pre-launched RTVM and Service VM are physically isolated
from each other, they must have their own devices to run a common OS,
such as Linux. Also, the platform must support booting ACRN with
multiple kernel images. So, your platform must have:
- Two hard disk drives, one for the Pre-Launched RT and one for the Service
- Two hard disk drives, one for the pre-launched RTVM and one for the Service
VM
- Two network devices
- GRUB multiboot support
@ -30,29 +30,29 @@ Example of Pre-Launched RT
Take the Whiskey Lake WHL-IPC-I5 board (as described in :ref:`hardware`) for
example. This platform can connect both an NVMe and a SATA drive and has
two Ethernet ports. We will passthrough the SATA and Ethernet 03:00.0
devices into the Pre-Launched RT VM, and give the rest of the devices to
two Ethernet ports. We will pass through the SATA and Ethernet 03:00.0
devices into the pre-launched RTVM, and give the rest of the devices to
the Service VM.
Install SOS With Grub on NVMe
=============================
Install Service VM OS With GRUB on NVMe
=======================================
As with the Hybrid and Logical Partition scenarios, the Pre-Launched RT
As with the Hybrid and Partition scenarios, the Pre-Launched RT
mode must boot using GRUB. The ACRN hypervisor is loaded as a GRUB
multiboot kernel, while the Pre-Launched RT kernel and Service VM
kernels are loaded as multiboot modules. The ACRN hypervisor, Service
VM, and Pre-Launched RT kernel images are all located on the NVMe drive.
multiboot kernel, while the pre-launched RTVM kernel and Service VM
kernel are loaded as multiboot modules. The ACRN hypervisor, Service
VM, and pre-launched RTVM kernel images are all located on the NVMe drive.
We recommend installing Ubuntu on the NVMe drive as the Service VM OS,
which also has the required GRUB image to launch Pre-Launched RT mode.
Refer to :ref:`gsg`, to
install Ubuntu on the NVMe drive, and use grub to launch the Service VM.
Refer to :ref:`gsg` to
install Ubuntu on the NVMe drive, and use GRUB to launch the Service VM.
Install Pre-Launched RT Filesystem on SATA and Kernel Image on NVMe
===================================================================
Follow the :ref:`gsg` to install RT rootfs on SATA drive.
Follow the :ref:`gsg` to install RT rootfs on the SATA drive.
The Kernel should
The kernel should
be on the NVMe drive along with GRUB. You'll need to copy the RT kernel
to the NVMe drive. Once you have successfully installed and booted
Ubuntu from the NVMe drive, you'll then need to copy the RT kernel from
@ -60,30 +60,30 @@ the SATA to the NVMe drive:
.. code-block:: none
# mount /dev/nvme0n1p1 /boot
# mount /dev/sda1 /mnt
# cp /mnt/bzImage /boot/EFI/BOOT/bzImage_RT
sudo mount /dev/nvme0n1p1 /boot
sudo mount /dev/sda1 /mnt
sudo cp /mnt/bzImage /boot/EFI/BOOT/bzImage_RT
Build ACRN With Pre-Launched RT Mode
====================================
The ACRN VM configuration framework can easily configure resources for
Pre-Launched VMs. On Whiskey Lake WHL-IPC-I5, to passthrough SATA and
Ethernet 03:00.0 devices to the Pre-Launched RT VM, build ACRN with:
pre-launched VMs. On Whiskey Lake WHL-IPC-I5, to pass through SATA and
Ethernet 03:00.0 devices to the pre-launched RTVM, build ACRN with:
.. code-block:: none
make BOARD_FILE=$PWD/misc/acrn-config/xmls/board-xmls/whl-ipc-i5.xml SCENARIO_FILE=$PWD/misc/acrn-config/xmls/config-xmls/whl-ipc-i5/hybrid_rt.xml RELEASE=0
make BOARD=whl-ipc-i5 SCENARIO=hybrid_rt
After the build completes, update ACRN on NVMe. It is
/boot/EFI/BOOT/acrn.bin, if /dev/nvme0n1p1 is mounted at /boot.
``/boot/EFI/BOOT/acrn.bin``, if ``/dev/nvme0n1p1`` is mounted at ``/boot``.
Add Pre-Launched RT Kernel Image to GRUB Config
===============================================
The last step is to modify the GRUB configuration file to load the Pre-Launched
kernel. (For more information about this, see
the :ref:`gsg`.) The grub config file will look something
The last step is to modify the GRUB configuration file to load the pre-launched
RTVM kernel. (For more information about this, see
the :ref:`gsg`.) The GRUB configuration file will look something
like this:
.. code-block:: none
@ -96,7 +96,7 @@ like this:
module2 /boot/ACPI_VM0.bin ACPI_VM0
}
Reboot the system, and it will boot into Pre-Launched RT Mode
Reboot the system, and it will boot into Pre-Launched RT Mode:
.. code-block:: none
@ -104,10 +104,10 @@ Reboot the system, and it will boot into Pre-Launched RT Mode
VM_UUID VM_ID VM_NAME VM_STATE
================================ ===== ================================ ========
26c5e0d88f8a47d88109f201ebd61a5e 0 ACRN PRE-LAUNCHED VM0 Running
dbbbd4347a574216a12c2201f1ab0240 1 ACRN SOS VM Running
dbbbd4347a574216a12c2201f1ab0240 1 ACRN Service VM Running
ACRN:\>
Connect console of VM0, via 'vm_console' ACRN shell command (Press
Connect to the console of VM0, via ``vm_console`` ACRN shell command. (Press
:kbd:`Ctrl` + :kbd:`Space` to return to the ACRN shell.)
.. code-block:: none