]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/media/radio/radio-mr800.c
V4L/DVB: radio-mr800: remove BKL
[karo-tx-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/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>
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.11"
74 #define RADIO_VERSION KERNEL_VERSION(0, 1, 1)
75
76 MODULE_AUTHOR(DRIVER_AUTHOR);
77 MODULE_DESCRIPTION(DRIVER_DESC);
78 MODULE_LICENSE("GPL");
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 isnt full and will be updated with implementation of new functions
104  */
105 #define AMRADIO_SET_FREQ        0xa4
106 #define AMRADIO_SET_MUTE        0xab
107 #define AMRADIO_SET_MONO        0xae
108
109 /* Comfortable defines for amradio_set_mute */
110 #define AMRADIO_START           0x00
111 #define AMRADIO_STOP            0x01
112
113 /* Comfortable defines for amradio_set_stereo */
114 #define WANT_STEREO             0x00
115 #define WANT_MONO               0x01
116
117 /* module parameter */
118 static int radio_nr = -1;
119 module_param(radio_nr, int, 0);
120 MODULE_PARM_DESC(radio_nr, "Radio Nr");
121
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);
130
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;
138
139         unsigned char *buffer;
140         struct mutex lock;      /* buffer locking */
141         int curfreq;
142         int stereo;
143         int muted;
144         int initialized;
145 };
146
147 static inline struct amradio_device *to_amradio_dev(struct v4l2_device *v4l2_dev)
148 {
149         return container_of(v4l2_dev, struct amradio_device, v4l2_dev);
150 }
151
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 */
157 };
158
159 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
160
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,
171 };
172
173 /* switch on/off the radio. Send 8 bytes to device */
174 static int amradio_set_mute(struct amradio_device *radio, char argument)
175 {
176         int retval;
177         int size;
178
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;
187
188         retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
189                 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
190
191         if (retval < 0 || size != BUFFER_LENGTH) {
192                 amradio_dev_warn(&radio->videodev.dev, "set mute failed\n");
193                 return retval;
194         }
195
196         radio->muted = argument;
197
198         return retval;
199 }
200
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)
203 {
204         int retval;
205         int size;
206         unsigned short freq_send = 0x10 + (freq >> 3) / 25;
207
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;
216
217         retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
218                 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
219
220         if (retval < 0 || size != BUFFER_LENGTH)
221                 goto out_err;
222
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;
231
232         retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
233                 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
234
235         if (retval < 0 || size != BUFFER_LENGTH)
236                 goto out_err;
237
238         radio->curfreq = freq;
239         goto out;
240
241 out_err:
242         amradio_dev_warn(&radio->videodev.dev, "set frequency failed\n");
243 out:
244         return retval;
245 }
246
247 static int amradio_set_stereo(struct amradio_device *radio, char argument)
248 {
249         int retval;
250         int size;
251
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;
260
261         retval = usb_bulk_msg(radio->usbdev, usb_sndintpipe(radio->usbdev, 2),
262                 (void *) (radio->buffer), BUFFER_LENGTH, &size, USB_TIMEOUT);
263
264         if (retval < 0 || size != BUFFER_LENGTH) {
265                 amradio_dev_warn(&radio->videodev.dev, "set stereo failed\n");
266                 return retval;
267         }
268
269         if (argument == WANT_STEREO)
270                 radio->stereo = 1;
271         else
272                 radio->stereo = 0;
273
274         return retval;
275 }
276
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.
281  */
282 static void usb_amradio_disconnect(struct usb_interface *intf)
283 {
284         struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
285
286         mutex_lock(&radio->lock);
287         v4l2_device_disconnect(&radio->v4l2_dev);
288         video_unregister_device(&radio->videodev);
289         mutex_unlock(&radio->lock);
290 }
291
292 /* vidioc_querycap - query device capabilities */
293 static int vidioc_querycap(struct file *file, void *priv,
294                                         struct v4l2_capability *v)
295 {
296         struct amradio_device *radio = file->private_data;
297
298         strlcpy(v->driver, "radio-mr800", sizeof(v->driver));
299         strlcpy(v->card, "AverMedia MR 800 USB FM Radio", sizeof(v->card));
300         usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
301         v->version = RADIO_VERSION;
302         v->capabilities = V4L2_CAP_TUNER;
303         return 0;
304 }
305
306 /* vidioc_g_tuner - get tuner attributes */
307 static int vidioc_g_tuner(struct file *file, void *priv,
308                                 struct v4l2_tuner *v)
309 {
310         struct amradio_device *radio = file->private_data;
311         int retval;
312
313         if (v->index > 0)
314                 return -EINVAL;
315
316 /* TODO: Add function which look is signal stereo or not
317  *      amradio_getstat(radio);
318  */
319
320 /* we call amradio_set_stereo to set radio->stereo
321  * Honestly, amradio_getstat should cover this in future and
322  * amradio_set_stereo shouldn't be here
323  */
324         retval = amradio_set_stereo(radio, WANT_STEREO);
325
326         strcpy(v->name, "FM");
327         v->type = V4L2_TUNER_RADIO;
328         v->rangelow = FREQ_MIN * FREQ_MUL;
329         v->rangehigh = FREQ_MAX * FREQ_MUL;
330         v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
331         v->capability = V4L2_TUNER_CAP_LOW;
332         if (radio->stereo)
333                 v->audmode = V4L2_TUNER_MODE_STEREO;
334         else
335                 v->audmode = V4L2_TUNER_MODE_MONO;
336         v->signal = 0xffff;     /* Can't get the signal strength, sad.. */
337         v->afc = 0; /* Don't know what is this */
338
339         return retval;
340 }
341
342 /* vidioc_s_tuner - set tuner attributes */
343 static int vidioc_s_tuner(struct file *file, void *priv,
344                                 struct v4l2_tuner *v)
345 {
346         struct amradio_device *radio = file->private_data;
347         int retval = -EINVAL;
348
349         if (v->index > 0)
350                 return -EINVAL;
351
352         /* mono/stereo selector */
353         switch (v->audmode) {
354         case V4L2_TUNER_MODE_MONO:
355                 retval = amradio_set_stereo(radio, WANT_MONO);
356                 break;
357         case V4L2_TUNER_MODE_STEREO:
358                 retval = amradio_set_stereo(radio, WANT_STEREO);
359                 break;
360         }
361
362         return retval;
363 }
364
365 /* vidioc_s_frequency - set tuner radio frequency */
366 static int vidioc_s_frequency(struct file *file, void *priv,
367                                 struct v4l2_frequency *f)
368 {
369         struct amradio_device *radio = file->private_data;
370
371         if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
372                 return -EINVAL;
373         return amradio_setfreq(radio, f->frequency);
374 }
375
376 /* vidioc_g_frequency - get tuner radio frequency */
377 static int vidioc_g_frequency(struct file *file, void *priv,
378                                 struct v4l2_frequency *f)
379 {
380         struct amradio_device *radio = file->private_data;
381
382         if (f->tuner != 0)
383                 return -EINVAL;
384         f->type = V4L2_TUNER_RADIO;
385         f->frequency = radio->curfreq;
386
387         return 0;
388 }
389
390 /* vidioc_queryctrl - enumerate control items */
391 static int vidioc_queryctrl(struct file *file, void *priv,
392                                 struct v4l2_queryctrl *qc)
393 {
394         switch (qc->id) {
395         case V4L2_CID_AUDIO_MUTE:
396                 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
397         }
398
399         return -EINVAL;
400 }
401
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)
405 {
406         struct amradio_device *radio = file->private_data;
407
408         switch (ctrl->id) {
409         case V4L2_CID_AUDIO_MUTE:
410                 ctrl->value = radio->muted;
411                 return 0;
412         }
413
414         return -EINVAL;
415 }
416
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)
420 {
421         struct amradio_device *radio = file->private_data;
422         int retval = -EINVAL;
423
424         switch (ctrl->id) {
425         case V4L2_CID_AUDIO_MUTE:
426                 if (ctrl->value)
427                         retval = amradio_set_mute(radio, AMRADIO_STOP);
428                 else
429                         retval = amradio_set_mute(radio, AMRADIO_START);
430
431                 break;
432         }
433
434         return retval;
435 }
436
437 /* vidioc_g_audio - get audio attributes */
438 static int vidioc_g_audio(struct file *file, void *priv,
439                                 struct v4l2_audio *a)
440 {
441         if (a->index > 1)
442                 return -EINVAL;
443
444         strcpy(a->name, "Radio");
445         a->capability = V4L2_AUDCAP_STEREO;
446         return 0;
447 }
448
449 /* vidioc_s_audio - set audio attributes  */
450 static int vidioc_s_audio(struct file *file, void *priv,
451                                         struct v4l2_audio *a)
452 {
453         if (a->index != 0)
454                 return -EINVAL;
455         return 0;
456 }
457
458 /* vidioc_g_input - get input */
459 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
460 {
461         *i = 0;
462         return 0;
463 }
464
465 /* vidioc_s_input - set input */
466 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
467 {
468         if (i != 0)
469                 return -EINVAL;
470         return 0;
471 }
472
473 static int usb_amradio_init(struct amradio_device *radio)
474 {
475         int retval;
476
477         retval = amradio_set_mute(radio, AMRADIO_STOP);
478         if (retval)
479                 goto out_err;
480
481         retval = amradio_set_stereo(radio, WANT_STEREO);
482         if (retval)
483                 goto out_err;
484
485         radio->initialized = 1;
486         goto out;
487
488 out_err:
489         amradio_dev_err(&radio->videodev.dev, "initialization failed\n");
490 out:
491         return retval;
492 }
493
494 /* open device - amradio_start() and amradio_setfreq() */
495 static int usb_amradio_open(struct file *file)
496 {
497         struct amradio_device *radio = video_drvdata(file);
498         int retval;
499
500         file->private_data = radio;
501         retval = usb_autopm_get_interface(radio->intf);
502         if (retval)
503                 return retval;
504
505         if (unlikely(!radio->initialized)) {
506                 retval = usb_amradio_init(radio);
507                 if (retval)
508                         usb_autopm_put_interface(radio->intf);
509         }
510         return retval;
511 }
512
513 /*close device */
514 static int usb_amradio_close(struct file *file)
515 {
516         struct amradio_device *radio = file->private_data;
517
518         usb_autopm_put_interface(radio->intf);
519         return 0;
520 }
521
522 /* Suspend device - stop device. Need to be checked and fixed */
523 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
524 {
525         struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
526
527         if (!radio->muted && radio->initialized) {
528                 amradio_set_mute(radio, AMRADIO_STOP);
529                 radio->muted = 0;
530         }
531
532         dev_info(&intf->dev, "going into suspend..\n");
533         return 0;
534 }
535
536 /* Resume device - start device. Need to be checked and fixed */
537 static int usb_amradio_resume(struct usb_interface *intf)
538 {
539         struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
540
541         if (unlikely(!radio->initialized))
542                 return 0;
543
544         if (radio->stereo)
545                 amradio_set_stereo(radio, WANT_STEREO);
546         else
547                 amradio_set_stereo(radio, WANT_MONO);
548
549         amradio_setfreq(radio, radio->curfreq);
550
551         if (!radio->muted)
552                 amradio_set_mute(radio, AMRADIO_START);
553
554         dev_info(&intf->dev, "coming out of suspend..\n");
555         return 0;
556 }
557
558 /* File system interface */
559 static const struct v4l2_file_operations usb_amradio_fops = {
560         .owner          = THIS_MODULE,
561         .open           = usb_amradio_open,
562         .release        = usb_amradio_close,
563         .unlocked_ioctl = video_ioctl2,
564 };
565
566 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
567         .vidioc_querycap    = vidioc_querycap,
568         .vidioc_g_tuner     = vidioc_g_tuner,
569         .vidioc_s_tuner     = vidioc_s_tuner,
570         .vidioc_g_frequency = vidioc_g_frequency,
571         .vidioc_s_frequency = vidioc_s_frequency,
572         .vidioc_queryctrl   = vidioc_queryctrl,
573         .vidioc_g_ctrl      = vidioc_g_ctrl,
574         .vidioc_s_ctrl      = vidioc_s_ctrl,
575         .vidioc_g_audio     = vidioc_g_audio,
576         .vidioc_s_audio     = vidioc_s_audio,
577         .vidioc_g_input     = vidioc_g_input,
578         .vidioc_s_input     = vidioc_s_input,
579 };
580
581 static void usb_amradio_video_device_release(struct video_device *videodev)
582 {
583         struct amradio_device *radio = video_get_drvdata(videodev);
584
585         /* free rest memory */
586         kfree(radio->buffer);
587         kfree(radio);
588 }
589
590 /* check if the device is present and register with v4l and usb if it is */
591 static int usb_amradio_probe(struct usb_interface *intf,
592                                 const struct usb_device_id *id)
593 {
594         struct amradio_device *radio;
595         int retval = 0;
596
597         radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
598
599         if (!radio) {
600                 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
601                 retval = -ENOMEM;
602                 goto err;
603         }
604
605         radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
606
607         if (!radio->buffer) {
608                 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
609                 retval = -ENOMEM;
610                 goto err_nobuf;
611         }
612
613         retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
614         if (retval < 0) {
615                 dev_err(&intf->dev, "couldn't register v4l2_device\n");
616                 goto err_v4l2;
617         }
618
619         mutex_init(&radio->lock);
620
621         strlcpy(radio->videodev.name, radio->v4l2_dev.name,
622                 sizeof(radio->videodev.name));
623         radio->videodev.v4l2_dev = &radio->v4l2_dev;
624         radio->videodev.fops = &usb_amradio_fops;
625         radio->videodev.ioctl_ops = &usb_amradio_ioctl_ops;
626         radio->videodev.release = usb_amradio_video_device_release;
627         radio->videodev.lock = &radio->lock;
628
629         radio->usbdev = interface_to_usbdev(intf);
630         radio->intf = intf;
631         radio->curfreq = 95.16 * FREQ_MUL;
632
633         video_set_drvdata(&radio->videodev, radio);
634
635         retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
636                                         radio_nr);
637         if (retval < 0) {
638                 dev_err(&intf->dev, "could not register video device\n");
639                 goto err_vdev;
640         }
641
642         return 0;
643
644 err_vdev:
645         v4l2_device_unregister(&radio->v4l2_dev);
646 err_v4l2:
647         kfree(radio->buffer);
648 err_nobuf:
649         kfree(radio);
650 err:
651         return retval;
652 }
653
654 static int __init amradio_init(void)
655 {
656         int retval = usb_register(&usb_amradio_driver);
657
658         pr_info(KBUILD_MODNAME
659                 ": version " DRIVER_VERSION " " DRIVER_DESC "\n");
660
661         if (retval)
662                 pr_err(KBUILD_MODNAME
663                         ": usb_register failed. Error number %d\n", retval);
664
665         return retval;
666 }
667
668 static void __exit amradio_exit(void)
669 {
670         usb_deregister(&usb_amradio_driver);
671 }
672
673 module_init(amradio_init);
674 module_exit(amradio_exit);
675