include/linux/timekeeping.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_TIMEKEEPING_H
   3 #define _LINUX_TIMEKEEPING_H
   4
   5 #include <linux/errno.h>
   6
   7 /* Included from linux/ktime.h */
   8
   9 void timekeeping_init(void);
  10 extern int timekeeping_suspended;
  11
  12 /* Architecture timer tick functions: */
  13 extern void update_process_times(int user);
  14 extern void xtime_update(unsigned long ticks);
  15
  16 /*
  17  * Get and set timeofday
  18  */
  19 extern int do_settimeofday64(const struct timespec64 *ts);
  20 extern int do_sys_settimeofday64(const struct timespec64 *tv,
  21                                  const struct timezone *tz);
  22 /*
  23  * Kernel time accessors
  24  */
  25 struct timespec64 current_kernel_time64(void);
  26
  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 void ktime_get_real_ts64(struct timespec64 *tv);
  34 extern time64_t ktime_get_seconds(void);
  35 extern time64_t __ktime_get_real_seconds(void);
  36 extern time64_t ktime_get_real_seconds(void);
  37
  38 extern void getboottime64(struct timespec64 *ts);
  39
  40
  41 /*
  42  * ktime_t based interfaces
  43  */
  44
  45 enum tk_offsets {
  46         TK_OFFS_REAL,
  47         TK_OFFS_BOOT,
  48         TK_OFFS_TAI,
  49         TK_OFFS_MAX,
  50 };
  51
  52 extern ktime_t ktime_get(void);
  53 extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
  54 extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
  55 extern ktime_t ktime_get_raw(void);
  56 extern u32 ktime_get_resolution_ns(void);
  57
  58 /**
  59  * ktime_get_real - get the real (wall-) time in ktime_t format
  60  */
  61 static inline ktime_t ktime_get_real(void)
  62 {
  63         return ktime_get_with_offset(TK_OFFS_REAL);
  64 }
  65
  66 /**
  67  * ktime_get_boottime - Returns monotonic time since boot in ktime_t format
  68  *
  69  * This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
  70  * time spent in suspend.
  71  */
  72 static inline ktime_t ktime_get_boottime(void)
  73 {
  74         return ktime_get_with_offset(TK_OFFS_BOOT);
  75 }
  76
  77 /**
  78  * ktime_get_clocktai - Returns the TAI time of day in ktime_t format
  79  */
  80 static inline ktime_t ktime_get_clocktai(void)
  81 {
  82         return ktime_get_with_offset(TK_OFFS_TAI);
  83 }
  84
  85 /**
  86  * ktime_mono_to_real - Convert monotonic time to clock realtime
  87  */
  88 static inline ktime_t ktime_mono_to_real(ktime_t mono)
  89 {
  90         return ktime_mono_to_any(mono, TK_OFFS_REAL);
  91 }
  92
  93 static inline u64 ktime_get_ns(void)
  94 {
  95         return ktime_to_ns(ktime_get());
  96 }
  97
  98 static inline u64 ktime_get_real_ns(void)
  99 {
 100         return ktime_to_ns(ktime_get_real());
 101 }
 102
 103 static inline u64 ktime_get_boot_ns(void)
 104 {
 105         return ktime_to_ns(ktime_get_boottime());
 106 }
 107
 108 static inline u64 ktime_get_tai_ns(void)
 109 {
 110         return ktime_to_ns(ktime_get_clocktai());
 111 }
 112
 113 static inline u64 ktime_get_raw_ns(void)
 114 {
 115         return ktime_to_ns(ktime_get_raw());
 116 }
 117
 118 extern u64 ktime_get_mono_fast_ns(void);
 119 extern u64 ktime_get_raw_fast_ns(void);
 120 extern u64 ktime_get_boot_fast_ns(void);
 121 extern u64 ktime_get_real_fast_ns(void);
 122
 123 /*
 124  * timespec64 interfaces utilizing the ktime based ones
 125  */
 126 static inline void get_monotonic_boottime64(struct timespec64 *ts)
 127 {
 128         *ts = ktime_to_timespec64(ktime_get_boottime());
 129 }
 130
 131 static inline void timekeeping_clocktai64(struct timespec64 *ts)
 132 {
 133         *ts = ktime_to_timespec64(ktime_get_clocktai());
 134 }
 135
 136 /*
 137  * RTC specific
 138  */
 139 extern bool timekeeping_rtc_skipsuspend(void);
 140 extern bool timekeeping_rtc_skipresume(void);
 141
 142 extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
 143
 144 /*
 145  * struct system_time_snapshot - simultaneous raw/real time capture with
 146  *      counter value
 147  * @cycles:     Clocksource counter value to produce the system times
 148  * @real:       Realtime system time
 149  * @raw:        Monotonic raw system time
 150  * @clock_was_set_seq:  The sequence number of clock was set events
 151  * @cs_was_changed_seq: The sequence number of clocksource change events
 152  */
 153 struct system_time_snapshot {
 154         u64             cycles;
 155         ktime_t         real;
 156         ktime_t         raw;
 157         unsigned int    clock_was_set_seq;
 158         u8              cs_was_changed_seq;
 159 };
 160
 161 /*
 162  * struct system_device_crosststamp - system/device cross-timestamp
 163  *      (syncronized capture)
 164  * @device:             Device time
 165  * @sys_realtime:       Realtime simultaneous with device time
 166  * @sys_monoraw:        Monotonic raw simultaneous with device time
 167  */
 168 struct system_device_crosststamp {
 169         ktime_t device;
 170         ktime_t sys_realtime;
 171         ktime_t sys_monoraw;
 172 };
 173
 174 /*
 175  * struct system_counterval_t - system counter value with the pointer to the
 176  *      corresponding clocksource
 177  * @cycles:     System counter value
 178  * @cs:         Clocksource corresponding to system counter value. Used by
 179  *      timekeeping code to verify comparibility of two cycle values
 180  */
 181 struct system_counterval_t {
 182         u64                     cycles;
 183         struct clocksource      *cs;
 184 };
 185
 186 /*
 187  * Get cross timestamp between system clock and device clock
 188  */
 189 extern int get_device_system_crosststamp(
 190                         int (*get_time_fn)(ktime_t *device_time,
 191                                 struct system_counterval_t *system_counterval,
 192                                 void *ctx),
 193                         void *ctx,
 194                         struct system_time_snapshot *history,
 195                         struct system_device_crosststamp *xtstamp);
 196
 197 /*
 198  * Simultaneously snapshot realtime and monotonic raw clocks
 199  */
 200 extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
 201
 202 /*
 203  * Persistent clock related interfaces
 204  */
 205 extern int persistent_clock_is_local;
 206
 207 extern void read_persistent_clock64(struct timespec64 *ts);
 208 extern void read_boot_clock64(struct timespec64 *ts);
 209 extern int update_persistent_clock64(struct timespec64 now);
 210
 211 /*
 212  * deprecated aliases, don't use in new code
 213  */
 214 #define getnstimeofday64(ts)            ktime_get_real_ts64(ts)
 215
 216 #endif