VSF Documented
vsf_simple_bmpevt.c File Reference

Macros

#define __VSF_EDA_CLASS_INHERIT__
 
#define this   (*this_ptr)
 

Functions

vsf_sync_reason_t __vsf_bmpevt_wait_for (vsf_bmpevt_t *bmpevt_ptr, const vsf_bmpevt_pender_t *pender_ptr, int_fast32_t time_out)
 Low-level bitmap-event wait helper backing the wait_for_one()/ wait_for_any()/wait_for_all() statement macros.
 
void __vsf_grouped_evts_init (vsf_bmpevt_t *this_ptr, vsf_bmpevt_adapter_t **adapters_pptr, uint_fast8_t adapter_count, uint_fast32_t auto_reset)
 Low-level initialization helper backing the init_grouped_evts() macro.
 

Macro Definition Documentation

◆ __VSF_EDA_CLASS_INHERIT__

#define __VSF_EDA_CLASS_INHERIT__

◆ this

#define this   (*this_ptr)

Function Documentation

◆ __vsf_bmpevt_wait_for()

vsf_sync_reason_t __vsf_bmpevt_wait_for ( vsf_bmpevt_t * bmpevt_ptr,
const vsf_bmpevt_pender_t * pender_ptr,
int_fast32_t time_out )

Low-level bitmap-event wait helper backing the wait_for_one()/ wait_for_any()/wait_for_all() statement macros.

Parameters
[in]bmpevt_ptrpointer to the group instance vsf_bmpevt_t
[in]pender_ptrpointer to the pender vsf_bmpevt_pender_t holding the mask and the operation (VSF_BMPEVT_AND/VSF_BMPEVT_OR)
[in]time_outtimeout in system timer ticks; a negative value waits forever
Returns
vsf_sync_reason_t: VSF_SYNC_GET when the wait condition is met, VSF_SYNC_TIMEOUT on timeout, VSF_SYNC_CANCEL when the wait is cancelled, VSF_SYNC_FAIL on error, otherwise VSF_SYNC_PENDING while the wait is still in progress
Note
Internal use only.

◆ __vsf_grouped_evts_init()

void __vsf_grouped_evts_init ( vsf_bmpevt_t * this_ptr,
vsf_bmpevt_adapter_t ** adapters_pptr,
uint_fast8_t adapter_count,
uint_fast32_t auto_reset )

Low-level initialization helper backing the init_grouped_evts() macro.

Parameters
[in]this_ptrpointer to the group instance vsf_bmpevt_t
[in]adapters_pptrpointer to the adapter list defined by implement_grouped_evts()
[in]adapter_countnumber of adapters in the list
[in]auto_resetmask of the event bits that are reset automatically after a successful wait
Returns
none
Note
Internal use only.
Generated from commit: vsfteam/vsf@a5104db