* [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
@ 2024-01-17 23:07 Randy Dunlap
2024-01-17 23:07 ` [PATCH 01/10] KVM: arm64: debug: fix " Randy Dunlap
` (13 more replies)
0 siblings, 14 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
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 <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 01/10] KVM: arm64: debug: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 02/10] KVM: arm64: guest: " Randy Dunlap
` (12 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Change one "/**" comment to a common "/*" comment since the comment
is not in kernel-doc format.
Add description for the @vcpu function parameter.
These changes prevent warnings:
debug.c:27: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* save/restore_guest_debug_regs
debug.c:27: warning: missing initial short description on line:
* save/restore_guest_debug_regs
debug.c:149: warning: Function parameter or struct member 'vcpu' not described in 'kvm_arm_reset_debug_ptr'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/debug.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff -- a/arch/arm64/kvm/debug.c b/arch/arm64/kvm/debug.c
--- a/arch/arm64/kvm/debug.c
+++ b/arch/arm64/kvm/debug.c
@@ -23,7 +23,7 @@
static DEFINE_PER_CPU(u64, mdcr_el2);
-/**
+/*
* save/restore_guest_debug_regs
*
* For some debug operations we need to tweak some guest registers. As
@@ -143,6 +143,7 @@ void kvm_arm_vcpu_init_debug(struct kvm_
/**
* kvm_arm_reset_debug_ptr - reset the debug ptr to point to the vcpu state
+ * @vcpu: the vcpu pointer
*/
void kvm_arm_reset_debug_ptr(struct kvm_vcpu *vcpu)
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 02/10] KVM: arm64: guest: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 01/10] KVM: arm64: debug: fix " Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 03/10] KVM: arm64: hyp/aarch32: " Randy Dunlap
` (11 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
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 <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
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
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 03/10] KVM: arm64: hyp/aarch32: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 01/10] KVM: arm64: debug: fix " Randy Dunlap
2024-01-17 23:07 ` [PATCH 02/10] KVM: arm64: guest: " Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning Randy Dunlap
` (10 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
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 <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
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)
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (2 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 03/10] KVM: arm64: hyp/aarch32: " Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 05/10] KVM: arm64: mmu: " Randy Dunlap
` (9 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Use the correct function name in the kernel-doc comment to prevent
a warning:
arch/arm64/kvm/hyp/vhe/sysreg-sr.c:109: warning: expecting prototype for __vcpu_put_switch_syregs(). Prototype was for __vcpu_put_switch_sysregs() instead
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/hyp/vhe/sysreg-sr.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff -- a/arch/arm64/kvm/hyp/vhe/sysreg-sr.c b/arch/arm64/kvm/hyp/vhe/sysreg-sr.c
--- a/arch/arm64/kvm/hyp/vhe/sysreg-sr.c
+++ b/arch/arm64/kvm/hyp/vhe/sysreg-sr.c
@@ -95,7 +95,7 @@ void __vcpu_load_switch_sysregs(struct k
}
/**
- * __vcpu_put_switch_syregs - Restore host system registers to the physical CPU
+ * __vcpu_put_switch_sysregs - Restore host system registers to the physical CPU
*
* @vcpu: The VCPU pointer
*
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 05/10] KVM: arm64: mmu: fix a kernel-doc warning
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (3 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings Randy Dunlap
` (8 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Use the correct function name in a kernel-doc comment to prevent
a warning:
arch/arm64/kvm/mmu.c:321: warning: expecting prototype for unmap_stage2_range(). Prototype was for __unmap_stage2_range() instead
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/mmu.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff -- a/arch/arm64/kvm/mmu.c b/arch/arm64/kvm/mmu.c
--- a/arch/arm64/kvm/mmu.c
+++ b/arch/arm64/kvm/mmu.c
@@ -305,7 +305,7 @@ static void invalidate_icache_guest_page
* does.
*/
/**
- * unmap_stage2_range -- Clear stage2 page table entries to unmap a range
+ * __unmap_stage2_range -- Clear stage2 page table entries to unmap a range
* @mmu: The KVM stage-2 MMU pointer
* @start: The intermediate physical base address of the range to unmap
* @size: The size of the area to unmap
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (4 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 05/10] KVM: arm64: mmu: " Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 07/10] KVM: arm64: sys_regs: " Randy Dunlap
` (7 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
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 <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
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,
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 07/10] KVM: arm64: sys_regs: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (5 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning Randy Dunlap
` (6 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
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 <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
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,
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (6 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 07/10] KVM: arm64: sys_regs: " Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings Randy Dunlap
` (5 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Change the function comment block to kernel-doc format to prevent
a kernel-doc warning:
arch/arm64/kvm/vgic/vgic-init.c:448: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Map the MMIO regions depending on the VGIC model exposed to the guest
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/vgic/vgic-init.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff -- a/arch/arm64/kvm/vgic/vgic-init.c b/arch/arm64/kvm/vgic/vgic-init.c
--- a/arch/arm64/kvm/vgic/vgic-init.c
+++ b/arch/arm64/kvm/vgic/vgic-init.c
@@ -445,13 +445,15 @@ int vgic_lazy_init(struct kvm *kvm)
/* RESOURCE MAPPING */
/**
+ * kvm_vgic_map_resources - map the MMIO regions
+ * @kvm: kvm struct pointer
+ *
* Map the MMIO regions depending on the VGIC model exposed to the guest
* called on the first VCPU run.
* Also map the virtual CPU interface into the VM.
* v2 calls vgic_init() if not already done.
* v3 and derivatives return an error if the VGIC is not initialized.
* vgic_ready() returns true if this function has succeeded.
- * @kvm: kvm struct pointer
*/
int kvm_vgic_map_resources(struct kvm *kvm)
{
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (7 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-01-17 23:07 ` [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning Randy Dunlap
` (4 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Correct the function parameter name "@save tables" -> "@save_tables".
Use the "typedef" keyword in the kernel-doc comment for a typedef.
These changes prevent kernel-doc warnings:
vgic/vgic-its.c:174: warning: Function parameter or struct member 'save_tables' not described in 'vgic_its_abi'
arch/arm64/kvm/vgic/vgic-its.c:2152: warning: expecting prototype for entry_fn_t(). Prototype was for int() instead
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/vgic/vgic-its.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/vgic/vgic-its.c b/arch/arm64/kvm/vgic/vgic-its.c
--- a/arch/arm64/kvm/vgic/vgic-its.c
+++ b/arch/arm64/kvm/vgic/vgic-its.c
@@ -158,7 +158,7 @@ struct vgic_translation_cache_entry {
* @cte_esz: collection table entry size
* @dte_esz: device table entry size
* @ite_esz: interrupt translation table entry size
- * @save tables: save the ITS tables into guest RAM
+ * @save_tables: save the ITS tables into guest RAM
* @restore_tables: restore the ITS internal structs from tables
* stored in guest RAM
* @commit: initialize the registers which expose the ABI settings,
@@ -2139,7 +2139,7 @@ static u32 compute_next_eventid_offset(s
}
/**
- * entry_fn_t - Callback called on a table entry restore path
+ * typedef entry_fn_t - Callback called on a table entry restore path
* @its: its handle
* @id: id of the entry
* @entry: pointer to the entry
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (8 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings Randy Dunlap
@ 2024-01-17 23:07 ` Randy Dunlap
2024-02-01 6:19 ` [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (3 subsequent siblings)
13 siblings, 0 replies; 17+ messages in thread
From: Randy Dunlap @ 2024-01-17 23:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, Zenghui Yu, linux-arm-kernel, kvmarm,
Catalin Marinas, Will Deacon
Use the correct function name in a kernel-doc comment to prevent a
warning:
arch/arm64/kvm/vgic/vgic.c:217: warning: expecting prototype for kvm_vgic_target_oracle(). Prototype was for vgic_target_oracle() instead
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
---
arch/arm64/kvm/vgic/vgic.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff -- a/arch/arm64/kvm/vgic/vgic.c b/arch/arm64/kvm/vgic/vgic.c
--- a/arch/arm64/kvm/vgic/vgic.c
+++ b/arch/arm64/kvm/vgic/vgic.c
@@ -203,7 +203,7 @@ void vgic_irq_set_phys_active(struct vgi
}
/**
- * kvm_vgic_target_oracle - compute the target vcpu for an irq
+ * vgic_target_oracle - compute the target vcpu for an irq
*
* @irq: The irq to route. Must be already locked.
*
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (9 preceding siblings ...)
2024-01-17 23:07 ` [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning Randy Dunlap
@ 2024-02-01 6:19 ` Randy Dunlap
2024-02-01 13:45 ` Marc Zyngier
2024-02-01 10:23 ` Suzuki K Poulose
` (2 subsequent siblings)
13 siblings, 1 reply; 17+ messages in thread
From: Randy Dunlap @ 2024-02-01 6:19 UTC (permalink / raw)
To: linux-kernel
Cc: Marc Zyngier, Oliver Upton, James Morse, Suzuki K Poulose,
Zenghui Yu, linux-arm-kernel, kvmarm, Catalin Marinas,
Will Deacon
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 <maz@kernel.org>
> Cc: Oliver Upton <oliver.upton@linux.dev>
> Cc: James Morse <james.morse@arm.com>
> Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
> Cc: Zenghui Yu <yuzenghui@huawei.com>
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: kvmarm@lists.linux.dev
> Cc: Catalin Marinas <catalin.marinas@arm.com>
> Cc: Will Deacon <will@kernel.org>
>
--
#Randy
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (10 preceding siblings ...)
2024-02-01 6:19 ` [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
@ 2024-02-01 10:23 ` Suzuki K Poulose
2024-02-01 13:49 ` Zenghui Yu
2024-02-01 20:30 ` Oliver Upton
13 siblings, 0 replies; 17+ messages in thread
From: Suzuki K Poulose @ 2024-02-01 10:23 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Marc Zyngier, Oliver Upton, James Morse, Zenghui Yu,
linux-arm-kernel, kvmarm, Catalin Marinas, Will Deacon
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 <maz@kernel.org>
> Cc: Oliver Upton <oliver.upton@linux.dev>
> Cc: James Morse <james.morse@arm.com>
> Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
> Cc: Zenghui Yu <yuzenghui@huawei.com>
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: kvmarm@lists.linux.dev
> Cc: Catalin Marinas <catalin.marinas@arm.com>
> Cc: Will Deacon <will@kernel.org>
For the series:
Reviewed-by: Suzuki K Poulose <suzuki.poulose@arm.com>
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-02-01 6:19 ` [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
@ 2024-02-01 13:45 ` Marc Zyngier
2024-02-01 17:47 ` Oliver Upton
0 siblings, 1 reply; 17+ messages in thread
From: Marc Zyngier @ 2024-02-01 13:45 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Oliver Upton, James Morse, Suzuki K Poulose,
Zenghui Yu, linux-arm-kernel, kvmarm, Catalin Marinas,
Will Deacon
On Thu, 01 Feb 2024 06:19:14 +0000,
Randy Dunlap <rdunlap@infradead.org> 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.
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (11 preceding siblings ...)
2024-02-01 10:23 ` Suzuki K Poulose
@ 2024-02-01 13:49 ` Zenghui Yu
2024-02-01 20:30 ` Oliver Upton
13 siblings, 0 replies; 17+ messages in thread
From: Zenghui Yu @ 2024-02-01 13:49 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Marc Zyngier, Oliver Upton, James Morse,
Suzuki K Poulose, linux-arm-kernel, kvmarm, Catalin Marinas,
Will Deacon
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 <yuzenghui@huawei.com>
Thanks!
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-02-01 13:45 ` Marc Zyngier
@ 2024-02-01 17:47 ` Oliver Upton
0 siblings, 0 replies; 17+ messages in thread
From: Oliver Upton @ 2024-02-01 17:47 UTC (permalink / raw)
To: Marc Zyngier
Cc: Randy Dunlap, linux-kernel, James Morse, Suzuki K Poulose,
Zenghui Yu, linux-arm-kernel, kvmarm, Catalin Marinas,
Will Deacon
On Thu, Feb 01, 2024 at 01:45:04PM +0000, Marc Zyngier wrote:
> On Thu, 01 Feb 2024 06:19:14 +0000,
> Randy Dunlap <rdunlap@infradead.org> 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
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
` (12 preceding siblings ...)
2024-02-01 13:49 ` Zenghui Yu
@ 2024-02-01 20:30 ` Oliver Upton
13 siblings, 0 replies; 17+ messages in thread
From: Oliver Upton @ 2024-02-01 20:30 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Oliver Upton, Marc Zyngier, linux-arm-kernel, Will Deacon,
Suzuki K Poulose, James Morse, Zenghui Yu, kvmarm,
Catalin Marinas
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
^ permalink raw reply [flat|nested] 17+ messages in thread
end of thread, other threads:[~2024-02-01 20:31 UTC | newest]
Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 01/10] KVM: arm64: debug: fix " Randy Dunlap
2024-01-17 23:07 ` [PATCH 02/10] KVM: arm64: guest: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 03/10] KVM: arm64: hyp/aarch32: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning Randy Dunlap
2024-01-17 23:07 ` [PATCH 05/10] KVM: arm64: mmu: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 07/10] KVM: arm64: sys_regs: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning Randy Dunlap
2024-01-17 23:07 ` [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 10/10] KVM: arm64: vgic: fix a kernel-doc warning Randy Dunlap
2024-02-01 6:19 ` [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
2024-02-01 13:45 ` Marc Zyngier
2024-02-01 17:47 ` Oliver Upton
2024-02-01 10:23 ` Suzuki K Poulose
2024-02-01 13:49 ` Zenghui Yu
2024-02-01 20:30 ` Oliver Upton
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).