File: [local] / sys / dev / usb / udcf.c (download)
Revision 1.1, Tue Mar 4 16:14:33 2008 UTC (16 years, 6 months ago) by nbrk
Branch point for: MAIN
Initial revision
|
/* $OpenBSD: udcf.c,v 1.38 2007/06/14 10:11:15 mbalmer Exp $ */
/*
* Copyright (c) 2006 Marc Balmer <mbalmer@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/conf.h>
#include <sys/file.h>
#include <sys/select.h>
#include <sys/proc.h>
#include <sys/vnode.h>
#include <sys/device.h>
#include <sys/poll.h>
#include <sys/time.h>
#include <sys/sensors.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include <dev/usb/usbdevs.h>
#ifdef UDCF_DEBUG
#define DPRINTFN(n, x) do { if (udcfdebug > (n)) printf x; } while (0)
int udcfdebug = 0;
#else
#define DPRINTFN(n, x)
#endif
#define DPRINTF(x) DPRINTFN(0, x)
#define UDCF_READ_REQ 0xc0
#define UDCF_READ_IDX 0x1f
#define UDCF_CTRL_REQ 0x40
#define UDCF_CTRL_IDX 0x33
#define UDCF_CTRL_VAL 0x98
#define DPERIOD1 ((long) 5 * 60) /* degrade OK -> WARN */
#define DPERIOD2 ((long) 15 * 60) /* degrade WARN -> CRIT */
/* max. skew of received time diff vs. measured time diff in percent. */
#define MAX_SKEW 5
#define CLOCK_DCF77 0
#define CLOCK_HBG 1
static const char *clockname[2] = {
"DCF77",
"HBG" };
struct udcf_softc {
struct device sc_dev; /* base device */
usbd_device_handle sc_udev; /* USB device */
usbd_interface_handle sc_iface; /* data interface */
u_char sc_dying; /* disconnecting */
struct timeout sc_to;
struct usb_task sc_task;
struct timeout sc_bv_to; /* bit-value detect */
struct timeout sc_db_to; /* debounce */
struct timeout sc_mg_to; /* minute-gap detect */
struct timeout sc_sl_to; /* signal-loss detect */
struct timeout sc_it_to; /* invalidate time */
struct timeout sc_ct_to; /* detect clock type */
struct usb_task sc_bv_task;
struct usb_task sc_mg_task;
struct usb_task sc_sl_task;
struct usb_task sc_it_task;
struct usb_task sc_ct_task;
usb_device_request_t sc_req;
int sc_clocktype; /* DCF77 or HBG */
int sc_sync; /* 1 during sync */
u_int64_t sc_mask; /* 64 bit mask */
u_int64_t sc_tbits; /* Time bits */
int sc_minute;
int sc_level;
time_t sc_last_mg;
time_t sc_current; /* current time */
time_t sc_next; /* time to become valid next */
time_t sc_last;
int sc_nrecv; /* consecutive valid times */
struct timeval sc_last_tv; /* uptime of last valid time */
struct ksensor sc_sensor;
#ifdef UDCF_DEBUG
struct ksensor sc_skew; /* recv vs local skew */
#endif
struct ksensordev sc_sensordev;
};
/*
* timeouts being used in hz:
* t_bv bit value detection (150ms)
* t_ct detect clocktype (250ms)
* t_sync sync (950ms)
* t_mg minute gap detection (1500ms)
* t_mgsync resync after a minute gap (450ms)
* t_sl detect signal loss (3sec)
* t_wait wait (5sec)
* t_warn degrade sensor status to warning (5min)
* t_crit degrade sensor status to critical (15min)
*/
static int t_bv, t_ct, t_sync, t_mg, t_sl, t_mgsync, t_wait, t_warn, t_crit;
void udcf_intr(void *);
void udcf_probe(void *);
void udcf_bv_intr(void *);
void udcf_mg_intr(void *);
void udcf_sl_intr(void *);
void udcf_it_intr(void *);
void udcf_ct_intr(void *);
void udcf_bv_probe(void *);
void udcf_mg_probe(void *);
void udcf_sl_probe(void *);
void udcf_it_probe(void *);
void udcf_ct_probe(void *);
int udcf_match(struct device *, void *, void *);
void udcf_attach(struct device *, struct device *, void *);
int udcf_detach(struct device *, int);
int udcf_activate(struct device *, enum devact);
struct cfdriver udcf_cd = {
NULL, "udcf", DV_DULL
};
const struct cfattach udcf_ca = {
sizeof(struct udcf_softc),
udcf_match,
udcf_attach,
udcf_detach,
udcf_activate,
};
int
udcf_match(struct device *parent, void *match, void *aux)
{
struct usb_attach_arg *uaa = aux;
if (uaa->iface != NULL)
return UMATCH_NONE;
return uaa->vendor == USB_VENDOR_GUDE &&
uaa->product == USB_PRODUCT_GUDE_DCF ?
UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
}
void
udcf_attach(struct device *parent, struct device *self, void *aux)
{
struct udcf_softc *sc = (struct udcf_softc *)self;
struct usb_attach_arg *uaa = aux;
usbd_device_handle dev = uaa->device;
usbd_interface_handle iface;
struct timeval t;
char *devinfop;
usb_interface_descriptor_t *id;
usbd_status err;
usb_device_request_t req;
uWord result;
int actlen;
if ((err = usbd_set_config_index(dev, 0, 1))) {
DPRINTF(("\n%s: failed to set configuration, err=%s\n",
sc->sc_dev.dv_xname, usbd_errstr(err)));
goto fishy;
}
if ((err = usbd_device2interface_handle(dev, 0, &iface))) {
DPRINTF(("\n%s: failed to get interface, err=%s\n",
sc->sc_dev.dv_xname, usbd_errstr(err)));
goto fishy;
}
devinfop = usbd_devinfo_alloc(dev, 0);
printf("\n%s: %s\n", sc->sc_dev.dv_xname, devinfop);
usbd_devinfo_free(devinfop);
id = usbd_get_interface_descriptor(iface);
sc->sc_udev = dev;
sc->sc_iface = iface;
sc->sc_clocktype = -1;
sc->sc_level = 0;
sc->sc_minute = 0;
sc->sc_last_mg = 0L;
sc->sc_sync = 1;
sc->sc_current = 0L;
sc->sc_next = 0L;
sc->sc_nrecv = 0;
sc->sc_last = 0L;
sc->sc_last_tv.tv_sec = 0L;
strlcpy(sc->sc_sensordev.xname, sc->sc_dev.dv_xname,
sizeof(sc->sc_sensordev.xname));
sc->sc_sensor.type = SENSOR_TIMEDELTA;
sc->sc_sensor.status = SENSOR_S_UNKNOWN;
sc->sc_sensor.value = 0LL;
sc->sc_sensor.flags = 0;
strlcpy(sc->sc_sensor.desc, "Unknown", sizeof(sc->sc_sensor.desc));
sensor_attach(&sc->sc_sensordev, &sc->sc_sensor);
#ifdef UDCF_DEBUG
sc->sc_skew.type = SENSOR_TIMEDELTA;
sc->sc_skew.status = SENSOR_S_UNKNOWN;
sc->sc_skew.value = 0LL;
sc->sc_skew.flags = 0;
strlcpy(sc->sc_skew.desc, "local clock skew",
sizeof(sc->sc_skew.desc));
sensor_attach(&sc->sc_sensordev, &sc->sc_skew);
#endif
sensordev_install(&sc->sc_sensordev);
/* Prepare the USB request to probe the value */
sc->sc_req.bmRequestType = UDCF_READ_REQ;
sc->sc_req.bRequest = 1;
USETW(sc->sc_req.wValue, 0);
USETW(sc->sc_req.wIndex, UDCF_READ_IDX);
USETW(sc->sc_req.wLength, 1);
req.bmRequestType = UDCF_CTRL_REQ;
req.bRequest = 0;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, 0);
if ((err = usbd_do_request_flags(sc->sc_udev, &req, &result,
USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT))) {
DPRINTF(("failed to turn on power for receiver\n"));
goto fishy;
}
req.bmRequestType = UDCF_CTRL_REQ;
req.bRequest = 0;
USETW(req.wValue, UDCF_CTRL_VAL);
USETW(req.wIndex, UDCF_CTRL_IDX);
USETW(req.wLength, 0);
if ((err = usbd_do_request_flags(sc->sc_udev, &req, &result,
USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT))) {
DPRINTF(("failed to turn on receiver\n"));
goto fishy;
}
usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
&sc->sc_dev);
usb_init_task(&sc->sc_task, udcf_probe, sc);
usb_init_task(&sc->sc_bv_task, udcf_bv_probe, sc);
usb_init_task(&sc->sc_mg_task, udcf_mg_probe, sc);
usb_init_task(&sc->sc_sl_task, udcf_sl_probe, sc);
usb_init_task(&sc->sc_it_task, udcf_it_probe, sc);
usb_init_task(&sc->sc_ct_task, udcf_ct_probe, sc);
timeout_set(&sc->sc_to, udcf_intr, sc);
timeout_set(&sc->sc_bv_to, udcf_bv_intr, sc);
timeout_set(&sc->sc_mg_to, udcf_mg_intr, sc);
timeout_set(&sc->sc_sl_to, udcf_sl_intr, sc);
timeout_set(&sc->sc_it_to, udcf_it_intr, sc);
timeout_set(&sc->sc_ct_to, udcf_ct_intr, sc);
/* convert timevals to hz */
t.tv_sec = 0L;
t.tv_usec = 150000L;
t_bv = tvtohz(&t);
t.tv_usec = 450000L;
t_mgsync = tvtohz(&t);
t.tv_usec = 950000L;
t_sync = tvtohz(&t);
t.tv_sec = 1L;
t.tv_usec = 500000L;
t_mg = tvtohz(&t);
t.tv_sec = 3L;
t.tv_usec = 0L;
t_sl = tvtohz(&t);
t.tv_sec = 5L;
t_wait = tvtohz(&t);
t.tv_sec = DPERIOD1;
t_warn = tvtohz(&t);
t.tv_sec = DPERIOD2;
t_crit = tvtohz(&t);
t.tv_sec = 0L;
t.tv_usec = 250000L;
t_ct = tvtohz(&t);
/* Give the receiver some slack to stabilize */
timeout_add(&sc->sc_to, t_wait);
/* Detect signal loss */
timeout_add(&sc->sc_sl_to, t_wait + t_sl);
DPRINTF(("synchronizing\n"));
return;
fishy:
DPRINTF(("udcf_attach failed\n"));
sc->sc_dying = 1;
}
int
udcf_detach(struct device *self, int flags)
{
struct udcf_softc *sc = (struct udcf_softc *)self;
sc->sc_dying = 1;
timeout_del(&sc->sc_to);
timeout_del(&sc->sc_bv_to);
timeout_del(&sc->sc_mg_to);
timeout_del(&sc->sc_sl_to);
timeout_del(&sc->sc_it_to);
timeout_del(&sc->sc_ct_to);
/* Unregister the clock with the kernel */
sensordev_deinstall(&sc->sc_sensordev);
usb_rem_task(sc->sc_udev, &sc->sc_task);
usb_rem_task(sc->sc_udev, &sc->sc_bv_task);
usb_rem_task(sc->sc_udev, &sc->sc_mg_task);
usb_rem_task(sc->sc_udev, &sc->sc_sl_task);
usb_rem_task(sc->sc_udev, &sc->sc_it_task);
usb_rem_task(sc->sc_udev, &sc->sc_ct_task);
usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
&sc->sc_dev);
return 0;
}
/* udcf_intr runs in an interrupt context */
void
udcf_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_task);
}
/* bit value detection */
void
udcf_bv_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_bv_task);
}
/* minute gap detection */
void
udcf_mg_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_mg_task);
}
/* signal loss detection */
void
udcf_sl_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_sl_task);
}
/* degrade the sensor */
void
udcf_it_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_it_task);
}
/* detect the clock type (DCF77 or HBG) */
void
udcf_ct_intr(void *xsc)
{
struct udcf_softc *sc = xsc;
usb_add_task(sc->sc_udev, &sc->sc_ct_task);
}
/*
* udcf_probe runs in a process context. If bit 0 is set, the transmitter
* emits at full power. During the low-power emission we decode a zero bit.
*/
void
udcf_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
struct timespec now;
unsigned char data;
int actlen;
if (sc->sc_dying)
return;
if (usbd_do_request_flags(sc->sc_udev, &sc->sc_req, &data,
USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT))
/* This happens if we pull the receiver */
return;
if (data & 0x01) {
sc->sc_level = 1;
timeout_add(&sc->sc_to, 1);
return;
}
if (sc->sc_level == 0)
return;
/* Begin of a second */
sc->sc_level = 0;
if (sc->sc_minute == 1) {
if (sc->sc_sync) {
DPRINTF(("start collecting bits\n"));
sc->sc_sync = 0;
if (sc->sc_sensor.status == SENSOR_S_UNKNOWN)
sc->sc_clocktype = -1;
} else {
/* provide the timedelta */
microtime(&sc->sc_sensor.tv);
nanotime(&now);
sc->sc_current = sc->sc_next;
sc->sc_sensor.value = (int64_t)(now.tv_sec -
sc->sc_current) * 1000000000LL + now.tv_nsec;
/* set the clocktype and make sensor valid */
if (sc->sc_sensor.status == SENSOR_S_UNKNOWN) {
strlcpy(sc->sc_sensor.desc, sc->sc_clocktype ?
clockname[CLOCK_HBG] :
clockname[CLOCK_DCF77],
sizeof(sc->sc_sensor.desc));
}
sc->sc_sensor.status = SENSOR_S_OK;
/*
* if no valid time information is received
* during the next 5 minutes, the sensor state
* will be degraded to SENSOR_S_WARN
*/
timeout_add(&sc->sc_it_to, t_warn);
}
sc->sc_minute = 0;
}
timeout_add(&sc->sc_to, t_sync); /* resync in 950 ms */
/* No clock and bit detection during sync */
if (!sc->sc_sync) {
/* detect bit value */
timeout_add(&sc->sc_bv_to, t_bv);
/* detect clocktype */
if (sc->sc_clocktype == -1)
timeout_add(&sc->sc_ct_to, t_ct);
}
timeout_add(&sc->sc_mg_to, t_mg); /* detect minute gap */
timeout_add(&sc->sc_sl_to, t_sl); /* detect signal loss */
}
/* detect the bit value */
void
udcf_bv_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
int actlen;
unsigned char data;
if (sc->sc_dying)
return;
if (usbd_do_request_flags(sc->sc_udev, &sc->sc_req, &data,
USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT)) {
/* This happens if we pull the receiver */
DPRINTF(("bit detection failed\n"));
return;
}
DPRINTFN(1, (data & 0x01 ? "0" : "1"));
if (!(data & 0x01))
sc->sc_tbits |= sc->sc_mask;
sc->sc_mask <<= 1;
}
/* detect the minute gap */
void
udcf_mg_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
struct clock_ymdhms ymdhm;
struct timeval monotime;
int tdiff_recv, tdiff_local;
int skew;
int minute_bits, hour_bits, day_bits;
int month_bits, year_bits, wday;
int p1, p2, p3;
int p1_bit, p2_bit, p3_bit;
int r_bit, a1_bit, a2_bit, z1_bit, z2_bit;
int s_bit, m_bit;
u_int32_t parity = 0x6996;
if (sc->sc_sync) {
sc->sc_minute = 1;
goto cleanbits;
}
if (time_second - sc->sc_last_mg < 57) {
DPRINTF(("\nunexpected gap, resync\n"));
sc->sc_sync = sc->sc_minute = 1;
goto cleanbits;
}
/* Extract bits w/o parity */
m_bit = sc->sc_tbits & 1;
r_bit = sc->sc_tbits >> 15 & 1;
a1_bit = sc->sc_tbits >> 16 & 1;
z1_bit = sc->sc_tbits >> 17 & 1;
z2_bit = sc->sc_tbits >> 18 & 1;
a2_bit = sc->sc_tbits >> 19 & 1;
s_bit = sc->sc_tbits >> 20 & 1;
p1_bit = sc->sc_tbits >> 28 & 1;
p2_bit = sc->sc_tbits >> 35 & 1;
p3_bit = sc->sc_tbits >> 58 & 1;
minute_bits = sc->sc_tbits >> 21 & 0x7f;
hour_bits = sc->sc_tbits >> 29 & 0x3f;
day_bits = sc->sc_tbits >> 36 & 0x3f;
wday = (sc->sc_tbits >> 42) & 0x07;
month_bits = sc->sc_tbits >> 45 & 0x1f;
year_bits = sc->sc_tbits >> 50 & 0xff;
/* Validate time information */
p1 = (parity >> (minute_bits & 0x0f) & 1) ^
(parity >> (minute_bits >> 4) & 1);
p2 = (parity >> (hour_bits & 0x0f) & 1) ^
(parity >> (hour_bits >> 4) & 1);
p3 = (parity >> (day_bits & 0x0f) & 1) ^
(parity >> (day_bits >> 4) & 1) ^
((parity >> wday) & 1) ^ (parity >> (month_bits & 0x0f) & 1) ^
(parity >> (month_bits >> 4) & 1) ^
(parity >> (year_bits & 0x0f) & 1) ^
(parity >> (year_bits >> 4) & 1);
if (m_bit == 0 && s_bit == 1 && p1 == p1_bit && p2 == p2_bit &&
p3 == p3_bit && (z1_bit ^ z2_bit)) {
/* Decode time */
if ((ymdhm.dt_year = 2000 + FROMBCD(year_bits)) > 2037) {
DPRINTF(("year out of range, resync\n"));
sc->sc_sync = 1;
goto cleanbits;
}
ymdhm.dt_min = FROMBCD(minute_bits);
ymdhm.dt_hour = FROMBCD(hour_bits);
ymdhm.dt_day = FROMBCD(day_bits);
ymdhm.dt_mon = FROMBCD(month_bits);
ymdhm.dt_sec = 0;
sc->sc_next = clock_ymdhms_to_secs(&ymdhm);
getmicrouptime(&monotime);
/* convert to coordinated universal time */
sc->sc_next -= z1_bit ? 7200 : 3600;
DPRINTF(("\n%02d.%02d.%04d %02d:%02d:00 %s",
ymdhm.dt_day, ymdhm.dt_mon, ymdhm.dt_year,
ymdhm.dt_hour, ymdhm.dt_min, z1_bit ? "CEST" : "CET"));
DPRINTF((r_bit ? ", call bit" : ""));
DPRINTF((a1_bit ? ", dst chg ann." : ""));
DPRINTF((a2_bit ? ", leap sec ann." : ""));
DPRINTF(("\n"));
if (sc->sc_last) {
tdiff_recv = sc->sc_next - sc->sc_last;
tdiff_local = monotime.tv_sec - sc->sc_last_tv.tv_sec;
skew = abs(tdiff_local - tdiff_recv);
#ifdef UDCF_DEBUG
if (sc->sc_skew.status == SENSOR_S_UNKNOWN)
sc->sc_skew.status = SENSOR_S_CRIT;
sc->sc_skew.value = skew * 1000000000LL;
getmicrotime(&sc->sc_skew.tv);
#endif
DPRINTF(("local = %d, recv = %d, skew = %d\n",
tdiff_local, tdiff_recv, skew));
if (skew && skew * 100LL / tdiff_local > MAX_SKEW) {
DPRINTF(("skew out of tolerated range\n"));
goto cleanbits;
} else {
if (sc->sc_nrecv < 2) {
sc->sc_nrecv++;
DPRINTF(("got frame %d\n",
sc->sc_nrecv));
} else {
DPRINTF(("data is valid\n"));
sc->sc_minute = 1;
}
}
} else {
DPRINTF(("received the first frame\n"));
sc->sc_nrecv = 1;
}
/* record the time received and when it was received */
sc->sc_last = sc->sc_next;
sc->sc_last_tv.tv_sec = monotime.tv_sec;
} else {
DPRINTF(("\nparity error, resync\n"));
sc->sc_sync = sc->sc_minute = 1;
}
cleanbits:
timeout_add(&sc->sc_to, t_mgsync); /* re-sync in 450 ms */
sc->sc_last_mg = time_second;
sc->sc_tbits = 0LL;
sc->sc_mask = 1LL;
}
/* detect signal loss */
void
udcf_sl_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
if (sc->sc_dying)
return;
DPRINTF(("no signal\n"));
sc->sc_sync = 1;
timeout_add(&sc->sc_to, t_wait);
timeout_add(&sc->sc_sl_to, t_wait + t_sl);
}
/* invalidate timedelta */
void
udcf_it_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
if (sc->sc_dying)
return;
DPRINTF(("\ndegrading sensor state\n"));
if (sc->sc_sensor.status == SENSOR_S_OK) {
sc->sc_sensor.status = SENSOR_S_WARN;
/*
* further degrade in 15 minutes if we dont receive any new
* time information
*/
timeout_add(&sc->sc_it_to, t_crit);
} else {
sc->sc_sensor.status = SENSOR_S_CRIT;
sc->sc_nrecv = 0;
}
}
/* detect clock type */
void
udcf_ct_probe(void *xsc)
{
struct udcf_softc *sc = xsc;
int actlen;
unsigned char data;
if (sc->sc_dying)
return;
if (usbd_do_request_flags(sc->sc_udev, &sc->sc_req, &data,
USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT)) {
/* This happens if we pull the receiver */
DPRINTF(("clocktype detection failed\n"));
return;
}
sc->sc_clocktype = data & 0x01 ? 0 : 1;
DPRINTF(("\nclocktype is %s\n", sc->sc_clocktype ?
clockname[CLOCK_HBG] : clockname[CLOCK_DCF77]));
}
int
udcf_activate(struct device *self, enum devact act)
{
struct udcf_softc *sc = (struct udcf_softc *)self;
switch (act) {
case DVACT_ACTIVATE:
break;
case DVACT_DEACTIVATE:
sc->sc_dying = 1;
break;
}
return 0;
}