add FreeBSD section
[KenyonWiki.git] / Time_server.mdwn
1 This page documents my project to build a stratum 1 NTP [[!wikipedia time server]] at my house.
2 <!-- link to this page from http://wiki.northgrum.com/wiki/Network_Time_Protocol#Stratum_1_time_servers -->
3 [[!toc levels=2]]
4
5 ## GPS selection
6
7 I selected the [Garmin GPS 18x LVC](http://www.amazon.com/gp/product/B0016O3T7A) for the following reasons:
8
9 * Plenty of documentation exists by people who have used this unit as an NTP timing source.
10 * The receiver and antenna are integrated into one enclosure.
11 * Minimal assembly and soldering necessary, compared to bare-board receivers.
12 * Available on [Amazon](http://amazon.com/) for a decent price.
13
14 I ordered the 18x (and a [serial cable](http://www.amazon.com/gp/product/B000ZKNANO)) on Amazon on 2011-09-05. UPS delivered it on 2011-09-09.
15
16 ## Cable Construction
17
18 I simply spliced the GPS 18x LVC wires onto serial and USB wires. This matches what's documented in Garmin's GPS 18x LVC Technical Specifications.
19
20 ## GPS preparation
21
22 I used a Windows Vista computer with Garmin's SNSRXCFG_270.exe to upgrade the firmware from version 3.60 to the latest, 3.70. I also used SNSRXCFG_270.exe to set the PPS pulse width to 200 ms, and disable all NMEA sentences except GPGGA.
23
24 ## Debian GNU/Linux setup
25
26 I first tried using the GPS with an old Pentium III computer running Ubuntu 11.04 natty running kernel 2.6.38-11-generic-pae. I could see the NMEA sentences with `gpsd` and `gpspipe -r`, but a few seconds after I did `sudo ldattach PPS /dev/ttyS0` the system would lock up hard due to some kernel bug in some driver for my hardware. I saw `BUG: scheduling while atomic` in the syslog, but I wasn't able to capture the whole bug output. The same bug would occur if I just did `cat /dev/ttyS0`. So I just gave up with that old hardware and moved the GPS to my newer desktop computer running Debian squeeze and kernel 2.6.39-bpo.2-amd64. No lockups on this machine.
27
28 You need to have `/usr/include/timepps.h` to compile ntpd with proper PPS support. This header [does not exist in Debian yet](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=570233), so I used the one from [Alexander Gordeev's git repository](https://github.com/ago/pps-tools/).
29
30 The ntpd in Debian squeeze [does not have debugging enabled](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=643954), which makes it difficult to see what is going on with your local reference clock. I [rebuilt the squeeze package](http://raphaelhertzog.com/2010/12/15/howto-to-rebuild-debian-packages/) with debugging enabled, but I still wasn't getting very good results. It would not select the GPS as system peer or PPS peer, and jitter was high, in the tens of milliseconds. So I compiled my own ntp version 4.2.6p4 straight from the tarball, starting with this configure line: `./configure --prefix=/usr --sysconfdir=/var/lib/ntp` The output below is from this build of ntp, not the Debian package, which was version 4.2.6p2.
31
32 When you do `sudo ldattach PPS /dev/ttyS0`, the PPS modules will be loaded automatically and the device `/dev/pps0` will be created. I have some udev rules to create device symlinks:
33
34     KERNEL=="ttyS0" SYMLINK+="gps0"
35     KERNEL=="pps0" SYMLINK+="gpspps0"
36
37 Here is my working Debian squeeze ntp.conf:
38
39     driftfile /var/lib/ntp/ntp.drift
40     logconfig +clockall
41     server 127.127.20.0 prefer
42     fudge 127.127.20.0 flag1 1 flag2 0 flag3 1 time2 0.600
43     server voodoo.kenyonralph.com iburst
44     server darwin.kenyonralph.com iburst
45
46 Example output after letting ntpd run for about 8 hours:
47
48     ntpq -p -c clockvar; ntptime; ntpdc -c kerninfo
49          remote           refid      st t when poll reach   delay   offset  jitter
50     ==============================================================================
51     oGPS_NMEA(0)     .GPS.            0 l    3    8  377    0.000    0.001   0.001
52     *voodoo.kenyonra 72.29.161.5      2 u   46   64  377    0.243    2.454   0.146
53     +darwin.kenyonra 127.67.113.92    2 u   14   64  377   20.122    2.467   3.413
54     associd=0 status=0012 , 1 event, clk_bad_format,
55     device="NMEA GPS Clock",
56     timecode="$GPRMC,212627,A,1111.1111,N,11111.1111,W,000.0,171.9,011011,012.1,E*61",
57     poll=3876, noreply=0, badformat=1, baddata=0, fudgetime1=0.000,
58     stratum=0, refid=GPS, flags=5
59     ntp_gettime() returns code 0 (OK)
60       time d2320403.a6e5ab84  Sat, Oct  1 2011 14:26:27.651, (.651942165),
61       maximum error 1617 us, estimated error 0 us
62     ntp_adjtime() returns code 0 (OK)
63       modes 0x0 (),
64       offset 0.530 us, frequency 4.205 ppm, interval 1 s,
65       maximum error 1617 us, estimated error 0 us,
66       status 0x2007 (PLL,PPSFREQ,PPSTIME,NANO),
67       time constant 3, precision 0.001 us, tolerance 500 ppm,
68     pll offset:           5.3e-07 s
69     pll frequency:        4.205 ppm
70     maximum error:        0.001617 s
71     estimated error:      0 s
72     status:               2007  pll ppsfreq ppstime nano
73     pll time constant:    3
74     precision:            1e-09 s
75     frequency tolerance:  500 ppm
76
77 I'm going to try setting up a time server with FreeBSD next to see if it's any easier.
78
79 ## FreeBSD setup
80
81 I am using [ntp-devel](http://www.freshports.org/net/ntp-devel/) from ports.
82
83 ### /etc/rc.conf
84     ntpd_enable="YES"
85     ntpd_flags="-N -p /var/run/ntpd.pid -f /var/db/ntpd.drift"
86     ntpd_program="/usr/local/sbin/ntpd"
87     ntpd_sync_on_start="YES"
88
89 ### /etc/devfs.conf
90     link cuau0 gps0
91
92 ### /etc/ttys
93 Commented out ttyu*.
94
95 ### Kernel configuration
96     #
97     # PPS -- Generic kernel configuration file for FreeBSD/amd64 PPS
98     #
99     include GENERIC
100     ident PPS-GENERIC
101     options PPS_SYNC
102
103 ### ntp.conf
104     server 127.127.20.0 prefer
105     fudge 127.127.20.0 flag1 1 flag2 0 flag3 1 time2 0.600
106     server darwin.kenyonralph.com iburst
107     server voodoo.kenyonralph.com iburst
108     server grunt.kenyonralph.com iburst
109     pool 2.us.pool.ntp.org iburst
110
111 ## Notes
112
113 * Show serial port settings: `stty --all --file=/dev/ttyS0`
114 * Set serial port baud rate to 4800: `stty --file=/dev/ttyS0 4800`
115 * FreeBSD: Observe NMEA output: `cu -l /dev/cuau0 -s 4800`
116
117 ## References
118
119 * NTP documentation: [Reference Clock Support](http://www.eecis.udel.edu/~mills/ntp/html/refclock.html)
120 * NTP support wiki: [Configuring Garmin Refclocks](https://support.ntp.org/bin/view/Support/ConfiguringGarminRefclocks)
121 * NTP support wiki: [Configuring NMEA Refclocks](https://support.ntp.org/bin/view/Support/ConfiguringNMEARefclocks)
122 * NTP support wiki: [Garmin Refclock Users](https://support.ntp.org/bin/view/Support/GarminRefclockUsers)
123 * [Adding a FreeBSD NTP server based on an GPS 18 LVC device](http://www.satsignal.eu/ntp/FreeBSD-GPS-PPS.htm) by David Taylor
124 * [Enabling ntpd PPS support for Debian Lenny Linux](http://www.worldtimesolutions.com/support/ntp/Debian_Lenny_Linux_PPS_support_for_ntpd.html) by World Time Solutions
125 * [Garmin GPS 18x OEM](https://buy.garmin.com/shop/shop.do?cID=158&pID=27594)
126 * [LinuxPPS installation](http://wiki.enneenne.com/index.php/LinuxPPS_installation) and [ntpd support](http://wiki.enneenne.com/index.php/LinuxPPS_NTPD_support)
127 * [NTP server using PC gnu/linux and freebsd](http://www.wraith.sf.ca.us/ntp/) by Steven Bjork
128 * [NTP](http://en.gentoo-wiki.com/wiki/NTP) on Gentoo Wiki
129 * [Stratum 1 NTP, Garmin GPS 18 LVC on FreeBSD 8.0](http://blog.doylenet.net/?p=145) by Ryan Doyle
130 * [Synchronising to a Garmin GPS 18 LVC](http://www.sput.nl/time/garmin.html) by R.J. van der Putten
131 * [Synchronizing an NTP server to GPS/PPS](http://linlog.blogspot.com/2009/07/synchronizing-ntp-server-to-gpspps.html) by Pela-Suros
132 * [Synchronizing ntpd to a Garmin GPS 18 LVC via gpsd](http://www.rjsystems.nl/en/2100-ntpd-garmin-gps-18-lvc-gpsd.php) by Jaap Winius
133 * [Ubuntu bug 805661](https://bugs.launchpad.net/bugs/805661)
134 * [Using a Garmin GPS 18 LVC as NTP stratum-0 on Linux 2.6](http://time.qnan.org/) by Philip M. White