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 /* These can be replaced after done */
57 #define MIXER_ADDR_LAST MAX_CX88_INPUT
59 struct cx88_audio_dev {
60 struct cx88_core *core;
61 struct cx88_dmaqueue q;
70 struct snd_card *card;
75 unsigned int dma_size;
76 unsigned int period_size;
77 unsigned int num_periods;
79 struct videobuf_dmabuf dma_risc;
81 int mixer_volume[MIXER_ADDR_LAST+1][2];
82 int capture_source[MIXER_ADDR_LAST+1][2];
84 struct cx88_buffer *buf;
86 struct snd_pcm_substream *substream;
88 typedef struct cx88_audio_dev snd_cx88_card_t;
92 /****************************************************************************
93 Module global static vars
94 ****************************************************************************/
96 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
97 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
98 static int enable[SNDRV_CARDS] = {1, [1 ... (SNDRV_CARDS - 1)] = 1};
100 module_param_array(enable, bool, NULL, 0444);
101 MODULE_PARM_DESC(enable, "Enable cx88x soundcard. default enabled.");
103 module_param_array(index, int, NULL, 0444);
104 MODULE_PARM_DESC(index, "Index value for cx88x capture interface(s).");
107 /****************************************************************************
109 ****************************************************************************/
111 MODULE_DESCRIPTION("ALSA driver module for cx2388x based TV cards");
112 MODULE_AUTHOR("Ricardo Cerqueira");
113 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
114 MODULE_LICENSE("GPL");
115 MODULE_SUPPORTED_DEVICE("{{Conexant,23881},"
117 "{{Conexant,23883}");
118 static unsigned int debug;
119 module_param(debug,int,0644);
120 MODULE_PARM_DESC(debug,"enable debug messages");
122 /****************************************************************************
123 Module specific funtions
124 ****************************************************************************/
127 * BOARD Specific: Sets audio DMA
130 static int _cx88_start_audio_dma(snd_cx88_card_t *chip)
132 struct cx88_buffer *buf = chip->buf;
133 struct cx88_core *core=chip->core;
134 struct sram_channel *audio_ch = &cx88_sram_channels[SRAM_CH25];
136 /* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
137 cx_clear(MO_AUD_DMACNTRL, 0x11);
139 /* setup fifo + format - out channel */
140 cx88_sram_channel_setup(chip->core, audio_ch, buf->bpl, buf->risc.dma);
143 cx_write(MO_AUDD_LNGTH, buf->bpl);
146 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
147 atomic_set(&chip->count, 0);
149 dprintk(1, "Start audio DMA, %d B/line, %d lines/FIFO, %d periods, %d "
150 "byte buffer\n", buf->bpl, cx_read(audio_ch->cmds_start + 8)>>1,
151 chip->num_periods, buf->bpl * chip->num_periods);
153 /* Enables corresponding bits at AUD_INT_STAT */
154 cx_write(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
155 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
157 /* Clean any pending interrupt bits already set */
158 cx_write(MO_AUD_INTSTAT, ~0);
160 /* enable audio irqs */
161 cx_set(MO_PCI_INTMSK, chip->core->pci_irqmask | PCI_INT_AUDINT);
164 cx_set(MO_DEV_CNTRL2, (1<<5)); /* Enables Risc Processor */
165 cx_set(MO_AUD_DMACNTRL, 0x11); /* audio downstream FIFO and RISC enable */
168 cx88_sram_channel_dump(chip->core, audio_ch);
174 * BOARD Specific: Resets audio DMA
176 static int _cx88_stop_audio_dma(snd_cx88_card_t *chip)
178 struct cx88_core *core=chip->core;
179 dprintk(1, "Stopping audio DMA\n");
182 cx_clear(MO_AUD_DMACNTRL, 0x11);
185 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
186 cx_clear(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
187 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
190 cx88_sram_channel_dump(chip->core, &cx88_sram_channels[SRAM_CH25]);
195 #define MAX_IRQ_LOOP 50
198 * BOARD Specific: IRQ dma bits
200 static char *cx88_aud_irqs[32] = {
201 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
203 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
205 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
207 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
209 "opc_err", "par_err", "rip_err", /* 16-18 */
210 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
214 * BOARD Specific: Threats IRQ audio specific calls
216 static void cx8801_aud_irq(snd_cx88_card_t *chip)
218 struct cx88_core *core = chip->core;
221 status = cx_read(MO_AUD_INTSTAT);
222 mask = cx_read(MO_AUD_INTMSK);
223 if (0 == (status & mask))
225 cx_write(MO_AUD_INTSTAT, status);
226 if (debug > 1 || (status & mask & ~0xff))
227 cx88_print_irqbits(core->name, "irq aud",
228 cx88_aud_irqs, ARRAY_SIZE(cx88_aud_irqs),
230 /* risc op code error */
231 if (status & AUD_INT_OPC_ERR) {
232 printk(KERN_WARNING "%s/1: Audio risc op code error\n",core->name);
233 cx_clear(MO_AUD_DMACNTRL, 0x11);
234 cx88_sram_channel_dump(core, &cx88_sram_channels[SRAM_CH25]);
236 if (status & AUD_INT_DN_SYNC) {
237 dprintk(1, "Downstream sync error\n");
238 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
241 /* risc1 downstream */
242 if (status & AUD_INT_DN_RISCI1) {
243 atomic_set(&chip->count, cx_read(MO_AUDD_GPCNT));
244 snd_pcm_period_elapsed(chip->substream);
246 /* FIXME: Any other status should deserve a special handling? */
250 * BOARD Specific: Handles IRQ calls
252 static irqreturn_t cx8801_irq(int irq, void *dev_id)
254 snd_cx88_card_t *chip = dev_id;
255 struct cx88_core *core = chip->core;
257 int loop, handled = 0;
259 for (loop = 0; loop < MAX_IRQ_LOOP; loop++) {
260 status = cx_read(MO_PCI_INTSTAT) &
261 (core->pci_irqmask | PCI_INT_AUDINT);
264 dprintk(3, "cx8801_irq loop %d/%d, status %x\n",
265 loop, MAX_IRQ_LOOP, status);
267 cx_write(MO_PCI_INTSTAT, status);
269 if (status & core->pci_irqmask)
270 cx88_core_irq(core, status);
271 if (status & PCI_INT_AUDINT)
272 cx8801_aud_irq(chip);
275 if (MAX_IRQ_LOOP == loop) {
277 "%s/1: IRQ loop detected, disabling interrupts\n",
279 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
283 return IRQ_RETVAL(handled);
287 static int dsp_buffer_free(snd_cx88_card_t *chip)
289 BUG_ON(!chip->dma_size);
291 dprintk(2,"Freeing buffer\n");
292 videobuf_pci_dma_unmap(chip->pci, &chip->dma_risc);
293 videobuf_dma_free(&chip->dma_risc);
294 btcx_riscmem_free(chip->pci,&chip->buf->risc);
302 /****************************************************************************
304 ****************************************************************************/
307 * Digital hardware definition
309 #define DEFAULT_FIFO_SIZE 4096
310 static struct snd_pcm_hardware snd_cx88_digital_hw = {
311 .info = SNDRV_PCM_INFO_MMAP |
312 SNDRV_PCM_INFO_INTERLEAVED |
313 SNDRV_PCM_INFO_BLOCK_TRANSFER |
314 SNDRV_PCM_INFO_MMAP_VALID,
315 .formats = SNDRV_PCM_FMTBIT_S16_LE,
317 .rates = SNDRV_PCM_RATE_48000,
322 /* Analog audio output will be full of clicks and pops if there
323 are not exactly four lines in the SRAM FIFO buffer. */
324 .period_bytes_min = DEFAULT_FIFO_SIZE/4,
325 .period_bytes_max = DEFAULT_FIFO_SIZE/4,
328 .buffer_bytes_max = (1024*1024),
332 * audio pcm capture open callback
334 static int snd_cx88_pcm_open(struct snd_pcm_substream *substream)
336 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
337 struct snd_pcm_runtime *runtime = substream->runtime;
340 err = snd_pcm_hw_constraint_pow2(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS);
344 chip->substream = substream;
346 runtime->hw = snd_cx88_digital_hw;
348 if (cx88_sram_channels[SRAM_CH25].fifo_size != DEFAULT_FIFO_SIZE) {
349 unsigned int bpl = cx88_sram_channels[SRAM_CH25].fifo_size / 4;
350 bpl &= ~7; /* must be multiple of 8 */
351 runtime->hw.period_bytes_min = bpl;
352 runtime->hw.period_bytes_max = bpl;
357 dprintk(1,"Error opening PCM!\n");
362 * audio close callback
364 static int snd_cx88_close(struct snd_pcm_substream *substream)
372 static int snd_cx88_hw_params(struct snd_pcm_substream * substream,
373 struct snd_pcm_hw_params * hw_params)
375 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
376 struct cx88_buffer *buf;
379 if (substream->runtime->dma_area) {
380 dsp_buffer_free(chip);
381 substream->runtime->dma_area = NULL;
384 chip->period_size = params_period_bytes(hw_params);
385 chip->num_periods = params_periods(hw_params);
386 chip->dma_size = chip->period_size * params_periods(hw_params);
388 BUG_ON(!chip->dma_size);
389 BUG_ON(chip->num_periods & (chip->num_periods-1));
391 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
395 buf->vb.memory = V4L2_MEMORY_MMAP;
396 buf->vb.field = V4L2_FIELD_NONE;
397 buf->vb.width = chip->period_size;
398 buf->bpl = chip->period_size;
399 buf->vb.height = chip->num_periods;
400 buf->vb.size = chip->dma_size;
402 videobuf_dma_init(&buf->vb.dma);
403 ret = videobuf_dma_init_kernel(&buf->vb.dma, PCI_DMA_FROMDEVICE,
404 (PAGE_ALIGN(buf->vb.size) >> PAGE_SHIFT));
408 ret = videobuf_pci_dma_map(chip->pci,&buf->vb.dma);
412 ret = cx88_risc_databuffer(chip->pci, &buf->risc, buf->vb.dma.sglist,
413 buf->vb.width, buf->vb.height, 1);
417 /* Loop back to start of program */
418 buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP|RISC_IRQ1|RISC_CNT_INC);
419 buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
421 buf->vb.state = STATE_PREPARED;
424 chip->dma_risc = buf->vb.dma;
426 substream->runtime->dma_area = chip->dma_risc.vmalloc;
427 substream->runtime->dma_bytes = chip->dma_size;
428 substream->runtime->dma_addr = 0;
439 static int snd_cx88_hw_free(struct snd_pcm_substream * substream)
442 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
444 if (substream->runtime->dma_area) {
445 dsp_buffer_free(chip);
446 substream->runtime->dma_area = NULL;
455 static int snd_cx88_prepare(struct snd_pcm_substream *substream)
463 static int snd_cx88_card_trigger(struct snd_pcm_substream *substream, int cmd)
465 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
468 /* Local interrupts are already disabled by ALSA */
469 spin_lock(&chip->reg_lock);
472 case SNDRV_PCM_TRIGGER_START:
473 err=_cx88_start_audio_dma(chip);
475 case SNDRV_PCM_TRIGGER_STOP:
476 err=_cx88_stop_audio_dma(chip);
483 spin_unlock(&chip->reg_lock);
491 static snd_pcm_uframes_t snd_cx88_pointer(struct snd_pcm_substream *substream)
493 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
494 struct snd_pcm_runtime *runtime = substream->runtime;
497 count = atomic_read(&chip->count);
499 // dprintk(2, "%s - count %d (+%u), period %d, frame %lu\n", __FUNCTION__,
500 // count, new, count & (runtime->periods-1),
501 // runtime->period_size * (count & (runtime->periods-1)));
502 return runtime->period_size * (count & (runtime->periods-1));
506 * page callback (needed for mmap)
508 static struct page *snd_cx88_page(struct snd_pcm_substream *substream,
509 unsigned long offset)
511 void *pageptr = substream->runtime->dma_area + offset;
512 return vmalloc_to_page(pageptr);
518 static struct snd_pcm_ops snd_cx88_pcm_ops = {
519 .open = snd_cx88_pcm_open,
520 .close = snd_cx88_close,
521 .ioctl = snd_pcm_lib_ioctl,
522 .hw_params = snd_cx88_hw_params,
523 .hw_free = snd_cx88_hw_free,
524 .prepare = snd_cx88_prepare,
525 .trigger = snd_cx88_card_trigger,
526 .pointer = snd_cx88_pointer,
527 .page = snd_cx88_page,
531 * create a PCM device
533 static int __devinit snd_cx88_pcm(snd_cx88_card_t *chip, int device, char *name)
538 err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
541 pcm->private_data = chip;
542 strcpy(pcm->name, name);
543 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx88_pcm_ops);
548 /****************************************************************************
550 ****************************************************************************/
551 static int snd_cx88_capture_volume_info(struct snd_kcontrol *kcontrol,
552 struct snd_ctl_elem_info *info)
554 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
556 info->value.integer.min = 0;
557 info->value.integer.max = 0x3f;
562 /* OK - TODO: test it */
563 static int snd_cx88_capture_volume_get(struct snd_kcontrol *kcontrol,
564 struct snd_ctl_elem_value *value)
566 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
567 struct cx88_core *core=chip->core;
568 int vol = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f),
569 bal = cx_read(AUD_BAL_CTL);
571 value->value.integer.value[(bal & 0x40) ? 0 : 1] = vol;
573 value->value.integer.value[(bal & 0x40) ? 1 : 0] = vol < 0 ? 0 : vol;
578 /* OK - TODO: test it */
579 static int snd_cx88_capture_volume_put(struct snd_kcontrol *kcontrol,
580 struct snd_ctl_elem_value *value)
582 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
583 struct cx88_core *core=chip->core;
588 b = value->value.integer.value[1] - value->value.integer.value[0];
590 v = 0x3f - value->value.integer.value[0];
593 v = 0x3f - value->value.integer.value[1];
595 /* Do we really know this will always be called with IRQs on? */
596 spin_lock_irq(&chip->reg_lock);
597 old = cx_read(AUD_VOL_CTL);
598 if (v != (old & 0x3f)) {
599 cx_write(AUD_VOL_CTL, (old & ~0x3f) | v);
602 if (cx_read(AUD_BAL_CTL) != b) {
603 cx_write(AUD_BAL_CTL, b);
606 spin_unlock_irq(&chip->reg_lock);
611 static struct snd_kcontrol_new snd_cx88_capture_volume = {
612 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
613 .name = "Capture Volume",
614 .info = snd_cx88_capture_volume_info,
615 .get = snd_cx88_capture_volume_get,
616 .put = snd_cx88_capture_volume_put,
620 /****************************************************************************
621 Basic Flow for Sound Devices
622 ****************************************************************************/
625 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
626 * Only boards with eeprom and byte 1 at eeprom=1 have it
629 static struct pci_device_id cx88_audio_pci_tbl[] __devinitdata = {
630 {0x14f1,0x8801,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
631 {0x14f1,0x8811,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
634 MODULE_DEVICE_TABLE(pci, cx88_audio_pci_tbl);
637 * Chip-specific destructor
640 static int snd_cx88_free(snd_cx88_card_t *chip)
644 synchronize_irq(chip->irq);
645 free_irq(chip->irq, chip);
648 cx88_core_put(chip->core,chip->pci);
650 pci_disable_device(chip->pci);
655 * Component Destructor
657 static void snd_cx88_dev_free(struct snd_card * card)
659 snd_cx88_card_t *chip = card->private_data;
666 * Alsa Constructor - Component probe
670 static int __devinit snd_cx88_create(struct snd_card *card,
672 snd_cx88_card_t **rchip)
674 snd_cx88_card_t *chip;
675 struct cx88_core *core;
677 unsigned char pci_lat;
681 err = pci_enable_device(pci);
687 chip = (snd_cx88_card_t *) card->private_data;
689 core = cx88_core_get(pci);
696 if (!pci_dma_supported(pci,DMA_32BIT_MASK)) {
697 dprintk(0, "%s/1: Oops: no 32bit PCI DMA ???\n",core->name);
699 cx88_core_put(core,pci);
708 spin_lock_init(&chip->reg_lock);
713 err = request_irq(chip->pci->irq, cx8801_irq,
714 IRQF_SHARED | IRQF_DISABLED, chip->core->name, chip);
716 dprintk(0, "%s: can't get IRQ %d\n",
717 chip->core->name, chip->pci->irq);
722 pci_read_config_byte(pci, PCI_LATENCY_TIMER, &pci_lat);
724 dprintk(1,"ALSA %s/%i: found at %s, rev: %d, irq: %d, "
725 "latency: %d, mmio: 0x%llx\n", core->name, devno,
726 pci_name(pci), pci->revision, pci->irq,
727 pci_lat, (unsigned long long)pci_resource_start(pci,0));
729 chip->irq = pci->irq;
730 synchronize_irq(chip->irq);
732 snd_card_set_dev(card, &pci->dev);
739 static int __devinit cx88_audio_initdev(struct pci_dev *pci,
740 const struct pci_device_id *pci_id)
742 struct snd_card *card;
743 snd_cx88_card_t *chip;
746 if (devno >= SNDRV_CARDS)
749 if (!enable[devno]) {
754 card = snd_card_new(index[devno], id[devno], THIS_MODULE, sizeof(snd_cx88_card_t));
758 card->private_free = snd_cx88_dev_free;
760 err = snd_cx88_create(card, pci, &chip);
764 err = snd_cx88_pcm(chip, 0, "CX88 Digital");
768 err = snd_ctl_add(card, snd_ctl_new1(&snd_cx88_capture_volume, chip));
772 strcpy (card->driver, "CX88x");
773 sprintf(card->shortname, "Conexant CX%x", pci->device);
774 sprintf(card->longname, "%s at %#llx",
775 card->shortname,(unsigned long long)pci_resource_start(pci, 0));
776 strcpy (card->mixername, "CX88");
778 dprintk (0, "%s/%i: ALSA support for cx2388x boards\n",
781 err = snd_card_register(card);
784 pci_set_drvdata(pci,card);
796 static void __devexit cx88_audio_finidev(struct pci_dev *pci)
798 struct cx88_audio_dev *card = pci_get_drvdata(pci);
800 snd_card_free((void *)card);
802 pci_set_drvdata(pci, NULL);
808 * PCI driver definition
811 static struct pci_driver cx88_audio_pci_driver = {
812 .name = "cx88_audio",
813 .id_table = cx88_audio_pci_tbl,
814 .probe = cx88_audio_initdev,
815 .remove = cx88_audio_finidev,
818 /****************************************************************************
820 ****************************************************************************/
825 static int cx88_audio_init(void)
827 printk(KERN_INFO "cx2388x alsa driver version %d.%d.%d loaded\n",
828 (CX88_VERSION_CODE >> 16) & 0xff,
829 (CX88_VERSION_CODE >> 8) & 0xff,
830 CX88_VERSION_CODE & 0xff);
832 printk(KERN_INFO "cx2388x: snapshot date %04d-%02d-%02d\n",
833 SNAPSHOT/10000, (SNAPSHOT/100)%100, SNAPSHOT%100);
835 return pci_register_driver(&cx88_audio_pci_driver);
841 static void cx88_audio_fini(void)
844 pci_unregister_driver(&cx88_audio_pci_driver);
847 module_init(cx88_audio_init);
848 module_exit(cx88_audio_fini);
850 /* ----------------------------------------------------------- */