/*      $NetBSD: clk_trimtaip.c,v 1.7 2024/08/18 20:47:17 christos Exp $        */

/*
* /src/NTP/ntp4-dev/libparse/clk_trimtaip.c,v 4.11 2005/04/16 17:32:10 kardel RELEASE_20050508_A
*
* clk_trimtaip.c,v 4.11 2005/04/16 17:32:10 kardel RELEASE_20050508_A
*
* Trimble SV6 clock support - several collected codepieces
*
* Copyright (c) 1995-2005 by Frank Kardel <kardel <AT> ntp.org>
* Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universitaet Erlangen-Nuernberg, Germany
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. Neither the name of the author nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

#if defined(REFCLOCK) && defined(CLOCK_PARSE) && defined(CLOCK_TRIMTAIP)

#include "ntp_fp.h"
#include "ntp_unixtime.h"
#include "ntp_calendar.h"

#include "parse.h"

#ifndef PARSESTREAM
#include "ntp_stdlib.h"
#include <stdio.h>
#else
#include "sys/parsestreams.h"
extern int printf (const char *, ...);
#endif

/*      0000000000111111111122222222223333333   / char
*      0123456789012345678901234567890123456   \ posn
*      >RTMhhmmssdddDDMMYYYYoodnnvrrrrr;*xx<   Actual
*      ----33445566600112222BB7__-_____--99-   Parse
*      >RTM                      1     ;*  <", Check
*/

#define hexval(x) (('0' <= (x) && (x) <= '9') ? (x) - '0' : \
                  ('a' <= (x) && (x) <= 'f') ? (x) - 'a' + 10 : \
                  ('A' <= (x) && (x) <= 'F') ? (x) - 'A' + 10 : \
                  -1)
#define O_USEC          O_WDAY
#define O_GPSFIX        O_FLAGS
#define O_CHKSUM        O_UTCHOFFSET
    static struct format trimsv6_fmt =
{ { { 13, 2 }, {15, 2}, { 17, 4}, /* Day, Month, Year */
   {  4, 2 }, { 6, 2}, {  8, 2}, /* Hour, Minute, Second */
   { 10, 3 }, {23, 1}, {  0, 0}, /* uSec, FIXes (WeekDAY, FLAGS, ZONE) */
   { 34, 2 }, { 0, 0}, { 21, 2}, /* cksum, -, utcS (UTC[HMS]OFFSET) */
},
 (const unsigned char *)">RTM                      1     ;*  <",
 0
};

static parse_cvt_fnc_t cvt_trimtaip;
static parse_inp_fnc_t inp_trimtaip;

clockformat_t clock_trimtaip =
{
 inp_trimtaip,                 /* no input handling */
 cvt_trimtaip,                 /* Trimble conversion */
 pps_one,                      /* easy PPS monitoring */
 (void *)&trimsv6_fmt,         /* conversion configuration */
 "Trimble TAIP",
 37,                           /* string buffer */
 0                             /* no private data */
};

/* parse_cvt_fnc_t cvt_trimtaip */
static u_long
cvt_trimtaip(
            unsigned char *buffer,
            int            size,
            struct format *format,
            clocktime_t   *clock_time,
            void          *local
            )
{
       long gpsfix;
       u_char calc_csum = 0;
       long   recv_csum;
       int      i;

       if (!Strok(buffer, format->fixed_string)) return CVT_NONE;
#define OFFS(x) format->field_offsets[(x)].offset
#define STOI(x, y) \
       Stoi(&buffer[OFFS(x)], y, \
            format->field_offsets[(x)].length)
               if (    STOI(O_DAY,     &clock_time->day)       ||
                       STOI(O_MONTH,   &clock_time->month)     ||
                       STOI(O_YEAR,    &clock_time->year)      ||
                       STOI(O_HOUR,    &clock_time->hour)      ||
                       STOI(O_MIN,     &clock_time->minute)    ||
                       STOI(O_SEC,     &clock_time->second)    ||
                       STOI(O_USEC,    &clock_time->usecond)||
                       STOI(O_GPSFIX,  &gpsfix)
                       ) return CVT_FAIL|CVT_BADFMT;

       clock_time->usecond *= 1000;
       /* Check that the checksum is right */
       for (i=OFFS(O_CHKSUM)-1; i >= 0; i--) calc_csum ^= buffer[i];
       recv_csum =     (hexval(buffer[OFFS(O_CHKSUM)]) << 4) |
               hexval(buffer[OFFS(O_CHKSUM)+1]);
       if (recv_csum < 0) return CVT_FAIL|CVT_BADTIME;
       if (((u_char) recv_csum) != calc_csum) return CVT_FAIL|CVT_BADTIME;

       clock_time->utcoffset = 0;

       /* What should flags be set to ? */
       clock_time->flags = PARSEB_UTC;

       /* if the current GPS fix is 9 (unknown), reject */
       if (0 > gpsfix || gpsfix > 9) clock_time->flags |= PARSEB_POWERUP;

       return CVT_OK;
}

/*
* parse_inp_fnc_t inp_trimtaip
*
* grab data from input stream
*/
static u_long
inp_trimtaip(
            parse_t      *parseio,
            char         ch,
            timestamp_t  *tstamp
         )
{
       unsigned int rtc;

       parseprintf(DD_PARSE, ("inp_trimtaip(0x%p, 0x%x, ...)\n", (void*)parseio, ch));

       switch (ch)
       {
       case '>':
               parseprintf(DD_PARSE, ("inp_trimptaip: START seen\n"));

               parseio->parse_index = 1;
               parseio->parse_data[0] = ch;
               parseio->parse_dtime.parse_stime = *tstamp; /* collect timestamp */
               return PARSE_INP_SKIP;

       case '<':
               parseprintf(DD_PARSE, ("inp_trimtaip: END seen\n"));
               if ((rtc = parse_addchar(parseio, ch)) == PARSE_INP_SKIP)
                       return parse_end(parseio);
               else
                       return rtc;


       default:
               return parse_addchar(parseio, ch);
       }
}

#else /* not (REFCLOCK && CLOCK_PARSE && CLOCK_TRIMTAIP) */
NONEMPTY_TRANSLATION_UNIT
#endif /* not (REFCLOCK && CLOCK_PARSE && CLOCK_TRIMTAIP) */

/*
* History:
*
* clk_trimtaip.c,v
* Revision 4.11  2005/04/16 17:32:10  kardel
* update copyright
*
* Revision 4.10  2004/11/14 15:29:41  kardel
* support PPSAPI, upgrade Copyright to Berkeley style
*
* Revision 4.7  1999/11/28 09:13:51  kardel
* RECON_4_0_98F
*
* Revision 4.6  1998/08/16 18:46:27  kardel
* (clock_trimtaip =): changed format name
*
* Revision 4.5  1998/06/14 21:09:38  kardel
* Sun acc cleanup
*
* Revision 4.4  1998/06/13 12:06:57  kardel
* fix SYSV clock name clash
*
* Revision 4.3  1998/06/12 15:22:29  kardel
* fix prototypes
*
* Revision 4.2  1998/06/12 09:13:26  kardel
* conditional compile macros fixed
* printf prototype
*
* Revision 4.1  1998/05/24 09:39:54  kardel
* implementation of the new IO handling model
*
* Revision 4.0  1998/04/10 19:45:31  kardel
* Start 4.0 release version numbering
*
* from V3 1.4 log info deleted 1998/04/11 kardel
*/