diff options
| author | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2021-03-29 20:13:37 +0200 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2021-04-07 19:26:44 +0200 |
| commit | 4c81cb7e64436a729cf20cdddaf18a9b4a638430 (patch) | |
| tree | af5a0c3c427bcc54d0b9ff6b3eae2c11bb60ab07 /kernel/time/tick-sched.c | |
| parent | d484b8bfc6fa71a088e4ac85d9ce11aa0385867e (diff) | |
| download | linux-4c81cb7e64436a729cf20cdddaf18a9b4a638430.tar.bz2 | |
tick/nohz: Improve tick_nohz_get_next_hrtimer() kerneldoc
Make the tick_nohz_get_next_hrtimer() kerneldoc comment state clearly
that the function may return negative numbers.
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'kernel/time/tick-sched.c')
| -rw-r--r-- | kernel/time/tick-sched.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c index e10a4af88737..ee0032b95a7c 100644 --- a/kernel/time/tick-sched.c +++ b/kernel/time/tick-sched.c @@ -1124,7 +1124,11 @@ ktime_t tick_nohz_get_next_hrtimer(void) * tick_nohz_get_sleep_length - return the expected length of the current sleep * @delta_next: duration until the next event if the tick cannot be stopped * - * Called from power state control code with interrupts disabled + * Called from power state control code with interrupts disabled. + * + * The return value of this function and/or the value returned by it through the + * @delta_next pointer can be negative which must be taken into account by its + * callers. */ ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next) { |