2c756feb18
Another representative use case of time sync and the correlated
clocksource (in addition to PTP noted above) is PTP synchronized
audio.
In a streaming application, as an example, samples will be sent and/or
received by multiple devices with a presentation time that is in terms
of the PTP master clock. Synchronizing the audio output on these
devices requires correlating the audio clock with the PTP master
clock. The more precise this correlation is, the better the audio
quality (i.e. out of sync audio sounds bad).
From an application standpoint, to correlate the PTP master clock with
the audio device clock, the system clock is used as a intermediate
timebase. The transforms such an application would perform are:
System Clock <-> Audio clock
System Clock <-> Network Device Clock [<-> PTP Master Clock]
Modern Intel platforms can perform a more accurate cross timestamp in
hardware (ART,audio device clock). The audio driver requires
ART->system time transforms -- the same as required for the network
driver. These platforms offload audio processing (including
cross-timestamps) to a DSP which to ensure uninterrupted audio
processing, communicates and response to the host only once every
millsecond. As a result is takes up to a millisecond for the DSP to
receive a request, the request is processed by the DSP, the audio
output hardware is polled for completion, the result is copied into
shared memory, and the host is notified. All of these operation occur
on a millisecond cadence. This transaction requires about 2 ms, but
under heavier workloads it may take up to 4 ms.
Adding a history allows these slow devices the option of providing an
ART value outside of the current interval. In this case, the callback
provided is an accessor function for the previously obtained counter
value. If get_system_device_crosststamp() receives a counter value
previous to cycle_last, it consults the history provided as an
argument in history_ref and interpolates the realtime and monotonic
raw system time using the provided counter value. If there are any
clock discontinuities, e.g. from calling settimeofday(), the monotonic
raw time is interpolated in the usual way, but the realtime clock time
is adjusted by scaling the monotonic raw adjustment.
When an accessor function is used a history argument *must* be
provided. The history is initialized using ktime_get_snapshot() and
must be called before the counter values are read.
Cc: Prarit Bhargava <prarit@redhat.com>
Cc: Richard Cochran <richardcochran@gmail.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: kevin.b.stanton@intel.com
Cc: kevin.j.clarke@intel.com
Cc: hpa@zytor.com
Cc: jeffrey.t.kirsher@intel.com
Cc: netdev@vger.kernel.org
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Christopher S. Hall <christopher.s.hall@intel.com>
[jstultz: Fixed up cycles_t/cycle_t type confusion]
Signed-off-by: John Stultz <john.stultz@linaro.org>
340 lines
7.5 KiB
C
340 lines
7.5 KiB
C
#ifndef _LINUX_TIMEKEEPING_H
|
|
#define _LINUX_TIMEKEEPING_H
|
|
|
|
/* Included from linux/ktime.h */
|
|
|
|
void timekeeping_init(void);
|
|
extern int timekeeping_suspended;
|
|
|
|
/*
|
|
* Get and set timeofday
|
|
*/
|
|
extern void do_gettimeofday(struct timeval *tv);
|
|
extern int do_settimeofday64(const struct timespec64 *ts);
|
|
extern int do_sys_settimeofday(const struct timespec *tv,
|
|
const struct timezone *tz);
|
|
|
|
/*
|
|
* Kernel time accessors
|
|
*/
|
|
unsigned long get_seconds(void);
|
|
struct timespec64 current_kernel_time64(void);
|
|
/* does not take xtime_lock */
|
|
struct timespec __current_kernel_time(void);
|
|
|
|
static inline struct timespec current_kernel_time(void)
|
|
{
|
|
struct timespec64 now = current_kernel_time64();
|
|
|
|
return timespec64_to_timespec(now);
|
|
}
|
|
|
|
/*
|
|
* timespec based interfaces
|
|
*/
|
|
struct timespec64 get_monotonic_coarse64(void);
|
|
extern void getrawmonotonic64(struct timespec64 *ts);
|
|
extern void ktime_get_ts64(struct timespec64 *ts);
|
|
extern time64_t ktime_get_seconds(void);
|
|
extern time64_t ktime_get_real_seconds(void);
|
|
|
|
extern int __getnstimeofday64(struct timespec64 *tv);
|
|
extern void getnstimeofday64(struct timespec64 *tv);
|
|
extern void getboottime64(struct timespec64 *ts);
|
|
|
|
#if BITS_PER_LONG == 64
|
|
/**
|
|
* Deprecated. Use do_settimeofday64().
|
|
*/
|
|
static inline int do_settimeofday(const struct timespec *ts)
|
|
{
|
|
return do_settimeofday64(ts);
|
|
}
|
|
|
|
static inline int __getnstimeofday(struct timespec *ts)
|
|
{
|
|
return __getnstimeofday64(ts);
|
|
}
|
|
|
|
static inline void getnstimeofday(struct timespec *ts)
|
|
{
|
|
getnstimeofday64(ts);
|
|
}
|
|
|
|
static inline void ktime_get_ts(struct timespec *ts)
|
|
{
|
|
ktime_get_ts64(ts);
|
|
}
|
|
|
|
static inline void ktime_get_real_ts(struct timespec *ts)
|
|
{
|
|
getnstimeofday64(ts);
|
|
}
|
|
|
|
static inline void getrawmonotonic(struct timespec *ts)
|
|
{
|
|
getrawmonotonic64(ts);
|
|
}
|
|
|
|
static inline struct timespec get_monotonic_coarse(void)
|
|
{
|
|
return get_monotonic_coarse64();
|
|
}
|
|
|
|
static inline void getboottime(struct timespec *ts)
|
|
{
|
|
return getboottime64(ts);
|
|
}
|
|
#else
|
|
/**
|
|
* Deprecated. Use do_settimeofday64().
|
|
*/
|
|
static inline int do_settimeofday(const struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
ts64 = timespec_to_timespec64(*ts);
|
|
return do_settimeofday64(&ts64);
|
|
}
|
|
|
|
static inline int __getnstimeofday(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
int ret = __getnstimeofday64(&ts64);
|
|
|
|
*ts = timespec64_to_timespec(ts64);
|
|
return ret;
|
|
}
|
|
|
|
static inline void getnstimeofday(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
getnstimeofday64(&ts64);
|
|
*ts = timespec64_to_timespec(ts64);
|
|
}
|
|
|
|
static inline void ktime_get_ts(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
ktime_get_ts64(&ts64);
|
|
*ts = timespec64_to_timespec(ts64);
|
|
}
|
|
|
|
static inline void ktime_get_real_ts(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
getnstimeofday64(&ts64);
|
|
*ts = timespec64_to_timespec(ts64);
|
|
}
|
|
|
|
static inline void getrawmonotonic(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
getrawmonotonic64(&ts64);
|
|
*ts = timespec64_to_timespec(ts64);
|
|
}
|
|
|
|
static inline struct timespec get_monotonic_coarse(void)
|
|
{
|
|
return timespec64_to_timespec(get_monotonic_coarse64());
|
|
}
|
|
|
|
static inline void getboottime(struct timespec *ts)
|
|
{
|
|
struct timespec64 ts64;
|
|
|
|
getboottime64(&ts64);
|
|
*ts = timespec64_to_timespec(ts64);
|
|
}
|
|
#endif
|
|
|
|
#define ktime_get_real_ts64(ts) getnstimeofday64(ts)
|
|
|
|
/*
|
|
* ktime_t based interfaces
|
|
*/
|
|
|
|
enum tk_offsets {
|
|
TK_OFFS_REAL,
|
|
TK_OFFS_BOOT,
|
|
TK_OFFS_TAI,
|
|
TK_OFFS_MAX,
|
|
};
|
|
|
|
extern ktime_t ktime_get(void);
|
|
extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
|
|
extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
|
|
extern ktime_t ktime_get_raw(void);
|
|
extern u32 ktime_get_resolution_ns(void);
|
|
|
|
/**
|
|
* ktime_get_real - get the real (wall-) time in ktime_t format
|
|
*/
|
|
static inline ktime_t ktime_get_real(void)
|
|
{
|
|
return ktime_get_with_offset(TK_OFFS_REAL);
|
|
}
|
|
|
|
/**
|
|
* ktime_get_boottime - Returns monotonic time since boot in ktime_t format
|
|
*
|
|
* This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
|
|
* time spent in suspend.
|
|
*/
|
|
static inline ktime_t ktime_get_boottime(void)
|
|
{
|
|
return ktime_get_with_offset(TK_OFFS_BOOT);
|
|
}
|
|
|
|
/**
|
|
* ktime_get_clocktai - Returns the TAI time of day in ktime_t format
|
|
*/
|
|
static inline ktime_t ktime_get_clocktai(void)
|
|
{
|
|
return ktime_get_with_offset(TK_OFFS_TAI);
|
|
}
|
|
|
|
/**
|
|
* ktime_mono_to_real - Convert monotonic time to clock realtime
|
|
*/
|
|
static inline ktime_t ktime_mono_to_real(ktime_t mono)
|
|
{
|
|
return ktime_mono_to_any(mono, TK_OFFS_REAL);
|
|
}
|
|
|
|
static inline u64 ktime_get_ns(void)
|
|
{
|
|
return ktime_to_ns(ktime_get());
|
|
}
|
|
|
|
static inline u64 ktime_get_real_ns(void)
|
|
{
|
|
return ktime_to_ns(ktime_get_real());
|
|
}
|
|
|
|
static inline u64 ktime_get_boot_ns(void)
|
|
{
|
|
return ktime_to_ns(ktime_get_boottime());
|
|
}
|
|
|
|
static inline u64 ktime_get_tai_ns(void)
|
|
{
|
|
return ktime_to_ns(ktime_get_clocktai());
|
|
}
|
|
|
|
static inline u64 ktime_get_raw_ns(void)
|
|
{
|
|
return ktime_to_ns(ktime_get_raw());
|
|
}
|
|
|
|
extern u64 ktime_get_mono_fast_ns(void);
|
|
extern u64 ktime_get_raw_fast_ns(void);
|
|
|
|
/*
|
|
* Timespec interfaces utilizing the ktime based ones
|
|
*/
|
|
static inline void get_monotonic_boottime(struct timespec *ts)
|
|
{
|
|
*ts = ktime_to_timespec(ktime_get_boottime());
|
|
}
|
|
|
|
static inline void get_monotonic_boottime64(struct timespec64 *ts)
|
|
{
|
|
*ts = ktime_to_timespec64(ktime_get_boottime());
|
|
}
|
|
|
|
static inline void timekeeping_clocktai(struct timespec *ts)
|
|
{
|
|
*ts = ktime_to_timespec(ktime_get_clocktai());
|
|
}
|
|
|
|
/*
|
|
* RTC specific
|
|
*/
|
|
extern bool timekeeping_rtc_skipsuspend(void);
|
|
extern bool timekeeping_rtc_skipresume(void);
|
|
|
|
extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
|
|
|
|
/*
|
|
* PPS accessor
|
|
*/
|
|
extern void ktime_get_raw_and_real_ts64(struct timespec64 *ts_raw,
|
|
struct timespec64 *ts_real);
|
|
|
|
/*
|
|
* struct system_time_snapshot - simultaneous raw/real time capture with
|
|
* counter value
|
|
* @cycles: Clocksource counter value to produce the system times
|
|
* @real: Realtime system time
|
|
* @raw: Monotonic raw system time
|
|
* @clock_was_set_seq: The sequence number of clock was set events
|
|
* @cs_was_changed_seq: The sequence number of clocksource change events
|
|
*/
|
|
struct system_time_snapshot {
|
|
cycle_t cycles;
|
|
ktime_t real;
|
|
ktime_t raw;
|
|
unsigned int clock_was_set_seq;
|
|
u8 cs_was_changed_seq;
|
|
};
|
|
|
|
/*
|
|
* struct system_device_crosststamp - system/device cross-timestamp
|
|
* (syncronized capture)
|
|
* @device: Device time
|
|
* @sys_realtime: Realtime simultaneous with device time
|
|
* @sys_monoraw: Monotonic raw simultaneous with device time
|
|
*/
|
|
struct system_device_crosststamp {
|
|
ktime_t device;
|
|
ktime_t sys_realtime;
|
|
ktime_t sys_monoraw;
|
|
};
|
|
|
|
/*
|
|
* struct system_counterval_t - system counter value with the pointer to the
|
|
* corresponding clocksource
|
|
* @cycles: System counter value
|
|
* @cs: Clocksource corresponding to system counter value. Used by
|
|
* timekeeping code to verify comparibility of two cycle values
|
|
*/
|
|
struct system_counterval_t {
|
|
cycle_t cycles;
|
|
struct clocksource *cs;
|
|
};
|
|
|
|
/*
|
|
* Get cross timestamp between system clock and device clock
|
|
*/
|
|
extern int get_device_system_crosststamp(
|
|
int (*get_time_fn)(ktime_t *device_time,
|
|
struct system_counterval_t *system_counterval,
|
|
void *ctx),
|
|
void *ctx,
|
|
struct system_time_snapshot *history,
|
|
struct system_device_crosststamp *xtstamp);
|
|
|
|
/*
|
|
* Simultaneously snapshot realtime and monotonic raw clocks
|
|
*/
|
|
extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
|
|
|
|
/*
|
|
* Persistent clock related interfaces
|
|
*/
|
|
extern int persistent_clock_is_local;
|
|
|
|
extern void read_persistent_clock(struct timespec *ts);
|
|
extern void read_persistent_clock64(struct timespec64 *ts);
|
|
extern void read_boot_clock64(struct timespec64 *ts);
|
|
extern int update_persistent_clock(struct timespec now);
|
|
extern int update_persistent_clock64(struct timespec64 now);
|
|
|
|
|
|
#endif
|