refclock_tpro.c revision 1.1.1.2 
1/*	$NetBSD: refclock_tpro.c,v 1.1.1.2 2012/01/31 21:25:47 kardel Exp $	*/
2
3/*
4 * refclock_tpro - clock driver for the KSI/Odetics TPRO-S IRIG-B reader
5 */
6
7#ifdef HAVE_CONFIG_H
8#include <config.h>
9#endif
10
11#if defined(REFCLOCK) && defined(CLOCK_TPRO)
12
13#include "ntpd.h"
14#include "ntp_io.h"
15#include "ntp_refclock.h"
16#include "ntp_unixtime.h"
17#include "sys/tpro.h"
18#include "ntp_stdlib.h"
19
20#include <stdio.h>
21#include <ctype.h>
22
23/*
24 * This driver supports the KSI/Odetecs TPRO-S IRIG-B reader and TPRO-
25 * SAT GPS receiver for the Sun Microsystems SBus. It requires that the
26 * tpro.o device driver be installed and loaded.
27 */
28
29/*
30 * TPRO interface definitions
31 */
32#define	DEVICE		 "/dev/tpro%d" /* device name and unit */
33#define	PRECISION	(-20)	/* precision assumed (1 us) */
34#define	REFID		"IRIG"	/* reference ID */
35#define	DESCRIPTION	"KSI/Odetics TPRO/S IRIG Interface" /* WRU */
36
37/*
38 * Unit control structure
39 */
40struct tprounit {
41	struct	tproval tprodata; /* data returned from tpro read */
42};
43
44/*
45 * Function prototypes
46 */
47static	int	tpro_start	(int, struct peer *);
48static	void	tpro_shutdown	(int, struct peer *);
49static	void	tpro_poll	(int unit, struct peer *);
50
51/*
52 * Transfer vector
53 */
54struct	refclock refclock_tpro = {
55	tpro_start,		/* start up driver */
56	tpro_shutdown,		/* shut down driver */
57	tpro_poll,		/* transmit poll message */
58	noentry,		/* not used (old tpro_control) */
59	noentry,		/* initialize driver (not used) */
60	noentry,		/* not used (old tpro_buginfo) */
61	NOFLAGS			/* not used */
62};
63
64
65/*
66 * tpro_start - open the TPRO device and initialize data for processing
67 */
68static int
69tpro_start(
70	int unit,
71	struct peer *peer
72	)
73{
74	register struct tprounit *up;
75	struct refclockproc *pp;
76	char device[20];
77	int fd;
78
79	/*
80	 * Open TPRO device
81	 */
82	snprintf(device, sizeof(device), DEVICE, unit);
83	fd = open(device, O_RDONLY | O_NDELAY, 0777);
84	if (fd == -1) {
85		msyslog(LOG_ERR, "tpro_start: open of %s: %m", device);
86		return (0);
87	}
88
89	/*
90	 * Allocate and initialize unit structure
91	 */
92	up = emalloc(sizeof(*up));
93	memset(up, 0, sizeof(*up));
94	pp = peer->procptr;
95	pp->io.clock_recv = noentry;
96	pp->io.srcclock = (caddr_t)peer;
97	pp->io.datalen = 0;
98	pp->io.fd = fd;
99	pp->unitptr = (caddr_t)up;
100
101	/*
102	 * Initialize miscellaneous peer variables
103	 */
104	peer->precision = PRECISION;
105	peer->burst = NSTAGE;
106	pp->clockdesc = DESCRIPTION;
107	memcpy((char *)&pp->refid, REFID, 4);
108	return (1);
109}
110
111
112/*
113 * tpro_shutdown - shut down the clock
114 */
115static void
116tpro_shutdown(
117	int unit,
118	struct peer *peer
119	)
120{
121	register struct tprounit *up;
122	struct refclockproc *pp;
123
124	pp = peer->procptr;
125	up = (struct tprounit *)pp->unitptr;
126	io_closeclock(&pp->io);
127	if (NULL != up)
128		free(up);
129}
130
131
132/*
133 * tpro_poll - called by the transmit procedure
134 */
135static void
136tpro_poll(
137	int unit,
138	struct peer *peer
139	)
140{
141	register struct tprounit *up;
142	struct refclockproc *pp;
143	struct tproval *tp;
144
145	/*
146	 * This is the main routine. It snatches the time from the TPRO
147	 * board and tacks on a local timestamp.
148	 */
149	pp = peer->procptr;
150	up = (struct tprounit *)pp->unitptr;
151
152	tp = &up->tprodata;
153	if (read(pp->io.fd, (char *)tp, sizeof(struct tproval)) < 0) {
154		refclock_report(peer, CEVNT_FAULT);
155		return;
156	}
157	get_systime(&pp->lastrec);
158	pp->polls++;
159
160	/*
161	 * We get down to business, check the timecode format and decode
162	 * its contents. If the timecode has invalid length or is not in
163	 * proper format, we declare bad format and exit. Note: we
164	 * can't use the sec/usec conversion produced by the driver,
165	 * since the year may be suspect. All format error checking is
166	 * done by the sprintf() and sscanf() routines.
167	 *
168	 * Note that the refclockproc usec member has now become nsec.
169	 * We could either multiply the read-in usec value by 1000 or
170	 * we could pad the written string appropriately and read the
171	 * resulting value in already scaled.
172	 */
173	snprintf(pp->a_lastcode, sizeof(pp->a_lastcode),
174		 "%1x%1x%1x %1x%1x:%1x%1x:%1x%1x.%1x%1x%1x%1x%1x%1x %1x",
175		 tp->day100, tp->day10, tp->day1, tp->hour10, tp->hour1,
176		 tp->min10, tp->min1, tp->sec10, tp->sec1, tp->ms100,
177		 tp->ms10, tp->ms1, tp->usec100, tp->usec10, tp->usec1,
178		 tp->status);
179	pp->lencode = strlen(pp->a_lastcode);
180#ifdef DEBUG
181	if (debug)
182		printf("tpro: time %s timecode %d %s\n",
183		   ulfptoa(&pp->lastrec, 6), pp->lencode,
184		   pp->a_lastcode);
185#endif
186	if (sscanf(pp->a_lastcode, "%3d %2d:%2d:%2d.%6ld", &pp->day,
187	    &pp->hour, &pp->minute, &pp->second, &pp->nsec)
188	    != 5) {
189		refclock_report(peer, CEVNT_BADTIME);
190		return;
191	}
192	pp->nsec *= 1000;	/* Convert usec to nsec */
193	if (!tp->status & 0x3)
194		pp->leap = LEAP_NOTINSYNC;
195	else
196		pp->leap = LEAP_NOWARNING;
197	if (!refclock_process(pp)) {
198		refclock_report(peer, CEVNT_BADTIME);
199		return;
200	}
201	if (peer->burst > 0)
202		return;
203	if (pp->coderecv == pp->codeproc) {
204		refclock_report(peer, CEVNT_TIMEOUT);
205		return;
206	}
207	pp->lastref = pp->lastrec;
208	record_clock_stats(&peer->srcadr, pp->a_lastcode);
209	refclock_receive(peer);
210	peer->burst = NSTAGE;
211}
212
213#else
214int refclock_tpro_bs;
215#endif /* REFCLOCK */
216