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_SYSTEM_RTC_SET,                  
        M2MB_SNTPC_EVENT_SYSTEM_RTC_NOT_SET,      
}M2MB_SNTPC_RTC_STATUS_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_EVENTS_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
{
    UINT32  tm_sec;     
    UINT32  tm_min;     
    UINT32  tm_hour;    
    UINT32  tm_mday;    
    UINT32  tm_mon;     
    UINT32  tm_year;    
    UINT32  tm_wday;    
    UINT32  tm_yday;    
    UINT32  tm_isdst;   
} M2MB_SNTP_TM_T;

/****************************************************************************************/
typedef void (* M2MB_SNTPC_APP_CB_t)( void *sntpc_ctx, uint32_t event, void *uData );

/* Global functions =========================================================*/
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_init(M2MB_SNTPC_APP_CB_t user_cb, void *user_ctx, uint32_t poll_interval);

/*-----------------------------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_sntp_start( VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_sntp_is_started( VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_sntp_deinit( VOID );

/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_svr_add( M2MB_SNTP_SERVER_ID_E serverID, UINT8* name );

/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_svr_delete( M2MB_SNTP_SERVER_ID_E serverID );
    
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_update( VOID );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_get_time( M2MB_SNTP_TM_T *tm );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_sntp_get_server_list(M2MB_SNTP_SERVER_LIST_T *svr_List);

#ifdef __cplusplus
}
#endif
#endif