HSR/PRP Common Driver APIs

Introduction

Functions
void	LRE_open (Lre_Handle lreHandle)
	Opens the LRE driver. More...
int32_t	LRE_supervisionInit (Lre_Handle lreHandle)
	Initializes the LRE supervision object. More...
void	LRE_nodesTableInit (Lre_nodestableObj *ntObj)
	Initializes the nodestable. More...
void	LRE_updateNodeEntry (NodesTable *table, const uint8_t *src_mac, uint16_t sequence_number, uint8_t port, Lre_NodeType node_type)
	Updates the node entry in the node table. More...
void	LRE_checkNodeTimeouts (NodesTable *table)
	Checks the node timeouts. More...
void	LRE_printNodesTable (Lre_Handle lreHandle)
	Prints the current state of the node table. More...
void	LRE_supervisionDeinit (Lre_Handle lreHandle)
	Deinitializes the supervision module. More...
void	LRE_statisticsInit (Lre_Handle lreHandle)
	Initializes the statistics object. More...
void	LRE_getStatistics (Lre_Handle lreHandle)
	Updates the LRE statistics. More...

Function Documentation

LRE_open()

void LRE_open

(

Lre_Handle

lreHandle

)

Opens the LRE driver.

This function is called to open the LRE driver.

Parameters

lreHandle

LRE handle

LRE_supervisionInit()

int32_t LRE_supervisionInit

(

Lre_Handle

lreHandle

)

Initializes the LRE supervision object.

This function initializes the LRE supervision object by setting the different fields with required values.

Parameters

lreHandle

LRE handle

Returns

Status of the function call

LRE_nodesTableInit()

void LRE_nodesTableInit

(

Lre_nodestableObj *

ntObj

)

Initializes the nodestable.

This function is called to initialize the nodestable.

Parameters

ntObj

LRE nodestable object

LRE_updateNodeEntry()

void LRE_updateNodeEntry	(	NodesTable *	table,
		const uint8_t *	src_mac,
		uint16_t	sequence_number,
		uint8_t	port,
		Lre_NodeType	node_type
	)

Updates the node entry in the node table.

This function is called to update the node entry in the node table.

Parameters

table	Pointer to the NodesTable.
src_mac	Pointer to the source MAC address.
sequence_number	Sequence number (host byte order).
port	The port on which SV frame was received
node_type	Type of the remote node.

LRE_checkNodeTimeouts()

void LRE_checkNodeTimeouts

(

NodesTable *

table

)

Checks the node timeouts.

This function is called to check the node timeouts.

Parameters

table

Pointer to the NodesTable.

LRE_printNodesTable()

void LRE_printNodesTable

(

Lre_Handle

lreHandle

)

Prints the current state of the node table.

This function is called to print the current state of the node table.

Parameters

lreHandle

LRE handle

LRE_supervisionDeinit()

void LRE_supervisionDeinit

(

Lre_Handle

lreHandle

)

Deinitializes the supervision module.

This function is called to deinitialize the supervision module.

Parameters

lreHandle

LRE handle

LRE_statisticsInit()

void LRE_statisticsInit

(

Lre_Handle

lreHandle

)

Initializes the statistics object.

This function is called to clear out the statistics.

Parameters

lreHandle

LRE handle

LRE_getStatistics()

void LRE_getStatistics

(

Lre_Handle

lreHandle

)

Updates the LRE statistics.

Parameters

lreHandle

LRE handle