Linux 3.12.39
[linux/fpc-iii.git] / drivers / media / radio / radio-mr800.c
bloba360227ca3ab8fd285054ba91340777f0db07349
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/input.h>
62 #include <linux/videodev2.h>
63 #include <media/v4l2-device.h>
64 #include <media/v4l2-ioctl.h>
65 #include <media/v4l2-ctrls.h>
66 #include <media/v4l2-event.h>
67 #include <linux/usb.h>
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.1.2"
75 MODULE_AUTHOR(DRIVER_AUTHOR);
76 MODULE_DESCRIPTION(DRIVER_DESC);
77 MODULE_LICENSE("GPL");
78 MODULE_VERSION(DRIVER_VERSION);
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 isn't full and will be updated with implementation of new functions
105 #define AMRADIO_SET_FREQ 0xa4
106 #define AMRADIO_GET_READY_FLAG 0xa5
107 #define AMRADIO_GET_SIGNAL 0xa7
108 #define AMRADIO_GET_FREQ 0xa8
109 #define AMRADIO_SET_SEARCH_UP 0xa9
110 #define AMRADIO_SET_SEARCH_DOWN 0xaa
111 #define AMRADIO_SET_MUTE 0xab
112 #define AMRADIO_SET_RIGHT_MUTE 0xac
113 #define AMRADIO_SET_LEFT_MUTE 0xad
114 #define AMRADIO_SET_MONO 0xae
115 #define AMRADIO_SET_SEARCH_LVL 0xb0
116 #define AMRADIO_STOP_SEARCH 0xb1
118 /* Comfortable defines for amradio_set_stereo */
119 #define WANT_STEREO 0x00
120 #define WANT_MONO 0x01
122 /* module parameter */
123 static int radio_nr = -1;
124 module_param(radio_nr, int, 0);
125 MODULE_PARM_DESC(radio_nr, "Radio Nr");
127 /* Data for one (physical) device */
128 struct amradio_device {
129 /* reference to USB and video device */
130 struct usb_device *usbdev;
131 struct usb_interface *intf;
132 struct video_device vdev;
133 struct v4l2_device v4l2_dev;
134 struct v4l2_ctrl_handler hdl;
136 u8 *buffer;
137 struct mutex lock; /* buffer locking */
138 int curfreq;
139 int stereo;
140 int muted;
143 static inline struct amradio_device *to_amradio_dev(struct v4l2_device *v4l2_dev)
145 return container_of(v4l2_dev, struct amradio_device, v4l2_dev);
148 static int amradio_send_cmd(struct amradio_device *radio, u8 cmd, u8 arg,
149 u8 *extra, u8 extralen, bool reply)
151 int retval;
152 int size;
154 radio->buffer[0] = 0x00;
155 radio->buffer[1] = 0x55;
156 radio->buffer[2] = 0xaa;
157 radio->buffer[3] = extralen;
158 radio->buffer[4] = cmd;
159 radio->buffer[5] = arg;
160 radio->buffer[6] = 0x00;
161 radio->buffer[7] = extra || reply ? 8 : 0;
163 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
164 radio->buffer, BUFFER_LENGTH, &size, USB_TIMEOUT);
166 if (retval < 0 || size != BUFFER_LENGTH) {
167 if (video_is_registered(&radio->vdev))
168 amradio_dev_warn(&radio->vdev.dev,
169 "cmd %02x failed\n", cmd);
170 return retval ? retval : -EIO;
172 if (!extra && !reply)
173 return 0;
175 if (extra) {
176 memcpy(radio->buffer, extra, extralen);
177 memset(radio->buffer + extralen, 0, 8 - extralen);
178 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
179 radio->buffer, BUFFER_LENGTH, &size, USB_TIMEOUT);
180 } else {
181 memset(radio->buffer, 0, 8);
182 retval = usb_bulk_msg(radio->usbdev, usb_rcvbulkpipe(radio->usbdev, 0x81),
183 radio->buffer, BUFFER_LENGTH, &size, USB_TIMEOUT);
185 if (retval == 0 && size == BUFFER_LENGTH)
186 return 0;
187 if (video_is_registered(&radio->vdev) && cmd != AMRADIO_GET_READY_FLAG)
188 amradio_dev_warn(&radio->vdev.dev, "follow-up to cmd %02x failed\n", cmd);
189 return retval ? retval : -EIO;
192 /* switch on/off the radio. Send 8 bytes to device */
193 static int amradio_set_mute(struct amradio_device *radio, bool mute)
195 int ret = amradio_send_cmd(radio,
196 AMRADIO_SET_MUTE, mute, NULL, 0, false);
198 if (!ret)
199 radio->muted = mute;
200 return ret;
203 /* set a frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
204 static int amradio_set_freq(struct amradio_device *radio, int freq)
206 unsigned short freq_send;
207 u8 buf[3];
208 int retval;
210 /* we need to be sure that frequency isn't out of range */
211 freq = clamp_t(unsigned, freq, FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL);
212 freq_send = 0x10 + (freq >> 3) / 25;
214 /* frequency is calculated from freq_send and placed in first 2 bytes */
215 buf[0] = (freq_send >> 8) & 0xff;
216 buf[1] = freq_send & 0xff;
217 buf[2] = 0x01;
219 retval = amradio_send_cmd(radio, AMRADIO_SET_FREQ, 0, buf, 3, false);
220 if (retval)
221 return retval;
222 radio->curfreq = freq;
223 msleep(40);
224 return 0;
227 static int amradio_set_stereo(struct amradio_device *radio, bool stereo)
229 int ret = amradio_send_cmd(radio,
230 AMRADIO_SET_MONO, !stereo, NULL, 0, false);
232 if (!ret)
233 radio->stereo = stereo;
234 return ret;
237 static int amradio_get_stat(struct amradio_device *radio, bool *is_stereo, u32 *signal)
239 int ret = amradio_send_cmd(radio,
240 AMRADIO_GET_SIGNAL, 0, NULL, 0, true);
242 if (ret)
243 return ret;
244 *is_stereo = radio->buffer[2] >> 7;
245 *signal = (radio->buffer[3] & 0xf0) << 8;
246 return 0;
249 /* Handle unplugging the device.
250 * We call video_unregister_device in any case.
251 * The last function called in this procedure is
252 * usb_amradio_device_release.
254 static void usb_amradio_disconnect(struct usb_interface *intf)
256 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
258 mutex_lock(&radio->lock);
259 video_unregister_device(&radio->vdev);
260 amradio_set_mute(radio, true);
261 usb_set_intfdata(intf, NULL);
262 v4l2_device_disconnect(&radio->v4l2_dev);
263 mutex_unlock(&radio->lock);
264 v4l2_device_put(&radio->v4l2_dev);
267 /* vidioc_querycap - query device capabilities */
268 static int vidioc_querycap(struct file *file, void *priv,
269 struct v4l2_capability *v)
271 struct amradio_device *radio = video_drvdata(file);
273 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
274 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
275 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
276 v->device_caps = V4L2_CAP_RADIO | V4L2_CAP_TUNER |
277 V4L2_CAP_HW_FREQ_SEEK;
278 v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
279 return 0;
282 /* vidioc_g_tuner - get tuner attributes */
283 static int vidioc_g_tuner(struct file *file, void *priv,
284 struct v4l2_tuner *v)
286 struct amradio_device *radio = video_drvdata(file);
287 bool is_stereo = false;
288 int retval;
290 if (v->index > 0)
291 return -EINVAL;
293 v->signal = 0;
294 retval = amradio_get_stat(radio, &is_stereo, &v->signal);
295 if (retval)
296 return retval;
298 strcpy(v->name, "FM");
299 v->type = V4L2_TUNER_RADIO;
300 v->rangelow = FREQ_MIN * FREQ_MUL;
301 v->rangehigh = FREQ_MAX * FREQ_MUL;
302 v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO |
303 V4L2_TUNER_CAP_HWSEEK_WRAP;
304 v->rxsubchans = is_stereo ? V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
305 v->audmode = radio->stereo ?
306 V4L2_TUNER_MODE_STEREO : V4L2_TUNER_MODE_MONO;
307 return 0;
310 /* vidioc_s_tuner - set tuner attributes */
311 static int vidioc_s_tuner(struct file *file, void *priv,
312 const struct v4l2_tuner *v)
314 struct amradio_device *radio = video_drvdata(file);
316 if (v->index > 0)
317 return -EINVAL;
319 /* mono/stereo selector */
320 switch (v->audmode) {
321 case V4L2_TUNER_MODE_MONO:
322 return amradio_set_stereo(radio, WANT_MONO);
323 default:
324 return amradio_set_stereo(radio, WANT_STEREO);
328 /* vidioc_s_frequency - set tuner radio frequency */
329 static int vidioc_s_frequency(struct file *file, void *priv,
330 const struct v4l2_frequency *f)
332 struct amradio_device *radio = video_drvdata(file);
334 if (f->tuner != 0)
335 return -EINVAL;
336 return amradio_set_freq(radio, f->frequency);
339 /* vidioc_g_frequency - get tuner radio frequency */
340 static int vidioc_g_frequency(struct file *file, void *priv,
341 struct v4l2_frequency *f)
343 struct amradio_device *radio = video_drvdata(file);
345 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
346 return -EINVAL;
347 f->type = V4L2_TUNER_RADIO;
348 f->frequency = radio->curfreq;
350 return 0;
353 static int vidioc_s_hw_freq_seek(struct file *file, void *priv,
354 const struct v4l2_hw_freq_seek *seek)
356 static u8 buf[8] = {
357 0x3d, 0x32, 0x0f, 0x08, 0x3d, 0x32, 0x0f, 0x08
359 struct amradio_device *radio = video_drvdata(file);
360 unsigned long timeout;
361 int retval;
363 if (seek->tuner != 0 || !seek->wrap_around)
364 return -EINVAL;
366 if (file->f_flags & O_NONBLOCK)
367 return -EWOULDBLOCK;
369 retval = amradio_send_cmd(radio,
370 AMRADIO_SET_SEARCH_LVL, 0, buf, 8, false);
371 if (retval)
372 return retval;
373 amradio_set_freq(radio, radio->curfreq);
374 retval = amradio_send_cmd(radio,
375 seek->seek_upward ? AMRADIO_SET_SEARCH_UP : AMRADIO_SET_SEARCH_DOWN,
376 0, NULL, 0, false);
377 if (retval)
378 return retval;
379 timeout = jiffies + msecs_to_jiffies(30000);
380 for (;;) {
381 if (time_after(jiffies, timeout)) {
382 retval = -ENODATA;
383 break;
385 if (schedule_timeout_interruptible(msecs_to_jiffies(10))) {
386 retval = -ERESTARTSYS;
387 break;
389 retval = amradio_send_cmd(radio, AMRADIO_GET_READY_FLAG,
390 0, NULL, 0, true);
391 if (retval)
392 continue;
393 amradio_send_cmd(radio, AMRADIO_GET_FREQ, 0, NULL, 0, true);
394 if (radio->buffer[1] || radio->buffer[2]) {
395 /* To check: sometimes radio->curfreq is set to out of range value */
396 radio->curfreq = (radio->buffer[1] << 8) | radio->buffer[2];
397 radio->curfreq = (radio->curfreq - 0x10) * 200;
398 amradio_send_cmd(radio, AMRADIO_STOP_SEARCH,
399 0, NULL, 0, false);
400 amradio_set_freq(radio, radio->curfreq);
401 retval = 0;
402 break;
405 amradio_send_cmd(radio, AMRADIO_STOP_SEARCH, 0, NULL, 0, false);
406 amradio_set_freq(radio, radio->curfreq);
407 return retval;
410 static int usb_amradio_s_ctrl(struct v4l2_ctrl *ctrl)
412 struct amradio_device *radio =
413 container_of(ctrl->handler, struct amradio_device, hdl);
415 switch (ctrl->id) {
416 case V4L2_CID_AUDIO_MUTE:
417 return amradio_set_mute(radio, ctrl->val);
420 return -EINVAL;
423 static int usb_amradio_init(struct amradio_device *radio)
425 int retval;
427 retval = amradio_set_mute(radio, true);
428 if (retval)
429 goto out_err;
430 retval = amradio_set_stereo(radio, true);
431 if (retval)
432 goto out_err;
433 retval = amradio_set_freq(radio, radio->curfreq);
434 if (retval)
435 goto out_err;
436 return 0;
438 out_err:
439 amradio_dev_err(&radio->vdev.dev, "initialization failed\n");
440 return retval;
443 /* Suspend device - stop device. Need to be checked and fixed */
444 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
446 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
448 mutex_lock(&radio->lock);
449 if (!radio->muted) {
450 amradio_set_mute(radio, true);
451 radio->muted = false;
453 mutex_unlock(&radio->lock);
455 dev_info(&intf->dev, "going into suspend..\n");
456 return 0;
459 /* Resume device - start device. Need to be checked and fixed */
460 static int usb_amradio_resume(struct usb_interface *intf)
462 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
464 mutex_lock(&radio->lock);
465 amradio_set_stereo(radio, radio->stereo);
466 amradio_set_freq(radio, radio->curfreq);
468 if (!radio->muted)
469 amradio_set_mute(radio, false);
471 mutex_unlock(&radio->lock);
473 dev_info(&intf->dev, "coming out of suspend..\n");
474 return 0;
477 static const struct v4l2_ctrl_ops usb_amradio_ctrl_ops = {
478 .s_ctrl = usb_amradio_s_ctrl,
481 /* File system interface */
482 static const struct v4l2_file_operations usb_amradio_fops = {
483 .owner = THIS_MODULE,
484 .open = v4l2_fh_open,
485 .release = v4l2_fh_release,
486 .poll = v4l2_ctrl_poll,
487 .unlocked_ioctl = video_ioctl2,
490 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
491 .vidioc_querycap = vidioc_querycap,
492 .vidioc_g_tuner = vidioc_g_tuner,
493 .vidioc_s_tuner = vidioc_s_tuner,
494 .vidioc_g_frequency = vidioc_g_frequency,
495 .vidioc_s_frequency = vidioc_s_frequency,
496 .vidioc_s_hw_freq_seek = vidioc_s_hw_freq_seek,
497 .vidioc_log_status = v4l2_ctrl_log_status,
498 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
499 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
502 static void usb_amradio_release(struct v4l2_device *v4l2_dev)
504 struct amradio_device *radio = to_amradio_dev(v4l2_dev);
506 /* free rest memory */
507 v4l2_ctrl_handler_free(&radio->hdl);
508 v4l2_device_unregister(&radio->v4l2_dev);
509 kfree(radio->buffer);
510 kfree(radio);
513 /* check if the device is present and register with v4l and usb if it is */
514 static int usb_amradio_probe(struct usb_interface *intf,
515 const struct usb_device_id *id)
517 struct amradio_device *radio;
518 int retval = 0;
520 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
522 if (!radio) {
523 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
524 retval = -ENOMEM;
525 goto err;
528 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
530 if (!radio->buffer) {
531 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
532 retval = -ENOMEM;
533 goto err_nobuf;
536 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
537 if (retval < 0) {
538 dev_err(&intf->dev, "couldn't register v4l2_device\n");
539 goto err_v4l2;
542 v4l2_ctrl_handler_init(&radio->hdl, 1);
543 v4l2_ctrl_new_std(&radio->hdl, &usb_amradio_ctrl_ops,
544 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
545 if (radio->hdl.error) {
546 retval = radio->hdl.error;
547 dev_err(&intf->dev, "couldn't register control\n");
548 goto err_ctrl;
550 mutex_init(&radio->lock);
552 radio->v4l2_dev.ctrl_handler = &radio->hdl;
553 radio->v4l2_dev.release = usb_amradio_release;
554 strlcpy(radio->vdev.name, radio->v4l2_dev.name,
555 sizeof(radio->vdev.name));
556 radio->vdev.v4l2_dev = &radio->v4l2_dev;
557 radio->vdev.fops = &usb_amradio_fops;
558 radio->vdev.ioctl_ops = &usb_amradio_ioctl_ops;
559 radio->vdev.release = video_device_release_empty;
560 radio->vdev.lock = &radio->lock;
561 set_bit(V4L2_FL_USE_FH_PRIO, &radio->vdev.flags);
563 radio->usbdev = interface_to_usbdev(intf);
564 radio->intf = intf;
565 usb_set_intfdata(intf, &radio->v4l2_dev);
566 radio->curfreq = 95.16 * FREQ_MUL;
568 video_set_drvdata(&radio->vdev, radio);
569 retval = usb_amradio_init(radio);
570 if (retval)
571 goto err_vdev;
573 retval = video_register_device(&radio->vdev, VFL_TYPE_RADIO,
574 radio_nr);
575 if (retval < 0) {
576 dev_err(&intf->dev, "could not register video device\n");
577 goto err_vdev;
580 return 0;
582 err_vdev:
583 v4l2_ctrl_handler_free(&radio->hdl);
584 err_ctrl:
585 v4l2_device_unregister(&radio->v4l2_dev);
586 err_v4l2:
587 kfree(radio->buffer);
588 err_nobuf:
589 kfree(radio);
590 err:
591 return retval;
594 /* USB Device ID List */
595 static struct usb_device_id usb_amradio_device_table[] = {
596 { USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
597 USB_CLASS_HID, 0, 0) },
598 { } /* Terminating entry */
601 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
603 /* USB subsystem interface */
604 static struct usb_driver usb_amradio_driver = {
605 .name = MR800_DRIVER_NAME,
606 .probe = usb_amradio_probe,
607 .disconnect = usb_amradio_disconnect,
608 .suspend = usb_amradio_suspend,
609 .resume = usb_amradio_resume,
610 .reset_resume = usb_amradio_resume,
611 .id_table = usb_amradio_device_table,
614 module_usb_driver(usb_amradio_driver);