Support for USB fm radio.

Submitted by: David Yeske <dyeske@yahoo.com>

sys/boot/forth/loader.conf

@@ -222,6 +222,7 @@ snd_load="NO"			# All sound drivers
 usb_load="NO"			# USB subsystem
 udbp_load="NO"			# USB double bulk pipe host 2 host cables
 ugen_load="NO"			# USB generic device, if all else fails ...
+ufm_load="NO"			# Fm Radio
 uhid_load="NO"			# Human Interface Devices
 ukbd_load="NO"			# Keyboard
 ulpt_load="NO"			# Printer

sys/conf/NOTES

@@ -2853,6 +2853,8 @@ device		ums
 device		urio
 # USB scanners
 device		uscanner
+# USB Fm Radio
+device		ufm
 #
 # ADMtek USB ethernet. Supports the LinkSys USB100TX,
 # the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX

sys/conf/majors

@@ -182,6 +182,7 @@ chrdev	name		comments
 164	iir		Intel Integrated RAID <boji.t.kannanthanam@intel.com>
 165	net		Network drivers <jlemon>
 166	ciss		Compaq SmartArray 5* adapter <msmith>
+167	ufm		USB Fm Radio
 200	??		entries from 200-252 are reserved for local use
 252	??		entries from 200-252 are reserved for local use
 254	internal	Used internally by the kernel

sys/dev/usb/FILES

@@ -7,6 +7,7 @@ Makefile		to install .h files
 Makefile.usbdevs	to run devlist2h.awk
 TODO			just a list of things to do
 devlist2h.awk		script to generate usbdevs*.h
+dsbr100io.h		API for ufm.c
 files.usb		config include file
 hid.c			subroutines to parse and access HID data
 hid.h			API for hid.c
@@ -22,6 +23,7 @@ ohcireg.h		Hardware definitions for OHCI
 ohcivar.h		API for ohci.c
 uaudio.c		USB audio class driver
 uaudioreg.h		  and definitions for it
+ufm.c			USB fm radio driver
 [Merged] ugen.c		generic driver that can handle access to any USB device
 uhci.c			Host controller driver for UHCI
 uhcireg.h		Hardware definitions for UHCI

sys/dev/usb/dsbr100io.h

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2001 M. Warner Losh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions, and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson.
+ * This code includes software developed by the NetBSD Foundation, Inc. and
+ * its contributors.
+ */
+
+/*  $FreeBSD$ */
+
+#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
+#include <sys/ioccom.h>
+#endif
+
+#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
+#define FM_SET_FREQ	_IOWR('U', 200, int)
+#define FM_GET_FREQ	_IOWR('U', 201, int)
+#define FM_START	_IOWR('U', 202, int)
+#define FM_STOP		_IOWR('U', 203, int)
+#define FM_GET_STAT	_IOWR('U', 204, int)
+#else
+#define FM_SET_FREQ		0x1
+#define FM_GET_FREQ		0x2
+#define FM_START		0x3
+#define FM_STOP			0x4
+#define FM_GET_STAT		0x5
+#endif

sys/dev/usb/ufm.c

@@ -0,0 +1,475 @@
+/*
+ * Copyright (c) 2001 M. Warner Losh
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions, and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson.
+ * This code includes software developed by the NetBSD Foundation, Inc. and
+ * its contributors.
+ */
+
+/* $FreeBSD$ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/kernel.h>
+#include <sys/malloc.h>
+#if defined(__NetBSD__)
+#include <sys/device.h>
+#include <sys/ioctl.h>
+#elif defined(__FreeBSD__)
+#include <sys/module.h>
+#include <sys/bus.h>
+#include <sys/ioccom.h>
+#endif
+#include <sys/fcntl.h>
+#include <sys/filio.h>
+#include <sys/conf.h>
+#include <sys/uio.h>
+#include <sys/tty.h>
+#include <sys/file.h>
+#if __FreeBSD_version >= 500014
+#include <sys/selinfo.h>
+#else
+#include <sys/select.h>
+#endif
+#include <sys/vnode.h>
+#include <sys/poll.h>
+
+#include <dev/usb/usb.h>
+#include <dev/usb/usbdi.h>
+#include <dev/usb/usbdi_util.h>
+
+#include <dev/usb/usbdevs.h>
+#include <dev/usb/dsbr100io.h>
+
+#ifdef UFM_DEBUG
+#define DPRINTF(x)	if (ufmdebug) logprintf x
+#define DPRINTFN(n,x)	if (ufmdebug>(n)) logprintf x
+int	ufmdebug = 100;
+#else
+#define DPRINTF(x)
+#define DPRINTFN(n,x)
+#endif
+
+#if defined(__FreeBSD__) && __FreeBSD_version__ >= 500023
+typedef struct thread usb_proc_t;
+#else
+typedef struct proc usb_proc_t;
+#endif
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+typedef struct proc usb_proc_t;
+int ufmopen(dev_t, int, int, struct proc *);
+int ufmclose(dev_t, int, int, struct proc *p);
+int ufmioctl(dev_t, u_long, caddr_t, int, struct proc *);
+
+cdev_decl(ufm);
+#elif defined(__FreeBSD__)
+d_open_t  ufmopen;
+d_close_t ufmclose;
+d_ioctl_t ufmioctl;
+
+#define UFM_CDEV_MAJOR	200
+
+Static struct cdevsw ufm_cdevsw = {
+	ufmopen,	ufmclose,	noread,		nowrite,
+ 	ufmioctl,	nopoll,		nommap,		nostrategy,
+ 	"ufm",		UFM_CDEV_MAJOR,	nodump,		nopsize,
+ 	0,
+#if (__FreeBSD__ < 5)
+ 	-1
+#endif
+};
+#endif  /*defined(__FreeBSD__)*/
+
+#define FM_CMD0		0x00
+#define FM_CMD_SET_FREQ	0x01
+#define FM_CMD2		0x02
+
+struct ufm_softc {
+ 	USBBASEDEVICE sc_dev;
+	usbd_device_handle sc_udev;
+	usbd_interface_handle sc_iface;
+
+	int sc_opened;
+	int sc_epaddr;
+	int sc_freq;
+
+	int sc_refcnt;
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	u_char sc_dying;
+#endif
+};
+
+#define UFMUNIT(n) (minor(n))
+
+USB_DECLARE_DRIVER(ufm);
+
+USB_MATCH(ufm)
+{
+	USB_MATCH_START(ufm, uaa);
+	usb_device_descriptor_t *dd;
+
+	DPRINTFN(10,("ufm_match\n"));
+	if (!uaa->iface)
+		return UMATCH_NONE;
+
+	dd = usbd_get_device_descriptor(uaa->device);
+
+	if (dd &&
+	    ((UGETW(dd->idVendor) == USB_VENDOR_CYPRESS &&
+	    UGETW(dd->idProduct) == USB_PRODUCT_CYPRESS_FMRADIO)))
+		return UMATCH_VENDOR_PRODUCT;
+	else
+		return UMATCH_NONE;
+}
+
+USB_ATTACH(ufm)
+{
+	USB_ATTACH_START(ufm, sc, uaa);
+	char devinfo[1024];
+	usb_endpoint_descriptor_t *edesc;
+	usbd_device_handle udev;
+	usbd_interface_handle iface;
+	u_int8_t epcount;
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	u_int8_t niface;
+#endif
+	usbd_status r;
+	char * ermsg = "<none>";
+
+	DPRINTFN(10,("ufm_attach: sc=%p\n", sc));	
+	usbd_devinfo(uaa->device, 0, devinfo);
+	USB_ATTACH_SETUP;
+	printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
+
+	sc->sc_udev = udev = uaa->device;
+
+#if defined(__FreeBSD__)
+ 	if ((!uaa->device) || (!uaa->iface)) {
+		ermsg = "device or iface";
+ 		goto nobulk;
+	}
+	sc->sc_iface = iface = uaa->iface;
+#elif defined(__NetBSD__) || defined(__OpenBSD__)
+ 	if (!udev) {
+		ermsg = "device";
+ 		goto nobulk;
+	}
+	r = usbd_interface_count(udev, &niface);
+	if (r) {
+		ermsg = "iface";
+		goto nobulk;  
+	}
+	r = usbd_device2interface_handle(udev, 0, &iface);
+	if (r) {
+		ermsg = "iface";
+		goto nobulk;  
+	}
+	sc->sc_iface = iface;
+#endif
+	sc->sc_opened = 0;
+	sc->sc_refcnt = 0;
+
+	r = usbd_endpoint_count(iface, &epcount);
+	if (r != USBD_NORMAL_COMPLETION) { 
+		ermsg = "endpoints";
+		goto nobulk;
+	}
+
+	edesc = usbd_interface2endpoint_descriptor(iface, 0);
+	if (!edesc) {
+		ermsg = "interface endpoint";
+		goto nobulk;
+	}
+	sc->sc_epaddr = edesc->bEndpointAddress;
+
+#if defined(__FreeBSD__)
+	/* XXX no error trapping, no storing of dev_t */
+	(void) make_dev(&ufm_cdevsw, device_get_unit(self),
+			UID_ROOT, GID_OPERATOR,
+			0644, "ufm%d", device_get_unit(self));
+#elif defined(__NetBSD__) || defined(__OpenBSD__)
+	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
+			   USBDEV(sc->sc_dev));
+#endif
+
+	DPRINTFN(10, ("ufm_attach: %p\n", sc->sc_udev));
+
+	USB_ATTACH_SUCCESS_RETURN;
+
+ nobulk:
+	printf("%s: could not find %s\n", USBDEVNAME(sc->sc_dev),ermsg);
+	USB_ATTACH_ERROR_RETURN;
+}
+
+
+int
+ufmopen(dev_t dev, int flag, int mode, usb_proc_ptr td)
+{
+	struct ufm_softc *sc;
+
+	int unit = UFMUNIT(dev);
+	USB_GET_SC_OPEN(ufm, unit, sc);
+
+	DPRINTFN(5, ("ufmopen: flag=%d, mode=%d, unit=%d\n", 
+		     flag, mode, unit));
+
+	if (sc->sc_opened)
+		return (EBUSY);
+
+	if ((flag & (FWRITE|FREAD)) != (FWRITE|FREAD))
+		return (EACCES);
+
+	sc->sc_opened = 1;
+	return (0);
+}
+
+int
+ufmclose(dev_t dev, int flag, int mode, usb_proc_ptr td)
+{
+	struct ufm_softc *sc;
+
+	int unit = UFMUNIT(dev);
+	USB_GET_SC(ufm, unit, sc);
+
+	DPRINTFN(5, ("ufmclose: flag=%d, mode=%d, unit=%d\n", flag, mode, unit));
+	sc->sc_opened = 0;
+	sc->sc_refcnt = 0;
+	return 0;	
+}
+
+static int
+ufm_do_req(struct ufm_softc *sc, u_int8_t reqtype, u_int8_t request,
+    u_int16_t value, u_int16_t index, u_int8_t len, void *retbuf)
+{
+	int s;
+	usb_device_request_t req;
+	usbd_status err;
+
+	s = splusb();
+	req.bmRequestType = reqtype;
+	req.bRequest = request;
+	USETW(req.wValue, value);
+	USETW(req.wIndex, index);
+	USETW(req.wLength, len);
+	err = usbd_do_request_flags(sc->sc_udev, &req, retbuf, 0, NULL);
+	splx(s);
+	if (err) {
+		printf("usbd_do_request_flags returned %#x\n", err);
+		return (EIO);
+	}
+	return (0);
+}
+
+static int
+ufm_set_freq(struct ufm_softc *sc, caddr_t addr)
+{
+	int freq = *(int *)addr;
+	u_int8_t ret;
+
+	/*
+	 * Freq now is in Hz.  We need to convert it to the frequency
+	 * that the radio wants.  This frequency is 10.7MHz above
+	 * the actual frequency.  We then need to convert to
+	 * units of 12.5kHz.  We add one to the IFM to make rounding
+	 * easier. 
+	 */
+	sc->sc_freq = freq;
+	freq = (freq + 10700001) / 12500;
+	/* This appears to set the frequency */
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD_SET_FREQ, freq >> 8,
+	    freq, 1, &ret) != 0)
+		return (EIO);
+	/* Not sure what this does */
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x96, 0xb7, 1, 
+	    &ret) != 0)
+		return (EIO);
+	return (0);
+}
+
+static int
+ufm_get_freq(struct ufm_softc *sc, caddr_t addr)
+{
+	int *valp = (int *)addr;
+	*valp = sc->sc_freq;
+	return (0);
+}
+
+static int
+ufm_start(struct ufm_softc *sc, caddr_t addr)
+{
+	u_int8_t ret;
+	
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0xc7, 
+	    1, &ret))
+		return (EIO);
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x01, 0x00,
+	    1, &ret))
+		return (EIO);
+	if (ret & 0x1)
+		return (EIO);
+	return (0);
+}
+
+static int
+ufm_stop(struct ufm_softc *sc, caddr_t addr)
+{
+	u_int8_t ret;
+	
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x16, 0x1C,
+	    1, &ret))
+		return (EIO);
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD2, 0x00, 0x00,
+	    1, &ret))
+		return (EIO);
+	return (0);
+}
+
+static int
+ufm_get_stat(struct ufm_softc *sc, caddr_t addr)
+{
+	u_int8_t ret;
+	
+	/*
+	 * Note, there's a 240ms settle time before the status
+	 * will be valid, so tsleep that amount.  hz/4 is a good
+	 * approximation of that.  Since this is a short sleep
+	 * we don't try to catch any signals to keep things
+	 * simple.
+	 */
+	tsleep(sc, 0, "ufmwait", hz/4);
+	if (ufm_do_req(sc, UT_READ_VENDOR_DEVICE, FM_CMD0, 0x00, 0x24,
+	    1, &ret))
+		return (EIO);
+	*(int *)addr = ret;
+	
+	return (0);
+}
+
+int
+ufmioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr td)
+{
+	struct ufm_softc *sc;
+
+	int unit = UFMUNIT(dev);
+	int error = 0;
+
+	USB_GET_SC(ufm, unit, sc);
+
+	switch (cmd) {
+	case FM_SET_FREQ:
+		error = ufm_set_freq(sc, addr);
+		break;
+	case FM_GET_FREQ:
+		error = ufm_get_freq(sc, addr);
+		break;
+	case FM_START:
+		error = ufm_start(sc, addr);
+		break;
+	case FM_STOP:
+		error = ufm_stop(sc, addr);
+		break;
+	case FM_GET_STAT:
+		error = ufm_get_stat(sc, addr);
+		break;
+	default:
+		return ENOTTY;
+		break;
+	}
+	return error;
+}
+
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+int
+ufm_activate(device_ptr_t self, enum devact act)
+{
+	struct ufm_softc *sc = (struct ufm_softc *)self;
+
+	switch (act) {
+	case DVACT_ACTIVATE:
+		return (EOPNOTSUPP);
+		break;
+
+	case DVACT_DEACTIVATE:
+		sc->sc_dying = 1;
+		break;
+	}
+	return (0);
+}
+
+USB_DETACH(ufm)
+{
+	USB_DETACH_START(ufm, sc);
+	struct ufm_endpoint *sce;
+	int i, dir;
+	int s;
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	int maj, mn;
+
+	DPRINTF(("ufm_detach: sc=%p flags=%d\n", sc, flags));
+#elif defined(__FreeBSD__)
+	DPRINTF(("ufm_detach: sc=%p\n", sc));
+#endif
+
+	sc->sc_dying = 1;
+
+	s = splusb();
+	if (--sc->sc_refcnt >= 0) {
+		/* Wait for processes to go away. */
+		usb_detach_wait(USBDEV(sc->sc_dev));
+	}
+	splx(s);
+
+#if defined(__NetBSD__) || defined(__OpenBSD__)
+	/* locate the major number */
+	for (maj = 0; maj < nchrdev; maj++)
+		if (cdevsw[maj].d_open == ufmopen)
+			break;
+
+	/* Nuke the vnodes for any open instances (calls close). */
+	mn = self->dv_unit * USB_MAX_ENDPOINTS;
+	vdevgone(maj, mn, mn + USB_MAX_ENDPOINTS - 1, VCHR);
+#elif defined(__FreeBSD__)
+	/* XXX not implemented yet */
+#endif
+
+	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
+			   USBDEV(sc->sc_dev));
+
+	return (0);
+}
+#endif /* defined(__NetBSD__) || defined(__OpenBSD__) */
+
+#if defined(__FreeBSD__)
+Static int
+ufm_detach(device_t self)
+{       
+	DPRINTF(("%s: disconnected\n", USBDEVNAME(self)));
+	return 0;
+}
+
+DRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, usbd_driver_load, 0);
+#endif

sys/i386/conf/NOTES

@@ -2853,6 +2853,8 @@ device		ums
 device		urio
 # USB scanners
 device		uscanner
+# USB Fm Radio
+device		ufm
 #
 # ADMtek USB ethernet. Supports the LinkSys USB100TX,
 # the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX

sys/modules/Makefile

@@ -91,6 +91,7 @@ SUBDIR=	3dfx \
 	tx \
 	txp \
 	udbp \
+	ufm \
 	ugen \
 	uhid \
 	ukbd \

sys/modules/ufm/Makefile

@@ -0,0 +1,8 @@
+# $FreeBSD$
+
+.PATH:	${.CURDIR}/../../dev/usb
+KMOD=	ufm
+SRCS=	bus_if.h device_if.h vnode_if.h opt_usb.h ufm.c dsbr100io.h
+NOMAN=	YES
+
+.include <bsd.kmod.mk>