timer: document the unit of the timer rate
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Thu, 7 Sep 2023 07:54:42 +0000 (09:54 +0200)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 9 Sep 2023 04:12:47 +0000 (06:12 +0200)
commitc00b289b9636a6f545deb0d068d2b8c51a01b0de
tree33d1a57540abe7db043ab3bb16e171626811d1f6
parent063536a7810d4e760787592f1b8e0e01992fa796
timer: document the unit of the timer rate

To avoid confusion document that timer_dev_priv.clock_rate and
timer_get_rate() yield the timer rate in hertz.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
include/timer.h