lre_common.h

Go to the documentation of this file.

 
#ifndef LRE_COMMON_H_
#define LRE_COMMON_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <enet.h>
#include <enet_cfg.h>
#include <include/core/enet_dma.h>
#include <include/core/enet_base.h>
#include <utils/include/enet_ethutils.h>
#include <utils/include/enet_appmemutils.h>
#include <utils/include/enet_apputils.h>
#include <kernel/dpl/TaskP.h>
#include <kernel/dpl/ClockP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <per/icssg.h>
#include <priv/per/icssg_priv.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define LRE_MANUFACTURER  "Texas Instruments"
#define LRE_VERSION_NAME  "1.0.0.1"
#define LRE_NODE_NAME     "TI"
 
#define LRE_SUP_SEND_HANDLER_TASK_PRIORITY  (7U)
#define LRE_SUP_SEND_HANDLER_TASK_STACK     (3 * 1024)
#define LRE_SUP_RCV_HANDLER_TASK_PRIORITY   (7U)
#define LRE_SUP_RCV_HANDLER_TASK_STACK      (8 * 1024)
 
#define ETHER_TYPE_LRE_SUP       ( 0x88FB )  
#define LRE_FRAME_MIN_SIZE           ( 66 )  
#define LRE_FRAME_VLAN_MIN_SIZE      ( 70 )  
#define ICSS_EMAC_MAXMTU_HSR         1528
 
/* --- LRE Supervision frame related Defines --- */
 
#define LRE_SUP_PATH_VERSION                        ( 0x0001 )
 
#define LRE_TLV1_TYPE_PRP_DUP_DISCARD               ( 20 )
 
#define LRE_TLV1_TYPE_PRP_DUP_ACCEPT                ( 21 )
 
#define LRE_TLV1_TYPE_HSR                           ( 23 )
 
#define LRE_TLV2_TYPE_REDBOX_MAC                    ( 30 )
 
#define LRE_TLV0_TYPE                               ( 0 )
 
#define LRE_TLV0_LENGTH                             ( 0 )
 
/* --- LRE Nodetable related Defines --- */
 
#define NT_TOTAL_ENTRIES    256
 
#define NT_BUCKET_SIZE      8
 
#define NT_NUM_OF_BUCKETS   (NT_TOTAL_ENTRIES/NT_BUCKET_SIZE)
 
#define LRE_NODE_FORGET_TIME    60
 
#define LRE_PORT_A      0U
 
#define LRE_PORT_B      1U
 
#define LRE_NODESTABLE_ENTRY_INVALID    0U
 
#define LRE_NODESTABLE_ENTRY_VALID      1U
 
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum Lre_Mode_e
{
    LRE_MODE_PRP_DUP_DISCARD,
 
    LRE_MODE_PRP_DUP_ACCEPT,
 
    LRE_MODE_HSR,
} Lre_Mode;
 
typedef struct
{
    /*  Port A & Port B counters (members aligned to icssg offsets) */
    uint32_t cntUniqueA;
    uint32_t cntUniqueB;
 
    uint32_t cntDuplicateA;
    uint32_t cntDuplicateB;
 
    uint32_t cntMultiA;
    uint32_t cntMultiB;
 
    uint32_t cntRxA;
    uint32_t cntRxB;
 
    uint32_t cntTxA;
    uint32_t cntTxB;
 
    uint32_t cntOwnRxA;
    uint32_t cntOwnRxB;
    
    uint32_t cntErrWrongLanA;
    uint32_t cntErrWrongLanB;
 
    uint32_t cntErrorsA;
    uint32_t cntErrorsB;
 
    /*  Port C counters */
    uint32_t cntUniqueC;
    uint32_t cntDuplicateC;
    uint32_t cntMultiC;
    uint32_t cntRxC;
    uint32_t cntTxC;
    /* Only applicable to HSR RedBoxes in HSR-PRP configuration */
    uint32_t cntErrWrongLanC;
    uint32_t cntErrorsC;
 
    /*  Node Table related counters */
    uint32_t cntNodes;
    /* Only applicable to HSR RedBoxes in HSR-PRP configuration */
    uint32_t cntProxyNodes;
 
} lreStatistics;
 
/*
*  HSR PRP Supervision Frame Format
*
*    Octet[0-5]     Destination MAC address = multicast (01-15-4E-00-01-XX)
*    Octet[6-11]    Source MAC address (MAC address of the node)
*    Octet[12-17]   Supervision frame tag = 0x88FB
*    Octet[18-25]   TLV1
*    Octet[26-33]   TLV2
*    Octet[34-35]   TLV0
*    Octet[36-65]   Padding to 70 octets
*/
 
typedef struct
{
    uint16_t ether_type;
 
    uint16_t path_and_ver;
 
    uint16_t seq_nr;
} SUP_TAG;
 
typedef struct
{
    uint8_t type;
 
    uint8_t length;
 
    uint8_t dan_mac[ETH_MAC_ADDR_LEN];
} TLV1_TAG;
 
typedef struct
{
    uint8_t type;
 
    uint8_t length;
 
    uint8_t redbox_mac[ETH_MAC_ADDR_LEN];
} TLV2_TAG;
 
typedef struct
{
    uint8_t type;
 
    uint8_t length;
} TLV0_TAG;
 
typedef struct /* Use packed attribute for direct memory mapping */
{
    uint8_t  dst[ETH_MAC_ADDR_LEN];
 
    uint8_t  src[ETH_MAC_ADDR_LEN];
 
    SUP_TAG  supTag;
 
    TLV1_TAG tlv1;
 
    TLV2_TAG tlv2;
 
    TLV0_TAG tlv0;
 
}  __attribute__((packed)) SupervisionFrame;
 
typedef struct
{
    uint32_t enableSupSendByDriver;
 
    uint32_t enableSupRcvByDriver;
 
    uint32_t filterNum;
 
    uint32_t classifierNum;
 
    /* Destination multicast address for HSR/PRP supervision */
    uint8_t dstMac[ETH_MAC_ADDR_LEN];
 
    /* Source MAC address of the node */
    uint8_t srcMac[ETH_MAC_ADDR_LEN];
 
    EnetDma_RxChHandle hRxCh[2];
 
    EnetDma_PktQ rxReadyQ[2];
 
    EnetDma_PktQ rxFreeQ[2];
 
    EnetDma_TxChHandle hTxCh;
 
    EnetDma_PktQ txFreePktInfoQ;
 
    EnetDma_PktQ txSubmitQ;
 
    SupervisionFrame svFrame;
 
    uint16_t supSeqNr;
 
    uint64_t clkTimerPeriod_ms;
 
    uint64_t NodeForgetTime_ms;
 
    uint64_t lifecheckPeriod_ms;
 
    TaskP_Object taskSendSupHandlerObj;
 
    TaskP_Object taskRcvSupHandlerObj;
 
    ClockP_Object supTimerObj;
 
    SemaphoreP_Object sendSupSem;
 
    SemaphoreP_Object rcvSupSem;
 
    uint8_t lreSendSupFrameTaskStack[LRE_SUP_SEND_HANDLER_TASK_STACK] __attribute__ ((aligned(32)));
 
    uint8_t lreRcvSupFrameTaskStack[LRE_SUP_SEND_HANDLER_TASK_STACK] __attribute__ ((aligned(32)));
 
} Lre_supervisionObj;
 
typedef enum Lre_NodeType_e
{
    NT_NODE_PRP_TYPE_DAN_DUP_ACCEPT,
 
    NT_NODE_PRP_TYPE_DAN_DUP_DISCARD,
 
    NT_NODE_PRP_TYPE_REDBOX_DUP_ACCEPT,
 
    NT_NODE_PRP_TYPE_REDBOX_DUP_DISCARD,
 
    NT_NODE_PRP_TYPE_VDAN_DUP_ACCEPT,
 
    NT_NODE_PRP_TYPE_VDAN_DUP_DISCARD,
 
    NT_NODE_HSR_TYPE_DAN,
 
    NT_NODE_HSR_TYPE_VDAN,
 
    NT_NODE_HSR_TYPE_REDBOX,
 
    NT_NODE_TYPE_SANA,
 
    NT_NODE_TYPE_SANB,
 
    NT_NODE_TYPE_SANAB,
 
    NT_NODE_TYPE_END
} Lre_NodeType;
 
/* --- Node Table Data Structures --- */
 
typedef struct {
    uint8_t macAddress[ETH_MAC_ADDR_LEN];
 
    uint16_t lastSeqNumber;
 
    uint32_t cntRxSupA;
 
    uint32_t cntRxSupB;
 
    uint32_t timeLastSeenA;
 
    uint32_t timeLastSeenB;
 
    uint8_t entry_valid;
 
    Lre_NodeType type;
} NodeInfo;
 
typedef struct {
    NodeInfo nodes[NT_BUCKET_SIZE];
} NodeBucket;
 
typedef struct {
    NodeBucket buckets[NT_NUM_OF_BUCKETS];
    uint32_t nodesCount;
} NodesTable;
 
typedef struct {
    NodesTable nodesTable;
} Lre_nodestableObj;
 
 
typedef struct {
    lreStatistics statistics;
} Lre_statisticsObj;
 
typedef struct Lre_Obj_s {
    Enet_Handle        hEnet;
 
    Lre_Mode           lreMode;
 
    PRUICSS_Handle     pruicssHandle;
 
    Lre_supervisionObj svObj;
 
    Lre_nodestableObj  ntObj;
 
    Lre_statisticsObj  statsObj;
} Lre_Obj;
 
typedef struct Lre_Obj_s *Lre_Handle;
 
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void LRE_open(Lre_Handle lreHandle);
 
int32_t LRE_supervisionInit(Lre_Handle lreHandle);
 
void LRE_nodesTableInit(Lre_nodestableObj* ntObj);
 
void LRE_updateNodeEntry(NodesTable *table, const uint8_t *src_mac, uint16_t sequence_number, uint8_t port, Lre_NodeType node_type);
 
void LRE_checkNodeTimeouts(NodesTable *table);
 
void LRE_printNodesTable(Lre_Handle lreHandle);
 
void LRE_supervisionDeinit(Lre_Handle lreHandle);
 
void LRE_statisticsInit(Lre_Handle lreHandle);
 
void LRE_getStatistics(Lre_Handle lreHandle);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LRE_COMMON_H_ */