From: Harlan Stenn Date: Thu, 19 Jul 2012 23:26:56 +0000 (-0400) Subject: [Bug 1454] Add parse clock support for the SEL-240x GPS products X-Git-Tag: NTP_4_2_7P290~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dda3834e7693a2dc5f7c25b310a57aca0e3f29df;p=thirdparty%2Fntp.git [Bug 1454] Add parse clock support for the SEL-240x GPS products bk: 500897c0XPetpV3NJLjswfJUbY423Q --- diff --git a/ChangeLog b/ChangeLog index 8c32fdebd..919dced82 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,4 @@ +* [Bug 1454] Add parse clock support for the SEL-240x GPS products. * CID 709185: refclock_chu.c will leak fd==0 (better fix) (4.2.7p289) 2012/07/16 Released by Harlan Stenn * CID 97123: Future-proof possible change to refclock_nmea.c. diff --git a/configure.ac b/configure.ac index ed1ba4079..e94f58aae 100644 --- a/configure.ac +++ b/configure.ac @@ -2877,6 +2877,22 @@ case "$ntp_ok$ntp_canparse" in AC_MSG_ERROR([That's a parse clock and this system doesn't support it!]) esac +AC_MSG_CHECKING(SEL240X clock) +AC_ARG_ENABLE(SEL240X, + AC_HELP_STRING([--enable-SEL240X], [s SEL240X clock]), + [ntp_ok=$enableval], [ntp_ok=$ntp_eapc]) +if test "$ntp_ok" = "yes"; then + ntp_libparse=yes + ntp_refclock=yes + AC_DEFINE(CLOCK_SEL240X, 1, [SEL240X protocol]) +fi +AC_MSG_RESULT($ntp_ok) +case "$ntp_ok$ntp_canparse" in + yesno) + AC_MSG_ERROR(That's a parse clock and this system doesn't support it!) + ;; +esac + AC_SUBST([LIBPARSE]) AC_SUBST([MAKE_LIBPARSE]) AC_SUBST([MAKE_LIBPARSE_KERNEL]) diff --git a/html/drivers/driver8.html b/html/drivers/driver8.html index dcde36d4b..39be105fc 100644 --- a/html/drivers/driver8.html +++ b/html/drivers/driver8.html @@ -2,264 +2,274 @@ - - - Generic Reference Driver - - + + + Generic Reference Driver + + - -

Generic Reference Driver

-
+ +

Generic Reference Driver

+

Synopsis

Address: 127.127.8.u
-Reference ID: PARSE
-Driver ID: GENERIC
-Serial Port: /dev/refclock-u; TTY mode according to clock type
-PPS device: /dev/refclockpps-u; alternate PPS device (if not available via the serial port) -

Description

-The PARSE driver supports 20 different clock types/configurations. PARSE is actually a multi-clock driver.
-
-

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 list below).

-

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.

-

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.

-

The use of the PPS option requires receivers with an accuracy of better than 1ms.

-

Timecode variables listed by ntpq (8)

-

The ntpq program can read and display several clock variables. These hold the following information:

-
-
refclock_format
-
A qualification of the decoded time code format.
-
refclock_states
-
The overall running time and the accumulated times for the clock event states.
-
refclock_status
-
Lists the currently active receiver flags. Additional feature flags for the receiver are optionally listed in parentheses.
-
refclock_time
-
The local time with the offset to UTC (format HHMM).
-
timecode
-
The actual time code.
-
-

If PPS information is present, additional variables are available:

-
-
refclock_ppsskew
-
The difference between the RS-232-derived timestamp and the PPS timestamp.
-
refclock_ppstime
-
The PPS timestamp.
-
-

Supported Devices

-

Currently, nineteen clock types (devices /dev/refclock-0 - /dev/refclock-3) are supported by the PARSE driver.
- A note on the implementations:

- -

The pictures below have been taken from and are linked to the vendors' web pages.

- - +

Actual data formats and setup requirements of the various clocks can be found in NTP PARSE clock data formats.

+

Operation

+

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.

+

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.

+

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.

+

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.

+

Hardware PPS support
+

+

For PPS to be used, add 128 to the mode parameter.

+

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.

+

Monitor Data

+

Clock state statistics are written hourly to the syslog service. Online information can be found by examining the clock variables via the ntpq cv command.
+ Some devices have quite extensive additional information (GPS16x/GPS17x, Trimble). The driver reads out much of the internal GPS data and makes it accessible via clock variables. To find out about additional variable names, query for the clock_var_list variable on a specific clock association as shown below.

+

First let ntpq display the table of associations:

+ 
  ntpq> as    ind assID status  conf reach auth condition  last_event cnt    ===========================================================      1 19556  9154   yes   yes  none falsetick   reachable  5      2 19557  9435   yes   yes  none  candidat  clock expt  3      3 19558  9714   yes   yes  none  pps.peer   reachable  1
+

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.

+ 
  ntpq> raw    Output set to raw
+

Use the cv command to read the list of clock variables of a selected association:

+ 
  ntpq> cv 19557 clock_var_list
+

The long output of the command above looks similar to:

+ 
  assID=19557 status=0x0000,    clock_var_list="type,timecode,poll,noreply,badformat,baddata,fudgetime1,    fudgetime2,stratum,refid,flags,device,clock_var_list,refclock_time,refclock_status,    refclock_format,refclock_states,refclock_id,refclock_iomode,refclock_driver_version,    meinberg_gps_status,gps_utc_correction,gps_message,meinberg_antenna_status,gps_tot_51,    gps_tot_63,gps_t0a,gps_cfg[1],gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],    gps_health[3],gps_cfg[4],gps_health[4],gps_cfg[5]"
+

Then use the cv command again to list selected clock variables. The following command must be entered as a single line:

+ 
  ntpq> cv 19557 refclock_status,refclock_format,refclock_states,refclock_id,    refclock_iomode,refclock_driver_version,meinberg_gps_status,gps_utc_correction,    gps_message,meinberg_antenna_status,gps_tot_51,gps_tot_63,gps_t0a,gps_cfg[1],    gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],gps_health[3],gps_cfg[4],    gps_health[4],gps_cfg[5]
+

The output of the command above is wrapped around depending on the screen width and looks similar to:

+ 
  status=0x0003,    refclock_status="UTC DISPLAY; TIME CODE; PPS; POSITION; (LEAP INDICATION;    PPS SIGNAL; POSITION)",    refclock_format="Meinberg GPS Extended",    refclock_states="*NOMINAL: 21:21:36 (99.99%); FAULT: 00:00:03 (0.00%);    running time: 21:21:39",    refclock_id="GPS", refclock_iomode="normal",    refclock_driver_version="refclock_parse.c,v 4.77 2006/08/05 07:44:49    kardel RELEASE_20060805_A",    meinberg_gps_status="[0x0000] <OK>",    gps_utc_correction="current correction 14 sec, last correction    on c7619a00.00000000  Sun, Jan  1 2006  0:00:00.000",    gps_message="/PFU3SOP-4WG14EPU0V1KA",    meinberg_antenna_status="RECONNECTED on 2006-07-18 08:13:20.0000000 (+0000)    UTC CORR, LOCAL TIME, reconnect clockoffset +0.0000000 s,    disconnect time 0000-00-00 00:00:00.0000000 (+0000) ",    gps_tot_51="week 1400 + 3 days + 42300.0000000 sec",    gps_tot_63="week 1400 + 3 days + 42294.0000000 sec",    gps_t0a="week 1400 + 5 days + 71808.0000000 sec",    gps_cfg[1]="[0x9] BLOCK II", gps_health[1]="[0x0] OK;SIGNAL OK",    gps_cfg[2]="[0x0] BLOCK I", gps_health[2]="[0x3f] PARITY;MULTIPLE ERRS",    gps_cfg[3]="[0x9] BLOCK II", gps_health[3]="[0x0] OK;SIGNAL OK",    gps_cfg[4]="[0x9] BLOCK II", gps_health[6]="[0x0] OK;SIGNAL OK",    gps_cfg[5]="[0x9] BLOCK II"
+

Fudge Factors

+
+
time1 time
+
Specifies the time offset calibration factor, in seconds and fraction. The default value depends on the clock type.
+
time2 time
+
If flag1 is 0, time2 specifies the offset of the PPS signal from the actual time (PPS fine tuning).
+
If flag1 is 1, time2 specifies the number of seconds a receiver with a premium local oscillator can be trusted after losing synchronisation.
+
stratum stratum
+
The stratum for this reference clock.
+
refid refid
+
The refid for this reference clock.
+
+
+
flag1 { 0 | 1 }
+
If 0, the fudge factor time2 refers to the PPS offset.
+
If 1, time2 refers to the TRUST TIME.
+
flag2 { 0 | 1 }
+
If flag2 is 1, sample PPS on CLEAR instead of on ASSERT.
+
flag3 { 0 | 1 }
+
If flag3 is 1, link kernel PPS tracking to this refclock instance.
+
flag4 { 0 | 1 }
+
Delete next leap second instead of adding it. (You'll need to wait a bit for that to happen 8-)
+
+ Note about auxiliary Sun STREAMS modules (SunOS and Solaris):
+
+
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.
+
+

Making your own PARSE clocks

+

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 making PARSE clocks.

+

Additional Information

+

Reference Clock Drivers

+
+ + diff --git a/libparse/Makefile.am b/libparse/Makefile.am index 64f614863..4d3d55462 100644 --- a/libparse/Makefile.am +++ b/libparse/Makefile.am @@ -25,6 +25,7 @@ libparse_a_SOURCES = parse.c \ clk_computime.c \ clk_wharton.c \ clk_varitext.c \ + clk_sel240x.c \ data_mbg.c \ info_trimble.c \ trim_info.c \ @@ -49,6 +50,7 @@ libparse_kernel_a_LIBADD = \ kclk_trimtsip.o \ kclk_varitext.o \ kclk_wharton.o \ + kclk_sel240x$u.o \ kbinio.o \ kieee754io.o \ kmfp_mul.o \ @@ -113,6 +115,12 @@ kclk_varitext.o: $(srcdir)/clk_varitext.c kclk_wharton.o: $(srcdir)/clk_wharton.c $(COMPILE) $(K_CFLAGS) -c $(srcdir)/clk_wharton.c -o $@ +kclk_sel240x.o: $(srcdir)/clk_sel240x.c + $(COMPILE) $(K_CFLAGS) -c $(srcdir)/clk_sel240x.c -o $@ + +kclk_sel240x.o: $(srcdir)/clk_sel240x.c + $(COMPILE) $(K_CFLAGS) -c $(srcdir)/clk_sel240x.c -o $@ + kparse.o: $(srcdir)/parse.c $(COMPILE) $(K_CFLAGS) -c $(srcdir)/parse.c -o $@ diff --git a/libparse/clk_sel240x.c b/libparse/clk_sel240x.c new file mode 100644 index 000000000..db4cc7012 --- /dev/null +++ b/libparse/clk_sel240x.c @@ -0,0 +1,194 @@ +////////////////////////////////////////////////////////////////////////////// +// Copyright (c) 2009 - +// Schweitzer Engineering Laboratories, Inc. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in +// the documentation and/or other materials provided with the +// distribution. +// 3. The name of the author may not be used to endorse or promote +// products derived from this software without specific prior +// written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +////////////////////////////////////////////////////////////////////////////// +#ifdef HAVE_CONFIG_H +# include +#endif + +#if defined(REFCLOCK) && defined(CLOCK_PARSE) && defined(CLOCK_SEL240X) + +#include "ntp_syslog.h" +#include "ntp_types.h" +#include "ntp_fp.h" +#include "ntp_unixtime.h" +#include "ntp_calendar.h" +#include "ntp_machine.h" +#include "ntp_stdlib.h" + +#include "parse.h" + +#ifndef PARSESTREAM +# include +#else +# include "sys/parsestreams.h" +#endif + +#define _XOPEN_SOURCE +#include + +////////////////////////////////////////////////////////////////////////////// +// The B8 output has the following format B8 = '\x01YYYY:ddd:hh:mm:ssq\r\n' +// where q = ' ' locked +// '.' <1 us +// '*' <10 us +// '#' <100 us +// '?' >100 us +// +// Based on this we need to recored the stime when we receive the +// character and end it when we see the \n. +// +// The q or quality character indicates satellite lock and sync. For the +// purposes of NTP we are going to call it valid when we receive anything but +// a '?'. But we are only going to call it synced when we receive a ' ' +////////////////////////////////////////////////////////////////////////////// + +static unsigned long inp_sel240x( parse_t *parseio, + unsigned int ch, + timestamp_t *tstamp); +static unsigned long cvt_sel240x( unsigned char *buffer, + int size, + struct format *format, + clocktime_t *clock_time, + void *local ); + +// Parse clock format structure describing the message above +static struct format sel240x_fmt = +{ { { 6, 3 }, + { 0, 0 }, + { 1, 4 }, + { 10, 2 }, + { 13, 2 }, + { 16, 2 }, + { 0, 0 }, + { 0, 0 }, + { 0, 0 }, + { 0, 0 }, + { 0, 0 }, + { 0, 0 } + }, + "\x01 : : : : \x0d\x0a", + 0 +}; + +// Structure desctibing the parser +clockformat_t clock_sel240x = +{ + inp_sel240x, + cvt_sel240x, + pps_one, + (void*)&sel240x_fmt, + "SEL B8", + 25, + 0 +}; + +////////////////////////////////////////////////////////////////////////////// +static unsigned long +inp_sel240x( parse_t *parseio, + unsigned int ch, + timestamp_t *tstamp + ) +{ + unsigned long rc; + + parseprintf( DD_PARSE, + ("inp_sel240x(0x%lx, 0x%x, ...)\n",(long)parseio, ch)); + + switch( ch ) + { + case '\x01': + parseio->parse_index = 1; + parseio->parse_data[0] = ch; + parseio->parse_dtime.parse_stime = *tstamp; + rc = PARSE_INP_SKIP; + break; + case '\n': + if( (rc = parse_addchar(parseio, ch)) == PARSE_INP_SKIP ) + { + rc = parse_end( parseio ); + } + break; + default: + rc = parse_addchar( parseio, ch ); + } + + return rc; +} + +////////////////////////////////////////////////////////////////////////////// +static unsigned long +cvt_sel240x( unsigned char *buffer, + int size, + struct format *format, + clocktime_t *clock_time, + void *local + ) +{ + unsigned long rc = CVT_NONE; + + if( Strok(buffer, format->fixed_string) ) + { + struct tm ptime; + buffer++; + buffer = strptime( buffer, "%Y:%j:%H:%M:%S", &ptime ); + if( *(buffer+1) != '\x0d' ) + { + rc = CVT_FAIL | CVT_BADFMT; + } + else + { + clock_time->day = ptime.tm_mday; + clock_time->month = ptime.tm_mon + 1; + clock_time->year = ptime.tm_year + 1900; + clock_time->hour = ptime.tm_hour; + clock_time->minute = ptime.tm_min; + clock_time->second = ptime.tm_sec; + clock_time->usecond = 0; + clock_time->utcoffset = 0; + clock_time->flags = PARSEB_UTC; + + if( *buffer == '?' ) + { + clock_time->flags |= PARSEB_POWERUP; + } + else if( *buffer != ' ' ) + { + clock_time->flags |= PARSEB_NOSYNC; + } + + rc = CVT_OK; + } + } + + return rc; +} + +#else /* not (REFCLOCK && CLOCK_PARSE && CLOCK_SEL240X) */ +int clk_sel240x_bs; +#endif /* not (REFCLOCK && CLOCK_PARSE && CLOCK_SEL240X) */ diff --git a/libparse/parse_conf.c b/libparse/parse_conf.c index b5451cff1..b7234dd41 100644 --- a/libparse/parse_conf.c +++ b/libparse/parse_conf.c @@ -96,6 +96,10 @@ extern clockformat_t clock_wharton_400a; extern clockformat_t clock_varitext; #endif +#ifdef CLOCK_SEL240X +extern clockformat_t clock_sel240x; +#endif + /* * format definitions */ @@ -135,6 +139,9 @@ clockformat_t *clockformats[] = #endif #ifdef CLOCK_VARITEXT &clock_varitext, +#endif +#ifdef CLOCK_SEL240X + &clock_sel240x, #endif 0}; diff --git a/ntpd/refclock_parse.c b/ntpd/refclock_parse.c index 42eddfc20..c5134039f 100644 --- a/ntpd/refclock_parse.c +++ b/ntpd/refclock_parse.c @@ -859,6 +859,35 @@ static poll_info_t rcc8000_pollinfo = { RCC_POLLRATE, RCC_POLLCMD, RCC_CMDSIZE } #define VARITEXT_SAMPLES 32 #define VARITEXT_KEEP 20 +/* + * SEL240x Satellite Sychronized Clock + */ +#define SEL240X_POLLRATE 0 /* only true direct polling */ +#define SEL240X_POLLCMD "BUB8" +#define SEL240X_CMDSIZE 4 + +static poll_info_t sel240x_pollinfo = { SEL240X_POLLRATE, + SEL240X_POLLCMD, + SEL240X_CMDSIZE }; +#define SEL240X_FLAGS (PARSE_F_PPSONSECOND) +#define SEL240X_POLL poll_dpoll +#define SEL240X_INIT poll_init +#define SEL240X_END 0 +#define SEL240X_DATA ((void *)(&sel240x_pollinfo)) +#define SEL240X_ROOTDELAY 0.0 +#define SEL240X_BASEDELAY 0.0 +#define SEL240X_ID GPS_ID +#define SEL240X_DESCRIPTION "SEL240x Satellite Synchronized Clock" +#define SEL240X_FORMAT "SEL B8" +#define SEL240X_MAXUNSYNC 60*60*12 /* only trust clock for 12 hours */ +#define SEL240X_SPEED (B9600) +#define SEL240X_CFLAG (CS8|CREAD|CLOCAL) +#define SEL240X_IFLAG (IGNBRK|IGNPAR) +#define SEL240X_OFLAG (0) +#define SEL240X_LFLAG (0) +#define SEL240X_SAMPLES 5 +#define SEL240X_KEEP 3 + static struct parse_clockinfo { u_long cl_flags; /* operation flags (PPS interpretation, trust handling) */ @@ -1448,6 +1477,29 @@ static struct parse_clockinfo GPS16X_SAMPLES, GPS16X_KEEP }, + { /* mode 24 */ + SEL240X_FLAGS, + SEL240X_POLL, + SEL240X_INIT, + NO_EVENT, + SEL240X_END, + NO_MESSAGE, + SEL240X_DATA, + SEL240X_ROOTDELAY, + SEL240X_BASEDELAY, + SEL240X_ID, + SEL240X_DESCRIPTION, + SEL240X_FORMAT, + GPS_TYPE, + SEL240X_MAXUNSYNC, + SEL240X_SPEED, + SEL240X_CFLAG, + SEL240X_IFLAG, + SEL240X_OFLAG, + SEL240X_LFLAG, + SEL240X_SAMPLES, + SEL240X_KEEP + }, }; static int ncltypes = sizeof(parse_clockinfo) / sizeof(struct parse_clockinfo);