Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Time Stamping Functions
ARINC Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables time stamping for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Reads the time stamp enable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetTimeStamp (int32_t cardIndex, int32_t module)
 Resets the time stamp for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_PLLErrorCount (int32_t cardIndex, int32_t module, uint32_t *outcount)
 Returns the count of how many times the phase-locked loop (PLL) lost lock. The count resets to 0 upon calling this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeStampRsln (int32_t cardIndex, int32_t module, nai_ar_tstamp_t resolution)
 Sets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeStampRsln (int32_t cardIndex, int32_t module, nai_ar_tstamp_t *outresolution)
 Gets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetModuleTimeStamp (int32_t cardIndex, int32_t module, int32_t *outtimestamp)
 Reads the time stamp for the module specified.
 

Detailed Description


Function Documentation

◆ naibrd_AR_GetModuleTimeStamp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetModuleTimeStamp ( int32_t cardIndex,
int32_t module,
int32_t * outtimestamp )

Reads the time stamp for the module specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
outtimestamp: (Output) Timestamp value.
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_SUPPORTED when function is not supported.

◆ naibrd_AR_GetRxTimeStampEn()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxTimeStampEn ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Reads the time stamp enable status of the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
outenable: (Output) Enabled (1) or Disabled (0).
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_CHANNEL when invalid channel parameter is specified.

◆ naibrd_AR_GetTimeStampRsln()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeStampRsln ( int32_t cardIndex,
int32_t module,
nai_ar_tstamp_t * outresolution )

Gets the time stamp resolution for the module specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
outresolution: (Output) Time stamp resolution. 
   0 : 1us
   1 : 10us
   2 : 100us
   3 : 1ms
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_SUPPORTED when function is not supported.

◆ naibrd_AR_PLLErrorCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_PLLErrorCount ( int32_t cardIndex,
int32_t module,
uint32_t * outcount )

Returns the count of how many times the phase-locked loop (PLL) lost lock. The count resets to 0 upon calling this function.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
outcount: (Output) Count of how many times PLL lost lock.
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_SUPPORTED when function is not supported.

◆ naibrd_AR_ResetTimeStamp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetTimeStamp ( int32_t cardIndex,
int32_t module )

Resets the time stamp for the module specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
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_SUPPORTED when function is not supported.

◆ naibrd_AR_SetRxTimeStampEn()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxTimeStampEn ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables or disables time stamping for the channel specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
enable: (Input) Enable (1) or Disable (0).
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetTimeStampRsln()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeStampRsln ( int32_t cardIndex,
int32_t module,
nai_ar_tstamp_t resolution )

Sets the time stamp resolution for the module specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
resolution: (Input) Time stamp resolution. 
   0 : 1us
   1 : 10us
   2 : 100us
   3 : 1ms
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_SUPPORTED when function is not supported.