/* * /src/NTP/REPOSITORY/v4/include/parse.h,v 3.31 1996/12/01 16:02:46 kardel Exp * * parse.h,v 3.31 1996/12/01 16:02:46 kardel Exp * * Copyright (C) 1989,1990,1991,1992,1993,1994,1995,1996 by Frank Kardel * Friedrich-Alexander Universität Erlangen-Nürnberg, Germany * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * */ #ifndef __PARSE_H__ #define __PARSE_H__ #if !(defined(lint) || defined(__GNUC__)) static char parsehrcsid[]="parse.h,v 3.31 1996/12/01 16:02:46 kardel Exp"; #endif #include "ntp_types.h" #include "parse_conf.h" /* * we use the following datastructures in two modes * either in the NTP itself where we use NTP time stamps at some places * or in the kernel, where only struct timeval will be used. */ #undef PARSEKERNEL #if defined(KERNEL) || defined(_KERNEL) #ifndef PARSESTREAM #define PARSESTREAM #endif #endif #if defined(PARSESTREAM) && defined(STREAM) #define PARSEKERNEL #endif #ifdef PARSEKERNEL #ifndef _KERNEL extern caddr_t kmem_alloc P((unsigned int)); extern caddr_t kmem_free P((caddr_t, unsigned int)); extern int splx(); extern int splhigh(); #define MALLOC(_X_) (char *)kmem_alloc(_X_) #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) #else #include #define MALLOC(_X_) (char *)kmem_alloc(_X_, KM_SLEEP) #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) #endif #else #define MALLOC(_X_) malloc(_X_) #define FREE(_X_, _Y_) free(_X_) #endif #if defined(PARSESTREAM) && defined(STREAM) #include #include #else /* STREAM */ #include #include "ntp_syslog.h" #ifdef DEBUG extern int debug; #define DD_PARSE 5 #define DD_RAWDCF 4 #define parseprintf(LEVEL, ARGS) if (debug > LEVEL) printf ARGS #else /* DEBUG */ #define parseprintf(LEVEL, ARGS) #endif /* DEBUG */ #endif /* PARSESTREAM */ #if defined(timercmp) && defined(__GNUC__) #undef timercmp #define timercmp(tvp, uvp, cmp) \ ((tvp)->tv_sec cmp (uvp)->tv_sec || \ ((tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)) #endif #ifndef TIMES10 #define TIMES10(_X_) (((_X_) << 3) + ((_X_) << 1)) #endif /* * state flags */ #define PARSEB_POWERUP 0x00000001 /* no synchronisation */ #define PARSEB_NOSYNC 0x00000002 /* timecode currently not confirmed */ /* * time zone information */ #define PARSEB_ANNOUNCE 0x00000010 /* switch time zone warning (DST switch) */ #define PARSEB_DST 0x00000020 /* DST in effect */ #define PARSEB_UTC 0x00000040 /* UTC time */ /* * leap information */ #define PARSEB_LEAPDEL 0x00000100 /* LEAP deletion warning */ #define PARSEB_LEAPADD 0x00000200 /* LEAP addition warning */ #define PARSEB_LEAPS 0x00000300 /* LEAP warnings */ #define PARSEB_LEAPSECOND 0x00000400 /* actual leap second */ /* * optional status information */ #define PARSEB_ALTERNATE 0x00001000 /* alternate antenna used */ #define PARSEB_POSITION 0x00002000 /* position available */ /* * feature information */ #define PARSEB_S_LEAP 0x00010000 /* supports LEAP */ #define PARSEB_S_ANTENNA 0x00020000 /* supports antenna information */ #define PARSEB_S_PPS 0x00040000 /* supports PPS time stamping */ #define PARSEB_S_POSITION 0x00080000 /* supports position information (GPS) */ /* * time stamp availability */ #define PARSEB_TIMECODE 0x10000000 /* valid time code sample */ #define PARSEB_PPS 0x20000000 /* valid PPS sample */ #define PARSE_TCINFO (PARSEB_ANNOUNCE|PARSEB_POWERUP|PARSEB_NOSYNC|PARSEB_DST|\ PARSEB_UTC|PARSEB_LEAPS|PARSEB_ALTERNATE|PARSEB_S_LEAP|\ PARSEB_S_LOCATION|PARSEB_TIMECODE) #define PARSE_POWERUP(x) ((x) & PARSEB_POWERUP) #define PARSE_NOSYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == PARSEB_NOSYNC) #define PARSE_SYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == 0) #define PARSE_ANNOUNCE(x) ((x) & PARSEB_ANNOUNCE) #define PARSE_DST(x) ((x) & PARSEB_DST) #define PARSE_UTC(x) ((x) & PARSEB_UTC) #define PARSE_LEAPADD(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPADD)) #define PARSE_LEAPDEL(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPDEL)) #define PARSE_ALTERNATE(x) ((x) & PARSEB_ALTERNATE) #define PARSE_LEAPSECOND(x) (PARSE_SYNC(x) && ((x) & PARSEB_LEAP_SECOND)) #define PARSE_S_LEAP(x) ((x) & PARSEB_S_LEAP) #define PARSE_S_ANTENNA(x) ((x) & PARSEB_S_ANTENNA) #define PARSE_S_PPS(x) ((x) & PARSEB_S_PPS) #define PARSE_S_POSITION(x) ((x) & PARSEB_S_POSITION) #define PARSE_TIMECODE(x) ((x) & PARSEB_TIMECODE) #define PARSE_PPS(x) ((x) & PARSEB_PPS) #define PARSE_POSITION(x) ((x) & PARSEB_POSITION) /* * operation flags - some are also fudge flags */ #define PARSE_STATISTICS 0x08 /* enable statistics */ #define PARSE_LEAP_DELETE 0x04 /* delete leap - overides statistics */ #define PARSE_FIXED_FMT 0x10 /* fixed format */ #define PARSE_PPSCLOCK 0x20 /* try to get PPS time stamp via ppsclock ioctl */ typedef union timestamp { struct timeval tv; /* timeval - usually kernel view */ l_fp fp; /* fixed point - xntp view */ } timestamp_t; /* * standard time stamp structure */ struct parsetime { u_long parse_status; /* data status - CVT_OK, CVT_NONE, CVT_FAIL ... */ timestamp_t parse_time; /* PARSE timestamp */ timestamp_t parse_stime; /* telegram sample timestamp */ timestamp_t parse_ptime; /* PPS time stamp */ long parse_usecerror; /* sampled usec error */ u_long parse_state; /* current receiver state */ unsigned short parse_format; /* format code */ }; typedef struct parsetime parsetime_t; /*---------- STREAMS interface ----------*/ #ifdef STREAM /* * ioctls */ #define PARSEIOC_ENABLE (('D'<<8) + 'E') #define PARSEIOC_DISABLE (('D'<<8) + 'D') #define PARSEIOC_SETFMT (('D'<<8) + 'f') #define PARSEIOC_GETFMT (('D'<<8) + 'F') #define PARSEIOC_SETCS (('D'<<8) + 'C') #define PARSEIOC_TIMECODE (('D'<<8) + 'T') #endif /*------ IO handling flags (sorry) ------*/ #define PARSE_IO_CSIZE 0x00000003 #define PARSE_IO_CS5 0x00000000 #define PARSE_IO_CS6 0x00000001 #define PARSE_IO_CS7 0x00000002 #define PARSE_IO_CS8 0x00000003 /* * sizes */ #define PARSE_TCMAX 128 /* * ioctl structure */ union parsectl { struct parsegettc { u_long parse_state; /* last state */ u_long parse_badformat; /* number of bad packets since last query */ unsigned short parse_format;/* last decoded format */ unsigned short parse_count; /* count of valid time code bytes */ char parse_buffer[PARSE_TCMAX+1]; /* timecode buffer */ } parsegettc; struct parseformat { unsigned short parse_format;/* number of examined format */ unsigned short parse_count; /* count of valid string bytes */ char parse_buffer[PARSE_TCMAX+1]; /* format code string */ } parseformat; struct parsesetcs { u_long parse_cs; /* character size (needed for stripping) */ } parsesetcs; }; typedef union parsectl parsectl_t; /*------ for conversion routines --------*/ #define PARSE_DELTA 16 struct parse /* parse module local data */ { int parse_flags; /* operation and current status flags */ int parse_ioflags; /* io handling flags (5-8 Bit control currently) */ int parse_syncflags; /* possible sync events (START/END/character) */ /* * RS232 input parser information */ unsigned char parse_startsym[32]; /* possible start packet values */ unsigned char parse_endsym[32]; /* possible end packet values */ unsigned char parse_syncsym[32]; /* sync characters */ struct timeval parse_timeout; /* max gap between characters (us) */ /* * PPS 'input' buffer */ struct timeval parse_lastone; /* time stamp of last PPS 1 transition */ struct timeval parse_lastzero; /* time stamp of last PPS 0 transition */ /* * character input buffer */ timestamp_t parse_lastchar; /* time stamp of last received character */ /* * private data - fixed format only */ unsigned short parse_plen; /* length of private data */ void *parse_pdata; /* private data pointer */ /* * time code input buffer (from RS232 or PPS) */ unsigned short parse_index; /* current buffer index */ char *parse_data; /* data buffer */ unsigned short parse_dsize; /* size of data buffer */ unsigned short parse_lformat; /* last format used */ u_long parse_lstate; /* last state code */ char *parse_ldata; /* last data buffer */ unsigned short parse_ldsize; /* last data buffer length */ u_long parse_badformat; /* number of unparsable pakets */ parsetime_t parse_dtime; /* external data prototype */ }; typedef struct parse parse_t; struct clocktime /* clock time broken up from time code */ { long day; long month; long year; long hour; long minute; long second; long usecond; long utcoffset; /* in seconds */ time_t utctime; /* the actual time - alternative to date/time */ long flags; /* current clock status */ }; typedef struct clocktime clocktime_t; /* * clock formats specify routines to be called to * convert the buffer into a struct clock. * functions are called * fn(buffer, data, clock) -> CVT_NONE, CVT_FAIL, CVT_OK * * the private data pointer can be used to * distingush between different formats of a common * base type */ #define F_START 0x00000001 /* start packet delimiter */ #define F_END 0x00000002 /* end packet delimiter */ #define SYNC_TIMEOUT 0x00000004 /* packet restart after timeout */ #define SYNC_START 0x00000008 /* packet start is sync event */ #define SYNC_END 0x00000010 /* packet end is sync event */ #define SYNC_CHAR 0x00000020 /* special character is sync event */ #define SYNC_ONE 0x00000040 /* PPS synchronize on 'ONE' transition */ #define SYNC_ZERO 0x00000080 /* PPS synchronize on 'ZERO' transition */ #define SYNC_SYNTHESIZE 0x00000100 /* generate intermediate time stamps */ #define CVT_FIXEDONLY 0x00010000 /* convert only in fixed configuration */ /* * parser related return/error codes */ #define CVT_MASK 0x0000000F /* conversion exit code */ #define CVT_NONE 0x00000001 /* format not applicable */ #define CVT_FAIL 0x00000002 /* conversion failed - error code returned */ #define CVT_OK 0x00000004 /* conversion succeeded */ #define CVT_SKIP 0x00000008 /* conversion succeeded */ #define CVT_BADFMT 0x00000010 /* general format error - (unparsable) */ #define CVT_BADDATE 0x00000020 /* date field incorrect */ #define CVT_BADTIME 0x00000040 /* time field incorrect */ struct clockformat { u_long (*input)(); /* special input protocol - implies fixed format */ u_long (*convert)(); /* conversion routine */ void (*syncevt)(); /* routine for handling RS232 sync events (time stamps) */ u_long (*syncpps)(); /* PPS input routine */ u_long (*synth)(); /* time code synthesizer */ void *data; /* local parameters */ char *name; /* clock format name */ unsigned short length; /* maximum length of data packet */ u_long flags; /* valid start symbols etc. */ unsigned short plen; /* length of private data - implies fixed format */ struct timeval timeout; /* buffer restart after timeout (us) */ unsigned char startsym; /* start symbol */ unsigned char endsym; /* end symbol */ unsigned char syncsym; /* sync symbol */ }; typedef struct clockformat clockformat_t; /* * parse interface */ extern int parse_ioinit P((parse_t *)); extern void parse_ioend P((parse_t *)); extern int parse_ioread P((parse_t *, unsigned int, timestamp_t *)); extern int parse_iopps P((parse_t *, int, timestamp_t *)); extern void parse_iodone P((parse_t *)); extern int parse_timecode P((parsectl_t *, parse_t *)); extern int parse_getfmt P((parsectl_t *, parse_t *)); extern int parse_setfmt P((parsectl_t *, parse_t *)); extern int parse_setcs P((parsectl_t *, parse_t *)); extern int Strok P((char *, char *)); extern int Stoi P((char *, long *, int)); extern time_t parse_to_unixtime P((clocktime_t *, u_long *)); extern u_long updatetimeinfo P((parse_t *, time_t, u_long, u_long)); extern void syn_simple P((parse_t *, timestamp_t *, struct format *, u_long)); extern u_long pps_simple P((parse_t *, int, timestamp_t *)); #endif /* * History: * * parse.h,v * Revision 3.31 1996/12/01 16:02:46 kardel * freeze for 5.86.12.2 PARSE-Patch * * Revision 3.30 1996/11/24 20:09:17 kardel * RELEASE_5_86_12_2 reconcilation * * Revision 3.29 1996/10/05 13:30:13 kardel * general update * * Revision 3.28 1996/06/01 16:49:59 kardel * changed flag value for statistics preparation * * Revision 3.27 1995/10/15 23:46:05 duwe * look for ntp_syslog.h in the right place * * Revision 3.26 1995/07/02 20:01:00 kardel * keep ANSI happy... * * Revision 3.25 1995/06/18 12:14:56 kardel * removed dispersion calulation from parse subsystem * * Revision 3.24 1995/04/09 20:53:39 kardel * 3.4n reconcilation * * Revision 3.23 1994/10/03 22:13:04 kardel * typoe... * * Revision 3.22 1994/10/03 10:03:19 kardel * 3.4e reconcilation * * Revision 3.21 1994/05/30 20:58:34 kardel * fix prototypes * * Revision 3.20 1994/05/30 10:19:44 kardel * int32 cleanup * * Revision 3.19 1994/05/15 11:30:33 kardel * documented flag4 as statistics enable flag * * Revision 3.18 1994/05/12 12:40:34 kardel * shut up gcc about broken Sun/BSD code * * Revision 3.17 1994/03/03 09:27:20 kardel * rcs ids fixed * * Revision 3.13 1994/01/25 19:04:21 kardel * 94/01/23 reconcilation * * Revision 3.12 1994/01/23 17:23:05 kardel * 1994 reconcilation * * Revision 3.11 1993/11/11 11:20:18 kardel * declaration fixes * * Revision 3.10 1993/11/01 19:59:48 kardel * parse Solaris support (initial version) * * Revision 3.9 1993/10/06 00:14:57 kardel * include fixes * * Revision 3.8 1993/10/05 23:15:41 kardel * more STREAM protection * * Revision 3.7 1993/10/05 22:56:10 kardel * STREAM must be defined for PARSESTREAMS * * Revision 3.6 1993/10/03 19:10:28 kardel * restructured I/O handling * * Revision 3.5 1993/09/26 23:41:13 kardel * new parse driver logic * * Revision 3.4 1993/09/01 21:46:31 kardel * conditional cleanup * * Revision 3.3 1993/08/27 00:29:29 kardel * compilation cleanup * * Revision 3.2 1993/07/09 11:37:05 kardel * Initial restructured version + GPS support * * Revision 3.1 1993/07/06 09:59:12 kardel * DCF77 driver goes generic... * */