rtc.c revision 1.12 1 /* $NetBSD: rtc.c,v 1.12 2005/11/16 01:47:58 uwe Exp $ */
2
3 /*
4 * Copyright (c) 2001 Valeriy E. Ushakov
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 /*
31 * `rtc' is a DS1287A (== MC146818A) time-of-day clock at EBus.
32 * In Krups it's not used to store idprom so this driver doesn't
33 * support it. Don't know about other ms-IIep systems.
34 */
35
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: rtc.c,v 1.12 2005/11/16 01:47:58 uwe Exp $");
38
39 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/device.h>
42 #include <sys/malloc.h>
43 #include <sys/systm.h>
44 #ifdef GPROF
45 #include <sys/gmon.h>
46 #endif
47
48 #include <machine/bus.h>
49 #include <machine/autoconf.h>
50
51 #include <dev/clock_subr.h>
52 #include <dev/ic/mc146818reg.h>
53
54 #include <dev/ebus/ebusreg.h>
55 #include <dev/ebus/ebusvar.h>
56
57 struct rtc_ebus_softc {
58 struct device sc_dev;
59
60 bus_space_tag_t sc_bt; /* parent bus tag */
61 bus_space_handle_t sc_bh; /* handle for registers */
62 };
63
64 static int rtcmatch_ebus(struct device *, struct cfdata *, void *);
65 static void rtcattach_ebus(struct device *, struct device *, void *);
66
67 CFATTACH_DECL(rtc_ebus, sizeof(struct rtc_ebus_softc),
68 rtcmatch_ebus, rtcattach_ebus, NULL, NULL);
69
70 /* XXX: global TOD clock handle (sparc/clock.c) */
71 extern todr_chip_handle_t todr_handle;
72
73 /* todr(9) methods */
74 static int rtc_gettime(todr_chip_handle_t, volatile struct timeval *);
75 static int rtc_settime(todr_chip_handle_t, volatile struct timeval *);
76 static int rtc_getcal(todr_chip_handle_t, int *);
77 static int rtc_setcal(todr_chip_handle_t, int);
78
79 int rtc_auto_century_adjust = 1; /* XXX: do we ever want not to? */
80
81
82 /*
83 * MD read/write functions declared in mc146818reg.h
84 */
85 #define RTC_ADDR 0
86 #define RTC_DATA 1
87
88 u_int
89 mc146818_read(void *cookie, u_int reg)
90 {
91 struct rtc_ebus_softc *sc = cookie;
92
93 bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_ADDR, reg);
94 return (bus_space_read_1(sc->sc_bt, sc->sc_bh, RTC_DATA));
95 }
96
97 void
98 mc146818_write(void *cookie, u_int reg, u_int datum)
99 {
100 struct rtc_ebus_softc *sc = cookie;
101
102 bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_ADDR, reg);
103 bus_space_write_1(sc->sc_bt, sc->sc_bh, RTC_DATA, datum);
104 }
105
106
107 static int
108 rtcmatch_ebus(struct device *parent, struct cfdata *cf, void *aux)
109 {
110 struct ebus_attach_args *ea = aux;
111
112 return (strcmp(cf->cf_name, ea->ea_name) == 0);
113 }
114
115 static void
116 rtcattach_ebus(struct device *parent, struct device *self, void *aux)
117 {
118 struct rtc_ebus_softc *sc = (void *)self;
119 struct ebus_attach_args *ea = aux;
120
121 todr_chip_handle_t handle;
122
123 sc->sc_bt = ea->ea_bustag;
124 if (bus_space_map(sc->sc_bt, EBUS_ADDR_FROM_REG(&ea->ea_reg[0]),
125 ea->ea_reg[0].size, 0, &sc->sc_bh) != 0)
126 {
127 printf(": unable to map registers\n");
128 return;
129 }
130
131 /* XXX: no "model" property in Krups */
132 printf(": time-of-day clock\n");
133
134 /*
135 * Turn interrupts off (clear MC_REGB_?IE bits), just in case
136 * (although they shouldn't be wired to an interrupt
137 * controller on sparcs).
138 */
139 mc146818_write(sc, MC_REGB, MC_REGB_BINARY | MC_REGB_24HR);
140
141 /* setup our todr_handle */
142 handle = malloc(ALIGN(sizeof(struct todr_chip_handle)),
143 M_DEVBUF, M_NOWAIT);
144
145 handle->cookie = sc;
146 handle->bus_cookie = NULL; /* unused */
147 handle->todr_gettime = rtc_gettime;
148 handle->todr_settime = rtc_settime;
149 handle->todr_getcal = rtc_getcal;
150 handle->todr_setcal = rtc_setcal;
151 handle->todr_setwen = NULL; /* not necessary, no idprom to protect */
152
153 todr_handle = handle;
154 }
155
156
157 /*
158 * Get time-of-day and convert to a `struct timeval'
159 * Return 0 on success; an error number otherwise.
160 */
161 static int
162 rtc_gettime(todr_chip_handle_t handle, volatile struct timeval *tv)
163 {
164 struct rtc_ebus_softc *sc = handle->cookie;
165 struct clock_ymdhms dt;
166 u_int year;
167
168 /* update in progress; spin loop */
169 while (mc146818_read(sc, MC_REGA) & MC_REGA_UIP)
170 continue;
171
172 /* stop updates (XXX: do we need that???) */
173 mc146818_write(sc, MC_REGB,
174 (mc146818_read(sc, MC_REGB) | MC_REGB_SET));
175
176 /* read time */
177 dt.dt_sec = mc146818_read(sc, MC_SEC);
178 dt.dt_min = mc146818_read(sc, MC_MIN);
179 dt.dt_hour = mc146818_read(sc, MC_HOUR);
180 dt.dt_day = mc146818_read(sc, MC_DOM);
181 dt.dt_mon = mc146818_read(sc, MC_MONTH);
182 year = mc146818_read(sc, MC_YEAR);
183
184 /* reenable updates */
185 mc146818_write(sc, MC_REGB,
186 (mc146818_read(sc, MC_REGB) & ~MC_REGB_SET));
187
188 /* year in the century 0..99: adjust to AD */
189 year += 1900;
190 if (year < POSIX_BASE_YEAR && rtc_auto_century_adjust != 0)
191 year += 100;
192 dt.dt_year = year;
193
194 /* simple sanity checks */
195 if (dt.dt_mon > 12 || dt.dt_day > 31
196 || dt.dt_hour >= 24 || dt.dt_min >= 60 || dt.dt_sec >= 60)
197 return (ERANGE);
198
199 tv->tv_sec = clock_ymdhms_to_secs(&dt);
200 tv->tv_usec = 0;
201 return (0);
202 }
203
204 /*
205 * Set the time-of-day clock based on the value of the `struct timeval' arg.
206 * Return 0 on success; an error number otherwise.
207 */
208 static int
209 rtc_settime(todr_chip_handle_t handle, volatile struct timeval *tv)
210 {
211 struct rtc_ebus_softc *sc = handle->cookie;
212 struct clock_ymdhms dt;
213 u_int year;
214
215 clock_secs_to_ymdhms(tv->tv_sec, &dt);
216
217 year = dt.dt_year - 1900;
218 if (year >= 100 && rtc_auto_century_adjust != 0)
219 year -= 100;
220
221 /* stop updates */
222 mc146818_write(sc, MC_REGB,
223 (mc146818_read(sc, MC_REGB) | MC_REGB_SET));
224
225 mc146818_write(sc, MC_SEC, dt.dt_sec);
226 mc146818_write(sc, MC_MIN, dt.dt_min);
227 mc146818_write(sc, MC_HOUR, dt.dt_hour);
228 mc146818_write(sc, MC_DOW, dt.dt_wday + 1);
229 mc146818_write(sc, MC_DOM, dt.dt_day);
230 mc146818_write(sc, MC_MONTH, dt.dt_mon);
231 mc146818_write(sc, MC_YEAR, year);
232
233 /* reenable updates */
234 mc146818_write(sc, MC_REGB,
235 (mc146818_read(sc, MC_REGB) & ~MC_REGB_SET));
236 return (0);
237 }
238
239
240 /*
241 * RTC does not support TOD clock calibration
242 */
243
244 /* ARGSUSED */
245 static int
246 rtc_getcal(todr_chip_handle_t handle, int *vp)
247 {
248
249 return (EOPNOTSUPP);
250 }
251
252 /* ARGSUSED */
253 static int
254 rtc_setcal(todr_chip_handle_t handle, int v)
255 {
256
257 return (EOPNOTSUPP);
258 }
259