types_c.h File Reference

Enumerator types. More...

#include <stdint.h>
#include <stdbool.h>

Include dependency graph for types_c.h:

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

Go to the source code of this file.

Macros
#define	CLKMGR_PTP_EVENT_ALL
#define	CLKMGR_SYS_EVENT_ALL   (Clkmgr_EventOffsetInRange)
#define	CLKMGR_PTP_COMPOSITE_EVENT_ALL

Enumerations
enum	Clkmgr_EventIndex { Clkmgr_EventOffsetInRange = 1 << 0 , Clkmgr_EventSyncedWithGm = 1 << 1 , Clkmgr_EventAsCapable = 1 << 2 , Clkmgr_EventGmChanged = 1 << 3 }
enum	Clkmgr_ClockType { Clkmgr_PTPClock = 1 , Clkmgr_SysClock = 2 }
enum	Clkmgr_StatusWaitResult { Clkmgr_SWRLostConnection = -2 , Clkmgr_SWRInvalidArgument = -1 , Clkmgr_SWRNoEventDetected = 0 , Clkmgr_SWREventDetected = 1 }

Detailed Description

Enumerator types.

Author

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

Copyright

© 2024 Intel Corporation.

Macro Definition Documentation

CLKMGR_PTP_COMPOSITE_EVENT_ALL

#define CLKMGR_PTP_COMPOSITE_EVENT_ALL

Value:

    (Clkmgr_EventOffsetInRange | \
    Clkmgr_EventSyncedWithGm | Clkmgr_EventAsCapable)

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

CLKMGR_PTP_EVENT_ALL

#define CLKMGR_PTP_EVENT_ALL

Value:

    (Clkmgr_EventOffsetInRange | \
    Clkmgr_EventSyncedWithGm | Clkmgr_EventAsCapable | Clkmgr_EventGmChanged)

All the PTP clock events available for subscription.

CLKMGR_SYS_EVENT_ALL

#define CLKMGR_SYS_EVENT_ALL   (Clkmgr_EventOffsetInRange)

All the System clock events available for subscription.

Enumeration Type Documentation

Clkmgr_ClockType

enum Clkmgr_ClockType

Types of clock available for subscription.

Enumerator
Clkmgr_PTPClock	PTP Clock
Clkmgr_SysClock	System Clock

Clkmgr_EventIndex

enum Clkmgr_EventIndex

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

Enumerator
Clkmgr_EventOffsetInRange	Event indicating whether clock offset is in-range
Clkmgr_EventSyncedWithGm	Event indicating whether PTP clock is synchronized with a grandmaster
Clkmgr_EventAsCapable	Event indicating whether clock is an IEEE 802.1AS capable
Clkmgr_EventGmChanged	Event indicating whether grandmaster has changed

Clkmgr_StatusWaitResult

enum Clkmgr_StatusWaitResult

Return value of statusWait API.

Enumerator
Clkmgr_SWRLostConnection	Lost connection to Proxy
Clkmgr_SWRInvalidArgument	Invalid argument
Clkmgr_SWRNoEventDetected	No event changes detected
Clkmgr_SWREventDetected	At least an event change detected