diff --git a/misc/config_tools/schema/VMtypes.xsd b/misc/config_tools/schema/VMtypes.xsd index 94335e3e7..380e966de 100644 --- a/misc/config_tools/schema/VMtypes.xsd +++ b/misc/config_tools/schema/VMtypes.xsd @@ -72,13 +72,13 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. - - Specify SGX EPC section base, must be page aligned. (Default value is 0) + + Specify the enclave page cache (EPC) section base for Intel Software Guard Extensions (SGX). Must be page aligned. - - Specify SGX EPC section size in Bytes, must be page aligned. (Default value is 0) + + Specify the enclave page cache (EPC) section size in bytes for Intel Software Guard Extensions (SGX). Must be page aligned. @@ -118,22 +118,22 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. - Specify the kernel image type so the hypervisor can load it correctly. + Select the kernel image type so that the hypervisor can load it correctly. - Enter the tag for the kernel image that is used as a multiboot module. It must exactly match the module tag in the GRUB multiboot cmdline. + Specify the tag for the kernel image that is used as a multiboot module. The tag's spelling must exactly match the module tag in the GRUB multiboot cmdline. - Specify the tag for the ramdisk image that is used as a multiboot module. It must exactly match the module tag in the GRUB multiboot cmdline. + Specify the tag for the RAMdisk image that is used as a multiboot module. The tag's spelling must exactly match the module tag in the GRUB multiboot cmdline. - - Specify configurable boot argument for pre-launched or Service VM. + + Specify the command-line parameters that will be used to boot the kernel for this VM. See `Linux documentation <https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html>`__ for a list of parameters. @@ -207,13 +207,13 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. - - Passthrough the Trusted Platform Module (TPM2) device to this VM. (Optional) (Default value is n) + + Pass through the trusted platform module (TPM2) device to this VM. - Passthrough the P2SB (Primary-to-Sideband) bridge register access BAR to the this VM. (Optional) (Default value is n) + Pass through the Primary-to-Sideband (P2SB) bridge register access BAR to this VM. diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd index b9209b416..fde228dae 100644 --- a/misc/config_tools/schema/config.xsd +++ b/misc/config_tools/schema/config.xsd @@ -15,27 +15,27 @@ - Identify build type. Debug mode enables debug shell, prints, and logs. Release mode optimizes the ACRN binary for deployment and turns off all debug infrastructure. These can only be changed at build time. + Select the build type. Debug mode enables debug shell, prints, and logs. Release mode optimizes the ACRN binary for deployment and turns off all debug infrastructure. These settings can only be changed at build time. - Specify the host serial device used for hypervisor debugging. + Select the host serial device used for hypervisor debugging. - Specify default log level for log messages stored in memory. Value can be changed at runtime. Log messages with the selected value or lower are displayed. + Select the default log level for log messages stored in memory. Value can be changed at runtime. Log messages with the selected value or lower are displayed. - Specify default log level for the hypervisor via Intel Trace Hub log. Use the Intel Trace Hub's memory to record log messages. Value can be changed at runtime. Log messages with the selected value or lower are displayed. + Select the default log level for the hypervisor via Intel Trace Hub log. Use the Intel Trace Hub's memory to record log messages. Value can be changed at runtime. Log messages with the selected value or lower are displayed. - Specify default log level for log messages written to the serial console. Log messages with the selected value or lower are displayed. + Select the default log level for log messages written to the serial console. Log messages with the selected value or lower are displayed. @@ -49,27 +49,27 @@ - Enable hypervisor relocation in memory. The boot loader may need to change the location of the hypervisor because of other firmware. + Enable hypervisor relocation in memory. The bootloader may need to change the location of the hypervisor because of other firmware. - - Choose scheduling algorithm used for determining which User VM runs on a shared virtual CPU. + + Select the scheduling algorithm used to determine which User VM runs on a shared virtual CPU. - - Enable multiboot2 boot protocol support and multiboot1 downward compatibility. Disable this feature if multiboot1 meets your requirements and to reduce lines of code. + + Enable multiboot2 protocol support and multiboot1 downward compatibility. Disable this feature if multiboot1 meets your requirements and to reduce lines of code. - Enable split lock detection for real-time application. This prevents alignment check exceptions from impacting hypervisor real-time performance. + Enable detection of split locks, which can negatively affect an application's real-time performance. If a lock is detected, an alignment check exception #AC occurs. - - Enable UC lock detection for real-time application. This prevents general protection faults from impacting hypervisor real-time performance. + + Enable detection of uncacheable-memory locks, which can negatively affect an application's real-time performance. If a lock is detected, a general-protection exception #GP occurs. @@ -83,13 +83,13 @@ - - Enable Intel Resource Director Technology (RDT). The technology provides cache and memory allocation features to improve time performance of real-time VMs. + + Intel Resource Director Technology (RDT) provides cache and memory bandwidth allocation features. The features can be used to improve an application's real-time performance. - - Enable Microsoft(R) Hypervisor Top-Level Functional Specification for Windows hyper-v support. + + Enable Microsoft Hyper-V Hypervisor Top-Level Functional Specification (TFLS) for Windows User VMs. @@ -99,17 +99,17 @@ - Enable ACPI runtime parsing to get DMAR (DMA remapping) configuration data from the APCI tables. Otherwise, use existing, static information from the associated board.xml file. + Enable ACPI runtime parsing to get DMAR (DMA remapping) configuration data from the APCI tables. Otherwise, use existing, static information from the associated board configuration file. - Enable L1 cache flush before VM entry,Determine the enabling of mitigation solution for L1 Terminal Fault (L1TF). The L1 data cache will be flushed before each VMENTRY.L1TF is a speculative execution side channel cache timing vulnerability. Each variety of L1TF could potentially allow unauthorized disclosure of information residing in the L1 data cache. + Enable L1 cache flush before VM entry to prevent L1 terminal fault. L1 terminal fault is a hardware vulnerability that allows unauthorized disclosure of information residing in the L1 data cache. - - Enable software workaround for Machine Check Error on Page Size Change (silicon bug in some processor families). + + Enable the software workaround for Machine Check Error on Page Size Change (hardware bug in some processor families). @@ -128,8 +128,8 @@ - - Capacity of one stack (in bytes) used by a physical core. Each core uses one stack for normal operation and another three for specific exceptions. + + Specify the size of the memory stack in bytes for each physical CPU. For example, if you specify 8 kilobytes, each CPU will get its own 8-kilobyte stack. @@ -166,7 +166,7 @@ - Specify the static memory allocation of maximum number of PCI devices. (Default value is 96) + Specify the maximum number of PCI devices. This impacts the amount of memory used to maintain information about these PCI devices. The default value is calculated from the board configuration file. If you have PCI devices that were not detected by the Board Inspector, you may need to change this maximum value. @@ -193,13 +193,13 @@ - - The pre-defined number of interrupt sources of all pass-through devices. + + Specify the maximum number of interrupt request (IRQ) entries from all passthrough devices. - - Specify maximum number of MSI-X tables per device. If this value is empty, then the default value will be calculated from the board XML file. (Default value is 64) + + Specify the maximum number of Message Signaled Interrupt MSI-X tables per device. The default value is calculated from the board configuration file. @@ -212,8 +212,8 @@ - - Specify maximum number of emulated MMIO regions. (Default value is 16) + + Specify the maximum number of emulated MMIO regions for device virtualization. The default value is calculated from the board configuration file. @@ -267,7 +267,7 @@ - Specify the vUART connection setting. + Specify the vUART connection settings. Refer to :ref:`vuart_config` for detailed vUART settings. @@ -283,12 +283,12 @@ Refer to :ref:`vuart_config` for detailed vUART settings. - Specify the VM type. + Select the VM type. A standard VM (``STANDARD_VM``) is for general-purpose applications, such as human-machine interface (HMI). A real-time VM (``RTVM``) offers special features for time-sensitive applications. - Type in the name used to identify each VM. The VM name will be shown in the hypervisor console vm_list command. + Specify the name used to identify this VM. The VM name will be shown in the hypervisor console vm_list command. @@ -303,22 +303,22 @@ Refer to :ref:`vuart_config` for detailed vUART settings. - Specify LAPIC to passthrough. + Enable LAPIC passthrough for this VM. This feature is required for VMs with stringent real-time performance needs. - Specify Polling mode for IO Completion. + Enable polling mode for I/O completion for this VM. This feature is required for VMs with stringent real-time performance needs. - - Specify nested virtualization support for KVM. + + Enable nested virtualization for KVM. - - Specify virtual CAT support for VM. + + Enable virtualization of the Cache Allocation Technology (CAT) feature in RDT. CAT enables you to allocate cache to VMs, providing isolation to avoid performance interference from other VMs. @@ -338,7 +338,7 @@ Refer to :ref:`vuart_config` for detailed vUART settings. - List of pCPU that this VM's vCPUs are pinned to. + Select a subset of physical CPUs that this VM can use. More than one can be selected. @@ -349,7 +349,7 @@ Refer SDM 17.19.2 for details, and use with caution. - Specify SGX Enclave Page Cache section base and size in byte. It must be page aligned. + Specify the Intel Software Guard Extensions (SGX) enclave page cache (EPC) section settings. @@ -374,9 +374,8 @@ argument and memory. - - Specify the console vUART (aka PCI based vUART) with the vUART ID by -its ``id`` attribute. + + Select the console virtual UART (vUART) type. Add the console settings to the kernel command line by typing them in the "Linux kernel command-line parameters" text box (for example, console=ttyS0 for COM port 1). @@ -386,7 +385,7 @@ its ``id`` attribute. - Determine the static memory size of pt_intx array. It is used to describe the pre-launched VM owned ioapic pins and the corresponding mapping between physical GSI and virtual GSI. + Specify the pre-launched VM owned IOAPIC pins and the corresponding mapping between physical GSI and virtual GSI. @@ -396,27 +395,27 @@ its ``id`` attribute. - Enable virtualization of PCIE Precision Time Measurement (PTM) mechanism for devices with PTM capability and for real-time application. HV provides PCIE root port emulation instead of host bridge emulation for VM , PTM could coordinate timing between device and root port with device’s local timebases without relying on software. + Enable virtualization of PCIe Precision Time Measurement (PTM) mechanism for devices with PTM capability and for real-time application. The hypervisor provides PCIe root port emulation instead of host bridge emulation for the VM. PTM coordinates timing between the device and root port with the device's local timebases without relying on software. - Specify user VM OS type, for config tool to format the DM commandline. If it is windows, then add -windows to DM parameter. It supports Oracle virtio-blk, virtio-net and virtio-input devices for Windows guests with secure boot. For windows guest vm this option is mandatory for running Windows in a User VM. If it is not used, Windows will not recognize the virtual disk. When it is linux like OS , config tool also format the related parameters in the same way. + Select the OS type for this VM. This is required to run Windows in a User VM. See :ref:`acrn-dm_parameters` for how to include this in the Device Model arguments. - Specify if to use virtual boot loader OVMF (Open Virtual Machine Firmware) to boot User VM, right now ovmf is the only virtual boot loader supported. User could also disable this to use another boot protocol with parameter -K set. + Use virtual bootloader OVMF (Open Virtual Machine Firmware) to boot this VM. - - Enable ACRN Device Model to emulate COM1 as a User VM standard IO. + + Enable the ACRN Device Model to emulate COM1 as a User VM stdio I/O. Hypervisor global emulation will take priority over this VM setting. - - Device model emulates USB controller used to support USB 3.0 devices, (also supports USB 2.0 and USB 1.0 devices). The physical USB devices attached on the specified bus and port in service VM will be detected by User VM and used as expected as parameters setting. + + Select the USB physical bus and port number that will be emulated by the ACRN Device Model for this VM. USB 3.0, 2.0, and 1.0 are supported. diff --git a/misc/config_tools/schema/types.xsd b/misc/config_tools/schema/types.xsd index 0059a9142..b40424b35 100644 --- a/misc/config_tools/schema/types.xsd +++ b/misc/config_tools/schema/types.xsd @@ -247,19 +247,19 @@ device in VM . Set in hex. - Whether the shared memory region is emulated by the hypervisor or device model. + Whether the shared memory region is emulated by the hypervisor or Device Model. - - Memory size of inter-VM shared memory (IVSHMEM) + + Select the size of the shared memory region in megabytes. The value should be a power of 2 and no more than 512. - Set all VMs which use this IVSHMEM. + Select all VMs that use the shared memory region. @@ -286,16 +286,12 @@ RDT, setting this option to ``y`` is ignored. - Specify whether to enable Code and Data Prioritization (CDP). -CDP is an extension of CAT. Set to 'y' to enable the feature or 'n' to disable it. -The 'y' will be ignored when hardware does not support CDP. + Enable Code and Data Prioritization (CDP). CDP provides control over code and data placement in cache to improve an application's real-time performance. - Specify whether to enable CAT virtualization (vCAT). -Set to 'y' to enable the feature or 'n' to disable it. -The 'y' will be ignored when hardware does not support CAT. + Enable virtualization of the Cache Allocation Technology (CAT) feature in RDT. CAT enables you to allocate cache to VMs, providing isolation to avoid performance interference from other VMs. @@ -318,8 +314,8 @@ As :option:`vm.clos.vcpu_clos` specifies the index of the CLOS to be associated - - Enable the Software SRAM feature for real-time VMs. This feature reserves memory buffers as always-cached memory for improved VM performance. + + Enable Software SRAM. This feature reserves memory buffers as always-cached memory to improve an application's real-time performance.