WL865E4-P  36.07.001
m2mb_os_tmr.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
25 #ifndef M2MB_OS_TMR_H
26 #define M2MB_OS_TMR_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
41 /*-----------------------------------------------------------------------------------------------*/
42 
47 /*-----------------------------------------------------------------------------------------------*/
48 /* Global declarations ==========================================================================*/
49 
50 #define M2MB_OS_TMR_INVALID 0
51 #define M2MB_OS_TMR_INVALID_ATTR 0
53 #define M2MB_OS_TMR_ONESHOT 0x01
54 #define M2MB_OS_TMR_PERIODIC_TMR 0x02
56 #define M2MB_OS_TMR_NO_AUTO_START 0x04
57 #define M2MB_OS_TMR_AUTO_START 0x08
59 #define M2MB_OS_TMR_OBJ_SIZE_BYTES 128
61 /* Global typedefs --------------------------------------------------------------- */
62 
70 typedef VOID ( *M2MB_OS_TMR_CB_T )( VOID * );
71 
72 
80 typedef UINT32 M2MB_OS_TIME_T;
81 
89 typedef HANDLE M2MB_OS_TMR_HANDLE;
90 
98 typedef HANDLE M2MB_OS_TMR_ATTR_HANDLE;
99 
107 typedef enum
108 {
109  M2MB_OS_TIME_TICK,
110  M2MB_OS_TIME_MSEC,
111  M2MB_OS_TIME_NONE = 0x7FFFFFF
112 }M2MB_OS_TIME_UNIT_T;
113 
121 typedef enum
122 {
123  M2MB_OS_TMR_SEL_CMD_CREATE_ATTR,
124  M2MB_OS_TMR_SEL_CMD_DEL_ATTR,
125  M2MB_OS_TMR_SEL_CMD_NAME,
126  M2MB_OS_TMR_SEL_CMD_USRNAME,
128  M2MB_OS_TMR_SEL_CMD_CB_FUNC,
129  M2MB_OS_TMR_SEL_CMD_ARG_CB,
130  M2MB_OS_TMR_SEL_CMD_TICKS_PERIOD,
131  M2MB_OS_TMR_SEL_CMD_TICKS2ELAPSE,
132  M2MB_OS_TMR_SEL_CMD_PERIODIC,
133  M2MB_OS_TMR_SEL_CMD_DURATION,
134  M2MB_OS_TMR_SEL_CMD_RELOAD,
135  M2MB_OS_TMR_SEL_CMD_AUTOSTART,
136  M2MB_OS_TMR_SEL_CMD_STATE,
137  M2MB_OS_TMR_SEL_CMD_OPTION,
138  M2MB_OS_TMR_SEL_CMD_EVENT_HANDLE,
139  M2MB_OS_TMR_SEL_CMD_EVENT_MASK,
141  /* ---- */
142  M2MB_OS_TMR_SEL_CMD_END,
143  ENUM_TO_INT( M2MB_OS_TMR_SEL_CMD_E )
144 } M2MB_OS_TMR_SEL_CMD_E;
145 
154 typedef struct M2MB_OS_TMR_EVENT_INFO
155 {
156  M2MB_OS_EV_HANDLE event;
157  UINT32 mask;
158 }M2MB_OS_TMR_EVENT_INFO_T;
159 
168 typedef struct M2MB_OS_TMR_CB_INFO
169 {
170  M2MB_OS_TMR_CB_T cbfunc;
171  VOID *cbctxt;
172 }M2MB_OS_TMR_CB_INFO_T;
173 
181 typedef struct M2MB_OS_TMR_NOTIFY_INFO
182 {
183  UINT32 timer_notify_type;
184  union
185  {
186  M2MB_OS_TMR_EVENT_INFO_T ev_obj;
187  M2MB_OS_TMR_CB_INFO_T cb_obj;
188  }notify_option;
189 }M2MB_OS_TMR_NOTIFY_INFO_T;
190 
199 typedef struct M2MB_OS_TMR_ATTR
200 {
201  UINT32 duration;
202  UINT32 reload;
203  UINT32 remaining;
204  UINT32 option;
205  M2MB_OS_TMR_NOTIFY_INFO_T notify_info;
206 }M2MB_OS_TMR_ATTR_T;
207 
208 /* Global functions =============================================================================*/
209 
210 /*-----------------------------------------------------------------------------------------------*/
306 /*-----------------------------------------------------------------------------------------------*/
307 M2MB_OS_RESULT_E m2mb_os_tmr_init( M2MB_OS_TMR_HANDLE *pTmrHandle,
308  M2MB_OS_TMR_ATTR_HANDLE *pTmrAttr );
309 
310 /*-----------------------------------------------------------------------------------------------*/
348 /*-----------------------------------------------------------------------------------------------*/
349 M2MB_OS_RESULT_E m2mb_os_tmr_deinit( M2MB_OS_TMR_HANDLE tmrHandle );
350 
351 /*-----------------------------------------------------------------------------------------------*/
389 /*-----------------------------------------------------------------------------------------------*/
390 M2MB_OS_RESULT_E m2mb_os_tmr_start( M2MB_OS_TMR_HANDLE tmrHandle );
391 
392 /*-----------------------------------------------------------------------------------------------*/
439 /*-----------------------------------------------------------------------------------------------*/
440 M2MB_OS_RESULT_E m2mb_os_tmr_change( M2MB_OS_TMR_HANDLE tmrHandle, UINT32 initial_ticks,
441  UINT32 reschedule_ticks );
442 
443 /*-----------------------------------------------------------------------------------------------*/
475 /*-----------------------------------------------------------------------------------------------*/
476 M2MB_OS_RESULT_E m2mb_os_tmr_stop( M2MB_OS_TMR_HANDLE tmrHandle );
477 
478 /*-----------------------------------------------------------------------------------------------*/
580 /*-----------------------------------------------------------------------------------------------*/
581 M2MB_OS_RESULT_E m2mb_os_tmr_setAttrItem( M2MB_OS_TMR_ATTR_HANDLE *pTmrAttrHandle,
582  UINT8 nCmds,
583  ...
584 );
585 
586 /*-----------------------------------------------------------------------------------------------*/
655 /*-----------------------------------------------------------------------------------------------*/
656 M2MB_OS_RESULT_E m2mb_os_tmr_getItem( M2MB_OS_TMR_HANDLE tmrHandle, M2MB_OS_TMR_SEL_CMD_E selCmd,
657  MEM_W *pOut,
658  VOID *pIn
659 );
660 
661 /*-----------------------------------------------------------------------------------------------*/
721 /*-----------------------------------------------------------------------------------------------*/
722 M2MB_OS_RESULT_E m2mb_os_tmr_setItem( M2MB_OS_TMR_HANDLE tmrHandle, M2MB_OS_TMR_SEL_CMD_E selCmd,
723  VOID *pIn
724 );
725 
726 /*-----------------------------------------------------------------------------------------------*/
759 /*-----------------------------------------------------------------------------------------------*/
760 M2MB_OS_TIME_T m2mb_os_tmr_convert_time_to_ticks(M2MB_OS_TIME_T time, M2MB_OS_TIME_UNIT_T unit_of_time );
761 
762 /*-----------------------------------------------------------------------------------------------*/
795 /*-----------------------------------------------------------------------------------------------*/
796 M2MB_OS_TIME_T m2mb_os_tmr_convert_ticks_to_time(M2MB_OS_TIME_T ticks, M2MB_OS_TIME_UNIT_T time_unit);
797 
798 /*-----------------------------------------------------------------------------------------------*/
827 /*-----------------------------------------------------------------------------------------------*/
828 M2MB_OS_TIME_T m2mb_os_tmr_get_ticks (VOID);
829 
833 /*-----------------------------------------------------------------------------------------------*/
834 
835 #ifdef __cplusplus
836 }
837 #endif
838 #endif /* M2MB_OS_TMR_H */
UINT8
unsigned char UINT8
Definition: m2mb_types.h:83
M2MB_OS_TIME_UNIT_T
M2MB_OS_TIME_UNIT_T
Timer unit enumeration.
Definition: m2mb_os_tmr.h:107
M2MB_OS_TMR_EVENT_INFO
Timer event information structure.
Definition: m2mb_os_tmr.h:154
M2MB_OS_TMR_SEL_CMD_E
M2MB_OS_TMR_SEL_CMD_E
Timer attribute enumeration.
Definition: m2mb_os_tmr.h:121
m2mb_os_tmr_setItem
M2MB_OS_RESULT_E m2mb_os_tmr_setItem(M2MB_OS_TMR_HANDLE tmrHandle, M2MB_OS_TMR_SEL_CMD_E selCmd, VOID *pIn)
Set specific properties of the timer.
m2mb_os_tmr_get_ticks
M2MB_OS_TIME_T m2mb_os_tmr_get_ticks(VOID)
Gets the current timer ticks.
M2MB_OS_TMR_NOTIFY_INFO::cb_obj
M2MB_OS_TMR_CB_INFO_T cb_obj
Definition: m2mb_os_tmr.h:187
m2mb_os_tmr_setAttrItem
M2MB_OS_RESULT_E m2mb_os_tmr_setAttrItem(M2MB_OS_TMR_ATTR_HANDLE *pTmrAttrHandle, UINT8 nCmds,...)
Set specific attribute for timer creation.
m2mb_os_tmr_change
M2MB_OS_RESULT_E m2mb_os_tmr_change(M2MB_OS_TMR_HANDLE tmrHandle, UINT32 initial_ticks, UINT32 reschedule_ticks)
Change application timer.
M2MB_OS_TMR_NOTIFY_INFO
Timer notify information structure.
Definition: m2mb_os_tmr.h:181
m2mb_os_tmr_convert_time_to_ticks
M2MB_OS_TIME_T m2mb_os_tmr_convert_time_to_ticks(M2MB_OS_TIME_T time, M2MB_OS_TIME_UNIT_T unit_of_time)
Convertion time to ticks.
m2mb_os_tmr_getItem
M2MB_OS_RESULT_E m2mb_os_tmr_getItem(M2MB_OS_TMR_HANDLE tmrHandle, M2MB_OS_TMR_SEL_CMD_E selCmd, MEM_W *pOut, VOID *pIn)
Get specific properties of the timer.
M2MB_OS_TMR_NOTIFY_INFO::ev_obj
M2MB_OS_TMR_EVENT_INFO_T ev_obj
Definition: m2mb_os_tmr.h:186
M2MB_OS_TMR_NOTIFY_INFO::notify_option
union M2MB_OS_TMR_NOTIFY_INFO::@6 notify_option
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:85
m2mb_os_tmr_start
M2MB_OS_RESULT_E m2mb_os_tmr_start(M2MB_OS_TMR_HANDLE tmrHandle)
Start application timer.
M2MB_OS_TMR_ATTR
Timer attiribute structure.
Definition: m2mb_os_tmr.h:199
M2MB_OS_TMR_ATTR::notify_info
M2MB_OS_TMR_NOTIFY_INFO_T notify_info
Definition: m2mb_os_tmr.h:205
M2MB_OS_TMR_ATTR_HANDLE
HANDLE M2MB_OS_TMR_ATTR_HANDLE
OS timer attribute handle declaration.
Definition: m2mb_os_tmr.h:98
VOID
void VOID
Definition: m2mb_types.h:72
MEM_W
UINT32 MEM_W
Definition: m2mb_types.h:91
M2MB_OS_TMR_HANDLE
HANDLE M2MB_OS_TMR_HANDLE
OS timer handle declaration.
Definition: m2mb_os_tmr.h:89
M2MB_OS_RESULT_E
enum M2MB_OS_RESULT M2MB_OS_RESULT_E
m2mb_os_tmr_init
M2MB_OS_RESULT_E m2mb_os_tmr_init(M2MB_OS_TMR_HANDLE *pTmrHandle, M2MB_OS_TMR_ATTR_HANDLE *pTmrAttr)
Application timer Creation.
HANDLE
void * HANDLE
Definition: m2mb_types.h:95
M2MB_OS_TMR_CB_T
VOID(* M2MB_OS_TMR_CB_T)(VOID *)
OS timer callback declaration.
Definition: m2mb_os_tmr.h:70
m2mb_os_tmr_deinit
M2MB_OS_RESULT_E m2mb_os_tmr_deinit(M2MB_OS_TMR_HANDLE tmrHandle)
Timer deinit => deletion.
M2MB_OS_TMR_EVENT_INFO_T
struct M2MB_OS_TMR_EVENT_INFO M2MB_OS_TMR_EVENT_INFO_T
Timer event information structure.
M2MB_OS_TMR_CB_INFO::cbfunc
M2MB_OS_TMR_CB_T cbfunc
Definition: m2mb_os_tmr.h:170
M2MB_OS_TMR_ATTR_T
struct M2MB_OS_TMR_ATTR M2MB_OS_TMR_ATTR_T
Timer attiribute structure.
m2mb_os_tmr_stop
M2MB_OS_RESULT_E m2mb_os_tmr_stop(M2MB_OS_TMR_HANDLE tmrHandle)
Stop an application timer.
M2MB_OS_TMR_NOTIFY_INFO_T
struct M2MB_OS_TMR_NOTIFY_INFO M2MB_OS_TMR_NOTIFY_INFO_T
Timer notify information structure.
M2MB_OS_TMR_EVENT_INFO::event
M2MB_OS_EV_HANDLE event
Definition: m2mb_os_tmr.h:156
M2MB_OS_TMR_CB_INFO_T
struct M2MB_OS_TMR_CB_INFO M2MB_OS_TMR_CB_INFO_T
Timer callback information structure.
m2mb_os_tmr_convert_ticks_to_time
M2MB_OS_TIME_T m2mb_os_tmr_convert_ticks_to_time(M2MB_OS_TIME_T ticks, M2MB_OS_TIME_UNIT_T time_unit)
Convertion ticks to time.
M2MB_OS_TIME_T
UINT32 M2MB_OS_TIME_T
OS Time type declaration.
Definition: m2mb_os_tmr.h:80
M2MB_OS_EV_HANDLE
HANDLE M2MB_OS_EV_HANDLE
Definition: m2mb_os_ev.h:103
M2MB_OS_TMR_CB_INFO
Timer callback information structure.
Definition: m2mb_os_tmr.h:168
ENUM_TO_INT
#define ENUM_TO_INT(Prefix)
Definition: m2mb_types.h:198