|
StateOS
|
semaphores (binary, limited, counting) More...
Macros | |
| #define | semDirect ( 0U ) |
| direct semaphore (producer can't free the semaphore, it can post the semaphore only to the pending task) | |
| #define | semBinary ( 1U ) |
| binary semaphore | |
| #define | semCounting ( 0U-1 ) |
| counting semaphore | |
| #define | semDefault semCounting |
| default semaphore type | |
| #define | OS_SEM(sem, init, ...) |
| define and initialize a semaphore object | |
| #define | static_SEM(sem, init, ...) |
| static alias of OS_SEM() | |
| #define | SEM_INIT(init, ...) |
| create and initialize a semaphore object | |
| #define | SEM_CREATE(init, ...) |
| create and initialize a semaphore object | |
| #define | SEM_NEW SEM_CREATE |
| alias of SEM_CREATE() | |
Functions | |
| void | sem_init (sem_t *sem, unsigned init, unsigned limit) |
| initialize a semaphore object | |
| sem_t * | sem_create (unsigned init, unsigned limit) |
| create and initialize a new semaphore object | |
| sem_t * | sem_new (unsigned init, unsigned limit) |
| alias of sem_create() | |
| void | sem_reset (sem_t *sem) |
| reset the semaphore object and wake up all waiting tasks with 'E_STOPPED' event value | |
| void | sem_kill (sem_t *sem) |
| alias of sem_reset() | |
| void | sem_destroy (sem_t *sem) |
| reset the semaphore object, wake up all waiting tasks with 'E_DELETED' event value and free allocated resource | |
| void | sem_delete (sem_t *sem) |
| alias of sem_destroy() | |
| int | sem_take (sem_t *sem) |
| try to lock the semaphore object, don't wait if the semaphore object can't be locked immediately | |
| int | sem_tryWait (sem_t *sem) |
| alias of sem_take() | |
| int | sem_takeISR (sem_t *sem) |
| ISR alias of sem_take(). | |
| int | sem_takeAsync (sem_t *sem) |
| Async alias of sem_take(). | |
| int | sem_waitFor (sem_t *sem, cnt_t delay) |
| try to lock the semaphore object, wait for given duration of time if the semaphore object can't be locked immediately | |
| int | sem_waitUntil (sem_t *sem, cnt_t time) |
| try to lock the semaphore object, wait until given timepoint if the semaphore object can't be locked immediately | |
| int | sem_wait (sem_t *sem) |
| try to lock the semaphore object, wait indefinitely if the semaphore object can't be locked immediately | |
| int | sem_waitAsync (sem_t *sem) |
| Async alias of sem_wait(). | |
| int | sem_give (sem_t *sem) |
| try to unlock the semaphore object, don't wait if the semaphore object can't be unlocked immediately | |
| int | sem_post (sem_t *sem) |
| alias of sem_give() | |
| int | sem_giveISR (sem_t *sem) |
| ISR alias of sem_give(). | |
| int | sem_giveAsync (sem_t *sem) |
| Async alias of sem_give(). | |
| int | sem_release (sem_t *sem, unsigned num) |
| try to increment the internal semaphore counter by the value of num | |
| int | sem_releaseISR (sem_t *sem, unsigned num) |
| ISR alias of sem_release(). | |
| unsigned | sem_getValue (sem_t *sem) |
| return current value of semaphore | |
semaphores (binary, limited, counting)
| #define OS_SEM | ( | sem, | |
| init, | |||
| ... ) |
define and initialize a semaphore object
| sem | name of a pointer to semaphore object |
| init | initial value of semaphore counter |
| ... | limit: (optional) maximum value of semaphore counter
|
| #define static_SEM | ( | sem, | |
| init, | |||
| ... ) |
static alias of OS_SEM()
| #define SEM_INIT | ( | init, | |
| ... ) |
create and initialize a semaphore object
| init | initial value of semaphore counter |
| ... | limit: (optional) maximum value of semaphore counter
|
| #define SEM_CREATE | ( | init, | |
| ... ) |
create and initialize a semaphore object
| init | initial value of semaphore counter |
| ... | limit: (optional) maximum value of semaphore counter
|
| void sem_init | ( | sem_t * | sem, |
| unsigned | init, | ||
| unsigned | limit ) |
initialize a semaphore object
| sem | pointer to semaphore object |
| init | initial value of semaphore counter |
| limit | maximum value of semaphore counter
|
| sem_t * sem_create | ( | unsigned | init, |
| unsigned | limit ) |
create and initialize a new semaphore object
| init | initial value of semaphore counter |
| limit | maximum value of semaphore counter
|
| NULL | object not created (not enough free memory) |
| void sem_reset | ( | sem_t * | sem | ) |
reset the semaphore object and wake up all waiting tasks with 'E_STOPPED' event value
| sem | pointer to semaphore object |
| void sem_destroy | ( | sem_t * | sem | ) |
reset the semaphore object, wake up all waiting tasks with 'E_DELETED' event value and free allocated resource
| sem | pointer to semaphore object |
| int sem_take | ( | sem_t * | sem | ) |
try to lock the semaphore object, don't wait if the semaphore object can't be locked immediately
| sem | pointer to semaphore object |
| E_SUCCESS | semaphore object was successfully locked |
| E_TIMEOUT | semaphore object can't be locked immediately, try again |
| int sem_waitFor | ( | sem_t * | sem, |
| cnt_t | delay ) |
try to lock the semaphore object, wait for given duration of time if the semaphore object can't be locked immediately
| sem | pointer to semaphore object |
| delay | duration of time (maximum number of ticks to wait for lock the semaphore object)
|
| E_SUCCESS | semaphore object was successfully locked |
| E_STOPPED | semaphore object was reseted before the specified timeout expired |
| E_DELETED | semaphore object was deleted before the specified timeout expired |
| E_TIMEOUT | semaphore object was not locked before the specified timeout expired |
| int sem_waitUntil | ( | sem_t * | sem, |
| cnt_t | time ) |
try to lock the semaphore object, wait until given timepoint if the semaphore object can't be locked immediately
| sem | pointer to semaphore object |
| time | timepoint value |
| E_SUCCESS | semaphore object was successfully locked |
| E_STOPPED | semaphore object was reseted before the specified timeout expired |
| E_DELETED | semaphore object was deleted before the specified timeout expired |
| E_TIMEOUT | semaphore object was not locked before the specified timeout expired |
|
inline |
try to lock the semaphore object, wait indefinitely if the semaphore object can't be locked immediately
| sem | pointer to semaphore object |
| E_SUCCESS | semaphore object was successfully locked |
| E_STOPPED | semaphore object was reseted (unavailable for async version) |
| E_DELETED | semaphore object was deleted (unavailable for async version) |
| int sem_give | ( | sem_t * | sem | ) |
try to unlock the semaphore object, don't wait if the semaphore object can't be unlocked immediately
| sem | pointer to semaphore object |
| E_SUCCESS | semaphore object was successfully unlocked |
| E_TIMEOUT | semaphore object can't be unlocked immediately, try again |
| int sem_release | ( | sem_t * | sem, |
| unsigned | num ) |
try to increment the internal semaphore counter by the value of num
| sem | pointer to semaphore object |
| num | update value of semaphore counter |
| E_SUCCESS | semaphore counter was successfully updated |
| E_TIMEOUT | semaphore counter was updated to the limit value |
| unsigned sem_getValue | ( | sem_t * | sem | ) |
return current value of semaphore
| sem | pointer to semaphore object |