config_tools: more annotation on the config items

This patch adds the following annotations to the config items defined in
the schema of scenario XMLs:

  - acrn:title, which defines the human-readable label of the corresponding
    widgets in the configurator.

  - acrn:views, which controls in which view(s) this item shows in the
    configurator.

  - acrn:applicable-vms, which specifies the kinds of VMs (pre-launched,
    post-launched and/or service VM) this item applies to. An item not
    applicable to a certain type of VM will not be shown in the
    configurator, and will trigger validation error if that item exists for
    a VM of that specific type.

v1 -> v2:

  * Preserve the CPU affinity settings for service VMs. This will be needed
    later when we want to restrict the available CPUs the service VM can use at
    runtime (but not at initialization time).

Tracked-On: #6690
Signed-off-by: Junjie Mao <junjie.mao@intel.com>

misc/config_tools/data/cfl-k700-i7/hybrid.xml

@@ -124,9 +124,6 @@
         </bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -138,10 +135,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -155,10 +148,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/cfl-k700-i7/hybrid_rt.xml

@@ -144,9 +144,6 @@
       <bootargs>root=/dev/nvme0n1p3 rw rootwait console=ttyS0,115200n8 ignore_loglevel no_timer_check</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -162,10 +159,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -181,10 +174,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/cfl-k700-i7/shared.xml

@@ -76,9 +76,6 @@
         i915.nuclear_pageflip=1</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -92,10 +89,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
   </vm>
   <vm id="2">
@@ -110,10 +103,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -129,10 +118,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -148,10 +133,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -167,10 +148,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -186,10 +163,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/generic_board/hybrid.xml

@@ -126,9 +126,6 @@
         i915.nuclear_pageflip=1 swiotlb=131072</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -140,10 +137,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -157,10 +150,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/generic_board/hybrid_rt.xml

@@ -147,9 +147,6 @@
             i915.nuclear_pageflip=1 swiotlb=131072</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -163,10 +160,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -180,10 +173,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/generic_board/shared.xml

@@ -84,9 +84,6 @@
         i915.nuclear_pageflip=1 swiotlb=131072</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -100,10 +97,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -120,10 +113,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -139,10 +128,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -158,10 +143,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -177,10 +158,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -196,10 +173,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/nuc11tnbi5/hybrid.xml

@@ -126,9 +126,6 @@
         i915.nuclear_pageflip=1 swiotlb=131072</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -140,10 +137,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -157,10 +150,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/nuc11tnbi5/shared.xml

@@ -96,9 +96,6 @@
         i915.nuclear_pageflip=1 swiotlb=131072</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -112,10 +109,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -132,10 +125,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -151,10 +140,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -170,10 +155,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -189,10 +170,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -208,10 +185,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/qemu/shared.xml

@@ -76,9 +76,6 @@
         ignore_loglevel no_timer_check intel_iommu=off tsc=reliable</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -90,10 +87,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>None</console_vuart>
   </vm>
 </acrn-config>

misc/config_tools/data/tgl-vecow-spc-7100-Corei7/hybrid.xml

@@ -127,9 +127,6 @@
       </bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -141,10 +138,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -158,10 +151,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/tgl-vecow-spc-7100-Corei7/shared.xml

@@ -97,9 +97,6 @@
       </bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -113,10 +110,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <priority>PRIO_LOW</priority>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
@@ -134,10 +127,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <priority>PRIO_LOW</priority>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>

misc/config_tools/data/whl-ipc-i5/hybrid.xml

@@ -116,9 +116,6 @@
         i915.nuclear_pageflip=1</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -130,10 +127,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/whl-ipc-i5/hybrid_rt.xml

@@ -137,9 +137,6 @@
         i915.nuclear_pageflip=1</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="2">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -153,10 +150,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -170,10 +163,6 @@
     <clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/whl-ipc-i5/sdc.xml

@@ -62,9 +62,6 @@
         i915.nuclear_pageflip=1</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -78,10 +75,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>None</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/data/whl-ipc-i5/shared.xml

@@ -76,9 +76,6 @@
         i915.nuclear_pageflip=1</bootargs>
     </os_config>
     <console_vuart>COM Port 1</console_vuart>
-    <pci_devs>
-      <pci_dev/>
-    </pci_devs>
   </vm>
   <vm id="1">
     <load_order>POST_LAUNCHED_VM</load_order>
@@ -92,10 +89,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
   </vm>
   <vm id="2">
@@ -110,10 +103,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -129,10 +118,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -148,10 +133,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -167,10 +148,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>
@@ -186,10 +163,6 @@
       <vcpu_clos>0</vcpu_clos>
       <vcpu_clos>0</vcpu_clos>
     </clos>
-    <epc_section>
-      <base>0</base>
-      <size>0</size>
-    </epc_section>
     <console_vuart>COM Port 1</console_vuart>
     <PTM>n</PTM>
   </vm>

misc/config_tools/scenario_config/upgrader.py

@@ -518,7 +518,6 @@ class UpgradingScenarioStage(PipelineStage):
         DiscardedDataFilter("vm/guest_flags/guest_flag", "0", None),
         DiscardedDataFilter("vm/epc_section/base", "0", "Post-launched VMs cannot have EPC sections."),
         DiscardedDataFilter("vm/epc_section/size", "0", "Post-launched VMs cannot have EPC sections."),
-        DiscardedDataFilter("vm/cpu_affinity/pcpu_id", None, "CPU affinity of the service VM is no longer needed."),
         DiscardedDataFilter("vm/os_config/name", None, "Guest OS names are no longer needed in scenario definitions."),
     ]
 

misc/config_tools/schema/VMtypes.xsd

@@ -32,8 +32,12 @@
   <xs:restriction base="xs:string">
     <xs:enumeration value="RTVM" />
     <xs:enumeration value="STANDARD_VM" />
-    <xs:enumeration value="TEE_VM" />
+    <xs:enumeration value="TEE_VM">
-    <xs:enumeration value="REE_VM" />
+      <xs:annotation acrn:views="" />
+    </xs:enumeration>
+    <xs:enumeration value="REE_VM">
+      <xs:annotation acrn:views="" />
+    </xs:enumeration>
   </xs:restriction>
 </xs:simpleType>
 
@@ -66,75 +70,65 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc.</xs:documentation>
 </xs:complexType>
 
 <xs:complexType name="EPCSection">
-  <xs:annotation acrn:configurable="n">
-    <xs:documentation>epc section.</xs:documentation>
-  </xs:annotation>
   <xs:sequence>
     <xs:element name="base" type="HexFormat" default="0">
-      <xs:annotation>
+      <xs:annotation acrn:applicable-vms="pre-launched">
-        <xs:documentation>SGX EPC section base, must be page aligned.</xs:documentation>
+        <xs:documentation>Specify SGX EPC section base, must be page aligned. (Default value is 0)</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="size" type="HexFormat" default="0">
-      <xs:annotation>
+      <xs:annotation acrn:applicable-vms="pre-launched">
-        <xs:documentation>SGX EPC section size in Bytes, must be page
+        <xs:documentation>Specify SGX EPC section size in Bytes, must be page aligned. (Default value is 0)</xs:documentation>
-aligned.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:sequence>
 </xs:complexType>
 
 <xs:complexType name="MemoryInfo">
-  <xs:sequence>
+  <xs:all>
     <xs:element name="start_hpa" type="HexFormat" default="0x100000000">
-      <xs:annotation>
+      <xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched, service-vm">
-        <xs:documentation>The starting physical address in host for the
+        <xs:documentation>The starting physical address in host for the VM.</xs:documentation>
-VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="size" type="MemorySizeType" default="0x20000000" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched, service-vm">
-        <xs:documentation>The memory size in bytes for the VM. Default
+        <xs:documentation>The memory size in bytes for the VM. Default value is ``0x200000000``.</xs:documentation>
-value is ``0x200000000``.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="start_hpa2" type="HexFormat" default="0x0" minOccurs="0">
-      <xs:annotation acrn:configurable="n">
+      <xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched, service-vm">
-        <xs:documentation>Start of second HPA for non-contiguous
+        <xs:documentation>Start of second HPA for non-contiguous allocations in host for the VM.</xs:documentation>
-allocations in host for the VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="size_hpa2" type="MemorySizeType" default="0x0" minOccurs="0">
-      <xs:annotation acrn:configurable="n">
+      <xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched, service-vm">
-        <xs:documentation>Memory size of second HPA for non-contiguous
+        <xs:documentation>Memory size of second HPA for non-contiguous allocations in Bytes for the VM.</xs:documentation>
-allocations in Bytes for the VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
-  </xs:sequence>
+  </xs:all>
 </xs:complexType>
 
 <xs:complexType name="OSConfigurations">
   <xs:all>
     <xs:element name="kern_type" type="VMKernelType">
-      <xs:annotation>
+      <xs:annotation acrn:title="Kernel image type">
         <xs:documentation>Specify the kernel image type so the hypervisor can load it correctly.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="kern_mod" type="xs:string">
-      <xs:annotation>
+      <xs:annotation acrn:title="Kernel module tag">
-        <xs:documentation>The tag for the kernel image that acts as a multiboot module; it must
+        <xs:documentation>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.</xs:documentation>
-exactly match the module tag in the GRUB multiboot cmdline.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="ramdisk_mod" type="xs:string">
+    <xs:element name="ramdisk_mod" type="xs:string" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="RAMdisk module tag">
-        <xs:documentation>The tag for the ramdisk image, which acts as a multiboot module; it
+        <xs:documentation>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.</xs:documentation>
-must exactly match the module tag in the GRUB multiboot cmdline.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="bootargs" type="xs:string">
+    <xs:element name="bootargs" type="xs:string" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Kernel boot arguments">
-        <xs:documentation>Configurable boot argument for pre-launched VM of hybrid or hybrid_rt mode.</xs:documentation>
+        <xs:documentation>Specify configurable boot argument for pre-launched or Service VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="kern_load_addr" type="KernLoadAddr" minOccurs="0">
@@ -208,14 +202,13 @@ must exactly match the module tag in the GRUB multiboot cmdline.</xs:documentati
 <xs:complexType name="MMIOResourcesConfiguration">
   <xs:sequence>
     <xs:element name="TPM2" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Trusted Platform Module passthrough" acrn:applicable-vms="pre-launched, post-launched">
-        <xs:documentation>Specify TPM2 device to passthrough.</xs:documentation>
+        <xs:documentation>Passthrough the Trusted Platform Module (TPM2) device to this VM. (Optional) (Default value is n)</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="p2sb" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Primary-to-Sideband bridge passthrough" acrn:applicable-vms="pre-launched">
-        <xs:documentation>Expose the P2SB (Primary-to-Sideband) bridge
+        <xs:documentation>Passthrough the P2SB (Primary-to-Sideband) bridge register access BAR to the this VM. (Optional) (Default value is n)</xs:documentation>
-to the pre-launched VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:sequence>
@@ -223,9 +216,9 @@ to the pre-launched VM.</xs:documentation>
 
 <xs:complexType name="PCIDevsConfiguration">
   <xs:sequence>
-    <xs:element name="pci_dev" type="xs:string" maxOccurs="unbounded">
+    <xs:element name="pci_dev" type="xs:string" minOccurs="0" maxOccurs="unbounded">
-      <xs:annotation>
+      <xs:annotation acrn:title="PCI device assignment">
-        <xs:documentation>A passthrough PCI device.</xs:documentation>
+        <xs:documentation>Select the PCI devices you want to assign to this virtual machine.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:sequence>

misc/config_tools/schema/config.xsd

@@ -15,44 +15,27 @@
   <xs:all>
     <xs:element name="BUILD_TYPE" type="BuildType" default="debug">
       <xs:annotation acrn:title="Build type" acrn:views="basic">
-        <xs:documentation>Build an image for release (``y``) or debug (``n``).
+        <xs:documentation>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.</xs:documentation>
-In a **release** image, assertions are not enforced and debugging
-features are disabled, including logs, serial console, and the
-hypervisor shell.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="SERIAL_CONSOLE" type="SerialConsoleOptions" default="/dev/ttyS0">
+    <xs:element name="SERIAL_CONSOLE" type="SerialConsoleOptions">
-      <xs:annotation>
+      <xs:annotation acrn:title="Serial console port" acrn:views="basic">
-        <xs:documentation>Specify the host serial device used for hypervisor debugging.
+        <xs:documentation>Specify the host serial device used for hypervisor debugging.</xs:documentation>
-This option is only valid if :option:`hv.DEBUG_OPTIONS.RELEASE` is set to ``n``.
-This option impacts the content of ``vm.(legacy_vuart id="0").base`` when :option:`vm.load_order` is ``SERVICE_VM``,
-which specifies the PIO base for Service VM legacy vUART 0 (used for the console).
-The PIO base for the Service VM's legacy vUART 0 is determined using these rules:
-
-- If :option:`hv.DEBUG_OPTIONS.SERIAL_CONSOLE` is any available ttyS# in the native environment,
-  the PIO base of the Service VM legacy vUART 0 would be the same as the PIO base
-  corresponding to :option:`hv.DEBUG_OPTIONS.SERIAL_CONSOLE` in the native environment.
-- Otherwise, a PIO base would be assigned to the Service VM legacy vUART 0 from the available PIO list.
-
-This logic is implemented in the configuration tools.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="MEM_LOGLEVEL" type="LogLevelType" default="5">
+    <xs:element name="MEM_LOGLEVEL" type="LogLevelType" default="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="ACRN log level" acrn:views="basic">
-        <xs:documentation>Default loglevel for log messages stored in
+        <xs:documentation>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.</xs:documentation>
-memory. Value can be changed at runtime.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="NPK_LOGLEVEL" type="LogLevelType" default="5">
+    <xs:element name="NPK_LOGLEVEL" type="LogLevelType" default="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Intel Trace Hub log level" acrn:views="basic">
-        <xs:documentation>Default loglevel for the hypervisor North Peak
+        <xs:documentation>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.</xs:documentation>
-(NPK) log. Value can be changed at runtime.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="CONSOLE_LOGLEVEL" type="LogLevelType" default="3">
+    <xs:element name="CONSOLE_LOGLEVEL" type="LogLevelType" default="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Serial console log level" acrn:views="basic">
-        <xs:documentation>Default loglevel for log messages
+        <xs:documentation>Specify default log level for log messages written to the serial console.  Log messages with the selected value or lower are displayed.</xs:documentation>
-written to the serial console.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:all>
@@ -65,91 +48,78 @@ written to the serial console.</xs:documentation>
 
   <xs:all>
     <xs:element name="RELOC" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="Hypervisor relocation in memory" acrn:views="advanced">
-        <xs:documentation>Specify if hypervisor relocation is enabled on
+        <xs:documentation>Enable hypervisor relocation in memory.  The boot loader may need to change the location of the hypervisor because of other firmware.</xs:documentation>
-booting.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="SCHEDULER" type="SchedulerType" default="SCHED_BVT">
-      <xs:annotation>
+      <xs:annotation acrn:title="Scheduler and workload prioritization" acrn:views="advanced">
-        <xs:documentation>The CPU scheduler used by the hypervisor.</xs:documentation>
+        <xs:documentation>Choose scheduling algorithm used for determining which User VM runs on a shared virtual CPU.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="MULTIBOOT2" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="Enable Multiboot2" acrn:views="advanced">
-        <xs:documentation>Specify if the ACRN hypervisor image can be booted using the
+        <xs:documentation>Enable multiboot2 boot protocol support and multiboot1 downward compatibility.  Disable this feature if multiboot1 meets your requirements and to reduce lines of code.</xs:documentation>
-multiboot2 protocol. If set to ``n``, GRUB's multiboot2 is not available as a
-boot option.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="ENFORCE_TURNOFF_AC" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="Split lock detection" acrn:views="advanced">
-        <xs:documentation>Force to disable #AC for Split-locked Access. If CPU has #AC for
+        <xs:documentation>Enable split lock detection for real-time application. This prevents alignment check exceptions from impacting hypervisor real-time performance.</xs:documentation>
-split-locked access, HV enables it and VMs can't disable. Set this to enforce turning off that
-#AC, for debugging purposes only.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="ENFORCE_TURNOFF_GP" type="Boolean" default="n">
-      <xs:annotation>
+      <xs:annotation acrn:title="Prevent system bus locking" acrn:views="advanced">
-        <xs:documentation>Force to disable #GP for Split-locked Access. If CPU has #GP for
+        <xs:documentation>Enable UC lock detection for real-time application. This prevents general protection faults from impacting hypervisor real-time performance.</xs:documentation>
-UC lock, HV enable it and VMs can't disable. Set this to enforce turn off that #GP, for community
-developer only.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="SECURITY_VM_FIXUP" type="Boolean" default="n">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
-        <xs:documentation>Enable to do fixup for TPM2 and SMBIOS for Security VM. If no
+        <xs:documentation>Enable to do fixup for TPM2 and SMBIOS for Security VM. If no Security VM, setting this option to ``n``</xs:documentation>
-Security VM, setting this option to ``n``</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="KEEP_IRQ_DISABLED" type="Boolean" default="n">
-      <xs:annotation>
+      <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>
+      <xs:annotation acrn:title="Intel Resource Director Technology" acrn:views="advanced">
-        <xs:documentation>Enable the Intel Resource Director Technology (RDT)
+        <xs:documentation>Enable Intel Resource Director Technology (RDT). The technology provides cache and memory allocation features to improve time performance of real-time VMs.</xs:documentation>
-allocation feature and Code and Data Prioritization (CDP). If the board hardware does not
-support RDT or CDP, setting this option to ``y`` is ignored.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="HYPERV_ENABLED" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="TLFS support for Windows" acrn:views="advanced">
-        <xs:documentation>Enable Hyper-V.</xs:documentation>
+        <xs:documentation>Enable Microsoft(R) Hypervisor Top-Level Functional Specification for Windows hyper-v support.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="IOMMU_ENFORCE_SNP" type="Boolean" default="n">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
-        <xs:documentation>Specify if the IOMMU enforces snoop behavior
+        <xs:documentation>Specify if the IOMMU enforces snoop behavior of DMA operations.</xs:documentation>
-of DMA operations.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="ACPI_PARSE_ENABLED" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="Parse ACPI tables at runtime" acrn:views="advanced">
-        <xs:documentation>Enable ACPI runtime parsing.</xs:documentation>
+        <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.xml file.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="L1D_VMENTRY_ENABLED" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="Mitigate L1 terminal fault" acrn:views="advanced">
-        <xs:documentation>Enable L1 cache flush before VM entry. Default
+        <xs:documentation>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.</xs:documentation>
-value ``n``.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="MCE_ON_PSC_DISABLED" type="Boolean" default="y">
-      <xs:annotation>
+      <xs:annotation acrn:title="MCE workaround" acrn:views="advanced">
-        <xs:documentation>Force disabling software workaround for
+        <xs:documentation>Enable software workaround for Machine Check Error on Page Size Change (silicon bug in some processor families).</xs:documentation>
-Machine Check Error on Page Size Change.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="IVSHMEM" type="IVSHMEMInfo">
-      <xs:annotation>
+      <xs:annotation acrn:title="Inter-VM shared memory" acrn:views="basic">
-        <xs:documentation>Enable Inter-VM Shared memory feature.</xs:documentation>
+        <xs:documentation/>
       </xs:annotation>
     </xs:element>
     <xs:element name="SSRAM" minOccurs="0" type="SSRAMInfo">
-      <xs:annotation>
+      <xs:annotation acrn:title="Software SRAM (for real-time apps)" acrn:views="advanced">
-        <xs:documentation>Pseudo SRAM configuration.</xs:documentation>
+        <xs:documentation />
       </xs:annotation>
     </xs:element>
   </xs:all>
@@ -158,16 +128,13 @@ Machine Check Error on Page Size Change.</xs:documentation>
 <xs:complexType name="MemoryOptionsType">
   <xs:all>
     <xs:element name="STACK_SIZE" type="HexFormat" default="0x2000">
-      <xs:annotation>
+      <xs:annotation acrn:title="Stack size (in byte)" acrn:views="advanced">
-        <xs:documentation>Capacity of one stack (in bytes) used by a
+        <xs:documentation>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.</xs:documentation>
-physical core. Each core uses one stack for normal operation and another
-three for specific exceptions.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="HV_RAM_START" type="HexFormat" default="0x00400000">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
-        <xs:documentation>The 2MB-aligned starting physical address of
+        <xs:documentation>The 2MB-aligned starting physical address of the RAM region used by the hypervisor.</xs:documentation>
-the RAM region used by the hypervisor.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:all>
@@ -175,23 +142,21 @@ the RAM region used by the hypervisor.</xs:documentation>
 
 <xs:complexType name="CapacitiesOptionsType">
   <xs:annotation>
-    <xs:documentation>Capacity limits for static assigned data structure or
+    <xs:documentation>Capacity limits for static assigned data structure or maximum supported resource.</xs:documentation>
-maximum supported resource.</xs:documentation>
   </xs:annotation>
   <xs:all>
     <xs:element name="MAX_VM_NUM" type="xs:integer" default="16">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Maximum number of User VMs allowed.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="IOMMU_BUS_NUM" type="HexFormat" default="0x100">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
-        <xs:documentation>Highest PCI bus ID used during IOMMU
+        <xs:documentation>Highest PCI bus ID used during IOMMU initialization.</xs:documentation>
-initialization.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="MAX_IOAPIC_NUM" default="1">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Maximum number of IOAPICs.</xs:documentation>
       </xs:annotation>
       <xs:simpleType>
@@ -205,8 +170,8 @@ initialization.</xs:documentation>
       </xs:simpleType>
     </xs:element>
     <xs:element name="MAX_PCI_DEV_NUM" default="96">
-      <xs:annotation>
+      <xs:annotation acrn:title="Maximum number of PCI devices" acrn:views="advanced">
-        <xs:documentation>Maximum number of PCI devices.</xs:documentation>
+        <xs:documentation>Specify the static memory allocation of maximum number of PCI devices. (Default value is 96)</xs:documentation>
       </xs:annotation>
       <xs:simpleType>
          <xs:annotation>
@@ -219,7 +184,7 @@ initialization.</xs:documentation>
       </xs:simpleType>
     </xs:element>
     <xs:element name="MAX_IOAPIC_LINES" default="120">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Maximum number of interrupt lines per IOAPIC.</xs:documentation>
       </xs:annotation>
       <xs:simpleType>
@@ -233,14 +198,13 @@ initialization.</xs:documentation>
       </xs:simpleType>
     </xs:element>
     <xs:element name="MAX_PT_IRQ_ENTRIES" type="xs:integer" default="256">
-      <xs:annotation>
+      <xs:annotation acrn:views="advanced">
         <xs:documentation>The pre-defined number of interrupt sources of all pass-through devices.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="MAX_MSIX_TABLE_NUM" default="64">
-        <xs:annotation>
+        <xs:annotation acrn:views="advanced">
-          <xs:documentation>Pre-defined maximum number of virtual MSI-X table entries per device.
+          <xs:documentation>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)</xs:documentation>
-If this value is empty, then the default value will be calculated from information in the board XML file.</xs:documentation>
         </xs:annotation>
       <xs:simpleType>
         <xs:annotation>
@@ -253,8 +217,8 @@ If this value is empty, then the default value will be calculated from informati
       </xs:simpleType>
     </xs:element>
     <xs:element name="MAX_EMULATED_MMIO" default="16">
-        <xs:annotation>
+        <xs:annotation acrn:views="advanced">
-          <xs:documentation>Maximum number of emulated MMIO regions.</xs:documentation>
+          <xs:documentation>Specify maximum number of emulated MMIO regions. (Default value is 16)</xs:documentation>
         </xs:annotation>
       <xs:simpleType>
         <xs:annotation>
@@ -272,7 +236,7 @@ If this value is empty, then the default value will be calculated from informati
 <xs:complexType name="MiscCfgOptionsType">
   <xs:all>
     <xs:element name="GPU_SBDF" type="HexFormat" default="0x00000010">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Segment, Bus, Device, and function of the GPU.</xs:documentation>
       </xs:annotation>
     </xs:element>
@@ -281,13 +245,33 @@ If this value is empty, then the default value will be calculated from informati
 
 <xs:complexType name="HVConfigType">
   <xs:all>
-    <xs:element name="DEBUG_OPTIONS" type="DebugOptionsType" />
+    <xs:element name="DEBUG_OPTIONS" type="DebugOptionsType">
-    <xs:element name="FEATURES" type="FeatureOptionsType" />
+      <xs:annotation acrn:title="Debug options" acrn:views="basic">
-    <xs:element name="MEMORY" type="MemoryOptionsType" />
+	<xs:documentation>Configure the debug facilities.</xs:documentation>
-    <xs:element name="CAPACITIES" type="CapacitiesOptionsType" />
+      </xs:annotation>
-    <xs:element name="MISC_CFG" type="MiscCfgOptionsType" />
+    </xs:element>
-    <xs:element name="vuart_connections" type="VuartConnectionsType" minOccurs="0" maxOccurs="8">
+    <xs:element name="FEATURES" type="FeatureOptionsType">
-      <xs:annotation>
+      <xs:annotation acrn:title="Hypervisor features" acrn:views="basic, advanced">
+	<xs:documentation>Enable hypervisor features.</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="MEMORY" type="MemoryOptionsType">
+      <xs:annotation acrn:title="Memory options" acrn:views="advanced">
+	<xs:documentation>Configure memory used by the hypervisor.</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="CAPACITIES" type="CapacitiesOptionsType">
+      <xs:annotation acrn:title="Hypervisor capacities" acrn:views="advanced">
+	<xs:documentation>Configure the capacities of the hypervisor.</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="MISC_CFG" type="MiscCfgOptionsType">
+      <xs:annotation acrn:views="">
+	<xs:documentation>Miscellaneous options for workarounds.</xs:documentation>
+      </xs:annotation>
+    </xs:element>
+    <xs:element name="vuart_connections" type="VuartConnectionsType">
+      <xs:annotation acrn:title="Virtual UART connection" acrn:views="basic">
         <xs:documentation>Specify the vUART connection setting.
 Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
       </xs:annotation>
@@ -297,20 +281,19 @@ Refer to :ref:`vuart_config` for detailed vUART settings.</xs:documentation>
 
 <xs:complexType name="VMConfigType">
   <xs:all>
-    <xs:element name="vm_type" type="VMType">
-      <xs:annotation>
-        <xs:documentation>Specify the VM type.</xs:documentation>
-      </xs:annotation>
-    </xs:element>
     <xs:element name="load_order" type="LoadOrderType">
-      <xs:annotation>
+      <xs:annotation acrn:title="Load order" acrn:views="">
         <xs:documentation>Specify the load_order.</xs:documentation>
       </xs:annotation>
     </xs:element>
+    <xs:element name="vm_type" type="VMType">
+      <xs:annotation acrn:title="VM type" acrn:views="basic">
+        <xs:documentation>Specify the VM type.</xs:documentation>
+      </xs:annotation>
+    </xs:element>
     <xs:element name="name">
-        <xs:annotation>
+        <xs:annotation acrn:title="VM name" acrn:views="basic">
-          <xs:documentation>Specify the VM name shown in the
+          <xs:documentation>Type in the name used to identify each VM.  The VM name will be shown in the hypervisor console vm_list command.</xs:documentation>
-hypervisor console ``vm_list`` command.</xs:documentation>
         </xs:annotation>
       <xs:simpleType>
         <xs:annotation>
@@ -324,101 +307,101 @@ hypervisor console ``vm_list`` command.</xs:documentation>
       </xs:simpleType>
     </xs:element>
     <xs:element name="lapic_passthrough" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="LAPIC passthrough" acrn:views="advanced">
         <xs:documentation>Specify LAPIC to passthrough.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="io_completion_polling" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="I/O completion polling" acrn:views="advanced">
         <xs:documentation>Specify Polling mode for IO Completion.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="nested_virtualization_support" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Nested virtualization support" acrn:views="advanced">
         <xs:documentation>Specify nested virtualization support for KVM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="virtual_cat_support" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Virtual CAT support" acrn:views="advanced">
         <xs:documentation>Specify virtual CAT support for VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="secure_world_support" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Specify secure world support for trustry OS.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="hide_mtrr_support" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Specify MTRR capability to hide for VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="security_vm" type="Boolean" default="n" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Specify TPM2 FIXUP for VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="cpu_affinity" type="CPUAffinityConfiguration" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Physical CPU affinity" acrn:views="basic">
         <xs:documentation>List of pCPU that this VM's vCPUs are pinned to.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="clos" type="CLOSConfiguration">
-      <xs:annotation>
+      <xs:annotation acrn:views="advanced">
         <xs:documentation>Class of Service for Cache Allocation Technology.
 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>
+      <xs:annotation acrn:views="advanced" acrn:applicable-vms="pre-launched">
         <xs:documentation>Specify SGX Enclave Page Cache section base and size in byte. It must be page aligned.</xs:documentation>
       </xs:annotation>
     </xs:element>
-    <xs:element name="memory" type="MemoryInfo" minOccurs="0">
+    <xs:element name="memory" type="MemoryInfo">
-      <xs:annotation>
+      <xs:annotation acrn:views="basic, advanced">
         <xs:documentation>Specify memory information for Service and User VMs.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="priority" type="PriorityType"  default="PRIO_LOW">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Specify the VM vCPU priority for scheduling.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="companion_vmid" type="xs:integer" default="65535">
-      <xs:annotation>
+      <xs:annotation acrn:views="">
         <xs:documentation>Specify the companion VM id of this VM.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="os_config" type="OSConfigurations" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:applicable-vms="pre-launched, service-vm" acrn:views="basic">
         <xs:documentation>General information for host kernel, boot
 argument and memory.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="console_vuart" type="ConsoleVuartConfiguration" default="None">
-      <xs:annotation>
+      <xs:annotation acrn:views="basic">
         <xs:documentation>Specify the console vUART (aka PCI based vUART) with the vUART ID by
 its ``id`` attribute.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="mmio_resources" type="MMIOResourcesConfiguration" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:views="basic">
         <xs:documentation>MMIO resources to passthrough.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="pt_intx" type="xs:string" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:applicable-vms="pre-launched" acrn:views="advanced">
-        <xs:documentation>pt intx mapping.</xs:documentation>
+        <xs:documentation>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.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="pci_devs" type="PCIDevsConfiguration" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="PCI device assignment" acrn:applicable-vms="pre-launched, post-launched" acrn:views="basic">
-        <xs:documentation>PCI devices list.</xs:documentation>
+        <xs:documentation />
       </xs:annotation>
     </xs:element>
     <xs:element name="PTM" type="Boolean" default="y" minOccurs="0">
-      <xs:annotation>
+      <xs:annotation acrn:title="Precision Time Measurement" acrn:applicable-vms="pre-launched, post-launched" acrn:views="advanced">
-        <xs:documentation>Enable and disable PTM(Precision Timing Measurement) feature.</xs:documentation>
+        <xs:documentation>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.</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:all>

misc/config_tools/schema/types.xsd

@@ -81,19 +81,35 @@
     <xs:documentation>An Integer from 0 to 7 representing log message
 severity and intent:
 
+- 0 no log at all
 - 1 (LOG_FATAL) system is unusable
-- 2 (LOG_ACRN) hypervisor failure
+- 2 (LOG_ERROR) error conditions
-- 3 (LOG_ERROR) error conditions
+- 3 (LOG_WARNING) warning conditions
-- 4 (LOG_WARNING) warning conditions
+- 4 (LOG_INFO) informational
-- 5 (LOG_INFO) informational
+- 5 (LOG_DEBUG) debug-level messages
-- 6 (LOG_DEBUG) debug-level messages
 
 A lower value has a higher severity. Log messages with a
 higher value (lower severity) are discarded.</xs:documentation>
   </xs:annotation>
-  <xs:restriction base="xs:integer">
+  <xs:restriction base="xs:string">
-    <xs:minInclusive value="0" />
+    <xs:enumeration value="0">
-    <xs:maxInclusive value="7" />
+      <xs:annotation acrn:title="0: None" />
+    </xs:enumeration>
+    <xs:enumeration value="1">
+      <xs:annotation acrn:title="1: Critical" />
+    </xs:enumeration>
+    <xs:enumeration value="2">
+      <xs:annotation acrn:title="2: Error" />
+    </xs:enumeration>
+    <xs:enumeration value="3">
+      <xs:annotation acrn:title="3: Warning" />
+    </xs:enumeration>
+    <xs:enumeration value="4">
+      <xs:annotation acrn:title="4: Information" />
+    </xs:enumeration>
+    <xs:enumeration value="5">
+      <xs:annotation acrn:title="5: Debug" />
+    </xs:enumeration>
   </xs:restriction>
 </xs:simpleType>
 
@@ -255,14 +271,14 @@ and no more than 512.</xs:documentation>
 <xs:complexType name="RDTType">
   <xs:sequence>
     <xs:element name="RDT_ENABLED" type="Boolean" default="n">
-      <xs:annotation>
+      <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
 RDT, setting this option to ``y`` is ignored.</xs:documentation>
       </xs:annotation>
     </xs:element>
     <xs:element name="CDP_ENABLED" type="Boolean" default="n">
-      <xs:annotation>
+      <xs:annotation acrn:title="Code and Data Prioritization">
         <xs:documentation>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.</xs:documentation>
@@ -295,9 +311,8 @@ 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>
+      <xs:annotation acrn:title="Software SRAM">
-        <xs:documentation>Enable PTCM (Platform Tuning Configuration
+        <xs:documentation>Enable the Software SRAM feature for real-time VMs. This feature reserves memory buffers as always-cached memory for improved VM performance.</xs:documentation>
-Manager).</xs:documentation>
       </xs:annotation>
     </xs:element>
   </xs:sequence>