drivers: counter: API unifying counter and rtc drivers.
counter.h and rtc.h API's share almost the same functionality. They are unified as a new counter.h. rtc.h will be deprecated. Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruściński
Anas Nashif
parent
ad92d5bfe9
commit
dedbecb046
1 changed files with 264 additions and 24 deletions
|
|
@ -1,4 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2018 Nordic Semiconductor ASA
|
||||
* Copyright (c) 2016 Intel Corporation
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
|
|
@ -22,36 +23,183 @@
|
|||
#include <zephyr/types.h>
|
||||
#include <stddef.h>
|
||||
#include <device.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef void (*counter_callback_t)(struct device *dev, void *user_data);
|
||||
struct counter_alarm_cfg;
|
||||
|
||||
/** @brief Alarm callback
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
* @param cfg Original structure owning this handler.
|
||||
* @param ticks Counter value that triggered the callback.
|
||||
*/
|
||||
typedef void (*counter_alarm_callback_t)(struct device *dev,
|
||||
const struct counter_alarm_cfg *cfg,
|
||||
u32_t ticks);
|
||||
|
||||
/** @brief Alarm callback structure.
|
||||
*
|
||||
* Used to set an alarm.
|
||||
* Beware such structure should not be allocated on stack.
|
||||
*/
|
||||
struct counter_alarm_cfg {
|
||||
counter_alarm_callback_t handler; /*!< handler called on alarm
|
||||
* (cannot be NULL).
|
||||
*/
|
||||
|
||||
u32_t ticks; /*!< In case of absolute flag is set, maximal value that
|
||||
* can be set equals wrap value (counter_get_wrap).
|
||||
* Otherwise counter_get_max_relative_alarm() returns
|
||||
* maximal value that can be set. If counter is clock
|
||||
* driven then ticks can be converted to microseconds
|
||||
* (see @ref counter_ticks_to_us). Alternatively,
|
||||
* counter implementation may count asynchronous events.
|
||||
*/
|
||||
|
||||
u8_t channel_id; /*!< Channel ID. Number of channels is driver
|
||||
* dependent.
|
||||
*/
|
||||
|
||||
bool absolute; /*!< If true ticks are treated as absolute value, else
|
||||
* it is relative to the counter reading performed
|
||||
* during the call.
|
||||
*/
|
||||
};
|
||||
|
||||
/** @brief Wrap callback
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
* @param user_data User data provided in counter_set_wrap_alarm.
|
||||
*/
|
||||
typedef void (*counter_wrap_callback_t)(struct device *dev, void *user_data);
|
||||
|
||||
/** @brief Structure with generic counter features. */
|
||||
struct counter_config_info {
|
||||
u32_t max_wrap; /*!< Maximal (default) wrap value on which counter is
|
||||
* reset (cleared or reloaded).
|
||||
*/
|
||||
|
||||
u32_t freq; /*!< Frequency of the source clock if synchronous events
|
||||
* are counted.
|
||||
*/
|
||||
|
||||
bool count_up; /*!< Flag indicating direction of the counter. If true
|
||||
* counter is counting up else counting down.
|
||||
*/
|
||||
|
||||
u8_t channels; /*!< Number of channels that can be used for setting
|
||||
* alarm, see @ref counter_set_alarm.
|
||||
*/
|
||||
};
|
||||
|
||||
typedef int (*counter_api_start)(struct device *dev);
|
||||
typedef int (*counter_api_stop)(struct device *dev);
|
||||
typedef u32_t (*counter_api_read)(struct device *dev);
|
||||
typedef int (*counter_api_set_alarm)(struct device *dev,
|
||||
counter_callback_t callback,
|
||||
u32_t count, void *user_data);
|
||||
const struct counter_alarm_cfg *alarm_cfg);
|
||||
typedef int (*counter_api_disable_alarm)(struct device *dev,
|
||||
const struct counter_alarm_cfg *alarm_cfg);
|
||||
typedef int (*counter_api_set_wrap)(struct device *dev, u32_t ticks,
|
||||
counter_wrap_callback_t callback,
|
||||
void *user_data);
|
||||
typedef u32_t (*counter_api_get_pending_int)(struct device *dev);
|
||||
typedef u32_t (*counter_api_get_wrap)(struct device *dev);
|
||||
typedef u32_t (*counter_api_get_max_relative_alarm)(struct device *dev);
|
||||
|
||||
struct counter_driver_api {
|
||||
counter_api_start start;
|
||||
counter_api_stop stop;
|
||||
counter_api_read read;
|
||||
counter_api_set_alarm set_alarm;
|
||||
counter_api_disable_alarm disable_alarm;
|
||||
counter_api_set_wrap set_wrap;
|
||||
counter_api_get_pending_int get_pending_int;
|
||||
counter_api_get_wrap get_wrap;
|
||||
counter_api_get_max_relative_alarm get_max_relative_alarm;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @brief Function to check if counter is counting up.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @retval true if counter is counting up.
|
||||
* @retval false if counter is counting down.
|
||||
*/
|
||||
static inline bool counter_count_up(const struct device *dev)
|
||||
{
|
||||
const struct counter_config_info *config = dev->config->config_info;
|
||||
|
||||
return config->count_up;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to get number of alarm channels.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @return Number of alarm channels.
|
||||
*/
|
||||
static inline u8_t counter_get_num_of_channels(const struct device *dev)
|
||||
{
|
||||
const struct counter_config_info *config = dev->config->config_info;
|
||||
|
||||
return config->channels;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to convert microseconds to ticks.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
* @param[in] us Microseconds.
|
||||
*
|
||||
* @return Converted ticks. Ticks will be saturated if exceed 32 bits.
|
||||
*/
|
||||
static inline u32_t counter_us_to_ticks(const struct device *dev, u64_t us)
|
||||
{
|
||||
const struct counter_config_info *config = dev->config->config_info;
|
||||
u64_t ticks = (us * config->freq) / USEC_PER_SEC;
|
||||
|
||||
return (ticks > (u64_t)UINT32_MAX) ? UINT32_MAX : ticks;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to convert ticks to microseconds.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
* @param[in] ticks Ticks.
|
||||
*
|
||||
* @return Converted microseconds.
|
||||
*/
|
||||
static inline u64_t counter_ticks_to_us(const struct device *dev, u32_t ticks)
|
||||
{
|
||||
const struct counter_config_info *config = dev->config->config_info;
|
||||
|
||||
return ((u64_t)ticks * USEC_PER_SEC) / config->freq;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to retrieve maximum wrap value that can be set.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @return Max wrap value.
|
||||
*/
|
||||
static inline u32_t counter_get_max_wrap(const struct device *dev)
|
||||
{
|
||||
const struct counter_config_info *config = dev->config->config_info;
|
||||
|
||||
return config->max_wrap;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Start counter device in free running mode.
|
||||
*
|
||||
* Start the counter device. If the device is a 'countup' counter, the
|
||||
* counter initial value is set to zero. If it is a 'countdown' counter,
|
||||
* the initial value is set to the maximum value supported by the device.
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @retval 0 If successful.
|
||||
|
|
@ -68,10 +216,11 @@ static inline int _impl_counter_start(struct device *dev)
|
|||
|
||||
/**
|
||||
* @brief Stop counter device.
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @retval 0 If successful.
|
||||
* @retval -ENODEV if the device doesn't support stopping the
|
||||
* @retval -ENOTSUP if the device doesn't support stopping the
|
||||
* counter.
|
||||
*/
|
||||
__syscall int counter_stop(struct device *dev);
|
||||
|
|
@ -100,26 +249,85 @@ static inline u32_t _impl_counter_read(struct device *dev)
|
|||
|
||||
/**
|
||||
* @brief Set an alarm.
|
||||
*
|
||||
* In case of absolute request, maximal value that can be set is equal to
|
||||
* wrap value set by counter_set_wrap call or default, maximal one. in case of
|
||||
* relative request, Maximal value can be retrieved using
|
||||
* counter_get_max_relative_alarm.
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
* @param callback Pointer to the callback function. If this is NULL,
|
||||
* this function unsets the alarm.
|
||||
* @param count Number of counter ticks. This is relative value, meaning
|
||||
* an alarm will be triggered count ticks in the future.
|
||||
* @param user_data Pointer to user data.
|
||||
* @param alarm_cfg Alarm configuration.
|
||||
*
|
||||
* @retval 0 If successful.
|
||||
* @retval -ENOTSUP if the counter was not started yet.
|
||||
* @retval -ENODEV if the device doesn't support interrupt (e.g. free
|
||||
* running counters).
|
||||
* @retval Negative errno code if failure.
|
||||
* @retval -ENOTSUP if request is not supported (device does not support
|
||||
* interrupts or requested channel).
|
||||
* @retval -EINVAL if alarm settings are invalid.
|
||||
*/
|
||||
static inline int counter_set_alarm(struct device *dev,
|
||||
counter_callback_t callback,
|
||||
u32_t count, void *user_data)
|
||||
const struct counter_alarm_cfg *alarm_cfg)
|
||||
{
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
return api->set_alarm(dev, callback, count, user_data);
|
||||
if (alarm_cfg->channel_id >= counter_get_num_of_channels(dev)) {
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
return api->set_alarm(dev, alarm_cfg);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Disable an alarm.
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
* @param alarm_cfg Alarm configuration. It must be the same address as the
|
||||
* one used for @ref counter_set_alarm.
|
||||
*
|
||||
* @retval 0 If successful.
|
||||
* @retval -ENOTSUP if request is not supported or the counter was not started
|
||||
* yet.
|
||||
*/
|
||||
static inline int counter_disable_alarm(struct device *dev,
|
||||
const struct counter_alarm_cfg *alarm_cfg)
|
||||
{
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
if (alarm_cfg->channel_id >= counter_get_num_of_channels(dev)) {
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
return api->disable_alarm(dev, alarm_cfg);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set counter wrap.
|
||||
*
|
||||
* Function sets wrap value and resets the counter to 0 or wrap value
|
||||
* depending on counter direction. On wrap, counter is reset and optinal
|
||||
* callback is periodically called. Wrap value can only be changed when there
|
||||
* is no active alarm.
|
||||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
* @param ticks Wrap value.
|
||||
* @param callback Callback function. Can be NULL.
|
||||
* @param user_data User data passed to callback function. Not valid if
|
||||
* callback is NULL.
|
||||
*
|
||||
* @retval 0 If successful.
|
||||
* @retval -ENOTSUP if request is not supported (e.g. wrap value cannot be
|
||||
* changed).
|
||||
* @retval -EBUSY if any alarm is active.
|
||||
*/
|
||||
static inline int counter_set_wrap(struct device *dev, u32_t ticks,
|
||||
counter_wrap_callback_t callback,
|
||||
void *user_data)
|
||||
{
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
if (ticks > counter_get_max_wrap(dev)) {
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
return api->set_wrap(dev, ticks, callback, user_data);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -132,19 +340,51 @@ static inline int counter_set_alarm(struct device *dev,
|
|||
*
|
||||
* @param dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @retval 1 if the counter interrupt is pending.
|
||||
* @retval 1 if any counter interrupt is pending.
|
||||
* @retval 0 if no counter interrupt is pending.
|
||||
*/
|
||||
__syscall int counter_get_pending_int(struct device *dev);
|
||||
|
||||
static inline int _impl_counter_get_pending_int(struct device *dev)
|
||||
{
|
||||
struct counter_driver_api *api;
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
api = (struct counter_driver_api *)dev->driver_api;
|
||||
return api->get_pending_int(dev);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to retrieve current wrap value.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @return Wrap value.
|
||||
*/
|
||||
__syscall u32_t counter_get_wrap(struct device *dev);
|
||||
|
||||
static inline u32_t _impl_counter_get_wrap(struct device *dev)
|
||||
{
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
return api->get_wrap(dev);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Function to retrieve maximum relative value that can be set by
|
||||
* counter_set_alarm.
|
||||
*
|
||||
* @param[in] dev Pointer to the device structure for the driver instance.
|
||||
*
|
||||
* @return Max alarm value.
|
||||
*/
|
||||
__syscall u32_t counter_get_max_relative_alarm(struct device *dev);
|
||||
|
||||
static inline u32_t _impl_counter_get_max_relative_alarm(struct device *dev)
|
||||
{
|
||||
const struct counter_driver_api *api = dev->driver_api;
|
||||
|
||||
return api->get_max_relative_alarm(dev);
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue