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 #define vdev_to_amradio(r) container_of(r, struct amradio_device, videodev)
146 /* USB Device ID List */
147 static struct usb_device_id usb_amradio_device_table[] = {
148 {USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
149 USB_CLASS_HID, 0, 0) },
150 { } /* Terminating entry */
153 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
155 /* USB subsystem interface */
156 static struct usb_driver usb_amradio_driver = {
157 .name = MR800_DRIVER_NAME,
158 .probe = usb_amradio_probe,
159 .disconnect = usb_amradio_disconnect,
160 .suspend = usb_amradio_suspend,
161 .resume = usb_amradio_resume,
162 .reset_resume = usb_amradio_resume,
163 .id_table = usb_amradio_device_table,
164 .supports_autosuspend = 0,
167 /* switch on/off the radio. Send 8 bytes to device */
168 static int amradio_set_mute(struct amradio_device *radio, char argument)
173 BUG_ON(!mutex_is_locked(&radio->lock));
175 radio->buffer[0] = 0x00;
176 radio->buffer[1] = 0x55;
177 radio->buffer[2] = 0xaa;
178 radio->buffer[3] = 0x00;
179 radio->buffer[4] = AMRADIO_SET_MUTE;
180 radio->buffer[5] = argument;
181 radio->buffer[6] = 0x00;
182 radio->buffer[7] = 0x00;
184 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
185 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
187 if (retval < 0 || size != BUFFER_LENGTH)
190 radio->muted = argument;
195 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
196 static int amradio_setfreq(struct amradio_device *radio, int freq)
200 unsigned short freq_send = 0x10 + (freq >> 3) / 25;
202 BUG_ON(!mutex_is_locked(&radio->lock));
204 radio->buffer[0] = 0x00;
205 radio->buffer[1] = 0x55;
206 radio->buffer[2] = 0xaa;
207 radio->buffer[3] = 0x03;
208 radio->buffer[4] = AMRADIO_SET_FREQ;
209 radio->buffer[5] = 0x00;
210 radio->buffer[6] = 0x00;
211 radio->buffer[7] = 0x08;
213 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
214 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
216 if (retval < 0 || size != BUFFER_LENGTH)
219 /* frequency is calculated from freq_send and placed in first 2 bytes */
220 radio->buffer[0] = (freq_send >> 8) & 0xff;
221 radio->buffer[1] = freq_send & 0xff;
222 radio->buffer[2] = 0x01;
223 radio->buffer[3] = 0x00;
224 radio->buffer[4] = 0x00;
225 /* 5 and 6 bytes of buffer already = 0x00 */
226 radio->buffer[7] = 0x00;
228 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
229 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
234 static int amradio_set_stereo(struct amradio_device *radio, char argument)
239 BUG_ON(!mutex_is_locked(&radio->lock));
241 radio->buffer[0] = 0x00;
242 radio->buffer[1] = 0x55;
243 radio->buffer[2] = 0xaa;
244 radio->buffer[3] = 0x00;
245 radio->buffer[4] = AMRADIO_SET_MONO;
246 radio->buffer[5] = argument;
247 radio->buffer[6] = 0x00;
248 radio->buffer[7] = 0x00;
250 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
251 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
253 if (retval < 0 || size != BUFFER_LENGTH) {
263 /* Handle unplugging the device.
264 * We call video_unregister_device in any case.
265 * The last function called in this procedure is
266 * usb_amradio_device_release.
268 static void usb_amradio_disconnect(struct usb_interface *intf)
270 struct amradio_device *radio = usb_get_intfdata(intf);
272 mutex_lock(&radio->lock);
274 mutex_unlock(&radio->lock);
276 usb_set_intfdata(intf, NULL);
277 video_unregister_device(&radio->videodev);
278 v4l2_device_disconnect(&radio->v4l2_dev);
281 /* vidioc_querycap - query device capabilities */
282 static int vidioc_querycap(struct file *file, void *priv,
283 struct v4l2_capability *v)
285 struct amradio_device *radio = file->private_data;
287 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
288 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
289 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
290 v->version = RADIO_VERSION;
291 v->capabilities = V4L2_CAP_TUNER;
295 /* vidioc_g_tuner - get tuner attributes */
296 static int vidioc_g_tuner(struct file *file, void *priv,
297 struct v4l2_tuner *v)
299 struct amradio_device *radio = file->private_data;
302 mutex_lock(&radio->lock);
305 if (radio->removed) {
315 /* TODO: Add function which look is signal stereo or not
316 * amradio_getstat(radio);
319 /* we call amradio_set_stereo to set radio->stereo
320 * Honestly, amradio_getstat should cover this in future and
321 * amradio_set_stereo shouldn't be here
323 retval = amradio_set_stereo(radio, WANT_STEREO);
325 amradio_dev_warn(&radio->videodev.dev,
326 "set stereo failed\n");
328 strcpy(v->name, "FM");
329 v->type = V4L2_TUNER_RADIO;
330 v->rangelow = FREQ_MIN * FREQ_MUL;
331 v->rangehigh = FREQ_MAX * FREQ_MUL;
332 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
333 v->capability = V4L2_TUNER_CAP_LOW;
335 v->audmode = V4L2_TUNER_MODE_STEREO;
337 v->audmode = V4L2_TUNER_MODE_MONO;
338 v->signal = 0xffff; /* Can't get the signal strength, sad.. */
339 v->afc = 0; /* Don't know what is this */
342 mutex_unlock(&radio->lock);
346 /* vidioc_s_tuner - set tuner attributes */
347 static int vidioc_s_tuner(struct file *file, void *priv,
348 struct v4l2_tuner *v)
350 struct amradio_device *radio = file->private_data;
353 mutex_lock(&radio->lock);
356 if (radio->removed) {
366 /* mono/stereo selector */
367 switch (v->audmode) {
368 case V4L2_TUNER_MODE_MONO:
369 retval = amradio_set_stereo(radio, WANT_MONO);
371 amradio_dev_warn(&radio->videodev.dev,
372 "set mono failed\n");
374 case V4L2_TUNER_MODE_STEREO:
375 retval = amradio_set_stereo(radio, WANT_STEREO);
377 amradio_dev_warn(&radio->videodev.dev,
378 "set stereo failed\n");
385 mutex_unlock(&radio->lock);
389 /* vidioc_s_frequency - set tuner radio frequency */
390 static int vidioc_s_frequency(struct file *file, void *priv,
391 struct v4l2_frequency *f)
393 struct amradio_device *radio = file->private_data;
396 mutex_lock(&radio->lock);
399 if (radio->removed) {
404 radio->curfreq = f->frequency;
406 retval = amradio_setfreq(radio, radio->curfreq);
408 amradio_dev_warn(&radio->videodev.dev,
409 "set frequency failed\n");
412 mutex_unlock(&radio->lock);
416 /* vidioc_g_frequency - get tuner radio frequency */
417 static int vidioc_g_frequency(struct file *file, void *priv,
418 struct v4l2_frequency *f)
420 struct amradio_device *radio = file->private_data;
423 mutex_lock(&radio->lock);
426 if (radio->removed) {
431 f->type = V4L2_TUNER_RADIO;
432 f->frequency = radio->curfreq;
435 mutex_unlock(&radio->lock);
439 /* vidioc_queryctrl - enumerate control items */
440 static int vidioc_queryctrl(struct file *file, void *priv,
441 struct v4l2_queryctrl *qc)
444 case V4L2_CID_AUDIO_MUTE:
445 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
451 /* vidioc_g_ctrl - get the value of a control */
452 static int vidioc_g_ctrl(struct file *file, void *priv,
453 struct v4l2_control *ctrl)
455 struct amradio_device *radio = file->private_data;
456 int retval = -EINVAL;
458 mutex_lock(&radio->lock);
461 if (radio->removed) {
467 case V4L2_CID_AUDIO_MUTE:
468 ctrl->value = radio->muted;
474 mutex_unlock(&radio->lock);
478 /* vidioc_s_ctrl - set the value of a control */
479 static int vidioc_s_ctrl(struct file *file, void *priv,
480 struct v4l2_control *ctrl)
482 struct amradio_device *radio = file->private_data;
483 int retval = -EINVAL;
485 mutex_lock(&radio->lock);
488 if (radio->removed) {
494 case V4L2_CID_AUDIO_MUTE:
496 retval = amradio_set_mute(radio, AMRADIO_STOP);
498 amradio_dev_warn(&radio->videodev.dev,
499 "amradio_stop failed\n");
502 retval = amradio_set_mute(radio, AMRADIO_START);
504 amradio_dev_warn(&radio->videodev.dev,
505 "amradio_start failed\n");
512 mutex_unlock(&radio->lock);
516 /* vidioc_g_audio - get audio attributes */
517 static int vidioc_g_audio(struct file *file, void *priv,
518 struct v4l2_audio *a)
523 strcpy(a->name, "Radio");
524 a->capability = V4L2_AUDCAP_STEREO;
528 /* vidioc_s_audio - set audio attributes */
529 static int vidioc_s_audio(struct file *file, void *priv,
530 struct v4l2_audio *a)
537 /* vidioc_g_input - get input */
538 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
544 /* vidioc_s_input - set input */
545 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
552 /* open device - amradio_start() and amradio_setfreq() */
553 static int usb_amradio_open(struct file *file)
555 struct amradio_device *radio = vdev_to_amradio(video_devdata(file));
558 mutex_lock(&radio->lock);
560 if (radio->removed) {
565 file->private_data = radio;
569 retval = amradio_set_mute(radio, AMRADIO_START);
571 amradio_dev_warn(&radio->videodev.dev,
572 "radio did not start up properly\n");
577 retval = amradio_set_stereo(radio, WANT_STEREO);
579 amradio_dev_warn(&radio->videodev.dev,
580 "set stereo failed\n");
582 retval = amradio_setfreq(radio, radio->curfreq);
584 amradio_dev_warn(&radio->videodev.dev,
585 "set frequency failed\n");
588 mutex_unlock(&radio->lock);
593 static int usb_amradio_close(struct file *file)
595 struct amradio_device *radio = file->private_data;
598 mutex_lock(&radio->lock);
600 if (radio->removed) {
607 if (!radio->removed) {
608 retval = amradio_set_mute(radio, AMRADIO_STOP);
610 amradio_dev_warn(&radio->videodev.dev,
611 "amradio_stop failed\n");
615 mutex_unlock(&radio->lock);
619 /* Suspend device - stop device. Need to be checked and fixed */
620 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
622 struct amradio_device *radio = usb_get_intfdata(intf);
625 mutex_lock(&radio->lock);
627 retval = amradio_set_mute(radio, AMRADIO_STOP);
629 dev_warn(&intf->dev, "amradio_stop failed\n");
631 dev_info(&intf->dev, "going into suspend..\n");
633 mutex_unlock(&radio->lock);
637 /* Resume device - start device. Need to be checked and fixed */
638 static int usb_amradio_resume(struct usb_interface *intf)
640 struct amradio_device *radio = usb_get_intfdata(intf);
643 mutex_lock(&radio->lock);
645 retval = amradio_set_mute(radio, AMRADIO_START);
647 dev_warn(&intf->dev, "amradio_start failed\n");
649 dev_info(&intf->dev, "coming out of suspend..\n");
651 mutex_unlock(&radio->lock);
655 /* File system interface */
656 static const struct v4l2_file_operations usb_amradio_fops = {
657 .owner = THIS_MODULE,
658 .open = usb_amradio_open,
659 .release = usb_amradio_close,
660 .ioctl = video_ioctl2,
663 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
664 .vidioc_querycap = vidioc_querycap,
665 .vidioc_g_tuner = vidioc_g_tuner,
666 .vidioc_s_tuner = vidioc_s_tuner,
667 .vidioc_g_frequency = vidioc_g_frequency,
668 .vidioc_s_frequency = vidioc_s_frequency,
669 .vidioc_queryctrl = vidioc_queryctrl,
670 .vidioc_g_ctrl = vidioc_g_ctrl,
671 .vidioc_s_ctrl = vidioc_s_ctrl,
672 .vidioc_g_audio = vidioc_g_audio,
673 .vidioc_s_audio = vidioc_s_audio,
674 .vidioc_g_input = vidioc_g_input,
675 .vidioc_s_input = vidioc_s_input,
678 static void usb_amradio_video_device_release(struct video_device *videodev)
680 struct amradio_device *radio = vdev_to_amradio(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;
696 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
699 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 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
714 dev_err(&intf->dev, "couldn't register v4l2_device\n");
718 strlcpy(radio->videodev.name, radio->v4l2_dev.name,
719 sizeof(radio->videodev.name));
720 radio->videodev.v4l2_dev = &radio->v4l2_dev;
721 radio->videodev.fops = &usb_amradio_fops;
722 radio->videodev.ioctl_ops = &usb_amradio_ioctl_ops;
723 radio->videodev.release = usb_amradio_video_device_release;
727 radio->usbdev = interface_to_usbdev(intf);
728 radio->curfreq = 95.16 * FREQ_MUL;
731 mutex_init(&radio->lock);
733 video_set_drvdata(&radio->videodev, radio);
735 retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
738 dev_err(&intf->dev, "could not register video device\n");
742 usb_set_intfdata(intf, radio);
746 v4l2_device_unregister(&radio->v4l2_dev);
748 kfree(radio->buffer);
755 static int __init amradio_init(void)
757 int retval = usb_register(&usb_amradio_driver);
759 pr_info(KBUILD_MODNAME
760 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
763 pr_err(KBUILD_MODNAME
764 ": usb_register failed. Error number %d\n", retval);
769 static void __exit amradio_exit(void)
771 usb_deregister(&usb_amradio_driver);
774 module_init(amradio_init);
775 module_exit(amradio_exit);