Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Module Power Reset Functions
NAI Board Library - Module Functions » AD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModulePowerResetStatus (int32_t cardIndex, int32_t module, naibrd_ad_module_power_reset_status_type_t modulePowerResetStatusType, bool_t *p_outmodulePowerResetStatusBit)
 Retrieves the bit specified by the module power reset status type from the module power reset status register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearModulePowerResetStatus (int32_t cardIndex, int32_t module, naibrd_ad_module_power_reset_status_type_t modulePowerResetStatusType)
 Clears the bit specified by the module power reset status type in the module power reset status register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetModulePowerReset (int32_t cardIndex, int32_t module, naibrd_ad_module_power_reset_type_t modulePowerResetType, bool_t modulePowerResetBit)
 Sets the bit specified by the module power reset type in the module power reset register for the specified A/D module. If the bit was set, the hardware will acknowledge it by setting the corresponding bit back to 0. Feature supported in Motherboard FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModulePowerReset (int32_t cardIndex, int32_t module, naibrd_ad_module_power_reset_type_t modulePowerResetType, bool_t *p_outmodulePowerResetBit)
 Retrieves the bit specified by the module power reset type from the module power reset register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.
 

Detailed Description

Function Documentation

◆ naibrd_AD_ClearModulePowerResetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearModulePowerResetStatus ( int32_t cardIndex,
int32_t module,
naibrd_ad_module_power_reset_status_type_t modulePowerResetStatusType )

Clears the bit specified by the module power reset status type in the module power reset status register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.

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]).
modulePowerResetStatusType: (Input) A/D Module Power Reset Status Type: refer to naibrd_ad_module_power_reset_status_type_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid modulePowerResetStatusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetModulePowerReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModulePowerReset ( int32_t cardIndex,
int32_t module,
naibrd_ad_module_power_reset_type_t modulePowerResetType,
bool_t * p_outmodulePowerResetBit )

Retrieves the bit specified by the module power reset type from the module power reset register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.

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]).
modulePowerResetType: (Input) A/D Module Power Reset Type: refer to naibrd_ad_module_power_reset_type_t definition.
p_outmodulePowerResetBit: (Output) 1 if bit is set, 0 if bit is cleared.
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_VALUE when invalid modulePowerResetType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetModulePowerResetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetModulePowerResetStatus ( int32_t cardIndex,
int32_t module,
naibrd_ad_module_power_reset_status_type_t modulePowerResetStatusType,
bool_t * p_outmodulePowerResetStatusBit )

Retrieves the bit specified by the module power reset status type from the module power reset status register for the specified A/D module. Feature supported in Motherboard FPGA Version >= X.X.

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]).
modulePowerResetStatusType: (Input) A/D Module Power Reset Status Type: refer to naibrd_ad_module_power_reset_status_type_t definition.
p_outmodulePowerResetStatusBit: (Output) 1 if bit is set, 0 if bit is cleared.
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_VALUE when invalid modulePowerResetStatusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_SetModulePowerReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetModulePowerReset ( int32_t cardIndex,
int32_t module,
naibrd_ad_module_power_reset_type_t modulePowerResetType,
bool_t modulePowerResetBit )

Sets the bit specified by the module power reset type in the module power reset register for the specified A/D module. If the bit was set, the hardware will acknowledge it by setting the corresponding bit back to 0. Feature supported in Motherboard FPGA Version >= X.X.

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]).
modulePowerResetType: (Input) A/D Module Power Reset Type: refer to naibrd_ad_module_power_reset_type_t definition.
modulePowerResetBit: (Input) 1 to set, 0 to clear.
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_VALUE when invalid modulePowerResetType parameter or invalid modulePowerResetBit parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.