diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-09-07 09:54:42 +0200 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-09-09 06:12:47 +0200 |
commit | c00b289b9636a6f545deb0d068d2b8c51a01b0de (patch) | |
tree | 33d1a57540abe7db043ab3bb16e171626811d1f6 /include/timer.h | |
parent | 063536a7810d4e760787592f1b8e0e01992fa796 (diff) | |
download | u-boot-c00b289b9636a6f545deb0d068d2b8c51a01b0de.zip u-boot-c00b289b9636a6f545deb0d068d2b8c51a01b0de.tar.gz u-boot-c00b289b9636a6f545deb0d068d2b8c51a01b0de.tar.bz2 |
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>
Diffstat (limited to 'include/timer.h')
-rw-r--r-- | include/timer.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/timer.h b/include/timer.h index 311ce6b..091d8df 100644 --- a/include/timer.h +++ b/include/timer.h @@ -55,10 +55,10 @@ u64 timer_conv_64(u32 count); int timer_get_count(struct udevice *dev, u64 *count); /** - * timer_get_rate() - Get the timer input clock frequency + * timer_get_rate() - Get the timer input clock frequency in Hz * @dev: The timer device * - * Return: the timer input clock frequency + * Return: the timer input clock frequency in Hz */ unsigned long timer_get_rate(struct udevice *dev); @@ -87,7 +87,7 @@ struct timer_ops { /** * struct timer_dev_priv - information about a device used by the uclass * - * @clock_rate: the timer input clock frequency + * @clock_rate: the timer input clock frequency in Hz */ struct timer_dev_priv { unsigned long clock_rate; |