Serial BIT Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_InitiateBIT (int32_t cardIndex, int32_t module, int32_t channel, bool_t waitForResult)
	Executes the serial Built-in Test and returns the result. The BIT requires the user to disable the channel prior to executing this test. If the user chooses to wait for the result (waitForResult = NAI_TRUE) then the result of the test is returned in the status, either as NAI_SUCCESS or NAI_ERROR_BIT_FAILED. If the user chooses not to wait for the result, they can call naibrd_SER_CheckBITComplete() and naibrd_SER_GetChanMappedStatus() at a later time to verify the test has completed and fetch the BIT status.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_CheckBITComplete (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outbitComplete)
	Retrieves the initiate BIT status (complete or incomplete) of the channel specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SER_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete)
	Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for all channels. The PBIT result will be in the BIT status register.

Detailed Description

Function Documentation

naibrd_SER_CheckBITComplete()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_CheckBITComplete	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	p_outbitComplete )

Retrieves the initiate BIT status (complete or incomplete) of the channel specified.

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]).
p_outbitComplete	: (Output) NAI_FALSE = BIT not done, NAI_TRUE = BIT complete.

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_CheckPowerOnBITComplete()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_CheckPowerOnBITComplete	(	int32_t	cardIndex,
		int32_t	module,
		bool_t *	p_outpbitComplete )

Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for all channels. The PBIT result will be in the BIT status register.

Note

This feature is only available on SC3 modules with FPGA revision >= 1.0.

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]).
p_outpbitComplete	: (Output) NAI_TRUE = PBIT complete, NAI_FALSE = PBIT not complete.

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_NOT_SUPPORTED when the module does not support Power-On BIT.

naibrd_SER_InitiateBIT()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_InitiateBIT	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	waitForResult )

Executes the serial Built-in Test and returns the result. The BIT requires the user to disable the channel prior to executing this test. If the user chooses to wait for the result (waitForResult = NAI_TRUE) then the result of the test is returned in the status, either as NAI_SUCCESS or NAI_ERROR_BIT_FAILED. If the user chooses not to wait for the result, they can call naibrd_SER_CheckBITComplete() and naibrd_SER_GetChanMappedStatus() at a later time to verify the test has completed and fetch the BIT status.

Warning

For the Built-In-Test to run, the channel needs to be disabled. For modules with more than four channels, the channels need be disabled in pairs ex (1&2, 3&4, etc.). If both channels are not disabled, it will cause this function to return NAI_ERROR_TIMEOUT.

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]).
waitForResult	: (Input) This allows this API to either wait for the BIT result before returning or return immediately after BIT is initiated. When returning immediately, please allow more than 5mS for the BIT to complete. Calling naibrd_SER_GetChanMappedStatus() after BIT is complete will return the results of the last executed test, regardless if this API returns immediately or after the test is complete.

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.
• NAI_ERROR_TIMEOUT when BIT times out (does not finish in time allotted or user forgot to disable respective channels).
• NAI_ERROR_BIT_FAILED when the BIT indicates a failure.