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