|
StateOS
|
flags (any, all, new) More...
Macros | |
| #define | flgAny 0U |
| wait for any flags to be set | |
| #define | flgAll 1U |
| wait for all flags to be set | |
| #define | flgNew 2U |
| ignore flags in flag object that have been set before | |
| #define | flgAnyNew ( flgAny | flgNew ) |
| flgAny | flgNew | |
| #define | flgAllNew ( flgAll | flgNew ) |
| flgAll | flgNew | |
| #define | OS_FLG(flg, ...) |
| define and initialize a flag object | |
| #define | static_FLG(flg, ...) |
| static alias of OS_FLG() | |
| #define | FLG_INIT(...) |
| create and initialize a flag object | |
| #define | FLG_CREATE(...) |
| create and initialize a flag object | |
| #define | FLG_NEW FLG_CREATE |
| alias of FLG_CREATE() | |
Functions | |
| void | flg_init (flg_t *flg, unsigned init) |
| initialize a flag object | |
| flg_t * | flg_create (unsigned init) |
| create and initialize a new flag object | |
| flg_t * | flg_new (unsigned init) |
| alias of flg_create() | |
| void | flg_reset (flg_t *flg) |
| reset the flag object and wake up all waiting tasks with 'E_STOPPED' event value | |
| void | flg_kill (flg_t *flg) |
| alias of flg_reset() | |
| void | flg_destroy (flg_t *flg) |
| reset the flag object, wake up all waiting tasks with 'E_DELETED' event value and free allocated resource | |
| void | flg_delete (flg_t *flg) |
| alias of flg_destroy() | |
| unsigned | flg_take (flg_t *flg, unsigned flags, unsigned mode) |
| check if required flags have been set in the flag object | |
| unsigned | flg_tryWait (flg_t *flg, unsigned flags, unsigned mode) |
| alias of flg_take() | |
| unsigned | flg_takeISR (flg_t *flg, unsigned flags, unsigned mode) |
| ISR alias of flg_take(). | |
| int | flg_waitFor (flg_t *flg, unsigned flags, unsigned mode, cnt_t delay) |
| wait on flag object for given flags for given duration of time | |
| int | flg_waitUntil (flg_t *flg, unsigned flags, unsigned mode, cnt_t time) |
| wait on flag object for given flags until given timepoint | |
| int | flg_wait (flg_t *flg, unsigned flags, unsigned mode) |
| wait indefinitely on flag object until required flags have been set | |
| unsigned | flg_give (flg_t *flg, unsigned flags) |
| set given flags in flag object | |
| unsigned | flg_set (flg_t *flg, unsigned flags) |
| alias of flg_give() | |
| unsigned | flg_giveISR (flg_t *flg, unsigned flags) |
| ISR alias of flg_give(). | |
| unsigned | flg_clear (flg_t *flg, unsigned flags) |
| clear given flags in flag object | |
| unsigned | flg_clearISR (flg_t *flg, unsigned flags) |
| ISR alias of flg_clear(). | |
| unsigned | flg_get (flg_t *flg) |
| get current flags from flag object | |
| unsigned | flg_getISR (flg_t *flg) |
| ISR alias of flg_get(). | |
flags (any, all, new)
| #define OS_FLG | ( | flg, | |
| ... ) |
define and initialize a flag object
| flg | name of a pointer to flag object |
| ... | init: (optional) initial value of flag; default: 0 |
| #define static_FLG | ( | flg, | |
| ... ) |
static alias of OS_FLG()
| #define FLG_INIT | ( | ... | ) |
create and initialize a flag object
| ... | init: (optional) initial value of flag; default: 0 |
| #define FLG_CREATE | ( | ... | ) |
| void flg_init | ( | flg_t * | flg, |
| unsigned | init ) |
initialize a flag object
| flg | pointer to flag object |
| init | initial value of flag |
| flg_t * flg_create | ( | unsigned | init | ) |
create and initialize a new flag object
| init | initial value of flag |
| NULL | object not created (not enough free memory) |
| void flg_reset | ( | flg_t * | flg | ) |
reset the flag object and wake up all waiting tasks with 'E_STOPPED' event value
| flg | pointer to flag object |
| void flg_destroy | ( | flg_t * | flg | ) |
reset the flag object, wake up all waiting tasks with 'E_DELETED' event value and free allocated resource
| flg | pointer to flag object |
| unsigned flg_take | ( | flg_t * | flg, |
| unsigned | flags, | ||
| unsigned | mode ) |
check if required flags have been set in the flag object
| flg | pointer to flag object |
| flags | all flags to wait |
| mode | waiting mode
|
| 0 | required flags have been set |
| another | value remaining flags, try again |
| int flg_waitFor | ( | flg_t * | flg, |
| unsigned | flags, | ||
| unsigned | mode, | ||
| cnt_t | delay ) |
wait on flag object for given flags for given duration of time
| flg | pointer to flag object |
| flags | all flags to wait |
| mode | waiting mode
|
| delay | duration of time (maximum number of ticks to wait on flag object for given flags)
|
| E_SUCCESS | required flags have been set |
| E_STOPPED | flag object was reseted before the specified timeout expired |
| E_DELETED | flag object was deleted before the specified timeout expired |
| E_TIMEOUT | required flags have not been set before the specified timeout expired |
| int flg_waitUntil | ( | flg_t * | flg, |
| unsigned | flags, | ||
| unsigned | mode, | ||
| cnt_t | time ) |
wait on flag object for given flags until given timepoint
| flg | pointer to flag object |
| flags | all flags to wait |
| mode | waiting mode
|
| time | timepoint value |
| E_SUCCESS | required flags have been set |
| E_STOPPED | flag object was reseted before the specified timeout expired |
| E_DELETED | flag object was deleted before the specified timeout expired |
| E_TIMEOUT | required flags have not been set before the specified timeout expired |
|
inline |
wait indefinitely on flag object until required flags have been set
| flg | pointer to flag object |
| flags | all flags to wait |
| mode | waiting mode
|
| E_SUCCESS | required flags have been set |
| E_STOPPED | flag object was reseted |
| E_DELETED | flag object was deleted |
| unsigned flg_give | ( | flg_t * | flg, |
| unsigned | flags ) |
set given flags in flag object
| flg | pointer to flag object |
| flags | all flags to set |
| unsigned flg_clear | ( | flg_t * | flg, |
| unsigned | flags ) |
clear given flags in flag object
| flg | pointer to flag object |
| flags | all flags to clear |
| unsigned flg_get | ( | flg_t * | flg | ) |
get current flags from flag object
| flg | pointer to flag object |