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.23 2007/11/06 07:37:01 hasso Exp $
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>
42 #include <sys/ioccom.h>
43 #include <sys/fcntl.h>
44 #include <sys/filio.h>
49 #include <sys/select.h>
51 #include <sys/sysctl.h>
52 #include <sys/thread2.h>
54 #include <bus/usb/usb.h>
55 #include <bus/usb/usbdi.h>
56 #include <bus/usb/usbdi_util.h>
58 #include <bus/usb/dsbr100io.h>
61 #define DPRINTF(x) if (ufmdebug) kprintf x
62 #define DPRINTFN(n,x) if (ufmdebug>(n)) kprintf x
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");
76 #define UFM_CDEV_MAJOR 200
78 static struct dev_ops ufm_ops = {
79 { "ufm", UFM_CDEV_MAJOR, 0 },
86 #define FM_CMD_SET_FREQ 0x01
91 usbd_device_handle sc_udev;
92 usbd_interface_handle sc_iface;
101 #define UFMUNIT(n) (minor(n))
103 static device_probe_t ufm_match;
104 static device_attach_t ufm_attach;
105 static device_detach_t ufm_detach;
107 static devclass_t ufm_devclass;
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),
116 static driver_t ufm_driver = {
119 sizeof(struct ufm_softc)
122 MODULE_DEPEND(ufm, usb, 1, 1, 1);
125 ufm_match(device_t self)
127 struct usb_attach_arg *uaa = device_get_ivars(self);
128 usb_device_descriptor_t *dd;
130 DPRINTFN(10,("ufm_match\n"));
134 dd = usbd_get_device_descriptor(uaa->device);
137 ((UGETW(dd->idVendor) == 0x04b4 && UGETW(dd->idProduct) == 0x1002)))
138 return UMATCH_VENDOR_PRODUCT;
144 ufm_attach(device_t self)
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;
153 char * ermsg = "<none>";
155 DPRINTFN(10,("ufm_attach: sc=%p\n", sc));
157 sc->sc_udev = udev = uaa->device;
159 if ((!uaa->device) || (!uaa->iface)) {
160 ermsg = "device or iface";
163 sc->sc_iface = iface = uaa->iface;
167 r = usbd_endpoint_count(iface, &epcount);
168 if (r != USBD_NORMAL_COMPLETION) {
173 edesc = usbd_interface2endpoint_descriptor(iface, 0);
175 ermsg = "interface endpoint";
178 sc->sc_epaddr = edesc->bEndpointAddress;
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));
186 DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
191 kprintf("%s: could not find %s\n", device_get_nameunit(sc->sc_dev),ermsg);
197 ufmopen(struct dev_open_args *ap)
199 cdev_t dev = ap->a_head.a_dev;
200 struct ufm_softc *sc;
202 int unit = UFMUNIT(dev);
203 sc = devclass_get_softc(ufm_devclass, unit);
207 DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
208 ap->a_oflags, ap->a_devtype, unit));
213 if ((ap->a_oflags & (FWRITE|FREAD)) != (FWRITE|FREAD))
221 ufmclose(struct dev_close_args *ap)
223 cdev_t dev = ap->a_head.a_dev;
224 struct ufm_softc *sc;
226 int unit = UFMUNIT(dev);
227 sc = devclass_get_softc(ufm_devclass, unit);
229 DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n",
230 ap->a_fflag, ap->a_devtype, unit));
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)
240 usb_device_request_t req;
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);
253 kprintf("usbd_do_request_flags returned %#x\n", err);
260 ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
262 int freq = *(int *)addr;
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
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,
278 /* Not sure what this does */
279 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1,
286 ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
288 int *valp = (int *)addr;
294 ufm_start(struct ufm_softc *sc, caddr_t addr)
298 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7,
301 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
310 ufm_stop(struct ufm_softc *sc, caddr_t addr)
314 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
317 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
324 ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
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
335 tsleep(sc, 0, "ufmwait", hz/4);
336 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
345 ufmioctl(struct dev_ioctl_args *ap)
347 cdev_t dev = ap->a_head.a_dev;
348 caddr_t addr = ap->a_data;
349 struct ufm_softc *sc;
351 int unit = UFMUNIT(dev);
354 sc = devclass_get_softc(ufm_devclass, unit);
358 error = ufm_set_freq(sc, addr);
361 error = ufm_get_freq(sc, addr);
364 error = ufm_start(sc, addr);
367 error = ufm_stop(sc, addr);
370 error = ufm_get_stat(sc, addr);
380 ufm_detach(device_t self)
382 DPRINTF(("%s: disconnected\n", device_get_nameunit(self)));
386 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);