ar_get_rx_channel_status

short ar_get_rx_channel_status (short board, short channel, unsigned int * channelStatus, unsigned int * messageCount);

Purpose

This function supplies the current status of the specified receive channel buffer, including detection of either a buffer overflow or ARINC 429 protocol error and the current buffer fill level.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-127).

channel

short

(input) Receive channel of the board to reference, (valid range is 0-31).

Name

Type

Description

channelStatus

unsigned int (passed by reference)

(output) Bit-wise representation of the respective receiver’s Channel Status Register bits 0-2.  The Status Register Bit Assignments are defined as follows:
b0 - An unread ARINC 429 Message is Available (AR_BUFFER_MSG_AVAILABLE)
b1 - An invalid ARINC 429 Message was received since the buffer was last queried (AR_INVALID_MSG_DETECTED)
b2 - A buffer overflow was encountered (AR_BUFFER_OVERFLOW_DETECTED)

messageCount

unsigned int (passed by reference)

(output) Buffer file level, acquired from the most significant 16 bits of the status register; valid only if channelStatus bit 0 is set, with a valid range from 1 – 2047.

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL            Routine execution was successful.

ARS_INVHARVAL       The channel parameter value was invalid. 

ARS_INVARG            The channelStatus or messageCount parameter was null. ARS_INVBOARD        The board parameter value was invalid. 

References

Status Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description