m2mb_sntp.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2MB_SNTP_API_H
#define  M2MB_SNTP_API_H
#ifdef __cplusplus
extern "C" {
#endif

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

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

#define M2MB_SNTP_DEFAULT_SERVER        "pool.ntp.org"

#define M2MB_SNTP_SERVER_NAME_SIZE      68

#define M2MB_SNTP_SERVER_MAX            2

#define M2MB_IP_ADDR_STR_LEN     48

#define M2MB_SNTP_SYNC_DONE 0x0010

/* Global typedefs ==============================================================================*/
typedef enum M2MB_SNTP_SERVER_STATUS
{
    M2MB_SNTP_SERVER_STATUS_KOD     = 1,    
    M2MB_SNTP_SERVER_STATUS_NORESP  = 2     
}M2MB_SNTP_SERVER_STATUS_E;

typedef enum M2MB_SNTP_SERVER_ID
{
    M2MB_SNTP_SERVER_ID_PRIMARY,    
    M2MB_SNTP_SERVER_ID_SECONDARY   
}M2MB_SNTP_SERVER_ID_E;

typedef enum
{
        M2MB_SNTPC_EVENT_INIT,                                  
        M2MB_SNTPC_EVENT_INCORRECT_SVR_TYPE,    
        M2MB_SNTPC_EVENT_SYSTEM_SYNC_DONE,              
        M2MB_SNTPC_EVENT_SERVER_DELETED,        
    M2MB_SNTPC_EVENT_SERVER_ADDED,          
    M2MB_SNTPC_EVENT_SYNC_FAIL,             
}M2MB_SNTPC_EVENTS_ID_E;

typedef enum M2MB_SNTP_CONF_ID
{
    M2MB_SNTP_CONF_INVALID                  = 0,        
    M2MB_SNTP_CONF_SET_SRV_ADD              = 1, 
    M2MB_SNTP_CONF_SET_SRV_DEL              = 2, 
    M2MB_SNTP_CONF_GET_IS_STARTED           = 4, 
    M2MB_SNTP_CONF_GET_TIME                 = 5, 
    M2MB_SNTP_CONF_GET_SERVER_LIST          = 6, 
}M2MB_SNTP_CONF_ID_E;

typedef struct M2MB_SNTP_SERVER_ENTRY
{
    UINT8   name[M2MB_SNTP_SERVER_NAME_SIZE];   
    UINT8   addr[M2MB_IP_ADDR_STR_LEN];                 
    UINT32  status;                                                     
} M2MB_SNTP_SERVER_ENTRY_T;

typedef struct M2MB_SNTP_SERVER_LIST
{
    M2MB_SNTP_SERVER_ENTRY_T server[M2MB_SNTP_SERVER_MAX];
} M2MB_SNTP_SERVER_LIST_T;

typedef struct M2MB_SNTP_TM
{
        UINT16  tm_sec;         
        UINT16  tm_min;         
        UINT16  tm_hour;        
        UINT16  tm_mday;        
        UINT16  tm_mon;         
        UINT16  tm_year;        
        UINT16  tm_wday;        
        UINT16  tm_yday;        
        UINT16  tm_isdst;       
} M2MB_SNTP_TM_T;


/****************************************************************************************/
typedef void (* M2MB_SNTPC_APP_CB_T)( VOID *sntpc_ctx, UINT32 event, VOID *uData );

typedef struct M2MB_SNTP_SRV_ADD_INFO
{
    UINT8* ipAddr;
    M2MB_SNTP_SERVER_ID_E serverID;
}M2MB_SNTP_SRV_ADD_INFO_T;

typedef struct M2MB_SNTP_INIT_PARAMS
{
    M2MB_SNTPC_APP_CB_T user_cb;  
    void *user_ctx;               
    UINT32 poll_interval;         
}M2MB_SNTP_INIT_PARAMS_T;

typedef union 
{
    UINT32 sntp_status;                              
    M2MB_SNTP_SRV_ADD_INFO_T *srv_info;              
    M2MB_SNTP_SERVER_ID_E serverID;                  
    M2MB_SNTP_TM_T *tm;                              
    M2MB_SNTP_SERVER_LIST_T *get_srv_list;           
} M2MB_SNTP_CONF_PARAMS_T;

/****************************************************************************************/

/* Global functions =========================================================*/
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_init(HANDLE *handle, M2MB_SNTP_INIT_PARAMS_T * init_params);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_deinit( HANDLE handle );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_set_cfg( HANDLE handle, M2MB_SNTP_CONF_ID_E conf_id, M2MB_SNTP_CONF_PARAMS_T * conf_params);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_get_cfg( HANDLE handle, M2MB_SNTP_CONF_ID_E conf_id, M2MB_SNTP_CONF_PARAMS_T * conf_params);

/*-----------------------------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_start( HANDLE handle );
    
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_sntp_update( HANDLE handle );


#ifdef __cplusplus
}
#endif
#endif