sys/dev/misc/pcfclock/pcfclock.c

   1 /*
   2  * Copyright (c) 2000 Sascha Schumann. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   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.
  12  *
  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.
  23  *
  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.8 2005/10/28 03:25:48 dillon Exp $
  26  *
  27  */
  28
  29 #include "opt_pcfclock.h"
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/bus.h>
  34 #include <sys/sockio.h>
  35 #include <sys/mbuf.h>
  36 #include <sys/kernel.h>
  37 #include <sys/conf.h>
  38 #include <sys/fcntl.h>
  39 #include <sys/uio.h>
  40
  41 #include <machine/bus.h>
  42 #include <machine/resource.h>
  43 #include <machine/clock.h>      /* for DELAY */
  44
  45 #include <bus/ppbus/ppbconf.h>
  46 #include <bus/ppbus/ppb_msq.h>
  47 #include <bus/ppbus/ppbio.h>
  48
  49 #include "ppbus_if.h"
  50
  51 #define PCFCLOCK_NAME "pcfclock"
  52
  53 struct pcfclock_data {
  54         int     count;
  55         struct  ppb_device pcfclock_dev;
  56 };
  57
  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)))
  64
  65 static devclass_t pcfclock_devclass;
  66
  67 static  d_open_t                pcfclock_open;
  68 static  d_close_t               pcfclock_close;
  69 static  d_read_t                pcfclock_read;
  70
  71 #define CDEV_MAJOR 140
  72 static struct cdevsw pcfclock_cdevsw = {
  73         /* name */      PCFCLOCK_NAME,
  74         /* maj */       CDEV_MAJOR,
  75         /* flags */     0,
  76         /* port */      NULL,
  77         /* clone */     NULL,
  78
  79         /* open */      pcfclock_open,
  80         /* close */     pcfclock_close,
  81         /* read */      pcfclock_read,
  82         /* write */     nowrite,
  83         /* ioctl */     noioctl,
  84         /* poll */      nopoll,
  85         /* mmap */      nommap,
  86         /* strategy */  nostrategy,
  87         /* dump */      nodump,
  88         /* psize */     nopsize
  89 };
  90
  91 #ifndef PCFCLOCK_MAX_RETRIES
  92 #define PCFCLOCK_MAX_RETRIES 10
  93 #endif
  94
  95 #define AFC_HI 0
  96 #define AFC_LO AUTOFEED
  97
  98 /* AUTO FEED is used as clock */
  99 #define AUTOFEED_CLOCK(val) \
 100         ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr)
 101
 102 /* SLCT is used as clock */
 103 #define CLOCK_OK \
 104         ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0))
 105
 106 /* PE is used as data */
 107 #define BIT_SET (ppb_rstr(ppbus)&PERROR)
 108
 109 /* the first byte sent as reply must be 00001001b */
 110 #define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9)
 111
 112 #define NR(buf, off) (buf[off+1]*10+buf[off])
 113
 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 && \
 121         NR(buf,  2) <= 59)
 122
 123 #define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4)
 124
 125 #define PCFCLOCK_CMD_TIME 0             /* send current time */
 126 #define PCFCLOCK_CMD_COPY 7     /* copy received signal to PC */
 127
 128 static int
 129 pcfclock_probe(device_t dev)
 130 {
 131         struct pcfclock_data *sc;
 132
 133         device_set_desc(dev, "PCF-1.0");
 134
 135         sc = DEVTOSOFTC(dev);
 136         bzero(sc, sizeof(struct pcfclock_data));
 137
 138         return (0);
 139 }
 140
 141 static int
 142 pcfclock_attach(device_t dev)
 143 {
 144         int unit;
 145
 146         unit = device_get_unit(dev);
 147
 148         cdevsw_add(&pcfclock_cdevsw, -1, unit);
 149         make_dev(&pcfclock_cdevsw, unit,
 150                         UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit);
 151
 152         return (0);
 153 }
 154
 155 static int
 156 pcfclock_open(dev_t dev, int flag, int fms, struct thread *td)
 157 {
 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);
 162         int res;
 163
 164         if (!sc)
 165                 return (ENXIO);
 166
 167         if ((res = ppb_request_bus(ppbus, pcfclockdev,
 168                 (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT)))
 169                 return (res);
 170
 171         sc->count++;
 172
 173         return (0);
 174 }
 175
 176 static int
 177 pcfclock_close(dev_t dev, int flags, int fmt, struct thread *td)
 178 {
 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);
 183
 184         sc->count--;
 185         if (sc->count == 0) {
 186                 ppb_release_bus(ppbus, pcfclockdev);
 187         }
 188
 189         return (0);
 190 }
 191
 192 static void
 193 pcfclock_write_cmd(dev_t dev, unsigned char command)
 194 {
 195         u_int unit = minor(dev);
 196         device_t ppidev = UNITODEVICE(unit);
 197         device_t ppbus = device_get_parent(ppidev);
 198         unsigned char ctr = 14;
 199         char i;
 200
 201         for (i = 0; i <= 7; i++) {
 202                 ppb_wdtr(ppbus, i);
 203                 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO);
 204                 DELAY(3000);
 205         }
 206         ppb_wdtr(ppbus, command);
 207         AUTOFEED_CLOCK(AFC_LO);
 208         DELAY(3000);
 209         AUTOFEED_CLOCK(AFC_HI);
 210 }
 211
 212 static void
 213 pcfclock_display_data(dev_t dev, char buf[18])
 214 {
 215         u_int unit = minor(dev);
 216 #ifdef PCFCLOCK_VERBOSE
 217         int year;
 218
 219         year = NR(buf, 14);
 220         if (year < 70)
 221                 year += 100;
 222         printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, "
 223                         "battery status: %s\n",
 224                         unit,
 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");
 228 #else
 229         if (PCFCLOCK_BATTERY_STATUS_LOW(buf))
 230                 printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n",
 231                                 unit);
 232 #endif
 233 }
 234
 235 static int
 236 pcfclock_read_data(dev_t dev, char *buf, ssize_t bits)
 237 {
 238         u_int unit = minor(dev);
 239         device_t ppidev = UNITODEVICE(unit);
 240         device_t ppbus = device_get_parent(ppidev);
 241         int i;
 242         char waitfor;
 243         int offset;
 244
 245         /* one byte per four bits */
 246         bzero(buf, ((bits + 3) >> 2) + 1);
 247
 248         waitfor = 100;
 249         for (i = 0; i <= bits; i++) {
 250                 /* wait for clock, maximum (waitfor*100) usec */
 251                 while(!CLOCK_OK && --waitfor > 0)
 252                         DELAY(100);
 253
 254                 /* timed out? */
 255                 if (!waitfor)
 256                         return (EIO);
 257
 258                 waitfor = 100; /* reload */
 259
 260                 /* give it some time */
 261                 DELAY(500);
 262
 263                 /* calculate offset into buffer */
 264                 offset = i >> 2;
 265                 buf[offset] <<= 1;
 266
 267                 if (BIT_SET)
 268                         buf[offset] |= 1;
 269         }
 270
 271         return (0);
 272 }
 273
 274 static int
 275 pcfclock_read_dev(dev_t dev, char *buf, int maxretries)
 276 {
 277         u_int unit = minor(dev);
 278         device_t ppidev = UNITODEVICE(unit);
 279         device_t ppbus = device_get_parent(ppidev);
 280         int error = 0;
 281
 282         ppb_set_mode(ppbus, PPB_COMPATIBLE);
 283
 284         while (--maxretries > 0) {
 285                 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME);
 286                 if (pcfclock_read_data(dev, buf, 68))
 287                         continue;
 288
 289                 if (!PCFCLOCK_CORRECT_SYNC(buf))
 290                         continue;
 291
 292                 if (!PCFCLOCK_CORRECT_FORMAT(buf))
 293                         continue;
 294
 295                 break;
 296         }
 297
 298         if (!maxretries)
 299                 error = EIO;
 300
 301         return (error);
 302 }
 303
 304 static ssize_t
 305 pcfclock_read(dev_t dev, struct uio *uio, int ioflag)
 306 {
 307         u_int unit = minor(dev);
 308         char buf[18];
 309         int error = 0;
 310
 311         if (uio->uio_resid < 18)
 312                 return (ERANGE);
 313
 314         error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES);
 315
 316         if (error) {
 317                 printf(PCFCLOCK_NAME "%d: no PCF found\n", unit);
 318         } else {
 319                 pcfclock_display_data(dev, buf);
 320
 321                 uiomove(buf, 18, uio);
 322         }
 323
 324         return (error);
 325 }
 326
 327 /*
 328  * Because pcfclock is a static device that always exists under any
 329  * attached ppbus, and not scanned by the ppbus, we need an identify function
 330  * to create the device.
 331  */
 332 static device_method_t pcfclock_methods[] = {
 333         /* device interface */
 334         DEVMETHOD(device_identify,      bus_generic_identify),
 335         DEVMETHOD(device_probe,         pcfclock_probe),
 336         DEVMETHOD(device_attach,        pcfclock_attach),
 337
 338         { 0, 0 }
 339 };
 340
 341 static driver_t pcfclock_driver = {
 342         PCFCLOCK_NAME,
 343         pcfclock_methods,
 344         sizeof(struct pcfclock_data),
 345 };
 346
 347 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0);
 348