com_queue.h File Reference

#include "com_defs.h"

Include dependency graph for com_queue.h:

Enumerations
enum	ComQueue_e

Functions
ComStatus_tv	ComQueueAdd (uint8_t ubNetV, uint8_t ubQueueIndexV, CpCanMsg_ts *ptsCanMsgV)
ComStatus_tv	ComQueueClear (uint8_t ubNetV, uint8_t ubQueueIndexV)
ComStatus_tv	ComQueueFetch (uint8_t ubNetV, uint8_t ubQueueIndexV, CpCanMsg_ts *ptsCanMsgV)
ComStatus_tv	ComQueueConfigure (uint8_t ubNetV, uint8_t ubQueueIndexV)
ComStatus_tv	ComQueueInit (uint8_t ubNetV)
ComStatus_tv	ComQueuePending (uint8_t ubNetV, uint8_t ubQueueIndexV)
ComStatus_tv	ComQueueRelease (uint8_t ubNetV, uint8_t ubQueueIndexV)

Enumeration Type Documentation

ComQueue_e

enum ComQueue_e

Queue assignments.

The enumeration defines the queue assignments to different services.

Enumerator
eCOM_QUEUE_RPDO
eCOM_QUEUE_EMCY
eCOM_QUEUE_MAX

Function Documentation

ComQueueAdd()

ComStatus_tv ComQueueAdd	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV,
		CpCanMsg_ts *	ptsCanMsgV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e
[in]	ptsCanMsgV	Pointer to CANpie FD message structure

Returns

Value of enumeration ComErr_e

Add CANpie message to selected queue defined by queue index ubQueueIndexV.

ComQueueClear()

ComStatus_tv ComQueueClear	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e

Returns

Value of enumeration ComErr_e

Clear selected queue

ComQueueConfigure()

ComStatus_tv ComQueueConfigure	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e

Returns

Value of enumeration ComErr_e

Enable a queue for the selected ubQueueIndexV.

ComQueueFetch()

ComStatus_tv ComQueueFetch	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV,
		CpCanMsg_ts *	ptsCanMsgV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e
[out]	ptsCanMsgV	Pointer to CANpie FD message structure

Returns

Value of enumeration ComErr_e

Fetch CANpie FD message from selected queue.

ComQueueInit()

ComStatus_tv ComQueueInit

(

uint8_t

ubNetV

)

Parameters

[in]

ubNetV

CANopen Network channel

Returns

Value of enumeration ComErr_e

Initialize all queues for network ubNetV.

ComQueuePending()

ComStatus_tv ComQueuePending	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e

Returns

Number of pending entries within of the queue or eCOM_ERR_PARM from ComErr_e if requested queue does not exist.

Get number of pending entries within of defined queue

ComQueueRelease()

ComStatus_tv ComQueueRelease	(	uint8_t	ubNetV,
		uint8_t	ubQueueIndexV )

Parameters

[in]	ubNetV	CANopen Network channel
[in]	ubQueueIndexV	Queue index defined by ComQueue_e

Returns

Value of enumeration ComErr_e

Disable a queue defined by parameter ubQueueIndexV.