clocksource: cadence-ttc: fix some kernel-doc warnings
Commit Message
Fix some function kernel-doc warnings to placate scripts/kernel-doc.
timer-cadence-ttc.c:79: warning: Function parameter or member 'clk_rate_change_nb' not described in 'ttc_timer'
timer-cadence-ttc.c:158: warning: Function parameter or member 'cs' not described in '__ttc_clocksource_read'
timer-cadence-ttc.c:194: warning: expecting prototype for ttc_set_{shutdown|oneshot|periodic}(). Prototype was for ttc_shutdown() instead
timer-cadence-ttc.c:196: warning: No description found for return value of 'ttc_shutdown'
timer-cadence-ttc.c:212: warning: No description found for return value of 'ttc_set_periodic'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Michal Simek <michal.simek@amd.com>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-arm-kernel@lists.infradead.org
---
drivers/clocksource/timer-cadence-ttc.c | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
Comments
On 12/6/23 00:04, Randy Dunlap wrote:
> Fix some function kernel-doc warnings to placate scripts/kernel-doc.
>
> timer-cadence-ttc.c:79: warning: Function parameter or member 'clk_rate_change_nb' not described in 'ttc_timer'
> timer-cadence-ttc.c:158: warning: Function parameter or member 'cs' not described in '__ttc_clocksource_read'
> timer-cadence-ttc.c:194: warning: expecting prototype for ttc_set_{shutdown|oneshot|periodic}(). Prototype was for ttc_shutdown() instead
> timer-cadence-ttc.c:196: warning: No description found for return value of 'ttc_shutdown'
> timer-cadence-ttc.c:212: warning: No description found for return value of 'ttc_set_periodic'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Michal Simek <michal.simek@amd.com>
> Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: linux-arm-kernel@lists.infradead.org
> ---
> drivers/clocksource/timer-cadence-ttc.c | 22 ++++++++++++++++------
> 1 file changed, 16 insertions(+), 6 deletions(-)
>
> diff -- a/drivers/clocksource/timer-cadence-ttc.c b/drivers/clocksource/timer-cadence-ttc.c
> --- a/drivers/clocksource/timer-cadence-ttc.c
> +++ b/drivers/clocksource/timer-cadence-ttc.c
> @@ -69,7 +69,7 @@
> * @base_addr: Base address of timer
> * @freq: Timer input clock frequency
> * @clk: Associated clock source
> - * @clk_rate_change_nb Notifier block for clock rate changes
> + * @clk_rate_change_nb: Notifier block for clock rate changes
> */
> struct ttc_timer {
> void __iomem *base_addr;
> @@ -134,7 +134,7 @@ static void ttc_set_interval(struct ttc_
> * @irq: IRQ number of the Timer
> * @dev_id: void pointer to the ttc_timer instance
> *
> - * returns: Always IRQ_HANDLED - success
> + * Returns: Always IRQ_HANDLED - success
> **/
> static irqreturn_t ttc_clock_event_interrupt(int irq, void *dev_id)
> {
> @@ -151,8 +151,9 @@ static irqreturn_t ttc_clock_event_inter
>
> /**
> * __ttc_clocksource_read - Reads the timer counter register
> + * @cs: &clocksource to read from
> *
> - * returns: Current timer counter register value
> + * Returns: Current timer counter register value
> **/
> static u64 __ttc_clocksource_read(struct clocksource *cs)
> {
> @@ -173,7 +174,7 @@ static u64 notrace ttc_sched_clock_read(
> * @cycles: Timer interval ticks
> * @evt: Address of clock event instance
> *
> - * returns: Always 0 - success
> + * Returns: Always %0 - success
> **/
> static int ttc_set_next_event(unsigned long cycles,
> struct clock_event_device *evt)
> @@ -186,9 +187,12 @@ static int ttc_set_next_event(unsigned l
> }
>
> /**
> - * ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer
> - *
> + * ttc_shutdown - Sets the state of timer
> * @evt: Address of clock event instance
> + *
> + * Used for shutdown or oneshot.
> + *
> + * Returns: Always %0 - success
> **/
> static int ttc_shutdown(struct clock_event_device *evt)
> {
> @@ -202,6 +206,12 @@ static int ttc_shutdown(struct clock_eve
> return 0;
> }
>
> +/**
> + * ttc_set_periodic - Sets the state of timer
> + * @evt: Address of clock event instance
> + *
> + * Returns: Always %0 - success
> + */
> static int ttc_set_periodic(struct clock_event_device *evt)
> {
> struct ttc_timer_clockevent *ttce = to_ttc_timer_clkevent(evt);
Acked-by: Michal Simek <michal.simek@amd.com>
Tested-by: Michal Simek <michal.simek@amd.com>
Thanks,
Michal
On 06/12/2023 00:04, Randy Dunlap wrote:
> Fix some function kernel-doc warnings to placate scripts/kernel-doc.
>
> timer-cadence-ttc.c:79: warning: Function parameter or member 'clk_rate_change_nb' not described in 'ttc_timer'
> timer-cadence-ttc.c:158: warning: Function parameter or member 'cs' not described in '__ttc_clocksource_read'
> timer-cadence-ttc.c:194: warning: expecting prototype for ttc_set_{shutdown|oneshot|periodic}(). Prototype was for ttc_shutdown() instead
> timer-cadence-ttc.c:196: warning: No description found for return value of 'ttc_shutdown'
> timer-cadence-ttc.c:212: warning: No description found for return value of 'ttc_set_periodic'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Michal Simek <michal.simek@amd.com>
> Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: linux-arm-kernel@lists.infradead.org
> ---
Applied, thanks
@@ -69,7 +69,7 @@
* @base_addr: Base address of timer
* @freq: Timer input clock frequency
* @clk: Associated clock source
- * @clk_rate_change_nb Notifier block for clock rate changes
+ * @clk_rate_change_nb: Notifier block for clock rate changes
*/
struct ttc_timer {
void __iomem *base_addr;
@@ -134,7 +134,7 @@ static void ttc_set_interval(struct ttc_
* @irq: IRQ number of the Timer
* @dev_id: void pointer to the ttc_timer instance
*
- * returns: Always IRQ_HANDLED - success
+ * Returns: Always IRQ_HANDLED - success
**/
static irqreturn_t ttc_clock_event_interrupt(int irq, void *dev_id)
{
@@ -151,8 +151,9 @@ static irqreturn_t ttc_clock_event_inter
/**
* __ttc_clocksource_read - Reads the timer counter register
+ * @cs: &clocksource to read from
*
- * returns: Current timer counter register value
+ * Returns: Current timer counter register value
**/
static u64 __ttc_clocksource_read(struct clocksource *cs)
{
@@ -173,7 +174,7 @@ static u64 notrace ttc_sched_clock_read(
* @cycles: Timer interval ticks
* @evt: Address of clock event instance
*
- * returns: Always 0 - success
+ * Returns: Always %0 - success
**/
static int ttc_set_next_event(unsigned long cycles,
struct clock_event_device *evt)
@@ -186,9 +187,12 @@ static int ttc_set_next_event(unsigned l
}
/**
- * ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer
- *
+ * ttc_shutdown - Sets the state of timer
* @evt: Address of clock event instance
+ *
+ * Used for shutdown or oneshot.
+ *
+ * Returns: Always %0 - success
**/
static int ttc_shutdown(struct clock_event_device *evt)
{
@@ -202,6 +206,12 @@ static int ttc_shutdown(struct clock_eve
return 0;
}
+/**
+ * ttc_set_periodic - Sets the state of timer
+ * @evt: Address of clock event instance
+ *
+ * Returns: Always %0 - success
+ */
static int ttc_set_periodic(struct clock_event_device *evt)
{
struct ttc_timer_clockevent *ttce = to_ttc_timer_clkevent(evt);