Skip to content

Commit 69bf758

Browse files
mchehabbonzini
authored andcommitted
docs: kvm: convert arm/hyp-abi.txt to ReST
- Add proper markups for titles; - Adjust whitespaces and blank lines to match ReST needs; - Mark literal blocks as such. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 106ee47 commit 69bf758

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

Documentation/virt/kvm/arm/hyp-abi.txt renamed to Documentation/virt/kvm/arm/hyp-abi.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
* Internal ABI between the kernel and HYP
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=======================================
4+
Internal ABI between the kernel and HYP
5+
=======================================
26

37
This file documents the interaction between the Linux kernel and the
48
hypervisor layer when running Linux as a hypervisor (for example
@@ -19,25 +23,31 @@ and only act on individual CPUs.
1923
Unless specified otherwise, any built-in hypervisor must implement
2024
these functions (see arch/arm{,64}/include/asm/virt.h):
2125

22-
* r0/x0 = HVC_SET_VECTORS
23-
r1/x1 = vectors
26+
* ::
27+
28+
r0/x0 = HVC_SET_VECTORS
29+
r1/x1 = vectors
2430

2531
Set HVBAR/VBAR_EL2 to 'vectors' to enable a hypervisor. 'vectors'
2632
must be a physical address, and respect the alignment requirements
2733
of the architecture. Only implemented by the initial stubs, not by
2834
Linux hypervisors.
2935

30-
* r0/x0 = HVC_RESET_VECTORS
36+
* ::
37+
38+
r0/x0 = HVC_RESET_VECTORS
3139

3240
Turn HYP/EL2 MMU off, and reset HVBAR/VBAR_EL2 to the initials
3341
stubs' exception vector value. This effectively disables an existing
3442
hypervisor.
3543

36-
* r0/x0 = HVC_SOFT_RESTART
37-
r1/x1 = restart address
38-
x2 = x0's value when entering the next payload (arm64)
39-
x3 = x1's value when entering the next payload (arm64)
40-
x4 = x2's value when entering the next payload (arm64)
44+
* ::
45+
46+
r0/x0 = HVC_SOFT_RESTART
47+
r1/x1 = restart address
48+
x2 = x0's value when entering the next payload (arm64)
49+
x3 = x1's value when entering the next payload (arm64)
50+
x4 = x2's value when entering the next payload (arm64)
4151

4252
Mask all exceptions, disable the MMU, move the arguments into place
4353
(arm64 only), and jump to the restart address while at HYP/EL2. This

Documentation/virt/kvm/arm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ ARM
77
.. toctree::
88
:maxdepth: 2
99

10+
hyp-abi
1011
pvtime

0 commit comments

Comments
 (0)