pcfclock.c revision 126080
1214501Srpaulo/* 2214501Srpaulo * Copyright (c) 2000 Sascha Schumann. All rights reserved. 3214501Srpaulo * 4214501Srpaulo * Redistribution and use in source and binary forms, with or without 5252726Srpaulo * modification, are permitted provided that the following conditions 6252726Srpaulo * are met: 7214501Srpaulo * 1. Redistributions of source code must retain the above copyright 8214501Srpaulo * notice, this list of conditions and the following disclaimer. 9214501Srpaulo * 2. Redistributions in binary form must reproduce the above copyright 10214501Srpaulo * notice, this list of conditions and the following disclaimer in the 11214501Srpaulo * documentation and/or other materials provided with the distribution. 12214501Srpaulo * 13214501Srpaulo * THIS SOFTWARE IS PROVIDED BY SASCHA SCHUMANN ``AS IS'' AND ANY EXPRESS OR 14214501Srpaulo * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 15214501Srpaulo * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 16214501Srpaulo * EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 17214501Srpaulo * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 18214501Srpaulo * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 19214501Srpaulo * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 20214501Srpaulo * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 21252726Srpaulo * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 22252726Srpaulo * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23252726Srpaulo * 24252726Srpaulo * 25252726Srpaulo */ 26252726Srpaulo 27252726Srpaulo#include <sys/cdefs.h> 28252726Srpaulo__FBSDID("$FreeBSD: head/sys/dev/ppbus/pcfclock.c 126080 2004-02-21 21:10:55Z phk $"); 29252726Srpaulo 30252726Srpaulo#include "opt_pcfclock.h" 31252726Srpaulo 32252726Srpaulo#include <sys/param.h> 33214501Srpaulo#include <sys/systm.h> 34214501Srpaulo#include <sys/bus.h> 35214501Srpaulo#include <sys/sockio.h> 36214501Srpaulo#include <sys/mbuf.h> 37214501Srpaulo#include <sys/kernel.h> 38214501Srpaulo#include <sys/conf.h> 39214501Srpaulo#include <sys/fcntl.h> 40214501Srpaulo#include <sys/uio.h> 41214501Srpaulo 42214501Srpaulo#include <machine/bus.h> 43214501Srpaulo#include <machine/resource.h> 44214501Srpaulo 45214501Srpaulo#include <dev/ppbus/ppbconf.h> 46214501Srpaulo#include <dev/ppbus/ppb_msq.h> 47214501Srpaulo#include <dev/ppbus/ppbio.h> 48214501Srpaulo 49214501Srpaulo#include "ppbus_if.h" 50214501Srpaulo 51214501Srpaulo#define PCFCLOCK_NAME "pcfclock" 52214501Srpaulo 53214501Srpaulostruct pcfclock_data { 54252726Srpaulo int count; 55214501Srpaulo}; 56214501Srpaulo 57214501Srpaulo#define DEVTOSOFTC(dev) \ 58214501Srpaulo ((struct pcfclock_data *)device_get_softc(dev)) 59214501Srpaulo#define UNITOSOFTC(unit) \ 60214501Srpaulo ((struct pcfclock_data *)devclass_get_softc(pcfclock_devclass, (unit))) 61214501Srpaulo#define UNITODEVICE(unit) \ 62214501Srpaulo (devclass_get_device(pcfclock_devclass, (unit))) 63214501Srpaulo 64214501Srpaulostatic devclass_t pcfclock_devclass; 65214501Srpaulo 66214501Srpaulostatic d_open_t pcfclock_open; 67214501Srpaulostatic d_close_t pcfclock_close; 68214501Srpaulostatic d_read_t pcfclock_read; 69214501Srpaulo 70214501Srpaulostatic struct cdevsw pcfclock_cdevsw = { 71214501Srpaulo .d_version = D_VERSION, 72214501Srpaulo .d_flags = D_NEEDGIANT, 73214501Srpaulo .d_open = pcfclock_open, 74214501Srpaulo .d_close = pcfclock_close, 75214501Srpaulo .d_read = pcfclock_read, 76214501Srpaulo .d_name = PCFCLOCK_NAME, 77214501Srpaulo}; 78214501Srpaulo 79214501Srpaulo#ifndef PCFCLOCK_MAX_RETRIES 80214501Srpaulo#define PCFCLOCK_MAX_RETRIES 10 81214501Srpaulo#endif 82214501Srpaulo 83214501Srpaulo#define AFC_HI 0 84214501Srpaulo#define AFC_LO AUTOFEED 85214501Srpaulo 86214501Srpaulo/* AUTO FEED is used as clock */ 87214501Srpaulo#define AUTOFEED_CLOCK(val) \ 88214501Srpaulo ctr = (ctr & ~(AUTOFEED)) ^ (val); ppb_wctr(ppbus, ctr) 89214501Srpaulo 90214501Srpaulo/* SLCT is used as clock */ 91214501Srpaulo#define CLOCK_OK \ 92214501Srpaulo ((ppb_rstr(ppbus) & SELECT) == (i & 1 ? SELECT : 0)) 93214501Srpaulo 94214501Srpaulo/* PE is used as data */ 95214501Srpaulo#define BIT_SET (ppb_rstr(ppbus)&PERROR) 96214501Srpaulo 97214501Srpaulo/* the first byte sent as reply must be 00001001b */ 98214501Srpaulo#define PCFCLOCK_CORRECT_SYNC(buf) (buf[0] == 9) 99214501Srpaulo 100214501Srpaulo#define NR(buf, off) (buf[off+1]*10+buf[off]) 101214501Srpaulo 102214501Srpaulo/* check for correct input values */ 103252726Srpaulo#define PCFCLOCK_CORRECT_FORMAT(buf) (\ 104252726Srpaulo NR(buf, 14) <= 99 && \ 105252726Srpaulo NR(buf, 12) <= 12 && \ 106214501Srpaulo NR(buf, 10) <= 31 && \ 107214501Srpaulo NR(buf, 6) <= 23 && \ 108214501Srpaulo NR(buf, 4) <= 59 && \ 109214501Srpaulo NR(buf, 2) <= 59) 110214501Srpaulo 111214501Srpaulo#define PCFCLOCK_BATTERY_STATUS_LOW(buf) (buf[8] & 4) 112214501Srpaulo 113214501Srpaulo#define PCFCLOCK_CMD_TIME 0 /* send current time */ 114214501Srpaulo#define PCFCLOCK_CMD_COPY 7 /* copy received signal to PC */ 115214501Srpaulo 116214501Srpaulostatic void 117214501Srpaulopcfclock_identify(driver_t *driver, device_t parent) 118214501Srpaulo{ 119214501Srpaulo 120214501Srpaulo BUS_ADD_CHILD(parent, 0, PCFCLOCK_NAME, -1); 121214501Srpaulo} 122214501Srpaulo 123214501Srpaulostatic int 124214501Srpaulopcfclock_probe(device_t dev) 125214501Srpaulo{ 126214501Srpaulo struct pcfclock_data *sc; 127214501Srpaulo 128214501Srpaulo device_set_desc(dev, "PCF-1.0"); 129214501Srpaulo 130214501Srpaulo sc = DEVTOSOFTC(dev); 131214501Srpaulo bzero(sc, sizeof(struct pcfclock_data)); 132214501Srpaulo 133214501Srpaulo return (0); 134214501Srpaulo} 135214501Srpaulo 136214501Srpaulostatic int 137214501Srpaulopcfclock_attach(device_t dev) 138214501Srpaulo{ 139214501Srpaulo int unit; 140214501Srpaulo 141214501Srpaulo unit = device_get_unit(dev); 142214501Srpaulo 143214501Srpaulo make_dev(&pcfclock_cdevsw, unit, 144214501Srpaulo UID_ROOT, GID_WHEEL, 0400, PCFCLOCK_NAME "%d", unit); 145214501Srpaulo 146252726Srpaulo return (0); 147214501Srpaulo} 148214501Srpaulo 149214501Srpaulostatic int 150214501Srpaulopcfclock_open(dev_t dev, int flag, int fms, struct thread *td) 151214501Srpaulo{ 152214501Srpaulo u_int unit = minor(dev); 153214501Srpaulo struct pcfclock_data *sc = UNITOSOFTC(unit); 154214501Srpaulo device_t pcfclockdev = UNITODEVICE(unit); 155214501Srpaulo device_t ppbus = device_get_parent(pcfclockdev); 156214501Srpaulo int res; 157214501Srpaulo 158214501Srpaulo if (!sc) 159214501Srpaulo return (ENXIO); 160214501Srpaulo 161214501Srpaulo if ((res = ppb_request_bus(ppbus, pcfclockdev, 162214501Srpaulo (flag & O_NONBLOCK) ? PPB_DONTWAIT : PPB_WAIT))) 163214501Srpaulo return (res); 164214501Srpaulo 165214501Srpaulo sc->count++; 166214501Srpaulo 167214501Srpaulo return (0); 168214501Srpaulo} 169214501Srpaulo 170214501Srpaulostatic int 171214501Srpaulopcfclock_close(dev_t dev, int flags, int fmt, struct thread *td) 172214501Srpaulo{ 173214501Srpaulo u_int unit = minor(dev); 174214501Srpaulo struct pcfclock_data *sc = UNITOSOFTC(unit); 175214501Srpaulo device_t pcfclockdev = UNITODEVICE(unit); 176214501Srpaulo device_t ppbus = device_get_parent(pcfclockdev); 177214501Srpaulo 178214501Srpaulo sc->count--; 179214501Srpaulo if (sc->count == 0) 180214501Srpaulo ppb_release_bus(ppbus, pcfclockdev); 181214501Srpaulo 182252726Srpaulo return (0); 183214501Srpaulo} 184214501Srpaulo 185214501Srpaulostatic void 186214501Srpaulopcfclock_write_cmd(dev_t dev, unsigned char command) 187214501Srpaulo{ 188214501Srpaulo u_int unit = minor(dev); 189214501Srpaulo device_t ppidev = UNITODEVICE(unit); 190214501Srpaulo device_t ppbus = device_get_parent(ppidev); 191214501Srpaulo unsigned char ctr = 14; 192214501Srpaulo char i; 193214501Srpaulo 194214501Srpaulo for (i = 0; i <= 7; i++) { 195214501Srpaulo ppb_wdtr(ppbus, i); 196214501Srpaulo AUTOFEED_CLOCK(i & 1 ? AFC_HI : AFC_LO); 197214501Srpaulo DELAY(3000); 198214501Srpaulo } 199214501Srpaulo ppb_wdtr(ppbus, command); 200214501Srpaulo AUTOFEED_CLOCK(AFC_LO); 201214501Srpaulo DELAY(3000); 202214501Srpaulo AUTOFEED_CLOCK(AFC_HI); 203214501Srpaulo} 204214501Srpaulo 205214501Srpaulostatic void 206214501Srpaulopcfclock_display_data(dev_t dev, char buf[18]) 207214501Srpaulo{ 208214501Srpaulo u_int unit = minor(dev); 209214501Srpaulo#ifdef PCFCLOCK_VERBOSE 210214501Srpaulo int year; 211214501Srpaulo 212214501Srpaulo year = NR(buf, 14); 213214501Srpaulo if (year < 70) 214214501Srpaulo year += 100; 215214501Srpaulo 216214501Srpaulo printf(PCFCLOCK_NAME "%d: %02d.%02d.%4d %02d:%02d:%02d, " 217214501Srpaulo "battery status: %s\n", 218214501Srpaulo unit, 219214501Srpaulo NR(buf, 10), NR(buf, 12), 1900 + year, 220214501Srpaulo NR(buf, 6), NR(buf, 4), NR(buf, 2), 221214501Srpaulo PCFCLOCK_BATTERY_STATUS_LOW(buf) ? "LOW" : "ok"); 222214501Srpaulo#else 223214501Srpaulo if (PCFCLOCK_BATTERY_STATUS_LOW(buf)) 224214501Srpaulo printf(PCFCLOCK_NAME "%d: BATTERY STATUS LOW ON\n", 225214501Srpaulo unit); 226214501Srpaulo#endif 227214501Srpaulo} 228214501Srpaulo 229214501Srpaulostatic int 230214501Srpaulopcfclock_read_data(dev_t dev, char *buf, ssize_t bits) 231243419Scperciva{ 232243419Scperciva u_int unit = minor(dev); 233243419Scperciva device_t ppidev = UNITODEVICE(unit); 234243419Scperciva device_t ppbus = device_get_parent(ppidev); 235243419Scperciva int i; 236243419Scperciva char waitfor; 237243419Scperciva int offset; 238243419Scperciva 239214501Srpaulo /* one byte per four bits */ 240214501Srpaulo bzero(buf, ((bits + 3) >> 2) + 1); 241214501Srpaulo 242214501Srpaulo waitfor = 100; 243214501Srpaulo for (i = 0; i <= bits; i++) { 244214501Srpaulo /* wait for clock, maximum (waitfor*100) usec */ 245214501Srpaulo while(!CLOCK_OK && --waitfor > 0) 246214501Srpaulo DELAY(100); 247214501Srpaulo 248214501Srpaulo /* timed out? */ 249214501Srpaulo if (!waitfor) 250214501Srpaulo return (EIO); 251214501Srpaulo 252214501Srpaulo waitfor = 100; /* reload */ 253214501Srpaulo 254214501Srpaulo /* give it some time */ 255214501Srpaulo DELAY(500); 256214501Srpaulo 257214501Srpaulo /* calculate offset into buffer */ 258214501Srpaulo offset = i >> 2; 259214501Srpaulo buf[offset] <<= 1; 260214501Srpaulo 261214501Srpaulo if (BIT_SET) 262214501Srpaulo buf[offset] |= 1; 263214501Srpaulo } 264214501Srpaulo 265214501Srpaulo return (0); 266214501Srpaulo} 267214501Srpaulo 268214501Srpaulostatic int 269214501Srpaulopcfclock_read_dev(dev_t dev, char *buf, int maxretries) 270214501Srpaulo{ 271214501Srpaulo u_int unit = minor(dev); 272214501Srpaulo device_t ppidev = UNITODEVICE(unit); 273214501Srpaulo device_t ppbus = device_get_parent(ppidev); 274214501Srpaulo int error = 0; 275214501Srpaulo 276214501Srpaulo ppb_set_mode(ppbus, PPB_COMPATIBLE); 277214501Srpaulo 278214501Srpaulo while (--maxretries > 0) { 279214501Srpaulo pcfclock_write_cmd(dev, PCFCLOCK_CMD_TIME); 280214501Srpaulo if (pcfclock_read_data(dev, buf, 68)) 281214501Srpaulo continue; 282214501Srpaulo 283214501Srpaulo if (!PCFCLOCK_CORRECT_SYNC(buf)) 284214501Srpaulo continue; 285214501Srpaulo 286214501Srpaulo if (!PCFCLOCK_CORRECT_FORMAT(buf)) 287214501Srpaulo continue; 288214501Srpaulo 289214501Srpaulo break; 290214501Srpaulo } 291214501Srpaulo 292214501Srpaulo if (!maxretries) 293214501Srpaulo error = EIO; 294214501Srpaulo 295214501Srpaulo return (error); 296214501Srpaulo} 297214501Srpaulo 298214501Srpaulostatic int 299214501Srpaulopcfclock_read(dev_t dev, struct uio *uio, int ioflag) 300252726Srpaulo{ 301252726Srpaulo u_int unit = minor(dev); 302252726Srpaulo char buf[18]; 303252726Srpaulo int error = 0; 304252726Srpaulo 305252726Srpaulo if (uio->uio_resid < 18) 306252726Srpaulo return (ERANGE); 307214501Srpaulo 308214501Srpaulo error = pcfclock_read_dev(dev, buf, PCFCLOCK_MAX_RETRIES); 309214501Srpaulo 310214501Srpaulo if (error) { 311214501Srpaulo printf(PCFCLOCK_NAME "%d: no PCF found\n", unit); 312214501Srpaulo } else { 313214501Srpaulo pcfclock_display_data(dev, buf); 314214501Srpaulo 315214501Srpaulo uiomove(buf, 18, uio); 316214501Srpaulo } 317214501Srpaulo 318214501Srpaulo return (error); 319214501Srpaulo} 320214501Srpaulo 321214501Srpaulostatic device_method_t pcfclock_methods[] = { 322214501Srpaulo /* device interface */ 323214501Srpaulo DEVMETHOD(device_identify, pcfclock_identify), 324214501Srpaulo DEVMETHOD(device_probe, pcfclock_probe), 325214501Srpaulo DEVMETHOD(device_attach, pcfclock_attach), 326214501Srpaulo 327214501Srpaulo { 0, 0 } 328214501Srpaulo}; 329214501Srpaulo 330214501Srpaulostatic driver_t pcfclock_driver = { 331214501Srpaulo PCFCLOCK_NAME, 332214501Srpaulo pcfclock_methods, 333214501Srpaulo sizeof(struct pcfclock_data), 334214501Srpaulo}; 335214501Srpaulo 336214501SrpauloDRIVER_MODULE(pcfclock, ppbus, pcfclock_driver, pcfclock_devclass, 0, 0); 337214501Srpaulo