Time Stamping 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 *p_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_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_AR_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_AR_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_AR_GetTimeStampResolution().

Detailed Description

Function Documentation

naibrd_AR_GetModuleTimeStamp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_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_AR_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_AR_GetRxTimeStampEn()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_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 (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_GetTimeStampResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_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_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_SetTimeStampResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_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.