udsbr.c revision 1.12 
1/*	$NetBSD: udsbr.c,v 1.12 2007/03/13 13:51:55 drochner Exp $	*/
2
3/*
4 * Copyright (c) 2002 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (lennart@augustsson.net).
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *        This product includes software developed by the NetBSD
21 *        Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 *    contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39/*
40 * Driver for the D-Link DSB-R100 FM radio.
41 * I apologize for the magic hex constants, but this is what happens
42 * when you have to reverse engineer the driver.
43 * Parts of the code borrowed from Linux and parts from Warner Losh's
44 * FreeBSD driver.
45 */
46
47#include <sys/cdefs.h>
48__KERNEL_RCSID(0, "$NetBSD: udsbr.c,v 1.12 2007/03/13 13:51:55 drochner Exp $");
49
50#include <sys/param.h>
51#include <sys/systm.h>
52#include <sys/kernel.h>
53#include <sys/device.h>
54
55#include <sys/radioio.h>
56#include <dev/radio_if.h>
57
58#include <dev/usb/usb.h>
59#include <dev/usb/usbdi.h>
60#include <dev/usb/usbdi_util.h>
61
62#include <dev/usb/usbdevs.h>
63
64#ifdef UDSBR_DEBUG
65#define DPRINTF(x)	if (udsbrdebug) logprintf x
66#define DPRINTFN(n,x)	if (udsbrdebug>(n)) logprintf x
67int	udsbrdebug = 0;
68#else
69#define DPRINTF(x)
70#define DPRINTFN(n,x)
71#endif
72
73#define UDSBR_CONFIG_NO		1
74
75Static	int     udsbr_get_info(void *, struct radio_info *);
76Static	int     udsbr_set_info(void *, struct radio_info *);
77
78const struct radio_hw_if udsbr_hw_if = {
79	NULL, /* open */
80	NULL, /* close */
81	udsbr_get_info,
82	udsbr_set_info,
83	NULL
84};
85
86struct udsbr_softc {
87 	USBBASEDEVICE		sc_dev;
88	usbd_device_handle	sc_udev;
89
90	char			sc_mute;
91	char			sc_vol;
92	u_int32_t		sc_freq;
93
94	struct device		*sc_child;
95
96	char			sc_dying;
97};
98
99Static	int	udsbr_req(struct udsbr_softc *sc, int ureq, int value,
100			  int index);
101Static	void	udsbr_start(struct udsbr_softc *sc);
102Static	void	udsbr_stop(struct udsbr_softc *sc);
103Static	void	udsbr_setfreq(struct udsbr_softc *sc, int freq);
104Static	int	udsbr_status(struct udsbr_softc *sc);
105
106USB_DECLARE_DRIVER(udsbr);
107
108USB_MATCH(udsbr)
109{
110	USB_MATCH_START(udsbr, uaa);
111
112	DPRINTFN(50,("udsbr_match\n"));
113
114	if (uaa->vendor != USB_VENDOR_CYPRESS ||
115	    uaa->product != USB_PRODUCT_CYPRESS_FMRADIO)
116		return (UMATCH_NONE);
117	return (UMATCH_VENDOR_PRODUCT);
118}
119
120USB_ATTACH(udsbr)
121{
122	USB_ATTACH_START(udsbr, sc, uaa);
123	usbd_device_handle	dev = uaa->device;
124	char			*devinfop;
125	usbd_status		err;
126
127	DPRINTFN(10,("udsbr_attach: sc=%p\n", sc));
128
129	devinfop = usbd_devinfo_alloc(dev, 0);
130	USB_ATTACH_SETUP;
131	printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfop);
132	usbd_devinfo_free(devinfop);
133
134	err = usbd_set_config_no(dev, UDSBR_CONFIG_NO, 1);
135	if (err) {
136		printf("%s: setting config no failed\n",
137		    USBDEVNAME(sc->sc_dev));
138		USB_ATTACH_ERROR_RETURN;
139	}
140
141	sc->sc_udev = dev;
142
143	DPRINTFN(10, ("udsbr_attach: %p\n", sc->sc_udev));
144
145	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
146			   USBDEV(sc->sc_dev));
147
148	sc->sc_child = radio_attach_mi(&udsbr_hw_if, sc, USBDEV(sc->sc_dev));
149
150	USB_ATTACH_SUCCESS_RETURN;
151}
152
153USB_DETACH(udsbr)
154{
155	USB_DETACH_START(udsbr, sc);
156	int rv = 0;
157
158	if (sc->sc_child != NULL)
159		rv = config_detach(sc->sc_child, flags);
160
161	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
162			   USBDEV(sc->sc_dev));
163
164	return (rv);
165}
166
167int
168udsbr_activate(device_ptr_t self, enum devact act)
169{
170	struct udsbr_softc *sc = (struct udsbr_softc *)self;
171	int rv = 0;
172
173	switch (act) {
174	case DVACT_ACTIVATE:
175		return (EOPNOTSUPP);
176		break;
177
178	case DVACT_DEACTIVATE:
179		sc->sc_dying = 1;
180		if (sc->sc_child != NULL)
181			rv = config_deactivate(sc->sc_child);
182		break;
183	}
184	return (rv);
185}
186
187int
188udsbr_req(struct udsbr_softc *sc, int ureq, int value, int index)
189{
190	usb_device_request_t req;
191	usbd_status err;
192	u_char data;
193
194	DPRINTFN(1,("udsbr_req: ureq=0x%02x value=0x%04x index=0x%04x\n",
195		    ureq, value, index));
196	req.bmRequestType = UT_READ_VENDOR_DEVICE;
197	req.bRequest = ureq;
198	USETW(req.wValue, value);
199	USETW(req.wIndex, index);
200	USETW(req.wLength, 1);
201	err = usbd_do_request(sc->sc_udev, &req, &data);
202	if (err) {
203		printf("%s: request failed err=%d\n", USBDEVNAME(sc->sc_dev),
204		       err);
205	}
206	return !(data & 1);
207}
208
209void
210udsbr_start(struct udsbr_softc *sc)
211{
212	(void)udsbr_req(sc, 0x00, 0x0000, 0x00c7);
213	(void)udsbr_req(sc, 0x02, 0x0001, 0x0000);
214}
215
216void
217udsbr_stop(struct udsbr_softc *sc)
218{
219	(void)udsbr_req(sc, 0x00, 0x0016, 0x001c);
220	(void)udsbr_req(sc, 0x02, 0x0000, 0x0000);
221}
222
223void
224udsbr_setfreq(struct udsbr_softc *sc, int freq)
225{
226	DPRINTF(("udsbr_setfreq: setfreq=%d\n", freq));
227        /*
228         * Freq now is in Hz.  We need to convert it to the frequency
229         * that the radio wants.  This frequency is 10.7MHz above
230         * the actual frequency.  We then need to convert to
231         * units of 12.5kHz.  We add one to the IFM to make rounding
232         * easier.
233         */
234        freq = (freq * 1000 + 10700001) / 12500;
235	(void)udsbr_req(sc, 0x01, (freq >> 8) & 0xff, freq & 0xff);
236	(void)udsbr_req(sc, 0x00, 0x0096, 0x00b7);
237	usbd_delay_ms(sc->sc_udev, 240); /* wait for signal to settle */
238}
239
240int
241udsbr_status(struct udsbr_softc *sc)
242{
243	return (udsbr_req(sc, 0x00, 0x0000, 0x0024));
244}
245
246
247int
248udsbr_get_info(void *v, struct radio_info *ri)
249{
250	struct udsbr_softc *sc = v;
251
252	ri->mute = sc->sc_mute;
253	ri->volume = sc->sc_vol ? 255 : 0;
254	ri->caps = RADIO_CAPS_DETECT_STEREO;
255	ri->rfreq = 0;
256	ri->lock = 0;
257	ri->freq = sc->sc_freq;
258	ri->info = udsbr_status(sc) ? RADIO_INFO_STEREO : 0;
259
260	return (0);
261}
262
263int
264udsbr_set_info(void *v, struct radio_info *ri)
265{
266	struct udsbr_softc *sc = v;
267
268	sc->sc_mute = ri->mute != 0;
269	sc->sc_vol = ri->volume != 0;
270	sc->sc_freq = ri->freq;
271	udsbr_setfreq(sc, sc->sc_freq);
272
273	if (sc->sc_mute || sc->sc_vol == 0)
274		udsbr_stop(sc);
275	else
276		udsbr_start(sc);
277
278	return (0);
279}
280