kern_todr.c revision 1.17
1 /* $NetBSD: kern_todr.c,v 1.17 2006/09/12 05:47:47 gdamore Exp $ */ 2 3 /* 4 * Copyright (c) 1992, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * the Systems Programming Group of the University of Utah Computer 9 * Science Department and Ralph Campbell. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * from: Utah Hdr: clock.c 1.18 91/01/21 36 * 37 * @(#)clock.c 8.1 (Berkeley) 6/10/93 38 */ 39 /* 40 * Copyright (c) 1988 University of Utah. 41 * 42 * This code is derived from software contributed to Berkeley by 43 * the Systems Programming Group of the University of Utah Computer 44 * Science Department and Ralph Campbell. 45 * 46 * Redistribution and use in source and binary forms, with or without 47 * modification, are permitted provided that the following conditions 48 * are met: 49 * 1. Redistributions of source code must retain the above copyright 50 * notice, this list of conditions and the following disclaimer. 51 * 2. Redistributions in binary form must reproduce the above copyright 52 * notice, this list of conditions and the following disclaimer in the 53 * documentation and/or other materials provided with the distribution. 54 * 3. All advertising materials mentioning features or use of this software 55 * must display the following acknowledgement: 56 * This product includes software developed by the University of 57 * California, Berkeley and its contributors. 58 * 4. Neither the name of the University nor the names of its contributors 59 * may be used to endorse or promote products derived from this software 60 * without specific prior written permission. 61 * 62 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 63 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 64 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 65 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 66 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 67 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 68 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 69 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 70 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 71 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 72 * SUCH DAMAGE. 73 * 74 * from: Utah Hdr: clock.c 1.18 91/01/21 75 * 76 * @(#)clock.c 8.1 (Berkeley) 6/10/93 77 */ 78 #include <sys/cdefs.h> 79 __KERNEL_RCSID(0, "$NetBSD: kern_todr.c,v 1.17 2006/09/12 05:47:47 gdamore Exp $"); 80 81 #include <sys/param.h> 82 #include <sys/kernel.h> 83 #include <sys/systm.h> 84 #include <sys/device.h> 85 #include <sys/timetc.h> 86 #include <dev/clock_subr.h> /* hmm.. this should probably move to sys */ 87 88 #ifdef __HAVE_GENERIC_TODR 89 90 static todr_chip_handle_t todr_handle = NULL; 91 92 /* 93 * Attach the clock device to todr_handle. 94 */ 95 void 96 todr_attach(todr_chip_handle_t todr) 97 { 98 99 if (todr_handle) { 100 printf("todr_attach: TOD already configured\n"); 101 return; 102 } 103 todr_handle = todr; 104 } 105 106 static int timeset = 0; 107 108 /* 109 * Set up the system's time, given a `reasonable' time value. 110 */ 111 void 112 inittodr(time_t base) 113 { 114 int badbase = 0, waszero = (base == 0), goodtime = 0, badrtc = 0; 115 int s; 116 #ifdef __HAVE_TIMECOUNTER 117 struct timespec ts; 118 #endif 119 struct timeval tv; 120 121 if (base < 5 * SECYR) { 122 struct clock_ymdhms basedate; 123 124 /* 125 * If base is 0, assume filesystem time is just unknown 126 * instead of preposterous. Don't bark. 127 */ 128 if (base != 0) 129 printf("WARNING: preposterous time in file system\n"); 130 /* not going to use it anyway, if the chip is readable */ 131 basedate.dt_year = 2006; 132 basedate.dt_mon = 1; 133 basedate.dt_day = 1; 134 basedate.dt_hour = 12; 135 basedate.dt_min = 0; 136 basedate.dt_sec = 0; 137 base = clock_ymdhms_to_secs(&basedate); 138 badbase = 1; 139 } 140 141 /* 142 * Some ports need to be supplied base in order to fabricate a time_t. 143 */ 144 tv.tv_sec = base; 145 tv.tv_usec = 0; 146 147 if ((todr_handle == NULL) || 148 (todr_gettime(todr_handle, &tv) != 0) || 149 (tv.tv_sec < (25 * SECYR))) { 150 151 if (todr_handle != NULL) { 152 printf("WARNING: preposterous TOD clock time\n"); 153 } 154 else 155 printf("WARNING: no TOD clock present\n"); 156 badrtc = 1; 157 } else { 158 int deltat = tv.tv_sec - base; 159 160 if (deltat < 0) 161 deltat = -deltat; 162 163 if ((badbase == 0) && deltat >= 2 * SECDAY) { 164 165 if (tv.tv_sec < base) { 166 /* 167 * The clock should never go backwards 168 * relative to filesystem time. If it 169 * does by more than the threshold, 170 * believe the filesystem. 171 */ 172 printf("WARNING: clock lost %d days\n", 173 deltat / SECDAY); 174 badrtc = 1; 175 } 176 else { 177 printf("WARNING: clock gained %d days\n", 178 deltat / SECDAY); 179 } 180 } else { 181 goodtime = 1; 182 } 183 } 184 185 /* if the rtc time is bad, use the filesystem time */ 186 if (badrtc) { 187 if (badbase) { 188 printf("WARNING: using default initial time\n"); 189 } else { 190 printf("WARNING: using filesystem time\n"); 191 } 192 tv.tv_sec = base; 193 tv.tv_usec = 0; 194 } 195 196 timeset = 1; 197 198 s = splclock(); 199 #ifdef __HAVE_TIMECOUNTER 200 ts.tv_sec = tv.tv_sec; 201 ts.tv_nsec = tv.tv_usec * 1000; 202 tc_setclock(&ts); 203 #else 204 time = tv; 205 #endif 206 splx(s); 207 208 if (waszero || goodtime) 209 return; 210 211 printf("WARNING: CHECK AND RESET THE DATE!\n"); 212 } 213 214 #ifdef TODR_DEBUG 215 static void 216 todr_debug(const char *prefix, int rv, struct clock_ymdhms *dt, 217 volatile struct timeval *tvp) 218 { 219 struct timeval tv_val; 220 struct clock_ymdhms dt_val; 221 222 if (dt == NULL) { 223 clock_secs_to_ymdhms(tvp->tv_sec, &dt_val); 224 dt = &dt_val; 225 } 226 if (tvp == NULL) { 227 tvp = &tv_val; 228 tvp->tv_sec = clock_ymdhms_to_secs(dt); 229 tvp->tv_usec = 0; 230 } 231 printf("%s: rv = %d\n", prefix, rv); 232 printf("%s: rtc_offset = %d\n", prefix, rtc_offset); 233 printf("%s: %u/%u/%u %02u:%02u:%02u, (wday %d) (epoch %u.%06u)\n", 234 prefix, 235 dt->dt_year, dt->dt_mon, dt->dt_day, 236 dt->dt_hour, dt->dt_min, dt->dt_sec, 237 dt->dt_wday, (unsigned)tvp->tv_sec, (unsigned)tvp->tv_usec); 238 } 239 #else /* !TODR_DEBUG */ 240 #define todr_debug(prefix, rv, dt, tvp) 241 #endif /* TODR_DEBUG */ 242 243 /* 244 * Reset the TODR based on the time value; used when the TODR 245 * has a preposterous value and also when the time is reset 246 * by the stime system call. Also called when the TODR goes past 247 * TODRZERO + 100*(SECYEAR+2*SECDAY) (e.g. on Jan 2 just after midnight) 248 * to wrap the TODR around. 249 */ 250 void 251 resettodr(void) 252 { 253 #ifdef __HAVE_TIMECOUNTER 254 struct timeval time; 255 #endif 256 257 /* 258 * We might have been called by boot() due to a crash early 259 * on. Don't reset the clock chip if we don't know what time 260 * it is. 261 */ 262 if (!timeset) 263 return; 264 265 #ifdef __HAVE_TIMECOUNTER 266 getmicrotime(&time); 267 #endif 268 269 if (time.tv_sec == 0) 270 return; 271 272 if (todr_handle) 273 if (todr_settime(todr_handle, &time) != 0) 274 printf("Cannot set TOD clock time\n"); 275 } 276 277 #endif /* __HAVE_GENERIC_TODR */ 278 279 280 int 281 todr_gettime(todr_chip_handle_t tch, volatile struct timeval *tvp) 282 { 283 struct clock_ymdhms dt; 284 int rv; 285 286 if (tch->todr_gettime) { 287 rv = tch->todr_gettime(tch, tvp); 288 todr_debug("TOD-GET-SECS", rv, NULL, tvp); 289 return rv; 290 } else if (tch->todr_gettime_ymdhms) { 291 rv = tch->todr_gettime_ymdhms(tch, &dt); 292 todr_debug("TOD-GET-YMDHMS", rv, &dt, NULL); 293 if (rv) 294 return rv; 295 296 /* 297 * Formerly we had code here that explicitly checked 298 * for 2038 year rollover. 299 * 300 * However, clock_ymdhms_to_secs performs the same 301 * check for us, so we need not worry about it. Note 302 * that this assumes that the tvp->tv_sec member is 303 * a time_t. 304 */ 305 306 /* simple sanity checks */ 307 if (dt.dt_mon < 1 || dt.dt_mon > 12 || 308 dt.dt_day < 1 || dt.dt_day > 31 || 309 dt.dt_hour >= 24 || dt.dt_min >= 60 || dt.dt_sec >= 62) { 310 return EINVAL; 311 } 312 tvp->tv_sec = clock_ymdhms_to_secs(&dt) + rtc_offset * 60; 313 tvp->tv_usec = 0; 314 return tvp->tv_sec < 0 ? EINVAL : 0; 315 } 316 317 return ENXIO; 318 } 319 320 int 321 todr_settime(todr_chip_handle_t tch, volatile struct timeval *tvp) 322 { 323 struct clock_ymdhms dt; 324 int rv; 325 326 if (tch->todr_settime) { 327 rv = tch->todr_settime(tch, tvp); 328 todr_debug("TODR-SET-SECS", rv, NULL, tvp); 329 return rv; 330 } else if (tch->todr_settime_ymdhms) { 331 time_t sec = tvp->tv_sec - rtc_offset * 60; 332 if (tvp->tv_usec >= 500000) 333 sec++; 334 clock_secs_to_ymdhms(sec, &dt); 335 rv = tch->todr_settime_ymdhms(tch, &dt); 336 todr_debug("TODR-SET-YMDHMS", rv, &dt, NULL); 337 return rv; 338 } else { 339 return ENXIO; 340 } 341 } 342
Indexes created Sun Sep 21 20:09:37 GMT 2025