Skip to content

Commit 5a08146

Browse files
willdeaconMarc Zyngier
authored andcommitted
KVM: arm64: Reformat/beautify PTP hypercall documentation
The PTP hypercall documentation doesn't produce the best-looking table when formatting in HTML as all of the return value definitions end up on the same line. Reformat the PTP hypercall documentation to follow the formatting used by hypercalls.rst. Signed-off-by: Will Deacon <[email protected]> Signed-off-by: Fuad Tabba <[email protected]> Acked-by: Oliver Upton <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Marc Zyngier <[email protected]>
1 parent eef4ce6 commit 5a08146

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

Documentation/virt/kvm/arm/ptp_kvm.rst

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,29 @@ PTP_KVM is used for high precision time sync between host and guests.
77
It relies on transferring the wall clock and counter value from the
88
host to the guest using a KVM-specific hypercall.
99

10-
* ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID: 0x86000001
10+
``ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID``
11+
----------------------------------------
1112

12-
This hypercall uses the SMC32/HVC32 calling convention:
13+
Retrieve current time information for the specific counter. There are no
14+
endianness restrictions.
1315

14-
ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID
15-
============== ======== =====================================
16-
Function ID: (uint32) 0x86000001
17-
Arguments: (uint32) KVM_PTP_VIRT_COUNTER(0)
18-
KVM_PTP_PHYS_COUNTER(1)
19-
Return Values: (int32) NOT_SUPPORTED(-1) on error, or
20-
(uint32) Upper 32 bits of wall clock time (r0)
21-
(uint32) Lower 32 bits of wall clock time (r1)
22-
(uint32) Upper 32 bits of counter (r2)
23-
(uint32) Lower 32 bits of counter (r3)
24-
Endianness: No Restrictions.
25-
============== ======== =====================================
16+
+---------------------+-------------------------------------------------------+
17+
| Presence: | Optional |
18+
+---------------------+-------------------------------------------------------+
19+
| Calling convention: | HVC32 |
20+
+---------------------+----------+--------------------------------------------+
21+
| Function ID: | (uint32) | 0x86000001 |
22+
+---------------------+----------+----+---------------------------------------+
23+
| Arguments: | (uint32) | R1 | ``KVM_PTP_VIRT_COUNTER (0)`` |
24+
| | | +---------------------------------------+
25+
| | | | ``KVM_PTP_PHYS_COUNTER (1)`` |
26+
+---------------------+----------+----+---------------------------------------+
27+
| Return Values: | (int32) | R0 | ``NOT_SUPPORTED (-1)`` on error, else |
28+
| | | | upper 32 bits of wall clock time |
29+
| +----------+----+---------------------------------------+
30+
| | (uint32) | R1 | Lower 32 bits of wall clock time |
31+
| +----------+----+---------------------------------------+
32+
| | (uint32) | R2 | Upper 32 bits of counter |
33+
| +----------+----+---------------------------------------+
34+
| | (uint32) | R3 | Lower 32 bits of counter |
35+
+---------------------+----------+----+---------------------------------------+

0 commit comments

Comments
 (0)