LinuxTimestamperIntelCE Class Reference

#include <linux_hal_intelce.hpp>

Inheritance diagram for LinuxTimestamperIntelCE:

Collaboration diagram for LinuxTimestamperIntelCE:

Public Member Functions
virtual bool	HWTimestamper_init (InterfaceLabel *iface_label, OSNetworkInterface *iface)
	Initializes the hardware timestamp unit. More...
virtual int	HWTimestamper_txtimestamp (PortIdentity *identity, uint16_t sequenceId, Timestamp &timestamp, unsigned &clock_value, bool last)
	Gets the TX hardware timestamp value. More...
virtual int	HWTimestamper_rxtimestamp (PortIdentity *identity, uint16_t sequenceId, Timestamp &timestamp, unsigned &clock_value, bool last)
	Gets the RX hardware timestamp value. More...
bool	post_init (int ifindex, int sd, TicketingLock *lock)
	Post initialization procedure. Configures hardware ptp filter. More...
virtual	~LinuxTimestamperIntelCE ()
	LinuxTimestamperIntelCE ()
virtual bool	HWTimestamper_gettime (Timestamp *system_time, Timestamp *device_time, uint32_t *local_clock, uint32_t *nominal_clock_rate)
	Gets time from hardware interface and stores internally in the object's memory. More...
Public Member Functions inherited from LinuxTimestamper
virtual	~LinuxTimestamper ()=0
Public Member Functions inherited from HWTimestamper
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_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

Extends the LinuxTimestamper to IntelCE cards

Constructor & Destructor Documentation

virtual LinuxTimestamperIntelCE::~LinuxTimestamperIntelCE ( )

inlinevirtual

Destroys timestamper

LinuxTimestamperIntelCE::LinuxTimestamperIntelCE ( )

inline

Default constructor. Initialize some internal variables

Member Function Documentation

virtual bool LinuxTimestamperIntelCE::HWTimestamper_gettime ( Timestamp *  system_time, Timestamp *  device_time, uint32_t *  local_clock, uint32_t *  nominal_clock_rate  )

virtual

Gets time from hardware interface and stores internally in the object's memory.

Parameters

system_time	Not used
device_time	Not used
local_clock	Not used
nominal_clock_rate	Not used

Implements HWTimestamper.

virtual bool LinuxTimestamperIntelCE::HWTimestamper_init ( InterfaceLabel *  iface_label, OSNetworkInterface *  iface  )

virtual

Initializes the hardware timestamp unit.

Parameters

iface_label	[in] Interface label
iface	[in] Network interface

Returns

TRUE if success, FALSE otherwise

Reimplemented from HWTimestamper.

virtual int LinuxTimestamperIntelCE::HWTimestamper_rxtimestamp ( PortIdentity *  identity, uint16_t  sequenceId, Timestamp &  timestamp, unsigned &  clock_value, bool  last  )

virtual

Gets the RX hardware timestamp value.

Parameters

identity	Clock identity
sequenceId	Sequence ID
timestamp	[out] Reference to the RX timestamps
clock_value	[out] 64 bit timestamp value
last	Not used

Returns

0 if success. -72 if there is an error in the captured sequence or if there is no data available. -1 in case of error when reading data from hardware interface.

Implements HWTimestamper.

virtual int LinuxTimestamperIntelCE::HWTimestamper_txtimestamp ( PortIdentity *  identity, uint16_t  sequenceId, Timestamp &  timestamp, unsigned &  clock_value, bool  last  )

virtual

Gets the TX hardware timestamp value.

Parameters

identity	Clock Identity
sequenceId	Sequence ID
timestamp	[out] Reference to the TX timestamps
clock_value	[out] 64 bit timestamp value
last	Not used

Returns

0 if success. -72 if there is an error in the captured sequence or if there is no data available. -1 in case of error when reading data from hardware interface.

Implements HWTimestamper.

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

virtual

Post initialization procedure. Configures hardware ptp filter.

Parameters

ifindex	Not used
sd	Not used
lock	Not used

Returns

TRUE if success, FALSE otherwise.

Implements LinuxTimestamper.

---

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

• linux_hal_intelce.hpp