AM64x MCU+ SDK  08.03.00
hsrPrp_red_prp.h File Reference

Introduction

Include file for hsrPrp_red_prp.c.

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.

Go to the source code of this file.

Data Structures

struct  PRP_RCT
 
struct  PRP_SUP_FRAME
 

Macros

#define ETHER_TYPE_PRP_SUP   ( ETHER_TYPE_RED_SUP )
 
#define PRP_RCT_SIZE   ( 6 )
 
#define PRP_TRAILER_MAGIC   ( 0x88FB )
 
#define PRP_TRAILER_MAGIC_BIG_ENDIAN   ( 0xFB88 )
 
#define PRP_LAN_A_MAGIC   ( 0xA )
 
#define PRP_LAN_B_MAGIC   ( 0xB )
 
#define PRP_RCT_SEQNO_OFFSET   ( 0 )
 
#define PRP_RCT_LANID_LSDU_OFFSET   ( 2 )
 
#define PRP_RCT_ETHTYPE_OFFSET   ( 4 )
 
#define PRP_TLV1_TYPE_DUP_DISCARD   ( 20 )
 
#define PRP_TLV1_TYPE_DUP_ACCEPT   ( 21 )
 
#define PRP_SUP_SIZE   ( RED_SUP_SIZE )
 
#define PRP_SUP_PATH   ( RED_SUP_PATH )
 
#define PRP_SUP_VER   ( RED_SUP_VER )
 
#define PRP_SUP_PAD   ( RED_SUP_PAD )
 
#define PRP_MODE_MASK   ( 0x0 )
 
#define EMAC_MODE_MASK   ( 0x1 )
 
#define PRP_VS_EMAC_MODE_MASK   ( PRP_MODE_MASK )
 

Functions

void PrpFrameFill (hsrPrpHandle *hsrPrphandle, RED_FRAME *pRedFrame, const uint8_t *pFrame, int32_t frameSize)
 
void PrpFrameUpdateLanId (RED_FRAME *pPrpFrame, uint16_t pathId)
 
RED_FRAMEPrpSupFrameAllocate (hsrPrpHandle *hsrPrphandle)
 Allocates a RED_FRAME that holds PRP Supervision frame. More...
 
void PrpSupFrameUpdateSrcAdd (RED_FRAME *pRedFrame, uint8_t *srcAdd)
 Updates Source Address of a PRP Supervision frame. More...
 
void PrpSupFrameUpdateLanId (RED_FRAME *pRedFrame, uint16_t lanId)
 Updates LAN ID of a PRP Supervision frame. More...
 
void PrpSupFrameUpdateSeqNr (hsrPrpHandle *hsrPrphandle, RED_FRAME *pRedFrame)
 
void PrpSupFrameUpdateTlv (RED_FRAME *pRedFrame, uint8_t type)
 
void PrpSupFrameIncrementSeqNr (hsrPrpHandle *hsrPrphandle)
 

Macro Definition Documentation

◆ ETHER_TYPE_PRP_SUP

#define ETHER_TYPE_PRP_SUP   ( ETHER_TYPE_RED_SUP )

◆ PRP_RCT_SIZE

#define PRP_RCT_SIZE   ( 6 )

PRP RCT size

◆ PRP_TRAILER_MAGIC

#define PRP_TRAILER_MAGIC   ( 0x88FB )

PRP-1 RCT Suffix

◆ PRP_TRAILER_MAGIC_BIG_ENDIAN

#define PRP_TRAILER_MAGIC_BIG_ENDIAN   ( 0xFB88 )

PRP-1 RCT Suffix in Big Endian format

◆ PRP_LAN_A_MAGIC

#define PRP_LAN_A_MAGIC   ( 0xA )

PRP-1 LAN A marker

◆ PRP_LAN_B_MAGIC

#define PRP_LAN_B_MAGIC   ( 0xB )

PRP-1 LAN B marker

◆ PRP_RCT_SEQNO_OFFSET

#define PRP_RCT_SEQNO_OFFSET   ( 0 )

Seq No : 2 bytes

◆ PRP_RCT_LANID_LSDU_OFFSET

#define PRP_RCT_LANID_LSDU_OFFSET   ( 2 )

LanID : 4 bits followed by LSDU size : 12 bits

◆ PRP_RCT_ETHTYPE_OFFSET

#define PRP_RCT_ETHTYPE_OFFSET   ( 4 )

set to 0x88FB for PRP

◆ PRP_TLV1_TYPE_DUP_DISCARD

#define PRP_TLV1_TYPE_DUP_DISCARD   ( 20 )

PRP node in Duplicate Discard mode

◆ PRP_TLV1_TYPE_DUP_ACCEPT

#define PRP_TLV1_TYPE_DUP_ACCEPT   ( 21 )

PRP node in Duplicate Accept mode

◆ PRP_SUP_SIZE

#define PRP_SUP_SIZE   ( RED_SUP_SIZE )

◆ PRP_SUP_PATH

#define PRP_SUP_PATH   ( RED_SUP_PATH )

◆ PRP_SUP_VER

#define PRP_SUP_VER   ( RED_SUP_VER )

◆ PRP_SUP_PAD

#define PRP_SUP_PAD   ( RED_SUP_PAD )

◆ PRP_MODE_MASK

#define PRP_MODE_MASK   ( 0x0 )

◆ EMAC_MODE_MASK

#define EMAC_MODE_MASK   ( 0x1 )

◆ PRP_VS_EMAC_MODE_MASK

#define PRP_VS_EMAC_MODE_MASK   ( PRP_MODE_MASK )