icss_eip_driver.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_EIP_DRIVER_H_
#define ICSS_EIP_DRIVER_H_
 
/* ========================================================================== */
/*                          Doxygen                                           */
/* ========================================================================== */
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include "icss_dlr.h"
#include <networking/icss_timesync/icss_timeSyncApi.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
/*Use compare reg 4*/
#define IEP_CMP_DEFAULT_VAL      0x11
#define IEP_CMP4_DEFAULT_VAL     0x5000
#define IEP_CMP0_DEFAULT_VAL     0xffffffff
 
#define PRU_IEP_CMP_CFG_REG             0x40
/*Compare 0 register*/
#define PRU_IEP_CMP0_REG                0x48
 
#define EIP_TICK_PERIOD 1 /*in milliseconds*/
#define LOOPBK_PKT_SEND_PERIOD 1000
 
#define DEFAULT_BC_PKT_SIZE     60
 
#define ONE_SECOND_INTERVAL 1000    /*in milliseconds*/
#define TWO_MINUTE_INTERVAL  120000 /*in milliseconds*/
 
#define CRS_STATUS_MASK                     0x2
 
#define CRS_STATUS_SHIFT                    0x1
 
#define PTP_PROT_TYPE       0x88F7
#define DLR_MDIO_PHY0 1
#define DLR_MDIO_PHY1 2
 
/*DLR port 0 Interrupt*/
#define PHYBMSR_OFFSET                      0x1
#define PHYSTS_OFFSET                       0x10
 
#define PHY_LINK_STATUS_MASK                0x4
#define PHY_LINK_STATUS_SHIFT               0x2
 
typedef struct eip_Config_s *EIP_Handle;
 
typedef enum
{
    ORDINARY_CLOCK = 0,
    TRANSPARENT_CLOCK = 1,
    BOUNDARY_CLOCK = 2
 
} clockType;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint8_t clockIdentity[8];
    uint16_t clockClass;
    uint16_t timeAccuracy;
    uint16_t offsetScaledLogVariance;
    uint16_t currentUTCOffset;
    uint16_t timePropertyFlags;
    uint16_t timeSource;
 
    uint16_t observedOffsetScaledLogVariance;
 
    uint16_t observedPhaseChangeRate;
 
} clockClass_t;
 
typedef struct
{
    uint32_t size;
    uint8_t descr[32];
} descr_t;
 
typedef struct
{
    uint8_t portProfileIdentity[8];
} portProfileIdentity_t;
 
typedef struct
{
    uint8_t physicalProtocol[16];
    uint16_t sizeOfAddress;
    uint8_t portPhysicalAddress[16];
} portPhysAddr_t;
 
typedef struct
{
    uint16_t portNumber;
    uint16_t networkProtocol;
    uint16_t addressSize;
    uint8_t portProtocolAddress[16];
} portProtAddr_t;
 
typedef struct
{
    uint64_t systemTime;
    uint64_t systemOffset;
} sysTimeOffset_t;
 
typedef struct
{
    uint8_t ifPTPEnable;
    uint8_t IsSynchronized;
    uint64_t systemTimeMicrosec;
    uint64_t systemTimeNanosec;
    int64_t offsetFromMaster;
    uint64_t maxOffsetFromMaster;
    int64_t meanPathDelayToMaster;
    clockClass_t grandMasterClkInfo;
    clockClass_t parentClkInfo;
    clockClass_t localClkInfo;
    uint16_t numberOfPorts;
    /*TODO: Review ICSS_EMAC_MAX_PORTS_PER_INSTANCE -> ICSS_EMAC_MAX_PORTS_PER_INSTANCE*/
    port_State portState[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    uint16_t portEnable[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    uint16_t portLogAnnounceInterval[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    uint16_t portLogSyncInterval[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
 
    uint8_t priority1;
    uint8_t priority2;
 
    uint8_t domainNumber;
    clockType clockType;
    uint8_t manufacturerIdentity[4];
    descr_t productType;
    descr_t revData;
    descr_t userDesc;
 
    portProfileIdentity_t profileInfo[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    portPhysAddr_t physInfo[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    portProtAddr_t protInfo[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
 
    uint16_t stepsRemoved;
    sysTimeOffset_t timeOffset;
 
} cipSyncConfig_t;
 
/*
*  \brief     EIP Config
*             Structure storing the EIP info
*/
typedef struct eip_Config_s
{
    PRUICSS_Handle pruicssHandle;
    ICSS_EMAC_Handle emacHandle;
    TimeSync_ParamsHandle_t timeSyncHandle;
    cipSyncConfig_t cipSyncObj;
    uint8_t  tempFrame[ICSS_EMAC_MAXMTU];
    EIP_DLRHandle dlrHandle;
} eip_Config;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
void EIP_drvInit(EIP_Handle icssEipHandle);
void EIP_drvStop(EIP_Handle icssEipHandle);
void EIP_drvStart(EIP_Handle icssEipHandle);
void EIP_processProtocolFrames(uint32_t *queue_number, void *userArg);
 
int8_t EIP_initializeCIPSync(EIP_Handle icssEipHandle);
 
#endif /* ICSS_EIP_DRIVER_H_ */