Merge branch 'akpm' (Andrew's patch-bomb)
[firefly-linux-kernel-4.4.55.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         v->rxsubchans = is_stereo ? V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
300         v->audmode = radio->stereo ?
301                 V4L2_TUNER_MODE_STEREO : V4L2_TUNER_MODE_MONO;
302         return 0;
303 }
304
305 /* vidioc_s_tuner - set tuner attributes */
306 static int vidioc_s_tuner(struct file *file, void *priv,
307                                 struct v4l2_tuner *v)
308 {
309         struct amradio_device *radio = video_drvdata(file);
310
311         if (v->index > 0)
312                 return -EINVAL;
313
314         /* mono/stereo selector */
315         switch (v->audmode) {
316         case V4L2_TUNER_MODE_MONO:
317                 return amradio_set_stereo(radio, WANT_MONO);
318         default:
319                 return amradio_set_stereo(radio, WANT_STEREO);
320         }
321 }
322
323 /* vidioc_s_frequency - set tuner radio frequency */
324 static int vidioc_s_frequency(struct file *file, void *priv,
325                                 struct v4l2_frequency *f)
326 {
327         struct amradio_device *radio = video_drvdata(file);
328
329         if (f->tuner != 0)
330                 return -EINVAL;
331         return amradio_set_freq(radio, clamp_t(unsigned, f->frequency,
332                                 FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL));
333 }
334
335 /* vidioc_g_frequency - get tuner radio frequency */
336 static int vidioc_g_frequency(struct file *file, void *priv,
337                                 struct v4l2_frequency *f)
338 {
339         struct amradio_device *radio = video_drvdata(file);
340
341         if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
342                 return -EINVAL;
343         f->type = V4L2_TUNER_RADIO;
344         f->frequency = radio->curfreq;
345
346         return 0;
347 }
348
349 static int vidioc_s_hw_freq_seek(struct file *file, void *priv,
350                 struct v4l2_hw_freq_seek *seek)
351 {
352         static u8 buf[8] = {
353                 0x3d, 0x32, 0x0f, 0x08, 0x3d, 0x32, 0x0f, 0x08
354         };
355         struct amradio_device *radio = video_drvdata(file);
356         unsigned long timeout;
357         int retval;
358
359         if (seek->tuner != 0 || !seek->wrap_around)
360                 return -EINVAL;
361
362         retval = amradio_send_cmd(radio,
363                         AMRADIO_SET_SEARCH_LVL, 0, buf, 8, false);
364         if (retval)
365                 return retval;
366         amradio_set_freq(radio, radio->curfreq);
367         retval = amradio_send_cmd(radio,
368                 seek->seek_upward ? AMRADIO_SET_SEARCH_UP : AMRADIO_SET_SEARCH_DOWN,
369                 0, NULL, 0, false);
370         if (retval)
371                 return retval;
372         timeout = jiffies + msecs_to_jiffies(30000);
373         for (;;) {
374                 if (time_after(jiffies, timeout)) {
375                         retval = -EAGAIN;
376                         break;
377                 }
378                 if (schedule_timeout_interruptible(msecs_to_jiffies(10))) {
379                         retval = -ERESTARTSYS;
380                         break;
381                 }
382                 retval = amradio_send_cmd(radio, AMRADIO_GET_READY_FLAG,
383                                 0, NULL, 0, true);
384                 if (retval)
385                         continue;
386                 amradio_send_cmd(radio, AMRADIO_GET_FREQ, 0, NULL, 0, true);
387                 if (radio->buffer[1] || radio->buffer[2]) {
388                         radio->curfreq = (radio->buffer[1] << 8) | radio->buffer[2];
389                         radio->curfreq = (radio->curfreq - 0x10) * 200;
390                         amradio_send_cmd(radio, AMRADIO_STOP_SEARCH,
391                                         0, NULL, 0, false);
392                         amradio_set_freq(radio, radio->curfreq);
393                         retval = 0;
394                         break;
395                 }
396         }
397         amradio_send_cmd(radio, AMRADIO_STOP_SEARCH, 0, NULL, 0, false);
398         amradio_set_freq(radio, radio->curfreq);
399         return retval;
400 }
401
402 static int usb_amradio_s_ctrl(struct v4l2_ctrl *ctrl)
403 {
404         struct amradio_device *radio =
405                 container_of(ctrl->handler, struct amradio_device, hdl);
406
407         switch (ctrl->id) {
408         case V4L2_CID_AUDIO_MUTE:
409                 return amradio_set_mute(radio, ctrl->val);
410         }
411
412         return -EINVAL;
413 }
414
415 static int usb_amradio_init(struct amradio_device *radio)
416 {
417         int retval;
418
419         retval = amradio_set_mute(radio, true);
420         if (retval)
421                 goto out_err;
422         retval = amradio_set_stereo(radio, true);
423         if (retval)
424                 goto out_err;
425         retval = amradio_set_freq(radio, radio->curfreq);
426         if (retval)
427                 goto out_err;
428         return 0;
429
430 out_err:
431         amradio_dev_err(&radio->vdev.dev, "initialization failed\n");
432         return retval;
433 }
434
435 /* Suspend device - stop device. Need to be checked and fixed */
436 static int usb_amradio_suspend(struct usb_interface *intf, pm_message_t message)
437 {
438         struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
439
440         mutex_lock(&radio->lock);
441         if (!radio->muted) {
442                 amradio_set_mute(radio, true);
443                 radio->muted = false;
444         }
445         mutex_unlock(&radio->lock);
446
447         dev_info(&intf->dev, "going into suspend..\n");
448         return 0;
449 }
450
451 /* Resume device - start device. Need to be checked and fixed */
452 static int usb_amradio_resume(struct usb_interface *intf)
453 {
454         struct amradio_device *radio = to_amradio_dev(usb_get_intfdata(intf));
455
456         mutex_lock(&radio->lock);
457         amradio_set_stereo(radio, radio->stereo);
458         amradio_set_freq(radio, radio->curfreq);
459
460         if (!radio->muted)
461                 amradio_set_mute(radio, false);
462
463         mutex_unlock(&radio->lock);
464
465         dev_info(&intf->dev, "coming out of suspend..\n");
466         return 0;
467 }
468
469 static const struct v4l2_ctrl_ops usb_amradio_ctrl_ops = {
470         .s_ctrl = usb_amradio_s_ctrl,
471 };
472
473 /* File system interface */
474 static const struct v4l2_file_operations usb_amradio_fops = {
475         .owner          = THIS_MODULE,
476         .open           = v4l2_fh_open,
477         .release        = v4l2_fh_release,
478         .poll           = v4l2_ctrl_poll,
479         .unlocked_ioctl = video_ioctl2,
480 };
481
482 static const struct v4l2_ioctl_ops usb_amradio_ioctl_ops = {
483         .vidioc_querycap    = vidioc_querycap,
484         .vidioc_g_tuner     = vidioc_g_tuner,
485         .vidioc_s_tuner     = vidioc_s_tuner,
486         .vidioc_g_frequency = vidioc_g_frequency,
487         .vidioc_s_frequency = vidioc_s_frequency,
488         .vidioc_s_hw_freq_seek = vidioc_s_hw_freq_seek,
489         .vidioc_log_status  = v4l2_ctrl_log_status,
490         .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
491         .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
492 };
493
494 static void usb_amradio_release(struct v4l2_device *v4l2_dev)
495 {
496         struct amradio_device *radio = to_amradio_dev(v4l2_dev);
497
498         /* free rest memory */
499         v4l2_ctrl_handler_free(&radio->hdl);
500         v4l2_device_unregister(&radio->v4l2_dev);
501         kfree(radio->buffer);
502         kfree(radio);
503 }
504
505 /* check if the device is present and register with v4l and usb if it is */
506 static int usb_amradio_probe(struct usb_interface *intf,
507                                 const struct usb_device_id *id)
508 {
509         struct amradio_device *radio;
510         int retval = 0;
511
512         radio = kzalloc(sizeof(struct amradio_device), GFP_KERNEL);
513
514         if (!radio) {
515                 dev_err(&intf->dev, "kmalloc for amradio_device failed\n");
516                 retval = -ENOMEM;
517                 goto err;
518         }
519
520         radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
521
522         if (!radio->buffer) {
523                 dev_err(&intf->dev, "kmalloc for radio->buffer failed\n");
524                 retval = -ENOMEM;
525                 goto err_nobuf;
526         }
527
528         retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
529         if (retval < 0) {
530                 dev_err(&intf->dev, "couldn't register v4l2_device\n");
531                 goto err_v4l2;
532         }
533
534         v4l2_ctrl_handler_init(&radio->hdl, 1);
535         v4l2_ctrl_new_std(&radio->hdl, &usb_amradio_ctrl_ops,
536                           V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
537         if (radio->hdl.error) {
538                 retval = radio->hdl.error;
539                 dev_err(&intf->dev, "couldn't register control\n");
540                 goto err_ctrl;
541         }
542         mutex_init(&radio->lock);
543
544         radio->v4l2_dev.ctrl_handler = &radio->hdl;
545         radio->v4l2_dev.release = usb_amradio_release;
546         strlcpy(radio->vdev.name, radio->v4l2_dev.name,
547                 sizeof(radio->vdev.name));
548         radio->vdev.v4l2_dev = &radio->v4l2_dev;
549         radio->vdev.fops = &usb_amradio_fops;
550         radio->vdev.ioctl_ops = &usb_amradio_ioctl_ops;
551         radio->vdev.release = video_device_release_empty;
552         radio->vdev.lock = &radio->lock;
553         set_bit(V4L2_FL_USE_FH_PRIO, &radio->vdev.flags);
554
555         radio->usbdev = interface_to_usbdev(intf);
556         radio->intf = intf;
557         usb_set_intfdata(intf, &radio->v4l2_dev);
558         radio->curfreq = 95.16 * FREQ_MUL;
559
560         video_set_drvdata(&radio->vdev, radio);
561         retval = usb_amradio_init(radio);
562         if (retval)
563                 goto err_vdev;
564
565         retval = video_register_device(&radio->vdev, VFL_TYPE_RADIO,
566                                         radio_nr);
567         if (retval < 0) {
568                 dev_err(&intf->dev, "could not register video device\n");
569                 goto err_vdev;
570         }
571
572         return 0;
573
574 err_vdev:
575         v4l2_ctrl_handler_free(&radio->hdl);
576 err_ctrl:
577         v4l2_device_unregister(&radio->v4l2_dev);
578 err_v4l2:
579         kfree(radio->buffer);
580 err_nobuf:
581         kfree(radio);
582 err:
583         return retval;
584 }
585
586 /* USB Device ID List */
587 static struct usb_device_id usb_amradio_device_table[] = {
588         { USB_DEVICE_AND_INTERFACE_INFO(USB_AMRADIO_VENDOR, USB_AMRADIO_PRODUCT,
589                                                         USB_CLASS_HID, 0, 0) },
590         { }                                             /* Terminating entry */
591 };
592
593 MODULE_DEVICE_TABLE(usb, usb_amradio_device_table);
594
595 /* USB subsystem interface */
596 static struct usb_driver usb_amradio_driver = {
597         .name                   = MR800_DRIVER_NAME,
598         .probe                  = usb_amradio_probe,
599         .disconnect             = usb_amradio_disconnect,
600         .suspend                = usb_amradio_suspend,
601         .resume                 = usb_amradio_resume,
602         .reset_resume           = usb_amradio_resume,
603         .id_table               = usb_amradio_device_table,
604 };
605
606 module_usb_driver(usb_amradio_driver);