OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: update config data descriptions 

Fix some formatting issues in PR #6378

Tracked-On: #6377

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-08-11 11:27:11 -07:00 committed by David Kinder
parent de19301a5a
commit 2216134cf4
3 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
misc/config_tools/schema/VMtypes.xsd
View File

@ -86,8 +86,7 @@ to.</xs:documentation>
<xs:annotation>
<xs:documentation>Configure each CPU in VMs to a desired CLOS ID in the ``VM`` section of the
scenario file. Follow :ref:`rdt_detection_capabilities`
to identify the maximum supported CLOS ID that can be used. Default
value ``0``.</xs:documentation>
to identify the maximum supported CLOS ID that can be used.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>

22
misc/config_tools/schema/config.xsd
View File

@ -24,17 +24,17 @@ hypervisor shell.</xs:documentation>
<xs:element name="SERIAL_CONSOLE" type="SerialConsoleOptions" default="/dev/ttyS0">
<xs:annotation>
<xs:documentation>Specify the host serial device used for hypervisor debugging.
This entry is valid if and only if `hv.DEBUG_OPTIONS.RELEASE` is n.
This entry impacts the content of `vm.(legacy_vuart id="0").base` when `vm.vm_type` is SOS_VM,
which specifies the PIO base for Service VM legacy vUART 0 (used for console).
The determination of the PIO base for Service VM legacy vUART 0 follows the rules below:
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.vm_type` is ``SOS_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 hv.DEBUG_OPTIONS.SERIAL_CONSOLE is one of [ttys0, ttys1, ttys2, ttys3] and it's a PIO in the
native environment, the PIO base of Service VM legacy vUART 0 would be the same as the PIO base
corresponding to hv.DEBUG_OPTIONS.SERIAL_CONSOLE in the native environment.
- Otherwise, a PIO base would be assigned to Service VM legacy vUART 0 from the available PIO list.
- If :option:`hv.DEBUG_OPTIONS.SERIAL_CONSOLE` is ``ttys0``, ``ttys1``, ``ttys2``, or ``ttys3`` and it is a PIO 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.
The above logic is implemented in the configuration tools.</xs:documentation>
This logic is implemented in the configuration tools.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MEM_LOGLEVEL" type="LogLevelType" default="5">
@ -292,8 +292,8 @@ initialization.</xs:documentation>
</xs:element>
<xs:element name="MAX_MSIX_TABLE_NUM" default="64">
<xs:annotation>
<xs:documentation>Pre-defined maximum number of virtual MSI-X Table entries per device.
If this value is empty, then the default value will be calculated from the board XML file.</xs:documentation>
<xs:documentation>Pre-defined maximum number of virtual MSI-X table entries per device.
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>

6
misc/config_tools/schema/types.xsd
View File

@ -179,9 +179,9 @@ value ``n``.</xs:documentation>
<xs:annotation>
<xs:documentation>Specify the cache capacity bitmask for the CLOS; only continuous '1' bits
are allowed. The value will be ignored when hardware does not support RDT.
This entry takes effect only if `hv.FEATURES.RDT.RDT_ENABLED` is y.
As `vm.clos.vcpu_clos` specifies the index of the CLOS to be associated with the given vCPU,
`hv.FEATURES.RDT.CLOS_MASK` of that CLOS would impact the performance of the given vCPU.</xs:documentation>
This option takes effect only if :option:`hv.FEATURES.RDT.RDT_ENABLED` is set to ``y``.
As :option:`vm.clos.vcpu_clos` specifies the index of the CLOS to be associated with the given vCPU,
:option:`hv.FEATURES.RDT.CLOS_MASK` of that CLOS would impact the performance of the given vCPU.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MBA_DELAY" type="xs:string" minOccurs="0" maxOccurs="unbounded">