m2mb_os_tmr.h

Go to the documentation of this file.

/* $version: 252203  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2MB_OS_TMR_H
#define M2MB_OS_TMR_H
 
 
 
 
/* GLOBAL DECLARATIONS ----------------------------------------------------------- */
#define  M2MB_OS_TMR_INVALID            0
#define  M2MB_OS_TMR_INVALID_ATTR       0
#define  M2MB_OS_TMR_PERIODIC_TMR       1
#define  M2MB_OS_TMR_ONESHOT_TMR        0
 
 
/* Global declarations ==========================================================================*/
 
 
/*-----------------------------------------------------------------------------------------------
 
    can be called directly without specify CMDS_ARGS
    osRes = m2mb_os_tmr_setAttrItem_( &tmrAttrHandle,
                                      M2MB_OS_TMR_SEL_CMD_CREATE_ATTR,  NULL,
                                      M2MB_OS_TMR_SEL_CMD_NAME, "mytmr",
                                      M2MB_OS_TMR_SEL_CMD_USRNAME, "myUsrtmr",
                                      M2MB_OS_TMR_SEL_CMD_CB_FUNC, &timerCb,
                                      M2MB_OS_TMR_SEL_CMD_ARG_CB, &tmrHandle,
                                      M2MB_OS_TMR_SEL_CMD_TICKS_PERIOD, M2MB_OS_MS2TICKS(4000)
                                    );
  -----------------------------------------------------------------------------------------------*/
#ifdef _WIN32
#define m2mb_os_tmr_setAttrItem_( h, ... )        m2mb_os_tmr_setAttrItem( h, CMDS_ARGS( __VA_ARGS__ ) )
#else
#define m2mb_os_tmr_setAttrItem_( h, args... )        m2mb_os_tmr_setAttrItem( h, CMDS_ARGS( args ) )
#endif
 
/* Global typedefs --------------------------------------------------------------- */
 
/* available timer states */
typedef enum
{
  M2MB_TMR_STATE_TOSTART,
  M2MB_TMR_STATE_RUN,
  M2MB_TMR_STATE_STOP,
  M2MB_TMR_STATE_DELETED
} M2MB_TMR_STATE_E;
 
/* set or get commands ; not always all availbale */
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,
  /* the callback for timer elapsed */
  M2MB_OS_TMR_SEL_CMD_CB_FUNC,
  /* argument to be passed to callback */
  M2MB_OS_TMR_SEL_CMD_ARG_CB,
  /* timeout period in ticks */
  M2MB_OS_TMR_SEL_CMD_TICKS_PERIOD,
  /* period of elapsing in ticks : max is 0xFFFF FFFF ticks */
  M2MB_OS_TMR_SEL_CMD_TICKS2ELAPSE,
  /* define if it is periodic or not */
  M2MB_OS_TMR_SEL_CMD_PERIODIC,
  /* autostart, not need to call m2mb_os_tmr_start */
  M2MB_OS_TMR_SEL_CMD_AUTOSTART,
  M2MB_OS_TMR_SEL_CMD_STATE,
 
  /* ---- */
  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_HANDLE_TAG      *M2MB_OS_TMR_HANDLE;
typedef struct M2MB_OS_TMR_ATTR_HANDLE_TAG *M2MB_OS_TMR_ATTR_HANDLE;
 
 
typedef void ( *USR_TMR_CB )( M2MB_OS_TMR_HANDLE handle, void *arg );
 
 
/* 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_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
);
 
#endif /* M2MB_OS_TMR_H */