michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: add user data API to timers

Browse source 
Similar to what was available with nano timers in the original kernel,
allow a user to associate opaque data with a timer.

Fix for ZEP-1558.

Change-Id: Ib8cf998b47988da27eba4ee5cd2658f90366b1e4
Signed-off-by: Benjamin Walsh <walsh.benj@gmail.com>
This commit is contained in:
Benjamin Walsh 2017-01-12 19:38:53 -05:00 • committed by Anas Nashif
commit e4e98f9d7b
4 changed files with 40 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

38
include/kernel.h
View file

@ -757,8 +757,8 @@ struct k_timer {
/* timer status */
uint32_t status;
/* used to support legacy timer APIs */
void *_legacy_data;
/* user-specific data, also used to support legacy features */
void *user_data;
_OBJECT_TRACING_NEXT_PTR(k_timer);
};
@ -773,7 +773,7 @@ struct k_timer {
.expiry_fn = expiry, \
.stop_fn = stop, \
.status = 0, \
._legacy_data = NULL, \
.user_data = 0, \
_OBJECT_TRACING_INIT \
}
@ -929,6 +929,38 @@ static inline int32_t k_timer_remaining_get(struct k_timer *timer)
return _timeout_remaining_get(&timer->timeout);
}
/**
* @brief Associate user-specific data with a timer.
*
* This routine records the @a user_data with the @a timer, to be retrieved
* later.
*
* It can be used e.g. in a timer handler shared across multiple subsystems to
* retrieve data specific to the subsystem this timer is associated with.
*
* @param timer Address of timer.
* @param user_data User data to associate with the timer.
*
* @return N/A
*/
static inline void k_timer_user_data_set(struct k_timer *timer,
void *user_data)
{
timer->user_data = user_data;
}
/**
* @brief Retrieve the user-specific data from a timer.
*
* @param timer Address of timer.
*
* @return The user data.
*/
static inline void *k_timer_user_data_get(struct k_timer *timer)
{
return timer->user_data;
}
/**
* @} end defgroup timer_apis
*/