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