Module FIFO Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PB_GetTxFIFOCount (int32_t cardIndex, int32_t module, int32_t *p_outcount)
	Get the number of words used in the Tx FIFO.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PB_GetRxFIFOCount (int32_t cardIndex, int32_t module, int32_t *p_outcount)
	Get the number of words used in the Rx FIFO.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PB_ResetTxFIFO (int32_t cardIndex, int32_t module)
	naibrd_PB_ResetTxFIFO forces the TX FIFO to be emptied without the need to force transmission to empty the FIFO.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PB_ResetRxFIFO (int32_t cardIndex, int32_t module)
	naibrd_PB_ResetRxFIFO forces the RX FIFO to be emptied without the need to force receiving to empty the FIFO.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PB_ResetTxAndRxFIFOs (int32_t cardIndex, int32_t module)
	naibrd_PB_ResetTxAndRxFIFOs forces the TX FIFO and RX FIFO to be emptied without the need to force transmitting and receiving to empty the FIFOs.

Detailed Description

Function Documentation

naibrd_PB_GetRxFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PB_GetRxFIFOCount	(	int32_t	cardIndex,
		int32_t	module,
		int32_t *	p_outcount )

Get the number of words used in the Rx FIFO.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
p_outcount	: (Output) Number of words currently in the Rx FIFO.

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_SUPPORTED when function is not supported.

naibrd_PB_GetTxFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PB_GetTxFIFOCount	(	int32_t	cardIndex,
		int32_t	module,
		int32_t *	p_outcount )

Get the number of words used in the Tx FIFO.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
p_outcount	: (Output) Number of words currently in the Tx FIFO.

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_SUPPORTED when function is not supported.

naibrd_PB_ResetRxFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PB_ResetRxFIFO	(	int32_t	cardIndex,
		int32_t	module )

naibrd_PB_ResetRxFIFO forces the RX FIFO to be emptied without the need to force receiving to empty the FIFO.

Parameters

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

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_SUPPORTED when function is not supported.

naibrd_PB_ResetTxAndRxFIFOs()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PB_ResetTxAndRxFIFOs	(	int32_t	cardIndex,
		int32_t	module )

naibrd_PB_ResetTxAndRxFIFOs forces the TX FIFO and RX FIFO to be emptied without the need to force transmitting and receiving to empty the FIFOs.

Parameters

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

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_SUPPORTED when function is not supported.

naibrd_PB_ResetTxFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PB_ResetTxFIFO	(	int32_t	cardIndex,
		int32_t	module )

naibrd_PB_ResetTxFIFO forces the TX FIFO to be emptied without the need to force transmission to empty the FIFO.

Parameters

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

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_SUPPORTED when function is not supported.