mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-08-07 11:14:53 +00:00
config_tools: Update Configurator UI XSD
- Update labels and descriptions Tracked-On: #5692 Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
This commit is contained in:
Reyes, Amy
acrnsi-robot
parent
a79d2ded7e
commit
9a4cb33f39
@ -22,16 +22,17 @@
|
||||
<xs:annotation>
|
||||
<xs:documentation>Current supported VM types are:
|
||||
|
||||
- ``RTVM`` Read-time VM
|
||||
- ``STANDARD_VM`` Service VM
|
||||
- ``TEE_VM`` VM with Trusted Execution Environment, which could provide high level
|
||||
security of code execution
|
||||
- ``REE_VM`` VM with Rich Execution Environment, which is a companion VM with TEE_VM,
|
||||
and could provide more features and applications, but is vulnerable to attacks</xs:documentation>
|
||||
- ``Real-time`` for time-sensitive applications.
|
||||
- ``Standard`` for general-purpose applications, such as human-machine interface (HMI).
|
||||
</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="RTVM" />
|
||||
<xs:enumeration value="STANDARD_VM" />
|
||||
<xs:enumeration value="RTVM">
|
||||
<xs:annotation acrn:title="Real-time" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="STANDARD_VM">
|
||||
<xs:annotation acrn:title="Standard" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="TEE_VM">
|
||||
<xs:annotation acrn:views="" />
|
||||
</xs:enumeration>
|
||||
@ -72,12 +73,12 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
|
||||
<xs:complexType name="EPCSection">
|
||||
<xs:sequence>
|
||||
<xs:element name="base" type="HexFormat" default="0">
|
||||
<xs:annotation acrn:title="Intel Software Guard Extensions (SGX) EPC section base" acrn:applicable-vms="pre-launched">
|
||||
<xs:annotation acrn:title="EPC section base" acrn:applicable-vms="pre-launched">
|
||||
<xs:documentation>Specify the enclave page cache (EPC) section base for Intel Software Guard Extensions (SGX). Must be page aligned.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="size" type="HexFormat" default="0">
|
||||
<xs:annotation acrn:title="Intel Software Guard Extensions (SGX) EPC section size (bytes)" acrn:applicable-vms="pre-launched">
|
||||
<xs:annotation acrn:title="EPC section size (bytes)" acrn:applicable-vms="pre-launched">
|
||||
<xs:documentation>Specify the enclave page cache (EPC) section size in bytes for Intel Software Guard Extensions (SGX). Must be page aligned.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
@ -87,8 +88,8 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
|
||||
<xs:complexType name="MemoryInfo">
|
||||
<xs:all>
|
||||
<xs:element name="whole" type="xs:integer" default="256">
|
||||
<xs:annotation acrn:title="VM physical memory allocation (MB)" acrn:views="basic" acrn:applicable-vms="post-launched">
|
||||
<xs:documentation>Specify the physical memory allocated to this VM in Megabytes.</xs:documentation>
|
||||
<xs:annotation acrn:title="Memory size (MB)" acrn:views="basic" acrn:applicable-vms="post-launched">
|
||||
<xs:documentation>Specify the physical memory size allocated to this VM in megabytes.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="start_hpa" type="HexFormat" default="0x100000000">
|
||||
@ -177,8 +178,12 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
|
||||
<xs:documentation>vCOM type</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="legacy" />
|
||||
<xs:enumeration value="pci" />
|
||||
<xs:enumeration value="legacy">
|
||||
<xs:annotation acrn:title="Legacy" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="pci">
|
||||
<xs:annotation acrn:title="PCI" />
|
||||
</xs:enumeration>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
@ -191,17 +196,25 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
|
||||
</xs:element>
|
||||
<xs:element name="io_port" type="HexFormat" default="0x3F">
|
||||
<xs:annotation acrn:title="Virtual I/O address">
|
||||
<xs:documentation>Virtual I/O address</xs:documentation>
|
||||
<xs:documentation>Specify the COM base for each legacy virtual UART.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vbdf" type="VBDFType" minOccurs="0" maxOccurs="1">
|
||||
<xs:annotation acrn:title="Virtual BDF">
|
||||
<xs:documentation>Specify the virtual Bus:Device.Function (BDF) for each PCI virtual UART. Virtual BDF is automatically assigned when the configuration is saved and can be changed if needed.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vbdf" type="VBDFType" minOccurs="0" maxOccurs="1" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="VuartConnectionType">
|
||||
<xs:sequence>
|
||||
<xs:element name="name" type="xs:string" />
|
||||
<xs:element name="type" type="VuartType" default="legacy" />
|
||||
<xs:element name="type" type="VuartType" default="legacy">
|
||||
<xs:annotation acrn:title="Type">
|
||||
<xs:documentation>Select the communication virtual UART (vUART) type.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="endpoint" type="VuartEndpointType" minOccurs="2" maxOccurs="2" />
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
@ -215,13 +228,13 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
|
||||
<xs:complexType name="MMIOResourcesConfiguration">
|
||||
<xs:all>
|
||||
<xs:element name="TPM2" type="Boolean" default="n" minOccurs="0">
|
||||
<xs:annotation acrn:title="Trusted platform module (TPM2) passthrough" acrn:applicable-vms="pre-launched, post-launched">
|
||||
<xs:documentation>Pass through the trusted platform module (TPM2) device to this VM.</xs:documentation>
|
||||
<xs:annotation acrn:title="TPM2 passthrough" acrn:applicable-vms="pre-launched, post-launched">
|
||||
<xs:documentation>Enable passthrough of the trusted platform module (TPM2) device to this VM.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="p2sb" type="Boolean" default="n" minOccurs="0">
|
||||
<xs:annotation acrn:title="Primary-to-Sideband bridge passthrough" acrn:applicable-vms="pre-launched">
|
||||
<xs:documentation>Pass through the Primary-to-Sideband (P2SB) bridge register access BAR to this VM.</xs:documentation>
|
||||
<xs:annotation acrn:title="P2SB bridge passthrough" acrn:applicable-vms="pre-launched">
|
||||
<xs:documentation>Enable passthrough of the Primary-to-Sideband (P2SB) bridge register access BAR to this VM.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:all>
|
||||
|
||||
@ -15,7 +15,12 @@
|
||||
<xs:all>
|
||||
<xs:element name="BUILD_TYPE" type="BuildType" default="debug">
|
||||
<xs:annotation acrn:title="Build type" acrn:views="basic">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
<xs:documentation>Select the build type:
|
||||
|
||||
* ``Debug`` enables the debug shell, prints, and logs.
|
||||
* ``Release`` optimizes the ACRN binary for deployment and turns off all debug infrastructure.
|
||||
|
||||
These settings can only be changed at build time.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="SERIAL_CONSOLE" type="SerialConsoleOptions">
|
||||
@ -49,28 +54,28 @@
|
||||
|
||||
<xs:all>
|
||||
<xs:element name="RELOC" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Hypervisor relocation in memory" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Hypervisor relocation" acrn:views="advanced">
|
||||
<xs:documentation>Enable hypervisor relocation in memory. The bootloader may need to change the location of the hypervisor because of other firmware.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="SCHEDULER" type="SchedulerType" default="SCHED_BVT">
|
||||
<xs:annotation acrn:title="Virtual CPU scheduler" acrn:views="advanced">
|
||||
<xs:documentation>Select the scheduling algorithm used to determine which User VM runs on a shared virtual CPU.</xs:documentation>
|
||||
<xs:documentation>Select the scheduling algorithm for determining the priority of User VMs running on a shared virtual CPU.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="MULTIBOOT2" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Multiboot2" acrn:views="advanced">
|
||||
<xs:documentation>Enable multiboot2 protocol support and multiboot1 downward compatibility. Disable this feature if multiboot1 meets your requirements and to reduce lines of code.</xs:documentation>
|
||||
<xs:documentation>Enable multiboot2 protocol support (with multiboot1 downward compatibility). If multiboot1 meets your requirements, disable this feature to reduce hypervisor code size.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="ENFORCE_TURNOFF_AC" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Split lock detection" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
<xs:documentation>Enable detection of split locks. A split lock can negatively affect an application's real-time performance. If a lock is detected, an alignment check exception #AC occurs.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="ENFORCE_TURNOFF_GP" type="Boolean" default="n">
|
||||
<xs:annotation acrn:title="Uncacheable-memory lock detection" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
<xs:annotation acrn:title="UC lock detection" acrn:views="advanced">
|
||||
<xs:documentation>Enable detection of uncacheable-memory (UC) locks. A UC lock can negatively affect an application's real-time performance. If a lock is detected, a general-protection exception #GP occurs.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="SECURITY_VM_FIXUP" type="Boolean" default="n">
|
||||
@ -84,13 +89,13 @@
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="RDT" type="RDTType">
|
||||
<xs:annotation acrn:title="Intel Resource Director Technology (RDT)" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Intel Resource Director Tech" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="HYPERV_ENABLED" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Hyper-V virtualization technology" acrn:views="advanced">
|
||||
<xs:documentation>Enable Microsoft Hyper-V Hypervisor Top-Level Functional Specification (TFLS) for Windows User VMs.</xs:documentation>
|
||||
<xs:annotation acrn:title="Hyper-V" acrn:views="advanced">
|
||||
<xs:documentation>Enable Microsoft Hyper-V Hypervisor Top-Level Functional Specification (TFLS) for User VMs running Windows.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="IOMMU_ENFORCE_SNP" type="Boolean" default="n">
|
||||
@ -99,28 +104,28 @@
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="ACPI_PARSE_ENABLED" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Parse ACPI tables at runtime" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Parse ACPI tables" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="L1D_VMENTRY_ENABLED" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Mitigate L1 terminal fault" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
<xs:documentation>Enable L1 cache flush before VM entry to prevent L1 terminal fault. L1 terminal fault is a hardware vulnerability that could allow unauthorized disclosure of information residing in the L1 data cache.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="MCE_ON_PSC_DISABLED" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Machine Check Error (MCE) workaround" acrn:views="advanced">
|
||||
<xs:documentation>Enable the software workaround for Machine Check Error on Page Size Change (hardware bug in some processor families).</xs:documentation>
|
||||
<xs:annotation acrn:title="MCE workaround" acrn:views="advanced">
|
||||
<xs:documentation>Enable the software workaround for Machine Check Error on Page Size Change (erratum in some processor families).</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="IVSHMEM" type="IVSHMEMInfo">
|
||||
<xs:annotation acrn:title="Inter-VM shared memory" acrn:views="basic">
|
||||
<xs:documentation/>
|
||||
<xs:documentation>Configure shared memory regions for inter-VM communication.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="SSRAM" minOccurs="0" type="SSRAMInfo">
|
||||
<xs:annotation acrn:title="Software SRAM (for real-time apps)" acrn:views="advanced">
|
||||
<xs:documentation />
|
||||
<xs:annotation acrn:title="Software SRAM" acrn:views="advanced">
|
||||
<xs:documentation>Configure Software SRAM. This feature reserves memory buffers as always-cached memory to improve an application's real-time performance.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:all>
|
||||
@ -129,7 +134,7 @@
|
||||
<xs:complexType name="MemoryOptionsType">
|
||||
<xs:all>
|
||||
<xs:element name="STACK_SIZE" type="HexFormat" default="0x2000">
|
||||
<xs:annotation acrn:title="CPU memory stack size (bytes per CPU)" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="CPU memory stack size (bytes)" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
@ -166,7 +171,7 @@
|
||||
</xs:simpleType>
|
||||
</xs:element>
|
||||
<xs:element name="MAX_PCI_DEV_NUM" default="96">
|
||||
<xs:annotation acrn:title="Maximum number of PCI devices" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Max PCI devices" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:simpleType>
|
||||
@ -194,12 +199,12 @@
|
||||
</xs:simpleType>
|
||||
</xs:element>
|
||||
<xs:element name="MAX_PT_IRQ_ENTRIES" type="xs:integer" default="256">
|
||||
<xs:annotation acrn:title="Maximum number of IRQ entries for passthrough devices" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Max passthrough IRQ entries" acrn:views="advanced">
|
||||
<xs:documentation>Specify the maximum number of interrupt request (IRQ) entries from all passthrough devices.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="MAX_MSIX_TABLE_NUM" default="64">
|
||||
<xs:annotation acrn:title="Maximum number of MSI-X tables per device" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Max MSI-X tables" acrn:views="advanced">
|
||||
<xs:documentation>Specify the maximum number of Message Signaled Interrupt MSI-X tables per device. The default value is calculated from the board configuration file.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:simpleType>
|
||||
@ -213,7 +218,7 @@
|
||||
</xs:simpleType>
|
||||
</xs:element>
|
||||
<xs:element name="MAX_EMULATED_MMIO" default="16">
|
||||
<xs:annotation acrn:title="Maximum number of emulated MMIO regions" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Max emulated MMIO regions" acrn:views="advanced">
|
||||
<xs:documentation>Specify the maximum number of emulated MMIO regions for device virtualization. The default value is calculated from the board configuration file.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:simpleType>
|
||||
@ -267,7 +272,7 @@
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vuart_connections" type="VuartConnectionsType">
|
||||
<xs:annotation acrn:title="Virtual UART connection" acrn:views="basic">
|
||||
<xs:annotation acrn:title="Inter-VM virtual UART connection" acrn:views="basic">
|
||||
<xs:documentation>Specify the vUART connection settings.
|
||||
Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
|
||||
</xs:annotation>
|
||||
@ -318,13 +323,13 @@ Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="virtual_cat_support" type="Boolean" default="n" minOccurs="0">
|
||||
<xs:annotation acrn:title="Virtual Cache Allocation Technology (vCAT)" acrn:views="advanced">
|
||||
<xs:annotation acrn:title="Virtual Cache Allocation Tech" acrn:views="advanced">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="secure_world_support" type="Boolean" default="n" minOccurs="0">
|
||||
<xs:annotation acrn:views="">
|
||||
<xs:documentation>Specify secure world support for trustry OS.</xs:documentation>
|
||||
<xs:documentation>Specify secure world support for trusty OS.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="hide_mtrr_support" type="Boolean" default="n" minOccurs="0">
|
||||
@ -405,17 +410,17 @@ argument and memory.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vbootloader" type="EnablementType" default="Enable">
|
||||
<xs:annotation acrn:title="OVMF (Open Virtual Machine Firmware)" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:annotation acrn:title="Open Virtual Machine Firmware" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:documentation>Use virtual bootloader OVMF (Open Virtual Machine Firmware) to boot this VM.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vuart0" type="EnablementType" default="Enable">
|
||||
<xs:annotation acrn:title="Emulate COM1 as stdio I/O in Device Model" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:annotation acrn:title="Emulate COM1 as stdio I/O" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="usb_xhci" minOccurs="0">
|
||||
<xs:annotation acrn:title="Virtual USB host controller interface" acrn:views="basic" acrn:applicable-vms="post-launched">
|
||||
<xs:annotation acrn:title="Virtual USB HCI" acrn:views="basic" acrn:applicable-vms="post-launched">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:simpleType>
|
||||
@ -435,18 +440,18 @@ argument and memory.</xs:documentation>
|
||||
<xs:all>
|
||||
<xs:element name="console" type="xs:string" minOccurs="0">
|
||||
<xs:annotation acrn:views="basic">
|
||||
<xs:documentation>The virtio console device setting.Input format:
|
||||
``[@]stdio|tty|pty|sock:portname[=portpath][,[@]stdio|tty|pty:portname[=portpath]]``</xs:documentation>
|
||||
<xs:documentation>The virtio console device setting. Input format:
|
||||
``[@]stdio|tty|pty|sock:portname[=portpath][,[@]stdio|tty|pty:portname[=portpath]]``</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="network" type="xs:string" minOccurs="0">
|
||||
<xs:annotation acrn:views="basic">
|
||||
<xs:documentation>The virtio network device setting.
|
||||
Input format: ``device_name[,vhost][,mac=XX:XX:XX:XX:XX:XX]``.
|
||||
The ``device_name`` is the name of the TAP (or MacVTap) device.
|
||||
It must include the keyword ``tap``. ``vhost`` specifies the
|
||||
vhost backend; otherwise, the VBSU backend is used. The ``mac``
|
||||
address is optional.</xs:documentation>
|
||||
Input format: ``device_name[,vhost][,mac=XX:XX:XX:XX:XX:XX]``.
|
||||
The ``device_name`` is the name of the TAP (or MacVTap) device.
|
||||
It must include the keyword ``tap``. ``vhost`` specifies the
|
||||
vhost backend; otherwise, the VBSU backend is used. The ``mac``
|
||||
address is optional.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="input" type="xs:string" minOccurs="0">
|
||||
@ -457,7 +462,7 @@ argument and memory.</xs:documentation>
|
||||
<xs:element name="block" type="xs:string" minOccurs="0">
|
||||
<xs:annotation acrn:views="basic">
|
||||
<xs:documentation>The virtio block device setting.
|
||||
Format: [blk partition:][img path] e.g.: /dev/sda3:./a/b.img</xs:documentation>
|
||||
Format: ``[blk partition:][img path]``. Example: ``/dev/sda3:./a/b.img``.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:all>
|
||||
|
||||
@ -40,8 +40,12 @@
|
||||
<xs:documentation>A string that indicates the build type of the hypervisor.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="release" />
|
||||
<xs:enumeration value="debug" />
|
||||
<xs:enumeration value="release">
|
||||
<xs:annotation acrn:title="Release" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="debug">
|
||||
<xs:annotation acrn:title="Debug" />
|
||||
</xs:enumeration>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
@ -85,15 +89,15 @@
|
||||
|
||||
<xs:simpleType name="LogLevelType">
|
||||
<xs:annotation>
|
||||
<xs:documentation>An Integer from 0 to 7 representing log message
|
||||
<xs:documentation>An Integer from 0 to 5 representing log message
|
||||
severity and intent:
|
||||
|
||||
- 0 no log at all
|
||||
- 1 (LOG_FATAL) system is unusable
|
||||
- 2 (LOG_ERROR) error conditions
|
||||
- 3 (LOG_WARNING) warning conditions
|
||||
- 4 (LOG_INFO) informational
|
||||
- 5 (LOG_DEBUG) debug-level messages
|
||||
- ``0: None``: No log at all.
|
||||
- ``1: Critical``: Messages about critical errors that cause the hypervisor to crash or hang (almost) immediately.
|
||||
- ``2: Error``: Messages about significant errors that affect the main functions (for example, launch of VMs) of ACRN hypervisor.
|
||||
- ``3: Warning``: Messages about detected abnormalities that have local effects on certain features.
|
||||
- ``4: Information``: Informational messages
|
||||
- ``5: Debug``: Debug-level messages
|
||||
|
||||
A lower value has a higher severity. Log messages with a
|
||||
higher value (lower severity) are discarded.</xs:documentation>
|
||||
@ -122,28 +126,31 @@ higher value (lower severity) are discarded.</xs:documentation>
|
||||
|
||||
<xs:simpleType name="SchedulerType">
|
||||
<xs:annotation>
|
||||
<xs:documentation>Four scheduler options are supported:
|
||||
<xs:documentation>Options:
|
||||
|
||||
- ``SCHED_NOOP``: The NOOP (No-Operation) scheduler means there is a
|
||||
strict 1 to 1 mapping between vCPUs and pCPUs.
|
||||
- ``SCHED_IORR``: The IORR (IO sensitive Round Robin) scheduler supports
|
||||
multiple vCPUs running on one pCPU, scheduled by
|
||||
a IO sensitive round robin policy.
|
||||
- ``SCHED_BVT``: The BVT (Borrowed Virtual Time) scheduler is a virtual time based
|
||||
scheduling algorithm, it dispatches the runnable thread with the
|
||||
- ``No-Operation (NOOP)``: The No-Operation (NOOP) scheduler means there is a
|
||||
strict one-to-one mapping between vCPUs and pCPUs.
|
||||
- ``Borrowed Virtual Time``: The Borrowed Virtual Time (BVT) scheduler is a
|
||||
virtual time-based
|
||||
scheduling algorithm. It dispatches the runnable thread with the
|
||||
earliest effective virtual time. *TODO: BVT scheduler will be built on
|
||||
top of a prioritized scheduling mechanism, i.e. higher priority threads
|
||||
get scheduled first, and same priority tasks are scheduled per BVT.*
|
||||
- ``SCHED_PRIO``: The priority based scheduler. vCPU scheduling will be based on
|
||||
their pre-configured priorities.
|
||||
- ``Priority Based Scheduling``: The priority based scheduler supports vCPU scheduling based on their pre-configured priorities.
|
||||
|
||||
Read more about the available scheduling options in :ref:`cpu_sharing`.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="SCHED_NOOP" />
|
||||
<xs:enumeration value="SCHED_NOOP">
|
||||
<xs:annotation acrn:title="No-Operation (NOOP)" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="SCHED_IORR" />
|
||||
<xs:enumeration value="SCHED_BVT" />
|
||||
<xs:enumeration value="SCHED_PRIO" />
|
||||
<xs:enumeration value="SCHED_BVT">
|
||||
<xs:annotation acrn:title="Borrowed Virtual Time" />
|
||||
</xs:enumeration>
|
||||
<xs:enumeration value="SCHED_PRIO">
|
||||
<xs:annotation acrn:title="Priority Based Scheduling" />
|
||||
</xs:enumeration>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
@ -196,14 +203,13 @@ Read more about the available scheduling options in :ref:`cpu_sharing`.</xs:docu
|
||||
<xs:complexType name="IVSHMEMVM">
|
||||
<xs:sequence>
|
||||
<xs:element name="VM_NAME" type="VMNameType">
|
||||
<xs:annotation acrn:title="Shared VMS">
|
||||
<xs:documentation>Name of the VM which use this IVSHMEM.</xs:documentation>
|
||||
<xs:annotation acrn:title="Shared VMs">
|
||||
<xs:documentation>Name of the VM that uses this shared memory region.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="VBDF" type = "VBDFType">
|
||||
<xs:annotation>
|
||||
<xs:documentation>Bus, Device and function of the virtual
|
||||
device in VM . Set in hex.</xs:documentation>
|
||||
<xs:annotation acrn:title="Virtual BDF">
|
||||
<xs:documentation>Virtual BDF (Bus Device Function) is automatically assigned and can be changed if needed. Set in Hex.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
@ -213,7 +219,7 @@ device in VM . Set in hex.</xs:documentation>
|
||||
<xs:sequence>
|
||||
<xs:element name="IVSHMEM_VM" type="IVSHMEMVM" maxOccurs="unbounded">
|
||||
<xs:annotation>
|
||||
<xs:documentation>Set each VM which use this IVSHMEM.</xs:documentation>
|
||||
<xs:documentation>Select all VMs that use the shared memory region.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
@ -269,7 +275,7 @@ and no more than 512.</xs:documentation>
|
||||
<xs:sequence>
|
||||
<xs:element name="IVSHMEM_REGION" type="IVSHMEMRegionType" minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:annotation>
|
||||
<xs:documentation>Set a inter-VM shared memory.</xs:documentation>
|
||||
<xs:documentation>Create a memory region for VMs to share: specify its name, size, and associated VMs.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
@ -278,9 +284,9 @@ and no more than 512.</xs:documentation>
|
||||
<xs:complexType name="RDTType">
|
||||
<xs:sequence>
|
||||
<xs:element name="RDT_ENABLED" type="Boolean" default="n">
|
||||
<xs:annotation acrn:title="Intel Resource Director Technology">
|
||||
<xs:documentation>Enable the Intel Resource Director Technology (RDT)
|
||||
allocation feature. If the board hardware does not support
|
||||
<xs:annotation acrn:title="Intel Resource Director Tech">
|
||||
<xs:documentation>Enable Intel Resource Director Technology (RDT). If
|
||||
the board hardware does not support
|
||||
RDT, setting this option to ``y`` is ignored.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
@ -290,7 +296,7 @@ RDT, setting this option to ``y`` is ignored.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="VCAT_ENABLED" type="Boolean" default="n">
|
||||
<xs:annotation>
|
||||
<xs:annotation acrn:title="Virtual Cache Allocation Tech">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
@ -314,7 +320,7 @@ As :option:`vm.clos.vcpu_clos` specifies the index of the CLOS to be associated
|
||||
<xs:complexType name="SSRAMInfo">
|
||||
<xs:sequence>
|
||||
<xs:element name="SSRAM_ENABLED" type="Boolean" default="n">
|
||||
<xs:annotation acrn:title="Software SRAM (for real-time apps)">
|
||||
<xs:annotation acrn:title="Software SRAM">
|
||||
<xs:documentation>Enable Software SRAM. This feature reserves memory buffers as always-cached memory to improve an application's real-time performance.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user