ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Extend scheduler with init and run callbacks.

Niklas Hauser 2016-04-05 16:54:50 +01:00 committed by Martin Kojtal
parent 6e85376d37
commit df1d9f5529
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
frameworks\utest/utest/scheduler.h
View File

@ -33,6 +33,15 @@ extern "C" {
*/ */
typedef void (*utest_v1_harness_callback_t)(void); typedef void (*utest_v1_harness_callback_t)(void);
/**
* utest calls this function before running the test specification.
* Use this function to initialize your scheduler before the first callback is requested.
*
* @retval `0` if success
* @retval non-zero if failure
*/
typedef int32_t (*utest_v1_scheduler_init_callback_t)(void);
/** /**
* utest calls this function when it needs to schedule a callback with a delay in milliseconds. * utest calls this function when it needs to schedule a callback with a delay in milliseconds.
* `delay_ms` will only be non-zero if an asynchronous test case exists in the test specification. * `delay_ms` will only be non-zero if an asynchronous test case exists in the test specification.
@ -66,13 +75,25 @@ typedef void *(*utest_v1_scheduler_post_callback_t)(const utest_v1_harness_callb
*/ */
typedef int32_t (*utest_v1_scheduler_cancel_callback_t)(void *handle); typedef int32_t (*utest_v1_scheduler_cancel_callback_t)(void *handle);
/**
* utest calls this function at the end of the `Harness::run()` function, after (!) the first callback has been requested.
* This function is meant to implement an optional event loop, which may very well be blocking (if your scheduler works with that).
* This assumes that `Harness::run()` will be called on the main stack (ie. not in an interrupt!).
*
* @retval `0` if success
* @retval non-zero if failure
*/
typedef int32_t (*utest_v1_scheduler_run_callback_t)(void);
/** /**
* The scheduler interface consists out of the `post` and `cancel` functions, * The scheduler interface consists out of the `post` and `cancel` functions,
* which you must implement to use `utest`. * which you must implement to use `utest`.
*/ */
typedef struct { typedef struct {
utest_v1_scheduler_init_callback_t init;
utest_v1_scheduler_post_callback_t post; utest_v1_scheduler_post_callback_t post;
utest_v1_scheduler_cancel_callback_t cancel; utest_v1_scheduler_cancel_callback_t cancel;
utest_v1_scheduler_run_callback_t run;
} utest_v1_scheduler_t; } utest_v1_scheduler_t;
#ifdef __cplusplus #ifdef __cplusplus