timekeeping/clocksource_cyc2ns: Document intended range limitation
authorChris Metcalf <cmetcalf@mellanox.com>
Mon, 28 Nov 2016 22:35:20 +0000 (14:35 -0800)
committerThomas Gleixner <tglx@linutronix.de>
Tue, 29 Nov 2016 17:02:58 +0000 (18:02 +0100)
commitec4101e8903e318b9fd4e3bbf72b1eaba53c64e1
treec3e5196fea272e92a229707dc861f9545953f933
parentba58d1020a54933c6b087a3107661c8513556cb8
timekeeping/clocksource_cyc2ns: Document intended range limitation

The "cycles" argument should not be an absolute clocksource cycle
value, as the implementation's arithmetic will overflow relatively
easily with wide (64 bit) clocksource counters.

For performance, the implementation is simple and fast, since the
function is intended for only relatively small delta values of
clocksource cycles.

[jstultz: Fixed up to merge against HEAD & commit message tweaks,
 also included rewording suggestion by Ingo]
Signed-off-by: Chris Metcalf <cmetcalf@mellanox.com>
Signed-off-by: John Stultz <john.stultz@linaro.org>
Cc: Prarit Bhargava <prarit@redhat.com>
Cc: Richard Cochran <richardcochran@gmail.com>
Link: http://lkml.kernel.org/r/1480372524-15181-4-git-send-email-john.stultz@linaro.org
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
include/linux/clocksource.h