target/arm/kvm: trivial: Clean up header documentation (d1ebbc9d) · Commits · SUMMER2020 / students / proj-2021291

target/arm/kvm_arm.h

+27 −19

Original line number	Diff line number	Diff line
		@@ -28,9 +28,9 @@
		int kvm_arm_vcpu_init(CPUState *cs);

		/**
		* kvm_arm_vcpu_finalize
		* kvm_arm_vcpu_finalize:
		* @cs: CPUState
		* @feature: int
		* @feature: feature to finalize
		*
		* Finalizes the configuration of the specified VCPU feature by
		* invoking the KVM_ARM_VCPU_FINALIZE ioctl. Features requiring
		@@ -75,8 +75,8 @@ void kvm_arm_register_device(MemoryRegion *mr, uint64_t devid, uint64_t group,
		int kvm_arm_init_cpreg_list(ARMCPU *cpu);

		/**
		* kvm_arm_reg_syncs_via_cpreg_list
		* regidx: KVM register index
		* kvm_arm_reg_syncs_via_cpreg_list:
		* @regidx: KVM register index
		*
		* Return true if this KVM register should be synchronized via the
		* cpreg list of arbitrary system registers, false if it is synchronized
		@@ -85,8 +85,8 @@ int kvm_arm_init_cpreg_list(ARMCPU *cpu);
		bool kvm_arm_reg_syncs_via_cpreg_list(uint64_t regidx);

		/**
		* kvm_arm_cpreg_level
		* regidx: KVM register index
		* kvm_arm_cpreg_level:
		* @regidx: KVM register index
		*
		* Return the level of this coprocessor/system register. Return value is
		* either KVM_PUT_RUNTIME_STATE, KVM_PUT_RESET_STATE, or KVM_PUT_FULL_STATE.
		@@ -148,6 +148,8 @@ void kvm_arm_init_serror_injection(CPUState *cs);
		* @cpu: ARMCPU
		*
		* Get VCPU related state from kvm.
		*
		* Returns: 0 if success else < 0 error code
		*/
		int kvm_get_vcpu_events(ARMCPU *cpu);

		@@ -156,6 +158,8 @@ int kvm_get_vcpu_events(ARMCPU *cpu);
		* @cpu: ARMCPU
		*
		* Put VCPU related state to kvm.
		*
		* Returns: 0 if success else < 0 error code
		*/
		int kvm_put_vcpu_events(ARMCPU *cpu);

		@@ -205,10 +209,12 @@ typedef struct ARMHostCPUFeatures {

		/**
		* kvm_arm_get_host_cpu_features:
		* @ahcc: ARMHostCPUClass to fill in
		* @ahcf: ARMHostCPUClass to fill in
		*
		* Probe the capabilities of the host kernel's preferred CPU and fill
		* in the ARMHostCPUClass struct accordingly.
		*
		* Returns true on success and false otherwise.
		*/
		bool kvm_arm_get_host_cpu_features(ARMHostCPUFeatures *ahcf);

		@@ -242,7 +248,7 @@ void kvm_arm_set_cpu_features_from_host(ARMCPU *cpu);
		bool kvm_arm_aarch32_supported(CPUState *cs);

		/**
		* bool kvm_arm_pmu_supported:
		* kvm_arm_pmu_supported:
		* @cs: CPUState
		*
		* Returns: true if the KVM VCPU can enable its PMU
		@@ -251,7 +257,7 @@ bool kvm_arm_aarch32_supported(CPUState *cs);
		bool kvm_arm_pmu_supported(CPUState *cs);

		/**
		* bool kvm_arm_sve_supported:
		* kvm_arm_sve_supported:
		* @cs: CPUState
		*
		* Returns true if the KVM VCPU can enable SVE and false otherwise.
		@@ -259,26 +265,30 @@ bool kvm_arm_pmu_supported(CPUState *cs);
		bool kvm_arm_sve_supported(CPUState *cs);

		/**
		* kvm_arm_get_max_vm_ipa_size - Returns the number of bits in the
		* IPA address space supported by KVM
		*
		* kvm_arm_get_max_vm_ipa_size:
		* @ms: Machine state handle
		*
		* Returns the number of bits in the IPA address space supported by KVM
		*/
		int kvm_arm_get_max_vm_ipa_size(MachineState *ms);

		/**
		* kvm_arm_sync_mpstate_to_kvm
		* kvm_arm_sync_mpstate_to_kvm:
		* @cpu: ARMCPU
		*
		* If supported set the KVM MP_STATE based on QEMU's model.
		*
		* Returns 0 on success and -1 on failure.
		*/
		int kvm_arm_sync_mpstate_to_kvm(ARMCPU *cpu);

		/**
		* kvm_arm_sync_mpstate_to_qemu
		* kvm_arm_sync_mpstate_to_qemu:
		* @cpu: ARMCPU
		*
		* If supported get the MP_STATE from KVM and store in QEMU's model.
		*
		* Returns 0 on success and aborts on failure.
		*/
		int kvm_arm_sync_mpstate_to_qemu(ARMCPU *cpu);

		@@ -292,7 +302,8 @@ int kvm_arm_set_irq(int cpu, int irqtype, int irq, int level);

		static inline void kvm_arm_set_cpu_features_from_host(ARMCPU *cpu)
		{
		/* This should never actually be called in the "not KVM" case,
		/*
		* This should never actually be called in the "not KVM" case,
		* but set up the fields to indicate an error anyway.
		*/
		cpu->kvm_target = QEMU_KVM_ARM_TARGET_NONE;
		@@ -377,23 +388,20 @@ bool kvm_arm_handle_debug(CPUState cs, struct kvm_debug_exit_arch debug_exit);
		*
		* Return: TRUE if any hardware breakpoints in use.
		*/

		bool kvm_arm_hw_debug_active(CPUState *cs);

		/**
		* kvm_arm_copy_hw_debug_data:
		*
		* @ptr: kvm_guest_debug_arch structure
		*
		* Copy the architecture specific debug registers into the
		* kvm_guest_debug ioctl structure.
		*/
		struct kvm_guest_debug_arch;

		void kvm_arm_copy_hw_debug_data(struct kvm_guest_debug_arch *ptr);

		/**
		* its_class_name
		* its_class_name:
		*
		* Return the ITS class name to use depending on whether KVM acceleration
		* and KVM CAP_SIGNAL_MSI are supported