core_sntp_serializer.h

Go to the documentation of this file.

/*
 * coreSNTP v1.2.0
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef CORE_SNTP_SERIALIZER_H_
#define CORE_SNTP_SERIALIZER_H_
 
/* Standard include. */
#include <stdint.h>
#include <stddef.h>
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
#define SNTP_PACKET_BASE_SIZE                         ( 48U )
 
#define SNTP_FRACTION_VALUE_PER_MICROSECOND           ( 4295U )
 
#define SNTP_TIME_AT_UNIX_EPOCH_SECS                  ( 2208988800U )
 
#define SNTP_TIME_AT_LARGEST_UNIX_TIME_SECS           ( 61505151U )
 
#define UNIX_TIME_SECS_AT_SNTP_ERA_1_SMALLEST_TIME    ( 2085978496U )
 
#define SNTP_KISS_OF_DEATH_CODE_LENGTH                ( 4U )
 
#define SNTP_KISS_OF_DEATH_CODE_NONE                  ( 0U )
 
typedef enum SntpStatus
{
    SntpSuccess,
 
    SntpErrorBadParameter,
 
    SntpRejectedResponse,
 
    SntpRejectedResponseChangeServer,
 
    SntpRejectedResponseRetryWithBackoff,
 
    SntpRejectedResponseOtherCode,
 
    SntpErrorBufferTooSmall,
 
    SntpInvalidResponse,
 
    SntpZeroPollInterval,
 
    SntpErrorTimeNotSupported,
 
    SntpErrorDnsFailure,
 
    SntpErrorNetworkFailure,
 
    SntpServerNotAuthenticated,
 
    SntpErrorAuthFailure,
 
    SntpErrorSendTimeout,
 
    SntpErrorResponseTimeout,
 
    SntpNoResponseReceived,
 
    SntpErrorContextNotInitialized
} SntpStatus_t;
 
typedef enum SntpLeapSecondInfo
{
    NoLeapSecond = 0x00,              
    LastMinuteHas61Seconds = 0x01,    
    LastMinuteHas59Seconds = 0x02,    
    AlarmServerNotSynchronized = 0x03 
} SntpLeapSecondInfo_t;
 
typedef struct SntpTimestamp
{
    uint32_t seconds;   
    uint32_t fractions; 
} SntpTimestamp_t;
 
typedef struct SntpResponse
{
    SntpTimestamp_t serverTime;
 
    SntpLeapSecondInfo_t leapSecondType;
 
    uint32_t rejectedResponseCode;
 
    int64_t clockOffsetMs;
} SntpResponseData_t;
 
 
/* @[define_sntp_serializerequest] */
SntpStatus_t Sntp_SerializeRequest( SntpTimestamp_t * pRequestTime,
                                    uint32_t randomNumber,
                                    void * pBuffer,
                                    size_t bufferSize );
/* @[define_sntp_serializerequest] */
 
/* @[define_sntp_deserializeresponse] */
SntpStatus_t Sntp_DeserializeResponse( const SntpTimestamp_t * pRequestTime,
                                       const SntpTimestamp_t * pResponseRxTime,
                                       const void * pResponseBuffer,
                                       size_t bufferSize,
                                       SntpResponseData_t * pParsedResponse );
/* @[define_sntp_deserializeresponse] */
 
/* @[define_sntp_calculatepollinterval] */
SntpStatus_t Sntp_CalculatePollInterval( uint16_t clockFreqTolerance,
                                         uint16_t desiredAccuracy,
                                         uint32_t * pPollInterval );
/* @[define_sntp_calculatepollinterval] */
 
 
/* @[define_sntp_converttounixtime] */
SntpStatus_t Sntp_ConvertToUnixTime( const SntpTimestamp_t * pSntpTime,
                                     uint32_t * pUnixTimeSecs,
                                     uint32_t * pUnixTimeMicrosecs );
/* @[define_sntp_converttounixtime] */
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef CORE_SNTP_SERIALIZER_H_ */