1184610Salfred/*- 2184610Salfred * Copyright (c) 2001 M. Warner Losh 3184610Salfred * All rights reserved. 4184610Salfred * 5184610Salfred * Redistribution and use in source and binary forms, with or without 6184610Salfred * modification, are permitted provided that the following conditions 7184610Salfred * are met: 8184610Salfred * 1. Redistributions of source code must retain the above copyright 9184610Salfred * notice, this list of conditions, and the following disclaimer. 10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer in the 12184610Salfred * documentation and/or other materials provided with the distribution. 13184610Salfred * 14184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 18184610Salfred * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24184610Salfred * SUCH DAMAGE. 25184610Salfred * 26184610Salfred * This code is based on ugen.c and ulpt.c developed by Lennart Augustsson. 27184610Salfred * This code includes software developed by the NetBSD Foundation, Inc. and 28184610Salfred * its contributors. 29184610Salfred */ 30184610Salfred 31184610Salfred#include <sys/cdefs.h> 32184610Salfred__FBSDID("$FreeBSD$"); 33184610Salfred 34184610Salfred 35194677Sthompsa#include <sys/stdint.h> 36194677Sthompsa#include <sys/stddef.h> 37194677Sthompsa#include <sys/param.h> 38194677Sthompsa#include <sys/queue.h> 39194677Sthompsa#include <sys/types.h> 40194677Sthompsa#include <sys/systm.h> 41194677Sthompsa#include <sys/kernel.h> 42194677Sthompsa#include <sys/bus.h> 43194677Sthompsa#include <sys/module.h> 44194677Sthompsa#include <sys/lock.h> 45194677Sthompsa#include <sys/mutex.h> 46194677Sthompsa#include <sys/condvar.h> 47194677Sthompsa#include <sys/sysctl.h> 48194677Sthompsa#include <sys/sx.h> 49194677Sthompsa#include <sys/unistd.h> 50194677Sthompsa#include <sys/callout.h> 51194677Sthompsa#include <sys/malloc.h> 52194677Sthompsa#include <sys/priv.h> 53194677Sthompsa#include <sys/conf.h> 54194677Sthompsa#include <sys/fcntl.h> 55194677Sthompsa 56194677Sthompsa#include <dev/usb/usb.h> 57194677Sthompsa#include <dev/usb/usbdi.h> 58188746Sthompsa#include "usbdevs.h" 59184610Salfred 60194228Sthompsa#define USB_DEBUG_VAR usb_debug 61188942Sthompsa#include <dev/usb/usb_debug.h> 62184610Salfred 63194677Sthompsa#include <dev/usb/ufm_ioctl.h> 64194677Sthompsa 65184610Salfred#define UFM_CMD0 0x00 66184610Salfred#define UFM_CMD_SET_FREQ 0x01 67184610Salfred#define UFM_CMD2 0x02 68184610Salfred 69184610Salfredstruct ufm_softc { 70192984Sthompsa struct usb_fifo_sc sc_fifo; 71184610Salfred struct mtx sc_mtx; 72184610Salfred 73192984Sthompsa struct usb_device *sc_udev; 74184610Salfred 75184610Salfred uint32_t sc_unit; 76184610Salfred uint32_t sc_freq; 77184610Salfred 78184610Salfred uint8_t sc_name[16]; 79184610Salfred}; 80184610Salfred 81184610Salfred/* prototypes */ 82184610Salfred 83184610Salfredstatic device_probe_t ufm_probe; 84184610Salfredstatic device_attach_t ufm_attach; 85184610Salfredstatic device_detach_t ufm_detach; 86184610Salfred 87193045Sthompsastatic usb_fifo_ioctl_t ufm_ioctl; 88184610Salfred 89192984Sthompsastatic struct usb_fifo_methods ufm_fifo_methods = { 90184610Salfred .f_ioctl = &ufm_ioctl, 91184610Salfred .basename[0] = "ufm", 92184610Salfred}; 93184610Salfred 94185948Sthompsastatic int ufm_do_req(struct ufm_softc *, uint8_t, uint16_t, uint16_t, 95185948Sthompsa uint8_t *); 96185948Sthompsastatic int ufm_set_freq(struct ufm_softc *, void *); 97185948Sthompsastatic int ufm_get_freq(struct ufm_softc *, void *); 98185948Sthompsastatic int ufm_start(struct ufm_softc *, void *); 99185948Sthompsastatic int ufm_stop(struct ufm_softc *, void *); 100185948Sthompsastatic int ufm_get_stat(struct ufm_softc *, void *); 101184610Salfred 102184610Salfredstatic devclass_t ufm_devclass; 103184610Salfred 104184610Salfredstatic device_method_t ufm_methods[] = { 105184610Salfred DEVMETHOD(device_probe, ufm_probe), 106184610Salfred DEVMETHOD(device_attach, ufm_attach), 107184610Salfred DEVMETHOD(device_detach, ufm_detach), 108246128Ssbz 109246128Ssbz DEVMETHOD_END 110184610Salfred}; 111184610Salfred 112184610Salfredstatic driver_t ufm_driver = { 113184610Salfred .name = "ufm", 114184610Salfred .methods = ufm_methods, 115184610Salfred .size = sizeof(struct ufm_softc), 116184610Salfred}; 117184610Salfred 118292080Simpstatic const STRUCT_USB_HOST_ID ufm_devs[] = { 119292080Simp {USB_VPI(USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_FMRADIO, 0)}, 120292080Simp}; 121292080Simp 122189275SthompsaDRIVER_MODULE(ufm, uhub, ufm_driver, ufm_devclass, NULL, 0); 123188942SthompsaMODULE_DEPEND(ufm, usb, 1, 1, 1); 124212122SthompsaMODULE_VERSION(ufm, 1); 125292080SimpUSB_PNP_HOST_INFO(ufm_devs); 126184610Salfred 127184610Salfredstatic int 128184610Salfredufm_probe(device_t dev) 129184610Salfred{ 130192984Sthompsa struct usb_attach_arg *uaa = device_get_ivars(dev); 131184610Salfred 132223515Shselasky if (uaa->usb_mode != USB_MODE_HOST) 133184610Salfred return (ENXIO); 134223515Shselasky if (uaa->info.bConfigIndex != 0) 135223515Shselasky return (ENXIO); 136223515Shselasky if (uaa->info.bIfaceIndex != 0) 137223515Shselasky return (ENXIO); 138223515Shselasky 139223515Shselasky return (usbd_lookup_id_by_uaa(ufm_devs, sizeof(ufm_devs), uaa)); 140184610Salfred} 141184610Salfred 142184610Salfredstatic int 143184610Salfredufm_attach(device_t dev) 144184610Salfred{ 145192984Sthompsa struct usb_attach_arg *uaa = device_get_ivars(dev); 146184610Salfred struct ufm_softc *sc = device_get_softc(dev); 147184610Salfred int error; 148184610Salfred 149184610Salfred sc->sc_udev = uaa->device; 150184610Salfred sc->sc_unit = device_get_unit(dev); 151184610Salfred 152184610Salfred snprintf(sc->sc_name, sizeof(sc->sc_name), "%s", 153184610Salfred device_get_nameunit(dev)); 154184610Salfred 155184610Salfred mtx_init(&sc->sc_mtx, "ufm lock", NULL, MTX_DEF | MTX_RECURSE); 156184610Salfred 157194228Sthompsa device_set_usb_desc(dev); 158184610Salfred 159194228Sthompsa error = usb_fifo_attach(uaa->device, sc, &sc->sc_mtx, 160184610Salfred &ufm_fifo_methods, &sc->sc_fifo, 161233774Shselasky device_get_unit(dev), -1, uaa->info.bIfaceIndex, 162189110Sthompsa UID_ROOT, GID_OPERATOR, 0644); 163184610Salfred if (error) { 164184610Salfred goto detach; 165184610Salfred } 166184610Salfred return (0); /* success */ 167184610Salfred 168184610Salfreddetach: 169184610Salfred ufm_detach(dev); 170184610Salfred return (ENXIO); 171184610Salfred} 172184610Salfred 173184610Salfredstatic int 174184610Salfredufm_detach(device_t dev) 175184610Salfred{ 176184610Salfred struct ufm_softc *sc = device_get_softc(dev); 177184610Salfred 178194228Sthompsa usb_fifo_detach(&sc->sc_fifo); 179184610Salfred 180184610Salfred mtx_destroy(&sc->sc_mtx); 181184610Salfred 182184610Salfred return (0); 183184610Salfred} 184184610Salfred 185184610Salfredstatic int 186184610Salfredufm_do_req(struct ufm_softc *sc, uint8_t request, 187184610Salfred uint16_t value, uint16_t index, uint8_t *retbuf) 188184610Salfred{ 189184610Salfred int error; 190184610Salfred 191192984Sthompsa struct usb_device_request req; 192184610Salfred uint8_t buf[1]; 193184610Salfred 194184610Salfred req.bmRequestType = UT_READ_VENDOR_DEVICE; 195184610Salfred req.bRequest = request; 196184610Salfred USETW(req.wValue, value); 197184610Salfred USETW(req.wIndex, index); 198184610Salfred USETW(req.wLength, 1); 199184610Salfred 200194228Sthompsa error = usbd_do_request(sc->sc_udev, NULL, &req, buf); 201184610Salfred 202184610Salfred if (retbuf) { 203184610Salfred *retbuf = buf[0]; 204184610Salfred } 205184610Salfred if (error) { 206184610Salfred return (ENXIO); 207184610Salfred } 208184610Salfred return (0); 209184610Salfred} 210184610Salfred 211184610Salfredstatic int 212184610Salfredufm_set_freq(struct ufm_softc *sc, void *addr) 213184610Salfred{ 214184610Salfred int freq = *(int *)addr; 215184610Salfred 216184610Salfred /* 217184610Salfred * Freq now is in Hz. We need to convert it to the frequency 218184610Salfred * that the radio wants. This frequency is 10.7MHz above 219184610Salfred * the actual frequency. We then need to convert to 220184610Salfred * units of 12.5kHz. We add one to the IFM to make rounding 221184610Salfred * easier. 222184610Salfred */ 223184610Salfred mtx_lock(&sc->sc_mtx); 224184610Salfred sc->sc_freq = freq; 225184610Salfred mtx_unlock(&sc->sc_mtx); 226184610Salfred 227184610Salfred freq = (freq + 10700001) / 12500; 228184610Salfred 229184610Salfred /* This appears to set the frequency */ 230184610Salfred if (ufm_do_req(sc, UFM_CMD_SET_FREQ, 231184610Salfred freq >> 8, freq, NULL) != 0) { 232184610Salfred return (EIO); 233184610Salfred } 234184610Salfred /* Not sure what this does */ 235184610Salfred if (ufm_do_req(sc, UFM_CMD0, 236184610Salfred 0x96, 0xb7, NULL) != 0) { 237184610Salfred return (EIO); 238184610Salfred } 239184610Salfred return (0); 240184610Salfred} 241184610Salfred 242184610Salfredstatic int 243184610Salfredufm_get_freq(struct ufm_softc *sc, void *addr) 244184610Salfred{ 245184610Salfred int *valp = (int *)addr; 246184610Salfred 247184610Salfred mtx_lock(&sc->sc_mtx); 248184610Salfred *valp = sc->sc_freq; 249184610Salfred mtx_unlock(&sc->sc_mtx); 250184610Salfred return (0); 251184610Salfred} 252184610Salfred 253184610Salfredstatic int 254184610Salfredufm_start(struct ufm_softc *sc, void *addr) 255184610Salfred{ 256184610Salfred uint8_t ret; 257184610Salfred 258184610Salfred if (ufm_do_req(sc, UFM_CMD0, 259184610Salfred 0x00, 0xc7, &ret)) { 260184610Salfred return (EIO); 261184610Salfred } 262184610Salfred if (ufm_do_req(sc, UFM_CMD2, 263184610Salfred 0x01, 0x00, &ret)) { 264184610Salfred return (EIO); 265184610Salfred } 266184610Salfred if (ret & 0x1) { 267184610Salfred return (EIO); 268184610Salfred } 269184610Salfred return (0); 270184610Salfred} 271184610Salfred 272184610Salfredstatic int 273184610Salfredufm_stop(struct ufm_softc *sc, void *addr) 274184610Salfred{ 275184610Salfred if (ufm_do_req(sc, UFM_CMD0, 276184610Salfred 0x16, 0x1C, NULL)) { 277184610Salfred return (EIO); 278184610Salfred } 279184610Salfred if (ufm_do_req(sc, UFM_CMD2, 280184610Salfred 0x00, 0x00, NULL)) { 281184610Salfred return (EIO); 282184610Salfred } 283184610Salfred return (0); 284184610Salfred} 285184610Salfred 286184610Salfredstatic int 287184610Salfredufm_get_stat(struct ufm_softc *sc, void *addr) 288184610Salfred{ 289184610Salfred uint8_t ret; 290184610Salfred 291184610Salfred /* 292184610Salfred * Note, there's a 240ms settle time before the status 293184610Salfred * will be valid, so sleep that amount. 294184610Salfred */ 295194228Sthompsa usb_pause_mtx(NULL, hz / 4); 296184610Salfred 297184610Salfred if (ufm_do_req(sc, UFM_CMD0, 298184610Salfred 0x00, 0x24, &ret)) { 299184610Salfred return (EIO); 300184610Salfred } 301184610Salfred *(int *)addr = ret; 302184610Salfred 303184610Salfred return (0); 304184610Salfred} 305184610Salfred 306184610Salfredstatic int 307192984Sthompsaufm_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, 308189110Sthompsa int fflags) 309184610Salfred{ 310194677Sthompsa struct ufm_softc *sc = usb_fifo_softc(fifo); 311184610Salfred int error = 0; 312184610Salfred 313196490Salfred if ((fflags & (FWRITE | FREAD)) != (FWRITE | FREAD)) { 314196490Salfred return (EACCES); 315196490Salfred } 316196490Salfred 317184610Salfred switch (cmd) { 318184610Salfred case FM_SET_FREQ: 319184610Salfred error = ufm_set_freq(sc, addr); 320184610Salfred break; 321184610Salfred case FM_GET_FREQ: 322184610Salfred error = ufm_get_freq(sc, addr); 323184610Salfred break; 324184610Salfred case FM_START: 325184610Salfred error = ufm_start(sc, addr); 326184610Salfred break; 327184610Salfred case FM_STOP: 328184610Salfred error = ufm_stop(sc, addr); 329184610Salfred break; 330184610Salfred case FM_GET_STAT: 331184610Salfred error = ufm_get_stat(sc, addr); 332184610Salfred break; 333184610Salfred default: 334184610Salfred error = ENOTTY; 335184610Salfred break; 336184610Salfred } 337184610Salfred return (error); 338184610Salfred} 339