1c0b746e5SOllivier Robert /* 2c0b746e5SOllivier Robert * /src/NTP/REPOSITORY/ntp4-dev/include/parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A 3c0b746e5SOllivier Robert * 4c0b746e5SOllivier Robert * parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A 5c0b746e5SOllivier Robert * 6c0b746e5SOllivier Robert * Copyright (c) 1995-2015 by Frank Kardel <kardel <AT> ntp.org> 7c0b746e5SOllivier Robert * Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universitaet Erlangen-Nuernberg, Germany 8c0b746e5SOllivier Robert * 9c0b746e5SOllivier Robert * Redistribution and use in source and binary forms, with or without 10c0b746e5SOllivier Robert * modification, are permitted provided that the following conditions 11c0b746e5SOllivier Robert * are met: 12c0b746e5SOllivier Robert * 1. Redistributions of source code must retain the above copyright 13c0b746e5SOllivier Robert * notice, this list of conditions and the following disclaimer. 14c0b746e5SOllivier Robert * 2. Redistributions in binary form must reproduce the above copyright 15c0b746e5SOllivier Robert * notice, this list of conditions and the following disclaimer in the 16c0b746e5SOllivier Robert * documentation and/or other materials provided with the distribution. 17c0b746e5SOllivier Robert * 3. Neither the name of the author nor the names of its contributors 18c0b746e5SOllivier Robert * may be used to endorse or promote products derived from this software 19c0b746e5SOllivier Robert * without specific prior written permission. 20c0b746e5SOllivier Robert * 21c0b746e5SOllivier Robert * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 22c0b746e5SOllivier Robert * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23c0b746e5SOllivier Robert * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24c0b746e5SOllivier Robert * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 25c0b746e5SOllivier Robert * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26c0b746e5SOllivier Robert * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27c0b746e5SOllivier Robert * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28c0b746e5SOllivier Robert * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29c0b746e5SOllivier Robert * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30c0b746e5SOllivier Robert * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31c0b746e5SOllivier Robert * SUCH DAMAGE. 32c0b746e5SOllivier Robert * 33c0b746e5SOllivier Robert */ 34c0b746e5SOllivier Robert 35c0b746e5SOllivier Robert #ifndef __PARSE_H__ 36c0b746e5SOllivier Robert #define __PARSE_H__ 37c0b746e5SOllivier Robert #if !(defined(lint) || defined(__GNUC__)) 38c0b746e5SOllivier Robert static char parsehrcsid[]="parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A"; 39c0b746e5SOllivier Robert #endif 40c0b746e5SOllivier Robert 41c0b746e5SOllivier Robert #include "ntp_types.h" 42c0b746e5SOllivier Robert 43c0b746e5SOllivier Robert #include "parse_conf.h" 44c0b746e5SOllivier Robert 45c0b746e5SOllivier Robert /* 46c0b746e5SOllivier Robert * we use the following datastructures in two modes 47c0b746e5SOllivier Robert * either in the NTP itself where we use NTP time stamps at some places 48c0b746e5SOllivier Robert * or in the kernel, where only struct timeval will be used. 49c0b746e5SOllivier Robert */ 50c0b746e5SOllivier Robert #undef PARSEKERNEL 51c0b746e5SOllivier Robert #if defined(KERNEL) || defined(_KERNEL) 52c0b746e5SOllivier Robert #ifndef PARSESTREAM 53c0b746e5SOllivier Robert #define PARSESTREAM 54c0b746e5SOllivier Robert #endif 55c0b746e5SOllivier Robert #endif 56c0b746e5SOllivier Robert #if defined(PARSESTREAM) && defined(HAVE_SYS_STREAM_H) 57c0b746e5SOllivier Robert #define PARSEKERNEL 58c0b746e5SOllivier Robert #endif 59c0b746e5SOllivier Robert #ifdef PARSEKERNEL 60c0b746e5SOllivier Robert #ifndef _KERNEL 61c0b746e5SOllivier Robert extern caddr_t kmem_alloc (unsigned int); 62c0b746e5SOllivier Robert extern caddr_t kmem_free (caddr_t, unsigned int); 63c0b746e5SOllivier Robert extern unsigned int splx (unsigned int); 64c0b746e5SOllivier Robert extern unsigned int splhigh (void); 65c0b746e5SOllivier Robert extern unsigned int splclock (void); 66c0b746e5SOllivier Robert #define MALLOC(_X_) (char *)kmem_alloc(_X_) 67c0b746e5SOllivier Robert #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) 68c0b746e5SOllivier Robert #else 69c0b746e5SOllivier Robert #include <sys/kmem.h> 70c0b746e5SOllivier Robert #define MALLOC(_X_) (char *)kmem_alloc(_X_, KM_SLEEP) 71c0b746e5SOllivier Robert #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) 72c0b746e5SOllivier Robert #endif 73c0b746e5SOllivier Robert #else 74c0b746e5SOllivier Robert #define MALLOC(_X_) malloc(_X_) 75c0b746e5SOllivier Robert #define FREE(_X_, _Y_) free(_X_) 76c0b746e5SOllivier Robert #endif 77c0b746e5SOllivier Robert 78c0b746e5SOllivier Robert #if defined(PARSESTREAM) && defined(HAVE_SYS_STREAM_H) 79c0b746e5SOllivier Robert #include <sys/stream.h> 80c0b746e5SOllivier Robert #include <sys/stropts.h> 81c0b746e5SOllivier Robert #else /* STREAM */ 82c0b746e5SOllivier Robert #include <stdio.h> 83c0b746e5SOllivier Robert #include "ntp_syslog.h" 84c0b746e5SOllivier Robert #ifdef DEBUG 85c0b746e5SOllivier Robert #define DD_PARSE 5 86c0b746e5SOllivier Robert #define DD_RAWDCF 4 87c0b746e5SOllivier Robert #define parseprintf(LEVEL, ARGS) if (debug > LEVEL) printf ARGS 88c0b746e5SOllivier Robert #else /* DEBUG */ 89c0b746e5SOllivier Robert #define parseprintf(LEVEL, ARGS) 90c0b746e5SOllivier Robert #endif /* DEBUG */ 91c0b746e5SOllivier Robert #endif /* PARSESTREAM */ 92c0b746e5SOllivier Robert 93c0b746e5SOllivier Robert #if defined(timercmp) && defined(__GNUC__) 94c0b746e5SOllivier Robert #undef timercmp 95c0b746e5SOllivier Robert #endif 96c0b746e5SOllivier Robert 97c0b746e5SOllivier Robert #if !defined(timercmp) 98c0b746e5SOllivier Robert #define timercmp(tvp, uvp, cmp) \ 99c0b746e5SOllivier Robert ((tvp)->tv_sec cmp (uvp)->tv_sec || \ 100c0b746e5SOllivier Robert ((tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)) 101c0b746e5SOllivier Robert #endif 102c0b746e5SOllivier Robert 103c0b746e5SOllivier Robert #ifndef TIMES10 104c0b746e5SOllivier Robert #define TIMES10(_X_) (((_X_) << 3) + ((_X_) << 1)) 105c0b746e5SOllivier Robert #endif 106c0b746e5SOllivier Robert 107c0b746e5SOllivier Robert /* 108c0b746e5SOllivier Robert * some constants useful for GPS time conversion 109c0b746e5SOllivier Robert */ 110c0b746e5SOllivier Robert #define GPSORIGIN 2524953600UL /* NTP origin - GPS origin in seconds */ 111c0b746e5SOllivier Robert #define GPSWEEKS 1024 /* number of weeks until the GPS epch rolls over */ 112c0b746e5SOllivier Robert 113c0b746e5SOllivier Robert /* 114c0b746e5SOllivier Robert * state flags 115c0b746e5SOllivier Robert */ 116c0b746e5SOllivier Robert #define PARSEB_POWERUP 0x00000001 /* no synchronisation */ 117c0b746e5SOllivier Robert #define PARSEB_NOSYNC 0x00000002 /* timecode currently not confirmed */ 118c0b746e5SOllivier Robert 119c0b746e5SOllivier Robert /* 120c0b746e5SOllivier Robert * time zone information 121c0b746e5SOllivier Robert */ 122c0b746e5SOllivier Robert #define PARSEB_ANNOUNCE 0x00000010 /* switch time zone warning (DST switch) */ 123c0b746e5SOllivier Robert #define PARSEB_DST 0x00000020 /* DST in effect */ 124c0b746e5SOllivier Robert #define PARSEB_UTC 0x00000040 /* UTC time */ 125c0b746e5SOllivier Robert 126c0b746e5SOllivier Robert /* 127c0b746e5SOllivier Robert * leap information 128c0b746e5SOllivier Robert */ 129c0b746e5SOllivier Robert #define PARSEB_LEAPDEL 0x00000100 /* LEAP deletion warning */ 130c0b746e5SOllivier Robert #define PARSEB_LEAPADD 0x00000200 /* LEAP addition warning */ 131c0b746e5SOllivier Robert #define PARSEB_LEAPS 0x00000300 /* LEAP warnings */ 132c0b746e5SOllivier Robert #define PARSEB_LEAPSECOND 0x00000400 /* actual leap second */ 133c0b746e5SOllivier Robert /* 134c0b746e5SOllivier Robert * optional status information 135c0b746e5SOllivier Robert */ 136c0b746e5SOllivier Robert #define PARSEB_CALLBIT 0x00001000 /* "call bit" used to signalize irregularities in the control facilities */ 137c0b746e5SOllivier Robert #define PARSEB_POSITION 0x00002000 /* position available */ 138c0b746e5SOllivier Robert #define PARSEB_MESSAGE 0x00004000 /* addtitional message data */ 139c0b746e5SOllivier Robert /* 140c0b746e5SOllivier Robert * feature information 141c0b746e5SOllivier Robert */ 142c0b746e5SOllivier Robert #define PARSEB_S_LEAP 0x00010000 /* supports LEAP */ 143c0b746e5SOllivier Robert #define PARSEB_S_CALLBIT 0x00020000 /* supports callbit information */ 144c0b746e5SOllivier Robert #define PARSEB_S_PPS 0x00040000 /* supports PPS time stamping */ 145c0b746e5SOllivier Robert #define PARSEB_S_POSITION 0x00080000 /* supports position information (GPS) */ 146c0b746e5SOllivier Robert 147c0b746e5SOllivier Robert /* 148c0b746e5SOllivier Robert * time stamp availability 149c0b746e5SOllivier Robert */ 150c0b746e5SOllivier Robert #define PARSEB_TIMECODE 0x10000000 /* valid time code sample */ 151c0b746e5SOllivier Robert #define PARSEB_PPS 0x20000000 /* valid PPS sample */ 152c0b746e5SOllivier Robert 153c0b746e5SOllivier Robert #define PARSE_TCINFO (PARSEB_ANNOUNCE|PARSEB_POWERUP|PARSEB_NOSYNC|PARSEB_DST|\ 154c0b746e5SOllivier Robert PARSEB_UTC|PARSEB_LEAPS|PARSEB_CALLBIT|PARSEB_S_LEAP|\ 155c0b746e5SOllivier Robert PARSEB_S_LOCATION|PARSEB_TIMECODE|PARSEB_MESSAGE) 156c0b746e5SOllivier Robert 157c0b746e5SOllivier Robert #define PARSE_POWERUP(x) ((x) & PARSEB_POWERUP) 158c0b746e5SOllivier Robert #define PARSE_NOSYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == PARSEB_NOSYNC) 159c0b746e5SOllivier Robert #define PARSE_SYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == 0) 160c0b746e5SOllivier Robert #define PARSE_ANNOUNCE(x) ((x) & PARSEB_ANNOUNCE) 161c0b746e5SOllivier Robert #define PARSE_DST(x) ((x) & PARSEB_DST) 162c0b746e5SOllivier Robert #define PARSE_UTC(x) ((x) & PARSEB_UTC) 163c0b746e5SOllivier Robert #define PARSE_LEAPADD(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPADD)) 164c0b746e5SOllivier Robert #define PARSE_LEAPDEL(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPDEL)) 165c0b746e5SOllivier Robert #define PARSE_CALLBIT(x) ((x) & PARSEB_CALLBIT) 166c0b746e5SOllivier Robert #define PARSE_LEAPSECOND(x) (PARSE_SYNC(x) && ((x) & PARSEB_LEAP_SECOND)) 167c0b746e5SOllivier Robert 168c0b746e5SOllivier Robert #define PARSE_S_LEAP(x) ((x) & PARSEB_S_LEAP) 169c0b746e5SOllivier Robert #define PARSE_S_CALLBIT(x) ((x) & PARSEB_S_CALLBIT) 170c0b746e5SOllivier Robert #define PARSE_S_PPS(x) ((x) & PARSEB_S_PPS) 171c0b746e5SOllivier Robert #define PARSE_S_POSITION(x) ((x) & PARSEB_S_POSITION) 172c0b746e5SOllivier Robert 173c0b746e5SOllivier Robert #define PARSE_TIMECODE(x) ((x) & PARSEB_TIMECODE) 174c0b746e5SOllivier Robert #define PARSE_PPS(x) ((x) & PARSEB_PPS) 175c0b746e5SOllivier Robert #define PARSE_POSITION(x) ((x) & PARSEB_POSITION) 176c0b746e5SOllivier Robert #define PARSE_MESSAGE(x) ((x) & PARSEB_MESSAGE) 177c0b746e5SOllivier Robert 178c0b746e5SOllivier Robert /* 179c0b746e5SOllivier Robert * operation flags - lower nibble contains fudge flags 180c0b746e5SOllivier Robert */ 181c0b746e5SOllivier Robert #define PARSE_TRUSTTIME CLK_FLAG1 /* use flag1 to indicate the time2 references mean the trust time */ 182c0b746e5SOllivier Robert #define PARSE_CLEAR CLK_FLAG2 /* use flag2 to control pps on assert */ 183c0b746e5SOllivier Robert #define PARSE_PPSKERNEL CLK_FLAG3 /* use flag3 to bind PPS to kernel */ 184c0b746e5SOllivier Robert #define PARSE_LEAP_DELETE CLK_FLAG4 /* use flag4 to force leap deletion - only necessary when earth slows down */ 185c0b746e5SOllivier Robert 186c0b746e5SOllivier Robert #define PARSE_FIXED_FMT 0x10 /* fixed format */ 187c0b746e5SOllivier Robert #define PARSE_PPSCLOCK 0x20 /* try to get PPS time stamp via ppsclock ioctl */ 188c0b746e5SOllivier Robert 189c0b746e5SOllivier Robert /* 190c0b746e5SOllivier Robert * size of buffers 191c0b746e5SOllivier Robert */ 192c0b746e5SOllivier Robert #define PARSE_TCMAX 400 /* maximum addition data size */ 193c0b746e5SOllivier Robert 194c0b746e5SOllivier Robert typedef union 195c0b746e5SOllivier Robert { 196c0b746e5SOllivier Robert struct timeval tv; /* timeval - kernel view */ 197c0b746e5SOllivier Robert l_fp fp; /* fixed point - ntp view */ 198c0b746e5SOllivier Robert } timestamp_t; 199c0b746e5SOllivier Robert 200c0b746e5SOllivier Robert /* 201c0b746e5SOllivier Robert * standard time stamp structure 202c0b746e5SOllivier Robert */ 203c0b746e5SOllivier Robert struct parsetime 204c0b746e5SOllivier Robert { 205c0b746e5SOllivier Robert u_long parse_status; /* data status - CVT_OK, CVT_NONE, CVT_FAIL ... */ 206c0b746e5SOllivier Robert timestamp_t parse_time; /* PARSE timestamp */ 207c0b746e5SOllivier Robert timestamp_t parse_stime; /* telegram sample timestamp */ 208c0b746e5SOllivier Robert timestamp_t parse_ptime; /* PPS time stamp */ 209c0b746e5SOllivier Robert long parse_usecerror; /* sampled usec error */ 210c0b746e5SOllivier Robert u_long parse_state; /* current receiver state */ 211c0b746e5SOllivier Robert unsigned short parse_format; /* format code */ 212c0b746e5SOllivier Robert unsigned short parse_msglen; /* length of message */ 213c0b746e5SOllivier Robert unsigned char parse_msg[PARSE_TCMAX]; /* original messages */ 214c0b746e5SOllivier Robert }; 215c0b746e5SOllivier Robert 216c0b746e5SOllivier Robert typedef struct parsetime parsetime_t; 217c0b746e5SOllivier Robert 218c0b746e5SOllivier Robert /*---------- STREAMS interface ----------*/ 219c0b746e5SOllivier Robert 220c0b746e5SOllivier Robert #ifdef HAVE_SYS_STREAM_H 221c0b746e5SOllivier Robert /* 222c0b746e5SOllivier Robert * ioctls 223c0b746e5SOllivier Robert */ 224c0b746e5SOllivier Robert #define PARSEIOC_ENABLE (('D'<<8) + 'E') 225c0b746e5SOllivier Robert #define PARSEIOC_DISABLE (('D'<<8) + 'D') 226c0b746e5SOllivier Robert #define PARSEIOC_SETFMT (('D'<<8) + 'f') 227c0b746e5SOllivier Robert #define PARSEIOC_GETFMT (('D'<<8) + 'F') 228c0b746e5SOllivier Robert #define PARSEIOC_SETCS (('D'<<8) + 'C') 229c0b746e5SOllivier Robert #define PARSEIOC_TIMECODE (('D'<<8) + 'T') 230c0b746e5SOllivier Robert 231c0b746e5SOllivier Robert #endif 232c0b746e5SOllivier Robert 233c0b746e5SOllivier Robert /*------ IO handling flags (sorry) ------*/ 234c0b746e5SOllivier Robert 235c0b746e5SOllivier Robert #define PARSE_IO_CSIZE 0x00000003 236c0b746e5SOllivier Robert #define PARSE_IO_CS5 0x00000000 237c0b746e5SOllivier Robert #define PARSE_IO_CS6 0x00000001 238c0b746e5SOllivier Robert #define PARSE_IO_CS7 0x00000002 239c0b746e5SOllivier Robert #define PARSE_IO_CS8 0x00000003 240c0b746e5SOllivier Robert 241c0b746e5SOllivier Robert /* 242c0b746e5SOllivier Robert * ioctl structure 243c0b746e5SOllivier Robert */ 244c0b746e5SOllivier Robert union parsectl 245c0b746e5SOllivier Robert { 246c0b746e5SOllivier Robert struct parsegettc 247c0b746e5SOllivier Robert { 248c0b746e5SOllivier Robert u_long parse_state; /* last state */ 249c0b746e5SOllivier Robert u_long parse_badformat; /* number of bad packets since last query */ 250c0b746e5SOllivier Robert unsigned short parse_format;/* last decoded format */ 251c0b746e5SOllivier Robert unsigned short parse_count; /* count of valid time code bytes */ 252c0b746e5SOllivier Robert char parse_buffer[PARSE_TCMAX+1]; /* timecode buffer */ 253c0b746e5SOllivier Robert } parsegettc; 254c0b746e5SOllivier Robert 255c0b746e5SOllivier Robert struct parseformat 256c0b746e5SOllivier Robert { 257c0b746e5SOllivier Robert unsigned short parse_format;/* number of examined format */ 258c0b746e5SOllivier Robert unsigned short parse_count; /* count of valid string bytes */ 259c0b746e5SOllivier Robert char parse_buffer[PARSE_TCMAX+1]; /* format code string */ 260c0b746e5SOllivier Robert } parseformat; 261c0b746e5SOllivier Robert 262c0b746e5SOllivier Robert struct parsesetcs 263c0b746e5SOllivier Robert { 264c0b746e5SOllivier Robert u_long parse_cs; /* character size (needed for stripping) */ 265c0b746e5SOllivier Robert } parsesetcs; 266c0b746e5SOllivier Robert }; 267c0b746e5SOllivier Robert 268c0b746e5SOllivier Robert typedef union parsectl parsectl_t; 269c0b746e5SOllivier Robert 270c0b746e5SOllivier Robert /*------ for conversion routines --------*/ 271c0b746e5SOllivier Robert 272c0b746e5SOllivier Robert struct parse /* parse module local data */ 273c0b746e5SOllivier Robert { 274c0b746e5SOllivier Robert int parse_flags; /* operation and current status flags */ 275c0b746e5SOllivier Robert 276c0b746e5SOllivier Robert int parse_ioflags; /* io handling flags (5-8 Bit control currently) */ 277c0b746e5SOllivier Robert 278c0b746e5SOllivier Robert /* 279c0b746e5SOllivier Robert * private data - fixed format only 280c0b746e5SOllivier Robert */ 281c0b746e5SOllivier Robert unsigned short parse_plen; /* length of private data */ 282c0b746e5SOllivier Robert void *parse_pdata; /* private data pointer */ 283c0b746e5SOllivier Robert 284c0b746e5SOllivier Robert /* 285c0b746e5SOllivier Robert * time code input buffer (from RS232 or PPS) 286c0b746e5SOllivier Robert */ 287c0b746e5SOllivier Robert unsigned short parse_index; /* current buffer index */ 288c0b746e5SOllivier Robert char *parse_data; /* data buffer */ 289c0b746e5SOllivier Robert unsigned short parse_dsize; /* size of data buffer */ 290c0b746e5SOllivier Robert unsigned short parse_lformat; /* last format used */ 291c0b746e5SOllivier Robert u_long parse_lstate; /* last state code */ 292c0b746e5SOllivier Robert char *parse_ldata; /* last data buffer */ 293c0b746e5SOllivier Robert unsigned short parse_ldsize; /* last data buffer length */ 294c0b746e5SOllivier Robert u_long parse_badformat; /* number of unparsable pakets */ 295c0b746e5SOllivier Robert 296c0b746e5SOllivier Robert timestamp_t parse_lastchar; /* last time a character was received */ 297c0b746e5SOllivier Robert parsetime_t parse_dtime; /* external data prototype */ 298c0b746e5SOllivier Robert }; 299c0b746e5SOllivier Robert 300c0b746e5SOllivier Robert typedef struct parse parse_t; 301c0b746e5SOllivier Robert 302c0b746e5SOllivier Robert struct clocktime /* clock time broken up from time code */ 303c0b746e5SOllivier Robert { 304c0b746e5SOllivier Robert long day; 305c0b746e5SOllivier Robert long month; 306c0b746e5SOllivier Robert long year; 307c0b746e5SOllivier Robert long hour; 308c0b746e5SOllivier Robert long minute; 309c0b746e5SOllivier Robert long second; 310c0b746e5SOllivier Robert long usecond; 311c0b746e5SOllivier Robert long utcoffset; /* in seconds */ 312c0b746e5SOllivier Robert time_t utctime; /* the actual time - alternative to date/time */ 313c0b746e5SOllivier Robert u_long flags; /* current clock status */ 314c0b746e5SOllivier Robert }; 315c0b746e5SOllivier Robert 316c0b746e5SOllivier Robert typedef struct clocktime clocktime_t; 317c0b746e5SOllivier Robert 318c0b746e5SOllivier Robert /* 319c0b746e5SOllivier Robert * parser related return/error codes 320c0b746e5SOllivier Robert */ 321c0b746e5SOllivier Robert #define CVT_MASK (unsigned)0x0000000F /* conversion exit code */ 322c0b746e5SOllivier Robert #define CVT_NONE (unsigned)0x00000001 /* format not applicable */ 323c0b746e5SOllivier Robert #define CVT_FAIL (unsigned)0x00000002 /* conversion failed - error code returned */ 324c0b746e5SOllivier Robert #define CVT_OK (unsigned)0x00000004 /* conversion succeeded */ 325c0b746e5SOllivier Robert #define CVT_SKIP (unsigned)0x00000008 /* conversion succeeded */ 326c0b746e5SOllivier Robert #define CVT_ADDITIONAL (unsigned)0x00000010 /* additional data is available */ 327c0b746e5SOllivier Robert #define CVT_BADFMT (unsigned)0x00000100 /* general format error - (unparsable) */ 328c0b746e5SOllivier Robert #define CVT_BADDATE (unsigned)0x00000200 /* date field incorrect */ 329c0b746e5SOllivier Robert #define CVT_BADTIME (unsigned)0x00000400 /* time field incorrect */ 330c0b746e5SOllivier Robert 331c0b746e5SOllivier Robert /* 332c0b746e5SOllivier Robert * return codes used by special input parsers 333c0b746e5SOllivier Robert */ 334c0b746e5SOllivier Robert #define PARSE_INP_SKIP 0x00 /* discard data - may have been consumed */ 335c0b746e5SOllivier Robert #define PARSE_INP_TIME 0x01 /* time code assembled */ 336c0b746e5SOllivier Robert #define PARSE_INP_PARSE 0x02 /* parse data using normal algorithm */ 337c0b746e5SOllivier Robert #define PARSE_INP_DATA 0x04 /* additional data to pass up */ 338c0b746e5SOllivier Robert #define PARSE_INP_SYNTH 0x08 /* just pass up synthesized time */ 339c0b746e5SOllivier Robert 340c0b746e5SOllivier Robert /* 341c0b746e5SOllivier Robert * PPS edge info 342c0b746e5SOllivier Robert */ 343c0b746e5SOllivier Robert #define SYNC_ZERO 0x00 344c0b746e5SOllivier Robert #define SYNC_ONE 0x01 345c0b746e5SOllivier Robert 346c0b746e5SOllivier Robert typedef u_long parse_inp_fnc_t(parse_t *, char, timestamp_t *); 347c0b746e5SOllivier Robert typedef u_long parse_cvt_fnc_t(unsigned char *, int, struct format *, clocktime_t *, void *); 348c0b746e5SOllivier Robert typedef u_long parse_pps_fnc_t(parse_t *, int, timestamp_t *); 349c0b746e5SOllivier Robert 350c0b746e5SOllivier Robert struct clockformat 351c0b746e5SOllivier Robert { 352c0b746e5SOllivier Robert /* special input protocol - implies fixed format */ 353c0b746e5SOllivier Robert parse_inp_fnc_t *input; 354c0b746e5SOllivier Robert /* conversion routine */ 355c0b746e5SOllivier Robert parse_cvt_fnc_t *convert; 356c0b746e5SOllivier Robert /* routine for handling RS232 sync events (time stamps) */ 357c0b746e5SOllivier Robert /* PPS input routine */ 358c0b746e5SOllivier Robert parse_pps_fnc_t *syncpps; 359c0b746e5SOllivier Robert /* time code synthesizer */ 360c0b746e5SOllivier Robert 361c0b746e5SOllivier Robert void *data; /* local parameters */ 362c0b746e5SOllivier Robert const char *name; /* clock format name */ 363c0b746e5SOllivier Robert unsigned short length; /* maximum length of data packet */ 364c0b746e5SOllivier Robert unsigned short plen; /* length of private data - implies fixed format */ 365c0b746e5SOllivier Robert }; 366c0b746e5SOllivier Robert 367c0b746e5SOllivier Robert typedef struct clockformat clockformat_t; 368c0b746e5SOllivier Robert 369c0b746e5SOllivier Robert /* 370c0b746e5SOllivier Robert * parse interface 371c0b746e5SOllivier Robert */ 372c0b746e5SOllivier Robert extern int parse_ioinit (parse_t *); 373c0b746e5SOllivier Robert extern void parse_ioend (parse_t *); 374c0b746e5SOllivier Robert extern int parse_ioread (parse_t *, char, timestamp_t *); 375c0b746e5SOllivier Robert extern int parse_iopps (parse_t *, int, timestamp_t *); 376c0b746e5SOllivier Robert extern void parse_iodone (parse_t *); 377c0b746e5SOllivier Robert extern int parse_timecode (parsectl_t *, parse_t *); 378c0b746e5SOllivier Robert extern int parse_getfmt (parsectl_t *, parse_t *); 379c0b746e5SOllivier Robert extern int parse_setfmt (parsectl_t *, parse_t *); 380c0b746e5SOllivier Robert extern int parse_setcs (parsectl_t *, parse_t *); 381c0b746e5SOllivier Robert 382c0b746e5SOllivier Robert extern unsigned int parse_restart (parse_t *, char); 383c0b746e5SOllivier Robert extern unsigned int parse_addchar (parse_t *, char); 384c0b746e5SOllivier Robert extern unsigned int parse_end (parse_t *); 385c0b746e5SOllivier Robert 386c0b746e5SOllivier Robert extern int Strok (const unsigned char *, const unsigned char *); 387c0b746e5SOllivier Robert extern int Stoi (const unsigned char *, long *, int); 388c0b746e5SOllivier Robert 389c0b746e5SOllivier Robert extern time_t parse_to_unixtime (clocktime_t *, u_long *); 390c0b746e5SOllivier Robert extern u_long updatetimeinfo (parse_t *, u_long); 391c0b746e5SOllivier Robert extern void syn_simple (parse_t *, timestamp_t *, struct format *, u_long); 392 extern parse_pps_fnc_t pps_simple; 393 extern parse_pps_fnc_t pps_one; 394 extern parse_pps_fnc_t pps_zero; 395 extern int parse_timedout (parse_t *, timestamp_t *, struct timeval *); 396 397 #endif 398 399 /* 400 * History: 401 * 402 * parse.h,v 403 * Revision 4.12 2007/01/14 08:36:03 kardel 404 * make timestamp union anonymous to avoid conflicts with 405 * some OSes that choose to create a nameing conflic here. 406 * 407 * Revision 4.11 2005/06/25 10:58:45 kardel 408 * add missing log keywords 409 * 410 * Revision 4.5 1998/08/09 22:23:32 kardel 411 * 4.0.73e2 adjustments 412 * 413 * Revision 4.4 1998/06/14 21:09:27 kardel 414 * Sun acc cleanup 415 * 416 * Revision 4.3 1998/06/13 11:49:25 kardel 417 * STREAM macro gone in favor of HAVE_SYS_STREAM_H 418 * 419 * Revision 4.2 1998/06/12 15:14:25 kardel 420 * fixed prototypes 421 * 422 * Revision 4.1 1998/05/24 10:07:59 kardel 423 * removed old data structure cruft (new input model) 424 * new PARSE_INP* macros for input handling 425 * removed old SYNC_* macros from old input model 426 * (struct clockformat): removed old parse functions in favor of the 427 * new input model 428 * updated prototypes 429 * 430 * form V3 3.31 - log info deleted 1998/04/11 kardel 431 */ 432