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 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 * So, we have smth to begin with.
36 * Version 0.01: First working version.
37 * It's required to blacklist AverMedia USB Radio
38 * in usbhid/hid-quirks.c
41 * - Correct power managment of device (suspend & resume)
42 * - Make x86 independance (little-endian and big-endian stuff)
43 * - Add code for scanning and smooth tuning
44 * - Checked and add stereo&mono stuff
45 * - Add code for sensitivity value
47 * - In Japan another FREQ_MIN and FREQ_MAX
51 #include <linux/kernel.h>
52 #include <linux/module.h>
53 #include <linux/init.h>
54 #include <linux/slab.h>
55 #include <linux/input.h>
56 #include <linux/videodev2.h>
57 #include <media/v4l2-common.h>
58 #include <media/v4l2-ioctl.h>
59 #include <linux/usb.h>
60 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
62 /* driver and module definitions */
63 #define DRIVER_AUTHOR "Alexey Klimov <klimov.linux@gmail.com>"
64 #define DRIVER_DESC "AverMedia MR 800 USB FM radio driver"
65 #define DRIVER_VERSION "0.01"
66 #define RADIO_VERSION KERNEL_VERSION(0, 0, 1)
68 MODULE_AUTHOR(DRIVER_AUTHOR
);
69 MODULE_DESCRIPTION(DRIVER_DESC
);
70 MODULE_LICENSE("GPL");
72 #define USB_AMRADIO_VENDOR 0x07ca
73 #define USB_AMRADIO_PRODUCT 0xb800
75 /* dev_warn macro with driver name */
76 #define MR800_DRIVER_NAME "radio-mr800"
77 #define amradio_dev_warn(dev, fmt, arg...) \
78 dev_warn(dev, MR800_DRIVER_NAME " - " fmt, ##arg)
80 /* Probably USB_TIMEOUT should be modified in module parameter */
81 #define BUFFER_LENGTH 8
82 #define USB_TIMEOUT 500
84 /* Frequency limits in MHz -- these are European values. For Japanese
85 devices, that would be 76 and 91. */
87 #define FREQ_MAX 108.0
88 #define FREQ_MUL 16000
90 /* module parameter */
91 static int radio_nr
= -1;
92 module_param(radio_nr
, int, 0);
93 MODULE_PARM_DESC(radio_nr
, "Radio Nr");
95 static struct v4l2_queryctrl radio_qctrl
[] = {
97 .id
= V4L2_CID_AUDIO_MUTE
,
103 .type
= V4L2_CTRL_TYPE_BOOLEAN
,
105 /* HINT: the disabled controls are only here to satify kradio and such apps */
106 { .id
= V4L2_CID_AUDIO_VOLUME
,
107 .flags
= V4L2_CTRL_FLAG_DISABLED
,
110 .id
= V4L2_CID_AUDIO_BALANCE
,
111 .flags
= V4L2_CTRL_FLAG_DISABLED
,
114 .id
= V4L2_CID_AUDIO_BASS
,
115 .flags
= V4L2_CTRL_FLAG_DISABLED
,
118 .id
= V4L2_CID_AUDIO_TREBLE
,
119 .flags
= V4L2_CTRL_FLAG_DISABLED
,
122 .id
= V4L2_CID_AUDIO_LOUDNESS
,
123 .flags
= V4L2_CTRL_FLAG_DISABLED
,
127 static int usb_amradio_probe(struct usb_interface
*intf
,
128 const struct usb_device_id
*id
);
129 static void usb_amradio_disconnect(struct usb_interface
*intf
);
130 static int usb_amradio_open(struct file
*file
);
131 static int usb_amradio_close(struct file
*file
);
132 static int usb_amradio_suspend(struct usb_interface
*intf
,
133 pm_message_t message
);
134 static int usb_amradio_resume(struct usb_interface
*intf
);
136 /* Data for one (physical) device */
137 struct amradio_device
{
138 /* reference to USB and video device */
139 struct usb_device
*usbdev
;
140 struct video_device
*videodev
;
142 unsigned char *buffer
;
143 struct mutex lock
; /* buffer locking */
151 /* USB Device ID List */
152 static struct usb_device_id usb_amradio_device_table
[] = {
153 {USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR
, USB_AMRADIO_PRODUCT
,
154 USB_CLASS_HID
, 0, 0) },
155 { } /* Terminating entry */
158 MODULE_DEVICE_TABLE(usb
, usb_amradio_device_table
);
160 /* USB subsystem interface */
161 static struct usb_driver usb_amradio_driver
= {
162 .name
= MR800_DRIVER_NAME
,
163 .probe
= usb_amradio_probe
,
164 .disconnect
= usb_amradio_disconnect
,
165 .suspend
= usb_amradio_suspend
,
166 .resume
= usb_amradio_resume
,
167 .reset_resume
= usb_amradio_resume
,
168 .id_table
= usb_amradio_device_table
,
169 .supports_autosuspend
= 0,
172 /* switch on radio. Send 8 bytes to device. */
173 static int amradio_start(struct amradio_device
*radio
)
178 mutex_lock(&radio
->lock
);
180 radio
->buffer
[0] = 0x00;
181 radio
->buffer
[1] = 0x55;
182 radio
->buffer
[2] = 0xaa;
183 radio
->buffer
[3] = 0x00;
184 radio
->buffer
[4] = 0xab;
185 radio
->buffer
[5] = 0x00;
186 radio
->buffer
[6] = 0x00;
187 radio
->buffer
[7] = 0x00;
189 retval
= usb_bulk_msg(radio
->usbdev
, usb_sndintpipe(radio
->usbdev
, 2),
190 (void *) (radio
->buffer
), BUFFER_LENGTH
, &size
, USB_TIMEOUT
);
193 mutex_unlock(&radio
->lock
);
199 mutex_unlock(&radio
->lock
);
204 /* switch off radio */
205 static int amradio_stop(struct amradio_device
*radio
)
214 mutex_lock(&radio
->lock
);
216 radio
->buffer
[0] = 0x00;
217 radio
->buffer
[1] = 0x55;
218 radio
->buffer
[2] = 0xaa;
219 radio
->buffer
[3] = 0x00;
220 radio
->buffer
[4] = 0xab;
221 radio
->buffer
[5] = 0x01;
222 radio
->buffer
[6] = 0x00;
223 radio
->buffer
[7] = 0x00;
225 retval
= usb_bulk_msg(radio
->usbdev
, usb_sndintpipe(radio
->usbdev
, 2),
226 (void *) (radio
->buffer
), BUFFER_LENGTH
, &size
, USB_TIMEOUT
);
229 mutex_unlock(&radio
->lock
);
235 mutex_unlock(&radio
->lock
);
240 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
241 static int amradio_setfreq(struct amradio_device
*radio
, int freq
)
245 unsigned short freq_send
= 0x13 + (freq
>> 3) / 25;
251 mutex_lock(&radio
->lock
);
253 radio
->buffer
[0] = 0x00;
254 radio
->buffer
[1] = 0x55;
255 radio
->buffer
[2] = 0xaa;
256 radio
->buffer
[3] = 0x03;
257 radio
->buffer
[4] = 0xa4;
258 radio
->buffer
[5] = 0x00;
259 radio
->buffer
[6] = 0x00;
260 radio
->buffer
[7] = 0x08;
262 retval
= usb_bulk_msg(radio
->usbdev
, usb_sndintpipe(radio
->usbdev
, 2),
263 (void *) (radio
->buffer
), BUFFER_LENGTH
, &size
, USB_TIMEOUT
);
266 mutex_unlock(&radio
->lock
);
270 /* frequency is calculated from freq_send and placed in first 2 bytes */
271 radio
->buffer
[0] = (freq_send
>> 8) & 0xff;
272 radio
->buffer
[1] = freq_send
& 0xff;
273 radio
->buffer
[2] = 0x01;
274 radio
->buffer
[3] = 0x00;
275 radio
->buffer
[4] = 0x00;
276 /* 5 and 6 bytes of buffer already = 0x00 */
277 radio
->buffer
[7] = 0x00;
279 retval
= usb_bulk_msg(radio
->usbdev
, usb_sndintpipe(radio
->usbdev
, 2),
280 (void *) (radio
->buffer
), BUFFER_LENGTH
, &size
, USB_TIMEOUT
);
283 mutex_unlock(&radio
->lock
);
289 mutex_unlock(&radio
->lock
);
294 /* USB subsystem interface begins here */
296 /* handle unplugging of the device, release data structures
297 if nothing keeps us from doing it. If something is still
298 keeping us busy, the release callback of v4l will take care
300 static void usb_amradio_disconnect(struct usb_interface
*intf
)
302 struct amradio_device
*radio
= usb_get_intfdata(intf
);
304 mutex_lock(&radio
->lock
);
306 mutex_unlock(&radio
->lock
);
308 usb_set_intfdata(intf
, NULL
);
309 video_unregister_device(radio
->videodev
);
312 /* vidioc_querycap - query device capabilities */
313 static int vidioc_querycap(struct file
*file
, void *priv
,
314 struct v4l2_capability
*v
)
316 struct amradio_device
*radio
= video_drvdata(file
);
318 strlcpy(v
->driver
, "radio-mr800", sizeof(v
->driver
));
319 strlcpy(v
->card
, "AverMedia MR 800 USB FM Radio", sizeof(v
->card
));
320 usb_make_path(radio
->usbdev
, v
->bus_info
, sizeof(v
->bus_info
));
321 v
->version
= RADIO_VERSION
;
322 v
->capabilities
= V4L2_CAP_TUNER
;
326 /* vidioc_g_tuner - get tuner attributes */
327 static int vidioc_g_tuner(struct file
*file
, void *priv
,
328 struct v4l2_tuner
*v
)
330 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
339 /* TODO: Add function which look is signal stereo or not
340 * amradio_getstat(radio);
343 strcpy(v
->name
, "FM");
344 v
->type
= V4L2_TUNER_RADIO
;
345 v
->rangelow
= FREQ_MIN
* FREQ_MUL
;
346 v
->rangehigh
= FREQ_MAX
* FREQ_MUL
;
347 v
->rxsubchans
= V4L2_TUNER_SUB_MONO
| V4L2_TUNER_SUB_STEREO
;
348 v
->capability
= V4L2_TUNER_CAP_LOW
;
350 v
->audmode
= V4L2_TUNER_MODE_STEREO
;
352 v
->audmode
= V4L2_TUNER_MODE_MONO
;
353 v
->signal
= 0xffff; /* Can't get the signal strength, sad.. */
354 v
->afc
= 0; /* Don't know what is this */
358 /* vidioc_s_tuner - set tuner attributes */
359 static int vidioc_s_tuner(struct file
*file
, void *priv
,
360 struct v4l2_tuner
*v
)
362 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
373 /* vidioc_s_frequency - set tuner radio frequency */
374 static int vidioc_s_frequency(struct file
*file
, void *priv
,
375 struct v4l2_frequency
*f
)
377 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
383 radio
->curfreq
= f
->frequency
;
384 if (amradio_setfreq(radio
, radio
->curfreq
) < 0)
385 amradio_dev_warn(&radio
->videodev
->dev
,
386 "set frequency failed\n");
390 /* vidioc_g_frequency - get tuner radio frequency */
391 static int vidioc_g_frequency(struct file
*file
, void *priv
,
392 struct v4l2_frequency
*f
)
394 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
400 f
->type
= V4L2_TUNER_RADIO
;
401 f
->frequency
= radio
->curfreq
;
405 /* vidioc_queryctrl - enumerate control items */
406 static int vidioc_queryctrl(struct file
*file
, void *priv
,
407 struct v4l2_queryctrl
*qc
)
411 for (i
= 0; i
< ARRAY_SIZE(radio_qctrl
); i
++) {
412 if (qc
->id
&& qc
->id
== radio_qctrl
[i
].id
) {
413 memcpy(qc
, &(radio_qctrl
[i
]), sizeof(*qc
));
420 /* vidioc_g_ctrl - get the value of a control */
421 static int vidioc_g_ctrl(struct file
*file
, void *priv
,
422 struct v4l2_control
*ctrl
)
424 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
431 case V4L2_CID_AUDIO_MUTE
:
432 ctrl
->value
= radio
->muted
;
438 /* vidioc_s_ctrl - set the value of a control */
439 static int vidioc_s_ctrl(struct file
*file
, void *priv
,
440 struct v4l2_control
*ctrl
)
442 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
449 case V4L2_CID_AUDIO_MUTE
:
451 if (amradio_stop(radio
) < 0) {
452 amradio_dev_warn(&radio
->videodev
->dev
,
453 "amradio_stop failed\n");
457 if (amradio_start(radio
) < 0) {
458 amradio_dev_warn(&radio
->videodev
->dev
,
459 "amradio_start failed\n");
468 /* vidioc_g_audio - get audio attributes */
469 static int vidioc_g_audio(struct file
*file
, void *priv
,
470 struct v4l2_audio
*a
)
475 strcpy(a
->name
, "Radio");
476 a
->capability
= V4L2_AUDCAP_STEREO
;
480 /* vidioc_s_audio - set audio attributes */
481 static int vidioc_s_audio(struct file
*file
, void *priv
,
482 struct v4l2_audio
*a
)
489 /* vidioc_g_input - get input */
490 static int vidioc_g_input(struct file
*filp
, void *priv
, unsigned int *i
)
496 /* vidioc_s_input - set input */
497 static int vidioc_s_input(struct file
*filp
, void *priv
, unsigned int i
)
504 /* open device - amradio_start() and amradio_setfreq() */
505 static int usb_amradio_open(struct file
*file
)
507 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
514 if (amradio_start(radio
) < 0) {
515 amradio_dev_warn(&radio
->videodev
->dev
,
516 "radio did not start up properly\n");
521 if (amradio_setfreq(radio
, radio
->curfreq
) < 0)
522 amradio_dev_warn(&radio
->videodev
->dev
,
523 "set frequency failed\n");
530 static int usb_amradio_close(struct file
*file
)
532 struct amradio_device
*radio
= video_get_drvdata(video_devdata(file
));
540 if (!radio
->removed
) {
541 retval
= amradio_stop(radio
);
543 amradio_dev_warn(&radio
->videodev
->dev
,
544 "amradio_stop failed\n");
550 /* Suspend device - stop device. Need to be checked and fixed */
551 static int usb_amradio_suspend(struct usb_interface
*intf
, pm_message_t message
)
553 struct amradio_device
*radio
= usb_get_intfdata(intf
);
555 if (amradio_stop(radio
) < 0)
556 dev_warn(&intf
->dev
, "amradio_stop failed\n");
558 dev_info(&intf
->dev
, "going into suspend..\n");
563 /* Resume device - start device. Need to be checked and fixed */
564 static int usb_amradio_resume(struct usb_interface
*intf
)
566 struct amradio_device
*radio
= usb_get_intfdata(intf
);
568 if (amradio_start(radio
) < 0)
569 dev_warn(&intf
->dev
, "amradio_start failed\n");
571 dev_info(&intf
->dev
, "coming out of suspend..\n");
576 /* File system interface */
577 static const struct v4l2_file_operations usb_amradio_fops
= {
578 .owner
= THIS_MODULE
,
579 .open
= usb_amradio_open
,
580 .release
= usb_amradio_close
,
581 .ioctl
= video_ioctl2
,
584 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops
= {
585 .vidioc_querycap
= vidioc_querycap
,
586 .vidioc_g_tuner
= vidioc_g_tuner
,
587 .vidioc_s_tuner
= vidioc_s_tuner
,
588 .vidioc_g_frequency
= vidioc_g_frequency
,
589 .vidioc_s_frequency
= vidioc_s_frequency
,
590 .vidioc_queryctrl
= vidioc_queryctrl
,
591 .vidioc_g_ctrl
= vidioc_g_ctrl
,
592 .vidioc_s_ctrl
= vidioc_s_ctrl
,
593 .vidioc_g_audio
= vidioc_g_audio
,
594 .vidioc_s_audio
= vidioc_s_audio
,
595 .vidioc_g_input
= vidioc_g_input
,
596 .vidioc_s_input
= vidioc_s_input
,
599 static void usb_amradio_device_release(struct video_device
*videodev
)
601 struct amradio_device
*radio
= video_get_drvdata(videodev
);
603 /* we call v4l to free radio->videodev */
604 video_device_release(videodev
);
606 /* free rest memory */
607 kfree(radio
->buffer
);
612 static struct video_device amradio_videodev_template
= {
613 .name
= "AverMedia MR 800 USB FM Radio",
614 .fops
= &usb_amradio_fops
,
615 .ioctl_ops
= &usb_amradio_ioctl_ops
,
616 .release
= usb_amradio_device_release
,
619 /* check if the device is present and register with v4l and
621 static int usb_amradio_probe(struct usb_interface
*intf
,
622 const struct usb_device_id
*id
)
624 struct amradio_device
*radio
;
626 radio
= kmalloc(sizeof(struct amradio_device
), GFP_KERNEL
);
631 radio
->buffer
= kmalloc(BUFFER_LENGTH
, GFP_KERNEL
);
633 if (!(radio
->buffer
)) {
638 radio
->videodev
= video_device_alloc();
640 if (!(radio
->videodev
)) {
641 kfree(radio
->buffer
);
646 memcpy(radio
->videodev
, &amradio_videodev_template
,
647 sizeof(amradio_videodev_template
));
651 radio
->usbdev
= interface_to_usbdev(intf
);
652 radio
->curfreq
= 95.16 * FREQ_MUL
;
654 mutex_init(&radio
->lock
);
656 video_set_drvdata(radio
->videodev
, radio
);
657 if (video_register_device(radio
->videodev
, VFL_TYPE_RADIO
, radio_nr
)) {
658 dev_warn(&intf
->dev
, "could not register video device\n");
659 video_device_release(radio
->videodev
);
660 kfree(radio
->buffer
);
665 usb_set_intfdata(intf
, radio
);
669 static int __init
amradio_init(void)
671 int retval
= usb_register(&usb_amradio_driver
);
673 pr_info(KBUILD_MODNAME
674 ": version " DRIVER_VERSION
" " DRIVER_DESC
"\n");
677 pr_err(KBUILD_MODNAME
678 ": usb_register failed. Error number %d\n", retval
);
683 static void __exit
amradio_exit(void)
685 usb_deregister(&usb_amradio_driver
);
688 module_init(amradio_init
);
689 module_exit(amradio_exit
);