2 * Empiatech em28x1 audio extension
4 * Copyright (C) 2006 Markus Rechberger <mrechberger@gmail.com>
6 * Copyright (C) 2007-2011 Mauro Carvalho Chehab <mchehab@redhat.com>
7 * - Port to work with the in-kernel driver
8 * - Cleanups, fixes, alsa-controls, etc.
10 * This driver is based on my previous au600 usb pstn audio driver
11 * and inherits all the copyrights
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.
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.
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.
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 <sound/tlv.h>
45 #include <media/v4l2-common.h>
49 module_param(debug, int, 0644);
50 MODULE_PARM_DESC(debug, "activates debug info");
52 #define dprintk(fmt, arg...) do { \
54 printk(KERN_INFO "em28xx-audio %s: " fmt, \
58 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
60 static int em28xx_deinit_isoc_audio(struct em28xx *dev)
64 dprintk("Stopping isoc\n");
65 for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
67 usb_kill_urb(dev->adev.urb[i]);
69 usb_unlink_urb(dev->adev.urb[i]);
71 usb_free_urb(dev->adev.urb[i]);
72 dev->adev.urb[i] = NULL;
74 kfree(dev->adev.transfer_buffer[i]);
75 dev->adev.transfer_buffer[i] = NULL;
81 static void em28xx_audio_isocirq(struct urb *urb)
83 struct em28xx *dev = urb->context;
86 int period_elapsed = 0;
90 struct snd_pcm_substream *substream;
91 struct snd_pcm_runtime *runtime;
93 switch (urb->status) {
95 case -ETIMEDOUT: /* NAK */
97 case -ECONNRESET: /* kill */
102 dprintk("urb completition error %d.\n", urb->status);
106 if (atomic_read(&dev->stream_started) == 0)
109 if (dev->adev.capture_pcm_substream) {
110 substream = dev->adev.capture_pcm_substream;
111 runtime = substream->runtime;
112 stride = runtime->frame_bits >> 3;
114 for (i = 0; i < urb->number_of_packets; i++) {
116 urb->iso_frame_desc[i].actual_length / stride;
117 cp = (unsigned char *)urb->transfer_buffer +
118 urb->iso_frame_desc[i].offset;
123 oldptr = dev->adev.hwptr_done_capture;
124 if (oldptr + length >= runtime->buffer_size) {
126 runtime->buffer_size - oldptr;
127 memcpy(runtime->dma_area + oldptr * stride, cp,
129 memcpy(runtime->dma_area, cp + cnt * stride,
130 length * stride - cnt * stride);
132 memcpy(runtime->dma_area + oldptr * stride, cp,
136 snd_pcm_stream_lock(substream);
138 dev->adev.hwptr_done_capture += length;
139 if (dev->adev.hwptr_done_capture >=
140 runtime->buffer_size)
141 dev->adev.hwptr_done_capture -=
142 runtime->buffer_size;
144 dev->adev.capture_transfer_done += length;
145 if (dev->adev.capture_transfer_done >=
146 runtime->period_size) {
147 dev->adev.capture_transfer_done -=
148 runtime->period_size;
152 snd_pcm_stream_unlock(substream);
155 snd_pcm_period_elapsed(substream);
159 status = usb_submit_urb(urb, GFP_ATOMIC);
161 em28xx_errdev("resubmit of audio urb failed (error=%i)\n",
167 static int em28xx_init_audio_isoc(struct em28xx *dev)
170 const int sb_size = EM28XX_NUM_AUDIO_PACKETS *
171 EM28XX_AUDIO_MAX_PACKET_SIZE;
173 dprintk("Starting isoc transfers\n");
175 for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
179 dev->adev.transfer_buffer[i] = kmalloc(sb_size, GFP_ATOMIC);
180 if (!dev->adev.transfer_buffer[i])
183 memset(dev->adev.transfer_buffer[i], 0x80, sb_size);
184 urb = usb_alloc_urb(EM28XX_NUM_AUDIO_PACKETS, GFP_ATOMIC);
186 em28xx_errdev("usb_alloc_urb failed!\n");
187 for (j = 0; j < i; j++) {
188 usb_free_urb(dev->adev.urb[j]);
189 kfree(dev->adev.transfer_buffer[j]);
194 urb->dev = dev->udev;
196 urb->pipe = usb_rcvisocpipe(dev->udev, 0x83);
197 urb->transfer_flags = URB_ISO_ASAP;
198 urb->transfer_buffer = dev->adev.transfer_buffer[i];
200 urb->complete = em28xx_audio_isocirq;
201 urb->number_of_packets = EM28XX_NUM_AUDIO_PACKETS;
202 urb->transfer_buffer_length = sb_size;
204 for (j = k = 0; j < EM28XX_NUM_AUDIO_PACKETS;
205 j++, k += EM28XX_AUDIO_MAX_PACKET_SIZE) {
206 urb->iso_frame_desc[j].offset = k;
207 urb->iso_frame_desc[j].length =
208 EM28XX_AUDIO_MAX_PACKET_SIZE;
210 dev->adev.urb[i] = urb;
213 for (i = 0; i < EM28XX_AUDIO_BUFS; i++) {
214 errCode = usb_submit_urb(dev->adev.urb[i], GFP_ATOMIC);
216 em28xx_errdev("submit of audio urb failed\n");
217 em28xx_deinit_isoc_audio(dev);
218 atomic_set(&dev->stream_started, 0);
227 static int snd_pcm_alloc_vmalloc_buffer(struct snd_pcm_substream *subs,
230 struct snd_pcm_runtime *runtime = subs->runtime;
232 dprintk("Allocating vbuffer\n");
233 if (runtime->dma_area) {
234 if (runtime->dma_bytes > size)
237 vfree(runtime->dma_area);
239 runtime->dma_area = vmalloc(size);
240 if (!runtime->dma_area)
243 runtime->dma_bytes = size;
248 static struct snd_pcm_hardware snd_em28xx_hw_capture = {
249 .info = SNDRV_PCM_INFO_BLOCK_TRANSFER |
250 SNDRV_PCM_INFO_MMAP |
251 SNDRV_PCM_INFO_INTERLEAVED |
252 SNDRV_PCM_INFO_BATCH |
253 SNDRV_PCM_INFO_MMAP_VALID,
255 .formats = SNDRV_PCM_FMTBIT_S16_LE,
257 .rates = SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_KNOT,
263 .buffer_bytes_max = 62720 * 8, /* just about the value in usbaudio.c */
264 .period_bytes_min = 64, /* 12544/2, */
265 .period_bytes_max = 12544,
267 .periods_max = 98, /* 12544, */
270 static int snd_em28xx_capture_open(struct snd_pcm_substream *substream)
272 struct em28xx *dev = snd_pcm_substream_chip(substream);
273 struct snd_pcm_runtime *runtime = substream->runtime;
276 dprintk("opening device and trying to acquire exclusive lock\n");
279 em28xx_err("BUG: em28xx can't find device struct."
280 " Can't proceed with open\n");
284 runtime->hw = snd_em28xx_hw_capture;
285 if ((dev->alt == 0 || dev->audio_ifnum) && dev->adev.users == 0) {
286 if (dev->audio_ifnum)
291 dprintk("changing alternate number on interface %d to %d\n",
292 dev->audio_ifnum, dev->alt);
293 usb_set_interface(dev->udev, dev->audio_ifnum, dev->alt);
295 /* Sets volume, mute, etc */
297 mutex_lock(&dev->lock);
298 ret = em28xx_audio_analog_set(dev);
303 mutex_unlock(&dev->lock);
306 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
307 dev->adev.capture_pcm_substream = substream;
308 runtime->private_data = dev;
312 mutex_unlock(&dev->lock);
314 em28xx_err("Error while configuring em28xx mixer\n");
318 static int snd_em28xx_pcm_close(struct snd_pcm_substream *substream)
320 struct em28xx *dev = snd_pcm_substream_chip(substream);
322 dprintk("closing device\n");
325 mutex_lock(&dev->lock);
327 if (atomic_read(&dev->stream_started) > 0) {
328 atomic_set(&dev->stream_started, 0);
329 schedule_work(&dev->wq_trigger);
332 em28xx_audio_analog_set(dev);
333 if (substream->runtime->dma_area) {
334 dprintk("freeing\n");
335 vfree(substream->runtime->dma_area);
336 substream->runtime->dma_area = NULL;
338 mutex_unlock(&dev->lock);
343 static int snd_em28xx_hw_capture_params(struct snd_pcm_substream *substream,
344 struct snd_pcm_hw_params *hw_params)
346 unsigned int channels, rate, format;
349 dprintk("Setting capture parameters\n");
351 ret = snd_pcm_alloc_vmalloc_buffer(substream,
352 params_buffer_bytes(hw_params));
355 format = params_format(hw_params);
356 rate = params_rate(hw_params);
357 channels = params_channels(hw_params);
359 /* TODO: set up em28xx audio chip to deliver the correct audio format,
360 current default is 48000hz multiplexed => 96000hz mono
361 which shouldn't matter since analogue TV only supports mono */
365 static int snd_em28xx_hw_capture_free(struct snd_pcm_substream *substream)
367 struct em28xx *dev = snd_pcm_substream_chip(substream);
369 dprintk("Stop capture, if needed\n");
371 if (atomic_read(&dev->stream_started) > 0) {
372 atomic_set(&dev->stream_started, 0);
373 schedule_work(&dev->wq_trigger);
379 static int snd_em28xx_prepare(struct snd_pcm_substream *substream)
381 struct em28xx *dev = snd_pcm_substream_chip(substream);
383 dev->adev.hwptr_done_capture = 0;
384 dev->adev.capture_transfer_done = 0;
389 static void audio_trigger(struct work_struct *work)
391 struct em28xx *dev = container_of(work, struct em28xx, wq_trigger);
393 if (atomic_read(&dev->stream_started)) {
394 dprintk("starting capture");
395 em28xx_init_audio_isoc(dev);
397 dprintk("stopping capture");
398 em28xx_deinit_isoc_audio(dev);
402 static int snd_em28xx_capture_trigger(struct snd_pcm_substream *substream,
405 struct em28xx *dev = snd_pcm_substream_chip(substream);
409 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE: /* fall through */
410 case SNDRV_PCM_TRIGGER_RESUME: /* fall through */
411 case SNDRV_PCM_TRIGGER_START:
412 atomic_set(&dev->stream_started, 1);
414 case SNDRV_PCM_TRIGGER_PAUSE_PUSH: /* fall through */
415 case SNDRV_PCM_TRIGGER_SUSPEND: /* fall through */
416 case SNDRV_PCM_TRIGGER_STOP:
417 atomic_set(&dev->stream_started, 0);
422 schedule_work(&dev->wq_trigger);
426 static snd_pcm_uframes_t snd_em28xx_capture_pointer(struct snd_pcm_substream
431 snd_pcm_uframes_t hwptr_done;
433 dev = snd_pcm_substream_chip(substream);
434 spin_lock_irqsave(&dev->adev.slock, flags);
435 hwptr_done = dev->adev.hwptr_done_capture;
436 spin_unlock_irqrestore(&dev->adev.slock, flags);
441 static struct page *snd_pcm_get_vmalloc_page(struct snd_pcm_substream *subs,
442 unsigned long offset)
444 void *pageptr = subs->runtime->dma_area + offset;
446 return vmalloc_to_page(pageptr);
450 * AC97 volume control support
452 static int em28xx_vol_info(struct snd_kcontrol *kcontrol,
453 struct snd_ctl_elem_info *info)
455 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
457 info->value.integer.min = 0;
458 info->value.integer.max = 0x1f;
463 static int em28xx_vol_put(struct snd_kcontrol *kcontrol,
464 struct snd_ctl_elem_value *value)
466 struct em28xx *dev = snd_kcontrol_chip(kcontrol);
467 u16 val = (0x1f - (value->value.integer.value[0] & 0x1f)) |
468 (0x1f - (value->value.integer.value[1] & 0x1f)) << 8;
471 mutex_lock(&dev->lock);
472 rc = em28xx_read_ac97(dev, kcontrol->private_value);
476 val |= rc & 0x8000; /* Preserve the mute flag */
478 rc = em28xx_write_ac97(dev, kcontrol->private_value, val);
482 dprintk("%sleft vol %d, right vol %d (0x%04x) to ac97 volume control 0x%04x\n",
483 (val & 0x8000) ? "muted " : "",
484 0x1f - ((val >> 8) & 0x1f), 0x1f - (val & 0x1f),
485 val, (int)kcontrol->private_value);
488 mutex_unlock(&dev->lock);
492 static int em28xx_vol_get(struct snd_kcontrol *kcontrol,
493 struct snd_ctl_elem_value *value)
495 struct em28xx *dev = snd_kcontrol_chip(kcontrol);
498 mutex_lock(&dev->lock);
499 val = em28xx_read_ac97(dev, kcontrol->private_value);
500 mutex_unlock(&dev->lock);
504 dprintk("%sleft vol %d, right vol %d (0x%04x) from ac97 volume control 0x%04x\n",
505 (val & 0x8000) ? "muted " : "",
506 0x1f - ((val >> 8) & 0x1f), 0x1f - (val & 0x1f),
507 val, (int)kcontrol->private_value);
509 value->value.integer.value[0] = 0x1f - (val & 0x1f);
510 value->value.integer.value[1] = 0x1f - ((val << 8) & 0x1f);
515 static int em28xx_vol_put_mute(struct snd_kcontrol *kcontrol,
516 struct snd_ctl_elem_value *value)
518 struct em28xx *dev = snd_kcontrol_chip(kcontrol);
519 u16 val = value->value.integer.value[0];
522 mutex_lock(&dev->lock);
523 rc = em28xx_read_ac97(dev, kcontrol->private_value);
532 rc = em28xx_write_ac97(dev, kcontrol->private_value, rc);
536 dprintk("%sleft vol %d, right vol %d (0x%04x) to ac97 volume control 0x%04x\n",
537 (val & 0x8000) ? "muted " : "",
538 0x1f - ((val >> 8) & 0x1f), 0x1f - (val & 0x1f),
539 val, (int)kcontrol->private_value);
542 mutex_unlock(&dev->lock);
546 static int em28xx_vol_get_mute(struct snd_kcontrol *kcontrol,
547 struct snd_ctl_elem_value *value)
549 struct em28xx *dev = snd_kcontrol_chip(kcontrol);
552 mutex_lock(&dev->lock);
553 val = em28xx_read_ac97(dev, kcontrol->private_value);
554 mutex_unlock(&dev->lock);
559 value->value.integer.value[0] = 0;
561 value->value.integer.value[0] = 1;
563 dprintk("%sleft vol %d, right vol %d (0x%04x) from ac97 volume control 0x%04x\n",
564 (val & 0x8000) ? "muted " : "",
565 0x1f - ((val >> 8) & 0x1f), 0x1f - (val & 0x1f),
566 val, (int)kcontrol->private_value);
571 static const DECLARE_TLV_DB_SCALE(em28xx_db_scale, -3450, 150, 0);
573 static int em28xx_cvol_new(struct snd_card *card, struct em28xx *dev,
578 struct snd_kcontrol *kctl;
579 struct snd_kcontrol_new tmp;
581 memset (&tmp, 0, sizeof(tmp));
582 tmp.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
583 tmp.private_value = id,
586 /* Add Mute Control */
587 sprintf(ctl_name, "%s Switch", name);
588 tmp.get = em28xx_vol_get_mute;
589 tmp.put = em28xx_vol_put_mute;
590 tmp.info = snd_ctl_boolean_mono_info;
591 kctl = snd_ctl_new1(&tmp, dev);
592 err = snd_ctl_add(card, kctl);
595 dprintk("Added control %s for ac97 volume control 0x%04x\n",
598 memset (&tmp, 0, sizeof(tmp));
599 tmp.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
600 tmp.private_value = id,
603 /* Add Volume Control */
604 sprintf(ctl_name, "%s Volume", name);
605 tmp.get = em28xx_vol_get;
606 tmp.put = em28xx_vol_put;
607 tmp.info = em28xx_vol_info;
608 tmp.tlv.p = em28xx_db_scale,
609 kctl = snd_ctl_new1(&tmp, dev);
610 err = snd_ctl_add(card, kctl);
613 dprintk("Added control %s for ac97 volume control 0x%04x\n",
620 * register/unregister code and data
622 static struct snd_pcm_ops snd_em28xx_pcm_capture = {
623 .open = snd_em28xx_capture_open,
624 .close = snd_em28xx_pcm_close,
625 .ioctl = snd_pcm_lib_ioctl,
626 .hw_params = snd_em28xx_hw_capture_params,
627 .hw_free = snd_em28xx_hw_capture_free,
628 .prepare = snd_em28xx_prepare,
629 .trigger = snd_em28xx_capture_trigger,
630 .pointer = snd_em28xx_capture_pointer,
631 .page = snd_pcm_get_vmalloc_page,
634 static int em28xx_audio_init(struct em28xx *dev)
636 struct em28xx_audio *adev = &dev->adev;
638 struct snd_card *card;
642 if (!dev->has_alsa_audio || dev->audio_ifnum < 0) {
643 /* This device does not support the extension (in this case
644 the device is expecting the snd-usb-audio module or
645 doesn't have analog audio support at all) */
649 printk(KERN_INFO "em28xx-audio.c: probing for em28xx Audio Vendor Class\n");
650 printk(KERN_INFO "em28xx-audio.c: Copyright (C) 2006 Markus "
652 printk(KERN_INFO "em28xx-audio.c: Copyright (C) 2007-2011 Mauro Carvalho Chehab\n");
654 err = snd_card_create(index[devnr], "Em28xx Audio", THIS_MODULE, 0,
659 spin_lock_init(&adev->slock);
660 err = snd_pcm_new(card, "Em28xx Audio", 0, 0, 1, &pcm);
666 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_em28xx_pcm_capture);
668 pcm->private_data = dev;
669 strcpy(pcm->name, "Empia 28xx Capture");
671 snd_card_set_dev(card, &dev->udev->dev);
672 strcpy(card->driver, "Em28xx-Audio");
673 strcpy(card->shortname, "Em28xx Audio");
674 strcpy(card->longname, "Empia Em28xx Audio");
676 INIT_WORK(&dev->wq_trigger, audio_trigger);
678 if (dev->audio_mode.ac97 != EM28XX_NO_AC97) {
679 em28xx_cvol_new(card, dev, "Video", AC97_VIDEO_VOL);
680 em28xx_cvol_new(card, dev, "Line In", AC97_LINEIN_VOL);
681 em28xx_cvol_new(card, dev, "Phone", AC97_PHONE_VOL);
682 em28xx_cvol_new(card, dev, "Microphone", AC97_PHONE_VOL);
683 em28xx_cvol_new(card, dev, "CD", AC97_CD_VOL);
684 em28xx_cvol_new(card, dev, "AUX", AC97_AUX_VOL);
685 em28xx_cvol_new(card, dev, "PCM", AC97_PCM_OUT_VOL);
687 em28xx_cvol_new(card, dev, "Master", AC97_MASTER_VOL);
688 em28xx_cvol_new(card, dev, "Line", AC97_LINE_LEVEL_VOL);
689 em28xx_cvol_new(card, dev, "Mono", AC97_MASTER_MONO_VOL);
690 em28xx_cvol_new(card, dev, "LFE", AC97_LFE_MASTER_VOL);
691 em28xx_cvol_new(card, dev, "Surround", AC97_SURR_MASTER_VOL);
694 err = snd_card_register(card);
699 adev->sndcard = card;
700 adev->udev = dev->udev;
705 static int em28xx_audio_fini(struct em28xx *dev)
710 if (dev->has_alsa_audio != 1) {
711 /* This device does not support the extension (in this case
712 the device is expecting the snd-usb-audio module or
713 doesn't have analog audio support at all) */
717 if (dev->adev.sndcard) {
718 snd_card_free(dev->adev.sndcard);
719 dev->adev.sndcard = NULL;
725 static struct em28xx_ops audio_ops = {
727 .name = "Em28xx Audio Extension",
728 .init = em28xx_audio_init,
729 .fini = em28xx_audio_fini,
732 static int __init em28xx_alsa_register(void)
734 return em28xx_register_extension(&audio_ops);
737 static void __exit em28xx_alsa_unregister(void)
739 em28xx_unregister_extension(&audio_ops);
742 MODULE_LICENSE("GPL");
743 MODULE_AUTHOR("Markus Rechberger <mrechberger@gmail.com>");
744 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@redhat.com>");
745 MODULE_DESCRIPTION("Em28xx Audio driver");
747 module_init(em28xx_alsa_register);
748 module_exit(em28xx_alsa_unregister);