3 * Support for audio capture
4 * PCI function #1 of the cx2388x.
6 * (c) 2007 Trent Piepho <xyzzy@speakeasy.org>
7 * (c) 2005,2006 Ricardo Cerqueira <v4l@cerqueira.org>
8 * (c) 2005 Mauro Carvalho Chehab <mchehab@infradead.org>
9 * Based on a dummy cx88 module by Gerd Knorr <kraxel@bytesex.org>
10 * Based on dummy.c by Jaroslav Kysela <perex@suse.cz>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/device.h>
30 #include <linux/interrupt.h>
31 #include <linux/vmalloc.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/pci.h>
35 #include <asm/delay.h>
36 #include <sound/driver.h>
37 #include <sound/core.h>
38 #include <sound/pcm.h>
39 #include <sound/pcm_params.h>
40 #include <sound/control.h>
41 #include <sound/initval.h>
46 #define dprintk(level,fmt, arg...) if (debug >= level) \
47 printk(KERN_INFO "%s/1: " fmt, chip->core->name , ## arg)
49 #define dprintk_core(level,fmt, arg...) if (debug >= level) \
50 printk(KERN_DEBUG "%s/1: " fmt, chip->core->name , ## arg)
52 /****************************************************************************
53 Data type declarations - Can be moded to a header file later
54 ****************************************************************************/
56 struct cx88_audio_dev {
57 struct cx88_core *core;
58 struct cx88_dmaqueue q;
66 struct snd_card *card;
71 unsigned int dma_size;
72 unsigned int period_size;
73 unsigned int num_periods;
75 struct videobuf_dmabuf dma_risc;
77 struct cx88_buffer *buf;
79 struct snd_pcm_substream *substream;
81 typedef struct cx88_audio_dev snd_cx88_card_t;
85 /****************************************************************************
86 Module global static vars
87 ****************************************************************************/
89 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
90 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
91 static int enable[SNDRV_CARDS] = {1, [1 ... (SNDRV_CARDS - 1)] = 1};
93 module_param_array(enable, bool, NULL, 0444);
94 MODULE_PARM_DESC(enable, "Enable cx88x soundcard. default enabled.");
96 module_param_array(index, int, NULL, 0444);
97 MODULE_PARM_DESC(index, "Index value for cx88x capture interface(s).");
100 /****************************************************************************
102 ****************************************************************************/
104 MODULE_DESCRIPTION("ALSA driver module for cx2388x based TV cards");
105 MODULE_AUTHOR("Ricardo Cerqueira");
106 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
107 MODULE_LICENSE("GPL");
108 MODULE_SUPPORTED_DEVICE("{{Conexant,23881},"
110 "{{Conexant,23883}");
111 static unsigned int debug;
112 module_param(debug,int,0644);
113 MODULE_PARM_DESC(debug,"enable debug messages");
115 /****************************************************************************
116 Module specific funtions
117 ****************************************************************************/
120 * BOARD Specific: Sets audio DMA
123 static int _cx88_start_audio_dma(snd_cx88_card_t *chip)
125 struct cx88_buffer *buf = chip->buf;
126 struct cx88_core *core=chip->core;
127 struct sram_channel *audio_ch = &cx88_sram_channels[SRAM_CH25];
129 /* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
130 cx_clear(MO_AUD_DMACNTRL, 0x11);
132 /* setup fifo + format - out channel */
133 cx88_sram_channel_setup(chip->core, audio_ch, buf->bpl, buf->risc.dma);
136 cx_write(MO_AUDD_LNGTH, buf->bpl);
139 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
140 atomic_set(&chip->count, 0);
142 dprintk(1, "Start audio DMA, %d B/line, %d lines/FIFO, %d periods, %d "
143 "byte buffer\n", buf->bpl, cx_read(audio_ch->cmds_start + 8)>>1,
144 chip->num_periods, buf->bpl * chip->num_periods);
146 /* Enables corresponding bits at AUD_INT_STAT */
147 cx_write(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
148 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
150 /* Clean any pending interrupt bits already set */
151 cx_write(MO_AUD_INTSTAT, ~0);
153 /* enable audio irqs */
154 cx_set(MO_PCI_INTMSK, chip->core->pci_irqmask | PCI_INT_AUDINT);
157 cx_set(MO_DEV_CNTRL2, (1<<5)); /* Enables Risc Processor */
158 cx_set(MO_AUD_DMACNTRL, 0x11); /* audio downstream FIFO and RISC enable */
161 cx88_sram_channel_dump(chip->core, audio_ch);
167 * BOARD Specific: Resets audio DMA
169 static int _cx88_stop_audio_dma(snd_cx88_card_t *chip)
171 struct cx88_core *core=chip->core;
172 dprintk(1, "Stopping audio DMA\n");
175 cx_clear(MO_AUD_DMACNTRL, 0x11);
178 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
179 cx_clear(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
180 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
183 cx88_sram_channel_dump(chip->core, &cx88_sram_channels[SRAM_CH25]);
188 #define MAX_IRQ_LOOP 50
191 * BOARD Specific: IRQ dma bits
193 static char *cx88_aud_irqs[32] = {
194 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
196 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
198 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
200 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
202 "opc_err", "par_err", "rip_err", /* 16-18 */
203 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
207 * BOARD Specific: Threats IRQ audio specific calls
209 static void cx8801_aud_irq(snd_cx88_card_t *chip)
211 struct cx88_core *core = chip->core;
214 status = cx_read(MO_AUD_INTSTAT);
215 mask = cx_read(MO_AUD_INTMSK);
216 if (0 == (status & mask))
218 cx_write(MO_AUD_INTSTAT, status);
219 if (debug > 1 || (status & mask & ~0xff))
220 cx88_print_irqbits(core->name, "irq aud",
221 cx88_aud_irqs, ARRAY_SIZE(cx88_aud_irqs),
223 /* risc op code error */
224 if (status & AUD_INT_OPC_ERR) {
225 printk(KERN_WARNING "%s/1: Audio risc op code error\n",core->name);
226 cx_clear(MO_AUD_DMACNTRL, 0x11);
227 cx88_sram_channel_dump(core, &cx88_sram_channels[SRAM_CH25]);
229 if (status & AUD_INT_DN_SYNC) {
230 dprintk(1, "Downstream sync error\n");
231 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
234 /* risc1 downstream */
235 if (status & AUD_INT_DN_RISCI1) {
236 atomic_set(&chip->count, cx_read(MO_AUDD_GPCNT));
237 snd_pcm_period_elapsed(chip->substream);
239 /* FIXME: Any other status should deserve a special handling? */
243 * BOARD Specific: Handles IRQ calls
245 static irqreturn_t cx8801_irq(int irq, void *dev_id)
247 snd_cx88_card_t *chip = dev_id;
248 struct cx88_core *core = chip->core;
250 int loop, handled = 0;
252 for (loop = 0; loop < MAX_IRQ_LOOP; loop++) {
253 status = cx_read(MO_PCI_INTSTAT) &
254 (core->pci_irqmask | PCI_INT_AUDINT);
257 dprintk(3, "cx8801_irq loop %d/%d, status %x\n",
258 loop, MAX_IRQ_LOOP, status);
260 cx_write(MO_PCI_INTSTAT, status);
262 if (status & core->pci_irqmask)
263 cx88_core_irq(core, status);
264 if (status & PCI_INT_AUDINT)
265 cx8801_aud_irq(chip);
268 if (MAX_IRQ_LOOP == loop) {
270 "%s/1: IRQ loop detected, disabling interrupts\n",
272 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
276 return IRQ_RETVAL(handled);
280 static int dsp_buffer_free(snd_cx88_card_t *chip)
282 BUG_ON(!chip->dma_size);
284 dprintk(2,"Freeing buffer\n");
285 videobuf_pci_dma_unmap(chip->pci, &chip->dma_risc);
286 videobuf_dma_free(&chip->dma_risc);
287 btcx_riscmem_free(chip->pci,&chip->buf->risc);
295 /****************************************************************************
297 ****************************************************************************/
300 * Digital hardware definition
302 #define DEFAULT_FIFO_SIZE 4096
303 static struct snd_pcm_hardware snd_cx88_digital_hw = {
304 .info = SNDRV_PCM_INFO_MMAP |
305 SNDRV_PCM_INFO_INTERLEAVED |
306 SNDRV_PCM_INFO_BLOCK_TRANSFER |
307 SNDRV_PCM_INFO_MMAP_VALID,
308 .formats = SNDRV_PCM_FMTBIT_S16_LE,
310 .rates = SNDRV_PCM_RATE_48000,
315 /* Analog audio output will be full of clicks and pops if there
316 are not exactly four lines in the SRAM FIFO buffer. */
317 .period_bytes_min = DEFAULT_FIFO_SIZE/4,
318 .period_bytes_max = DEFAULT_FIFO_SIZE/4,
321 .buffer_bytes_max = (1024*1024),
325 * audio pcm capture open callback
327 static int snd_cx88_pcm_open(struct snd_pcm_substream *substream)
329 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
330 struct snd_pcm_runtime *runtime = substream->runtime;
333 err = snd_pcm_hw_constraint_pow2(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS);
337 chip->substream = substream;
339 runtime->hw = snd_cx88_digital_hw;
341 if (cx88_sram_channels[SRAM_CH25].fifo_size != DEFAULT_FIFO_SIZE) {
342 unsigned int bpl = cx88_sram_channels[SRAM_CH25].fifo_size / 4;
343 bpl &= ~7; /* must be multiple of 8 */
344 runtime->hw.period_bytes_min = bpl;
345 runtime->hw.period_bytes_max = bpl;
350 dprintk(1,"Error opening PCM!\n");
355 * audio close callback
357 static int snd_cx88_close(struct snd_pcm_substream *substream)
365 static int snd_cx88_hw_params(struct snd_pcm_substream * substream,
366 struct snd_pcm_hw_params * hw_params)
368 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
369 struct cx88_buffer *buf;
372 if (substream->runtime->dma_area) {
373 dsp_buffer_free(chip);
374 substream->runtime->dma_area = NULL;
377 chip->period_size = params_period_bytes(hw_params);
378 chip->num_periods = params_periods(hw_params);
379 chip->dma_size = chip->period_size * params_periods(hw_params);
381 BUG_ON(!chip->dma_size);
382 BUG_ON(chip->num_periods & (chip->num_periods-1));
384 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
388 buf->vb.memory = V4L2_MEMORY_MMAP;
389 buf->vb.field = V4L2_FIELD_NONE;
390 buf->vb.width = chip->period_size;
391 buf->bpl = chip->period_size;
392 buf->vb.height = chip->num_periods;
393 buf->vb.size = chip->dma_size;
395 videobuf_dma_init(&buf->vb.dma);
396 ret = videobuf_dma_init_kernel(&buf->vb.dma, PCI_DMA_FROMDEVICE,
397 (PAGE_ALIGN(buf->vb.size) >> PAGE_SHIFT));
401 ret = videobuf_pci_dma_map(chip->pci,&buf->vb.dma);
405 ret = cx88_risc_databuffer(chip->pci, &buf->risc, buf->vb.dma.sglist,
406 buf->vb.width, buf->vb.height, 1);
410 /* Loop back to start of program */
411 buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP|RISC_IRQ1|RISC_CNT_INC);
412 buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
414 buf->vb.state = STATE_PREPARED;
417 chip->dma_risc = buf->vb.dma;
419 substream->runtime->dma_area = chip->dma_risc.vmalloc;
420 substream->runtime->dma_bytes = chip->dma_size;
421 substream->runtime->dma_addr = 0;
432 static int snd_cx88_hw_free(struct snd_pcm_substream * substream)
435 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
437 if (substream->runtime->dma_area) {
438 dsp_buffer_free(chip);
439 substream->runtime->dma_area = NULL;
448 static int snd_cx88_prepare(struct snd_pcm_substream *substream)
456 static int snd_cx88_card_trigger(struct snd_pcm_substream *substream, int cmd)
458 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
461 /* Local interrupts are already disabled by ALSA */
462 spin_lock(&chip->reg_lock);
465 case SNDRV_PCM_TRIGGER_START:
466 err=_cx88_start_audio_dma(chip);
468 case SNDRV_PCM_TRIGGER_STOP:
469 err=_cx88_stop_audio_dma(chip);
476 spin_unlock(&chip->reg_lock);
484 static snd_pcm_uframes_t snd_cx88_pointer(struct snd_pcm_substream *substream)
486 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
487 struct snd_pcm_runtime *runtime = substream->runtime;
490 count = atomic_read(&chip->count);
492 // dprintk(2, "%s - count %d (+%u), period %d, frame %lu\n", __FUNCTION__,
493 // count, new, count & (runtime->periods-1),
494 // runtime->period_size * (count & (runtime->periods-1)));
495 return runtime->period_size * (count & (runtime->periods-1));
499 * page callback (needed for mmap)
501 static struct page *snd_cx88_page(struct snd_pcm_substream *substream,
502 unsigned long offset)
504 void *pageptr = substream->runtime->dma_area + offset;
505 return vmalloc_to_page(pageptr);
511 static struct snd_pcm_ops snd_cx88_pcm_ops = {
512 .open = snd_cx88_pcm_open,
513 .close = snd_cx88_close,
514 .ioctl = snd_pcm_lib_ioctl,
515 .hw_params = snd_cx88_hw_params,
516 .hw_free = snd_cx88_hw_free,
517 .prepare = snd_cx88_prepare,
518 .trigger = snd_cx88_card_trigger,
519 .pointer = snd_cx88_pointer,
520 .page = snd_cx88_page,
524 * create a PCM device
526 static int __devinit snd_cx88_pcm(snd_cx88_card_t *chip, int device, char *name)
531 err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
534 pcm->private_data = chip;
535 strcpy(pcm->name, name);
536 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx88_pcm_ops);
541 /****************************************************************************
543 ****************************************************************************/
544 static int snd_cx88_capture_volume_info(struct snd_kcontrol *kcontrol,
545 struct snd_ctl_elem_info *info)
547 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
549 info->value.integer.min = 0;
550 info->value.integer.max = 0x3f;
555 /* OK - TODO: test it */
556 static int snd_cx88_capture_volume_get(struct snd_kcontrol *kcontrol,
557 struct snd_ctl_elem_value *value)
559 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
560 struct cx88_core *core=chip->core;
561 int vol = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f),
562 bal = cx_read(AUD_BAL_CTL);
564 value->value.integer.value[(bal & 0x40) ? 0 : 1] = vol;
566 value->value.integer.value[(bal & 0x40) ? 1 : 0] = vol < 0 ? 0 : vol;
571 /* OK - TODO: test it */
572 static int snd_cx88_capture_volume_put(struct snd_kcontrol *kcontrol,
573 struct snd_ctl_elem_value *value)
575 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
576 struct cx88_core *core=chip->core;
581 b = value->value.integer.value[1] - value->value.integer.value[0];
583 v = 0x3f - value->value.integer.value[0];
586 v = 0x3f - value->value.integer.value[1];
588 /* Do we really know this will always be called with IRQs on? */
589 spin_lock_irq(&chip->reg_lock);
590 old = cx_read(AUD_VOL_CTL);
591 if (v != (old & 0x3f)) {
592 cx_write(AUD_VOL_CTL, (old & ~0x3f) | v);
595 if (cx_read(AUD_BAL_CTL) != b) {
596 cx_write(AUD_BAL_CTL, b);
599 spin_unlock_irq(&chip->reg_lock);
604 static struct snd_kcontrol_new snd_cx88_capture_volume = {
605 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
606 .name = "Capture Volume",
607 .info = snd_cx88_capture_volume_info,
608 .get = snd_cx88_capture_volume_get,
609 .put = snd_cx88_capture_volume_put,
613 /****************************************************************************
614 Basic Flow for Sound Devices
615 ****************************************************************************/
618 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
619 * Only boards with eeprom and byte 1 at eeprom=1 have it
622 static struct pci_device_id cx88_audio_pci_tbl[] __devinitdata = {
623 {0x14f1,0x8801,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
624 {0x14f1,0x8811,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
627 MODULE_DEVICE_TABLE(pci, cx88_audio_pci_tbl);
630 * Chip-specific destructor
633 static int snd_cx88_free(snd_cx88_card_t *chip)
637 synchronize_irq(chip->irq);
638 free_irq(chip->irq, chip);
641 cx88_core_put(chip->core,chip->pci);
643 pci_disable_device(chip->pci);
648 * Component Destructor
650 static void snd_cx88_dev_free(struct snd_card * card)
652 snd_cx88_card_t *chip = card->private_data;
659 * Alsa Constructor - Component probe
663 static int __devinit snd_cx88_create(struct snd_card *card,
665 snd_cx88_card_t **rchip)
667 snd_cx88_card_t *chip;
668 struct cx88_core *core;
670 unsigned char pci_lat;
674 err = pci_enable_device(pci);
680 chip = (snd_cx88_card_t *) card->private_data;
682 core = cx88_core_get(pci);
689 if (!pci_dma_supported(pci,DMA_32BIT_MASK)) {
690 dprintk(0, "%s/1: Oops: no 32bit PCI DMA ???\n",core->name);
692 cx88_core_put(core,pci);
701 spin_lock_init(&chip->reg_lock);
706 err = request_irq(chip->pci->irq, cx8801_irq,
707 IRQF_SHARED | IRQF_DISABLED, chip->core->name, chip);
709 dprintk(0, "%s: can't get IRQ %d\n",
710 chip->core->name, chip->pci->irq);
715 pci_read_config_byte(pci, PCI_LATENCY_TIMER, &pci_lat);
717 dprintk(1,"ALSA %s/%i: found at %s, rev: %d, irq: %d, "
718 "latency: %d, mmio: 0x%llx\n", core->name, devno,
719 pci_name(pci), pci->revision, pci->irq,
720 pci_lat, (unsigned long long)pci_resource_start(pci,0));
722 chip->irq = pci->irq;
723 synchronize_irq(chip->irq);
725 snd_card_set_dev(card, &pci->dev);
732 static int __devinit cx88_audio_initdev(struct pci_dev *pci,
733 const struct pci_device_id *pci_id)
735 struct snd_card *card;
736 snd_cx88_card_t *chip;
739 if (devno >= SNDRV_CARDS)
742 if (!enable[devno]) {
747 card = snd_card_new(index[devno], id[devno], THIS_MODULE, sizeof(snd_cx88_card_t));
751 card->private_free = snd_cx88_dev_free;
753 err = snd_cx88_create(card, pci, &chip);
757 err = snd_cx88_pcm(chip, 0, "CX88 Digital");
761 err = snd_ctl_add(card, snd_ctl_new1(&snd_cx88_capture_volume, chip));
765 strcpy (card->driver, "CX88x");
766 sprintf(card->shortname, "Conexant CX%x", pci->device);
767 sprintf(card->longname, "%s at %#llx",
768 card->shortname,(unsigned long long)pci_resource_start(pci, 0));
769 strcpy (card->mixername, "CX88");
771 dprintk (0, "%s/%i: ALSA support for cx2388x boards\n",
774 err = snd_card_register(card);
777 pci_set_drvdata(pci,card);
789 static void __devexit cx88_audio_finidev(struct pci_dev *pci)
791 struct cx88_audio_dev *card = pci_get_drvdata(pci);
793 snd_card_free((void *)card);
795 pci_set_drvdata(pci, NULL);
801 * PCI driver definition
804 static struct pci_driver cx88_audio_pci_driver = {
805 .name = "cx88_audio",
806 .id_table = cx88_audio_pci_tbl,
807 .probe = cx88_audio_initdev,
808 .remove = cx88_audio_finidev,
811 /****************************************************************************
813 ****************************************************************************/
818 static int cx88_audio_init(void)
820 printk(KERN_INFO "cx2388x alsa driver version %d.%d.%d loaded\n",
821 (CX88_VERSION_CODE >> 16) & 0xff,
822 (CX88_VERSION_CODE >> 8) & 0xff,
823 CX88_VERSION_CODE & 0xff);
825 printk(KERN_INFO "cx2388x: snapshot date %04d-%02d-%02d\n",
826 SNAPSHOT/10000, (SNAPSHOT/100)%100, SNAPSHOT%100);
828 return pci_register_driver(&cx88_audio_pci_driver);
834 static void cx88_audio_fini(void)
837 pci_unregister_driver(&cx88_audio_pci_driver);
840 module_init(cx88_audio_init);
841 module_exit(cx88_audio_fini);
843 /* ----------------------------------------------------------- */