Introduction

Include file for hsrPrp_red_nodeTable.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.

Functions
uint32_t	RedGetNodesCount (PRUICSS_Handle pruicssHandle)

RED_STATUS	RedGetIndexArrayEntry (uint8_t index, uint8_t *pEntry, ICSS_EMAC_Handle icssEmacHandle)

RED_STATUS	RedGetNodeTableEntry (RED_NODE_TABLE pNodeTable, hsrPrpHandle hsrPrphandle)
	Gets the Node Table entry by an index return by redGetIndexArrayEntry. More...

RemNodeType_t	RedGetRemNodeType (uint8_t nodeEntryStatus)
	Gets the type of a remote node. More...

RED_STATUS	RedNodetableSearchOp (uint8_t srcMacId, uint8_t port, uint8_t isSupFrame, hsrPrpHandle hsrPrphandle, uint16_t flags)
	searches for the macid in the nodetable More...

RED_STATUS	RedInsertNodeTable (uint8_t port, uint8_t isSupFrame, hsrPrpHandle *hsrPrphandle, uint16_t flags)
	makes an insertion in the node table More...

bool	RedNodetableLinearSearch (uint16_t start, uint16_t size, uint8_t macid, uint16_t index, hsrPrpHandle *hsrPrphandle)
	linear search implementation \| search for the param macid in the BIN ARRAY where starting index for search given in param start & size of search given in param size More...

void	RedNodetableRefresh (void *args)
	increment the timeLastSeenX values by 1 every 10 ms & delete a nodetable entry if it reaches NODE_FORGET_TIME More...

Function Documentation

◆ RedGetNodesCount()

uint32_t RedGetNodesCount ( PRUICSS_Handle pruicssHandle )

◆ RedGetIndexArrayEntry()

RED_STATUS RedGetIndexArrayEntry	(	uint8_t	index,
		uint8_t *	pEntry,
		ICSS_EMAC_Handle	icssEmacHandle
	)

◆ RedGetNodeTableEntry()

RED_STATUS RedGetNodeTableEntry	(	RED_NODE_TABLE *	pNodeTable,
		hsrPrpHandle *	hsrPrphandle
	)

Gets the Node Table entry by an index return by redGetIndexArrayEntry.

Parameters

pNodeTable	pointer to Node Table Structure
hsrPrphandle

Returns: RED_OK on success, RED_ERR otherwise

◆ RedGetRemNodeType()

RemNodeType_t RedGetRemNodeType ( uint8_t nodeEntryStatus )

Gets the type of a remote node.

Parameters

nodeEntryStatus value to evaluate

Returns: type of remote node

◆ RedNodetableSearchOp()

RED_STATUS RedNodetableSearchOp	(	uint8_t *	srcMacId,
		uint8_t	port,
		uint8_t	isSupFrame,
		hsrPrpHandle *	hsrPrphandle,
		uint16_t	flags
	)

searches for the macid in the nodetable

Parameters

srcMacId	source MAC address
port	Port on which the frame was recieved
isSupFrame	Supervision frame indicator bit \| set for incoming supervision frame
hsrPrphandle	Handle to hsrPrp driver instance.
flags	flag to pass info about node type

Returns: RED_OK on success, RED_ERR otherwise

◆ RedInsertNodeTable()

RED_STATUS RedInsertNodeTable	(	uint8_t	port,
		uint8_t	isSupFrame,
		hsrPrpHandle *	hsrPrphandle,
		uint16_t	flags
	)

makes an insertion in the node table

Parameters

port	Port on which the frame was recieved
isSupFrame	Supervision frame indicator bit \| set for incoming supervision frame
hsrPrphandle	Handle to hsrPrp driver instance.
flags	flag to pass info about node type

Returns: RED_OK on success, RED_ERR otherwise

◆ RedNodetableLinearSearch()

bool RedNodetableLinearSearch	(	uint16_t	start,
		uint16_t	size,
		uint8_t *	macid,
		uint16_t *	index,
		hsrPrpHandle *	hsrPrphandle
	)

linear search implementation | search for the param macid in the BIN ARRAY where starting index for search given in param start & size of search given in param size

Parameters

start	staring location
size	no of entries to be searched
macid	MAC ID of the source of the packet
index	if HIT , returns the position in BIN ARRAY where entry was found \| if MISS , position where entry to be made
hsrPrphandle	Handle to hsrPrp driver instance.

Returns: bool TRUE if HIT | FALSE if MISS

◆ RedNodetableRefresh()

void RedNodetableRefresh ( void * args )

increment the timeLastSeenX values by 1 every 10 ms & delete a nodetable entry if it reaches NODE_FORGET_TIME

Parameters

args args

Introduction

Functions

Function Documentation

◆ RedGetNodesCount()

◆ RedGetIndexArrayEntry()

◆ RedGetNodeTableEntry()

◆ RedGetRemNodeType()

◆ RedNodetableSearchOp()

◆ RedInsertNodeTable()

◆ RedNodetableLinearSearch()

◆ RedNodetableRefresh()