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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 #include <sys/stdint.h>
36 #include <sys/stddef.h>
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/types.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
43 #include <sys/linker_set.h>
44 #include <sys/module.h>
46 #include <sys/mutex.h>
47 #include <sys/condvar.h>
48 #include <sys/sysctl.h>
50 #include <sys/unistd.h>
51 #include <sys/callout.h>
52 #include <sys/malloc.h>
55 #include <sys/fcntl.h>
57 #include <dev/usb/usb.h>
58 #include <dev/usb/usbdi.h>
61 #define USB_DEBUG_VAR usb_debug
62 #include <dev/usb/usb_debug.h>
64 #include <dev/usb/ufm_ioctl.h>
67 #define UFM_CMD_SET_FREQ 0x01
71 struct usb_fifo_sc sc_fifo;
74 struct usb_device *sc_udev;
84 static device_probe_t ufm_probe;
85 static device_attach_t ufm_attach;
86 static device_detach_t ufm_detach;
88 static usb_fifo_ioctl_t ufm_ioctl;
89 static usb_fifo_open_t ufm_open;
91 static struct usb_fifo_methods ufm_fifo_methods = {
92 .f_ioctl = &ufm_ioctl,
97 static int ufm_do_req(struct ufm_softc *, uint8_t, uint16_t, uint16_t,
99 static int ufm_set_freq(struct ufm_softc *, void *);
100 static int ufm_get_freq(struct ufm_softc *, void *);
101 static int ufm_start(struct ufm_softc *, void *);
102 static int ufm_stop(struct ufm_softc *, void *);
103 static int ufm_get_stat(struct ufm_softc *, void *);
105 static devclass_t ufm_devclass;
107 static device_method_t ufm_methods[] = {
108 DEVMETHOD(device_probe, ufm_probe),
109 DEVMETHOD(device_attach, ufm_attach),
110 DEVMETHOD(device_detach, ufm_detach),
114 static driver_t ufm_driver = {
116 .methods = ufm_methods,
117 .size = sizeof(struct ufm_softc),
120 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, NULL, 0);
121 MODULE_DEPEND(ufm, usb, 1, 1, 1);
124 ufm_probe(device_t dev)
126 struct usb_attach_arg *uaa = device_get_ivars(dev);
128 if (uaa->usb_mode != USB_MODE_HOST) {
131 if ((uaa->info.idVendor == USB_VENDOR_CYPRESS) &&
132 (uaa->info.idProduct == USB_PRODUCT_CYPRESS_FMRADIO)) {
139 ufm_attach(device_t dev)
141 struct usb_attach_arg *uaa = device_get_ivars(dev);
142 struct ufm_softc *sc = device_get_softc(dev);
145 sc->sc_udev = uaa->device;
146 sc->sc_unit = device_get_unit(dev);
148 snprintf(sc->sc_name, sizeof(sc->sc_name), "%s",
149 device_get_nameunit(dev));
151 mtx_init(&sc->sc_mtx, "ufm lock", NULL, MTX_DEF | MTX_RECURSE);
153 device_set_usb_desc(dev);
155 error = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx,
156 &ufm_fifo_methods, &sc->sc_fifo,
157 device_get_unit(dev), 0 - 1, uaa->info.bIfaceIndex,
158 UID_ROOT, GID_OPERATOR, 0644);
162 return (0); /* success */
170 ufm_detach(device_t dev)
172 struct ufm_softc *sc = device_get_softc(dev);
174 usb_fifo_detach(&sc->sc_fifo);
176 mtx_destroy(&sc->sc_mtx);
182 ufm_open(struct usb_fifo *dev, int fflags)
184 if ((fflags & (FWRITE | FREAD)) != (FWRITE | FREAD)) {
191 ufm_do_req(struct ufm_softc *sc, uint8_t request,
192 uint16_t value, uint16_t index, uint8_t *retbuf)
196 struct usb_device_request req;
199 req.bmRequestType = UT_READ_VENDOR_DEVICE;
200 req.bRequest = request;
201 USETW(req.wValue, value);
202 USETW(req.wIndex, index);
203 USETW(req.wLength, 1);
205 error = usbd_do_request(sc->sc_udev, NULL, &req, buf);
217 ufm_set_freq(struct ufm_softc *sc, void *addr)
219 int freq = *(int *)addr;
222 * Freq now is in Hz. We need to convert it to the frequency
223 * that the radio wants. This frequency is 10.7MHz above
224 * the actual frequency. We then need to convert to
225 * units of 12.5kHz. We add one to the IFM to make rounding
228 mtx_lock(&sc->sc_mtx);
230 mtx_unlock(&sc->sc_mtx);
232 freq = (freq + 10700001) / 12500;
234 /* This appears to set the frequency */
235 if (ufm_do_req(sc, UFM_CMD_SET_FREQ,
236 freq >> 8, freq, NULL) != 0) {
239 /* Not sure what this does */
240 if (ufm_do_req(sc, UFM_CMD0,
241 0x96, 0xb7, NULL) != 0) {
248 ufm_get_freq(struct ufm_softc *sc, void *addr)
250 int *valp = (int *)addr;
252 mtx_lock(&sc->sc_mtx);
254 mtx_unlock(&sc->sc_mtx);
259 ufm_start(struct ufm_softc *sc, void *addr)
263 if (ufm_do_req(sc, UFM_CMD0,
267 if (ufm_do_req(sc, UFM_CMD2,
278 ufm_stop(struct ufm_softc *sc, void *addr)
280 if (ufm_do_req(sc, UFM_CMD0,
284 if (ufm_do_req(sc, UFM_CMD2,
292 ufm_get_stat(struct ufm_softc *sc, void *addr)
297 * Note, there's a 240ms settle time before the status
298 * will be valid, so sleep that amount.
300 usb_pause_mtx(NULL, hz / 4);
302 if (ufm_do_req(sc, UFM_CMD0,
312 ufm_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr,
315 struct ufm_softc *sc = usb_fifo_softc(fifo);
320 error = ufm_set_freq(sc, addr);
323 error = ufm_get_freq(sc, addr);
326 error = ufm_start(sc, addr);
329 error = ufm_stop(sc, addr);
332 error = ufm_get_stat(sc, addr);