From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Paolo Bonzini <pbonzini@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
kvm@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH v2 09/27] docs: kvm: convert devices/arm-vgit.txt to ReST
Date: Thu, 6 Feb 2020 15:50:06 +0100 [thread overview]
Message-ID: <9d0b1c94cc9515ba4e753464a6ee95a89ba2b3b0.1581000481.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1581000481.git.mchehab+huawei@kernel.org>
- Use title markups;
- change indent to match ReST syntax;
- use proper table markups;
- use literal block markups.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../devices/{arm-vgic.txt => arm-vgic.rst} | 89 ++++++++++++-------
Documentation/virt/kvm/devices/index.rst | 1 +
2 files changed, 60 insertions(+), 30 deletions(-)
rename Documentation/virt/kvm/devices/{arm-vgic.txt => arm-vgic.rst} (66%)
diff --git a/Documentation/virt/kvm/devices/arm-vgic.txt b/Documentation/virt/kvm/devices/arm-vgic.rst
similarity index 66%
rename from Documentation/virt/kvm/devices/arm-vgic.txt
rename to Documentation/virt/kvm/devices/arm-vgic.rst
index 97b6518148f8..40bdeea1d86e 100644
--- a/Documentation/virt/kvm/devices/arm-vgic.txt
+++ b/Documentation/virt/kvm/devices/arm-vgic.rst
@@ -1,8 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==================================================
ARM Virtual Generic Interrupt Controller v2 (VGIC)
==================================================
Device types supported:
- KVM_DEV_TYPE_ARM_VGIC_V2 ARM Generic Interrupt Controller v2.0
+
+ - KVM_DEV_TYPE_ARM_VGIC_V2 ARM Generic Interrupt Controller v2.0
Only one VGIC instance may be instantiated through either this API or the
legacy KVM_CREATE_IRQCHIP API. The created VGIC will act as the VM interrupt
@@ -17,7 +21,8 @@ create both a GICv3 and GICv2 device on the same VM.
Groups:
KVM_DEV_ARM_VGIC_GRP_ADDR
- Attributes:
+ Attributes:
+
KVM_VGIC_V2_ADDR_TYPE_DIST (rw, 64-bit)
Base address in the guest physical address space of the GIC distributor
register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2.
@@ -27,19 +32,25 @@ Groups:
Base address in the guest physical address space of the GIC virtual cpu
interface register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2.
This address needs to be 4K aligned and the region covers 4 KByte.
+
Errors:
- -E2BIG: Address outside of addressable IPA range
- -EINVAL: Incorrectly aligned address
- -EEXIST: Address already configured
- -ENXIO: The group or attribute is unknown/unsupported for this device
+
+ ======= =============================================================
+ -E2BIG Address outside of addressable IPA range
+ -EINVAL Incorrectly aligned address
+ -EEXIST Address already configured
+ -ENXIO The group or attribute is unknown/unsupported for this device
or hardware support is missing.
- -EFAULT: Invalid user pointer for attr->addr.
+ -EFAULT Invalid user pointer for attr->addr.
+ ======= =============================================================
KVM_DEV_ARM_VGIC_GRP_DIST_REGS
- Attributes:
- The attr field of kvm_device_attr encodes two values:
- bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 |
- values: | reserved | vcpu_index | offset |
+ Attributes:
+
+ The attr field of kvm_device_attr encodes two values::
+
+ bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 |
+ values: | reserved | vcpu_index | offset |
All distributor regs are (rw, 32-bit)
@@ -58,16 +69,22 @@ Groups:
KVM_DEV_ARM_VGIC_GRP_DIST_REGS and KVM_DEV_ARM_VGIC_GRP_CPU_REGS) to ensure
the expected behavior. Unless GICD_IIDR has been set from userspace, writes
to the interrupt group registers (GICD_IGROUPR) are ignored.
+
Errors:
- -ENXIO: Getting or setting this register is not yet supported
- -EBUSY: One or more VCPUs are running
- -EINVAL: Invalid vcpu_index supplied
+
+ ======= =====================================================
+ -ENXIO Getting or setting this register is not yet supported
+ -EBUSY One or more VCPUs are running
+ -EINVAL Invalid vcpu_index supplied
+ ======= =====================================================
KVM_DEV_ARM_VGIC_GRP_CPU_REGS
- Attributes:
- The attr field of kvm_device_attr encodes two values:
- bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 |
- values: | reserved | vcpu_index | offset |
+ Attributes:
+
+ The attr field of kvm_device_attr encodes two values::
+
+ bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 |
+ values: | reserved | vcpu_index | offset |
All CPU interface regs are (rw, 32-bit)
@@ -101,27 +118,39 @@ Groups:
value left by 3 places to obtain the actual priority mask level.
Errors:
- -ENXIO: Getting or setting this register is not yet supported
- -EBUSY: One or more VCPUs are running
- -EINVAL: Invalid vcpu_index supplied
+
+ ======= =====================================================
+ -ENXIO Getting or setting this register is not yet supported
+ -EBUSY One or more VCPUs are running
+ -EINVAL Invalid vcpu_index supplied
+ ======= =====================================================
KVM_DEV_ARM_VGIC_GRP_NR_IRQS
- Attributes:
+ Attributes:
+
A value describing the number of interrupts (SGI, PPI and SPI) for
this GIC instance, ranging from 64 to 1024, in increments of 32.
Errors:
- -EINVAL: Value set is out of the expected range
- -EBUSY: Value has already be set, or GIC has already been initialized
- with default values.
+
+ ======= =============================================================
+ -EINVAL Value set is out of the expected range
+ -EBUSY Value has already be set, or GIC has already been initialized
+ with default values.
+ ======= =============================================================
KVM_DEV_ARM_VGIC_GRP_CTRL
- Attributes:
+ Attributes:
+
KVM_DEV_ARM_VGIC_CTRL_INIT
request the initialization of the VGIC or ITS, no additional parameter
in kvm_device_attr.addr.
+
Errors:
- -ENXIO: VGIC not properly configured as required prior to calling
- this attribute
- -ENODEV: no online VCPU
- -ENOMEM: memory shortage when allocating vgic internal data
+
+ ======= =========================================================
+ -ENXIO VGIC not properly configured as required prior to calling
+ this attribute
+ -ENODEV no online VCPU
+ -ENOMEM memory shortage when allocating vgic internal data
+ ======= =========================================================
diff --git a/Documentation/virt/kvm/devices/index.rst b/Documentation/virt/kvm/devices/index.rst
index 80c1e0e225f4..7eabce80c61e 100644
--- a/Documentation/virt/kvm/devices/index.rst
+++ b/Documentation/virt/kvm/devices/index.rst
@@ -8,4 +8,5 @@ Devices
:maxdepth: 2
arm-vgic-its
+ arm-vgic
arm-vgic-v3
--
2.24.1
next prev parent reply other threads:[~2020-02-06 14:51 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-06 14:49 [PATCH v2 00/27] docs: virt: manually convert text documents to ReST format Mauro Carvalho Chehab
2020-02-06 14:49 ` [PATCH v2 01/27] docs: kvm: add arm/pvtime.rst to index.rst Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 05/27] docs: virt: convert halt-polling.txt to ReST format Mauro Carvalho Chehab
2020-02-06 15:41 ` Cornelia Huck
2020-02-06 14:50 ` [PATCH v2 06/27] docs: virt: Convert msr.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 07/27] docs: kvm: devices/arm-vgic-its.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 08/27] docs: kvm: devices/arm-vgit-v3.txt to ReST Mauro Carvalho Chehab
2020-02-06 14:50 ` Mauro Carvalho Chehab [this message]
2020-02-06 14:50 ` [PATCH v2 10/27] docs: kvm: convert devices/mpic.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 11/27] docs: kvm: convert devices/s390_flic.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 12/27] docs: kvm: convert devices/vcpu.txt " Mauro Carvalho Chehab
2020-02-06 15:47 ` Cornelia Huck
2020-02-06 14:50 ` [PATCH v2 13/27] " Mauro Carvalho Chehab
2020-02-06 15:54 ` Cornelia Huck
2020-02-06 14:50 ` [PATCH v2 14/27] docs: kvm: convert devices/vm.txt " Mauro Carvalho Chehab
2020-02-06 15:57 ` Cornelia Huck
2020-02-06 14:50 ` [PATCH v2 15/27] docs: kvm: convert devices/xics.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 16/27] docs: kvm: convert devices/xive.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 18/27] docs: kvm: convert arm/hyp-abi.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 19/27] docs: kvm: arm/psci.txt: convert " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 20/27] docs: kvm: Convert hypercalls.txt to ReST format Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 21/27] docs: kvm: Convert locking.txt " Mauro Carvalho Chehab
2020-02-06 16:11 ` Cornelia Huck
2020-02-06 21:57 ` Paolo Bonzini
2020-02-06 22:47 ` Mauro Carvalho Chehab
2020-02-06 23:13 ` Paolo Bonzini
2020-02-07 6:24 ` Mauro Carvalho Chehab
2020-02-07 8:48 ` Cornelia Huck
2020-02-10 5:58 ` Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 22/27] docs: kvm: Convert mmu.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 23/27] docs: kvm: Convert nested-vmx.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 24/27] docs: kvm: Convert ppc-pv.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 25/27] docs: kvm: Convert s390-diag.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 26/27] docs: kvm: Convert timekeeping.txt " Mauro Carvalho Chehab
2020-02-06 14:50 ` [PATCH v2 27/27] docs: kvm: review-checklist.txt: rename to ReST Mauro Carvalho Chehab
2020-02-06 16:13 ` Cornelia Huck
2020-02-06 15:18 ` [PATCH v2 00/27] docs: virt: manually convert text documents to ReST format Paolo Bonzini
2020-02-06 16:17 ` Cornelia Huck
2020-02-06 16:21 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9d0b1c94cc9515ba4e753464a6ee95a89ba2b3b0.1581000481.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=pbonzini@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).