Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
AR-579 Time Stamping Functions
NAI Board Library - Module Functions » AR Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_GetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Reads the time stamp enable status of the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_ResetTimeStamp (int32_t cardIndex, int32_t module)
 Resets the time stamp for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t resolution)
 Sets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t *p_outresolution)
 Gets the time stamp resolution for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetModuleTimeStamp (int32_t cardIndex, int32_t module, uint32_t *p_outtimeStamp)
 Reads the time stamp for the module specified. The time stamp resolution can be retrieved by calling naibrd_AR579_GetTimeStampResolution().
 

Detailed Description

Function Documentation

◆ naibrd_AR579_GetModuleTimeStamp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetModuleTimeStamp ( int32_t cardIndex,
int32_t module,
uint32_t * p_outtimeStamp )

Reads the time stamp for the module specified. The time stamp resolution can be retrieved by calling naibrd_AR579_GetTimeStampResolution().

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]).
p_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_AR579_GetRxTimeStampEn()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetRxTimeStampEn ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_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]).
p_outenable: (Output) Enabled (TRUE) or Disabled (FALSE).
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_AR579_GetTimeStampResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_GetTimeStampResolution ( int32_t cardIndex,
int32_t module,
naibrd_ar_tstamp_t * p_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]).
p_outresolution: (Output) Time stamp resolution. 
   NAIBRD_AR_TSTAMP_1US   : 1us
   NAIBRD_AR_TSTAMP_10US  : 10us
   NAIBRD_AR_TSTAMP_100US : 100us
   NAIBRD_AR_TSTAMP_1MS   : 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_INVALID_VALUE when invalid resolution is detected by the function.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR579_ResetTimeStamp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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_AR579_SetRxTimeStampEn()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_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 (TRUE) or Disable (FALSE).
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_AR579_SetTimeStampResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR579_SetTimeStampResolution ( int32_t cardIndex,
int32_t module,
naibrd_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. 
   NAIBRD_AR_TSTAMP_1US   : 1us
   NAIBRD_AR_TSTAMP_10US  : 10us
   NAIBRD_AR_TSTAMP_100US : 100us
   NAIBRD_AR_TSTAMP_1MS   : 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_INVALID_VALUE when invalid resolution is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.