Skip to content

Commit 72faca5

Browse files
lyan3dbkinder
authored andcommitted
doc: update documents for "--lapic_pt" feature
- added description of lapic pt feature based on vlapic in HLD virt-interrupt part; - updated the doc to include description of new acrn-dm option "--lapic_pt". Tracked-On: #2351 Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Anthony Xu <anthony.xu@intel.com>
1 parent 2ffc683 commit 72faca5

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

doc/developer-guides/hld/hld-devicemodel.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ options:
5757
[-s pci] [-U uuid] [--vsbl vsbl_file_name] [--ovmf ovmf_file_path]
5858
[--part_info part_info_name] [--enable_trusty] [--intr_monitor param_setting]
5959
[--vtpm2 sock_path] [--virtio_poll interval] [--mac_seed seed_string]
60-
[--vmcfg sub_options] [--dump vm_idx] [--ptdev_no_reset] [--debugexit] <vm>
60+
[--vmcfg sub_options] [--dump vm_idx] [--ptdev_no_reset] [--debugexit]
61+
[--lapic_pt] <vm>
6162
-A: create ACPI tables
6263
-B: bootargs for kernel
6364
-c: # cpus (default 1)
@@ -88,6 +89,7 @@ options:
8889
its params: threshold/s,probe-period(s),delay_time(ms),delay_duration(ms),
8990
--virtio_poll: enable virtio poll mode with poll interval with ns
9091
--vtpm2: Virtual TPM2 args: sock_path=$PATH_OF_SWTPM_SOCKET
92+
--lapic_pt: enable local apic passthrough
9193
9294
See :ref:`acrn-dm_parameters` for more detailed descriptions of these
9395
configuration options.

doc/developer-guides/hld/hv-virt-interrupt.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,21 @@ it clears the highest priority vector in ISR and TMR, and updates PPR
126126
status. vLAPIC will then notify vIOAPIC if the corresponding vector
127127
comes from vIOAPIC. This only occurs for the level triggered interrupts.
128128

129+
LAPIC passthrough based on vLAPIC
130+
=================================
131+
132+
LAPIC passthrough is supported based on vLAPIC, after switch to x2APIC
133+
mode. In case of LAPIC passthrough based on vLAPIC, the system will have the
134+
following characteristics.
135+
136+
* IRQs received by the LAPIC can be handled by the Guest VM without ``vmexit``
137+
* Guest VM always see virtual LAPIC IDs for security reasons
138+
* most MSRs are directly accessible from Guest VM except for ``XAPICID``,
139+
``LDR`` and ``ICR``. Write operations to ``ICR`` will be trapped to avoid
140+
malicious IPI. Read operations to ``XAPIC`` and ``LDR`` will be trapped in
141+
order to make the Guest VM always see the virtual LAPIC IDs instead of the
142+
physical ones.
143+
129144
Virtual IOAPIC
130145
**************
131146

doc/user-guides/acrn-dm-parameters.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,3 +313,10 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
313313

314314
By default, DM will create the MPtable for you. Use this option to
315315
disable it.
316+
317+
* - :kbd:`--lapic_pt`
318+
- This option is to create a VM with lapic pass-through.
319+
With this option, a VM is created with LAPIC_PASSTHROUGH and
320+
IOREQ_COMPLETION_POLLING mode. This kind of VM is generally for realtime scenarios.
321+
322+
By default, DM will create VM without this option.

0 commit comments

Comments
 (0)