#include <chk_time_info.h>
#include <str_util.h>
#include <toolutil.h>
#include <stdio.h>

Macros
#define	_CHK_TIME_INFO

Functions
static MBG_PC_CYCLES	do_filter (CYCLES_FILTER_DATA *p, MBG_PC_CYCLES cyc)
	Compute the mean value of a number of cycles. More...

int	mbg_chk_time_info (MBG_DEV_HANDLE dh, MBG_CHK_TIME_INFO p, CYCLES_FILTER_DATA p_filter, int fast_ts_only)
	Read and evaluate a system timestamp / reference timestamp pair. More...

int	snprint_chk_time_info (char s, size_t max_len, const MBG_CHK_TIME_INFO p, const PCPS_DEV *p_dev, int frac_digits, int print_raw)
	Print info from a MBG_CHK_TIME_INFO structure into a string buffer. More...

Variables
MBG_PC_CYCLES_FREQUENCY	cyc_freq

Macro Definition Documentation

◆ _CHK_TIME_INFO

#define _CHK_TIME_INFO

Definition at line 31 of file chk_time_info.c.

Function Documentation

◆ do_filter()

static MBG_PC_CYCLES do_filter	(	CYCLES_FILTER_DATA *	p,
		MBG_PC_CYCLES	cyc
	)

static

Compute the mean value of a number of cycles.

Parameters

[in,out]	p	Address of a CYCLES_FILTER_DATA structure that needs to be updated.
[in]	cyc	The last recent cycles value to be taken into account.

Returns: The mean cycles value computed from the values in the filter structure p.

Definition at line 60 of file chk_time_info.c.

References CYCLES_FILTER_DATA::cyc, CYCLES_FILTER_DATA::entries, CYCLES_FILTER_DATA::index, MAX_CYCLES_FILTER_ENTRIES, and CYCLES_FILTER_DATA::sum.

Referenced by mbg_chk_time_info().

◆ mbg_chk_time_info()

int mbg_chk_time_info	(	MBG_DEV_HANDLE	dh,
		MBG_CHK_TIME_INFO *	p,
		CYCLES_FILTER_DATA *	p_filter,
		int	fast_ts_only
	)

Read and evaluate a system timestamp / reference timestamp pair.

The device timestamp is considered as reference timestamp.

Usually the fast_ts_only flag should be 0, in which case a PCPS_HR_TIME is read from the device in conjunction with the system timestamp.

If the fast_ts_only flag is not 0 then only a PCPS_TIME_STAMP instead of a PCPS_HR_TIME is read in conjunction with the system timestamp. In this case the call executes faster, but this is only supported if the device supports memory mapped timestamps (see chk_fast_tstamp_supp). Also, the returned data doesn't include the device status information in this case.

Once the device system timestamp / reference timestamp pair has been read successfully, the associated cycles values are evaluated to simplify further processing by the calling application.

Parameters

[in]	dh	Valid MBG_DEV_HANDLE handle to a Meinberg device.
[out]	p	Pointer to a POUT_SETTINGS_IDX structure to be written.
[in,out]	p_filter	Optional address of a CYCLES_FILTER_DATA instance associated with the device that is referenced by `dh`. If this parameter is not NULL then
[in]	fast_ts_only	A flag indicating that only a PCPS_TIME_STAMP instead of a PCPS_HR_TIME is to be read in conjunction with the system timestamp, usually 0.

Returns: MBG_SUCCESS on success, else one of the MBG_ERROR_CODES

See also: snprint_chk_time_info; mbg_get_time_info_hrt; mbg_get_time_info_tstamp

Definition at line 115 of file chk_time_info.c.

Referenced by do_mbgsvctasks().

◆ snprint_chk_time_info()

int snprint_chk_time_info	(	char *	s,
		size_t	max_len,
		const MBG_CHK_TIME_INFO *	p,
		const PCPS_DEV *	p_dev,
		int	frac_digits,
		int	print_raw
	)

Print info from a MBG_CHK_TIME_INFO structure into a string buffer.

Parameters

[out]	s	The string buffer to be filled.
[in]	max_len	Size of the output buffer for 0-terminated string.
[in]	p	Pointer to a MBG_CHK_TIME_INFO to be evaluated.
[in]	p_dev
[in]	frac_digits
[in]	print_raw