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