Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
General Configuration Functions
NAI Board Library - Module Functions » M1553 Module Functions

Functions

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetTimeTagRes (int16_t device, naibrd_1553_general_timeTagResolution_t timeTagResolution)
 Sets the time tag resolution of the device.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetClkFreq (int16_t device, naibrd_1553_general_clockFrequency_t clockFrequency)
 Sets the hardware clock input frequency. This function has no effect in the FTx module. NOTE: This function is not supported in FTJ/FTK modules.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetRespTimeout (int16_t device, naibrd_1553_general_responseTimeout_t responseTimeout)
 Sets the RT response timeout duration.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetDcdrCfg (int16_t device, naibrd_1553_general_decodedInput_t decodedInput, naibrd_1553_general_expandedXingOption_t expandedXingOption)
 Configure the Manchester-II decoder. This function has no effect in the FTx module. Expanded zero-crossing is always enabled for this module. NOTE: This function is not supported in FTJ/FTK modules.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetRamParityChk (int16_t device, naibrd_1553_general_ramParityCheckEnabler_t ramParityCheckEnabler)
 Enable or disable RAM parity checking. This function has no effect in the FTx module. NOTE: This function is not supported in FTJ/FTK modules.
 

Detailed Description

Function Documentation

◆ naibrd_1553_SetClkFreq()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetClkFreq ( int16_t device,
naibrd_1553_general_clockFrequency_t clockFrequency )

Sets the hardware clock input frequency. This function has no effect in the FTx module. NOTE: This function is not supported in FTJ/FTK modules.

Parameters
device: (Input) Logical Device Number (0-31).
clockFrequency: (Input) Clock Frequency to set (NAIBRD_1553_CLOCK_16MHZ, NAIBRD_1553_CLOCK_12MHZ, NAIBRD_1553_CLOCK_20MHZ, NAIBRD_1553_CLOCK_10MHZ).
Returns
  • NAI_SUCCESS
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_NOT_SUPPORTED when device is not in advanced mode or function is not supported
  • NAIBRD_1553_RC_INVALID_CLOCK_FREQUENCY when value of clockFrequency is invalid

◆ naibrd_1553_SetDcdrCfg()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetDcdrCfg ( int16_t device,
naibrd_1553_general_decodedInput_t decodedInput,
naibrd_1553_general_expandedXingOption_t expandedXingOption )

Configure the Manchester-II decoder. This function has no effect in the FTx module. Expanded zero-crossing is always enabled for this module. NOTE: This function is not supported in FTJ/FTK modules.

Parameters
device: (Input) Logical Device Number (0-31).
decodedInput: (Input) Select Input Type (NAIBRD_1553_INPUT_SINGLE_ENDED, NAIBRD_1553_INPUT_DOUBLE_ENDED).
expandedXingOption: (Input) Select Sampling Method (NAIBRD_1553_EXPANDED_XING_DISABLE, NAIBRD_1553_EXPANDED_XING_ENABLE).
Returns
  • NAI_SUCCESS
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_NOT_SUPPORTED when device is not in advanced mode or the function is not supported
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_PARAMETER when value of decodedInput or expandedXingOption is invalid

◆ naibrd_1553_SetRamParityChk()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetRamParityChk ( int16_t device,
naibrd_1553_general_ramParityCheckEnabler_t ramParityCheckEnabler )

Enable or disable RAM parity checking. This function has no effect in the FTx module. NOTE: This function is not supported in FTJ/FTK modules.

Parameters
device: (Input) Logical Device Number (0-31).
ramParityCheckEnabler: (Input) Select RAM Checking Operation (NAIBRD_1553_PARITY_CHECK_ENABLE, NAIBRD_1553_PARITY_CHECK_DISABLE).
Returns
  • NAI_SUCCESS
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1553_SetRespTimeout()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetRespTimeout ( int16_t device,
naibrd_1553_general_responseTimeout_t responseTimeout )

Sets the RT response timeout duration.

Parameters
device: (Input) Logical Device Number (0-31).
responseTimeout: (Input) Message RT Response Timeout 
* FT[1-9] module:
* NAIBRD_1553_RESP_TIMEOUT_18US
* BC Response timeout of 18.5us
*
* NAIBRD_1553_RESP_TIMEOUT_22US
* BC Response timeout of 22.5us
*
* NAIBRD_1553_RESP_TIMEOUT_50US
* BC Response timeout of 50.5us
*
* NAIBRD_1553_RESP_TIMEOUT_130US
* BC Response timeout of 130us
* 
* FTJ/FTK module:
* NAI_1760_BC_RESP_TIMEOUT_17US
* BC Response timeout of 17.0us
*
* NAI_1760_BC_RESP_TIMEOUT_22US
* BC Response timeout of 22.0us
*
* NAI_1760_BC_RESP_TIMEOUT_60US
* BC Response timeout of 60.0us
*
* NAI_1760_BC_RESP_TIMEOUT_140US
* BC Response timeout of 140.0us
*
* NAI_1760_BC_RTRT_RESP_TIMEOUT_60US
* BC RT-RT Response timeout of 60.0us
*
* NAI_1760_BC_RTRT_RESP_TIMEOUT_65US
* BC RT-RT Response timeout of 65.0us
*
* NAI_1760_BC_RTRT_RESP_TIMEOUT_100US
* BC RT-RT Response timeout of 100.0us
*
* NAI_1760_BC_RTRT_RESP_TIMEOUT_180US
* BC RT-RT Response timeout of 180.0us
*
* NAI_1760_MT_RESP_TIMEOUT_18US
* MT Response timeout of 18.0us
*
* NAI_1760_MT_RESP_TIMEOUT_23US
* MT Response timeout of 23.0us
*
* NAI_1760_MT_RESP_TIMEOUT_82US
* MT Response timeout of 82.0us
*
* NAI_1760_MT_RESP_TIMEOUT_140US
* MT Response timeout of 140.0us
*
* NAI_1760_MT_RTRT_RESP_TIMEOUT_61US
* MT RT-RT Response timeout of 61.0us
*
* NAI_1760_MT_RTRT_RESP_TIMEOUT_66US
* MT RT-RT Response timeout of 66.0us
*
* NAI_1760_MT_RTRT_RESP_TIMEOUT_122US
* MT RT-RT Response timeout of 122.0us
*
* NAI_1760_MT_RTRT_RESP_TIMEOUT_180US
* MT RT-RT Response timeout of 180.0us
*
* NAI_1760_RT_RTRT_RESP_TIMEOUT_57US
* RT RT-RT Response timeout of 57.0us
*
* NAI_1760_RT_RTRT_RESP_TIMEOUT_62US
* RT RT-RT Response timeout of 62.0us
*
* NAI_1760_RT_RTRT_RESP_TIMEOUT_100US
* RT RT-RT Response timeout of 100.0us
*
* NAI_1760_RT_RTRT_RESP_TIMEOUT_180US
* RT RT-RT Response timeout of 180.0us
*
Returns
  • NAI_SUCCESS
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_PARAMETER when value of responseTimeout is invalid

◆ naibrd_1553_SetTimeTagRes()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_SetTimeTagRes ( int16_t device,
naibrd_1553_general_timeTagResolution_t timeTagResolution )

Sets the time tag resolution of the device.

Parameters
device: (Input) Logical Device Number (0-31).
timeTagResolution: (Input) Time Tag Resolution. 
* NAIBRD_1553_TIME_TAG_2US
* 2 uS resolution
* NAIBRD_1553_TIME_TAG_4US
* 4 uS resolution
* NAIBRD_1553_TIME_TAG_8US
* 8 uS resolution
* NAIBRD_1553_TIME_TAG_16US
* 16 uS resolution
* NAIBRD_1553_TIME_TAG_32US
* 32 uS resolution
* NAIBRD_1553_TIME_TAG_64US
* 64 uS resolution
* NAIBRD_1553_TIME_TAG_TEST
* Increment manually
* NAIBRD_1553_TIME_TAG_EXTERNAL_CLOCK
* Use External Clock
*
Returns
  • NAI_SUCCESS
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_TIME_TAG_RESOLUTION when timeTagResolution input is invalid