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.20 2007/08/07 10:42:40 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/usbdevs.h>
59 #include <bus/usb/dsbr100io.h>
62 #define DPRINTF(x) if (ufmdebug) kprintf x
63 #define DPRINTFN(n,x) if (ufmdebug>(n)) kprintf x
65 SYSCTL_NODE(_hw_usb
, OID_AUTO
, ufm
, CTLFLAG_RW
, 0, "USB ufm");
66 SYSCTL_INT(_hw_usb_ufm
, OID_AUTO
, debug
, CTLFLAG_RW
,
67 &ufmdebug
, 0, "ufm debug level");
77 #define UFM_CDEV_MAJOR 200
79 static struct dev_ops ufm_ops
= {
80 { "ufm", UFM_CDEV_MAJOR
, 0 },
87 #define FM_CMD_SET_FREQ 0x01
92 usbd_device_handle sc_udev
;
93 usbd_interface_handle sc_iface
;
102 #define UFMUNIT(n) (minor(n))
104 static device_probe_t ufm_match
;
105 static device_attach_t ufm_attach
;
106 static device_detach_t ufm_detach
;
108 static devclass_t ufm_devclass
;
110 static kobj_method_t ufm_methods
[] = {
111 DEVMETHOD(device_probe
, ufm_match
),
112 DEVMETHOD(device_attach
, ufm_attach
),
113 DEVMETHOD(device_detach
, ufm_detach
),
117 static driver_t ufm_driver
= {
120 sizeof(struct ufm_softc
)
123 MODULE_DEPEND(ufm
, usb
, 1, 1, 1);
126 ufm_match(device_t self
)
128 struct usb_attach_arg
*uaa
= device_get_ivars(self
);
129 usb_device_descriptor_t
*dd
;
131 DPRINTFN(10,("ufm_match\n"));
135 dd
= usbd_get_device_descriptor(uaa
->device
);
138 ((UGETW(dd
->idVendor
) == USB_VENDOR_CYPRESS
&&
139 UGETW(dd
->idProduct
) == USB_PRODUCT_CYPRESS_FMRADIO
)))
140 return UMATCH_VENDOR_PRODUCT
;
146 ufm_attach(device_t self
)
148 struct ufm_softc
*sc
= device_get_softc(self
);
149 struct usb_attach_arg
*uaa
= device_get_ivars(self
);
151 usb_endpoint_descriptor_t
*edesc
;
152 usbd_device_handle udev
;
153 usbd_interface_handle iface
;
156 char * ermsg
= "<none>";
158 DPRINTFN(10,("ufm_attach: sc=%p\n", sc
));
159 usbd_devinfo(uaa
->device
, 0, devinfo
);
161 device_set_desc_copy(self
, devinfo
);
162 kprintf("%s: %s\n", device_get_nameunit(sc
->sc_dev
), devinfo
);
164 sc
->sc_udev
= udev
= uaa
->device
;
166 if ((!uaa
->device
) || (!uaa
->iface
)) {
167 ermsg
= "device or iface";
170 sc
->sc_iface
= iface
= uaa
->iface
;
174 r
= usbd_endpoint_count(iface
, &epcount
);
175 if (r
!= USBD_NORMAL_COMPLETION
) {
180 edesc
= usbd_interface2endpoint_descriptor(iface
, 0);
182 ermsg
= "interface endpoint";
185 sc
->sc_epaddr
= edesc
->bEndpointAddress
;
187 /* XXX no error trapping, no storing of cdev_t */
188 dev_ops_add(&ufm_ops
, -1, device_get_unit(self
));
189 make_dev(&ufm_ops
, device_get_unit(self
),
190 UID_ROOT
, GID_OPERATOR
,
191 0644, "ufm%d", device_get_unit(self
));
193 DPRINTFN(10, ("ufm_attach: %p\n", sc
->sc_udev
));
198 kprintf("%s: could not find %s\n", device_get_nameunit(sc
->sc_dev
),ermsg
);
204 ufmopen(struct dev_open_args
*ap
)
206 cdev_t dev
= ap
->a_head
.a_dev
;
207 struct ufm_softc
*sc
;
209 int unit
= UFMUNIT(dev
);
210 sc
= devclass_get_softc(ufm_devclass
, unit
);
214 DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
215 ap
->a_oflags
, ap
->a_devtype
, unit
));
220 if ((ap
->a_oflags
& (FWRITE
|FREAD
)) != (FWRITE
|FREAD
))
228 ufmclose(struct dev_close_args
*ap
)
230 cdev_t dev
= ap
->a_head
.a_dev
;
231 struct ufm_softc
*sc
;
233 int unit
= UFMUNIT(dev
);
234 sc
= devclass_get_softc(ufm_devclass
, unit
);
236 DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n",
237 ap
->a_fflag
, ap
->a_devtype
, unit
));
244 ufm_do_req(struct ufm_softc
*sc
, u_int8_t reqtype
, u_int8_t request
,
245 u_int16_t value
, u_int16_t index
, u_int8_t len
, void *retbuf
)
247 usb_device_request_t req
;
251 req
.bmRequestType
= reqtype
;
252 req
.bRequest
= request
;
253 USETW(req
.wValue
, value
);
254 USETW(req
.wIndex
, index
);
255 USETW(req
.wLength
, len
);
256 err
= usbd_do_request_flags(sc
->sc_udev
, &req
, retbuf
, 0, NULL
,
257 USBD_DEFAULT_TIMEOUT
);
260 kprintf("usbd_do_request_flags returned %#x\n", err
);
267 ufm_set_freq(struct ufm_softc
*sc
, caddr_t addr
)
269 int freq
= *(int *)addr
;
273 * Freq now is in Hz. We need to convert it to the frequency
274 * that the radio wants. This frequency is 10.7MHz above
275 * the actual frequency. We then need to convert to
276 * units of 12.5kHz. We add one to the IFM to make rounding
280 freq
= (freq
+ 10700001) / 12500;
281 /* This appears to set the frequency */
282 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD_SET_FREQ
, freq
>> 8,
285 /* Not sure what this does */
286 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD0
, 0x96, 0xb7, 1,
293 ufm_get_freq(struct ufm_softc
*sc
, caddr_t addr
)
295 int *valp
= (int *)addr
;
301 ufm_start(struct ufm_softc
*sc
, caddr_t addr
)
305 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD0
, 0x00, 0xc7,
308 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD2
, 0x01, 0x00,
317 ufm_stop(struct ufm_softc
*sc
, caddr_t addr
)
321 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD0
, 0x16, 0x1C,
324 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD2
, 0x00, 0x00,
331 ufm_get_stat(struct ufm_softc
*sc
, caddr_t addr
)
336 * Note, there's a 240ms settle time before the status
337 * will be valid, so tsleep that amount. hz/4 is a good
338 * approximation of that. Since this is a short sleep
339 * we don't try to catch any signals to keep things
342 tsleep(sc
, 0, "ufmwait", hz
/4);
343 if (ufm_do_req(sc
, UT_READ_VENDOR_DEVICE
, FM_CMD0
, 0x00, 0x24,
352 ufmioctl(struct dev_ioctl_args
*ap
)
354 cdev_t dev
= ap
->a_head
.a_dev
;
355 caddr_t addr
= ap
->a_data
;
356 struct ufm_softc
*sc
;
358 int unit
= UFMUNIT(dev
);
361 sc
= devclass_get_softc(ufm_devclass
, unit
);
365 error
= ufm_set_freq(sc
, addr
);
368 error
= ufm_get_freq(sc
, addr
);
371 error
= ufm_start(sc
, addr
);
374 error
= ufm_stop(sc
, addr
);
377 error
= ufm_get_stat(sc
, addr
);
387 ufm_detach(device_t self
)
389 DPRINTF(("%s: disconnected\n", device_get_nameunit(self
)));
393 DRIVER_MODULE(ufm
, uhub
, ufm_driver
, ufm_devclass
, usbd_driver_load
, 0);