timebase_configs_c.h File Reference

C wrapper to get the configuration of time base. More...

#include <stddef.h>

Include dependency graph for timebase_configs_c.h:

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

Go to the source code of this file.

Functions
bool	clkmgr_isTimeBaseIndexPresent (size_t timeBaseIndex)
const char *	clkmgr_ifName (size_t timeBaseIndex)
int	clkmgr_ifIndex (size_t timeBaseIndex)
int	clkmgr_ptpIndex (size_t timeBaseIndex)
uint8_t	clkmgr_transportSpecific (size_t timeBaseIndex)
uint8_t	clkmgr_domainNumber (size_t timeBaseIndex)
const char *	clkmgr_timeBaseName (size_t timeBaseIndex)
bool	clkmgr_havePtp (size_t timeBaseIndex)
bool	clkmgr_haveSysClock (size_t timeBaseIndex)
bool	clkmgr_BaseNameToBaseIndex (const char *timeBaseName, size_t *timeBaseIndex)

Detailed Description

C wrapper to get the configuration of time base.

Author

Song Yoong Siang <yoong.siang.song@intel.com>

Copyright

© 2025 Intel Corporation.

Function Documentation

clkmgr_BaseNameToBaseIndex()

bool clkmgr_BaseNameToBaseIndex	(	const char *	timeBaseName,
		size_t *	timeBaseIndex
	)

find index of the time base using its name.

Parameters

[in]	timeBaseName	The time base name.
[out]	timeBaseIndex	pointer to the time base index

Returns

true if found

clkmgr_domainNumber()

uint8_t clkmgr_domainNumber

(

size_t

timeBaseIndex

)

Get PTP Domain number

Returns

PTP Domain number

clkmgr_havePtp()

bool clkmgr_havePtp

(

size_t

timeBaseIndex

)

Query if we use PTP

Returns

true if this time base have PTP

clkmgr_haveSysClock()

bool clkmgr_haveSysClock

(

size_t

timeBaseIndex

)

Query if synchronize the system clock

Returns

true if this time base does synchronize

clkmgr_ifIndex()

int clkmgr_ifIndex

(

size_t

timeBaseIndex

)

Get Network interface index

Returns

Network interface index

clkmgr_ifName()

const char * clkmgr_ifName

(

size_t

timeBaseIndex

)

Get Network interface name

Parameters

[in]

timeBaseIndex

the time base index

Returns

Network interface name of the PTP hardware clock

clkmgr_isTimeBaseIndexPresent()

bool clkmgr_isTimeBaseIndexPresent

(

size_t

timeBaseIndex

)

Check if a given timeBaseIndex exist

Parameters

[in]

timeBaseIndex

The time base index to check.

Returns

true if found, false otherwise.

clkmgr_ptpIndex()

int clkmgr_ptpIndex

(

size_t

timeBaseIndex

)

Get PTP device index

Returns

PTP device index

clkmgr_timeBaseName()

const char * clkmgr_timeBaseName

(

size_t

timeBaseIndex

)

Get name of the time base

Returns

name of the time base

clkmgr_transportSpecific()

uint8_t clkmgr_transportSpecific

(

size_t

timeBaseIndex

)

Get PTP Transport specific

Returns

PTP Transport specific