1 /* $NetBSD: refclock_parse.c,v 1.16 2015/07/10 14:20:33 christos Exp $ */ 2 3 /* 4 * /src/NTP/REPOSITORY/ntp4-dev/ntpd/refclock_parse.c,v 4.81 2009/05/01 10:15:29 kardel RELEASE_20090105_A 5 * 6 * refclock_parse.c,v 4.81 2009/05/01 10:15:29 kardel RELEASE_20090105_A 7 * 8 * generic reference clock driver for several DCF/GPS/MSF/... receivers 9 * 10 * PPS notes: 11 * On systems that support PPSAPI (RFC2783) PPSAPI is the 12 * preferred interface. 13 * 14 * Optionally make use of a STREAMS module for input processing where 15 * available and configured. This STREAMS module reduces the time 16 * stamp latency for serial and PPS events. 17 * Currently the STREAMS module is only available for Suns running 18 * SunOS 4.x and SunOS5.x. 19 * 20 * Copyright (c) 1995-2015 by Frank Kardel <kardel <AT> ntp.org> 21 * Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universitaet Erlangen-Nuernberg, Germany 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the above copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. Neither the name of the author nor the names of its contributors 32 * may be used to endorse or promote products derived from this software 33 * without specific prior written permission. 34 * 35 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 36 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 38 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 39 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 40 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 41 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 42 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 43 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 44 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 45 * SUCH DAMAGE. 46 * 47 */ 48 49 #ifdef HAVE_CONFIG_H 50 # include "config.h" 51 #endif 52 53 #include "ntp_types.h" 54 55 #if defined(REFCLOCK) && defined(CLOCK_PARSE) 56 57 /* 58 * This driver currently provides the support for 59 * - Meinberg receiver DCF77 PZF535 (TCXO version) (DCF) 60 * - Meinberg receiver DCF77 PZF535 (OCXO version) (DCF) 61 * - Meinberg receiver DCF77 PZF509 (DCF) 62 * - Meinberg receiver DCF77 AM receivers (e.g. C51) (DCF) 63 * - IGEL CLOCK (DCF) 64 * - ELV DCF7000 (DCF) 65 * - Schmid clock (DCF) 66 * - Conrad DCF77 receiver module (DCF) 67 * - FAU DCF77 NTP receiver (TimeBrick) (DCF) 68 * - WHARTON 400A Series clock (DCF) 69 * 70 * - Meinberg GPS receivers (GPS) 71 * - Trimble (TSIP and TAIP protocol) (GPS) 72 * 73 * - RCC8000 MSF Receiver (MSF) 74 * - VARITEXT clock (MSF) 75 */ 76 77 /* 78 * Meinberg receivers are usually connected via a 79 * 9600/7E1 or 19200/8N1 serial line. 80 * 81 * The Meinberg GPS receivers also have a special NTP time stamp 82 * format. The firmware release is Uni-Erlangen. 83 * 84 * Meinberg generic receiver setup: 85 * output time code every second 86 * Baud rate 9600 7E2S 87 * 88 * Meinberg GPS receiver setup: 89 * output time code every second 90 * Baudrate 19200 8N1 91 * 92 * This software supports the standard data formats used 93 * in Meinberg receivers. 94 * 95 * Special software versions are only sensible for the 96 * oldest GPS receiver, GPS16x. For newer receiver types 97 * the output string format can be configured at the device, 98 * and the device name is generally GPSxxx instead of GPS16x. 99 * 100 * Meinberg can be reached via: http://www.meinberg.de/ 101 */ 102 103 #include "ntpd.h" 104 #include "ntp_refclock.h" 105 #include "timevalops.h" /* includes <sys/time.h> */ 106 #include "ntp_control.h" 107 #include "ntp_string.h" 108 109 #include <stdio.h> 110 #include <ctype.h> 111 #ifndef TM_IN_SYS_TIME 112 # include <time.h> 113 #endif 114 115 #ifdef HAVE_UNISTD_H 116 # include <unistd.h> 117 #endif 118 119 #if !defined(STREAM) && !defined(HAVE_SYSV_TTYS) && !defined(HAVE_BSD_TTYS) && !defined(HAVE_TERMIOS) 120 # include "Bletch: Define one of {STREAM,HAVE_SYSV_TTYS,HAVE_TERMIOS}" 121 #endif 122 123 #ifdef STREAM 124 # include <sys/stream.h> 125 # include <sys/stropts.h> 126 #endif 127 128 #ifdef HAVE_TERMIOS 129 # include <termios.h> 130 # define TTY_GETATTR(_FD_, _ARG_) tcgetattr((_FD_), (_ARG_)) 131 # define TTY_SETATTR(_FD_, _ARG_) tcsetattr((_FD_), TCSANOW, (_ARG_)) 132 # undef HAVE_SYSV_TTYS 133 #endif 134 135 #ifdef HAVE_SYSV_TTYS 136 # define TTY_GETATTR(_FD_, _ARG_) ioctl((_FD_), TCGETA, (_ARG_)) 137 # define TTY_SETATTR(_FD_, _ARG_) ioctl((_FD_), TCSETAW, (_ARG_)) 138 #endif 139 140 #ifdef HAVE_BSD_TTYS 141 /* #error CURRENTLY NO BSD TTY SUPPORT */ 142 # include "Bletch: BSD TTY not currently supported" 143 #endif 144 145 #ifdef HAVE_SYS_IOCTL_H 146 # include <sys/ioctl.h> 147 #endif 148 149 #ifdef HAVE_PPSAPI 150 # include "ppsapi_timepps.h" 151 # include "refclock_atom.h" 152 #endif 153 154 #ifdef PPS 155 # ifdef HAVE_SYS_PPSCLOCK_H 156 # include <sys/ppsclock.h> 157 # endif 158 # ifdef HAVE_TIO_SERIAL_STUFF 159 # include <linux/serial.h> 160 # endif 161 #endif 162 163 # define BUFFER_SIZE(_BUF, _PTR) ((int)((_BUF) + sizeof(_BUF) - (_PTR))) 164 # define BUFFER_SIZES(_BUF, _PTR, _SZ) ((int)((_BUF) + (_SZ) - (_PTR))) 165 166 /* 167 * document type of PPS interfacing - copy of ifdef mechanism in local_input() 168 */ 169 #undef PPS_METHOD 170 171 #ifdef HAVE_PPSAPI 172 #define PPS_METHOD "PPS API" 173 #else 174 #ifdef TIOCDCDTIMESTAMP 175 #define PPS_METHOD "TIOCDCDTIMESTAMP" 176 #else /* TIOCDCDTIMESTAMP */ 177 #if defined(HAVE_STRUCT_PPSCLOCKEV) && (defined(HAVE_CIOGETEV) || defined(HAVE_TIOCGPPSEV)) 178 #ifdef HAVE_CIOGETEV 179 #define PPS_METHOD "CIOGETEV" 180 #endif 181 #ifdef HAVE_TIOCGPPSEV 182 #define PPS_METHOD "TIOCGPPSEV" 183 #endif 184 #endif 185 #endif /* TIOCDCDTIMESTAMP */ 186 #endif /* HAVE_PPSAPI */ 187 188 /* 189 * COND_DEF can be conditionally defined as DEF or 0. If defined as DEF 190 * then some more parse-specific variables are flagged to be printed with 191 * "ntpq -c cv <assid>". This can be lengthy, so by default COND_DEF 192 * should be defined as 0. 193 */ 194 #if 0 195 # define COND_DEF DEF // enable this for testing 196 #else 197 # define COND_DEF 0 // enable this by default 198 #endif 199 200 #include "ntp_io.h" 201 #include "ntp_stdlib.h" 202 203 #include "parse.h" 204 #include "mbg_gps166.h" 205 #include "trimble.h" 206 #include "binio.h" 207 #include "ascii.h" 208 #include "ieee754io.h" 209 #include "recvbuff.h" 210 211 static char rcsid[] = "refclock_parse.c,v 4.81 2009/05/01 10:15:29 kardel RELEASE_20090105_A+POWERUPTRUST"; 212 213 /**=========================================================================== 214 ** external interface to ntp mechanism 215 **/ 216 217 static int parse_start (int, struct peer *); 218 static void parse_shutdown (int, struct peer *); 219 static void parse_poll (int, struct peer *); 220 static void parse_control (int, const struct refclockstat *, struct refclockstat *, struct peer *); 221 222 struct refclock refclock_parse = { 223 parse_start, 224 parse_shutdown, 225 parse_poll, 226 parse_control, 227 noentry, 228 noentry, 229 NOFLAGS 230 }; 231 232 /* 233 * Definitions 234 */ 235 #define MAXUNITS 4 /* maximum number of "PARSE" units permitted */ 236 #define PARSEDEVICE "/dev/refclock-%d" /* device to open %d is unit number */ 237 #define PARSEPPSDEVICE "/dev/refclockpps-%d" /* optional pps device to open %d is unit number */ 238 239 #undef ABS 240 #define ABS(_X_) (((_X_) < 0) ? -(_X_) : (_X_)) 241 242 #define PARSE_HARDPPS_DISABLE 0 243 #define PARSE_HARDPPS_ENABLE 1 244 245 /**=========================================================================== 246 ** function vector for dynamically binding io handling mechanism 247 **/ 248 249 struct parseunit; /* to keep inquiring minds happy */ 250 251 typedef struct bind 252 { 253 const char *bd_description; /* name of type of binding */ 254 int (*bd_init) (struct parseunit *); /* initialize */ 255 void (*bd_end) (struct parseunit *); /* end */ 256 int (*bd_setcs) (struct parseunit *, parsectl_t *); /* set character size */ 257 int (*bd_disable) (struct parseunit *); /* disable */ 258 int (*bd_enable) (struct parseunit *); /* enable */ 259 int (*bd_getfmt) (struct parseunit *, parsectl_t *); /* get format */ 260 int (*bd_setfmt) (struct parseunit *, parsectl_t *); /* setfmt */ 261 int (*bd_timecode) (struct parseunit *, parsectl_t *); /* get time code */ 262 void (*bd_receive) (struct recvbuf *); /* receive operation */ 263 int (*bd_io_input) (struct recvbuf *); /* input operation */ 264 } bind_t; 265 266 #define PARSE_END(_X_) (*(_X_)->binding->bd_end)(_X_) 267 #define PARSE_SETCS(_X_, _CS_) (*(_X_)->binding->bd_setcs)(_X_, _CS_) 268 #define PARSE_ENABLE(_X_) (*(_X_)->binding->bd_enable)(_X_) 269 #define PARSE_DISABLE(_X_) (*(_X_)->binding->bd_disable)(_X_) 270 #define PARSE_GETFMT(_X_, _DCT_) (*(_X_)->binding->bd_getfmt)(_X_, _DCT_) 271 #define PARSE_SETFMT(_X_, _DCT_) (*(_X_)->binding->bd_setfmt)(_X_, _DCT_) 272 #define PARSE_GETTIMECODE(_X_, _DCT_) (*(_X_)->binding->bd_timecode)(_X_, _DCT_) 273 274 /* 275 * special handling flags 276 */ 277 #define PARSE_F_PPSONSECOND 0x00000001 /* PPS pulses are on second */ 278 #define PARSE_F_POWERUPTRUST 0x00000100 /* POWERUP state ist trusted for */ 279 /* trusttime after SYNC was seen */ 280 /**=========================================================================== 281 ** error message regression handling 282 ** 283 ** there are quite a few errors that can occur in rapid succession such as 284 ** noisy input data or no data at all. in order to reduce the amount of 285 ** syslog messages in such case, we are using a backoff algorithm. We limit 286 ** the number of error messages of a certain class to 1 per time unit. if a 287 ** configurable number of messages is displayed that way, we move on to the 288 ** next time unit / count for that class. a count of messages that have been 289 ** suppressed is held and displayed whenever a corresponding message is 290 ** displayed. the time units for a message class will also be displayed. 291 ** whenever an error condition clears we reset the error message state, 292 ** thus we would still generate much output on pathological conditions 293 ** where the system oscillates between OK and NOT OK states. coping 294 ** with that condition is currently considered too complicated. 295 **/ 296 297 #define ERR_ALL (unsigned)~0 /* "all" errors */ 298 #define ERR_BADDATA (unsigned)0 /* unusable input data/conversion errors */ 299 #define ERR_NODATA (unsigned)1 /* no input data */ 300 #define ERR_BADIO (unsigned)2 /* read/write/select errors */ 301 #define ERR_BADSTATUS (unsigned)3 /* unsync states */ 302 #define ERR_BADEVENT (unsigned)4 /* non nominal events */ 303 #define ERR_INTERNAL (unsigned)5 /* internal error */ 304 #define ERR_CNT (unsigned)(ERR_INTERNAL+1) 305 306 #define ERR(_X_) if (list_err(parse, (_X_))) 307 308 struct errorregression 309 { 310 u_long err_count; /* number of repititions per class */ 311 u_long err_delay; /* minimum delay between messages */ 312 }; 313 314 static struct errorregression 315 err_baddata[] = /* error messages for bad input data */ 316 { 317 { 1, 0 }, /* output first message immediately */ 318 { 5, 60 }, /* output next five messages in 60 second intervals */ 319 { 3, 3600 }, /* output next 3 messages in hour intervals */ 320 { 0, 12*3600 } /* repeat messages only every 12 hours */ 321 }; 322 323 static struct errorregression 324 err_nodata[] = /* error messages for missing input data */ 325 { 326 { 1, 0 }, /* output first message immediately */ 327 { 5, 60 }, /* output next five messages in 60 second intervals */ 328 { 3, 3600 }, /* output next 3 messages in hour intervals */ 329 { 0, 12*3600 } /* repeat messages only every 12 hours */ 330 }; 331 332 static struct errorregression 333 err_badstatus[] = /* unsynchronized state messages */ 334 { 335 { 1, 0 }, /* output first message immediately */ 336 { 5, 60 }, /* output next five messages in 60 second intervals */ 337 { 3, 3600 }, /* output next 3 messages in hour intervals */ 338 { 0, 12*3600 } /* repeat messages only every 12 hours */ 339 }; 340 341 static struct errorregression 342 err_badio[] = /* io failures (bad reads, selects, ...) */ 343 { 344 { 1, 0 }, /* output first message immediately */ 345 { 5, 60 }, /* output next five messages in 60 second intervals */ 346 { 5, 3600 }, /* output next 3 messages in hour intervals */ 347 { 0, 12*3600 } /* repeat messages only every 12 hours */ 348 }; 349 350 static struct errorregression 351 err_badevent[] = /* non nominal events */ 352 { 353 { 20, 0 }, /* output first message immediately */ 354 { 6, 60 }, /* output next five messages in 60 second intervals */ 355 { 5, 3600 }, /* output next 3 messages in hour intervals */ 356 { 0, 12*3600 } /* repeat messages only every 12 hours */ 357 }; 358 359 static struct errorregression 360 err_internal[] = /* really bad things - basically coding/OS errors */ 361 { 362 { 0, 0 }, /* output all messages immediately */ 363 }; 364 365 static struct errorregression * 366 err_tbl[] = 367 { 368 err_baddata, 369 err_nodata, 370 err_badio, 371 err_badstatus, 372 err_badevent, 373 err_internal 374 }; 375 376 struct errorinfo 377 { 378 u_long err_started; /* begin time (ntp) of error condition */ 379 u_long err_last; /* last time (ntp) error occurred */ 380 u_long err_cnt; /* number of error repititions */ 381 u_long err_suppressed; /* number of suppressed messages */ 382 struct errorregression *err_stage; /* current error stage */ 383 }; 384 385 /**=========================================================================== 386 ** refclock instance data 387 **/ 388 389 struct parseunit 390 { 391 /* 392 * NTP management 393 */ 394 struct peer *peer; /* backlink to peer structure - refclock inactive if 0 */ 395 struct refclockproc *generic; /* backlink to refclockproc structure */ 396 397 /* 398 * PARSE io 399 */ 400 bind_t *binding; /* io handling binding */ 401 402 /* 403 * parse state 404 */ 405 parse_t parseio; /* io handling structure (user level parsing) */ 406 407 /* 408 * type specific parameters 409 */ 410 struct parse_clockinfo *parse_type; /* link to clock description */ 411 412 /* 413 * clock state handling/reporting 414 */ 415 u_char flags; /* flags (leap_control) */ 416 u_long lastchange; /* time (ntp) when last state change accured */ 417 u_long statetime[CEVNT_MAX+1]; /* accumulated time of clock states */ 418 u_long pollneeddata; /* current_time(!=0) for receive sample expected in PPS mode */ 419 u_short lastformat; /* last format used */ 420 u_long lastsync; /* time (ntp) when clock was last seen fully synchronized */ 421 u_long maxunsync; /* max time in seconds a receiver is trusted after loosing synchronisation */ 422 double ppsphaseadjust; /* phase adjustment of PPS time stamp */ 423 u_long lastmissed; /* time (ntp) when poll didn't get data (powerup heuristic) */ 424 u_long ppsserial; /* magic cookie for ppsclock serials (avoids stale ppsclock data) */ 425 int ppsfd; /* fd to ise for PPS io */ 426 #ifdef HAVE_PPSAPI 427 int hardppsstate; /* current hard pps state */ 428 struct refclock_atom atom; /* PPSAPI structure */ 429 #endif 430 parsetime_t timedata; /* last (parse module) data */ 431 void *localdata; /* optional local, receiver-specific data */ 432 unsigned long localstate; /* private local state */ 433 struct errorinfo errors[ERR_CNT]; /* error state table for suppressing excessive error messages */ 434 struct ctl_var *kv; /* additional pseudo variables */ 435 u_long laststatistic; /* time when staticstics where output */ 436 }; 437 438 439 /**=========================================================================== 440 ** Clockinfo section all parameter for specific clock types 441 ** includes NTP parameters, TTY parameters and IO handling parameters 442 **/ 443 444 static void poll_dpoll (struct parseunit *); 445 static void poll_poll (struct peer *); 446 static int poll_init (struct parseunit *); 447 448 typedef struct poll_info 449 { 450 u_long rate; /* poll rate - once every "rate" seconds - 0 off */ 451 const char *string; /* string to send for polling */ 452 u_long count; /* number of characters in string */ 453 } poll_info_t; 454 455 #define NO_CL_FLAGS 0 456 #define NO_POLL 0 457 #define NO_INIT 0 458 #define NO_END 0 459 #define NO_EVENT 0 460 #define NO_LCLDATA 0 461 #define NO_MESSAGE 0 462 #define NO_PPSDELAY 0 463 464 #define DCF_ID "DCF" /* generic DCF */ 465 #define DCF_A_ID "DCFa" /* AM demodulation */ 466 #define DCF_P_ID "DCFp" /* psuedo random phase shift */ 467 #define GPS_ID "GPS" /* GPS receiver */ 468 469 #define NOCLOCK_ROOTDELAY 0.0 470 #define NOCLOCK_BASEDELAY 0.0 471 #define NOCLOCK_DESCRIPTION 0 472 #define NOCLOCK_MAXUNSYNC 0 473 #define NOCLOCK_CFLAG 0 474 #define NOCLOCK_IFLAG 0 475 #define NOCLOCK_OFLAG 0 476 #define NOCLOCK_LFLAG 0 477 #define NOCLOCK_ID "TILT" 478 #define NOCLOCK_POLL NO_POLL 479 #define NOCLOCK_INIT NO_INIT 480 #define NOCLOCK_END NO_END 481 #define NOCLOCK_DATA NO_LCLDATA 482 #define NOCLOCK_FORMAT "" 483 #define NOCLOCK_TYPE CTL_SST_TS_UNSPEC 484 #define NOCLOCK_SAMPLES 0 485 #define NOCLOCK_KEEP 0 486 487 #define DCF_TYPE CTL_SST_TS_LF 488 #define GPS_TYPE CTL_SST_TS_UHF 489 490 /* 491 * receiver specific constants 492 */ 493 #define MBG_SPEED (B9600) 494 #define MBG_CFLAG (CS7|PARENB|CREAD|CLOCAL|HUPCL|CSTOPB) 495 #define MBG_IFLAG (IGNBRK|IGNPAR|ISTRIP) 496 #define MBG_OFLAG 0 497 #define MBG_LFLAG 0 498 #define MBG_FLAGS PARSE_F_PPSONSECOND 499 500 /* 501 * Meinberg DCF77 receivers 502 */ 503 #define DCFUA31_ROOTDELAY 0.0 /* 0 */ 504 #define DCFUA31_BASEDELAY 0.010 /* 10.7421875ms: 10 ms (+/- 3 ms) */ 505 #define DCFUA31_DESCRIPTION "Meinberg DCF77 C51 or compatible" 506 #define DCFUA31_MAXUNSYNC 60*30 /* only trust clock for 1/2 hour */ 507 #define DCFUA31_SPEED MBG_SPEED 508 #define DCFUA31_CFLAG MBG_CFLAG 509 #define DCFUA31_IFLAG MBG_IFLAG 510 #define DCFUA31_OFLAG MBG_OFLAG 511 #define DCFUA31_LFLAG MBG_LFLAG 512 #define DCFUA31_SAMPLES 5 513 #define DCFUA31_KEEP 3 514 #define DCFUA31_FORMAT "Meinberg Standard" 515 516 /* 517 * Meinberg DCF PZF535/TCXO (FM/PZF) receiver 518 */ 519 #define DCFPZF535_ROOTDELAY 0.0 520 #define DCFPZF535_BASEDELAY 0.001968 /* 1.968ms +- 104us (oscilloscope) - relative to start (end of STX) */ 521 #define DCFPZF535_DESCRIPTION "Meinberg DCF PZF 535/509 / TCXO" 522 #define DCFPZF535_MAXUNSYNC 60*60*12 /* only trust clock for 12 hours 523 * @ 5e-8df/f we have accumulated 524 * at most 2.16 ms (thus we move to 525 * NTP synchronisation */ 526 #define DCFPZF535_SPEED MBG_SPEED 527 #define DCFPZF535_CFLAG MBG_CFLAG 528 #define DCFPZF535_IFLAG MBG_IFLAG 529 #define DCFPZF535_OFLAG MBG_OFLAG 530 #define DCFPZF535_LFLAG MBG_LFLAG 531 #define DCFPZF535_SAMPLES 5 532 #define DCFPZF535_KEEP 3 533 #define DCFPZF535_FORMAT "Meinberg Standard" 534 535 /* 536 * Meinberg DCF PZF535/OCXO receiver 537 */ 538 #define DCFPZF535OCXO_ROOTDELAY 0.0 539 #define DCFPZF535OCXO_BASEDELAY 0.001968 /* 1.968ms +- 104us (oscilloscope) - relative to start (end of STX) */ 540 #define DCFPZF535OCXO_DESCRIPTION "Meinberg DCF PZF 535/509 / OCXO" 541 #define DCFPZF535OCXO_MAXUNSYNC 60*60*96 /* only trust clock for 4 days 542 * @ 5e-9df/f we have accumulated 543 * at most an error of 1.73 ms 544 * (thus we move to NTP synchronisation) */ 545 #define DCFPZF535OCXO_SPEED MBG_SPEED 546 #define DCFPZF535OCXO_CFLAG MBG_CFLAG 547 #define DCFPZF535OCXO_IFLAG MBG_IFLAG 548 #define DCFPZF535OCXO_OFLAG MBG_OFLAG 549 #define DCFPZF535OCXO_LFLAG MBG_LFLAG 550 #define DCFPZF535OCXO_SAMPLES 5 551 #define DCFPZF535OCXO_KEEP 3 552 #define DCFPZF535OCXO_FORMAT "Meinberg Standard" 553 554 /* 555 * Meinberg GPS receivers 556 */ 557 static void gps16x_message (struct parseunit *, parsetime_t *); 558 static int gps16x_poll_init (struct parseunit *); 559 560 #define GPS16X_ROOTDELAY 0.0 /* nothing here */ 561 #define GPS16X_BASEDELAY 0.001968 /* XXX to be fixed ! 1.968ms +- 104us (oscilloscope) - relative to start (end of STX) */ 562 #define GPS16X_DESCRIPTION "Meinberg GPS receiver" 563 #define GPS16X_MAXUNSYNC 60*60*96 /* only trust clock for 4 days 564 * @ 5e-9df/f we have accumulated 565 * at most an error of 1.73 ms 566 * (thus we move to NTP synchronisation) */ 567 #define GPS16X_SPEED B19200 568 #define GPS16X_CFLAG (CS8|CREAD|CLOCAL|HUPCL) 569 #define GPS16X_IFLAG (IGNBRK|IGNPAR) 570 #define GPS16X_OFLAG MBG_OFLAG 571 #define GPS16X_LFLAG MBG_LFLAG 572 #define GPS16X_POLLRATE 6 573 #define GPS16X_POLLCMD "" 574 #define GPS16X_CMDSIZE 0 575 576 static poll_info_t gps16x_pollinfo = { GPS16X_POLLRATE, GPS16X_POLLCMD, GPS16X_CMDSIZE }; 577 578 #define GPS16X_INIT gps16x_poll_init 579 #define GPS16X_POLL 0 580 #define GPS16X_END 0 581 #define GPS16X_DATA ((void *)(&gps16x_pollinfo)) 582 #define GPS16X_MESSAGE gps16x_message 583 #define GPS16X_ID GPS_ID 584 #define GPS16X_FORMAT "Meinberg GPS Extended" 585 #define GPS16X_SAMPLES 5 586 #define GPS16X_KEEP 3 587 588 /* 589 * ELV DCF7000 Wallclock-Receiver/Switching Clock (Kit) 590 * 591 * This is really not the hottest clock - but before you have nothing ... 592 */ 593 #define DCF7000_ROOTDELAY 0.0 /* 0 */ 594 #define DCF7000_BASEDELAY 0.405 /* slow blow */ 595 #define DCF7000_DESCRIPTION "ELV DCF7000" 596 #define DCF7000_MAXUNSYNC (60*5) /* sorry - but it just was not build as a clock */ 597 #define DCF7000_SPEED (B9600) 598 #define DCF7000_CFLAG (CS8|CREAD|PARENB|PARODD|CLOCAL|HUPCL) 599 #define DCF7000_IFLAG (IGNBRK) 600 #define DCF7000_OFLAG 0 601 #define DCF7000_LFLAG 0 602 #define DCF7000_SAMPLES 5 603 #define DCF7000_KEEP 3 604 #define DCF7000_FORMAT "ELV DCF7000" 605 606 /* 607 * Schmid DCF Receiver Kit 608 * 609 * When the WSDCF clock is operating optimally we want the primary clock 610 * distance to come out at 300 ms. Thus, peer.distance in the WSDCF peer 611 * structure is set to 290 ms and we compute delays which are at least 612 * 10 ms long. The following are 290 ms and 10 ms expressed in u_fp format 613 */ 614 #define WS_POLLRATE 1 /* every second - watch interdependency with poll routine */ 615 #define WS_POLLCMD "\163" 616 #define WS_CMDSIZE 1 617 618 static poll_info_t wsdcf_pollinfo = { WS_POLLRATE, WS_POLLCMD, WS_CMDSIZE }; 619 620 #define WSDCF_INIT poll_init 621 #define WSDCF_POLL poll_dpoll 622 #define WSDCF_END 0 623 #define WSDCF_DATA ((void *)(&wsdcf_pollinfo)) 624 #define WSDCF_ROOTDELAY 0.0 /* 0 */ 625 #define WSDCF_BASEDELAY 0.010 /* ~ 10ms */ 626 #define WSDCF_DESCRIPTION "WS/DCF Receiver" 627 #define WSDCF_FORMAT "Schmid" 628 #define WSDCF_MAXUNSYNC (60*60) /* assume this beast hold at 1 h better than 2 ms XXX-must verify */ 629 #define WSDCF_SPEED (B1200) 630 #define WSDCF_CFLAG (CS8|CREAD|CLOCAL) 631 #define WSDCF_IFLAG 0 632 #define WSDCF_OFLAG 0 633 #define WSDCF_LFLAG 0 634 #define WSDCF_SAMPLES 5 635 #define WSDCF_KEEP 3 636 637 /* 638 * RAW DCF77 - input of DCF marks via RS232 - many variants 639 */ 640 #define RAWDCF_FLAGS 0 641 #define RAWDCF_ROOTDELAY 0.0 /* 0 */ 642 #define RAWDCF_BASEDELAY 0.258 643 #define RAWDCF_FORMAT "RAW DCF77 Timecode" 644 #define RAWDCF_MAXUNSYNC (0) /* sorry - its a true receiver - no signal - no time */ 645 #define RAWDCF_SPEED (B50) 646 #ifdef NO_PARENB_IGNPAR /* Was: defined(SYS_IRIX4) || defined(SYS_IRIX5) */ 647 /* somehow doesn't grok PARENB & IGNPAR (mj) */ 648 # define RAWDCF_CFLAG (CS8|CREAD|CLOCAL) 649 #else 650 # define RAWDCF_CFLAG (CS8|CREAD|CLOCAL|PARENB) 651 #endif 652 #ifdef RAWDCF_NO_IGNPAR /* Was: defined(SYS_LINUX) && defined(CLOCK_RAWDCF) */ 653 # define RAWDCF_IFLAG 0 654 #else 655 # define RAWDCF_IFLAG (IGNPAR) 656 #endif 657 #define RAWDCF_OFLAG 0 658 #define RAWDCF_LFLAG 0 659 #define RAWDCF_SAMPLES 20 660 #define RAWDCF_KEEP 12 661 #define RAWDCF_INIT 0 662 663 /* 664 * RAW DCF variants 665 */ 666 /* 667 * Conrad receiver 668 * 669 * simplest (cheapest) DCF clock - e. g. DCF77 receiver by Conrad 670 * (~40DM - roughly $30 ) followed by a level converter for RS232 671 */ 672 #define CONRAD_BASEDELAY 0.292 /* Conrad receiver @ 50 Baud on a Sun */ 673 #define CONRAD_DESCRIPTION "RAW DCF77 CODE (Conrad DCF77 receiver module)" 674 675 /* Gude Analog- und Digitalsystem GmbH 'Expert mouseCLOCK USB v2.0' */ 676 #define GUDE_EMC_USB_V20_SPEED (B4800) 677 #define GUDE_EMC_USB_V20_BASEDELAY 0.425 /* USB serial<->USB converter FTDI232R */ 678 #define GUDE_EMC_USB_V20_DESCRIPTION "RAW DCF77 CODE (Expert mouseCLOCK USB v2.0)" 679 680 /* 681 * TimeBrick receiver 682 */ 683 #define TIMEBRICK_BASEDELAY 0.210 /* TimeBrick @ 50 Baud on a Sun */ 684 #define TIMEBRICK_DESCRIPTION "RAW DCF77 CODE (TimeBrick)" 685 686 /* 687 * IGEL:clock receiver 688 */ 689 #define IGELCLOCK_BASEDELAY 0.258 /* IGEL:clock receiver */ 690 #define IGELCLOCK_DESCRIPTION "RAW DCF77 CODE (IGEL:clock)" 691 #define IGELCLOCK_SPEED (B1200) 692 #define IGELCLOCK_CFLAG (CS8|CREAD|HUPCL|CLOCAL) 693 694 /* 695 * RAWDCF receivers that need to be powered from DTR 696 * (like Expert mouse clock) 697 */ 698 static int rawdcf_init_1 (struct parseunit *); 699 #define RAWDCFDTRSET_DESCRIPTION "RAW DCF77 CODE (DTR SET/RTS CLR)" 700 #define RAWDCFDTRSET75_DESCRIPTION "RAW DCF77 CODE (DTR SET/RTS CLR @ 75 baud)" 701 #define RAWDCFDTRSET_INIT rawdcf_init_1 702 703 /* 704 * RAWDCF receivers that need to be powered from 705 * DTR CLR and RTS SET 706 */ 707 static int rawdcf_init_2 (struct parseunit *); 708 #define RAWDCFDTRCLRRTSSET_DESCRIPTION "RAW DCF77 CODE (DTR CLR/RTS SET)" 709 #define RAWDCFDTRCLRRTSSET75_DESCRIPTION "RAW DCF77 CODE (DTR CLR/RTS SET @ 75 baud)" 710 #define RAWDCFDTRCLRRTSSET_INIT rawdcf_init_2 711 712 /* 713 * Trimble GPS receivers (TAIP and TSIP protocols) 714 */ 715 #ifndef TRIM_POLLRATE 716 #define TRIM_POLLRATE 0 /* only true direct polling */ 717 #endif 718 719 #define TRIM_TAIPPOLLCMD ">SRM;FR_FLAG=F;EC_FLAG=F<>QTM<" 720 #define TRIM_TAIPCMDSIZE (sizeof(TRIM_TAIPPOLLCMD)-1) 721 722 static poll_info_t trimbletaip_pollinfo = { TRIM_POLLRATE, TRIM_TAIPPOLLCMD, TRIM_TAIPCMDSIZE }; 723 static int trimbletaip_init (struct parseunit *); 724 static void trimbletaip_event (struct parseunit *, int); 725 726 /* query time & UTC correction data */ 727 static char tsipquery[] = { DLE, 0x21, DLE, ETX, DLE, 0x2F, DLE, ETX }; 728 729 static poll_info_t trimbletsip_pollinfo = { TRIM_POLLRATE, tsipquery, sizeof(tsipquery) }; 730 static int trimbletsip_init (struct parseunit *); 731 static void trimbletsip_end (struct parseunit *); 732 static void trimbletsip_message (struct parseunit *, parsetime_t *); 733 static void trimbletsip_event (struct parseunit *, int); 734 735 #define TRIMBLETSIP_IDLE_TIME (300) /* 5 minutes silence at most */ 736 #define TRIMBLE_RESET_HOLDOFF TRIMBLETSIP_IDLE_TIME 737 738 #define TRIMBLETAIP_SPEED (B4800) 739 #define TRIMBLETAIP_CFLAG (CS8|CREAD|CLOCAL) 740 #define TRIMBLETAIP_IFLAG (BRKINT|IGNPAR|ISTRIP|ICRNL|IXON) 741 #define TRIMBLETAIP_OFLAG (OPOST|ONLCR) 742 #define TRIMBLETAIP_LFLAG (0) 743 744 #define TRIMBLETSIP_SPEED (B9600) 745 #define TRIMBLETSIP_CFLAG (CS8|CLOCAL|CREAD|PARENB|PARODD) 746 #define TRIMBLETSIP_IFLAG (IGNBRK) 747 #define TRIMBLETSIP_OFLAG (0) 748 #define TRIMBLETSIP_LFLAG (ICANON) 749 750 #define TRIMBLETSIP_SAMPLES 5 751 #define TRIMBLETSIP_KEEP 3 752 #define TRIMBLETAIP_SAMPLES 5 753 #define TRIMBLETAIP_KEEP 3 754 755 #define TRIMBLETAIP_FLAGS (PARSE_F_PPSONSECOND) 756 #define TRIMBLETSIP_FLAGS (TRIMBLETAIP_FLAGS) 757 758 #define TRIMBLETAIP_POLL poll_dpoll 759 #define TRIMBLETSIP_POLL poll_dpoll 760 761 #define TRIMBLETAIP_INIT trimbletaip_init 762 #define TRIMBLETSIP_INIT trimbletsip_init 763 764 #define TRIMBLETAIP_EVENT trimbletaip_event 765 766 #define TRIMBLETSIP_EVENT trimbletsip_event 767 #define TRIMBLETSIP_MESSAGE trimbletsip_message 768 769 #define TRIMBLETAIP_END 0 770 #define TRIMBLETSIP_END trimbletsip_end 771 772 #define TRIMBLETAIP_DATA ((void *)(&trimbletaip_pollinfo)) 773 #define TRIMBLETSIP_DATA ((void *)(&trimbletsip_pollinfo)) 774 775 #define TRIMBLETAIP_ID GPS_ID 776 #define TRIMBLETSIP_ID GPS_ID 777 778 #define TRIMBLETAIP_FORMAT "Trimble TAIP" 779 #define TRIMBLETSIP_FORMAT "Trimble TSIP" 780 781 #define TRIMBLETAIP_ROOTDELAY 0x0 782 #define TRIMBLETSIP_ROOTDELAY 0x0 783 784 #define TRIMBLETAIP_BASEDELAY 0.0 785 #define TRIMBLETSIP_BASEDELAY 0.020 /* GPS time message latency */ 786 787 #define TRIMBLETAIP_DESCRIPTION "Trimble GPS (TAIP) receiver" 788 #define TRIMBLETSIP_DESCRIPTION "Trimble GPS (TSIP) receiver" 789 790 #define TRIMBLETAIP_MAXUNSYNC 0 791 #define TRIMBLETSIP_MAXUNSYNC 0 792 793 #define TRIMBLETAIP_EOL '<' 794 795 /* 796 * RadioCode Clocks RCC 800 receiver 797 */ 798 #define RCC_POLLRATE 0 /* only true direct polling */ 799 #define RCC_POLLCMD "\r" 800 #define RCC_CMDSIZE 1 801 802 static poll_info_t rcc8000_pollinfo = { RCC_POLLRATE, RCC_POLLCMD, RCC_CMDSIZE }; 803 #define RCC8000_FLAGS 0 804 #define RCC8000_POLL poll_dpoll 805 #define RCC8000_INIT poll_init 806 #define RCC8000_END 0 807 #define RCC8000_DATA ((void *)(&rcc8000_pollinfo)) 808 #define RCC8000_ROOTDELAY 0.0 809 #define RCC8000_BASEDELAY 0.0 810 #define RCC8000_ID "MSF" 811 #define RCC8000_DESCRIPTION "RCC 8000 MSF Receiver" 812 #define RCC8000_FORMAT "Radiocode RCC8000" 813 #define RCC8000_MAXUNSYNC (60*60) /* should be ok for an hour */ 814 #define RCC8000_SPEED (B2400) 815 #define RCC8000_CFLAG (CS8|CREAD|CLOCAL) 816 #define RCC8000_IFLAG (IGNBRK|IGNPAR) 817 #define RCC8000_OFLAG 0 818 #define RCC8000_LFLAG 0 819 #define RCC8000_SAMPLES 5 820 #define RCC8000_KEEP 3 821 822 /* 823 * Hopf Radio clock 6021 Format 824 * 825 */ 826 #define HOPF6021_ROOTDELAY 0.0 827 #define HOPF6021_BASEDELAY 0.0 828 #define HOPF6021_DESCRIPTION "HOPF 6021" 829 #define HOPF6021_FORMAT "hopf Funkuhr 6021" 830 #define HOPF6021_MAXUNSYNC (60*60) /* should be ok for an hour */ 831 #define HOPF6021_SPEED (B9600) 832 #define HOPF6021_CFLAG (CS8|CREAD|CLOCAL) 833 #define HOPF6021_IFLAG (IGNBRK|ISTRIP) 834 #define HOPF6021_OFLAG 0 835 #define HOPF6021_LFLAG 0 836 #define HOPF6021_FLAGS 0 837 #define HOPF6021_SAMPLES 5 838 #define HOPF6021_KEEP 3 839 840 /* 841 * Diem's Computime Radio Clock Receiver 842 */ 843 #define COMPUTIME_FLAGS 0 844 #define COMPUTIME_ROOTDELAY 0.0 845 #define COMPUTIME_BASEDELAY 0.0 846 #define COMPUTIME_ID DCF_ID 847 #define COMPUTIME_DESCRIPTION "Diem's Computime receiver" 848 #define COMPUTIME_FORMAT "Diem's Computime Radio Clock" 849 #define COMPUTIME_TYPE DCF_TYPE 850 #define COMPUTIME_MAXUNSYNC (60*60) /* only trust clock for 1 hour */ 851 #define COMPUTIME_SPEED (B9600) 852 #define COMPUTIME_CFLAG (CSTOPB|CS7|CREAD|CLOCAL) 853 #define COMPUTIME_IFLAG (IGNBRK|IGNPAR|ISTRIP) 854 #define COMPUTIME_OFLAG 0 855 #define COMPUTIME_LFLAG 0 856 #define COMPUTIME_SAMPLES 5 857 #define COMPUTIME_KEEP 3 858 859 /* 860 * Varitext Radio Clock Receiver 861 */ 862 #define VARITEXT_FLAGS 0 863 #define VARITEXT_ROOTDELAY 0.0 864 #define VARITEXT_BASEDELAY 0.0 865 #define VARITEXT_ID "MSF" 866 #define VARITEXT_DESCRIPTION "Varitext receiver" 867 #define VARITEXT_FORMAT "Varitext Radio Clock" 868 #define VARITEXT_TYPE DCF_TYPE 869 #define VARITEXT_MAXUNSYNC (60*60) /* only trust clock for 1 hour */ 870 #define VARITEXT_SPEED (B9600) 871 #define VARITEXT_CFLAG (CS7|CREAD|CLOCAL|PARENB|PARODD) 872 #define VARITEXT_IFLAG (IGNPAR|IGNBRK|INPCK) /*|ISTRIP)*/ 873 #define VARITEXT_OFLAG 0 874 #define VARITEXT_LFLAG 0 875 #define VARITEXT_SAMPLES 32 876 #define VARITEXT_KEEP 20 877 878 /* 879 * SEL240x Satellite Sychronized Clock 880 */ 881 #define SEL240X_POLLRATE 0 /* only true direct polling */ 882 #define SEL240X_POLLCMD "BUB8" 883 #define SEL240X_CMDSIZE 4 884 885 static poll_info_t sel240x_pollinfo = { SEL240X_POLLRATE, 886 SEL240X_POLLCMD, 887 SEL240X_CMDSIZE }; 888 #define SEL240X_FLAGS (PARSE_F_PPSONSECOND) 889 #define SEL240X_POLL poll_dpoll 890 #define SEL240X_INIT poll_init 891 #define SEL240X_END 0 892 #define SEL240X_DATA ((void *)(&sel240x_pollinfo)) 893 #define SEL240X_ROOTDELAY 0.0 894 #define SEL240X_BASEDELAY 0.0 895 #define SEL240X_ID GPS_ID 896 #define SEL240X_DESCRIPTION "SEL240x Satellite Synchronized Clock" 897 #define SEL240X_FORMAT "SEL B8" 898 #define SEL240X_MAXUNSYNC 60*60*12 /* only trust clock for 12 hours */ 899 #define SEL240X_SPEED (B9600) 900 #define SEL240X_CFLAG (CS8|CREAD|CLOCAL) 901 #define SEL240X_IFLAG (IGNBRK|IGNPAR) 902 #define SEL240X_OFLAG (0) 903 #define SEL240X_LFLAG (0) 904 #define SEL240X_SAMPLES 5 905 #define SEL240X_KEEP 3 906 907 static struct parse_clockinfo 908 { 909 u_long cl_flags; /* operation flags (PPS interpretation, trust handling) */ 910 void (*cl_poll) (struct parseunit *); /* active poll routine */ 911 int (*cl_init) (struct parseunit *); /* active poll init routine */ 912 void (*cl_event) (struct parseunit *, int); /* special event handling (e.g. reset clock) */ 913 void (*cl_end) (struct parseunit *); /* active poll end routine */ 914 void (*cl_message) (struct parseunit *, parsetime_t *); /* process a lower layer message */ 915 void *cl_data; /* local data area for "poll" mechanism */ 916 double cl_rootdelay; /* rootdelay */ 917 double cl_basedelay; /* current offset by which the RS232 918 time code is delayed from the actual time */ 919 const char *cl_id; /* ID code */ 920 const char *cl_description; /* device name */ 921 const char *cl_format; /* fixed format */ 922 u_char cl_type; /* clock type (ntp control) */ 923 u_long cl_maxunsync; /* time to trust oscillator after losing synch */ 924 u_long cl_speed; /* terminal input & output baudrate */ 925 u_long cl_cflag; /* terminal control flags */ 926 u_long cl_iflag; /* terminal input flags */ 927 u_long cl_oflag; /* terminal output flags */ 928 u_long cl_lflag; /* terminal local flags */ 929 u_long cl_samples; /* samples for median filter */ 930 u_long cl_keep; /* samples for median filter to keep */ 931 } parse_clockinfo[] = 932 { 933 { /* mode 0 */ 934 MBG_FLAGS, 935 NO_POLL, 936 NO_INIT, 937 NO_EVENT, 938 NO_END, 939 NO_MESSAGE, 940 NO_LCLDATA, 941 DCFPZF535_ROOTDELAY, 942 DCFPZF535_BASEDELAY, 943 DCF_P_ID, 944 DCFPZF535_DESCRIPTION, 945 DCFPZF535_FORMAT, 946 DCF_TYPE, 947 DCFPZF535_MAXUNSYNC, 948 DCFPZF535_SPEED, 949 DCFPZF535_CFLAG, 950 DCFPZF535_IFLAG, 951 DCFPZF535_OFLAG, 952 DCFPZF535_LFLAG, 953 DCFPZF535_SAMPLES, 954 DCFPZF535_KEEP 955 }, 956 { /* mode 1 */ 957 MBG_FLAGS, 958 NO_POLL, 959 NO_INIT, 960 NO_EVENT, 961 NO_END, 962 NO_MESSAGE, 963 NO_LCLDATA, 964 DCFPZF535OCXO_ROOTDELAY, 965 DCFPZF535OCXO_BASEDELAY, 966 DCF_P_ID, 967 DCFPZF535OCXO_DESCRIPTION, 968 DCFPZF535OCXO_FORMAT, 969 DCF_TYPE, 970 DCFPZF535OCXO_MAXUNSYNC, 971 DCFPZF535OCXO_SPEED, 972 DCFPZF535OCXO_CFLAG, 973 DCFPZF535OCXO_IFLAG, 974 DCFPZF535OCXO_OFLAG, 975 DCFPZF535OCXO_LFLAG, 976 DCFPZF535OCXO_SAMPLES, 977 DCFPZF535OCXO_KEEP 978 }, 979 { /* mode 2 */ 980 MBG_FLAGS, 981 NO_POLL, 982 NO_INIT, 983 NO_EVENT, 984 NO_END, 985 NO_MESSAGE, 986 NO_LCLDATA, 987 DCFUA31_ROOTDELAY, 988 DCFUA31_BASEDELAY, 989 DCF_A_ID, 990 DCFUA31_DESCRIPTION, 991 DCFUA31_FORMAT, 992 DCF_TYPE, 993 DCFUA31_MAXUNSYNC, 994 DCFUA31_SPEED, 995 DCFUA31_CFLAG, 996 DCFUA31_IFLAG, 997 DCFUA31_OFLAG, 998 DCFUA31_LFLAG, 999 DCFUA31_SAMPLES, 1000 DCFUA31_KEEP 1001 }, 1002 { /* mode 3 */ 1003 MBG_FLAGS, 1004 NO_POLL, 1005 NO_INIT, 1006 NO_EVENT, 1007 NO_END, 1008 NO_MESSAGE, 1009 NO_LCLDATA, 1010 DCF7000_ROOTDELAY, 1011 DCF7000_BASEDELAY, 1012 DCF_A_ID, 1013 DCF7000_DESCRIPTION, 1014 DCF7000_FORMAT, 1015 DCF_TYPE, 1016 DCF7000_MAXUNSYNC, 1017 DCF7000_SPEED, 1018 DCF7000_CFLAG, 1019 DCF7000_IFLAG, 1020 DCF7000_OFLAG, 1021 DCF7000_LFLAG, 1022 DCF7000_SAMPLES, 1023 DCF7000_KEEP 1024 }, 1025 { /* mode 4 */ 1026 NO_CL_FLAGS, 1027 WSDCF_POLL, 1028 WSDCF_INIT, 1029 NO_EVENT, 1030 WSDCF_END, 1031 NO_MESSAGE, 1032 WSDCF_DATA, 1033 WSDCF_ROOTDELAY, 1034 WSDCF_BASEDELAY, 1035 DCF_A_ID, 1036 WSDCF_DESCRIPTION, 1037 WSDCF_FORMAT, 1038 DCF_TYPE, 1039 WSDCF_MAXUNSYNC, 1040 WSDCF_SPEED, 1041 WSDCF_CFLAG, 1042 WSDCF_IFLAG, 1043 WSDCF_OFLAG, 1044 WSDCF_LFLAG, 1045 WSDCF_SAMPLES, 1046 WSDCF_KEEP 1047 }, 1048 { /* mode 5 */ 1049 RAWDCF_FLAGS, 1050 NO_POLL, 1051 RAWDCF_INIT, 1052 NO_EVENT, 1053 NO_END, 1054 NO_MESSAGE, 1055 NO_LCLDATA, 1056 RAWDCF_ROOTDELAY, 1057 CONRAD_BASEDELAY, 1058 DCF_A_ID, 1059 CONRAD_DESCRIPTION, 1060 RAWDCF_FORMAT, 1061 DCF_TYPE, 1062 RAWDCF_MAXUNSYNC, 1063 RAWDCF_SPEED, 1064 RAWDCF_CFLAG, 1065 RAWDCF_IFLAG, 1066 RAWDCF_OFLAG, 1067 RAWDCF_LFLAG, 1068 RAWDCF_SAMPLES, 1069 RAWDCF_KEEP 1070 }, 1071 { /* mode 6 */ 1072 RAWDCF_FLAGS, 1073 NO_POLL, 1074 RAWDCF_INIT, 1075 NO_EVENT, 1076 NO_END, 1077 NO_MESSAGE, 1078 NO_LCLDATA, 1079 RAWDCF_ROOTDELAY, 1080 TIMEBRICK_BASEDELAY, 1081 DCF_A_ID, 1082 TIMEBRICK_DESCRIPTION, 1083 RAWDCF_FORMAT, 1084 DCF_TYPE, 1085 RAWDCF_MAXUNSYNC, 1086 RAWDCF_SPEED, 1087 RAWDCF_CFLAG, 1088 RAWDCF_IFLAG, 1089 RAWDCF_OFLAG, 1090 RAWDCF_LFLAG, 1091 RAWDCF_SAMPLES, 1092 RAWDCF_KEEP 1093 }, 1094 { /* mode 7 */ 1095 MBG_FLAGS, 1096 GPS16X_POLL, 1097 GPS16X_INIT, 1098 NO_EVENT, 1099 GPS16X_END, 1100 GPS16X_MESSAGE, 1101 GPS16X_DATA, 1102 GPS16X_ROOTDELAY, 1103 GPS16X_BASEDELAY, 1104 GPS16X_ID, 1105 GPS16X_DESCRIPTION, 1106 GPS16X_FORMAT, 1107 GPS_TYPE, 1108 GPS16X_MAXUNSYNC, 1109 GPS16X_SPEED, 1110 GPS16X_CFLAG, 1111 GPS16X_IFLAG, 1112 GPS16X_OFLAG, 1113 GPS16X_LFLAG, 1114 GPS16X_SAMPLES, 1115 GPS16X_KEEP 1116 }, 1117 { /* mode 8 */ 1118 RAWDCF_FLAGS, 1119 NO_POLL, 1120 NO_INIT, 1121 NO_EVENT, 1122 NO_END, 1123 NO_MESSAGE, 1124 NO_LCLDATA, 1125 RAWDCF_ROOTDELAY, 1126 IGELCLOCK_BASEDELAY, 1127 DCF_A_ID, 1128 IGELCLOCK_DESCRIPTION, 1129 RAWDCF_FORMAT, 1130 DCF_TYPE, 1131 RAWDCF_MAXUNSYNC, 1132 IGELCLOCK_SPEED, 1133 IGELCLOCK_CFLAG, 1134 RAWDCF_IFLAG, 1135 RAWDCF_OFLAG, 1136 RAWDCF_LFLAG, 1137 RAWDCF_SAMPLES, 1138 RAWDCF_KEEP 1139 }, 1140 { /* mode 9 */ 1141 TRIMBLETAIP_FLAGS, 1142 #if TRIM_POLLRATE /* DHD940515: Allow user config */ 1143 NO_POLL, 1144 #else 1145 TRIMBLETAIP_POLL, 1146 #endif 1147 TRIMBLETAIP_INIT, 1148 TRIMBLETAIP_EVENT, 1149 TRIMBLETAIP_END, 1150 NO_MESSAGE, 1151 TRIMBLETAIP_DATA, 1152 TRIMBLETAIP_ROOTDELAY, 1153 TRIMBLETAIP_BASEDELAY, 1154 TRIMBLETAIP_ID, 1155 TRIMBLETAIP_DESCRIPTION, 1156 TRIMBLETAIP_FORMAT, 1157 GPS_TYPE, 1158 TRIMBLETAIP_MAXUNSYNC, 1159 TRIMBLETAIP_SPEED, 1160 TRIMBLETAIP_CFLAG, 1161 TRIMBLETAIP_IFLAG, 1162 TRIMBLETAIP_OFLAG, 1163 TRIMBLETAIP_LFLAG, 1164 TRIMBLETAIP_SAMPLES, 1165 TRIMBLETAIP_KEEP 1166 }, 1167 { /* mode 10 */ 1168 TRIMBLETSIP_FLAGS, 1169 #if TRIM_POLLRATE /* DHD940515: Allow user config */ 1170 NO_POLL, 1171 #else 1172 TRIMBLETSIP_POLL, 1173 #endif 1174 TRIMBLETSIP_INIT, 1175 TRIMBLETSIP_EVENT, 1176 TRIMBLETSIP_END, 1177 TRIMBLETSIP_MESSAGE, 1178 TRIMBLETSIP_DATA, 1179 TRIMBLETSIP_ROOTDELAY, 1180 TRIMBLETSIP_BASEDELAY, 1181 TRIMBLETSIP_ID, 1182 TRIMBLETSIP_DESCRIPTION, 1183 TRIMBLETSIP_FORMAT, 1184 GPS_TYPE, 1185 TRIMBLETSIP_MAXUNSYNC, 1186 TRIMBLETSIP_SPEED, 1187 TRIMBLETSIP_CFLAG, 1188 TRIMBLETSIP_IFLAG, 1189 TRIMBLETSIP_OFLAG, 1190 TRIMBLETSIP_LFLAG, 1191 TRIMBLETSIP_SAMPLES, 1192 TRIMBLETSIP_KEEP 1193 }, 1194 { /* mode 11 */ 1195 NO_CL_FLAGS, 1196 RCC8000_POLL, 1197 RCC8000_INIT, 1198 NO_EVENT, 1199 RCC8000_END, 1200 NO_MESSAGE, 1201 RCC8000_DATA, 1202 RCC8000_ROOTDELAY, 1203 RCC8000_BASEDELAY, 1204 RCC8000_ID, 1205 RCC8000_DESCRIPTION, 1206 RCC8000_FORMAT, 1207 DCF_TYPE, 1208 RCC8000_MAXUNSYNC, 1209 RCC8000_SPEED, 1210 RCC8000_CFLAG, 1211 RCC8000_IFLAG, 1212 RCC8000_OFLAG, 1213 RCC8000_LFLAG, 1214 RCC8000_SAMPLES, 1215 RCC8000_KEEP 1216 }, 1217 { /* mode 12 */ 1218 HOPF6021_FLAGS, 1219 NO_POLL, 1220 NO_INIT, 1221 NO_EVENT, 1222 NO_END, 1223 NO_MESSAGE, 1224 NO_LCLDATA, 1225 HOPF6021_ROOTDELAY, 1226 HOPF6021_BASEDELAY, 1227 DCF_ID, 1228 HOPF6021_DESCRIPTION, 1229 HOPF6021_FORMAT, 1230 DCF_TYPE, 1231 HOPF6021_MAXUNSYNC, 1232 HOPF6021_SPEED, 1233 HOPF6021_CFLAG, 1234 HOPF6021_IFLAG, 1235 HOPF6021_OFLAG, 1236 HOPF6021_LFLAG, 1237 HOPF6021_SAMPLES, 1238 HOPF6021_KEEP 1239 }, 1240 { /* mode 13 */ 1241 COMPUTIME_FLAGS, 1242 NO_POLL, 1243 NO_INIT, 1244 NO_EVENT, 1245 NO_END, 1246 NO_MESSAGE, 1247 NO_LCLDATA, 1248 COMPUTIME_ROOTDELAY, 1249 COMPUTIME_BASEDELAY, 1250 COMPUTIME_ID, 1251 COMPUTIME_DESCRIPTION, 1252 COMPUTIME_FORMAT, 1253 COMPUTIME_TYPE, 1254 COMPUTIME_MAXUNSYNC, 1255 COMPUTIME_SPEED, 1256 COMPUTIME_CFLAG, 1257 COMPUTIME_IFLAG, 1258 COMPUTIME_OFLAG, 1259 COMPUTIME_LFLAG, 1260 COMPUTIME_SAMPLES, 1261 COMPUTIME_KEEP 1262 }, 1263 { /* mode 14 */ 1264 RAWDCF_FLAGS, 1265 NO_POLL, 1266 RAWDCFDTRSET_INIT, 1267 NO_EVENT, 1268 NO_END, 1269 NO_MESSAGE, 1270 NO_LCLDATA, 1271 RAWDCF_ROOTDELAY, 1272 RAWDCF_BASEDELAY, 1273 DCF_A_ID, 1274 RAWDCFDTRSET_DESCRIPTION, 1275 RAWDCF_FORMAT, 1276 DCF_TYPE, 1277 RAWDCF_MAXUNSYNC, 1278 RAWDCF_SPEED, 1279 RAWDCF_CFLAG, 1280 RAWDCF_IFLAG, 1281 RAWDCF_OFLAG, 1282 RAWDCF_LFLAG, 1283 RAWDCF_SAMPLES, 1284 RAWDCF_KEEP 1285 }, 1286 { /* mode 15 */ 1287 0, /* operation flags (io modes) */ 1288 NO_POLL, /* active poll routine */ 1289 NO_INIT, /* active poll init routine */ 1290 NO_EVENT, /* special event handling (e.g. reset clock) */ 1291 NO_END, /* active poll end routine */ 1292 NO_MESSAGE, /* process a lower layer message */ 1293 NO_LCLDATA, /* local data area for "poll" mechanism */ 1294 0, /* rootdelay */ 1295 11.0 /* bits */ / 9600, /* current offset by which the RS232 1296 time code is delayed from the actual time */ 1297 DCF_ID, /* ID code */ 1298 "WHARTON 400A Series clock", /* device name */ 1299 "WHARTON 400A Series clock Output Format 1", /* fixed format */ 1300 /* Must match a format-name in a libparse/clk_xxx.c file */ 1301 DCF_TYPE, /* clock type (ntp control) */ 1302 (1*60*60), /* time to trust oscillator after losing synch */ 1303 B9600, /* terminal input & output baudrate */ 1304 (CS8|CREAD|PARENB|CLOCAL|HUPCL),/* terminal control flags */ 1305 0, /* terminal input flags */ 1306 0, /* terminal output flags */ 1307 0, /* terminal local flags */ 1308 5, /* samples for median filter */ 1309 3, /* samples for median filter to keep */ 1310 }, 1311 { /* mode 16 - RAWDCF RTS set, DTR clr */ 1312 RAWDCF_FLAGS, 1313 NO_POLL, 1314 RAWDCFDTRCLRRTSSET_INIT, 1315 NO_EVENT, 1316 NO_END, 1317 NO_MESSAGE, 1318 NO_LCLDATA, 1319 RAWDCF_ROOTDELAY, 1320 RAWDCF_BASEDELAY, 1321 DCF_A_ID, 1322 RAWDCFDTRCLRRTSSET_DESCRIPTION, 1323 RAWDCF_FORMAT, 1324 DCF_TYPE, 1325 RAWDCF_MAXUNSYNC, 1326 RAWDCF_SPEED, 1327 RAWDCF_CFLAG, 1328 RAWDCF_IFLAG, 1329 RAWDCF_OFLAG, 1330 RAWDCF_LFLAG, 1331 RAWDCF_SAMPLES, 1332 RAWDCF_KEEP 1333 }, 1334 { /* mode 17 */ 1335 VARITEXT_FLAGS, 1336 NO_POLL, 1337 NO_INIT, 1338 NO_EVENT, 1339 NO_END, 1340 NO_MESSAGE, 1341 NO_LCLDATA, 1342 VARITEXT_ROOTDELAY, 1343 VARITEXT_BASEDELAY, 1344 VARITEXT_ID, 1345 VARITEXT_DESCRIPTION, 1346 VARITEXT_FORMAT, 1347 VARITEXT_TYPE, 1348 VARITEXT_MAXUNSYNC, 1349 VARITEXT_SPEED, 1350 VARITEXT_CFLAG, 1351 VARITEXT_IFLAG, 1352 VARITEXT_OFLAG, 1353 VARITEXT_LFLAG, 1354 VARITEXT_SAMPLES, 1355 VARITEXT_KEEP 1356 }, 1357 { /* mode 18 */ 1358 MBG_FLAGS, 1359 NO_POLL, 1360 NO_INIT, 1361 NO_EVENT, 1362 GPS16X_END, 1363 GPS16X_MESSAGE, 1364 GPS16X_DATA, 1365 GPS16X_ROOTDELAY, 1366 GPS16X_BASEDELAY, 1367 GPS16X_ID, 1368 GPS16X_DESCRIPTION, 1369 GPS16X_FORMAT, 1370 GPS_TYPE, 1371 GPS16X_MAXUNSYNC, 1372 GPS16X_SPEED, 1373 GPS16X_CFLAG, 1374 GPS16X_IFLAG, 1375 GPS16X_OFLAG, 1376 GPS16X_LFLAG, 1377 GPS16X_SAMPLES, 1378 GPS16X_KEEP 1379 }, 1380 { /* mode 19 */ 1381 RAWDCF_FLAGS, 1382 NO_POLL, 1383 RAWDCF_INIT, 1384 NO_EVENT, 1385 NO_END, 1386 NO_MESSAGE, 1387 NO_LCLDATA, 1388 RAWDCF_ROOTDELAY, 1389 GUDE_EMC_USB_V20_BASEDELAY, 1390 DCF_A_ID, 1391 GUDE_EMC_USB_V20_DESCRIPTION, 1392 RAWDCF_FORMAT, 1393 DCF_TYPE, 1394 RAWDCF_MAXUNSYNC, 1395 GUDE_EMC_USB_V20_SPEED, 1396 RAWDCF_CFLAG, 1397 RAWDCF_IFLAG, 1398 RAWDCF_OFLAG, 1399 RAWDCF_LFLAG, 1400 RAWDCF_SAMPLES, 1401 RAWDCF_KEEP 1402 }, 1403 { /* mode 20, like mode 14 but driven by 75 baud */ 1404 RAWDCF_FLAGS, 1405 NO_POLL, 1406 RAWDCFDTRSET_INIT, 1407 NO_EVENT, 1408 NO_END, 1409 NO_MESSAGE, 1410 NO_LCLDATA, 1411 RAWDCF_ROOTDELAY, 1412 RAWDCF_BASEDELAY, 1413 DCF_A_ID, 1414 RAWDCFDTRSET75_DESCRIPTION, 1415 RAWDCF_FORMAT, 1416 DCF_TYPE, 1417 RAWDCF_MAXUNSYNC, 1418 B75, 1419 RAWDCF_CFLAG, 1420 RAWDCF_IFLAG, 1421 RAWDCF_OFLAG, 1422 RAWDCF_LFLAG, 1423 RAWDCF_SAMPLES, 1424 RAWDCF_KEEP 1425 }, 1426 { /* mode 21, like mode 16 but driven by 75 baud 1427 - RAWDCF RTS set, DTR clr */ 1428 RAWDCF_FLAGS, 1429 NO_POLL, 1430 RAWDCFDTRCLRRTSSET_INIT, 1431 NO_EVENT, 1432 NO_END, 1433 NO_MESSAGE, 1434 NO_LCLDATA, 1435 RAWDCF_ROOTDELAY, 1436 RAWDCF_BASEDELAY, 1437 DCF_A_ID, 1438 RAWDCFDTRCLRRTSSET75_DESCRIPTION, 1439 RAWDCF_FORMAT, 1440 DCF_TYPE, 1441 RAWDCF_MAXUNSYNC, 1442 B75, 1443 RAWDCF_CFLAG, 1444 RAWDCF_IFLAG, 1445 RAWDCF_OFLAG, 1446 RAWDCF_LFLAG, 1447 RAWDCF_SAMPLES, 1448 RAWDCF_KEEP 1449 }, 1450 { /* mode 22 - like 2 with POWERUP trust */ 1451 MBG_FLAGS | PARSE_F_POWERUPTRUST, 1452 NO_POLL, 1453 NO_INIT, 1454 NO_EVENT, 1455 NO_END, 1456 NO_MESSAGE, 1457 NO_LCLDATA, 1458 DCFUA31_ROOTDELAY, 1459 DCFUA31_BASEDELAY, 1460 DCF_A_ID, 1461 DCFUA31_DESCRIPTION, 1462 DCFUA31_FORMAT, 1463 DCF_TYPE, 1464 DCFUA31_MAXUNSYNC, 1465 DCFUA31_SPEED, 1466 DCFUA31_CFLAG, 1467 DCFUA31_IFLAG, 1468 DCFUA31_OFLAG, 1469 DCFUA31_LFLAG, 1470 DCFUA31_SAMPLES, 1471 DCFUA31_KEEP 1472 }, 1473 { /* mode 23 - like 7 with POWERUP trust */ 1474 MBG_FLAGS | PARSE_F_POWERUPTRUST, 1475 GPS16X_POLL, 1476 GPS16X_INIT, 1477 NO_EVENT, 1478 GPS16X_END, 1479 GPS16X_MESSAGE, 1480 GPS16X_DATA, 1481 GPS16X_ROOTDELAY, 1482 GPS16X_BASEDELAY, 1483 GPS16X_ID, 1484 GPS16X_DESCRIPTION, 1485 GPS16X_FORMAT, 1486 GPS_TYPE, 1487 GPS16X_MAXUNSYNC, 1488 GPS16X_SPEED, 1489 GPS16X_CFLAG, 1490 GPS16X_IFLAG, 1491 GPS16X_OFLAG, 1492 GPS16X_LFLAG, 1493 GPS16X_SAMPLES, 1494 GPS16X_KEEP 1495 }, 1496 { /* mode 24 */ 1497 SEL240X_FLAGS, 1498 SEL240X_POLL, 1499 SEL240X_INIT, 1500 NO_EVENT, 1501 SEL240X_END, 1502 NO_MESSAGE, 1503 SEL240X_DATA, 1504 SEL240X_ROOTDELAY, 1505 SEL240X_BASEDELAY, 1506 SEL240X_ID, 1507 SEL240X_DESCRIPTION, 1508 SEL240X_FORMAT, 1509 GPS_TYPE, 1510 SEL240X_MAXUNSYNC, 1511 SEL240X_SPEED, 1512 SEL240X_CFLAG, 1513 SEL240X_IFLAG, 1514 SEL240X_OFLAG, 1515 SEL240X_LFLAG, 1516 SEL240X_SAMPLES, 1517 SEL240X_KEEP 1518 }, 1519 }; 1520 1521 static int ncltypes = sizeof(parse_clockinfo) / sizeof(struct parse_clockinfo); 1522 1523 #define CLK_REALTYPE(x) ((int)(((x)->ttl) & 0x7F)) 1524 #define CLK_TYPE(x) ((CLK_REALTYPE(x) >= ncltypes) ? ~0 : CLK_REALTYPE(x)) 1525 #define CLK_UNIT(x) ((int)REFCLOCKUNIT(&(x)->srcadr)) 1526 #define CLK_PPS(x) (((x)->ttl) & 0x80) 1527 1528 /* 1529 * Other constant stuff 1530 */ 1531 #define PARSEHSREFID 0x7f7f08ff /* 127.127.8.255 refid for hi strata */ 1532 1533 #define PARSESTATISTICS (60*60) /* output state statistics every hour */ 1534 1535 static int notice = 0; 1536 1537 #define PARSE_STATETIME(parse, i) ((parse->generic->currentstatus == i) ? parse->statetime[i] + current_time - parse->lastchange : parse->statetime[i]) 1538 1539 static void parse_event (struct parseunit *, int); 1540 static void parse_process (struct parseunit *, parsetime_t *); 1541 static void clear_err (struct parseunit *, u_long); 1542 static int list_err (struct parseunit *, u_long); 1543 static char * l_mktime (u_long); 1544 1545 /**=========================================================================== 1546 ** implementation error message regression module 1547 **/ 1548 static void 1549 clear_err( 1550 struct parseunit *parse, 1551 u_long lstate 1552 ) 1553 { 1554 if (lstate == ERR_ALL) 1555 { 1556 size_t i; 1557 1558 for (i = 0; i < ERR_CNT; i++) 1559 { 1560 parse->errors[i].err_stage = err_tbl[i]; 1561 parse->errors[i].err_cnt = 0; 1562 parse->errors[i].err_last = 0; 1563 parse->errors[i].err_started = 0; 1564 parse->errors[i].err_suppressed = 0; 1565 } 1566 } 1567 else 1568 { 1569 parse->errors[lstate].err_stage = err_tbl[lstate]; 1570 parse->errors[lstate].err_cnt = 0; 1571 parse->errors[lstate].err_last = 0; 1572 parse->errors[lstate].err_started = 0; 1573 parse->errors[lstate].err_suppressed = 0; 1574 } 1575 } 1576 1577 static int 1578 list_err( 1579 struct parseunit *parse, 1580 u_long lstate 1581 ) 1582 { 1583 int do_it; 1584 struct errorinfo *err = &parse->errors[lstate]; 1585 1586 if (err->err_started == 0) 1587 { 1588 err->err_started = current_time; 1589 } 1590 1591 do_it = (current_time - err->err_last) >= err->err_stage->err_delay; 1592 1593 if (do_it) 1594 err->err_cnt++; 1595 1596 if (err->err_stage->err_count && 1597 (err->err_cnt >= err->err_stage->err_count)) 1598 { 1599 err->err_stage++; 1600 err->err_cnt = 0; 1601 } 1602 1603 if (!err->err_cnt && do_it) 1604 msyslog(LOG_INFO, "PARSE receiver #%d: interval for following error message class is at least %s", 1605 CLK_UNIT(parse->peer), l_mktime(err->err_stage->err_delay)); 1606 1607 if (!do_it) 1608 err->err_suppressed++; 1609 else 1610 err->err_last = current_time; 1611 1612 if (do_it && err->err_suppressed) 1613 { 1614 msyslog(LOG_INFO, "PARSE receiver #%d: %ld message%s suppressed, error condition class persists for %s", 1615 CLK_UNIT(parse->peer), err->err_suppressed, (err->err_suppressed == 1) ? " was" : "s where", 1616 l_mktime(current_time - err->err_started)); 1617 err->err_suppressed = 0; 1618 } 1619 1620 return do_it; 1621 } 1622 1623 /*-------------------------------------------------- 1624 * mkreadable - make a printable ascii string (without 1625 * embedded quotes so that the ntpq protocol isn't 1626 * fooled 1627 */ 1628 #ifndef isprint 1629 #define isprint(_X_) (((_X_) > 0x1F) && ((_X_) < 0x7F)) 1630 #endif 1631 1632 static char * 1633 mkreadable( 1634 char *buffer, 1635 long blen, 1636 const char *src, 1637 u_long srclen, 1638 int hex 1639 ) 1640 { 1641 static const char ellipsis[] = "..."; 1642 char *b = buffer; 1643 char *endb = NULL; 1644 1645 if (blen < 4) 1646 return NULL; /* don't bother with mini buffers */ 1647 1648 endb = buffer + blen - sizeof(ellipsis); 1649 1650 blen--; /* account for '\0' */ 1651 1652 while (blen && srclen--) 1653 { 1654 if (!hex && /* no binary only */ 1655 (*src != '\\') && /* no plain \ */ 1656 (*src != '"') && /* no " */ 1657 isprint((unsigned char)*src)) /* only printables */ 1658 { /* they are easy... */ 1659 *buffer++ = *src++; 1660 blen--; 1661 } 1662 else 1663 { 1664 if (blen < 4) 1665 { 1666 while (blen--) 1667 { 1668 *buffer++ = '.'; 1669 } 1670 *buffer = '\0'; 1671 return b; 1672 } 1673 else 1674 { 1675 if (*src == '\\') 1676 { 1677 memcpy(buffer, "\\\\", 2); 1678 buffer += 2; 1679 blen -= 2; 1680 src++; 1681 } 1682 else 1683 { 1684 snprintf(buffer, blen, "\\x%02x", *src++); 1685 blen -= 4; 1686 buffer += 4; 1687 } 1688 } 1689 } 1690 if (srclen && !blen && endb) /* overflow - set last chars to ... */ 1691 memcpy(endb, ellipsis, sizeof(ellipsis)); 1692 } 1693 1694 *buffer = '\0'; 1695 return b; 1696 } 1697 1698 1699 /*-------------------------------------------------- 1700 * mkascii - make a printable ascii string 1701 * assumes (unless defined better) 7-bit ASCII 1702 */ 1703 static char * 1704 mkascii( 1705 char *buffer, 1706 long blen, 1707 const char *src, 1708 u_long srclen 1709 ) 1710 { 1711 return mkreadable(buffer, blen, src, srclen, 0); 1712 } 1713 1714 /**=========================================================================== 1715 ** implementation of i/o handling methods 1716 ** (all STREAM, partial STREAM, user level) 1717 **/ 1718 1719 /* 1720 * define possible io handling methods 1721 */ 1722 #ifdef STREAM 1723 static int ppsclock_init (struct parseunit *); 1724 static int stream_init (struct parseunit *); 1725 static void stream_end (struct parseunit *); 1726 static int stream_enable (struct parseunit *); 1727 static int stream_disable (struct parseunit *); 1728 static int stream_setcs (struct parseunit *, parsectl_t *); 1729 static int stream_getfmt (struct parseunit *, parsectl_t *); 1730 static int stream_setfmt (struct parseunit *, parsectl_t *); 1731 static int stream_timecode (struct parseunit *, parsectl_t *); 1732 static void stream_receive (struct recvbuf *); 1733 #endif 1734 1735 static int local_init (struct parseunit *); 1736 static void local_end (struct parseunit *); 1737 static int local_nop (struct parseunit *); 1738 static int local_setcs (struct parseunit *, parsectl_t *); 1739 static int local_getfmt (struct parseunit *, parsectl_t *); 1740 static int local_setfmt (struct parseunit *, parsectl_t *); 1741 static int local_timecode (struct parseunit *, parsectl_t *); 1742 static void local_receive (struct recvbuf *); 1743 static int local_input (struct recvbuf *); 1744 1745 static bind_t io_bindings[] = 1746 { 1747 #ifdef STREAM 1748 { 1749 "parse STREAM", 1750 stream_init, 1751 stream_end, 1752 stream_setcs, 1753 stream_disable, 1754 stream_enable, 1755 stream_getfmt, 1756 stream_setfmt, 1757 stream_timecode, 1758 stream_receive, 1759 0, 1760 }, 1761 { 1762 "ppsclock STREAM", 1763 ppsclock_init, 1764 local_end, 1765 local_setcs, 1766 local_nop, 1767 local_nop, 1768 local_getfmt, 1769 local_setfmt, 1770 local_timecode, 1771 local_receive, 1772 local_input, 1773 }, 1774 #endif 1775 { 1776 "normal", 1777 local_init, 1778 local_end, 1779 local_setcs, 1780 local_nop, 1781 local_nop, 1782 local_getfmt, 1783 local_setfmt, 1784 local_timecode, 1785 local_receive, 1786 local_input, 1787 }, 1788 { 1789 (char *)0, 1790 NULL, 1791 NULL, 1792 NULL, 1793 NULL, 1794 NULL, 1795 NULL, 1796 NULL, 1797 NULL, 1798 NULL, 1799 NULL, 1800 } 1801 }; 1802 1803 #ifdef STREAM 1804 1805 /*-------------------------------------------------- 1806 * ppsclock STREAM init 1807 */ 1808 static int 1809 ppsclock_init( 1810 struct parseunit *parse 1811 ) 1812 { 1813 static char m1[] = "ppsclocd"; 1814 static char m2[] = "ppsclock"; 1815 1816 /* 1817 * now push the parse streams module 1818 * it will ensure exclusive access to the device 1819 */ 1820 if (ioctl(parse->ppsfd, I_PUSH, (caddr_t)m1) == -1 && 1821 ioctl(parse->ppsfd, I_PUSH, (caddr_t)m2) == -1) 1822 { 1823 if (errno != EINVAL) 1824 { 1825 msyslog(LOG_ERR, "PARSE receiver #%d: ppsclock_init: ioctl(fd, I_PUSH, \"ppsclock\"): %m", 1826 CLK_UNIT(parse->peer)); 1827 } 1828 return 0; 1829 } 1830 if (!local_init(parse)) 1831 { 1832 (void)ioctl(parse->ppsfd, I_POP, (caddr_t)0); 1833 return 0; 1834 } 1835 1836 parse->flags |= PARSE_PPSCLOCK; 1837 return 1; 1838 } 1839 1840 /*-------------------------------------------------- 1841 * parse STREAM init 1842 */ 1843 static int 1844 stream_init( 1845 struct parseunit *parse 1846 ) 1847 { 1848 static char m1[] = "parse"; 1849 /* 1850 * now push the parse streams module 1851 * to test whether it is there (neat interface 8-( ) 1852 */ 1853 if (ioctl(parse->generic->io.fd, I_PUSH, (caddr_t)m1) == -1) 1854 { 1855 if (errno != EINVAL) /* accept non-existence */ 1856 { 1857 msyslog(LOG_ERR, "PARSE receiver #%d: stream_init: ioctl(fd, I_PUSH, \"parse\"): %m", CLK_UNIT(parse->peer)); 1858 } 1859 return 0; 1860 } 1861 else 1862 { 1863 while(ioctl(parse->generic->io.fd, I_POP, (caddr_t)0) == 0) 1864 /* empty loop */; 1865 1866 /* 1867 * now push it a second time after we have removed all 1868 * module garbage 1869 */ 1870 if (ioctl(parse->generic->io.fd, I_PUSH, (caddr_t)m1) == -1) 1871 { 1872 msyslog(LOG_ERR, "PARSE receiver #%d: stream_init: ioctl(fd, I_PUSH, \"parse\"): %m", CLK_UNIT(parse->peer)); 1873 return 0; 1874 } 1875 else 1876 { 1877 return 1; 1878 } 1879 } 1880 } 1881 1882 /*-------------------------------------------------- 1883 * parse STREAM end 1884 */ 1885 static void 1886 stream_end( 1887 struct parseunit *parse 1888 ) 1889 { 1890 while(ioctl(parse->generic->io.fd, I_POP, (caddr_t)0) == 0) 1891 /* empty loop */; 1892 } 1893 1894 /*-------------------------------------------------- 1895 * STREAM setcs 1896 */ 1897 static int 1898 stream_setcs( 1899 struct parseunit *parse, 1900 parsectl_t *tcl 1901 ) 1902 { 1903 struct strioctl strioc; 1904 1905 strioc.ic_cmd = PARSEIOC_SETCS; 1906 strioc.ic_timout = 0; 1907 strioc.ic_dp = (char *)tcl; 1908 strioc.ic_len = sizeof (*tcl); 1909 1910 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 1911 { 1912 msyslog(LOG_ERR, "PARSE receiver #%d: stream_setcs: ioctl(fd, I_STR, PARSEIOC_SETCS): %m", CLK_UNIT(parse->peer)); 1913 return 0; 1914 } 1915 return 1; 1916 } 1917 1918 /*-------------------------------------------------- 1919 * STREAM enable 1920 */ 1921 static int 1922 stream_enable( 1923 struct parseunit *parse 1924 ) 1925 { 1926 struct strioctl strioc; 1927 1928 strioc.ic_cmd = PARSEIOC_ENABLE; 1929 strioc.ic_timout = 0; 1930 strioc.ic_dp = (char *)0; 1931 strioc.ic_len = 0; 1932 1933 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 1934 { 1935 msyslog(LOG_ERR, "PARSE receiver #%d: stream_enable: ioctl(fd, I_STR, PARSEIOC_ENABLE): %m", CLK_UNIT(parse->peer)); 1936 return 0; 1937 } 1938 parse->generic->io.clock_recv = stream_receive; /* ok - parse input in kernel */ 1939 return 1; 1940 } 1941 1942 /*-------------------------------------------------- 1943 * STREAM disable 1944 */ 1945 static int 1946 stream_disable( 1947 struct parseunit *parse 1948 ) 1949 { 1950 struct strioctl strioc; 1951 1952 strioc.ic_cmd = PARSEIOC_DISABLE; 1953 strioc.ic_timout = 0; 1954 strioc.ic_dp = (char *)0; 1955 strioc.ic_len = 0; 1956 1957 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 1958 { 1959 msyslog(LOG_ERR, "PARSE receiver #%d: stream_disable: ioctl(fd, I_STR, PARSEIOC_DISABLE): %m", CLK_UNIT(parse->peer)); 1960 return 0; 1961 } 1962 parse->generic->io.clock_recv = local_receive; /* ok - parse input in daemon */ 1963 return 1; 1964 } 1965 1966 /*-------------------------------------------------- 1967 * STREAM getfmt 1968 */ 1969 static int 1970 stream_getfmt( 1971 struct parseunit *parse, 1972 parsectl_t *tcl 1973 ) 1974 { 1975 struct strioctl strioc; 1976 1977 strioc.ic_cmd = PARSEIOC_GETFMT; 1978 strioc.ic_timout = 0; 1979 strioc.ic_dp = (char *)tcl; 1980 strioc.ic_len = sizeof (*tcl); 1981 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 1982 { 1983 msyslog(LOG_ERR, "PARSE receiver #%d: ioctl(fd, I_STR, PARSEIOC_GETFMT): %m", CLK_UNIT(parse->peer)); 1984 return 0; 1985 } 1986 return 1; 1987 } 1988 1989 /*-------------------------------------------------- 1990 * STREAM setfmt 1991 */ 1992 static int 1993 stream_setfmt( 1994 struct parseunit *parse, 1995 parsectl_t *tcl 1996 ) 1997 { 1998 struct strioctl strioc; 1999 2000 strioc.ic_cmd = PARSEIOC_SETFMT; 2001 strioc.ic_timout = 0; 2002 strioc.ic_dp = (char *)tcl; 2003 strioc.ic_len = sizeof (*tcl); 2004 2005 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 2006 { 2007 msyslog(LOG_ERR, "PARSE receiver #%d: stream_setfmt: ioctl(fd, I_STR, PARSEIOC_SETFMT): %m", CLK_UNIT(parse->peer)); 2008 return 0; 2009 } 2010 return 1; 2011 } 2012 2013 2014 /*-------------------------------------------------- 2015 * STREAM timecode 2016 */ 2017 static int 2018 stream_timecode( 2019 struct parseunit *parse, 2020 parsectl_t *tcl 2021 ) 2022 { 2023 struct strioctl strioc; 2024 2025 strioc.ic_cmd = PARSEIOC_TIMECODE; 2026 strioc.ic_timout = 0; 2027 strioc.ic_dp = (char *)tcl; 2028 strioc.ic_len = sizeof (*tcl); 2029 2030 if (ioctl(parse->generic->io.fd, I_STR, (caddr_t)&strioc) == -1) 2031 { 2032 ERR(ERR_INTERNAL) 2033 msyslog(LOG_ERR, "PARSE receiver #%d: stream_timecode: ioctl(fd, I_STR, PARSEIOC_TIMECODE): %m", CLK_UNIT(parse->peer)); 2034 return 0; 2035 } 2036 clear_err(parse, ERR_INTERNAL); 2037 return 1; 2038 } 2039 2040 /*-------------------------------------------------- 2041 * STREAM receive 2042 */ 2043 static void 2044 stream_receive( 2045 struct recvbuf *rbufp 2046 ) 2047 { 2048 struct parseunit * parse; 2049 parsetime_t parsetime; 2050 2051 parse = (struct parseunit *)rbufp->recv_peer->procptr->unitptr; 2052 if (!parse->peer) 2053 return; 2054 2055 if (rbufp->recv_length != sizeof(parsetime_t)) 2056 { 2057 ERR(ERR_BADIO) 2058 msyslog(LOG_ERR,"PARSE receiver #%d: stream_receive: bad size (got %d expected %d)", 2059 CLK_UNIT(parse->peer), rbufp->recv_length, (int)sizeof(parsetime_t)); 2060 parse_event(parse, CEVNT_BADREPLY); 2061 return; 2062 } 2063 clear_err(parse, ERR_BADIO); 2064 2065 memmove((caddr_t)&parsetime, 2066 (caddr_t)rbufp->recv_buffer, 2067 sizeof(parsetime_t)); 2068 2069 #ifdef DEBUG 2070 if (debug > 3) 2071 { 2072 printf("PARSE receiver #%d: status %06x, state %08x, time %lx.%08lx, stime %lx.%08lx, ptime %lx.%08lx\n", 2073 CLK_UNIT(parse->peer), 2074 (unsigned int)parsetime.parse_status, 2075 (unsigned int)parsetime.parse_state, 2076 (unsigned long)parsetime.parse_time.tv.tv_sec, 2077 (unsigned long)parsetime.parse_time.tv.tv_usec, 2078 (unsigned long)parsetime.parse_stime.tv.tv_sec, 2079 (unsigned long)parsetime.parse_stime.tv.tv_usec, 2080 (unsigned long)parsetime.parse_ptime.tv.tv_sec, 2081 (unsigned long)parsetime.parse_ptime.tv.tv_usec); 2082 } 2083 #endif 2084 2085 /* 2086 * switch time stamp world - be sure to normalize small usec field 2087 * errors. 2088 */ 2089 2090 parsetime.parse_stime.fp = tval_stamp_to_lfp(parsetime.parse_stime.tv); 2091 2092 if (PARSE_TIMECODE(parsetime.parse_state)) 2093 { 2094 parsetime.parse_time.fp = tval_stamp_to_lfp(parsetime.parse_time.tv); 2095 } 2096 2097 if (PARSE_PPS(parsetime.parse_state)) 2098 { 2099 parsetime.parse_ptime.fp = tval_stamp_to_lfp(parsetime.parse_ptime.tv); 2100 } 2101 2102 parse_process(parse, &parsetime); 2103 } 2104 #endif 2105 2106 /*-------------------------------------------------- 2107 * local init 2108 */ 2109 static int 2110 local_init( 2111 struct parseunit *parse 2112 ) 2113 { 2114 return parse_ioinit(&parse->parseio); 2115 } 2116 2117 /*-------------------------------------------------- 2118 * local end 2119 */ 2120 static void 2121 local_end( 2122 struct parseunit *parse 2123 ) 2124 { 2125 parse_ioend(&parse->parseio); 2126 } 2127 2128 2129 /*-------------------------------------------------- 2130 * local nop 2131 */ 2132 static int 2133 local_nop( 2134 struct parseunit *parse 2135 ) 2136 { 2137 return 1; 2138 } 2139 2140 /*-------------------------------------------------- 2141 * local setcs 2142 */ 2143 static int 2144 local_setcs( 2145 struct parseunit *parse, 2146 parsectl_t *tcl 2147 ) 2148 { 2149 return parse_setcs(tcl, &parse->parseio); 2150 } 2151 2152 /*-------------------------------------------------- 2153 * local getfmt 2154 */ 2155 static int 2156 local_getfmt( 2157 struct parseunit *parse, 2158 parsectl_t *tcl 2159 ) 2160 { 2161 return parse_getfmt(tcl, &parse->parseio); 2162 } 2163 2164 /*-------------------------------------------------- 2165 * local setfmt 2166 */ 2167 static int 2168 local_setfmt( 2169 struct parseunit *parse, 2170 parsectl_t *tcl 2171 ) 2172 { 2173 return parse_setfmt(tcl, &parse->parseio); 2174 } 2175 2176 /*-------------------------------------------------- 2177 * local timecode 2178 */ 2179 static int 2180 local_timecode( 2181 struct parseunit *parse, 2182 parsectl_t *tcl 2183 ) 2184 { 2185 return parse_timecode(tcl, &parse->parseio); 2186 } 2187 2188 2189 /*-------------------------------------------------- 2190 * local input 2191 */ 2192 static int 2193 local_input( 2194 struct recvbuf *rbufp 2195 ) 2196 { 2197 struct parseunit * parse; 2198 2199 int count; 2200 unsigned char *s; 2201 timestamp_t ts; 2202 2203 parse = (struct parseunit *)rbufp->recv_peer->procptr->unitptr; 2204 if (!parse->peer) 2205 return 0; 2206 2207 /* 2208 * eat all characters, parsing then and feeding complete samples 2209 */ 2210 count = rbufp->recv_length; 2211 s = (unsigned char *)rbufp->recv_buffer; 2212 ts.fp = rbufp->recv_time; 2213 2214 while (count--) 2215 { 2216 if (parse_ioread(&parse->parseio, (unsigned int)(*s++), &ts)) 2217 { 2218 struct recvbuf *buf; 2219 2220 /* 2221 * got something good to eat 2222 */ 2223 if (!PARSE_PPS(parse->parseio.parse_dtime.parse_state)) 2224 { 2225 #ifdef HAVE_PPSAPI 2226 if (parse->flags & PARSE_PPSCLOCK) 2227 { 2228 struct timespec pps_timeout; 2229 pps_info_t pps_info; 2230 2231 pps_timeout.tv_sec = 0; 2232 pps_timeout.tv_nsec = 0; 2233 2234 if (time_pps_fetch(parse->atom.handle, PPS_TSFMT_TSPEC, &pps_info, 2235 &pps_timeout) == 0) 2236 { 2237 if (pps_info.assert_sequence + pps_info.clear_sequence != parse->ppsserial) 2238 { 2239 double dtemp; 2240 2241 struct timespec pts; 2242 /* 2243 * add PPS time stamp if available via ppsclock module 2244 * and not supplied already. 2245 */ 2246 if (parse->flags & PARSE_CLEAR) 2247 pts = pps_info.clear_timestamp; 2248 else 2249 pts = pps_info.assert_timestamp; 2250 2251 parse->parseio.parse_dtime.parse_ptime.fp.l_ui = (uint32_t) (pts.tv_sec + JAN_1970); 2252 2253 dtemp = (double) pts.tv_nsec / 1e9; 2254 if (dtemp < 0.) { 2255 dtemp += 1; 2256 parse->parseio.parse_dtime.parse_ptime.fp.l_ui--; 2257 } 2258 if (dtemp > 1.) { 2259 dtemp -= 1; 2260 parse->parseio.parse_dtime.parse_ptime.fp.l_ui++; 2261 } 2262 parse->parseio.parse_dtime.parse_ptime.fp.l_uf = (uint32_t)(dtemp * FRAC); 2263 2264 parse->parseio.parse_dtime.parse_state |= PARSEB_PPS|PARSEB_S_PPS; 2265 #ifdef DEBUG 2266 if (debug > 3) 2267 { 2268 printf( 2269 "parse: local_receive: fd %d PPSAPI seq %ld - PPS %s\n", 2270 rbufp->fd, 2271 (long)pps_info.assert_sequence + (long)pps_info.clear_sequence, 2272 lfptoa(&parse->parseio.parse_dtime.parse_ptime.fp, 6)); 2273 } 2274 #endif 2275 } 2276 #ifdef DEBUG 2277 else 2278 { 2279 if (debug > 3) 2280 { 2281 printf( 2282 "parse: local_receive: fd %d PPSAPI seq assert %ld, seq clear %ld - NO PPS event\n", 2283 rbufp->fd, 2284 (long)pps_info.assert_sequence, (long)pps_info.clear_sequence); 2285 } 2286 } 2287 #endif 2288 parse->ppsserial = pps_info.assert_sequence + pps_info.clear_sequence; 2289 } 2290 #ifdef DEBUG 2291 else 2292 { 2293 if (debug > 3) 2294 { 2295 printf( 2296 "parse: local_receive: fd %d PPSAPI time_pps_fetch errno = %d\n", 2297 rbufp->fd, 2298 errno); 2299 } 2300 } 2301 #endif 2302 } 2303 #else 2304 #ifdef TIOCDCDTIMESTAMP 2305 struct timeval dcd_time; 2306 2307 if (ioctl(parse->ppsfd, TIOCDCDTIMESTAMP, &dcd_time) != -1) 2308 { 2309 l_fp tstmp; 2310 2311 TVTOTS(&dcd_time, &tstmp); 2312 tstmp.l_ui += JAN_1970; 2313 L_SUB(&ts.fp, &tstmp); 2314 if (ts.fp.l_ui == 0) 2315 { 2316 #ifdef DEBUG 2317 if (debug) 2318 { 2319 printf( 2320 "parse: local_receive: fd %d DCDTIMESTAMP %s\n", 2321 parse->ppsfd, 2322 lfptoa(&tstmp, 6)); 2323 printf(" sigio %s\n", 2324 lfptoa(&ts.fp, 6)); 2325 } 2326 #endif 2327 parse->parseio.parse_dtime.parse_ptime.fp = tstmp; 2328 parse->parseio.parse_dtime.parse_state |= PARSEB_PPS|PARSEB_S_PPS; 2329 } 2330 } 2331 #else /* TIOCDCDTIMESTAMP */ 2332 #if defined(HAVE_STRUCT_PPSCLOCKEV) && (defined(HAVE_CIOGETEV) || defined(HAVE_TIOCGPPSEV)) 2333 if (parse->flags & PARSE_PPSCLOCK) 2334 { 2335 l_fp tts; 2336 struct ppsclockev ev; 2337 2338 #ifdef HAVE_CIOGETEV 2339 if (ioctl(parse->ppsfd, CIOGETEV, (caddr_t)&ev) == 0) 2340 #endif 2341 #ifdef HAVE_TIOCGPPSEV 2342 if (ioctl(parse->ppsfd, TIOCGPPSEV, (caddr_t)&ev) == 0) 2343 #endif 2344 { 2345 if (ev.serial != parse->ppsserial) 2346 { 2347 /* 2348 * add PPS time stamp if available via ppsclock module 2349 * and not supplied already. 2350 */ 2351 if (!buftvtots((const char *)&ev.tv, &tts)) 2352 { 2353 ERR(ERR_BADDATA) 2354 msyslog(LOG_ERR,"parse: local_receive: timestamp conversion error (buftvtots) (ppsclockev.tv)"); 2355 } 2356 else 2357 { 2358 parse->parseio.parse_dtime.parse_ptime.fp = tts; 2359 parse->parseio.parse_dtime.parse_state |= PARSEB_PPS|PARSEB_S_PPS; 2360 } 2361 } 2362 parse->ppsserial = ev.serial; 2363 } 2364 } 2365 #endif 2366 #endif /* TIOCDCDTIMESTAMP */ 2367 #endif /* !HAVE_PPSAPI */ 2368 } 2369 if (count) 2370 { /* simulate receive */ 2371 buf = get_free_recv_buffer(); 2372 if (buf != NULL) { 2373 memmove((caddr_t)buf->recv_buffer, 2374 (caddr_t)&parse->parseio.parse_dtime, 2375 sizeof(parsetime_t)); 2376 buf->recv_length = sizeof(parsetime_t); 2377 buf->recv_time = rbufp->recv_time; 2378 #ifndef HAVE_IO_COMPLETION_PORT 2379 buf->srcadr = rbufp->srcadr; 2380 #endif 2381 buf->dstadr = rbufp->dstadr; 2382 buf->receiver = rbufp->receiver; 2383 buf->fd = rbufp->fd; 2384 buf->X_from_where = rbufp->X_from_where; 2385 parse->generic->io.recvcount++; 2386 packets_received++; 2387 add_full_recv_buffer(buf); 2388 #ifdef HAVE_IO_COMPLETION_PORT 2389 SetEvent(WaitableIoEventHandle); 2390 #endif 2391 } 2392 parse_iodone(&parse->parseio); 2393 } 2394 else 2395 { 2396 memmove((caddr_t)rbufp->recv_buffer, 2397 (caddr_t)&parse->parseio.parse_dtime, 2398 sizeof(parsetime_t)); 2399 parse_iodone(&parse->parseio); 2400 rbufp->recv_length = sizeof(parsetime_t); 2401 return 1; /* got something & in place return */ 2402 } 2403 } 2404 } 2405 return 0; /* nothing to pass up */ 2406 } 2407 2408 /*-------------------------------------------------- 2409 * local receive 2410 */ 2411 static void 2412 local_receive( 2413 struct recvbuf *rbufp 2414 ) 2415 { 2416 struct parseunit * parse; 2417 parsetime_t parsetime; 2418 2419 parse = (struct parseunit *)rbufp->recv_peer->procptr->unitptr; 2420 if (!parse->peer) 2421 return; 2422 2423 if (rbufp->recv_length != sizeof(parsetime_t)) 2424 { 2425 ERR(ERR_BADIO) 2426 msyslog(LOG_ERR,"PARSE receiver #%d: local_receive: bad size (got %d expected %d)", 2427 CLK_UNIT(parse->peer), rbufp->recv_length, (int)sizeof(parsetime_t)); 2428 parse_event(parse, CEVNT_BADREPLY); 2429 return; 2430 } 2431 clear_err(parse, ERR_BADIO); 2432 2433 memmove((caddr_t)&parsetime, 2434 (caddr_t)rbufp->recv_buffer, 2435 sizeof(parsetime_t)); 2436 2437 #ifdef DEBUG 2438 if (debug > 3) 2439 { 2440 printf("PARSE receiver #%d: status %06x, state %08x, time(fp) %lx.%08lx, stime(fp) %lx.%08lx, ptime(fp) %lx.%08lx\n", 2441 CLK_UNIT(parse->peer), 2442 (unsigned int)parsetime.parse_status, 2443 (unsigned int)parsetime.parse_state, 2444 (unsigned long)parsetime.parse_time.fp.l_ui, 2445 (unsigned long)parsetime.parse_time.fp.l_uf, 2446 (unsigned long)parsetime.parse_stime.fp.l_ui, 2447 (unsigned long)parsetime.parse_stime.fp.l_uf, 2448 (unsigned long)parsetime.parse_ptime.fp.l_ui, 2449 (unsigned long)parsetime.parse_ptime.fp.l_uf); 2450 } 2451 #endif 2452 2453 parse_process(parse, &parsetime); 2454 } 2455 2456 /*-------------------------------------------------- 2457 * init_iobinding - find and initialize lower layers 2458 */ 2459 static bind_t * 2460 init_iobinding( 2461 struct parseunit *parse 2462 ) 2463 { 2464 bind_t *b = io_bindings; 2465 2466 while (b->bd_description != (char *)0) 2467 { 2468 if ((*b->bd_init)(parse)) 2469 { 2470 return b; 2471 } 2472 b++; 2473 } 2474 return (bind_t *)0; 2475 } 2476 2477 /**=========================================================================== 2478 ** support routines 2479 **/ 2480 2481 static NTP_PRINTF(4, 5) char * 2482 ap(char *buffer, size_t len, char *pos, const char *fmt, ...) 2483 { 2484 va_list va; 2485 int l; 2486 size_t rem = len - (pos - buffer); 2487 2488 if (rem == 0) 2489 return pos; 2490 2491 va_start(va, fmt); 2492 l = vsnprintf(pos, rem, fmt, va); 2493 va_end(va); 2494 2495 if (l != -1) { 2496 rem--; 2497 if (rem >= (size_t)l) 2498 pos += l; 2499 else 2500 pos += rem; 2501 } 2502 2503 return pos; 2504 } 2505 2506 /*-------------------------------------------------- 2507 * convert a flag field to a string 2508 */ 2509 static char * 2510 parsestate( 2511 u_long lstate, 2512 char *buffer, 2513 int size 2514 ) 2515 { 2516 static struct bits 2517 { 2518 u_long bit; 2519 const char *name; 2520 } flagstrings[] = 2521 { 2522 { PARSEB_ANNOUNCE, "DST SWITCH WARNING" }, 2523 { PARSEB_POWERUP, "NOT SYNCHRONIZED" }, 2524 { PARSEB_NOSYNC, "TIME CODE NOT CONFIRMED" }, 2525 { PARSEB_DST, "DST" }, 2526 { PARSEB_UTC, "UTC DISPLAY" }, 2527 { PARSEB_LEAPADD, "LEAP ADD WARNING" }, 2528 { PARSEB_LEAPDEL, "LEAP DELETE WARNING" }, 2529 { PARSEB_LEAPSECOND, "LEAP SECOND" }, 2530 { PARSEB_CALLBIT, "CALL BIT" }, 2531 { PARSEB_TIMECODE, "TIME CODE" }, 2532 { PARSEB_PPS, "PPS" }, 2533 { PARSEB_POSITION, "POSITION" }, 2534 { 0, NULL } 2535 }; 2536 2537 static struct sbits 2538 { 2539 u_long bit; 2540 const char *name; 2541 } sflagstrings[] = 2542 { 2543 { PARSEB_S_LEAP, "LEAP INDICATION" }, 2544 { PARSEB_S_PPS, "PPS SIGNAL" }, 2545 { PARSEB_S_CALLBIT, "CALLBIT" }, 2546 { PARSEB_S_POSITION, "POSITION" }, 2547 { 0, NULL } 2548 }; 2549 int i; 2550 char *s, *t; 2551 2552 *buffer = '\0'; 2553 s = t = buffer; 2554 2555 i = 0; 2556 while (flagstrings[i].bit) 2557 { 2558 if (flagstrings[i].bit & lstate) 2559 { 2560 if (s != t) 2561 t = ap(buffer, size, t, "; "); 2562 t = ap(buffer, size, t, "%s", flagstrings[i].name); 2563 } 2564 i++; 2565 } 2566 2567 if (lstate & (PARSEB_S_LEAP|PARSEB_S_CALLBIT|PARSEB_S_PPS|PARSEB_S_POSITION)) 2568 { 2569 if (s != t) 2570 t = ap(buffer, size, t, "; "); 2571 2572 t = ap(buffer, size, t, "("); 2573 2574 s = t; 2575 2576 i = 0; 2577 while (sflagstrings[i].bit) 2578 { 2579 if (sflagstrings[i].bit & lstate) 2580 { 2581 if (t != s) 2582 { 2583 t = ap(buffer, size, t, "; "); 2584 } 2585 2586 t = ap(buffer, size, t, "%s", 2587 sflagstrings[i].name); 2588 } 2589 i++; 2590 } 2591 t = ap(buffer, size, t, ")"); 2592 } 2593 return buffer; 2594 } 2595 2596 /*-------------------------------------------------- 2597 * convert a status flag field to a string 2598 */ 2599 static char * 2600 parsestatus( 2601 u_long lstate, 2602 char *buffer, 2603 int size 2604 ) 2605 { 2606 static struct bits 2607 { 2608 u_long bit; 2609 const char *name; 2610 } flagstrings[] = 2611 { 2612 { CVT_OK, "CONVERSION SUCCESSFUL" }, 2613 { CVT_NONE, "NO CONVERSION" }, 2614 { CVT_FAIL, "CONVERSION FAILED" }, 2615 { CVT_BADFMT, "ILLEGAL FORMAT" }, 2616 { CVT_BADDATE, "DATE ILLEGAL" }, 2617 { CVT_BADTIME, "TIME ILLEGAL" }, 2618 { CVT_ADDITIONAL, "ADDITIONAL DATA" }, 2619 { 0, NULL } 2620 }; 2621 int i; 2622 char *t; 2623 2624 t = buffer; 2625 *buffer = '\0'; 2626 2627 i = 0; 2628 while (flagstrings[i].bit) 2629 { 2630 if (flagstrings[i].bit & lstate) 2631 { 2632 if (t != buffer) 2633 t = ap(buffer, size, t, "; "); 2634 t = ap(buffer, size, t, "%s", flagstrings[i].name); 2635 } 2636 i++; 2637 } 2638 2639 return buffer; 2640 } 2641 2642 /*-------------------------------------------------- 2643 * convert a clock status flag field to a string 2644 */ 2645 static const char * 2646 clockstatus( 2647 u_long lstate 2648 ) 2649 { 2650 static char buffer[20]; 2651 static struct status 2652 { 2653 u_long value; 2654 const char *name; 2655 } flagstrings[] = 2656 { 2657 { CEVNT_NOMINAL, "NOMINAL" }, 2658 { CEVNT_TIMEOUT, "NO RESPONSE" }, 2659 { CEVNT_BADREPLY,"BAD FORMAT" }, 2660 { CEVNT_FAULT, "FAULT" }, 2661 { CEVNT_PROP, "PROPAGATION DELAY" }, 2662 { CEVNT_BADDATE, "ILLEGAL DATE" }, 2663 { CEVNT_BADTIME, "ILLEGAL TIME" }, 2664 { (unsigned)~0L, NULL } 2665 }; 2666 int i; 2667 2668 i = 0; 2669 while (flagstrings[i].value != (u_int)~0) 2670 { 2671 if (flagstrings[i].value == lstate) 2672 { 2673 return flagstrings[i].name; 2674 } 2675 i++; 2676 } 2677 2678 snprintf(buffer, sizeof(buffer), "unknown #%ld", (u_long)lstate); 2679 2680 return buffer; 2681 } 2682 2683 2684 /*-------------------------------------------------- 2685 * l_mktime - make representation of a relative time 2686 */ 2687 static char * 2688 l_mktime( 2689 u_long delta 2690 ) 2691 { 2692 u_long tmp, m, s; 2693 static char buffer[40]; 2694 char *t; 2695 2696 buffer[0] = '\0'; 2697 t = buffer; 2698 2699 if ((tmp = delta / (60*60*24)) != 0) 2700 { 2701 t = ap(buffer, sizeof(buffer), t, "%ldd+", (u_long)tmp); 2702 delta -= tmp * 60*60*24; 2703 } 2704 2705 s = delta % 60; 2706 delta /= 60; 2707 m = delta % 60; 2708 delta /= 60; 2709 2710 t = ap(buffer, sizeof(buffer), t, "%02d:%02d:%02d", 2711 (int)delta, (int)m, (int)s); 2712 2713 return buffer; 2714 } 2715 2716 2717 /*-------------------------------------------------- 2718 * parse_statistics - list summary of clock states 2719 */ 2720 static void 2721 parse_statistics( 2722 struct parseunit *parse 2723 ) 2724 { 2725 int i; 2726 2727 NLOG(NLOG_CLOCKSTATIST) /* conditional if clause for conditional syslog */ 2728 { 2729 msyslog(LOG_INFO, "PARSE receiver #%d: running time: %s", 2730 CLK_UNIT(parse->peer), 2731 l_mktime(current_time - parse->generic->timestarted)); 2732 2733 msyslog(LOG_INFO, "PARSE receiver #%d: current status: %s", 2734 CLK_UNIT(parse->peer), 2735 clockstatus(parse->generic->currentstatus)); 2736 2737 for (i = 0; i <= CEVNT_MAX; i++) 2738 { 2739 u_long s_time; 2740 u_long percent, d = current_time - parse->generic->timestarted; 2741 2742 percent = s_time = PARSE_STATETIME(parse, i); 2743 2744 while (((u_long)(~0) / 10000) < percent) 2745 { 2746 percent /= 10; 2747 d /= 10; 2748 } 2749 2750 if (d) 2751 percent = (percent * 10000) / d; 2752 else 2753 percent = 10000; 2754 2755 if (s_time) 2756 msyslog(LOG_INFO, "PARSE receiver #%d: state %18s: %13s (%3ld.%02ld%%)", 2757 CLK_UNIT(parse->peer), 2758 clockstatus((unsigned int)i), 2759 l_mktime(s_time), 2760 percent / 100, percent % 100); 2761 } 2762 } 2763 } 2764 2765 /*-------------------------------------------------- 2766 * cparse_statistics - wrapper for statistics call 2767 */ 2768 static void 2769 cparse_statistics( 2770 struct parseunit *parse 2771 ) 2772 { 2773 if (parse->laststatistic + PARSESTATISTICS < current_time) 2774 parse_statistics(parse); 2775 parse->laststatistic = current_time; 2776 } 2777 2778 /**=========================================================================== 2779 ** ntp interface routines 2780 **/ 2781 2782 /*-------------------------------------------------- 2783 * parse_shutdown - shut down a PARSE clock 2784 */ 2785 static void 2786 parse_shutdown( 2787 int unit, 2788 struct peer *peer 2789 ) 2790 { 2791 struct parseunit *parse = NULL; 2792 2793 if (peer && peer->procptr) 2794 parse = peer->procptr->unitptr; 2795 2796 if (!parse) 2797 { 2798 /* nothing to clean up */ 2799 return; 2800 } 2801 2802 if (!parse->peer) 2803 { 2804 msyslog(LOG_INFO, "PARSE receiver #%d: INTERNAL ERROR - unit already inactive - shutdown ignored", unit); 2805 return; 2806 } 2807 2808 #ifdef HAVE_PPSAPI 2809 if (parse->flags & PARSE_PPSCLOCK) 2810 { 2811 (void)time_pps_destroy(parse->atom.handle); 2812 } 2813 #endif 2814 if (parse->generic->io.fd != parse->ppsfd && parse->ppsfd != -1) 2815 (void)closeserial(parse->ppsfd); /* close separate PPS source */ 2816 2817 /* 2818 * print statistics a last time and 2819 * stop statistics machine 2820 */ 2821 parse_statistics(parse); 2822 2823 if (parse->parse_type->cl_end) 2824 { 2825 parse->parse_type->cl_end(parse); 2826 } 2827 2828 /* 2829 * cleanup before leaving this world 2830 */ 2831 if (parse->binding) 2832 PARSE_END(parse); 2833 2834 /* 2835 * Tell the I/O module to turn us off. We're history. 2836 */ 2837 io_closeclock(&parse->generic->io); 2838 2839 free_varlist(parse->kv); 2840 2841 NLOG(NLOG_CLOCKINFO) /* conditional if clause for conditional syslog */ 2842 msyslog(LOG_INFO, "PARSE receiver #%d: reference clock \"%s\" removed", 2843 CLK_UNIT(parse->peer), parse->parse_type->cl_description); 2844 2845 parse->peer = (struct peer *)0; /* unused now */ 2846 peer->procptr->unitptr = (caddr_t)0; 2847 free(parse); 2848 } 2849 2850 #ifdef HAVE_PPSAPI 2851 /*---------------------------------------- 2852 * set up HARDPPS via PPSAPI 2853 */ 2854 static void 2855 parse_hardpps( 2856 struct parseunit *parse, 2857 int mode 2858 ) 2859 { 2860 if (parse->hardppsstate == mode) 2861 return; 2862 2863 if (CLK_PPS(parse->peer) && (parse->flags & PARSE_PPSKERNEL)) { 2864 int i = 0; 2865 2866 if (mode == PARSE_HARDPPS_ENABLE) 2867 { 2868 if (parse->flags & PARSE_CLEAR) 2869 i = PPS_CAPTURECLEAR; 2870 else 2871 i = PPS_CAPTUREASSERT; 2872 } 2873 2874 if (time_pps_kcbind(parse->atom.handle, PPS_KC_HARDPPS, i, 2875 PPS_TSFMT_TSPEC) < 0) { 2876 msyslog(LOG_ERR, "PARSE receiver #%d: time_pps_kcbind failed: %m", 2877 CLK_UNIT(parse->peer)); 2878 } else { 2879 NLOG(NLOG_CLOCKINFO) 2880 msyslog(LOG_INFO, "PARSE receiver #%d: kernel PPS synchronisation %sabled", 2881 CLK_UNIT(parse->peer), (mode == PARSE_HARDPPS_ENABLE) ? "en" : "dis"); 2882 /* 2883 * tell the rest, that we have a kernel PPS source, iff we ever enable HARDPPS 2884 */ 2885 if (mode == PARSE_HARDPPS_ENABLE) 2886 hardpps_enable = 1; 2887 } 2888 } 2889 2890 parse->hardppsstate = mode; 2891 } 2892 2893 /*---------------------------------------- 2894 * set up PPS via PPSAPI 2895 */ 2896 static int 2897 parse_ppsapi( 2898 struct parseunit *parse 2899 ) 2900 { 2901 int cap, mode_ppsoffset; 2902 const char *cp; 2903 2904 parse->flags &= (u_char) (~PARSE_PPSCLOCK); 2905 2906 /* 2907 * collect PPSAPI offset capability - should move into generic handling 2908 */ 2909 if (time_pps_getcap(parse->atom.handle, &cap) < 0) { 2910 msyslog(LOG_ERR, "PARSE receiver #%d: parse_ppsapi: time_pps_getcap failed: %m", 2911 CLK_UNIT(parse->peer)); 2912 2913 return 0; 2914 } 2915 2916 /* 2917 * initialize generic PPSAPI interface 2918 * 2919 * we leave out CLK_FLAG3 as time_pps_kcbind() 2920 * is handled here for now. Ideally this should also 2921 * be part of the generic PPSAPI interface 2922 */ 2923 if (!refclock_params(parse->flags & (CLK_FLAG1|CLK_FLAG2|CLK_FLAG4), &parse->atom)) 2924 return 0; 2925 2926 /* nb. only turn things on, if someone else has turned something 2927 * on before we get here, leave it alone! 2928 */ 2929 2930 if (parse->flags & PARSE_CLEAR) { 2931 cp = "CLEAR"; 2932 mode_ppsoffset = PPS_OFFSETCLEAR; 2933 } else { 2934 cp = "ASSERT"; 2935 mode_ppsoffset = PPS_OFFSETASSERT; 2936 } 2937 2938 msyslog(LOG_INFO, "PARSE receiver #%d: initializing PPS to %s", 2939 CLK_UNIT(parse->peer), cp); 2940 2941 if (!(mode_ppsoffset & cap)) { 2942 msyslog(LOG_WARNING, "PARSE receiver #%d: Cannot set PPS_%sCLEAR, this will increase jitter (PPS API capabilities=0x%x)", 2943 CLK_UNIT(parse->peer), cp, cap); 2944 mode_ppsoffset = 0; 2945 } else { 2946 if (mode_ppsoffset == PPS_OFFSETCLEAR) 2947 { 2948 parse->atom.pps_params.clear_offset.tv_sec = (time_t)(-parse->ppsphaseadjust); 2949 parse->atom.pps_params.clear_offset.tv_nsec = (long)(-1e9*(parse->ppsphaseadjust - (double)(long)parse->ppsphaseadjust)); 2950 } 2951 2952 if (mode_ppsoffset == PPS_OFFSETASSERT) 2953 { 2954 parse->atom.pps_params.assert_offset.tv_sec = (time_t)(-parse->ppsphaseadjust); 2955 parse->atom.pps_params.assert_offset.tv_nsec = (long)(-1e9*(parse->ppsphaseadjust - (double)(long)parse->ppsphaseadjust)); 2956 } 2957 } 2958 2959 parse->atom.pps_params.mode |= mode_ppsoffset; 2960 2961 if (time_pps_setparams(parse->atom.handle, &parse->atom.pps_params) < 0) { 2962 msyslog(LOG_ERR, "PARSE receiver #%d: FAILED set PPS parameters: %m", 2963 CLK_UNIT(parse->peer)); 2964 return 0; 2965 } 2966 2967 parse->flags |= PARSE_PPSCLOCK; 2968 return 1; 2969 } 2970 #else 2971 #define parse_hardpps(_PARSE_, _MODE_) /* empty */ 2972 #endif 2973 2974 /*-------------------------------------------------- 2975 * parse_start - open the PARSE devices and initialize data for processing 2976 */ 2977 static int 2978 parse_start( 2979 int sysunit, 2980 struct peer *peer 2981 ) 2982 { 2983 u_int unit; 2984 int fd232; 2985 #ifdef HAVE_TERMIOS 2986 struct termios tio; /* NEEDED FOR A LONG TIME ! */ 2987 #endif 2988 #ifdef HAVE_SYSV_TTYS 2989 struct termio tio; /* NEEDED FOR A LONG TIME ! */ 2990 #endif 2991 struct parseunit * parse; 2992 char parsedev[sizeof(PARSEDEVICE)+20]; 2993 char parseppsdev[sizeof(PARSEPPSDEVICE)+20]; 2994 parsectl_t tmp_ctl; 2995 u_int type; 2996 2997 /* 2998 * get out Copyright information once 2999 */ 3000 if (!notice) 3001 { 3002 NLOG(NLOG_CLOCKINFO) /* conditional if clause for conditional syslog */ 3003 msyslog(LOG_INFO, "NTP PARSE support: Copyright (c) 1989-2015, Frank Kardel"); 3004 notice = 1; 3005 } 3006 3007 type = CLK_TYPE(peer); 3008 unit = CLK_UNIT(peer); 3009 3010 if ((type == (u_int)~0) || (parse_clockinfo[type].cl_description == (char *)0)) 3011 { 3012 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: unsupported clock type %d (max %d)", 3013 unit, CLK_REALTYPE(peer), ncltypes-1); 3014 return 0; 3015 } 3016 3017 /* 3018 * Unit okay, attempt to open the device. 3019 */ 3020 (void) snprintf(parsedev, sizeof(parsedev), PARSEDEVICE, unit); 3021 (void) snprintf(parseppsdev, sizeof(parsedev), PARSEPPSDEVICE, unit); 3022 3023 #ifndef O_NOCTTY 3024 #define O_NOCTTY 0 3025 #endif 3026 #ifndef O_NONBLOCK 3027 #define O_NONBLOCK 0 3028 #endif 3029 3030 fd232 = tty_open(parsedev, O_RDWR | O_NOCTTY | O_NONBLOCK, 0777); 3031 3032 if (fd232 == -1) 3033 { 3034 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: open of %s failed: %m", unit, parsedev); 3035 return 0; 3036 } 3037 3038 parse = emalloc_zero(sizeof(*parse)); 3039 3040 parse->generic = peer->procptr; /* link up */ 3041 parse->generic->unitptr = (caddr_t)parse; /* link down */ 3042 3043 /* 3044 * Set up the structures 3045 */ 3046 parse->generic->timestarted = current_time; 3047 parse->lastchange = current_time; 3048 3049 parse->flags = 0; 3050 parse->pollneeddata = 0; 3051 parse->laststatistic = current_time; 3052 parse->lastformat = (unsigned short)~0; /* assume no format known */ 3053 parse->timedata.parse_status = (unsigned short)~0; /* be sure to mark initial status change */ 3054 parse->lastmissed = 0; /* assume got everything */ 3055 parse->ppsserial = 0; 3056 parse->ppsfd = -1; 3057 parse->localdata = (void *)0; 3058 parse->localstate = 0; 3059 parse->kv = (struct ctl_var *)0; 3060 3061 clear_err(parse, ERR_ALL); 3062 3063 parse->parse_type = &parse_clockinfo[type]; 3064 3065 parse->maxunsync = parse->parse_type->cl_maxunsync; 3066 3067 parse->generic->fudgetime1 = parse->parse_type->cl_basedelay; 3068 3069 parse->generic->fudgetime2 = 0.0; 3070 parse->ppsphaseadjust = parse->generic->fudgetime2; 3071 3072 parse->generic->clockdesc = parse->parse_type->cl_description; 3073 3074 peer->rootdelay = parse->parse_type->cl_rootdelay; 3075 peer->sstclktype = parse->parse_type->cl_type; 3076 peer->precision = sys_precision; 3077 3078 peer->stratum = STRATUM_REFCLOCK; 3079 3080 if (peer->stratum <= 1) 3081 memmove((char *)&parse->generic->refid, parse->parse_type->cl_id, 4); 3082 else 3083 parse->generic->refid = htonl(PARSEHSREFID); 3084 3085 parse->generic->io.fd = fd232; 3086 3087 parse->peer = peer; /* marks it also as busy */ 3088 3089 /* 3090 * configure terminal line 3091 */ 3092 if (TTY_GETATTR(fd232, &tio) == -1) 3093 { 3094 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: tcgetattr(%d, &tio): %m", unit, fd232); 3095 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3096 return 0; 3097 } 3098 else 3099 { 3100 #ifndef _PC_VDISABLE 3101 memset((char *)tio.c_cc, 0, sizeof(tio.c_cc)); 3102 #else 3103 int disablec; 3104 errno = 0; /* pathconf can deliver -1 without changing errno ! */ 3105 3106 disablec = fpathconf(parse->generic->io.fd, _PC_VDISABLE); 3107 if (disablec == -1 && errno) 3108 { 3109 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: fpathconf(fd, _PC_VDISABLE): %m", CLK_UNIT(parse->peer)); 3110 memset((char *)tio.c_cc, 0, sizeof(tio.c_cc)); /* best guess */ 3111 } 3112 else 3113 if (disablec != -1) 3114 memset((char *)tio.c_cc, disablec, sizeof(tio.c_cc)); 3115 #endif 3116 3117 #if defined (VMIN) || defined(VTIME) 3118 if ((parse_clockinfo[type].cl_lflag & ICANON) == 0) 3119 { 3120 #ifdef VMIN 3121 tio.c_cc[VMIN] = 1; 3122 #endif 3123 #ifdef VTIME 3124 tio.c_cc[VTIME] = 0; 3125 #endif 3126 } 3127 #endif 3128 3129 tio.c_cflag = (tcflag_t) parse_clockinfo[type].cl_cflag; 3130 tio.c_iflag = (tcflag_t) parse_clockinfo[type].cl_iflag; 3131 tio.c_oflag = (tcflag_t) parse_clockinfo[type].cl_oflag; 3132 tio.c_lflag = (tcflag_t) parse_clockinfo[type].cl_lflag; 3133 3134 3135 #ifdef HAVE_TERMIOS 3136 if ((cfsetospeed(&tio, (speed_t) parse_clockinfo[type].cl_speed) == -1) || 3137 (cfsetispeed(&tio, (speed_t) parse_clockinfo[type].cl_speed) == -1)) 3138 { 3139 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: tcset{i,o}speed(&tio, speed): %m", unit); 3140 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3141 return 0; 3142 } 3143 #else 3144 tio.c_cflag |= parse_clockinfo[type].cl_speed; 3145 #endif 3146 3147 /* 3148 * set up pps device 3149 * if the PARSEPPSDEVICE can be opened that will be used 3150 * for PPS else PARSEDEVICE will be used 3151 */ 3152 parse->ppsfd = tty_open(parseppsdev, O_RDWR | O_NOCTTY | O_NONBLOCK, 0777); 3153 3154 if (parse->ppsfd == -1) 3155 { 3156 parse->ppsfd = fd232; 3157 } 3158 3159 /* 3160 * Linux PPS - the old way 3161 */ 3162 #if defined(HAVE_TIO_SERIAL_STUFF) /* Linux hack: define PPS interface */ 3163 { 3164 struct serial_struct ss; 3165 if (ioctl(parse->ppsfd, TIOCGSERIAL, &ss) < 0 || 3166 ( 3167 #ifdef ASYNC_LOW_LATENCY 3168 ss.flags |= ASYNC_LOW_LATENCY, 3169 #endif 3170 #ifndef HAVE_PPSAPI 3171 #ifdef ASYNC_PPS_CD_NEG 3172 ss.flags |= ASYNC_PPS_CD_NEG, 3173 #endif 3174 #endif 3175 ioctl(parse->ppsfd, TIOCSSERIAL, &ss)) < 0) { 3176 msyslog(LOG_NOTICE, "refclock_parse: TIOCSSERIAL fd %d, %m", parse->ppsfd); 3177 msyslog(LOG_NOTICE, 3178 "refclock_parse: optional PPS processing not available"); 3179 } else { 3180 parse->flags |= PARSE_PPSCLOCK; 3181 #ifdef ASYNC_PPS_CD_NEG 3182 NLOG(NLOG_CLOCKINFO) 3183 msyslog(LOG_INFO, 3184 "refclock_parse: PPS detection on"); 3185 #endif 3186 } 3187 } 3188 #endif 3189 3190 /* 3191 * SUN the Solaris way 3192 */ 3193 #ifdef HAVE_TIOCSPPS /* SUN PPS support */ 3194 if (CLK_PPS(parse->peer)) 3195 { 3196 int i = 1; 3197 3198 if (ioctl(parse->ppsfd, TIOCSPPS, (caddr_t)&i) == 0) 3199 { 3200 parse->flags |= PARSE_PPSCLOCK; 3201 } 3202 } 3203 #endif 3204 3205 /* 3206 * PPS via PPSAPI 3207 */ 3208 #if defined(HAVE_PPSAPI) 3209 parse->hardppsstate = PARSE_HARDPPS_DISABLE; 3210 if (CLK_PPS(parse->peer)) 3211 { 3212 if (!refclock_ppsapi(parse->ppsfd, &parse->atom)) 3213 { 3214 msyslog(LOG_NOTICE, "PARSE receiver #%d: parse_start: could not set up PPS: %m", CLK_UNIT(parse->peer)); 3215 } 3216 else 3217 { 3218 parse_ppsapi(parse); 3219 } 3220 } 3221 #endif 3222 3223 if (TTY_SETATTR(fd232, &tio) == -1) 3224 { 3225 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: tcsetattr(%d, &tio): %m", unit, fd232); 3226 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3227 return 0; 3228 } 3229 } 3230 3231 /* 3232 * pick correct input machine 3233 */ 3234 parse->generic->io.srcclock = peer; 3235 parse->generic->io.datalen = 0; 3236 3237 parse->binding = init_iobinding(parse); 3238 3239 if (parse->binding == (bind_t *)0) 3240 { 3241 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: io sub system initialisation failed.", CLK_UNIT(parse->peer)); 3242 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3243 return 0; /* well, ok - special initialisation broke */ 3244 } 3245 3246 parse->generic->io.clock_recv = parse->binding->bd_receive; /* pick correct receive routine */ 3247 parse->generic->io.io_input = parse->binding->bd_io_input; /* pick correct input routine */ 3248 3249 /* 3250 * as we always(?) get 8 bit chars we want to be 3251 * sure, that the upper bits are zero for less 3252 * than 8 bit I/O - so we pass that information on. 3253 * note that there can be only one bit count format 3254 * per file descriptor 3255 */ 3256 3257 switch (tio.c_cflag & CSIZE) 3258 { 3259 case CS5: 3260 tmp_ctl.parsesetcs.parse_cs = PARSE_IO_CS5; 3261 break; 3262 3263 case CS6: 3264 tmp_ctl.parsesetcs.parse_cs = PARSE_IO_CS6; 3265 break; 3266 3267 case CS7: 3268 tmp_ctl.parsesetcs.parse_cs = PARSE_IO_CS7; 3269 break; 3270 3271 case CS8: 3272 tmp_ctl.parsesetcs.parse_cs = PARSE_IO_CS8; 3273 break; 3274 } 3275 3276 if (!PARSE_SETCS(parse, &tmp_ctl)) 3277 { 3278 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: parse_setcs() FAILED.", unit); 3279 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3280 return 0; /* well, ok - special initialisation broke */ 3281 } 3282 3283 strlcpy(tmp_ctl.parseformat.parse_buffer, parse->parse_type->cl_format, sizeof(tmp_ctl.parseformat.parse_buffer)); 3284 tmp_ctl.parseformat.parse_count = (u_short) strlen(tmp_ctl.parseformat.parse_buffer); 3285 3286 if (!PARSE_SETFMT(parse, &tmp_ctl)) 3287 { 3288 msyslog(LOG_ERR, "PARSE receiver #%d: parse_start: parse_setfmt() FAILED.", unit); 3289 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3290 return 0; /* well, ok - special initialisation broke */ 3291 } 3292 3293 /* 3294 * get rid of all IO accumulated so far 3295 */ 3296 #ifdef HAVE_TERMIOS 3297 (void) tcflush(parse->generic->io.fd, TCIOFLUSH); 3298 #else 3299 #if defined(TCFLSH) && defined(TCIOFLUSH) 3300 { 3301 int flshcmd = TCIOFLUSH; 3302 3303 (void) ioctl(parse->generic->io.fd, TCFLSH, (caddr_t)&flshcmd); 3304 } 3305 #endif 3306 #endif 3307 3308 /* 3309 * try to do any special initializations 3310 */ 3311 if (parse->parse_type->cl_init) 3312 { 3313 if (parse->parse_type->cl_init(parse)) 3314 { 3315 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3316 return 0; /* well, ok - special initialisation broke */ 3317 } 3318 } 3319 3320 /* 3321 * Insert in async io device list. 3322 */ 3323 if (!io_addclock(&parse->generic->io)) 3324 { 3325 msyslog(LOG_ERR, 3326 "PARSE receiver #%d: parse_start: addclock %s fails (ABORT - clock type requires async io)", CLK_UNIT(parse->peer), parsedev); 3327 parse_shutdown(CLK_UNIT(parse->peer), peer); /* let our cleaning staff do the work */ 3328 return 0; 3329 } 3330 3331 /* 3332 * print out configuration 3333 */ 3334 NLOG(NLOG_CLOCKINFO) 3335 { 3336 /* conditional if clause for conditional syslog */ 3337 msyslog(LOG_INFO, "PARSE receiver #%d: reference clock \"%s\" (I/O device %s, PPS device %s) added", 3338 CLK_UNIT(parse->peer), 3339 parse->parse_type->cl_description, parsedev, 3340 (parse->ppsfd != parse->generic->io.fd) ? parseppsdev : parsedev); 3341 3342 msyslog(LOG_INFO, "PARSE receiver #%d: Stratum %d, trust time %s, precision %d", 3343 CLK_UNIT(parse->peer), 3344 parse->peer->stratum, 3345 l_mktime(parse->maxunsync), parse->peer->precision); 3346 3347 msyslog(LOG_INFO, "PARSE receiver #%d: rootdelay %.6f s, phase adjustment %.6f s, PPS phase adjustment %.6f s, %s IO handling", 3348 CLK_UNIT(parse->peer), 3349 parse->parse_type->cl_rootdelay, 3350 parse->generic->fudgetime1, 3351 parse->ppsphaseadjust, 3352 parse->binding->bd_description); 3353 3354 msyslog(LOG_INFO, "PARSE receiver #%d: Format recognition: %s", CLK_UNIT(parse->peer), 3355 parse->parse_type->cl_format); 3356 msyslog(LOG_INFO, "PARSE receiver #%d: %sPPS support%s", CLK_UNIT(parse->peer), 3357 CLK_PPS(parse->peer) ? "" : "NO ", 3358 CLK_PPS(parse->peer) ? 3359 #ifdef PPS_METHOD 3360 " (implementation " PPS_METHOD ")" 3361 #else 3362 "" 3363 #endif 3364 : "" 3365 ); 3366 } 3367 3368 return 1; 3369 } 3370 3371 /*-------------------------------------------------- 3372 * parse_ctl - process changes on flags/time values 3373 */ 3374 static void 3375 parse_ctl( 3376 struct parseunit *parse, 3377 const struct refclockstat *in 3378 ) 3379 { 3380 if (in) 3381 { 3382 if (in->haveflags & (CLK_HAVEFLAG1|CLK_HAVEFLAG2|CLK_HAVEFLAG3|CLK_HAVEFLAG4)) 3383 { 3384 u_char mask = CLK_FLAG1|CLK_FLAG2|CLK_FLAG3|CLK_FLAG4; 3385 parse->flags = (parse->flags & (u_char)(~mask)) | (in->flags & mask); 3386 #if defined(HAVE_PPSAPI) 3387 if (CLK_PPS(parse->peer)) 3388 { 3389 parse_ppsapi(parse); 3390 } 3391 #endif 3392 } 3393 3394 if (in->haveflags & CLK_HAVETIME1) 3395 { 3396 parse->generic->fudgetime1 = in->fudgetime1; 3397 msyslog(LOG_INFO, "PARSE receiver #%d: new phase adjustment %.6f s", 3398 CLK_UNIT(parse->peer), 3399 parse->generic->fudgetime1); 3400 } 3401 3402 if (in->haveflags & CLK_HAVETIME2) 3403 { 3404 parse->generic->fudgetime2 = in->fudgetime2; 3405 if (parse->flags & PARSE_TRUSTTIME) 3406 { 3407 parse->maxunsync = (u_long)ABS(in->fudgetime2); 3408 msyslog(LOG_INFO, "PARSE receiver #%d: new trust time %s", 3409 CLK_UNIT(parse->peer), 3410 l_mktime(parse->maxunsync)); 3411 } 3412 else 3413 { 3414 parse->ppsphaseadjust = in->fudgetime2; 3415 msyslog(LOG_INFO, "PARSE receiver #%d: new PPS phase adjustment %.6f s", 3416 CLK_UNIT(parse->peer), 3417 parse->ppsphaseadjust); 3418 #if defined(HAVE_PPSAPI) 3419 if (CLK_PPS(parse->peer)) 3420 { 3421 parse_ppsapi(parse); 3422 } 3423 #endif 3424 } 3425 } 3426 } 3427 } 3428 3429 /*-------------------------------------------------- 3430 * parse_poll - called by the transmit procedure 3431 */ 3432 static void 3433 parse_poll( 3434 int unit, 3435 struct peer *peer 3436 ) 3437 { 3438 struct parseunit *parse = peer->procptr->unitptr; 3439 3440 if (peer != parse->peer) 3441 { 3442 msyslog(LOG_ERR, 3443 "PARSE receiver #%d: poll: INTERNAL: peer incorrect", 3444 unit); 3445 return; 3446 } 3447 3448 /* 3449 * Update clock stat counters 3450 */ 3451 parse->generic->polls++; 3452 3453 if (parse->pollneeddata && 3454 ((int)(current_time - parse->pollneeddata) > (1<<(max(min(parse->peer->hpoll, parse->peer->ppoll), parse->peer->minpoll))))) 3455 { 3456 /* 3457 * start worrying when exceeding a poll inteval 3458 * bad news - didn't get a response last time 3459 */ 3460 parse->lastmissed = current_time; 3461 parse_event(parse, CEVNT_TIMEOUT); 3462 3463 ERR(ERR_NODATA) 3464 msyslog(LOG_WARNING, "PARSE receiver #%d: no data from device within poll interval (check receiver / wiring)", CLK_UNIT(parse->peer)); 3465 } 3466 3467 /* 3468 * we just mark that we want the next sample for the clock filter 3469 */ 3470 parse->pollneeddata = current_time; 3471 3472 if (parse->parse_type->cl_poll) 3473 { 3474 parse->parse_type->cl_poll(parse); 3475 } 3476 3477 cparse_statistics(parse); 3478 3479 return; 3480 } 3481 3482 #define LEN_STATES 300 /* length of state string */ 3483 3484 /*-------------------------------------------------- 3485 * parse_control - set fudge factors, return statistics 3486 */ 3487 static void 3488 parse_control( 3489 int unit, 3490 const struct refclockstat *in, 3491 struct refclockstat *out, 3492 struct peer *peer 3493 ) 3494 { 3495 struct parseunit *parse = peer->procptr->unitptr; 3496 parsectl_t tmpctl; 3497 3498 static char outstatus[400]; /* status output buffer */ 3499 3500 if (out) 3501 { 3502 out->lencode = 0; 3503 out->p_lastcode = 0; 3504 out->kv_list = (struct ctl_var *)0; 3505 } 3506 3507 if (!parse || !parse->peer) 3508 { 3509 msyslog(LOG_ERR, "PARSE receiver #%d: parse_control: unit invalid (UNIT INACTIVE)", 3510 unit); 3511 return; 3512 } 3513 3514 unit = CLK_UNIT(parse->peer); 3515 3516 /* 3517 * handle changes 3518 */ 3519 parse_ctl(parse, in); 3520 3521 /* 3522 * supply data 3523 */ 3524 if (out) 3525 { 3526 u_long sum = 0; 3527 char *tt, *start; 3528 int i; 3529 3530 outstatus[0] = '\0'; 3531 3532 out->type = REFCLK_PARSE; 3533 3534 /* 3535 * keep fudgetime2 in sync with TRUSTTIME/MAXUNSYNC flag1 3536 */ 3537 parse->generic->fudgetime2 = (parse->flags & PARSE_TRUSTTIME) ? (double)parse->maxunsync : parse->ppsphaseadjust; 3538 3539 /* 3540 * figure out skew between PPS and RS232 - just for informational 3541 * purposes 3542 */ 3543 if (PARSE_SYNC(parse->timedata.parse_state)) 3544 { 3545 if (PARSE_PPS(parse->timedata.parse_state) && PARSE_TIMECODE(parse->timedata.parse_state)) 3546 { 3547 l_fp off; 3548 3549 /* 3550 * we have a PPS and RS232 signal - calculate the skew 3551 * WARNING: assumes on TIMECODE == PULSE (timecode after pulse) 3552 */ 3553 off = parse->timedata.parse_stime.fp; 3554 L_SUB(&off, &parse->timedata.parse_ptime.fp); /* true offset */ 3555 tt = add_var(&out->kv_list, 80, RO); 3556 snprintf(tt, 80, "refclock_ppsskew=%s", lfptoms(&off, 6)); 3557 } 3558 } 3559 3560 if (PARSE_PPS(parse->timedata.parse_state)) 3561 { 3562 tt = add_var(&out->kv_list, 80, RO|DEF); 3563 snprintf(tt, 80, "refclock_ppstime=\"%s\"", gmprettydate(&parse->timedata.parse_ptime.fp)); 3564 } 3565 3566 start = tt = add_var(&out->kv_list, 128, RO|DEF); 3567 tt = ap(start, 128, tt, "refclock_time=\""); 3568 3569 if (parse->timedata.parse_time.fp.l_ui == 0) 3570 { 3571 tt = ap(start, 128, tt, "<UNDEFINED>\""); 3572 } 3573 else 3574 { 3575 tt = ap(start, 128, tt, "%s\"", 3576 gmprettydate(&parse->timedata.parse_time.fp)); 3577 } 3578 3579 if (!PARSE_GETTIMECODE(parse, &tmpctl)) 3580 { 3581 ERR(ERR_INTERNAL) 3582 msyslog(LOG_ERR, "PARSE receiver #%d: parse_control: parse_timecode() FAILED", unit); 3583 } 3584 else 3585 { 3586 start = tt = add_var(&out->kv_list, 512, RO|DEF); 3587 tt = ap(start, 512, tt, "refclock_status=\""); 3588 3589 /* 3590 * copy PPS flags from last read transaction (informational only) 3591 */ 3592 tmpctl.parsegettc.parse_state |= parse->timedata.parse_state & 3593 (PARSEB_PPS|PARSEB_S_PPS); 3594 3595 (void)parsestate(tmpctl.parsegettc.parse_state, tt, BUFFER_SIZES(start, tt, 512)); 3596 3597 tt += strlen(tt); 3598 3599 tt = ap(start, 512, tt, "\""); 3600 3601 if (tmpctl.parsegettc.parse_count) 3602 mkascii(outstatus+strlen(outstatus), (int)(sizeof(outstatus)- strlen(outstatus) - 1), 3603 tmpctl.parsegettc.parse_buffer, (unsigned)(tmpctl.parsegettc.parse_count)); 3604 3605 } 3606 3607 tmpctl.parseformat.parse_format = tmpctl.parsegettc.parse_format; 3608 3609 if (!PARSE_GETFMT(parse, &tmpctl)) 3610 { 3611 ERR(ERR_INTERNAL) 3612 msyslog(LOG_ERR, "PARSE receiver #%d: parse_control: parse_getfmt() FAILED", unit); 3613 } 3614 else 3615 { 3616 int count = tmpctl.parseformat.parse_count - 1; 3617 3618 start = tt = add_var(&out->kv_list, 80, RO|DEF); 3619 tt = ap(start, 80, tt, "refclock_format=\""); 3620 3621 if (count > 0) { 3622 tt = ap(start, 80, tt, "%*.*s", 3623 count, 3624 count, 3625 tmpctl.parseformat.parse_buffer); 3626 } 3627 3628 tt = ap(start, 80, tt, "\""); 3629 } 3630 3631 /* 3632 * gather state statistics 3633 */ 3634 3635 start = tt = add_var(&out->kv_list, LEN_STATES, RO|DEF); 3636 tt = ap(start, LEN_STATES, tt, "refclock_states=\""); 3637 3638 for (i = 0; i <= CEVNT_MAX; i++) 3639 { 3640 u_long s_time; 3641 u_long d = current_time - parse->generic->timestarted; 3642 u_long percent; 3643 3644 percent = s_time = PARSE_STATETIME(parse, i); 3645 3646 while (((u_long)(~0) / 10000) < percent) 3647 { 3648 percent /= 10; 3649 d /= 10; 3650 } 3651 3652 if (d) 3653 percent = (percent * 10000) / d; 3654 else 3655 percent = 10000; 3656 3657 if (s_time) 3658 { 3659 char item[80]; 3660 int count; 3661 3662 snprintf(item, 80, "%s%s%s: %s (%d.%02d%%)", 3663 sum ? "; " : "", 3664 (parse->generic->currentstatus == i) ? "*" : "", 3665 clockstatus((unsigned int)i), 3666 l_mktime(s_time), 3667 (int)(percent / 100), (int)(percent % 100)); 3668 if ((count = (int) strlen(item)) < (LEN_STATES - 40 - (tt - start))) 3669 { 3670 tt = ap(start, LEN_STATES, tt, 3671 "%s", item); 3672 } 3673 sum += s_time; 3674 } 3675 } 3676 3677 tt = ap(start, LEN_STATES, tt, 3678 "; running time: %s\"", l_mktime(sum)); 3679 3680 tt = add_var(&out->kv_list, 32, RO); 3681 snprintf(tt, 32, "refclock_id=\"%s\"", parse->parse_type->cl_id); 3682 3683 tt = add_var(&out->kv_list, 80, RO); 3684 snprintf(tt, 80, "refclock_iomode=\"%s\"", parse->binding->bd_description); 3685 3686 tt = add_var(&out->kv_list, 128, RO); 3687 snprintf(tt, 128, "refclock_driver_version=\"%s\"", rcsid); 3688 3689 { 3690 struct ctl_var *k; 3691 3692 k = parse->kv; 3693 while (k && !(k->flags & EOV)) 3694 { 3695 set_var(&out->kv_list, k->text, strlen(k->text)+1, k->flags); 3696 k++; 3697 } 3698 } 3699 3700 out->lencode = (u_short) strlen(outstatus); 3701 out->p_lastcode = outstatus; 3702 } 3703 } 3704 3705 /**=========================================================================== 3706 ** processing routines 3707 **/ 3708 3709 /*-------------------------------------------------- 3710 * event handling - note that nominal events will also be posted 3711 * keep track of state dwelling times 3712 */ 3713 static void 3714 parse_event( 3715 struct parseunit *parse, 3716 int event 3717 ) 3718 { 3719 if (parse->generic->currentstatus != (u_char) event) 3720 { 3721 parse->statetime[parse->generic->currentstatus] += current_time - parse->lastchange; 3722 parse->lastchange = current_time; 3723 3724 if (parse->parse_type->cl_event) 3725 parse->parse_type->cl_event(parse, event); 3726 3727 if (event == CEVNT_NOMINAL) 3728 { 3729 NLOG(NLOG_CLOCKSTATUS) 3730 msyslog(LOG_INFO, "PARSE receiver #%d: SYNCHRONIZED", 3731 CLK_UNIT(parse->peer)); 3732 } 3733 3734 refclock_report(parse->peer, event); 3735 } 3736 } 3737 3738 /*-------------------------------------------------- 3739 * process a PARSE time sample 3740 */ 3741 static void 3742 parse_process( 3743 struct parseunit *parse, 3744 parsetime_t *parsetime 3745 ) 3746 { 3747 l_fp off, rectime, reftime; 3748 double fudge; 3749 3750 /* silence warning: 'off.Ul_i.Xl_i' may be used uninitialized in this function */ 3751 ZERO(off); 3752 3753 /* 3754 * check for changes in conversion status 3755 * (only one for each new status !) 3756 */ 3757 if (((parsetime->parse_status & CVT_MASK) != CVT_OK) && 3758 ((parsetime->parse_status & CVT_MASK) != CVT_NONE) && 3759 (parse->timedata.parse_status != parsetime->parse_status)) 3760 { 3761 char buffer[400]; 3762 3763 NLOG(NLOG_CLOCKINFO) /* conditional if clause for conditional syslog */ 3764 msyslog(LOG_WARNING, "PARSE receiver #%d: conversion status \"%s\"", 3765 CLK_UNIT(parse->peer), parsestatus(parsetime->parse_status, buffer, sizeof(buffer))); 3766 3767 if ((parsetime->parse_status & CVT_MASK) == CVT_FAIL) 3768 { 3769 /* 3770 * tell more about the story - list time code 3771 * there is a slight change for a race condition and 3772 * the time code might be overwritten by the next packet 3773 */ 3774 parsectl_t tmpctl; 3775 3776 if (!PARSE_GETTIMECODE(parse, &tmpctl)) 3777 { 3778 ERR(ERR_INTERNAL) 3779 msyslog(LOG_ERR, "PARSE receiver #%d: parse_process: parse_timecode() FAILED", CLK_UNIT(parse->peer)); 3780 } 3781 else 3782 { 3783 ERR(ERR_BADDATA) 3784 msyslog(LOG_WARNING, "PARSE receiver #%d: FAILED TIMECODE: \"%s\" (check receiver configuration / wiring)", 3785 CLK_UNIT(parse->peer), mkascii(buffer, sizeof buffer, tmpctl.parsegettc.parse_buffer, (unsigned)(tmpctl.parsegettc.parse_count - 1))); 3786 } 3787 /* copy status to show only changes in case of failures */ 3788 parse->timedata.parse_status = parsetime->parse_status; 3789 } 3790 } 3791 3792 /* 3793 * examine status and post appropriate events 3794 */ 3795 if ((parsetime->parse_status & CVT_MASK) != CVT_OK) 3796 { 3797 /* 3798 * got bad data - tell the rest of the system 3799 */ 3800 switch (parsetime->parse_status & CVT_MASK) 3801 { 3802 case CVT_NONE: 3803 if ((parsetime->parse_status & CVT_ADDITIONAL) && 3804 parse->parse_type->cl_message) 3805 parse->parse_type->cl_message(parse, parsetime); 3806 /* 3807 * save PPS information that comes piggyback 3808 */ 3809 if (PARSE_PPS(parsetime->parse_state)) 3810 { 3811 parse->timedata.parse_state |= PARSEB_PPS|PARSEB_S_PPS; 3812 parse->timedata.parse_ptime = parsetime->parse_ptime; 3813 } 3814 break; /* well, still waiting - timeout is handled at higher levels */ 3815 3816 case CVT_FAIL: 3817 if (parsetime->parse_status & CVT_BADFMT) 3818 { 3819 parse_event(parse, CEVNT_BADREPLY); 3820 } 3821 else 3822 if (parsetime->parse_status & CVT_BADDATE) 3823 { 3824 parse_event(parse, CEVNT_BADDATE); 3825 } 3826 else 3827 if (parsetime->parse_status & CVT_BADTIME) 3828 { 3829 parse_event(parse, CEVNT_BADTIME); 3830 } 3831 else 3832 { 3833 parse_event(parse, CEVNT_BADREPLY); /* for the lack of something better */ 3834 } 3835 } 3836 return; /* skip the rest - useless */ 3837 } 3838 3839 /* 3840 * check for format changes 3841 * (in case somebody has swapped clocks 8-) 3842 */ 3843 if (parse->lastformat != parsetime->parse_format) 3844 { 3845 parsectl_t tmpctl; 3846 3847 tmpctl.parseformat.parse_format = parsetime->parse_format; 3848 3849 if (!PARSE_GETFMT(parse, &tmpctl)) 3850 { 3851 ERR(ERR_INTERNAL) 3852 msyslog(LOG_ERR, "PARSE receiver #%d: parse_getfmt() FAILED", CLK_UNIT(parse->peer)); 3853 } 3854 else 3855 { 3856 NLOG(NLOG_CLOCKINFO) /* conditional if clause for conditional syslog */ 3857 msyslog(LOG_INFO, "PARSE receiver #%d: packet format \"%s\"", 3858 CLK_UNIT(parse->peer), tmpctl.parseformat.parse_buffer); 3859 } 3860 parse->lastformat = parsetime->parse_format; 3861 } 3862 3863 /* 3864 * now, any changes ? 3865 */ 3866 if ((parse->timedata.parse_state ^ parsetime->parse_state) & 3867 ~(unsigned)(PARSEB_PPS|PARSEB_S_PPS)) 3868 { 3869 char tmp1[200]; 3870 char tmp2[200]; 3871 /* 3872 * something happend - except for PPS events 3873 */ 3874 3875 (void) parsestate(parsetime->parse_state, tmp1, sizeof(tmp1)); 3876 (void) parsestate(parse->timedata.parse_state, tmp2, sizeof(tmp2)); 3877 3878 NLOG(NLOG_CLOCKINFO) /* conditional if clause for conditional syslog */ 3879 msyslog(LOG_INFO,"PARSE receiver #%d: STATE CHANGE: %s -> %s", 3880 CLK_UNIT(parse->peer), tmp2, tmp1); 3881 } 3882 3883 /* 3884 * carry on PPS information if still usable 3885 */ 3886 if (PARSE_PPS(parse->timedata.parse_state) && !PARSE_PPS(parsetime->parse_state)) 3887 { 3888 parsetime->parse_state |= PARSEB_PPS|PARSEB_S_PPS; 3889 parsetime->parse_ptime = parse->timedata.parse_ptime; 3890 } 3891 3892 /* 3893 * remember for future 3894 */ 3895 parse->timedata = *parsetime; 3896 3897 /* 3898 * check to see, whether the clock did a complete powerup or lost PZF signal 3899 * and post correct events for current condition 3900 */ 3901 if (PARSE_POWERUP(parsetime->parse_state)) 3902 { 3903 /* 3904 * this is bad, as we have completely lost synchronisation 3905 * well this is a problem with the receiver here 3906 * for PARSE Meinberg DCF77 receivers the lost synchronisation 3907 * is true as it is the powerup state and the time is taken 3908 * from a crude real time clock chip 3909 * for the PZF/GPS series this is only partly true, as 3910 * PARSE_POWERUP only means that the pseudo random 3911 * phase shift sequence cannot be found. this is only 3912 * bad, if we have never seen the clock in the SYNC 3913 * state, where the PHASE and EPOCH are correct. 3914 * for reporting events the above business does not 3915 * really matter, but we can use the time code 3916 * even in the POWERUP state after having seen 3917 * the clock in the synchronized state (PZF class 3918 * receivers) unless we have had a telegram disruption 3919 * after having seen the clock in the SYNC state. we 3920 * thus require having seen the clock in SYNC state 3921 * *after* having missed telegrams (noresponse) from 3922 * the clock. one problem remains: we might use erroneously 3923 * POWERUP data if the disruption is shorter than 1 polling 3924 * interval. fortunately powerdowns last usually longer than 64 3925 * seconds and the receiver is at least 2 minutes in the 3926 * POWERUP or NOSYNC state before switching to SYNC 3927 * for GPS receivers this can mean antenna problems and other causes. 3928 * the additional grace period can be enables by a clock 3929 * mode having the PARSE_F_POWERUPTRUST flag in cl_flag set. 3930 */ 3931 parse_event(parse, CEVNT_FAULT); 3932 NLOG(NLOG_CLOCKSTATUS) 3933 ERR(ERR_BADSTATUS) 3934 msyslog(LOG_ERR,"PARSE receiver #%d: NOT SYNCHRONIZED/RECEIVER PROBLEMS", 3935 CLK_UNIT(parse->peer)); 3936 } 3937 else 3938 { 3939 /* 3940 * we have two states left 3941 * 3942 * SYNC: 3943 * this state means that the EPOCH (timecode) and PHASE 3944 * information has be read correctly (at least two 3945 * successive PARSE timecodes were received correctly) 3946 * this is the best possible state - full trust 3947 * 3948 * NOSYNC: 3949 * The clock should be on phase with respect to the second 3950 * signal, but the timecode has not been received correctly within 3951 * at least the last two minutes. this is a sort of half baked state 3952 * for PARSE Meinberg DCF77 clocks this is bad news (clock running 3953 * without timecode confirmation) 3954 * PZF 535 has also no time confirmation, but the phase should be 3955 * very precise as the PZF signal can be decoded 3956 */ 3957 3958 if (PARSE_SYNC(parsetime->parse_state)) 3959 { 3960 /* 3961 * currently completely synchronized - best possible state 3962 */ 3963 parse->lastsync = current_time; 3964 clear_err(parse, ERR_BADSTATUS); 3965 } 3966 else 3967 { 3968 /* 3969 * we have had some problems receiving the time code 3970 */ 3971 parse_event(parse, CEVNT_PROP); 3972 NLOG(NLOG_CLOCKSTATUS) 3973 ERR(ERR_BADSTATUS) 3974 msyslog(LOG_ERR,"PARSE receiver #%d: TIMECODE NOT CONFIRMED", 3975 CLK_UNIT(parse->peer)); 3976 } 3977 } 3978 3979 fudge = parse->generic->fudgetime1; /* standard RS232 Fudgefactor */ 3980 3981 if (PARSE_TIMECODE(parsetime->parse_state)) 3982 { 3983 rectime = parsetime->parse_stime.fp; 3984 off = reftime = parsetime->parse_time.fp; 3985 3986 L_SUB(&off, &rectime); /* prepare for PPS adjustments logic */ 3987 3988 #ifdef DEBUG 3989 if (debug > 3) 3990 printf("PARSE receiver #%d: Reftime %s, Recvtime %s - initial offset %s\n", 3991 CLK_UNIT(parse->peer), 3992 prettydate(&reftime), 3993 prettydate(&rectime), 3994 lfptoa(&off,6)); 3995 #endif 3996 } 3997 3998 if (PARSE_PPS(parsetime->parse_state) && CLK_PPS(parse->peer)) 3999 { 4000 l_fp offset; 4001 double ppsphaseadjust = parse->ppsphaseadjust; 4002 4003 #ifdef HAVE_PPSAPI 4004 /* 4005 * set fudge = 0.0 if already included in PPS time stamps 4006 */ 4007 if (parse->atom.pps_params.mode & (PPS_OFFSETCLEAR|PPS_OFFSETASSERT)) 4008 { 4009 ppsphaseadjust = 0.0; 4010 } 4011 #endif 4012 4013 /* 4014 * we have a PPS signal - much better than the RS232 stuff (we hope) 4015 */ 4016 offset = parsetime->parse_ptime.fp; 4017 4018 #ifdef DEBUG 4019 if (debug > 3) 4020 printf("PARSE receiver #%d: PPStime %s\n", 4021 CLK_UNIT(parse->peer), 4022 prettydate(&offset)); 4023 #endif 4024 if (PARSE_TIMECODE(parsetime->parse_state)) 4025 { 4026 if (M_ISGEQ(off.l_i, off.l_uf, -1, 0x80000000) && 4027 M_ISGEQ(0, 0x7fffffff, off.l_i, off.l_uf)) 4028 { 4029 fudge = ppsphaseadjust; /* pick PPS fudge factor */ 4030 4031 /* 4032 * RS232 offsets within [-0.5..0.5[ - take PPS offsets 4033 */ 4034 4035 if (parse->parse_type->cl_flags & PARSE_F_PPSONSECOND) 4036 { 4037 reftime = off = offset; 4038 if (reftime.l_uf & 0x80000000) 4039 reftime.l_ui++; 4040 reftime.l_uf = 0; 4041 4042 4043 /* 4044 * implied on second offset 4045 */ 4046 off.l_uf = ~off.l_uf; /* map [0.5..1[ -> [-0.5..0[ */ 4047 off.l_i = (off.l_uf & 0x80000000) ? -1 : 0; /* sign extend */ 4048 } 4049 else 4050 { 4051 /* 4052 * time code describes pulse 4053 */ 4054 reftime = off = parsetime->parse_time.fp; 4055 4056 L_SUB(&off, &offset); /* true offset */ 4057 } 4058 } 4059 /* 4060 * take RS232 offset when PPS when out of bounds 4061 */ 4062 } 4063 else 4064 { 4065 fudge = ppsphaseadjust; /* pick PPS fudge factor */ 4066 /* 4067 * Well, no time code to guide us - assume on second pulse 4068 * and pray, that we are within [-0.5..0.5[ 4069 */ 4070 off = offset; 4071 reftime = offset; 4072 if (reftime.l_uf & 0x80000000) 4073 reftime.l_ui++; 4074 reftime.l_uf = 0; 4075 /* 4076 * implied on second offset 4077 */ 4078 off.l_uf = ~off.l_uf; /* map [0.5..1[ -> [-0.5..0[ */ 4079 off.l_i = (off.l_uf & 0x80000000) ? -1 : 0; /* sign extend */ 4080 } 4081 } 4082 else 4083 { 4084 if (!PARSE_TIMECODE(parsetime->parse_state)) 4085 { 4086 /* 4087 * Well, no PPS, no TIMECODE, no more work ... 4088 */ 4089 if ((parsetime->parse_status & CVT_ADDITIONAL) && 4090 parse->parse_type->cl_message) 4091 parse->parse_type->cl_message(parse, parsetime); 4092 return; 4093 } 4094 } 4095 4096 #ifdef DEBUG 4097 if (debug > 3) 4098 printf("PARSE receiver #%d: Reftime %s, Recvtime %s - final offset %s\n", 4099 CLK_UNIT(parse->peer), 4100 prettydate(&reftime), 4101 prettydate(&rectime), 4102 lfptoa(&off,6)); 4103 #endif 4104 4105 4106 rectime = reftime; 4107 L_SUB(&rectime, &off); /* just to keep the ntp interface happy */ 4108 4109 #ifdef DEBUG 4110 if (debug > 3) 4111 printf("PARSE receiver #%d: calculated Reftime %s, Recvtime %s\n", 4112 CLK_UNIT(parse->peer), 4113 prettydate(&reftime), 4114 prettydate(&rectime)); 4115 #endif 4116 4117 if ((parsetime->parse_status & CVT_ADDITIONAL) && 4118 parse->parse_type->cl_message) 4119 parse->parse_type->cl_message(parse, parsetime); 4120 4121 if (PARSE_SYNC(parsetime->parse_state)) 4122 { 4123 /* 4124 * log OK status 4125 */ 4126 parse_event(parse, CEVNT_NOMINAL); 4127 } 4128 4129 clear_err(parse, ERR_BADIO); 4130 clear_err(parse, ERR_BADDATA); 4131 clear_err(parse, ERR_NODATA); 4132 clear_err(parse, ERR_INTERNAL); 4133 4134 /* 4135 * and now stick it into the clock machine 4136 * samples are only valid iff lastsync is not too old and 4137 * we have seen the clock in sync at least once 4138 * after the last time we didn't see an expected data telegram 4139 * at startup being not in sync is also bad just like 4140 * POWERUP state unless PARSE_F_POWERUPTRUST is set 4141 * see the clock states section above for more reasoning 4142 */ 4143 if (((current_time - parse->lastsync) > parse->maxunsync) || 4144 (parse->lastsync < parse->lastmissed) || 4145 ((parse->lastsync == 0) && !PARSE_SYNC(parsetime->parse_state)) || 4146 (((parse->parse_type->cl_flags & PARSE_F_POWERUPTRUST) == 0) && 4147 PARSE_POWERUP(parsetime->parse_state))) 4148 { 4149 parse->generic->leap = LEAP_NOTINSYNC; 4150 parse->lastsync = 0; /* wait for full sync again */ 4151 } 4152 else 4153 { 4154 if (PARSE_LEAPADD(parsetime->parse_state)) 4155 { 4156 /* 4157 * we pick this state also for time code that pass leap warnings 4158 * without direction information (as earth is currently slowing 4159 * down). 4160 */ 4161 parse->generic->leap = (parse->flags & PARSE_LEAP_DELETE) ? LEAP_DELSECOND : LEAP_ADDSECOND; 4162 } 4163 else 4164 if (PARSE_LEAPDEL(parsetime->parse_state)) 4165 { 4166 parse->generic->leap = LEAP_DELSECOND; 4167 } 4168 else 4169 { 4170 parse->generic->leap = LEAP_NOWARNING; 4171 } 4172 } 4173 4174 if (parse->generic->leap != LEAP_NOTINSYNC) 4175 { 4176 /* 4177 * only good/trusted samples are interesting 4178 */ 4179 #ifdef DEBUG 4180 if (debug > 2) 4181 { 4182 printf("PARSE receiver #%d: refclock_process_offset(reftime=%s, rectime=%s, Fudge=%f)\n", 4183 CLK_UNIT(parse->peer), 4184 prettydate(&reftime), 4185 prettydate(&rectime), 4186 fudge); 4187 } 4188 #endif 4189 parse->generic->lastref = reftime; 4190 4191 refclock_process_offset(parse->generic, reftime, rectime, fudge); 4192 4193 #ifdef HAVE_PPSAPI 4194 /* 4195 * pass PPS information on to PPS clock 4196 */ 4197 if (PARSE_PPS(parsetime->parse_state) && CLK_PPS(parse->peer)) 4198 { 4199 parse->peer->flags |= (FLAG_PPS | FLAG_TSTAMP_PPS); 4200 parse_hardpps(parse, PARSE_HARDPPS_ENABLE); 4201 } 4202 #endif 4203 } else { 4204 parse_hardpps(parse, PARSE_HARDPPS_DISABLE); 4205 parse->peer->flags &= ~(FLAG_PPS | FLAG_TSTAMP_PPS); 4206 } 4207 4208 /* 4209 * ready, unless the machine wants a sample or 4210 * we are in fast startup mode (peer->dist > MAXDISTANCE) 4211 */ 4212 if (!parse->pollneeddata && parse->peer->disp <= MAXDISTANCE) 4213 return; 4214 4215 parse->pollneeddata = 0; 4216 4217 parse->timedata.parse_state &= ~(unsigned)(PARSEB_PPS|PARSEB_S_PPS); 4218 4219 refclock_receive(parse->peer); 4220 } 4221 4222 /**=========================================================================== 4223 ** special code for special clocks 4224 **/ 4225 4226 static void 4227 mk_utcinfo( 4228 char *t, // pointer to the output string buffer 4229 int swnt, 4230 int swnlsf, 4231 int dn, 4232 int dtls, 4233 int dtlsf, 4234 int size // size of the output string buffer 4235 ) 4236 { 4237 unsigned int wnt = swnt; 4238 unsigned int wnlsf = swnlsf; 4239 /* 4240 * The week number transmitted by the GPS satellites for the leap date 4241 * is truncated to 8 bits only. If the nearest leap second date is off 4242 * the current date by more than +/- 128 weeks then conversion to a 4243 * calendar date is ambiguous. On the other hand, if a leap second is 4244 * currently being announced (i.e. dtlsf != dtls) then the week number 4245 * wnlsf is close enough, and we can unambiguously determine the date 4246 * for which the leap second is scheduled. 4247 */ 4248 if ( dtlsf != dtls ) 4249 { 4250 time_t t_ls; 4251 struct tm *tm; 4252 int n = 0; 4253 4254 if (wnlsf < GPSWRAP) 4255 wnlsf += GPSWEEKS; 4256 4257 if (wnt < GPSWRAP) 4258 wnt += GPSWEEKS; 4259 4260 t_ls = (time_t) wnlsf * SECSPERWEEK 4261 + (time_t) dn * SECSPERDAY 4262 + GPS_SEC_BIAS - 1; 4263 4264 tm = gmtime( &t_ls ); 4265 if (tm == NULL) // gmtime() failed 4266 { 4267 snprintf( t, size, "** (gmtime() failed in mk_utcinfo())" ); 4268 return; 4269 } 4270 4271 n += snprintf( t, size, "UTC offset transition from %is to %is due to leap second %s", 4272 dtls, dtlsf, ( dtls < dtlsf ) ? "insertion" : "deletion" ); 4273 n += snprintf( t + n, size - n, " at UTC midnight at the end of %s, %04i-%02i-%02i", 4274 daynames[tm->tm_wday], tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday ); 4275 } 4276 else 4277 snprintf( t, size, "UTC offset parameter: %is, no leap second announced.\n", dtls ); 4278 4279 } 4280 4281 #ifdef CLOCK_MEINBERG 4282 /**=========================================================================== 4283 ** Meinberg GPS receiver support 4284 **/ 4285 4286 /*------------------------------------------------------------ 4287 * gps16x_message - process messages from Meinberg GPS receiver 4288 */ 4289 static void 4290 gps16x_message( 4291 struct parseunit *parse, 4292 parsetime_t *parsetime 4293 ) 4294 { 4295 if (parse->timedata.parse_msglen && parsetime->parse_msg[0] == SOH) 4296 { 4297 GPS_MSG_HDR header; 4298 unsigned char *bufp = (unsigned char *)parsetime->parse_msg + 1; 4299 4300 #ifdef DEBUG 4301 if (debug > 2) 4302 { 4303 char msgbuffer[600]; 4304 4305 mkreadable(msgbuffer, sizeof(msgbuffer), (char *)parsetime->parse_msg, parsetime->parse_msglen, 1); 4306 printf("PARSE receiver #%d: received message (%d bytes) >%s<\n", 4307 CLK_UNIT(parse->peer), 4308 parsetime->parse_msglen, 4309 msgbuffer); 4310 } 4311 #endif 4312 get_mbg_header(&bufp, &header); 4313 if (header.hdr_csum == mbg_csum(parsetime->parse_msg + 1, 6) && 4314 (header.len == 0 || 4315 (header.len < sizeof(parsetime->parse_msg) && 4316 header.data_csum == mbg_csum(bufp, header.len)))) 4317 { 4318 /* 4319 * clean message 4320 */ 4321 switch (header.cmd) 4322 { 4323 case GPS_SW_REV: 4324 { 4325 char buffer[64]; 4326 SW_REV gps_sw_rev; 4327 4328 get_mbg_sw_rev(&bufp, &gps_sw_rev); 4329 snprintf(buffer, sizeof(buffer), "meinberg_gps_version=\"%x.%02x%s%s\"", 4330 (gps_sw_rev.code >> 8) & 0xFF, 4331 gps_sw_rev.code & 0xFF, 4332 gps_sw_rev.name[0] ? " " : "", 4333 gps_sw_rev.name); 4334 set_var(&parse->kv, buffer, strlen(buffer)+1, RO|DEF); 4335 } 4336 break; 4337 4338 case GPS_BVAR_STAT: 4339 { 4340 static struct state 4341 { 4342 BVAR_STAT flag; /* status flag */ 4343 const char *string; /* bit name */ 4344 } states[] = 4345 { 4346 { BVAR_CFGH_INVALID, "Configuration/Health" }, 4347 { BVAR_ALM_NOT_COMPLETE, "Almanachs" }, 4348 { BVAR_UTC_INVALID, "UTC Correction" }, 4349 { BVAR_IONO_INVALID, "Ionospheric Correction" }, 4350 { BVAR_RCVR_POS_INVALID, "Receiver Position" }, 4351 { 0, "" } 4352 }; 4353 BVAR_STAT status; 4354 struct state *s = states; 4355 char buffer[512]; 4356 char *p, *b; 4357 4358 status = (BVAR_STAT) get_lsb_short(&bufp); 4359 p = b = buffer; 4360 p = ap(buffer, sizeof(buffer), p, 4361 "meinberg_gps_status=\"[0x%04x] ", 4362 status); 4363 4364 if (status) 4365 { 4366 p = ap(buffer, sizeof(buffer), p, "incomplete buffered data: "); 4367 b = p; 4368 while (s->flag) 4369 { 4370 if (status & s->flag) 4371 { 4372 if (p != b) 4373 { 4374 p = ap(buffer, sizeof(buffer), p, ", "); 4375 } 4376 4377 p = ap(buffer, sizeof(buffer), p, "%s", (const char *)s->string); 4378 } 4379 s++; 4380 } 4381 p = ap(buffer, sizeof(buffer), p, "\""); 4382 } 4383 else 4384 { 4385 p = ap(buffer, sizeof(buffer), p, "<all buffered data complete>\""); 4386 } 4387 4388 set_var(&parse->kv, buffer, strlen(buffer)+1, RO|DEF); 4389 } 4390 break; 4391 4392 case GPS_POS_XYZ: 4393 { 4394 XYZ xyz; 4395 char buffer[256]; 4396 4397 get_mbg_xyz(&bufp, xyz); 4398 snprintf(buffer, sizeof(buffer), "gps_position(XYZ)=\"%s m, %s m, %s m\"", 4399 mfptoa(xyz[XP].l_ui, xyz[XP].l_uf, 1), 4400 mfptoa(xyz[YP].l_ui, xyz[YP].l_uf, 1), 4401 mfptoa(xyz[ZP].l_ui, xyz[ZP].l_uf, 1)); 4402 4403 set_var(&parse->kv, buffer, sizeof(buffer), RO|DEF); 4404 } 4405 break; 4406 4407 case GPS_POS_LLA: 4408 { 4409 LLA lla; 4410 char buffer[256]; 4411 4412 get_mbg_lla(&bufp, lla); 4413 4414 snprintf(buffer, sizeof(buffer), "gps_position(LLA)=\"%s deg, %s deg, %s m\"", 4415 mfptoa(lla[LAT].l_ui, lla[LAT].l_uf, 4), 4416 mfptoa(lla[LON].l_ui, lla[LON].l_uf, 4), 4417 mfptoa(lla[ALT].l_ui, lla[ALT].l_uf, 1)); 4418 4419 set_var(&parse->kv, buffer, sizeof(buffer), RO|DEF); 4420 } 4421 break; 4422 4423 case GPS_TZDL: 4424 break; 4425 4426 case GPS_PORT_PARM: 4427 break; 4428 4429 case GPS_SYNTH: 4430 break; 4431 4432 case GPS_ANT_INFO: 4433 { 4434 ANT_INFO antinfo; 4435 char buffer[512]; 4436 char *p, *q; 4437 4438 get_mbg_antinfo(&bufp, &antinfo); 4439 p = buffer; 4440 p = ap(buffer, sizeof(buffer), p, "meinberg_antenna_status=\""); 4441 switch (antinfo.status) 4442 { 4443 case ANT_INVALID: // No other fields valid since antenna has not yet been disconnected 4444 p = ap(buffer, sizeof(buffer), 4445 p, "<OK>"); 4446 break; 4447 4448 case ANT_DISCONN: // Antenna is disconnected, tm_reconn and delta_t not yet set 4449 q = ap(buffer, sizeof(buffer), 4450 p, "DISCONNECTED since "); 4451 NLOG(NLOG_CLOCKSTATUS) 4452 ERR(ERR_BADSTATUS) 4453 msyslog(LOG_ERR,"PARSE receiver #%d: ANTENNA FAILURE: %s", 4454 CLK_UNIT(parse->peer), p); 4455 4456 p = q; 4457 mbg_tm_str(&p, &antinfo.tm_disconn, BUFFER_SIZE(buffer, p), 0); 4458 *p = '\0'; 4459 break; 4460 4461 case ANT_RECONN: // Antenna had been disconnect, but receiver sync. after reconnect, so all fields valid 4462 p = ap(buffer, sizeof(buffer), 4463 p, "SYNC AFTER RECONNECT on "); 4464 mbg_tm_str(&p, &antinfo.tm_reconn, BUFFER_SIZE(buffer, p), 0); 4465 p = ap(buffer, sizeof(buffer), 4466 p, ", clock offset at reconnect %c%ld.%07ld s, disconnect time ", 4467 (antinfo.delta_t < 0) ? '-' : '+', 4468 (long) ABS(antinfo.delta_t) / 10000, 4469 (long) ABS(antinfo.delta_t) % 10000); 4470 mbg_tm_str(&p, &antinfo.tm_disconn, BUFFER_SIZE(buffer, p), 0); 4471 *p = '\0'; 4472 break; 4473 4474 default: 4475 p = ap(buffer, sizeof(buffer), 4476 p, "bad status 0x%04x", 4477 antinfo.status); 4478 break; 4479 } 4480 4481 p = ap(buffer, sizeof(buffer), p, "\""); 4482 4483 set_var(&parse->kv, buffer, sizeof(buffer), RO|DEF); 4484 } 4485 break; 4486 4487 case GPS_UCAP: 4488 break; 4489 4490 case GPS_CFGH: 4491 { 4492 CFGH cfgh; 4493 char buffer[512]; 4494 char *p; 4495 4496 get_mbg_cfgh(&bufp, &cfgh); 4497 if (cfgh.valid) 4498 { 4499 const char *cp; 4500 uint16_t tmp_val; 4501 int i; 4502 4503 p = buffer; 4504 p = ap(buffer, sizeof(buffer), 4505 p, "gps_tot_51=\""); 4506 mbg_tgps_str(&p, &cfgh.tot_51, BUFFER_SIZE(buffer, p)); 4507 p = ap(buffer, sizeof(buffer), 4508 p, "\""); 4509 set_var(&parse->kv, buffer, sizeof(buffer), RO|COND_DEF); 4510 4511 p = buffer; 4512 p = ap(buffer, sizeof(buffer), 4513 p, "gps_tot_63=\""); 4514 mbg_tgps_str(&p, &cfgh.tot_63, BUFFER_SIZE(buffer, p)); 4515 p = ap(buffer, sizeof(buffer), 4516 p, "\""); 4517 set_var(&parse->kv, buffer, sizeof(buffer), RO|COND_DEF); 4518 4519 p = buffer; 4520 p = ap(buffer, sizeof(buffer), 4521 p, "gps_t0a=\""); 4522 mbg_tgps_str(&p, &cfgh.t0a, BUFFER_SIZE(buffer, p)); 4523 p = ap(buffer, sizeof(buffer), 4524 p, "\""); 4525 set_var(&parse->kv, buffer, sizeof(buffer), RO|COND_DEF); 4526 4527 for (i = 0; i < N_SVNO_GPS; i++) 4528 { 4529 p = buffer; 4530 p = ap(buffer, sizeof(buffer), p, "sv_info[%d]=\"PRN%d", i, i + N_SVNO_GPS); 4531 4532 tmp_val = cfgh.health[i]; /* a 6 bit SV health code */ 4533 p = ap(buffer, sizeof(buffer), p, "; health=0x%02x (", tmp_val); 4534 /* "All Ones" has a special meaning" */ 4535 if (tmp_val == 0x3F) /* satellite is unusable or doesn't even exist */ 4536 cp = "SV UNAVAILABLE"; 4537 else { 4538 /* The MSB contains a summary of the 3 MSBs of the 8 bit health code, 4539 * indicating if the data sent by the satellite is OK or not. */ 4540 p = ap(buffer, sizeof(buffer), p, "DATA %s, ", (tmp_val & 0x20) ? "BAD" : "OK" ); 4541 4542 /* The 5 LSBs contain the status of the different signals sent by the satellite. */ 4543 switch (tmp_val & 0x1F) 4544 { 4545 case 0x00: cp = "SIGNAL OK"; break; 4546 /* codes 0x01 through 0x1B indicate that one or more 4547 * specific signal components are weak or dead. 4548 * We don't decode this here in detail. */ 4549 case 0x1C: cp = "SV IS TEMP OUT"; break; 4550 case 0x1D: cp = "SV WILL BE TEMP OUT"; break; 4551 default: cp = "TRANSMISSION PROBLEMS"; break; 4552 } 4553 } 4554 p = ap(buffer, sizeof(buffer), p, "%s)", cp ); 4555 4556 tmp_val = cfgh.cfg[i]; /* a 4 bit SV configuration/type code */ 4557 p = ap(buffer, sizeof(buffer), p, "; cfg=0x%02x (", tmp_val); 4558 switch (tmp_val & 0x7) 4559 { 4560 case 0x00: cp = "(reserved)"; break; 4561 case 0x01: cp = "BLOCK II/IIA/IIR"; break; 4562 case 0x02: cp = "BLOCK IIR-M"; break; 4563 case 0x03: cp = "BLOCK IIF"; break; 4564 case 0x04: cp = "BLOCK III"; break; 4565 default: cp = "unknown SV type"; break; 4566 } 4567 p = ap(buffer, sizeof(buffer), p, "%s", cp ); 4568 if (tmp_val & 0x08) /* A-S is on, P-code is encrypted */ 4569 p = ap( buffer, sizeof(buffer), p, ", A-S on" ); 4570 4571 p = ap(buffer, sizeof(buffer), p, ")\""); 4572 set_var(&parse->kv, buffer, sizeof(buffer), RO|COND_DEF); 4573 } 4574 } 4575 } 4576 break; 4577 4578 case GPS_ALM: 4579 break; 4580 4581 case GPS_EPH: 4582 break; 4583 4584 case GPS_UTC: 4585 { 4586 UTC utc; 4587 char buffer[512]; 4588 char *p; 4589 4590 p = buffer; 4591 4592 get_mbg_utc(&bufp, &utc); 4593 4594 if (utc.valid) 4595 { 4596 p = ap(buffer, sizeof(buffer), p, "gps_utc_correction=\""); 4597 mk_utcinfo(p, utc.t0t.wn, utc.WNlsf, utc.DNt, utc.delta_tls, utc.delta_tlsf, BUFFER_SIZE(buffer, p)); 4598 p += strlen(p); 4599 p = ap(buffer, sizeof(buffer), p, "\""); 4600 } 4601 else 4602 { 4603 p = ap(buffer, sizeof(buffer), p, "gps_utc_correction=\"<NO UTC DATA>\""); 4604 } 4605 set_var(&parse->kv, buffer, sizeof(buffer), RO|DEF); 4606 } 4607 break; 4608 4609 case GPS_IONO: 4610 break; 4611 4612 case GPS_ASCII_MSG: 4613 { 4614 ASCII_MSG gps_ascii_msg; 4615 char buffer[128]; 4616 4617 get_mbg_ascii_msg(&bufp, &gps_ascii_msg); 4618 4619 if (gps_ascii_msg.valid) 4620 { 4621 char buffer1[128]; 4622 mkreadable(buffer1, sizeof(buffer1), gps_ascii_msg.s, strlen(gps_ascii_msg.s), (int)0); 4623 4624 snprintf(buffer, sizeof(buffer), "gps_message=\"%s\"", buffer1); 4625 } 4626 else 4627 snprintf(buffer, sizeof(buffer), "gps_message=<NONE>"); 4628 4629 set_var(&parse->kv, buffer, sizeof(buffer), RO|DEF); 4630 } 4631 4632 break; 4633 4634 default: 4635 break; 4636 } 4637 } 4638 else 4639 { 4640 msyslog(LOG_DEBUG, "PARSE receiver #%d: gps16x_message: message checksum error: hdr_csum = 0x%x (expected 0x%x), " 4641 "data_len = %d, data_csum = 0x%x (expected 0x%x)", 4642 CLK_UNIT(parse->peer), 4643 header.hdr_csum, mbg_csum(parsetime->parse_msg + 1, 6), 4644 header.len, 4645 header.data_csum, mbg_csum(bufp, (unsigned)((header.len < sizeof(parsetime->parse_msg)) ? header.len : 0))); 4646 } 4647 } 4648 4649 return; 4650 } 4651 4652 /*------------------------------------------------------------ 4653 * gps16x_poll - query the reciver peridically 4654 */ 4655 static void 4656 gps16x_poll( 4657 struct peer *peer 4658 ) 4659 { 4660 struct parseunit *parse = peer->procptr->unitptr; 4661 4662 static GPS_MSG_HDR sequence[] = 4663 { 4664 { GPS_SW_REV, 0, 0, 0 }, 4665 { GPS_BVAR_STAT, 0, 0, 0 }, 4666 { GPS_UTC, 0, 0, 0 }, 4667 { GPS_ASCII_MSG, 0, 0, 0 }, 4668 { GPS_ANT_INFO, 0, 0, 0 }, 4669 { GPS_CFGH, 0, 0, 0 }, 4670 { GPS_POS_XYZ, 0, 0, 0 }, 4671 { GPS_POS_LLA, 0, 0, 0 }, 4672 { (unsigned short)~0, 0, 0, 0 } 4673 }; 4674 4675 int rtc; 4676 unsigned char cmd_buffer[64]; 4677 unsigned char *outp = cmd_buffer; 4678 GPS_MSG_HDR *header; 4679 4680 if (((poll_info_t *)parse->parse_type->cl_data)->rate) 4681 { 4682 parse->peer->procptr->nextaction = current_time + ((poll_info_t *)parse->parse_type->cl_data)->rate; 4683 } 4684 4685 if (sequence[parse->localstate].cmd == (unsigned short)~0) 4686 parse->localstate = 0; 4687 4688 header = sequence + parse->localstate++; 4689 4690 *outp++ = SOH; /* start command */ 4691 4692 put_mbg_header(&outp, header); 4693 outp = cmd_buffer + 1; 4694 4695 header->hdr_csum = (short)mbg_csum(outp, 6); 4696 put_mbg_header(&outp, header); 4697 4698 #ifdef DEBUG 4699 if (debug > 2) 4700 { 4701 char buffer[128]; 4702 4703 mkreadable(buffer, sizeof(buffer), (char *)cmd_buffer, (unsigned)(outp - cmd_buffer), 1); 4704 printf("PARSE receiver #%d: transmitted message #%ld (%d bytes) >%s<\n", 4705 CLK_UNIT(parse->peer), 4706 parse->localstate - 1, 4707 (int)(outp - cmd_buffer), 4708 buffer); 4709 } 4710 #endif 4711 4712 rtc = (int) write(parse->generic->io.fd, cmd_buffer, (unsigned long)(outp - cmd_buffer)); 4713 4714 if (rtc < 0) 4715 { 4716 ERR(ERR_BADIO) 4717 msyslog(LOG_ERR, "PARSE receiver #%d: gps16x_poll: failed to send cmd to clock: %m", CLK_UNIT(parse->peer)); 4718 } 4719 else 4720 if (rtc != outp - cmd_buffer) 4721 { 4722 ERR(ERR_BADIO) 4723 msyslog(LOG_ERR, "PARSE receiver #%d: gps16x_poll: failed to send cmd incomplete (%d of %d bytes sent)", CLK_UNIT(parse->peer), rtc, (int)(outp - cmd_buffer)); 4724 } 4725 4726 clear_err(parse, ERR_BADIO); 4727 return; 4728 } 4729 4730 /*-------------------------------------------------- 4731 * init routine - setup timer 4732 */ 4733 static int 4734 gps16x_poll_init( 4735 struct parseunit *parse 4736 ) 4737 { 4738 if (((poll_info_t *)parse->parse_type->cl_data)->rate) 4739 { 4740 parse->peer->procptr->action = gps16x_poll; 4741 gps16x_poll(parse->peer); 4742 } 4743 4744 return 0; 4745 } 4746 4747 #else 4748 static void 4749 gps16x_message( 4750 struct parseunit *parse, 4751 parsetime_t *parsetime 4752 ) 4753 {} 4754 static int 4755 gps16x_poll_init( 4756 struct parseunit *parse 4757 ) 4758 { 4759 return 1; 4760 } 4761 #endif /* CLOCK_MEINBERG */ 4762 4763 /**=========================================================================== 4764 ** clock polling support 4765 **/ 4766 4767 /*-------------------------------------------------- 4768 * direct poll routine 4769 */ 4770 static void 4771 poll_dpoll( 4772 struct parseunit *parse 4773 ) 4774 { 4775 long rtc; 4776 const char *ps = ((poll_info_t *)parse->parse_type->cl_data)->string; 4777 long ct = ((poll_info_t *)parse->parse_type->cl_data)->count; 4778 4779 rtc = write(parse->generic->io.fd, ps, ct); 4780 if (rtc < 0) 4781 { 4782 ERR(ERR_BADIO) 4783 msyslog(LOG_ERR, "PARSE receiver #%d: poll_dpoll: failed to send cmd to clock: %m", CLK_UNIT(parse->peer)); 4784 } 4785 else 4786 if (rtc != ct) 4787 { 4788 ERR(ERR_BADIO) 4789 msyslog(LOG_ERR, "PARSE receiver #%d: poll_dpoll: failed to send cmd incomplete (%ld of %ld bytes sent)", CLK_UNIT(parse->peer), rtc, ct); 4790 } 4791 clear_err(parse, ERR_BADIO); 4792 } 4793 4794 /*-------------------------------------------------- 4795 * periodic poll routine 4796 */ 4797 static void 4798 poll_poll( 4799 struct peer *peer 4800 ) 4801 { 4802 struct parseunit *parse = peer->procptr->unitptr; 4803 4804 if (parse->parse_type->cl_poll) 4805 parse->parse_type->cl_poll(parse); 4806 4807 if (((poll_info_t *)parse->parse_type->cl_data)->rate) 4808 { 4809 parse->peer->procptr->nextaction = current_time + ((poll_info_t *)parse->parse_type->cl_data)->rate; 4810 } 4811 } 4812 4813 /*-------------------------------------------------- 4814 * init routine - setup timer 4815 */ 4816 static int 4817 poll_init( 4818 struct parseunit *parse 4819 ) 4820 { 4821 if (((poll_info_t *)parse->parse_type->cl_data)->rate) 4822 { 4823 parse->peer->procptr->action = poll_poll; 4824 poll_poll(parse->peer); 4825 } 4826 4827 return 0; 4828 } 4829 4830 /**=========================================================================== 4831 ** Trimble support 4832 **/ 4833 4834 /*------------------------------------------------------------- 4835 * trimble TAIP init routine - setup EOL and then do poll_init. 4836 */ 4837 static int 4838 trimbletaip_init( 4839 struct parseunit *parse 4840 ) 4841 { 4842 #ifdef HAVE_TERMIOS 4843 struct termios tio; 4844 #endif 4845 #ifdef HAVE_SYSV_TTYS 4846 struct termio tio; 4847 #endif 4848 /* 4849 * configure terminal line for trimble receiver 4850 */ 4851 if (TTY_GETATTR(parse->generic->io.fd, &tio) == -1) 4852 { 4853 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletaip_init: tcgetattr(fd, &tio): %m", CLK_UNIT(parse->peer)); 4854 return 0; 4855 } 4856 else 4857 { 4858 tio.c_cc[VEOL] = TRIMBLETAIP_EOL; 4859 4860 if (TTY_SETATTR(parse->generic->io.fd, &tio) == -1) 4861 { 4862 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletaip_init: tcsetattr(fd, &tio): %m", CLK_UNIT(parse->peer)); 4863 return 0; 4864 } 4865 } 4866 return poll_init(parse); 4867 } 4868 4869 /*-------------------------------------------------- 4870 * trimble TAIP event routine - reset receiver upon data format trouble 4871 */ 4872 static const char *taipinit[] = { 4873 ">FPV00000000<", 4874 ">SRM;ID_FLAG=F;CS_FLAG=T;EC_FLAG=F;FR_FLAG=T;CR_FLAG=F<", 4875 ">FTM00020001<", 4876 (char *)0 4877 }; 4878 4879 static void 4880 trimbletaip_event( 4881 struct parseunit *parse, 4882 int event 4883 ) 4884 { 4885 switch (event) 4886 { 4887 case CEVNT_BADREPLY: /* reset on garbled input */ 4888 case CEVNT_TIMEOUT: /* reset on no input */ 4889 { 4890 const char **iv; 4891 4892 iv = taipinit; 4893 while (*iv) 4894 { 4895 int rtc = (int) write(parse->generic->io.fd, *iv, strlen(*iv)); 4896 if (rtc < 0) 4897 { 4898 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletaip_event: failed to send cmd to clock: %m", CLK_UNIT(parse->peer)); 4899 return; 4900 } 4901 else 4902 { 4903 if (rtc != (int)strlen(*iv)) 4904 { 4905 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletaip_event: failed to send cmd incomplete (%d of %d bytes sent)", 4906 CLK_UNIT(parse->peer), rtc, (int)strlen(*iv)); 4907 return; 4908 } 4909 } 4910 iv++; 4911 } 4912 4913 NLOG(NLOG_CLOCKINFO) 4914 ERR(ERR_BADIO) 4915 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletaip_event: RECEIVER INITIALIZED", 4916 CLK_UNIT(parse->peer)); 4917 } 4918 break; 4919 4920 default: /* ignore */ 4921 break; 4922 } 4923 } 4924 4925 /* 4926 * This driver supports the Trimble SVee Six Plus GPS receiver module. 4927 * It should support other Trimble receivers which use the Trimble Standard 4928 * Interface Protocol (see below). 4929 * 4930 * The module has a serial I/O port for command/data and a 1 pulse-per-second 4931 * output, about 1 microsecond wide. The leading edge of the pulse is 4932 * coincident with the change of the GPS second. This is the same as 4933 * the change of the UTC second +/- ~1 microsecond. Some other clocks 4934 * specifically use a feature in the data message as a timing reference, but 4935 * the SVee Six Plus does not do this. In fact there is considerable jitter 4936 * on the timing of the messages, so this driver only supports the use 4937 * of the PPS pulse for accurate timing. Where it is determined that 4938 * the offset is way off, when first starting up ntpd for example, 4939 * the timing of the data stream is used until the offset becomes low enough 4940 * (|offset| < CLOCK_MAX), at which point the pps offset is used. 4941 * 4942 * It can use either option for receiving PPS information - the 'ppsclock' 4943 * stream pushed onto the serial data interface to timestamp the Carrier 4944 * Detect interrupts, where the 1PPS connects to the CD line. This only 4945 * works on SunOS 4.1.x currently. To select this, define PPSPPS in 4946 * Config.local. The other option is to use a pulse-stretcher/level-converter 4947 * to convert the PPS pulse into a RS232 start pulse & feed this into another 4948 * tty port. To use this option, define PPSCLK in Config.local. The pps input, 4949 * by whichever method, is handled in ntp_loopfilter.c 4950 * 4951 * The receiver uses a serial message protocol called Trimble Standard 4952 * Interface Protocol (it can support others but this driver only supports 4953 * TSIP). Messages in this protocol have the following form: 4954 * 4955 * <DLE><id> ... <data> ... <DLE><ETX> 4956 * 4957 * Any bytes within the <data> portion of value 10 hex (<DLE>) are doubled 4958 * on transmission and compressed back to one on reception. Otherwise 4959 * the values of data bytes can be anything. The serial interface is RS-422 4960 * asynchronous using 9600 baud, 8 data bits with odd party (**note** 9 bits 4961 * in total!), and 1 stop bit. The protocol supports byte, integer, single, 4962 * and double datatypes. Integers are two bytes, sent most significant first. 4963 * Singles are IEEE754 single precision floating point numbers (4 byte) sent 4964 * sign & exponent first. Doubles are IEEE754 double precision floating point 4965 * numbers (8 byte) sent sign & exponent first. 4966 * The receiver supports a large set of messages, only a small subset of 4967 * which are used here. From driver to receiver the following are used: 4968 * 4969 * ID Description 4970 * 4971 * 21 Request current time 4972 * 22 Mode Select 4973 * 2C Set/Request operating parameters 4974 * 2F Request UTC info 4975 * 35 Set/Request I/O options 4976 4977 * From receiver to driver the following are recognised: 4978 * 4979 * ID Description 4980 * 4981 * 41 GPS Time 4982 * 44 Satellite selection, PDOP, mode 4983 * 46 Receiver health 4984 * 4B Machine code/status 4985 * 4C Report operating parameters (debug only) 4986 * 4F UTC correction data (used to get leap second warnings) 4987 * 55 I/O options (debug only) 4988 * 4989 * All others are accepted but ignored. 4990 * 4991 */ 4992 4993 #define PI 3.1415926535898 /* lots of sig figs */ 4994 #define D2R PI/180.0 4995 4996 /*------------------------------------------------------------------- 4997 * sendcmd, sendbyte, sendetx, sendflt, sendint implement the command 4998 * interface to the receiver. 4999 * 5000 * CAVEAT: the sendflt, sendint routines are byte order dependend and 5001 * float implementation dependend - these must be converted to portable 5002 * versions ! 5003 * 5004 * CURRENT LIMITATION: float implementation. This runs only on systems 5005 * with IEEE754 floats as native floats 5006 */ 5007 5008 typedef struct trimble 5009 { 5010 u_long last_msg; /* last message received */ 5011 u_long last_reset; /* last time a reset was issued */ 5012 u_char qtracking; /* query tracking status */ 5013 u_long ctrack; /* current tracking set */ 5014 u_long ltrack; /* last tracking set */ 5015 } trimble_t; 5016 5017 union uval { 5018 u_char bd[8]; 5019 int iv; 5020 float fv; 5021 double dv; 5022 }; 5023 5024 struct txbuf 5025 { 5026 short idx; /* index to first unused byte */ 5027 u_char *txt; /* pointer to actual data buffer */ 5028 }; 5029 5030 void sendcmd (struct txbuf *buf, int c); 5031 void sendbyte (struct txbuf *buf, int b); 5032 void sendetx (struct txbuf *buf, struct parseunit *parse); 5033 void sendint (struct txbuf *buf, int a); 5034 void sendflt (struct txbuf *buf, double a); 5035 5036 void 5037 sendcmd( 5038 struct txbuf *buf, 5039 int c 5040 ) 5041 { 5042 buf->txt[0] = DLE; 5043 buf->txt[1] = (u_char)c; 5044 buf->idx = 2; 5045 } 5046 5047 void sendcmd (struct txbuf *buf, int c); 5048 void sendbyte (struct txbuf *buf, int b); 5049 void sendetx (struct txbuf *buf, struct parseunit *parse); 5050 void sendint (struct txbuf *buf, int a); 5051 void sendflt (struct txbuf *buf, double a); 5052 5053 void 5054 sendbyte( 5055 struct txbuf *buf, 5056 int b 5057 ) 5058 { 5059 if (b == DLE) 5060 buf->txt[buf->idx++] = DLE; 5061 buf->txt[buf->idx++] = (u_char)b; 5062 } 5063 5064 void 5065 sendetx( 5066 struct txbuf *buf, 5067 struct parseunit *parse 5068 ) 5069 { 5070 buf->txt[buf->idx++] = DLE; 5071 buf->txt[buf->idx++] = ETX; 5072 5073 if (write(parse->generic->io.fd, buf->txt, (unsigned long)buf->idx) != buf->idx) 5074 { 5075 ERR(ERR_BADIO) 5076 msyslog(LOG_ERR, "PARSE receiver #%d: sendetx: failed to send cmd to clock: %m", CLK_UNIT(parse->peer)); 5077 } 5078 else 5079 { 5080 #ifdef DEBUG 5081 if (debug > 2) 5082 { 5083 char buffer[256]; 5084 5085 mkreadable(buffer, sizeof(buffer), (char *)buf->txt, (unsigned)buf->idx, 1); 5086 printf("PARSE receiver #%d: transmitted message (%d bytes) >%s<\n", 5087 CLK_UNIT(parse->peer), 5088 buf->idx, buffer); 5089 } 5090 #endif 5091 clear_err(parse, ERR_BADIO); 5092 } 5093 } 5094 5095 void 5096 sendint( 5097 struct txbuf *buf, 5098 int a 5099 ) 5100 { 5101 /* send 16bit int, msbyte first */ 5102 sendbyte(buf, (u_char)((a>>8) & 0xff)); 5103 sendbyte(buf, (u_char)(a & 0xff)); 5104 } 5105 5106 void 5107 sendflt( 5108 struct txbuf *buf, 5109 double a 5110 ) 5111 { 5112 int i; 5113 union uval uval; 5114 5115 uval.fv = (float) a; 5116 #ifdef WORDS_BIGENDIAN 5117 for (i=0; i<=3; i++) 5118 #else 5119 for (i=3; i>=0; i--) 5120 #endif 5121 sendbyte(buf, uval.bd[i]); 5122 } 5123 5124 #define TRIM_POS_OPT 0x13 /* output position with high precision */ 5125 #define TRIM_TIME_OPT 0x03 /* use UTC time stamps, on second */ 5126 5127 /*-------------------------------------------------- 5128 * trimble TSIP setup routine 5129 */ 5130 static int 5131 trimbletsip_setup( 5132 struct parseunit *parse, 5133 const char *reason 5134 ) 5135 { 5136 u_char buffer[256]; 5137 struct txbuf buf; 5138 trimble_t *t = parse->localdata; 5139 5140 if (t && t->last_reset && 5141 ((t->last_reset + TRIMBLE_RESET_HOLDOFF) > current_time)) { 5142 return 1; /* not yet */ 5143 } 5144 5145 if (t) 5146 t->last_reset = current_time; 5147 5148 buf.txt = buffer; 5149 5150 sendcmd(&buf, CMD_CVERSION); /* request software versions */ 5151 sendetx(&buf, parse); 5152 5153 sendcmd(&buf, CMD_COPERPARAM); /* set operating parameters */ 5154 sendbyte(&buf, 4); /* static */ 5155 sendflt(&buf, 5.0*D2R); /* elevation angle mask = 10 deg XXX */ 5156 sendflt(&buf, 4.0); /* s/n ratio mask = 6 XXX */ 5157 sendflt(&buf, 12.0); /* PDOP mask = 12 */ 5158 sendflt(&buf, 8.0); /* PDOP switch level = 8 */ 5159 sendetx(&buf, parse); 5160 5161 sendcmd(&buf, CMD_CMODESEL); /* fix mode select */ 5162 sendbyte(&buf, 1); /* time transfer mode */ 5163 sendetx(&buf, parse); 5164 5165 sendcmd(&buf, CMD_CMESSAGE); /* request system message */ 5166 sendetx(&buf, parse); 5167 5168 sendcmd(&buf, CMD_CSUPER); /* superpacket fix */ 5169 sendbyte(&buf, 0x2); /* binary mode */ 5170 sendetx(&buf, parse); 5171 5172 sendcmd(&buf, CMD_CIOOPTIONS); /* set I/O options */ 5173 sendbyte(&buf, TRIM_POS_OPT); /* position output */ 5174 sendbyte(&buf, 0x00); /* no velocity output */ 5175 sendbyte(&buf, TRIM_TIME_OPT); /* UTC, compute on seconds */ 5176 sendbyte(&buf, 0x00); /* no raw measurements */ 5177 sendetx(&buf, parse); 5178 5179 sendcmd(&buf, CMD_CUTCPARAM); /* request UTC correction data */ 5180 sendetx(&buf, parse); 5181 5182 NLOG(NLOG_CLOCKINFO) 5183 ERR(ERR_BADIO) 5184 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletsip_setup: RECEIVER RE-INITIALIZED (%s)", CLK_UNIT(parse->peer), reason); 5185 5186 return 0; 5187 } 5188 5189 /*-------------------------------------------------- 5190 * TRIMBLE TSIP check routine 5191 */ 5192 static void 5193 trimble_check( 5194 struct peer *peer 5195 ) 5196 { 5197 struct parseunit *parse = peer->procptr->unitptr; 5198 trimble_t *t = parse->localdata; 5199 u_char buffer[256]; 5200 struct txbuf buf; 5201 buf.txt = buffer; 5202 5203 if (t) 5204 { 5205 if (current_time > t->last_msg + TRIMBLETSIP_IDLE_TIME) 5206 (void)trimbletsip_setup(parse, "message timeout"); 5207 } 5208 5209 poll_poll(parse->peer); /* emit query string and re-arm timer */ 5210 5211 if (t && t->qtracking) 5212 { 5213 u_long oldsats = t->ltrack & ~t->ctrack; 5214 5215 t->qtracking = 0; 5216 t->ltrack = t->ctrack; 5217 5218 if (oldsats) 5219 { 5220 int i; 5221 5222 for (i = 0; oldsats; i++) { 5223 if (oldsats & (1 << i)) 5224 { 5225 sendcmd(&buf, CMD_CSTATTRACK); 5226 sendbyte(&buf, i+1); /* old sat */ 5227 sendetx(&buf, parse); 5228 } 5229 oldsats &= ~(1 << i); 5230 } 5231 } 5232 5233 sendcmd(&buf, CMD_CSTATTRACK); 5234 sendbyte(&buf, 0x00); /* current tracking set */ 5235 sendetx(&buf, parse); 5236 } 5237 } 5238 5239 /*-------------------------------------------------- 5240 * TRIMBLE TSIP end routine 5241 */ 5242 static void 5243 trimbletsip_end( 5244 struct parseunit *parse 5245 ) 5246 { trimble_t *t = parse->localdata; 5247 5248 if (t) 5249 { 5250 free(t); 5251 parse->localdata = NULL; 5252 } 5253 parse->peer->procptr->nextaction = 0; 5254 parse->peer->procptr->action = NULL; 5255 } 5256 5257 /*-------------------------------------------------- 5258 * TRIMBLE TSIP init routine 5259 */ 5260 static int 5261 trimbletsip_init( 5262 struct parseunit *parse 5263 ) 5264 { 5265 #if defined(VEOL) || defined(VEOL2) 5266 #ifdef HAVE_TERMIOS 5267 struct termios tio; /* NEEDED FOR A LONG TIME ! */ 5268 #endif 5269 #ifdef HAVE_SYSV_TTYS 5270 struct termio tio; /* NEEDED FOR A LONG TIME ! */ 5271 #endif 5272 /* 5273 * allocate local data area 5274 */ 5275 if (!parse->localdata) 5276 { 5277 trimble_t *t; 5278 5279 t = (trimble_t *)(parse->localdata = emalloc(sizeof(trimble_t))); 5280 5281 if (t) 5282 { 5283 memset((char *)t, 0, sizeof(trimble_t)); 5284 t->last_msg = current_time; 5285 } 5286 } 5287 5288 parse->peer->procptr->action = trimble_check; 5289 parse->peer->procptr->nextaction = current_time; 5290 5291 /* 5292 * configure terminal line for ICANON mode with VEOL characters 5293 */ 5294 if (TTY_GETATTR(parse->generic->io.fd, &tio) == -1) 5295 { 5296 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletsip_init: tcgetattr(%d, &tio): %m", CLK_UNIT(parse->peer), parse->generic->io.fd); 5297 return 0; 5298 } 5299 else 5300 { 5301 if ((parse_clockinfo[CLK_TYPE(parse->peer)].cl_lflag & ICANON)) 5302 { 5303 #ifdef VEOL 5304 tio.c_cc[VEOL] = ETX; 5305 #endif 5306 #ifdef VEOL2 5307 tio.c_cc[VEOL2] = DLE; 5308 #endif 5309 } 5310 5311 if (TTY_SETATTR(parse->generic->io.fd, &tio) == -1) 5312 { 5313 msyslog(LOG_ERR, "PARSE receiver #%d: trimbletsip_init: tcsetattr(%d, &tio): %m", CLK_UNIT(parse->peer), parse->generic->io.fd); 5314 return 0; 5315 } 5316 } 5317 #endif 5318 return trimbletsip_setup(parse, "initial startup"); 5319 } 5320 5321 /*------------------------------------------------------------ 5322 * trimbletsip_event - handle Trimble events 5323 * simple evente handler - attempt to re-initialize receiver 5324 */ 5325 static void 5326 trimbletsip_event( 5327 struct parseunit *parse, 5328 int event 5329 ) 5330 { 5331 switch (event) 5332 { 5333 case CEVNT_BADREPLY: /* reset on garbled input */ 5334 case CEVNT_TIMEOUT: /* reset on no input */ 5335 (void)trimbletsip_setup(parse, "event BAD_REPLY/TIMEOUT"); 5336 break; 5337 5338 default: /* ignore */ 5339 break; 5340 } 5341 } 5342 5343 /* 5344 * getflt, getint convert fields in the incoming data into the 5345 * appropriate type of item 5346 * 5347 * CAVEAT: these routines are currently definitely byte order dependent 5348 * and assume Representation(float) == IEEE754 5349 * These functions MUST be converted to portable versions (especially 5350 * converting the float representation into ntp_fp formats in order 5351 * to avoid floating point operations at all! 5352 */ 5353 5354 static float 5355 getflt( 5356 u_char *bp 5357 ) 5358 { 5359 union uval uval; 5360 5361 #ifdef WORDS_BIGENDIAN 5362 uval.bd[0] = *bp++; 5363 uval.bd[1] = *bp++; 5364 uval.bd[2] = *bp++; 5365 uval.bd[3] = *bp; 5366 #else /* ! WORDS_BIGENDIAN */ 5367 uval.bd[3] = *bp++; 5368 uval.bd[2] = *bp++; 5369 uval.bd[1] = *bp++; 5370 uval.bd[0] = *bp; 5371 #endif /* ! WORDS_BIGENDIAN */ 5372 return uval.fv; 5373 } 5374 5375 static double 5376 getdbl( 5377 u_char *bp 5378 ) 5379 { 5380 union uval uval; 5381 5382 #ifdef WORDS_BIGENDIAN 5383 uval.bd[0] = *bp++; 5384 uval.bd[1] = *bp++; 5385 uval.bd[2] = *bp++; 5386 uval.bd[3] = *bp++; 5387 uval.bd[4] = *bp++; 5388 uval.bd[5] = *bp++; 5389 uval.bd[6] = *bp++; 5390 uval.bd[7] = *bp; 5391 #else /* ! WORDS_BIGENDIAN */ 5392 uval.bd[7] = *bp++; 5393 uval.bd[6] = *bp++; 5394 uval.bd[5] = *bp++; 5395 uval.bd[4] = *bp++; 5396 uval.bd[3] = *bp++; 5397 uval.bd[2] = *bp++; 5398 uval.bd[1] = *bp++; 5399 uval.bd[0] = *bp; 5400 #endif /* ! WORDS_BIGENDIAN */ 5401 return uval.dv; 5402 } 5403 5404 static int 5405 getshort( 5406 unsigned char *p 5407 ) 5408 { 5409 return (int) get_msb_short(&p); 5410 } 5411 5412 /*-------------------------------------------------- 5413 * trimbletsip_message - process trimble messages 5414 */ 5415 #define RTOD (180.0 / 3.1415926535898) 5416 #define mb(_X_) (buffer[2+(_X_)]) /* shortcut for buffer access */ 5417 5418 static void 5419 trimbletsip_message( 5420 struct parseunit *parse, 5421 parsetime_t *parsetime 5422 ) 5423 { 5424 unsigned char *buffer = parsetime->parse_msg; 5425 unsigned int size = parsetime->parse_msglen; 5426 5427 if ((size < 4) || 5428 (buffer[0] != DLE) || 5429 (buffer[size-1] != ETX) || 5430 (buffer[size-2] != DLE)) 5431 { 5432 #ifdef DEBUG 5433 if (debug > 2) { 5434 size_t i; 5435 5436 printf("TRIMBLE BAD packet, size %d:\n ", size); 5437 for (i = 0; i < size; i++) { 5438 printf ("%2.2x, ", buffer[i]&0xff); 5439 if (i%16 == 15) printf("\n\t"); 5440 } 5441 printf("\n"); 5442 } 5443 #endif 5444 return; 5445 } 5446 else 5447 { 5448 u_short var_flag; 5449 trimble_t *tr = parse->localdata; 5450 unsigned int cmd = buffer[1]; 5451 char pbuffer[200]; 5452 char *t = pbuffer; 5453 cmd_info_t *s; 5454 5455 #ifdef DEBUG 5456 if (debug > 3) { 5457 size_t i; 5458 5459 printf("TRIMBLE packet 0x%02x, size %d:\n ", cmd, size); 5460 for (i = 0; i < size; i++) { 5461 printf ("%2.2x, ", buffer[i]&0xff); 5462 if (i%16 == 15) printf("\n\t"); 5463 } 5464 printf("\n"); 5465 } 5466 #endif 5467 5468 if (tr) 5469 tr->last_msg = current_time; 5470 5471 s = trimble_convert(cmd, trimble_rcmds); 5472 5473 if (s) 5474 { 5475 t = ap(pbuffer, sizeof(pbuffer), t, "%s=\"", s->varname); 5476 } 5477 else 5478 { 5479 DPRINTF(1, ("TRIMBLE UNKNOWN COMMAND 0x%02x\n", cmd)); 5480 return; 5481 } 5482 5483 var_flag = (u_short) s->varmode; 5484 5485 switch(cmd) 5486 { 5487 case CMD_RCURTIME: 5488 t = ap(pbuffer, sizeof(pbuffer), t, "%f, %d, %f", 5489 getflt((unsigned char *)&mb(0)), getshort((unsigned char *)&mb(4)), 5490 getflt((unsigned char *)&mb(6))); 5491 break; 5492 5493 case CMD_RBEST4: 5494 t = ap(pbuffer, sizeof(pbuffer), t, "mode: "); 5495 switch (mb(0) & 0xF) 5496 { 5497 default: 5498 t = ap(pbuffer, sizeof(pbuffer), t, 5499 "0x%x", mb(0) & 0x7); 5500 break; 5501 5502 case 1: 5503 t = ap(pbuffer, sizeof(pbuffer), t, "0D"); 5504 break; 5505 5506 case 3: 5507 t = ap(pbuffer, sizeof(pbuffer), t, "2D"); 5508 break; 5509 5510 case 4: 5511 t = ap(pbuffer, sizeof(pbuffer), t, "3D"); 5512 break; 5513 } 5514 if (mb(0) & 0x10) 5515 t = ap(pbuffer, sizeof(pbuffer), t, "-MANUAL, "); 5516 else 5517 t = ap(pbuffer, sizeof(pbuffer), t, "-AUTO, "); 5518 5519 t = ap(pbuffer, sizeof(pbuffer), t, "satellites %02d %02d %02d %02d, PDOP %.2f, HDOP %.2f, VDOP %.2f, TDOP %.2f", 5520 mb(1), mb(2), mb(3), mb(4), 5521 getflt((unsigned char *)&mb(5)), 5522 getflt((unsigned char *)&mb(9)), 5523 getflt((unsigned char *)&mb(13)), 5524 getflt((unsigned char *)&mb(17))); 5525 5526 break; 5527 5528 case CMD_RVERSION: 5529 t = ap(pbuffer, sizeof(pbuffer), t, "%d.%d (%d/%d/%d)", 5530 mb(0)&0xff, mb(1)&0xff, 1900+(mb(4)&0xff), mb(2)&0xff, mb(3)&0xff); 5531 break; 5532 5533 case CMD_RRECVHEALTH: 5534 { 5535 static const char *msgs[] = 5536 { 5537 "Battery backup failed", 5538 "Signal processor error", 5539 "Alignment error, channel or chip 1", 5540 "Alignment error, channel or chip 2", 5541 "Antenna feed line fault", 5542 "Excessive ref freq. error", 5543 "<BIT 6>", 5544 "<BIT 7>" 5545 }; 5546 5547 int i, bits; 5548 5549 switch (mb(0) & 0xFF) 5550 { 5551 default: 5552 t = ap(pbuffer, sizeof(pbuffer), t, "illegal value 0x%02x", mb(0) & 0xFF); 5553 break; 5554 case 0x00: 5555 t = ap(pbuffer, sizeof(pbuffer), t, "doing position fixes"); 5556 break; 5557 case 0x01: 5558 t = ap(pbuffer, sizeof(pbuffer), t, "no GPS time yet"); 5559 break; 5560 case 0x03: 5561 t = ap(pbuffer, sizeof(pbuffer), t, "PDOP too high"); 5562 break; 5563 case 0x08: 5564 t = ap(pbuffer, sizeof(pbuffer), t, "no usable satellites"); 5565 break; 5566 case 0x09: 5567 t = ap(pbuffer, sizeof(pbuffer), t, "only ONE usable satellite"); 5568 break; 5569 case 0x0A: 5570 t = ap(pbuffer, sizeof(pbuffer), t, "only TWO usable satellites"); 5571 break; 5572 case 0x0B: 5573 t = ap(pbuffer, sizeof(pbuffer), t, "only THREE usable satellites"); 5574 break; 5575 case 0x0C: 5576 t = ap(pbuffer, sizeof(pbuffer), t, "the chosen satellite is unusable"); 5577 break; 5578 } 5579 5580 bits = mb(1) & 0xFF; 5581 5582 for (i = 0; i < 8; i++) 5583 if (bits & (0x1<<i)) 5584 { 5585 t = ap(pbuffer, sizeof(pbuffer), t, ", %s", msgs[i]); 5586 } 5587 } 5588 break; 5589 5590 case CMD_RMESSAGE: 5591 mkreadable(t, (int)BUFFER_SIZE(pbuffer, t), (char *)&mb(0), (unsigned)(size - 2 - (&mb(0) - buffer)), 0); 5592 break; 5593 5594 case CMD_RMACHSTAT: 5595 { 5596 static const char *msgs[] = 5597 { 5598 "Synthesizer Fault", 5599 "Battery Powered Time Clock Fault", 5600 "A-to-D Converter Fault", 5601 "The almanac stored in the receiver is not complete and current", 5602 "<BIT 4>", 5603 "<BIT 5", 5604 "<BIT 6>", 5605 "<BIT 7>" 5606 }; 5607 5608 int i, bits; 5609 5610 t = ap(pbuffer, sizeof(pbuffer), t, "machine id 0x%02x", mb(0) & 0xFF); 5611 bits = mb(1) & 0xFF; 5612 5613 for (i = 0; i < 8; i++) 5614 if (bits & (0x1<<i)) 5615 { 5616 t = ap(pbuffer, sizeof(pbuffer), t, ", %s", msgs[i]); 5617 } 5618 5619 t = ap(pbuffer, sizeof(pbuffer), t, ", Superpackets %ssupported", (mb(2) & 0xFF) ? "" :"un" ); 5620 } 5621 break; 5622 5623 case CMD_ROPERPARAM: 5624 t = ap(pbuffer, sizeof(pbuffer), t, "%2x %.1f %.1f %.1f %.1f", 5625 mb(0), getflt((unsigned char *)&mb(1)), getflt((unsigned char *)&mb(5)), 5626 getflt((unsigned char *)&mb(9)), getflt((unsigned char *)&mb(13))); 5627 break; 5628 5629 case CMD_RUTCPARAM: 5630 { 5631 float t0t = getflt((unsigned char *)&mb(14)); 5632 short wnt = (short) getshort((unsigned char *)&mb(18)); 5633 short dtls = (short) getshort((unsigned char *)&mb(12)); 5634 short wnlsf = (short) getshort((unsigned char *)&mb(20)); 5635 short dn = (short) getshort((unsigned char *)&mb(22)); 5636 short dtlsf = (short) getshort((unsigned char *)&mb(24)); 5637 5638 if ((int)t0t != 0) 5639 { 5640 mk_utcinfo(t, wnt, wnlsf, dn, dtls, dtlsf, BUFFER_SIZE(pbuffer, t)); 5641 } 5642 else 5643 { 5644 t = ap(pbuffer, sizeof(pbuffer), t, "<NO UTC DATA>"); 5645 } 5646 } 5647 break; 5648 5649 case CMD_RSAT1BIAS: 5650 t = ap(pbuffer, sizeof(pbuffer), t, "%.1fm %.2fm/s at %.1fs", 5651 getflt(&mb(0)), getflt(&mb(4)), getflt(&mb(8))); 5652 break; 5653 5654 case CMD_RIOOPTIONS: 5655 { 5656 t = ap(pbuffer, sizeof(pbuffer), t, "%02x %02x %02x %02x", 5657 mb(0), mb(1), mb(2), mb(3)); 5658 if (mb(0) != TRIM_POS_OPT || 5659 mb(2) != TRIM_TIME_OPT) 5660 { 5661 (void)trimbletsip_setup(parse, "bad io options"); 5662 } 5663 } 5664 break; 5665 5666 case CMD_RSPOSXYZ: 5667 { 5668 double x = getflt((unsigned char *)&mb(0)); 5669 double y = getflt((unsigned char *)&mb(4)); 5670 double z = getflt((unsigned char *)&mb(8)); 5671 double f = getflt((unsigned char *)&mb(12)); 5672 5673 if (f > 0.0) 5674 t = ap(pbuffer, sizeof(pbuffer), t, "x= %.1fm, y= %.1fm, z= %.1fm, time_of_fix= %f sec", 5675 x, y, z, 5676 f); 5677 else 5678 return; 5679 } 5680 break; 5681 5682 case CMD_RSLLAPOS: 5683 { 5684 double lat = getflt((unsigned char *)&mb(0)); 5685 double lng = getflt((unsigned char *)&mb(4)); 5686 double f = getflt((unsigned char *)&mb(12)); 5687 5688 if (f > 0.0) 5689 t = ap(pbuffer, sizeof(pbuffer), t, "lat %f %c, long %f %c, alt %.2fm", 5690 ((lat < 0.0) ? (-lat) : (lat))*RTOD, (lat < 0.0 ? 'S' : 'N'), 5691 ((lng < 0.0) ? (-lng) : (lng))*RTOD, (lng < 0.0 ? 'W' : 'E'), 5692 getflt((unsigned char *)&mb(8))); 5693 else 5694 return; 5695 } 5696 break; 5697 5698 case CMD_RDOUBLEXYZ: 5699 { 5700 double x = getdbl((unsigned char *)&mb(0)); 5701 double y = getdbl((unsigned char *)&mb(8)); 5702 double z = getdbl((unsigned char *)&mb(16)); 5703 t = ap(pbuffer, sizeof(pbuffer), t, "x= %.1fm, y= %.1fm, z= %.1fm", 5704 x, y, z); 5705 } 5706 break; 5707 5708 case CMD_RDOUBLELLA: 5709 { 5710 double lat = getdbl((unsigned char *)&mb(0)); 5711 double lng = getdbl((unsigned char *)&mb(8)); 5712 t = ap(pbuffer, sizeof(pbuffer), t, "lat %f %c, lon %f %c, alt %.2fm", 5713 ((lat < 0.0) ? (-lat) : (lat))*RTOD, (lat < 0.0 ? 'S' : 'N'), 5714 ((lng < 0.0) ? (-lng) : (lng))*RTOD, (lng < 0.0 ? 'W' : 'E'), 5715 getdbl((unsigned char *)&mb(16))); 5716 } 5717 break; 5718 5719 case CMD_RALLINVIEW: 5720 { 5721 int i, sats; 5722 5723 t = ap(pbuffer, sizeof(pbuffer), t, "mode: "); 5724 switch (mb(0) & 0x7) 5725 { 5726 default: 5727 t = ap(pbuffer, sizeof(pbuffer), t, "0x%x", mb(0) & 0x7); 5728 break; 5729 5730 case 3: 5731 t = ap(pbuffer, sizeof(pbuffer), t, "2D"); 5732 break; 5733 5734 case 4: 5735 t = ap(pbuffer, sizeof(pbuffer), t, "3D"); 5736 break; 5737 } 5738 if (mb(0) & 0x8) 5739 t = ap(pbuffer, sizeof(pbuffer), t, "-MANUAL, "); 5740 else 5741 t = ap(pbuffer, sizeof(pbuffer), t, "-AUTO, "); 5742 5743 sats = (mb(0)>>4) & 0xF; 5744 5745 t = ap(pbuffer, sizeof(pbuffer), t, "PDOP %.2f, HDOP %.2f, VDOP %.2f, TDOP %.2f, %d satellite%s in view: ", 5746 getflt((unsigned char *)&mb(1)), 5747 getflt((unsigned char *)&mb(5)), 5748 getflt((unsigned char *)&mb(9)), 5749 getflt((unsigned char *)&mb(13)), 5750 sats, (sats == 1) ? "" : "s"); 5751 5752 for (i=0; i < sats; i++) 5753 { 5754 t = ap(pbuffer, sizeof(pbuffer), t, "%s%02d", i ? ", " : "", mb(17+i)); 5755 if (tr) 5756 tr->ctrack |= (1 << (mb(17+i)-1)); 5757 } 5758 5759 if (tr) 5760 { /* mark for tracking status query */ 5761 tr->qtracking = 1; 5762 } 5763 } 5764 break; 5765 5766 case CMD_RSTATTRACK: 5767 { 5768 t = ap(pbuffer, sizeof(pbuffer), t-2, "[%02d]=\"", mb(0)); /* add index to var name */ 5769 if (getflt((unsigned char *)&mb(4)) < 0.0) 5770 { 5771 t = ap(pbuffer, sizeof(pbuffer), t, "<NO MEASUREMENTS>"); 5772 var_flag &= (u_short)(~DEF); 5773 } 5774 else 5775 { 5776 t = ap(pbuffer, sizeof(pbuffer), t, "ch=%d, acq=%s, eph=%d, signal_level= %5.2f, elevation= %5.2f, azimuth= %6.2f", 5777 (mb(1) & 0xFF)>>3, 5778 mb(2) ? ((mb(2) == 1) ? "ACQ" : "SRCH") : "NEVER", 5779 mb(3), 5780 getflt((unsigned char *)&mb(4)), 5781 getflt((unsigned char *)&mb(12)) * RTOD, 5782 getflt((unsigned char *)&mb(16)) * RTOD); 5783 if (mb(20)) 5784 { 5785 var_flag &= (u_short)(~DEF); 5786 t = ap(pbuffer, sizeof(pbuffer), t, ", OLD"); 5787 } 5788 if (mb(22)) 5789 { 5790 if (mb(22) == 1) 5791 t = ap(pbuffer, sizeof(pbuffer), t, ", BAD PARITY"); 5792 else 5793 if (mb(22) == 2) 5794 t = ap(pbuffer, sizeof(pbuffer), t, ", BAD EPH HEALTH"); 5795 } 5796 if (mb(23)) 5797 t = ap(pbuffer, sizeof(pbuffer), t, ", collecting data"); 5798 } 5799 } 5800 break; 5801 5802 default: 5803 t = ap(pbuffer, sizeof(pbuffer), t, "<UNDECODED>"); 5804 break; 5805 } 5806 5807 t = ap(pbuffer, sizeof(pbuffer), t, "\""); 5808 set_var(&parse->kv, pbuffer, sizeof(pbuffer), var_flag); 5809 } 5810 } 5811 5812 5813 /**============================================================ 5814 ** RAWDCF support 5815 **/ 5816 5817 /*-------------------------------------------------- 5818 * rawdcf_init_1 - set up modem lines for RAWDCF receivers 5819 * SET DTR line 5820 */ 5821 #if defined(TIOCMSET) && (defined(TIOCM_DTR) || defined(CIOCM_DTR)) 5822 static int 5823 rawdcf_init_1( 5824 struct parseunit *parse 5825 ) 5826 { 5827 /* fixed 2000 for using with Linux by Wolfram Pienkoss <wp@bszh.de> */ 5828 /* 5829 * You can use the RS232 to supply the power for a DCF77 receiver. 5830 * Here a voltage between the DTR and the RTS line is used. Unfortunately 5831 * the name has changed from CIOCM_DTR to TIOCM_DTR recently. 5832 */ 5833 int sl232; 5834 5835 if (ioctl(parse->generic->io.fd, TIOCMGET, (caddr_t)&sl232) == -1) 5836 { 5837 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_1: WARNING: ioctl(fd, TIOCMGET, [C|T]IOCM_DTR): %m", CLK_UNIT(parse->peer)); 5838 return 0; 5839 } 5840 5841 #ifdef TIOCM_DTR 5842 sl232 = (sl232 & ~TIOCM_RTS) | TIOCM_DTR; /* turn on DTR, clear RTS for power supply */ 5843 #else 5844 sl232 = (sl232 & ~CIOCM_RTS) | CIOCM_DTR; /* turn on DTR, clear RTS for power supply */ 5845 #endif 5846 5847 if (ioctl(parse->generic->io.fd, TIOCMSET, (caddr_t)&sl232) == -1) 5848 { 5849 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_1: WARNING: ioctl(fd, TIOCMSET, [C|T]IOCM_DTR): %m", CLK_UNIT(parse->peer)); 5850 } 5851 return 0; 5852 } 5853 #else 5854 static int 5855 rawdcfdtr_init_1( 5856 struct parseunit *parse 5857 ) 5858 { 5859 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_1: WARNING: OS interface incapable of setting DTR to power DCF modules", CLK_UNIT(parse->peer)); 5860 return 0; 5861 } 5862 #endif /* DTR initialisation type */ 5863 5864 /*-------------------------------------------------- 5865 * rawdcf_init_2 - set up modem lines for RAWDCF receivers 5866 * CLR DTR line, SET RTS line 5867 */ 5868 #if defined(TIOCMSET) && (defined(TIOCM_RTS) || defined(CIOCM_RTS)) 5869 static int 5870 rawdcf_init_2( 5871 struct parseunit *parse 5872 ) 5873 { 5874 /* fixed 2000 for using with Linux by Wolfram Pienkoss <wp@bszh.de> */ 5875 /* 5876 * You can use the RS232 to supply the power for a DCF77 receiver. 5877 * Here a voltage between the DTR and the RTS line is used. Unfortunately 5878 * the name has changed from CIOCM_DTR to TIOCM_DTR recently. 5879 */ 5880 int sl232; 5881 5882 if (ioctl(parse->generic->io.fd, TIOCMGET, (caddr_t)&sl232) == -1) 5883 { 5884 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_2: WARNING: ioctl(fd, TIOCMGET, [C|T]IOCM_RTS): %m", CLK_UNIT(parse->peer)); 5885 return 0; 5886 } 5887 5888 #ifdef TIOCM_RTS 5889 sl232 = (sl232 & ~TIOCM_DTR) | TIOCM_RTS; /* turn on RTS, clear DTR for power supply */ 5890 #else 5891 sl232 = (sl232 & ~CIOCM_DTR) | CIOCM_RTS; /* turn on RTS, clear DTR for power supply */ 5892 #endif 5893 5894 if (ioctl(parse->generic->io.fd, TIOCMSET, (caddr_t)&sl232) == -1) 5895 { 5896 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_2: WARNING: ioctl(fd, TIOCMSET, [C|T]IOCM_RTS): %m", CLK_UNIT(parse->peer)); 5897 } 5898 return 0; 5899 } 5900 #else 5901 static int 5902 rawdcf_init_2( 5903 struct parseunit *parse 5904 ) 5905 { 5906 msyslog(LOG_NOTICE, "PARSE receiver #%d: rawdcf_init_2: WARNING: OS interface incapable of setting RTS to power DCF modules", CLK_UNIT(parse->peer)); 5907 return 0; 5908 } 5909 #endif /* DTR initialisation type */ 5910 5911 #else /* defined(REFCLOCK) && defined(PARSE) */ 5912 NONEMPTY_TRANSLATION_UNIT 5913 #endif /* defined(REFCLOCK) && defined(PARSE) */ 5914 5915 /* 5916 * History: 5917 * 5918 * refclock_parse.c,v 5919 * Revision 4.81 2009/05/01 10:15:29 kardel 5920 * use new refclock_ppsapi interface 5921 * 5922 * Revision 4.80 2007/08/11 12:06:29 kardel 5923 * update comments wrt/ to PPS 5924 * 5925 * Revision 4.79 2007/08/11 11:52:23 kardel 5926 * - terminate io bindings before io_closeclock() will close our file descriptor 5927 * 5928 * Revision 4.78 2006/12/22 20:08:27 kardel 5929 * Bug 746 (RFE): add configuration for Expert mouseCLOCK USB v2.0 as mode 19 5930 * 5931 * Revision 4.77 2006/08/05 07:44:49 kardel 5932 * support optionally separate PPS devices via /dev/refclockpps-{0..3} 5933 * 5934 * Revision 4.76 2006/06/22 18:40:47 kardel 5935 * clean up signedness (gcc 4) 5936 * 5937 * Revision 4.75 2006/06/22 16:58:10 kardel 5938 * Bug #632: call parse_ppsapi() in parse_ctl() when updating 5939 * the PPS offset. Fix sign of offset passed to kernel. 5940 * 5941 * Revision 4.74 2006/06/18 21:18:37 kardel 5942 * NetBSD Coverity CID 3796: possible NULL deref 5943 * 5944 * Revision 4.73 2006/05/26 14:23:46 kardel 5945 * cleanup of copyright info 5946 * 5947 * Revision 4.72 2006/05/26 14:19:43 kardel 5948 * cleanup of ioctl cruft 5949 * 5950 * Revision 4.71 2006/05/26 14:15:57 kardel 5951 * delay adding refclock to async refclock io after all initializations 5952 * 5953 * Revision 4.70 2006/05/25 18:20:50 kardel 5954 * bug #619 5955 * terminate parse io engine after de-registering 5956 * from refclock io engine 5957 * 5958 * Revision 4.69 2006/05/25 17:28:02 kardel 5959 * complete refclock io structure initialization *before* inserting it into the 5960 * refclock input machine (avoids null pointer deref) (bug #619) 5961 * 5962 * Revision 4.68 2006/05/01 17:02:51 kardel 5963 * copy receiver method also for newlwy created receive buffers 5964 * 5965 * Revision 4.67 2006/05/01 14:37:29 kardel 5966 * If an input buffer parses into more than one message do insert the 5967 * parsed message in a new input buffer instead of processing it 5968 * directly. This avoids deed complicated processing in signal 5969 * handling. 5970 * 5971 * Revision 4.66 2006/03/18 00:45:30 kardel 5972 * coverity fixes found in NetBSD coverity scan 5973 * 5974 * Revision 4.65 2006/01/26 06:08:33 kardel 5975 * output errno on PPS setup failure 5976 * 5977 * Revision 4.64 2005/11/09 20:44:47 kardel 5978 * utilize full PPS timestamp resolution from PPS API 5979 * 5980 * Revision 4.63 2005/10/07 22:10:25 kardel 5981 * bounded buffer implementation 5982 * 5983 * Revision 4.62.2.2 2005/09/25 10:20:16 kardel 5984 * avoid unexpected buffer overflows due to sprintf("%f") on strange floats: 5985 * replace almost all str* and *printf functions be their buffer bounded 5986 * counterparts 5987 * 5988 * Revision 4.62.2.1 2005/08/27 16:19:27 kardel 5989 * limit re-set rate of trimble clocks 5990 * 5991 * Revision 4.62 2005/08/06 17:40:00 kardel 5992 * cleanup size handling wrt/ to buffer boundaries 5993 * 5994 * Revision 4.61 2005/07/27 21:16:19 kardel 5995 * fix a long (> 11 years) misconfiguration wrt/ Meinberg cflag factory 5996 * default setup. CSTOPB was missing for the 7E2 default data format of 5997 * the DCF77 clocks. 5998 * 5999 * Revision 4.60 2005/07/17 21:14:44 kardel 6000 * change contents of version string to include the RCS/CVS Id 6001 * 6002 * Revision 4.59 2005/07/06 06:56:38 kardel 6003 * syntax error 6004 * 6005 * Revision 4.58 2005/07/04 13:10:40 kardel 6006 * fix bug 455: tripping over NULL pointer on cleanup 6007 * fix shadow storage logic for ppsphaseadjust and trustime wrt/ time2 6008 * fix compiler warnings for some platforms wrt/ printf formatstrings and 6009 * varying structure element sizes 6010 * reorder assignment in binding to avoid tripping over NULL pointers 6011 * 6012 * Revision 4.57 2005/06/25 09:25:19 kardel 6013 * sort out log output sequence 6014 * 6015 * Revision 4.56 2005/06/14 21:47:27 kardel 6016 * collect samples only if samples are ok (sync or trusted flywheel) 6017 * propagate pps phase adjustment value to kernel via PPSAPI to help HARDPPS 6018 * en- and dis-able HARDPPS in correlation to receiver sync state 6019 * 6020 * Revision 4.55 2005/06/02 21:28:31 kardel 6021 * clarify trust logic 6022 * 6023 * Revision 4.54 2005/06/02 17:06:49 kardel 6024 * change status reporting to use fixed refclock_report() 6025 * 6026 * Revision 4.53 2005/06/02 16:33:31 kardel 6027 * fix acceptance of clocks unsync clocks right at start 6028 * 6029 * Revision 4.52 2005/05/26 21:55:06 kardel 6030 * cleanup status reporting 6031 * 6032 * Revision 4.51 2005/05/26 19:19:14 kardel 6033 * implement fast refclock startup 6034 * 6035 * Revision 4.50 2005/04/16 20:51:35 kardel 6036 * set hardpps_enable = 1 when binding a kernel PPS source 6037 * 6038 * Revision 4.49 2005/04/16 17:29:26 kardel 6039 * add non polling clock type 18 for just listenning to Meinberg clocks 6040 * 6041 * Revision 4.48 2005/04/16 16:22:27 kardel 6042 * bk sync 20050415 ntp-dev 6043 * 6044 * Revision 4.47 2004/11/29 10:42:48 kardel 6045 * bk sync ntp-dev 20041129 6046 * 6047 * Revision 4.46 2004/11/29 10:26:29 kardel 6048 * keep fudgetime2 in sync with trusttime/ppsphaseadjust depending in flag1 6049 * 6050 * Revision 4.45 2004/11/14 20:53:20 kardel 6051 * clear PPS flags after using them 6052 * 6053 * Revision 4.44 2004/11/14 15:29:41 kardel 6054 * support PPSAPI, upgrade Copyright to Berkeley style 6055 * 6056 * Revision 4.43 2001/05/26 22:53:16 kardel 6057 * 20010526 reconcilation 6058 * 6059 * Revision 4.42 2000/05/14 15:31:51 kardel 6060 * PPSAPI && RAWDCF modemline support 6061 * 6062 * Revision 4.41 2000/04/09 19:50:45 kardel 6063 * fixed rawdcfdtr_init() -> rawdcf_init_1 6064 * 6065 * Revision 4.40 2000/04/09 15:27:55 kardel 6066 * modem line fiddle in rawdcf_init_2 6067 * 6068 * Revision 4.39 2000/03/18 09:16:55 kardel 6069 * PPSAPI integration 6070 * 6071 * Revision 4.38 2000/03/05 20:25:06 kardel 6072 * support PPSAPI 6073 * 6074 * Revision 4.37 2000/03/05 20:11:14 kardel 6075 * 4.0.99g reconcilation 6076 * 6077 * Revision 4.36 1999/11/28 17:18:20 kardel 6078 * disabled burst mode 6079 * 6080 * Revision 4.35 1999/11/28 09:14:14 kardel 6081 * RECON_4_0_98F 6082 * 6083 * Revision 4.34 1999/05/14 06:08:05 kardel 6084 * store current_time in a suitable container (u_long) 6085 * 6086 * Revision 4.33 1999/05/13 21:48:38 kardel 6087 * double the no response timeout interval 6088 * 6089 * Revision 4.32 1999/05/13 20:09:13 kardel 6090 * complain only about missing polls after a full poll interval 6091 * 6092 * Revision 4.31 1999/05/13 19:59:32 kardel 6093 * add clock type 16 for RTS set DTR clr in RAWDCF 6094 * 6095 * Revision 4.30 1999/02/28 20:36:43 kardel 6096 * fixed printf fmt 6097 * 6098 * Revision 4.29 1999/02/28 19:58:23 kardel 6099 * updated copyright information 6100 * 6101 * Revision 4.28 1999/02/28 19:01:50 kardel 6102 * improved debug out on sent Meinberg messages 6103 * 6104 * Revision 4.27 1999/02/28 18:05:55 kardel 6105 * no linux/ppsclock.h stuff 6106 * 6107 * Revision 4.26 1999/02/28 15:27:27 kardel 6108 * wharton clock integration 6109 * 6110 * Revision 4.25 1999/02/28 14:04:46 kardel 6111 * added missing double quotes to UTC information string 6112 * 6113 * Revision 4.24 1999/02/28 12:06:50 kardel 6114 * (parse_control): using gmprettydate instead of prettydate() 6115 * (mk_utcinfo): new function for formatting GPS derived UTC information 6116 * (gps16x_message): changed to use mk_utcinfo() 6117 * (trimbletsip_message): changed to use mk_utcinfo() 6118 * ignoring position information in unsynchronized mode 6119 * (parse_start): augument linux support for optional ASYNC_LOW_LATENCY 6120 * 6121 * Revision 4.23 1999/02/23 19:47:53 kardel 6122 * fixed #endifs 6123 * (stream_receive): fixed formats 6124 * 6125 * Revision 4.22 1999/02/22 06:21:02 kardel 6126 * use new autoconfig symbols 6127 * 6128 * Revision 4.21 1999/02/21 12:18:13 kardel 6129 * 4.91f reconcilation 6130 * 6131 * Revision 4.20 1999/02/21 10:53:36 kardel 6132 * initial Linux PPSkit version 6133 * 6134 * Revision 4.19 1999/02/07 09:10:45 kardel 6135 * clarify STREAMS mitigation rules in comment 6136 * 6137 * Revision 4.18 1998/12/20 23:45:34 kardel 6138 * fix types and warnings 6139 * 6140 * Revision 4.17 1998/11/15 21:24:51 kardel 6141 * cannot access mbg_ routines when CLOCK_MEINBERG 6142 * is not defined 6143 * 6144 * Revision 4.16 1998/11/15 20:28:17 kardel 6145 * Release 4.0.73e13 reconcilation 6146 * 6147 * Revision 4.15 1998/08/22 21:56:08 kardel 6148 * fixed IO handling for non-STREAM IO 6149 * 6150 * Revision 4.14 1998/08/16 19:00:48 kardel 6151 * (gps16x_message): reduced UTC parameter information (dropped A0,A1) 6152 * made uval a local variable (killed one of the last globals) 6153 * (sendetx): added logging of messages when in debug mode 6154 * (trimble_check): added periodic checks to facilitate re-initialization 6155 * (trimbletsip_init): made use of EOL character if in non-kernel operation 6156 * (trimbletsip_message): extended message interpretation 6157 * (getdbl): fixed data conversion 6158 * 6159 * Revision 4.13 1998/08/09 22:29:13 kardel 6160 * Trimble TSIP support 6161 * 6162 * Revision 4.12 1998/07/11 10:05:34 kardel 6163 * Release 4.0.73d reconcilation 6164 * 6165 * Revision 4.11 1998/06/14 21:09:42 kardel 6166 * Sun acc cleanup 6167 * 6168 * Revision 4.10 1998/06/13 12:36:45 kardel 6169 * signed/unsigned, name clashes 6170 * 6171 * Revision 4.9 1998/06/12 15:30:00 kardel 6172 * prototype fixes 6173 * 6174 * Revision 4.8 1998/06/12 11:19:42 kardel 6175 * added direct input processing routine for refclocks in 6176 * order to avaiod that single character io gobbles up all 6177 * receive buffers and drops input data. (Problem started 6178 * with fast machines so a character a buffer was possible 6179 * one of the few cases where faster machines break existing 6180 * allocation algorithms) 6181 * 6182 * Revision 4.7 1998/06/06 18:35:20 kardel 6183 * (parse_start): added BURST mode initialisation 6184 * 6185 * Revision 4.6 1998/05/27 06:12:46 kardel 6186 * RAWDCF_BASEDELAY default added 6187 * old comment removed 6188 * casts for ioctl() 6189 * 6190 * Revision 4.5 1998/05/25 22:05:09 kardel 6191 * RAWDCF_SETDTR option removed 6192 * clock type 14 attempts to set DTR for 6193 * power supply of RAWDCF receivers 6194 * 6195 * Revision 4.4 1998/05/24 16:20:47 kardel 6196 * updated comments referencing Meinberg clocks 6197 * added RAWDCF clock with DTR set option as type 14 6198 * 6199 * Revision 4.3 1998/05/24 10:48:33 kardel 6200 * calibrated CONRAD RAWDCF default fudge factor 6201 * 6202 * Revision 4.2 1998/05/24 09:59:35 kardel 6203 * corrected version information (ntpq support) 6204 * 6205 * Revision 4.1 1998/05/24 09:52:31 kardel 6206 * use fixed format only (new IO model) 6207 * output debug to stdout instead of msyslog() 6208 * don't include >"< in ASCII output in order not to confuse 6209 * ntpq parsing 6210 * 6211 * Revision 4.0 1998/04/10 19:52:11 kardel 6212 * Start 4.0 release version numbering 6213 * 6214 * Revision 1.2 1998/04/10 19:28:04 kardel 6215 * initial NTP VERSION 4 integration of PARSE with GPS166 binary support 6216 * derived from 3.105.1.2 from V3 tree 6217 * 6218 * Revision information 3.1 - 3.105 from log deleted 1998/04/10 kardel 6219 * 6220 */ 6221