m2mb_os_tmr.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2MB_OS_TMR_H
#define M2MB_OS_TMR_H

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/

#define  M2MB_OS_TMR_INVALID        0       
#define  M2MB_OS_TMR_INVALID_ATTR   0       
#define  M2MB_OS_TMR_ONESHOT        0x01    
#define  M2MB_OS_TMR_PERIODIC_TMR   0x02    
#define M2MB_OS_TMR_NO_AUTO_START   0x04    
#define M2MB_OS_TMR_AUTO_START      0x08    
#define M2MB_OS_TMR_OBJ_SIZE_BYTES  128     
/* Global typedefs --------------------------------------------------------------- */

typedef UINT32 M2MB_OS_TIME_T;

typedef HANDLE M2MB_OS_TMR_HANDLE;

typedef HANDLE M2MB_OS_TMR_ATTR_HANDLE;

typedef enum 
{
  M2MB_OS_TIME_TICK,                    
  M2MB_OS_TIME_MSEC,                    
  M2MB_OS_TIME_NONE = 0x7FFFFFF         
}M2MB_OS_TIME_UNIT_T;

typedef enum
{
  M2MB_OS_TMR_SEL_CMD_CREATE_ATTR,  
  M2MB_OS_TMR_SEL_CMD_DEL_ATTR,     
  M2MB_OS_TMR_SEL_CMD_NAME,         
  M2MB_OS_TMR_SEL_CMD_USRNAME,      
  M2MB_OS_TMR_SEL_CMD_CB_FUNC,      
  M2MB_OS_TMR_SEL_CMD_ARG_CB,       
  M2MB_OS_TMR_SEL_CMD_TICKS_PERIOD, 
  M2MB_OS_TMR_SEL_CMD_TICKS2ELAPSE, 
  M2MB_OS_TMR_SEL_CMD_PERIODIC,     
  M2MB_OS_TMR_SEL_CMD_DURATION,     
  M2MB_OS_TMR_SEL_CMD_RELOAD,       
  M2MB_OS_TMR_SEL_CMD_AUTOSTART,    
  M2MB_OS_TMR_SEL_CMD_STATE,        
  M2MB_OS_TMR_SEL_CMD_OPTION,       
  M2MB_OS_TMR_SEL_CMD_EVENT_HANDLE, 
  M2MB_OS_TMR_SEL_CMD_EVENT_MASK,   
  /* ---- */
  M2MB_OS_TMR_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_TMR_SEL_CMD_E )
} M2MB_OS_TMR_SEL_CMD_E;

typedef struct M2MB_OS_TMR_EVENT_INFO 
{
  M2MB_OS_EV_HANDLE event;  
  UINT32 mask;              
}M2MB_OS_TMR_EVENT_INFO_T;

typedef VOID(*M2MB_OS_TMR_CB_T)(VOID *);
typedef void(*USR_TMR_CB)(M2MB_OS_TMR_HANDLE handle, void *arg);

typedef struct M2MB_OS_TMR_CB_INFO 
{
  M2MB_OS_TMR_CB_T cbfunc;  
  VOID *cbctxt;             
}M2MB_OS_TMR_CB_INFO_T;

typedef struct M2MB_OS_TMR_NOTIFY_INFO
{
  UINT32 timer_notify_type; 
  union
  {
    M2MB_OS_TMR_EVENT_INFO_T ev_obj;  
    M2MB_OS_TMR_CB_INFO_T cb_obj;     
  }notify_option;
}M2MB_OS_TMR_NOTIFY_INFO_T; 


/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_init( M2MB_OS_TMR_HANDLE *pTmrHandle, 
  M2MB_OS_TMR_ATTR_HANDLE *pTmrAttr );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_deinit( M2MB_OS_TMR_HANDLE tmrHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_start( M2MB_OS_TMR_HANDLE tmrHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_change( M2MB_OS_TMR_HANDLE tmrHandle, UINT32 initial_ticks,
    UINT32 reschedule_ticks );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_stop( M2MB_OS_TMR_HANDLE tmrHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_setAttrItem( M2MB_OS_TMR_ATTR_HANDLE *pTmrAttrHandle,
  UINT8 nCmds,
  ...
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
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
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_tmr_setItem( M2MB_OS_TMR_HANDLE tmrHandle, M2MB_OS_TMR_SEL_CMD_E selCmd,
  VOID *pIn
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_TIME_T m2mb_os_tmr_convert_time_to_ticks(M2MB_OS_TIME_T time, M2MB_OS_TIME_UNIT_T unit_of_time );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_TIME_T m2mb_os_tmr_convert_ticks_to_time(M2MB_OS_TIME_T ticks, M2MB_OS_TIME_UNIT_T time_unit);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_TIME_T m2mb_os_tmr_get_ticks (VOID);

/*-----------------------------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif /* M2MB_OS_TMR_H */