Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-20 03:44:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

timer: document the unit of the timer rate

Browse source 
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>
This commit is contained in:
Heinrich Schuchardt 2023-09-07 09:54:42 +02:00
parent 063536a781
commit c00b289b96
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/timer.h
View file

@ -55,10 +55,10 @@ u64 timer_conv_64(u32 count);
int timer_get_count(struct udevice *dev, u64 *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 * @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); 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 * 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 { struct timer_dev_priv {
unsigned long clock_rate; unsigned long clock_rate;