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 $
28 #include "opt_pcfclock.h"
30 #include <sys/param.h>
31 #include <sys/systm.h>
34 #include <sys/device.h>
35 #include <sys/sockio.h>
37 #include <sys/kernel.h>
38 #include <sys/fcntl.h>
41 #include <machine/clock.h> /* for DELAY */
43 #include <bus/ppbus/ppbconf.h>
44 #include <bus/ppbus/ppb_msq.h>
45 #include <bus/ppbus/ppbio.h>
49 #define PCFCLOCK_NAME "pcfclock"
51 struct pcfclock_data {
53 struct ppb_device pcfclock_dev;
56 #define DEVTOSOFTC(dev) \
57 ((struct pcfclock_data *)device_get_softc(dev))
58 #define UNITOSOFTC(unit) \
59 ((struct pcfclock_data *)devclass_get_softc(pcfclock_devclass, (unit)))
60 #define UNITODEVICE(unit) \
61 (devclass_get_device(pcfclock_devclass, (unit)))
63 static devclass_t pcfclock_devclass;
65 static d_open_t pcfclock_open;
66 static d_close_t pcfclock_close;
67 static d_read_t pcfclock_read;
69 static struct dev_ops pcfclock_ops = {
70 { PCFCLOCK_NAME, 0, 0 },
71 .d_open = pcfclock_open,
72 .d_close = pcfclock_close,
73 .d_read = pcfclock_read,
76 #ifndef PCFCLOCK_MAX_RETRIES
77 #define PCFCLOCK_MAX_RETRIES 10
81 #define AFC_LO AUTOFEED
83 /* AUTO FEED is used as clock */
84 #define AUTOFEED_CLOCK(val) \
85 ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr)
87 /* SLCT is used as clock */
89 ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0))
91 /* PE is used as data */
92 #define BIT_SET (ppb_rstr(ppbus)&PERROR)
94 /* the first byte sent as reply must be 00001001b */
95 #define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9)
97 #define NR(buf, off) (buf[off+1]*10+buf[off])
99 /* check for correct input values */
100 #define PCFCLOCK_CORRECT_FORMAT(buf) (\
101 NR(buf, 14) <= 99 && \
102 NR(buf, 12) <= 12 && \
103 NR(buf, 10) <= 31 && \
104 NR(buf, 6) <= 23 && \
105 NR(buf, 4) <= 59 && \
108 #define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4)
110 #define PCFCLOCK_CMD_TIME 0 /* send current time */
111 #define PCFCLOCK_CMD_COPY 7 /* copy received signal to PC */
114 pcfclock_probe(device_t dev)
116 struct pcfclock_data *sc;
118 device_set_desc(dev, "PCF-1.0");
120 sc = DEVTOSOFTC(dev);
121 bzero(sc, sizeof(struct pcfclock_data));
127 pcfclock_attach(device_t dev)
131 unit = device_get_unit(dev);
133 make_dev(&pcfclock_ops, unit,
134 UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit);
140 pcfclock_open(struct dev_open_args *ap)
142 cdev_t dev = ap->a_head.a_dev;
143 u_int unit = minor(dev);
144 struct pcfclock_data *sc = UNITOSOFTC(unit);
145 device_t pcfclockdev = UNITODEVICE(unit);
146 device_t ppbus = device_get_parent(pcfclockdev);
152 if ((res = ppb_request_bus(ppbus, pcfclockdev,
153 (ap->a_oflags & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT)))
162 pcfclock_close(struct dev_close_args *ap)
164 cdev_t dev = ap->a_head.a_dev;
165 u_int unit = minor(dev);
166 struct pcfclock_data *sc = UNITOSOFTC(unit);
167 device_t pcfclockdev = UNITODEVICE(unit);
168 device_t ppbus = device_get_parent(pcfclockdev);
171 if (sc->count == 0) {
172 ppb_release_bus(ppbus, pcfclockdev);
179 pcfclock_write_cmd(cdev_t dev, unsigned char command)
181 u_int unit = minor(dev);
182 device_t ppidev = UNITODEVICE(unit);
183 device_t ppbus = device_get_parent(ppidev);
184 unsigned char ctr = 14;
187 for (i = 0; i <= 7; i++) {
189 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO);
192 ppb_wdtr(ppbus, command);
193 AUTOFEED_CLOCK(AFC_LO);
195 AUTOFEED_CLOCK(AFC_HI);
199 pcfclock_display_data(cdev_t dev, char buf[18])
201 u_int unit = minor(dev);
202 #ifdef PCFCLOCK_VERBOSE
208 kprintf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, "
209 "battery status: %s\n",
211 NR(buf, 10), NR(buf, 12), 1900 + year,
212 NR(buf, 6), NR(buf, 4), NR(buf, 2),
213 PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok");
215 if (PCFCLOCK_BATTERY_STATUS_LOW(buf))
216 kprintf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n",
222 pcfclock_read_data(cdev_t dev, char *buf, ssize_t bits)
224 u_int unit = minor(dev);
225 device_t ppidev = UNITODEVICE(unit);
226 device_t ppbus = device_get_parent(ppidev);
231 /* one byte per four bits */
232 bzero(buf, ((bits + 3) >> 2) + 1);
235 for (i = 0; i <= bits; i++) {
236 /* wait for clock, maximum (waitfor*100) usec */
237 while(!CLOCK_OK && --waitfor > 0)
244 waitfor = 100; /* reload */
246 /* give it some time */
249 /* calculate offset into buffer */
261 pcfclock_read_dev(cdev_t dev, char *buf, int maxretries)
263 u_int unit = minor(dev);
264 device_t ppidev = UNITODEVICE(unit);
265 device_t ppbus = device_get_parent(ppidev);
268 ppb_set_mode(ppbus, PPB_COMPATIBLE);
270 while (--maxretries > 0) {
271 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME);
272 if (pcfclock_read_data(dev, buf, 68))
275 if (!PCFCLOCK_CORRECT_SYNC(buf))
278 if (!PCFCLOCK_CORRECT_FORMAT(buf))
291 pcfclock_read(struct dev_read_args *ap)
293 cdev_t dev = ap->a_head.a_dev;
294 u_int unit = minor(dev);
298 if (ap->a_uio->uio_resid < 18)
301 error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES);
304 kprintf(PCFCLOCK_NAME "%d: no PCF found\n", unit);
306 pcfclock_display_data(dev, buf);
308 uiomove(buf, 18, ap->a_uio);
315 * Because pcfclock is a static device that always exists under any
316 * attached ppbus, and not scanned by the ppbus, we need an identify function
317 * to create the device.
319 static device_method_t pcfclock_methods[] = {
320 /* device interface */
321 DEVMETHOD(device_identify, bus_generic_identify),
322 DEVMETHOD(device_probe, pcfclock_probe),
323 DEVMETHOD(device_attach, pcfclock_attach),
328 static driver_t pcfclock_driver = {
331 sizeof(struct pcfclock_data),
334 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, NULL, NULL);