xref: /freebsd/contrib/ntp/libparse/clk_computime.c (revision f5f40dd63bc7acbb5312b26ac1ea1103c12352a6)
1c0b746e5SOllivier Robert #ifdef HAVE_CONFIG_H
2c0b746e5SOllivier Robert # include <config.h>
3c0b746e5SOllivier Robert #endif
4c0b746e5SOllivier Robert 
5c0b746e5SOllivier Robert #if defined(REFCLOCK) && defined(CLOCK_PARSE) && defined(CLOCK_COMPUTIME)
6c0b746e5SOllivier Robert /*
7ea906c41SOllivier Robert  * /src/NTP/ntp4-dev/libparse/clk_computime.c,v 4.10 2005/04/16 17:32:10 kardel RELEASE_20050508_A
8c0b746e5SOllivier Robert  *
9ea906c41SOllivier Robert  * clk_computime.c,v 4.10 2005/04/16 17:32:10 kardel RELEASE_20050508_A
10c0b746e5SOllivier Robert  *
11c0b746e5SOllivier Robert  * Supports Diem's Computime Radio Clock
12c0b746e5SOllivier Robert  *
13c0b746e5SOllivier Robert  * Used the Meinberg clock as a template for Diem's Computime Radio Clock
14c0b746e5SOllivier Robert  *
15c0b746e5SOllivier Robert  * adapted by Alois Camenzind <alois.camenzind@ubs.ch>
16c0b746e5SOllivier Robert  *
17ea906c41SOllivier Robert  * Copyright (c) 1995-2005 by Frank Kardel <kardel <AT> ntp.org>
18a25439b6SCy Schubert  * Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universitaet Erlangen-Nuernberg, Germany
19c0b746e5SOllivier Robert  *
20ea906c41SOllivier Robert  * Redistribution and use in source and binary forms, with or without
21ea906c41SOllivier Robert  * modification, are permitted provided that the following conditions
22ea906c41SOllivier Robert  * are met:
23ea906c41SOllivier Robert  * 1. Redistributions of source code must retain the above copyright
24ea906c41SOllivier Robert  *    notice, this list of conditions and the following disclaimer.
25ea906c41SOllivier Robert  * 2. Redistributions in binary form must reproduce the above copyright
26ea906c41SOllivier Robert  *    notice, this list of conditions and the following disclaimer in the
27ea906c41SOllivier Robert  *    documentation and/or other materials provided with the distribution.
28ea906c41SOllivier Robert  * 3. Neither the name of the author nor the names of its contributors
29ea906c41SOllivier Robert  *    may be used to endorse or promote products derived from this software
30ea906c41SOllivier Robert  *    without specific prior written permission.
31ea906c41SOllivier Robert  *
32ea906c41SOllivier Robert  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
33ea906c41SOllivier Robert  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34ea906c41SOllivier Robert  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35ea906c41SOllivier Robert  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
36ea906c41SOllivier Robert  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37ea906c41SOllivier Robert  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38ea906c41SOllivier Robert  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39ea906c41SOllivier Robert  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40ea906c41SOllivier Robert  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41ea906c41SOllivier Robert  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42ea906c41SOllivier Robert  * SUCH DAMAGE.
43c0b746e5SOllivier Robert  *
44c0b746e5SOllivier Robert  */
45c0b746e5SOllivier Robert 
46c0b746e5SOllivier Robert #include "ntp_fp.h"
47c0b746e5SOllivier Robert #include "ntp_unixtime.h"
48c0b746e5SOllivier Robert #include "ntp_calendar.h"
49c0b746e5SOllivier Robert #include "ntp_stdlib.h"
50c0b746e5SOllivier Robert 
51c0b746e5SOllivier Robert #include "parse.h"
52c0b746e5SOllivier Robert 
53c0b746e5SOllivier Robert #ifndef PARSESTREAM
54c0b746e5SOllivier Robert #include <stdio.h>
55c0b746e5SOllivier Robert #else
56c0b746e5SOllivier Robert #include "sys/parsestreams.h"
572b15cb3dSCy Schubert extern int printf (const char *, ...);
58c0b746e5SOllivier Robert #endif
59c0b746e5SOllivier Robert 
60c0b746e5SOllivier Robert /*
61c0b746e5SOllivier Robert  * The Computime receiver sends a datagram in the following format every minute
62c0b746e5SOllivier Robert  *
63c0b746e5SOllivier Robert  * Timestamp	T:YY:MM:MD:WD:HH:MM:SSCRLF
64c0b746e5SOllivier Robert  * Pos          0123456789012345678901 2 3
65c0b746e5SOllivier Robert  *              0000000000111111111122 2 2
66c0b746e5SOllivier Robert  * Parse        T:  :  :  :  :  :  :  rn
67c0b746e5SOllivier Robert  *
68c0b746e5SOllivier Robert  * T	Startcharacter "T" specifies start of the timestamp
69c0b746e5SOllivier Robert  * YY	Year MM	Month 1-12
70c0b746e5SOllivier Robert  * MD	Day of the month
71c0b746e5SOllivier Robert  * WD	Day of week
72c0b746e5SOllivier Robert  * HH	Hour
73c0b746e5SOllivier Robert  * MM   Minute
74c0b746e5SOllivier Robert  * SS   Second
75c0b746e5SOllivier Robert  * CR   Carriage return
76c0b746e5SOllivier Robert  * LF   Linefeed
77c0b746e5SOllivier Robert  *
78c0b746e5SOllivier Robert  */
79c0b746e5SOllivier Robert 
80c0b746e5SOllivier Robert static struct format computime_fmt =
81c0b746e5SOllivier Robert {
82c0b746e5SOllivier Robert 	{
83c0b746e5SOllivier Robert 		{8, 2},  {5,  2}, {2,  2},	/* day, month, year */
84c0b746e5SOllivier Robert 		{14, 2}, {17, 2}, {20, 2},	/* hour, minute, second */
85c0b746e5SOllivier Robert 		{11, 2},                        /* dayofweek,  */
86c0b746e5SOllivier Robert 	},
87c0b746e5SOllivier Robert 	(const unsigned char *)"T:  :  :  :  :  :  :  \r\n",
88c0b746e5SOllivier Robert 	0
89c0b746e5SOllivier Robert };
90c0b746e5SOllivier Robert 
91a25439b6SCy Schubert static parse_cvt_fnc_t cvt_computime;
92a25439b6SCy Schubert static parse_inp_fnc_t inp_computime;
93c0b746e5SOllivier Robert 
94c0b746e5SOllivier Robert clockformat_t clock_computime =
95c0b746e5SOllivier Robert {
96c0b746e5SOllivier Robert 	inp_computime,		/* Computime input handling */
97c0b746e5SOllivier Robert 	cvt_computime,		/* Computime conversion */
98c0b746e5SOllivier Robert 	0,			/* no PPS monitoring */
99c0b746e5SOllivier Robert 	(void *)&computime_fmt,	/* conversion configuration */
100c0b746e5SOllivier Robert 	"Diem's Computime Radio Clock",	/* Computime Radio Clock */
101c0b746e5SOllivier Robert 	24,			/* string buffer */
102a25439b6SCy Schubert 	0			/* no private data (complete packets) */
103c0b746e5SOllivier Robert };
104c0b746e5SOllivier Robert 
105c0b746e5SOllivier Robert /*
106a25439b6SCy Schubert  * parse_cvt_fnc_t cvt_computime
107c0b746e5SOllivier Robert  *
108c0b746e5SOllivier Robert  * convert simple type format
109c0b746e5SOllivier Robert  */
110c0b746e5SOllivier Robert static u_long
111c0b746e5SOllivier Robert cvt_computime(
112c0b746e5SOllivier Robert 	unsigned char *buffer,
113c0b746e5SOllivier Robert 	int            size,
114c0b746e5SOllivier Robert 	struct format *format,
115c0b746e5SOllivier Robert 	clocktime_t   *clock_time,
116c0b746e5SOllivier Robert 	void          *local
117c0b746e5SOllivier Robert 	)
118c0b746e5SOllivier Robert {
119c0b746e5SOllivier Robert 
120c0b746e5SOllivier Robert 	if (!Strok(buffer, format->fixed_string)) {
121c0b746e5SOllivier Robert 		return CVT_NONE;
122c0b746e5SOllivier Robert 	} else {
123c0b746e5SOllivier Robert 		if (Stoi(&buffer[format->field_offsets[O_DAY].offset], &clock_time->day,
124c0b746e5SOllivier Robert 			 format->field_offsets[O_DAY].length) ||
125c0b746e5SOllivier Robert 		    Stoi(&buffer[format->field_offsets[O_MONTH].offset], &clock_time->month,
126c0b746e5SOllivier Robert 			 format->field_offsets[O_MONTH].length) ||
127c0b746e5SOllivier Robert 		    Stoi(&buffer[format->field_offsets[O_YEAR].offset], &clock_time->year,
128c0b746e5SOllivier Robert 			 format->field_offsets[O_YEAR].length) ||
129c0b746e5SOllivier Robert 		    Stoi(&buffer[format->field_offsets[O_HOUR].offset], &clock_time->hour,
130c0b746e5SOllivier Robert 			 format->field_offsets[O_HOUR].length) ||
131c0b746e5SOllivier Robert 		    Stoi(&buffer[format->field_offsets[O_MIN].offset], &clock_time->minute,
132c0b746e5SOllivier Robert 			 format->field_offsets[O_MIN].length) ||
133c0b746e5SOllivier Robert 		    Stoi(&buffer[format->field_offsets[O_SEC].offset], &clock_time->second,
134c0b746e5SOllivier Robert 			 format->field_offsets[O_SEC].length)) {
135c0b746e5SOllivier Robert 			return CVT_FAIL | CVT_BADFMT;
136c0b746e5SOllivier Robert 		} else {
137c0b746e5SOllivier Robert 
138c0b746e5SOllivier Robert 			clock_time->flags = 0;
139c0b746e5SOllivier Robert 			clock_time->utcoffset = 0;	/* We have UTC time */
140c0b746e5SOllivier Robert 
141c0b746e5SOllivier Robert 			return CVT_OK;
142c0b746e5SOllivier Robert 		}
143c0b746e5SOllivier Robert 	}
144c0b746e5SOllivier Robert }
145c0b746e5SOllivier Robert 
146c0b746e5SOllivier Robert /*
147a25439b6SCy Schubert  * parse_inp_fnc_t inp_computime
148c0b746e5SOllivier Robert  *
149a25439b6SCy Schubert  * grab data from input stream
150c0b746e5SOllivier Robert  */
151c0b746e5SOllivier Robert static u_long
152c0b746e5SOllivier Robert inp_computime(
153c0b746e5SOllivier Robert 	      parse_t      *parseio,
154a25439b6SCy Schubert 	      char         ch,
155c0b746e5SOllivier Robert 	      timestamp_t  *tstamp
156c0b746e5SOllivier Robert 	      )
157c0b746e5SOllivier Robert {
158c0b746e5SOllivier Robert 	unsigned int rtc;
159c0b746e5SOllivier Robert 
1603311ff84SXin LI 	parseprintf(DD_PARSE, ("inp_computime(0x%p, 0x%x, ...)\n", (void*)parseio, ch));
161c0b746e5SOllivier Robert 
162c0b746e5SOllivier Robert 	switch (ch)
163c0b746e5SOllivier Robert 	{
164c0b746e5SOllivier Robert 	case 'T':
165c0b746e5SOllivier Robert 		parseprintf(DD_PARSE, ("inp_computime: START seen\n"));
166c0b746e5SOllivier Robert 
167c0b746e5SOllivier Robert 		parseio->parse_index = 1;
168c0b746e5SOllivier Robert 		parseio->parse_data[0] = ch;
169c0b746e5SOllivier Robert 		parseio->parse_dtime.parse_stime = *tstamp; /* collect timestamp */
170c0b746e5SOllivier Robert 		return PARSE_INP_SKIP;
171c0b746e5SOllivier Robert 
172c0b746e5SOllivier Robert 	case '\n':
173c0b746e5SOllivier Robert 		parseprintf(DD_PARSE, ("inp_computime: END seen\n"));
174c0b746e5SOllivier Robert 		if ((rtc = parse_addchar(parseio, ch)) == PARSE_INP_SKIP)
175c0b746e5SOllivier Robert 			return parse_end(parseio);
176c0b746e5SOllivier Robert 		else
177c0b746e5SOllivier Robert 			return rtc;
178c0b746e5SOllivier Robert 
179c0b746e5SOllivier Robert 	default:
180c0b746e5SOllivier Robert 		return parse_addchar(parseio, ch);
181c0b746e5SOllivier Robert 	}
182c0b746e5SOllivier Robert }
183c0b746e5SOllivier Robert 
184c0b746e5SOllivier Robert #else /* not (REFCLOCK && CLOCK_PARSE && CLOCK_COMPUTIME) */
185*f5f40dd6SCy Schubert NONEMPTY_TRANSLATION_UNIT
186c0b746e5SOllivier Robert #endif /* not (REFCLOCK && CLOCK_PARSE && CLOCK_COMPUTIME) */
187c0b746e5SOllivier Robert 
188c0b746e5SOllivier Robert /*
189c0b746e5SOllivier Robert  * clk_computime.c,v
190ea906c41SOllivier Robert  * Revision 4.10  2005/04/16 17:32:10  kardel
191ea906c41SOllivier Robert  * update copyright
192ea906c41SOllivier Robert  *
193ea906c41SOllivier Robert  * Revision 4.9  2004/11/14 15:29:41  kardel
194ea906c41SOllivier Robert  * support PPSAPI, upgrade Copyright to Berkeley style
195ea906c41SOllivier Robert  *
196a151a66cSOllivier Robert  * Revision 4.6  1999/11/28 09:13:49  kardel
197a151a66cSOllivier Robert  * RECON_4_0_98F
198a151a66cSOllivier Robert  *
199c0b746e5SOllivier Robert  * Revision 4.5  1998/06/14 21:09:34  kardel
200c0b746e5SOllivier Robert  * Sun acc cleanup
201c0b746e5SOllivier Robert  *
202c0b746e5SOllivier Robert  * Revision 4.4  1998/06/13 12:00:38  kardel
203c0b746e5SOllivier Robert  * fix SYSV clock name clash
204c0b746e5SOllivier Robert  *
205c0b746e5SOllivier Robert  * Revision 4.3  1998/06/12 15:22:26  kardel
206c0b746e5SOllivier Robert  * fix prototypes
207c0b746e5SOllivier Robert  *
208c0b746e5SOllivier Robert  * Revision 4.2  1998/06/12 09:13:24  kardel
209c0b746e5SOllivier Robert  * conditional compile macros fixed
210c0b746e5SOllivier Robert  * printf prototype
211c0b746e5SOllivier Robert  *
212c0b746e5SOllivier Robert  * Revision 4.1  1998/05/24 09:39:51  kardel
213c0b746e5SOllivier Robert  * implementation of the new IO handling model
214c0b746e5SOllivier Robert  *
215c0b746e5SOllivier Robert  * Revision 4.0  1998/04/10 19:45:27  kardel
216c0b746e5SOllivier Robert  * Start 4.0 release version numbering
217c0b746e5SOllivier Robert  *
218c0b746e5SOllivier Robert  * from V3 1.8 log info deleted 1998/04/11 kardel
219c0b746e5SOllivier Robert  */
220