contrib/ntp/html/drivers/driver8.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2
   3 <html>
   4
   5         <head>
   6                 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
   7                 <title>Generic Reference Driver</title>
   8                 <link href="scripts/style.css" type="text/css" rel="stylesheet">
   9         </head>
  10
  11         <body>
  12                 <h3>Generic Reference Driver</h3>
  13                 <hr>
  14                 <h4>Synopsis</h4>
  15                 Address: 127.127.8.<i>u</i><br>
  16                 Reference ID: <tt>PARSE</tt><br>
  17                 Driver ID: <tt>GENERIC</tt><br>
  18                 Serial Port: <tt>/dev/refclock-<i>u</i></tt>; TTY mode according to clock type<br>
  19                 PPS device: <tt>/dev/refclockpps-<i>u</i></tt>; alternate PPS device (if not available via the serial port)
  20                 <h4>Description</h4>
  21                 The PARSE driver supports 20 different clock types/configurations. PARSE is actually a multi-clock driver.<br>
  22                 <br>
  23                 <p>The actual receiver status is mapped into various synchronization states generally used by receivers. The driver is configured to interpret the time codes of Meinberg DCF77 AM receivers, DCF77 FM receivers, Meinberg GPS16x/17x receivers, Trimble SV6 GPS, ELV DCF7000, Schmid, Wharton 400A and low cost receivers (see <a href="#clocklist">list below</a>).</p>
  24                 <p>The reference clock support in NTP contains the necessary configuration tables for those receivers. In addition to supporting several different clock types and up to 4 devices, the processing of a PPS signal is also provided as a configuration option. The PPS configuration option uses the receiver-generated time stamps for feeding the PPS loopfilter control for much finer clock synchronization.</p>
  25                 <p>CAUTION: The PPS configuration option is different from the hardware PPS signal, which is also supported (see below), as it controls the way ntpd is synchronized to the reference clock, while the hardware PPS signal controls the way time offsets are determined.</p>
  26                 <p>The use of the PPS option requires receivers with an accuracy of better than 1ms.</p>
  27                 <h4>Timecode variables listed by ntpq (8)</h4>
  28                 <p>The ntpq program can read and display several clock variables. These hold the following information:</p>
  29                 <dl>
  30                         <dt><tt>refclock_format</tt></dt>
  31                         <dd>A qualification of the decoded time code format.</dd>
  32                         <dt><tt>refclock_states</tt></dt>
  33                         <dd>The overall running time and the accumulated times for the clock event states.</dd>
  34                         <dt><tt>refclock_status</tt></dt>
  35                         <dd>Lists the currently active receiver flags. Additional feature flags for the receiver are optionally listed in parentheses.</dd>
  36                         <dt><tt>refclock_time</tt></dt>
  37                         <dd>The local time with the offset to UTC (format HHMM).</dd>
  38                         <dt><tt>timecode</tt></dt>
  39                         <dd>The actual time code.</dd>
  40                 </dl>
  41                 <p>If PPS information is present, additional variables are available:</p>
  42                 <dl>
  43                         <dt><tt>refclock_ppsskew</tt></dt>
  44                         <dd>The difference between the RS-232-derived timestamp and the PPS timestamp.</dd>
  45                         <dt><tt>refclock_ppstime</tt></dt>
  46                         <dd>The PPS timestamp.</dd>
  47                 </dl>
  48                 <h4>Supported Devices</h4>
  49                 <p>Currently, nineteen clock types (devices /dev/refclock-0 - /dev/refclock-3) are supported by the PARSE driver.<br>
  50                         A note on the implementations:</p>
  51                 <ul>
  52                         <li>These implementations were mainly done without actual access to the hardware, thus not all implementations provide full support. The development was done with the help of many kind souls who had the hardware and kindly lent me their time and patience during the development and debugging cycle. Thus for continued support and quality, direct access to the receivers is a big help. Nevertheless I am not prepared to buy these reference clocks - donations to (<a href="mailto:kardel <AT> ntp.org">kardel &lt;AT&gt; ntp.org</a>) are welcome as long as they work within Europe 8-).
  53                                 <p>Verified implementations are:</p>
  54                                 <ul>
  55                                         <li>RAWDCF variants
  56                                                 <p>These variants have been tested for correct decoding with my own homegrown receivers. Interfacing with specific commercial products may involve some fiddling with cables. In particular, commercial RAWDCF receivers have a seemingly unlimited number of ways to draw power from the RS-232 port and to encode the DCF77 datastream. You are mainly on your own here unless I have a sample of the receiver.</p>
  57                                         <li><a href="http://www.meinberg.de">Meinberg clocks</a>
  58                                                 <p>These implementations have been verified by the Meinberg people themselves and I have access to one of these clocks.</p>
  59                                 </ul>
  60                 </ul>
  61                 <p>The pictures below have been taken from and are linked to the vendors' web pages.</p>
  62                 <a name="clocklist"></a>
  63                 <ul>
  64                         <li><b><tt>server 127.127.8.0-3 mode 0</tt></b>
  65                                 <p><b><tt><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#dcf---freq_sync">PZF5xx receiver family</a> (FM demodulation/TCXO / 50&mu;s)</tt></b><br>
  66                                 <br></p>
  67
  68                         <li><b><tt>server 127.127.8.0-3 mode 1</tt></b>
  69                                 <p><b><tt><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#dcf---freq_sync">PZF5xx receiver family</a> (FM demodulation/OCXO / 50&mu;s)</tt></b><br>
  70                                         <a href="http://www.meinberg.de/english/products/pzf-eurocard.htm"><img src="../pic/pzf511.jpg" alt="Image PZF511" height="300" width="260" align="top" border="0"></a><br>
  71                                 <br></p>
  72
  73                         <li><a name="mode2"></a><b><tt>server 127.127.8.0-3 mode 2</tt></b>
  74                                 <p><b><tt><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/c51.htm">DCF C51 receiver and similar</a> (AM demodulation / 4ms)</tt></b><br>
  75                                         <a href="http://www.meinberg.de/english/products/c51.htm"><img src="../pic/c51.jpg" alt="Image C51" height="239" width="330" align="top"  border="0"></a><br>
  76                                 </p>
  77                                 <p>This mode expects the Meinberg standard time string format with 9600/7E2.</p>
  78                                 <p><b>Note:</b> mode 2 must also be used for <a href="http://www.meinberg.de/english/products/formfactor.htm#slot_card">Meinberg PCI cards</a> under Linux, e.g. <a href="http://www.meinberg.de/english/products/gps-pcicard.htm">the GPS PCI card</a> or <a href="http://www.meinberg.de/english/products/dcf-pcicard.htm">the DCF77 PCI card</a>. Please note the <a href="http://www.meinberg.de/english/sw/#linux">Meinberg Linux driver</a> must be installed. That driver emulates a refclock device in order to allow ntpd to access those cards. For details, please refer to the README file that comes with the Meinberg driver package.<br>
  79                                 <br></p>
  80
  81                         <li><b><tt>server 127.127.8.0-3 mode 3</tt></b>
  82                                 <p><b><tt><a href="http://www.elv.de">ELV</a> DCF7000 (sloppy AM demodulation / 50ms)</tt></b><br>
  83                                 <br></p>
  84
  85                         <li><b><tt>server 127.127.8.0-3 mode 4</tt></b>
  86                                 <p><b><tt>Walter Schmid DCF receiver Kit (AM demodulation / 1ms)</tt></b><br>
  87                                 <br></p>
  88
  89                         <li><b><tt>server 127.127.8.0-3 mode 5</tt></b>
  90                                 <p><b><tt>RAW DCF77 100/200ms pulses (Conrad DCF77 receiver module / 5ms)</tt></b><br>
  91                                 <br></p>
  92
  93                         <li><b><tt>server 127.127.8.0-3 mode 6</tt></b>
  94                                 <p><b><tt>RAW DCF77 100/200ms pulses (TimeBrick DCF77 receiver module / 5ms)</tt></b><br>
  95                                 <br></p>
  96
  97                         <li><b><tt>server 127.127.8.0-3 mode 7</tt></b>
  98                                 <p><b><tt><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#gps---freq_sync">GPS16x/GPS17x receivers</a> (GPS / &lt;&lt;1&mu;s)</tt></b><br>
  99                                         <a href="http://www.meinberg.de/english/products/gps-eurocard.htm"><img src="../pic/gps167.jpg" alt="Image GPS167" height="300" width="280" align="top" border="0"></a><br>
 100                                 </p>
 101                                 <p>This mode expects either the University of Erlangen time string format or the Meinberg standard time string format at 19200/8N1.</p>
 102                                 <p>The University of Erlangen format is preferred. Newer Meinberg GPS receivers can be configured to transmit that format; for older devices, a special firmware version may be available.</p>
 103                                 <p>In this mode some additional GPS receiver status information is also read. However, this requires a point-to-point connection. <a href="#mode18">Mode 18</a> should be used if the device is accessed by a multidrop connection.</p>
 104                                 <p><b>Note:</b> mode 7 must not be used with Meinberg PCI cards; use <a href="#mode2">mode 2</a> instead.<br>
 105                                 <br></p>
 106
 107                         <li><b><tt>server 127.127.8.0-3 mode 8</tt></b>
 108                                 <p><b><tt><a href="http://www.igel.de">IGEL</a> <a href="http://www.igel.de/eigelmn.html">clock</a></tt></b><br>
 109                                         <a href="http://www.igel.de/eigelmn.html"><img src="../pic/igclock.gif" alt="Image IGEL clock" height="174" width="200" border="0"></a><br>
 110                                 <br></p>
 111
 112                         <li><b><tt>server 127.127.8.0-3 mode 9</tt></b>
 113                                 <p><b><tt><a href="http://www.trimble.com">Trimble</a> <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html">SVeeSix GPS receiver</a> TAIP protocol (GPS / &lt;&lt;1&mu;s)</tt></b><br>
 114                                 <br></p>
 115
 116                         <li><b><tt>server 127.127.8.0-3 mode 10</tt></b>
 117                                 <p><b><tt><a href="http://www.trimble.com">Trimble</a> <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html">SVeeSix GPS receiver</a> TSIP protocol (GPS / &lt;&lt;1&mu;s) (no kernel support yet)</tt></b><br>
 118                                         <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html"><img src="../pic/pd_om011.gif" alt="Image SVeeSix-CM3" height="100" width="420" align="top" border="0"></a><br>
 119                                         <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om006.html"><img src="../pic/pd_om006.gif" alt="Image Lassen-SK8" height="100" width="420" border="0"></a><br>
 120                                 <br></p>
 121
 122                         <li><b><tt>server 127.127.8.0-3 mode 11</tt></b>
 123                                 <p><b><tt>Radiocode Clocks Ltd RCC 8000 Intelligent Off-Air Master Clock support </tt></b><br>
 124                                 <br></p>
 125
 126                         <li><b><tt>server 127.127.8.0-3 mode 12</tt></b>
 127                                 <p><b><tt><a href="http://www.hopf-time.com">HOPF</a> <a href="http://www.hopf-time.com/kart6021.html">Funkuhr 6021</a></tt></b><br>
 128                                         <a href="http://www.hopf-time.com/engl/kart6021.html"><img src="../pic/fg6021.gif" alt="Image DCF77 Interface Board" height="207" width="238" align="top" border="0"></a><br>
 129                                 <br></p>
 130
 131                         <li><b><tt>server 127.127.8.0-3 mode 13</tt></b>
 132                                 <p><b><tt>Diem's Computime Radio Clock</tt></b><br>
 133                                 <br></p>
 134
 135                         <li><b><tt>server 127.127.8.0-3 mode 14</tt></b>
 136                                 <p><b><tt>RAWDCF receiver (DTR=high/RTS=low)</tt></b><br>
 137                                 <br></p>
 138
 139                         <li><b><tt>server 127.127.8.0-3 mode 15</tt></b>
 140                                 <p><b><tt>WHARTON 400A Series Clocks with a 404.2 Serial Interface</tt></b><br>
 141                                 <br></p>
 142
 143                         <li><b><tt>server 127.127.8.0-3 mode 16</tt></b>
 144                                 <p><b><tt>RAWDCF receiver (DTR=low/RTS=high) </tt></b><br>
 145                                 <br></p>
 146
 147                         <li><b><tt>server 127.127.8.0-3 mode 17</tt></b>
 148                                 <p><b><tt>VARITEXT Receiver (MSF) </tt></b><br>
 149                                 <br></p>
 150
 151                         <li><a name="mode18"></a><b><tt>server 127.127.8.0-3 mode 18</tt></b>
 152                                 <p><b><tt><a href="http://www.meinberg.de">Meinberg </a><a href="http://www.meinberg.de/english/products/timesource.htm#gps---freq_sync">GPS16x/GPS17x receivers</a> (GPS / &lt;&lt;1&mu;s)</tt></b><br>
 153                                 </p>
 154                                 <p>This mode works without additional data communication (version, GPS status etc.) and thus should be used with multidrop, heterogeneous multiclient operation.</p>
 155                                 <p><b>Note:</b> mode 18 must not be used with Meinberg PCI cards, use mode 2 instead.<br>
 156                                 <br></p>
 157                         <li><b><tt>server 127.127.8.0-3 mode 19</tt></b>
 158                                 <p><b><tt>Gude Analog- und Digitalsystem GmbH 'Expert mouseCLOCK USB v2.0'</tt></b><br>
 159                                 <br></p>
 160
 161                 </ul>
 162                 <p>Actual data formats and setup requirements of the various clocks can be found in <a href="../parsedata.html">NTP PARSE clock data formats</a>.</p>
 163                 <h4>Operation</h4>
 164                 <p>The reference clock support software carefully monitors the state transitions of the receiver. All state changes and exceptional events (such as loss of time code transmission) are logged via the syslog facility. Every hour a summary of the accumulated times for the clock states is listed via syslog.</p>
 165                 <p>PPS support is only available when the receiver is completely synchronized. The receiver is believed to deliver correct time for an additional period of time after losing synchronization, unless a disruption in time code transmission is detected (possible power loss). The trust period is dependent on the receiver oscillator and thus is a function of clock type.</p>
 166                 <p>Raw DCF77 pulses can be fed via a level converter to the RXD pin of an RS-232 serial port (pin 3 of a 25-pin connector or pin 2 of a 9-pin connector). The telegrams are decoded and used for synchronization. DCF77 AM receivers can be bought for as little as $25. The accuracy is dependent on the receiver and is somewhere between 2ms (expensive) and 10ms (cheap). Synchronization ceases when reception of the DCF77 signal deteriorates, since no backup oscillator is available as usually found in other reference clock receivers. So it is important to have a good place for the DCF77 antenna. During transmitter shutdowns you are out of luck unless you have other NTP servers with alternate time sources available.</p>
 167                 <p>In addition to the PPS loopfilter control, a true PPS hardware signal can be utilized via the PPSAPI interface. PPS pulses are usually fed via a level converter to the DCD pin of an RS-232 serial port (pin 8 of a 25-pin connector or pin 1 of a 9-pin connector). To select PPS support, the mode parameter is the mode value as above plus 128. If 128 is not added to the mode value, PPS will be detected to be available but will not be used.
 168                 </p>
 169                 <h4>Hardware PPS support<br>
 170                 </h4>
 171                 <p>For PPS to be used, add 128 to the mode parameter.</p>
 172                 <p>If the PPS signal is fed in from a device different from the device providing the serial communication (/dev/refclock-{0..3}), this device is configured as /dev/refclockpps-{0..3}. This allows the PPS information to be fed in e.g. via the parallel port (if supported by the underlying operation system) and the date/time telegrams to be handled via the serial port.</p>
 173                 <h4>Monitor Data</h4>
 174                 <p>Clock state statistics are written hourly to the syslog service. Online information can be found by examining the clock variables via the <code>ntpq cv</code> command.<br>
 175                         Some devices have quite extensive additional information (GPS16x/GPS17x, Trimble). The driver reads out much of the internal GPS data
 176                         and makes it accessible via clock variables. To find out about additional variable names, query for the clock_var_list variable on
 177                         a specific clock association as shown below.
 178                 </p>
 179                 <p>First let <code>ntpq</code> display the table of associations:</p>
 180                 <pre>
 181   ntpq&gt; as
 182   ind assID status  conf reach auth condition  last_event cnt
 183   ===========================================================
 184     1 19556  9154   yes   yes  none falsetick   reachable  5
 185     2 19557  9435   yes   yes  none  candidat  clock expt  3
 186     3 19558  9714   yes   yes  none  pps.peer   reachable  1
 187                 </pre>
 188                 <p>Then switch to raw output. This may be required because of display limitations in ntpq/ntpd - so large lists need to be retrieved in several queries.</p>
 189                 <pre>
 190   ntpq&gt; raw
 191   Output set to raw
 192                 </pre>
 193                 <p>Use the cv command to read the list of clock variables of a selected association:</p>
 194                 <pre>
 195   ntpq&gt; cv 19557 clock_var_list
 196                 </pre>
 197                 <p>The long output of the command above looks similar to:</p>
 198                 <pre>
 199   assID=19557 status=0x0000,
 200   clock_var_list=&quot;type,timecode,poll,noreply,badformat,baddata,fudgetime1,
 201   fudgetime2,stratum,refid,flags,device,clock_var_list,refclock_time,refclock_status,
 202   refclock_format,refclock_states,refclock_id,refclock_iomode,refclock_driver_version,
 203   meinberg_gps_status,gps_utc_correction,gps_message,meinberg_antenna_status,gps_tot_51,
 204   gps_tot_63,gps_t0a,gps_cfg[1],gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],
 205   gps_health[3],gps_cfg[4],gps_health[4],gps_cfg[5]&quot;
 206                 </pre>
 207                 <p>Then use the cv command again to list selected clock variables. The following command must be entered as a single line:</p>
 208                 <pre>
 209   ntpq&gt; cv 19557 refclock_status,refclock_format,refclock_states,refclock_id,
 210   refclock_iomode,refclock_driver_version,meinberg_gps_status,gps_utc_correction,
 211   gps_message,meinberg_antenna_status,gps_tot_51,gps_tot_63,gps_t0a,gps_cfg[1],
 212   gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],gps_health[3],gps_cfg[4],
 213   gps_health[4],gps_cfg[5]
 214                 </pre>
 215                 <p>The output of the command above is wrapped around depending on the screen width and looks similar to:</p>
 216                 <pre>
 217   status=0x0003,
 218   refclock_status=&quot;UTC DISPLAY; TIME CODE; PPS; POSITION; (LEAP INDICATION;
 219   PPS SIGNAL; POSITION)&quot;,
 220   refclock_format=&quot;Meinberg GPS Extended&quot;,
 221   refclock_states=&quot;*NOMINAL: 21:21:36 (99.99%); FAULT: 00:00:03 (0.00%);
 222   running time: 21:21:39&quot;,
 223   refclock_id=&quot;GPS&quot;, refclock_iomode=&quot;normal&quot;,
 224   refclock_driver_version=&quot;refclock_parse.c,v 4.77 2006/08/05 07:44:49
 225   kardel RELEASE_20060805_A&quot;,
 226   meinberg_gps_status=&quot;[0x0000] &lt;OK&gt;&quot;,
 227   gps_utc_correction=&quot;current correction 14 sec, last correction
 228   on c7619a00.00000000  Sun, Jan  1 2006  0:00:00.000&quot;,
 229   gps_message=&quot;/PFU3SOP-4WG14EPU0V1KA&quot;,
 230   meinberg_antenna_status=&quot;RECONNECTED on 2006-07-18 08:13:20.0000000 (+0000)
 231   UTC CORR, LOCAL TIME, reconnect clockoffset +0.0000000 s,
 232   disconnect time 0000-00-00 00:00:00.0000000 (+0000) &quot;,
 233   gps_tot_51=&quot;week 1400 + 3 days + 42300.0000000 sec&quot;,
 234   gps_tot_63=&quot;week 1400 + 3 days + 42294.0000000 sec&quot;,
 235   gps_t0a=&quot;week 1400 + 5 days + 71808.0000000 sec&quot;,
 236   gps_cfg[1]=&quot;[0x9] BLOCK II&quot;, gps_health[1]=&quot;[0x0] OK;SIGNAL OK&quot;,
 237   gps_cfg[2]=&quot;[0x0] BLOCK I&quot;, gps_health[2]=&quot;[0x3f] PARITY;MULTIPLE ERRS&quot;,
 238   gps_cfg[3]=&quot;[0x9] BLOCK II&quot;, gps_health[3]=&quot;[0x0] OK;SIGNAL OK&quot;,
 239   gps_cfg[4]=&quot;[0x9] BLOCK II&quot;, gps_health[6]=&quot;[0x0] OK;SIGNAL OK&quot;,
 240   gps_cfg[5]=&quot;[0x9] BLOCK II&quot;
 241                 </pre>
 242                 <h4>Fudge Factors</h4>
 243                 <dl>
 244                         <dt><tt>time1 <i>time</i></tt>
 245                         <dd>Specifies the time offset calibration factor, in seconds and fraction. The default value depends on the clock type.
 246                         <dt><tt>time2 <i>time</i></tt>
 247                         <dd>
 248                                 If flag1 is 0, time2 specifies the offset of the PPS signal from the actual time (PPS fine tuning).
 249                         <dd>
 250                                 If flag1 is 1, time2 specifies the number of seconds a receiver with a premium local oscillator can be trusted after losing synchronisation.
 251                         <dt><tt>stratum <i>stratum</i></tt>
 252                         <dd>The stratum for this reference clock.
 253                         <dt><tt>refid <i>refid</i></tt>
 254                         <dd>The refid for this reference clock.
 255                 </dl>
 256                 <dl>
 257                         <dt><tt>flag1 { 0 | 1 }</tt>
 258                         <dd>If 0, the fudge factor <tt>time2</tt> refers to the PPS offset.
 259                         <dd>If 1, <tt>time2</tt> refers to the TRUST TIME.
 260                         <dt><tt>flag2 { 0 | 1 }</tt>
 261                         <dd>If <tt>flag2</tt> is 1, sample PPS on CLEAR instead of on ASSERT.
 262                         <dt><tt>flag3 { 0 | 1 }</tt>
 263                         <dd>If <tt>flag3</tt> is 1, link kernel PPS tracking to this refclock instance.
 264                         <dt><tt>flag4 { 0 | 1 }</tt>
 265                         <dd>Delete next leap second instead of adding it. (You'll need to wait a bit for that to happen 8-)
 266                 </dl>
 267                 <span style="font-weight: bold;">Note about auxiliary Sun STREAMS modules (SunOS and Solaris):</span><br>
 268                 <dl>
 269                         <dt>The timecode of these receivers can be sampled via a STREAMS module in the kernel. (The STREAMS module has been designed for use with Sun systems under SunOS 4.1.x or Solaris 2.3 - 2.8. It can be linked directly into the kernel or loaded via the loadable driver mechanism.) This STREAMS module can be adapted to convert different time code formats. Nowadays the PPSAPI mechanism is usually used.
 270                 </dl>
 271                 <h4>Making your own PARSE clocks</h4>
 272                 <p>The parse clock mechanism deviates from the way other NTP reference clocks work. For a short description of how to build parse reference clocks, see <a href="../parsenew.html">making PARSE clocks</a>.</p>
 273                 <p>Additional Information</p>
 274                 <p><a href="../refclock.html">Reference Clock Drivers</a></p>
 275                 <hr>
 276                 <script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
 277         </body>
 278
 279 </html>