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.24 2008/08/14 20:55:53 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_interface_handle iface;
 150         u_int8_t epcount;
 151         usbd_status r;
 152         char * ermsg = "<none>";
 153
 154         DPRINTFN(10,("ufm_attach: sc=%p\n", sc));
 155         sc->sc_dev = self;
 156         sc->sc_udev = uaa->device;
 157
 158         if ((!uaa->device) || (!uaa->iface)) {
 159                 ermsg = "device or iface";
 160                 goto nobulk;
 161         }
 162         sc->sc_iface = iface = uaa->iface;
 163         sc->sc_opened = 0;
 164         sc->sc_refcnt = 0;
 165
 166         r = usbd_endpoint_count(iface, &epcount);
 167         if (r != USBD_NORMAL_COMPLETION) {
 168                 ermsg = "endpoints";
 169                 goto nobulk;
 170         }
 171
 172         edesc = usbd_interface2endpoint_descriptor(iface, 0);
 173         if (!edesc) {
 174                 ermsg = "interface endpoint";
 175                 goto nobulk;
 176         }
 177         sc->sc_epaddr = edesc->bEndpointAddress;
 178
 179         /* XXX no error trapping, no storing of cdev_t */
 180         dev_ops_add(&ufm_ops, -1, device_get_unit(self));
 181         make_dev(&ufm_ops, device_get_unit(self),
 182                         UID_ROOT, GID_OPERATOR,
 183                         0644, "ufm%d", device_get_unit(self));
 184
 185         DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
 186
 187         return 0;
 188
 189  nobulk:
 190         kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
 191         return ENXIO;
 192 }
 193
 194
 195 int
 196 ufmopen(struct dev_open_args *ap)
 197 {
 198         cdev_t dev = ap->a_head.a_dev;
 199         struct ufm_softc *sc;
 200
 201         int unit = UFMUNIT(dev);
 202         sc = devclass_get_softc(ufm_devclass, unit);
 203         if (sc == NULL)
 204                 return (ENXIO);
 205
 206         DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
 207                      ap->a_oflags, ap->a_devtype, unit));
 208
 209         if (sc->sc_opened)
 210                 return (EBUSY);
 211
 212         if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
 213                 return (EACCES);
 214
 215         sc->sc_opened = 1;
 216         return (0);
 217 }
 218
 219 int
 220 ufmclose(struct dev_close_args *ap)
 221 {
 222         cdev_t dev = ap->a_head.a_dev;
 223         struct ufm_softc *sc;
 224
 225         int unit = UFMUNIT(dev);
 226         sc = devclass_get_softc(ufm_devclass, unit);
 227
 228         DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n",
 229                     ap->a_fflag, ap->a_devtype, unit));
 230         sc->sc_opened = 0;
 231         sc->sc_refcnt = 0;
 232         return 0;
 233 }
 234
 235 static int
 236 ufm_do_req(struct ufm_softc *sc, u_int8_t reqtype, u_int8_t request,
 237     u_int16_t value, u_int16_t index, u_int8_t len, void *retbuf)
 238 {
 239         usb_device_request_t req;
 240         usbd_status err;
 241
 242         crit_enter();
 243         req.bmRequestType = reqtype;
 244         req.bRequest = request;
 245         USETW(req.wValue, value);
 246         USETW(req.wIndex, index);
 247         USETW(req.wLength, len);
 248         err = usbd_do_request_flags(sc->sc_udev, &req, retbuf, 0, NULL,
 249             USBD_DEFAULT_TIMEOUT);
 250         crit_exit();
 251         if (err) {
 252                 kprintf("usbd_do_request_flags returned %#x\n", err);
 253                 return (EIO);
 254         }
 255         return (0);
 256 }
 257
 258 static int
 259 ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
 260 {
 261         int freq = *(int *)addr;
 262         u_int8_t ret;
 263
 264         /*
 265          * Freq now is in Hz.  We need to convert it to the frequency
 266          * that the radio wants.  This frequency is 10.7MHz above
 267          * the actual frequency.  We then need to convert to
 268          * units of 12.5kHz.  We add one to the IFM to make rounding
 269          * easier.
 270          */
 271         sc->sc_freq = freq;
 272         freq = (freq + 10700001) / 12500;
 273         /* This appears to set the frequency */
 274         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD_SET_FREQ, freq >> 8,
 275             freq, 1, &ret) != 0)
 276                 return (EIO);
 277         /* Not sure what this does */
 278         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1,
 279             &ret) != 0)
 280                 return (EIO);
 281         return (0);
 282 }
 283
 284 static int
 285 ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
 286 {
 287         int *valp = (int *)addr;
 288         *valp = sc->sc_freq;
 289         return (0);
 290 }
 291
 292 static int
 293 ufm_start(struct ufm_softc *sc, caddr_t addr)
 294 {
 295         u_int8_t ret;
 296
 297         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7,
 298             1, &ret))
 299                 return (EIO);
 300         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
 301             1, &ret))
 302                 return (EIO);
 303         if (ret & 0x1)
 304                 return (EIO);
 305         return (0);
 306 }
 307
 308 static int
 309 ufm_stop(struct ufm_softc *sc, caddr_t addr)
 310 {
 311         u_int8_t ret;
 312
 313         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
 314             1, &ret))
 315                 return (EIO);
 316         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
 317             1, &ret))
 318                 return (EIO);
 319         return (0);
 320 }
 321
 322 static int
 323 ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
 324 {
 325         u_int8_t ret;
 326
 327         /*
 328          * Note, there's a 240ms settle time before the status
 329          * will be valid, so tsleep that amount.  hz/4 is a good
 330          * approximation of that.  Since this is a short sleep
 331          * we don't try to catch any signals to keep things
 332          * simple.
 333          */
 334         tsleep(sc, 0, "ufmwait", hz/4);
 335         if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
 336             1, &ret))
 337                 return (EIO);
 338         *(int *)addr = ret;
 339
 340         return (0);
 341 }
 342
 343 int
 344 ufmioctl(struct dev_ioctl_args *ap)
 345 {
 346         cdev_t dev = ap->a_head.a_dev;
 347         caddr_t addr = ap->a_data;
 348         struct ufm_softc *sc;
 349
 350         int unit = UFMUNIT(dev);
 351         int error = 0;
 352
 353         sc = devclass_get_softc(ufm_devclass, unit);
 354
 355         switch (ap->a_cmd) {
 356         case FM_SET_FREQ:
 357                 error = ufm_set_freq(sc, addr);
 358                 break;
 359         case FM_GET_FREQ:
 360                 error = ufm_get_freq(sc, addr);
 361                 break;
 362         case FM_START:
 363                 error = ufm_start(sc, addr);
 364                 break;
 365         case FM_STOP:
 366                 error = ufm_stop(sc, addr);
 367                 break;
 368         case FM_GET_STAT:
 369                 error = ufm_get_stat(sc, addr);
 370                 break;
 371         default:
 372                 return ENOTTY;
 373                 break;
 374         }
 375         return error;
 376 }
 377
 378 static int
 379 ufm_detach(device_t self)
 380 {
 381         DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
 382         return 0;
 383 }
 384
 385 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);