Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 91e5a217 authored by Thomas Gleixner's avatar Thomas Gleixner
Browse files

hrtimer: Document hrtimer_forward[_now]() proper 



Document the calling context conditions.

Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Acked-by: default avatarPeter Zijlstra <peterz@infradead.org>
Link: http://lkml.kernel.org/r/20150413210035.178751779@linutronix.de


Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
parent 51a03393

include/linux/hrtimer.h

+16 −1
Original line number Diff line number Diff line
@@ -418,7 +418,22 @@ static inline int hrtimer_callback_running(struct hrtimer *timer) 
extern u64

hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);



/* Forward a hrtimer so it expires after the hrtimer's current now */

/**

 * hrtimer_forward_now - forward the timer expiry so it expires after now

 * @timer:	hrtimer to forward

 * @interval:	the interval to forward

 *

 * Forward the timer expiry so it will expire after the current time

 * of the hrtimer clock base. Returns the number of overruns.

 *

 * Can be safely called from the callback function of @timer. If

 * called from other contexts @timer must neither be enqueued nor

 * running the callback and the caller needs to take care of

 * serialization.

 *

 * Note: This only updates the timer expiry value and does not requeue

 * the timer.

 */

static inline u64 hrtimer_forward_now(struct hrtimer *timer,

				      ktime_t interval)

{

kernel/time/hrtimer.c

+8 −0
Original line number Diff line number Diff line
@@ -801,6 +801,14 @@ void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags) 
 *

 * Forward the timer expiry so it will expire in the future.

 * Returns the number of overruns.

 *

 * Can be safely called from the callback function of @timer. If

 * called from other contexts @timer must neither be enqueued nor

 * running the callback and the caller needs to take care of

 * serialization.

 *

 * Note: This only updates the timer expiry value and does not requeue

 * the timer.

 */

u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)

{