Skip to content

Commit 0515c73

Browse files
rddunlapdlezcano
authored andcommitted
clocksource/drivers/cadence-ttc: Fix some kernel-doc warnings
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 <[email protected]> Cc: Michal Simek <[email protected]> Cc: Daniel Lezcano <[email protected]> Cc: Thomas Gleixner <[email protected]> Cc: [email protected] Acked-by: Michal Simek <[email protected]> Tested-by: Michal Simek <[email protected]> Signed-off-by: Daniel Lezcano <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent b99a212 commit 0515c73

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

drivers/clocksource/timer-cadence-ttc.c

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
* @base_addr: Base address of timer
7070
* @freq: Timer input clock frequency
7171
* @clk: Associated clock source
72-
* @clk_rate_change_nb Notifier block for clock rate changes
72+
* @clk_rate_change_nb: Notifier block for clock rate changes
7373
*/
7474
struct ttc_timer {
7575
void __iomem *base_addr;
@@ -134,7 +134,7 @@ static void ttc_set_interval(struct ttc_timer *timer,
134134
* @irq: IRQ number of the Timer
135135
* @dev_id: void pointer to the ttc_timer instance
136136
*
137-
* returns: Always IRQ_HANDLED - success
137+
* Returns: Always IRQ_HANDLED - success
138138
**/
139139
static irqreturn_t ttc_clock_event_interrupt(int irq, void *dev_id)
140140
{
@@ -151,8 +151,9 @@ static irqreturn_t ttc_clock_event_interrupt(int irq, void *dev_id)
151151

152152
/**
153153
* __ttc_clocksource_read - Reads the timer counter register
154+
* @cs: &clocksource to read from
154155
*
155-
* returns: Current timer counter register value
156+
* Returns: Current timer counter register value
156157
**/
157158
static u64 __ttc_clocksource_read(struct clocksource *cs)
158159
{
@@ -173,7 +174,7 @@ static u64 notrace ttc_sched_clock_read(void)
173174
* @cycles: Timer interval ticks
174175
* @evt: Address of clock event instance
175176
*
176-
* returns: Always 0 - success
177+
* Returns: Always %0 - success
177178
**/
178179
static int ttc_set_next_event(unsigned long cycles,
179180
struct clock_event_device *evt)
@@ -186,9 +187,12 @@ static int ttc_set_next_event(unsigned long cycles,
186187
}
187188

188189
/**
189-
* ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer
190-
*
190+
* ttc_shutdown - Sets the state of timer
191191
* @evt: Address of clock event instance
192+
*
193+
* Used for shutdown or oneshot.
194+
*
195+
* Returns: Always %0 - success
192196
**/
193197
static int ttc_shutdown(struct clock_event_device *evt)
194198
{
@@ -202,6 +206,12 @@ static int ttc_shutdown(struct clock_event_device *evt)
202206
return 0;
203207
}
204208

209+
/**
210+
* ttc_set_periodic - Sets the state of timer
211+
* @evt: Address of clock event instance
212+
*
213+
* Returns: Always %0 - success
214+
*/
205215
static int ttc_set_periodic(struct clock_event_device *evt)
206216
{
207217
struct ttc_timer_clockevent *ttce = to_ttc_timer_clkevent(evt);

0 commit comments

Comments
 (0)