UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

alarmtimer: Update kerneldoc 

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

Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20210202013457.3482388-1-alexandre.belloni@bootlin.com
This commit is contained in:
Alexandre Belloni 2021-02-02 02:34:57 +01:00 committed by Thomas Gleixner
parent 1048ba83fb
commit b5c28ea601
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
kernel/time/alarmtimer.c
View File

@ -527,8 +527,11 @@ static enum alarmtimer_type clock2alarm(clockid_t clockid)
/** /**
* alarm_handle_timer - Callback for posix timers * alarm_handle_timer - Callback for posix timers
* @alarm: alarm that fired * @alarm: alarm that fired
* @now: time at the timer expiration
* *
* Posix timer callback for expired alarm timers. * 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, static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
ktime_t now) 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 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
* @alarm: ptr to alarm that fired * @alarm: ptr to alarm that fired
* @now: time at the timer expiration
* *
* Wakes up the task that set the alarmtimer * Wakes up the task that set the alarmtimer
*
* Return: ALARMTIMER_NORESTART
*/ */
static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm, static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
ktime_t now) ktime_t now)
@ -733,6 +739,7 @@ static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
* alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
* @alarm: ptr to alarmtimer * @alarm: ptr to alarmtimer
* @absexp: absolute expiration time * @absexp: absolute expiration time
* @type: alarm type (BOOTTIME/REALTIME).
* *
* Sets the alarm timer and sleeps until it is fired or interrupted. * 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 * @which_clock: clockid
* @flags: determins abstime or relative * @flags: determins abstime or relative
* @tsreq: requested sleep time (abs or rel) * @tsreq: requested sleep time (abs or rel)
* @rmtp: remaining sleep time saved
* *
* Handles clock_nanosleep calls against _ALARM clockids * Handles clock_nanosleep calls against _ALARM clockids
*/ */