diff --git a/doc/reference/config-options.rst b/doc/reference/config-options.rst index e3809d5fa..a49824fda 100644 --- a/doc/reference/config-options.rst +++ b/doc/reference/config-options.rst @@ -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 diff --git a/misc/config_tools/schema/VMtypes.xsd b/misc/config_tools/schema/VMtypes.xsd index a61237bc0..302e152b6 100644 --- a/misc/config_tools/schema/VMtypes.xsd +++ b/misc/config_tools/schema/VMtypes.xsd @@ -61,8 +61,8 @@ - - A pCPU that this VM's vCPU is allowed to pin to. + + List of pCPU affinities. diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd index a65114d9a..260189f93 100644 --- a/misc/config_tools/schema/config.xsd +++ b/misc/config_tools/schema/config.xsd @@ -85,12 +85,7 @@ These settings can only be changed at build time. - If ``y``, permanently disables all interrupts in HV root mode. - - - - - 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. + If checked, permanently disables all interrupts in HV root mode. @@ -118,6 +113,11 @@ These settings can only be changed at build time. Enable the software workaround for Machine Check Error on Page Size Change (erratum in some processor families). + + + 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. + + Configure shared memory regions for inter-VM communication. @@ -255,14 +255,20 @@ These settings can only be changed at build time. + + + Enable hypervisor features. + + Configure the debug facilities. - - - Enable hypervisor features. + + + Specify the vUART connection settings. +Refer to :ref:`vuart_config` for detailed vUART settings. @@ -280,12 +286,6 @@ These settings can only be changed at build time. Miscellaneous options for workarounds. - - - Specify the vUART connection settings. -Refer to :ref:`vuart_config` for detailed vUART settings. - - Specify the cache setting. @@ -301,15 +301,40 @@ Refer to :ref:`vuart_config` for detailed vUART settings. Specify the VM load order. + + + Specify the name used to identify this VM. The VM name will be shown in the hypervisor console vm_list command. + + 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. - - - Specify the name used to identify this VM. The VM name will be shown in the hypervisor console vm_list command. - + + + 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). + + + + + 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. + + + + + 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. + + + + + Use virtual bootloader OVMF (Open Virtual Machine Firmware) to boot this VM. + + + + + 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. + @@ -363,13 +388,12 @@ Refer SDM 17.19.2 for details, and use with caution. - + Specify the Intel Software Guard Extensions (SGX) enclave page cache (EPC) section settings. - - Specify memory information for User VMs. + @@ -388,11 +412,6 @@ Refer SDM 17.19.2 for details, and use with caution. argument and memory. - - - 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). - - MMIO resources to passthrough. @@ -413,32 +432,19 @@ argument and memory. 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. - - - 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. - - - - - Use virtual bootloader OVMF (Open Virtual Machine Firmware) to boot this VM. - - - - - 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. - - - - - 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. - - Enable virt-IO devices in post-launched VMs. + + + 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. + + Virtio console device for data input and output. @@ -469,13 +475,6 @@ mouse, and tablet. It sends Linux input layer events over virtio. - - - 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. - - diff --git a/misc/config_tools/schema/types.xsd b/misc/config_tools/schema/types.xsd index b80cfaff1..1be4f8ef3 100644 --- a/misc/config_tools/schema/types.xsd +++ b/misc/config_tools/schema/types.xsd @@ -5,7 +5,7 @@ - A Boolean value, written as ``y`` or ``n``. + A Boolean value, displayed as a check box. @@ -307,7 +307,7 @@ and no more than 512. Enable Intel Resource Director Technology (RDT). If the board hardware does not support -RDT, setting this option to ``y`` is ignored. +RDT, setting this option to checked is ignored.