xref: /netbsd-src/sys/dev/i2c/rs5c372.c (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1 /*	$NetBSD: rs5c372.c,v 1.6 2006/09/04 23:45:30 gdamore Exp $	*/
2 
3 /*
4  * Copyright (c) 2005 Kimihiro Nonaka
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  *
16  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/device.h>
32 #include <sys/kernel.h>
33 #include <sys/fcntl.h>
34 #include <sys/uio.h>
35 #include <sys/conf.h>
36 #include <sys/event.h>
37 
38 #include <dev/clock_subr.h>
39 
40 #include <dev/i2c/i2cvar.h>
41 #include <dev/i2c/rs5c372reg.h>
42 
43 struct rs5c372rtc_softc {
44 	struct device sc_dev;
45 	i2c_tag_t sc_tag;
46 	int sc_address;
47 	struct todr_chip_handle sc_todr;
48 };
49 
50 static int rs5c372rtc_match(struct device *, struct cfdata *, void *);
51 static void rs5c372rtc_attach(struct device *, struct device *, void *);
52 
53 CFATTACH_DECL(rs5c372rtc, sizeof(struct rs5c372rtc_softc),
54     rs5c372rtc_match, rs5c372rtc_attach, NULL, NULL);
55 
56 static void rs5c372rtc_reg_write(struct rs5c372rtc_softc *, int, uint8_t);
57 static int rs5c372rtc_clock_read(struct rs5c372rtc_softc *, struct clock_ymdhms *);
58 static int rs5c372rtc_clock_write(struct rs5c372rtc_softc *, struct clock_ymdhms *);
59 static int rs5c372rtc_gettime(struct todr_chip_handle *, volatile struct timeval *);
60 static int rs5c372rtc_settime(struct todr_chip_handle *, volatile struct timeval *);
61 
62 static int
63 rs5c372rtc_match(struct device *parent, struct cfdata *cf, void *arg)
64 {
65 	struct i2c_attach_args *ia = arg;
66 
67 	if (ia->ia_addr == RS5C372_ADDR)
68 		return (1);
69 	return (0);
70 }
71 
72 static void
73 rs5c372rtc_attach(struct device *parent, struct device *self, void *arg)
74 {
75 	struct rs5c372rtc_softc *sc = device_private(self);
76 	struct i2c_attach_args *ia = arg;
77 
78 	aprint_naive(": Real-time Clock\n");
79 	aprint_normal(": RICOH RS5C372[AB] Real-time Clock\n");
80 
81 	sc->sc_tag = ia->ia_tag;
82 	sc->sc_address = ia->ia_addr;
83 	sc->sc_todr.cookie = sc;
84 	sc->sc_todr.todr_gettime = rs5c372rtc_gettime;
85 	sc->sc_todr.todr_settime = rs5c372rtc_settime;
86 	sc->sc_todr.todr_setwen = NULL;
87 
88 	todr_attach(&sc->sc_todr);
89 
90 	/* Initialize RTC */
91 	rs5c372rtc_reg_write(sc, RS5C372_CONTROL2, RS5C372_CONTROL2_24HRS);
92 	rs5c372rtc_reg_write(sc, RS5C372_CONTROL1, 0);
93 }
94 
95 static int
96 rs5c372rtc_gettime(struct todr_chip_handle *ch, volatile struct timeval *tv)
97 {
98 	struct rs5c372rtc_softc *sc = ch->cookie;
99 	struct clock_ymdhms dt;
100 
101 	memset(&dt, 0, sizeof(dt));
102 
103 	if (rs5c372rtc_clock_read(sc, &dt) == 0)
104 		return (-1);
105 
106 	tv->tv_sec = clock_ymdhms_to_secs(&dt);
107 	tv->tv_usec = 0;
108 
109 	return (0);
110 }
111 
112 static int
113 rs5c372rtc_settime(struct todr_chip_handle *ch, volatile struct timeval *tv)
114 {
115 	struct rs5c372rtc_softc *sc = ch->cookie;
116 	struct clock_ymdhms dt;
117 
118 	clock_secs_to_ymdhms(tv->tv_sec, &dt);
119 
120 	if (rs5c372rtc_clock_write(sc, &dt) == 0)
121 		return (-1);
122 
123 	return (0);
124 }
125 
126 static void
127 rs5c372rtc_reg_write(struct rs5c372rtc_softc *sc, int reg, uint8_t val)
128 {
129 	uint8_t cmdbuf[2];
130 
131 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
132 		printf("%s: rs5c372rtc_reg_write: failed to acquire I2C bus\n",
133 		    sc->sc_dev.dv_xname);
134 		return;
135 	}
136 
137 	reg &= 0xf;
138 	cmdbuf[0] = (reg << 4);
139 	cmdbuf[1] = val;
140 	if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
141 	             cmdbuf, 1, &cmdbuf[1], 1, I2C_F_POLL)) {
142 		iic_release_bus(sc->sc_tag, I2C_F_POLL);
143 		printf("%s: rs5c372rtc_reg_write: failed to write reg%d\n",
144 		    sc->sc_dev.dv_xname, reg);
145 		return;
146 	}
147 
148 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
149 }
150 
151 static int
152 rs5c372rtc_clock_read(struct rs5c372rtc_softc *sc, struct clock_ymdhms *dt)
153 {
154 	uint8_t bcd[RS5C372_NRTC_REGS];
155 	uint8_t cmdbuf[1];
156 
157 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
158 		printf("%s: rs5c372rtc_clock_read: failed to acquire I2C bus\n",
159 		    sc->sc_dev.dv_xname);
160 		return (0);
161 	}
162 
163 	cmdbuf[0] = (RS5C372_SECONDS << 4);
164 	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_address,
165 	             cmdbuf, 1, bcd, RS5C372_NRTC_REGS, I2C_F_POLL)) {
166 		iic_release_bus(sc->sc_tag, I2C_F_POLL);
167 		printf("%s: rs5c372rtc_clock_read: failed to read rtc\n",
168 		    sc->sc_dev.dv_xname);
169 		return (0);
170 	}
171 
172 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
173 
174 	/*
175 	 * Convert the RS5C372's register values into something useable
176 	 */
177 	dt->dt_sec = FROMBCD(bcd[RS5C372_SECONDS] & RS5C372_SECONDS_MASK);
178 	dt->dt_min = FROMBCD(bcd[RS5C372_MINUTES] & RS5C372_MINUTES_MASK);
179 	dt->dt_hour = FROMBCD(bcd[RS5C372_HOURS] & RS5C372_HOURS_24MASK);
180 	dt->dt_day = FROMBCD(bcd[RS5C372_DATE] & RS5C372_DATE_MASK);
181 	dt->dt_mon = FROMBCD(bcd[RS5C372_MONTH] & RS5C372_MONTH_MASK);
182 	dt->dt_year = FROMBCD(bcd[RS5C372_YEAR]) + 2000;
183 
184 	return (1);
185 }
186 
187 static int
188 rs5c372rtc_clock_write(struct rs5c372rtc_softc *sc, struct clock_ymdhms *dt)
189 {
190 	uint8_t bcd[RS5C372_NRTC_REGS];
191 	uint8_t cmdbuf[1];
192 
193 	/*
194 	 * Convert our time representation into something the RS5C372
195 	 * can understand.
196 	 */
197 	bcd[RS5C372_SECONDS] = TOBCD(dt->dt_sec);
198 	bcd[RS5C372_MINUTES] = TOBCD(dt->dt_min);
199 	bcd[RS5C372_HOURS] = TOBCD(dt->dt_hour);
200 	bcd[RS5C372_DATE] = TOBCD(dt->dt_day);
201 	bcd[RS5C372_DAY] = TOBCD(dt->dt_wday);
202 	bcd[RS5C372_MONTH] = TOBCD(dt->dt_mon);
203 	bcd[RS5C372_YEAR] = TOBCD(dt->dt_year % 100);
204 
205 	if (iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) {
206 		printf("%s: rs5c372rtc_clock_write: failed to "
207 		    "acquire I2C bus\n", sc->sc_dev.dv_xname);
208 		return (0);
209 	}
210 
211 	cmdbuf[0] = (RS5C372_SECONDS << 4);
212 	if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
213 	             cmdbuf, 1, bcd, RS5C372_NRTC_REGS, I2C_F_POLL)) {
214 		iic_release_bus(sc->sc_tag, I2C_F_POLL);
215 		printf("%s: rs5c372rtc_clock_write: failed to write rtc\n",
216 		    sc->sc_dev.dv_xname);
217 		return (0);
218 	}
219 
220 	iic_release_bus(sc->sc_tag, I2C_F_POLL);
221 
222 	return (1);
223 }
224