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/dma-mapping.h>
32 #include <linux/pci.h>
34 #include <asm/delay.h>
35 #include <sound/driver.h>
36 #include <sound/core.h>
37 #include <sound/pcm.h>
38 #include <sound/pcm_params.h>
39 #include <sound/control.h>
40 #include <sound/initval.h>
45 #define dprintk(level,fmt, arg...) if (debug >= level) \
46 printk(KERN_INFO "%s/1: " fmt, chip->core->name , ## arg)
48 #define dprintk_core(level,fmt, arg...) if (debug >= level) \
49 printk(KERN_DEBUG "%s/1: " fmt, chip->core->name , ## arg)
51 /****************************************************************************
52 Data type declarations - Can be moded to a header file later
53 ****************************************************************************/
55 /* These can be replaced after done */
56 #define MIXER_ADDR_LAST MAX_CX88_INPUT
58 struct cx88_audio_dev {
59 struct cx88_core *core;
60 struct cx88_dmaqueue q;
69 struct snd_card *card;
74 unsigned int dma_size;
75 unsigned int period_size;
76 unsigned int num_periods;
78 struct videobuf_dmabuf dma_risc;
80 int mixer_volume[MIXER_ADDR_LAST+1][2];
81 int capture_source[MIXER_ADDR_LAST+1][2];
83 struct cx88_buffer *buf;
85 struct snd_pcm_substream *substream;
87 typedef struct cx88_audio_dev snd_cx88_card_t;
91 /****************************************************************************
92 Module global static vars
93 ****************************************************************************/
95 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
96 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
97 static int enable[SNDRV_CARDS] = {1, [1 ... (SNDRV_CARDS - 1)] = 1};
99 module_param_array(enable, bool, NULL, 0444);
100 MODULE_PARM_DESC(enable, "Enable cx88x soundcard. default enabled.");
102 module_param_array(index, int, NULL, 0444);
103 MODULE_PARM_DESC(index, "Index value for cx88x capture interface(s).");
106 /****************************************************************************
108 ****************************************************************************/
110 MODULE_DESCRIPTION("ALSA driver module for cx2388x based TV cards");
111 MODULE_AUTHOR("Ricardo Cerqueira");
112 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
113 MODULE_LICENSE("GPL");
114 MODULE_SUPPORTED_DEVICE("{{Conexant,23881},"
116 "{{Conexant,23883}");
117 static unsigned int debug;
118 module_param(debug,int,0644);
119 MODULE_PARM_DESC(debug,"enable debug messages");
121 /****************************************************************************
122 Module specific funtions
123 ****************************************************************************/
126 * BOARD Specific: Sets audio DMA
129 static int _cx88_start_audio_dma(snd_cx88_card_t *chip)
131 struct cx88_buffer *buf = chip->buf;
132 struct cx88_core *core=chip->core;
133 struct sram_channel *audio_ch = &cx88_sram_channels[SRAM_CH25];
135 /* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
136 cx_clear(MO_AUD_DMACNTRL, 0x11);
138 /* setup fifo + format - out channel */
139 cx88_sram_channel_setup(chip->core, audio_ch, buf->bpl, buf->risc.dma);
142 cx_write(MO_AUDD_LNGTH, buf->bpl);
145 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
146 atomic_set(&chip->count, 0);
148 dprintk(1, "Start audio DMA, %d B/line, %d lines/FIFO, %d periods, %d "
149 "byte buffer\n", buf->bpl, cx_read(audio_ch->cmds_start + 8)>>1,
150 chip->num_periods, buf->bpl * chip->num_periods);
152 /* Enables corresponding bits at AUD_INT_STAT */
153 cx_write(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
154 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
156 /* Clean any pending interrupt bits already set */
157 cx_write(MO_AUD_INTSTAT, ~0);
159 /* enable audio irqs */
160 cx_set(MO_PCI_INTMSK, chip->core->pci_irqmask | PCI_INT_AUDINT);
163 cx_set(MO_DEV_CNTRL2, (1<<5)); /* Enables Risc Processor */
164 cx_set(MO_AUD_DMACNTRL, 0x11); /* audio downstream FIFO and RISC enable */
167 cx88_sram_channel_dump(chip->core, audio_ch);
173 * BOARD Specific: Resets audio DMA
175 static int _cx88_stop_audio_dma(snd_cx88_card_t *chip)
177 struct cx88_core *core=chip->core;
178 dprintk(1, "Stopping audio DMA\n");
181 cx_clear(MO_AUD_DMACNTRL, 0x11);
184 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
185 cx_clear(MO_AUD_INTMSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
186 AUD_INT_DN_RISCI2 | AUD_INT_DN_RISCI1);
189 cx88_sram_channel_dump(chip->core, &cx88_sram_channels[SRAM_CH25]);
194 #define MAX_IRQ_LOOP 50
197 * BOARD Specific: IRQ dma bits
199 static char *cx88_aud_irqs[32] = {
200 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
202 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
204 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
206 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
208 "opc_err", "par_err", "rip_err", /* 16-18 */
209 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
213 * BOARD Specific: Threats IRQ audio specific calls
215 static void cx8801_aud_irq(snd_cx88_card_t *chip)
217 struct cx88_core *core = chip->core;
220 status = cx_read(MO_AUD_INTSTAT);
221 mask = cx_read(MO_AUD_INTMSK);
222 if (0 == (status & mask))
224 cx_write(MO_AUD_INTSTAT, status);
225 if (debug > 1 || (status & mask & ~0xff))
226 cx88_print_irqbits(core->name, "irq aud",
227 cx88_aud_irqs, ARRAY_SIZE(cx88_aud_irqs),
229 /* risc op code error */
230 if (status & AUD_INT_OPC_ERR) {
231 printk(KERN_WARNING "%s/1: Audio risc op code error\n",core->name);
232 cx_clear(MO_AUD_DMACNTRL, 0x11);
233 cx88_sram_channel_dump(core, &cx88_sram_channels[SRAM_CH25]);
235 if (status & AUD_INT_DN_SYNC) {
236 dprintk(1, "Downstream sync error\n");
237 cx_write(MO_AUDD_GPCNTRL, GP_COUNT_CONTROL_RESET);
240 /* risc1 downstream */
241 if (status & AUD_INT_DN_RISCI1) {
242 atomic_set(&chip->count, cx_read(MO_AUDD_GPCNT));
243 snd_pcm_period_elapsed(chip->substream);
245 /* FIXME: Any other status should deserve a special handling? */
249 * BOARD Specific: Handles IRQ calls
251 static irqreturn_t cx8801_irq(int irq, void *dev_id)
253 snd_cx88_card_t *chip = dev_id;
254 struct cx88_core *core = chip->core;
256 int loop, handled = 0;
258 for (loop = 0; loop < MAX_IRQ_LOOP; loop++) {
259 status = cx_read(MO_PCI_INTSTAT) &
260 (core->pci_irqmask | PCI_INT_AUDINT);
263 dprintk(3, "cx8801_irq loop %d/%d, status %x\n",
264 loop, MAX_IRQ_LOOP, status);
266 cx_write(MO_PCI_INTSTAT, status);
268 if (status & core->pci_irqmask)
269 cx88_core_irq(core, status);
270 if (status & PCI_INT_AUDINT)
271 cx8801_aud_irq(chip);
274 if (MAX_IRQ_LOOP == loop) {
276 "%s/1: IRQ loop detected, disabling interrupts\n",
278 cx_clear(MO_PCI_INTMSK, PCI_INT_AUDINT);
282 return IRQ_RETVAL(handled);
286 static int dsp_buffer_free(snd_cx88_card_t *chip)
288 BUG_ON(!chip->dma_size);
290 dprintk(2,"Freeing buffer\n");
291 videobuf_pci_dma_unmap(chip->pci, &chip->dma_risc);
292 videobuf_dma_free(&chip->dma_risc);
293 btcx_riscmem_free(chip->pci,&chip->buf->risc);
301 /****************************************************************************
303 ****************************************************************************/
306 * Digital hardware definition
308 #define DEFAULT_FIFO_SIZE 4096
309 static struct snd_pcm_hardware snd_cx88_digital_hw = {
310 .info = SNDRV_PCM_INFO_MMAP |
311 SNDRV_PCM_INFO_INTERLEAVED |
312 SNDRV_PCM_INFO_BLOCK_TRANSFER |
313 SNDRV_PCM_INFO_MMAP_VALID,
314 .formats = SNDRV_PCM_FMTBIT_S16_LE,
316 .rates = SNDRV_PCM_RATE_48000,
321 /* Analog audio output will be full of clicks and pops if there
322 are not exactly four lines in the SRAM FIFO buffer. */
323 .period_bytes_min = DEFAULT_FIFO_SIZE/4,
324 .period_bytes_max = DEFAULT_FIFO_SIZE/4,
327 .buffer_bytes_max = (1024*1024),
331 * audio pcm capture open callback
333 static int snd_cx88_pcm_open(struct snd_pcm_substream *substream)
335 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
336 struct snd_pcm_runtime *runtime = substream->runtime;
339 err = snd_pcm_hw_constraint_pow2(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS);
343 chip->substream = substream;
345 runtime->hw = snd_cx88_digital_hw;
347 if (cx88_sram_channels[SRAM_CH25].fifo_size != DEFAULT_FIFO_SIZE) {
348 unsigned int bpl = cx88_sram_channels[SRAM_CH25].fifo_size / 4;
349 bpl &= ~7; /* must be multiple of 8 */
350 runtime->hw.period_bytes_min = bpl;
351 runtime->hw.period_bytes_max = bpl;
356 dprintk(1,"Error opening PCM!\n");
361 * audio close callback
363 static int snd_cx88_close(struct snd_pcm_substream *substream)
371 static int snd_cx88_hw_params(struct snd_pcm_substream * substream,
372 struct snd_pcm_hw_params * hw_params)
374 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
375 struct cx88_buffer *buf;
378 if (substream->runtime->dma_area) {
379 dsp_buffer_free(chip);
380 substream->runtime->dma_area = NULL;
383 chip->period_size = params_period_bytes(hw_params);
384 chip->num_periods = params_periods(hw_params);
385 chip->dma_size = chip->period_size * params_periods(hw_params);
387 BUG_ON(!chip->dma_size);
388 BUG_ON(chip->num_periods & (chip->num_periods-1));
390 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
394 buf->vb.memory = V4L2_MEMORY_MMAP;
395 buf->vb.field = V4L2_FIELD_NONE;
396 buf->vb.width = chip->period_size;
397 buf->bpl = chip->period_size;
398 buf->vb.height = chip->num_periods;
399 buf->vb.size = chip->dma_size;
401 videobuf_dma_init(&buf->vb.dma);
402 ret = videobuf_dma_init_kernel(&buf->vb.dma, PCI_DMA_FROMDEVICE,
403 (PAGE_ALIGN(buf->vb.size) >> PAGE_SHIFT));
407 ret = videobuf_pci_dma_map(chip->pci,&buf->vb.dma);
411 ret = cx88_risc_databuffer(chip->pci, &buf->risc, buf->vb.dma.sglist,
412 buf->vb.width, buf->vb.height, 1);
416 /* Loop back to start of program */
417 buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP|RISC_IRQ1|RISC_CNT_INC);
418 buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
420 buf->vb.state = STATE_PREPARED;
423 chip->dma_risc = buf->vb.dma;
425 substream->runtime->dma_area = chip->dma_risc.vmalloc;
436 static int snd_cx88_hw_free(struct snd_pcm_substream * substream)
439 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
441 if (substream->runtime->dma_area) {
442 dsp_buffer_free(chip);
443 substream->runtime->dma_area = NULL;
452 static int snd_cx88_prepare(struct snd_pcm_substream *substream)
460 static int snd_cx88_card_trigger(struct snd_pcm_substream *substream, int cmd)
462 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
465 /* Local interrupts are already disabled by ALSA */
466 spin_lock(&chip->reg_lock);
469 case SNDRV_PCM_TRIGGER_START:
470 err=_cx88_start_audio_dma(chip);
472 case SNDRV_PCM_TRIGGER_STOP:
473 err=_cx88_stop_audio_dma(chip);
480 spin_unlock(&chip->reg_lock);
488 static snd_pcm_uframes_t snd_cx88_pointer(struct snd_pcm_substream *substream)
490 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
491 struct snd_pcm_runtime *runtime = substream->runtime;
494 count = atomic_read(&chip->count);
496 // dprintk(2, "%s - count %d (+%u), period %d, frame %lu\n", __FUNCTION__,
497 // count, new, count & (runtime->periods-1),
498 // runtime->period_size * (count & (runtime->periods-1)));
499 return runtime->period_size * (count & (runtime->periods-1));
505 static struct snd_pcm_ops snd_cx88_pcm_ops = {
506 .open = snd_cx88_pcm_open,
507 .close = snd_cx88_close,
508 .ioctl = snd_pcm_lib_ioctl,
509 .hw_params = snd_cx88_hw_params,
510 .hw_free = snd_cx88_hw_free,
511 .prepare = snd_cx88_prepare,
512 .trigger = snd_cx88_card_trigger,
513 .pointer = snd_cx88_pointer,
517 * create a PCM device
519 static int __devinit snd_cx88_pcm(snd_cx88_card_t *chip, int device, char *name)
524 err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
527 pcm->private_data = chip;
528 strcpy(pcm->name, name);
529 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx88_pcm_ops);
534 /****************************************************************************
536 ****************************************************************************/
537 static int snd_cx88_capture_volume_info(struct snd_kcontrol *kcontrol,
538 struct snd_ctl_elem_info *info)
540 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
542 info->value.integer.min = 0;
543 info->value.integer.max = 0x3f;
548 /* OK - TODO: test it */
549 static int snd_cx88_capture_volume_get(struct snd_kcontrol *kcontrol,
550 struct snd_ctl_elem_value *value)
552 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
553 struct cx88_core *core=chip->core;
555 value->value.integer.value[0] = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f);
560 /* OK - TODO: test it */
561 static int snd_cx88_capture_volume_put(struct snd_kcontrol *kcontrol,
562 struct snd_ctl_elem_value *value)
564 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
565 struct cx88_core *core=chip->core;
569 /* Do we really know this will always be called with IRQs on? */
570 spin_lock_irq(&chip->reg_lock);
572 old_control = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f);
573 v = 0x3f - (value->value.integer.value[0] & 0x3f);
574 cx_andor(AUD_VOL_CTL, 0x3f, v);
576 spin_unlock_irq(&chip->reg_lock);
578 return v != old_control;
581 static struct snd_kcontrol_new snd_cx88_capture_volume = {
582 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
583 .name = "Capture Volume",
584 .info = snd_cx88_capture_volume_info,
585 .get = snd_cx88_capture_volume_get,
586 .put = snd_cx88_capture_volume_put,
590 /****************************************************************************
591 Basic Flow for Sound Devices
592 ****************************************************************************/
595 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
596 * Only boards with eeprom and byte 1 at eeprom=1 have it
599 static struct pci_device_id cx88_audio_pci_tbl[] __devinitdata = {
600 {0x14f1,0x8801,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
601 {0x14f1,0x8811,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
604 MODULE_DEVICE_TABLE(pci, cx88_audio_pci_tbl);
607 * Chip-specific destructor
610 static int snd_cx88_free(snd_cx88_card_t *chip)
614 synchronize_irq(chip->irq);
615 free_irq(chip->irq, chip);
618 cx88_core_put(chip->core,chip->pci);
620 pci_disable_device(chip->pci);
625 * Component Destructor
627 static void snd_cx88_dev_free(struct snd_card * card)
629 snd_cx88_card_t *chip = card->private_data;
636 * Alsa Constructor - Component probe
640 static int __devinit snd_cx88_create(struct snd_card *card,
642 snd_cx88_card_t **rchip)
644 snd_cx88_card_t *chip;
645 struct cx88_core *core;
647 unsigned char pci_lat;
651 err = pci_enable_device(pci);
657 chip = (snd_cx88_card_t *) card->private_data;
659 core = cx88_core_get(pci);
666 if (!pci_dma_supported(pci,DMA_32BIT_MASK)) {
667 dprintk(0, "%s/1: Oops: no 32bit PCI DMA ???\n",core->name);
669 cx88_core_put(core,pci);
678 spin_lock_init(&chip->reg_lock);
683 err = request_irq(chip->pci->irq, cx8801_irq,
684 IRQF_SHARED | IRQF_DISABLED, chip->core->name, chip);
686 dprintk(0, "%s: can't get IRQ %d\n",
687 chip->core->name, chip->pci->irq);
692 pci_read_config_byte(pci, PCI_LATENCY_TIMER, &pci_lat);
694 dprintk(1,"ALSA %s/%i: found at %s, rev: %d, irq: %d, "
695 "latency: %d, mmio: 0x%llx\n", core->name, devno,
696 pci_name(pci), pci->revision, pci->irq,
697 pci_lat, (unsigned long long)pci_resource_start(pci,0));
699 chip->irq = pci->irq;
700 synchronize_irq(chip->irq);
702 snd_card_set_dev(card, &pci->dev);
709 static int __devinit cx88_audio_initdev(struct pci_dev *pci,
710 const struct pci_device_id *pci_id)
712 struct snd_card *card;
713 snd_cx88_card_t *chip;
716 if (devno >= SNDRV_CARDS)
719 if (!enable[devno]) {
724 card = snd_card_new(index[devno], id[devno], THIS_MODULE, sizeof(snd_cx88_card_t));
728 card->private_free = snd_cx88_dev_free;
730 err = snd_cx88_create(card, pci, &chip);
734 err = snd_cx88_pcm(chip, 0, "CX88 Digital");
741 err = snd_ctl_add(card, snd_ctl_new1(&snd_cx88_capture_volume, chip));
747 strcpy (card->driver, "CX88x");
748 sprintf(card->shortname, "Conexant CX%x", pci->device);
749 sprintf(card->longname, "%s at %#llx",
750 card->shortname,(unsigned long long)pci_resource_start(pci, 0));
751 strcpy (card->mixername, "CX88");
753 dprintk (0, "%s/%i: ALSA support for cx2388x boards\n",
756 err = snd_card_register(card);
761 pci_set_drvdata(pci,card);
769 static void __devexit cx88_audio_finidev(struct pci_dev *pci)
771 struct cx88_audio_dev *card = pci_get_drvdata(pci);
773 snd_card_free((void *)card);
775 pci_set_drvdata(pci, NULL);
781 * PCI driver definition
784 static struct pci_driver cx88_audio_pci_driver = {
785 .name = "cx88_audio",
786 .id_table = cx88_audio_pci_tbl,
787 .probe = cx88_audio_initdev,
788 .remove = cx88_audio_finidev,
791 /****************************************************************************
793 ****************************************************************************/
798 static int cx88_audio_init(void)
800 printk(KERN_INFO "cx2388x alsa driver version %d.%d.%d loaded\n",
801 (CX88_VERSION_CODE >> 16) & 0xff,
802 (CX88_VERSION_CODE >> 8) & 0xff,
803 CX88_VERSION_CODE & 0xff);
805 printk(KERN_INFO "cx2388x: snapshot date %04d-%02d-%02d\n",
806 SNAPSHOT/10000, (SNAPSHOT/100)%100, SNAPSHOT%100);
808 return pci_register_driver(&cx88_audio_pci_driver);
814 static void cx88_audio_fini(void)
817 pci_unregister_driver(&cx88_audio_pci_driver);
820 module_init(cx88_audio_init);
821 module_exit(cx88_audio_fini);
823 /* ----------------------------------------------------------- */