Fix a bunch of kernel-doc warnings in arch/arm64/kvm/.
[PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
[PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
[PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
[PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
[PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
[PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
[PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
[PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
[PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
[PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
Cc: Marc Zyngier <[email protected]>
Cc: Oliver Upton <[email protected]>
Cc: James Morse <[email protected]>
Cc: Suzuki K Poulose <[email protected]>
Cc: Zenghui Yu <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
Fix multiple function parameter descriptions to prevent warnings:
guest.c:718: warning: Function parameter or struct member 'vcpu' not described in 'kvm_arm_num_regs'
guest.c:736: warning: Function parameter or struct member 'vcpu' not described in 'kvm_arm_copy_reg_indices'
guest.c:736: warning: Function parameter or struct member 'uindices' not described in 'kvm_arm_copy_reg_indices'
arch/arm64/kvm/guest.c:915: warning: Excess function parameter 'kvm' description in 'kvm_arch_vcpu_ioctl_set_guest_debug'
arch/arm64/kvm/guest.c:915: warning: Excess function parameter 'kvm_guest_debug' description in 'kvm_arch_vcpu_ioctl_set_guest_debug'
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Marc Zyngier <[email protected]>
Cc: Oliver Upton <[email protected]>
Cc: James Morse <[email protected]>
Cc: Suzuki K Poulose <[email protected]>
Cc: Zenghui Yu <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
---
arch/arm64/kvm/guest.c | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/guest.c b/arch/arm64/kvm/guest.c
--- a/arch/arm64/kvm/guest.c
+++ b/arch/arm64/kvm/guest.c
@@ -711,6 +711,7 @@ static int copy_sve_reg_indices(const st
/**
* kvm_arm_num_regs - how many registers do we present via KVM_GET_ONE_REG
+ * @vcpu: the vCPU pointer
*
* This is for all registers.
*/
@@ -729,6 +730,8 @@ unsigned long kvm_arm_num_regs(struct kv
/**
* kvm_arm_copy_reg_indices - get indices of all registers.
+ * @vcpu: the vCPU pointer
+ * @uindices: register list to copy
*
* We do core registers right here, then we append system regs.
*/
@@ -902,8 +905,8 @@ int kvm_arch_vcpu_ioctl_translate(struct
/**
* kvm_arch_vcpu_ioctl_set_guest_debug - set up guest debugging
- * @kvm: pointer to the KVM struct
- * @kvm_guest_debug: the ioctl data buffer
+ * @vcpu: the vCPU pointer
+ * @dbg: the ioctl data buffer
*
* This sets up and enables the VM for guest debugging. Userspace
* passes in a control flag to enable different debug types and
Change 2 uses of "/**" on non-kernel-doc comments to common "/*"
comments to prevent kernel-doc warnings:
arch/arm64/kvm/pmu-emul.c:423: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* When perf interrupt is an NMI, we cannot safely notify the vcpu corresponding
arch/arm64/kvm/pmu-emul.c:494: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* When the perf event overflows, set the overflow status and inform the vcpu.
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Marc Zyngier <[email protected]>
Cc: Oliver Upton <[email protected]>
Cc: James Morse <[email protected]>
Cc: Suzuki K Poulose <[email protected]>
Cc: Zenghui Yu <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
---
arch/arm64/kvm/pmu-emul.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/pmu-emul.c b/arch/arm64/kvm/pmu-emul.c
--- a/arch/arm64/kvm/pmu-emul.c
+++ b/arch/arm64/kvm/pmu-emul.c
@@ -419,7 +419,7 @@ void kvm_pmu_sync_hwstate(struct kvm_vcp
kvm_pmu_update_state(vcpu);
}
-/**
+/*
* When perf interrupt is an NMI, we cannot safely notify the vcpu corresponding
* to the event.
* This is why we need a callback to do it once outside of the NMI context.
@@ -490,7 +490,7 @@ static u64 compute_period(struct kvm_pmc
return val;
}
-/**
+/*
* When the perf event overflows, set the overflow status and inform the vcpu.
*/
static void kvm_pmu_perf_overflow(struct perf_event *perf_event,
Use the correct function name in the kernel-doc comments to prevent
kernel-doc warnings:
arch/arm64/kvm/hyp/vhe/../aarch32.c:97: warning: expecting prototype for adjust_itstate(). Prototype was for kvm_adjust_itstate() instead
arch/arm64/kvm/hyp/vhe/../aarch32.c:127: warning: expecting prototype for kvm_skip_instr(). Prototype was for kvm_skip_instr32() instead
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Marc Zyngier <[email protected]>
Cc: Oliver Upton <[email protected]>
Cc: James Morse <[email protected]>
Cc: Suzuki K Poulose <[email protected]>
Cc: Zenghui Yu <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
---
arch/arm64/kvm/hyp/aarch32.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/hyp/aarch32.c b/arch/arm64/kvm/hyp/aarch32.c
--- a/arch/arm64/kvm/hyp/aarch32.c
+++ b/arch/arm64/kvm/hyp/aarch32.c
@@ -84,7 +84,7 @@ bool kvm_condition_valid32(const struct
}
/**
- * adjust_itstate - adjust ITSTATE when emulating instructions in IT-block
+ * kvm_adjust_itstate - adjust ITSTATE when emulating instructions in IT-block
* @vcpu: The VCPU pointer
*
* When exceptions occur while instructions are executed in Thumb IF-THEN
@@ -120,7 +120,7 @@ static void kvm_adjust_itstate(struct kv
}
/**
- * kvm_skip_instr - skip a trapped instruction and proceed to the next
+ * kvm_skip_instr32 - skip a trapped instruction and proceed to the next
* @vcpu: The vcpu pointer
*/
void kvm_skip_instr32(struct kvm_vcpu *vcpu)
Drop the @run function parameter descriptions and add the actual ones
for 2 functions to prevent kernel-doc warnings:
arch/arm64/kvm/sys_regs.c:3167: warning: Excess function parameter 'run' description in 'kvm_handle_cp_64'
arch/arm64/kvm/sys_regs.c:3335: warning: Excess function parameter 'run' description in 'kvm_handle_cp_32'
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Marc Zyngier <[email protected]>
Cc: Oliver Upton <[email protected]>
Cc: James Morse <[email protected]>
Cc: Suzuki K Poulose <[email protected]>
Cc: Zenghui Yu <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
---
arch/arm64/kvm/sys_regs.c | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/sys_regs.c b/arch/arm64/kvm/sys_regs.c
--- a/arch/arm64/kvm/sys_regs.c
+++ b/arch/arm64/kvm/sys_regs.c
@@ -3159,7 +3159,8 @@ static void unhandled_cp_access(struct k
/**
* kvm_handle_cp_64 -- handles a mrrc/mcrr trap on a guest CP14/CP15 access
* @vcpu: The VCPU pointer
- * @run: The kvm_run struct
+ * @global: &struct sys_reg_desc
+ * @nr_global: size of the @global array
*/
static int kvm_handle_cp_64(struct kvm_vcpu *vcpu,
const struct sys_reg_desc *global,
@@ -3326,7 +3327,9 @@ static int kvm_emulate_cp15_id_reg(struc
/**
* kvm_handle_cp_32 -- handles a mrc/mcr trap on a guest CP14/CP15 access
* @vcpu: The VCPU pointer
- * @run: The kvm_run struct
+ * @params: &struct sys_reg_params
+ * @global: &struct sys_reg_desc
+ * @nr_global: size of the @global array
*/
static int kvm_handle_cp_32(struct kvm_vcpu *vcpu,
struct sys_reg_params *params,
Hi,
Any comments on this series?
Thanks.
On 1/17/24 15:07, Randy Dunlap wrote:
> Fix a bunch of kernel-doc warnings in arch/arm64/kvm/.
>
> [PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
> [PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
> [PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
> [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
> [PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
> [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
> [PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
> [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
> [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
> [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
>
> Cc: Marc Zyngier <[email protected]>
> Cc: Oliver Upton <[email protected]>
> Cc: James Morse <[email protected]>
> Cc: Suzuki K Poulose <[email protected]>
> Cc: Zenghui Yu <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Catalin Marinas <[email protected]>
> Cc: Will Deacon <[email protected]>
>
--
#Randy
On 17/01/2024 23:07, Randy Dunlap wrote:
> Fix a bunch of kernel-doc warnings in arch/arm64/kvm/.
>
> [PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
> [PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
> [PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
> [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
> [PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
> [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
> [PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
> [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
> [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
> [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
>
> Cc: Marc Zyngier <[email protected]>
> Cc: Oliver Upton <[email protected]>
> Cc: James Morse <[email protected]>
> Cc: Suzuki K Poulose <[email protected]>
> Cc: Zenghui Yu <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Catalin Marinas <[email protected]>
> Cc: Will Deacon <[email protected]>
For the series:
Reviewed-by: Suzuki K Poulose <[email protected]>
On Thu, 01 Feb 2024 06:19:14 +0000,
Randy Dunlap <[email protected]> wrote:
>
> Hi,
>
> Any comments on this series?
This is currently earmarked for 6.9.
Thanks,
M.
--
Without deviation from the norm, progress is not possible.
On 2024/1/18 7:07, Randy Dunlap wrote:
> Fix a bunch of kernel-doc warnings in arch/arm64/kvm/.
>
> [PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
> [PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
> [PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
> [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
> [PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
> [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
> [PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
> [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
> [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
> [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
All look good to me,
Reviewed-by: Zenghui Yu <[email protected]>
Thanks!
On Thu, Feb 01, 2024 at 01:45:04PM +0000, Marc Zyngier wrote:
> On Thu, 01 Feb 2024 06:19:14 +0000,
> Randy Dunlap <[email protected]> wrote:
> >
> > Hi,
> >
> > Any comments on this series?
>
> This is currently earmarked for 6.9.
Yup, I'm going to start applying some stuff soon and I'll grab this.
--
Thanks,
Oliver
On Wed, 17 Jan 2024 15:07:04 -0800, Randy Dunlap wrote:
> Fix a bunch of kernel-doc warnings in arch/arm64/kvm/.
>
> [PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
> [PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
> [PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
> [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
> [PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
> [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
> [PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
> [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
> [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
> [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
>
> [...]
Applied to kvmarm/next, thanks!
[01/10] KVM: arm64: debug: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/c4d15f841570
[02/10] KVM: arm64: guest: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/39db66e6b404
[03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/bc13610b4240
[04/10] KVM: arm64: vhe: fix a kernel-doc warning
https://git.kernel.org/kvmarm/kvmarm/c/aa96af24f320
[05/10] KVM: arm64: mmu: fix a kernel-doc warning
https://git.kernel.org/kvmarm/kvmarm/c/ffd9eaffa34d
[06/10] KVM: arm64: PMU: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/2a00f0855530
[07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/8ce783927268
[08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
https://git.kernel.org/kvmarm/kvmarm/c/dd609a574a02
[09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
https://git.kernel.org/kvmarm/kvmarm/c/f779d2c0176c
[10/10] KVM: arm64: vgic: fix a kernel-doc warning
https://git.kernel.org/kvmarm/kvmarm/c/e634ff9598a4
--
Best,
Oliver