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 #define amradio_dev_err(dev, fmt, arg...) \
89 dev_err(dev, MR800_DRIVER_NAME " - " fmt, ##arg)
91 /* Probably USB_TIMEOUT should be modified in module parameter */
92 #define BUFFER_LENGTH 8
93 #define USB_TIMEOUT 500
95 /* Frequency limits in MHz -- these are European values. For Japanese
96 devices, that would be 76 and 91. */
98 #define FREQ_MAX 108.0
99 #define FREQ_MUL 16000
102 * Commands that device should understand
103 * List isnt full and will be updated with implementation of new functions
105 #define AMRADIO_SET_FREQ 0xa4
106 #define AMRADIO_SET_MUTE 0xab
107 #define AMRADIO_SET_MONO 0xae
109 /* Comfortable defines for amradio_set_mute */
110 #define AMRADIO_START 0x00
111 #define AMRADIO_STOP 0x01
113 /* Comfortable defines for amradio_set_stereo */
114 #define WANT_STEREO 0x00
115 #define WANT_MONO 0x01
117 /* module parameter */
118 static int radio_nr = -1;
119 module_param(radio_nr, int, 0);
120 MODULE_PARM_DESC(radio_nr, "Radio Nr");
122 static int usb_amradio_probe(struct usb_interface *intf,
123 const struct usb_device_id *id);
124 static void usb_amradio_disconnect(struct usb_interface *intf);
125 static int usb_amradio_open(struct file *file);
126 static int usb_amradio_close(struct file *file);
127 static int usb_amradio_suspend(struct usb_interface *intf,
128 pm_message_t message);
129 static int usb_amradio_resume(struct usb_interface *intf);
131 /* Data for one (physical) device */
132 struct amradio_device {
133 /* reference to USB and video device */
134 struct usb_device *usbdev;
135 struct video_device videodev;
136 struct v4l2_device v4l2_dev;
138 unsigned char *buffer;
139 struct mutex lock; /* buffer locking */
146 #define vdev_to_amradio(r) container_of(r, struct amradio_device, videodev)
148 /* USB Device ID List */
149 static struct usb_device_id usb_amradio_device_table[] = {
150 {USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
151 USB_CLASS_HID, 0, 0) },
152 { } /* Terminating entry */
155 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
157 /* USB subsystem interface */
158 static struct usb_driver usb_amradio_driver = {
159 .name = MR800_DRIVER_NAME,
160 .probe = usb_amradio_probe,
161 .disconnect = usb_amradio_disconnect,
162 .suspend = usb_amradio_suspend,
163 .resume = usb_amradio_resume,
164 .reset_resume = usb_amradio_resume,
165 .id_table = usb_amradio_device_table,
166 .supports_autosuspend = 0,
169 /* switch on/off the radio. Send 8 bytes to device */
170 static int amradio_set_mute(struct amradio_device *radio, char argument)
175 BUG_ON(!mutex_is_locked(&radio->lock));
177 radio->buffer[0] = 0x00;
178 radio->buffer[1] = 0x55;
179 radio->buffer[2] = 0xaa;
180 radio->buffer[3] = 0x00;
181 radio->buffer[4] = AMRADIO_SET_MUTE;
182 radio->buffer[5] = argument;
183 radio->buffer[6] = 0x00;
184 radio->buffer[7] = 0x00;
186 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
187 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
189 if (retval < 0 || size != BUFFER_LENGTH) {
190 amradio_dev_warn(&radio->videodev.dev, "set mute failed\n");
194 radio->muted = argument;
199 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
200 static int amradio_setfreq(struct amradio_device *radio, int freq)
204 unsigned short freq_send = 0x10 + (freq >> 3) / 25;
206 BUG_ON(!mutex_is_locked(&radio->lock));
208 radio->buffer[0] = 0x00;
209 radio->buffer[1] = 0x55;
210 radio->buffer[2] = 0xaa;
211 radio->buffer[3] = 0x03;
212 radio->buffer[4] = AMRADIO_SET_FREQ;
213 radio->buffer[5] = 0x00;
214 radio->buffer[6] = 0x00;
215 radio->buffer[7] = 0x08;
217 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
218 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
220 if (retval < 0 || size != BUFFER_LENGTH)
223 /* frequency is calculated from freq_send and placed in first 2 bytes */
224 radio->buffer[0] = (freq_send >> 8) & 0xff;
225 radio->buffer[1] = freq_send & 0xff;
226 radio->buffer[2] = 0x01;
227 radio->buffer[3] = 0x00;
228 radio->buffer[4] = 0x00;
229 /* 5 and 6 bytes of buffer already = 0x00 */
230 radio->buffer[7] = 0x00;
232 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
233 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
235 if (retval < 0 || size != BUFFER_LENGTH)
238 radio->curfreq = freq;
242 amradio_dev_warn(&radio->videodev.dev, "set frequency failed\n");
247 static int amradio_set_stereo(struct amradio_device *radio, char argument)
252 BUG_ON(!mutex_is_locked(&radio->lock));
254 radio->buffer[0] = 0x00;
255 radio->buffer[1] = 0x55;
256 radio->buffer[2] = 0xaa;
257 radio->buffer[3] = 0x00;
258 radio->buffer[4] = AMRADIO_SET_MONO;
259 radio->buffer[5] = argument;
260 radio->buffer[6] = 0x00;
261 radio->buffer[7] = 0x00;
263 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
264 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
266 if (retval < 0 || size != BUFFER_LENGTH) {
267 amradio_dev_warn(&radio->videodev.dev, "set stereo failed\n");
271 if (argument == WANT_STEREO)
279 /* Handle unplugging the device.
280 * We call video_unregister_device in any case.
281 * The last function called in this procedure is
282 * usb_amradio_device_release.
284 static void usb_amradio_disconnect(struct usb_interface *intf)
286 struct amradio_device *radio = usb_get_intfdata(intf);
288 mutex_lock(&radio->lock);
289 radio->usbdev = NULL;
290 mutex_unlock(&radio->lock);
292 usb_set_intfdata(intf, NULL);
293 v4l2_device_disconnect(&radio->v4l2_dev);
294 video_unregister_device(&radio->videodev);
297 /* vidioc_querycap - query device capabilities */
298 static int vidioc_querycap(struct file *file, void *priv,
299 struct v4l2_capability *v)
301 struct amradio_device *radio = file->private_data;
303 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
304 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
305 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
306 v->version = RADIO_VERSION;
307 v->capabilities = V4L2_CAP_TUNER;
311 /* vidioc_g_tuner - get tuner attributes */
312 static int vidioc_g_tuner(struct file *file, void *priv,
313 struct v4l2_tuner *v)
315 struct amradio_device *radio = file->private_data;
321 /* TODO: Add function which look is signal stereo or not
322 * amradio_getstat(radio);
325 /* we call amradio_set_stereo to set radio->stereo
326 * Honestly, amradio_getstat should cover this in future and
327 * amradio_set_stereo shouldn't be here
329 retval = amradio_set_stereo(radio, WANT_STEREO);
331 strcpy(v->name, "FM");
332 v->type = V4L2_TUNER_RADIO;
333 v->rangelow = FREQ_MIN * FREQ_MUL;
334 v->rangehigh = FREQ_MAX * FREQ_MUL;
335 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
336 v->capability = V4L2_TUNER_CAP_LOW;
338 v->audmode = V4L2_TUNER_MODE_STEREO;
340 v->audmode = V4L2_TUNER_MODE_MONO;
341 v->signal = 0xffff; /* Can't get the signal strength, sad.. */
342 v->afc = 0; /* Don't know what is this */
347 /* vidioc_s_tuner - set tuner attributes */
348 static int vidioc_s_tuner(struct file *file, void *priv,
349 struct v4l2_tuner *v)
351 struct amradio_device *radio = file->private_data;
352 int retval = -EINVAL;
357 /* mono/stereo selector */
358 switch (v->audmode) {
359 case V4L2_TUNER_MODE_MONO:
360 retval = amradio_set_stereo(radio, WANT_MONO);
362 case V4L2_TUNER_MODE_STEREO:
363 retval = amradio_set_stereo(radio, WANT_STEREO);
370 /* vidioc_s_frequency - set tuner radio frequency */
371 static int vidioc_s_frequency(struct file *file, void *priv,
372 struct v4l2_frequency *f)
374 struct amradio_device *radio = file->private_data;
376 return amradio_setfreq(radio, f->frequency);
379 /* vidioc_g_frequency - get tuner radio frequency */
380 static int vidioc_g_frequency(struct file *file, void *priv,
381 struct v4l2_frequency *f)
383 struct amradio_device *radio = file->private_data;
385 f->type = V4L2_TUNER_RADIO;
386 f->frequency = radio->curfreq;
391 /* vidioc_queryctrl - enumerate control items */
392 static int vidioc_queryctrl(struct file *file, void *priv,
393 struct v4l2_queryctrl *qc)
396 case V4L2_CID_AUDIO_MUTE:
397 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
403 /* vidioc_g_ctrl - get the value of a control */
404 static int vidioc_g_ctrl(struct file *file, void *priv,
405 struct v4l2_control *ctrl)
407 struct amradio_device *radio = file->private_data;
410 case V4L2_CID_AUDIO_MUTE:
411 ctrl->value = radio->muted;
418 /* vidioc_s_ctrl - set the value of a control */
419 static int vidioc_s_ctrl(struct file *file, void *priv,
420 struct v4l2_control *ctrl)
422 struct amradio_device *radio = file->private_data;
423 int retval = -EINVAL;
426 case V4L2_CID_AUDIO_MUTE:
428 retval = amradio_set_mute(radio, AMRADIO_STOP);
430 retval = amradio_set_mute(radio, AMRADIO_START);
438 /* vidioc_g_audio - get audio attributes */
439 static int vidioc_g_audio(struct file *file, void *priv,
440 struct v4l2_audio *a)
445 strcpy(a->name, "Radio");
446 a->capability = V4L2_AUDCAP_STEREO;
450 /* vidioc_s_audio - set audio attributes */
451 static int vidioc_s_audio(struct file *file, void *priv,
452 struct v4l2_audio *a)
459 /* vidioc_g_input - get input */
460 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
466 /* vidioc_s_input - set input */
467 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
474 static int usb_amradio_init(struct amradio_device *radio)
478 retval = amradio_set_mute(radio, AMRADIO_STOP);
482 retval = amradio_set_stereo(radio, WANT_STEREO);
486 radio->initialized = 1;
490 amradio_dev_err(&radio->videodev.dev, "initialization failed\n");
495 /* open device - amradio_start() and amradio_setfreq() */
496 static int usb_amradio_open(struct file *file)
498 struct amradio_device *radio = vdev_to_amradio(video_devdata(file));
501 mutex_lock(&radio->lock);
503 if (!radio->usbdev) {
508 file->private_data = radio;
510 if (unlikely(!radio->initialized))
511 retval = usb_amradio_init(radio);
514 mutex_unlock(&radio->lock);
519 static int usb_amradio_close(struct file *file)
521 struct amradio_device *radio = file->private_data;
524 mutex_lock(&radio->lock);
529 mutex_unlock(&radio->lock);
533 static long usb_amradio_ioctl(struct file *file, unsigned int cmd,
536 struct amradio_device *radio = file->private_data;
539 mutex_lock(&radio->lock);
541 if (!radio->usbdev) {
546 retval = video_ioctl2(file, cmd, arg);
549 mutex_unlock(&radio->lock);
553 /* Suspend device - stop device. Need to be checked and fixed */
554 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
556 struct amradio_device *radio = usb_get_intfdata(intf);
558 mutex_lock(&radio->lock);
560 if (!radio->muted && radio->initialized) {
561 amradio_set_mute(radio, AMRADIO_STOP);
565 dev_info(&intf->dev, "going into suspend..\n");
567 mutex_unlock(&radio->lock);
571 /* Resume device - start device. Need to be checked and fixed */
572 static int usb_amradio_resume(struct usb_interface *intf)
574 struct amradio_device *radio = usb_get_intfdata(intf);
576 mutex_lock(&radio->lock);
578 if (unlikely(!radio->initialized))
582 amradio_set_stereo(radio, WANT_STEREO);
584 amradio_set_stereo(radio, WANT_MONO);
586 amradio_setfreq(radio, radio->curfreq);
589 amradio_set_mute(radio, AMRADIO_START);
592 dev_info(&intf->dev, "coming out of suspend..\n");
594 mutex_unlock(&radio->lock);
598 /* File system interface */
599 static const struct v4l2_file_operations usb_amradio_fops = {
600 .owner = THIS_MODULE,
601 .open = usb_amradio_open,
602 .release = usb_amradio_close,
603 .ioctl = usb_amradio_ioctl,
606 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
607 .vidioc_querycap = vidioc_querycap,
608 .vidioc_g_tuner = vidioc_g_tuner,
609 .vidioc_s_tuner = vidioc_s_tuner,
610 .vidioc_g_frequency = vidioc_g_frequency,
611 .vidioc_s_frequency = vidioc_s_frequency,
612 .vidioc_queryctrl = vidioc_queryctrl,
613 .vidioc_g_ctrl = vidioc_g_ctrl,
614 .vidioc_s_ctrl = vidioc_s_ctrl,
615 .vidioc_g_audio = vidioc_g_audio,
616 .vidioc_s_audio = vidioc_s_audio,
617 .vidioc_g_input = vidioc_g_input,
618 .vidioc_s_input = vidioc_s_input,
621 static void usb_amradio_video_device_release(struct video_device *videodev)
623 struct amradio_device *radio = vdev_to_amradio(videodev);
625 v4l2_device_unregister(&radio->v4l2_dev);
627 /* free rest memory */
628 kfree(radio->buffer);
632 /* check if the device is present and register with v4l and usb if it is */
633 static int usb_amradio_probe(struct usb_interface *intf,
634 const struct usb_device_id *id)
636 struct amradio_device *radio;
639 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
642 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
647 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
649 if (!radio->buffer) {
650 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
655 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
657 dev_err(&intf->dev, "couldn't register v4l2_device\n");
661 strlcpy(radio->videodev.name, radio->v4l2_dev.name,
662 sizeof(radio->videodev.name));
663 radio->videodev.v4l2_dev = &radio->v4l2_dev;
664 radio->videodev.fops = &usb_amradio_fops;
665 radio->videodev.ioctl_ops = &usb_amradio_ioctl_ops;
666 radio->videodev.release = usb_amradio_video_device_release;
668 radio->usbdev = interface_to_usbdev(intf);
669 radio->curfreq = 95.16 * FREQ_MUL;
671 mutex_init(&radio->lock);
673 video_set_drvdata(&radio->videodev, radio);
675 retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
678 dev_err(&intf->dev, "could not register video device\n");
682 usb_set_intfdata(intf, radio);
686 v4l2_device_unregister(&radio->v4l2_dev);
688 kfree(radio->buffer);
695 static int __init amradio_init(void)
697 int retval = usb_register(&usb_amradio_driver);
699 pr_info(KBUILD_MODNAME
700 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
703 pr_err(KBUILD_MODNAME
704 ": usb_register failed. Error number %d\n", retval);
709 static void __exit amradio_exit(void)
711 usb_deregister(&usb_amradio_driver);
714 module_init(amradio_init);
715 module_exit(amradio_exit);