timekeeping.h 5.2 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4
#ifndef _LINUX_TIMEKEEPING_H
#define _LINUX_TIMEKEEPING_H

5
#include <linux/errno.h>
6

7 8 9 10 11
/* Included from linux/ktime.h */

void timekeeping_init(void);
extern int timekeeping_suspended;

12 13 14 15
/* Architecture timer tick functions: */
extern void update_process_times(int user);
extern void xtime_update(unsigned long ticks);

16 17 18
/*
 * Get and set timeofday
 */
19
extern int do_settimeofday64(const struct timespec64 *ts);
20 21
extern int do_sys_settimeofday64(const struct timespec64 *tv,
				 const struct timezone *tz);
22 23 24
/*
 * Kernel time accessors
 */
25 26
struct timespec64 current_kernel_time64(void);

27
/*
28
 * timespec64 based interfaces
29
 */
30
struct timespec64 get_monotonic_coarse64(void);
31
extern void getrawmonotonic64(struct timespec64 *ts);
32
extern void ktime_get_ts64(struct timespec64 *ts);
33
extern time64_t ktime_get_seconds(void);
34
extern time64_t ktime_get_real_seconds(void);
35 36 37

extern int __getnstimeofday64(struct timespec64 *tv);
extern void getnstimeofday64(struct timespec64 *tv);
38
extern void getboottime64(struct timespec64 *ts);
39 40

#define ktime_get_real_ts64(ts)	getnstimeofday64(ts)
41 42 43 44

/*
 * ktime_t based interfaces
 */
45 46 47 48 49 50 51 52

enum tk_offsets {
	TK_OFFS_REAL,
	TK_OFFS_BOOT,
	TK_OFFS_TAI,
	TK_OFFS_MAX,
};

53
extern ktime_t ktime_get(void);
54
extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
55
extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
56
extern ktime_t ktime_get_raw(void);
57
extern u32 ktime_get_resolution_ns(void);
58

59 60 61 62 63 64 65 66
/**
 * 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);
}

67 68 69 70 71 72 73 74 75 76 77
/**
 * 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);
}

78 79 80 81 82 83 84 85
/**
 * 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);
}

86 87 88 89 90 91 92 93
/**
 * 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);
}

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
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());
}

P
Peter Zijlstra 已提交
109 110 111 112 113
static inline u64 ktime_get_tai_ns(void)
{
	return ktime_to_ns(ktime_get_clocktai());
}

114 115 116 117 118
static inline u64 ktime_get_raw_ns(void)
{
	return ktime_to_ns(ktime_get_raw());
}

119
extern u64 ktime_get_mono_fast_ns(void);
P
Peter Zijlstra 已提交
120
extern u64 ktime_get_raw_fast_ns(void);
121
extern u64 ktime_get_boot_fast_ns(void);
122
extern u64 ktime_get_real_fast_ns(void);
123

124
/*
125
 * timespec64 interfaces utilizing the ktime based ones
126
 */
127 128 129 130 131
static inline void get_monotonic_boottime64(struct timespec64 *ts)
{
	*ts = ktime_to_timespec64(ktime_get_boottime());
}

132 133 134 135 136
static inline void timekeeping_clocktai64(struct timespec64 *ts)
{
	*ts = ktime_to_timespec64(ktime_get_clocktai());
}

137 138 139
/*
 * RTC specific
 */
140 141 142
extern bool timekeeping_rtc_skipsuspend(void);
extern bool timekeeping_rtc_skipresume(void);

143 144
extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);

145 146 147 148 149 150
/*
 * 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
151 152
 * @clock_was_set_seq:	The sequence number of clock was set events
 * @cs_was_changed_seq:	The sequence number of clocksource change events
153 154
 */
struct system_time_snapshot {
155
	u64		cycles;
156 157
	ktime_t		real;
	ktime_t		raw;
158 159
	unsigned int	clock_was_set_seq;
	u8		cs_was_changed_seq;
160 161
};

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/*
 * 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 {
183
	u64			cycles;
184 185 186 187 188 189 190 191 192 193 194
	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,
195
			struct system_time_snapshot *history,
196 197
			struct system_device_crosststamp *xtstamp);

198 199 200 201 202
/*
 * Simultaneously snapshot realtime and monotonic raw clocks
 */
extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);

203 204 205 206 207
/*
 * Persistent clock related interfaces
 */
extern int persistent_clock_is_local;

208
extern void read_persistent_clock64(struct timespec64 *ts);
209
extern void read_boot_clock64(struct timespec64 *ts);
210
extern int update_persistent_clock64(struct timespec64 now);
211 212 213


#endif