diff options
author | 2023-10-10 14:33:42 +0000 | |
---|---|---|
committer | 2023-10-10 14:33:42 +0000 | |
commit | af1a266670d040d2f4083ff309d732d648afba2a (patch) | |
tree | 2fc46203448ddcc6f81546d379abfaeb323575e9 /roms/u-boot/include/timer.h | |
parent | e02cda008591317b1625707ff8e115a4841aa889 (diff) |
Change-Id: Iaf8d18082d3991dec7c0ebbea540f092188eb4ec
Diffstat (limited to 'roms/u-boot/include/timer.h')
-rw-r--r-- | roms/u-boot/include/timer.h | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/roms/u-boot/include/timer.h b/roms/u-boot/include/timer.h new file mode 100644 index 000000000..a044cb034 --- /dev/null +++ b/roms/u-boot/include/timer.h @@ -0,0 +1,110 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * Copyright (C) 2015 Thomas Chou <thomas@wytron.com.tw> + */ + +#ifndef _TIMER_H_ +#define _TIMER_H_ + +/** + * dm_timer_init() - initialize a timer for time keeping. On success + * initializes gd->timer so that lib/timer can use it for future + * referrence. + * + * Return: 0 on success or error number + */ +int dm_timer_init(void); + +/** + * timer_timebase_fallback() - Helper for timers using timebase fallback + * @dev: A timer partially-probed timer device + * + * This is a helper function designed for timers which need to fall back on the + * cpu's timebase. This function is designed to be called during the driver's + * probe(). If there is a clocks or clock-frequency property in the timer's + * binding, then it will be used. Otherwise, the timebase of the current cpu + * will be used. This is initialized by the cpu driver, and usually gotten from + * ``/cpus/timebase-frequency`` or ``/cpus/cpu@X/timebase-frequency``. + * + * Return: 0 if OK, or negative error code on failure + */ +int timer_timebase_fallback(struct udevice *dev); + +/** + * timer_conv_64() - convert 32-bit counter value to 64-bit + * @count: 32-bit counter value + * + * Return: 64-bit counter value + */ +u64 timer_conv_64(u32 count); + +/** + * timer_get_count() - Get the current timer count + * @dev: The timer device + * @count: pointer that returns the current timer count + * + * Return: 0 if OK, -ve on error + */ +int timer_get_count(struct udevice *dev, u64 *count); + +/** + * timer_get_rate() - Get the timer input clock frequency + * @dev: The timer device + * + * Return: the timer input clock frequency + */ +unsigned long timer_get_rate(struct udevice *dev); + +/** + * struct timer_ops - Driver model timer operations + * + * The uclass interface is implemented by all timer devices which use + * driver model. + */ +struct timer_ops { + /** + * @get_count: Get the current timer count + * + * @dev: The timer device + * + * This function may be called at any time after the driver is probed. + * All necessary initialization must be completed by the time probe() + * returns. The count returned by this functions should be monotonic. + * This function must succeed. + * + * Return: The current 64-bit timer count + */ + u64 (*get_count)(struct udevice *dev); +}; + +/** + * struct timer_dev_priv - information about a device used by the uclass + * + * @clock_rate: the timer input clock frequency + */ +struct timer_dev_priv { + unsigned long clock_rate; +}; + +/** + * timer_early_get_count() - Implement timer_get_count() before driver model + * + * If ``CONFIG_TIMER_EARLY`` is enabled, this function wil be called to return + * the current timer value before the proper driver model timer is ready. + * It should be implemented by one of the timer values. This is mostly useful + * for tracing. + */ +u64 timer_early_get_count(void); + +/** + * timer_early_get_rate() - Get the timer rate before driver model + * + * If ``CONFIG_TIMER_EARLY`` is enabled, this function wil be called to return + * the current timer rate in Hz before the proper driver model timer is ready. + * It should be implemented by one of the timer values. This is mostly useful + * for tracing. This corresponds to the clock_rate value in struct + * timer_dev_priv. + */ +unsigned long timer_early_get_rate(void); + +#endif /* _TIMER_H_ */ |