[PATCH] KVM: arm64: Fix kvm_get_vtcr() kernel-doc

[PATCH] KVM: arm64: Fix kvm_get_vtcr() kernel-doc

[Karl Mehltretter]

kvm_get_vtcr() takes a parameter named phys_shift, but its kernel-doc
describes phys_shfit. This leaves the real parameter undescribed and
adds an excess parameter description to the generated documentation.

Correct the spelling.

Fixes: bcb25a2b86b4 ("KVM: arm64: Refactor kvm_arm_setup_stage2()")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 arch/arm64/include/asm/kvm_pgtable.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/include/asm/kvm_pgtable.h b/arch/arm64/include/asm/kvm_pgtable.h
index 41a8687938eb..c078cfedce19 100644
--- a/arch/arm64/include/asm/kvm_pgtable.h
+++ b/arch/arm64/include/asm/kvm_pgtable.h
@@ -532,7 +532,7 @@ u64 kvm_pgtable_hyp_unmap(struct kvm_pgtable *pgt, u64 addr, u64 size);
  * kvm_get_vtcr() - Helper to construct VTCR_EL2
  * @mmfr0:	Sanitized value of SYS_ID_AA64MMFR0_EL1 register.
  * @mmfr1:	Sanitized value of SYS_ID_AA64MMFR1_EL1 register.
- * @phys_shfit:	Value to set in VTCR_EL2.T0SZ.
+ * @phys_shift:	Value to set in VTCR_EL2.T0SZ.
  *
  * The VTCR value is common across all the physical CPUs on the system.
  * We use system wide sanitised values to fill in different fields,

base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
-- 
2.53.0

Re: [PATCH] KVM: arm64: Fix kvm_get_vtcr() kernel-doc

[Fuad Tabba]

Hi Karl,

...

Good catch, I'm a fan of documentation fixes :)

While you're on that line, the description is also inaccurate, so you
could fix both in one go and save a follow-up touching the same line:

> - * @phys_shfit:        Value to set in VTCR_EL2.T0SZ.
> + * @phys_shift:        Value to set in VTCR_EL2.T0SZ.

kvm_get_vtcr() sets T0SZ to 64 - phys_shift, so phys_shift isn't the
value written to the field, it's the IPA size in bits. Something like:

     * @phys_shift:    IPA size, in bits.

Cheers,
/fuad

>
> base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
> --
> 2.53.0

Re: [PATCH] KVM: arm64: Fix kvm_get_vtcr() kernel-doc

[Karl Mehltretter]

On Wed, Sep 09, 2026 at 08:36:40AM +0100, Fuad Tabba wrote:
> Hi Karl,
> While you're on that line, the description is also inaccurate, so you
> could fix both in one go and save a follow-up touching the same line:
> 
> > - * @phys_shfit:        Value to set in VTCR_EL2.T0SZ.
> > + * @phys_shift:        Value to set in VTCR_EL2.T0SZ.
> 
> kvm_get_vtcr() sets T0SZ to 64 - phys_shift, so phys_shift isn't the
> value written to the field, it's the IPA size in bits. Something like:
> 
>      * @phys_shift:    IPA size, in bits.
> 

Hi Fuad. 

well spotted. A typo seldom comes alone :)

I'll fix that.

Thanks,
Karl

[PATCH v2] KVM: arm64: Fix kvm_get_vtcr() kernel-doc

[Karl Mehltretter]

kvm_get_vtcr() takes a parameter named phys_shift, but its kernel-doc
describes phys_shfit. This leaves the real parameter undescribed and
adds an excess parameter description to the generated documentation.

Correct the spelling and describe phys_shift as the IPA size in bits.
The value written to VTCR_EL2.T0SZ is 64 - phys_shift, rather than
phys_shift itself.

Fixes: bcb25a2b86b4 ("KVM: arm64: Refactor kvm_arm_setup_stage2()")
Suggested-by: Fuad Tabba <fuad.tabba@linux.dev>
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
Changes in v2:
- Describe phys_shift as the IPA size in bits (Fuad).

 arch/arm64/include/asm/kvm_pgtable.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/include/asm/kvm_pgtable.h b/arch/arm64/include/asm/kvm_pgtable.h
index 41a8687938eb..20d12da3d28e 100644
--- a/arch/arm64/include/asm/kvm_pgtable.h
+++ b/arch/arm64/include/asm/kvm_pgtable.h
@@ -532,7 +532,7 @@ u64 kvm_pgtable_hyp_unmap(struct kvm_pgtable *pgt, u64 addr, u64 size);
  * kvm_get_vtcr() - Helper to construct VTCR_EL2
  * @mmfr0:	Sanitized value of SYS_ID_AA64MMFR0_EL1 register.
  * @mmfr1:	Sanitized value of SYS_ID_AA64MMFR1_EL1 register.
- * @phys_shfit:	Value to set in VTCR_EL2.T0SZ.
+ * @phys_shift:	IPA size, in bits.
  *
  * The VTCR value is common across all the physical CPUs on the system.
  * We use system wide sanitised values to fill in different fields,

base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
-- 
2.53.0