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
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #if defined(__NetBSD__)
38 #include <sys/device.h>
39 #include <sys/ioctl.h>
40 #elif defined(__FreeBSD__)
41 #include <sys/module.h>
43 #include <sys/ioccom.h>
45 #include <sys/fcntl.h>
46 #include <sys/filio.h>
51 #if __FreeBSD_version >= 500014
52 #include <sys/selinfo.h>
54 #include <sys/select.h>
56 #include <sys/vnode.h>
58 #include <sys/sysctl.h>
60 #include <dev/usb/usb.h>
61 #include <dev/usb/usbdi.h>
62 #include <dev/usb/usbdi_util.h>
64 #include <dev/usb/usbdevs.h>
65 #include <dev/usb/dsbr100io.h>
68 #define DPRINTF(x) if (ufmdebug) logprintf x
69 #define DPRINTFN(n,x) if (ufmdebug>(n)) logprintf x
71 SYSCTL_NODE(_hw_usb, OID_AUTO, ufm, CTLFLAG_RW, 0, "USB ufm");
72 SYSCTL_INT(_hw_usb_ufm, OID_AUTO, debug, CTLFLAG_RW,
73 &ufmdebug, 0, "ufm debug level");
79 #ifdef __FreeBSD_version
80 typedef d_thread_t usb_proc_t;
82 typedef struct proc usb_proc_t;
85 #if defined(__NetBSD__) || defined(__OpenBSD__)
86 typedef struct proc usb_proc_t;
87 int ufmopen(dev_t, int, int, struct proc *);
88 int ufmclose(dev_t, int, int, struct proc *p);
89 int ufmioctl(dev_t, u_long, caddr_t, int, struct proc *);
92 #elif defined(__FreeBSD__)
97 #define UFM_CDEV_MAJOR 200
99 Static struct cdevsw ufm_cdevsw = {
100 ufmopen, ufmclose, noread, nowrite,
101 ufmioctl, nopoll, nommap, nostrategy,
102 "ufm", UFM_CDEV_MAJOR, nodump, nopsize,
104 #if (__FreeBSD_version < 500014)
108 #endif /*defined(__FreeBSD__)*/
111 #define FM_CMD_SET_FREQ 0x01
115 USBBASEDEVICE sc_dev;
116 usbd_device_handle sc_udev;
117 usbd_interface_handle sc_iface;
124 #if defined(__NetBSD__) || defined(__OpenBSD__)
129 #define UFMUNIT(n) (minor(n))
131 USB_DECLARE_DRIVER(ufm);
135 USB_MATCH_START(ufm, uaa);
136 usb_device_descriptor_t *dd;
138 DPRINTFN(10,("ufm_match\n"));
142 dd = usbd_get_device_descriptor(uaa->device);
145 ((UGETW(dd->idVendor) == USB_VENDOR_CYPRESS &&
146 UGETW(dd->idProduct) == USB_PRODUCT_CYPRESS_FMRADIO)))
147 return UMATCH_VENDOR_PRODUCT;
154 USB_ATTACH_START(ufm, sc, uaa);
156 usb_endpoint_descriptor_t *edesc;
157 usbd_device_handle udev;
158 usbd_interface_handle iface;
160 #if defined(__NetBSD__) || defined(__OpenBSD__)
164 char * ermsg = "<none>";
166 DPRINTFN(10,("ufm_attach: sc=%p\n", sc));
167 usbd_devinfo(uaa->device, 0, devinfo);
169 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
171 sc->sc_udev = udev = uaa->device;
173 #if defined(__FreeBSD__)
174 if ((!uaa->device) || (!uaa->iface)) {
175 ermsg = "device or iface";
178 sc->sc_iface = iface = uaa->iface;
179 #elif defined(__NetBSD__) || defined(__OpenBSD__)
184 r = usbd_interface_count(udev, &niface);
189 r = usbd_device2interface_handle(udev, 0, &iface);
194 sc->sc_iface = iface;
199 r = usbd_endpoint_count(iface, &epcount);
200 if (r != USBD_NORMAL_COMPLETION) {
205 edesc = usbd_interface2endpoint_descriptor(iface, 0);
207 ermsg = "interface endpoint";
210 sc->sc_epaddr = edesc->bEndpointAddress;
212 #if defined(__FreeBSD__)
213 /* XXX no error trapping, no storing of dev_t */
214 (void) make_dev(&ufm_cdevsw, device_get_unit(self),
215 UID_ROOT, GID_OPERATOR,
216 0644, "ufm%d", device_get_unit(self));
217 #elif defined(__NetBSD__) || defined(__OpenBSD__)
218 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
222 DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
224 USB_ATTACH_SUCCESS_RETURN;
227 printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
228 USB_ATTACH_ERROR_RETURN;
233 ufmopen(dev_t dev, int flag, int mode, usb_proc_ptr td)
235 struct ufm_softc *sc;
237 int unit = UFMUNIT(dev);
238 USB_GET_SC_OPEN(ufm, unit, sc);
240 DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n",
246 if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
254 ufmclose(dev_t dev, int flag, int mode, usb_proc_ptr td)
256 struct ufm_softc *sc;
258 int unit = UFMUNIT(dev);
259 USB_GET_SC(ufm, unit, sc);
261 DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
268 ufm_do_req(struct ufm_softc *sc, u_int8_t reqtype, u_int8_t request,
269 u_int16_t value, u_int16_t index, u_int8_t len, void *retbuf)
272 usb_device_request_t req;
276 req.bmRequestType = reqtype;
277 req.bRequest = request;
278 USETW(req.wValue, value);
279 USETW(req.wIndex, index);
280 USETW(req.wLength, len);
281 err = usbd_do_request_flags(sc->sc_udev, &req, retbuf, 0, NULL,
282 USBD_DEFAULT_TIMEOUT);
285 printf("usbd_do_request_flags returned %#x\n", err);
292 ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
294 int freq = *(int *)addr;
298 * Freq now is in Hz. We need to convert it to the frequency
299 * that the radio wants. This frequency is 10.7MHz above
300 * the actual frequency. We then need to convert to
301 * units of 12.5kHz. We add one to the IFM to make rounding
305 freq = (freq + 10700001) / 12500;
306 /* This appears to set the frequency */
307 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD_SET_FREQ, freq >> 8,
310 /* Not sure what this does */
311 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1,
318 ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
320 int *valp = (int *)addr;
326 ufm_start(struct ufm_softc *sc, caddr_t addr)
330 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7,
333 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
342 ufm_stop(struct ufm_softc *sc, caddr_t addr)
346 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
349 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
356 ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
361 * Note, there's a 240ms settle time before the status
362 * will be valid, so tsleep that amount. hz/4 is a good
363 * approximation of that. Since this is a short sleep
364 * we don't try to catch any signals to keep things
367 tsleep(sc, 0, "ufmwait", hz/4);
368 if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
377 ufmioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr td)
379 struct ufm_softc *sc;
381 int unit = UFMUNIT(dev);
384 USB_GET_SC(ufm, unit, sc);
388 error = ufm_set_freq(sc, addr);
391 error = ufm_get_freq(sc, addr);
394 error = ufm_start(sc, addr);
397 error = ufm_stop(sc, addr);
400 error = ufm_get_stat(sc, addr);
410 #if defined(__NetBSD__) || defined(__OpenBSD__)
412 ufm_activate(device_ptr_t self, enum devact act)
414 struct ufm_softc *sc = (struct ufm_softc *)self;
421 case DVACT_DEACTIVATE:
430 USB_DETACH_START(ufm, sc);
431 struct ufm_endpoint *sce;
434 #if defined(__NetBSD__) || defined(__OpenBSD__)
437 DPRINTF(("ufm_detach: sc=%p flags=%d\n", sc, flags));
438 #elif defined(__FreeBSD__)
439 DPRINTF(("ufm_detach: sc=%p\n", sc));
445 if (--sc->sc_refcnt >= 0) {
446 /* Wait for processes to go away. */
447 usb_detach_wait(USBDEV(sc->sc_dev));
451 #if defined(__NetBSD__) || defined(__OpenBSD__)
452 /* locate the major number */
453 for (maj = 0; maj < nchrdev; maj++)
454 if (cdevsw[maj].d_open == ufmopen)
457 /* Nuke the vnodes for any open instances (calls close). */
458 mn = self->dv_unit * USB_MAX_ENDPOINTS;
459 vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
460 #elif defined(__FreeBSD__)
461 /* XXX not implemented yet */
464 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
469 #endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
471 #if defined(__FreeBSD__)
473 ufm_detach(device_t self)
475 DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
479 DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);