All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
From: Fuad Tabba <tabba@google.com>
To: kvmarm@lists.linux.dev
Cc: maz@kernel.org, will@kernel.org, qperret@google.com,
	tabba@google.com,  seanjc@google.com, alexandru.elisei@arm.com,
	catalin.marinas@arm.com,  philmd@linaro.org, james.morse@arm.com,
	suzuki.poulose@arm.com,  oliver.upton@linux.dev,
	mark.rutland@arm.com, broonie@kernel.org,  joey.gouly@arm.com,
	rananta@google.com, smostafa@google.com
Subject: [PATCH v2 33/47] KVM: arm64: Document the KVM/arm64-specific calls in hypercalls.rst
Date: Tue, 16 Apr 2024 10:56:24 +0100	[thread overview]
Message-ID: <20240416095638.3620345-34-tabba@google.com> (raw)
In-Reply-To: <20240416095638.3620345-1-tabba@google.com>

From: Will Deacon <will@kernel.org>

KVM/arm64 makes use of the SMCCC "Vendor Specific Hypervisor Service
Call Range" to expose KVM-specific hypercalls to guests in a
discoverable and extensible fashion.

Document the existence of this interface and the discovery hypercall.

Signed-off-by: Will Deacon <will@kernel.org>
Signed-off-by: Fuad Tabba <tabba@google.com>
---
 Documentation/virt/kvm/arm/hypercalls.rst | 46 +++++++++++++++++++++++
 Documentation/virt/kvm/arm/index.rst      |  1 +
 2 files changed, 47 insertions(+)
 create mode 100644 Documentation/virt/kvm/arm/hypercalls.rst

diff --git a/Documentation/virt/kvm/arm/hypercalls.rst b/Documentation/virt/kvm/arm/hypercalls.rst
new file mode 100644
index 000000000000..17be111f493f
--- /dev/null
+++ b/Documentation/virt/kvm/arm/hypercalls.rst
@@ -0,0 +1,46 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===============================================
+KVM/arm64-specific hypercalls exposed to guests
+===============================================
+
+This file documents the KVM/arm64-specific hypercalls which may be
+exposed by KVM/arm64 to guest operating systems. These hypercalls are
+issued using the HVC instruction according to version 1.1 of the Arm SMC
+Calling Convention (DEN0028/C):
+
+https://developer.arm.com/docs/den0028/c
+
+All KVM/arm64-specific hypercalls are allocated within the "Vendor
+Specific Hypervisor Service Call" range with a UID of
+``28b46fb6-2ec5-11e9-a9ca-4b564d003a74``. This UID should be queried by the
+guest using the standard "Call UID" function for the service range in
+order to determine that the KVM/arm64-specific hypercalls are available.
+
+``ARM_SMCCC_VENDOR_HYP_KVM_FEATURES_FUNC_ID``
+---------------------------------------------
+
+Provides a discovery mechanism for other KVM/arm64 hypercalls.
+
++---------------------+-------------------------------------------------------------+
+| Presence:           | Mandatory for the KVM/arm64 UID                             |
++---------------------+-------------------------------------------------------------+
+| Calling convention: | HVC32                                                       |
++---------------------+----------+--------------------------------------------------+
+| Function ID:        | (uint32) | 0x86000000                                       |
++---------------------+----------+--------------------------------------------------+
+| Arguments:          | None                                                        |
++---------------------+----------+----+---------------------------------------------+
+| Return Values:      | (uint32) | R0 | Bitmap of available function numbers 0-31   |
+|                     +----------+----+---------------------------------------------+
+|                     | (uint32) | R1 | Bitmap of available function numbers 32-63  |
+|                     +----------+----+---------------------------------------------+
+|                     | (uint32) | R2 | Bitmap of available function numbers 64-95  |
+|                     +----------+----+---------------------------------------------+
+|                     | (uint32) | R3 | Bitmap of available function numbers 96-127 |
++---------------------+----------+----+---------------------------------------------+
+
+``ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID``
+----------------------------------------
+
+See ptp_kvm.rst
diff --git a/Documentation/virt/kvm/arm/index.rst b/Documentation/virt/kvm/arm/index.rst
index d28d65122290..ec09881de4cf 100644
--- a/Documentation/virt/kvm/arm/index.rst
+++ b/Documentation/virt/kvm/arm/index.rst
@@ -9,6 +9,7 @@ ARM
 
    fw-pseudo-registers
    hyp-abi
+   hypercalls
    pvtime
    ptp_kvm
    vcpu-features
-- 
2.44.0.683.g7961c838ac-goog


  parent reply	other threads:[~2024-04-16  9:57 UTC|newest]

Thread overview: 67+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-16  9:55 [PATCH v2 00/47] KVM: arm64: Preamble for pKVM Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 01/47] KVM: arm64: Allocate per-cpu memory for the host fpsimd state in pKVM Fuad Tabba
2024-04-16 10:57   ` Mark Brown
2024-04-16 12:54   ` Marc Zyngier
2024-04-16 13:08     ` Marc Zyngier
2024-04-16 13:10       ` Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 02/47] KVM: arm64: Do not re-initialize the KVM lock Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 03/47] KVM: arm64: Issue CMOs when tearing down guest s2 pages Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 04/47] KVM: arm64: Avoid BUG-ing from the host abort path Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 05/47] KVM: arm64: Fix comment for __pkvm_vcpu_init_traps() Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 06/47] KVM: arm64: Change kvm_handle_mmio_return() return polarity Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 07/47] KVM: arm64: Move setting the page as dirty out of the critical section Fuad Tabba
2024-04-16  9:55 ` [PATCH v2 08/47] KVM: arm64: Check for PTE validity when checking for executable/cacheable Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 09/47] KVM: arm64: Avoid BBM when changing only s/w bits in Stage-2 PTE Fuad Tabba
2024-04-16 16:59   ` Oliver Upton
2024-04-16 18:06     ` Fuad Tabba
2024-04-16 18:19       ` Oliver Upton
2024-04-16  9:56 ` [PATCH v2 10/47] KVM: arm64: Support TLB invalidation in guest context Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 11/47] KVM: arm64: Simplify vgic-v3 hypercalls Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 12/47] KVM: arm64: Add is_pkvm_initialized() helper Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 13/47] KVM: arm64: Introduce predicates to check for protected state Fuad Tabba
2024-04-16 17:18   ` Oliver Upton
2024-04-16 18:07     ` Fuad Tabba
2024-04-16 18:10       ` Oliver Upton
2024-04-16 18:12         ` Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 14/47] KVM: arm64: Split up nvhe/fixed_config.h Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 15/47] KVM: arm64: Move pstate reset value definitions to kvm_arm.h Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 16/47] KVM: arm64: Clarify rationale for ZCR_EL1 value restored on guest exit Fuad Tabba
2024-04-16 10:47   ` Mark Brown
2024-04-16 13:38     ` Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 17/47] KVM: arm64: Refactor calculating SVE state size to use helpers Fuad Tabba
2024-04-16 10:48   ` Mark Brown
2024-04-16  9:56 ` [PATCH v2 18/47] KVM: arm64: Do not map the host fpsimd state to hyp in pKVM Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 19/47] KVM: arm64: Move some kvm_psci functions to a shared header Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 20/47] KVM: arm64: Refactor reset_mpidr() to extract its computation Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 21/47] KVM: arm64: Refactor kvm_vcpu_enable_ptrauth() for hyp use Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 22/47] KVM: arm64: Refactor enter_exception64() Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 23/47] KVM: arm64: Add PC_UPDATE_REQ flags covering all PC updates Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 24/47] KVM: arm64: Add vcpu flag copy primitive Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 25/47] KVM: arm64: Introduce gfn_to_memslot_prot() Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 26/47] KVM: arm64: Do not use the hva in kvm_handle_guest_abort() Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 27/47] KVM: arm64: Introduce hyp_rwlock_t Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 28/47] KVM: arm64: Add atomics-based checking refcount implementation at EL2 Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 29/47] KVM: arm64: Use atomic refcount helpers for 'struct hyp_page::refcount' Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 30/47] KVM: arm64: Remove locking from EL2 allocation fast-paths Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 31/47] KVM: arm64: Reformat/beautify PTP hypercall documentation Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 32/47] KVM: arm64: Rename firmware pseudo-register documentation file Fuad Tabba
2024-04-16  9:56 ` Fuad Tabba [this message]
2024-04-16  9:56 ` [PATCH v2 34/47] KVM: arm64: Prevent kmemleak from accessing .hyp.data Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 35/47] KVM: arm64: Do not set the virtual timer offset for protected vCPUs Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 36/47] KVM: arm64: Check directly whether a vcpu is protected Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 37/47] KVM: arm64: Trap debug break and watch from guest Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 38/47] KVM: arm64: Restrict protected VM capabilities Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 39/47] KVM: arm64: Do not support MTE for protected VMs Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 40/47] KVM: arm64: Move pkvm_vcpu_init_traps() to hyp vcpu init Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 41/47] KVM: arm64: Fix initializing traps in protected mode Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 42/47] KVM: arm64: Advertise GICv3 sysreg interface to protected guests Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 43/47] KVM: arm64: Force injection of a data abort on NISV MMIO exit Fuad Tabba
2024-04-16  9:56 ` [PATCH v2 44/47] KVM: arm64: Remove unused vcpu parameter from guest_owns_fp_regs() Fuad Tabba
2024-04-16 10:49   ` Mark Brown
2024-04-16  9:56 ` [PATCH v2 45/47] KVM: arm64: Move guest_owns_fp_regs() to enable use in KVM code Fuad Tabba
2024-04-16 10:50   ` Mark Brown
2024-04-16  9:56 ` [PATCH v2 46/47] KVM: arm64: Add host_owns_fp_regs() Fuad Tabba
2024-04-16 10:51   ` Mark Brown
2024-04-16  9:56 ` [PATCH v2 47/47] KVM: arm64: Refactor checks for FP state ownership Fuad Tabba
2024-04-16 10:55   ` Mark Brown
2024-04-16 13:33     ` Marc Zyngier

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=20240416095638.3620345-34-tabba@google.com \
    --to=tabba@google.com \
    --cc=alexandru.elisei@arm.com \
    --cc=broonie@kernel.org \
    --cc=catalin.marinas@arm.com \
    --cc=james.morse@arm.com \
    --cc=joey.gouly@arm.com \
    --cc=kvmarm@lists.linux.dev \
    --cc=mark.rutland@arm.com \
    --cc=maz@kernel.org \
    --cc=oliver.upton@linux.dev \
    --cc=philmd@linaro.org \
    --cc=qperret@google.com \
    --cc=rananta@google.com \
    --cc=seanjc@google.com \
    --cc=smostafa@google.com \
    --cc=suzuki.poulose@arm.com \
    --cc=will@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.