Skip to content

Commit 0476707

Browse files
deb-intelwenlingz
authored andcommitted
Doc: Final edits to the HV Hypercall doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
1 parent dcfa758 commit 0476707

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

doc/developer-guides/hld/hv-hypercall.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,35 @@
33
Hypercall / VHM upcall
44
######################
55

6-
Hypercall/upcall used to request services between Guest VM and hypervisor,
7-
hypercall is from Guest VM to hypervisor, upcall is from hypervisor to Guest VM.
8-
Hypervisor currently supports hypercall APIs for VM management, I/O request
9-
distribution,interrupt injection, PCI assignment, guest memory mapping,
10-
power management and secure world switch.
6+
The hypercall/upcall is used to request services between the Guest VM and the hypervisor.
7+
The hypercall is from the Guest VM to hypervisor, and the upcall is from the hypervisor to the Guest VM.
8+
The hypervisor currently supports hypercall APIs for VM management, I/O request
9+
distribution, interrupt injection, PCI assignment, guest memory mapping,
10+
power management, and secure world switch.
1111

1212
There are some restrictions for hypercall and upcall:
1313

14-
#. Only ring0 hypercalls from the guest VM are handled by the hypervisor,
15-
otherwise hypervisor will inject GP to Guest VM.
16-
#. All the hypercalls (except secure world hypercalls) must be called from SOS VM,
17-
otherwise hypervisor will inject UD to Guest VM.
14+
#. Only ring 0 hypercalls from the guest VM are handled by the hypervisor;
15+
otherwise, the hypervisor will inject GP to the Guest VM.
16+
#. All the hypercalls (except secure world hypercalls) must be called from the Service VM;
17+
otherwise, the hypervisor will inject UD to the Guest VM.
1818
see :ref:`secure-hypervisor-interface` for a detailed description.
19-
#. Hypervisor needs to protect the critical resources such as global VM and VCPU structures
19+
#. The hypervisor needs to protect the critical resources such as global VM and VCPU structures
2020
for VM and VCPU management hypercalls.
21-
#. Upcall is only used for SOS VM.
21+
#. Upcall is only used for the Service VM.
2222

2323

24-
HV and Service OS (SOS) both use the same vector(0xF3) reserved as x86 platform
25-
IPI vector for HV notification to SOS. This upcall is necessary whenever
26-
there is device emulation requirement to SOS. The upcall vector(0xF3) is
27-
injected to SOS vCPU0.SOS will register the irq handler for vector(0xF3) and notify the I/O emulation
28-
module in SOS once the irq is triggered.
29-
The detailed upcall process see :ref:`ipi-management`
24+
HV and Service VM both use the same vector (0xF3) reserved as x86 platform
25+
IPI vector for HV notification to the Service VM. This upcall is necessary whenever
26+
there is device emulation requirement to the Service VM. The upcall vector (0xF3) is
27+
injected to Service VM vCPU0. The Service VM will register the irq handler for vector (0xF3) and notify the I/O emulation
28+
module in the Service VM once the irq is triggered.
29+
View the detailed upcall process at :ref:`ipi-management`
3030

3131
Hypercall APIs reference:
3232
*************************
3333

34-
:ref:`hypercall_apis` for SOS
34+
:ref:`hypercall_apis` for the Service VM
3535

3636
:ref:`trusty-hypercalls` for Trusty
3737

0 commit comments

Comments
 (0)