sys/dev/usbmisc/ufm/ufm.c

   1 /*
   2  * Copyright (c) 2001 M. Warner Losh
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson.
  27  * This code includes software developed by the NetBSD Foundation, Inc. and
  28  * its contributors.
  29  */
  30
  31 /*
  32  * $FreeBSD: src/sys/dev/usb/ufm.c,v 1.16 2003/10/04 21:41:01 joe Exp $
  33  * $DragonFly: src/sys/dev/usbmisc/ufm/ufm.c,v 1.23 2007/11/06 07:37:01 hasso Exp $
  34  */
  35
  36 #include <sys/param.h>
  37 #include <sys/systm.h>
  38 #include <sys/kernel.h>
  39 #include <sys/malloc.h>
  40 #include <sys/module.h>
  41 #include <sys/bus.h>
  42 #include <sys/ioccom.h>
  43 #include <sys/fcntl.h>
  44 #include <sys/filio.h>
  45 #include <sys/conf.h>
  46 #include <sys/uio.h>
  47 #include <sys/tty.h>
  48 #include <sys/file.h>
  49 #include <sys/select.h>
  50 #include <sys/poll.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/thread2.h>
  53
  54 #include <bus/usb/usb.h>
  55 #include <bus/usb/usbdi.h>
  56 #include <bus/usb/usbdi_util.h>
  57
  58 #include <bus/usb/dsbr100io.h>
  59
  60 #ifdef USB_DEBUG
  61 #define DPRINTF(x)      if (ufmdebug) kprintf x
  62 #define DPRINTFN(n,x)   if (ufmdebug>(n)) kprintf x
  63 int     ufmdebug = 0;
  64 SYSCTL_NODE(_hw_usb, OID_AUTO, ufm, CTLFLAG_RW, 0, "USB ufm");
  65 SYSCTL_INT(_hw_usb_ufm, OID_AUTO, debug, CTLFLAG_RW,
  66            &ufmdebug, 0, "ufm debug level");
  67 #else
  68 #define DPRINTF(x)
  69 #define DPRINTFN(n,x)
  70 #endif
  71
  72 d_open_t  ufmopen;
  73 d_close_t ufmclose;
  74 d_ioctl_t ufmioctl;
  75
  76 #define UFM_CDEV_MAJOR  200
  77
  78 static struct dev_ops ufm_ops = {
  79         { "ufm", UFM_CDEV_MAJOR, 0 },
  80         .d_open = ufmopen,
  81         .d_close = ufmclose,
  82         .d_ioctl = ufmioctl,
  83 };
  84
  85 #define FM_CMD0         0x00
  86 #define FM_CMD_SET_FREQ 0x01
  87 #define FM_CMD2         0x02
  88
  89 struct ufm_softc {
  90         device_t sc_dev;
  91         usbd_device_handle sc_udev;
  92         usbd_interface_handle sc_iface;
  93
  94         int sc_opened;
  95         int sc_epaddr;
  96         int sc_freq;
  97
  98         int sc_refcnt;
  99 };
 100
 101 #define UFMUNIT(n) (minor(n))
 102
 103 static device_probe_t ufm_match;
 104 static device_attach_t ufm_attach;
 105 static device_detach_t ufm_detach;
 106
 107 static devclass_t ufm_devclass;
 108
 109 static kobj_method_t ufm_methods[] = {
 110         DEVMETHOD(device_probe, ufm_match),
 111         DEVMETHOD(device_attach, ufm_attach),
 112         DEVMETHOD(device_detach, ufm_detach),
 113         {0,0}
 114 };
 115
 116 static driver_t ufm_driver = {
 117         "ufm",
 118         ufm_methods,
 119         sizeof(struct ufm_softc)
 120 };
 121
 122 MODULE_DEPEND(ufm, usb, 1, 1, 1);
 123
 124 static int
 125 ufm_match(device_t self)
 126 {
 127         struct usb_attach_arg *uaa = device_get_ivars(self);
 128         usb_device_descriptor_t *dd;
 129
 130         DPRINTFN(10,("ufm_match\n"));
 131         if (!uaa->iface)
 132                 return UMATCH_NONE;
 133
 134         dd = usbd_get_device_descriptor(uaa->device);
 135
 136         if (dd &&
 137             ((UGETW(dd->idVendor) == 0x04b4 && UGETW(dd->idProduct) == 0x1002)))
 138                 return UMATCH_VENDOR_PRODUCT;
 139         else
 140                 return UMATCH_NONE;
 141 }
 142
 143 static int
 144 ufm_attach(device_t self)
 145 {
 146         struct ufm_softc *sc = device_get_softc(self);
 147         struct usb_attach_arg *uaa = device_get_ivars(self);
 148         usb_endpoint_descriptor_t *edesc;
 149         usbd_device_handle udev;
 150         usbd_interface_handle iface;
 151         u_int8_t epcount;
 152         usbd_status r;
 153         char * ermsg = "<none>";
 154
 155         DPRINTFN(10,("ufm_attach: sc=%p\n", sc));
 156         sc->sc_dev = self;
 157         sc->sc_udev = udev = uaa->device;
 158
 159         if ((!uaa->device) || (!uaa->iface)) {
 160                 ermsg = "device or iface";
 161                 goto nobulk;
 162         }
 163         sc->sc_iface = iface = uaa->iface;
 164         sc->sc_opened = 0;
 165         sc->sc_refcnt = 0;
 166
 167         r = usbd_endpoint_count(iface, &epcount);
 168         if (r != USBD_NORMAL_COMPLETION) {
 169                 ermsg = "endpoints";
 170                 goto nobulk;
 171         }
 172
 173         edesc = usbd_interface2endpoint_descriptor(iface, 0);
 174         if (!edesc) {
 175                 ermsg = "interface endpoint";
 176                 goto nobulk;
 177         }
 178         sc->sc_epaddr = edesc->bEndpointAddress;
 179
 180         /* XXX no error trapping, no storing of cdev_t */
 181         dev_ops_add(&ufm_ops, -1, device_get_unit(self));
 182         make_dev(&ufm_ops, device_get_unit(self),
 183                         UID_ROOT, GID_OPERATOR,
 184                         0644, "ufm%d", device_get_unit(self));
 185
 186         DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
 187
 188         return 0;
 189
 190  nobulk:
 191         kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
 192         return ENXIO;
 193 }
 194
 195
 196 int
 197 ufmopen(struct dev_open_args *ap)
 198 {
 199         cdev_t dev = ap->a_head.a_dev;
 200         struct ufm_softc *sc;
 201
 202         int unit = UFMUNIT(dev);
 203         sc = devclass_get_softc(ufm_devclass, unit);
 204         if (sc == NULL)
 205                 return (ENXIO);
 206
 207         DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
 208                      ap->a_oflags, ap->a_devtype, unit));
 209
 210         if (sc->sc_opened)
 211                 return (EBUSY);
 212
 213         if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
 214                 return (EACCES);
 215
 216         sc->sc_opened = 1;
 217         return (0);
 218 }
 219
 220 int
 221 ufmclose(struct dev_close_args *ap)
 222 {
 223         cdev_t dev = ap->a_head.a_dev;
 224         struct ufm_softc *sc;
 225
 226         int unit = UFMUNIT(dev);
 227         sc = devclass_get_softc(ufm_devclass, unit);
 228
 229         DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n",
 230                     ap->a_fflag, ap->a_devtype, unit));
 231         sc->sc_opened = 0;
 232         sc->sc_refcnt = 0;
 233         return 0;
 234 }
 235
 236 static int
 237 ufm_do_req(struct ufm_softc *sc, u_int8_t reqtype, u_int8_t request,
 238     u_int16_t value, u_int16_t index, u_int8_t len, void *retbuf)
 239 {
 240         usb_device_request_t req;
 241         usbd_status err;
 242
 243         crit_enter();
 244         req.bmRequestType = reqtype;
 245         req.bRequest = request;
 246         USETW(req.wValue, value);
 247         USETW(req.wIndex, index);
 248         USETW(req.wLength, len);
 249         err = usbd_do_request_flags(sc->sc_udev, &req, retbuf, 0, NULL,
 250             USBD_DEFAULT_TIMEOUT);
 251         crit_exit();
 252         if (err) {
 253                 kprintf("usbd_do_request_flags returned %#x\n", err);
 254                 return (EIO);
 255         }
 256         return (0);
 257 }
 258
 259 static int
 260 ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
 261 {
 262         int freq = *(int *)addr;
 263         u_int8_t ret;
 264
 265         /*
 266          * Freq now is in Hz.  We need to convert it to the frequency
 267          * that the radio wants.  This frequency is 10.7MHz above
 268          * the actual frequency.  We then need to convert to
 269          * units of 12.5kHz.  We add one to the IFM to make rounding
 270          * easier.
 271          */
 272         sc->sc_freq = freq;
 273         freq = (freq + 10700001) / 12500;
 274         /* This appears to set the frequency */
 275         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD_SET_FREQ, freq >> 8,
 276             freq, 1, &ret) != 0)
 277                 return (EIO);
 278         /* Not sure what this does */
 279         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1,
 280             &ret) != 0)
 281                 return (EIO);
 282         return (0);
 283 }
 284
 285 static int
 286 ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
 287 {
 288         int *valp = (int *)addr;
 289         *valp = sc->sc_freq;
 290         return (0);
 291 }
 292
 293 static int
 294 ufm_start(struct ufm_softc *sc, caddr_t addr)
 295 {
 296         u_int8_t ret;
 297
 298         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7,
 299             1, &ret))
 300                 return (EIO);
 301         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
 302             1, &ret))
 303                 return (EIO);
 304         if (ret & 0x1)
 305                 return (EIO);
 306         return (0);
 307 }
 308
 309 static int
 310 ufm_stop(struct ufm_softc *sc, caddr_t addr)
 311 {
 312         u_int8_t ret;
 313
 314         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
 315             1, &ret))
 316                 return (EIO);
 317         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
 318             1, &ret))
 319                 return (EIO);
 320         return (0);
 321 }
 322
 323 static int
 324 ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
 325 {
 326         u_int8_t ret;
 327
 328         /*
 329          * Note, there's a 240ms settle time before the status
 330          * will be valid, so tsleep that amount.  hz/4 is a good
 331          * approximation of that.  Since this is a short sleep
 332          * we don't try to catch any signals to keep things
 333          * simple.
 334          */
 335         tsleep(sc, 0, "ufmwait", hz/4);
 336         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
 337             1, &ret))
 338                 return (EIO);
 339         *(int *)addr = ret;
 340
 341         return (0);
 342 }
 343
 344 int
 345 ufmioctl(struct dev_ioctl_args *ap)
 346 {
 347         cdev_t dev = ap->a_head.a_dev;
 348         caddr_t addr = ap->a_data;
 349         struct ufm_softc *sc;
 350
 351         int unit = UFMUNIT(dev);
 352         int error = 0;
 353
 354         sc = devclass_get_softc(ufm_devclass, unit);
 355
 356         switch (ap->a_cmd) {
 357         case FM_SET_FREQ:
 358                 error = ufm_set_freq(sc, addr);
 359                 break;
 360         case FM_GET_FREQ:
 361                 error = ufm_get_freq(sc, addr);
 362                 break;
 363         case FM_START:
 364                 error = ufm_start(sc, addr);
 365                 break;
 366         case FM_STOP:
 367                 error = ufm_stop(sc, addr);
 368                 break;
 369         case FM_GET_STAT:
 370                 error = ufm_get_stat(sc, addr);
 371                 break;
 372         default:
 373                 return ENOTTY;
 374                 break;
 375         }
 376         return error;
 377 }
 378
 379 static int
 380 ufm_detach(device_t self)
 381 {
 382         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 383         return 0;
 384 }
 385
 386 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);