timecounter.h File Reference

This header file provides interfaces of the Timecounter Handler which are used by the implementation and the API. More...

#include <sys/time.h>
#include <sys/timetc.h>
#include <machine/_timecounter.h>
#include <rtems/score/isrlock.h>

Go to the source code of this file.

Macros
#define	_Timecounter_Acquire(lock_context)    _ISR_lock_ISR_disable_and_acquire( &_Timecounter_Lock, lock_context )
	Acquires the timecounter lock.
#define	_Timecounter_Release(lock_context)    _ISR_lock_Release_and_ISR_enable(&_Timecounter_Lock, lock_context)
	Releases the timecounter lock.

Typedefs
typedef void(*	Timecounter_NTP_update_second) (int64_t *adjustment, time_t *newsec)
	Handler doing the NTP update second processing shall have this type.

Functions
void	_Timecounter_Bintime (struct bintime *bt)
	Returns the wall clock time in the bintime format.
void	_Timecounter_Nanotime (struct timespec *ts)
	Returns the wall clock time in the timespec format.
void	_Timecounter_Microtime (struct timeval *tv)
	Returns the wall clock time in the timeval format.
void	_Timecounter_Binuptime (struct bintime *bt)
	Returns the uptime in the bintime format.
int64_t	_Timecounter_Sbinuptime (void)
	Returns the uptime in the sbintime_t format.
void	_Timecounter_Nanouptime (struct timespec *ts)
	Returns the uptime in the timespec format.
void	_Timecounter_Microuptime (struct timeval *tv)
	Returns the uptime in the timeval format.
void	_Timecounter_Getbintime (struct bintime *bt)
	Returns the wall clock time in the bintime format.
void	_Timecounter_Getnanotime (struct timespec *ts)
	Returns the wall clock time in the timespec format.
void	_Timecounter_Getmicrotime (struct timeval *tv)
	Returns the wall clock time in the timeval format.
void	_Timecounter_Getbinuptime (struct bintime *bt)
	Returns the uptime in the bintime format.
void	_Timecounter_Getnanouptime (struct timespec *ts)
	Returns the uptime in the timespec format.
void	_Timecounter_Getmicrouptime (struct timeval *tv)
	Returns the uptime in the timeval format.
void	_Timecounter_Getboottime (struct timeval *tv)
	Returns the boot time in the timeval format.
void	_Timecounter_Getboottimebin (struct bintime *bt)
	Returns the boot time in the bintime format.
void	_Timecounter_Install (struct timecounter *tc)
	Installs the timecounter.
void	_Timecounter_Tick (void)
	Performs a timecounter tick.
void	_Timecounter_Tick_simple (uint32_t delta, uint32_t offset, ISR_lock_Context *lock_context)
	Performs a simple timecounter tick.
void	_Timecounter_Set_NTP_update_second (Timecounter_NTP_update_second handler)
	Sets the NTP update second handler.
void	_Timecounter_NTP_update_second (int64_t *adjustment, time_t *newsec)
	Updates the time adjustment and seconds according to the NTP state.
uint64_t	_Timecounter_Get_frequency (void)
	Gets the frequency in Hz of the current timecounter at some time point during the call.
void	_Timecounter_Discipline (struct timespec *tsp, long nsec)
	Updates the timecounter frequency adjustment used by _Timecounter_Set_NTP_update_second().

Variables
volatile time_t	_Timecounter_Time_second
	The wall clock time in seconds.
volatile int32_t	_Timecounter_Time_uptime
	The uptime in seconds.
struct timecounter *	_Timecounter
	The current timecounter.

Detailed Description

This header file provides interfaces of the Timecounter Handler which are used by the implementation and the API.