[mirror_ubuntu-artful-kernel.git] / include / linux / timekeeping.h

#ifndef _LINUX_TIMEKEEPING_H
#define _LINUX_TIMEKEEPING_H

#include <linux/errno.h>

/* Included from linux/ktime.h */

void timekeeping_init(void);
extern int timekeeping_suspended;

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

/*
 * Get and set timeofday
 */
extern void do_gettimeofday(struct timeval *tv);
extern int do_settimeofday64(const struct timespec64 *ts);
extern int do_sys_settimeofday64(const struct timespec64 *tv,
				 const struct timezone *tz);
static inline int do_sys_settimeofday(const struct timespec *tv,
				      const struct timezone *tz)
{
	struct timespec64 ts64;

	if (!tv)
		return do_sys_settimeofday64(NULL, tz);

	if (!timespec_valid(tv))
		return -EINVAL;

	ts64 = timespec_to_timespec64(*tv);
	return do_sys_settimeofday64(&ts64, 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);
extern u64 ktime_get_boot_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 {
	u64		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 {
	u64			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
Commit	Line	Data
8b094cd0 TG	1	#ifndef _LINUX_TIMEKEEPING_H
	2	#define _LINUX_TIMEKEEPING_H
	3
b536fd58	4	#include <linux/errno.h>
86d34732	5
8b094cd0 TG	6	/* Included from linux/ktime.h */
	7
	8	void timekeeping_init(void);
	9	extern int timekeeping_suspended;
	10
93b5a9a7 IM	11	/* Architecture timer tick functions: */
	12	extern void update_process_times(int user);
	13	extern void xtime_update(unsigned long ticks);
	14
8b094cd0 TG	15	/*
	16	* Get and set timeofday
	17	*/
	18	extern void do_gettimeofday(struct timeval *tv);
21f7eca5	19	extern int do_settimeofday64(const struct timespec64 *ts);
86d34732 BW	20	extern int do_sys_settimeofday64(const struct timespec64 *tv,
	21	const struct timezone *tz);
	22	static inline int do_sys_settimeofday(const struct timespec *tv,
	23	const struct timezone *tz)
	24	{
	25	struct timespec64 ts64;
	26
	27	if (!tv)
dfc2507b JS	28	return do_sys_settimeofday64(NULL, tz);
	29
	30	if (!timespec_valid(tv))
86d34732 BW	31	return -EINVAL;
	32
	33	ts64 = timespec_to_timespec64(*tv);
	34	return do_sys_settimeofday64(&ts64, tz);
	35	}
8b094cd0 TG	36
	37	/*
	38	* Kernel time accessors
	39	*/
	40	unsigned long get_seconds(void);
8758a240	41	struct timespec64 current_kernel_time64(void);
8b094cd0 TG	42	/* does not take xtime_lock */
	43	struct timespec __current_kernel_time(void);
	44
8758a240 BW	45	static inline struct timespec current_kernel_time(void)
	46	{
	47	struct timespec64 now = current_kernel_time64();
	48
	49	return timespec64_to_timespec(now);
	50	}
	51
8b094cd0 TG	52	/*
	53	* timespec based interfaces
	54	*/
334334b5	55	struct timespec64 get_monotonic_coarse64(void);
cdba2ec5	56	extern void getrawmonotonic64(struct timespec64 *ts);
d6d29896	57	extern void ktime_get_ts64(struct timespec64 *ts);
9e3680b1	58	extern time64_t ktime_get_seconds(void);
dbe7aa62	59	extern time64_t ktime_get_real_seconds(void);
d6d29896 TG	60
	61	extern int __getnstimeofday64(struct timespec64 *tv);
	62	extern void getnstimeofday64(struct timespec64 *tv);
d08c0cdd	63	extern void getboottime64(struct timespec64 *ts);
d6d29896 TG	64
d6d29896 TG	65	#if BITS_PER_LONG == 64
21f7eca5	66	/**
	67	* Deprecated. Use do_settimeofday64().
	68	*/
	69	static inline int do_settimeofday(const struct timespec *ts)
	70	{
	71	return do_settimeofday64(ts);
	72	}
	73
d6d29896 TG	74	static inline int __getnstimeofday(struct timespec *ts)
	75	{
	76	return __getnstimeofday64(ts);
	77	}
	78
	79	static inline void getnstimeofday(struct timespec *ts)
	80	{
	81	getnstimeofday64(ts);
	82	}
	83
	84	static inline void ktime_get_ts(struct timespec *ts)
	85	{
	86	ktime_get_ts64(ts);
	87	}
	88
	89	static inline void ktime_get_real_ts(struct timespec *ts)
	90	{
	91	getnstimeofday64(ts);
	92	}
	93
cdba2ec5 JS	94	static inline void getrawmonotonic(struct timespec *ts)
	95	{
	96	getrawmonotonic64(ts);
	97	}
	98
334334b5 JS	99	static inline struct timespec get_monotonic_coarse(void)
	100	{
	101	return get_monotonic_coarse64();
	102	}
d08c0cdd JS	103
	104	static inline void getboottime(struct timespec *ts)
	105	{
	106	return getboottime64(ts);
	107	}
d6d29896	108	#else
21f7eca5	109	/**
	110	* Deprecated. Use do_settimeofday64().
	111	*/
	112	static inline int do_settimeofday(const struct timespec *ts)
	113	{
	114	struct timespec64 ts64;
	115
	116	ts64 = timespec_to_timespec64(*ts);
	117	return do_settimeofday64(&ts64);
	118	}
	119
d6d29896 TG	120	static inline int __getnstimeofday(struct timespec *ts)
	121	{
	122	struct timespec64 ts64;
	123	int ret = __getnstimeofday64(&ts64);
	124
	125	*ts = timespec64_to_timespec(ts64);
	126	return ret;
	127	}
	128
	129	static inline void getnstimeofday(struct timespec *ts)
	130	{
	131	struct timespec64 ts64;
	132
	133	getnstimeofday64(&ts64);
	134	*ts = timespec64_to_timespec(ts64);
	135	}
	136
	137	static inline void ktime_get_ts(struct timespec *ts)
	138	{
	139	struct timespec64 ts64;
	140
	141	ktime_get_ts64(&ts64);
	142	*ts = timespec64_to_timespec(ts64);
	143	}
	144
	145	static inline void ktime_get_real_ts(struct timespec *ts)
	146	{
	147	struct timespec64 ts64;
	148
	149	getnstimeofday64(&ts64);
	150	*ts = timespec64_to_timespec(ts64);
	151	}
cdba2ec5 JS	152
	153	static inline void getrawmonotonic(struct timespec *ts)
	154	{
	155	struct timespec64 ts64;
	156
	157	getrawmonotonic64(&ts64);
	158	*ts = timespec64_to_timespec(ts64);
	159	}
334334b5 JS	160
	161	static inline struct timespec get_monotonic_coarse(void)
	162	{
	163	return timespec64_to_timespec(get_monotonic_coarse64());
	164	}
8b094cd0	165
d08c0cdd JS	166	static inline void getboottime(struct timespec *ts)
	167	{
	168	struct timespec64 ts64;
	169
	170	getboottime64(&ts64);
	171	*ts = timespec64_to_timespec(ts64);
	172	}
	173	#endif
8b094cd0	174
d6d29896	175	#define ktime_get_real_ts64(ts) getnstimeofday64(ts)
8b094cd0 TG	176
	177	/*
	178	* ktime_t based interfaces
	179	*/
0077dc60 TG	180
	181	enum tk_offsets {
	182	TK_OFFS_REAL,
	183	TK_OFFS_BOOT,
	184	TK_OFFS_TAI,
	185	TK_OFFS_MAX,
	186	};
	187
8b094cd0	188	extern ktime_t ktime_get(void);
0077dc60	189	extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
9a6b5197	190	extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
f519b1a2	191	extern ktime_t ktime_get_raw(void);
6374f912	192	extern u32 ktime_get_resolution_ns(void);
8b094cd0	193
f5264d5d TG	194	/**
	195	* ktime_get_real - get the real (wall-) time in ktime_t format
	196	*/
	197	static inline ktime_t ktime_get_real(void)
	198	{
	199	return ktime_get_with_offset(TK_OFFS_REAL);
	200	}
	201
b82c817e TG	202	/**
	203	* ktime_get_boottime - Returns monotonic time since boot in ktime_t format
	204	*
	205	* This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
	206	* time spent in suspend.
	207	*/
	208	static inline ktime_t ktime_get_boottime(void)
	209	{
	210	return ktime_get_with_offset(TK_OFFS_BOOT);
	211	}
	212
afab07c0 TG	213	/**
	214	* ktime_get_clocktai - Returns the TAI time of day in ktime_t format
	215	*/
	216	static inline ktime_t ktime_get_clocktai(void)
	217	{
	218	return ktime_get_with_offset(TK_OFFS_TAI);
	219	}
	220
9a6b5197 TG	221	/**
	222	* ktime_mono_to_real - Convert monotonic time to clock realtime
	223	*/
	224	static inline ktime_t ktime_mono_to_real(ktime_t mono)
	225	{
	226	return ktime_mono_to_any(mono, TK_OFFS_REAL);
	227	}
	228
897994e3 TG	229	static inline u64 ktime_get_ns(void)
	230	{
	231	return ktime_to_ns(ktime_get());
	232	}
	233
	234	static inline u64 ktime_get_real_ns(void)
	235	{
	236	return ktime_to_ns(ktime_get_real());
	237	}
	238
	239	static inline u64 ktime_get_boot_ns(void)
	240	{
	241	return ktime_to_ns(ktime_get_boottime());
	242	}
	243
fe5fba05 PZ	244	static inline u64 ktime_get_tai_ns(void)
	245	{
	246	return ktime_to_ns(ktime_get_clocktai());
	247	}
	248
f519b1a2 TG	249	static inline u64 ktime_get_raw_ns(void)
	250	{
	251	return ktime_to_ns(ktime_get_raw());
	252	}
	253
4396e058	254	extern u64 ktime_get_mono_fast_ns(void);
f09cb9a1	255	extern u64 ktime_get_raw_fast_ns(void);
948a5312	256	extern u64 ktime_get_boot_fast_ns(void);
4396e058	257
48f18fd6 TG	258	/*
	259	* Timespec interfaces utilizing the ktime based ones
	260	*/
	261	static inline void get_monotonic_boottime(struct timespec *ts)
	262	{
	263	*ts = ktime_to_timespec(ktime_get_boottime());
	264	}
	265
2e0c78ee JS	266	static inline void get_monotonic_boottime64(struct timespec64 *ts)
	267	{
	268	*ts = ktime_to_timespec64(ktime_get_boottime());
	269	}
	270
61edec81 TG	271	static inline void timekeeping_clocktai(struct timespec *ts)
	272	{
	273	*ts = ktime_to_timespec(ktime_get_clocktai());
	274	}
	275
8b094cd0 TG	276	/*
	277	* RTC specific
	278	*/
0fa88cb4 XP	279	extern bool timekeeping_rtc_skipsuspend(void);
	280	extern bool timekeeping_rtc_skipresume(void);
	281
04d90890	282	extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
04d90890	283
8b094cd0 TG	284	/*
	285	* PPS accessor
	286	*/
071eee45 AB	287	extern void ktime_get_raw_and_real_ts64(struct timespec64 *ts_raw,
071eee45 AB	288	struct timespec64 *ts_real);
8b094cd0	289
9da0f49c CH	290	/*
	291	* struct system_time_snapshot - simultaneous raw/real time capture with
	292	* counter value
	293	* @cycles: Clocksource counter value to produce the system times
	294	* @real: Realtime system time
	295	* @raw: Monotonic raw system time
2c756feb CH	296	* @clock_was_set_seq: The sequence number of clock was set events
2c756feb CH	297	* @cs_was_changed_seq: The sequence number of clocksource change events
9da0f49c CH	298	*/
9da0f49c CH	299	struct system_time_snapshot {
a5a1d1c2	300	u64 cycles;
9da0f49c CH	301	ktime_t real;
9da0f49c CH	302	ktime_t raw;
2c756feb CH	303	unsigned int clock_was_set_seq;
2c756feb CH	304	u8 cs_was_changed_seq;
9da0f49c CH	305	};
9da0f49c CH	306
8006c245 CH	307	/*
	308	* struct system_device_crosststamp - system/device cross-timestamp
	309	* (syncronized capture)
	310	* @device: Device time
	311	* @sys_realtime: Realtime simultaneous with device time
	312	* @sys_monoraw: Monotonic raw simultaneous with device time
	313	*/
	314	struct system_device_crosststamp {
	315	ktime_t device;
	316	ktime_t sys_realtime;
	317	ktime_t sys_monoraw;
	318	};
	319
	320	/*
	321	* struct system_counterval_t - system counter value with the pointer to the
	322	* corresponding clocksource
	323	* @cycles: System counter value
	324	* @cs: Clocksource corresponding to system counter value. Used by
	325	* timekeeping code to verify comparibility of two cycle values
	326	*/
	327	struct system_counterval_t {
a5a1d1c2	328	u64 cycles;
8006c245 CH	329	struct clocksource *cs;
	330	};
	331
	332	/*
	333	* Get cross timestamp between system clock and device clock
	334	*/
	335	extern int get_device_system_crosststamp(
	336	int (get_time_fn)(ktime_t device_time,
	337	struct system_counterval_t *system_counterval,
	338	void *ctx),
	339	void *ctx,
2c756feb	340	struct system_time_snapshot *history,
8006c245 CH	341	struct system_device_crosststamp *xtstamp);
8006c245 CH	342
9da0f49c CH	343	/*
	344	* Simultaneously snapshot realtime and monotonic raw clocks
	345	*/
	346	extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
	347
8b094cd0 TG	348	/*
	349	* Persistent clock related interfaces
	350	*/
8b094cd0 TG	351	extern int persistent_clock_is_local;
8b094cd0 TG	352
8b094cd0	353	extern void read_persistent_clock(struct timespec *ts);
2ee96632	354	extern void read_persistent_clock64(struct timespec64 *ts);
9a806ddb	355	extern void read_boot_clock64(struct timespec64 *ts);
8b094cd0	356	extern int update_persistent_clock(struct timespec now);
3c00a1fe	357	extern int update_persistent_clock64(struct timespec64 now);
8b094cd0 TG	358
	359
	360	#endif