V4L/DVB (10254): em28xx: Fix audio URB transfer buffer race condition
[firefly-linux-kernel-4.4.55.git] / drivers / media / video / em28xx / em28xx-audio.c
1 /*
2  *  Empiatech em28x1 audio extension
3  *
4  *  Copyright (C) 2006 Markus Rechberger <mrechberger@gmail.com>
5  *
6  *  Copyright (C) 2007 Mauro Carvalho Chehab <mchehab@infradead.org>
7  *      - Port to work with the in-kernel driver
8  *      - Several cleanups
9  *
10  *  This driver is based on my previous au600 usb pstn audio driver
11  *  and inherits all the copyrights
12  *
13  *  This program is free software; you can redistribute it and/or modify
14  *  it under the terms of the GNU General Public License as published by
15  *  the Free Software Foundation; either version 2 of the License, or
16  *  (at your option) any later version.
17  *
18  *  This program is distributed in the hope that it will be useful,
19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  *  GNU General Public License for more details.
22  *
23  *  You should have received a copy of the GNU General Public License
24  *  along with this program; if not, write to the Free Software
25  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  */
27
28 #include <linux/kernel.h>
29 #include <linux/usb.h>
30 #include <linux/init.h>
31 #include <linux/sound.h>
32 #include <linux/spinlock.h>
33 #include <linux/soundcard.h>
34 #include <linux/slab.h>
35 #include <linux/vmalloc.h>
36 #include <linux/proc_fs.h>
37 #include <linux/module.h>
38 #include <sound/core.h>
39 #include <sound/pcm.h>
40 #include <sound/pcm_params.h>
41 #include <sound/info.h>
42 #include <sound/initval.h>
43 #include <sound/control.h>
44 #include <media/v4l2-common.h>
45 #include "em28xx.h"
46
47 static int debug;
48 module_param(debug, int, 0644);
49 MODULE_PARM_DESC(debug, "activates debug info");
50
51 #define dprintk(fmt, arg...) do {                                       \
52             if (debug)                                                  \
53                 printk(KERN_INFO "em28xx-audio %s: " fmt,               \
54                                   __func__, ##arg);             \
55         } while (0)
56
57 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
58
59 static int em28xx_isoc_audio_deinit(struct em28xx *dev)
60 {
61         int i;
62
63         dprintk("Stopping isoc\n");
64         for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
65                 usb_unlink_urb(dev->adev.urb[i]);
66                 usb_free_urb(dev->adev.urb[i]);
67                 dev->adev.urb[i] = NULL;
68
69                kfree(dev->adev.transfer_buffer[i]);
70                dev->adev.transfer_buffer[i] = NULL;
71         }
72
73         return 0;
74 }
75
76 static void em28xx_audio_isocirq(struct urb *urb)
77 {
78         struct em28xx            *dev = urb->context;
79         int                      i;
80         unsigned int             oldptr;
81         int                      period_elapsed = 0;
82         int                      status;
83         unsigned char            *cp;
84         unsigned int             stride;
85         struct snd_pcm_substream *substream;
86         struct snd_pcm_runtime   *runtime;
87         if (dev->adev.capture_pcm_substream) {
88                 substream = dev->adev.capture_pcm_substream;
89                 runtime = substream->runtime;
90                 stride = runtime->frame_bits >> 3;
91
92                 for (i = 0; i < urb->number_of_packets; i++) {
93                         int length =
94                             urb->iso_frame_desc[i].actual_length / stride;
95                         cp = (unsigned char *)urb->transfer_buffer +
96                             urb->iso_frame_desc[i].offset;
97
98                         if (!length)
99                                 continue;
100
101                         oldptr = dev->adev.hwptr_done_capture;
102                         if (oldptr + length >= runtime->buffer_size) {
103                                 unsigned int cnt =
104                                     runtime->buffer_size - oldptr;
105                                 memcpy(runtime->dma_area + oldptr * stride, cp,
106                                        cnt * stride);
107                                 memcpy(runtime->dma_area, cp + cnt * stride,
108                                        length * stride - cnt * stride);
109                         } else {
110                                 memcpy(runtime->dma_area + oldptr * stride, cp,
111                                        length * stride);
112                         }
113
114                         snd_pcm_stream_lock(substream);
115
116                         dev->adev.hwptr_done_capture += length;
117                         if (dev->adev.hwptr_done_capture >=
118                             runtime->buffer_size)
119                                 dev->adev.hwptr_done_capture -=
120                                     runtime->buffer_size;
121
122                         dev->adev.capture_transfer_done += length;
123                         if (dev->adev.capture_transfer_done >=
124                             runtime->period_size) {
125                                 dev->adev.capture_transfer_done -=
126                                     runtime->period_size;
127                                 period_elapsed = 1;
128                         }
129
130                         snd_pcm_stream_unlock(substream);
131                 }
132                 if (period_elapsed)
133                         snd_pcm_period_elapsed(substream);
134         }
135         urb->status = 0;
136
137         if (dev->adev.shutdown)
138                 return;
139
140         status = usb_submit_urb(urb, GFP_ATOMIC);
141         if (status < 0) {
142                 em28xx_errdev("resubmit of audio urb failed (error=%i)\n",
143                               status);
144         }
145         return;
146 }
147
148 static int em28xx_init_audio_isoc(struct em28xx *dev)
149 {
150         int       i, errCode;
151         const int sb_size = EM28XX_NUM_AUDIO_PACKETS *
152                             EM28XX_AUDIO_MAX_PACKET_SIZE;
153
154         dprintk("Starting isoc transfers\n");
155
156         for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
157                 struct urb *urb;
158                 int j, k;
159
160                 dev->adev.transfer_buffer[i] = kmalloc(sb_size, GFP_ATOMIC);
161                 if (!dev->adev.transfer_buffer[i])
162                         return -ENOMEM;
163
164                 memset(dev->adev.transfer_buffer[i], 0x80, sb_size);
165                 urb = usb_alloc_urb(EM28XX_NUM_AUDIO_PACKETS, GFP_ATOMIC);
166                 if (!urb) {
167                         em28xx_errdev("usb_alloc_urb failed!\n");
168                         for (j = 0; j < i; j++) {
169                                 usb_free_urb(dev->adev.urb[j]);
170                                 kfree(dev->adev.transfer_buffer[j]);
171                         }
172                         return -ENOMEM;
173                 }
174
175                 urb->dev = dev->udev;
176                 urb->context = dev;
177                 urb->pipe = usb_rcvisocpipe(dev->udev, 0x83);
178                 urb->transfer_flags = URB_ISO_ASAP;
179                 urb->transfer_buffer = dev->adev.transfer_buffer[i];
180                 urb->interval = 1;
181                 urb->complete = em28xx_audio_isocirq;
182                 urb->number_of_packets = EM28XX_NUM_AUDIO_PACKETS;
183                 urb->transfer_buffer_length = sb_size;
184
185                 for (j = k = 0; j < EM28XX_NUM_AUDIO_PACKETS;
186                              j++, k += EM28XX_AUDIO_MAX_PACKET_SIZE) {
187                         urb->iso_frame_desc[j].offset = k;
188                         urb->iso_frame_desc[j].length =
189                             EM28XX_AUDIO_MAX_PACKET_SIZE;
190                 }
191                 dev->adev.urb[i] = urb;
192         }
193
194         for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
195                 errCode = usb_submit_urb(dev->adev.urb[i], GFP_ATOMIC);
196                 if (errCode) {
197                         em28xx_isoc_audio_deinit(dev);
198
199                         return errCode;
200                 }
201         }
202
203         return 0;
204 }
205
206 static int em28xx_cmd(struct em28xx *dev, int cmd, int arg)
207 {
208         dprintk("%s transfer\n", (dev->adev.capture_stream == STREAM_ON) ?
209                                  "stop" : "start");
210
211         switch (cmd) {
212         case EM28XX_CAPTURE_STREAM_EN:
213                 if (dev->adev.capture_stream == STREAM_OFF && arg == 1) {
214                         dev->adev.capture_stream = STREAM_ON;
215                         em28xx_init_audio_isoc(dev);
216                 } else if (dev->adev.capture_stream == STREAM_ON && arg == 0) {
217                         dev->adev.capture_stream = STREAM_OFF;
218                         em28xx_isoc_audio_deinit(dev);
219                 } else {
220                         printk(KERN_ERR "An underrun very likely occurred. "
221                                         "Ignoring it.\n");
222                 }
223                 return 0;
224         default:
225                 return -EINVAL;
226         }
227 }
228
229 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs,
230                                         size_t size)
231 {
232         struct snd_pcm_runtime *runtime = subs->runtime;
233
234         dprintk("Alocating vbuffer\n");
235         if (runtime->dma_area) {
236                 if (runtime->dma_bytes > size)
237                         return 0;
238
239                 vfree(runtime->dma_area);
240         }
241         runtime->dma_area = vmalloc(size);
242         if (!runtime->dma_area)
243                 return -ENOMEM;
244
245         runtime->dma_bytes = size;
246
247         return 0;
248 }
249
250 static struct snd_pcm_hardware snd_em28xx_hw_capture = {
251         .info = SNDRV_PCM_INFO_BLOCK_TRANSFER |
252                 SNDRV_PCM_INFO_MMAP           |
253                 SNDRV_PCM_INFO_INTERLEAVED    |
254                 SNDRV_PCM_INFO_MMAP_VALID,
255
256         .formats = SNDRV_PCM_FMTBIT_S16_LE,
257
258         .rates = SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_KNOT,
259
260         .rate_min = 48000,
261         .rate_max = 48000,
262         .channels_min = 2,
263         .channels_max = 2,
264         .buffer_bytes_max = 62720 * 8,  /* just about the value in usbaudio.c */
265         .period_bytes_min = 64,         /* 12544/2, */
266         .period_bytes_max = 12544,
267         .periods_min = 2,
268         .periods_max = 98,              /* 12544, */
269 };
270
271 static int snd_em28xx_capture_open(struct snd_pcm_substream *substream)
272 {
273         struct em28xx *dev = snd_pcm_substream_chip(substream);
274         struct snd_pcm_runtime *runtime = substream->runtime;
275         int ret = 0;
276
277         dprintk("opening device and trying to acquire exclusive lock\n");
278
279         if (!dev) {
280                 printk(KERN_ERR "BUG: em28xx can't find device struct."
281                                 " Can't proceed with open\n");
282                 return -ENODEV;
283         }
284
285         /* Sets volume, mute, etc */
286
287         dev->mute = 0;
288         mutex_lock(&dev->lock);
289         ret = em28xx_audio_analog_set(dev);
290         mutex_unlock(&dev->lock);
291         if (ret < 0)
292                 goto err;
293
294         runtime->hw = snd_em28xx_hw_capture;
295         if (dev->alt == 0 && dev->adev.users == 0) {
296                 int errCode;
297                 dev->alt = 7;
298                 errCode = usb_set_interface(dev->udev, 0, 7);
299                 dprintk("changing alternate number to 7\n");
300         }
301
302         dev->adev.users++;
303
304         snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
305         dev->adev.capture_pcm_substream = substream;
306         runtime->private_data = dev;
307
308         return 0;
309 err:
310         printk(KERN_ERR "Error while configuring em28xx mixer\n");
311         return ret;
312 }
313
314 static int snd_em28xx_pcm_close(struct snd_pcm_substream *substream)
315 {
316         struct em28xx *dev = snd_pcm_substream_chip(substream);
317         dev->adev.users--;
318
319         dprintk("closing device\n");
320
321         dev->mute = 1;
322         mutex_lock(&dev->lock);
323         em28xx_audio_analog_set(dev);
324         mutex_unlock(&dev->lock);
325
326         if (dev->adev.users == 0 && dev->adev.shutdown == 1) {
327                 dprintk("audio users: %d\n", dev->adev.users);
328                 dprintk("disabling audio stream!\n");
329                 dev->adev.shutdown = 0;
330                 dprintk("released lock\n");
331                 em28xx_cmd(dev, EM28XX_CAPTURE_STREAM_EN, 0);
332         }
333         return 0;
334 }
335
336 static int snd_em28xx_hw_capture_params(struct snd_pcm_substream *substream,
337                                         struct snd_pcm_hw_params *hw_params)
338 {
339         unsigned int channels, rate, format;
340         int ret;
341
342         dprintk("Setting capture parameters\n");
343
344         ret = snd_pcm_alloc_vmalloc_buffer(substream,
345                                 params_buffer_bytes(hw_params));
346         format = params_format(hw_params);
347         rate = params_rate(hw_params);
348         channels = params_channels(hw_params);
349
350         /* TODO: set up em28xx audio chip to deliver the correct audio format,
351            current default is 48000hz multiplexed => 96000hz mono
352            which shouldn't matter since analogue TV only supports mono */
353         return 0;
354 }
355
356 static int snd_em28xx_hw_capture_free(struct snd_pcm_substream *substream)
357 {
358         struct em28xx *dev = snd_pcm_substream_chip(substream);
359
360         dprintk("Stop capture, if needed\n");
361
362         if (dev->adev.capture_stream == STREAM_ON)
363                 em28xx_cmd(dev, EM28XX_CAPTURE_STREAM_EN, 0);
364
365         return 0;
366 }
367
368 static int snd_em28xx_prepare(struct snd_pcm_substream *substream)
369 {
370         return 0;
371 }
372
373 static int snd_em28xx_capture_trigger(struct snd_pcm_substream *substream,
374                                       int cmd)
375 {
376         struct em28xx *dev = snd_pcm_substream_chip(substream);
377
378         dprintk("Should %s capture\n", (cmd == SNDRV_PCM_TRIGGER_START)?
379                                        "start": "stop");
380         switch (cmd) {
381         case SNDRV_PCM_TRIGGER_START:
382                 em28xx_cmd(dev, EM28XX_CAPTURE_STREAM_EN, 1);
383                 return 0;
384         case SNDRV_PCM_TRIGGER_STOP:
385                 dev->adev.shutdown = 1;
386                 return 0;
387         default:
388                 return -EINVAL;
389         }
390 }
391
392 static snd_pcm_uframes_t snd_em28xx_capture_pointer(struct snd_pcm_substream
393                                                     *substream)
394 {
395        unsigned long flags;
396
397         struct em28xx *dev;
398         snd_pcm_uframes_t hwptr_done;
399
400         dev = snd_pcm_substream_chip(substream);
401        spin_lock_irqsave(&dev->adev.slock, flags);
402         hwptr_done = dev->adev.hwptr_done_capture;
403        spin_unlock_irqrestore(&dev->adev.slock, flags);
404
405         return hwptr_done;
406 }
407
408 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
409                                              unsigned long offset)
410 {
411         void *pageptr = subs->runtime->dma_area + offset;
412
413         return vmalloc_to_page(pageptr);
414 }
415
416 static struct snd_pcm_ops snd_em28xx_pcm_capture = {
417         .open      = snd_em28xx_capture_open,
418         .close     = snd_em28xx_pcm_close,
419         .ioctl     = snd_pcm_lib_ioctl,
420         .hw_params = snd_em28xx_hw_capture_params,
421         .hw_free   = snd_em28xx_hw_capture_free,
422         .prepare   = snd_em28xx_prepare,
423         .trigger   = snd_em28xx_capture_trigger,
424         .pointer   = snd_em28xx_capture_pointer,
425         .page      = snd_pcm_get_vmalloc_page,
426 };
427
428 static int em28xx_audio_init(struct em28xx *dev)
429 {
430         struct em28xx_audio *adev = &dev->adev;
431         struct snd_pcm      *pcm;
432         struct snd_card     *card;
433         static int          devnr;
434         int                 err;
435
436         if (dev->has_alsa_audio != 1) {
437                 /* This device does not support the extension (in this case
438                    the device is expecting the snd-usb-audio module or
439                    doesn't have analog audio support at all) */
440                 return 0;
441         }
442
443         printk(KERN_INFO "em28xx-audio.c: probing for em28x1 "
444                          "non standard usbaudio\n");
445         printk(KERN_INFO "em28xx-audio.c: Copyright (C) 2006 Markus "
446                          "Rechberger\n");
447
448         card = snd_card_new(index[devnr], "Em28xx Audio", THIS_MODULE, 0);
449         if (card == NULL)
450                 return -ENOMEM;
451
452         spin_lock_init(&adev->slock);
453         err = snd_pcm_new(card, "Em28xx Audio", 0, 0, 1, &pcm);
454         if (err < 0) {
455                 snd_card_free(card);
456                 return err;
457         }
458
459         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_em28xx_pcm_capture);
460         pcm->info_flags = 0;
461         pcm->private_data = dev;
462         strcpy(pcm->name, "Empia 28xx Capture");
463         strcpy(card->driver, "Empia Em28xx Audio");
464         strcpy(card->shortname, "Em28xx Audio");
465         strcpy(card->longname, "Empia Em28xx Audio");
466
467         err = snd_card_register(card);
468         if (err < 0) {
469                 snd_card_free(card);
470                 return err;
471         }
472         adev->sndcard = card;
473         adev->udev = dev->udev;
474
475         return 0;
476 }
477
478 static int em28xx_audio_fini(struct em28xx *dev)
479 {
480         if (dev == NULL)
481                 return 0;
482
483         if (dev->has_alsa_audio != 1) {
484                 /* This device does not support the extension (in this case
485                    the device is expecting the snd-usb-audio module or
486                    doesn't have analog audio support at all) */
487                 return 0;
488         }
489
490         if (dev->adev.sndcard) {
491                 snd_card_free(dev->adev.sndcard);
492                 dev->adev.sndcard = NULL;
493         }
494
495         return 0;
496 }
497
498 static struct em28xx_ops audio_ops = {
499         .id   = EM28XX_AUDIO,
500         .name = "Em28xx Audio Extension",
501         .init = em28xx_audio_init,
502         .fini = em28xx_audio_fini,
503 };
504
505 static int __init em28xx_alsa_register(void)
506 {
507         return em28xx_register_extension(&audio_ops);
508 }
509
510 static void __exit em28xx_alsa_unregister(void)
511 {
512         em28xx_unregister_extension(&audio_ops);
513 }
514
515 MODULE_LICENSE("GPL");
516 MODULE_AUTHOR("Markus Rechberger <mrechberger@gmail.com>");
517 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
518 MODULE_DESCRIPTION("Em28xx Audio driver");
519
520 module_init(em28xx_alsa_register);
521 module_exit(em28xx_alsa_unregister);