Home | History | Annotate | Line # | Download | only in libparse
clk_rawdcf.c revision 1.8.8.1
      1  1.8.8.1  perseant /*	$NetBSD: clk_rawdcf.c,v 1.8.8.1 2025/08/02 05:22:32 perseant Exp $	*/
      2      1.1    kardel 
      3      1.1    kardel /*
      4      1.1    kardel  * /src/NTP/REPOSITORY/ntp4-dev/libparse/clk_rawdcf.c,v 4.18 2006/06/22 18:40:01 kardel RELEASE_20060622_A
      5      1.5  christos  *
      6      1.1    kardel  * clk_rawdcf.c,v 4.18 2006/06/22 18:40:01 kardel RELEASE_20060622_A
      7      1.1    kardel  *
      8      1.1    kardel  * Raw DCF77 pulse clock support
      9      1.1    kardel  *
     10      1.6  christos  * Copyright (c) 1995-2015 by Frank Kardel <kardel <AT> ntp.org>
     11      1.5  christos  * Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universitaet Erlangen-Nuernberg, Germany
     12      1.1    kardel  *
     13      1.1    kardel  * Redistribution and use in source and binary forms, with or without
     14      1.1    kardel  * modification, are permitted provided that the following conditions
     15      1.1    kardel  * are met:
     16      1.1    kardel  * 1. Redistributions of source code must retain the above copyright
     17      1.1    kardel  *    notice, this list of conditions and the following disclaimer.
     18      1.1    kardel  * 2. Redistributions in binary form must reproduce the above copyright
     19      1.1    kardel  *    notice, this list of conditions and the following disclaimer in the
     20      1.1    kardel  *    documentation and/or other materials provided with the distribution.
     21      1.1    kardel  * 3. Neither the name of the author nor the names of its contributors
     22      1.1    kardel  *    may be used to endorse or promote products derived from this software
     23      1.1    kardel  *    without specific prior written permission.
     24      1.1    kardel  *
     25      1.1    kardel  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     26      1.1    kardel  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     27      1.1    kardel  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     28      1.1    kardel  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     29      1.1    kardel  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     30      1.1    kardel  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     31      1.1    kardel  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     32      1.1    kardel  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     33      1.1    kardel  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     34      1.1    kardel  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     35      1.1    kardel  * SUCH DAMAGE.
     36      1.1    kardel  *
     37      1.1    kardel  */
     38      1.1    kardel 
     39      1.1    kardel #ifdef HAVE_CONFIG_H
     40      1.1    kardel # include <config.h>
     41      1.1    kardel #endif
     42      1.1    kardel 
     43      1.1    kardel #if defined(REFCLOCK) && defined(CLOCK_PARSE) && defined(CLOCK_RAWDCF)
     44      1.1    kardel 
     45      1.1    kardel #include "ntp_fp.h"
     46      1.6  christos #include "timevalops.h"
     47      1.1    kardel #include "ntp_unixtime.h"
     48      1.1    kardel #include "ntp_calendar.h"
     49      1.1    kardel 
     50      1.1    kardel #include "parse.h"
     51      1.1    kardel #ifdef PARSESTREAM
     52      1.1    kardel # include <sys/parsestreams.h>
     53      1.1    kardel #endif
     54      1.1    kardel 
     55      1.1    kardel #ifndef PARSEKERNEL
     56      1.1    kardel # include "ntp_stdlib.h"
     57      1.1    kardel #endif
     58      1.1    kardel 
     59      1.1    kardel /*
     60      1.1    kardel  * DCF77 raw time code
     61      1.1    kardel  *
     62      1.1    kardel  * From "Zur Zeit", Physikalisch-Technische Bundesanstalt (PTB), Braunschweig
     63      1.1    kardel  * und Berlin, Maerz 1989
     64      1.1    kardel  *
     65      1.1    kardel  * Timecode transmission:
     66      1.1    kardel  * AM:
     67      1.1    kardel  *	time marks are send every second except for the second before the
     68      1.1    kardel  *	next minute mark
     69      1.1    kardel  *	time marks consist of a reduction of transmitter power to 25%
     70      1.1    kardel  *	of the nominal level
     71      1.1    kardel  *	the falling edge is the time indication (on time)
     72      1.1    kardel  *	time marks of a 100ms duration constitute a logical 0
     73      1.1    kardel  *	time marks of a 200ms duration constitute a logical 1
     74      1.1    kardel  * FM:
     75      1.1    kardel  *	see the spec. (basically a (non-)inverted psuedo random phase shift)
     76      1.1    kardel  *
     77      1.1    kardel  * Encoding:
     78      1.1    kardel  * Second	Contents
     79      1.1    kardel  * 0  - 10	AM: free, FM: 0
     80      1.1    kardel  * 11 - 14	free
     81      1.5  christos  * 15		R     - "call bit" used to signalize irregularities in the control facilities
     82      1.5  christos  *		        (until 2003 indicated transmission via alternate antenna)
     83      1.1    kardel  * 16		A1    - expect zone change (1 hour before)
     84      1.1    kardel  * 17 - 18	Z1,Z2 - time zone
     85      1.1    kardel  *		 0  0 illegal
     86      1.1    kardel  *		 0  1 MEZ  (MET)
     87      1.1    kardel  *		 1  0 MESZ (MED, MET DST)
     88      1.1    kardel  *		 1  1 illegal
     89      1.1    kardel  * 19		A2    - expect leap insertion/deletion (1 hour before)
     90      1.1    kardel  * 20		S     - start of time code (1)
     91      1.1    kardel  * 21 - 24	M1    - BCD (lsb first) Minutes
     92      1.1    kardel  * 25 - 27	M10   - BCD (lsb first) 10 Minutes
     93      1.1    kardel  * 28		P1    - Minute Parity (even)
     94      1.1    kardel  * 29 - 32	H1    - BCD (lsb first) Hours
     95      1.1    kardel  * 33 - 34      H10   - BCD (lsb first) 10 Hours
     96      1.1    kardel  * 35		P2    - Hour Parity (even)
     97      1.1    kardel  * 36 - 39	D1    - BCD (lsb first) Days
     98      1.1    kardel  * 40 - 41	D10   - BCD (lsb first) 10 Days
     99      1.1    kardel  * 42 - 44	DW    - BCD (lsb first) day of week (1: Monday -> 7: Sunday)
    100      1.1    kardel  * 45 - 49	MO    - BCD (lsb first) Month
    101      1.1    kardel  * 50           MO0   - 10 Months
    102      1.1    kardel  * 51 - 53	Y1    - BCD (lsb first) Years
    103      1.1    kardel  * 54 - 57	Y10   - BCD (lsb first) 10 Years
    104      1.1    kardel  * 58 		P3    - Date Parity (even)
    105      1.1    kardel  * 59		      - usually missing (minute indication), except for leap insertion
    106      1.1    kardel  */
    107      1.1    kardel 
    108      1.5  christos static parse_pps_fnc_t pps_rawdcf;
    109      1.5  christos static parse_cvt_fnc_t cvt_rawdcf;
    110      1.5  christos static parse_inp_fnc_t inp_rawdcf;
    111      1.1    kardel 
    112      1.1    kardel typedef struct last_tcode {
    113      1.6  christos 	time_t      tcode;	/* last converted time code */
    114      1.6  christos         timestamp_t tminute;	/* sample time for minute start */
    115      1.6  christos         timestamp_t timeout;	/* last timeout timestamp */
    116      1.1    kardel } last_tcode_t;
    117      1.1    kardel 
    118      1.1    kardel #define BUFFER_MAX	61
    119      1.1    kardel 
    120      1.1    kardel clockformat_t clock_rawdcf =
    121      1.1    kardel {
    122      1.1    kardel   inp_rawdcf,			/* DCF77 input handling */
    123      1.1    kardel   cvt_rawdcf,			/* raw dcf input conversion */
    124      1.1    kardel   pps_rawdcf,			/* examining PPS information */
    125      1.1    kardel   0,				/* no private configuration data */
    126      1.1    kardel   "RAW DCF77 Timecode",		/* direct decoding / time synthesis */
    127      1.1    kardel 
    128      1.1    kardel   BUFFER_MAX,			/* bit buffer */
    129      1.1    kardel   sizeof(last_tcode_t)
    130      1.1    kardel };
    131      1.1    kardel 
    132      1.1    kardel static struct dcfparam
    133      1.1    kardel {
    134      1.2  christos 	const unsigned char *onebits;
    135      1.2  christos 	const unsigned char *zerobits;
    136      1.5  christos } dcfparameter =
    137      1.1    kardel {
    138      1.2  christos 	(const unsigned char *)"###############RADMLS1248124P124812P1248121241248112481248P??", /* 'ONE' representation */
    139      1.2  christos 	(const unsigned char *)"--------------------s-------p------p----------------------p__"  /* 'ZERO' representation */
    140      1.1    kardel };
    141      1.1    kardel 
    142      1.5  christos static struct rawdcfcode
    143      1.1    kardel {
    144      1.1    kardel 	char offset;			/* start bit */
    145      1.1    kardel } rawdcfcode[] =
    146      1.1    kardel {
    147      1.1    kardel 	{  0 }, { 15 }, { 16 }, { 17 }, { 19 }, { 20 }, { 21 }, { 25 }, { 28 }, { 29 },
    148      1.1    kardel 	{ 33 }, { 35 }, { 36 }, { 40 }, { 42 }, { 45 }, { 49 }, { 50 }, { 54 }, { 58 }, { 59 }
    149      1.1    kardel };
    150      1.1    kardel 
    151      1.1    kardel #define DCF_M	0
    152      1.1    kardel #define DCF_R	1
    153      1.1    kardel #define DCF_A1	2
    154      1.1    kardel #define DCF_Z	3
    155      1.1    kardel #define DCF_A2	4
    156      1.1    kardel #define DCF_S	5
    157      1.1    kardel #define DCF_M1	6
    158      1.1    kardel #define DCF_M10	7
    159      1.1    kardel #define DCF_P1	8
    160      1.1    kardel #define DCF_H1	9
    161      1.1    kardel #define DCF_H10	10
    162      1.1    kardel #define DCF_P2	11
    163      1.1    kardel #define DCF_D1	12
    164      1.1    kardel #define DCF_D10	13
    165      1.1    kardel #define DCF_DW	14
    166      1.1    kardel #define DCF_MO	15
    167      1.1    kardel #define DCF_MO0	16
    168      1.1    kardel #define DCF_Y1	17
    169      1.1    kardel #define DCF_Y10	18
    170      1.1    kardel #define DCF_P3	19
    171      1.1    kardel 
    172      1.1    kardel static struct partab
    173      1.1    kardel {
    174      1.1    kardel 	char offset;			/* start bit of parity field */
    175      1.1    kardel } partab[] =
    176      1.1    kardel {
    177      1.1    kardel 	{ 21 }, { 29 }, { 36 }, { 59 }
    178      1.1    kardel };
    179      1.1    kardel 
    180      1.1    kardel #define DCF_P_P1	0
    181      1.1    kardel #define DCF_P_P2	1
    182      1.1    kardel #define DCF_P_P3	2
    183      1.1    kardel 
    184      1.1    kardel #define DCF_Z_MET 0x2
    185      1.1    kardel #define DCF_Z_MED 0x1
    186      1.1    kardel 
    187      1.1    kardel static u_long
    188      1.1    kardel ext_bf(
    189      1.1    kardel 	unsigned char *buf,
    190      1.1    kardel 	int   idx,
    191      1.2  christos 	const unsigned char *zero
    192      1.1    kardel 	)
    193      1.1    kardel {
    194      1.1    kardel 	u_long sum = 0;
    195      1.1    kardel 	int i, first;
    196      1.1    kardel 
    197      1.1    kardel 	first = rawdcfcode[idx].offset;
    198      1.5  christos 
    199      1.1    kardel 	for (i = rawdcfcode[idx+1].offset - 1; i >= first; i--)
    200      1.1    kardel 	{
    201      1.1    kardel 		sum <<= 1;
    202      1.1    kardel 		sum |= (buf[i] != zero[i]);
    203      1.1    kardel 	}
    204      1.1    kardel 	return sum;
    205      1.1    kardel }
    206      1.1    kardel 
    207      1.1    kardel static unsigned
    208      1.1    kardel pcheck(
    209      1.1    kardel        unsigned char *buf,
    210      1.1    kardel        int   idx,
    211      1.2  christos        const unsigned char *zero
    212      1.1    kardel        )
    213      1.1    kardel {
    214      1.1    kardel 	int i,last;
    215      1.1    kardel 	unsigned psum = 1;
    216      1.1    kardel 
    217      1.1    kardel 	last = partab[idx+1].offset;
    218      1.1    kardel 
    219      1.1    kardel 	for (i = partab[idx].offset; i < last; i++)
    220      1.1    kardel 	    psum ^= (buf[i] != zero[i]);
    221      1.1    kardel 
    222      1.1    kardel 	return psum;
    223      1.1    kardel }
    224      1.1    kardel 
    225      1.8  christos static int/*BOOL*/
    226      1.8  christos zeller_expand(
    227      1.8  christos 	clocktime_t     *clock_time,
    228      1.8  christos 	unsigned int	wd
    229      1.8  christos 	)
    230      1.8  christos {
    231      1.8  christos         unsigned int  y = (unsigned int)clock_time->year;
    232      1.8  christos         unsigned int  m = (unsigned int)clock_time->month - 1u;
    233      1.8  christos         unsigned int  d = (unsigned int)clock_time->day - 1u;
    234      1.8  christos 	unsigned int  c;
    235      1.8  christos 
    236      1.8  christos 	/* Check basic constraints first. */
    237      1.8  christos         if ((y >= 100u) || (m >= 12u) || (d >= 31u) || (--wd >= 7u))
    238      1.8  christos 		return FALSE;
    239      1.8  christos 
    240      1.8  christos 	/* Get weekday of date in 1st century by a variation on Zeller's
    241      1.8  christos 	 * congruence. All operands are non-negative, and the month
    242      1.8  christos 	 * formula is adjusted to use a divider of 32, so we can do a
    243      1.8  christos 	 * shift instead of a 'true' division:
    244      1.8  christos 	 */
    245      1.8  christos 	if ((m += 10u) >= 12u)		/* shift base to 0000-03-01 */
    246      1.8  christos 		m -= 12u;
    247      1.8  christos 	else if (--y >= 100u)
    248      1.8  christos 		y += 100;
    249      1.8  christos 	d += y + (y >> 2) + 2u;		/* year-related share */
    250      1.8  christos 	d += (m * 83u + 16u) >> 5;	/* month-related share */
    251      1.8  christos 
    252      1.8  christos 	/* The next step combines the exact division by modular inverse
    253      1.8  christos 	 * with the (mod 7) step in such way that no true division and
    254      1.8  christos 	 * only one multiplication is needed. The multiplier is
    255      1.8  christos 	 *      M <- ceil((3*8)/7 * 2**29)
    256      1.8  christos 	 * and combines multiplication by invmod(5, 7) -> 3 and modulus
    257      1.8  christos 	 * by 7 transformation to (mod 8) in one step.
    258      1.8  christos 	 *   Note that 252 == 0 (mod 7) and that 'd' is less than 185,
    259      1.8  christos 	 * so the number to invert and reduce is strictly positive. In
    260      1.8  christos 	 * the end, 'c' is number of centuries since start of a great
    261      1.8  christos 	 * cycle and must be in [0..3] or we had bad input.
    262      1.8  christos 	 */
    263      1.8  christos 	c = (((252u + wd - d) * 0x6db6db6eU) >> 29) & 7u;
    264      1.8  christos 	if (c >= 4)
    265      1.8  christos 		return FALSE;
    266      1.8  christos 	/* undo calendar base shift now */
    267      1.8  christos 	if ((m > 9u) && (++y >= 100u)) {
    268      1.8  christos 		y -= 100u;
    269      1.8  christos 		c = (c + 1u) & 3u;
    270      1.8  christos 	}
    271      1.8  christos 	/* combine year with centuries & map to [1970..2369] */
    272      1.8  christos 	y += (c * 100u);
    273      1.8  christos 	clock_time->year = (int)y + ((y < 370u) ? 2000 : 1600);
    274      1.8  christos 	return TRUE;
    275      1.8  christos }
    276      1.8  christos 
    277      1.1    kardel static u_long
    278      1.1    kardel convert_rawdcf(
    279      1.1    kardel 	       unsigned char   *buffer,
    280      1.1    kardel 	       int              size,
    281      1.1    kardel 	       struct dcfparam *dcfprm,
    282      1.1    kardel 	       clocktime_t     *clock_time
    283      1.1    kardel 	       )
    284      1.1    kardel {
    285      1.1    kardel 	unsigned char *s = buffer;
    286      1.2  christos 	const unsigned char *b = dcfprm->onebits;
    287      1.2  christos 	const unsigned char *c = dcfprm->zerobits;
    288      1.1    kardel 	int i;
    289      1.1    kardel 
    290      1.6  christos 	parseprintf(DD_RAWDCF,("parse: convert_rawdcf: \"%.*s\"\n", size, buffer));
    291      1.1    kardel 
    292      1.1    kardel 	if (size < 57)
    293      1.1    kardel 	{
    294      1.1    kardel #ifndef PARSEKERNEL
    295      1.3  christos 		msyslog(LOG_ERR, "parse: convert_rawdcf: INCOMPLETE DATA - time code only has %d bits", size);
    296      1.1    kardel #endif
    297      1.6  christos 		return CVT_FAIL|CVT_BADFMT;
    298      1.1    kardel 	}
    299      1.5  christos 
    300      1.1    kardel 	for (i = 0; i < size; i++)
    301      1.1    kardel 	{
    302      1.1    kardel 		if ((*s != *b) && (*s != *c))
    303      1.1    kardel 		{
    304      1.1    kardel 			/*
    305      1.1    kardel 			 * we only have two types of bytes (ones and zeros)
    306      1.1    kardel 			 */
    307      1.1    kardel #ifndef PARSEKERNEL
    308      1.1    kardel 			msyslog(LOG_ERR, "parse: convert_rawdcf: BAD DATA - no conversion");
    309      1.1    kardel #endif
    310      1.6  christos 			return CVT_FAIL|CVT_BADFMT;
    311      1.1    kardel 		}
    312      1.1    kardel 		if (*b) b++;
    313      1.1    kardel 		if (*c) c++;
    314      1.1    kardel 		s++;
    315      1.1    kardel 	}
    316      1.1    kardel 
    317      1.1    kardel 	/*
    318      1.1    kardel 	 * check Start and Parity bits
    319      1.1    kardel 	 */
    320      1.1    kardel 	if ((ext_bf(buffer, DCF_S, dcfprm->zerobits) == 1) &&
    321      1.1    kardel 	    pcheck(buffer, DCF_P_P1, dcfprm->zerobits) &&
    322      1.1    kardel 	    pcheck(buffer, DCF_P_P2, dcfprm->zerobits) &&
    323      1.1    kardel 	    pcheck(buffer, DCF_P_P3, dcfprm->zerobits))
    324      1.1    kardel 	{
    325      1.1    kardel 		/*
    326      1.1    kardel 		 * buffer OK
    327      1.1    kardel 		 */
    328      1.1    kardel 		parseprintf(DD_RAWDCF,("parse: convert_rawdcf: parity check passed\n"));
    329      1.1    kardel 
    330      1.6  christos 		clock_time->flags  = PARSEB_S_CALLBIT|PARSEB_S_LEAP;
    331      1.1    kardel 		clock_time->utctime= 0;
    332      1.1    kardel 		clock_time->usecond= 0;
    333      1.1    kardel 		clock_time->second = 0;
    334      1.1    kardel 		clock_time->minute = ext_bf(buffer, DCF_M10, dcfprm->zerobits);
    335      1.1    kardel 		clock_time->minute = TIMES10(clock_time->minute) + ext_bf(buffer, DCF_M1, dcfprm->zerobits);
    336      1.1    kardel 		clock_time->hour   = ext_bf(buffer, DCF_H10, dcfprm->zerobits);
    337      1.1    kardel 		clock_time->hour   = TIMES10(clock_time->hour) + ext_bf(buffer, DCF_H1, dcfprm->zerobits);
    338      1.1    kardel 		clock_time->day    = ext_bf(buffer, DCF_D10, dcfprm->zerobits);
    339      1.1    kardel 		clock_time->day    = TIMES10(clock_time->day) + ext_bf(buffer, DCF_D1, dcfprm->zerobits);
    340      1.1    kardel 		clock_time->month  = ext_bf(buffer, DCF_MO0, dcfprm->zerobits);
    341      1.1    kardel 		clock_time->month  = TIMES10(clock_time->month) + ext_bf(buffer, DCF_MO, dcfprm->zerobits);
    342      1.1    kardel 		clock_time->year   = ext_bf(buffer, DCF_Y10, dcfprm->zerobits);
    343      1.1    kardel 		clock_time->year   = TIMES10(clock_time->year) + ext_bf(buffer, DCF_Y1, dcfprm->zerobits);
    344      1.1    kardel 
    345      1.8  christos 		if (!zeller_expand(clock_time, ext_bf(buffer, DCF_DW, dcfprm->zerobits)))
    346      1.8  christos 		    return CVT_FAIL|CVT_BADFMT;
    347      1.8  christos 
    348      1.1    kardel 		switch (ext_bf(buffer, DCF_Z, dcfprm->zerobits))
    349      1.1    kardel 		{
    350      1.1    kardel 		    case DCF_Z_MET:
    351      1.1    kardel 			clock_time->utcoffset = -1*60*60;
    352      1.1    kardel 			break;
    353      1.1    kardel 
    354      1.1    kardel 		    case DCF_Z_MED:
    355      1.1    kardel 			clock_time->flags     |= PARSEB_DST;
    356      1.1    kardel 			clock_time->utcoffset  = -2*60*60;
    357      1.1    kardel 			break;
    358      1.1    kardel 
    359      1.1    kardel 		    default:
    360      1.1    kardel 			parseprintf(DD_RAWDCF,("parse: convert_rawdcf: BAD TIME ZONE\n"));
    361      1.1    kardel 			return CVT_FAIL|CVT_BADFMT;
    362      1.1    kardel 		}
    363      1.1    kardel 
    364      1.1    kardel 		if (ext_bf(buffer, DCF_A1, dcfprm->zerobits))
    365      1.1    kardel 		    clock_time->flags |= PARSEB_ANNOUNCE;
    366      1.1    kardel 
    367      1.1    kardel 		if (ext_bf(buffer, DCF_A2, dcfprm->zerobits))
    368      1.1    kardel 		    clock_time->flags |= PARSEB_LEAPADD; /* default: DCF77 data format deficiency */
    369      1.1    kardel 
    370      1.1    kardel 		if (ext_bf(buffer, DCF_R, dcfprm->zerobits))
    371      1.5  christos 		    clock_time->flags |= PARSEB_CALLBIT;
    372      1.1    kardel 
    373      1.6  christos 		parseprintf(DD_RAWDCF,("parse: convert_rawdcf: TIME CODE OK: %02d:%02d, %02d.%02d.%02d, flags 0x%lx\n",
    374      1.1    kardel 				       (int)clock_time->hour, (int)clock_time->minute, (int)clock_time->day, (int)clock_time->month,(int) clock_time->year,
    375      1.1    kardel 				       (u_long)clock_time->flags));
    376      1.1    kardel 		return CVT_OK;
    377      1.1    kardel 	}
    378      1.1    kardel 	else
    379      1.1    kardel 	{
    380      1.1    kardel 		/*
    381      1.1    kardel 		 * bad format - not for us
    382      1.1    kardel 		 */
    383      1.1    kardel #ifndef PARSEKERNEL
    384      1.6  christos 		msyslog(LOG_ERR, "parse: convert_rawdcf: start bit / parity check FAILED for \"%.*s\"", size, buffer);
    385      1.1    kardel #endif
    386      1.1    kardel 		return CVT_FAIL|CVT_BADFMT;
    387      1.1    kardel 	}
    388      1.1    kardel }
    389      1.1    kardel 
    390      1.1    kardel /*
    391      1.5  christos  * parse_cvt_fnc_t cvt_rawdcf
    392      1.1    kardel  * raw dcf input routine - needs to fix up 50 baud
    393      1.1    kardel  * characters for 1/0 decision
    394      1.1    kardel  */
    395      1.1    kardel static u_long
    396      1.1    kardel cvt_rawdcf(
    397      1.1    kardel 	   unsigned char   *buffer,
    398      1.1    kardel 	   int              size,
    399      1.1    kardel 	   struct format   *param,
    400      1.1    kardel 	   clocktime_t     *clock_time,
    401      1.1    kardel 	   void            *local
    402      1.1    kardel 	   )
    403      1.1    kardel {
    404      1.1    kardel 	last_tcode_t  *t = (last_tcode_t *)local;
    405      1.1    kardel 	unsigned char *s = (unsigned char *)buffer;
    406      1.1    kardel 	unsigned char *e = s + size;
    407      1.2  christos 	const unsigned char *b = dcfparameter.onebits;
    408      1.2  christos 	const unsigned char *c = dcfparameter.zerobits;
    409      1.1    kardel 	u_long       rtc = CVT_NONE;
    410      1.1    kardel 	unsigned int i, lowmax, highmax, cutoff, span;
    411      1.1    kardel #define BITS 9
    412      1.1    kardel 	unsigned char     histbuf[BITS];
    413      1.1    kardel 	/*
    414      1.1    kardel 	 * the input buffer contains characters with runs of consecutive
    415      1.1    kardel 	 * bits set. These set bits are an indication of the DCF77 pulse
    416      1.1    kardel 	 * length. We assume that we receive the pulse at 50 Baud. Thus
    417      1.1    kardel 	 * a 100ms pulse would generate a 4 bit train (20ms per bit and
    418      1.1    kardel 	 * start bit)
    419      1.1    kardel 	 * a 200ms pulse would create all zeroes (and probably a frame error)
    420      1.1    kardel 	 */
    421      1.1    kardel 
    422      1.1    kardel 	for (i = 0; i < BITS; i++)
    423      1.1    kardel 	{
    424      1.1    kardel 		histbuf[i] = 0;
    425      1.1    kardel 	}
    426      1.1    kardel 
    427      1.1    kardel 	cutoff = 0;
    428      1.1    kardel 	lowmax = 0;
    429      1.1    kardel 
    430      1.1    kardel 	while (s < e)
    431      1.1    kardel 	{
    432      1.1    kardel 		unsigned int ch = *s ^ 0xFF;
    433      1.1    kardel 		/*
    434      1.1    kardel 		 * these lines are left as an excercise to the reader 8-)
    435      1.1    kardel 		 */
    436      1.1    kardel 		if (!((ch+1) & ch) || !*s)
    437      1.1    kardel 		{
    438      1.1    kardel 
    439      1.1    kardel 			for (i = 0; ch; i++)
    440      1.1    kardel 			{
    441      1.1    kardel 				ch >>= 1;
    442      1.1    kardel 			}
    443      1.1    kardel 
    444      1.5  christos 			*s = (unsigned char) i;
    445      1.1    kardel 			histbuf[i]++;
    446      1.1    kardel 			cutoff += i;
    447      1.1    kardel 			lowmax++;
    448      1.1    kardel 		}
    449      1.1    kardel 		else
    450      1.1    kardel 		{
    451      1.1    kardel 			parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: character check for 0x%x@%d FAILED\n", *s, (int)(s - (unsigned char *)buffer)));
    452      1.1    kardel 			*s = (unsigned char)~0;
    453      1.1    kardel 			rtc = CVT_FAIL|CVT_BADFMT;
    454      1.1    kardel 		}
    455      1.1    kardel 		s++;
    456      1.1    kardel 	}
    457      1.1    kardel 
    458      1.1    kardel 	if (lowmax)
    459      1.1    kardel 	{
    460      1.1    kardel 		cutoff /= lowmax;
    461      1.1    kardel 	}
    462      1.1    kardel 	else
    463      1.1    kardel 	{
    464      1.1    kardel 		cutoff = 4;	/* doesn't really matter - it'll fail anyway, but gives error output */
    465      1.1    kardel 	}
    466      1.1    kardel 
    467      1.1    kardel 	parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: average bit count: %d\n", cutoff));
    468      1.1    kardel 
    469      1.1    kardel 	lowmax = 0;
    470      1.1    kardel 	highmax = 0;
    471      1.1    kardel 
    472      1.1    kardel 	parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: histogram:"));
    473      1.1    kardel 	for (i = 0; i <= cutoff; i++)
    474      1.1    kardel 	{
    475      1.1    kardel 		lowmax+=histbuf[i] * i;
    476      1.1    kardel 		highmax += histbuf[i];
    477      1.1    kardel 		parseprintf(DD_RAWDCF,(" %d", histbuf[i]));
    478      1.1    kardel 	}
    479      1.1    kardel 	parseprintf(DD_RAWDCF, (" <M>"));
    480      1.1    kardel 
    481      1.1    kardel 	lowmax += highmax / 2;
    482      1.1    kardel 
    483      1.1    kardel 	if (highmax)
    484      1.1    kardel 	{
    485      1.1    kardel 		lowmax /= highmax;
    486      1.1    kardel 	}
    487      1.1    kardel 	else
    488      1.1    kardel 	{
    489      1.1    kardel 		lowmax = 0;
    490      1.1    kardel 	}
    491      1.1    kardel 
    492      1.1    kardel 	highmax = 0;
    493      1.1    kardel 	cutoff = 0;
    494      1.1    kardel 
    495      1.1    kardel 	for (; i < BITS; i++)
    496      1.1    kardel 	{
    497      1.1    kardel 		highmax+=histbuf[i] * i;
    498      1.1    kardel 		cutoff +=histbuf[i];
    499      1.1    kardel 		parseprintf(DD_RAWDCF,(" %d", histbuf[i]));
    500      1.1    kardel 	}
    501      1.1    kardel 	parseprintf(DD_RAWDCF,("\n"));
    502      1.1    kardel 
    503      1.1    kardel 	if (cutoff)
    504      1.1    kardel 	{
    505      1.1    kardel 		highmax /= cutoff;
    506      1.1    kardel 	}
    507      1.1    kardel 	else
    508      1.1    kardel 	{
    509      1.1    kardel 		highmax = BITS-1;
    510      1.1    kardel 	}
    511      1.1    kardel 
    512      1.1    kardel 	span = cutoff = lowmax;
    513      1.1    kardel 	for (i = lowmax; i <= highmax; i++)
    514      1.1    kardel 	{
    515      1.1    kardel 		if (histbuf[cutoff] > histbuf[i])
    516      1.1    kardel 		{
    517      1.1    kardel 			cutoff = i;
    518      1.1    kardel 			span = i;
    519      1.1    kardel 		}
    520      1.1    kardel 		else
    521      1.1    kardel 		    if (histbuf[cutoff] == histbuf[i])
    522      1.1    kardel 		    {
    523      1.1    kardel 			    span = i;
    524      1.1    kardel 		    }
    525      1.1    kardel 	}
    526      1.1    kardel 
    527      1.1    kardel 	cutoff = (cutoff + span) / 2;
    528      1.1    kardel 
    529      1.1    kardel 	parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: lower maximum %d, higher maximum %d, cutoff %d\n", lowmax, highmax, cutoff));
    530      1.1    kardel 
    531      1.1    kardel 	s = (unsigned char *)buffer;
    532      1.1    kardel 	while (s < e)
    533      1.1    kardel 	{
    534      1.1    kardel 		if (*s == (unsigned char)~0)
    535      1.1    kardel 		{
    536      1.1    kardel 			*s = '?';
    537      1.1    kardel 		}
    538      1.1    kardel 		else
    539      1.1    kardel 		{
    540      1.1    kardel 			*s = (*s >= cutoff) ? *b : *c;
    541      1.1    kardel 		}
    542      1.1    kardel 		s++;
    543      1.1    kardel 		if (*b) b++;
    544      1.1    kardel 		if (*c) c++;
    545      1.1    kardel 	}
    546      1.1    kardel 
    547      1.6  christos 	*s = '\0';
    548      1.6  christos 
    549      1.1    kardel         if (rtc == CVT_NONE)
    550      1.1    kardel         {
    551      1.1    kardel 	       rtc = convert_rawdcf(buffer, size, &dcfparameter, clock_time);
    552      1.1    kardel 	       if (rtc == CVT_OK)
    553      1.1    kardel 	       {
    554      1.1    kardel 			time_t newtime;
    555      1.1    kardel 
    556      1.1    kardel 			newtime = parse_to_unixtime(clock_time, &rtc);
    557      1.1    kardel 			if ((rtc == CVT_OK) && t)
    558      1.1    kardel 			{
    559      1.6  christos 				if ((newtime - t->tcode) <= 600) /* require a successful telegram within last 10 minutes */
    560      1.1    kardel 				{
    561      1.6  christos 				        parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: recent timestamp check OK\n"));
    562      1.1    kardel 					clock_time->utctime = newtime;
    563      1.1    kardel 				}
    564      1.1    kardel 				else
    565      1.1    kardel 				{
    566      1.6  christos 					parseprintf(DD_RAWDCF,("parse: cvt_rawdcf: recent timestamp check FAIL - ignore timestamp\n"));
    567      1.6  christos 					rtc = CVT_SKIP;
    568      1.1    kardel 				}
    569      1.1    kardel 				t->tcode            = newtime;
    570      1.1    kardel 			}
    571      1.1    kardel 	       }
    572      1.1    kardel         }
    573      1.5  christos 
    574      1.1    kardel     	return rtc;
    575      1.1    kardel }
    576      1.1    kardel 
    577      1.1    kardel /*
    578      1.5  christos  * parse_pps_fnc_t pps_rawdcf
    579      1.1    kardel  *
    580      1.1    kardel  * currently a very stupid version - should be extended to decode
    581      1.1    kardel  * also ones and zeros (which is easy)
    582      1.1    kardel  */
    583      1.1    kardel /*ARGSUSED*/
    584      1.1    kardel static u_long
    585      1.1    kardel pps_rawdcf(
    586      1.1    kardel 	parse_t *parseio,
    587      1.1    kardel 	int status,
    588      1.1    kardel 	timestamp_t *ptime
    589      1.1    kardel 	)
    590      1.1    kardel {
    591      1.1    kardel 	if (!status)		/* negative edge for simpler wiring (Rx->DCD) */
    592      1.1    kardel 	{
    593      1.1    kardel 		parseio->parse_dtime.parse_ptime  = *ptime;
    594      1.1    kardel 		parseio->parse_dtime.parse_state |= PARSEB_PPS|PARSEB_S_PPS;
    595      1.1    kardel 	}
    596      1.1    kardel 
    597      1.1    kardel 	return CVT_NONE;
    598      1.1    kardel }
    599      1.1    kardel 
    600      1.6  christos static long
    601      1.6  christos calc_usecdiff(
    602      1.6  christos 	timestamp_t *ref,
    603      1.6  christos 	timestamp_t *base,
    604      1.6  christos 	long         offset
    605      1.6  christos 	)
    606      1.6  christos {
    607      1.6  christos 	struct timeval delta;
    608      1.6  christos 	long delta_usec = 0;
    609      1.6  christos 
    610      1.6  christos #ifdef PARSEKERNEL
    611      1.6  christos 	delta.tv_sec = ref->tv.tv_sec - offset - base->tv.tv_sec;
    612      1.6  christos 	delta.tv_usec = ref->tv.tv_usec - base->tv.tv_usec;
    613      1.6  christos 	if (delta.tv_usec < 0)
    614      1.6  christos 	{
    615      1.6  christos 		delta.tv_sec  -= 1;
    616      1.6  christos 		delta.tv_usec += 1000000;
    617      1.6  christos 	}
    618      1.6  christos #else
    619      1.6  christos 	l_fp delt;
    620      1.6  christos 
    621      1.6  christos 	delt = ref->fp;
    622      1.6  christos 	delt.l_i -= offset;
    623      1.6  christos 	L_SUB(&delt, &base->fp);
    624      1.6  christos 	TSTOTV(&delt, &delta);
    625      1.6  christos #endif
    626      1.6  christos 
    627      1.6  christos 	delta_usec = 1000000 * (int32_t)delta.tv_sec + delta.tv_usec;
    628      1.6  christos 	return delta_usec;
    629      1.6  christos }
    630      1.6  christos 
    631      1.1    kardel static u_long
    632      1.1    kardel snt_rawdcf(
    633      1.1    kardel 	parse_t *parseio,
    634      1.1    kardel 	timestamp_t *ptime
    635      1.1    kardel 	)
    636      1.1    kardel {
    637      1.6  christos 	/*
    638      1.6  christos 	 * only synthesize if all of following conditions are met:
    639      1.6  christos 	 * - CVT_OK parse_status (we have a time stamp base)
    640      1.6  christos 	 * - ABS(ptime - tminute - (parse_index - 1) sec) < 500ms (spaced by 1 sec +- 500ms)
    641      1.6  christos 	 * - minute marker is available (confirms minute raster as base)
    642      1.6  christos 	 */
    643      1.6  christos 	last_tcode_t  *t = (last_tcode_t *)parseio->parse_pdata;
    644      1.6  christos 	long delta_usec = -1;
    645      1.6  christos 
    646      1.6  christos 	if (t != NULL && t->tminute.tv.tv_sec != 0) {
    647      1.6  christos 		delta_usec = calc_usecdiff(ptime, &t->tminute, parseio->parse_index - 1);
    648      1.6  christos 		if (delta_usec < 0)
    649      1.6  christos 			delta_usec = -delta_usec;
    650      1.6  christos 	}
    651      1.6  christos 
    652      1.6  christos 	parseprintf(DD_RAWDCF,("parse: snt_rawdcf: synth for offset %d seconds - absolute usec error %ld\n",
    653      1.6  christos 			       parseio->parse_index - 1, delta_usec));
    654      1.6  christos 
    655      1.6  christos 	if (((parseio->parse_dtime.parse_status & CVT_MASK) == CVT_OK) &&
    656      1.6  christos 	    (delta_usec < 500000 && delta_usec >= 0)) /* only if minute marker is available */
    657      1.1    kardel 	{
    658      1.1    kardel 		parseio->parse_dtime.parse_stime = *ptime;
    659      1.1    kardel 
    660      1.1    kardel #ifdef PARSEKERNEL
    661      1.1    kardel 		parseio->parse_dtime.parse_time.tv.tv_sec++;
    662      1.1    kardel #else
    663      1.1    kardel 		parseio->parse_dtime.parse_time.fp.l_ui++;
    664      1.1    kardel #endif
    665      1.5  christos 
    666      1.1    kardel 		parseprintf(DD_RAWDCF,("parse: snt_rawdcf: time stamp synthesized offset %d seconds\n", parseio->parse_index - 1));
    667      1.5  christos 
    668      1.1    kardel 		return updatetimeinfo(parseio, parseio->parse_lstate);
    669      1.1    kardel 	}
    670      1.1    kardel 	return CVT_NONE;
    671      1.1    kardel }
    672      1.1    kardel 
    673      1.1    kardel /*
    674      1.5  christos  * parse_inp_fnc_t inp_rawdcf
    675      1.1    kardel  *
    676      1.1    kardel  * grab DCF77 data from input stream
    677      1.1    kardel  */
    678      1.1    kardel static u_long
    679      1.1    kardel inp_rawdcf(
    680      1.1    kardel 	  parse_t      *parseio,
    681      1.5  christos 	  char         ch,
    682      1.1    kardel 	  timestamp_t  *tstamp
    683      1.1    kardel 	  )
    684      1.1    kardel {
    685      1.1    kardel 	static struct timeval timeout = { 1, 500000 }; /* 1.5 secongs denote second #60 */
    686      1.5  christos 
    687      1.7  christos 	parseprintf(DD_PARSE, ("inp_rawdcf(0x%p, 0x%x, ...)\n", (void*)parseio, ch));
    688      1.5  christos 
    689      1.1    kardel 	parseio->parse_dtime.parse_stime = *tstamp; /* collect timestamp */
    690      1.1    kardel 
    691      1.1    kardel 	if (parse_timedout(parseio, tstamp, &timeout))
    692      1.1    kardel 	{
    693      1.6  christos 		last_tcode_t *t = (last_tcode_t *)parseio->parse_pdata;
    694      1.6  christos 		long delta_usec;
    695      1.6  christos 
    696      1.6  christos 		parseprintf(DD_RAWDCF, ("inp_rawdcf: time out seen\n"));
    697      1.6  christos 		/* finish collection */
    698      1.6  christos 		(void) parse_end(parseio);
    699      1.6  christos 
    700      1.6  christos 		if (t != NULL)
    701      1.6  christos 		{
    702      1.6  christos 			/* remember minute start sample time if timeouts occur in minute raster */
    703      1.6  christos 			if (t->timeout.tv.tv_sec != 0)
    704      1.6  christos 			{
    705      1.6  christos 				delta_usec = calc_usecdiff(tstamp, &t->timeout, 60);
    706      1.6  christos 				if (delta_usec < 0)
    707      1.6  christos 					delta_usec = -delta_usec;
    708      1.6  christos 			}
    709      1.6  christos 			else
    710      1.6  christos 			{
    711      1.6  christos 				delta_usec = -1;
    712      1.6  christos 			}
    713      1.1    kardel 
    714      1.6  christos 			if (delta_usec < 500000 && delta_usec >= 0)
    715      1.6  christos 			{
    716      1.6  christos 				parseprintf(DD_RAWDCF, ("inp_rawdcf: timeout time difference %ld usec - minute marker set\n", delta_usec));
    717      1.6  christos 				/* collect minute markers only if spaced by 60 seconds */
    718      1.6  christos 				t->tminute = *tstamp;
    719      1.6  christos 			}
    720      1.6  christos 			else
    721      1.6  christos 			{
    722      1.6  christos 				parseprintf(DD_RAWDCF, ("inp_rawdcf: timeout time difference %ld usec - minute marker cleared\n", delta_usec));
    723      1.6  christos 				memset((char *)&t->tminute, 0, sizeof(t->tminute));
    724      1.6  christos 			}
    725      1.6  christos 			t->timeout = *tstamp;
    726      1.6  christos 		}
    727      1.1    kardel 		(void) parse_addchar(parseio, ch);
    728      1.6  christos 
    729      1.6  christos 		/* pass up to higher layers */
    730      1.1    kardel 		return PARSE_INP_TIME;
    731      1.1    kardel 	}
    732      1.1    kardel 	else
    733      1.1    kardel 	{
    734      1.1    kardel 		unsigned int rtc;
    735      1.5  christos 
    736      1.1    kardel 		rtc = parse_addchar(parseio, ch);
    737      1.1    kardel 		if (rtc == PARSE_INP_SKIP)
    738      1.1    kardel 		{
    739      1.1    kardel 			if (snt_rawdcf(parseio, tstamp) == CVT_OK)
    740      1.1    kardel 				return PARSE_INP_SYNTH;
    741      1.1    kardel 		}
    742      1.1    kardel 		return rtc;
    743      1.1    kardel 	}
    744      1.1    kardel }
    745      1.1    kardel 
    746      1.1    kardel #else /* not (REFCLOCK && CLOCK_PARSE && CLOCK_RAWDCF) */
    747  1.8.8.1  perseant NONEMPTY_TRANSLATION_UNIT
    748      1.1    kardel #endif /* not (REFCLOCK && CLOCK_PARSE && CLOCK_RAWDCF) */
    749      1.1    kardel 
    750      1.1    kardel /*
    751      1.1    kardel  * History:
    752      1.1    kardel  *
    753      1.1    kardel  * clk_rawdcf.c,v
    754      1.1    kardel  * Revision 4.18  2006/06/22 18:40:01  kardel
    755      1.1    kardel  * clean up signedness (gcc 4)
    756      1.1    kardel  *
    757      1.1    kardel  * Revision 4.17  2006/01/22 16:01:55  kardel
    758      1.1    kardel  * update version information
    759      1.1    kardel  *
    760      1.1    kardel  * Revision 4.16  2006/01/22 15:51:22  kardel
    761      1.1    kardel  * generate reasonable timecode output on invalid input
    762      1.1    kardel  *
    763      1.1    kardel  * Revision 4.15  2005/08/06 19:17:06  kardel
    764      1.1    kardel  * clean log output
    765      1.1    kardel  *
    766      1.1    kardel  * Revision 4.14  2005/08/06 17:39:40  kardel
    767      1.1    kardel  * cleanup size handling wrt/ to buffer boundaries
    768      1.1    kardel  *
    769      1.1    kardel  * Revision 4.13  2005/04/16 17:32:10  kardel
    770      1.1    kardel  * update copyright
    771      1.1    kardel  *
    772      1.1    kardel  * Revision 4.12  2004/11/14 15:29:41  kardel
    773      1.1    kardel  * support PPSAPI, upgrade Copyright to Berkeley style
    774      1.1    kardel  *
    775      1.1    kardel  * Revision 4.9  1999/12/06 13:42:23  kardel
    776      1.1    kardel  * transfer correctly converted time codes always into tcode
    777      1.1    kardel  *
    778      1.1    kardel  * Revision 4.8  1999/11/28 09:13:50  kardel
    779      1.1    kardel  * RECON_4_0_98F
    780      1.1    kardel  *
    781      1.1    kardel  * Revision 4.7  1999/04/01 20:07:20  kardel
    782      1.1    kardel  * added checking for minutie increment of timestamps in clk_rawdcf.c
    783      1.1    kardel  *
    784      1.1    kardel  * Revision 4.6  1998/06/14 21:09:37  kardel
    785      1.1    kardel  * Sun acc cleanup
    786      1.1    kardel  *
    787      1.1    kardel  * Revision 4.5  1998/06/13 12:04:16  kardel
    788      1.1    kardel  * fix SYSV clock name clash
    789      1.1    kardel  *
    790      1.1    kardel  * Revision 4.4  1998/06/12 15:22:28  kardel
    791      1.1    kardel  * fix prototypes
    792      1.1    kardel  *
    793      1.1    kardel  * Revision 4.3  1998/06/06 18:33:36  kardel
    794      1.1    kardel  * simplified condidional compile expression
    795      1.1    kardel  *
    796      1.1    kardel  * Revision 4.2  1998/05/24 11:04:18  kardel
    797      1.1    kardel  * triggering PPS on negative edge for simpler wiring (Rx->DCD)
    798      1.1    kardel  *
    799      1.1    kardel  * Revision 4.1  1998/05/24 09:39:53  kardel
    800      1.1    kardel  * implementation of the new IO handling model
    801      1.1    kardel  *
    802      1.1    kardel  * Revision 4.0  1998/04/10 19:45:30  kardel
    803      1.1    kardel  * Start 4.0 release version numbering
    804      1.1    kardel  *
    805      1.1    kardel  * from V3 3.24 log info deleted 1998/04/11 kardel
    806      1.1    kardel  *
    807      1.1    kardel  */
    808