staging: brcm80211: remove redundant CHIPREV macro
[zen-stable.git] / drivers / media / radio / radio-mr800.c
blobb540e8072e9295ca8551e65858e5f2670e381d0c
1 /*
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 through 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.
48 * Many things to do:
49 * - Correct power management of device (suspend & resume)
50 * - Add code for scanning and smooth tuning
51 * - Add code for sensitivity value
52 * - Correct mistakes
53 * - In Japan another FREQ_MIN and FREQ_MAX
56 /* kernel includes */
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. */
97 #define FREQ_MIN 87.5
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 usb_interface *intf;
136 struct video_device videodev;
137 struct v4l2_device v4l2_dev;
139 unsigned char *buffer;
140 struct mutex lock; /* buffer locking */
141 int curfreq;
142 int stereo;
143 int muted;
144 int initialized;
147 static inline struct amradio_device *to_amradio_dev(struct v4l2_device *v4l2_dev)
149 return container_of(v4l2_dev, struct amradio_device, v4l2_dev);
152 /* USB Device ID List */
153 static struct usb_device_id usb_amradio_device_table[] = {
154 {USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
155 USB_CLASS_HID, 0, 0) },
156 { } /* Terminating entry */
159 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
161 /* USB subsystem interface */
162 static struct usb_driver usb_amradio_driver = {
163 .name = MR800_DRIVER_NAME,
164 .probe = usb_amradio_probe,
165 .disconnect = usb_amradio_disconnect,
166 .suspend = usb_amradio_suspend,
167 .resume = usb_amradio_resume,
168 .reset_resume = usb_amradio_resume,
169 .id_table = usb_amradio_device_table,
170 .supports_autosuspend = 1,
173 /* switch on/off the radio. Send 8 bytes to device */
174 static int amradio_set_mute(struct amradio_device *radio, char argument)
176 int retval;
177 int size;
179 radio->buffer[0] = 0x00;
180 radio->buffer[1] = 0x55;
181 radio->buffer[2] = 0xaa;
182 radio->buffer[3] = 0x00;
183 radio->buffer[4] = AMRADIO_SET_MUTE;
184 radio->buffer[5] = argument;
185 radio->buffer[6] = 0x00;
186 radio->buffer[7] = 0x00;
188 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
189 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
191 if (retval < 0 || size != BUFFER_LENGTH) {
192 amradio_dev_warn(&radio->videodev.dev, "set mute failed\n");
193 return retval;
196 radio->muted = argument;
198 return retval;
201 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
202 static int amradio_setfreq(struct amradio_device *radio, int freq)
204 int retval;
205 int size;
206 unsigned short freq_send = 0x10 + (freq >> 3) / 25;
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)
221 goto out_err;
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)
236 goto out_err;
238 radio->curfreq = freq;
239 goto out;
241 out_err:
242 amradio_dev_warn(&radio->videodev.dev, "set frequency failed\n");
243 out:
244 return retval;
247 static int amradio_set_stereo(struct amradio_device *radio, char argument)
249 int retval;
250 int size;
252 radio->buffer[0] = 0x00;
253 radio->buffer[1] = 0x55;
254 radio->buffer[2] = 0xaa;
255 radio->buffer[3] = 0x00;
256 radio->buffer[4] = AMRADIO_SET_MONO;
257 radio->buffer[5] = argument;
258 radio->buffer[6] = 0x00;
259 radio->buffer[7] = 0x00;
261 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
262 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
264 if (retval < 0 || size != BUFFER_LENGTH) {
265 amradio_dev_warn(&radio->videodev.dev, "set stereo failed\n");
266 return retval;
269 if (argument == WANT_STEREO)
270 radio->stereo = 1;
271 else
272 radio->stereo = 0;
274 return retval;
277 /* Handle unplugging the device.
278 * We call video_unregister_device in any case.
279 * The last function called in this procedure is
280 * usb_amradio_device_release.
282 static void usb_amradio_disconnect(struct usb_interface *intf)
284 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
286 mutex_lock(&radio->lock);
287 /* increase the device node's refcount */
288 get_device(&radio->videodev.dev);
289 v4l2_device_disconnect(&radio->v4l2_dev);
290 video_unregister_device(&radio->videodev);
291 mutex_unlock(&radio->lock);
292 /* decrease the device node's refcount, allowing it to be released */
293 put_device(&radio->videodev.dev);
296 /* vidioc_querycap - query device capabilities */
297 static int vidioc_querycap(struct file *file, void *priv,
298 struct v4l2_capability *v)
300 struct amradio_device *radio = file->private_data;
302 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
303 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
304 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
305 v->version = RADIO_VERSION;
306 v->capabilities = V4L2_CAP_TUNER;
307 return 0;
310 /* vidioc_g_tuner - get tuner attributes */
311 static int vidioc_g_tuner(struct file *file, void *priv,
312 struct v4l2_tuner *v)
314 struct amradio_device *radio = file->private_data;
315 int retval;
317 if (v->index > 0)
318 return -EINVAL;
320 /* TODO: Add function which look is signal stereo or not
321 * amradio_getstat(radio);
324 /* we call amradio_set_stereo to set radio->stereo
325 * Honestly, amradio_getstat should cover this in future and
326 * amradio_set_stereo shouldn't be here
328 retval = amradio_set_stereo(radio, WANT_STEREO);
330 strcpy(v->name, "FM");
331 v->type = V4L2_TUNER_RADIO;
332 v->rangelow = FREQ_MIN * FREQ_MUL;
333 v->rangehigh = FREQ_MAX * FREQ_MUL;
334 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
335 v->capability = V4L2_TUNER_CAP_LOW;
336 if (radio->stereo)
337 v->audmode = V4L2_TUNER_MODE_STEREO;
338 else
339 v->audmode = V4L2_TUNER_MODE_MONO;
340 v->signal = 0xffff; /* Can't get the signal strength, sad.. */
341 v->afc = 0; /* Don't know what is this */
343 return retval;
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;
351 int retval = -EINVAL;
353 if (v->index > 0)
354 return -EINVAL;
356 /* mono/stereo selector */
357 switch (v->audmode) {
358 case V4L2_TUNER_MODE_MONO:
359 retval = amradio_set_stereo(radio, WANT_MONO);
360 break;
361 case V4L2_TUNER_MODE_STEREO:
362 retval = amradio_set_stereo(radio, WANT_STEREO);
363 break;
366 return retval;
369 /* vidioc_s_frequency - set tuner radio frequency */
370 static int vidioc_s_frequency(struct file *file, void *priv,
371 struct v4l2_frequency *f)
373 struct amradio_device *radio = file->private_data;
375 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
376 return -EINVAL;
377 return amradio_setfreq(radio, f->frequency);
380 /* vidioc_g_frequency - get tuner radio frequency */
381 static int vidioc_g_frequency(struct file *file, void *priv,
382 struct v4l2_frequency *f)
384 struct amradio_device *radio = file->private_data;
386 if (f->tuner != 0)
387 return -EINVAL;
388 f->type = V4L2_TUNER_RADIO;
389 f->frequency = radio->curfreq;
391 return 0;
394 /* vidioc_queryctrl - enumerate control items */
395 static int vidioc_queryctrl(struct file *file, void *priv,
396 struct v4l2_queryctrl *qc)
398 switch (qc->id) {
399 case V4L2_CID_AUDIO_MUTE:
400 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
403 return -EINVAL;
406 /* vidioc_g_ctrl - get the value of a control */
407 static int vidioc_g_ctrl(struct file *file, void *priv,
408 struct v4l2_control *ctrl)
410 struct amradio_device *radio = file->private_data;
412 switch (ctrl->id) {
413 case V4L2_CID_AUDIO_MUTE:
414 ctrl->value = radio->muted;
415 return 0;
418 return -EINVAL;
421 /* vidioc_s_ctrl - set the value of a control */
422 static int vidioc_s_ctrl(struct file *file, void *priv,
423 struct v4l2_control *ctrl)
425 struct amradio_device *radio = file->private_data;
426 int retval = -EINVAL;
428 switch (ctrl->id) {
429 case V4L2_CID_AUDIO_MUTE:
430 if (ctrl->value)
431 retval = amradio_set_mute(radio, AMRADIO_STOP);
432 else
433 retval = amradio_set_mute(radio, AMRADIO_START);
435 break;
438 return retval;
441 /* vidioc_g_audio - get audio attributes */
442 static int vidioc_g_audio(struct file *file, void *priv,
443 struct v4l2_audio *a)
445 if (a->index > 1)
446 return -EINVAL;
448 strcpy(a->name, "Radio");
449 a->capability = V4L2_AUDCAP_STEREO;
450 return 0;
453 /* vidioc_s_audio - set audio attributes */
454 static int vidioc_s_audio(struct file *file, void *priv,
455 struct v4l2_audio *a)
457 if (a->index != 0)
458 return -EINVAL;
459 return 0;
462 /* vidioc_g_input - get input */
463 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
465 *i = 0;
466 return 0;
469 /* vidioc_s_input - set input */
470 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
472 if (i != 0)
473 return -EINVAL;
474 return 0;
477 static int usb_amradio_init(struct amradio_device *radio)
479 int retval;
481 retval = amradio_set_mute(radio, AMRADIO_STOP);
482 if (retval)
483 goto out_err;
485 retval = amradio_set_stereo(radio, WANT_STEREO);
486 if (retval)
487 goto out_err;
489 radio->initialized = 1;
490 goto out;
492 out_err:
493 amradio_dev_err(&radio->videodev.dev, "initialization failed\n");
494 out:
495 return retval;
498 /* open device - amradio_start() and amradio_setfreq() */
499 static int usb_amradio_open(struct file *file)
501 struct amradio_device *radio = video_drvdata(file);
502 int retval;
504 file->private_data = radio;
505 retval = usb_autopm_get_interface(radio->intf);
506 if (retval)
507 return retval;
509 if (unlikely(!radio->initialized)) {
510 retval = usb_amradio_init(radio);
511 if (retval)
512 usb_autopm_put_interface(radio->intf);
514 return retval;
517 /*close device */
518 static int usb_amradio_close(struct file *file)
520 struct amradio_device *radio = file->private_data;
522 if (video_is_registered(&radio->videodev))
523 usb_autopm_put_interface(radio->intf);
524 return 0;
527 /* Suspend device - stop device. Need to be checked and fixed */
528 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
530 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
532 mutex_lock(&radio->lock);
533 if (!radio->muted && radio->initialized) {
534 amradio_set_mute(radio, AMRADIO_STOP);
535 radio->muted = 0;
537 mutex_unlock(&radio->lock);
539 dev_info(&intf->dev, "going into suspend..\n");
540 return 0;
543 /* Resume device - start device. Need to be checked and fixed */
544 static int usb_amradio_resume(struct usb_interface *intf)
546 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
548 mutex_lock(&radio->lock);
549 if (unlikely(!radio->initialized))
550 goto unlock;
552 if (radio->stereo)
553 amradio_set_stereo(radio, WANT_STEREO);
554 else
555 amradio_set_stereo(radio, WANT_MONO);
557 amradio_setfreq(radio, radio->curfreq);
559 if (!radio->muted)
560 amradio_set_mute(radio, AMRADIO_START);
562 unlock:
563 mutex_unlock(&radio->lock);
565 dev_info(&intf->dev, "coming out of suspend..\n");
566 return 0;
569 /* File system interface */
570 static const struct v4l2_file_operations usb_amradio_fops = {
571 .owner = THIS_MODULE,
572 .open = usb_amradio_open,
573 .release = usb_amradio_close,
574 .unlocked_ioctl = video_ioctl2,
577 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
578 .vidioc_querycap = vidioc_querycap,
579 .vidioc_g_tuner = vidioc_g_tuner,
580 .vidioc_s_tuner = vidioc_s_tuner,
581 .vidioc_g_frequency = vidioc_g_frequency,
582 .vidioc_s_frequency = vidioc_s_frequency,
583 .vidioc_queryctrl = vidioc_queryctrl,
584 .vidioc_g_ctrl = vidioc_g_ctrl,
585 .vidioc_s_ctrl = vidioc_s_ctrl,
586 .vidioc_g_audio = vidioc_g_audio,
587 .vidioc_s_audio = vidioc_s_audio,
588 .vidioc_g_input = vidioc_g_input,
589 .vidioc_s_input = vidioc_s_input,
592 static void usb_amradio_video_device_release(struct video_device *videodev)
594 struct amradio_device *radio = video_get_drvdata(videodev);
596 /* free rest memory */
597 kfree(radio->buffer);
598 kfree(radio);
601 /* check if the device is present and register with v4l and usb if it is */
602 static int usb_amradio_probe(struct usb_interface *intf,
603 const struct usb_device_id *id)
605 struct amradio_device *radio;
606 int retval = 0;
608 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
610 if (!radio) {
611 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
612 retval = -ENOMEM;
613 goto err;
616 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
618 if (!radio->buffer) {
619 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
620 retval = -ENOMEM;
621 goto err_nobuf;
624 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
625 if (retval < 0) {
626 dev_err(&intf->dev, "couldn't register v4l2_device\n");
627 goto err_v4l2;
630 mutex_init(&radio->lock);
632 strlcpy(radio->videodev.name, radio->v4l2_dev.name,
633 sizeof(radio->videodev.name));
634 radio->videodev.v4l2_dev = &radio->v4l2_dev;
635 radio->videodev.fops = &usb_amradio_fops;
636 radio->videodev.ioctl_ops = &usb_amradio_ioctl_ops;
637 radio->videodev.release = usb_amradio_video_device_release;
638 radio->videodev.lock = &radio->lock;
640 radio->usbdev = interface_to_usbdev(intf);
641 radio->intf = intf;
642 radio->curfreq = 95.16 * FREQ_MUL;
644 video_set_drvdata(&radio->videodev, radio);
646 retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
647 radio_nr);
648 if (retval < 0) {
649 dev_err(&intf->dev, "could not register video device\n");
650 goto err_vdev;
653 return 0;
655 err_vdev:
656 v4l2_device_unregister(&radio->v4l2_dev);
657 err_v4l2:
658 kfree(radio->buffer);
659 err_nobuf:
660 kfree(radio);
661 err:
662 return retval;
665 static int __init amradio_init(void)
667 int retval = usb_register(&usb_amradio_driver);
669 pr_info(KBUILD_MODNAME
670 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
672 if (retval)
673 pr_err(KBUILD_MODNAME
674 ": usb_register failed. Error number %d\n", retval);
676 return retval;
679 static void __exit amradio_exit(void)
681 usb_deregister(&usb_amradio_driver);
684 module_init(amradio_init);
685 module_exit(amradio_exit);