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.7 2004/05/19 22:52:43 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 void 129 pcfclock_identify(driver_t *driver, device_t parent) 130 { 131 132 BUS_ADD_CHILD(parent, 0, PCFCLOCK_NAME, 0); 133 } 134 135 static int 136 pcfclock_probe(device_t dev) 137 { 138 struct pcfclock_data *sc; 139 140 device_set_desc(dev, "PCF-1.0"); 141 142 sc = DEVTOSOFTC(dev); 143 bzero(sc, sizeof(struct pcfclock_data)); 144 145 return (0); 146 } 147 148 static int 149 pcfclock_attach(device_t dev) 150 { 151 int unit; 152 153 unit = device_get_unit(dev); 154 155 cdevsw_add(&pcfclock_cdevsw, -1, unit); 156 make_dev(&pcfclock_cdevsw, unit, 157 UID_ROOT, GID_WHEEL, 0444, PCFCLOCK_NAME "%d", unit); 158 159 return (0); 160 } 161 162 static int 163 pcfclock_open(dev_t dev, int flag, int fms, struct thread *td) 164 { 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); 169 int res; 170 171 if (!sc) 172 return (ENXIO); 173 174 if ((res = ppb_request_bus(ppbus, pcfclockdev, 175 (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT))) 176 return (res); 177 178 sc->count++; 179 180 return (0); 181 } 182 183 static int 184 pcfclock_close(dev_t dev, int flags, int fmt, struct thread *td) 185 { 186 u_int unit = minor(dev); 187 struct pcfclock_data *sc = UNITOSOFTC(unit); 188 device_t pcfclockdev = UNITODEVICE(unit); 189 device_t ppbus = device_get_parent(pcfclockdev); 190 191 sc->count--; 192 if (sc->count == 0) { 193 ppb_release_bus(ppbus, pcfclockdev); 194 } 195 196 return (0); 197 } 198 199 static void 200 pcfclock_write_cmd(dev_t dev, unsigned char command) 201 { 202 u_int unit = minor(dev); 203 device_t ppidev = UNITODEVICE(unit); 204 device_t ppbus = device_get_parent(ppidev); 205 unsigned char ctr = 14; 206 char i; 207 208 for (i = 0; i <= 7; i++) { 209 ppb_wdtr(ppbus, i); 210 AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO); 211 DELAY(3000); 212 } 213 ppb_wdtr(ppbus, command); 214 AUTOFEED_CLOCK(AFC_LO); 215 DELAY(3000); 216 AUTOFEED_CLOCK(AFC_HI); 217 } 218 219 static void 220 pcfclock_display_data(dev_t dev, char buf[18]) 221 { 222 u_int unit = minor(dev); 223 #ifdef PCFCLOCK_VERBOSE 224 int year; 225 226 year = NR(buf, 14); 227 if (year < 70) 228 year += 100; 229 printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, " 230 "battery status: %s\n", 231 unit, 232 NR(buf, 10), NR(buf, 12), 1900 + year, 233 NR(buf, 6), NR(buf, 4), NR(buf, 2), 234 PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok"); 235 #else 236 if (PCFCLOCK_BATTERY_STATUS_LOW(buf)) 237 printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n", 238 unit); 239 #endif 240 } 241 242 static int 243 pcfclock_read_data(dev_t dev, char *buf, ssize_t bits) 244 { 245 u_int unit = minor(dev); 246 device_t ppidev = UNITODEVICE(unit); 247 device_t ppbus = device_get_parent(ppidev); 248 int i; 249 char waitfor; 250 int offset; 251 252 /* one byte per four bits */ 253 bzero(buf, ((bits + 3) >> 2) + 1); 254 255 waitfor = 100; 256 for (i = 0; i <= bits; i++) { 257 /* wait for clock, maximum (waitfor*100) usec */ 258 while(!CLOCK_OK && --waitfor > 0) 259 DELAY(100); 260 261 /* timed out? */ 262 if (!waitfor) 263 return (EIO); 264 265 waitfor = 100; /* reload */ 266 267 /* give it some time */ 268 DELAY(500); 269 270 /* calculate offset into buffer */ 271 offset = i >> 2; 272 buf[offset] <<= 1; 273 274 if (BIT_SET) 275 buf[offset] |= 1; 276 } 277 278 return (0); 279 } 280 281 static int 282 pcfclock_read_dev(dev_t dev, char *buf, int maxretries) 283 { 284 u_int unit = minor(dev); 285 device_t ppidev = UNITODEVICE(unit); 286 device_t ppbus = device_get_parent(ppidev); 287 int error = 0; 288 289 ppb_set_mode(ppbus, PPB_COMPATIBLE); 290 291 while (--maxretries > 0) { 292 pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME); 293 if (pcfclock_read_data(dev, buf, 68)) 294 continue; 295 296 if (!PCFCLOCK_CORRECT_SYNC(buf)) 297 continue; 298 299 if (!PCFCLOCK_CORRECT_FORMAT(buf)) 300 continue; 301 302 break; 303 } 304 305 if (!maxretries) 306 error = EIO; 307 308 return (error); 309 } 310 311 static ssize_t 312 pcfclock_read(dev_t dev, struct uio *uio, int ioflag) 313 { 314 u_int unit = minor(dev); 315 char buf[18]; 316 int error = 0; 317 318 if (uio->uio_resid < 18) 319 return (ERANGE); 320 321 error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES); 322 323 if (error) { 324 printf(PCFCLOCK_NAME "%d: no PCF found\n", unit); 325 } else { 326 pcfclock_display_data(dev, buf); 327 328 uiomove(buf, 18, uio); 329 } 330 331 return (error); 332 } 333 334 static device_method_t pcfclock_methods[] = { 335 /* device interface */ 336 DEVMETHOD(device_identify, pcfclock_identify), 337 DEVMETHOD(device_probe, pcfclock_probe), 338 DEVMETHOD(device_attach, pcfclock_attach), 339 340 { 0, 0 } 341 }; 342 343 static driver_t pcfclock_driver = { 344 PCFCLOCK_NAME, 345 pcfclock_methods, 346 sizeof(struct pcfclock_data), 347 }; 348 349 DRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0); 350