contrib/ntp/libparse/clk_wharton.c

   1 /*
   2  * /src/NTP/ntp4-dev/libparse/clk_wharton.c,v 4.2 2004/11/14 15:29:41 kardel RELEASE_20050508_A
   3  *
   4  * clk_wharton.c,v 4.2 2004/11/14 15:29:41 kardel RELEASE_20050508_A
   5  *
   6  * From Philippe De Muyter <phdm@macqel.be>, 1999
   7  */
   8 #ifdef HAVE_CONFIG_H
   9 #include <config.h>
  10 #endif
  11
  12 #if defined(REFCLOCK) && defined(CLOCK_PARSE) && defined(CLOCK_WHARTON_400A)
  13 /*
  14  * Support for WHARTON 400A Series clock + 404.2 serial interface.
  15  *
  16  * Copyright (C) 1999, 2000 by Philippe De Muyter <phdm@macqel.be>
  17  *
  18  * This program is distributed in the hope that it will be useful, but WITHOUT
  19  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  20  * FITNESS FOR A PARTICULAR PURPOSE.
  21  *
  22  */
  23
  24 #include "ntp_fp.h"
  25 #include "ascii.h"
  26 #include "parse.h"
  27
  28 #ifndef PARSESTREAM
  29 #include "ntp_stdlib.h"
  30 #include <stdio.h>
  31 #else
  32 #include "sys/parsestreams.h"
  33 extern void printf (const char *, ...);
  34 #endif
  35
  36 /*
  37  * In private e-mail alastair@wharton.co.uk said :
  38  * "If you are going to use the 400A and 404.2 system [for ntp] I recommend
  39  * that you set the 400A to output the message every second.  The start of
  40  * transmission of the first byte of the message is synchronised to the
  41  * second edge."
  42  * The WHARTON 400A Series is able to send date/time serial messages
  43  * in 7 output formats.  We use format 1 here because it is the shortest.
  44  * For use with this driver, the WHARTON 400A Series clock must be set-up
  45  * as follows :
  46  *                                      Programmable    Selected
  47  *                                      Option No       Option
  48  *      BST or CET display              3               9 or 11
  49  *      No external controller          7               0
  50  *      Serial Output Format 1          9               1
  51  *      Baud rate 9600 bps              10              96
  52  *      Bit length 8 bits               11              8
  53  *      Parity even                     12              E
  54  *
  55  * WHARTON 400A Series output format 1 is as follows :
  56  *
  57  * Timestamp    STXssmmhhDDMMYYSETX
  58  * Pos          0  12345678901234
  59  *              0  00000000011111
  60  *
  61  *      STX     start transmission (ASCII 0x02)
  62  *      ETX     end transmission (ASCII 0x03)
  63  *      ss      Second expressed in reversed decimal (units then tens)
  64  *      mm      Minute expressed in reversed decimal
  65  *      hh      Hour expressed in reversed decimal
  66  *      DD      Day of month expressed in reversed decimal
  67  *      MM      Month expressed in reversed decimal (January is 1)
  68  *      YY      Year (without century) expressed in reversed decimal
  69  *      S       Status byte : 0x30 +
  70  *                      bit 0   0 = MSF source          1 = DCF source
  71  *                      bit 1   0 = Winter time         1 = Summer time
  72  *                      bit 2   0 = not synchronised    1 = synchronised
  73  *                      bit 3   0 = no early warning    1 = early warning
  74  *
  75  */
  76
  77 static parse_cvt_fnc_t cvt_wharton_400a;
  78 static parse_inp_fnc_t inp_wharton_400a;
  79
  80 /*
  81  * parse_cvt_fnc_t cvt_wharton_400a
  82  *
  83  * convert simple type format
  84  */
  85 static          u_long
  86 cvt_wharton_400a(
  87         unsigned char *buffer,
  88         int            size,
  89         struct format *format,
  90         clocktime_t   *clock_time,
  91         void          *local
  92         )
  93 {
  94         int     i;
  95
  96         /* The given `size' includes a terminating null-character. */
  97         if (size != 15 || buffer[0] != STX || buffer[14] != ETX
  98             || buffer[13] < '0' || buffer[13] > ('0' + 0xf))
  99                 return CVT_NONE;
 100         for (i = 1; i < 13; i += 1)
 101                 if (buffer[i] < '0' || buffer[i] > '9')
 102                         return CVT_NONE;
 103         clock_time->second = (buffer[2] - '0') * 10 + buffer[1] - '0';
 104         clock_time->minute = (buffer[4] - '0') * 10 + buffer[3] - '0';
 105         clock_time->hour   = (buffer[6] - '0') * 10 + buffer[5] - '0';
 106         clock_time->day    = (buffer[8] - '0') * 10 + buffer[7] - '0';
 107         clock_time->month  = (buffer[10] - '0') * 10 + buffer[9] - '0';
 108         clock_time->year   = (buffer[12] - '0') * 10 + buffer[11] - '0';
 109         clock_time->usecond = 0;
 110         if (buffer[13] & 0x1) /* We have CET time */
 111                 clock_time->utcoffset = -1*60*60;
 112         else            /* We have BST time */
 113                 clock_time->utcoffset = 0;
 114         if (buffer[13] & 0x2) {
 115                 clock_time->flags |= PARSEB_DST;
 116                 clock_time->utcoffset += -1*60*60;
 117         }
 118         if (!(buffer[13] & 0x4))
 119                 clock_time->flags |= PARSEB_NOSYNC;
 120         if (buffer[13] & 0x8)
 121                 clock_time->flags |= PARSEB_ANNOUNCE;
 122
 123         return CVT_OK;
 124 }
 125
 126 /*
 127  * parse_inp_fnc_t inp_wharton_400a
 128  *
 129  * grab data from input stream
 130  */
 131 static u_long
 132 inp_wharton_400a(
 133               parse_t      *parseio,
 134               char         ch,
 135               timestamp_t  *tstamp
 136               )
 137 {
 138         unsigned int rtc;
 139
 140         parseprintf(DD_PARSE, ("inp_wharton_400a(0x%p, 0x%x, ...)\n", (void*)parseio, ch));
 141
 142         switch (ch)
 143         {
 144         case STX:
 145                 parseprintf(DD_PARSE, ("inp_wharton_400a: STX seen\n"));
 146
 147                 parseio->parse_index = 1;
 148                 parseio->parse_data[0] = ch;
 149                 parseio->parse_dtime.parse_stime = *tstamp; /* collect timestamp */
 150                 return PARSE_INP_SKIP;
 151
 152         case ETX:
 153                 parseprintf(DD_PARSE, ("inp_wharton_400a: ETX seen\n"));
 154                 if ((rtc = parse_addchar(parseio, ch)) == PARSE_INP_SKIP)
 155                         return parse_end(parseio);
 156                 else
 157                         return rtc;
 158
 159         default:
 160                 return parse_addchar(parseio, ch);
 161         }
 162 }
 163
 164 clockformat_t   clock_wharton_400a =
 165 {
 166         inp_wharton_400a,       /* input handling function */
 167         cvt_wharton_400a,       /* conversion function */
 168         0,                      /* no PPS monitoring */
 169         0,                      /* conversion configuration */
 170         "WHARTON 400A Series clock Output Format 1",    /* String format name */
 171         15,                     /* string buffer */
 172         0                       /* no private data (complete packets) */
 173 };
 174
 175 #else /* not (REFCLOCK && CLOCK_PARSE && CLOCK_WHARTON_400A) */
 176 int clk_wharton_400a_bs;
 177 #endif /* not (REFCLOCK && CLOCK_PARSE && CLOCK_WHARTON_400A) */
 178
 179 /*
 180  * clk_wharton.c,v
 181  * Revision 4.1  1999/02/28 15:27:24  kardel
 182  * wharton clock integration
 183  *
 184  */