LinuxTimestamper Class Reference

#include <linux_hal_common.hpp>

Inheritance diagram for LinuxTimestamper:

Collaboration diagram for LinuxTimestamper:

Public Member Functions
virtual	~LinuxTimestamper ()=0
virtual bool	post_init (int ifindex, int sd, TicketingLock *lock)=0
	Provides a generic method for initializing timestamp interfaces. More...
Public Member Functions inherited from HWTimestamper
virtual bool	HWTimestamper_init (InterfaceLabel *iface_label, OSNetworkInterface *iface)
	Initializes the hardware timestamp unit. More...
virtual void	HWTimestamper_final (void)
	This method is called before the object is de-allocated. More...
virtual bool	HWTimestamper_adjclockrate (float frequency_offset)
	Adjusts the hardware clock frequency. More...
virtual bool	HWTimestamper_adjclockphase (int64_t phase_adjust)
	Adjusts the hardware clock phase. More...
virtual bool	HWTimestamper_gettime (Timestamp *system_time, Timestamp *device_time, uint32_t *local_clock, uint32_t *nominal_clock_rate)=0
	Get the cross timestamping information. The gPTP subsystem uses these samples to calculate ratios which can be used to translate or extrapolate one clock into another clock reference. The gPTP service uses these supplied cross timestamps to perform internal rate estimation and conversion functions. More...
virtual int	HWTimestamper_txtimestamp (PortIdentity *identity, uint16_t sequenceId, Timestamp &timestamp, unsigned &clock_value, bool last)=0
	Gets the tx timestamp from hardware. More...
virtual int	HWTimestamper_rxtimestamp (PortIdentity *identity, uint16_t sequenceId, Timestamp &timestamp, unsigned &clock_value, bool last)=0
	Get rx timestamp. More...
virtual bool	HWTimestamper_get_extclk_offset (Timestamp *local_time, int64_t *clk_offset, int32_t *ppt_freq_offset)
	Get external clock offset. More...
virtual void	HWTimestamper_get_extderror (char *msg)
	Gets a string with the error from the hardware timestamp block. More...
virtual bool	HWTimestamper_PPS_start ()
	Starts the PPS (pulse per second) interface. More...
virtual bool	HWTimestamper_PPS_stop ()
	Stops the PPS (pulse per second) interface. More...
int	getVersion ()
	Gets the HWTimestamper version. More...
	HWTimestamper ()

Additional Inherited Members
Protected Attributes inherited from HWTimestamper
uint8_t	version
	HWTimestamper version.

Detailed Description

LinuxTimestamper: Provides a generic hardware timestamp interface for linux based systems.

Constructor & Destructor Documentation

virtual LinuxTimestamper::~LinuxTimestamper ( )

pure virtual

Destructor

Member Function Documentation

virtual bool LinuxTimestamper::post_init ( int  ifindex, int  sd, TicketingLock *  lock  )

pure virtual

Provides a generic method for initializing timestamp interfaces.

Parameters

ifindex	Network device interface index
sd	Socket descriptor
lock	[in] Pointer to ticketing Lock object

Returns

TRUE if success, FALSE in case of error

Implemented in LinuxTimestamperGeneric, and LinuxTimestamperIntelCE.

---

The documentation for this class was generated from the following file:

• linux_hal_common.hpp