Commit 2161ba07 authored Jan 29, 2022 by Randy Dunlap Committed by Thomas Bogendoerfer Feb 01, 2022

MIPS: KVM: fix vz.c kernel-doc notation

Fix all kernel-doc warnings in mips/kvm/vz.c as reported by the
kernel test robot:

arch/mips/kvm/vz.c:471: warning: Function parameter or member 'out_compare' not described in '_kvm_vz_save_htimer'
arch/mips/kvm/vz.c:471: warning: Function parameter or member 'out_cause' not described in '_kvm_vz_save_htimer'
arch/mips/kvm/vz.c:471: warning: Excess function parameter 'compare' description in '_kvm_vz_save_htimer'
arch/mips/kvm/vz.c:471: warning: Excess function parameter 'cause' description in '_kvm_vz_save_htimer'
arch/mips/kvm/vz.c:1551: warning: No description found for return value of 'kvm_trap_vz_handle_cop_unusable'
arch/mips/kvm/vz.c:1552: warning: expecting prototype for kvm_trap_vz_handle_cop_unusuable(). Prototype was for kvm_trap_vz_handle_cop_unusable() instead
arch/mips/kvm/vz.c:1597: warning: No description found for return value of 'kvm_trap_vz_handle_msa_disabled'

Fixes: c992a4f6 ("KVM: MIPS: Implement VZ support")
Fixes: f4474d50 ("KVM: MIPS/VZ: Support hardware guest timer")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Cc: Huacai Chen <chenhuacai@kernel.org>
Cc: Aleksandar Markovic <aleksandar.qemu.devel@gmail.com>
Cc: James Hogan <jhogan@kernel.org>
Cc: kvm@vger.kernel.org
Signed-off-by: Thomas Bogendoerfer <tsbogend@alpha.franken.de>

parent 50317b63

arch/mips/kvm/vz.c

+9 −3

Original line number	Diff line number	Diff line
		@@ -458,8 +458,8 @@ void kvm_vz_acquire_htimer(struct kvm_vcpu *vcpu)
		/**
		* _kvm_vz_save_htimer() - Switch to software emulation of guest timer.
		* @vcpu: Virtual CPU.
		* @compare: Pointer to write compare value to.
		* @cause: Pointer to write cause value to.
		* @out_compare: Pointer to write compare value to.
		* @out_cause: Pointer to write cause value to.
		*
		* Save VZ guest timer state and switch to software emulation of guest CP0
		* timer. The hard timer must already be in use, so preemption should be
		@@ -1541,11 +1541,14 @@ static int kvm_trap_vz_handle_guest_exit(struct kvm_vcpu *vcpu)
		}

		/**
		* kvm_trap_vz_handle_cop_unusuable() - Guest used unusable coprocessor.
		* kvm_trap_vz_handle_cop_unusable() - Guest used unusable coprocessor.
		* @vcpu: Virtual CPU context.
		*
		* Handle when the guest attempts to use a coprocessor which hasn't been allowed
		* by the root context.
		*
		* Return: value indicating whether to resume the host or the guest
		* (RESUME_HOST or RESUME_GUEST)
		*/
		static int kvm_trap_vz_handle_cop_unusable(struct kvm_vcpu *vcpu)
		{
		@@ -1592,6 +1595,9 @@ static int kvm_trap_vz_handle_cop_unusable(struct kvm_vcpu *vcpu)
		*
		* Handle when the guest attempts to use MSA when it is disabled in the root
		* context.
		*
		* Return: value indicating whether to resume the host or the guest
		* (RESUME_HOST or RESUME_GUEST)
		*/
		static int kvm_trap_vz_handle_msa_disabled(struct kvm_vcpu *vcpu)
		{