| 1 |
13 |
serginhofr |
/*****************************************************************************
|
| 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 |
|
|
* 2004-08-12 Christoph Lameter
|
| 51 |
|
|
* Reworked time interpolation logic
|
| 52 |
|
|
*/
|
| 53 |
|
|
#ifndef _LINUX_TIMEX_H
|
| 54 |
|
|
#define _LINUX_TIMEX_H
|
| 55 |
|
|
|
| 56 |
|
|
#include <linux/time.h>
|
| 57 |
|
|
|
| 58 |
|
|
#define NTP_API 4 /* NTP API version */
|
| 59 |
|
|
|
| 60 |
|
|
/*
|
| 61 |
|
|
* syscall interface - used (mainly by NTP daemon)
|
| 62 |
|
|
* to discipline kernel clock oscillator
|
| 63 |
|
|
*/
|
| 64 |
|
|
struct timex {
|
| 65 |
|
|
unsigned int modes; /* mode selector */
|
| 66 |
|
|
__kernel_long_t offset; /* time offset (usec) */
|
| 67 |
|
|
__kernel_long_t freq; /* frequency offset (scaled ppm) */
|
| 68 |
|
|
__kernel_long_t maxerror;/* maximum error (usec) */
|
| 69 |
|
|
__kernel_long_t esterror;/* estimated error (usec) */
|
| 70 |
|
|
int status; /* clock command/status */
|
| 71 |
|
|
__kernel_long_t constant;/* pll time constant */
|
| 72 |
|
|
__kernel_long_t precision;/* clock precision (usec) (read only) */
|
| 73 |
|
|
__kernel_long_t tolerance;/* clock frequency tolerance (ppm)
|
| 74 |
|
|
* (read only)
|
| 75 |
|
|
*/
|
| 76 |
|
|
struct timeval time; /* (read only, except for ADJ_SETOFFSET) */
|
| 77 |
|
|
__kernel_long_t tick; /* (modified) usecs between clock ticks */
|
| 78 |
|
|
|
| 79 |
|
|
__kernel_long_t ppsfreq;/* pps frequency (scaled ppm) (ro) */
|
| 80 |
|
|
__kernel_long_t jitter; /* pps jitter (us) (ro) */
|
| 81 |
|
|
int shift; /* interval duration (s) (shift) (ro) */
|
| 82 |
|
|
__kernel_long_t stabil; /* pps stability (scaled ppm) (ro) */
|
| 83 |
|
|
__kernel_long_t jitcnt; /* jitter limit exceeded (ro) */
|
| 84 |
|
|
__kernel_long_t calcnt; /* calibration intervals (ro) */
|
| 85 |
|
|
__kernel_long_t errcnt; /* calibration errors (ro) */
|
| 86 |
|
|
__kernel_long_t stbcnt; /* stability limit exceeded (ro) */
|
| 87 |
|
|
|
| 88 |
|
|
int tai; /* TAI offset (ro) */
|
| 89 |
|
|
|
| 90 |
|
|
int :32; int :32; int :32; int :32;
|
| 91 |
|
|
int :32; int :32; int :32; int :32;
|
| 92 |
|
|
int :32; int :32; int :32;
|
| 93 |
|
|
};
|
| 94 |
|
|
|
| 95 |
|
|
/*
|
| 96 |
|
|
* Mode codes (timex.mode)
|
| 97 |
|
|
*/
|
| 98 |
|
|
#define ADJ_OFFSET 0x0001 /* time offset */
|
| 99 |
|
|
#define ADJ_FREQUENCY 0x0002 /* frequency offset */
|
| 100 |
|
|
#define ADJ_MAXERROR 0x0004 /* maximum time error */
|
| 101 |
|
|
#define ADJ_ESTERROR 0x0008 /* estimated time error */
|
| 102 |
|
|
#define ADJ_STATUS 0x0010 /* clock status */
|
| 103 |
|
|
#define ADJ_TIMECONST 0x0020 /* pll time constant */
|
| 104 |
|
|
#define ADJ_TAI 0x0080 /* set TAI offset */
|
| 105 |
|
|
#define ADJ_SETOFFSET 0x0100 /* add 'time' to current time */
|
| 106 |
|
|
#define ADJ_MICRO 0x1000 /* select microsecond resolution */
|
| 107 |
|
|
#define ADJ_NANO 0x2000 /* select nanosecond resolution */
|
| 108 |
|
|
#define ADJ_TICK 0x4000 /* tick value */
|
| 109 |
|
|
|
| 110 |
|
|
#define ADJ_OFFSET_SINGLESHOT 0x8001 /* old-fashioned adjtime */
|
| 111 |
|
|
#define ADJ_OFFSET_SS_READ 0xa001 /* read-only adjtime */
|
| 112 |
|
|
|
| 113 |
|
|
/* NTP userland likes the MOD_ prefix better */
|
| 114 |
|
|
#define MOD_OFFSET ADJ_OFFSET
|
| 115 |
|
|
#define MOD_FREQUENCY ADJ_FREQUENCY
|
| 116 |
|
|
#define MOD_MAXERROR ADJ_MAXERROR
|
| 117 |
|
|
#define MOD_ESTERROR ADJ_ESTERROR
|
| 118 |
|
|
#define MOD_STATUS ADJ_STATUS
|
| 119 |
|
|
#define MOD_TIMECONST ADJ_TIMECONST
|
| 120 |
|
|
#define MOD_TAI ADJ_TAI
|
| 121 |
|
|
#define MOD_MICRO ADJ_MICRO
|
| 122 |
|
|
#define MOD_NANO ADJ_NANO
|
| 123 |
|
|
|
| 124 |
|
|
|
| 125 |
|
|
/*
|
| 126 |
|
|
* Status codes (timex.status)
|
| 127 |
|
|
*/
|
| 128 |
|
|
#define STA_PLL 0x0001 /* enable PLL updates (rw) */
|
| 129 |
|
|
#define STA_PPSFREQ 0x0002 /* enable PPS freq discipline (rw) */
|
| 130 |
|
|
#define STA_PPSTIME 0x0004 /* enable PPS time discipline (rw) */
|
| 131 |
|
|
#define STA_FLL 0x0008 /* select frequency-lock mode (rw) */
|
| 132 |
|
|
|
| 133 |
|
|
#define STA_INS 0x0010 /* insert leap (rw) */
|
| 134 |
|
|
#define STA_DEL 0x0020 /* delete leap (rw) */
|
| 135 |
|
|
#define STA_UNSYNC 0x0040 /* clock unsynchronized (rw) */
|
| 136 |
|
|
#define STA_FREQHOLD 0x0080 /* hold frequency (rw) */
|
| 137 |
|
|
|
| 138 |
|
|
#define STA_PPSSIGNAL 0x0100 /* PPS signal present (ro) */
|
| 139 |
|
|
#define STA_PPSJITTER 0x0200 /* PPS signal jitter exceeded (ro) */
|
| 140 |
|
|
#define STA_PPSWANDER 0x0400 /* PPS signal wander exceeded (ro) */
|
| 141 |
|
|
#define STA_PPSERROR 0x0800 /* PPS signal calibration error (ro) */
|
| 142 |
|
|
|
| 143 |
|
|
#define STA_CLOCKERR 0x1000 /* clock hardware fault (ro) */
|
| 144 |
|
|
#define STA_NANO 0x2000 /* resolution (0 = us, 1 = ns) (ro) */
|
| 145 |
|
|
#define STA_MODE 0x4000 /* mode (0 = PLL, 1 = FLL) (ro) */
|
| 146 |
|
|
#define STA_CLK 0x8000 /* clock source (0 = A, 1 = B) (ro) */
|
| 147 |
|
|
|
| 148 |
|
|
/* read-only bits */
|
| 149 |
|
|
#define STA_RONLY (STA_PPSSIGNAL | STA_PPSJITTER | STA_PPSWANDER | \
|
| 150 |
|
|
STA_PPSERROR | STA_CLOCKERR | STA_NANO | STA_MODE | STA_CLK)
|
| 151 |
|
|
|
| 152 |
|
|
/*
|
| 153 |
|
|
* Clock states (time_state)
|
| 154 |
|
|
*/
|
| 155 |
|
|
#define TIME_OK 0 /* clock synchronized, no leap second */
|
| 156 |
|
|
#define TIME_INS 1 /* insert leap second */
|
| 157 |
|
|
#define TIME_DEL 2 /* delete leap second */
|
| 158 |
|
|
#define TIME_OOP 3 /* leap second in progress */
|
| 159 |
|
|
#define TIME_WAIT 4 /* leap second has occurred */
|
| 160 |
|
|
#define TIME_ERROR 5 /* clock not synchronized */
|
| 161 |
|
|
#define TIME_BAD TIME_ERROR /* bw compat */
|
| 162 |
|
|
|
| 163 |
|
|
|
| 164 |
|
|
#endif /* _LINUX_TIMEX_H */
|
