xref: /netbsd-src/sys/arch/hp300/dev/rtc.c (revision d48f14661dda8638fee055ba15d35bdfb29b9fa8)
1 /*	$NetBSD: rtc.c,v 1.15 2005/12/11 12:17:14 christos 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.15 2005/12/11 12:17:14 christos 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 int	rtc_getcal(todr_chip_handle_t, int *);
112 static int	rtc_setcal(todr_chip_handle_t, int);
113 static uint8_t	rtc_readreg(struct rtc_softc *, int);
114 static uint8_t	rtc_writereg(struct rtc_softc *, int, uint8_t);
115 
116 
117 static int
118 rtcmatch(struct device *parent, struct cfdata *match, void *aux)
119 {
120 	struct intio_attach_args *ia = aux;
121 
122 	if (strcmp("rtc", ia->ia_modname) != 0)
123 		return (0);
124 
125 	return (1);
126 }
127 
128 static void
129 rtcattach(struct device *parent, struct device *self, void *aux)
130 {
131 	struct intio_attach_args *ia = aux;
132 	struct rtc_softc *sc = (struct rtc_softc *)self;
133 	struct todr_chip_handle *todr_handle;
134 	bus_space_tag_t bst = ia->ia_bst;
135 
136 	printf("\n");
137 
138 	if (bus_space_map(bst, ia->ia_iobase, INTIO_DEVSIZE, 0,
139 	    &sc->sc_bsh)) {
140 		printf("%s: can't map registers\n",
141 		    sc->sc_dev.dv_xname);
142 		return;
143 	}
144 
145 	sc->sc_bst = bst;
146 
147 	todr_handle = &sc->sc_handle;
148 	todr_handle->cookie = sc;
149 	todr_handle->todr_gettime = rtc_gettime;
150 	todr_handle->todr_settime = rtc_settime;
151 	todr_handle->todr_getcal = rtc_getcal;
152 	todr_handle->todr_setcal = rtc_setcal;
153 	todr_handle->todr_setwen = NULL;
154 
155 	todr_attach(todr_handle);
156 }
157 
158 static int
159 rtc_gettime(todr_chip_handle_t handle, volatile struct timeval *tv)
160 {
161 	struct rtc_softc *sc = (struct rtc_softc *)handle->cookie;
162 	int i, read_okay, year;
163 	struct clock_ymdhms dt;
164 	uint8_t rtc_registers[NUM_RTC_REGS];
165 
166 	/* read rtc registers */
167 	read_okay = 0;
168 	while (!read_okay) {
169 		read_okay = 1;
170 		for (i = 0; i < NUM_RTC_REGS; i++)
171 			rtc_registers[i] = rtc_readreg(sc, i);
172 		for (i = 0; i < NUM_RTC_REGS; i++)
173 			if (rtc_registers[i] != rtc_readreg(sc, i))
174 				read_okay = 0;
175 	}
176 
177 #define	rtc_to_decimal(a,b) 	(rtc_registers[a] * 10 + rtc_registers[b])
178 
179 	dt.dt_sec  = rtc_to_decimal(1, 0);
180 	dt.dt_min  = rtc_to_decimal(3, 2);
181 	dt.dt_hour = (rtc_registers[5] & RTC_REG5_HOUR) * 10 + rtc_registers[4];
182 	dt.dt_day  = rtc_to_decimal(8, 7);
183 	dt.dt_mon  = rtc_to_decimal(10, 9);
184 
185 	year = rtc_to_decimal(12, 11) + RTC_BASE_YEAR;
186 	if (year < POSIX_BASE_YEAR)
187 		year += 100;
188 	dt.dt_year = year;
189 
190 #undef	rtc_to_decimal
191 
192 	/* simple sanity checks */
193 	if (dt.dt_mon > 12 || dt.dt_day > 31 ||
194 	    dt.dt_hour >= 24 || dt.dt_min >= 60 || dt.dt_sec >= 60)
195 		return (1);
196 
197 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
198 	tv->tv_usec = 0;
199 	return (0);
200 }
201 
202 static int
203 rtc_settime(todr_chip_handle_t handle, volatile struct timeval *tv)
204 {
205 	struct rtc_softc *sc = (struct rtc_softc *)handle->cookie;
206 	int i, year;
207 	struct clock_ymdhms dt;
208 	uint8_t rtc_registers[NUM_RTC_REGS];
209 
210 	/* Note: we ignore `tv_usec' */
211 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
212 
213 	year = dt.dt_year - RTC_BASE_YEAR;
214 	if (year > 99)
215 		year -= 100;
216 
217 #define	decimal_to_rtc(a,b,n)		\
218 	rtc_registers[a] = (n) % 10;	\
219 	rtc_registers[b] = (n) / 10;
220 
221 	decimal_to_rtc(0, 1, dt.dt_sec);
222 	decimal_to_rtc(2, 3, dt.dt_min);
223 	decimal_to_rtc(7, 8, dt.dt_day);
224 	decimal_to_rtc(9, 10, dt.dt_mon);
225 	decimal_to_rtc(11, 12, year);
226 
227 	rtc_registers[4] = dt.dt_hour % 10;
228 	rtc_registers[5] = ((dt.dt_hour / 10) & RTC_REG5_HOUR) | RTC_REG5_24HR;
229 
230 	rtc_registers[6] = 0;
231 
232 #undef	decimal_to_rtc
233 
234 	/* write rtc registers */
235 	rtc_writereg(sc, 15, 13);	/* reset prescalar */
236 	for (i = 0; i < NUM_RTC_REGS; i++)
237 		if (rtc_registers[i] !=
238 		    rtc_writereg(sc, i, rtc_registers[i]))
239 			return (1);
240 	return (0);
241 }
242 
243 static int
244 rtc_getcal(todr_chip_handle_t handle, int *vp)
245 {
246 	return (EOPNOTSUPP);
247 }
248 
249 static int
250 rtc_setcal(todr_chip_handle_t handle, int v)
251 {
252 	return (EOPNOTSUPP);
253 }
254 
255 static uint8_t
256 rtc_readreg(struct rtc_softc *sc, int reg)
257 {
258 	bus_space_tag_t bst = sc->sc_bst;
259 	bus_space_handle_t bsh = sc->sc_bsh;
260 	uint8_t data;
261 	int s = splvm();
262 
263 	data = reg;
264 	intio_device_writecmd(bst, bsh, RTC_SET_REG, &data, 1);
265 	intio_device_readcmd(bst, bsh, RTC_READ_REG, &data);
266 
267 	splx(s);
268 	return (data);
269 }
270 
271 static uint8_t
272 rtc_writereg(struct rtc_softc *sc, int reg, uint8_t data)
273 {
274 	bus_space_tag_t bst = sc->sc_bst;
275 	bus_space_handle_t bsh = sc->sc_bsh;
276 	uint8_t tmp;
277 	int s = splvm();
278 
279 	tmp = (data << 4) | reg;
280 	intio_device_writecmd(bst, bsh, RTC_SET_REG, &tmp, 1);
281 	intio_device_writecmd(bst, bsh, RTC_WRITE_REG, NULL, 0);
282 	intio_device_readcmd(bst, bsh, RTC_READ_REG, &tmp);
283 
284 	splx(s);
285 	return (tmp);
286 }
287