2 * A driver for the AverMedia MR 800 USB FM radio. This device plugs
3 * into both the USB and an analog audio input, so this thing
4 * only deals with initialization and frequency setting, the
5 * audio data has to be handled by a sound driver.
7 * Copyright (c) 2008 Alexey Klimov <klimov.linux@gmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Big thanks to authors and contributors of dsbr100.c and radio-si470x.c
27 * When work was looked pretty good, i discover this:
28 * http://av-usbradio.sourceforge.net/index.php
29 * http://sourceforge.net/projects/av-usbradio/
30 * Latest release of theirs project was in 2005.
31 * Probably, this driver could be improved trough using their
32 * achievements (specifications given).
33 * Also, Faidon Liambotis <paravoid@debian.org> wrote nice driver for this radio
34 * in 2007. He allowed to use his driver to improve current mr800 radio driver.
35 * http://kerneltrap.org/mailarchive/linux-usb-devel/2007/10/11/342492
37 * Version 0.01: First working version.
38 * It's required to blacklist AverMedia USB Radio
39 * in usbhid/hid-quirks.c
40 * Version 0.10: A lot of cleanups and fixes: unpluging the device,
41 * few mutex locks were added, codinstyle issues, etc.
42 * Added stereo support. Thanks to
43 * Douglas Schilling Landgraf <dougsland@gmail.com> and
44 * David Ellingsworth <david@identd.dyndns.org>
45 * for discussion, help and support.
46 * Version 0.11: Converted to v4l2_device.
49 * - Correct power management of device (suspend & resume)
50 * - Add code for scanning and smooth tuning
51 * - Add code for sensitivity value
53 * - In Japan another FREQ_MIN and FREQ_MAX
57 #include <linux/kernel.h>
58 #include <linux/module.h>
59 #include <linux/init.h>
60 #include <linux/slab.h>
61 #include <linux/smp_lock.h>
62 #include <linux/input.h>
63 #include <linux/videodev2.h>
64 #include <media/v4l2-device.h>
65 #include <media/v4l2-ioctl.h>
66 #include <linux/usb.h>
67 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
68 #include <linux/mutex.h>
70 /* driver and module definitions */
71 #define DRIVER_AUTHOR "Alexey Klimov <klimov.linux@gmail.com>"
72 #define DRIVER_DESC "AverMedia MR 800 USB FM radio driver"
73 #define DRIVER_VERSION "0.11"
74 #define RADIO_VERSION KERNEL_VERSION(0, 1, 1)
76 MODULE_AUTHOR(DRIVER_AUTHOR);
77 MODULE_DESCRIPTION(DRIVER_DESC);
78 MODULE_LICENSE("GPL");
80 #define USB_AMRADIO_VENDOR 0x07ca
81 #define USB_AMRADIO_PRODUCT 0xb800
83 /* dev_warn macro with driver name */
84 #define MR800_DRIVER_NAME "radio-mr800"
85 #define amradio_dev_warn(dev, fmt, arg...) \
86 dev_warn(dev, MR800_DRIVER_NAME " - " fmt, ##arg)
88 /* Probably USB_TIMEOUT should be modified in module parameter */
89 #define BUFFER_LENGTH 8
90 #define USB_TIMEOUT 500
92 /* Frequency limits in MHz -- these are European values. For Japanese
93 devices, that would be 76 and 91. */
95 #define FREQ_MAX 108.0
96 #define FREQ_MUL 16000
99 * Commands that device should understand
100 * List isnt full and will be updated with implementation of new functions
102 #define AMRADIO_SET_FREQ 0xa4
103 #define AMRADIO_SET_MUTE 0xab
104 #define AMRADIO_SET_MONO 0xae
106 /* Comfortable defines for amradio_set_mute */
107 #define AMRADIO_START 0x00
108 #define AMRADIO_STOP 0x01
110 /* Comfortable defines for amradio_set_stereo */
111 #define WANT_STEREO 0x00
112 #define WANT_MONO 0x01
114 /* module parameter */
115 static int radio_nr = -1;
116 module_param(radio_nr, int, 0);
117 MODULE_PARM_DESC(radio_nr, "Radio Nr");
119 static int usb_amradio_probe(struct usb_interface *intf,
120 const struct usb_device_id *id);
121 static void usb_amradio_disconnect(struct usb_interface *intf);
122 static int usb_amradio_open(struct file *file);
123 static int usb_amradio_close(struct file *file);
124 static int usb_amradio_suspend(struct usb_interface *intf,
125 pm_message_t message);
126 static int usb_amradio_resume(struct usb_interface *intf);
128 /* Data for one (physical) device */
129 struct amradio_device {
130 /* reference to USB and video device */
131 struct usb_device *usbdev;
132 struct video_device *videodev;
133 struct v4l2_device v4l2_dev;
135 unsigned char *buffer;
136 struct mutex lock; /* buffer locking */
144 /* USB Device ID List */
145 static struct usb_device_id usb_amradio_device_table[] = {
146 {USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
147 USB_CLASS_HID, 0, 0) },
148 { } /* Terminating entry */
151 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
153 /* USB subsystem interface */
154 static struct usb_driver usb_amradio_driver = {
155 .name = MR800_DRIVER_NAME,
156 .probe = usb_amradio_probe,
157 .disconnect = usb_amradio_disconnect,
158 .suspend = usb_amradio_suspend,
159 .resume = usb_amradio_resume,
160 .reset_resume = usb_amradio_resume,
161 .id_table = usb_amradio_device_table,
162 .supports_autosuspend = 0,
165 /* switch on/off the radio. Send 8 bytes to device */
166 static int amradio_set_mute(struct amradio_device *radio, char argument)
171 BUG_ON(!mutex_is_locked(&radio->lock));
173 radio->buffer[0] = 0x00;
174 radio->buffer[1] = 0x55;
175 radio->buffer[2] = 0xaa;
176 radio->buffer[3] = 0x00;
177 radio->buffer[4] = AMRADIO_SET_MUTE;
178 radio->buffer[5] = argument;
179 radio->buffer[6] = 0x00;
180 radio->buffer[7] = 0x00;
182 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
183 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
185 if (retval < 0 || size != BUFFER_LENGTH)
188 radio->muted = argument;
193 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
194 static int amradio_setfreq(struct amradio_device *radio, int freq)
198 unsigned short freq_send = 0x10 + (freq >> 3) / 25;
200 BUG_ON(!mutex_is_locked(&radio->lock));
202 radio->buffer[0] = 0x00;
203 radio->buffer[1] = 0x55;
204 radio->buffer[2] = 0xaa;
205 radio->buffer[3] = 0x03;
206 radio->buffer[4] = AMRADIO_SET_FREQ;
207 radio->buffer[5] = 0x00;
208 radio->buffer[6] = 0x00;
209 radio->buffer[7] = 0x08;
211 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
212 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
214 if (retval < 0 || size != BUFFER_LENGTH)
217 /* frequency is calculated from freq_send and placed in first 2 bytes */
218 radio->buffer[0] = (freq_send >> 8) & 0xff;
219 radio->buffer[1] = freq_send & 0xff;
220 radio->buffer[2] = 0x01;
221 radio->buffer[3] = 0x00;
222 radio->buffer[4] = 0x00;
223 /* 5 and 6 bytes of buffer already = 0x00 */
224 radio->buffer[7] = 0x00;
226 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
227 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
232 static int amradio_set_stereo(struct amradio_device *radio, char argument)
237 BUG_ON(!mutex_is_locked(&radio->lock));
239 radio->buffer[0] = 0x00;
240 radio->buffer[1] = 0x55;
241 radio->buffer[2] = 0xaa;
242 radio->buffer[3] = 0x00;
243 radio->buffer[4] = AMRADIO_SET_MONO;
244 radio->buffer[5] = argument;
245 radio->buffer[6] = 0x00;
246 radio->buffer[7] = 0x00;
248 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
249 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
251 if (retval < 0 || size != BUFFER_LENGTH) {
261 /* Handle unplugging the device.
262 * We call video_unregister_device in any case.
263 * The last function called in this procedure is
264 * usb_amradio_device_release.
266 static void usb_amradio_disconnect(struct usb_interface *intf)
268 struct amradio_device *radio = usb_get_intfdata(intf);
270 mutex_lock(&radio->lock);
272 mutex_unlock(&radio->lock);
274 usb_set_intfdata(intf, NULL);
275 video_unregister_device(radio->videodev);
276 v4l2_device_disconnect(&radio->v4l2_dev);
279 /* vidioc_querycap - query device capabilities */
280 static int vidioc_querycap(struct file *file, void *priv,
281 struct v4l2_capability *v)
283 struct amradio_device *radio = video_drvdata(file);
285 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
286 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
287 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
288 v->version = RADIO_VERSION;
289 v->capabilities = V4L2_CAP_TUNER;
293 /* vidioc_g_tuner - get tuner attributes */
294 static int vidioc_g_tuner(struct file *file, void *priv,
295 struct v4l2_tuner *v)
297 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
300 mutex_lock(&radio->lock);
303 if (radio->removed) {
313 /* TODO: Add function which look is signal stereo or not
314 * amradio_getstat(radio);
317 /* we call amradio_set_stereo to set radio->stereo
318 * Honestly, amradio_getstat should cover this in future and
319 * amradio_set_stereo shouldn't be here
321 retval = amradio_set_stereo(radio, WANT_STEREO);
323 amradio_dev_warn(&radio->videodev->dev,
324 "set stereo failed\n");
326 strcpy(v->name, "FM");
327 v->type = V4L2_TUNER_RADIO;
328 v->rangelow = FREQ_MIN * FREQ_MUL;
329 v->rangehigh = FREQ_MAX * FREQ_MUL;
330 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
331 v->capability = V4L2_TUNER_CAP_LOW;
333 v->audmode = V4L2_TUNER_MODE_STEREO;
335 v->audmode = V4L2_TUNER_MODE_MONO;
336 v->signal = 0xffff; /* Can't get the signal strength, sad.. */
337 v->afc = 0; /* Don't know what is this */
340 mutex_unlock(&radio->lock);
344 /* vidioc_s_tuner - set tuner attributes */
345 static int vidioc_s_tuner(struct file *file, void *priv,
346 struct v4l2_tuner *v)
348 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
351 mutex_lock(&radio->lock);
354 if (radio->removed) {
364 /* mono/stereo selector */
365 switch (v->audmode) {
366 case V4L2_TUNER_MODE_MONO:
367 retval = amradio_set_stereo(radio, WANT_MONO);
369 amradio_dev_warn(&radio->videodev->dev,
370 "set mono failed\n");
372 case V4L2_TUNER_MODE_STEREO:
373 retval = amradio_set_stereo(radio, WANT_STEREO);
375 amradio_dev_warn(&radio->videodev->dev,
376 "set stereo failed\n");
383 mutex_unlock(&radio->lock);
387 /* vidioc_s_frequency - set tuner radio frequency */
388 static int vidioc_s_frequency(struct file *file, void *priv,
389 struct v4l2_frequency *f)
391 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
394 mutex_lock(&radio->lock);
397 if (radio->removed) {
402 radio->curfreq = f->frequency;
404 retval = amradio_setfreq(radio, radio->curfreq);
406 amradio_dev_warn(&radio->videodev->dev,
407 "set frequency failed\n");
410 mutex_unlock(&radio->lock);
414 /* vidioc_g_frequency - get tuner radio frequency */
415 static int vidioc_g_frequency(struct file *file, void *priv,
416 struct v4l2_frequency *f)
418 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
421 mutex_lock(&radio->lock);
424 if (radio->removed) {
429 f->type = V4L2_TUNER_RADIO;
430 f->frequency = radio->curfreq;
433 mutex_unlock(&radio->lock);
437 /* vidioc_queryctrl - enumerate control items */
438 static int vidioc_queryctrl(struct file *file, void *priv,
439 struct v4l2_queryctrl *qc)
442 case V4L2_CID_AUDIO_MUTE:
443 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
449 /* vidioc_g_ctrl - get the value of a control */
450 static int vidioc_g_ctrl(struct file *file, void *priv,
451 struct v4l2_control *ctrl)
453 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
454 int retval = -EINVAL;
456 mutex_lock(&radio->lock);
459 if (radio->removed) {
465 case V4L2_CID_AUDIO_MUTE:
466 ctrl->value = radio->muted;
472 mutex_unlock(&radio->lock);
476 /* vidioc_s_ctrl - set the value of a control */
477 static int vidioc_s_ctrl(struct file *file, void *priv,
478 struct v4l2_control *ctrl)
480 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
481 int retval = -EINVAL;
483 mutex_lock(&radio->lock);
486 if (radio->removed) {
492 case V4L2_CID_AUDIO_MUTE:
494 retval = amradio_set_mute(radio, AMRADIO_STOP);
496 amradio_dev_warn(&radio->videodev->dev,
497 "amradio_stop failed\n");
500 retval = amradio_set_mute(radio, AMRADIO_START);
502 amradio_dev_warn(&radio->videodev->dev,
503 "amradio_start failed\n");
510 mutex_unlock(&radio->lock);
514 /* vidioc_g_audio - get audio attributes */
515 static int vidioc_g_audio(struct file *file, void *priv,
516 struct v4l2_audio *a)
521 strcpy(a->name, "Radio");
522 a->capability = V4L2_AUDCAP_STEREO;
526 /* vidioc_s_audio - set audio attributes */
527 static int vidioc_s_audio(struct file *file, void *priv,
528 struct v4l2_audio *a)
535 /* vidioc_g_input - get input */
536 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
542 /* vidioc_s_input - set input */
543 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
550 /* open device - amradio_start() and amradio_setfreq() */
551 static int usb_amradio_open(struct file *file)
553 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
556 mutex_lock(&radio->lock);
558 if (radio->removed) {
566 retval = amradio_set_mute(radio, AMRADIO_START);
568 amradio_dev_warn(&radio->videodev->dev,
569 "radio did not start up properly\n");
574 retval = amradio_set_stereo(radio, WANT_STEREO);
576 amradio_dev_warn(&radio->videodev->dev,
577 "set stereo failed\n");
579 retval = amradio_setfreq(radio, radio->curfreq);
581 amradio_dev_warn(&radio->videodev->dev,
582 "set frequency failed\n");
585 mutex_unlock(&radio->lock);
590 static int usb_amradio_close(struct file *file)
592 struct amradio_device *radio = video_get_drvdata(video_devdata(file));
595 mutex_lock(&radio->lock);
597 if (radio->removed) {
604 if (!radio->removed) {
605 retval = amradio_set_mute(radio, AMRADIO_STOP);
607 amradio_dev_warn(&radio->videodev->dev,
608 "amradio_stop failed\n");
612 mutex_unlock(&radio->lock);
616 /* Suspend device - stop device. Need to be checked and fixed */
617 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
619 struct amradio_device *radio = usb_get_intfdata(intf);
622 mutex_lock(&radio->lock);
624 retval = amradio_set_mute(radio, AMRADIO_STOP);
626 dev_warn(&intf->dev, "amradio_stop failed\n");
628 dev_info(&intf->dev, "going into suspend..\n");
630 mutex_unlock(&radio->lock);
634 /* Resume device - start device. Need to be checked and fixed */
635 static int usb_amradio_resume(struct usb_interface *intf)
637 struct amradio_device *radio = usb_get_intfdata(intf);
640 mutex_lock(&radio->lock);
642 retval = amradio_set_mute(radio, AMRADIO_START);
644 dev_warn(&intf->dev, "amradio_start failed\n");
646 dev_info(&intf->dev, "coming out of suspend..\n");
648 mutex_unlock(&radio->lock);
652 /* File system interface */
653 static const struct v4l2_file_operations usb_amradio_fops = {
654 .owner = THIS_MODULE,
655 .open = usb_amradio_open,
656 .release = usb_amradio_close,
657 .ioctl = video_ioctl2,
660 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
661 .vidioc_querycap = vidioc_querycap,
662 .vidioc_g_tuner = vidioc_g_tuner,
663 .vidioc_s_tuner = vidioc_s_tuner,
664 .vidioc_g_frequency = vidioc_g_frequency,
665 .vidioc_s_frequency = vidioc_s_frequency,
666 .vidioc_queryctrl = vidioc_queryctrl,
667 .vidioc_g_ctrl = vidioc_g_ctrl,
668 .vidioc_s_ctrl = vidioc_s_ctrl,
669 .vidioc_g_audio = vidioc_g_audio,
670 .vidioc_s_audio = vidioc_s_audio,
671 .vidioc_g_input = vidioc_g_input,
672 .vidioc_s_input = vidioc_s_input,
675 static void usb_amradio_video_device_release(struct video_device *videodev)
677 struct amradio_device *radio = video_get_drvdata(videodev);
679 /* we call v4l to free radio->videodev */
680 video_device_release(videodev);
682 v4l2_device_unregister(&radio->v4l2_dev);
684 /* free rest memory */
685 kfree(radio->buffer);
689 /* check if the device is present and register with v4l and usb if it is */
690 static int usb_amradio_probe(struct usb_interface *intf,
691 const struct usb_device_id *id)
693 struct amradio_device *radio;
694 struct v4l2_device *v4l2_dev;
697 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
700 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
704 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
706 if (!radio->buffer) {
707 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
712 v4l2_dev = &radio->v4l2_dev;
713 retval = v4l2_device_register(&intf->dev, v4l2_dev);
715 dev_err(&intf->dev, "couldn't register v4l2_device\n");
716 kfree(radio->buffer);
721 radio->videodev = video_device_alloc();
723 if (!radio->videodev) {
724 dev_err(&intf->dev, "video_device_alloc failed\n");
725 kfree(radio->buffer);
730 strlcpy(radio->videodev->name, v4l2_dev->name, sizeof(radio->videodev->name));
731 radio->videodev->v4l2_dev = v4l2_dev;
732 radio->videodev->fops = &usb_amradio_fops;
733 radio->videodev->ioctl_ops = &usb_amradio_ioctl_ops;
734 radio->videodev->release = usb_amradio_video_device_release;
738 radio->usbdev = interface_to_usbdev(intf);
739 radio->curfreq = 95.16 * FREQ_MUL;
742 mutex_init(&radio->lock);
744 video_set_drvdata(radio->videodev, radio);
746 retval = video_register_device(radio->videodev, VFL_TYPE_RADIO, radio_nr);
748 dev_err(&intf->dev, "could not register video device\n");
749 video_device_release(radio->videodev);
750 v4l2_device_unregister(v4l2_dev);
751 kfree(radio->buffer);
756 usb_set_intfdata(intf, radio);
760 static int __init amradio_init(void)
762 int retval = usb_register(&usb_amradio_driver);
764 pr_info(KBUILD_MODNAME
765 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
768 pr_err(KBUILD_MODNAME
769 ": usb_register failed. Error number %d\n", retval);
774 static void __exit amradio_exit(void)
776 usb_deregister(&usb_amradio_driver);
779 module_init(amradio_init);
780 module_exit(amradio_exit);