icss_timeSync.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef ICSS_TIMESYNC_H_
#define ICSS_TIMESYNC_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdlib.h>
#include <math.h>
#include <networking/icss_emac/icss_emac.h>
#include "icss_timeSyncApi.h"
 
/* ========================================================================== */
/*                                Error Codes                                 */
/* ========================================================================== */
#define TIME_SYNC_OK                                                         (1)
 
#define TIME_SYNC_UNABLE_TO_CREATE_TASK                                     (-1)
 
#define TIME_SYNC_UNABLE_TO_CREATE_SEMAPHORE                                (-2)
 
#define TIME_SYNC_UNABLE_TO_CREATE_INTERRUPT                                (-3)
 
#define TIME_SYNC_UNABLE_TO_ALLOC_MEM                                       (-4)
 
#define TIME_SYNC_UNABLE_TO_CREATE_CLOCK                                    (-5)
 
#define TIME_SYNC_UNABLE_TO_CREATE_MAILBOX                                  (-6)
 
#define TIME_SYNC_UNABLE_TO_CREATE_EVENT                                    (-7)
 
#define TIME_SYNC_UNSUPPORTED_FORMAT                                        (-8)
 
#define TIME_SYNC_EDMA_INIT_FAILED                                          (-9)
 
#define TIME_SYNC_FEATURE_NOT_ENABLED                                       (-10)
 
#define TIME_SYNC_HANDLE_NOT_INITIALIZED                                    (-11)
 
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define DEFAULT_PDELAY_REQ_LOG_INTERVAL         3
 
#define DEFAULT_SYNC_SEND_LOG_INTERVAL          0
 
#define DEFAULT_ANNOUNCE_SEND_LOG_INTERVAL      1
 
#define DEFAULT_ANNOUNCE_TIMEOUT_LOG_INTERVAL   3
 
#define TIMESYNC_SYNC_ISR_MASK_P1               0x400000
 
#define TIMESYNC_SYNC_ISR_MASK_P2               0x2000000
 
/*
 * \def TIMESYNC_TX_TS_ISR_MASK_P1
 *      Interrupt mask for PRU event 23
 */
#define TIMESYNC_TX_TS_ISR_MASK_P1              0x800000
 
#define TIMESYNC_TX_TS_ISR_MASK_P2              0x1000000
 
#define PTP_SYNC_MSG_ID                     0x00
 
#define PTP_DLY_REQ_MSG_ID                  0x01
 
#define PTP_PDLY_REQ_MSG_ID                 0x02
 
#define PTP_PDLY_RSP_MSG_ID                 0x03
 
#define PTP_FOLLOW_UP_MSG_ID                0x08
 
#define PTP_DLY_RESP_MSG_ID                 0x09
 
#define PTP_PDLY_RESP_FLW_UP_MSG_ID         0x0A
 
#define PTP_ANNOUNCE_MSG_ID                 0x0B
 
#define PTP_MGMT_MSG_ID                     0x0D
 
#define PTP_FLW_UP_CTRL_MSG_ID              0x02
 
#define SEC_TO_NS                           1000000000
 
#define FILTER_ALPHA_COEFF                          0.85
 
#define PTP_SYNC0_PERIOD_DIVIDER        4
 
#define OFFSET_THRESHOLD_FOR_RESET     10000
 
#define STABLE_FILTER_THRESHOLD         100
 
#define TIMESYNC_PEER_DELAY_ERROR_THRESHOLD     10000
 
#define NUM_SYNC_MISSED_THRESHOLD       3
 
#define AVG_NUM_DELAY_MEASUREMENTS      3
 
/*Hex Offsets for different fields in PTP Delay Req/Res Packet. Annex E*/
/*To get Annex F offsets subtract ANNEX_D_ANNEX_F_DIFF from it*/
 
#define SRC_MAC_OFFSET              6
 
#define IP_DSCP_OFFSET              15
 
#define SRC_IP_OFFSET               26
 
#define DST_IP_OFFSET               30
 
#define IP_CHKSUM_OFFSET            40
 
#define PTP_MSG_ID_OFFSET           42
 
#define PTP_DOMAIN_NUM_OFFSET       46
 
#define PTP_FLAG_OFFSET             48
 
#define PTP_CORRECTION_OFFSET       50
 
#define PTP_SRC_CLK_IDENTITY        62
 
#define PTP_SRC_PORT_ID_OFFSET      70
 
#define PTP_SEQ_ID_OFFSET           72
 
#define PTP_CONTROL_MSG_ID_OFFSET   74
 
#define PTP_LOG_MSG_PERIOD          75
 
#define PTP_REQ_RCPT_TS_SEC_OFFSET  76
 
#define PTP_REQ_RCPT_TS_NSEC_OFFSET 82
 
#define PTP_REQ_SRC_PORT_IDENTITY   86
 
#define PTP_REQ_SRC_PORT_ID         94
 
#define PTP_UTC_OFFSET              86
 
#define PTP_PRIORITY1_OFFSET        89
 
#define PTP_GM_CLK_CLASS_OFFSET     90
 
#define PTP_GM_CLK_ACCU_OFFSET          91
 
#define PTP_GM_CLK_VARIANCE_OFFSET      92
 
#define PTP_PRIORITY2_OFFSET            94
 
#define PTP_GM_CLK_IDENTITY_OFFSET      95
 
#define PTP_STEPS_REMOVED_OFFSET        103
 
#define PTP_TIME_SRC_OFFSET             105
 
#define PTP_E2E_BUFFER_OFFSET           42
 
#define PTP_P2P_BUFFER_OFFSET           14
 
#define ANNEX_D_ANNEX_F_DIFF            28
 
#define HSR_CORRECTION                  6
 
#define SRC_DST_MAC_SIZE                12
 
#define  PTP_LEAP_61_MASK               (1<<0)
 
#define  PTP_LEAP_59_MASK               (1<<1)
 
#define  PTP_UTC_REASONABLE_MASK        (1<<2)
 
#define  PTP_TIMESCALE_MASK             (1<<3)
 
#define  PTP_TIME_TRACEABLE_MASK        (1<<4)
 
#define  PTP_FREQ_TRACEABLE_MASK        (1<<5)
 
#define  PTP_ALTERNATE_MASTER_MASK      (1<<8)
 
#define  PTP_TWO_STEP_MASK              (1<<9)
 
#define  PTP_UNICAST_MASK               (1<<10)
 
#define  PTP_PROFILE_SPECIFIC_1_MASK    (1<<13)
 
#define  PTP_PROFILE_SPECIFIC_2_MASK    (1<<14)
 
#define  PTP_SECURITY_MASK              (1<<15)
 
#define SYNC_INTERVAL_PERIOD_CHANGE_THRESHOLD   60
 
#define GPTP_NUM_DOMAINS                        2
 
#define PTP_FLAG_SIZE               (2)
 
#define PTP_SRC_CLK_IDENTITY_SIZE   (8)
 
#define PTP_SRC_PORT_ID_SIZE        (2)
 
#define PTP_GM_CLK_IDENTITY_SIZE    (8)
 
#define PTP_GM_CLK_CLASS_SIZE       (1)
 
#define PTP_GM_CLK_ACCU_SIZE        (1)
 
#define PTP_GM_CLK_VARIANCE_SIZE    (2)
 
#define PTP_UTC_SIZE                (2)
 
#define PTP_TIME_SRC_SIZE           (1)
 
#define PTP_PRIORITY1_SIZE          (1)
 
#define PTP_PRIORITY2_SIZE          (1)
 
#define PTP_STEPS_REMOVED_SIZE      (2)
 
/* ========================================================================== */
/*                          Function Definitions                              */
/* ========================================================================== */
void TimeSync_resetIEP(TimeSync_ParamsHandle_t timeSyncHandle);
void TimeSync_doFirstAdjustment(TimeSync_ParamsHandle_t timeSyncHandle,
                                uint8_t portNum);
 
void TimeSync_Port1linkResetCallBack(uint8_t linkStatus, void *arg2);
 
void TimeSync_Port2linkResetCallBack(uint8_t linkStatus, void *arg2);
 
void TimeSync_reset(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_processPTPFrame(TimeSync_ParamsHandle_t timeSyncHandle,
                              uint8_t *pktBuffer, \
                              uint8_t portNum, uint16_t size, uint8_t isLinkLocal);
 
uint8_t TimeSync_isEnabled(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_updateParentAddress(TimeSync_ParamsHandle_t timeSyncHandle,
                                  uint8_t *parentMac);
void TimeSync_getPrevAddress(TimeSync_ParamsHandle_t timeSyncHandle,
                             uint8_t *prevMac);
void TimeSync_getGeneralMessage(TimeSync_ParamsHandle_t timeSyncHandle,
                                int8_t *buff);
void TimeSync_rxPhyDelayCorrection(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_getTxTS(TimeSync_ParamsHandle_t timeSyncHandle, uint8_t portNum,
                      ptpFrameTypes_t frameType);
 
void TimeSync_lineDelayCalc(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_peerDelayCalc(TimeSync_ParamsHandle_t timeSyncHandle,
                            uint8_t twoStep, uint8_t portNum);
void TimeSync_processSyncFrame(TimeSync_ParamsHandle_t timeSyncHandle,
                               uint8_t *buff, \
                               uint8_t followUp, uint8_t portNum, uint16_t size);
void TimeSync_processDelayResFrame(TimeSync_ParamsHandle_t timeSyncHandle,
                                   uint8_t *buff, \
                                   uint8_t portNum);
void TimeSync_processPdelayReqFrame(TimeSync_ParamsHandle_t timeSyncHandle,
                                    uint8_t *buff, \
                                    uint8_t portNum);
void TimeSync_processPdelayRespFrame(TimeSync_ParamsHandle_t timeSyncHandle,
                                     uint8_t *buff, \
                                     uint8_t followUp, uint8_t portNum);
void TimeSync_forced2StepBDCalc(TimeSync_ParamsHandle_t timeSyncHandle,
                                uint8_t portNum);
 
void TimeSync_synchronizeClock(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_calcNRR(TimeSync_ParamsHandle_t timeSyncHandle, uint8_t portNum);
void TimeSync_updateNRRParams(TimeSync_ParamsHandle_t timeSyncHandle,
                              uint8_t portNum);
 
void TimeSync_calcRcfAndSyncInterval(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_writeTS_SingleStep_Sync(TimeSync_ParamsHandle_t timeSyncHandle,
                                      uint8_t portNum);
 
void TimeSync_dummyBMCA(TimeSync_ParamsHandle_t timeSyncHandle,
                        uint8_t *pktBuffer);
 
 
uint64_t getIEPTimestamp(TimeSync_ParamsHandle_t timeSyncHandle);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICSS_TIMESYNC_H_ */