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

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

[Yang Li]

Fix some function names in kernel-doc comments.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/arch/powerpc/sysdev/fsl_gtm.c b/arch/powerpc/sysdev/fsl_gtm.c
index 39186ad6b3c3..3dabc9621810 100644
--- a/arch/powerpc/sysdev/fsl_gtm.c
+++ b/arch/powerpc/sysdev/fsl_gtm.c
@@ -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
-- 
2.20.1.7.g153144c

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

[Yang Li]

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

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 arch/powerpc/platforms/cell/smp.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/arch/powerpc/platforms/cell/smp.c b/arch/powerpc/platforms/cell/smp.c
index 30394c6f8894..fee638fd8970 100644
--- a/arch/powerpc/platforms/cell/smp.c
+++ b/arch/powerpc/platforms/cell/smp.c
@@ -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
-- 
2.20.1.7.g153144c

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

[Randy Dunlap]

On 4/7/24 10:31 PM, Yang Li wrote:
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function smp_startup_cpu().
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  arch/powerpc/platforms/cell/smp.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/arch/powerpc/platforms/cell/smp.c b/arch/powerpc/platforms/cell/smp.c
> index 30394c6f8894..fee638fd8970 100644
> --- a/arch/powerpc/platforms/cell/smp.c
> +++ b/arch/powerpc/platforms/cell/smp.c
> @@ -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

-- 
#Randy

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

[Randy Dunlap]

On 4/7/24 10:31 PM, Yang Li wrote:
> Fix some function names in kernel-doc comments.
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/arch/powerpc/sysdev/fsl_gtm.c b/arch/powerpc/sysdev/fsl_gtm.c
> index 39186ad6b3c3..3dabc9621810 100644
> --- a/arch/powerpc/sysdev/fsl_gtm.c
> +++ b/arch/powerpc/sysdev/fsl_gtm.c
> @@ -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

-- 
#Randy

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

[Michael Ellerman]

On Mon, 08 Apr 2024 13:31:08 +0800, Yang Li wrote:
> Fix some function names in kernel-doc comments.
> 
> 

Applied to powerpc/next.

[2/3] powerpc: Fix kernel-doc comments in fsl_gtm.c
      https://git.kernel.org/powerpc/c/97bd2693b399cfd436acaa230d8f09e4c39e8e5c
[3/3] powerpc/rtas: Add kernel-doc comments to smp_startup_cpu()
      https://git.kernel.org/powerpc/c/554da5e0f71238384787954242d881cfeeff844d

cheers