djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

supervisor: tick: document

This commit is contained in:
Jeff Epler 2019-11-20 10:15:33 -06:00
parent 70719597ab
commit a9baa0f954
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
supervisor/shared/tick.h
View File

@ -29,9 +29,32 @@
#include <stdint.h> #include <stdint.h>
/** @brief To be called once every ms
*
* The port must call supervisor_tick once per millisecond to perform regular tasks.
* This is called from the SysTick interrupt or similar, and is safe to call in an
* interrupt context.
*/
extern void supervisor_tick(void); extern void supervisor_tick(void);
/** @brief Get the lower 32 bits of the time in milliseconds
*
* This can be more efficient than supervisor_ticks_ms64, for sites where a wraparound
* of ~49.5 days is not harmful.
*/
extern uint32_t supervisor_ticks_ms32(void); extern uint32_t supervisor_ticks_ms32(void);
/** @brief Get the full time in milliseconds
*
* Because common ARM mcus cannot atomically work with 64-bit quantities, this
* function must briefly disable interrupts in order to return the value. If
* only relative durations of less than about ~49.5 days need to be considered,
* then it may be possible to use supervisor_ticks_ms64 instead.
*/
extern uint64_t supervisor_ticks_ms64(void); extern uint64_t supervisor_ticks_ms64(void);
/** @brief Run background ticks, but only about every millisecond.
*
* Normally, this is not called directly. Instead use the RUN_BACKGROUND_TASKS
* macro.
*/
extern void supervisor_run_background_if_tick(void); extern void supervisor_run_background_if_tick(void);
#endif #endif