Merge branch 'for-next' of git://git.samba.org/sfrench/cifs-2.6
[deliverable/linux.git] / drivers / media / radio / radio-mr800.c
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.
6 *
7 * Copyright (c) 2008 Alexey Klimov <klimov.linux@gmail.com>
8 *
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.
13 *
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.
18 *
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
22 */
23
24 /*
25 * Big thanks to authors and contributors of dsbr100.c and radio-si470x.c
26 *
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
36 *
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.
47 *
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
54 */
55
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>
69
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"
74
75 MODULE_AUTHOR(DRIVER_AUTHOR);
76 MODULE_DESCRIPTION(DRIVER_DESC);
77 MODULE_LICENSE("GPL");
78 MODULE_VERSION(DRIVER_VERSION);
79
80 #define USB_AMRADIO_VENDOR 0x07ca
81 #define USB_AMRADIO_PRODUCT 0xb800
82
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)
87
88 #define amradio_dev_err(dev, fmt, arg...) \
89 dev_err(dev, MR800_DRIVER_NAME " - " fmt, ##arg)
90
91 /* Probably USB_TIMEOUT should be modified in module parameter */
92 #define BUFFER_LENGTH 8
93 #define USB_TIMEOUT 500
94
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
100
101 /*
102 * Commands that device should understand
103 * List isn't full and will be updated with implementation of new functions
104 */
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
117
118 /* Comfortable defines for amradio_set_stereo */
119 #define WANT_STEREO 0x00
120 #define WANT_MONO 0x01
121
122 /* module parameter */
123 static int radio_nr = -1;
124 module_param(radio_nr, int, 0);
125 MODULE_PARM_DESC(radio_nr, "Radio Nr");
126
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;
135
136 u8 *buffer;
137 struct mutex lock; /* buffer locking */
138 int curfreq;
139 int stereo;
140 int muted;
141 };
142
143 static inline struct amradio_device *to_amradio_dev(struct v4l2_device *v4l2_dev)
144 {
145 return container_of(v4l2_dev, struct amradio_device, v4l2_dev);
146 }
147
148 static int amradio_send_cmd(struct amradio_device *radio, u8 cmd, u8 arg,
149 u8 *extra, u8 extralen, bool reply)
150 {
151 int retval;
152 int size;
153
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;
162
163 retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
164 radio->buffer, BUFFER_LENGTH, &size, USB_TIMEOUT);
165
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;
171 }
172 if (!extra && !reply)
173 return 0;
174
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);
184 }
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;
190 }
191
192 /* switch on/off the radio. Send 8 bytes to device */
193 static int amradio_set_mute(struct amradio_device *radio, bool mute)
194 {
195 int ret = amradio_send_cmd(radio,
196 AMRADIO_SET_MUTE, mute, NULL, 0, false);
197
198 if (!ret)
199 radio->muted = mute;
200 return ret;
201 }
202
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)
205 {
206 unsigned short freq_send = 0x10 + (freq >> 3) / 25;
207 u8 buf[3];
208 int retval;
209
210 /* frequency is calculated from freq_send and placed in first 2 bytes */
211 buf[0] = (freq_send >> 8) & 0xff;
212 buf[1] = freq_send & 0xff;
213 buf[2] = 0x01;
214
215 retval = amradio_send_cmd(radio, AMRADIO_SET_FREQ, 0, buf, 3, false);
216 if (retval)
217 return retval;
218 radio->curfreq = freq;
219 msleep(40);
220 return 0;
221 }
222
223 static int amradio_set_stereo(struct amradio_device *radio, bool stereo)
224 {
225 int ret = amradio_send_cmd(radio,
226 AMRADIO_SET_MONO, !stereo, NULL, 0, false);
227
228 if (!ret)
229 radio->stereo = stereo;
230 return ret;
231 }
232
233 static int amradio_get_stat(struct amradio_device *radio, bool *is_stereo, u32 *signal)
234 {
235 int ret = amradio_send_cmd(radio,
236 AMRADIO_GET_SIGNAL, 0, NULL, 0, true);
237
238 if (ret)
239 return ret;
240 *is_stereo = radio->buffer[2] >> 7;
241 *signal = (radio->buffer[3] & 0xf0) << 8;
242 return 0;
243 }
244
245 /* Handle unplugging the device.
246 * We call video_unregister_device in any case.
247 * The last function called in this procedure is
248 * usb_amradio_device_release.
249 */
250 static void usb_amradio_disconnect(struct usb_interface *intf)
251 {
252 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
253
254 mutex_lock(&radio->lock);
255 video_unregister_device(&radio->vdev);
256 amradio_set_mute(radio, true);
257 usb_set_intfdata(intf, NULL);
258 v4l2_device_disconnect(&radio->v4l2_dev);
259 mutex_unlock(&radio->lock);
260 v4l2_device_put(&radio->v4l2_dev);
261 }
262
263 /* vidioc_querycap - query device capabilities */
264 static int vidioc_querycap(struct file *file, void *priv,
265 struct v4l2_capability *v)
266 {
267 struct amradio_device *radio = video_drvdata(file);
268
269 strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
270 strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
271 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
272 v->device_caps = V4L2_CAP_RADIO | V4L2_CAP_TUNER |
273 V4L2_CAP_HW_FREQ_SEEK;
274 v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
275 return 0;
276 }
277
278 /* vidioc_g_tuner - get tuner attributes */
279 static int vidioc_g_tuner(struct file *file, void *priv,
280 struct v4l2_tuner *v)
281 {
282 struct amradio_device *radio = video_drvdata(file);
283 bool is_stereo = false;
284 int retval;
285
286 if (v->index > 0)
287 return -EINVAL;
288
289 v->signal = 0;
290 retval = amradio_get_stat(radio, &is_stereo, &v->signal);
291 if (retval)
292 return retval;
293
294 strcpy(v->name, "FM");
295 v->type = V4L2_TUNER_RADIO;
296 v->rangelow = FREQ_MIN * FREQ_MUL;
297 v->rangehigh = FREQ_MAX * FREQ_MUL;
298 v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO |
299 V4L2_TUNER_CAP_HWSEEK_WRAP;
300 v->rxsubchans = is_stereo ? V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
301 v->audmode = radio->stereo ?
302 V4L2_TUNER_MODE_STEREO : V4L2_TUNER_MODE_MONO;
303 return 0;
304 }
305
306 /* vidioc_s_tuner - set tuner attributes */
307 static int vidioc_s_tuner(struct file *file, void *priv,
308 struct v4l2_tuner *v)
309 {
310 struct amradio_device *radio = video_drvdata(file);
311
312 if (v->index > 0)
313 return -EINVAL;
314
315 /* mono/stereo selector */
316 switch (v->audmode) {
317 case V4L2_TUNER_MODE_MONO:
318 return amradio_set_stereo(radio, WANT_MONO);
319 default:
320 return amradio_set_stereo(radio, WANT_STEREO);
321 }
322 }
323
324 /* vidioc_s_frequency - set tuner radio frequency */
325 static int vidioc_s_frequency(struct file *file, void *priv,
326 struct v4l2_frequency *f)
327 {
328 struct amradio_device *radio = video_drvdata(file);
329
330 if (f->tuner != 0)
331 return -EINVAL;
332 return amradio_set_freq(radio, clamp_t(unsigned, f->frequency,
333 FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL));
334 }
335
336 /* vidioc_g_frequency - get tuner radio frequency */
337 static int vidioc_g_frequency(struct file *file, void *priv,
338 struct v4l2_frequency *f)
339 {
340 struct amradio_device *radio = video_drvdata(file);
341
342 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
343 return -EINVAL;
344 f->type = V4L2_TUNER_RADIO;
345 f->frequency = radio->curfreq;
346
347 return 0;
348 }
349
350 static int vidioc_s_hw_freq_seek(struct file *file, void *priv,
351 struct v4l2_hw_freq_seek *seek)
352 {
353 static u8 buf[8] = {
354 0x3d, 0x32, 0x0f, 0x08, 0x3d, 0x32, 0x0f, 0x08
355 };
356 struct amradio_device *radio = video_drvdata(file);
357 unsigned long timeout;
358 int retval;
359
360 if (seek->tuner != 0 || !seek->wrap_around)
361 return -EINVAL;
362
363 retval = amradio_send_cmd(radio,
364 AMRADIO_SET_SEARCH_LVL, 0, buf, 8, false);
365 if (retval)
366 return retval;
367 amradio_set_freq(radio, radio->curfreq);
368 retval = amradio_send_cmd(radio,
369 seek->seek_upward ? AMRADIO_SET_SEARCH_UP : AMRADIO_SET_SEARCH_DOWN,
370 0, NULL, 0, false);
371 if (retval)
372 return retval;
373 timeout = jiffies + msecs_to_jiffies(30000);
374 for (;;) {
375 if (time_after(jiffies, timeout)) {
376 retval = -ENODATA;
377 break;
378 }
379 if (schedule_timeout_interruptible(msecs_to_jiffies(10))) {
380 retval = -ERESTARTSYS;
381 break;
382 }
383 retval = amradio_send_cmd(radio, AMRADIO_GET_READY_FLAG,
384 0, NULL, 0, true);
385 if (retval)
386 continue;
387 amradio_send_cmd(radio, AMRADIO_GET_FREQ, 0, NULL, 0, true);
388 if (radio->buffer[1] || radio->buffer[2]) {
389 radio->curfreq = (radio->buffer[1] << 8) | radio->buffer[2];
390 radio->curfreq = (radio->curfreq - 0x10) * 200;
391 amradio_send_cmd(radio, AMRADIO_STOP_SEARCH,
392 0, NULL, 0, false);
393 amradio_set_freq(radio, radio->curfreq);
394 retval = 0;
395 break;
396 }
397 }
398 amradio_send_cmd(radio, AMRADIO_STOP_SEARCH, 0, NULL, 0, false);
399 amradio_set_freq(radio, radio->curfreq);
400 return retval;
401 }
402
403 static int usb_amradio_s_ctrl(struct v4l2_ctrl *ctrl)
404 {
405 struct amradio_device *radio =
406 container_of(ctrl->handler, struct amradio_device, hdl);
407
408 switch (ctrl->id) {
409 case V4L2_CID_AUDIO_MUTE:
410 return amradio_set_mute(radio, ctrl->val);
411 }
412
413 return -EINVAL;
414 }
415
416 static int usb_amradio_init(struct amradio_device *radio)
417 {
418 int retval;
419
420 retval = amradio_set_mute(radio, true);
421 if (retval)
422 goto out_err;
423 retval = amradio_set_stereo(radio, true);
424 if (retval)
425 goto out_err;
426 retval = amradio_set_freq(radio, radio->curfreq);
427 if (retval)
428 goto out_err;
429 return 0;
430
431 out_err:
432 amradio_dev_err(&radio->vdev.dev, "initialization failed\n");
433 return retval;
434 }
435
436 /* Suspend device - stop device. Need to be checked and fixed */
437 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
438 {
439 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
440
441 mutex_lock(&radio->lock);
442 if (!radio->muted) {
443 amradio_set_mute(radio, true);
444 radio->muted = false;
445 }
446 mutex_unlock(&radio->lock);
447
448 dev_info(&intf->dev, "going into suspend..\n");
449 return 0;
450 }
451
452 /* Resume device - start device. Need to be checked and fixed */
453 static int usb_amradio_resume(struct usb_interface *intf)
454 {
455 struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
456
457 mutex_lock(&radio->lock);
458 amradio_set_stereo(radio, radio->stereo);
459 amradio_set_freq(radio, radio->curfreq);
460
461 if (!radio->muted)
462 amradio_set_mute(radio, false);
463
464 mutex_unlock(&radio->lock);
465
466 dev_info(&intf->dev, "coming out of suspend..\n");
467 return 0;
468 }
469
470 static const struct v4l2_ctrl_ops usb_amradio_ctrl_ops = {
471 .s_ctrl = usb_amradio_s_ctrl,
472 };
473
474 /* File system interface */
475 static const struct v4l2_file_operations usb_amradio_fops = {
476 .owner = THIS_MODULE,
477 .open = v4l2_fh_open,
478 .release = v4l2_fh_release,
479 .poll = v4l2_ctrl_poll,
480 .unlocked_ioctl = video_ioctl2,
481 };
482
483 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
484 .vidioc_querycap = vidioc_querycap,
485 .vidioc_g_tuner = vidioc_g_tuner,
486 .vidioc_s_tuner = vidioc_s_tuner,
487 .vidioc_g_frequency = vidioc_g_frequency,
488 .vidioc_s_frequency = vidioc_s_frequency,
489 .vidioc_s_hw_freq_seek = vidioc_s_hw_freq_seek,
490 .vidioc_log_status = v4l2_ctrl_log_status,
491 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
492 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
493 };
494
495 static void usb_amradio_release(struct v4l2_device *v4l2_dev)
496 {
497 struct amradio_device *radio = to_amradio_dev(v4l2_dev);
498
499 /* free rest memory */
500 v4l2_ctrl_handler_free(&radio->hdl);
501 v4l2_device_unregister(&radio->v4l2_dev);
502 kfree(radio->buffer);
503 kfree(radio);
504 }
505
506 /* check if the device is present and register with v4l and usb if it is */
507 static int usb_amradio_probe(struct usb_interface *intf,
508 const struct usb_device_id *id)
509 {
510 struct amradio_device *radio;
511 int retval = 0;
512
513 radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
514
515 if (!radio) {
516 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
517 retval = -ENOMEM;
518 goto err;
519 }
520
521 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
522
523 if (!radio->buffer) {
524 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
525 retval = -ENOMEM;
526 goto err_nobuf;
527 }
528
529 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
530 if (retval < 0) {
531 dev_err(&intf->dev, "couldn't register v4l2_device\n");
532 goto err_v4l2;
533 }
534
535 v4l2_ctrl_handler_init(&radio->hdl, 1);
536 v4l2_ctrl_new_std(&radio->hdl, &usb_amradio_ctrl_ops,
537 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
538 if (radio->hdl.error) {
539 retval = radio->hdl.error;
540 dev_err(&intf->dev, "couldn't register control\n");
541 goto err_ctrl;
542 }
543 mutex_init(&radio->lock);
544
545 radio->v4l2_dev.ctrl_handler = &radio->hdl;
546 radio->v4l2_dev.release = usb_amradio_release;
547 strlcpy(radio->vdev.name, radio->v4l2_dev.name,
548 sizeof(radio->vdev.name));
549 radio->vdev.v4l2_dev = &radio->v4l2_dev;
550 radio->vdev.fops = &usb_amradio_fops;
551 radio->vdev.ioctl_ops = &usb_amradio_ioctl_ops;
552 radio->vdev.release = video_device_release_empty;
553 radio->vdev.lock = &radio->lock;
554 set_bit(V4L2_FL_USE_FH_PRIO, &radio->vdev.flags);
555
556 radio->usbdev = interface_to_usbdev(intf);
557 radio->intf = intf;
558 usb_set_intfdata(intf, &radio->v4l2_dev);
559 radio->curfreq = 95.16 * FREQ_MUL;
560
561 video_set_drvdata(&radio->vdev, radio);
562 retval = usb_amradio_init(radio);
563 if (retval)
564 goto err_vdev;
565
566 retval = video_register_device(&radio->vdev, VFL_TYPE_RADIO,
567 radio_nr);
568 if (retval < 0) {
569 dev_err(&intf->dev, "could not register video device\n");
570 goto err_vdev;
571 }
572
573 return 0;
574
575 err_vdev:
576 v4l2_ctrl_handler_free(&radio->hdl);
577 err_ctrl:
578 v4l2_device_unregister(&radio->v4l2_dev);
579 err_v4l2:
580 kfree(radio->buffer);
581 err_nobuf:
582 kfree(radio);
583 err:
584 return retval;
585 }
586
587 /* USB Device ID List */
588 static struct usb_device_id usb_amradio_device_table[] = {
589 { USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
590 USB_CLASS_HID, 0, 0) },
591 { } /* Terminating entry */
592 };
593
594 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
595
596 /* USB subsystem interface */
597 static struct usb_driver usb_amradio_driver = {
598 .name = MR800_DRIVER_NAME,
599 .probe = usb_amradio_probe,
600 .disconnect = usb_amradio_disconnect,
601 .suspend = usb_amradio_suspend,
602 .resume = usb_amradio_resume,
603 .reset_resume = usb_amradio_resume,
604 .id_table = usb_amradio_device_table,
605 };
606
607 module_usb_driver(usb_amradio_driver);
This page took 0.042953 seconds and 5 git commands to generate.