ds1307.c revision 1.21 1 1.21 christos /* $NetBSD: ds1307.c,v 1.21 2014/11/20 16:34:26 christos Exp $ */
2 1.1 thorpej
3 1.1 thorpej /*
4 1.1 thorpej * Copyright (c) 2003 Wasabi Systems, Inc.
5 1.1 thorpej * All rights reserved.
6 1.1 thorpej *
7 1.1 thorpej * Written by Steve C. Woodford and Jason R. Thorpe for Wasabi Systems, Inc.
8 1.1 thorpej *
9 1.1 thorpej * Redistribution and use in source and binary forms, with or without
10 1.1 thorpej * modification, are permitted provided that the following conditions
11 1.1 thorpej * are met:
12 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
13 1.1 thorpej * notice, this list of conditions and the following disclaimer.
14 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
15 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
16 1.1 thorpej * documentation and/or other materials provided with the distribution.
17 1.1 thorpej * 3. All advertising materials mentioning features or use of this software
18 1.1 thorpej * must display the following acknowledgement:
19 1.1 thorpej * This product includes software developed for the NetBSD Project by
20 1.1 thorpej * Wasabi Systems, Inc.
21 1.1 thorpej * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 1.1 thorpej * or promote products derived from this software without specific prior
23 1.1 thorpej * written permission.
24 1.1 thorpej *
25 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 1.1 thorpej * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 1.1 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 1.1 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 1.1 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 1.1 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 1.1 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 1.1 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 1.1 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 1.1 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 1.1 thorpej * POSSIBILITY OF SUCH DAMAGE.
36 1.1 thorpej */
37 1.1 thorpej
38 1.9 lukem #include <sys/cdefs.h>
39 1.21 christos __KERNEL_RCSID(0, "$NetBSD: ds1307.c,v 1.21 2014/11/20 16:34:26 christos Exp $");
40 1.9 lukem
41 1.1 thorpej #include <sys/param.h>
42 1.1 thorpej #include <sys/systm.h>
43 1.1 thorpej #include <sys/device.h>
44 1.1 thorpej #include <sys/kernel.h>
45 1.1 thorpej #include <sys/fcntl.h>
46 1.1 thorpej #include <sys/uio.h>
47 1.1 thorpej #include <sys/conf.h>
48 1.1 thorpej #include <sys/event.h>
49 1.1 thorpej
50 1.1 thorpej #include <dev/clock_subr.h>
51 1.1 thorpej
52 1.1 thorpej #include <dev/i2c/i2cvar.h>
53 1.1 thorpej #include <dev/i2c/ds1307reg.h>
54 1.19 macallan #include <dev/sysmon/sysmonvar.h>
55 1.1 thorpej
56 1.15 matt struct dsrtc_model {
57 1.15 matt uint16_t dm_model;
58 1.15 matt uint8_t dm_ch_reg;
59 1.15 matt uint8_t dm_ch_value;
60 1.15 matt uint8_t dm_rtc_start;
61 1.15 matt uint8_t dm_rtc_size;
62 1.15 matt uint8_t dm_nvram_start;
63 1.15 matt uint8_t dm_nvram_size;
64 1.15 matt uint8_t dm_flags;
65 1.15 matt #define DSRTC_FLAG_CLOCK_HOLD 1
66 1.15 matt #define DSRTC_FLAG_BCD 2
67 1.19 macallan #define DSRTC_FLAG_TEMP 4
68 1.15 matt };
69 1.15 matt
70 1.15 matt static const struct dsrtc_model dsrtc_models[] = {
71 1.15 matt {
72 1.15 matt .dm_model = 1307,
73 1.15 matt .dm_ch_reg = DSXXXX_SECONDS,
74 1.15 matt .dm_ch_value = DS1307_SECONDS_CH,
75 1.15 matt .dm_rtc_start = DS1307_RTC_START,
76 1.15 matt .dm_rtc_size = DS1307_RTC_SIZE,
77 1.15 matt .dm_nvram_start = DS1307_NVRAM_START,
78 1.15 matt .dm_nvram_size = DS1307_NVRAM_SIZE,
79 1.15 matt .dm_flags = DSRTC_FLAG_BCD | DSRTC_FLAG_CLOCK_HOLD,
80 1.15 matt }, {
81 1.15 matt .dm_model = 1339,
82 1.15 matt .dm_rtc_start = DS1339_RTC_START,
83 1.15 matt .dm_rtc_size = DS1339_RTC_SIZE,
84 1.15 matt .dm_flags = DSRTC_FLAG_BCD,
85 1.15 matt }, {
86 1.15 matt .dm_model = 1672,
87 1.15 matt .dm_rtc_start = DS1672_RTC_START,
88 1.15 matt .dm_rtc_size = DS1672_RTC_SIZE,
89 1.15 matt .dm_flags = 0,
90 1.15 matt }, {
91 1.19 macallan .dm_model = 3231,
92 1.19 macallan .dm_rtc_start = DS3232_RTC_START,
93 1.19 macallan .dm_rtc_size = DS3232_RTC_SIZE,
94 1.19 macallan /*
95 1.19 macallan * XXX
96 1.19 macallan * the DS3232 likely has the temperature sensor too but I can't
97 1.19 macallan * easily verify or test that right now
98 1.19 macallan */
99 1.19 macallan .dm_flags = DSRTC_FLAG_BCD | DSRTC_FLAG_TEMP,
100 1.19 macallan }, {
101 1.15 matt .dm_model = 3232,
102 1.15 matt .dm_rtc_start = DS3232_RTC_START,
103 1.15 matt .dm_rtc_size = DS3232_RTC_SIZE,
104 1.15 matt .dm_nvram_start = DS3232_NVRAM_START,
105 1.15 matt .dm_nvram_size = DS3232_NVRAM_SIZE,
106 1.15 matt .dm_flags = DSRTC_FLAG_BCD,
107 1.15 matt },
108 1.15 matt };
109 1.15 matt
110 1.1 thorpej struct dsrtc_softc {
111 1.11 xtraeme device_t sc_dev;
112 1.1 thorpej i2c_tag_t sc_tag;
113 1.15 matt uint8_t sc_address;
114 1.15 matt bool sc_open;
115 1.15 matt struct dsrtc_model sc_model;
116 1.1 thorpej struct todr_chip_handle sc_todr;
117 1.19 macallan struct sysmon_envsys *sc_sme;
118 1.19 macallan envsys_data_t sc_sensor;
119 1.1 thorpej };
120 1.1 thorpej
121 1.11 xtraeme static void dsrtc_attach(device_t, device_t, void *);
122 1.11 xtraeme static int dsrtc_match(device_t, cfdata_t, void *);
123 1.1 thorpej
124 1.11 xtraeme CFATTACH_DECL_NEW(dsrtc, sizeof(struct dsrtc_softc),
125 1.1 thorpej dsrtc_match, dsrtc_attach, NULL, NULL);
126 1.1 thorpej extern struct cfdriver dsrtc_cd;
127 1.1 thorpej
128 1.1 thorpej dev_type_open(dsrtc_open);
129 1.1 thorpej dev_type_close(dsrtc_close);
130 1.1 thorpej dev_type_read(dsrtc_read);
131 1.1 thorpej dev_type_write(dsrtc_write);
132 1.1 thorpej
133 1.1 thorpej const struct cdevsw dsrtc_cdevsw = {
134 1.17 dholland .d_open = dsrtc_open,
135 1.17 dholland .d_close = dsrtc_close,
136 1.17 dholland .d_read = dsrtc_read,
137 1.17 dholland .d_write = dsrtc_write,
138 1.17 dholland .d_ioctl = noioctl,
139 1.17 dholland .d_stop = nostop,
140 1.17 dholland .d_tty = notty,
141 1.17 dholland .d_poll = nopoll,
142 1.17 dholland .d_mmap = nommap,
143 1.17 dholland .d_kqfilter = nokqfilter,
144 1.18 dholland .d_discard = nodiscard,
145 1.17 dholland .d_flag = D_OTHER
146 1.1 thorpej };
147 1.1 thorpej
148 1.15 matt static int dsrtc_gettime_ymdhms(struct todr_chip_handle *, struct clock_ymdhms *);
149 1.15 matt static int dsrtc_settime_ymdhms(struct todr_chip_handle *, struct clock_ymdhms *);
150 1.15 matt static int dsrtc_clock_read_ymdhms(struct dsrtc_softc *, struct clock_ymdhms *);
151 1.15 matt static int dsrtc_clock_write_ymdhms(struct dsrtc_softc *, struct clock_ymdhms *);
152 1.15 matt
153 1.15 matt static int dsrtc_gettime_timeval(struct todr_chip_handle *, struct timeval *);
154 1.15 matt static int dsrtc_settime_timeval(struct todr_chip_handle *, struct timeval *);
155 1.15 matt static int dsrtc_clock_read_timeval(struct dsrtc_softc *, time_t *);
156 1.15 matt static int dsrtc_clock_write_timeval(struct dsrtc_softc *, time_t);
157 1.15 matt
158 1.19 macallan static int dsrtc_read_temp(struct dsrtc_softc *, uint32_t *);
159 1.19 macallan static void dsrtc_refresh(struct sysmon_envsys *, envsys_data_t *);
160 1.19 macallan
161 1.15 matt static const struct dsrtc_model *
162 1.15 matt dsrtc_model(u_int model)
163 1.15 matt {
164 1.15 matt /* no model given, assume it's a DS1307 (the first one) */
165 1.15 matt if (model == 0)
166 1.15 matt return &dsrtc_models[0];
167 1.15 matt
168 1.15 matt for (const struct dsrtc_model *dm = dsrtc_models;
169 1.15 matt dm < dsrtc_models + __arraycount(dsrtc_models); dm++) {
170 1.15 matt if (dm->dm_model == model)
171 1.15 matt return dm;
172 1.15 matt }
173 1.15 matt return NULL;
174 1.15 matt }
175 1.1 thorpej
176 1.1 thorpej static int
177 1.11 xtraeme dsrtc_match(device_t parent, cfdata_t cf, void *arg)
178 1.1 thorpej {
179 1.1 thorpej struct i2c_attach_args *ia = arg;
180 1.1 thorpej
181 1.13 phx if (ia->ia_name) {
182 1.13 phx /* direct config - check name */
183 1.13 phx if (strcmp(ia->ia_name, "dsrtc") == 0)
184 1.13 phx return 1;
185 1.13 phx } else {
186 1.13 phx /* indirect config - check typical address */
187 1.13 phx if (ia->ia_addr == DS1307_ADDR)
188 1.15 matt return dsrtc_model(cf->cf_flags & 0xffff) != NULL;
189 1.13 phx }
190 1.13 phx return 0;
191 1.1 thorpej }
192 1.1 thorpej
193 1.1 thorpej static void
194 1.11 xtraeme dsrtc_attach(device_t parent, device_t self, void *arg)
195 1.1 thorpej {
196 1.5 thorpej struct dsrtc_softc *sc = device_private(self);
197 1.1 thorpej struct i2c_attach_args *ia = arg;
198 1.15 matt const struct dsrtc_model * const dm =
199 1.15 matt dsrtc_model(device_cfdata(self)->cf_flags);
200 1.1 thorpej
201 1.15 matt aprint_naive(": Real-time Clock%s\n",
202 1.15 matt dm->dm_nvram_size > 0 ? "/NVRAM" : "");
203 1.15 matt aprint_normal(": DS%u Real-time Clock%s\n", dm->dm_model,
204 1.15 matt dm->dm_nvram_size > 0 ? "/NVRAM" : "");
205 1.1 thorpej
206 1.1 thorpej sc->sc_tag = ia->ia_tag;
207 1.1 thorpej sc->sc_address = ia->ia_addr;
208 1.15 matt sc->sc_model = *dm;
209 1.11 xtraeme sc->sc_dev = self;
210 1.1 thorpej sc->sc_open = 0;
211 1.1 thorpej sc->sc_todr.cookie = sc;
212 1.15 matt if (dm->dm_flags & DSRTC_FLAG_BCD) {
213 1.15 matt sc->sc_todr.todr_gettime_ymdhms = dsrtc_gettime_ymdhms;
214 1.15 matt sc->sc_todr.todr_settime_ymdhms = dsrtc_settime_ymdhms;
215 1.15 matt } else {
216 1.15 matt sc->sc_todr.todr_gettime = dsrtc_gettime_timeval;
217 1.15 matt sc->sc_todr.todr_settime = dsrtc_settime_timeval;
218 1.15 matt }
219 1.1 thorpej sc->sc_todr.todr_setwen = NULL;
220 1.1 thorpej
221 1.1 thorpej todr_attach(&sc->sc_todr);
222 1.19 macallan if ((sc->sc_model.dm_flags & DSRTC_FLAG_TEMP) != 0) {
223 1.19 macallan int error;
224 1.19 macallan
225 1.19 macallan sc->sc_sme = sysmon_envsys_create();
226 1.19 macallan sc->sc_sme->sme_name = device_xname(self);
227 1.19 macallan sc->sc_sme->sme_cookie = sc;
228 1.19 macallan sc->sc_sme->sme_refresh = dsrtc_refresh;
229 1.19 macallan
230 1.19 macallan sc->sc_sensor.units = ENVSYS_STEMP;
231 1.19 macallan sc->sc_sensor.state = ENVSYS_SINVALID;
232 1.19 macallan sc->sc_sensor.flags = 0;
233 1.19 macallan (void)strlcpy(sc->sc_sensor.desc, "temperature",
234 1.19 macallan sizeof(sc->sc_sensor.desc));
235 1.19 macallan
236 1.19 macallan if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor)) {
237 1.19 macallan aprint_error_dev(self, "unable to attach sensor\n");
238 1.19 macallan goto bad;
239 1.19 macallan }
240 1.19 macallan
241 1.19 macallan error = sysmon_envsys_register(sc->sc_sme);
242 1.19 macallan if (error) {
243 1.19 macallan aprint_error_dev(self,
244 1.19 macallan "error %d registering with sysmon\n", error);
245 1.19 macallan goto bad;
246 1.19 macallan }
247 1.19 macallan }
248 1.19 macallan return;
249 1.19 macallan bad:
250 1.19 macallan sysmon_envsys_destroy(sc->sc_sme);
251 1.1 thorpej }
252 1.1 thorpej
253 1.1 thorpej /*ARGSUSED*/
254 1.1 thorpej int
255 1.4 abs dsrtc_open(dev_t dev, int flag, int fmt, struct lwp *l)
256 1.1 thorpej {
257 1.1 thorpej struct dsrtc_softc *sc;
258 1.1 thorpej
259 1.12 tsutsui if ((sc = device_lookup_private(&dsrtc_cd, minor(dev))) == NULL)
260 1.14 phx return ENXIO;
261 1.1 thorpej
262 1.1 thorpej /* XXX: Locking */
263 1.1 thorpej if (sc->sc_open)
264 1.14 phx return EBUSY;
265 1.1 thorpej
266 1.15 matt sc->sc_open = true;
267 1.14 phx return 0;
268 1.1 thorpej }
269 1.1 thorpej
270 1.1 thorpej /*ARGSUSED*/
271 1.1 thorpej int
272 1.4 abs dsrtc_close(dev_t dev, int flag, int fmt, struct lwp *l)
273 1.1 thorpej {
274 1.1 thorpej struct dsrtc_softc *sc;
275 1.1 thorpej
276 1.12 tsutsui if ((sc = device_lookup_private(&dsrtc_cd, minor(dev))) == NULL)
277 1.14 phx return ENXIO;
278 1.1 thorpej
279 1.15 matt sc->sc_open = false;
280 1.14 phx return 0;
281 1.1 thorpej }
282 1.1 thorpej
283 1.1 thorpej /*ARGSUSED*/
284 1.1 thorpej int
285 1.1 thorpej dsrtc_read(dev_t dev, struct uio *uio, int flags)
286 1.1 thorpej {
287 1.1 thorpej struct dsrtc_softc *sc;
288 1.15 matt int error;
289 1.1 thorpej
290 1.12 tsutsui if ((sc = device_lookup_private(&dsrtc_cd, minor(dev))) == NULL)
291 1.14 phx return ENXIO;
292 1.1 thorpej
293 1.15 matt const struct dsrtc_model * const dm = &sc->sc_model;
294 1.15 matt if (uio->uio_offset >= dm->dm_nvram_size)
295 1.14 phx return EINVAL;
296 1.1 thorpej
297 1.1 thorpej if ((error = iic_acquire_bus(sc->sc_tag, 0)) != 0)
298 1.14 phx return error;
299 1.1 thorpej
300 1.15 matt KASSERT(uio->uio_offset >= 0);
301 1.15 matt while (uio->uio_resid && uio->uio_offset < dm->dm_nvram_size) {
302 1.15 matt uint8_t ch, cmd;
303 1.15 matt const u_int a = uio->uio_offset;
304 1.15 matt cmd = a + dm->dm_nvram_start;
305 1.15 matt if ((error = iic_exec(sc->sc_tag,
306 1.15 matt uio->uio_resid > 1 ? I2C_OP_READ : I2C_OP_READ_WITH_STOP,
307 1.15 matt sc->sc_address, &cmd, 1, &ch, 1, 0)) != 0) {
308 1.1 thorpej iic_release_bus(sc->sc_tag, 0);
309 1.11 xtraeme aprint_error_dev(sc->sc_dev,
310 1.16 matt "%s: read failed at 0x%x: %d\n",
311 1.16 matt __func__, a, error);
312 1.14 phx return error;
313 1.1 thorpej }
314 1.1 thorpej if ((error = uiomove(&ch, 1, uio)) != 0) {
315 1.1 thorpej iic_release_bus(sc->sc_tag, 0);
316 1.14 phx return error;
317 1.1 thorpej }
318 1.1 thorpej }
319 1.1 thorpej
320 1.1 thorpej iic_release_bus(sc->sc_tag, 0);
321 1.1 thorpej
322 1.14 phx return 0;
323 1.1 thorpej }
324 1.1 thorpej
325 1.1 thorpej /*ARGSUSED*/
326 1.1 thorpej int
327 1.1 thorpej dsrtc_write(dev_t dev, struct uio *uio, int flags)
328 1.1 thorpej {
329 1.1 thorpej struct dsrtc_softc *sc;
330 1.15 matt int error;
331 1.1 thorpej
332 1.12 tsutsui if ((sc = device_lookup_private(&dsrtc_cd, minor(dev))) == NULL)
333 1.14 phx return ENXIO;
334 1.1 thorpej
335 1.15 matt const struct dsrtc_model * const dm = &sc->sc_model;
336 1.15 matt if (uio->uio_offset >= dm->dm_nvram_size)
337 1.14 phx return EINVAL;
338 1.1 thorpej
339 1.1 thorpej if ((error = iic_acquire_bus(sc->sc_tag, 0)) != 0)
340 1.14 phx return error;
341 1.1 thorpej
342 1.15 matt while (uio->uio_resid && uio->uio_offset < dm->dm_nvram_size) {
343 1.15 matt uint8_t cmdbuf[2];
344 1.15 matt const u_int a = (int)uio->uio_offset;
345 1.15 matt cmdbuf[0] = a + dm->dm_nvram_start;
346 1.1 thorpej if ((error = uiomove(&cmdbuf[1], 1, uio)) != 0)
347 1.1 thorpej break;
348 1.1 thorpej
349 1.1 thorpej if ((error = iic_exec(sc->sc_tag,
350 1.1 thorpej uio->uio_resid ? I2C_OP_WRITE : I2C_OP_WRITE_WITH_STOP,
351 1.1 thorpej sc->sc_address, cmdbuf, 1, &cmdbuf[1], 1, 0)) != 0) {
352 1.11 xtraeme aprint_error_dev(sc->sc_dev,
353 1.16 matt "%s: write failed at 0x%x: %d\n",
354 1.16 matt __func__, a, error);
355 1.1 thorpej break;
356 1.1 thorpej }
357 1.1 thorpej }
358 1.1 thorpej
359 1.1 thorpej iic_release_bus(sc->sc_tag, 0);
360 1.1 thorpej
361 1.14 phx return error;
362 1.1 thorpej }
363 1.1 thorpej
364 1.1 thorpej static int
365 1.15 matt dsrtc_gettime_ymdhms(struct todr_chip_handle *ch, struct clock_ymdhms *dt)
366 1.1 thorpej {
367 1.1 thorpej struct dsrtc_softc *sc = ch->cookie;
368 1.7 gdamore struct clock_ymdhms check;
369 1.1 thorpej int retries;
370 1.1 thorpej
371 1.7 gdamore memset(dt, 0, sizeof(*dt));
372 1.1 thorpej memset(&check, 0, sizeof(check));
373 1.1 thorpej
374 1.1 thorpej /*
375 1.1 thorpej * Since we don't support Burst Read, we have to read the clock twice
376 1.1 thorpej * until we get two consecutive identical results.
377 1.1 thorpej */
378 1.1 thorpej retries = 5;
379 1.1 thorpej do {
380 1.15 matt dsrtc_clock_read_ymdhms(sc, dt);
381 1.15 matt dsrtc_clock_read_ymdhms(sc, &check);
382 1.7 gdamore } while (memcmp(dt, &check, sizeof(check)) != 0 && --retries);
383 1.1 thorpej
384 1.14 phx return 0;
385 1.1 thorpej }
386 1.1 thorpej
387 1.1 thorpej static int
388 1.15 matt dsrtc_settime_ymdhms(struct todr_chip_handle *ch, struct clock_ymdhms *dt)
389 1.1 thorpej {
390 1.1 thorpej struct dsrtc_softc *sc = ch->cookie;
391 1.1 thorpej
392 1.15 matt if (dsrtc_clock_write_ymdhms(sc, dt) == 0)
393 1.14 phx return -1;
394 1.1 thorpej
395 1.14 phx return 0;
396 1.1 thorpej }
397 1.1 thorpej
398 1.1 thorpej static int
399 1.15 matt dsrtc_clock_read_ymdhms(struct dsrtc_softc *sc, struct clock_ymdhms *dt)
400 1.1 thorpej {
401 1.15 matt struct dsrtc_model * const dm = &sc->sc_model;
402 1.15 matt uint8_t bcd[DSXXXX_RTC_SIZE], cmdbuf[1];
403 1.16 matt int error;
404 1.15 matt
405 1.15 matt KASSERT(DSXXXX_RTC_SIZE >= dm->dm_rtc_size);
406 1.1 thorpej
407 1.16 matt if ((error = iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) != 0) {
408 1.11 xtraeme aprint_error_dev(sc->sc_dev,
409 1.16 matt "%s: failed to acquire I2C bus: %d\n",
410 1.16 matt __func__, error);
411 1.14 phx return 0;
412 1.1 thorpej }
413 1.1 thorpej
414 1.1 thorpej /* Read each RTC register in order. */
415 1.16 matt for (u_int i = 0; !error && i < dm->dm_rtc_size; i++) {
416 1.15 matt cmdbuf[0] = dm->dm_rtc_start + i;
417 1.1 thorpej
418 1.16 matt error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
419 1.16 matt sc->sc_address, cmdbuf, 1, &bcd[i], 1, I2C_F_POLL);
420 1.1 thorpej }
421 1.1 thorpej
422 1.1 thorpej /* Done with I2C */
423 1.1 thorpej iic_release_bus(sc->sc_tag, I2C_F_POLL);
424 1.1 thorpej
425 1.16 matt if (error != 0) {
426 1.16 matt aprint_error_dev(sc->sc_dev,
427 1.16 matt "%s: failed to read rtc at 0x%x: %d\n",
428 1.16 matt __func__, cmdbuf[0], error);
429 1.16 matt return 0;
430 1.16 matt }
431 1.16 matt
432 1.1 thorpej /*
433 1.15 matt * Convert the RTC's register values into something useable
434 1.1 thorpej */
435 1.21 christos dt->dt_sec = bcdtobin(bcd[DSXXXX_SECONDS] & DSXXXX_SECONDS_MASK);
436 1.21 christos dt->dt_min = bcdtobin(bcd[DSXXXX_MINUTES] & DSXXXX_MINUTES_MASK);
437 1.1 thorpej
438 1.15 matt if ((bcd[DSXXXX_HOURS] & DSXXXX_HOURS_12HRS_MODE) != 0) {
439 1.21 christos dt->dt_hour = bcdtobin(bcd[DSXXXX_HOURS] &
440 1.15 matt DSXXXX_HOURS_12MASK) % 12; /* 12AM -> 0, 12PM -> 12 */
441 1.15 matt if (bcd[DSXXXX_HOURS] & DSXXXX_HOURS_12HRS_PM)
442 1.1 thorpej dt->dt_hour += 12;
443 1.14 phx } else
444 1.21 christos dt->dt_hour = bcdtobin(bcd[DSXXXX_HOURS] &
445 1.15 matt DSXXXX_HOURS_24MASK);
446 1.1 thorpej
447 1.21 christos dt->dt_day = bcdtobin(bcd[DSXXXX_DATE] & DSXXXX_DATE_MASK);
448 1.21 christos dt->dt_mon = bcdtobin(bcd[DSXXXX_MONTH] & DSXXXX_MONTH_MASK);
449 1.1 thorpej
450 1.1 thorpej /* XXX: Should be an MD way to specify EPOCH used by BIOS/Firmware */
451 1.21 christos dt->dt_year = bcdtobin(bcd[DSXXXX_YEAR]) + POSIX_BASE_YEAR;
452 1.15 matt if (bcd[DSXXXX_MONTH] & DSXXXX_MONTH_CENTURY)
453 1.15 matt dt->dt_year += 100;
454 1.1 thorpej
455 1.14 phx return 1;
456 1.1 thorpej }
457 1.1 thorpej
458 1.1 thorpej static int
459 1.15 matt dsrtc_clock_write_ymdhms(struct dsrtc_softc *sc, struct clock_ymdhms *dt)
460 1.1 thorpej {
461 1.15 matt struct dsrtc_model * const dm = &sc->sc_model;
462 1.15 matt uint8_t bcd[DSXXXX_RTC_SIZE], cmdbuf[2];
463 1.16 matt int error;
464 1.15 matt
465 1.15 matt KASSERT(DSXXXX_RTC_SIZE >= dm->dm_rtc_size);
466 1.1 thorpej
467 1.1 thorpej /*
468 1.15 matt * Convert our time representation into something the DSXXXX
469 1.1 thorpej * can understand.
470 1.1 thorpej */
471 1.21 christos bcd[DSXXXX_SECONDS] = bintobcd(dt->dt_sec);
472 1.21 christos bcd[DSXXXX_MINUTES] = bintobcd(dt->dt_min);
473 1.21 christos bcd[DSXXXX_HOURS] = bintobcd(dt->dt_hour); /* DSXXXX_HOURS_12HRS_MODE=0 */
474 1.21 christos bcd[DSXXXX_DATE] = bintobcd(dt->dt_day);
475 1.21 christos bcd[DSXXXX_DAY] = bintobcd(dt->dt_wday);
476 1.21 christos bcd[DSXXXX_MONTH] = bintobcd(dt->dt_mon);
477 1.21 christos bcd[DSXXXX_YEAR] = bintobcd((dt->dt_year - POSIX_BASE_YEAR) % 100);
478 1.15 matt if (dt->dt_year - POSIX_BASE_YEAR >= 100)
479 1.15 matt bcd[DSXXXX_MONTH] |= DSXXXX_MONTH_CENTURY;
480 1.1 thorpej
481 1.16 matt if ((error = iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) != 0) {
482 1.11 xtraeme aprint_error_dev(sc->sc_dev,
483 1.16 matt "%s: failed to acquire I2C bus: %d\n",
484 1.16 matt __func__, error);
485 1.14 phx return 0;
486 1.1 thorpej }
487 1.1 thorpej
488 1.1 thorpej /* Stop the clock */
489 1.15 matt cmdbuf[0] = dm->dm_ch_reg;
490 1.15 matt
491 1.16 matt if ((error = iic_exec(sc->sc_tag, I2C_OP_READ, sc->sc_address,
492 1.16 matt cmdbuf, 1, &cmdbuf[1], 1, I2C_F_POLL)) != 0) {
493 1.15 matt iic_release_bus(sc->sc_tag, I2C_F_POLL);
494 1.15 matt aprint_error_dev(sc->sc_dev,
495 1.16 matt "%s: failed to read Hold Clock: %d\n",
496 1.16 matt __func__, error);
497 1.15 matt return 0;
498 1.15 matt }
499 1.15 matt
500 1.15 matt cmdbuf[1] |= dm->dm_ch_value;
501 1.1 thorpej
502 1.16 matt if ((error = iic_exec(sc->sc_tag, I2C_OP_WRITE, sc->sc_address,
503 1.16 matt cmdbuf, 1, &cmdbuf[1], 1, I2C_F_POLL)) != 0) {
504 1.1 thorpej iic_release_bus(sc->sc_tag, I2C_F_POLL);
505 1.11 xtraeme aprint_error_dev(sc->sc_dev,
506 1.16 matt "%s: failed to write Hold Clock: %d\n",
507 1.16 matt __func__, error);
508 1.14 phx return 0;
509 1.1 thorpej }
510 1.1 thorpej
511 1.1 thorpej /*
512 1.1 thorpej * Write registers in reverse order. The last write (to the Seconds
513 1.1 thorpej * register) will undo the Clock Hold, above.
514 1.1 thorpej */
515 1.15 matt uint8_t op = I2C_OP_WRITE;
516 1.15 matt for (signed int i = dm->dm_rtc_size - 1; i >= 0; i--) {
517 1.15 matt cmdbuf[0] = dm->dm_rtc_start + i;
518 1.15 matt if (dm->dm_rtc_start + i == dm->dm_ch_reg) {
519 1.15 matt op = I2C_OP_WRITE_WITH_STOP;
520 1.15 matt }
521 1.16 matt if ((error = iic_exec(sc->sc_tag, op, sc->sc_address,
522 1.16 matt cmdbuf, 1, &bcd[i], 1, I2C_F_POLL)) != 0) {
523 1.1 thorpej iic_release_bus(sc->sc_tag, I2C_F_POLL);
524 1.11 xtraeme aprint_error_dev(sc->sc_dev,
525 1.16 matt "%s: failed to write rtc at 0x%x: %d\n",
526 1.16 matt __func__, i, error);
527 1.1 thorpej /* XXX: Clock Hold is likely still asserted! */
528 1.14 phx return 0;
529 1.1 thorpej }
530 1.1 thorpej }
531 1.15 matt /*
532 1.15 matt * If the clock hold register isn't the same register as seconds,
533 1.15 matt * we need to reeanble the clock.
534 1.15 matt */
535 1.15 matt if (op != I2C_OP_WRITE_WITH_STOP) {
536 1.15 matt cmdbuf[0] = dm->dm_ch_reg;
537 1.15 matt cmdbuf[1] &= ~dm->dm_ch_value;
538 1.15 matt
539 1.16 matt if ((error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
540 1.16 matt sc->sc_address, cmdbuf, 1, &cmdbuf[1], 1,
541 1.16 matt I2C_F_POLL)) != 0) {
542 1.15 matt iic_release_bus(sc->sc_tag, I2C_F_POLL);
543 1.15 matt aprint_error_dev(sc->sc_dev,
544 1.16 matt "%s: failed to Hold Clock: %d\n",
545 1.16 matt __func__, error);
546 1.15 matt return 0;
547 1.15 matt }
548 1.15 matt }
549 1.1 thorpej
550 1.1 thorpej iic_release_bus(sc->sc_tag, I2C_F_POLL);
551 1.1 thorpej
552 1.14 phx return 1;
553 1.1 thorpej }
554 1.15 matt
555 1.15 matt static int
556 1.15 matt dsrtc_gettime_timeval(struct todr_chip_handle *ch, struct timeval *tv)
557 1.15 matt {
558 1.15 matt struct dsrtc_softc *sc = ch->cookie;
559 1.15 matt struct timeval check;
560 1.15 matt int retries;
561 1.15 matt
562 1.15 matt memset(tv, 0, sizeof(*tv));
563 1.15 matt memset(&check, 0, sizeof(check));
564 1.15 matt
565 1.15 matt /*
566 1.15 matt * Since we don't support Burst Read, we have to read the clock twice
567 1.15 matt * until we get two consecutive identical results.
568 1.15 matt */
569 1.15 matt retries = 5;
570 1.15 matt do {
571 1.15 matt dsrtc_clock_read_timeval(sc, &tv->tv_sec);
572 1.15 matt dsrtc_clock_read_timeval(sc, &check.tv_sec);
573 1.15 matt } while (memcmp(tv, &check, sizeof(check)) != 0 && --retries);
574 1.15 matt
575 1.15 matt return 0;
576 1.15 matt }
577 1.15 matt
578 1.15 matt static int
579 1.15 matt dsrtc_settime_timeval(struct todr_chip_handle *ch, struct timeval *tv)
580 1.15 matt {
581 1.15 matt struct dsrtc_softc *sc = ch->cookie;
582 1.15 matt
583 1.15 matt if (dsrtc_clock_write_timeval(sc, tv->tv_sec) == 0)
584 1.15 matt return -1;
585 1.15 matt
586 1.15 matt return 0;
587 1.15 matt }
588 1.15 matt
589 1.15 matt /*
590 1.15 matt * The RTC probably has a nice Clock Burst Read/Write command, but we can't use
591 1.15 matt * it, since some I2C controllers don't support anything other than single-byte
592 1.15 matt * transfers.
593 1.15 matt */
594 1.15 matt static int
595 1.15 matt dsrtc_clock_read_timeval(struct dsrtc_softc *sc, time_t *tp)
596 1.15 matt {
597 1.15 matt const struct dsrtc_model * const dm = &sc->sc_model;
598 1.15 matt uint8_t buf[4];
599 1.16 matt int error;
600 1.15 matt
601 1.16 matt if ((error = iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) != 0) {
602 1.16 matt aprint_error_dev(sc->sc_dev,
603 1.16 matt "%s: failed to acquire I2C bus: %d\n",
604 1.16 matt __func__, error);
605 1.16 matt return 0;
606 1.15 matt }
607 1.15 matt
608 1.15 matt /* read all registers: */
609 1.15 matt uint8_t reg = dm->dm_rtc_start;
610 1.16 matt error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_address,
611 1.16 matt ®, 1, buf, 4, I2C_F_POLL);
612 1.15 matt
613 1.15 matt /* Done with I2C */
614 1.15 matt iic_release_bus(sc->sc_tag, I2C_F_POLL);
615 1.15 matt
616 1.16 matt if (error != 0) {
617 1.16 matt aprint_error_dev(sc->sc_dev,
618 1.16 matt "%s: failed to read rtc at 0x%x: %d\n",
619 1.16 matt __func__, reg, error);
620 1.16 matt return 0;
621 1.16 matt }
622 1.16 matt
623 1.15 matt uint32_t v = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
624 1.15 matt *tp = v;
625 1.15 matt
626 1.15 matt aprint_debug_dev(sc->sc_dev, "%s: cntr=0x%08"PRIx32"\n",
627 1.15 matt __func__, v);
628 1.15 matt
629 1.16 matt return 1;
630 1.15 matt }
631 1.15 matt
632 1.15 matt static int
633 1.15 matt dsrtc_clock_write_timeval(struct dsrtc_softc *sc, time_t t)
634 1.15 matt {
635 1.15 matt const struct dsrtc_model * const dm = &sc->sc_model;
636 1.15 matt size_t buflen = dm->dm_rtc_size + 2;
637 1.15 matt uint8_t buf[buflen];
638 1.16 matt int error;
639 1.15 matt
640 1.15 matt KASSERT((dm->dm_flags & DSRTC_FLAG_CLOCK_HOLD) == 0);
641 1.15 matt KASSERT(dm->dm_ch_reg == dm->dm_rtc_start + 4);
642 1.15 matt
643 1.15 matt buf[0] = dm->dm_rtc_start;
644 1.15 matt buf[1] = (t >> 0) & 0xff;
645 1.15 matt buf[2] = (t >> 8) & 0xff;
646 1.15 matt buf[3] = (t >> 16) & 0xff;
647 1.15 matt buf[4] = (t >> 24) & 0xff;
648 1.15 matt buf[5] = 0;
649 1.15 matt
650 1.16 matt if ((error = iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) != 0) {
651 1.16 matt aprint_error_dev(sc->sc_dev,
652 1.16 matt "%s: failed to acquire I2C bus: %d\n",
653 1.16 matt __func__, error);
654 1.16 matt return 0;
655 1.15 matt }
656 1.15 matt
657 1.16 matt error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_address,
658 1.16 matt &buf, buflen, NULL, 0, I2C_F_POLL);
659 1.16 matt
660 1.16 matt /* Done with I2C */
661 1.16 matt iic_release_bus(sc->sc_tag, I2C_F_POLL);
662 1.16 matt
663 1.15 matt /* send data */
664 1.16 matt if (error != 0) {
665 1.16 matt aprint_error_dev(sc->sc_dev,
666 1.16 matt "%s: failed to set time: %d\n",
667 1.16 matt __func__, error);
668 1.16 matt return 0;
669 1.15 matt }
670 1.15 matt
671 1.16 matt return 1;
672 1.15 matt }
673 1.19 macallan
674 1.19 macallan static int
675 1.19 macallan dsrtc_read_temp(struct dsrtc_softc *sc, uint32_t *temp)
676 1.19 macallan {
677 1.19 macallan int error, tc;
678 1.19 macallan uint8_t reg = DS3232_TEMP_MSB;
679 1.19 macallan uint8_t buf[2];
680 1.19 macallan
681 1.19 macallan if ((sc->sc_model.dm_flags & DSRTC_FLAG_TEMP) == 0)
682 1.19 macallan return ENOTSUP;
683 1.19 macallan
684 1.19 macallan if ((error = iic_acquire_bus(sc->sc_tag, I2C_F_POLL)) != 0) {
685 1.19 macallan aprint_error_dev(sc->sc_dev,
686 1.19 macallan "%s: failed to acquire I2C bus: %d\n",
687 1.19 macallan __func__, error);
688 1.19 macallan return 0;
689 1.19 macallan }
690 1.19 macallan
691 1.19 macallan /* read temperature registers: */
692 1.19 macallan error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_address,
693 1.19 macallan ®, 1, buf, 2, I2C_F_POLL);
694 1.19 macallan
695 1.19 macallan /* Done with I2C */
696 1.19 macallan iic_release_bus(sc->sc_tag, I2C_F_POLL);
697 1.19 macallan
698 1.19 macallan if (error != 0) {
699 1.19 macallan aprint_error_dev(sc->sc_dev,
700 1.19 macallan "%s: failed to read temperature: %d\n",
701 1.19 macallan __func__, error);
702 1.19 macallan return 0;
703 1.19 macallan }
704 1.19 macallan
705 1.19 macallan /* convert to microkelvin */
706 1.19 macallan tc = buf[0] * 1000000 + (buf[1] >> 6) * 250000;
707 1.19 macallan *temp = tc + 273150000;
708 1.19 macallan return 1;
709 1.19 macallan }
710 1.19 macallan
711 1.19 macallan static void
712 1.19 macallan dsrtc_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
713 1.19 macallan {
714 1.19 macallan struct dsrtc_softc *sc = sme->sme_cookie;
715 1.20 martin uint32_t temp = 0; /* XXX gcc */
716 1.19 macallan
717 1.19 macallan if (dsrtc_read_temp(sc, &temp) == 0) {
718 1.19 macallan edata->state = ENVSYS_SINVALID;
719 1.19 macallan return;
720 1.19 macallan }
721 1.19 macallan
722 1.19 macallan edata->value_cur = temp;
723 1.19 macallan
724 1.19 macallan edata->state = ENVSYS_SVALID;
725 1.19 macallan }
726