diff options
| author | Thomas Gleixner <tglx@linutronix.de> | 2015-04-13 21:02:22 +0000 |
|---|---|---|
| committer | Thomas Gleixner <tglx@linutronix.de> | 2015-04-22 17:06:48 +0200 |
| commit | 91e5a2170e795989da9f90c18ba18984f23acc5b (patch) | |
| tree | a0aba8e79eeefaf6a05982a97b11904fbbc4105c /include/linux | |
| parent | 51a03393bac061a4e13fd17214d3ef93a5b296e3 (diff) | |
hrtimer: Document hrtimer_forward[_now]() proper
Document the calling context conditions.
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Acked-by: Peter Zijlstra <peterz@infradead.org>
Link: http://lkml.kernel.org/r/20150413210035.178751779@linutronix.de
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Diffstat (limited to 'include/linux')
| -rw-r--r-- | include/linux/hrtimer.h | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index 05f6df1fdf5b..7770676c387a 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h @@ -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) { |