WL865E4-P  36.07.001
m2mb_os_sem.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
27 #ifndef M2MB_OS_SEM_H
28 #define M2MB_OS_SEM_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
43 /*-----------------------------------------------------------------------------------------------*/
44 
49 /*-----------------------------------------------------------------------------------------------*/
50 
51 /* Global declarations ==========================================================================*/
52 #define M2MB_OS_SEM_INVALID 0
53 #define M2MB_OS_SEM_INVALID_ATTR 0
54 /* Global typedefs --------------------------------------------------------------- */
55 typedef enum
56 {
57  M2MB_OS_SEM_GEN,
58  M2MB_OS_SEM_BINARY,
59  M2MB_OS_SEM_COUNTING,
61  M2MB_OS_SEM_MAX,
62  ENUM_TO_INT( M2MB_OS_SEM_TYPE_E )
63 } M2MB_OS_SEM_TYPE_E;
64 
65 typedef enum
66 {
67  M2MB_OS_SEM_SEL_CMD_CREATE_ATTR,
68  M2MB_OS_SEM_SEL_CMD_DEL_ATTR,
69 
70  M2MB_OS_SEM_SEL_CMD_NAME,
72  M2MB_OS_SEM_SEL_CMD_USRNAME,
74  M2MB_OS_SEM_SEL_CMD_TYPE,
76  M2MB_OS_SEM_SEL_CMD_MAX_COUNT,
78  M2MB_OS_SEM_SEL_CMD_HPTF,
80  M2MB_OS_SEM_SEL_CMD_COUNT,
81 
82  M2MB_OS_SEM_SEL_CMD_SUSPENDED_COUNT,
84  M2MB_OS_SEM_SEL_CMD_1ST_SUSP,
87  /* ---- */
88  M2MB_OS_SEM_SEL_CMD_END,
89  ENUM_TO_INT( M2MB_OS_SEM_SEL_CMD_E )
90 } M2MB_OS_SEM_SEL_CMD_E;
91 
92 typedef HANDLE M2MB_OS_SEM_HANDLE;
93 typedef HANDLE M2MB_OS_SEM_ATTR_HANDLE;
94 
95 
96 /* Global functions =============================================================================*/
97 
98 
99 /*-----------------------------------------------------------------------------------------------*/
162 /*-----------------------------------------------------------------------------------------------*/
163 M2MB_OS_RESULT_E m2mb_os_sem_init(
164  M2MB_OS_SEM_HANDLE *pSemHandle,
165  M2MB_OS_SEM_ATTR_HANDLE *pSemAttr
166 );
167 
168 /*-----------------------------------------------------------------------------------------------*/
208 /*-----------------------------------------------------------------------------------------------*/
209 M2MB_OS_RESULT_E m2mb_os_sem_deinit( M2MB_OS_SEM_HANDLE semHandle );
210 
211 /*-----------------------------------------------------------------------------------------------*/
262 /*-----------------------------------------------------------------------------------------------*/
263 M2MB_OS_RESULT_E m2mb_os_sem_get( M2MB_OS_SEM_HANDLE semHandle, UINT32 timeoutTicks );
264 
265 /*-----------------------------------------------------------------------------------------------*/
307 /*-----------------------------------------------------------------------------------------------*/
308 M2MB_OS_RESULT_E m2mb_os_sem_put( M2MB_OS_SEM_HANDLE semHandle );
309 
310 /*-----------------------------------------------------------------------------------------------*/
357 /*-----------------------------------------------------------------------------------------------*/
358 M2MB_OS_RESULT_E m2mb_os_sem_hptf( M2MB_OS_SEM_HANDLE semHandle );
359 
360 /*-----------------------------------------------------------------------------------------------*/
455 /*-----------------------------------------------------------------------------------------------*/
456 M2MB_OS_RESULT_E m2mb_os_sem_setAttrItem(
457  M2MB_OS_SEM_ATTR_HANDLE *pSemAttrHandle,
458  UINT8 nCmds,
459  ...
460 );
461 
462 /*-----------------------------------------------------------------------------------------------*/
532 /*-----------------------------------------------------------------------------------------------*/
533 M2MB_OS_RESULT_E m2mb_os_sem_getItem( M2MB_OS_SEM_HANDLE semHandle,
534  M2MB_OS_SEM_SEL_CMD_E selCmd,
535  MEM_W *pOut,
536  void *pIn
537  );
538 
539 /*-----------------------------------------------------------------------------------------------*/
585 /*-----------------------------------------------------------------------------------------------*/
586 M2MB_OS_RESULT_E m2mb_os_sem_setItem(
587  M2MB_OS_SEM_HANDLE semHandle,
588  M2MB_OS_SEM_SEL_CMD_E selCmd,
589  void *pIn
590 );
591 
595 /*-----------------------------------------------------------------------------------------------*/
596 
597 #ifdef __cplusplus
598 }
599 #endif
600 #endif /* M2MB_OS_SEM_H */
m2mb_os_sem_setItem
M2MB_OS_RESULT_E m2mb_os_sem_setItem(M2MB_OS_SEM_HANDLE semHandle, M2MB_OS_SEM_SEL_CMD_E selCmd, void *pIn)
Set specific semaphore properties.
UINT8
unsigned char UINT8
Definition: m2mb_types.h:83
m2mb_os_sem_put
M2MB_OS_RESULT_E m2mb_os_sem_put(M2MB_OS_SEM_HANDLE semHandle)
Place (put) an instance in semaphore.
m2mb_os_sem_setAttrItem
M2MB_OS_RESULT_E m2mb_os_sem_setAttrItem(M2MB_OS_SEM_ATTR_HANDLE *pSemAttrHandle, UINT8 nCmds,...)
Set semaphore attribute for creation.
m2mb_os_sem_hptf
M2MB_OS_RESULT_E m2mb_os_sem_hptf(M2MB_OS_SEM_HANDLE semHandle)
Prioritize semaphore suspension list HPTF: Highest Priority Task First.
M2MB_OS_SEM_TYPE_E
M2MB_OS_SEM_TYPE_E
Definition: m2mb_os_sem.h:55
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:85
M2MB_OS_SEM_SEL_CMD_E
M2MB_OS_SEM_SEL_CMD_E
Definition: m2mb_os_sem.h:65
m2mb_os_sem_get
M2MB_OS_RESULT_E m2mb_os_sem_get(M2MB_OS_SEM_HANDLE semHandle, UINT32 timeoutTicks)
Get an instance of semaphore.
M2MB_OS_SEM_ATTR_HANDLE
HANDLE M2MB_OS_SEM_ATTR_HANDLE
Definition: m2mb_os_sem.h:93
M2MB_OS_SEM_HANDLE
HANDLE M2MB_OS_SEM_HANDLE
Definition: m2mb_os_sem.h:92
m2mb_os_sem_init
M2MB_OS_RESULT_E m2mb_os_sem_init(M2MB_OS_SEM_HANDLE *pSemHandle, M2MB_OS_SEM_ATTR_HANDLE *pSemAttr)
Semaphore creation.
MEM_W
UINT32 MEM_W
Definition: m2mb_types.h:91
m2mb_os_sem_getItem
M2MB_OS_RESULT_E m2mb_os_sem_getItem(M2MB_OS_SEM_HANDLE semHandle, M2MB_OS_SEM_SEL_CMD_E selCmd, MEM_W *pOut, void *pIn)
Get specific semaphore properties.
M2MB_OS_RESULT_E
enum M2MB_OS_RESULT M2MB_OS_RESULT_E
HANDLE
void * HANDLE
Definition: m2mb_types.h:95
m2mb_os_sem_deinit
M2MB_OS_RESULT_E m2mb_os_sem_deinit(M2MB_OS_SEM_HANDLE semHandle)
Semaphore deinit or deletion.
ENUM_TO_INT
#define ENUM_TO_INT(Prefix)
Definition: m2mb_types.h:198