2 * Copyright (c) 2001 M. Warner Losh
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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
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.12 2006/12/22 23:26:25 swildner Exp $
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #if defined(__NetBSD__)
41 #include <sys/device.h>
42 #include <sys/ioctl.h>
43 #elif defined(__FreeBSD__) || defined(__DragonFly__)
44 #include <sys/module.h>
46 #include <sys/ioccom.h>
48 #include <sys/fcntl.h>
49 #include <sys/filio.h>
54 #if defined(__FreeBSD__) && __FreeBSD_version >= 500014
55 #include <sys/selinfo.h>
57 #include <sys/select.h>
59 #include <sys/vnode.h>
61 #include <sys/sysctl.h>
62 #include <sys/thread2.h>
64 #include <bus/usb/usb.h>
65 #include <bus/usb/usbdi.h>
66 #include <bus/usb/usbdi_util.h>
68 #include <bus/usb/usbdevs.h>
69 #include <bus/usb/dsbr100io.h>
72 #define DPRINTF(x) if (ufmdebug) logprintf x
73 #define DPRINTFN(n,x) if (ufmdebug>(n)) logprintf x
75 SYSCTL_NODE(_hw_usb, OID_AUTO, ufm, CTLFLAG_RW, 0, "USB ufm");
76 SYSCTL_INT(_hw_usb_ufm, OID_AUTO, debug, CTLFLAG_RW,
77 &ufmdebug, 0, "ufm debug level");
83 #if defined(__NetBSD__) || defined(__OpenBSD__)
84 int ufmopen(cdev_t, int, int, usb_proc_ptr);
85 int ufmclose(cdev_t, int, int, usb_proc_ptr);
86 int ufmioctl(cdev_t, u_long, caddr_t, int, usb_proc_ptr);
89 #elif defined(__FreeBSD__) || defined(__DragonFly__)
94 #define UFM_CDEV_MAJOR 200
96 Static struct dev_ops ufm_ops = {
97 { "ufm", UFM_CDEV_MAJOR, 0 },
102 #endif /*defined(__FreeBSD__)*/
105 #define FM_CMD_SET_FREQ 0x01
109 USBBASEDEVICE sc_dev;
110 usbd_device_handle sc_udev;
111 usbd_interface_handle sc_iface;
118 #if defined(__NetBSD__) || defined(__OpenBSD__)
123 #define UFMUNIT(n) (minor(n))
125 USB_DECLARE_DRIVER(ufm);
129 USB_MATCH_START(ufm, uaa);
130 usb_device_descriptor_t *dd;
132 DPRINTFN(10,("ufm_match\n"));
136 dd = usbd_get_device_descriptor(uaa->device);
139 ((UGETW(dd->idVendor) == USB_VENDOR_CYPRESS &&
140 UGETW(dd->idProduct) == USB_PRODUCT_CYPRESS_FMRADIO)))
141 return UMATCH_VENDOR_PRODUCT;
148 USB_ATTACH_START(ufm, sc, uaa);
150 usb_endpoint_descriptor_t *edesc;
151 usbd_device_handle udev;
152 usbd_interface_handle iface;
154 #if defined(__NetBSD__) || defined(__OpenBSD__)
158 char * ermsg = "<none>";
160 DPRINTFN(10,("ufm_attach: sc=%p\n", sc));
161 usbd_devinfo(uaa->device, 0, devinfo);
163 kprintf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
165 sc->sc_udev = udev = uaa->device;
167 #if defined(__FreeBSD__) || defined(__DragonFly__)
168 if ((!uaa->device) || (!uaa->iface)) {
169 ermsg = "device or iface";
172 sc->sc_iface = iface = uaa->iface;
173 #elif defined(__NetBSD__) || defined(__OpenBSD__)
178 r = usbd_interface_count(udev, &niface);
183 r = usbd_device2interface_handle(udev, 0, &iface);
188 sc->sc_iface = iface;
193 r = usbd_endpoint_count(iface, &epcount);
194 if (r != USBD_NORMAL_COMPLETION) {
199 edesc = usbd_interface2endpoint_descriptor(iface, 0);
201 ermsg = "interface endpoint";
204 sc->sc_epaddr = edesc->bEndpointAddress;
206 #if defined(__FreeBSD__) || defined(__DragonFly__)
207 /* XXX no error trapping, no storing of cdev_t */
208 dev_ops_add(&ufm_ops, -1, device_get_unit(self));
209 make_dev(&ufm_ops, device_get_unit(self),
210 UID_ROOT, GID_OPERATOR,
211 0644, "ufm%d", device_get_unit(self));
212 #elif defined(__NetBSD__) || defined(__OpenBSD__)
213 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
217 DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
219 USB_ATTACH_SUCCESS_RETURN;
222 kprintf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
223 USB_ATTACH_ERROR_RETURN;
228 ufmopen(struct dev_open_args *ap)
230 cdev_t dev = ap->a_head.a_dev;
231 struct ufm_softc *sc;
233 int unit = UFMUNIT(dev);
234 USB_GET_SC_OPEN(ufm, unit, sc);
236 DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
237 ap->a_oflags, ap->a_devtype, unit));
242 if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
250 ufmclose(struct dev_close_args *ap)
252 cdev_t dev = ap->a_head.a_dev;
253 struct ufm_softc *sc;
255 int unit = UFMUNIT(dev);
256 USB_GET_SC(ufm, unit, sc);
258 DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n",
259 ap->a_fflag, ap->a_devtype, unit));
266 ufm_do_req(struct ufm_softc *sc, u_int8_t reqtype, u_int8_t request,
267 u_int16_t value, u_int16_t index, u_int8_t len, void *retbuf)
269 usb_device_request_t req;
273 req.bmRequestType = reqtype;
274 req.bRequest = request;
275 USETW(req.wValue, value);
276 USETW(req.wIndex, index);
277 USETW(req.wLength, len);
278 err = usbd_do_request_flags(sc->sc_udev, &req, retbuf, 0, NULL,
279 USBD_DEFAULT_TIMEOUT);
282 kprintf("usbd_do_request_flags returned %#x\n", err);
289 ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
291 int freq = *(int *)addr;
295 * Freq now is in Hz. We need to convert it to the frequency
296 * that the radio wants. This frequency is 10.7MHz above
297 * the actual frequency. We then need to convert to
298 * units of 12.5kHz. We add one to the IFM to make rounding
302 freq = (freq + 10700001) / 12500;
303 /* This appears to set the frequency */
304 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD_SET_FREQ, freq >> 8,
307 /* Not sure what this does */
308 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1,
315 ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
317 int *valp = (int *)addr;
323 ufm_start(struct ufm_softc *sc, caddr_t addr)
327 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7,
330 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
339 ufm_stop(struct ufm_softc *sc, caddr_t addr)
343 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
346 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
353 ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
358 * Note, there's a 240ms settle time before the status
359 * will be valid, so tsleep that amount. hz/4 is a good
360 * approximation of that. Since this is a short sleep
361 * we don't try to catch any signals to keep things
364 tsleep(sc, 0, "ufmwait", hz/4);
365 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
374 ufmioctl(struct dev_ioctl_args *ap)
376 cdev_t dev = ap->a_head.a_dev;
377 caddr_t addr = ap->a_data;
378 struct ufm_softc *sc;
380 int unit = UFMUNIT(dev);
383 USB_GET_SC(ufm, unit, sc);
387 error = ufm_set_freq(sc, addr);
390 error = ufm_get_freq(sc, addr);
393 error = ufm_start(sc, addr);
396 error = ufm_stop(sc, addr);
399 error = ufm_get_stat(sc, addr);
409 #if defined(__NetBSD__) || defined(__OpenBSD__)
411 ufm_activate(device_ptr_t self, enum devact act)
413 struct ufm_softc *sc = (struct ufm_softc *)self;
420 case DVACT_DEACTIVATE:
429 USB_DETACH_START(ufm, sc);
430 struct ufm_endpoint *sce;
432 #if defined(__NetBSD__) || defined(__OpenBSD__)
435 DPRINTF(("ufm_detach: sc=%p flags=%d\n", sc, flags));
436 #elif defined(__FreeBSD__) || defined(__DragonFly__)
437 DPRINTF(("ufm_detach: sc=%p\n", sc));
443 if (--sc->sc_refcnt >= 0) {
444 /* Wait for processes to go away. */
445 usb_detach_wait(USBDEV(sc->sc_dev));
449 #if defined(__NetBSD__) || defined(__OpenBSD__)
450 /* locate the major number */
451 for (maj = 0; maj < nchrdev; maj++)
452 if (cdevsw[maj].d_open == ufmopen)
455 /* Nuke the vnodes for any open instances (calls close). */
456 mn = self->dv_unit * USB_MAX_ENDPOINTS;
457 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
458 #elif defined(__FreeBSD__) || defined(__DragonFly__)
459 /* XXX not implemented yet */
462 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
467 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
469 #if defined(__FreeBSD__) || defined(__DragonFly__)
471 ufm_detach(device_t self)
473 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
477 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);