[PATCH v2 1/2] x86/cpuid: Fix CPUID(0x2) iterator kernel-doc

Ahmed S. Darwish posted 2 patches 7 months ago
[PATCH v2 1/2] x86/cpuid: Fix CPUID(0x2) iterator kernel-doc
Posted by Ahmed S. Darwish 7 months ago
The CPUID(0x2) cache/TLB descriptors iterator has been recently changed
from:

    for_each_leaf_0x2_entry(regs, __ptr, entry)

to:

    for_each_cpuid_0x2_desc(_regs, _ptr, _desc)

but the attached kernel-doc was not fully adapted.  Fix it.

Fixes: c4c9ea879c3b ("x86/cpuid: Rename cpuid_get_leaf_0x2_regs() to cpuid_leaf_0x2()")
Signed-off-by: Ahmed S. Darwish <darwi@linutronix.de>
---
 arch/x86/include/asm/cpuid/api.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/arch/x86/include/asm/cpuid/api.h b/arch/x86/include/asm/cpuid/api.h
index bf97f9770789..ccf20c62b89f 100644
--- a/arch/x86/include/asm/cpuid/api.h
+++ b/arch/x86/include/asm/cpuid/api.h
@@ -252,15 +252,15 @@ static inline void cpuid_leaf_0x2(union leaf_0x2_regs *regs)
 
 /**
  * for_each_cpuid_0x2_desc() - Iterator for parsed CPUID(0x2) descriptors
- * @regs:   CPUID(0x2) register output, as returned by cpuid_leaf_0x2()
- * @__ptr:  u8 pointer, for macro internal use only
- * @desc:   Pointer to parsed CPUID(0x2) descriptor at each iteration
+ * @_regs:	CPUID(0x2) register output, as returned by cpuid_leaf_0x2()
+ * @_ptr:	u8 pointer, for macro internal use only
+ * @_desc:	Pointer to the parsed CPUID(0x2) descriptor at each iteration
  *
  * Loop over the 1-byte descriptors in the passed CPUID(0x2) output registers
- * @regs.  Provide the parsed information for each descriptor through @desc.
+ * @_regs.  Provide the parsed information for each descriptor through @_desc.
  *
- * To handle cache-specific descriptors, switch on @entry->c_type.  For TLB
- * descriptors, switch on @entry->t_type.
+ * To handle cache-specific descriptors, switch on @_desc->c_type.  For TLB
+ * descriptors, switch on @_desc->t_type.
  *
  * Example usage for cache descriptors::
  *
-- 
2.49.0
Re: [PATCH v2 1/2] x86/cpuid: Fix CPUID(0x2) iterator kernel-doc
Posted by Ingo Molnar 7 months ago
* Ahmed S. Darwish <darwi@linutronix.de> wrote:

> The CPUID(0x2) cache/TLB descriptors iterator has been recently changed
> from:
> 
>     for_each_leaf_0x2_entry(regs, __ptr, entry)
> 
> to:
> 
>     for_each_cpuid_0x2_desc(_regs, _ptr, _desc)
> 
> but the attached kernel-doc was not fully adapted.  Fix it.
> 
> Fixes: c4c9ea879c3b ("x86/cpuid: Rename cpuid_get_leaf_0x2_regs() to cpuid_leaf_0x2()")
> Signed-off-by: Ahmed S. Darwish <darwi@linutronix.de>

I've folded this fix back into the originator commit.

Thanks,

	Ingo