Skip to contentSkip to conversation

powerpc: Fix kernel-doc comments in fsl_gtm.c

PATCH Applied Yang Li 3 participants 5 messages Apr 8, 2024 – May 8, 2024

Subsystems (2)
lore
Share & tools
lore
author
#1 lore raw

PATCH v2 3/3 powerpc/rtas: Add kernel-doc comments to smp_startup_cpu()

In reply to Yang Li

This commit adds kernel-doc style comments with complete parameter descriptions for the function smp_startup_cpu().

---
 arch/powerpc/platforms/cell/smp.c | 1 +
 1 file changed, 1 insertion(+)
arch/powerpc/platforms/cell/smp.c +1 -0
index 30394c6f8894..fee638fd8970 100644
@@ -54,6 +54,7 @@ static cpumask_t of_spin_map;
 
 /**
  * smp_startup_cpu() - start the given cpu
+ * @lcpu: Logical CPU ID of the CPU to be started.
  *
  * At boot time, there is nothing to do for primary threads which were
  * started from Open Firmware.  For anything else, call RTAS with the
Signature · 1 line
2.20.1.7.g153144c

Yang Li

author
#0 lore raw

PATCH v2 2/3 powerpc: Fix kernel-doc comments in fsl_gtm.c

Fix some function names in kernel-doc comments.

---
 arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
arch/powerpc/sysdev/fsl_gtm.c +3 -3
index 39186ad6b3c3..3dabc9621810 100644
@@ -77,7 +77,7 @@ struct gtm {
 static LIST_HEAD(gtms);
 
 /**
- * gtm_get_timer - request GTM timer to use it with the rest of GTM API
+ * gtm_get_timer16 - request GTM timer to use it with the rest of GTM API
  * Context:	non-IRQ
  *
  * This function reserves GTM timer for later use. It returns gtm_timer
@@ -110,7 +110,7 @@ struct gtm_timer *gtm_get_timer16(void)
 EXPORT_SYMBOL(gtm_get_timer16);
 
 /**
- * gtm_get_specific_timer - request specific GTM timer
+ * gtm_get_specific_timer16 - request specific GTM timer
  * @gtm:	specific GTM, pass here GTM's device_node->data
  * @timer:	specific timer number, Timer1 is 0.
  * Context:	non-IRQ
@@ -260,7 +260,7 @@ int gtm_set_timer16(struct gtm_timer *tmr, unsigned long usec, bool reload)
 EXPORT_SYMBOL(gtm_set_timer16);
 
 /**
- * gtm_set_exact_utimer16 - (re)set 16 bits timer
+ * gtm_set_exact_timer16 - (re)set 16 bits timer
  * @tmr:	pointer to the gtm_timer structure obtained from gtm_get_timer
  * @usec:	timer interval in microseconds
  * @reload:	if set, the timer will reset upon expiry rather than
Signature · 1 line
2.20.1.7.g153144c
Reviewed-by on v2 2/3
#3 lore raw
Quoted 3 lines · Yang Li

Fix some function names in kernel-doc comments.

Thanks.

Quoted 35 lines
---
 arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
arch/powerpc/sysdev/fsl_gtm.c +3 -3
index 39186ad6b3c3..3dabc9621810 100644
@@ -77,7 +77,7 @@ struct gtm {
 static LIST_HEAD(gtms);
 
 /**
- * gtm_get_timer - request GTM timer to use it with the rest of GTM API
+ * gtm_get_timer16 - request GTM timer to use it with the rest of GTM API
  * Context:	non-IRQ
  *
  * This function reserves GTM timer for later use. It returns gtm_timer
@@ -110,7 +110,7 @@ struct gtm_timer *gtm_get_timer16(void)
 EXPORT_SYMBOL(gtm_get_timer16);
 
 /**
- * gtm_get_specific_timer - request specific GTM timer
+ * gtm_get_specific_timer16 - request specific GTM timer
  * @gtm:	specific GTM, pass here GTM's device_node->data
  * @timer:	specific timer number, Timer1 is 0.
  * Context:	non-IRQ
@@ -260,7 +260,7 @@ int gtm_set_timer16(struct gtm_timer *tmr, unsigned long usec, bool reload)
 EXPORT_SYMBOL(gtm_set_timer16);
 
 /**
- * gtm_set_exact_utimer16 - (re)set 16 bits timer
+ * gtm_set_exact_timer16 - (re)set 16 bits timer
  * @tmr:	pointer to the gtm_timer structure obtained from gtm_get_timer
  * @usec:	timer interval in microseconds
  * @reload:	if set, the timer will reset upon expiry rather than
Signature · 1 line
#Randy
Acked-by on v2 3/3
#2 lore raw

Re: [PATCH -next 3/3 v2] powerpc/rtas: Add kernel-doc comments to smp_startup_cpu()

In reply to Yang Li
Quoted 4 lines · Yang Li

This commit adds kernel-doc style comments with complete parameter descriptions for the function smp_startup_cpu().

Thanks.

Quoted 16 lines
---
 arch/powerpc/platforms/cell/smp.c | 1 +
 1 file changed, 1 insertion(+)
arch/powerpc/platforms/cell/smp.c +1 -0
index 30394c6f8894..fee638fd8970 100644
@@ -54,6 +54,7 @@ static cpumask_t of_spin_map;
 
 /**
  * smp_startup_cpu() - start the given cpu
+ * @lcpu: Logical CPU ID of the CPU to be started.
  *
  * At boot time, there is nothing to do for primary threads which were
  * started from Open Firmware.  For anything else, call RTAS with the
Signature · 1 line
#Randy