Software Library API naibrd 1.62
See all documentation at naii.docs.com
naibrd_ref.c File Reference
#include <stdlib.h>
#include "functions/naibrd_modCommon.h"
#include "functions/naibrd_ref.h"
#include "maps/nai_map_modCommon.h"
#include "maps/nai_map_ref.h"
#include "naibrd_config.h"
#include "naibrd_adv.h"
#include "boards/naibrd_gen5.h"

Macros

#define NAI_REF_GEN5_WATCHDOG_STATUS_MASK   0x80000000u
 
#define NAI_REF_GEN5_WATCHDOG_STATUS_SHIFT   31
 

Functions

NAIBRDFUNC int32_t NAIAPI naibrd_REF_GetChannelCount (uint32_t modid)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_value_type_t type, float64_t inValue)
 Sets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_value_type_t type, float64_t *outValue)
 Gets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_measured_type_t type, float64_t *outValue)
 Gets the measured operational values from the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inValue)
 Sets the control of a specific channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outValue)
 Retrieves the control of a specific channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetReset (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_reset_type_t type)
 Resets the channel depending on the type received.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetResetAll (int32_t cardIndex, int32_t module, nai_ref_reset_type_t type)
 Resets all of the channel depending on the type received.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified Reference channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Retrieves the enabled/disabled state of status reporting for the specified Reference channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, nai_ref_status_access_type_t accessType, uint32_t *outStatus)
 Retrieves the status for the specified Reference channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type)
 Clears the latched status for the specified REF channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetBitStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_access_type_t type, uint32_t *outstatus)
 Retrieves the latched BIT status for the specified REF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearBitStatus (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the latched BIT status for the specified REF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete)
 Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified channel. The PBIT result will be in the BIT status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetWatchdogQuietTime (int32_t cardIndex, int32_t module, uint32_t quietTime)
 Sets the quiet time duration for the watchdog timer. The watchdog timer is comprised of two parts: quiet time, and window. The quiet time is the time where a strobe is NOT expected to occur, and the window is the time where a SINGLE strobe is expected. A strobe is made by the application by calling naibrd_REF_WatchdogStrobe().
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetWatchdogQuietTime (int32_t cardIndex, int32_t module, uint32_t *outquietTime)
 Retrieves the quiet time duration for the watchdog timer. The watchdog timer is comprised of two parts: quiet time, and window. The quiet time is the time where a strobe is NOT expected to occur, and the window is the time where a SINGLE strobe is expected. A strobe is made by the application by calling naibrd_REF_WatchdogStrobe().
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetWatchdogWindow (int32_t cardIndex, int32_t module, uint32_t window)
 Sets the window that a call to naibrd_REF_WatchdogStrobe() will be made in. If a call to naibrd_REF_WatchdogStrobe() is not made by the application within the 'window' ('quiet time' + 'window'), the Watchdog Timer Fault will occur.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetWatchdogWindow (int32_t cardIndex, int32_t module, uint32_t *outwindow)
 Retrieves the window that a call to naibrd_REF_WatchdogStrobe() will be made in. If a call to naibrd_REF_WatchdogStrobe() is not made by the application within the 'window' ('quiet time' + 'window'), the Watchdog Timer Fault will occur.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_WatchdogStrobe (int32_t cardIndex, int32_t module)
 Strobes the Watchdog Timer. A SINGLE call to this function MUST be made by the application within the 'window' or a Watchdog Timer Fault will occur.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetModulePowerResetStatus (int32_t cardIndex, int32_t module, nai_ref_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 Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearModulePowerResetStatus (int32_t cardIndex, int32_t module, nai_ref_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 Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetModulePowerReset (int32_t cardIndex, int32_t module, nai_ref_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 Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetModulePowerReset (int32_t cardIndex, int32_t module, nai_ref_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 Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, bool_t enable)
 Sets the Interrupt Enable state for the specified Reference module channel and status type. When the interrupt is enabled, a fault on a channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, bool_t *outenable)
 Retrieves the Interrupt Enable state for the specified Reference module channel and status type. When the interrupt is enabled, a fault on a channel will trigger an interrupt. By default, interrupts are disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, nai_ref_edgelevel_t edgeLevel)
 Sets the Interrupt Edge/Level trigger setting for the specified Reference module channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, nai_ref_edgelevel_t *outedgeLevel)
 Retrieves the Interrupt Edge/Level trigger setting for the specified Reference module channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetInterruptVector (int32_t cardIndex, int32_t module, nai_ref_status_type_t type, uint32_t vector)
 Sets the Interrupt Vector associated with the specified status type for the specified Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetInterruptVector (int32_t cardIndex, int32_t module, nai_ref_status_type_t type, uint32_t *outvector)
 Retrieves the Interrupt Vector associated with the specified status type for the specified Reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_ref_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering, which indicates the interrupt direction, for the specified Reference module and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_ref_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering, which indicates the interrupt direction, for the specified Reference module and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelStatusRaw (int32_t cardIndex, int32_t module, uint32_t channel, nai_ref_status_access_type_t accessType, uint32_t *outstatusraw)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChannelStatusRaw (int32_t cardIndex, int32_t module, uint32_t channel)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValue (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, float64_t inValue)
 Sets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValue (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, float64_t *outValue)
 Gets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValue (int32_t cardIndex, int32_t module, nai_ref_measured_type_t type, float64_t *outValue)
 Gets the measured operational values from the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetOutputEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Sets the output on/off on the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOutputEnable (int32_t cardIndex, int32_t module, bool_t *outEnable)
 Gets the current output on/off state from the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOverCurrentStatus (int32_t cardIndex, int32_t module, bool_t *outOverCurrent)
 Gets the over current status of the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Reset (int32_t cardIndex, int32_t module, nai_ref_reset_type_t type)
 Resets any over current condition occurred on the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValueRaw (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, uint32_t inRawData)
 Sets the raw data value in the register associated to the property type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValueRaw (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, uint32_t *outRawData)
 Gets the raw data value in the register associated to the property type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValueRaw (int32_t cardIndex, int32_t module, nai_ref_measured_type_t type, uint32_t *outRawData)
 Gets the measured raw data value in the register of the reference module associated to the specified type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_SetValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, float64_t inValue)
 Sets operational properties (voltage, frequencies, ect..) for the on-board reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, float64_t *outValue)
 Gets operational properties (voltage, frequencies, ect..) for the on-board reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetMeasuredValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_measured_type_t type, float64_t *outValue)
 Gets the measured operational values from the on-board reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetOverCurrentStatus (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, bool_t *outOverCurrent)
 Gets the over current status of the on-board reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_Reset (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_reset_type_t type)
 Resets any over current condition occurred on the on-board reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_SetValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, uint32_t inRawData)
 Sets the raw data value in the register associated to the property type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, uint32_t *outRawData)
 Gets the raw data value in the register associated to the property type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetMeasuredValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_measured_type_t type, uint32_t *outRawData)
 Gets the measured raw data value in the register of the reference module associated to the specified type.
 

Macro Definition Documentation

◆ NAI_REF_GEN5_WATCHDOG_STATUS_MASK

#define NAI_REF_GEN5_WATCHDOG_STATUS_MASK   0x80000000u

◆ NAI_REF_GEN5_WATCHDOG_STATUS_SHIFT

#define NAI_REF_GEN5_WATCHDOG_STATUS_SHIFT   31

Function Documentation

◆ naibrd_REF_GetChannelCount()

NAIBRDFUNC int32_t NAIAPI naibrd_REF_GetChannelCount ( uint32_t modid)