mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-09-23 09:47:44 +00:00
doc: fix mispellings and formatting
* 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>
This commit is contained in:
David B. Kinder
committed by
David Kinder
David Kinder
parent
ac67051ab5
commit
0d03224070
@@ -199,7 +199,7 @@ Linux-based VMs (VM0 is a pre-launched VM and VM2 is a post-launched VM).
|
||||
.. code-block:: none
|
||||
:emphasize-lines: 2,3
|
||||
|
||||
<IVSHMEM desc="IVSHMEM configuration">
|
||||
<IVSHMEM>
|
||||
<IVSHMEM_ENABLED>y</IVSHMEM_ENABLED>
|
||||
<IVSHMEM_REGION>hv:/shm_region_0, 2, 0:2</IVSHMEM_REGION>
|
||||
</IVSHMEM>
|
||||
|
||||
@@ -75,7 +75,7 @@ Ethernet 03:00.0 devices to the Pre-Launched RT VM, build ACRN with:
|
||||
|
||||
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
|
||||
|
||||
After the build completes, please update ACRN on NVMe. It is
|
||||
After the build completes, update ACRN on NVMe. It is
|
||||
/boot/EFI/BOOT/acrn.bin, if /dev/nvme0n1p1 is mounted at /boot.
|
||||
|
||||
Add Pre-Launched RT Kernel Image to GRUB Config
|
||||
|
||||
@@ -155,14 +155,14 @@ Configure RDT for VM Using VM Configuration
|
||||
:emphasize-lines: 6
|
||||
|
||||
<FEATURES>
|
||||
<RELOC desc="Enable hypervisor relocation">y</RELOC>
|
||||
<SCHEDULER desc="The CPU scheduler to be used by the hypervisor.">SCHED_BVT</SCHEDULER>
|
||||
<MULTIBOOT2 desc="Support boot ACRN from multiboot2 protocol.">y</MULTIBOOT2>
|
||||
<RDT desc="Intel RDT (Resource Director Technology).">
|
||||
<RDT_ENABLED desc="Enable RDT">*y*</RDT_ENABLED>
|
||||
<CDP_ENABLED desc="CDP (Code and Data Prioritization). CDP is an extension of CAT.">n</CDP_ENABLED>
|
||||
<CLOS_MASK desc="Cache Capacity Bitmask"></CLOS_MASK>
|
||||
<MBA_DELAY desc="Memory Bandwidth Allocation delay value"></MBA_DELAY>
|
||||
<RELOC>y</RELOC>
|
||||
<SCHEDULER>SCHED_BVT</SCHEDULER>
|
||||
<MULTIBOOT2>y</MULTIBOOT2>
|
||||
<RDT>
|
||||
<RDT_ENABLED>y</RDT_ENABLED>
|
||||
<CDP_ENABLED>n</CDP_ENABLED>
|
||||
<CLOS_MASK></CLOS_MASK>
|
||||
<MBA_DELAY></MBA_DELAY>
|
||||
</RDT>
|
||||
|
||||
#. Once RDT is enabled in the scenario XML file, the next step is to program
|
||||
@@ -177,17 +177,17 @@ Configure RDT for VM Using VM Configuration
|
||||
:emphasize-lines: 8,9,10,11,12
|
||||
|
||||
<FEATURES>
|
||||
<RELOC desc="Enable hypervisor relocation">y</RELOC>
|
||||
<SCHEDULER desc="The CPU scheduler to be used by the hypervisor.">SCHED_BVT</SCHEDULER>
|
||||
<MULTIBOOT2 desc="Support boot ACRN from multiboot2 protocol.">y</MULTIBOOT2>
|
||||
<RDT desc="Intel RDT (Resource Director Technology).">
|
||||
<RDT_ENABLED desc="Enable RDT">y</RDT_ENABLED>
|
||||
<CDP_ENABLED desc="CDP (Code and Data Prioritization). CDP is an extension of CAT.">n</CDP_ENABLED>
|
||||
<CLOS_MASK desc="Cache Capacity Bitmask">*0xff*</CLOS_MASK>
|
||||
<CLOS_MASK desc="Cache Capacity Bitmask">*0x3f*</CLOS_MASK>
|
||||
<CLOS_MASK desc="Cache Capacity Bitmask">*0xf*</CLOS_MASK>
|
||||
<CLOS_MASK desc="Cache Capacity Bitmask">*0x3*</CLOS_MASK>
|
||||
<MBA_DELAY desc="Memory Bandwidth Allocation delay value">*0*</MBA_DELAY>
|
||||
<RELOC>y</RELOC>
|
||||
<SCHEDULER>SCHED_BVT</SCHEDULER>
|
||||
<MULTIBOOT2>y</MULTIBOOT2>
|
||||
<RDT>
|
||||
<RDT_ENABLED>y</RDT_ENABLED>
|
||||
<CDP_ENABLED>n</CDP_ENABLED>
|
||||
<CLOS_MASK>0xff</CLOS_MASK>
|
||||
<CLOS_MASK>0x3f</CLOS_MASK>
|
||||
<CLOS_MASK>0xf</CLOS_MASK>
|
||||
<CLOS_MASK>0x3</CLOS_MASK>
|
||||
<MBA_DELAY>0</MBA_DELAY>
|
||||
</RDT>
|
||||
|
||||
.. note::
|
||||
@@ -206,12 +206,12 @@ Configure RDT for VM Using VM Configuration
|
||||
:emphasize-lines: 5,6,7,8
|
||||
|
||||
<vm id="0">
|
||||
<vm_type desc="Specify the VM type" readonly="true">PRE_STD_VM</vm_type>
|
||||
<name desc="Specify the VM name which will be shown in hypervisor console command: vm_list.">ACRN PRE-LAUNCHED VM0</name>
|
||||
<uuid configurable="0" desc="vm uuid">26c5e0d8-8f8a-47d8-8109-f201ebd61a5e</uuid>
|
||||
<clos desc="Class of Service for Cache Allocation Technology. Please refer SDM 17.19.2 for details and use with caution.">
|
||||
<vcpu_clos>*0*</vcpu_clos>
|
||||
<vcpu_clos>*1*</vcpu_clos>
|
||||
<vm_type readonly="true">PRE_STD_VM</vm_type>
|
||||
<name>ACRN PRE-LAUNCHED VM0</name>
|
||||
<uuid configurable="0">26c5e0d8-8f8a-47d8-8109-f201ebd61a5e</uuid>
|
||||
<clos>
|
||||
<vcpu_clos>0</vcpu_clos>
|
||||
<vcpu_clos>1</vcpu_clos>
|
||||
</clos>
|
||||
</vm>
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ Tip: Do not share CPUs allocated to the RTVM with other RT or non-RT VMs.
|
||||
However, for an RT VM, CPUs should be dedicatedly allocated for determinism.
|
||||
|
||||
Tip: Use RDT such as CAT and MBA to allocate dedicated resources to the RTVM.
|
||||
ACRN enables Intel® Resource Director Technology such as CAT, and MBA
|
||||
ACRN enables Intel Resource Director Technology such as CAT, and MBA
|
||||
components such as the GPU via the memory hierarchy. The availability of RDT is
|
||||
hardware-specific. Refer to the :ref:`rdt_configuration`.
|
||||
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
Enable SGX Virtualization
|
||||
#########################
|
||||
|
||||
SGX refers to `Intel® Software Guard Extensions <https://software.intel.com/
|
||||
en-us/sgx>`_ (Intel® SGX). This is a set of instructions that can be used by
|
||||
SGX refers to `Intel Software Guard Extensions <https://software.intel.com/
|
||||
en-us/sgx>`_ (Intel SGX). This is a set of instructions that can be used by
|
||||
applications to set aside protected areas for select code and data in order to
|
||||
prevent direct attacks on executing code or data stored in memory. SGX allows
|
||||
an application to instantiate a protected container, referred to as an
|
||||
|
||||
@@ -94,16 +94,16 @@ Convert the BDF to Hex Format
|
||||
Refer this :ref:`hv-parameters` to change bdf 01:00.1 to Hex format: 0x101;
|
||||
then add it to the grub menu:
|
||||
|
||||
.. Note::
|
||||
.. code-block:: bash
|
||||
|
||||
multiboot2 /boot/acrn.bin root=PARTUUID="b1bebafc-2b06-43e2-bf6a-323337daebc0“ uart=bdf@0x101
|
||||
multiboot2 /boot/acrn.bin root=PARTUUID="b1bebafc-2b06-43e2-bf6a-323337daebc0" uart=bdf@0x101
|
||||
|
||||
.. Note::
|
||||
|
||||
uart=bdf@0x100 for port 1
|
||||
``uart=bdf@0x100`` for port 1
|
||||
|
||||
uart=bdf@0x101 for port 2
|
||||
``uart=bdf@0x101`` for port 2
|
||||
|
||||
uart=bdf@0x101 is preferred for the industry scenario; otherwise, it can't
|
||||
``uart=bdf@0x101`` is preferred for the industry scenario; otherwise, it can't
|
||||
input in the Hypervisor console after the Service VM boots up.
|
||||
There is no such limitation for the hybrid or hybrid_rt scenarios.
|
||||
|
||||
@@ -22,7 +22,7 @@ the OEM can generate their own PK.
|
||||
|
||||
Here we show two ways to generate a PK: ``openssl`` and Microsoft tools.
|
||||
|
||||
Generate PK Using Openssl
|
||||
Generate PK Using OpenSSL
|
||||
=========================
|
||||
|
||||
- Generate a Self-Signed Certificate as PK from a new key using the
|
||||
@@ -139,7 +139,7 @@ which we'll summarize below.
|
||||
(CSP)
|
||||
|
||||
For the detailed information of each Microsoft Cryptographic Service
|
||||
Provider, please check the `Microsoft CRP document
|
||||
Provider, check the `Microsoft CRP document
|
||||
<https://docs.microsoft.com/en-us/windows/desktop/seccrypto/microsoft-cryptographic-service-providers>`_
|
||||
|
||||
Here, we chose "Microsoft Strong Cryptographic Provider" for example::
|
||||
@@ -393,12 +393,12 @@ Download KEK and DB From Microsoft
|
||||
KEK (Key Exchange Key):
|
||||
`Microsoft Corporation KEK CA 2011
|
||||
<https://go.microsoft.com/fwlink/p/?linkid=321185>`_:
|
||||
allows updates to db and dbx.
|
||||
allows updates to DB and DBX.
|
||||
|
||||
DB (Allowed Signature database):
|
||||
`Microsoft Windows Production CA 2011
|
||||
<https://go.microsoft.com/fwlink/?LinkId=321192>`_:
|
||||
This CA in the Signature Database (db) allows Windows to boot.
|
||||
This CA in the Signature Database (DB) allows Windows to boot.
|
||||
|
||||
`Microsoft Corporation UEFI CA 2011
|
||||
<https://go.microsoft.com/fwlink/p/?LinkID=321194>`_:
|
||||
@@ -407,25 +407,28 @@ DB (Allowed Signature database):
|
||||
Compile OVMF With Secure Boot Support
|
||||
*************************************
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/projectacrn/acrn-edk2.git
|
||||
git clone https://github.com/projectacrn/acrn-edk2.git
|
||||
|
||||
cd acrn-edk2
|
||||
cd acrn-edk2
|
||||
|
||||
git checkout -b ovmf b64fe247c434e2a4228b9804c522575804550f82
|
||||
git checkout -b ovmf b64fe247c434e2a4228b9804c522575804550f82
|
||||
|
||||
git submodule update --init CryptoPkg/Library/OpensslLib/openssl
|
||||
git submodule update --init CryptoPkg/Library/OpensslLib/openssl
|
||||
|
||||
source edksetup.sh
|
||||
make -C BaseTools
|
||||
source edksetup.sh
|
||||
make -C BaseTools
|
||||
|
||||
vim Conf/target.txt
|
||||
Edit the ``Conf/target.txt`` file and set these values::
|
||||
|
||||
ACTIVE_PLATFORM = OvmfPkg/OvmfPkgX64.dsc
|
||||
TARGET_ARCH = X64
|
||||
TOOL_CHAIN_TAG = GCC5
|
||||
ACTIVE_PLATFORM = OvmfPkg/OvmfPkgX64.dsc
|
||||
TARGET_ARCH = X64
|
||||
TOOL_CHAIN_TAG = GCC5
|
||||
|
||||
build -DFD_SIZE_2MB -DDEBUG_ON_SERIAL_PORT=TRUE -DSECURE_BOOT_ENABLE
|
||||
Then continue doing the build::
|
||||
|
||||
build -DFD_SIZE_2MB -DDEBUG_ON_SERIAL_PORT=TRUE -DSECURE_BOOT_ENABLE
|
||||
|
||||
|
||||
Notes:
|
||||
|
||||
Reference in New Issue
Block a user