include/linux/timex.h

   1 /*****************************************************************************
   2  *                                                                           *
   3  * Copyright (c) David L. Mills 1993                                         *
   4  *                                                                           *
   5  * Permission to use, copy, modify, and distribute this software and its     *
   6  * documentation for any purpose and without fee is hereby granted, provided *
   7  * that the above copyright notice appears in all copies and that both the   *
   8  * copyright notice and this permission notice appear in supporting          *
   9  * documentation, and that the name University of Delaware not be used in    *
  10  * advertising or publicity pertaining to distribution of the software       *
  11  * without specific, written prior permission.  The University of Delaware   *
  12  * makes no representations about the suitability this software for any      *
  13  * purpose.  It is provided "as is" without express or implied warranty.     *
  14  *                                                                           *
  15  *****************************************************************************/
  16
  17 /*
  18  * Modification history timex.h
  19  *
  20  * 29 Dec 97    Russell King
  21  *      Moved CLOCK_TICK_RATE, CLOCK_TICK_FACTOR and FINETUNE to asm/timex.h
  22  *      for ARM machines
  23  *
  24  *  9 Jan 97    Adrian Sun
  25  *      Shifted LATCH define to allow access to alpha machines.
  26  *
  27  * 26 Sep 94    David L. Mills
  28  *      Added defines for hybrid phase/frequency-lock loop.
  29  *
  30  * 19 Mar 94    David L. Mills
  31  *      Moved defines from kernel routines to header file and added new
  32  *      defines for PPS phase-lock loop.
  33  *
  34  * 20 Feb 94    David L. Mills
  35  *      Revised status codes and structures for external clock and PPS
  36  *      signal discipline.
  37  *
  38  * 28 Nov 93    David L. Mills
  39  *      Adjusted parameters to improve stability and increase poll
  40  *      interval.
  41  *
  42  * 17 Sep 93    David L. Mills
  43  *      Created file $NTP/include/sys/timex.h
  44  * 07 Oct 93    Torsten Duwe
  45  *      Derived linux/timex.h
  46  * 1995-08-13    Torsten Duwe
  47  *      kernel PLL updated to 1994-12-13 specs (rfc-1589)
  48  * 1997-08-30    Ulrich Windl
  49  *      Added new constant NTP_PHASE_LIMIT
  50  */
  51 #ifndef _LINUX_TIMEX_H
  52 #define _LINUX_TIMEX_H
  53
  54 /*
  55  * The following defines establish the engineering parameters of the PLL
  56  * model. The HZ variable establishes the timer interrupt frequency, 100 Hz
  57  * for the SunOS kernel, 256 Hz for the Ultrix kernel and 1024 Hz for the
  58  * OSF/1 kernel. The SHIFT_HZ define expresses the same value as the
  59  * nearest power of two in order to avoid hardware multiply operations.
  60  */
  61 #ifdef __alpha__
  62 # define SHIFT_HZ 10            /* log2(HZ) */
  63 #else
  64 # define SHIFT_HZ 7             /* log2(HZ) */
  65 #endif
  66
  67 /*
  68  * SHIFT_KG and SHIFT_KF establish the damping of the PLL and are chosen
  69  * for a slightly underdamped convergence characteristic. SHIFT_KH
  70  * establishes the damping of the FLL and is chosen by wisdom and black
  71  * art.
  72  *
  73  * MAXTC establishes the maximum time constant of the PLL. With the
  74  * SHIFT_KG and SHIFT_KF values given and a time constant range from
  75  * zero to MAXTC, the PLL will converge in 15 minutes to 16 hours,
  76  * respectively.
  77  */
  78 #define SHIFT_KG 6              /* phase factor (shift) */
  79 #define SHIFT_KF 16             /* PLL frequency factor (shift) */
  80 #define SHIFT_KH 2              /* FLL frequency factor (shift) */
  81 #define MAXTC 6                 /* maximum time constant (shift) */
  82
  83 /*
  84  * The SHIFT_SCALE define establishes the decimal point of the time_phase
  85  * variable which serves as an extension to the low-order bits of the
  86  * system clock variable. The SHIFT_UPDATE define establishes the decimal
  87  * point of the time_offset variable which represents the current offset
  88  * with respect to standard time. The FINEUSEC define represents 1 usec in
  89  * scaled units.
  90  *
  91  * SHIFT_USEC defines the scaling (shift) of the time_freq and
  92  * time_tolerance variables, which represent the current frequency
  93  * offset and maximum frequency tolerance.
  94  *
  95  * FINEUSEC is 1 us in SHIFT_UPDATE units of the time_phase variable.
  96  */
  97 #define SHIFT_SCALE 22          /* phase scale (shift) */
  98 #define SHIFT_UPDATE (SHIFT_KG + MAXTC) /* time offset scale (shift) */
  99 #define SHIFT_USEC 16           /* frequency offset scale (shift) */
 100 #define FINEUSEC (1L << SHIFT_SCALE) /* 1 us in phase units */
 101
 102 #define MAXPHASE 512000L        /* max phase error (us) */
 103 #define MAXFREQ (512L << SHIFT_USEC)  /* max frequency error (ppm) */
 104 #define MAXTIME (200L << PPS_AVG) /* max PPS error (jitter) (200 us) */
 105 #define MINSEC 16L              /* min interval between updates (s) */
 106 #define MAXSEC 1200L            /* max interval between updates (s) */
 107 #define NTP_PHASE_LIMIT (MAXPHASE << 5) /* beyond max. dispersion */
 108
 109 /*
 110  * The following defines are used only if a pulse-per-second (PPS)
 111  * signal is available and connected via a modem control lead, such as
 112  * produced by the optional ppsclock feature incorporated in the Sun
 113  * asynch driver. They establish the design parameters of the frequency-
 114  * lock loop used to discipline the CPU clock oscillator to the PPS
 115  * signal.
 116  *
 117  * PPS_AVG is the averaging factor for the frequency loop, as well as
 118  * the time and frequency dispersion.
 119  *
 120  * PPS_SHIFT and PPS_SHIFTMAX specify the minimum and maximum
 121  * calibration intervals, respectively, in seconds as a power of two.
 122  *
 123  * PPS_VALID is the maximum interval before the PPS signal is considered
 124  * invalid and protocol updates used directly instead.
 125  *
 126  * MAXGLITCH is the maximum interval before a time offset of more than
 127  * MAXTIME is believed.
 128  */
 129 #define PPS_AVG 2               /* pps averaging constant (shift) */
 130 #define PPS_SHIFT 2             /* min interval duration (s) (shift) */
 131 #define PPS_SHIFTMAX 8          /* max interval duration (s) (shift) */
 132 #define PPS_VALID 120           /* pps signal watchdog max (s) */
 133 #define MAXGLITCH 30            /* pps signal glitch max (s) */
 134
 135 /*
 136  * Pick up the architecture specific timex specifications
 137  */
 138 #include <asm/timex.h>
 139
 140 /* LATCH is used in the interval timer and ftape setup. */
 141 #define LATCH  ((CLOCK_TICK_RATE + HZ/2) / HZ)  /* For divider */
 142
 143 /*
 144  * syscall interface - used (mainly by NTP daemon)
 145  * to discipline kernel clock oscillator
 146  */
 147 struct timex {
 148         unsigned int modes;     /* mode selector */
 149         long offset;            /* time offset (usec) */
 150         long freq;              /* frequency offset (scaled ppm) */
 151         long maxerror;          /* maximum error (usec) */
 152         long esterror;          /* estimated error (usec) */
 153         int status;             /* clock command/status */
 154         long constant;          /* pll time constant */
 155         long precision;         /* clock precision (usec) (read only) */
 156         long tolerance;         /* clock frequency tolerance (ppm)
 157                                  * (read only)
 158                                  */
 159         struct timeval time;    /* (read only) */
 160         long tick;              /* (modified) usecs between clock ticks */
 161
 162         long ppsfreq;           /* pps frequency (scaled ppm) (ro) */
 163         long jitter;            /* pps jitter (us) (ro) */
 164         int shift;              /* interval duration (s) (shift) (ro) */
 165         long stabil;            /* pps stability (scaled ppm) (ro) */
 166         long jitcnt;            /* jitter limit exceeded (ro) */
 167         long calcnt;            /* calibration intervals (ro) */
 168         long errcnt;            /* calibration errors (ro) */
 169         long stbcnt;            /* stability limit exceeded (ro) */
 170
 171         int  :32; int  :32; int  :32; int  :32;
 172         int  :32; int  :32; int  :32; int  :32;
 173         int  :32; int  :32; int  :32; int  :32;
 174 };
 175
 176 /*
 177  * Mode codes (timex.mode)
 178  */
 179 #define ADJ_OFFSET              0x0001  /* time offset */
 180 #define ADJ_FREQUENCY           0x0002  /* frequency offset */
 181 #define ADJ_MAXERROR            0x0004  /* maximum time error */
 182 #define ADJ_ESTERROR            0x0008  /* estimated time error */
 183 #define ADJ_STATUS              0x0010  /* clock status */
 184 #define ADJ_TIMECONST           0x0020  /* pll time constant */
 185 #define ADJ_TICK                0x4000  /* tick value */
 186 #define ADJ_OFFSET_SINGLESHOT   0x8001  /* old-fashioned adjtime */
 187
 188 /* xntp 3.4 compatibility names */
 189 #define MOD_OFFSET      ADJ_OFFSET
 190 #define MOD_FREQUENCY   ADJ_FREQUENCY
 191 #define MOD_MAXERROR    ADJ_MAXERROR
 192 #define MOD_ESTERROR    ADJ_ESTERROR
 193 #define MOD_STATUS      ADJ_STATUS
 194 #define MOD_TIMECONST   ADJ_TIMECONST
 195 #define MOD_CLKB        ADJ_TICK
 196 #define MOD_CLKA        ADJ_OFFSET_SINGLESHOT /* 0x8000 in original */
 197
 198
 199 /*
 200  * Status codes (timex.status)
 201  */
 202 #define STA_PLL         0x0001  /* enable PLL updates (rw) */
 203 #define STA_PPSFREQ     0x0002  /* enable PPS freq discipline (rw) */
 204 #define STA_PPSTIME     0x0004  /* enable PPS time discipline (rw) */
 205 #define STA_FLL         0x0008  /* select frequency-lock mode (rw) */
 206
 207 #define STA_INS         0x0010  /* insert leap (rw) */
 208 #define STA_DEL         0x0020  /* delete leap (rw) */
 209 #define STA_UNSYNC      0x0040  /* clock unsynchronized (rw) */
 210 #define STA_FREQHOLD    0x0080  /* hold frequency (rw) */
 211
 212 #define STA_PPSSIGNAL   0x0100  /* PPS signal present (ro) */
 213 #define STA_PPSJITTER   0x0200  /* PPS signal jitter exceeded (ro) */
 214 #define STA_PPSWANDER   0x0400  /* PPS signal wander exceeded (ro) */
 215 #define STA_PPSERROR    0x0800  /* PPS signal calibration error (ro) */
 216
 217 #define STA_CLOCKERR    0x1000  /* clock hardware fault (ro) */
 218
 219 #define STA_RONLY (STA_PPSSIGNAL | STA_PPSJITTER | STA_PPSWANDER | \
 220     STA_PPSERROR | STA_CLOCKERR) /* read-only bits */
 221
 222 /*
 223  * Clock states (time_state)
 224  */
 225 #define TIME_OK         0       /* clock synchronized, no leap second */
 226 #define TIME_INS        1       /* insert leap second */
 227 #define TIME_DEL        2       /* delete leap second */
 228 #define TIME_OOP        3       /* leap second in progress */
 229 #define TIME_WAIT       4       /* leap second has occurred */
 230 #define TIME_ERROR      5       /* clock not synchronized */
 231 #define TIME_BAD        TIME_ERROR /* bw compat */
 232
 233 #ifdef __KERNEL__
 234 /*
 235  * kernel variables
 236  * Note: maximum error = NTP synch distance = dispersion + delay / 2;
 237  * estimated error = NTP dispersion.
 238  */
 239 extern long tick;                      /* timer interrupt period */
 240 extern int tickadj;                     /* amount of adjustment per tick */
 241
 242 /*
 243  * phase-lock loop variables
 244  */
 245 extern int time_state;          /* clock status */
 246 extern int time_status;         /* clock synchronization status bits */
 247 extern long time_offset;        /* time adjustment (us) */
 248 extern long time_constant;      /* pll time constant */
 249 extern long time_tolerance;     /* frequency tolerance (ppm) */
 250 extern long time_precision;     /* clock precision (us) */
 251 extern long time_maxerror;      /* maximum error */
 252 extern long time_esterror;      /* estimated error */
 253
 254 extern long time_phase;         /* phase offset (scaled us) */
 255 extern long time_freq;          /* frequency offset (scaled ppm) */
 256 extern long time_adj;           /* tick adjust (scaled 1 / HZ) */
 257 extern long time_reftime;       /* time at last adjustment (s) */
 258
 259 extern long time_adjust;        /* The amount of adjtime left */
 260
 261 /* interface variables pps->timer interrupt */
 262 extern long pps_offset;         /* pps time offset (us) */
 263 extern long pps_jitter;         /* time dispersion (jitter) (us) */
 264 extern long pps_freq;           /* frequency offset (scaled ppm) */
 265 extern long pps_stabil;         /* frequency dispersion (scaled ppm) */
 266 extern long pps_valid;          /* pps signal watchdog counter */
 267
 268 /* interface variables pps->adjtimex */
 269 extern int pps_shift;           /* interval duration (s) (shift) */
 270 extern long pps_jitcnt;         /* jitter limit exceeded */
 271 extern long pps_calcnt;         /* calibration intervals */
 272 extern long pps_errcnt;         /* calibration errors */
 273 extern long pps_stbcnt;         /* stability limit exceeded */
 274
 275 #endif /* KERNEL */
 276
 277 #endif /* LINUX_TIMEX_H */