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 */
142 #define vdev_to_amradio(r) container_of(r, struct amradio_device, videodev)
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);
271 radio->usbdev = NULL;
272 mutex_unlock(&radio->lock);
274 usb_set_intfdata(intf, NULL);
275 v4l2_device_disconnect(&radio->v4l2_dev);
276 video_unregister_device(&radio->videodev);
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 = file->private_data;
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 = file->private_data;
303 /* TODO: Add function which look is signal stereo or not
304 * amradio_getstat(radio);
307 /* we call amradio_set_stereo to set radio->stereo
308 * Honestly, amradio_getstat should cover this in future and
309 * amradio_set_stereo shouldn't be here
311 retval = amradio_set_stereo(radio, WANT_STEREO);
313 amradio_dev_warn(&radio->videodev.dev,
314 "set stereo failed\n");
316 strcpy(v->name, "FM");
317 v->type = V4L2_TUNER_RADIO;
318 v->rangelow = FREQ_MIN * FREQ_MUL;
319 v->rangehigh = FREQ_MAX * FREQ_MUL;
320 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
321 v->capability = V4L2_TUNER_CAP_LOW;
323 v->audmode = V4L2_TUNER_MODE_STEREO;
325 v->audmode = V4L2_TUNER_MODE_MONO;
326 v->signal = 0xffff; /* Can't get the signal strength, sad.. */
327 v->afc = 0; /* Don't know what is this */
332 /* vidioc_s_tuner - set tuner attributes */
333 static int vidioc_s_tuner(struct file *file, void *priv,
334 struct v4l2_tuner *v)
336 struct amradio_device *radio = file->private_data;
337 int retval = -EINVAL;
342 /* mono/stereo selector */
343 switch (v->audmode) {
344 case V4L2_TUNER_MODE_MONO:
345 retval = amradio_set_stereo(radio, WANT_MONO);
347 amradio_dev_warn(&radio->videodev.dev,
348 "set mono failed\n");
350 case V4L2_TUNER_MODE_STEREO:
351 retval = amradio_set_stereo(radio, WANT_STEREO);
353 amradio_dev_warn(&radio->videodev.dev,
354 "set stereo failed\n");
361 /* vidioc_s_frequency - set tuner radio frequency */
362 static int vidioc_s_frequency(struct file *file, void *priv,
363 struct v4l2_frequency *f)
365 struct amradio_device *radio = file->private_data;
368 radio->curfreq = f->frequency;
370 retval = amradio_setfreq(radio, radio->curfreq);
372 amradio_dev_warn(&radio->videodev.dev,
373 "set frequency failed\n");
378 /* vidioc_g_frequency - get tuner radio frequency */
379 static int vidioc_g_frequency(struct file *file, void *priv,
380 struct v4l2_frequency *f)
382 struct amradio_device *radio = file->private_data;
384 f->type = V4L2_TUNER_RADIO;
385 f->frequency = radio->curfreq;
390 /* vidioc_queryctrl - enumerate control items */
391 static int vidioc_queryctrl(struct file *file, void *priv,
392 struct v4l2_queryctrl *qc)
395 case V4L2_CID_AUDIO_MUTE:
396 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
402 /* vidioc_g_ctrl - get the value of a control */
403 static int vidioc_g_ctrl(struct file *file, void *priv,
404 struct v4l2_control *ctrl)
406 struct amradio_device *radio = file->private_data;
409 case V4L2_CID_AUDIO_MUTE:
410 ctrl->value = radio->muted;
417 /* vidioc_s_ctrl - set the value of a control */
418 static int vidioc_s_ctrl(struct file *file, void *priv,
419 struct v4l2_control *ctrl)
421 struct amradio_device *radio = file->private_data;
422 int retval = -EINVAL;
425 case V4L2_CID_AUDIO_MUTE:
427 retval = amradio_set_mute(radio, AMRADIO_STOP);
429 amradio_dev_warn(&radio->videodev.dev,
430 "amradio_stop failed\n");
433 retval = amradio_set_mute(radio, AMRADIO_START);
435 amradio_dev_warn(&radio->videodev.dev,
436 "amradio_start failed\n");
445 /* vidioc_g_audio - get audio attributes */
446 static int vidioc_g_audio(struct file *file, void *priv,
447 struct v4l2_audio *a)
452 strcpy(a->name, "Radio");
453 a->capability = V4L2_AUDCAP_STEREO;
457 /* vidioc_s_audio - set audio attributes */
458 static int vidioc_s_audio(struct file *file, void *priv,
459 struct v4l2_audio *a)
466 /* vidioc_g_input - get input */
467 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
473 /* vidioc_s_input - set input */
474 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
481 /* open device - amradio_start() and amradio_setfreq() */
482 static int usb_amradio_open(struct file *file)
484 struct amradio_device *radio = vdev_to_amradio(video_devdata(file));
487 mutex_lock(&radio->lock);
489 if (!radio->usbdev) {
494 file->private_data = radio;
497 mutex_unlock(&radio->lock);
502 static int usb_amradio_close(struct file *file)
504 struct amradio_device *radio = file->private_data;
507 mutex_lock(&radio->lock);
512 mutex_unlock(&radio->lock);
516 static long usb_amradio_ioctl(struct file *file, unsigned int cmd,
519 struct amradio_device *radio = file->private_data;
522 mutex_lock(&radio->lock);
524 if (!radio->usbdev) {
529 retval = video_ioctl2(file, cmd, arg);
532 mutex_unlock(&radio->lock);
536 /* Suspend device - stop device. Need to be checked and fixed */
537 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
539 struct amradio_device *radio = usb_get_intfdata(intf);
542 mutex_lock(&radio->lock);
544 retval = amradio_set_mute(radio, AMRADIO_STOP);
546 dev_warn(&intf->dev, "amradio_stop failed\n");
548 dev_info(&intf->dev, "going into suspend..\n");
550 mutex_unlock(&radio->lock);
554 /* Resume device - start device. Need to be checked and fixed */
555 static int usb_amradio_resume(struct usb_interface *intf)
557 struct amradio_device *radio = usb_get_intfdata(intf);
560 mutex_lock(&radio->lock);
562 retval = amradio_set_mute(radio, AMRADIO_START);
564 dev_warn(&intf->dev, "amradio_start failed\n");
566 dev_info(&intf->dev, "coming out of suspend..\n");
568 mutex_unlock(&radio->lock);
572 /* File system interface */
573 static const struct v4l2_file_operations usb_amradio_fops = {
574 .owner = THIS_MODULE,
575 .open = usb_amradio_open,
576 .release = usb_amradio_close,
577 .ioctl = usb_amradio_ioctl,
580 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
581 .vidioc_querycap = vidioc_querycap,
582 .vidioc_g_tuner = vidioc_g_tuner,
583 .vidioc_s_tuner = vidioc_s_tuner,
584 .vidioc_g_frequency = vidioc_g_frequency,
585 .vidioc_s_frequency = vidioc_s_frequency,
586 .vidioc_queryctrl = vidioc_queryctrl,
587 .vidioc_g_ctrl = vidioc_g_ctrl,
588 .vidioc_s_ctrl = vidioc_s_ctrl,
589 .vidioc_g_audio = vidioc_g_audio,
590 .vidioc_s_audio = vidioc_s_audio,
591 .vidioc_g_input = vidioc_g_input,
592 .vidioc_s_input = vidioc_s_input,
595 static void usb_amradio_video_device_release(struct video_device *videodev)
597 struct amradio_device *radio = vdev_to_amradio(videodev);
599 v4l2_device_unregister(&radio->v4l2_dev);
601 /* free rest memory */
602 kfree(radio->buffer);
606 /* check if the device is present and register with v4l and usb if it is */
607 static int usb_amradio_probe(struct usb_interface *intf,
608 const struct usb_device_id *id)
610 struct amradio_device *radio;
613 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
616 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
621 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
623 if (!radio->buffer) {
624 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
629 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
631 dev_err(&intf->dev, "couldn't register v4l2_device\n");
635 strlcpy(radio->videodev.name, radio->v4l2_dev.name,
636 sizeof(radio->videodev.name));
637 radio->videodev.v4l2_dev = &radio->v4l2_dev;
638 radio->videodev.fops = &usb_amradio_fops;
639 radio->videodev.ioctl_ops = &usb_amradio_ioctl_ops;
640 radio->videodev.release = usb_amradio_video_device_release;
642 radio->usbdev = interface_to_usbdev(intf);
643 radio->curfreq = 95.16 * FREQ_MUL;
647 mutex_init(&radio->lock);
649 video_set_drvdata(&radio->videodev, radio);
651 retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
654 dev_err(&intf->dev, "could not register video device\n");
658 usb_set_intfdata(intf, radio);
662 v4l2_device_unregister(&radio->v4l2_dev);
664 kfree(radio->buffer);
671 static int __init amradio_init(void)
673 int retval = usb_register(&usb_amradio_driver);
675 pr_info(KBUILD_MODNAME
676 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
679 pr_err(KBUILD_MODNAME
680 ": usb_register failed. Error number %d\n", retval);
685 static void __exit amradio_exit(void)
687 usb_deregister(&usb_amradio_driver);
690 module_init(amradio_init);
691 module_exit(amradio_exit);