iPtcpDrv.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 IPTCPDRV_H_
#define IPTCPDRV_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                          Doxygen                                           */
/* ========================================================================== */
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/pruicss.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef enum
{
    disable = 0,            
    enable  = 1            
} ptcpPortStatus_t;
 
 
typedef enum
{
    OUT_OF_SYNC,            
    IN_SYNC,                
    TAKEOVER_TIMEOUT,       
    SYNC_TIMEOUT           
} syncState_t;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct ptcpTimes
{
    uint32_t    rxDelayLocal;       
    uint32_t    txDelayLocal;       
    uint32_t    rxDelayRemote;      
    uint32_t    txDelayRemote;      
    uint32_t    cableDelay;         
} ptcpPortDelayVal_t ;
 
typedef struct
{
    syncState_t syncState;              
    uint8_t         masterSA[6];            
    uint8_t         subdomainUUID[16];      
} ptcpSyncInfo_t;
 
typedef struct
{
    uint16_t Status;
    uint16_t SecondsHigh;
    uint32_t SecondsLow;
    uint32_t Nanoseconds;
} PNIO_TimeStamp;
 
typedef struct
{
    uint32_t TorgSec;
    uint32_t TorgNsec;
    uint32_t TDelay;
 
    uint32_t IEP_count_tS;
    uint32_t IEP_count_tL_R;
    uint32_t IEP_count_tL_F;
    uint32_t IEP_count_fn;
 
    uint64_t tick_S;
    uint64_t tick_L;
    uint64_t tick_fn;
} LatchVars;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
typedef void (*ptcpCallBack_t)(uint32_t arg, uint32_t arg2);
 
void PN_PTCP_registerSyncStatusCall(PN_Handle pnHandle,
                                    ptcpCallBack_t callBack);
 
void PN_PTCP_registerDelayUpdateCall(PN_Handle pnHandle,
                                     ptcpCallBack_t callBack);
 
void PN_PTCP_getDelayValues(PN_Handle pnHandle, ptcpPortDelayVal_t *portDelays,
                            uint8_t portNum);
 
void PN_PTCP_getLocalDelayValues(PN_Handle pnHandle, uint8_t portNum,
                                 uint32_t *outRxDelay, uint32_t *outTxDelay);
 
void PN_PTCP_getRemoteDelayValues(PN_Handle pnHandle, uint8_t portNum,
                                  uint32_t *outRxDelay, uint32_t *outTxDelay);
 
void PN_PTCP_getSyncInfo(PN_Handle pnHandle, ptcpSyncInfo_t *syncInfo);
 
void PN_PTCP_getSyncMasterAddress(PN_Handle pnHandle, uint8_t *addr);
 
void PN_PTCP_setPllWindow(PN_Handle pnHandle, uint32_t pllWindowSize);
 
void PN_PTCP_setSyncTimeoutFactor(PN_Handle pnHandle,
                                  uint32_t syncTimeoutFactor);
 
void PN_PTCP_setTakeoverTimeoutFactor(PN_Handle pnHandle,
                                      uint32_t takeoverTimeoutFactor);
 
void PN_PTCP_setSyncUUID(PN_Handle pnHandle, uint8_t *subdomainUUID);
 
void PN_PTCP_configureSyncFwd(PRUICSS_HwAttrs const *pruicssHwAttrs,
                              ptcpPortStatus_t state);
 
void PN_PTCP_configureDelayMeasurement(PN_Handle pnHandle, uint8_t portNum,
                                       ptcpPortStatus_t state);
 
void PN_PTCP_configureDelayResp(PRUICSS_HwAttrs const *pruicssHwAttrs,
                                uint8_t portNum,
                                ptcpPortStatus_t state);
int32_t PN_PTCP_getAbsoluteTime(PN_Handle pnHandle,
                                PNIO_TimeStamp *p_PNIO_TimeStamp, int32_t LatchEn);
 
 
void PN_PTCP_latchInit(PN_Handle pnHandle);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPTCPDRV_H_ */