doc: update Security VM Features config option

Updated the description of Security VM Features per review comments, and
made the option visible (again) in the configurator as an advanced
hypervisor option.

Created a new glossary entry for "Security VM", referenced by this new
description and tooltip.

Tweak wording of virtio console and input device descriptions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Tracked-On: #7968
This commit is contained in:
David B. Kinder 2022-08-09 13:01:29 -07:00 committed by acrnsi-robot
parent cb91722dd5
commit b8c85135d9
2 changed files with 21 additions and 4 deletions

View File

@ -143,6 +143,12 @@ Glossary of Terms
developers can use to define a scenario configuration appropriate for
their own application.
Security VM
A special :term:`User VM` providing software-based security services
within a dynamic virtualized environment. Such security services are
application dependent and can include antivirus and malware detection,
virtualized firewalls, resource monitoring, and more.
Service VM
A special VM, directly launched by the hypervisor. The Service VM can
access hardware resources directly by running native drivers and provides

View File

@ -69,8 +69,19 @@
</xs:annotation>
</xs:element>
<xs:element name="SECURITY_VM_FIXUP" type="Boolean" default="n">
<xs:annotation acrn:views="">
<xs:documentation>Enable to do fixup for TPM2 and SMBIOS for Security VM. If no Security VM, setting this option to ``n``</xs:documentation>
<xs:annotation acrn:title="Security VM Features" acrn:views="advanced">
<xs:documentation>This option enables hypervisor features potentially needed by a :term:`Security VM`:
- The virtual Trusted Platform Module (vTPM) 2.0 ACPI table, likely
used by a security VM, is usually generated statically at build
time. Checking this option enables the ACRN hypervisor to update the
vTPM 2.0 ACPI table if the physical ACPI table was modified by the BIOS.
- Data from the system management BIOS (SMBIOS) can replace probing
hardware directly to discover what devices are present. Checking
this option enables the hypervisor to pass through the physical
SMBIOS to a pre-launched security VM.
If your VM is not a security VM, leave this option unchecked. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="KEEP_IRQ_DISABLED" type="Boolean" default="n">
@ -448,7 +459,7 @@ This feature enables you to view the VM's GPU output in the Service VM.</xs:docu
<xs:annotation acrn:title="Virtio console device" acrn:views="basic">
<xs:documentation>Virtio console device for data input and output.
The virtio console BE driver copies data from the frontend's transmitting virtqueue when it receives a kick on virtqueue (implemented as a vmexit).
The BE driver then writes the data to backend, and can be implemented as PTY, TTY, STDIO, and regular file.
The BE driver then writes the data to backend, and can be implemented as a PTY, TTY, STDIO, or regular file.
For details, see :ref:`virtio-console`.</xs:documentation>
</xs:annotation>
</xs:element>
@ -462,7 +473,7 @@ is the virtio network driver, simulating the virtual NIC. The backend could be:
<xs:element name="input" type="VirtioInputConfiguration" minOccurs="0" maxOccurs="unbounded">
<xs:annotation acrn:title="Virtio input device" acrn:views="basic">
<xs:documentation>The virtio input device creates a virtual human interface device such as a keyboard,
mouse, and tablet. It sends Linux input layer events over virtio.</xs:documentation>
mouse, or tablet. The device sends Linux input layer events over virtio.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="block" minOccurs="0" maxOccurs="unbounded">