Detailed Description

Object for supervision frame handling.

Public Member Functions
uint8_t lreSendSupFrameTaskStack[LRE_SUP_SEND_HANDLER_TASK_STACK]	__attribute__ ((aligned(32)))

uint8_t lreRcvSupFrameTaskStack[LRE_SUP_SEND_HANDLER_TASK_STACK]	__attribute__ ((aligned(32)))

Data Fields
uint32_t	enableSupSendByDriver

uint32_t	enableSupRcvByDriver

uint32_t	filterNum

uint32_t	classifierNum

uint8_t	dstMac [ETH_MAC_ADDR_LEN]

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

Member Function Documentation

◆ attribute() [1/2]

uint8_t lreSendSupFrameTaskStack [LRE_SUP_SEND_HANDLER_TASK_STACK] Lre_supervisionObj::__attribute__ ( (aligned(32)) )

Stack for the supervision frame sender task.

◆ attribute() [2/2]

uint8_t lreRcvSupFrameTaskStack [LRE_SUP_SEND_HANDLER_TASK_STACK] Lre_supervisionObj::__attribute__ ( (aligned(32)) )

Stack for the supervision frame receiver task.

Field Documentation

◆ enableSupSendByDriver

uint32_t Lre_supervisionObj::enableSupSendByDriver

Flag to enable/disable sending supervision frames by driver

◆ enableSupRcvByDriver

uint32_t Lre_supervisionObj::enableSupRcvByDriver

Flag to enable/disable receiving supervision frames by driver

◆ filterNum

uint32_t Lre_supervisionObj::filterNum

Filter to configure for supervision frames detection

◆ classifierNum

uint32_t Lre_supervisionObj::classifierNum

Classifier to decide rx queue for supervision frames

◆ dstMac

uint8_t Lre_supervisionObj::dstMac[ETH_MAC_ADDR_LEN]

◆ srcMac

uint8_t Lre_supervisionObj::srcMac[ETH_MAC_ADDR_LEN]

◆ hRxCh

EnetDma_RxChHandle Lre_supervisionObj::hRxCh[2]

DMA RX channels for received supervision frames handling

◆ rxReadyQ

EnetDma_PktQ Lre_supervisionObj::rxReadyQ[2]

Queues for getting the RX packets from driver

◆ rxFreeQ

EnetDma_PktQ Lre_supervisionObj::rxFreeQ[2]

Queues for recycling the rx dma packets

◆ hTxCh

EnetDma_TxChHandle Lre_supervisionObj::hTxCh

tx channel handle for slice 0

◆ txFreePktInfoQ

EnetDma_PktQ Lre_supervisionObj::txFreePktInfoQ

Queue of free TX packets

◆ txSubmitQ

EnetDma_PktQ Lre_supervisionObj::txSubmitQ

Queue for submitting TX packets to driver

◆ svFrame

SupervisionFrame Lre_supervisionObj::svFrame

Supervison Frame

◆ supSeqNr

uint16_t Lre_supervisionObj::supSeqNr

Supervison Frame Sequence number counter

◆ clkTimerPeriod_ms

uint64_t Lre_supervisionObj::clkTimerPeriod_ms

Timer period in milliseconds. This is the time interval after which supervision frames are sent.

◆ NodeForgetTime_ms

uint64_t Lre_supervisionObj::NodeForgetTime_ms

Node forget time in milliseconds. This is the time interval after which a node entry is cleared from the NodesTable after frames from this node cease to be received.

◆ lifecheckPeriod_ms

uint64_t Lre_supervisionObj::lifecheckPeriod_ms

Timer period in milliseconds. This is the time interval after which supervision frames are sent.

◆ taskSendSupHandlerObj

TaskP_Object Lre_supervisionObj::taskSendSupHandlerObj

Task object for the supervision frame sender task.

◆ taskRcvSupHandlerObj

TaskP_Object Lre_supervisionObj::taskRcvSupHandlerObj

Task object for the supervision frame receiver task.

◆ supTimerObj

ClockP_Object Lre_supervisionObj::supTimerObj

Timer object for the supervision frame timer.

◆ sendSupSem

SemaphoreP_Object Lre_supervisionObj::sendSupSem

Semaphore object for the supervision frame sender task.

◆ rcvSupSem

SemaphoreP_Object Lre_supervisionObj::rcvSupSem

Semaphore object for the supervision frame receiver task.