From c00b289b9636a6f545deb0d068d2b8c51a01b0de Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Thu, 7 Sep 2023 09:54:42 +0200 Subject: [PATCH] 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 Reviewed-by: Simon Glass --- include/timer.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/timer.h b/include/timer.h index 311ce6b2c3..091d8dfa22 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; -- 2.39.5