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 AUTHOR 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.
28 #include "opt_pcfclock.h"
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/sockio.h>
35 #include <sys/kernel.h>
37 #include <sys/fcntl.h>
40 #include <machine/bus.h>
41 #include <machine/resource.h>
43 #include <dev/ppbus/ppbconf.h>
44 #include <dev/ppbus/ppb_msq.h>
45 #include <dev/ppbus/ppbio.h>
49 #define PCFCLOCK_NAME "pcfclock"
51 struct pcfclock_data {
55 #define DEVTOSOFTC(dev) \
56 ((struct pcfclock_data *)device_get_softc(dev))
57 #define UNITOSOFTC(unit) \
58 ((struct pcfclock_data *)devclass_get_softc(pcfclock_devclass, (unit)))
59 #define UNITODEVICE(unit) \
60 (devclass_get_device(pcfclock_devclass, (unit)))
62 static devclass_t pcfclock_devclass;
64 static d_open_t pcfclock_open;
65 static d_close_t pcfclock_close;
66 static d_read_t pcfclock_read;
68 #define CDEV_MAJOR 140
69 static struct cdevsw pcfclock_cdevsw = {
70 /* open */ pcfclock_open,
71 /* close */ pcfclock_close,
72 /* read */ pcfclock_read,
77 /* strategy */ nostrategy,
78 /* name */ PCFCLOCK_NAME,
85 #ifndef PCFCLOCK_MAX_RETRIES
86 #define PCFCLOCK_MAX_RETRIES 10
90 #define AFC_LO AUTOFEED
92 /* AUTO FEED is used as clock */
93 #define AUTOFEED_CLOCK(val) \
94 ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr)
96 /* SLCT is used as clock */
98 ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0))
100 /* PE is used as data */
101 #define BIT_SET (ppb_rstr(ppbus)&PERROR)
103 /* the first byte sent as reply must be 00001001b */
104 #define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9)
106 #define NR(buf, off) (buf[off+1]*10+buf[off])
108 /* check for correct input values */
109 #define PCFCLOCK_CORRECT_FORMAT(buf) (\
110 NR(buf, 14) <= 99 && \
111 NR(buf, 12) <= 12 && \
112 NR(buf, 10) <= 31 && \
113 NR(buf, 6) <= 23 && \
114 NR(buf, 4) <= 59 && \
117 #define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4)
119 #define PCFCLOCK_CMD_TIME 0 /* send current time */
120 #define PCFCLOCK_CMD_COPY 7 /* copy received signal to PC */
123 pcfclock_identify(driver_t *driver, device_t parent)
126 BUS_ADD_CHILD(parent, 0, PCFCLOCK_NAME, -1);
130 pcfclock_probe(device_t dev)
132 struct pcfclock_data *sc;
134 device_set_desc(dev, "PCF-1.0");
136 sc = DEVTOSOFTC(dev);
137 bzero(sc, sizeof(struct pcfclock_data));
143 pcfclock_attach(device_t dev)
147 unit = device_get_unit(dev);
149 make_dev(&pcfclock_cdevsw, unit,
150 UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit);
156 pcfclock_open(dev_t dev, int flag, int fms, struct thread *td)
158 u_int unit = minor(dev);
159 struct pcfclock_data *sc = UNITOSOFTC(unit);
160 device_t pcfclockdev = UNITODEVICE(unit);
161 device_t ppbus = device_get_parent(pcfclockdev);
167 if ((res = ppb_request_bus(ppbus, pcfclockdev,
168 (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT)))
177 pcfclock_close(dev_t dev, int flags, int fmt, struct thread *td)
179 u_int unit = minor(dev);
180 struct pcfclock_data *sc = UNITOSOFTC(unit);
181 device_t pcfclockdev = UNITODEVICE(unit);
182 device_t ppbus = device_get_parent(pcfclockdev);
186 ppb_release_bus(ppbus, pcfclockdev);
192 pcfclock_write_cmd(dev_t dev, unsigned char command)
194 u_int unit = minor(dev);
195 device_t ppidev = UNITODEVICE(unit);
196 device_t ppbus = device_get_parent(ppidev);
197 unsigned char ctr = 14;
200 for (i = 0; i <= 7; i++) {
202 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO);
205 ppb_wdtr(ppbus, command);
206 AUTOFEED_CLOCK(AFC_LO);
208 AUTOFEED_CLOCK(AFC_HI);
212 pcfclock_display_data(dev_t dev, char buf[18])
214 u_int unit = minor(dev);
215 #ifdef PCFCLOCK_VERBOSE
222 printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, "
223 "battery status: %s\n",
225 NR(buf, 10), NR(buf, 12), 1900 + year,
226 NR(buf, 6), NR(buf, 4), NR(buf, 2),
227 PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok");
229 if (PCFCLOCK_BATTERY_STATUS_LOW(buf))
230 printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n",
236 pcfclock_read_data(dev_t dev, char *buf, ssize_t bits)
238 u_int unit = minor(dev);
239 device_t ppidev = UNITODEVICE(unit);
240 device_t ppbus = device_get_parent(ppidev);
245 /* one byte per four bits */
246 bzero(buf, ((bits + 3) >> 2) + 1);
249 for (i = 0; i <= bits; i++) {
250 /* wait for clock, maximum (waitfor*100) usec */
251 while(!CLOCK_OK && --waitfor > 0)
258 waitfor = 100; /* reload */
260 /* give it some time */
263 /* calculate offset into buffer */
275 pcfclock_read_dev(dev_t dev, char *buf, int maxretries)
277 u_int unit = minor(dev);
278 device_t ppidev = UNITODEVICE(unit);
279 device_t ppbus = device_get_parent(ppidev);
282 ppb_set_mode(ppbus, PPB_COMPATIBLE);
284 while (--maxretries > 0) {
285 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME);
286 if (pcfclock_read_data(dev, buf, 68))
289 if (!PCFCLOCK_CORRECT_SYNC(buf))
292 if (!PCFCLOCK_CORRECT_FORMAT(buf))
305 pcfclock_read(dev_t dev, struct uio *uio, int ioflag)
307 u_int unit = minor(dev);
311 if (uio->uio_resid < 18)
314 error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES);
317 printf(PCFCLOCK_NAME "%d: no PCF found\n", unit);
319 pcfclock_display_data(dev, buf);
321 uiomove(buf, 18, uio);
327 static device_method_t pcfclock_methods[] = {
328 /* device interface */
329 DEVMETHOD(device_identify, pcfclock_identify),
330 DEVMETHOD(device_probe, pcfclock_probe),
331 DEVMETHOD(device_attach, pcfclock_attach),
336 static driver_t pcfclock_driver = {
339 sizeof(struct pcfclock_data),
342 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0);