]>
Commit | Line | Data |
---|---|---|
c942fddf | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
fc55bcb0 | 2 | /* A driver for the D-Link DSB-R100 USB radio and Gemtek USB Radio 21. |
5d778648 HV |
3 | * The device plugs into both the USB and an analog audio input, so this thing |
4 | * only deals with initialisation and frequency setting, the | |
5 | * audio data has to be handled by a sound driver. | |
6 | * | |
7 | * Major issue: I can't find out where the device reports the signal | |
8 | * strength, and indeed the windows software appearantly just looks | |
9 | * at the stereo indicator as well. So, scanning will only find | |
10 | * stereo stations. Sad, but I can't help it. | |
11 | * | |
12 | * Also, the windows program sends oodles of messages over to the | |
13 | * device, and I couldn't figure out their meaning. My suspicion | |
14 | * is that they don't have any:-) | |
15 | * | |
16 | * You might find some interesting stuff about this module at | |
17 | * http://unimut.fsk.uni-heidelberg.de/unimut/demi/dsbr | |
18 | * | |
19 | * Fully tested with the Keene USB FM Transmitter and the v4l2-compliance tool. | |
20 | * | |
21 | * Copyright (c) 2000 Markus Demleitner <msdemlei@cl.uni-heidelberg.de> | |
1da177e4 LT |
22 | */ |
23 | ||
1da177e4 LT |
24 | #include <linux/kernel.h> |
25 | #include <linux/module.h> | |
26 | #include <linux/init.h> | |
27 | #include <linux/slab.h> | |
28 | #include <linux/input.h> | |
5aff308c | 29 | #include <linux/videodev2.h> |
5d778648 | 30 | #include <linux/usb.h> |
406827cc | 31 | #include <media/v4l2-device.h> |
35ea11ff | 32 | #include <media/v4l2-ioctl.h> |
5d778648 HV |
33 | #include <media/v4l2-ctrls.h> |
34 | #include <media/v4l2-event.h> | |
1da177e4 LT |
35 | |
36 | /* | |
37 | * Version Information | |
38 | */ | |
5d778648 HV |
39 | MODULE_AUTHOR("Markus Demleitner <msdemlei@tucana.harvard.edu>"); |
40 | MODULE_DESCRIPTION("D-Link DSB-R100 USB FM radio driver"); | |
41 | MODULE_LICENSE("GPL"); | |
42 | MODULE_VERSION("1.1.0"); | |
1da177e4 LT |
43 | |
44 | #define DSB100_VENDOR 0x04b4 | |
45 | #define DSB100_PRODUCT 0x1002 | |
46 | ||
47 | /* Commands the device appears to understand */ | |
48 | #define DSB100_TUNE 1 | |
49 | #define DSB100_ONOFF 2 | |
50 | ||
51 | #define TB_LEN 16 | |
52 | ||
53 | /* Frequency limits in MHz -- these are European values. For Japanese | |
54 | devices, that would be 76 and 91. */ | |
55 | #define FREQ_MIN 87.5 | |
56 | #define FREQ_MAX 108.0 | |
57 | #define FREQ_MUL 16000 | |
58 | ||
13099294 | 59 | #define v4l2_dev_to_radio(d) container_of(d, struct dsbr100_device, v4l2_dev) |
1da177e4 | 60 | |
1da177e4 LT |
61 | static int radio_nr = -1; |
62 | module_param(radio_nr, int, 0); | |
63 | ||
64 | /* Data for one (physical) device */ | |
5aff308c | 65 | struct dsbr100_device { |
1da177e4 | 66 | struct usb_device *usbdev; |
3a0efc32 | 67 | struct video_device videodev; |
406827cc | 68 | struct v4l2_device v4l2_dev; |
5d778648 | 69 | struct v4l2_ctrl_handler hdl; |
406827cc | 70 | |
863c86dd | 71 | u8 *transfer_buffer; |
e64d07c9 | 72 | struct mutex v4l2_lock; |
1da177e4 | 73 | int curfreq; |
5d778648 HV |
74 | bool stereo; |
75 | bool muted; | |
1da177e4 LT |
76 | }; |
77 | ||
78 | /* Low-level device interface begins here */ | |
79 | ||
5d778648 HV |
80 | /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */ |
81 | static int dsbr100_setfreq(struct dsbr100_device *radio, unsigned freq) | |
1da177e4 | 82 | { |
5d778648 HV |
83 | unsigned f = (freq / 16 * 80) / 1000 + 856; |
84 | int retval = 0; | |
85 | ||
86 | if (!radio->muted) { | |
87 | retval = usb_control_msg(radio->usbdev, | |
88 | usb_rcvctrlpipe(radio->usbdev, 0), | |
89 | DSB100_TUNE, | |
90 | USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, | |
91 | (f >> 8) & 0x00ff, f & 0xff, | |
92 | radio->transfer_buffer, 8, 300); | |
93 | if (retval >= 0) | |
94 | mdelay(1); | |
3a0efc32 AK |
95 | } |
96 | ||
5d778648 HV |
97 | if (retval >= 0) { |
98 | radio->curfreq = freq; | |
99 | return 0; | |
417b7953 | 100 | } |
417b7953 AK |
101 | dev_err(&radio->usbdev->dev, |
102 | "%s - usb_control_msg returned %i, request %i\n", | |
5d778648 | 103 | __func__, retval, DSB100_TUNE); |
d25cb646 | 104 | return retval; |
1da177e4 LT |
105 | } |
106 | ||
5d778648 HV |
107 | /* switch on radio */ |
108 | static int dsbr100_start(struct dsbr100_device *radio) | |
1da177e4 | 109 | { |
5d778648 | 110 | int retval = usb_control_msg(radio->usbdev, |
417b7953 AK |
111 | usb_rcvctrlpipe(radio->usbdev, 0), |
112 | DSB100_ONOFF, | |
113 | USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, | |
5d778648 | 114 | 0x01, 0x00, radio->transfer_buffer, 8, 300); |
417b7953 | 115 | |
5d778648 HV |
116 | if (retval >= 0) |
117 | return dsbr100_setfreq(radio, radio->curfreq); | |
417b7953 AK |
118 | dev_err(&radio->usbdev->dev, |
119 | "%s - usb_control_msg returned %i, request %i\n", | |
5d778648 | 120 | __func__, retval, DSB100_ONOFF); |
d25cb646 | 121 | return retval; |
417b7953 | 122 | |
1da177e4 LT |
123 | } |
124 | ||
5d778648 HV |
125 | /* switch off radio */ |
126 | static int dsbr100_stop(struct dsbr100_device *radio) | |
1da177e4 | 127 | { |
5d778648 | 128 | int retval = usb_control_msg(radio->usbdev, |
417b7953 | 129 | usb_rcvctrlpipe(radio->usbdev, 0), |
5d778648 | 130 | DSB100_ONOFF, |
417b7953 | 131 | USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, |
5d778648 | 132 | 0x00, 0x00, radio->transfer_buffer, 8, 300); |
417b7953 | 133 | |
5d778648 HV |
134 | if (retval >= 0) |
135 | return 0; | |
417b7953 AK |
136 | dev_err(&radio->usbdev->dev, |
137 | "%s - usb_control_msg returned %i, request %i\n", | |
5d778648 | 138 | __func__, retval, DSB100_ONOFF); |
d25cb646 | 139 | return retval; |
5d778648 | 140 | |
1da177e4 LT |
141 | } |
142 | ||
143 | /* return the device status. This is, in effect, just whether it | |
144 | sees a stereo signal or not. Pity. */ | |
5aff308c | 145 | static void dsbr100_getstat(struct dsbr100_device *radio) |
1da177e4 | 146 | { |
5d778648 | 147 | int retval = usb_control_msg(radio->usbdev, |
417b7953 | 148 | usb_rcvctrlpipe(radio->usbdev, 0), |
d56410e0 | 149 | USB_REQ_GET_STATUS, |
1da177e4 | 150 | USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, |
5d778648 | 151 | 0x00, 0x24, radio->transfer_buffer, 8, 300); |
417b7953 AK |
152 | |
153 | if (retval < 0) { | |
5d778648 | 154 | radio->stereo = false; |
417b7953 AK |
155 | dev_err(&radio->usbdev->dev, |
156 | "%s - usb_control_msg returned %i, request %i\n", | |
157 | __func__, retval, USB_REQ_GET_STATUS); | |
158 | } else { | |
223377e7 | 159 | radio->stereo = !(radio->transfer_buffer[0] & 0x01); |
417b7953 | 160 | } |
1da177e4 LT |
161 | } |
162 | ||
7002a4f3 DL |
163 | static int vidioc_querycap(struct file *file, void *priv, |
164 | struct v4l2_capability *v) | |
165 | { | |
c7181cfa AK |
166 | struct dsbr100_device *radio = video_drvdata(file); |
167 | ||
c0decac1 MCC |
168 | strscpy(v->driver, "dsbr100", sizeof(v->driver)); |
169 | strscpy(v->card, "D-Link R-100 USB FM Radio", sizeof(v->card)); | |
c7181cfa | 170 | usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info)); |
7002a4f3 DL |
171 | return 0; |
172 | } | |
1da177e4 | 173 | |
7002a4f3 DL |
174 | static int vidioc_g_tuner(struct file *file, void *priv, |
175 | struct v4l2_tuner *v) | |
1da177e4 | 176 | { |
c170ecf4 | 177 | struct dsbr100_device *radio = video_drvdata(file); |
7002a4f3 DL |
178 | |
179 | if (v->index > 0) | |
180 | return -EINVAL; | |
181 | ||
182 | dsbr100_getstat(radio); | |
cc1e6315 | 183 | strscpy(v->name, "FM", sizeof(v->name)); |
7002a4f3 | 184 | v->type = V4L2_TUNER_RADIO; |
223377e7 AK |
185 | v->rangelow = FREQ_MIN * FREQ_MUL; |
186 | v->rangehigh = FREQ_MAX * FREQ_MUL; | |
5d778648 HV |
187 | v->rxsubchans = radio->stereo ? V4L2_TUNER_SUB_STEREO : |
188 | V4L2_TUNER_SUB_MONO; | |
189 | v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO; | |
190 | v->audmode = V4L2_TUNER_MODE_STEREO; | |
191 | v->signal = radio->stereo ? 0xffff : 0; /* We can't get the signal strength */ | |
7002a4f3 DL |
192 | return 0; |
193 | } | |
1da177e4 | 194 | |
7002a4f3 | 195 | static int vidioc_s_tuner(struct file *file, void *priv, |
2f73c7c5 | 196 | const struct v4l2_tuner *v) |
7002a4f3 | 197 | { |
13099294 | 198 | return v->index ? -EINVAL : 0; |
7002a4f3 | 199 | } |
5aff308c | 200 | |
7002a4f3 | 201 | static int vidioc_s_frequency(struct file *file, void *priv, |
b530a447 | 202 | const struct v4l2_frequency *f) |
7002a4f3 | 203 | { |
c170ecf4 | 204 | struct dsbr100_device *radio = video_drvdata(file); |
1da177e4 | 205 | |
5d778648 HV |
206 | if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO) |
207 | return -EINVAL; | |
fdf9c997 | 208 | |
5d778648 HV |
209 | return dsbr100_setfreq(radio, clamp_t(unsigned, f->frequency, |
210 | FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL)); | |
7002a4f3 | 211 | } |
5aff308c | 212 | |
7002a4f3 DL |
213 | static int vidioc_g_frequency(struct file *file, void *priv, |
214 | struct v4l2_frequency *f) | |
215 | { | |
c170ecf4 | 216 | struct dsbr100_device *radio = video_drvdata(file); |
5aff308c | 217 | |
5d778648 HV |
218 | if (f->tuner) |
219 | return -EINVAL; | |
7002a4f3 DL |
220 | f->type = V4L2_TUNER_RADIO; |
221 | f->frequency = radio->curfreq; | |
222 | return 0; | |
223 | } | |
5aff308c | 224 | |
5d778648 | 225 | static int usb_dsbr100_s_ctrl(struct v4l2_ctrl *ctrl) |
7002a4f3 | 226 | { |
5d778648 HV |
227 | struct dsbr100_device *radio = |
228 | container_of(ctrl->handler, struct dsbr100_device, hdl); | |
1da177e4 | 229 | |
7002a4f3 DL |
230 | switch (ctrl->id) { |
231 | case V4L2_CID_AUDIO_MUTE: | |
5d778648 HV |
232 | radio->muted = ctrl->val; |
233 | return radio->muted ? dsbr100_stop(radio) : dsbr100_start(radio); | |
7002a4f3 DL |
234 | } |
235 | return -EINVAL; | |
236 | } | |
5aff308c | 237 | |
1da177e4 | 238 | |
e64d07c9 HV |
239 | /* USB subsystem interface begins here */ |
240 | ||
241 | /* | |
242 | * Handle unplugging of the device. | |
243 | * We call video_unregister_device in any case. | |
244 | * The last function called in this procedure is | |
245 | * usb_dsbr100_video_device_release | |
246 | */ | |
247 | static void usb_dsbr100_disconnect(struct usb_interface *intf) | |
248 | { | |
249 | struct dsbr100_device *radio = usb_get_intfdata(intf); | |
250 | ||
e64d07c9 | 251 | mutex_lock(&radio->v4l2_lock); |
5d778648 HV |
252 | /* |
253 | * Disconnect is also called on unload, and in that case we need to | |
254 | * mute the device. This call will silently fail if it is called | |
255 | * after a physical disconnect. | |
256 | */ | |
257 | usb_control_msg(radio->usbdev, | |
258 | usb_rcvctrlpipe(radio->usbdev, 0), | |
259 | DSB100_ONOFF, | |
260 | USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, | |
261 | 0x00, 0x00, radio->transfer_buffer, 8, 300); | |
13099294 | 262 | usb_set_intfdata(intf, NULL); |
e64d07c9 HV |
263 | video_unregister_device(&radio->videodev); |
264 | v4l2_device_disconnect(&radio->v4l2_dev); | |
13099294 HV |
265 | mutex_unlock(&radio->v4l2_lock); |
266 | v4l2_device_put(&radio->v4l2_dev); | |
e64d07c9 HV |
267 | } |
268 | ||
269 | ||
04e0ffbb AK |
270 | /* Suspend device - stop device. */ |
271 | static int usb_dsbr100_suspend(struct usb_interface *intf, pm_message_t message) | |
272 | { | |
273 | struct dsbr100_device *radio = usb_get_intfdata(intf); | |
04e0ffbb | 274 | |
e64d07c9 | 275 | mutex_lock(&radio->v4l2_lock); |
5d778648 HV |
276 | if (!radio->muted && dsbr100_stop(radio) < 0) |
277 | dev_warn(&intf->dev, "dsbr100_stop failed\n"); | |
e64d07c9 | 278 | mutex_unlock(&radio->v4l2_lock); |
04e0ffbb AK |
279 | |
280 | dev_info(&intf->dev, "going into suspend..\n"); | |
04e0ffbb AK |
281 | return 0; |
282 | } | |
283 | ||
284 | /* Resume device - start device. */ | |
285 | static int usb_dsbr100_resume(struct usb_interface *intf) | |
286 | { | |
287 | struct dsbr100_device *radio = usb_get_intfdata(intf); | |
04e0ffbb | 288 | |
e64d07c9 | 289 | mutex_lock(&radio->v4l2_lock); |
5d778648 HV |
290 | if (!radio->muted && dsbr100_start(radio) < 0) |
291 | dev_warn(&intf->dev, "dsbr100_start failed\n"); | |
e64d07c9 | 292 | mutex_unlock(&radio->v4l2_lock); |
04e0ffbb AK |
293 | |
294 | dev_info(&intf->dev, "coming out of suspend..\n"); | |
04e0ffbb AK |
295 | return 0; |
296 | } | |
297 | ||
fc55bcb0 | 298 | /* free data structures */ |
13099294 | 299 | static void usb_dsbr100_release(struct v4l2_device *v4l2_dev) |
3a0efc32 | 300 | { |
13099294 | 301 | struct dsbr100_device *radio = v4l2_dev_to_radio(v4l2_dev); |
3a0efc32 | 302 | |
5d778648 | 303 | v4l2_ctrl_handler_free(&radio->hdl); |
406827cc | 304 | v4l2_device_unregister(&radio->v4l2_dev); |
3a0efc32 AK |
305 | kfree(radio->transfer_buffer); |
306 | kfree(radio); | |
307 | } | |
308 | ||
5d778648 HV |
309 | static const struct v4l2_ctrl_ops usb_dsbr100_ctrl_ops = { |
310 | .s_ctrl = usb_dsbr100_s_ctrl, | |
311 | }; | |
312 | ||
7002a4f3 | 313 | /* File system interface */ |
bec43661 | 314 | static const struct v4l2_file_operations usb_dsbr100_fops = { |
7002a4f3 | 315 | .owner = THIS_MODULE, |
e64d07c9 | 316 | .unlocked_ioctl = video_ioctl2, |
5d778648 HV |
317 | .open = v4l2_fh_open, |
318 | .release = v4l2_fh_release, | |
319 | .poll = v4l2_ctrl_poll, | |
7002a4f3 DL |
320 | }; |
321 | ||
a399810c | 322 | static const struct v4l2_ioctl_ops usb_dsbr100_ioctl_ops = { |
7002a4f3 DL |
323 | .vidioc_querycap = vidioc_querycap, |
324 | .vidioc_g_tuner = vidioc_g_tuner, | |
325 | .vidioc_s_tuner = vidioc_s_tuner, | |
326 | .vidioc_g_frequency = vidioc_g_frequency, | |
327 | .vidioc_s_frequency = vidioc_s_frequency, | |
5d778648 HV |
328 | .vidioc_log_status = v4l2_ctrl_log_status, |
329 | .vidioc_subscribe_event = v4l2_ctrl_subscribe_event, | |
330 | .vidioc_unsubscribe_event = v4l2_event_unsubscribe, | |
7002a4f3 DL |
331 | }; |
332 | ||
fc55bcb0 | 333 | /* check if the device is present and register with v4l and usb if it is */ |
7002a4f3 DL |
334 | static int usb_dsbr100_probe(struct usb_interface *intf, |
335 | const struct usb_device_id *id) | |
336 | { | |
337 | struct dsbr100_device *radio; | |
406827cc | 338 | struct v4l2_device *v4l2_dev; |
417b7953 | 339 | int retval; |
7002a4f3 | 340 | |
406827cc | 341 | radio = kzalloc(sizeof(struct dsbr100_device), GFP_KERNEL); |
223377e7 AK |
342 | |
343 | if (!radio) | |
7002a4f3 | 344 | return -ENOMEM; |
223377e7 AK |
345 | |
346 | radio->transfer_buffer = kmalloc(TB_LEN, GFP_KERNEL); | |
347 | ||
348 | if (!(radio->transfer_buffer)) { | |
863c86dd ON |
349 | kfree(radio); |
350 | return -ENOMEM; | |
351 | } | |
223377e7 | 352 | |
406827cc | 353 | v4l2_dev = &radio->v4l2_dev; |
13099294 | 354 | v4l2_dev->release = usb_dsbr100_release; |
406827cc AK |
355 | |
356 | retval = v4l2_device_register(&intf->dev, v4l2_dev); | |
357 | if (retval < 0) { | |
358 | v4l2_err(v4l2_dev, "couldn't register v4l2_device\n"); | |
5d778648 | 359 | goto err_reg_dev; |
406827cc AK |
360 | } |
361 | ||
5d778648 HV |
362 | v4l2_ctrl_handler_init(&radio->hdl, 1); |
363 | v4l2_ctrl_new_std(&radio->hdl, &usb_dsbr100_ctrl_ops, | |
364 | V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1); | |
365 | if (radio->hdl.error) { | |
366 | retval = radio->hdl.error; | |
367 | v4l2_err(v4l2_dev, "couldn't register control\n"); | |
368 | goto err_reg_ctrl; | |
369 | } | |
e64d07c9 | 370 | mutex_init(&radio->v4l2_lock); |
c0decac1 MCC |
371 | strscpy(radio->videodev.name, v4l2_dev->name, |
372 | sizeof(radio->videodev.name)); | |
406827cc AK |
373 | radio->videodev.v4l2_dev = v4l2_dev; |
374 | radio->videodev.fops = &usb_dsbr100_fops; | |
375 | radio->videodev.ioctl_ops = &usb_dsbr100_ioctl_ops; | |
13099294 | 376 | radio->videodev.release = video_device_release_empty; |
e64d07c9 | 377 | radio->videodev.lock = &radio->v4l2_lock; |
5d778648 | 378 | radio->videodev.ctrl_handler = &radio->hdl; |
e83ce300 | 379 | radio->videodev.device_caps = V4L2_CAP_RADIO | V4L2_CAP_TUNER; |
3a0efc32 | 380 | |
7002a4f3 | 381 | radio->usbdev = interface_to_usbdev(intf); |
223377e7 | 382 | radio->curfreq = FREQ_MIN * FREQ_MUL; |
5d778648 | 383 | radio->muted = true; |
406827cc | 384 | |
3a0efc32 | 385 | video_set_drvdata(&radio->videodev, radio); |
5d778648 | 386 | usb_set_intfdata(intf, radio); |
406827cc | 387 | |
417b7953 | 388 | retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO, radio_nr); |
5d778648 HV |
389 | if (retval == 0) |
390 | return 0; | |
391 | v4l2_err(v4l2_dev, "couldn't register video device\n"); | |
392 | ||
393 | err_reg_ctrl: | |
394 | v4l2_ctrl_handler_free(&radio->hdl); | |
395 | v4l2_device_unregister(v4l2_dev); | |
396 | err_reg_dev: | |
397 | kfree(radio->transfer_buffer); | |
398 | kfree(radio); | |
399 | return retval; | |
7002a4f3 DL |
400 | } |
401 | ||
1ab2234e | 402 | static const struct usb_device_id usb_dsbr100_device_table[] = { |
5d778648 HV |
403 | { USB_DEVICE(DSB100_VENDOR, DSB100_PRODUCT) }, |
404 | { } /* Terminating entry */ | |
405 | }; | |
1da177e4 | 406 | |
5d778648 HV |
407 | MODULE_DEVICE_TABLE(usb, usb_dsbr100_device_table); |
408 | ||
409 | /* USB subsystem interface */ | |
410 | static struct usb_driver usb_dsbr100_driver = { | |
411 | .name = "dsbr100", | |
412 | .probe = usb_dsbr100_probe, | |
413 | .disconnect = usb_dsbr100_disconnect, | |
414 | .id_table = usb_dsbr100_device_table, | |
415 | .suspend = usb_dsbr100_suspend, | |
416 | .resume = usb_dsbr100_resume, | |
417 | .reset_resume = usb_dsbr100_resume, | |
418 | }; | |
419 | ||
420 | module_usb_driver(usb_dsbr100_driver); |