Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Serial Advanced BIT Functions
NAI Board Library - Module Functions » SER Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetModuleBITEnable (int32_t cardIndex, int32_t module, uint32_t bitEnable)
 Executes the Initiated BIT test for the specified channels in bitEnable. Use this function if you want to run IBIT on more than one channel at a time. Otherwise use naibrd_SER_InitiateBIT().
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetModuleBITEnable (int32_t cardIndex, int32_t module, uint32_t *p_outbitEnable)
 Retrieves the state (enabled or disabled) of the Initiated BIT test on all channels. Once the IBIT test is enabled by calling naibrd_SER_SetModuleBITEnable() use this function to check if the test has completed by verifying the bits set have cleared.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t threshold)
 Sets the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t *p_outthreshold)
 Retrieves the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearModuleBITLogic (int32_t cardIndex, int32_t module, int32_t channel)
 Resets the Continuous BIT internal circuitry and counter mechanism for the specified channel.
 

Detailed Description

Function Documentation

◆ naibrd_SER_ClearModuleBITLogic()

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

Resets the Continuous BIT internal circuitry and counter mechanism for the specified channel.

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]).
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 the function is not supported.

◆ naibrd_SER_GetModuleBITEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetModuleBITEnable ( int32_t cardIndex,
int32_t module,
uint32_t * p_outbitEnable )

Retrieves the state (enabled or disabled) of the Initiated BIT test on all channels. Once the IBIT test is enabled by calling naibrd_SER_SetModuleBITEnable() use this function to check if the test has completed by verifying the bits set have cleared.

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_outbitEnable: (Output) IBIT enabled (0 = disabled, 1 = enabled), bit mapped per channel.
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 the function is not supported.

◆ naibrd_SER_GetModuleBITErrorThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetModuleBITErrorThreshold ( int32_t cardIndex,
int32_t module,
uint32_t * p_outthreshold )

Retrieves the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.

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_outthreshold: (Output) The current BIT Error Threshold.
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 the function is not supported.

◆ naibrd_SER_SetModuleBITEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetModuleBITEnable ( int32_t cardIndex,
int32_t module,
uint32_t bitEnable )

Executes the Initiated BIT test for the specified channels in bitEnable. Use this function if you want to run IBIT on more than one channel at a time. Otherwise use naibrd_SER_InitiateBIT().

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]).
bitEnable: (Input) The channels to enable IBIT on, bit mapped per channel.
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 the function is not supported.

◆ naibrd_SER_SetModuleBITErrorThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetModuleBITErrorThreshold ( int32_t cardIndex,
int32_t module,
uint32_t threshold )

Sets the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.

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]).
threshold: (Input) BIT Error Threshold to set (Default Value = 5u, Max Value = 0xFFFFu).
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 the function is not supported.