types.h File Reference

Enumerator types. More...

#include <cstddef>
#include <cstdint>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	EventIndex : uint32_t { EventOffsetInRange = 1 << 0 , EventSyncedWithGm = 1 << 1 , EventAsCapable = 1 << 2 , EventGmChanged = 1 << 3 }
enum	ClockType : uint8_t { PTPClock = 1 , SysClock = 2 }
enum	StatusWaitResult : int8_t { SWRLostConnection = -2 , SWRInvalidArgument = -1 , SWRNoEventDetected = 0 , SWREventDetected = 1 }

Variables
const uint32_t	PTP_EVENT_ALL
const uint32_t	SYS_EVENT_ALL = EventOffsetInRange
const uint32_t	PTP_COMPOSITE_EVENT_ALL

Detailed Description

Enumerator types.

Author

Christopher Hall <christopher.s.hall@intel.com>

Copyright

© 2024 Intel Corporation.

Enumeration Type Documentation

ClockType

enum ClockType : uint8_t

Types of clock available for subscription.

Enumerator
PTPClock	PTP Clock
SysClock	System Clock

EventIndex

enum EventIndex : uint32_t

Bitmask of events available for subscription. Each bit represents one event.

Enumerator
EventOffsetInRange	Event indicating whether clock offset is in-range
EventSyncedWithGm	Event indicating whether PTP clock is synchronized with a grandmaster
EventAsCapable	Event indicating whether clock is an IEEE 802.1AS capable
EventGmChanged	Event indicating whether grandmaster has changed

StatusWaitResult

enum StatusWaitResult : int8_t

Return value of statusWait API.

Enumerator
SWRLostConnection	Lost connection to Proxy
SWRInvalidArgument	Invalid argument
SWRNoEventDetected	No event changes detected
SWREventDetected	At least an event change detected

Variable Documentation

PTP_COMPOSITE_EVENT_ALL

const uint32_t PTP_COMPOSITE_EVENT_ALL

Initial value:

= EventOffsetInRange | 
    EventSyncedWithGm | EventAsCapable

All the events that can be used as conditions for satisfying the composite event of PTP clock.

PTP_EVENT_ALL

const uint32_t PTP_EVENT_ALL

Initial value:

= EventOffsetInRange | 
    EventSyncedWithGm | EventAsCapable | EventGmChanged

All the PTP clock events available for subscription.

SYS_EVENT_ALL

const uint32_t SYS_EVENT_ALL = EventOffsetInRange

All the System clock events available for subscription.