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>
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>
42 #include <machine/clock.h> /* for DELAY */
44 #include <dev/ppbus/ppbconf.h>
45 #include <dev/ppbus/ppb_msq.h>
46 #include <dev/ppbus/ppbio.h>
50 #define PCFCLOCK_NAME "pcfclock"
52 struct pcfclock_data {
54 struct ppb_device pcfclock_dev;
57 #define DEVTOSOFTC(dev) \
58 ((struct pcfclock_data *)device_get_softc(dev))
59 #define UNITOSOFTC(unit) \
60 ((struct pcfclock_data *)devclass_get_softc(pcfclock_devclass, (unit)))
61 #define UNITODEVICE(unit) \
62 (devclass_get_device(pcfclock_devclass, (unit)))
64 static devclass_t pcfclock_devclass;
66 static d_open_t pcfclock_open;
67 static d_close_t pcfclock_close;
68 static d_read_t pcfclock_read;
70 #define CDEV_MAJOR 140
71 static struct cdevsw pcfclock_cdevsw = {
72 /* open */ pcfclock_open,
73 /* close */ pcfclock_close,
74 /* read */ pcfclock_read,
79 /* strategy */ nostrategy,
80 /* name */ PCFCLOCK_NAME,
88 #ifndef PCFCLOCK_MAX_RETRIES
89 #define PCFCLOCK_MAX_RETRIES 10
93 #define AFC_LO AUTOFEED
95 /* AUTO FEED is used as clock */
96 #define AUTOFEED_CLOCK(val) \
97 ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr)
99 /* SLCT is used as clock */
101 ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0))
103 /* PE is used as data */
104 #define BIT_SET (ppb_rstr(ppbus)&PERROR)
106 /* the first byte sent as reply must be 00001001b */
107 #define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9)
109 #define NR(buf, off) (buf[off+1]*10+buf[off])
111 /* check for correct input values */
112 #define PCFCLOCK_CORRECT_FORMAT(buf) (\
113 NR(buf, 14) <= 99 && \
114 NR(buf, 12) <= 12 && \
115 NR(buf, 10) <= 31 && \
116 NR(buf, 6) <= 23 && \
117 NR(buf, 4) <= 59 && \
120 #define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4)
122 #define PCFCLOCK_CMD_TIME 0 /* send current time */
123 #define PCFCLOCK_CMD_COPY 7 /* copy received signal to PC */
126 pcfclock_identify(driver_t *driver, device_t parent)
129 BUS_ADD_CHILD(parent, 0, PCFCLOCK_NAME, 0);
133 pcfclock_probe(device_t dev)
135 struct pcfclock_data *sc;
137 device_set_desc(dev, "PCF-1.0");
139 sc = DEVTOSOFTC(dev);
140 bzero(sc, sizeof(struct pcfclock_data));
146 pcfclock_attach(device_t dev)
150 unit = device_get_unit(dev);
152 make_dev(&pcfclock_cdevsw, unit,
153 UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit);
159 pcfclock_open(dev_t dev, int flag, int fms, struct proc *p)
161 u_int unit = minor(dev);
162 struct pcfclock_data *sc = UNITOSOFTC(unit);
163 device_t pcfclockdev = UNITODEVICE(unit);
164 device_t ppbus = device_get_parent(pcfclockdev);
170 if ((res = ppb_request_bus(ppbus, pcfclockdev,
171 (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT)))
180 pcfclock_close(dev_t dev, int flags, int fmt, struct proc *p)
182 u_int unit = minor(dev);
183 struct pcfclock_data *sc = UNITOSOFTC(unit);
184 device_t pcfclockdev = UNITODEVICE(unit);
185 device_t ppbus = device_get_parent(pcfclockdev);
188 if (sc->count == 0) {
189 ppb_release_bus(ppbus, pcfclockdev);
196 pcfclock_write_cmd(dev_t dev, unsigned char command)
198 u_int unit = minor(dev);
199 device_t ppidev = UNITODEVICE(unit);
200 device_t ppbus = device_get_parent(ppidev);
201 unsigned char ctr = 14;
204 for (i = 0; i <= 7; i++) {
206 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO);
209 ppb_wdtr(ppbus, command);
210 AUTOFEED_CLOCK(AFC_LO);
212 AUTOFEED_CLOCK(AFC_HI);
216 pcfclock_display_data(dev_t dev, char buf[18])
218 u_int unit = minor(dev);
219 #ifdef PCFCLOCK_VERBOSE
225 printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, "
226 "battery status: %s\n",
228 NR(buf, 10), NR(buf, 12), 1900 + year,
229 NR(buf, 6), NR(buf, 4), NR(buf, 2),
230 PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok");
232 if (PCFCLOCK_BATTERY_STATUS_LOW(buf))
233 printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n",
239 pcfclock_read_data(dev_t dev, char *buf, ssize_t bits)
241 u_int unit = minor(dev);
242 device_t ppidev = UNITODEVICE(unit);
243 device_t ppbus = device_get_parent(ppidev);
248 /* one byte per four bits */
249 bzero(buf, ((bits + 3) >> 2) + 1);
252 for (i = 0; i <= bits; i++) {
253 /* wait for clock, maximum (waitfor*100) usec */
254 while(!CLOCK_OK && --waitfor > 0)
261 waitfor = 100; /* reload */
263 /* give it some time */
266 /* calculate offset into buffer */
278 pcfclock_read_dev(dev_t dev, char *buf, int maxretries)
280 u_int unit = minor(dev);
281 device_t ppidev = UNITODEVICE(unit);
282 device_t ppbus = device_get_parent(ppidev);
285 ppb_set_mode(ppbus, PPB_COMPATIBLE);
287 while (--maxretries > 0) {
288 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME);
289 if (pcfclock_read_data(dev, buf, 68))
292 if (!PCFCLOCK_CORRECT_SYNC(buf))
295 if (!PCFCLOCK_CORRECT_FORMAT(buf))
308 pcfclock_read(dev_t dev, struct uio *uio, int ioflag)
310 u_int unit = minor(dev);
314 if (uio->uio_resid < 18)
317 error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES);
320 printf(PCFCLOCK_NAME "%d: no PCF found\n", unit);
322 pcfclock_display_data(dev, buf);
324 uiomove(buf, 18, uio);
330 static device_method_t pcfclock_methods[] = {
331 /* device interface */
332 DEVMETHOD(device_identify, pcfclock_identify),
333 DEVMETHOD(device_probe, pcfclock_probe),
334 DEVMETHOD(device_attach, pcfclock_attach),
339 static driver_t pcfclock_driver = {
342 sizeof(struct pcfclock_data),
345 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0);