Standard Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_fifo_type_t type, uint32_t *outcount)
	Retrieves the FIFO counter registers that indicate the number of data elements in the IOCT channel's FIFO buffer.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetRxFIFOData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t outdata[], uint32_t *outread)
	Retrieves data elements from the IOCT channel's Receive FIFO buffer.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_SetTxFIFOData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t data[], uint32_t *outwrite)
	Loads 32-bit data elements in the IOCT channel's Transmit FIFO buffer.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_StartTransmit (int32_t cardIndex, int32_t module, int32_t channel)
	Initiates the transmission of the data in the IOCT channel's Transmit FIFO buffer.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IOCT_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ioct_status_t *outstatus)
	Retrieves the IOCT channel's status.

Detailed Description

Function Documentation

naibrd_IOCT_GetFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetFIFOCount	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_fifo_type_t	type,
		uint32_t *	outcount )

Retrieves the FIFO counter registers that indicate the number of data elements in the IOCT channel's FIFO buffer.

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]).
type	: (Input) Specify which FIFO to access, refer to nai_ioct_fifo_type_t definition
outcount	: (Output) Number of data elements in FIFO Buffer.

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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IOCT_GetRxFIFOData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetRxFIFOData	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	count,
		uint32_t	outdata[],
		uint32_t *	outread )

Retrieves data elements from the IOCT channel's Receive FIFO buffer.

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]).
count	: (Input) Number of data elements to retrieve.
outdata[]	: (Output) Array of 32-bit raw data.
outread	:(Output) Number of 32-bit data elements read from the IOCT channel's FIFO buffer.

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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IOCT_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ioct_status_t *	outstatus )

Retrieves the IOCT channel's status.

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]).
outstatus	: (Output) Channel Status, refer to nai_ioct_status_t definition.

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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IOCT_SetTxFIFOData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetTxFIFOData	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	count,
		uint32_t	data[],
		uint32_t *	outwrite )

Loads 32-bit data elements in the IOCT channel's Transmit FIFO buffer.

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]).
count	: (Input) Number of 32-bit data elements to write to FIFO.
data[]	: (Input) Array of 32-bit raw data.
outwrite	:(Output) Number of 32-bit data elements written to the D/A channel's FIFO buffer.

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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IOCT_StartTransmit()

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

Initiates the transmission of the data in the IOCT channel's Transmit FIFO buffer.

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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.