github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-07 19:24:34 +00:00
Code Issues Projects Releases Wiki Activity

doc: update doc for hybrid and logical_partition mode:

Browse Source 
using_hybrid_mode_on_nuc.rst
     using_partition_mode_on_nuc.rst

Signed-off-by: guoqingxz <guoqingx.q.zhang@intel.com>
This commit is contained in:
guoqingxz 2021-03-23 15:53:33 +08:00 committed by David Kinder
parent 83c82f01c3
commit 682ffb5234
3 changed files with 30 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/getting-started/building-from-source.rst
View File

@ -182,7 +182,7 @@ You can also build ACRN with your customized scenario:
.. code-block:: none .. code-block:: none
$ make BOARD=nuc6cayh SCENARIO=/path/to/scenario.xml $ make BOARD=$PWD/misc/config_tools/data/nuc6cayh/nuc6cayh.xml SCENARIO=/path/to/scenario.xml
* Build with your own board and scenario configuration, assuming the board and * Build with your own board and scenario configuration, assuming the board and
scenario XML files are ``/path/to/board.xml`` and ``/path/to/scenario.xml``: scenario XML files are ``/path/to/board.xml`` and ``/path/to/scenario.xml``:

7
doc/tutorials/using_hybrid_mode_on_nuc.rst
View File

@ -59,13 +59,12 @@ Perform the following to update Ubuntu GRUB so it can boot the hypervisor and lo
.. note:: The module ``/boot/zephyr.bin`` is the VM0 (Zephyr) kernel file. .. note:: The module ``/boot/zephyr.bin`` is the VM0 (Zephyr) kernel file.
The param ``xxxxxx`` is VM0's kernel file tag and must exactly match the The param ``xxxxxx`` is VM0's kernel file tag and must exactly match the
``kernel_mod_tag`` of VM0, which is configured in the ``misc/vm_configs/scenarios/hybrid/vm_configurations.c`` ``kern_mod`` of VM0, which is configured in the ``misc/config_tools/data/nuc7i7dnb/hybrid.xml``
file. The multiboot module ``/boot/bzImage`` is the Service VM kernel file. The multiboot module ``/boot/bzImage`` is the Service VM kernel
file. The param ``yyyyyy`` is the bzImage tag and must exactly match the file. The param ``yyyyyy`` is the bzImage tag and must exactly match the
``kernel_mod_tag`` of VM1 in the ``misc/vm_configs/scenarios/hybrid/vm_configurations.c`` ``kern_mod`` of VM1 in the ``misc/config_tools/data/nuc7i7dnb/hybrid.xml``
file. The kernel command-line arguments used to boot the Service VM are file. The kernel command-line arguments used to boot the Service VM are
located in the header file ``misc/vm_configs/scenarios/hybrid/vm_configurations.h`` ``bootargs`` of VM1 in the ``misc/config_tools/data/nuc7i7dnb/hybrid.xml``.
and are configured by the `SOS_VM_BOOTARGS` macro.
The module ``/boot/ACPI_VM0.bin`` is the binary of ACPI tables for pre-launched VM0 (Zephyr). The module ``/boot/ACPI_VM0.bin`` is the binary of ACPI tables for pre-launched VM0 (Zephyr).
The parameter ``ACPI_VM0`` is VM0's ACPI tag and should not be modified. The parameter ``ACPI_VM0`` is VM0's ACPI tag and should not be modified.

47
doc/tutorials/using_partition_mode_on_nuc.rst
View File

@ -18,8 +18,8 @@ Validated Versions
****************** ******************
- Ubuntu version: **18.04** - Ubuntu version: **18.04**
- ACRN hypervisor tag: **v2.3** - ACRN hypervisor tag: **v2.4**
- ACRN kernel tag: **v2.3** - ACRN kernel tag: **v2.4**
Prerequisites Prerequisites
************* *************
@ -128,16 +128,20 @@ Update ACRN Hypervisor Image
.. code-block:: none .. code-block:: none
$ sudo lspci -vv $ sudo lspci -vv
00:14.0 USB controller: Intel Corporation Sunrise Point-LP USB 3.0 xHCI Controller (rev 21) (prog-if 30 [XHCI]) 00:14.0 USB controller: Intel Corporation Device 9ded (rev 30) (prog-if 30 [XHCI])
Subsystem: Intel Corporation Sunrise Point-LP USB 3.0 xHCI Controller Subsystem: Intel Corporation Device 7270
00:17.0 SATA controller: Intel Corporation Sunrise Point-LP SATA Controller [AHCI mode] (rev 21) (prog-if 01 [AHCI 1.0]) 00:17.0 SATA controller: Intel Corporation Device 9dd3 (rev 30) (prog-if 01 [AHCI 1.0])
Subsystem: Intel Corporation Sunrise Point-LP SATA Controller [AHCI mode] Subsystem: Intel Corporation Device 7270
00:1f.6 Ethernet controller: Intel Corporation Ethernet Connection I219-LM (rev 21) 02:00.0 Non-Volatile memory controller: Intel Corporation Device f1a8 (rev 03) (prog-if 02 [NVM Express])
Subsystem: Intel Corporation Ethernet Connection I219-LM Subsystem: Intel Corporation Device 390d
03:00.0 Ethernet controller: Intel Corporation I210 Gigabit Network Connection (rev 03)
Subsystem: Intel Corporation I210 Gigabit Network Connection
04:00.0 Ethernet controller: Intel Corporation I210 Gigabit Network Connection (rev 03)
Subsystem: Intel Corporation I210 Gigabit Network Connection
.. note:: .. note::
Verify the PCI devices BDF defined in the Verify the ``pci_devs`` defined for VM0 and VM1 in the
``hypervisor/arch/x86/configs/whl-ipc-i5/pci_devices.h`` ``misc/config_tools/data/whl-ipc-i7/logical_partition.xml``
with the information reported by the ``lspci -vv`` command. with the information reported by the ``lspci -vv`` command.
#. Clone the ACRN source code and configure the build options. #. Clone the ACRN source code and configure the build options.
@ -145,19 +149,19 @@ Update ACRN Hypervisor Image
Refer to :ref:`getting-started-building` to set up the ACRN build Refer to :ref:`getting-started-building` to set up the ACRN build
environment on your development workstation. environment on your development workstation.
Clone the ACRN source code and check out to the tag v2.3: Clone the ACRN source code and check out to the tag v2.4:
.. code-block:: none .. code-block:: none
$ git clone https://github.com/projectacrn/acrn-hypervisor.git $ git clone https://github.com/projectacrn/acrn-hypervisor.git
$ cd acrn-hypervisor $ cd acrn-hypervisor
$ git checkout v2.3 $ git checkout v2.4
Build the ACRN hypervisor and ACPI binaries for pre-launched VMs with default xmls: Build the ACRN hypervisor and ACPI binaries for pre-launched VMs with default xmls:
.. code-block:: none .. code-block:: none
$ make hypervisor 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/logical_partition.xml RELEASE=0 $ make hypervisor BOARD_FILE=whl-ipc-i7 SCENARIO_FILE=logical_partition RELEASE=0
.. note:: .. note::
The ``acrn.bin`` will be generated to ``./build/hypervisor/acrn.bin``. The ``acrn.bin`` will be generated to ``./build/hypervisor/acrn.bin``.
@ -176,9 +180,9 @@ Update ACRN Hypervisor Image
The above command output should contain the ``GRUB`` keyword. The above command output should contain the ``GRUB`` keyword.
#. Check or update the BDF information of the PCI devices for each #. Check or update the BDF information of the PCI devices for each
pre-launched VM; check it in the ``hypervisor/arch/x86/configs/whl-ipc-i5/pci_devices.h``. pre-launched VM; check it in the ``misc/config_tools/data/whl-ipc-i7/logical_partition.xml``.
#. Copy the artifact ``acrn.bin``, ``ACPI_VM0.bin``, and ``ACPI_VM1.bin`` to the ``/boot`` directory: #. Copy the artifact ``acrn.bin``, ``ACPI_VM0.bin``, and ``ACPI_VM1.bin`` to the ``/boot`` directory on NVME:
#. Copy ``acrn.bin``, ``ACPI_VM1.bin`` and ``ACPI_VM0.bin`` to a removable disk. #. Copy ``acrn.bin``, ``ACPI_VM1.bin`` and ``ACPI_VM0.bin`` to a removable disk.
@ -213,13 +217,12 @@ Update Ubuntu GRUB to Boot Hypervisor and Load Kernel Image
} }
.. note:: .. note::
Update this to use the UUID (``--set``) and PARTUUID (``root=`` parameter) Update the UUID (``--set``) and PARTUUID (``root=`` parameter)
(or use the device node directly) of the root partition (e.g.``/dev/nvme0n1p2). Hint: use ``sudo blkid``. (or use the device node directly) of the root partition (e.g.``/dev/nvme0n1p2). Hint: use ``sudo blkid``.
The kernel command-line arguments used to boot the pre-launched VMs is The kernel command-line arguments used to boot the pre-launched VMs is ``bootargs``
located in the ``misc/vm_configs/scenarios/hybrid/vm_configurations.h`` header file in the ``misc/config_tools/data/whl-ipc-i7/logical_partition.xml``
and is configured by ``VMx_CONFIG_OS_BOOTARG_*`` MACROs (where x is the VM ID number and ``*`` are arguments). The ``module2 /boot/bzImage`` param ``XXXXXX`` is the bzImage tag and must exactly match the ``kern_mod``
The multiboot2 module param ``XXXXXX`` is the bzImage tag and must exactly match the ``kernel_mod_tag`` in the ``misc/config_tools/data/whl-ipc-i7/logical_partition.xml`` file.
configured in the ``misc/vm_configs/scenarios/hybrid/vm_configurations.c`` file.
The module ``/boot/ACPI_VM0.bin`` is the binary of ACPI tables for pre-launched VM0, the parameter ``ACPI_VM0`` is The module ``/boot/ACPI_VM0.bin`` is the binary of ACPI tables for pre-launched VM0, the parameter ``ACPI_VM0`` is
VM0's ACPI tag and should not be modified. VM0's ACPI tag and should not be modified.
The module ``/boot/ACPI_VM1.bin`` is the binary of ACPI tables for pre-launched VM1 the parameter ``ACPI_VM1`` is The module ``/boot/ACPI_VM1.bin`` is the binary of ACPI tables for pre-launched VM1 the parameter ``ACPI_VM1`` is
@ -231,6 +234,8 @@ Update Ubuntu GRUB to Boot Hypervisor and Load Kernel Image
.. code-block:: none .. code-block:: none
GRUB_DEFAULT=ACRN_Logical_Partition GRUB_DEFAULT=ACRN_Logical_Partition
#GRUB_HIDDEN_TIMEOUT=0
#GRUB_HIDDEN_TIMEOUT_QUIET=true
GRUB_TIMEOUT=10 GRUB_TIMEOUT=10
GRUB_DISTRIBUTOR=`lsb_release -i -s 2> /dev/null || echo Debian` GRUB_DISTRIBUTOR=`lsb_release -i -s 2> /dev/null || echo Debian`
GRUB_CMDLINE_LINUX_DEFAULT="quiet splash" GRUB_CMDLINE_LINUX_DEFAULT="quiet splash"