RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #15975 from maribu/ztimer-doc

Browse Source 
sys/ztimer: clearify doc on clock ops
This commit is contained in:
Marian Buschsieweke 2021-02-10 12:23:55 +01:00 committed by GitHub
commit d7f3e92c30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sys/include/ztimer.h
View File

@ -294,16 +294,20 @@ typedef struct {
typedef struct {
/**
* @brief Set a new timer target
* @param clock ztimer clock to set the new target
* @param val Relative target (e.g. fire at value `now() + val`)
*/
void (*set)(ztimer_clock_t *clock, uint32_t val);
/**
* @brief Get the current count of the timer
* @param clock ztimer clock to get the current time from
*/
uint32_t (*now)(ztimer_clock_t *clock);
/**
* @brief Cancel any set target
* @param clock ztimer clock to cancel a pending alarm, if any
*/
void (*cancel)(ztimer_clock_t *clock);
} ztimer_ops_t;