2 * Copyright (c) 2000 Sascha Schumann. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY SASCHA SCHUMANN ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
15 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
16 * EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
19 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
20 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
22 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 * $FreeBSD: src/sys/dev/ppbus/pcfclock.c,v 1.3.2.1 2000/05/24 00:20:57 n_hibma Exp $
25 * $DragonFly: src/sys/dev/misc/pcfclock/pcfclock.c,v 1.5 2003/08/07 21:16:57 dillon Exp $
29 #include "opt_pcfclock.h"
31 #include <sys/param.h>
32 #include <sys/systm.h>
34 #include <sys/sockio.h>
36 #include <sys/kernel.h>
38 #include <sys/fcntl.h>
41 #include <machine/bus.h>
42 #include <machine/resource.h>
43 #include <machine/clock.h> /* for DELAY */
45 #include <bus/ppbus/ppbconf.h>
46 #include <bus/ppbus/ppb_msq.h>
47 #include <bus/ppbus/ppbio.h>
51 #define PCFCLOCK_NAME "pcfclock"
53 struct pcfclock_data {
55 struct ppb_device pcfclock_dev;
58 #define DEVTOSOFTC(dev) \
59 ((struct pcfclock_data *)device_get_softc(dev))
60 #define UNITOSOFTC(unit) \
61 ((struct pcfclock_data *)devclass_get_softc(pcfclock_devclass, (unit)))
62 #define UNITODEVICE(unit) \
63 (devclass_get_device(pcfclock_devclass, (unit)))
65 static devclass_t pcfclock_devclass;
67 static d_open_t pcfclock_open;
68 static d_close_t pcfclock_close;
69 static d_read_t pcfclock_read;
71 #define CDEV_MAJOR 140
72 static struct cdevsw pcfclock_cdevsw = {
73 /* name */ PCFCLOCK_NAME,
79 /* open */ pcfclock_open,
80 /* close */ pcfclock_close,
81 /* read */ pcfclock_read,
86 /* strategy */ nostrategy,
91 #ifndef PCFCLOCK_MAX_RETRIES
92 #define PCFCLOCK_MAX_RETRIES 10
96 #define AFC_LO AUTOFEED
98 /* AUTO FEED is used as clock */
99 #define AUTOFEED_CLOCK(val) \
100 ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr)
102 /* SLCT is used as clock */
104 ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0))
106 /* PE is used as data */
107 #define BIT_SET (ppb_rstr(ppbus)&PERROR)
109 /* the first byte sent as reply must be 00001001b */
110 #define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9)
112 #define NR(buf, off) (buf[off+1]*10+buf[off])
114 /* check for correct input values */
115 #define PCFCLOCK_CORRECT_FORMAT(buf) (\
116 NR(buf, 14) <= 99 && \
117 NR(buf, 12) <= 12 && \
118 NR(buf, 10) <= 31 && \
119 NR(buf, 6) <= 23 && \
120 NR(buf, 4) <= 59 && \
123 #define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4)
125 #define PCFCLOCK_CMD_TIME 0 /* send current time */
126 #define PCFCLOCK_CMD_COPY 7 /* copy received signal to PC */
129 pcfclock_identify(driver_t *driver, device_t parent)
132 BUS_ADD_CHILD(parent, 0, PCFCLOCK_NAME, 0);
136 pcfclock_probe(device_t dev)
138 struct pcfclock_data *sc;
140 device_set_desc(dev, "PCF-1.0");
142 sc = DEVTOSOFTC(dev);
143 bzero(sc, sizeof(struct pcfclock_data));
149 pcfclock_attach(device_t dev)
153 unit = device_get_unit(dev);
155 make_dev(&pcfclock_cdevsw, unit,
156 UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit);
162 pcfclock_open(dev_t dev, int flag, int fms, struct thread *td)
164 u_int unit = minor(dev);
165 struct pcfclock_data *sc = UNITOSOFTC(unit);
166 device_t pcfclockdev = UNITODEVICE(unit);
167 device_t ppbus = device_get_parent(pcfclockdev);
173 if ((res = ppb_request_bus(ppbus, pcfclockdev,
174 (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT)))
183 pcfclock_close(dev_t dev, int flags, int fmt, struct thread *td)
185 u_int unit = minor(dev);
186 struct pcfclock_data *sc = UNITOSOFTC(unit);
187 device_t pcfclockdev = UNITODEVICE(unit);
188 device_t ppbus = device_get_parent(pcfclockdev);
191 if (sc->count == 0) {
192 ppb_release_bus(ppbus, pcfclockdev);
199 pcfclock_write_cmd(dev_t dev, unsigned char command)
201 u_int unit = minor(dev);
202 device_t ppidev = UNITODEVICE(unit);
203 device_t ppbus = device_get_parent(ppidev);
204 unsigned char ctr = 14;
207 for (i = 0; i <= 7; i++) {
209 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO);
212 ppb_wdtr(ppbus, command);
213 AUTOFEED_CLOCK(AFC_LO);
215 AUTOFEED_CLOCK(AFC_HI);
219 pcfclock_display_data(dev_t dev, char buf[18])
221 u_int unit = minor(dev);
222 #ifdef PCFCLOCK_VERBOSE
228 printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, "
229 "battery status: %s\n",
231 NR(buf, 10), NR(buf, 12), 1900 + year,
232 NR(buf, 6), NR(buf, 4), NR(buf, 2),
233 PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok");
235 if (PCFCLOCK_BATTERY_STATUS_LOW(buf))
236 printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n",
242 pcfclock_read_data(dev_t dev, char *buf, ssize_t bits)
244 u_int unit = minor(dev);
245 device_t ppidev = UNITODEVICE(unit);
246 device_t ppbus = device_get_parent(ppidev);
251 /* one byte per four bits */
252 bzero(buf, ((bits + 3) >> 2) + 1);
255 for (i = 0; i <= bits; i++) {
256 /* wait for clock, maximum (waitfor*100) usec */
257 while(!CLOCK_OK && --waitfor > 0)
264 waitfor = 100; /* reload */
266 /* give it some time */
269 /* calculate offset into buffer */
281 pcfclock_read_dev(dev_t dev, char *buf, int maxretries)
283 u_int unit = minor(dev);
284 device_t ppidev = UNITODEVICE(unit);
285 device_t ppbus = device_get_parent(ppidev);
288 ppb_set_mode(ppbus, PPB_COMPATIBLE);
290 while (--maxretries > 0) {
291 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME);
292 if (pcfclock_read_data(dev, buf, 68))
295 if (!PCFCLOCK_CORRECT_SYNC(buf))
298 if (!PCFCLOCK_CORRECT_FORMAT(buf))
311 pcfclock_read(dev_t dev, struct uio *uio, int ioflag)
313 u_int unit = minor(dev);
317 if (uio->uio_resid < 18)
320 error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES);
323 printf(PCFCLOCK_NAME "%d: no PCF found\n", unit);
325 pcfclock_display_data(dev, buf);
327 uiomove(buf, 18, uio);
333 static device_method_t pcfclock_methods[] = {
334 /* device interface */
335 DEVMETHOD(device_identify, pcfclock_identify),
336 DEVMETHOD(device_probe, pcfclock_probe),
337 DEVMETHOD(device_attach, pcfclock_attach),
342 static driver_t pcfclock_driver = {
345 sizeof(struct pcfclock_data),
348 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0);