riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sys/ztimer: clearify doc on clock ops

Browse Source
This commit is contained in:
Marian Buschsieweke 2021-02-09 22:34:04 +01:00
parent 807b154fc4
commit e241b43d3f
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
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 { typedef struct {
/** /**
* @brief Set a new timer target * @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); void (*set)(ztimer_clock_t *clock, uint32_t val);
/** /**
* @brief Get the current count of the timer * @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); uint32_t (*now)(ztimer_clock_t *clock);
/** /**
* @brief Cancel any set target * @brief Cancel any set target
* @param clock ztimer clock to cancel a pending alarm, if any
*/ */
void (*cancel)(ztimer_clock_t *clock); void (*cancel)(ztimer_clock_t *clock);
} ztimer_ops_t; } ztimer_ops_t;