HSR/PRP Common Driver APIs

Introduction

Functions
void	RedProtocolInit (void)
	Assigns key function pointers based on macro. More...
void	RedNodeTableClear (hsrPrpHandle *hsrPrphandle)
	Sets Clear Node Table flag to be used by PRU. More...
void	RedIncrementCounter (uint32_t offset, PRUICSS_Handle pruicssHandle)
	Increments statistics counter. More...
void	RedSupFrameUpdateTlv (hsrPrpHandle *hsrPrphandle, uint8_t type)
int32_t	RedTxPacket (void *icssEmachandle, ICSS_EMAC_TxArgument *txArg, void *userArg)
	Enqueues redundancy frames to transmit. More...
int32_t	RedRxPktGet (void *icssEmachandle, ICSS_EMAC_RxArgument *rxVoidArg, void *userArg)
	Copies data from L3 receive queues. More...
RED_STATUS	RedLifeCheckTaskCreate (hsrPrpHandle *hsrPrphandle, PRUICSS_Handle pruicssHandle)
	Function to create RED Supervision task. More...
void	RedLifeCheckTaskDelete (hsrPrpHandle *hsrPrphandle)
	Function to delete RED Supervision task. More...
RED_STATUS	RedProtocolStart (hsrPrpHandle *hsrPrphandle, PRUICSS_Handle pruicssHandle)
	Function to start RedProtocolStart. More...
void	RedProtocolConfigure (PRUICSS_Handle pruicssHandle)
	Configure IEP to modify max frame size (to acccount for LRE header) More...
void	RedProtocolStop (hsrPrpHandle *hsrPrphandle, PRUICSS_Handle pruicssHandle)
	Delete Node Table check Task. More...

Function Documentation

RedProtocolInit()

void RedProtocolInit

(

void

)

Assigns key function pointers based on macro.

RedNodeTableClear()

void RedNodeTableClear

(

hsrPrpHandle *

hsrPrphandle

)

Sets Clear Node Table flag to be used by PRU.

Parameters

hsrPrphandle

RedIncrementCounter()

void RedIncrementCounter	(	uint32_t	offset,
		PRUICSS_Handle	pruicssHandle
	)

Increments statistics counter.

Parameters

offset	Counter
pruicssHandle	Pointer to PRU ICSS Handle, parent structure containing all switch information

RedSupFrameUpdateTlv()

void RedSupFrameUpdateTlv	(	hsrPrpHandle *	hsrPrphandle,
		uint8_t	type
	)

RedTxPacket()

int32_t RedTxPacket	(	void *	icssEmachandle,
		ICSS_EMAC_TxArgument *	txArg,
		void *	userArg
	)

Enqueues redundancy frames to transmit.

Parameters

icssEmachandle
txArg
userArg

Returns

RED_OK on success, RED_ERR otherwise

RedRxPktGet()

int32_t RedRxPktGet	(	void *	icssEmachandle,
		ICSS_EMAC_RxArgument *	rxVoidArg,
		void *	userArg
	)

Copies data from L3 receive queues.

Parameters

icssEmachandle
rxVoidArg
userArg

Returns

RED_OK(0) on success, RED_ERR(1) otherwise

RedLifeCheckTaskCreate()

RED_STATUS RedLifeCheckTaskCreate	(	hsrPrpHandle *	hsrPrphandle,
		PRUICSS_Handle	pruicssHandle
	)

Function to create RED Supervision task.

Parameters

hsrPrphandle
pruicssHandle	Pointer to PRU ICSS Handle, parent structure containing all switch information

Returns

RED_OK(0) if success, RED_ERR(1) otherwise

RedLifeCheckTaskDelete()

void RedLifeCheckTaskDelete

(

hsrPrpHandle *

hsrPrphandle

)

Function to delete RED Supervision task.

Parameters

hsrPrphandle

RedProtocolStart()

RED_STATUS RedProtocolStart	(	hsrPrpHandle *	hsrPrphandle,
		PRUICSS_Handle	pruicssHandle
	)

Function to start RedProtocolStart.

Parameters

hsrPrphandle
pruicssHandle	Pointer to PRU ICSS Handle, parent structure containing all switch information

RedProtocolConfigure()

void RedProtocolConfigure

(

PRUICSS_Handle

pruicssHandle

)

Configure IEP to modify max frame size (to acccount for LRE header)

Parameters

pruicssHandle

Pointer to PRU ICSS Handle, parent structure containing all switch information

RedProtocolStop()

void RedProtocolStop	(	hsrPrpHandle *	hsrPrphandle,
		PRUICSS_Handle	pruicssHandle
	)

Delete Node Table check Task.

Parameters

hsrPrphandle
pruicssHandle	Pointer to PRU ICSS Handle, parent structure containing all switch information