xref: /openbsd-src/sys/dev/usb/udsbr.c (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /*	$OpenBSD: udsbr.c,v 1.20 2008/06/26 05:42:18 ray Exp $	*/
2 /*	$NetBSD: udsbr.c,v 1.7 2002/07/11 21:14:27 augustss Exp $	*/
3 
4 /*
5  * Copyright (c) 2002 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net).
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Driver for the D-Link DSB-R100 FM radio.
35  * I apologize for the magic hex constants, but this is what happens
36  * when you have to reverse engineer the driver.
37  * Parts of the code borrowed from Linux and parts from Warner Losh's
38  * FreeBSD driver.
39  */
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/device.h>
45 
46 #include <sys/radioio.h>
47 #include <dev/radio_if.h>
48 
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
52 
53 #include <dev/usb/usbdevs.h>
54 
55 #ifdef UDSBR_DEBUG
56 #define DPRINTF(x)	do { if (udsbrdebug) printf x; } while (0)
57 #define DPRINTFN(n,x)	do { if (udsbrdebug>(n)) printf x; } while (0)
58 int	udsbrdebug = 0;
59 #else
60 #define DPRINTF(x)
61 #define DPRINTFN(n,x)
62 #endif
63 
64 #define UDSBR_CONFIG_NO		1
65 
66 int     udsbr_get_info(void *, struct radio_info *);
67 int     udsbr_set_info(void *, struct radio_info *);
68 
69 struct radio_hw_if udsbr_hw_if = {
70 	NULL, /* open */
71 	NULL, /* close */
72 	udsbr_get_info,
73 	udsbr_set_info,
74 	NULL
75 };
76 
77 struct udsbr_softc {
78  	struct device		 sc_dev;
79 	usbd_device_handle	 sc_udev;
80 
81 	char			 sc_mute;
82 	char			 sc_vol;
83 	u_int32_t		 sc_freq;
84 
85 	struct device		*sc_child;
86 
87 	char			 sc_dying;
88 };
89 
90 int	udsbr_req(struct udsbr_softc *sc, int ureq, int value, int index);
91 void	udsbr_start(struct udsbr_softc *sc);
92 void	udsbr_stop(struct udsbr_softc *sc);
93 void	udsbr_setfreq(struct udsbr_softc *sc, int freq);
94 int	udsbr_status(struct udsbr_softc *sc);
95 
96 int udsbr_match(struct device *, void *, void *);
97 void udsbr_attach(struct device *, struct device *, void *);
98 int udsbr_detach(struct device *, int);
99 int udsbr_activate(struct device *, enum devact);
100 
101 struct cfdriver udsbr_cd = {
102 	NULL, "udsbr", DV_DULL
103 };
104 
105 const struct cfattach udsbr_ca = {
106 	sizeof(struct udsbr_softc),
107 	udsbr_match,
108 	udsbr_attach,
109 	udsbr_detach,
110 	udsbr_activate,
111 };
112 
113 int
114 udsbr_match(struct device *parent, void *match, void *aux)
115 {
116 	struct usb_attach_arg	*uaa = aux;
117 
118 	DPRINTFN(50,("udsbr_match\n"));
119 
120 	if (uaa->iface != NULL)
121 		return (UMATCH_NONE);
122 
123 	if (uaa->vendor != USB_VENDOR_CYPRESS ||
124 	    uaa->product != USB_PRODUCT_CYPRESS_FMRADIO)
125 		return (UMATCH_NONE);
126 	return (UMATCH_VENDOR_PRODUCT);
127 }
128 
129 void
130 udsbr_attach(struct device *parent, struct device *self, void *aux)
131 {
132 	struct udsbr_softc	*sc = (struct udsbr_softc *)self;
133 	struct usb_attach_arg	*uaa = aux;
134 	usbd_device_handle	dev = uaa->device;
135 	usbd_status		err;
136 
137 	DPRINTFN(10,("udsbr_attach: sc=%p\n", sc));
138 
139 	err = usbd_set_config_no(dev, UDSBR_CONFIG_NO, 1);
140 	if (err) {
141 		printf("%s: setting config no failed\n",
142 		    sc->sc_dev.dv_xname);
143 		return;
144 	}
145 
146 	sc->sc_udev = dev;
147 
148 	DPRINTFN(10, ("udsbr_attach: %p\n", sc->sc_udev));
149 
150 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
151 			   &sc->sc_dev);
152 
153 	sc->sc_child = radio_attach_mi(&udsbr_hw_if, sc, &sc->sc_dev);
154 }
155 
156 int
157 udsbr_detach(struct device *self, int flags)
158 {
159 	struct udsbr_softc *sc = (struct udsbr_softc *)self;
160 	int rv = 0;
161 
162 	if (sc->sc_child != NULL)
163 		rv = config_detach(sc->sc_child, flags);
164 
165 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
166 			   &sc->sc_dev);
167 
168 	return (rv);
169 }
170 
171 int
172 udsbr_activate(struct device *self, enum devact act)
173 {
174 	struct udsbr_softc *sc = (struct udsbr_softc *)self;
175 	int rv = 0;
176 
177 	switch (act) {
178 	case DVACT_ACTIVATE:
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", sc->sc_dev.dv_xname,
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