Reset Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel)
	Resets both the transmit and receive FIFO buffers and UART for the specified channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel)
	Resets the receive FIFO buffer for the specified channel. This will flush the data from the FIFO.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel)
	Resets the transmit FIFO buffer for the specified channel. This will flush the data from the FIFO.

Detailed Description

Function Documentation

naibrd_SER_ChannelReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ChannelReset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Resets both the transmit and receive FIFO buffers and UART for the specified channel.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_SER_ClearRxFifo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearRxFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Resets the receive FIFO buffer for the specified channel. This will flush the data from the FIFO.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_SER_ClearTxFifo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearTxFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Resets the transmit FIFO buffer for the specified channel. This will flush the data from the FIFO.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.