Commit b5c28ea6 authored by Alexandre Belloni's avatar Alexandre Belloni Committed by Thomas Gleixner
Browse files

alarmtimer: Update kerneldoc 



Update kerneldoc comments to reflect the actual arguments and return values
of the documented functions.

Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20210202013457.3482388-1-alexandre.belloni@bootlin.com
parent 1048ba83

kernel/time/alarmtimer.c

+7 −1
Original line number Diff line number Diff line
@@ -527,8 +527,11 @@ static enum alarmtimer_type clock2alarm(clockid_t clockid) 
/**

 * alarm_handle_timer - Callback for posix timers

 * @alarm: alarm that fired

 * @now: time at the timer expiration

 *

 * Posix timer callback for expired alarm timers.

 *

 * Return: whether the timer is to be restarted

 */

static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,

							ktime_t now)
@@ -715,8 +718,11 @@ static int alarm_timer_create(struct k_itimer *new_timer) 
/**

 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep

 * @alarm: ptr to alarm that fired

 * @now: time at the timer expiration

 *

 * Wakes up the task that set the alarmtimer

 *

 * Return: ALARMTIMER_NORESTART

 */

static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,

								ktime_t now)
@@ -733,6 +739,7 @@ static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm, 
 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation

 * @alarm: ptr to alarmtimer

 * @absexp: absolute expiration time

 * @type: alarm type (BOOTTIME/REALTIME).

 *

 * Sets the alarm timer and sleeps until it is fired or interrupted.

 */
@@ -806,7 +813,6 @@ static long __sched alarm_timer_nsleep_restart(struct restart_block *restart) 
 * @which_clock: clockid

 * @flags: determins abstime or relative

 * @tsreq: requested sleep time (abs or rel)

 * @rmtp: remaining sleep time saved

 *

 * Handles clock_nanosleep calls against _ALARM clockids

 */