udsbr.c revision 1.13 
1/*	$NetBSD: udsbr.c,v 1.13 2008/02/18 05:31:24 dyoung 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.13 2008/02/18 05:31:24 dyoung 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
106int udsbr_match(device_t, struct cfdata *, void *);
107void udsbr_attach(device_t, device_t, void *);
108void udsbr_childdet(device_t, device_t);
109int udsbr_detach(device_t, int);
110int udsbr_activate(device_t, enum devact);
111extern struct cfdriver udsbr_cd;
112CFATTACH_DECL2(udsbr, sizeof(struct udsbr_softc), udsbr_match,
113    udsbr_attach, udsbr_detach, udsbr_activate, NULL, udsbr_childdet);
114
115USB_MATCH(udsbr)
116{
117	USB_MATCH_START(udsbr, uaa);
118
119	DPRINTFN(50,("udsbr_match\n"));
120
121	if (uaa->vendor != USB_VENDOR_CYPRESS ||
122	    uaa->product != USB_PRODUCT_CYPRESS_FMRADIO)
123		return (UMATCH_NONE);
124	return (UMATCH_VENDOR_PRODUCT);
125}
126
127USB_ATTACH(udsbr)
128{
129	USB_ATTACH_START(udsbr, sc, uaa);
130	usbd_device_handle	dev = uaa->device;
131	char			*devinfop;
132	usbd_status		err;
133
134	DPRINTFN(10,("udsbr_attach: sc=%p\n", sc));
135
136	devinfop = usbd_devinfo_alloc(dev, 0);
137	USB_ATTACH_SETUP;
138	printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfop);
139	usbd_devinfo_free(devinfop);
140
141	err = usbd_set_config_no(dev, UDSBR_CONFIG_NO, 1);
142	if (err) {
143		printf("%s: setting config no failed\n",
144		    USBDEVNAME(sc->sc_dev));
145		USB_ATTACH_ERROR_RETURN;
146	}
147
148	sc->sc_udev = dev;
149
150	DPRINTFN(10, ("udsbr_attach: %p\n", sc->sc_udev));
151
152	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
153			   USBDEV(sc->sc_dev));
154
155	sc->sc_child = radio_attach_mi(&udsbr_hw_if, sc, USBDEV(sc->sc_dev));
156
157	USB_ATTACH_SUCCESS_RETURN;
158}
159
160void
161udsbr_childdet(device_t self, device_t child)
162{
163}
164
165USB_DETACH(udsbr)
166{
167	USB_DETACH_START(udsbr, sc);
168	int rv = 0;
169
170	if (sc->sc_child != NULL)
171		rv = config_detach(sc->sc_child, flags);
172
173	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
174			   USBDEV(sc->sc_dev));
175
176	return (rv);
177}
178
179int
180udsbr_activate(device_ptr_t self, enum devact act)
181{
182	struct udsbr_softc *sc = (struct udsbr_softc *)self;
183	int rv = 0;
184
185	switch (act) {
186	case DVACT_ACTIVATE:
187		return (EOPNOTSUPP);
188		break;
189
190	case DVACT_DEACTIVATE:
191		sc->sc_dying = 1;
192		if (sc->sc_child != NULL)
193			rv = config_deactivate(sc->sc_child);
194		break;
195	}
196	return (rv);
197}
198
199int
200udsbr_req(struct udsbr_softc *sc, int ureq, int value, int index)
201{
202	usb_device_request_t req;
203	usbd_status err;
204	u_char data;
205
206	DPRINTFN(1,("udsbr_req: ureq=0x%02x value=0x%04x index=0x%04x\n",
207		    ureq, value, index));
208	req.bmRequestType = UT_READ_VENDOR_DEVICE;
209	req.bRequest = ureq;
210	USETW(req.wValue, value);
211	USETW(req.wIndex, index);
212	USETW(req.wLength, 1);
213	err = usbd_do_request(sc->sc_udev, &req, &data);
214	if (err) {
215		printf("%s: request failed err=%d\n", USBDEVNAME(sc->sc_dev),
216		       err);
217	}
218	return !(data & 1);
219}
220
221void
222udsbr_start(struct udsbr_softc *sc)
223{
224	(void)udsbr_req(sc, 0x00, 0x0000, 0x00c7);
225	(void)udsbr_req(sc, 0x02, 0x0001, 0x0000);
226}
227
228void
229udsbr_stop(struct udsbr_softc *sc)
230{
231	(void)udsbr_req(sc, 0x00, 0x0016, 0x001c);
232	(void)udsbr_req(sc, 0x02, 0x0000, 0x0000);
233}
234
235void
236udsbr_setfreq(struct udsbr_softc *sc, int freq)
237{
238	DPRINTF(("udsbr_setfreq: setfreq=%d\n", freq));
239        /*
240         * Freq now is in Hz.  We need to convert it to the frequency
241         * that the radio wants.  This frequency is 10.7MHz above
242         * the actual frequency.  We then need to convert to
243         * units of 12.5kHz.  We add one to the IFM to make rounding
244         * easier.
245         */
246        freq = (freq * 1000 + 10700001) / 12500;
247	(void)udsbr_req(sc, 0x01, (freq >> 8) & 0xff, freq & 0xff);
248	(void)udsbr_req(sc, 0x00, 0x0096, 0x00b7);
249	usbd_delay_ms(sc->sc_udev, 240); /* wait for signal to settle */
250}
251
252int
253udsbr_status(struct udsbr_softc *sc)
254{
255	return (udsbr_req(sc, 0x00, 0x0000, 0x0024));
256}
257
258
259int
260udsbr_get_info(void *v, struct radio_info *ri)
261{
262	struct udsbr_softc *sc = v;
263
264	ri->mute = sc->sc_mute;
265	ri->volume = sc->sc_vol ? 255 : 0;
266	ri->caps = RADIO_CAPS_DETECT_STEREO;
267	ri->rfreq = 0;
268	ri->lock = 0;
269	ri->freq = sc->sc_freq;
270	ri->info = udsbr_status(sc) ? RADIO_INFO_STEREO : 0;
271
272	return (0);
273}
274
275int
276udsbr_set_info(void *v, struct radio_info *ri)
277{
278	struct udsbr_softc *sc = v;
279
280	sc->sc_mute = ri->mute != 0;
281	sc->sc_vol = ri->volume != 0;
282	sc->sc_freq = ri->freq;
283	udsbr_setfreq(sc, sc->sc_freq);
284
285	if (sc->sc_mute || sc->sc_vol == 0)
286		udsbr_stop(sc);
287	else
288		udsbr_start(sc);
289
290	return (0);
291}
292