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 time64_t ktime_get_seconds(void);
  34 extern time64_t ktime_get_real_seconds(void);
  35
  36 extern int __getnstimeofday64(struct timespec64 *tv);
  37 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  * ktime_t based interfaces
  44  */
  45
  46 enum tk_offsets {
  47         TK_OFFS_REAL,
  48         TK_OFFS_BOOT,
  49         TK_OFFS_TAI,
  50         TK_OFFS_MAX,
  51 };
  52
  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  * ktime_get_real - get the real (wall-) time in ktime_t format
  61  */
  62 static inline ktime_t ktime_get_real(void)
  63 {
  64         return ktime_get_with_offset(TK_OFFS_REAL);
  65 }
  66
  67 /**
  68  * ktime_get_boottime - Returns monotonic time since boot in ktime_t format
  69  *
  70  * This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
  71  * time spent in suspend.
  72  */
  73 static inline ktime_t ktime_get_boottime(void)
  74 {
  75         return ktime_get_with_offset(TK_OFFS_BOOT);
  76 }
  77
  78 /**
  79  * ktime_get_clocktai - Returns the TAI time of day in ktime_t format
  80  */
  81 static inline ktime_t ktime_get_clocktai(void)
  82 {
  83         return ktime_get_with_offset(TK_OFFS_TAI);
  84 }
  85
  86 /**
  87  * ktime_mono_to_real - Convert monotonic time to clock realtime
  88  */
  89 static inline ktime_t ktime_mono_to_real(ktime_t mono)
  90 {
  91         return ktime_mono_to_any(mono, TK_OFFS_REAL);
  92 }
  93
  94 static inline u64 ktime_get_ns(void)
  95 {
  96         return ktime_to_ns(ktime_get());
  97 }
  98
  99 static inline u64 ktime_get_real_ns(void)
 100 {
 101         return ktime_to_ns(ktime_get_real());
 102 }
 103
 104 static inline u64 ktime_get_boot_ns(void)
 105 {
 106         return ktime_to_ns(ktime_get_boottime());
 107 }
 108
 109 static inline u64 ktime_get_tai_ns(void)
 110 {
 111         return ktime_to_ns(ktime_get_clocktai());
 112 }
 113
 114 static inline u64 ktime_get_raw_ns(void)
 115 {
 116         return ktime_to_ns(ktime_get_raw());
 117 }
 118
 119 extern u64 ktime_get_mono_fast_ns(void);
 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 static inline void get_monotonic_boottime64(struct timespec64 *ts)
 128 {
 129         *ts = ktime_to_timespec64(ktime_get_boottime());
 130 }
 131
 132 static inline void timekeeping_clocktai64(struct timespec64 *ts)
 133 {
 134         *ts = ktime_to_timespec64(ktime_get_clocktai());
 135 }
 136
 137 /*
 138  * RTC specific
 139  */
 140 extern bool timekeeping_rtc_skipsuspend(void);
 141 extern bool timekeeping_rtc_skipresume(void);
 142
 143 extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
 144
 145 /*
 146  * PPS accessor
 147  */
 148 extern void ktime_get_raw_and_real_ts64(struct timespec64 *ts_raw,
 149                                         struct timespec64 *ts_real);
 150
 151 /*
 152  * struct system_time_snapshot - simultaneous raw/real time capture with
 153  *      counter value
 154  * @cycles:     Clocksource counter value to produce the system times
 155  * @real:       Realtime system time
 156  * @raw:        Monotonic raw system time
 157  * @clock_was_set_seq:  The sequence number of clock was set events
 158  * @cs_was_changed_seq: The sequence number of clocksource change events
 159  */
 160 struct system_time_snapshot {
 161         u64             cycles;
 162         ktime_t         real;
 163         ktime_t         raw;
 164         unsigned int    clock_was_set_seq;
 165         u8              cs_was_changed_seq;
 166 };
 167
 168 /*
 169  * struct system_device_crosststamp - system/device cross-timestamp
 170  *      (syncronized capture)
 171  * @device:             Device time
 172  * @sys_realtime:       Realtime simultaneous with device time
 173  * @sys_monoraw:        Monotonic raw simultaneous with device time
 174  */
 175 struct system_device_crosststamp {
 176         ktime_t device;
 177         ktime_t sys_realtime;
 178         ktime_t sys_monoraw;
 179 };
 180
 181 /*
 182  * struct system_counterval_t - system counter value with the pointer to the
 183  *      corresponding clocksource
 184  * @cycles:     System counter value
 185  * @cs:         Clocksource corresponding to system counter value. Used by
 186  *      timekeeping code to verify comparibility of two cycle values
 187  */
 188 struct system_counterval_t {
 189         u64                     cycles;
 190         struct clocksource      *cs;
 191 };
 192
 193 /*
 194  * Get cross timestamp between system clock and device clock
 195  */
 196 extern int get_device_system_crosststamp(
 197                         int (*get_time_fn)(ktime_t *device_time,
 198                                 struct system_counterval_t *system_counterval,
 199                                 void *ctx),
 200                         void *ctx,
 201                         struct system_time_snapshot *history,
 202                         struct system_device_crosststamp *xtstamp);
 203
 204 /*
 205  * Simultaneously snapshot realtime and monotonic raw clocks
 206  */
 207 extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
 208
 209 /*
 210  * Persistent clock related interfaces
 211  */
 212 extern int persistent_clock_is_local;
 213
 214 extern void read_persistent_clock64(struct timespec64 *ts);
 215 extern void read_boot_clock64(struct timespec64 *ts);
 216 extern int update_persistent_clock64(struct timespec64 now);
 217
 218
 219 #endif