yeahuh / rpms / qemu-kvm

Forked from rpms/qemu-kvm 2 years ago
Clone

Blame SOURCES/kvm-target-arm-kvm-trivial-Clean-up-header-documentation.patch

902636
From 11cb9cb7b1b56d5c9723e9c50bc2903281893bcc Mon Sep 17 00:00:00 2001
902636
From: Andrew Jones <drjones@redhat.com>
902636
Date: Fri, 31 Jan 2020 14:23:10 +0000
902636
Subject: [PATCH 08/15] target/arm/kvm: trivial: Clean up header documentation
902636
MIME-Version: 1.0
902636
Content-Type: text/plain; charset=UTF-8
902636
Content-Transfer-Encoding: 8bit
902636
902636
RH-Author: Andrew Jones <drjones@redhat.com>
902636
Message-id: <20200131142314.13175-2-drjones@redhat.com>
902636
Patchwork-id: 93625
902636
O-Subject: [RHEL-AV-8.2.0 qemu-kvm PATCH 1/5] target/arm/kvm: trivial: Clean up header documentation
902636
Bugzilla: 1647366
902636
RH-Acked-by: Philippe Mathieu-Daudé <philmd@redhat.com>
902636
RH-Acked-by: Auger Eric <eric.auger@redhat.com>
902636
RH-Acked-by: Gavin Shan <gshan@redhat.com>
902636
902636
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1647366
902636
902636
Author: Andrew Jones <drjones@redhat.com>
902636
Date:   Thu, 30 Jan 2020 16:02:05 +0000
902636
902636
    target/arm/kvm: trivial: Clean up header documentation
902636
902636
    Signed-off-by: Andrew Jones <drjones@redhat.com>
902636
    Message-id: 20200120101023.16030-2-drjones@redhat.com
902636
    Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
902636
    Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
902636
902636
(cherry picked from commit d1ebbc9d16297b54b153ee33abe05eb4f1df0c66)
902636
Signed-off-by: Danilo C. L. de Paula <ddepaula@redhat.com>
902636
---
902636
 target/arm/kvm_arm.h | 46 +++++++++++++++++++++++++++-------------------
902636
 1 file changed, 27 insertions(+), 19 deletions(-)
902636
902636
diff --git a/target/arm/kvm_arm.h b/target/arm/kvm_arm.h
902636
index 8e14d40..b48a9c9 100644
902636
--- a/target/arm/kvm_arm.h
902636
+++ b/target/arm/kvm_arm.h
902636
@@ -28,9 +28,9 @@
902636
 int kvm_arm_vcpu_init(CPUState *cs);
902636
 
902636
 /**
902636
- * kvm_arm_vcpu_finalize
902636
+ * kvm_arm_vcpu_finalize:
902636
  * @cs: CPUState
902636
- * @feature: int
902636
+ * @feature: feature to finalize
902636
  *
902636
  * Finalizes the configuration of the specified VCPU feature by
902636
  * invoking the KVM_ARM_VCPU_FINALIZE ioctl. Features requiring
902636
@@ -75,8 +75,8 @@ void kvm_arm_register_device(MemoryRegion *mr, uint64_t devid, uint64_t group,
902636
 int kvm_arm_init_cpreg_list(ARMCPU *cpu);
902636
 
902636
 /**
902636
- * kvm_arm_reg_syncs_via_cpreg_list
902636
- * regidx: KVM register index
902636
+ * kvm_arm_reg_syncs_via_cpreg_list:
902636
+ * @regidx: KVM register index
902636
  *
902636
  * Return true if this KVM register should be synchronized via the
902636
  * cpreg list of arbitrary system registers, false if it is synchronized
902636
@@ -85,8 +85,8 @@ int kvm_arm_init_cpreg_list(ARMCPU *cpu);
902636
 bool kvm_arm_reg_syncs_via_cpreg_list(uint64_t regidx);
902636
 
902636
 /**
902636
- * kvm_arm_cpreg_level
902636
- * regidx: KVM register index
902636
+ * kvm_arm_cpreg_level:
902636
+ * @regidx: KVM register index
902636
  *
902636
  * Return the level of this coprocessor/system register.  Return value is
902636
  * either KVM_PUT_RUNTIME_STATE, KVM_PUT_RESET_STATE, or KVM_PUT_FULL_STATE.
902636
@@ -148,6 +148,8 @@ void kvm_arm_init_serror_injection(CPUState *cs);
902636
  * @cpu: ARMCPU
902636
  *
902636
  * Get VCPU related state from kvm.
902636
+ *
902636
+ * Returns: 0 if success else < 0 error code
902636
  */
902636
 int kvm_get_vcpu_events(ARMCPU *cpu);
902636
 
902636
@@ -156,6 +158,8 @@ int kvm_get_vcpu_events(ARMCPU *cpu);
902636
  * @cpu: ARMCPU
902636
  *
902636
  * Put VCPU related state to kvm.
902636
+ *
902636
+ * Returns: 0 if success else < 0 error code
902636
  */
902636
 int kvm_put_vcpu_events(ARMCPU *cpu);
902636
 
902636
@@ -205,10 +209,12 @@ typedef struct ARMHostCPUFeatures {
902636
 
902636
 /**
902636
  * kvm_arm_get_host_cpu_features:
902636
- * @ahcc: ARMHostCPUClass to fill in
902636
+ * @ahcf: ARMHostCPUClass to fill in
902636
  *
902636
  * Probe the capabilities of the host kernel's preferred CPU and fill
902636
  * in the ARMHostCPUClass struct accordingly.
902636
+ *
902636
+ * Returns true on success and false otherwise.
902636
  */
902636
 bool kvm_arm_get_host_cpu_features(ARMHostCPUFeatures *ahcf);
902636
 
902636
@@ -242,7 +248,7 @@ void kvm_arm_set_cpu_features_from_host(ARMCPU *cpu);
902636
 bool kvm_arm_aarch32_supported(CPUState *cs);
902636
 
902636
 /**
902636
- * bool kvm_arm_pmu_supported:
902636
+ * kvm_arm_pmu_supported:
902636
  * @cs: CPUState
902636
  *
902636
  * Returns: true if the KVM VCPU can enable its PMU
902636
@@ -251,7 +257,7 @@ bool kvm_arm_aarch32_supported(CPUState *cs);
902636
 bool kvm_arm_pmu_supported(CPUState *cs);
902636
 
902636
 /**
902636
- * bool kvm_arm_sve_supported:
902636
+ * kvm_arm_sve_supported:
902636
  * @cs: CPUState
902636
  *
902636
  * Returns true if the KVM VCPU can enable SVE and false otherwise.
902636
@@ -259,26 +265,30 @@ bool kvm_arm_pmu_supported(CPUState *cs);
902636
 bool kvm_arm_sve_supported(CPUState *cs);
902636
 
902636
 /**
902636
- * kvm_arm_get_max_vm_ipa_size - Returns the number of bits in the
902636
- * IPA address space supported by KVM
902636
- *
902636
+ * kvm_arm_get_max_vm_ipa_size:
902636
  * @ms: Machine state handle
902636
+ *
902636
+ * Returns the number of bits in the IPA address space supported by KVM
902636
  */
902636
 int kvm_arm_get_max_vm_ipa_size(MachineState *ms);
902636
 
902636
 /**
902636
- * kvm_arm_sync_mpstate_to_kvm
902636
+ * kvm_arm_sync_mpstate_to_kvm:
902636
  * @cpu: ARMCPU
902636
  *
902636
  * If supported set the KVM MP_STATE based on QEMU's model.
902636
+ *
902636
+ * Returns 0 on success and -1 on failure.
902636
  */
902636
 int kvm_arm_sync_mpstate_to_kvm(ARMCPU *cpu);
902636
 
902636
 /**
902636
- * kvm_arm_sync_mpstate_to_qemu
902636
+ * kvm_arm_sync_mpstate_to_qemu:
902636
  * @cpu: ARMCPU
902636
  *
902636
  * If supported get the MP_STATE from KVM and store in QEMU's model.
902636
+ *
902636
+ * Returns 0 on success and aborts on failure.
902636
  */
902636
 int kvm_arm_sync_mpstate_to_qemu(ARMCPU *cpu);
902636
 
902636
@@ -292,7 +302,8 @@ int kvm_arm_set_irq(int cpu, int irqtype, int irq, int level);
902636
 
902636
 static inline void kvm_arm_set_cpu_features_from_host(ARMCPU *cpu)
902636
 {
902636
-    /* This should never actually be called in the "not KVM" case,
902636
+    /*
902636
+     * This should never actually be called in the "not KVM" case,
902636
      * but set up the fields to indicate an error anyway.
902636
      */
902636
     cpu->kvm_target = QEMU_KVM_ARM_TARGET_NONE;
902636
@@ -377,23 +388,20 @@ bool kvm_arm_handle_debug(CPUState *cs, struct kvm_debug_exit_arch *debug_exit);
902636
  *
902636
  * Return: TRUE if any hardware breakpoints in use.
902636
  */
902636
-
902636
 bool kvm_arm_hw_debug_active(CPUState *cs);
902636
 
902636
 /**
902636
  * kvm_arm_copy_hw_debug_data:
902636
- *
902636
  * @ptr: kvm_guest_debug_arch structure
902636
  *
902636
  * Copy the architecture specific debug registers into the
902636
  * kvm_guest_debug ioctl structure.
902636
  */
902636
 struct kvm_guest_debug_arch;
902636
-
902636
 void kvm_arm_copy_hw_debug_data(struct kvm_guest_debug_arch *ptr);
902636
 
902636
 /**
902636
- * its_class_name
902636
+ * its_class_name:
902636
  *
902636
  * Return the ITS class name to use depending on whether KVM acceleration
902636
  * and KVM CAP_SIGNAL_MSI are supported
902636
-- 
902636
1.8.3.1
902636