icss_timeSync_init.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 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_INIT_H_
#define ICSS_TIMESYNC_INIT_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include "icss_timeSync.h"
#include "icss_timeSyncApi.h"
#include "icss_timeSync_osal.h"
 
#define  TS_LEAP_61_INDEX                                   0
 
#define  TS_LEAP_59_INDEX                                   1
 
#define  TS_UTC_REASONABLE_INDEX                            2
 
#define  TS_PTP_TIMESCALE_INDEX                             3
 
#define  TS_TIME_TRACEABLE_INDEX                            4
 
#define  TS_FREQ_TRACEABLE_INDEX                            5
 
#define  TS_ALTERNATE_MASTER_INDEX                          6
 
#define  TS_PTP_TWO_STEP_INDEX                              7
 
#define  TS_PTP_UNICAST                                     8
 
#define  TS_PROFILE_SPECIFIC_1_INDEX                        9
 
#define  TS_PROFILE_SPECIFIC_2_INDEX                        10
 
#define  TS_PTP_SECURITY_INDEX                              11
 
/*------------Flag masks for different frames as per standard--------*/
/* These are derived indirectly from Table 20 of the standard*/
#define  TS_SYNC_BYTE0_MASK                                 0xFF
 
#define  TS_ANNOUNCE_BYTE0_MASK                             0xFD
 
#define  TS_FOLLOW_UP_BYTE0_MASK                            0xFD
 
#define  TS_PDELAY_RESP_BYTE0_MASK                          0xFE
 
#define  TS_DELAY_RESP_BYTE0_MASK                           0xFD
 
#define  TS_OTHER_FRAMES_BYTE0_MASK                         0xFC
 
#define  TIMESYNC_PDELAY_BUF_SIZE                           68
 
#define  TIMESYNC_SYNC_BUF_ANNEX_F_SIZE                     58
 
#define  TIMESYNC_FOLLOW_UP_BUF_ANNEX_F_SIZE                63
 
#define  TIMESYNC_ANNOUNCE_BUF_ANNEX_F_SIZE                 78
 
#define  TIMESYNC_SYNC_BUF_ANNEX_E_SIZE                     86
 
#define  TIMESYNC_FOLLOW_UP_BUF_ANNEX_E_SIZE                86
 
#define  TIMESYNC_ANNOUNCE_BUF_ANNEX_E_SIZE                 106
 
#define  TIMESYNC_DELAY_REQ_BUF_SIZE                        86
 
/*-----------------Default PTP Master init params-------------------*/
 
/* These are used in BMCA*/
#define  TIMESYNC_DEFAULT_PRIO_1                            128
 
#define  TIMESYNC_DEFAULT_PRIO_2                            128
 
#define  TIMESYNC_DEFAULT_CLOCK_ACCURACY                    0x31
 
#define  TIMESYNC_DEFAULT_CLOCK_CLASS                       248
 
#define  TIMESYNC_DEFAULT_CLOCK_VARIANCE                    0
 
#define  TIMESYNC_DEFAULT_STEPS_REMOVED                     0
 
#define  TIMESYNC_UTC_OFFSET                                0
 
#define  TIMESYNC_DEFAULT_TIME_SOURCE                       0xa0
 
 
#define  TIMESYNC_OFFSET_STABLE_ALGO_THRESHOLD              15
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int8_t TimeSync_drvInit(TimeSync_ParamsHandle_t timeSyncHandle);
 
int8_t TimeSync_alloc_PktBuffer(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_unAlloc_PktBuffer(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_drvEnable(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_drvDisable(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_dramInit(TimeSync_ParamsHandle_t timeSyncHandle);
 
 
void TimeSync_setDefaultValue(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_formatPTPFrames(TimeSync_ParamsHandle_t timeSyncHandle,
                              uint8_t *ifMacID);
void TimeSync_initializeFollowUp(TimeSync_ParamsHandle_t timeSyncHandle);
 
void TimeSync_addIP(TimeSync_ParamsHandle_t timeSyncHandle, uint32_t IP);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICSS_TIMESYNC_INIT_H_ */