WE310F5  39.00.000
m2mb_os_mtx.h File Reference

OS mutex prototypes. More...

Go to the source code of this file.

#define M2MB_OS_MTX_INVALID   0
 
#define M2MB_OS_MTX_INVALID_ATTR   0
 
#define m2mb_os_mtx_setAttrItem_(h, args, ...)   m2mb_os_mtx_setAttrItem( h, CMDS_ARGS( args ) )
 
enum  M2MB_OS_MTX_SEL_CMD_E {
  M2MB_OS_MTX_SEL_CMD_CREATE_ATTR,
  M2MB_OS_MTX_SEL_CMD_DEL_ATTR,
  M2MB_OS_MTX_SEL_CMD_NAME,
  M2MB_OS_MTX_SEL_CMD_USRNAME,
  M2MB_OS_MTX_SEL_CMD_INHERIT,
  M2MB_OS_MTX_SEL_CMD_HPTF_NO_SUPPORT,
  M2MB_OS_MTX_SEL_CMD_COUNT,
  M2MB_OS_MTX_SEL_CMD_SUSPENDED_COUNT,
  M2MB_OS_MTX_SEL_CMD_1ST_SUSP,
  M2MB_OS_MTX_SEL_CMD_OWNER,
  M2MB_OS_MTX_SEL_CMD_END
}
 
typedef struct M2MB_OS_MTX_HANDLE_TAG * M2MB_OS_MTX_HANDLE
 
typedef struct M2MB_OS_MTX_ATTR_HANDLE_TAG * M2MB_OS_MTX_ATTR_HANDLE
 
M2MB_OS_RESULT_E m2mb_os_mtx_init (M2MB_OS_MTX_HANDLE *pMtxHandle, M2MB_OS_MTX_ATTR_HANDLE *pMtxAttr)
 Mutex Creation. More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_deinit (M2MB_OS_MTX_HANDLE mtxHandle)
 Mutex deinit or deletion. More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_get (M2MB_OS_MTX_HANDLE mtxHandle, UINT32 timeoutTicks)
 Get the ownership of the mutex (critical session enter) More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_put (M2MB_OS_MTX_HANDLE mtxHandle)
 Release ownership of the mutex (if counter = 0: exit critical section) More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_hptf (M2MB_OS_MTX_HANDLE mtxHandle)
 Prioritize mutex suspension list HPTF: Highest Priority Task First. More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_setAttrItem (M2MB_OS_MTX_ATTR_HANDLE *pMtxAttrHandle, UINT8 nCmds,...)
 Set specific attribute for mutex creation. More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_getItem (M2MB_OS_MTX_HANDLE mtxHandle, M2MB_OS_MTX_SEL_CMD_E selCmd, MEM_W *pOut, void *pIn)
 Get specific properties of the mutex. More...
 
M2MB_OS_RESULT_E m2mb_os_mtx_setItem (M2MB_OS_MTX_HANDLE mtxHandle, M2MB_OS_MTX_SEL_CMD_E selCmd, void *pIn)
 Set specific properties of the mutex. More...
 

Detailed Description

OS mutex prototypes.

we866e4/epl/inc/rtos/m2mb_os_mtx.h

Basic functions for OS mutex are provided

Note
Dependencies:
"#include m2mb_types.h"
"#include m2mb_os_types.h"
Author
<Alessandro papagno>="">
Date
03/03/2017

Definition in file m2mb_os_mtx.h.