]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
adjtimex.2: Add nanosecond details
authorMichael Kerrisk <mtk.manpages@gmail.com>
Wed, 18 Jun 2014 13:08:28 +0000 (15:08 +0200)
committerMichael Kerrisk <mtk.manpages@gmail.com>
Tue, 30 Dec 2014 15:02:41 +0000 (16:02 +0100)
Fixes ttps://bugzilla.kernel.org/show_bug.cgi?id=61171.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Conflicts:
man2/adjtimex.2

man2/adjtimex.2

index c81beba98e9ea67c0b03eee3a0d63c1130646243..934f7705957003bc67bafb1107d05d13569b31dc 100644 (file)
@@ -51,7 +51,9 @@ This structure is declared as follows:
 .nf
 struct timex {
     int  modes;       /* Mode selector */
-    long offset;      /* Time offset (microseconds) */
+    long offset;      /* Time offset; nanoseconds, if STA_NANO
+                         status flag is set, otherwise
+                         microseconds */
     long freq;        /* Frequency offset, as scaled PPM
                          (parts per million) */
 .\" FIXME What is the scaling unit of timex.freq?  2^16 ?
@@ -64,13 +66,17 @@ struct timex {
     long tolerance;   /* Clock frequency tolerance (PPM,
                          read-only) */
     struct timeval time;
-                      /* Current time (read-only, except
-                         for ADJ_SETOFFSET) */
+                      /* Current time (read-only, except for
+                         ADJ_SETOFFSET); upon return, time.tv_usec
+                         contains nanoseconds, if STA_NANO status
+                         flag is set, otherwise microseconds */
     long tick;        /* Microseconds between clock ticks */
     long ppsfreq;     /* PPS (pulse per second) frequency
                          (scaled PPM, read-only) */
-    long jitter;      /* PPS jitter (microseconds, read-only) */
-    int shift;        /* PPS interval duration
+    long jitter;      /* PPS jitter (read-only); nanoseconds, if
+                         STA_NANO status flag is set, otherwise
+                         microseconds */
+    int  shift;       /* PPS interval duration
                          (seconds, read-only) */
     long stabil;      /* PPS stability (scaled PPM, read-only) */
     long jitcnt;      /* PPS jitter limit exceeded (read-only) */
@@ -115,6 +121,9 @@ Set clock status from
 .BR ADJ_TIMECONST
 Set PLL time constant from
 .IR buf.constant .
+If the
+.B STA_NANO
+status flag (see below) is clear, the kernel adds 4 to this value.
 .TP
 .BR ADJ_SETOFFSET " (since Linux 2.6.29)"
 .\" commit 094aa1881fdc1b8889b442eb3511b31f3ec2b762
@@ -267,6 +276,10 @@ Clock hardware fault (read-only).
 .\" commit eea83d896e318bda54be2d2770d2c5d6668d11db
 .\" Author: Roman Zippel <zippel@linux-m68k.org>
 Resolution (0 = microsecond, 1 = nanoseconds; read-only).
+See via
+.BR ADJ_NANO ,
+cleared via
+.BR ADJ_MICRO .
 .TP
 .BR STA_MODE " (since Linux 2.6.26)"
 .\" commit eea83d896e318bda54be2d2770d2c5d6668d11db