Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Module Health Monitoring Functions
Core Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetModuleHealthMonitor (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_module_health_monitor_value_type_t moduleHealthMonitorValueType, float64_t moduleHealthMonitorValue)
 Sets the module health monitor threshold based on the module health monitor type and module health monitor value (threshold) type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitor (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_module_health_monitor_value_type_t moduleHealthMonitorValueType, float64_t *p_outmoduleHealthMonitorValue)
 Retrieves the module health monitor value based on the module health monitor type and module health monitor value type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorStatus (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_module_health_monitor_status_type_t moduleHealthMonitorStatusType, nai_status_bit_t *p_outstatusBit)
 Retrieves the module health monitor status based on the module health monitor type and module health monitor status type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorSummaryStatus (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_status_bit_t *p_outstatusBit)
 Retrieves the module health monitor summary status based on the module health monitor type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SetModuleHealthMonitorRaw (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_module_health_monitor_value_type_t moduleHealthMonitorValueType, uint32_t rawModuleHealthMonitorValue)
 Sets the module health monitor threshold raw register value based on the module health monitor type and module health monitor value (threshold) type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorRaw (int32_t cardIndex, int32_t module, nai_module_health_monitor_type_t moduleHealthMonitorType, nai_module_health_monitor_value_type_t moduleHealthMonitorValueType, uint32_t *p_outrawModuleHealthMonitorValue)
 Retrieves the module health monitor raw register value based on the module health monitor type and module health monitor value type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorSummaryStatusRaw (int32_t cardIndex, int32_t module, uint32_t *p_outrawStatus)
 Retrieves the raw value in the module health monitor summary status register. This feature is only available on the Xilinx Generation 5 platforms.
 

Detailed Description


Function Documentation

◆ naibrd_GetModuleHealthMonitor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitor ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_module_health_monitor_value_type_t moduleHealthMonitorValueType,
float64_t * p_outmoduleHealthMonitorValue )

Retrieves the module health monitor value based on the module health monitor type and module health monitor value type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
moduleHealthMonitorValueType: (Input) Module Health Monitor Value type: refer to nai_module_health_monitor_value_type_t definition.
p_outmoduleHealthMonitorValue: (Output) Floating-point module health monitor value read from 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_VALUE when invalid moduleHealthMonitorType or invalid moduleHealthMonitorValueType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetModuleHealthMonitorRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorRaw ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_module_health_monitor_value_type_t moduleHealthMonitorValueType,
uint32_t * p_outrawModuleHealthMonitorValue )

Retrieves the module health monitor raw register value based on the module health monitor type and module health monitor value type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
moduleHealthMonitorValueType: (Input) Module Health Monitor Value type: refer to nai_module_health_monitor_value_type_t definition.
p_outrawModuleHealthMonitorValue: (Output) Raw module health monitor value read from 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_VALUE when invalid moduleHealthMonitorType or invalid moduleHealthMonitorValueType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetModuleHealthMonitorStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorStatus ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_module_health_monitor_status_type_t moduleHealthMonitorStatusType,
nai_status_bit_t * p_outstatusBit )

Retrieves the module health monitor status based on the module health monitor type and module health monitor status type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
moduleHealthMonitorStatusType: (Input) Module Health Monitor Status type: refer to nai_module_health_monitor_status_type_t definition.
p_outstatusBit: (Output) Status bit read from 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_VALUE when invalid moduleHealthMonitorType or invalid moduleHealthMonitorStatusType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetModuleHealthMonitorSummaryStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorSummaryStatus ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_status_bit_t * p_outstatusBit )

Retrieves the module health monitor summary status based on the module health monitor type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
p_outstatusBit: (Output) Status bit read from 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_VALUE when invalid moduleHealthMonitorType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetModuleHealthMonitorSummaryStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleHealthMonitorSummaryStatusRaw ( int32_t cardIndex,
int32_t module,
uint32_t * p_outrawStatus )

Retrieves the raw value in the module health monitor summary status register. This feature is only available on the Xilinx Generation 5 platforms.

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_outrawStatus: (Output) Raw status register value read from 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SetModuleHealthMonitor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetModuleHealthMonitor ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_module_health_monitor_value_type_t moduleHealthMonitorValueType,
float64_t moduleHealthMonitorValue )

Sets the module health monitor threshold based on the module health monitor type and module health monitor value (threshold) type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
moduleHealthMonitorValueType: (Input) Module Health Monitor Value (threshold) type: refer to nai_module_health_monitor_value_type_t definition. Note that only the threshold types are valid for this function, since these are the only module health monitor value types that can be set.
moduleHealthMonitorValue: (Input) Floating-point module health monitor threshold to set.
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_VALUE when invalid moduleHealthMonitorType or invalid moduleHealthMonitorValueType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SetModuleHealthMonitorRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetModuleHealthMonitorRaw ( int32_t cardIndex,
int32_t module,
nai_module_health_monitor_type_t moduleHealthMonitorType,
nai_module_health_monitor_value_type_t moduleHealthMonitorValueType,
uint32_t rawModuleHealthMonitorValue )

Sets the module health monitor threshold raw register value based on the module health monitor type and module health monitor value (threshold) type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleHealthMonitorType: (Input) Module Health Monitor type: refer to nai_module_health_monitor_type_t definition.
moduleHealthMonitorValueType: (Input) Module Health Monitor Value (threshold) type: refer to nai_module_health_monitor_value_type_t definition. Note that only the threshold types are valid for this function, since these are the only module health monitor value types that can be set.
rawModuleHealthMonitorValue: (Input) Raw module health monitor threshold to set.
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_VALUE when invalid moduleHealthMonitorType or invalid moduleHealthMonitorValueType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.