xref: /netbsd-src/sys/arch/hp300/dev/rtc.c (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1 /*	$NetBSD: rtc.c,v 1.17 2006/09/04 23:45:30 gdamore Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1990, 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.
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.2 (Berkeley) 1/12/94
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.
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.2 (Berkeley) 1/12/94
77  */
78 
79 /*
80  * attachment for HP300 real-time clock (RTC)
81  */
82 
83 #include <sys/cdefs.h>
84 __KERNEL_RCSID(0, "$NetBSD: rtc.c,v 1.17 2006/09/04 23:45:30 gdamore Exp $");
85 
86 #include <sys/param.h>
87 #include <sys/systm.h>
88 #include <sys/device.h>
89 #include <sys/malloc.h>
90 
91 #include <hp300/dev/intiovar.h>
92 #include <hp300/dev/rtcreg.h>
93 
94 #include <dev/clock_subr.h>
95 
96 struct rtc_softc {
97 	struct device sc_dev;
98 	bus_space_tag_t sc_bst;
99 	bus_space_handle_t sc_bsh;
100 	struct todr_chip_handle sc_handle;
101 };
102 
103 static int	rtcmatch(struct device *, struct cfdata *, void *);
104 static void	rtcattach(struct device *, struct device *, void *aux);
105 
106 CFATTACH_DECL(rtc, sizeof (struct rtc_softc),
107     rtcmatch, rtcattach, NULL, NULL);
108 
109 static int	rtc_gettime(todr_chip_handle_t, volatile struct timeval *);
110 static int	rtc_settime(todr_chip_handle_t, volatile struct timeval *);
111 static uint8_t	rtc_readreg(struct rtc_softc *, int);
112 static uint8_t	rtc_writereg(struct rtc_softc *, int, uint8_t);
113 
114 
115 static int
116 rtcmatch(struct device *parent, struct cfdata *match, void *aux)
117 {
118 	struct intio_attach_args *ia = aux;
119 
120 	if (strcmp("rtc", ia->ia_modname) != 0)
121 		return 0;
122 
123 	return 1;
124 }
125 
126 static void
127 rtcattach(struct device *parent, struct device *self, void *aux)
128 {
129 	struct intio_attach_args *ia = aux;
130 	struct rtc_softc *sc = (struct rtc_softc *)self;
131 	struct todr_chip_handle *todr_handle;
132 	bus_space_tag_t bst = ia->ia_bst;
133 
134 	printf("\n");
135 
136 	if (bus_space_map(bst, ia->ia_iobase, INTIO_DEVSIZE, 0,
137 	    &sc->sc_bsh)) {
138 		printf("%s: can't map registers\n",
139 		    sc->sc_dev.dv_xname);
140 		return;
141 	}
142 
143 	sc->sc_bst = bst;
144 
145 	todr_handle = &sc->sc_handle;
146 	todr_handle->cookie = sc;
147 	todr_handle->todr_gettime = rtc_gettime;
148 	todr_handle->todr_settime = rtc_settime;
149 	todr_handle->todr_setwen = NULL;
150 
151 	todr_attach(todr_handle);
152 }
153 
154 static int
155 rtc_gettime(todr_chip_handle_t handle, volatile struct timeval *tv)
156 {
157 	struct rtc_softc *sc = (struct rtc_softc *)handle->cookie;
158 	int i, read_okay, year;
159 	struct clock_ymdhms dt;
160 	uint8_t rtc_registers[NUM_RTC_REGS];
161 
162 	/* read rtc registers */
163 	read_okay = 0;
164 	while (!read_okay) {
165 		read_okay = 1;
166 		for (i = 0; i < NUM_RTC_REGS; i++)
167 			rtc_registers[i] = rtc_readreg(sc, i);
168 		for (i = 0; i < NUM_RTC_REGS; i++)
169 			if (rtc_registers[i] != rtc_readreg(sc, i))
170 				read_okay = 0;
171 	}
172 
173 #define	rtc_to_decimal(a,b) 	(rtc_registers[a] * 10 + rtc_registers[b])
174 
175 	dt.dt_sec  = rtc_to_decimal(1, 0);
176 	dt.dt_min  = rtc_to_decimal(3, 2);
177 	dt.dt_hour = (rtc_registers[5] & RTC_REG5_HOUR) * 10 + rtc_registers[4];
178 	dt.dt_day  = rtc_to_decimal(8, 7);
179 	dt.dt_mon  = rtc_to_decimal(10, 9);
180 
181 	year = rtc_to_decimal(12, 11) + RTC_BASE_YEAR;
182 	if (year < POSIX_BASE_YEAR)
183 		year += 100;
184 	dt.dt_year = year;
185 
186 #undef	rtc_to_decimal
187 
188 	/* simple sanity checks */
189 	if (dt.dt_mon > 12 || dt.dt_day > 31 ||
190 	    dt.dt_hour >= 24 || dt.dt_min >= 60 || dt.dt_sec >= 60)
191 		return 1;
192 
193 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
194 	tv->tv_usec = 0;
195 	return 0;
196 }
197 
198 static int
199 rtc_settime(todr_chip_handle_t handle, volatile struct timeval *tv)
200 {
201 	struct rtc_softc *sc = (struct rtc_softc *)handle->cookie;
202 	int i, year;
203 	struct clock_ymdhms dt;
204 	uint8_t rtc_registers[NUM_RTC_REGS];
205 
206 	/* Note: we ignore `tv_usec' */
207 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
208 
209 	year = dt.dt_year - RTC_BASE_YEAR;
210 	if (year > 99)
211 		year -= 100;
212 
213 #define	decimal_to_rtc(a,b,n)		\
214 	rtc_registers[a] = (n) % 10;	\
215 	rtc_registers[b] = (n) / 10;
216 
217 	decimal_to_rtc(0, 1, dt.dt_sec);
218 	decimal_to_rtc(2, 3, dt.dt_min);
219 	decimal_to_rtc(7, 8, dt.dt_day);
220 	decimal_to_rtc(9, 10, dt.dt_mon);
221 	decimal_to_rtc(11, 12, year);
222 
223 	rtc_registers[4] = dt.dt_hour % 10;
224 	rtc_registers[5] = ((dt.dt_hour / 10) & RTC_REG5_HOUR) | RTC_REG5_24HR;
225 
226 	rtc_registers[6] = 0;
227 
228 #undef	decimal_to_rtc
229 
230 	/* write rtc registers */
231 	rtc_writereg(sc, 15, 13);	/* reset prescalar */
232 	for (i = 0; i < NUM_RTC_REGS; i++)
233 		if (rtc_registers[i] !=
234 		    rtc_writereg(sc, i, rtc_registers[i]))
235 			return 1;
236 	return 0;
237 }
238 
239 static uint8_t
240 rtc_readreg(struct rtc_softc *sc, int reg)
241 {
242 	bus_space_tag_t bst = sc->sc_bst;
243 	bus_space_handle_t bsh = sc->sc_bsh;
244 	uint8_t data;
245 	int s = splvm();
246 
247 	data = reg;
248 	intio_device_writecmd(bst, bsh, RTC_SET_REG, &data, 1);
249 	intio_device_readcmd(bst, bsh, RTC_READ_REG, &data);
250 
251 	splx(s);
252 	return data;
253 }
254 
255 static uint8_t
256 rtc_writereg(struct rtc_softc *sc, int reg, uint8_t data)
257 {
258 	bus_space_tag_t bst = sc->sc_bst;
259 	bus_space_handle_t bsh = sc->sc_bsh;
260 	uint8_t tmp;
261 	int s = splvm();
262 
263 	tmp = (data << 4) | reg;
264 	intio_device_writecmd(bst, bsh, RTC_SET_REG, &tmp, 1);
265 	intio_device_writecmd(bst, bsh, RTC_WRITE_REG, NULL, 0);
266 	intio_device_readcmd(bst, bsh, RTC_READ_REG, &tmp);
267 
268 	splx(s);
269 	return tmp;
270 }
271