mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-04-28 11:43:56 +00:00
schema changes for DX configurator option presentation
Edit the schema (.xsd) files to modify the order options are presented. None of these changes invalidate existing scenario XML files, as they only reorder elements within the existing parent element, or tweak the acrn:views, acrn:title, or documentation content. Move simple type elements before complex type options (under the same parent element) to avoid the confusion where options look like they're part of a section based on the title that's added before complex typed options but not simple typed options. * add acrn:title to pcpu (pCPU list) * change documentation for binary option saying "checked" instead of 'y' * move HYPERV_ENABLED before RDT (simple type before complex type) * move vuart_connections before FEATURES * move name before vm_type * move console_vuart, os_type, vuart0, vbootloader, usb_xhci before lapic_passthrough * add acrn:title to epc_section * add acrn:title to memory * move gpu to top of virtio_devices (simple type before completx type) Tracked-On: #5692 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
acrnsi-robot
parent
72445d01b4
commit
8ffb0dee4d
@ -20,7 +20,7 @@ Within this option documentation, we refer to some common type
|
||||
definitions:
|
||||
|
||||
Boolean
|
||||
A true or false value specified as either ``y`` or ``n``.
|
||||
A true or false value displayed as a check box, checked indicating true.
|
||||
|
||||
Hexadecimal
|
||||
A base-16 (integer) value represented by a leading ``0x`` or ``0X`` followed by
|
||||
|
||||
@ -61,8 +61,8 @@
|
||||
<xs:complexType name="CPUAffinityConfigurations">
|
||||
<xs:sequence>
|
||||
<xs:element name="pcpu" type="CPUAffinityConfiguration" minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:annotation>
|
||||
<xs:documentation>A pCPU that this VM's vCPU is allowed to pin to.</xs:documentation>
|
||||
<xs:annotation acrn:title="pCPU list">
|
||||
<xs:documentation>List of pCPU affinities.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
|
||||
@ -85,12 +85,7 @@ These settings can only be changed at build time.</xs:documentation>
|
||||
</xs:element>
|
||||
<xs:element name="KEEP_IRQ_DISABLED" type="Boolean" default="n">
|
||||
<xs:annotation acrn:views="">
|
||||
<xs:documentation>If ``y``, permanently disables all interrupts in HV root mode.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="RDT" type="RDTType">
|
||||
<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:documentation>If checked, permanently disables all interrupts in HV root mode.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="HYPERV_ENABLED" type="Boolean" default="y">
|
||||
@ -118,6 +113,11 @@ These settings can only be changed at build time.</xs:documentation>
|
||||
<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="RDT" type="RDTType">
|
||||
<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="IVSHMEM" type="IVSHMEMInfo">
|
||||
<xs:annotation acrn:title="Inter-VM shared memory" acrn:views="basic">
|
||||
<xs:documentation>Configure shared memory regions for inter-VM communication.</xs:documentation>
|
||||
@ -255,14 +255,20 @@ These settings can only be changed at build time.</xs:documentation>
|
||||
|
||||
<xs:complexType name="HVConfigType">
|
||||
<xs:all>
|
||||
<xs:element name="FEATURES" type="FeatureOptionsType">
|
||||
<xs:annotation acrn:title="Hypervisor features" acrn:views="advanced">
|
||||
<xs:documentation>Enable hypervisor features.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="DEBUG_OPTIONS" type="DebugOptionsType">
|
||||
<xs:annotation acrn:title="Debug options" acrn:views="basic">
|
||||
<xs:documentation>Configure the debug facilities.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="FEATURES" type="FeatureOptionsType">
|
||||
<xs:annotation acrn:title="Hypervisor features" acrn:views="basic, advanced">
|
||||
<xs:documentation>Enable hypervisor features.</xs:documentation>
|
||||
<xs:element name="vuart_connections" type="VuartConnectionsType">
|
||||
<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>
|
||||
</xs:element>
|
||||
<xs:element name="MEMORY" type="MemoryOptionsType">
|
||||
@ -280,12 +286,6 @@ These settings can only be changed at build time.</xs:documentation>
|
||||
<xs:documentation>Miscellaneous options for workarounds.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vuart_connections" type="VuartConnectionsType">
|
||||
<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>
|
||||
</xs:element>
|
||||
<xs:element name="CACHE_REGION" type="CacheRegionType" minOccurs="0">
|
||||
<xs:annotation>
|
||||
<xs:documentation>Specify the cache setting.</xs:documentation>
|
||||
@ -301,14 +301,39 @@ Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
|
||||
<xs:documentation>Specify the VM load order.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="name" type="VMNameType">
|
||||
<xs:annotation acrn:title="VM name" acrn:views="basic">
|
||||
<xs:documentation>Specify the name used to identify this VM. The VM name will be shown in the hypervisor console vm_list command.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vm_type" type="VMType" minOccurs="0">
|
||||
<xs:annotation acrn:title="VM type" acrn:views="basic">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="name" type="VMNameType">
|
||||
<xs:annotation acrn:title="VM name" acrn:views="basic">
|
||||
<xs:documentation>Specify the name used to identify this VM. The VM name will be shown in the hypervisor console vm_list command.</xs:documentation>
|
||||
<xs:element name="console_vuart" type="ConsoleVuartConfiguration" default="None">
|
||||
<xs:annotation acrn:title="Console virtual UART type" acrn:views="basic">
|
||||
<xs:documentation>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).</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="os_type" type="OSType" default="Non-Windows OS">
|
||||
<xs:annotation acrn:title="OS type" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vuart0" type="Boolean" default="y">
|
||||
<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="vbootloader" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Enable Open Virtual Machine FW" 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="usb_xhci" type="USBDevsConfiguration" minOccurs="0">
|
||||
<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:element>
|
||||
<xs:element name="lapic_passthrough" type="Boolean" default="n" minOccurs="0">
|
||||
@ -363,13 +388,12 @@ Refer SDM 17.19.2 for details, and use with caution.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="epc_section" type="EPCSection" minOccurs="0">
|
||||
<xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched">
|
||||
<xs:annotation acrn:title="SGX Enclave Page Cache" acrn:views="advanced" acrn:applicable-vms="pre-launched">
|
||||
<xs:documentation>Specify the Intel Software Guard Extensions (SGX) enclave page cache (EPC) section settings.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="memory" type="MemoryInfo" minOccurs="0">
|
||||
<xs:annotation acrn:views="basic, advanced" acrn:applicable-vms="pre-launched, post-launched">
|
||||
<xs:documentation>Specify memory information for User VMs.</xs:documentation>
|
||||
<xs:annotation acrn:title="Memory allocation" acrn:views="basic, advanced" acrn:applicable-vms="pre-launched, post-launched">
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="priority" type="PriorityType" default="PRIO_LOW">
|
||||
@ -388,11 +412,6 @@ Refer SDM 17.19.2 for details, and use with caution.</xs:documentation>
|
||||
argument and memory.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="console_vuart" type="ConsoleVuartConfiguration" default="None">
|
||||
<xs:annotation acrn:title="Console virtual UART type" acrn:views="basic">
|
||||
<xs:documentation>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).</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="mmio_resources" type="MMIOResourcesConfiguration" minOccurs="0">
|
||||
<xs:annotation acrn:title="MMIO Resources" acrn:applicable-vms="pre-launched" acrn:views="basic">
|
||||
<xs:documentation>MMIO resources to passthrough.</xs:documentation>
|
||||
@ -413,32 +432,19 @@ argument and memory.</xs:documentation>
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="os_type" type="OSType" default="Non-Windows OS">
|
||||
<xs:annotation acrn:title="OS type" acrn:applicable-vms="post-launched" acrn:views="basic">
|
||||
<xs:documentation>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.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="vbootloader" type="Boolean" default="y">
|
||||
<xs:annotation acrn:title="Enable Open Virtual Machine FW" 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="Boolean" default="y">
|
||||
<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" type="USBDevsConfiguration" minOccurs="0">
|
||||
<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:element>
|
||||
<xs:element name="virtio_devices">
|
||||
<xs:annotation acrn:title="Virt-IO devices" acrn:views="basic" acrn:applicable-vms="post-launched">
|
||||
<xs:documentation>Enable virt-IO devices in post-launched VMs.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:complexType>
|
||||
<xs:all>
|
||||
<xs:element name="gpu" type="xs:string" minOccurs="0">
|
||||
<xs:annotation acrn:title="Virtio GPU device" acrn:views="basic"
|
||||
acrn:widget-options="'placeholder': 'fullscreen or geometry=[width]x[height]+[x offset]+[y offset], e.g. geometry=1280x720+0+0 specifies a 1280 x 720 pixels region at the top left corner of the screan'">
|
||||
<xs:documentation>The virtio GPU device presents a GPU device to the VM.
|
||||
This feature enables you to view the VM's GPU output in the Service VM.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="console" type="VirtioConsoleConfiguration" minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:annotation acrn:title="Virtio console device" acrn:views="basic">
|
||||
<xs:documentation>Virtio console device for data input and output.
|
||||
@ -469,13 +475,6 @@ mouse, and tablet. It sends Linux input layer events over virtio.</xs:documenta
|
||||
<xs:restriction base="xs:string" />
|
||||
</xs:simpleType>
|
||||
</xs:element>
|
||||
<xs:element name="gpu" type="xs:string" minOccurs="0">
|
||||
<xs:annotation acrn:title="Virtio GPU device" acrn:views="basic"
|
||||
acrn:widget-options="'placeholder': 'fullscreen or geometry=[width]x[height]+[x offset]+[y offset], e.g. geometry=1280x720+0+0 specifies a 1280 x 720 pixels region at the top left corner of the screan'">
|
||||
<xs:documentation>The virtio GPU device presents a GPU device to the VM.
|
||||
This feature enables you to view the VM's GPU output in the Service VM.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
</xs:all>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
|
||||
<xs:simpleType name="Boolean">
|
||||
<xs:annotation acrn:widget="b-form-checkbox" acrn:widget-options="'value': 'y', 'unchecked-value': 'n'">
|
||||
<xs:documentation>A Boolean value, written as ``y`` or ``n``.</xs:documentation>
|
||||
<xs:documentation>A Boolean value, displayed as a check box.</xs:documentation>
|
||||
</xs:annotation>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="y" />
|
||||
@ -307,7 +307,7 @@ and no more than 512.</xs:documentation>
|
||||
<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>
|
||||
RDT, setting this option to checked is ignored.</xs:documentation>
|
||||
</xs:annotation>
|
||||
</xs:element>
|
||||
<xs:element name="CDP_ENABLED" type="Boolean" default="n">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user