iPtcpUtils.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 IPTCPUTILS_H_
#define IPTCPUTILS_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "PN_Handle.h"
#include <networking/icss_emac/icss_emac.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define PRU_IEP_COUNT_REG               0x0C
 
#define PRU_IEP_CMP_CFG_REG             0x40
 
#define PRU_IEP_CMP1_REG                0x4C
 
#define PRU_IEP_SYNC_PWIDTH_REG         0x110
 
#define PRU_IEP_CAP_CFG_REG             0x10
 
 
/*#define   PTCP_DEBUG_SI*/
 
/*#define     PTCP_DEBUG_LI*/
 
/*#define     PTCP_DEBUG*/
 
/*#define   SYNC_ANALYSIS*/
 
/*#define   SYNC_SYS_LOG*/
 
/*#define   SYNC_SYS_LOG_1*/
 
/*#define   PTCP_DIRECT_IEP_ADJ*/
 
#define PTCP_ENABLE_FILTER
 
#define ISR_PTCP_NUM            24
 
#define ISR_PTCP_NUM_ARM            124+32
 
#define NUM_DELAYS_SMA          7
 
#define NUM_DELAYS_BURST        5
 
#define PTCP_NUM_PORTS              2
 
#define MAX_SEQID               61435
 
#define PTCP_DELAY_REQ_LEN      60
 
#define MAX_CTR_VAL             512
 
#define INTER_DEL_REQ_GAP       200000000
 
#define INTER_DEL_REQ_GAP_MS    205
 
#define INTER_DEL_REQ_BURST_GAP_MS  8205
 
#define SYNC_INTERVAL           30000000
 
#define PORT_RX_DELAY           184
 
#define PORT_TX_DELAY           86
 
#define DEBUG_DELAY_N_ITER      200
 
#ifdef PTCP_DEBUG_SI
#define DEBUG_SYNC_N_ITER       300
#else
#define DEBUG_SYNC_N_ITER       40000
#endif
 
#define SYNC_FILTER_SIZE        8
 
#define SYNC_ANALYSIS_N_ITER    100
 
#define SYNC_ANALYSIS_N_RESETS  40
 
/* EDMA related defines for clock synchronization*/
#define EDMA3_ECAPEVT0_CHA_NUM              (38U)
 
#define EDMA3_ECAPEVT0_LINK_CHA_NUM         (39U)
 
#define EDMA3_CLEAR_ECAP_CHA_NUM            (40U)
 
#define EDMA3_CLEAR_ECAP_LINK_CHA_NUM       (41U)
 
#define EDMA3_SYNC0_RETRIGGER_CHA_NUM       (42)
 
#define EDMA3_SYNC0_RETRIGGER_LINK_CHA_NUM  (43)
 
#define EVT_QUEUE_NUM                       (0)
 
 
#define ISR_LATCH_NUM               27/* Latch interrupt number */
#define LATCH0_EVENT                12/* Latch Event number */
 
#ifdef SOC_AM335X
#define ISR_LATCH_NUM_ARM       27
#elif defined SOC_AM437X
#define ISR_LATCH_NUM_ARM       27 + 32
#else
#define ISR_LATCH_NUM_ARM       27 + 32
#endif
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint16_t    seqId;
    uint32_t    T1PortTXDelay;
    uint32_t    T2PortRXDelay;
    uint32_t    T3PortTXDelay;
    uint32_t    T4PortRXDelay;
    uint32_t    T1TimeStamp;
    uint32_t    T2TimeStamp;
    uint32_t    T4TimeStamp;
    uint32_t    T1_cycle_ctr;
    uint32_t    T4_cycle_ctr;
    uint32_t    reqDelay;
    uint32_t    resDelay;
    float           rcf_peer;
    uint32_t    resDelay_peer;
    uint32_t    cable_delay;
    uint32_t    line_delay;
} ptcp_iDelayResp_struct_t;
 
typedef struct
{
    syncState_t syncState;
    /*TODO: Review NUM_PORTS -> PTCP_NUM_PORTS at all places*/
    uint32_t    cDelay[PTCP_NUM_PORTS];
    ptcpPortStatus_t    cDelayEnable[PTCP_NUM_PORTS];
 
    uint32_t    syncPllWnd;
    uint32_t    syncTimeoutFactor;
    uint32_t    takeoverTimeoutFactor;
 
    uint8_t firstSyncRcv;
    uint8_t syncRcv;
    uint32_t    nSyncMissed;
 
    uint8_t subdomainUUID[16];
    uint8_t masterSA[6];
} currentPtcpStatus_t;
 
typedef struct
{
    uint32_t  lDelays[NUM_DELAYS_SMA];
    uint32_t    cDelays[NUM_DELAYS_SMA];
} deviceDelays_t;
 
typedef struct
{
    uint32_t    *pT1TS;
    uint32_t    *pT4TS;
    uint32_t  *pT1CycleCtr;
    uint32_t    *pT4CycleCtr;
 
    uint8_t *pDelayReqPacket;
    uint8_t *pDelayResPacket;
    uint16_t    *pSeqIdInDelayPacket;
 
    uint8_t     *pInDelayResPacket;
    uint8_t     *pInDelayFupResPacket;
    uint8_t     *pInDelayResCtrl;
 
    uint32_t    *pSmaLineDelay;
} devicePortOffsets_t;
 
typedef struct
{
    int32_t     cDelay[DEBUG_DELAY_N_ITER];
    uint32_t    lDelay[DEBUG_DELAY_N_ITER];
    float   rcfPeer[DEBUG_DELAY_N_ITER];
    uint32_t    reqDelay[DEBUG_DELAY_N_ITER];
    uint32_t    resDelay[DEBUG_DELAY_N_ITER];
    uint16_t    seqId[DEBUG_DELAY_N_ITER];
} debugDelay_t;
 
typedef struct
{
    int32_t     syncDeltaT[DEBUG_SYNC_N_ITER];
    int32_t     syncSmaDeltaT[DEBUG_SYNC_N_ITER];
 
    uint32_t    syncLocalT[DEBUG_SYNC_N_ITER];
    uint32_t    syncMasterT[DEBUG_SYNC_N_ITER];
 
    uint32_t    syncTorgT[DEBUG_SYNC_N_ITER];
    uint32_t    syncInDelayPlusLDT[DEBUG_SYNC_N_ITER];
} debugSync_t;
 
 
#define SYNC_SINGLE_ITER_SIZE 200
 
typedef struct
{
    int32_t     deltaT[SYNC_SINGLE_ITER_SIZE];
    int32_t     smaDeltaT[SYNC_SINGLE_ITER_SIZE];
    int32_t     seqId[SYNC_SINGLE_ITER_SIZE];
    int32_t     tState[SYNC_SINGLE_ITER_SIZE];
    int32_t     tSeqId[SYNC_SINGLE_ITER_SIZE];
    int32_t     cycleTime[SYNC_SINGLE_ITER_SIZE];
} syncAnalysis_t;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
void PN_PTCP_start(PN_Handle pnHandle);
 
void PN_PTCP_ClockChange(PN_Handle pnHandle, uint32_t cycleTime);
 
void PN_PTCP_reset(PN_Handle pnHandle);
 
void PN_PTCP_init(PN_Handle pnHandle);
 
void PN_PTCP_delayMeasurement(PN_Handle pnHandle);
 
void PN_PTCP_resetDelayValues(PN_Handle pnHandle);
 
void PN_PTCP_smaDelayMeasurement(PN_Handle pnHandle);
 
int32_t PN_PTCP_lineDelayCalc(PN_Handle pnHandle,
                              ptcp_iDelayResp_struct_t *ptcp_iDelayResp_parsed);
 
int32_t PN_PTCP_parseInDelayResp(ptcp_iDelayResp_struct_t
                                 *ptcp_iDelayResp_parsed, uint8_t *ptcp_iDelayResp_packet,
                                 uint8_t *ptcp_iDelayFupResp_packet, int32_t w_FUP);
 
int32_t PN_PTCP_cableDelayCalc(PN_Handle pnHandle,
                               ptcp_iDelayResp_struct_t *ptcp_iDelayResp_parsed, uint8_t port);
 
uint32_t PN_PTCP_rotUint(uint32_t *input);
 
uint16_t PN_PTCP_rotUshort(uint16_t *input);
 
int32_t PN_PTCP_setupIsr(PN_Handle pnHandle);
 
void PN_PTCP_isrHandler(void* arg);
 
int32_t PN_PTCP_enableIsr(PN_Handle pnHandle);
 
void PN_PTCP_syncHandling(PN_Handle pnHandle);
 
void PN_PTCP_syncIepAdjustment(PN_Handle pnHandle, int32_t ecapPeriod,
                               uint32_t compensation);
 
int32_t PN_PTCP_parseSyncFields(PN_Handle pnHandle,
                                volatile ptcpSyncInfo_t *ptcp_sync_parsed, uint8_t *sync_sblock);
 
void PN_PTCP_initEcap(PN_Handle pnHandle);
 
void PN_PTCP_reconfigEcap(PN_Handle pnHandle, int32_t period);
 
void PN_PTCP_configEdma(PN_Handle pnHandle);
 
void PN_PTCP_setIepEdmaPaRamEntry(PN_Handle pnHandle);
 
void PN_PTCP_setEcapClrEdmaPaRamEntry(void);
 
void PN_PTCP_syncPreprocess(PN_Handle pnHandle, uint8_t ctrlByte);
 
void PN_PTCP_portDelaySmaCalc(PN_Handle pnHandle, uint8_t portNum);
 
void PN_PTCP_processDelayResponse(PN_Handle pnHandle, uint8_t portNum);
 
void PN_PTCP_resetDelayTimings(PN_Handle pnHandle, uint8_t portNum);
 
int32_t PN_PTCP_adjCtrDiff(PN_Handle pnHandle, int32_t ctrDiff);
 
int32_t PN_PTCP_absVal(int32_t num);
 
void PN_PTCP_syncTimeoutMonitor(PN_Handle pnHandle);
 
int32_t PN_PTCP_syncSubdomainCheck();
 
void PN_PTCP_taskSleep(uint32_t mSec);
 
void PN_PTCP_configureSync0Pin(PN_Handle pnHandle);
 
int32_t PN_PTCP_modFunc(int32_t num, uint32_t mod);
 
void PN_PTCP_triggerMeasurement(PN_Handle pnHandle);
#endif  /*PTCP_UTILS*/