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

sched_cb: Add function documentation

Browse Source
This commit is contained in:
Koen Zandberg 2020-06-23 15:29:20 +02:00
parent 9a10aad0a0
commit c4b4e66422
No known key found for this signature in database
GPG Key ID: 0895A893E6D2985B
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
core/include/sched.h
View File

@ -203,13 +203,25 @@ extern clist_node_t sched_runqueues[SCHED_PRIO_LEVELS];
*/
NORETURN void sched_task_exit(void);
#ifdef MODULE_SCHED_CB
#if IS_USED(MODULE_SCHED_CB) || defined(DOXYGEN)
/**
* @brief Register a callback that will be called on every scheduler run
* @brief Scheduler run callback
*
* @param[in] callback The callback functions the will be called
* @note Both @p active and @p next can be KERNEL_PID_UNDEF, but not at the same
* time.
*
* @param active Pid of the active thread pid
* @param next Pid of the next scheduled thread
*/
void sched_register_cb(void (*callback)(kernel_pid_t, kernel_pid_t));
typedef void (*sched_callback_t)(kernel_pid_t active, kernel_pid_t next);
/**
* @brief Register a callback that will be called on every scheduler run
*
* @param[in] callback The callback functions that will be called
*/
void sched_register_cb(sched_callback_t callback);
#endif /* MODULE_SCHED_CB */
#ifdef __cplusplus