LRSD stephane / Mbed 2 deprecated WEBserverv4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

lwip/SNTPClient/SNTPClient.cpp@0:3c32eeb9292a, 2011-09-22 (annotated)

Committer:
geiineuville
Date:
Thu Sep 22 15:59:17 2011 +0000
Revision:
0:3c32eeb9292a
V4

Who changed what in which revision?

UserRevisionLine numberNew contents of line
geiineuville 0:3c32eeb9292a 1 /*
geiineuville 0:3c32eeb9292a 2 * SNTPClient.cpp
geiineuville 0:3c32eeb9292a 3 * SNTP (Simple NTP) client
geiineuville 0:3c32eeb9292a 4 * Written by iva2k
geiineuville 0:3c32eeb9292a 5 *
geiineuville 0:3c32eeb9292a 6 * Wrapper around LWIP/sntp for MBED, with DST rules.
geiineuville 0:3c32eeb9292a 7 * This implementation relies on:
geiineuville 0:3c32eeb9292a 8 * 1. LWIP (http://www.sics.se/~adam/lwip/) adopted for MBED
geiineuville 0:3c32eeb9292a 9 * http://mbed.org/projects/cookbook/svn/EMAC/lwip/trunk
geiineuville 0:3c32eeb9292a 10 * 2. LWIP's contributed SNTP client (sntp.c and sntp.h) from
geiineuville 0:3c32eeb9292a 11 * http://cvs.savannah.gnu.org/viewvc/contrib/apps/sntp/?root=lwip
geiineuville 0:3c32eeb9292a 12 * (used version 1.8)
geiineuville 0:3c32eeb9292a 13 *
geiineuville 0:3c32eeb9292a 14 * Changes needed in LWIP/sntp:
geiineuville 0:3c32eeb9292a 15 * - pointer typecast (line 594) - fixes mbed compiler problem
geiineuville 0:3c32eeb9292a 16 * - #include "sntp.h" moved after lwip/opt.h et.al - for re-defines.
geiineuville 0:3c32eeb9292a 17 * - pbuf_free(p) in sntp_send_request() (line 602) - fixes memory leak BUG.
geiineuville 0:3c32eeb9292a 18 * - changing sntp_dns_found() to delayed sntp_try_next_server() - to unblock if network is disconnected.
geiineuville 0:3c32eeb9292a 19 *
geiineuville 0:3c32eeb9292a 20 * Changes in MBED's LWIP:
geiineuville 0:3c32eeb9292a 21 * - modified lwipopts.h (this file is automatically included into sntp.c)
geiineuville 0:3c32eeb9292a 22 *
geiineuville 0:3c32eeb9292a 23 * Requirements:
geiineuville 0:3c32eeb9292a 24 * + direct RTC update from receiving the NTP time packet
geiineuville 0:3c32eeb9292a 25 * + optionally support more than one NTP server
geiineuville 0:3c32eeb9292a 26 * + the IP address of the NTP server(s) stored in a local file
geiineuville 0:3c32eeb9292a 27 * + timeout error recovery should the NTP server(s) not be available. No RTC update should the NTP access fail
geiineuville 0:3c32eeb9292a 28 * + allow for a UTC offset, also stored in the local file
geiineuville 0:3c32eeb9292a 29 * + DST correction
geiineuville 0:3c32eeb9292a 30 * + use DNS for NTP servers IP address resolution
geiineuville 0:3c32eeb9292a 31 * + periodic updates at specified time intervals
geiineuville 0:3c32eeb9292a 32 *
geiineuville 0:3c32eeb9292a 33 * TODO:
geiineuville 0:3c32eeb9292a 34 * . DST correction
geiineuville 0:3c32eeb9292a 35 * - record metrics (count of updates, failed tries?, correction more than epsilon, etc.?)
geiineuville 0:3c32eeb9292a 36 */
geiineuville 0:3c32eeb9292a 37
geiineuville 0:3c32eeb9292a 38 #include "mbed.h"
geiineuville 0:3c32eeb9292a 39 #include "lwip/opt.h"
geiineuville 0:3c32eeb9292a 40 #include "SNTPClient.h"
geiineuville 0:3c32eeb9292a 41
geiineuville 0:3c32eeb9292a 42 #define SNTP_EPSILON 10 // time difference noticed as big update (in seconds).
geiineuville 0:3c32eeb9292a 43
geiineuville 0:3c32eeb9292a 44 //#define SNTP_DST_TESTS // Define this to run DST algorithms tests
geiineuville 0:3c32eeb9292a 45
geiineuville 0:3c32eeb9292a 46 typedef struct DST_ZONE_DESCR {
geiineuville 0:3c32eeb9292a 47 tDST_ZONE zone;
geiineuville 0:3c32eeb9292a 48 const char *name;
geiineuville 0:3c32eeb9292a 49 int gmt;
geiineuville 0:3c32eeb9292a 50 int dst;
geiineuville 0:3c32eeb9292a 51 int hr1;
geiineuville 0:3c32eeb9292a 52 int wk1;
geiineuville 0:3c32eeb9292a 53 int wday1;
geiineuville 0:3c32eeb9292a 54 int mon1;
geiineuville 0:3c32eeb9292a 55 int hr2;
geiineuville 0:3c32eeb9292a 56 int wk2;
geiineuville 0:3c32eeb9292a 57 int wday2;
geiineuville 0:3c32eeb9292a 58 int mon2;
geiineuville 0:3c32eeb9292a 59 pFncDstCalc fnc;
geiineuville 0:3c32eeb9292a 60 } tDST_ZONE_DESR;
geiineuville 0:3c32eeb9292a 61
geiineuville 0:3c32eeb9292a 62 static tDST_ZONE_DESR gSntpDstZones[] = {
geiineuville 0:3c32eeb9292a 63 #define _(z, fnc, gmt, dst, hr1,wk1,wday1,mon1, hr2,wk2,wday2,mon2) \
geiineuville 0:3c32eeb9292a 64 { z, #z, gmt, dst, hr1,wk1,wday1,mon1, hr2,wk2,wday2,mon2, fnc },
geiineuville 0:3c32eeb9292a 65 #include "DstZones.h"
geiineuville 0:3c32eeb9292a 66 };
geiineuville 0:3c32eeb9292a 67 #define DST_ZONE_DESCR_CNT (sizeof(gSntpDstZones)/sizeof(gSntpDstZones[0]))
geiineuville 0:3c32eeb9292a 68
geiineuville 0:3c32eeb9292a 69 const char *SNTPDstZoneName(tDST_ZONE zone) {
geiineuville 0:3c32eeb9292a 70 if (zone >= DST_ZONE_DESCR_CNT)
geiineuville 0:3c32eeb9292a 71 return "";
geiineuville 0:3c32eeb9292a 72 return gSntpDstZones[zone].name;
geiineuville 0:3c32eeb9292a 73 }
geiineuville 0:3c32eeb9292a 74
geiineuville 0:3c32eeb9292a 75 #ifdef __cplusplus
geiineuville 0:3c32eeb9292a 76 extern "C" {
geiineuville 0:3c32eeb9292a 77 #endif
geiineuville 0:3c32eeb9292a 78 tDST_ZONE gSntpDstZone = DST_NONE; // DST zone - rule selector
geiineuville 0:3c32eeb9292a 79 unsigned int gSntpRecvTimeout_s = 3; // 3 sec; SNTP_RECV_TIMEOUT
geiineuville 0:3c32eeb9292a 80 unsigned int gSntpUpdateDelay_s = 3600; // 1 hour; SNTP_UPDATE_DELAY
geiineuville 0:3c32eeb9292a 81 signed int gSntpTimezone = 0*3600; // seconds from UTC to local time
geiineuville 0:3c32eeb9292a 82 signed int gSntpDST = 0*3600; // seconds from UTC to local time
geiineuville 0:3c32eeb9292a 83 bool gSntpRtcUtc = false; // true to keep RTC in UTC, false to keep in local time
geiineuville 0:3c32eeb9292a 84 unsigned int gSntpUpdates = 0; // Track number of all clock NTP updates
geiineuville 0:3c32eeb9292a 85 unsigned int gSntpUpdatesBig = 0; // Track number of significant clock NTP updates
geiineuville 0:3c32eeb9292a 86 bool gSntpRunning = false; // true if SNTP service is running
geiineuville 0:3c32eeb9292a 87 Timeout gSntpDelay; // For async calls.
geiineuville 0:3c32eeb9292a 88 Ticker gSntpTicker; // There is no RTC interrupt on MBED (yet). Use (more wastefull) timer.
geiineuville 0:3c32eeb9292a 89 time_t gSntpRtcTCR = 0; // Timer Capture Register equivalent (in RTC time - either local or UTC depending on gSntpRtcUtc)
geiineuville 0:3c32eeb9292a 90 signed int gSntpRtcTCRDST = 0; // New DST value for when RTC crosses gSntpRtcTCR
geiineuville 0:3c32eeb9292a 91
geiineuville 0:3c32eeb9292a 92 static void SNTPSetDSTEx(unsigned int dst, bool adjust_clock) {
geiineuville 0:3c32eeb9292a 93 if (adjust_clock && !gSntpRtcUtc && gSntpDST != dst) {
geiineuville 0:3c32eeb9292a 94 time_t seconds = time(NULL);
geiineuville 0:3c32eeb9292a 95 seconds -= gSntpDST; // Convert from old local time
geiineuville 0:3c32eeb9292a 96 seconds += dst; // Convert to new local time
geiineuville 0:3c32eeb9292a 97 set_time(seconds);
geiineuville 0:3c32eeb9292a 98 if (gSntpRtcTCR) {
geiineuville 0:3c32eeb9292a 99 // Adjust our alarm clock
geiineuville 0:3c32eeb9292a 100 gSntpRtcTCR -= gSntpDST;
geiineuville 0:3c32eeb9292a 101 gSntpRtcTCR += dst;
geiineuville 0:3c32eeb9292a 102 }
geiineuville 0:3c32eeb9292a 103 }
geiineuville 0:3c32eeb9292a 104 gSntpDST = dst;
geiineuville 0:3c32eeb9292a 105 }
geiineuville 0:3c32eeb9292a 106
geiineuville 0:3c32eeb9292a 107 #if 0
geiineuville 0:3c32eeb9292a 108 // Custom DST zone function example
geiineuville 0:3c32eeb9292a 109 // USA (since 2007)
geiineuville 0:3c32eeb9292a 110 // Calculate start or stop DST point for given year based on rules
geiineuville 0:3c32eeb9292a 111 // tz - Timezone
geiineuville 0:3c32eeb9292a 112 // year - current year. DST changes well away from year end, so does not matter what timezone.
geiineuville 0:3c32eeb9292a 113 // start - DST_START for start, DST_STOP for stop
geiineuville 0:3c32eeb9292a 114 // Returns DST point (in local time). DST_STOP time is in DST
geiineuville 0:3c32eeb9292a 115 static tDstPoint _sntp_dst_calc_custom(int tz, int year, tDST_START start) {
geiineuville 0:3c32eeb9292a 116 tDstPoint ret;
geiineuville 0:3c32eeb9292a 117 struct tm t;
geiineuville 0:3c32eeb9292a 118
geiineuville 0:3c32eeb9292a 119 // USA: 3600; 2, Second SUN, March; 2, First SUN, November
geiineuville 0:3c32eeb9292a 120 int dst = 3600; // DST shift (seconds)
geiineuville 0:3c32eeb9292a 121 int hour; // Hour of the change
geiineuville 0:3c32eeb9292a 122 int N; // Week in the month
geiineuville 0:3c32eeb9292a 123 int wday; // Day of the week
geiineuville 0:3c32eeb9292a 124 int month;
geiineuville 0:3c32eeb9292a 125 if (start == DST_START) {
geiineuville 0:3c32eeb9292a 126 hour = 2; // (0-23) Hour of the change
geiineuville 0:3c32eeb9292a 127 N = 2-1; // 2nd in the month
geiineuville 0:3c32eeb9292a 128 wday = 0; // Sunday
geiineuville 0:3c32eeb9292a 129 month = 2; // March
geiineuville 0:3c32eeb9292a 130 } else { // DST_STOP
geiineuville 0:3c32eeb9292a 131 hour = 2; // (0-23) Hour of the change
geiineuville 0:3c32eeb9292a 132 N = 1-1; // 1st in the month
geiineuville 0:3c32eeb9292a 133 wday = 0; // Sunday
geiineuville 0:3c32eeb9292a 134 month = 10; // November
geiineuville 0:3c32eeb9292a 135 }
geiineuville 0:3c32eeb9292a 136
geiineuville 0:3c32eeb9292a 137 t.tm_sec = 0; // 0-59
geiineuville 0:3c32eeb9292a 138 t.tm_min = 0; // 0-59
geiineuville 0:3c32eeb9292a 139 t.tm_hour = hour; // 0-23
geiineuville 0:3c32eeb9292a 140 t.tm_year = year - 1900; //
geiineuville 0:3c32eeb9292a 141 t.tm_mon = month; // 0-11
geiineuville 0:3c32eeb9292a 142 t.tm_mday = 1+N*7; // 1-31, first possible date for Nth given weekday
geiineuville 0:3c32eeb9292a 143 mktime(&t); // Calculate tm_wday
geiineuville 0:3c32eeb9292a 144 t.tm_mday += (wday-t.tm_wday+14)%7; // Shift to wday
geiineuville 0:3c32eeb9292a 145 ret.t = mktime(&t);
geiineuville 0:3c32eeb9292a 146 ret.dst = (start == DST_START) ? dst : 0;
geiineuville 0:3c32eeb9292a 147 ret.dstshift = dst;
geiineuville 0:3c32eeb9292a 148 return ret;
geiineuville 0:3c32eeb9292a 149 }
geiineuville 0:3c32eeb9292a 150 #endif
geiineuville 0:3c32eeb9292a 151
geiineuville 0:3c32eeb9292a 152 // Calculate start or stop DST point for given year based on rules for the DST zone
geiineuville 0:3c32eeb9292a 153 // tz - Timezone
geiineuville 0:3c32eeb9292a 154 // zone - DST zone
geiineuville 0:3c32eeb9292a 155 // year - current year. DST changes well away from year end, so does not matter timezone.
geiineuville 0:3c32eeb9292a 156 // start - DST_START for start, DST_STOP for stop
geiineuville 0:3c32eeb9292a 157 // Returns DST point (in standard local time). DST_STOP time is in NOT IN DST
geiineuville 0:3c32eeb9292a 158 static tDstPoint _sntp_dst_calc(int tz, tDST_ZONE zone, int year, tDST_START start) {
geiineuville 0:3c32eeb9292a 159 tDstPoint ret;
geiineuville 0:3c32eeb9292a 160
geiineuville 0:3c32eeb9292a 161 ret.t = 0;
geiineuville 0:3c32eeb9292a 162 ret.dst = 0;
geiineuville 0:3c32eeb9292a 163 ret.dstshift = 0;
geiineuville 0:3c32eeb9292a 164 if (zone == DST_NONE || zone >= DST_ZONE_DESCR_CNT)
geiineuville 0:3c32eeb9292a 165 return ret;
geiineuville 0:3c32eeb9292a 166
geiineuville 0:3c32eeb9292a 167 tDST_ZONE_DESR *descr = &gSntpDstZones[zone];
geiineuville 0:3c32eeb9292a 168 if (descr->fnc) {
geiineuville 0:3c32eeb9292a 169 // Use custom function
geiineuville 0:3c32eeb9292a 170 ret = descr->fnc(tz, year, start);
geiineuville 0:3c32eeb9292a 171 } else {
geiineuville 0:3c32eeb9292a 172 // Use rules
geiineuville 0:3c32eeb9292a 173 struct tm t;
geiineuville 0:3c32eeb9292a 174 t.tm_sec = 0; // 0-59
geiineuville 0:3c32eeb9292a 175 t.tm_min = 0; // 0-59
geiineuville 0:3c32eeb9292a 176 t.tm_hour = (start == DST_START) ? descr->hr1 : descr->hr2;
geiineuville 0:3c32eeb9292a 177 t.tm_year = year - 1900; //
geiineuville 0:3c32eeb9292a 178 t.tm_mon = (start == DST_START) ? descr->mon1 : descr->mon2; // 0-11
geiineuville 0:3c32eeb9292a 179 int wk =((start == DST_START) ? descr->wk1 : descr->wk2) -1;
geiineuville 0:3c32eeb9292a 180 int wday = (start == DST_START) ? descr->wday1: descr->wday2;
geiineuville 0:3c32eeb9292a 181 if (wk < 0) {
geiineuville 0:3c32eeb9292a 182 // For "Last in the month" - we go to next month, then move back by one week
geiineuville 0:3c32eeb9292a 183 t.tm_mon += 1; // 0-11
geiineuville 0:3c32eeb9292a 184 if (t.tm_mon > 11) {
geiineuville 0:3c32eeb9292a 185 t.tm_mon -= 12;
geiineuville 0:3c32eeb9292a 186 t.tm_year += 1;
geiineuville 0:3c32eeb9292a 187 }
geiineuville 0:3c32eeb9292a 188 t.tm_mday = 1+0*7; // 1-31, first possible date for Nth given weekday
geiineuville 0:3c32eeb9292a 189 } else {
geiineuville 0:3c32eeb9292a 190 t.tm_mday = 1+wk*7; // 1-31, first possible date for Nth given weekday
geiineuville 0:3c32eeb9292a 191 }
geiineuville 0:3c32eeb9292a 192 mktime(&t); // Calculate tm_wday
geiineuville 0:3c32eeb9292a 193 t.tm_mday += (wday-t.tm_wday+14)%7; // Shift to wday
geiineuville 0:3c32eeb9292a 194 ret.t = mktime(&t);
geiineuville 0:3c32eeb9292a 195 if (wk < 0) {
geiineuville 0:3c32eeb9292a 196 ret.t -= 7 * 24 * 3600;
geiineuville 0:3c32eeb9292a 197 }
geiineuville 0:3c32eeb9292a 198 if (descr->gmt) {
geiineuville 0:3c32eeb9292a 199 ret.t += tz;
geiineuville 0:3c32eeb9292a 200 }
geiineuville 0:3c32eeb9292a 201 ret.dst = (start == DST_START) ? descr->dst : 0;
geiineuville 0:3c32eeb9292a 202 ret.dstshift = descr->dst;
geiineuville 0:3c32eeb9292a 203 }
geiineuville 0:3c32eeb9292a 204 if (start == DST_STOP) {
geiineuville 0:3c32eeb9292a 205 ret.t -= ret.dstshift;
geiineuville 0:3c32eeb9292a 206 // this correction is due to the fact that rules are given in local time with DST,
geiineuville 0:3c32eeb9292a 207 // but calculations are made in standard local time (without DST adjustment)
geiineuville 0:3c32eeb9292a 208 }
geiineuville 0:3c32eeb9292a 209 return ret;
geiineuville 0:3c32eeb9292a 210 }
geiineuville 0:3c32eeb9292a 211
geiineuville 0:3c32eeb9292a 212 // Calculate desired DST point relative to now based on rules for the DST zone
geiineuville 0:3c32eeb9292a 213 // tz - timezone
geiineuville 0:3c32eeb9292a 214 // zone - DST zone
geiineuville 0:3c32eeb9292a 215 // now - current time (standard local time = excluding DST).
geiineuville 0:3c32eeb9292a 216 // index - 0 for immediate next, +1 for second next, -1 for immediate previous
geiineuville 0:3c32eeb9292a 217 // Returns DST point (in standard local time)
geiineuville 0:3c32eeb9292a 218 static tDstPoint _sntp_dst_point(int tz, tDST_ZONE zone, time_t now, int index) {
geiineuville 0:3c32eeb9292a 219 tDstPoint ret;
geiineuville 0:3c32eeb9292a 220 int year;
geiineuville 0:3c32eeb9292a 221 tDST_START type;
geiineuville 0:3c32eeb9292a 222 struct tm *pt = localtime(&now);
geiineuville 0:3c32eeb9292a 223
geiineuville 0:3c32eeb9292a 224 ret.t = 0;
geiineuville 0:3c32eeb9292a 225 ret.dst = 0;
geiineuville 0:3c32eeb9292a 226 ret.dstshift = 0;
geiineuville 0:3c32eeb9292a 227 if (zone == DST_NONE || zone >= DST_ZONE_DESCR_CNT)
geiineuville 0:3c32eeb9292a 228 return ret;
geiineuville 0:3c32eeb9292a 229
geiineuville 0:3c32eeb9292a 230 // Algorithm
geiineuville 0:3c32eeb9292a 231 // 1. Determine where now is in respect to current year DST points (find for index=0)
geiineuville 0:3c32eeb9292a 232 // 2. Use index to shift year and type
geiineuville 0:3c32eeb9292a 233 // 3. return the point
geiineuville 0:3c32eeb9292a 234 // This algorithm relies on DST start date being before DST stop date in the year.
geiineuville 0:3c32eeb9292a 235
geiineuville 0:3c32eeb9292a 236 year = pt->tm_year + 1900;
geiineuville 0:3c32eeb9292a 237 type = DST_START;
geiineuville 0:3c32eeb9292a 238 ret = _sntp_dst_calc(tz, zone, year, type);
geiineuville 0:3c32eeb9292a 239 if (now > ret.t) {
geiineuville 0:3c32eeb9292a 240 type = DST_STOP;
geiineuville 0:3c32eeb9292a 241 ret = _sntp_dst_calc(tz, zone, year, type);
geiineuville 0:3c32eeb9292a 242 if (now > ret.t) {
geiineuville 0:3c32eeb9292a 243 // It is next year's start point
geiineuville 0:3c32eeb9292a 244 type = DST_START;
geiineuville 0:3c32eeb9292a 245 year += 1;
geiineuville 0:3c32eeb9292a 246 }
geiineuville 0:3c32eeb9292a 247 }
geiineuville 0:3c32eeb9292a 248 // Now year and type are right for index=0
geiineuville 0:3c32eeb9292a 249
geiineuville 0:3c32eeb9292a 250 // Calculate where index points to - shift year and type
geiineuville 0:3c32eeb9292a 251 int norm = (index > 0) ? (int)(index/2) : (int)((index-1)/2);
geiineuville 0:3c32eeb9292a 252 year += norm;
geiineuville 0:3c32eeb9292a 253 index -= norm*2; // Now index is (0,1)
geiineuville 0:3c32eeb9292a 254 if (index) {
geiineuville 0:3c32eeb9292a 255 // Flip the type
geiineuville 0:3c32eeb9292a 256 type = (type == DST_START) ? DST_STOP : DST_START;
geiineuville 0:3c32eeb9292a 257 }
geiineuville 0:3c32eeb9292a 258
geiineuville 0:3c32eeb9292a 259 ret = _sntp_dst_calc(tz, zone, year, type);
geiineuville 0:3c32eeb9292a 260 return ret;
geiineuville 0:3c32eeb9292a 261
geiineuville 0:3c32eeb9292a 262 // struct tm t;
geiineuville 0:3c32eeb9292a 263 // t.tm_sec = 0; // 0-59
geiineuville 0:3c32eeb9292a 264 // t.tm_min = 0; // 0-59
geiineuville 0:3c32eeb9292a 265 // t.tm_hour = 0; // 0-23
geiineuville 0:3c32eeb9292a 266 // t.tm_mday = 0; // 1-31
geiineuville 0:3c32eeb9292a 267 // t.tm_mon = 0; // 0-11
geiineuville 0:3c32eeb9292a 268 // t.tm_year = 2005-1900; // year since 1900
geiineuville 0:3c32eeb9292a 269 // t.tm_wday = 0; // 0-6 Day of week (Sunday = 0)
geiineuville 0:3c32eeb9292a 270 // t.tm_yday = 0; // Day of year (0 - 365)
geiineuville 0:3c32eeb9292a 271 // t.tm_isdst = -1; // Nonzero = Daylight saving time
geiineuville 0:3c32eeb9292a 272 }
geiineuville 0:3c32eeb9292a 273
geiineuville 0:3c32eeb9292a 274 #if defined(LWIP_DEBUG)
geiineuville 0:3c32eeb9292a 275 // Print DST dates report
geiineuville 0:3c32eeb9292a 276 static void _sntp_dst_dates(int tz, tDST_ZONE zone, int year) {
geiineuville 0:3c32eeb9292a 277 char _buffer[64];
geiineuville 0:3c32eeb9292a 278 tDstPoint r;
geiineuville 0:3c32eeb9292a 279 printf("\r\nDST DATES for zone %d/%s:\r\n", (int)zone, SNTPDstZoneName(zone));
geiineuville 0:3c32eeb9292a 280
geiineuville 0:3c32eeb9292a 281 r = _sntp_dst_calc(tz, zone, year, DST_START);
geiineuville 0:3c32eeb9292a 282 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 283 printf(" %d DST BEGINS (+%04d sec) %s\r\n", year, r.dst, _buffer);
geiineuville 0:3c32eeb9292a 284
geiineuville 0:3c32eeb9292a 285 r = _sntp_dst_calc(tz, zone, year, DST_STOP);
geiineuville 0:3c32eeb9292a 286 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 287 printf(" %d DST ENDS (+%04d sec) %s\r\n", year, r.dst, _buffer);
geiineuville 0:3c32eeb9292a 288 }
geiineuville 0:3c32eeb9292a 289 #endif
geiineuville 0:3c32eeb9292a 290
geiineuville 0:3c32eeb9292a 291 #ifdef SNTP_DST_TESTS
geiineuville 0:3c32eeb9292a 292 static void test_sntp_dst_calc(int tz, tDST_ZONE zone) {
geiineuville 0:3c32eeb9292a 293 char _buffer[64];
geiineuville 0:3c32eeb9292a 294 tDstPoint r;
geiineuville 0:3c32eeb9292a 295 int year;
geiineuville 0:3c32eeb9292a 296
geiineuville 0:3c32eeb9292a 297 printf("\r\nTEST: _sntp_dst_calc(tz=%d, zone=%d/%s)\r\n", tz, (int)zone, SNTPDstZoneName(zone));
geiineuville 0:3c32eeb9292a 298
geiineuville 0:3c32eeb9292a 299 for (year = 1999; year < 2016; year++) {
geiineuville 0:3c32eeb9292a 300 r = _sntp_dst_calc(tz, zone, year, DST_START);
geiineuville 0:3c32eeb9292a 301 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 302 printf(" (0,%d,start) %s %d\r\n", year, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 303
geiineuville 0:3c32eeb9292a 304 r = _sntp_dst_calc(tz, zone, year, DST_STOP);
geiineuville 0:3c32eeb9292a 305 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 306 printf(" (0,%d,stop ) %s %d\r\n", year, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 307 }
geiineuville 0:3c32eeb9292a 308 }
geiineuville 0:3c32eeb9292a 309
geiineuville 0:3c32eeb9292a 310 static void test_sntp_dst_point(int index) {
geiineuville 0:3c32eeb9292a 311 char _buffer[64];
geiineuville 0:3c32eeb9292a 312 struct tm t;
geiineuville 0:3c32eeb9292a 313 tDstPoint r;
geiineuville 0:3c32eeb9292a 314 int tz=gSntpTimezone;
geiineuville 0:3c32eeb9292a 315 tDST_ZONE zone=gSntpDstZone;
geiineuville 0:3c32eeb9292a 316 int year = 2009, day, month;
geiineuville 0:3c32eeb9292a 317
geiineuville 0:3c32eeb9292a 318 int norm = (index > 0) ? (int)(index/2) : (int)((index-1)/2);
geiineuville 0:3c32eeb9292a 319 printf("\r\nTEST: _sntp_dst_point(%d) norm=%d\r\n", index, norm);
geiineuville 0:3c32eeb9292a 320
geiineuville 0:3c32eeb9292a 321 t.tm_sec = 0; // 0-59
geiineuville 0:3c32eeb9292a 322 t.tm_min = 0; // 0-59
geiineuville 0:3c32eeb9292a 323 t.tm_hour = 9; // 0-23
geiineuville 0:3c32eeb9292a 324 t.tm_year = year-1900;
geiineuville 0:3c32eeb9292a 325
geiineuville 0:3c32eeb9292a 326 day = 1;
geiineuville 0:3c32eeb9292a 327 for (month = 0; month < 2; month++) {
geiineuville 0:3c32eeb9292a 328 t.tm_mon = month;
geiineuville 0:3c32eeb9292a 329 t.tm_mday = day;
geiineuville 0:3c32eeb9292a 330 t.tm_year = year-1900;
geiineuville 0:3c32eeb9292a 331 r = _sntp_dst_point(tz, zone, mktime(&t), index);
geiineuville 0:3c32eeb9292a 332 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 333 printf(" (0,%02d/%02d/%d,%d) %s %d\r\n", month+1, day, year, index, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 334 }
geiineuville 0:3c32eeb9292a 335
geiineuville 0:3c32eeb9292a 336 for (day = 1; day < 32; day++) {
geiineuville 0:3c32eeb9292a 337 t.tm_mon = month;
geiineuville 0:3c32eeb9292a 338 t.tm_mday = day;
geiineuville 0:3c32eeb9292a 339 t.tm_year = year-1900;
geiineuville 0:3c32eeb9292a 340 r = _sntp_dst_point(tz, zone, mktime(&t), index);
geiineuville 0:3c32eeb9292a 341 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 342 printf(" (0,%02d/%02d/%d,%d) %s %d\r\n", month+1, day, year, index, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 343 }
geiineuville 0:3c32eeb9292a 344
geiineuville 0:3c32eeb9292a 345 day = 30;
geiineuville 0:3c32eeb9292a 346 for (; month < 10; month++) {
geiineuville 0:3c32eeb9292a 347 t.tm_mon = month;
geiineuville 0:3c32eeb9292a 348 t.tm_mday = day;
geiineuville 0:3c32eeb9292a 349 t.tm_year = year-1900;
geiineuville 0:3c32eeb9292a 350 r = _sntp_dst_point(tz, zone, mktime(&t), index);
geiineuville 0:3c32eeb9292a 351 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 352 printf(" (0,%02d/%02d/%d,%d) %s %d\r\n", month+1, day, year, index, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 353 }
geiineuville 0:3c32eeb9292a 354
geiineuville 0:3c32eeb9292a 355 for (day = 1; day < 32; day++) {
geiineuville 0:3c32eeb9292a 356 t.tm_mon = month;
geiineuville 0:3c32eeb9292a 357 t.tm_mday = day;
geiineuville 0:3c32eeb9292a 358 t.tm_year = year-1900;
geiineuville 0:3c32eeb9292a 359 r = _sntp_dst_point(tz, zone, mktime(&t), index);
geiineuville 0:3c32eeb9292a 360 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&r.t));
geiineuville 0:3c32eeb9292a 361 printf(" (0,%02d/%02d/%d,%d) %s %d\r\n", month+1, day, year, index, _buffer, r.dst);
geiineuville 0:3c32eeb9292a 362 }
geiineuville 0:3c32eeb9292a 363
geiineuville 0:3c32eeb9292a 364 }
geiineuville 0:3c32eeb9292a 365 #endif // SNTP_DST_TESTS
geiineuville 0:3c32eeb9292a 366
geiineuville 0:3c32eeb9292a 367 // Set current DST
geiineuville 0:3c32eeb9292a 368 static void _sntp_dst_now(void) {
geiineuville 0:3c32eeb9292a 369 time_t now = time(NULL);
geiineuville 0:3c32eeb9292a 370 // Convert to standart local time (no DST)
geiineuville 0:3c32eeb9292a 371 now = gSntpRtcUtc ? (now + gSntpTimezone) : (now - gSntpDST);
geiineuville 0:3c32eeb9292a 372
geiineuville 0:3c32eeb9292a 373 // Check DST setting for now
geiineuville 0:3c32eeb9292a 374 tDstPoint dst = _sntp_dst_point(gSntpTimezone, gSntpDstZone, now, -1);
geiineuville 0:3c32eeb9292a 375
geiineuville 0:3c32eeb9292a 376 #ifdef LWIP_DEBUG
geiineuville 0:3c32eeb9292a 377 char _buffer[64];
geiineuville 0:3c32eeb9292a 378 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&dst.t));
geiineuville 0:3c32eeb9292a 379 LWIP_DEBUGF(SNTP_DEBUG_STATE, (
geiineuville 0:3c32eeb9292a 380 "DEBUG: _sntp_dst_now(%d) based on last DST change on (%d) %s to (+%04d sec)\r\n",
geiineuville 0:3c32eeb9292a 381 now, dst.t, _buffer, dst.dst));
geiineuville 0:3c32eeb9292a 382 #endif
geiineuville 0:3c32eeb9292a 383
geiineuville 0:3c32eeb9292a 384 // Change RTC
geiineuville 0:3c32eeb9292a 385 SNTPSetDSTEx(dst.dst, true);
geiineuville 0:3c32eeb9292a 386 }
geiineuville 0:3c32eeb9292a 387
geiineuville 0:3c32eeb9292a 388 // Plan for next DST change
geiineuville 0:3c32eeb9292a 389 static void _sntp_dst_schedule(void) {
geiineuville 0:3c32eeb9292a 390 time_t now = time(NULL);
geiineuville 0:3c32eeb9292a 391 // Convert to standart local time (no DST)
geiineuville 0:3c32eeb9292a 392 now = gSntpRtcUtc ? (now + gSntpTimezone) : (now - gSntpDST);
geiineuville 0:3c32eeb9292a 393
geiineuville 0:3c32eeb9292a 394 // Check next DST change point
geiineuville 0:3c32eeb9292a 395 tDstPoint dst = _sntp_dst_point(gSntpTimezone, gSntpDstZone, now, 0);
geiineuville 0:3c32eeb9292a 396
geiineuville 0:3c32eeb9292a 397 if (dst.t) {
geiineuville 0:3c32eeb9292a 398
geiineuville 0:3c32eeb9292a 399 #ifdef LWIP_DEBUG
geiineuville 0:3c32eeb9292a 400 char _buffer[64];
geiineuville 0:3c32eeb9292a 401 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&dst.t));
geiineuville 0:3c32eeb9292a 402 #endif
geiineuville 0:3c32eeb9292a 403
geiineuville 0:3c32eeb9292a 404 // Set our alarm clock
geiineuville 0:3c32eeb9292a 405 // Convert from standard local to UTC time or local time
geiineuville 0:3c32eeb9292a 406 dst.t = gSntpRtcUtc ? (dst.t - gSntpTimezone) : (dst.t + gSntpDST);
geiineuville 0:3c32eeb9292a 407
geiineuville 0:3c32eeb9292a 408 #ifdef LWIP_DEBUG
geiineuville 0:3c32eeb9292a 409 if (time(NULL) > dst.t) {
geiineuville 0:3c32eeb9292a 410 LWIP_DEBUGF(SNTP_DEBUG_STATE, (
geiineuville 0:3c32eeb9292a 411 "DEBUG: _sntp_dst_schedule() ASSERTION FAILED !(%d<%d) trying to schedule for the past: %s (+%04d sec)\r\n",
geiineuville 0:3c32eeb9292a 412 time(NULL), dst.t, _buffer, dst.dst));
geiineuville 0:3c32eeb9292a 413 } else {
geiineuville 0:3c32eeb9292a 414 LWIP_DEBUGF(SNTP_DEBUG_STATE, (
geiineuville 0:3c32eeb9292a 415 "DEBUG: _sntp_dst_schedule() scheduled in %d seconds, set for %s (+%04d sec)\r\n",
geiineuville 0:3c32eeb9292a 416 dst.t-time(NULL), _buffer, dst.dst));
geiineuville 0:3c32eeb9292a 417 }
geiineuville 0:3c32eeb9292a 418 #endif
geiineuville 0:3c32eeb9292a 419 }
geiineuville 0:3c32eeb9292a 420 gSntpRtcTCR = dst.t;
geiineuville 0:3c32eeb9292a 421 gSntpRtcTCRDST = dst.dst;
geiineuville 0:3c32eeb9292a 422 }
geiineuville 0:3c32eeb9292a 423
geiineuville 0:3c32eeb9292a 424 // RTC ISR - called upon each RTC tick
geiineuville 0:3c32eeb9292a 425 static void _sntp_isr(void) {
geiineuville 0:3c32eeb9292a 426 time_t seconds = time(NULL);
geiineuville 0:3c32eeb9292a 427 if (gSntpRtcTCR && seconds > gSntpRtcTCR ) {
geiineuville 0:3c32eeb9292a 428 // DST change has arrived
geiineuville 0:3c32eeb9292a 429 gSntpRtcTCR = 0;
geiineuville 0:3c32eeb9292a 430 // Disable ISR and avoid extra calcs in SNTPSetDSTEx()
geiineuville 0:3c32eeb9292a 431
geiineuville 0:3c32eeb9292a 432 //if (gSntpRtcTCRDST != gSntpDST) {
geiineuville 0:3c32eeb9292a 433 // Change to/from DST
geiineuville 0:3c32eeb9292a 434 SNTPSetDSTEx(gSntpRtcTCRDST, true);
geiineuville 0:3c32eeb9292a 435 gSntpRtcTCRDST = 0;
geiineuville 0:3c32eeb9292a 436
geiineuville 0:3c32eeb9292a 437 // Schedule callback to plan for next DST change (take it out of ISR context)
geiineuville 0:3c32eeb9292a 438 gSntpDelay.attach(_sntp_dst_schedule, 1.0);
geiineuville 0:3c32eeb9292a 439
geiineuville 0:3c32eeb9292a 440 #ifdef LWIP_DEBUG
geiineuville 0:3c32eeb9292a 441 char _buffer[64];
geiineuville 0:3c32eeb9292a 442 if (gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 443 seconds += gSntpTimezone + gSntpDST; // Convert to local time
geiineuville 0:3c32eeb9292a 444 }
geiineuville 0:3c32eeb9292a 445 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&seconds));
geiineuville 0:3c32eeb9292a 446 LWIP_DEBUGF(SNTP_DEBUG_STATE, (
geiineuville 0:3c32eeb9292a 447 "DEBUG: _sntp_isr() changed DST. datetime=%s\r\n", _buffer));
geiineuville 0:3c32eeb9292a 448 #endif
geiineuville 0:3c32eeb9292a 449
geiineuville 0:3c32eeb9292a 450 //}
geiineuville 0:3c32eeb9292a 451
geiineuville 0:3c32eeb9292a 452 }
geiineuville 0:3c32eeb9292a 453 }
geiineuville 0:3c32eeb9292a 454
geiineuville 0:3c32eeb9292a 455 // NTP Callback - timestamp from NTP server arrives here
geiineuville 0:3c32eeb9292a 456 void SntpClientSet(time_t seconds) {
geiineuville 0:3c32eeb9292a 457 time_t old_seconds = time(NULL);
geiineuville 0:3c32eeb9292a 458 if (!gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 459 seconds += gSntpTimezone + gSntpDST; // Convert to local time
geiineuville 0:3c32eeb9292a 460 }
geiineuville 0:3c32eeb9292a 461 set_time(seconds);
geiineuville 0:3c32eeb9292a 462
geiineuville 0:3c32eeb9292a 463 // Special tasks for the very first NTP updates
geiineuville 0:3c32eeb9292a 464 if (!gSntpUpdates) {
geiineuville 0:3c32eeb9292a 465
geiineuville 0:3c32eeb9292a 466 #if defined(LWIP_DEBUG)
geiineuville 0:3c32eeb9292a 467 // Report DST dates for the zone
geiineuville 0:3c32eeb9292a 468 struct tm *pt = localtime(&seconds);
geiineuville 0:3c32eeb9292a 469 _sntp_dst_dates(gSntpTimezone, gSntpDstZone, pt->tm_year+1900);
geiineuville 0:3c32eeb9292a 470 #endif
geiineuville 0:3c32eeb9292a 471
geiineuville 0:3c32eeb9292a 472 // DST scheduler
geiineuville 0:3c32eeb9292a 473 _sntp_dst_now();
geiineuville 0:3c32eeb9292a 474 _sntp_dst_schedule();
geiineuville 0:3c32eeb9292a 475
geiineuville 0:3c32eeb9292a 476 // Enable RTC ISR
geiineuville 0:3c32eeb9292a 477 gSntpTicker.attach(_sntp_isr, 1.0);
geiineuville 0:3c32eeb9292a 478 }
geiineuville 0:3c32eeb9292a 479
geiineuville 0:3c32eeb9292a 480 if (gSntpUpdates && abs((int)(old_seconds - seconds)) > SNTP_EPSILON) {
geiineuville 0:3c32eeb9292a 481 printf("SNTP settime() corrected big difference: (%d) seconds, more than %d. Big updates count=%d.\r\n",
geiineuville 0:3c32eeb9292a 482 old_seconds-seconds, SNTP_EPSILON, gSntpUpdatesBig);
geiineuville 0:3c32eeb9292a 483 gSntpUpdatesBig ++;
geiineuville 0:3c32eeb9292a 484 }
geiineuville 0:3c32eeb9292a 485
geiineuville 0:3c32eeb9292a 486 gSntpUpdates++;
geiineuville 0:3c32eeb9292a 487
geiineuville 0:3c32eeb9292a 488 if (1) {
geiineuville 0:3c32eeb9292a 489 char _buffer[64];
geiineuville 0:3c32eeb9292a 490 if (gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 491 seconds += gSntpTimezone + gSntpDST; // Convert to local time
geiineuville 0:3c32eeb9292a 492 }
geiineuville 0:3c32eeb9292a 493 strftime(_buffer, sizeof(_buffer), "%A %m/%d/%Y %H:%M:%S", localtime(&seconds));
geiineuville 0:3c32eeb9292a 494 printf("SNTP settime() #%d seconds=%d TZ=%0.1f datetime=%s\r\n",
geiineuville 0:3c32eeb9292a 495 gSntpUpdates, seconds, gSntpTimezone/3600.0, _buffer);
geiineuville 0:3c32eeb9292a 496 }
geiineuville 0:3c32eeb9292a 497 }
geiineuville 0:3c32eeb9292a 498 #ifdef __cplusplus
geiineuville 0:3c32eeb9292a 499 };
geiineuville 0:3c32eeb9292a 500 #endif
geiineuville 0:3c32eeb9292a 501
geiineuville 0:3c32eeb9292a 502 #ifdef __cplusplus
geiineuville 0:3c32eeb9292a 503 extern "C" {
geiineuville 0:3c32eeb9292a 504 #endif
geiineuville 0:3c32eeb9292a 505
geiineuville 0:3c32eeb9292a 506 #include "lwip/def.h"
geiineuville 0:3c32eeb9292a 507 #include "lwip/pbuf.h"
geiineuville 0:3c32eeb9292a 508 #include "lwip/sys.h"
geiineuville 0:3c32eeb9292a 509 #include "lwip/stats.h"
geiineuville 0:3c32eeb9292a 510 #include "netif/etharp.h"
geiineuville 0:3c32eeb9292a 511 #include "string.h"
geiineuville 0:3c32eeb9292a 512
geiineuville 0:3c32eeb9292a 513 #ifdef __cplusplus
geiineuville 0:3c32eeb9292a 514 };
geiineuville 0:3c32eeb9292a 515 #endif
geiineuville 0:3c32eeb9292a 516
geiineuville 0:3c32eeb9292a 517 // Accomodating sntp timeout functions
geiineuville 0:3c32eeb9292a 518 #if NO_SYS
geiineuville 0:3c32eeb9292a 519 #include "sntp.h"
geiineuville 0:3c32eeb9292a 520 extern void sntp_request(void *arg); // this is dirty hack around "static" function. Some linkers may revolt!
geiineuville 0:3c32eeb9292a 521 extern void sntp_try_next_server(void *arg);
geiineuville 0:3c32eeb9292a 522 extern char* sntp_server_addresses[];
geiineuville 0:3c32eeb9292a 523 extern u8_t sntp_current_server;
geiineuville 0:3c32eeb9292a 524 extern u8_t sntp_num_servers;
geiineuville 0:3c32eeb9292a 525 static void (*sntp_addresses_free)(void*) = NULL;
geiineuville 0:3c32eeb9292a 526 static Timeout _sntp_timer1;
geiineuville 0:3c32eeb9292a 527 static Timeout _sntp_timer2;
geiineuville 0:3c32eeb9292a 528 void sntp_sys_timeout(u32_t timeout_s, void (*func)(void *arg), void *arg) {
geiineuville 0:3c32eeb9292a 529 // all we really need to track is only 2 functions: sntp_request, sntp_try_next_server
geiineuville 0:3c32eeb9292a 530 Timeout *t = NULL;
geiineuville 0:3c32eeb9292a 531 if (func == &sntp_request) {
geiineuville 0:3c32eeb9292a 532 t = &_sntp_timer1;
geiineuville 0:3c32eeb9292a 533 LWIP_DEBUGF(SNTP_DEBUG_STATE, ("DEBUG: IN sntp_sys_timeout(), func=sntp_request\r\n"));
geiineuville 0:3c32eeb9292a 534 } else if (func == &sntp_try_next_server) {
geiineuville 0:3c32eeb9292a 535 t = &_sntp_timer2;
geiineuville 0:3c32eeb9292a 536 LWIP_DEBUGF(SNTP_DEBUG_STATE, ("DEBUG: IN sntp_sys_timeout(), func=sntp_try_next_server\r\n"));
geiineuville 0:3c32eeb9292a 537 }
geiineuville 0:3c32eeb9292a 538 if (t) {
geiineuville 0:3c32eeb9292a 539 t->detach();
geiineuville 0:3c32eeb9292a 540 t->attach((void(*)(void))func, 1.0*timeout_s);
geiineuville 0:3c32eeb9292a 541 // Another shortcut - we have no arg to pass, so just typecast the func.
geiineuville 0:3c32eeb9292a 542 }
geiineuville 0:3c32eeb9292a 543 }
geiineuville 0:3c32eeb9292a 544
geiineuville 0:3c32eeb9292a 545 void sntp_sys_untimeout(void (*func)(void *arg), void *arg) {
geiineuville 0:3c32eeb9292a 546 Timeout *t = NULL;
geiineuville 0:3c32eeb9292a 547 if (func == &sntp_request) {
geiineuville 0:3c32eeb9292a 548 t = &_sntp_timer1;
geiineuville 0:3c32eeb9292a 549 LWIP_DEBUGF(SNTP_DEBUG_STATE, ("DEBUG: IN sntp_sys_untimeout(), func=sntp_request\r\n"));
geiineuville 0:3c32eeb9292a 550 } else if (func == &sntp_try_next_server) {
geiineuville 0:3c32eeb9292a 551 t = &_sntp_timer2;
geiineuville 0:3c32eeb9292a 552 LWIP_DEBUGF(SNTP_DEBUG_STATE, ("DEBUG: IN sntp_sys_untimeout(), func=sntp_try_next_server\r\n"));
geiineuville 0:3c32eeb9292a 553 }
geiineuville 0:3c32eeb9292a 554 if (t) {
geiineuville 0:3c32eeb9292a 555 t->detach();
geiineuville 0:3c32eeb9292a 556 }
geiineuville 0:3c32eeb9292a 557 }
geiineuville 0:3c32eeb9292a 558
geiineuville 0:3c32eeb9292a 559 #else // NO_SYS
geiineuville 0:3c32eeb9292a 560 #error "I don't know how to compile LWIP/SNTP with NO_SYS=0"
geiineuville 0:3c32eeb9292a 561 #endif // NO_SYS
geiineuville 0:3c32eeb9292a 562
geiineuville 0:3c32eeb9292a 563 // Can be called when already running
geiineuville 0:3c32eeb9292a 564 void SNTPSetDstZone(tDST_ZONE zone) {
geiineuville 0:3c32eeb9292a 565 if (zone >= DST_ZONE_DESCR_CNT)
geiineuville 0:3c32eeb9292a 566 return; // ERR_INVALID_ARG
geiineuville 0:3c32eeb9292a 567
geiineuville 0:3c32eeb9292a 568 gSntpDstZone = zone;
geiineuville 0:3c32eeb9292a 569
geiineuville 0:3c32eeb9292a 570 if (gSntpRunning) {
geiineuville 0:3c32eeb9292a 571 // DST scheduler
geiineuville 0:3c32eeb9292a 572 _sntp_dst_now();
geiineuville 0:3c32eeb9292a 573 _sntp_dst_schedule();
geiineuville 0:3c32eeb9292a 574 }
geiineuville 0:3c32eeb9292a 575 }
geiineuville 0:3c32eeb9292a 576
geiineuville 0:3c32eeb9292a 577 void SNTPSetRecvTimeout(unsigned int val_s) { gSntpRecvTimeout_s = val_s; }
geiineuville 0:3c32eeb9292a 578 void SNTPSetUpdateDelay(unsigned int val_s) { gSntpUpdateDelay_s = val_s; }
geiineuville 0:3c32eeb9292a 579 void SNTPSetTimezone(float hours_from_utc, bool adjust_clock) {
geiineuville 0:3c32eeb9292a 580 if (adjust_clock && !gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 581 time_t seconds = time(NULL);
geiineuville 0:3c32eeb9292a 582 seconds -= gSntpTimezone; // Convert from old local time
geiineuville 0:3c32eeb9292a 583 seconds += hours_from_utc * 3600; // Convert to new local time
geiineuville 0:3c32eeb9292a 584 set_time(seconds);
geiineuville 0:3c32eeb9292a 585 if (gSntpRtcTCR) {
geiineuville 0:3c32eeb9292a 586 // Adjust our alarm clock
geiineuville 0:3c32eeb9292a 587 gSntpRtcTCR -= gSntpTimezone;
geiineuville 0:3c32eeb9292a 588 gSntpRtcTCR += hours_from_utc * 3600;
geiineuville 0:3c32eeb9292a 589 }
geiineuville 0:3c32eeb9292a 590 }
geiineuville 0:3c32eeb9292a 591 gSntpTimezone = hours_from_utc * 3600;
geiineuville 0:3c32eeb9292a 592 }
geiineuville 0:3c32eeb9292a 593 void SNTPSetDST(float hours_from_utc, bool adjust_clock) {
geiineuville 0:3c32eeb9292a 594 SNTPSetDSTEx(hours_from_utc * 3600, adjust_clock);
geiineuville 0:3c32eeb9292a 595 }
geiineuville 0:3c32eeb9292a 596
geiineuville 0:3c32eeb9292a 597 static int sntp_num_servers_alloc = 0;
geiineuville 0:3c32eeb9292a 598 static void _SNTPClrAddresses(void) {
geiineuville 0:3c32eeb9292a 599 if (!sntp_num_servers_alloc) sntp_num_servers_alloc = sntp_num_servers;
geiineuville 0:3c32eeb9292a 600 // Here we save the original size of the sntp_server_addresses[] array.
geiineuville 0:3c32eeb9292a 601
geiineuville 0:3c32eeb9292a 602 if (sntp_addresses_free) {
geiineuville 0:3c32eeb9292a 603 for (int i=0; i<sntp_num_servers; i++) {
geiineuville 0:3c32eeb9292a 604 sntp_addresses_free(sntp_server_addresses[i]);
geiineuville 0:3c32eeb9292a 605 }
geiineuville 0:3c32eeb9292a 606 }
geiineuville 0:3c32eeb9292a 607 sntp_current_server = 0;
geiineuville 0:3c32eeb9292a 608 sntp_num_servers = 0;
geiineuville 0:3c32eeb9292a 609 sntp_addresses_free = NULL;
geiineuville 0:3c32eeb9292a 610 }
geiineuville 0:3c32eeb9292a 611 static int _SNTPAddAddress(const char* server_address) {
geiineuville 0:3c32eeb9292a 612 if (sntp_num_servers+1 > sntp_num_servers_alloc)
geiineuville 0:3c32eeb9292a 613 return -1;
geiineuville 0:3c32eeb9292a 614 sntp_server_addresses[sntp_num_servers] = (char*)malloc(strlen(server_address)+1);
geiineuville 0:3c32eeb9292a 615 if (sntp_server_addresses[sntp_num_servers] == NULL) return -1; // Out of memory
geiineuville 0:3c32eeb9292a 616 strcpy(sntp_server_addresses[sntp_num_servers], server_address);
geiineuville 0:3c32eeb9292a 617 sntp_num_servers++;
geiineuville 0:3c32eeb9292a 618 return 0;
geiineuville 0:3c32eeb9292a 619 }
geiineuville 0:3c32eeb9292a 620
geiineuville 0:3c32eeb9292a 621 // Override default servers list.
geiineuville 0:3c32eeb9292a 622 // For no-copy, pass pointer to free() in p_free.
geiineuville 0:3c32eeb9292a 623 // Returns: actual number of servers set (limited by allocated buffer size)
geiineuville 0:3c32eeb9292a 624 // WARNING! There is no interlock to ensure that SNTP service does not read its data while we are updating it.
geiineuville 0:3c32eeb9292a 625 // This function is intended to be called only before SNTPClientInit().
geiineuville 0:3c32eeb9292a 626 int SNTPSetAddresses(const char* server_addresses[], int count, void (*p_free)(void*)) {
geiineuville 0:3c32eeb9292a 627 // In order to use sntp.c as-is, we hack into its static variables.
geiineuville 0:3c32eeb9292a 628 // Not all compilers/linkers will support that.
geiineuville 0:3c32eeb9292a 629
geiineuville 0:3c32eeb9292a 630 _SNTPClrAddresses();
geiineuville 0:3c32eeb9292a 631 if (count > sntp_num_servers_alloc)
geiineuville 0:3c32eeb9292a 632 count = sntp_num_servers_alloc;
geiineuville 0:3c32eeb9292a 633 for (int i=0; i<count; i++) {
geiineuville 0:3c32eeb9292a 634 if (p_free) {
geiineuville 0:3c32eeb9292a 635 sntp_server_addresses[i] = (char *)server_addresses[i];
geiineuville 0:3c32eeb9292a 636 } else {
geiineuville 0:3c32eeb9292a 637 _SNTPAddAddress(server_addresses[i]);
geiineuville 0:3c32eeb9292a 638 }
geiineuville 0:3c32eeb9292a 639 }
geiineuville 0:3c32eeb9292a 640 sntp_num_servers = count;
geiineuville 0:3c32eeb9292a 641 sntp_current_server = 0;
geiineuville 0:3c32eeb9292a 642 sntp_addresses_free = p_free ? p_free : &free;
geiineuville 0:3c32eeb9292a 643 return count;
geiineuville 0:3c32eeb9292a 644 }
geiineuville 0:3c32eeb9292a 645
geiineuville 0:3c32eeb9292a 646 // Trim whitespace/CRLFs from both ends of a given string
geiineuville 0:3c32eeb9292a 647 char * str_cleanup(char *in) {
geiineuville 0:3c32eeb9292a 648 char * out = in;
geiineuville 0:3c32eeb9292a 649 // Trim leading spaces and CR/LF
geiineuville 0:3c32eeb9292a 650 while (*out == ' ' || *out == '\t' || *out == '\r' || *out == '\n')
geiineuville 0:3c32eeb9292a 651 out ++;
geiineuville 0:3c32eeb9292a 652 // Trim trailing spaces and CR/LF
geiineuville 0:3c32eeb9292a 653 int len = strlen(out)-1;
geiineuville 0:3c32eeb9292a 654 while (out[len] == ' ' || out[len] == '\t' || out[len] == '\r' || out[len] == '\n') {
geiineuville 0:3c32eeb9292a 655 out[len] = '\0';
geiineuville 0:3c32eeb9292a 656 len--;
geiineuville 0:3c32eeb9292a 657 }
geiineuville 0:3c32eeb9292a 658 return out;
geiineuville 0:3c32eeb9292a 659 }
geiineuville 0:3c32eeb9292a 660
geiineuville 0:3c32eeb9292a 661 #ifndef CRLF
geiineuville 0:3c32eeb9292a 662 #define CRLF "\r\n"
geiineuville 0:3c32eeb9292a 663 #endif
geiineuville 0:3c32eeb9292a 664 void SNTPWriteIniFile(FILE * f) {
geiineuville 0:3c32eeb9292a 665 fprintf(f, "# SNTP Configuration file" CRLF);
geiineuville 0:3c32eeb9292a 666 fprintf(f, CRLF "[Servers]" CRLF);
geiineuville 0:3c32eeb9292a 667 for (int i=0; i<sntp_num_servers; i++) {
geiineuville 0:3c32eeb9292a 668 fprintf(f, "%s" CRLF, sntp_server_addresses[i]);
geiineuville 0:3c32eeb9292a 669 }
geiineuville 0:3c32eeb9292a 670 fprintf(f, CRLF "[Global]" CRLF);
geiineuville 0:3c32eeb9292a 671 fprintf(f, "RtcUtc=%d" CRLF, (int)gSntpRtcUtc);
geiineuville 0:3c32eeb9292a 672 fprintf(f, "Timezone=%0.1f" CRLF, gSntpTimezone / 3600.0);
geiineuville 0:3c32eeb9292a 673 fprintf(f, "DstZone=%d" CRLF, gSntpDstZone);
geiineuville 0:3c32eeb9292a 674 fprintf(f, "# %s" CRLF, SNTPDstZoneName(gSntpDstZone));
geiineuville 0:3c32eeb9292a 675 fprintf(f, "UpdateDelay=%d" CRLF, gSntpUpdateDelay_s);
geiineuville 0:3c32eeb9292a 676 fprintf(f, "RecvTimeout=%d" CRLF, gSntpRecvTimeout_s);
geiineuville 0:3c32eeb9292a 677 fprintf(f, CRLF "##END" CRLF);
geiineuville 0:3c32eeb9292a 678 }
geiineuville 0:3c32eeb9292a 679
geiineuville 0:3c32eeb9292a 680 // Simple ini file parser for SNTP configuration (Case-sensitive!)
geiineuville 0:3c32eeb9292a 681 // This function is intended to be called only before SNTPClientInit().
geiineuville 0:3c32eeb9292a 682 // Returns: 0 if OK, errno otherwise
geiineuville 0:3c32eeb9292a 683 enum {
geiineuville 0:3c32eeb9292a 684 SECT_NONE,
geiineuville 0:3c32eeb9292a 685 SECT_SERVERS,
geiineuville 0:3c32eeb9292a 686 SECT_GLOBAL,
geiineuville 0:3c32eeb9292a 687 };
geiineuville 0:3c32eeb9292a 688 int SNTPReadIniFile(const char* filename) {
geiineuville 0:3c32eeb9292a 689 FILE *f;
geiineuville 0:3c32eeb9292a 690 char buf[512];
geiineuville 0:3c32eeb9292a 691 bool addresses_cleared = false;
geiineuville 0:3c32eeb9292a 692
geiineuville 0:3c32eeb9292a 693 f = fopen(filename, "r");
geiineuville 0:3c32eeb9292a 694 if (!f)
geiineuville 0:3c32eeb9292a 695 return -1; // errno not used?
geiineuville 0:3c32eeb9292a 696
geiineuville 0:3c32eeb9292a 697 char *buf1, *buf2;
geiineuville 0:3c32eeb9292a 698 int section=SECT_NONE;
geiineuville 0:3c32eeb9292a 699 int line = 0;
geiineuville 0:3c32eeb9292a 700 while (fgets(buf, sizeof(buf)/sizeof(buf[0]), f)) {
geiineuville 0:3c32eeb9292a 701 line++;
geiineuville 0:3c32eeb9292a 702 buf1 = str_cleanup(buf);
geiineuville 0:3c32eeb9292a 703 if (*buf1 == '#' || *buf1 == '\0')
geiineuville 0:3c32eeb9292a 704 continue; // Comment line or empty line - skip
geiineuville 0:3c32eeb9292a 705 if (*buf1 == '[') {
geiineuville 0:3c32eeb9292a 706 // New section
geiineuville 0:3c32eeb9292a 707 if (0 == strncmp(buf1,"[Servers]", sizeof("[Servers]")-1)) {
geiineuville 0:3c32eeb9292a 708 section=SECT_SERVERS;
geiineuville 0:3c32eeb9292a 709 if (!addresses_cleared) {
geiineuville 0:3c32eeb9292a 710 // Clear addresses only once.
geiineuville 0:3c32eeb9292a 711 _SNTPClrAddresses();
geiineuville 0:3c32eeb9292a 712 addresses_cleared = true;
geiineuville 0:3c32eeb9292a 713 }
geiineuville 0:3c32eeb9292a 714 } else if (0 == strncmp(buf1,"[Global]", sizeof("[Global]")-1)) {
geiineuville 0:3c32eeb9292a 715 section=SECT_GLOBAL;
geiineuville 0:3c32eeb9292a 716 } else {
geiineuville 0:3c32eeb9292a 717 section=SECT_NONE;
geiineuville 0:3c32eeb9292a 718 fprintf(stderr, "File \"%s\", line %d - section \"%s\" is not understood.\r\n", filename, line, buf1);
geiineuville 0:3c32eeb9292a 719 }
geiineuville 0:3c32eeb9292a 720 } else {
geiineuville 0:3c32eeb9292a 721 // Section values
geiineuville 0:3c32eeb9292a 722 switch (section) {
geiineuville 0:3c32eeb9292a 723 case SECT_SERVERS:
geiineuville 0:3c32eeb9292a 724 if (_SNTPAddAddress(buf1)) {
geiineuville 0:3c32eeb9292a 725 fprintf(stderr, "File \"%s\", line %d - cannot add server \"%s\" - exceeded allocated slots.\r\n", filename, line, buf1);
geiineuville 0:3c32eeb9292a 726 }
geiineuville 0:3c32eeb9292a 727 break;
geiineuville 0:3c32eeb9292a 728 case SECT_GLOBAL:
geiineuville 0:3c32eeb9292a 729 buf2 = strchr(buf1, '=');
geiineuville 0:3c32eeb9292a 730 if (buf2) {
geiineuville 0:3c32eeb9292a 731 *buf2++ = '\0'; // Now buf1 has variable name, buf2 has value
geiineuville 0:3c32eeb9292a 732 buf2 = str_cleanup(buf2);
geiineuville 0:3c32eeb9292a 733 if (0 == strncmp(buf1, "Timezone", sizeof("Timezone")-1)) {
geiineuville 0:3c32eeb9292a 734 gSntpTimezone = strtod(buf2, &buf2) * 3600;
geiineuville 0:3c32eeb9292a 735 } else if (0 == strncmp(buf1, "UpdateDelay", sizeof("UpdateDelay")-1)) {
geiineuville 0:3c32eeb9292a 736 gSntpUpdateDelay_s = strtoul(buf2, &buf2, 10);
geiineuville 0:3c32eeb9292a 737 } else if (0 == strncmp(buf1, "RecvTimeout", sizeof("RecvTimeout")-1)) {
geiineuville 0:3c32eeb9292a 738 gSntpRecvTimeout_s = strtoul(buf2, &buf2, 10);
geiineuville 0:3c32eeb9292a 739 } else if (0 == strncmp(buf1, "RtcUtc", sizeof("RtcUtc")-1)) {
geiineuville 0:3c32eeb9292a 740 gSntpRtcUtc = (bool)strtol(buf2, &buf2, 10);
geiineuville 0:3c32eeb9292a 741 } else if (0 == strncmp(buf1, "DstZone", sizeof("DstZone")-1)) {
geiineuville 0:3c32eeb9292a 742 // FIXME: It would be nice to allow human-readable string here.
geiineuville 0:3c32eeb9292a 743 gSntpDstZone = (tDST_ZONE)strtol(buf2, &buf2, 10);
geiineuville 0:3c32eeb9292a 744 } else {
geiineuville 0:3c32eeb9292a 745 fprintf(stderr, "File \"%s\", line %d - unrecognized variable \"%s\" in section [Global]\r\n", filename, line, buf1);
geiineuville 0:3c32eeb9292a 746 }
geiineuville 0:3c32eeb9292a 747 } else {
geiineuville 0:3c32eeb9292a 748 fprintf(stderr, "File \"%s\", line %d - unrecognized statement in section [Global]: %s\r\n", filename, line, buf1);
geiineuville 0:3c32eeb9292a 749 }
geiineuville 0:3c32eeb9292a 750 break;
geiineuville 0:3c32eeb9292a 751 default:
geiineuville 0:3c32eeb9292a 752 fprintf(stderr, "File \"%s\", line %d - unrecognized statement / no section: %s\r\n", filename, line, buf1);
geiineuville 0:3c32eeb9292a 753 }
geiineuville 0:3c32eeb9292a 754 }
geiineuville 0:3c32eeb9292a 755 }
geiineuville 0:3c32eeb9292a 756 fclose(f);
geiineuville 0:3c32eeb9292a 757 printf("SNTP configuration read from file \"%s\", %d lines.\r\n", filename, line);
geiineuville 0:3c32eeb9292a 758 return 0;
geiineuville 0:3c32eeb9292a 759 }
geiineuville 0:3c32eeb9292a 760
geiineuville 0:3c32eeb9292a 761 // Start the SNTP client
geiineuville 0:3c32eeb9292a 762 void SNTPClientInit(void) {
geiineuville 0:3c32eeb9292a 763
geiineuville 0:3c32eeb9292a 764 #ifdef SNTP_DST_TESTS
geiineuville 0:3c32eeb9292a 765 // Test our DST algorithms
geiineuville 0:3c32eeb9292a 766 test_sntp_dst_calc(gSntpTimezone, gSntpDstZone);
geiineuville 0:3c32eeb9292a 767 test_sntp_dst_point(-2);
geiineuville 0:3c32eeb9292a 768 test_sntp_dst_point(-1);
geiineuville 0:3c32eeb9292a 769 test_sntp_dst_point(0);
geiineuville 0:3c32eeb9292a 770 test_sntp_dst_point(1);
geiineuville 0:3c32eeb9292a 771 test_sntp_dst_point(2);
geiineuville 0:3c32eeb9292a 772 #endif
geiineuville 0:3c32eeb9292a 773
geiineuville 0:3c32eeb9292a 774 // SNTPv4 RFC 4330 enforces a minimum update time of 15 seconds
geiineuville 0:3c32eeb9292a 775 if (gSntpUpdateDelay_s < 15) {
geiineuville 0:3c32eeb9292a 776 gSntpUpdateDelay_s = 15;
geiineuville 0:3c32eeb9292a 777 }
geiineuville 0:3c32eeb9292a 778
geiineuville 0:3c32eeb9292a 779 gSntpRunning = true;
geiineuville 0:3c32eeb9292a 780
geiineuville 0:3c32eeb9292a 781 // Just call this to start SNTP client:
geiineuville 0:3c32eeb9292a 782 sntp_init();
geiineuville 0:3c32eeb9292a 783
geiineuville 0:3c32eeb9292a 784 // // Enable RTC ISR
geiineuville 0:3c32eeb9292a 785 // gSntpTicker.attach(_sntp_isr, 1);
geiineuville 0:3c32eeb9292a 786 // We do it from first NTP response
geiineuville 0:3c32eeb9292a 787 }
geiineuville 0:3c32eeb9292a 788
geiineuville 0:3c32eeb9292a 789 // Use instead of system time()
geiineuville 0:3c32eeb9292a 790 // Returns local time
geiineuville 0:3c32eeb9292a 791 time_t SNTPTime(void) {
geiineuville 0:3c32eeb9292a 792 time_t seconds = time(NULL);
geiineuville 0:3c32eeb9292a 793 if (gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 794 seconds += gSntpTimezone + gSntpDST; // Convert to local time
geiineuville 0:3c32eeb9292a 795 }
geiineuville 0:3c32eeb9292a 796 return seconds;
geiineuville 0:3c32eeb9292a 797 }
geiineuville 0:3c32eeb9292a 798
geiineuville 0:3c32eeb9292a 799 // Use instead of system set_time()
geiineuville 0:3c32eeb9292a 800 // seconds - local time
geiineuville 0:3c32eeb9292a 801 void SNTPSetTime(time_t seconds) {
geiineuville 0:3c32eeb9292a 802 if (gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 803 seconds -= gSntpTimezone + gSntpDST; // Convert from local time
geiineuville 0:3c32eeb9292a 804 }
geiineuville 0:3c32eeb9292a 805 set_time(seconds);
geiineuville 0:3c32eeb9292a 806 }
geiineuville 0:3c32eeb9292a 807
geiineuville 0:3c32eeb9292a 808 // Use instead of system time()
geiineuville 0:3c32eeb9292a 809 // Returns UTC time
geiineuville 0:3c32eeb9292a 810 time_t SNTPTimeUTC(void) {
geiineuville 0:3c32eeb9292a 811 time_t seconds = time(NULL);
geiineuville 0:3c32eeb9292a 812 if (!gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 813 seconds -= gSntpTimezone + gSntpDST; // Convert from local time
geiineuville 0:3c32eeb9292a 814 }
geiineuville 0:3c32eeb9292a 815 return seconds;
geiineuville 0:3c32eeb9292a 816 }
geiineuville 0:3c32eeb9292a 817
geiineuville 0:3c32eeb9292a 818 // Use instead of system set_time()
geiineuville 0:3c32eeb9292a 819 // seconds - UTC time
geiineuville 0:3c32eeb9292a 820 void SNTPSetTimeUTC(time_t seconds) {
geiineuville 0:3c32eeb9292a 821 if (!gSntpRtcUtc) {
geiineuville 0:3c32eeb9292a 822 seconds += gSntpTimezone + gSntpDST; // Convert to local time
geiineuville 0:3c32eeb9292a 823 }
geiineuville 0:3c32eeb9292a 824 set_time(seconds);
geiineuville 0:3c32eeb9292a 825 }
geiineuville 0:3c32eeb9292a 826
geiineuville 0:3c32eeb9292a 827 //END