3 * Support for audio capture
4 * PCI function #1 of the cx2388x.
6 * (c) 2005,2006 Ricardo Cerqueira <v4l@cerqueira.org>
7 * (c) 2005 Mauro Carvalho Chehab <mchehab@brturbo.com.br>
8 * Based on a dummy cx88 module by Gerd Knorr <kraxel@bytesex.org>
9 * Based on dummy.c by Jaroslav Kysela <perex@suse.cz>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/device.h>
29 #include <linux/interrupt.h>
30 #include <asm/delay.h>
31 #include <sound/driver.h>
32 #include <sound/core.h>
33 #include <sound/pcm.h>
34 #include <sound/pcm_params.h>
35 #include <sound/control.h>
36 #include <sound/initval.h>
41 #define dprintk(level,fmt, arg...) if (debug >= level) \
42 printk(KERN_INFO "%s/1: " fmt, chip->core->name , ## arg)
44 #define dprintk_core(level,fmt, arg...) if (debug >= level) \
45 printk(KERN_DEBUG "%s/1: " fmt, chip->core->name , ## arg)
48 /****************************************************************************
49 Data type declarations - Can be moded to a header file later
50 ****************************************************************************/
52 /* These can be replaced after done */
53 #define MIXER_ADDR_LAST MAX_CX88_INPUT
55 struct cx88_audio_dev {
56 struct cx88_core *core;
57 struct cx88_dmaqueue q;
61 unsigned char pci_rev,pci_lat;
66 struct snd_card *card;
70 unsigned int dma_size;
71 unsigned int period_size;
72 unsigned int num_periods;
74 struct videobuf_dmabuf dma_risc;
76 int mixer_volume[MIXER_ADDR_LAST+1][2];
77 int capture_source[MIXER_ADDR_LAST+1][2];
82 struct cx88_buffer *buf;
85 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};
99 static struct snd_card *snd_cx88_cards[SNDRV_CARDS];
101 module_param_array(enable, bool, NULL, 0444);
102 MODULE_PARM_DESC(enable, "Enable cx88x soundcard. default enabled.");
104 module_param_array(index, int, NULL, 0444);
105 MODULE_PARM_DESC(index, "Index value for cx88x capture interface(s).");
108 /****************************************************************************
110 ****************************************************************************/
112 MODULE_DESCRIPTION("ALSA driver module for cx2388x based TV cards");
113 MODULE_AUTHOR("Ricardo Cerqueira");
114 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@brturbo.com.br>");
115 MODULE_LICENSE("GPL");
116 MODULE_SUPPORTED_DEVICE("{{Conexant,23881},"
118 "{{Conexant,23883}");
119 static unsigned int debug;
120 module_param(debug,int,0644);
121 MODULE_PARM_DESC(debug,"enable debug messages");
123 /****************************************************************************
124 Module specific funtions
125 ****************************************************************************/
128 * BOARD Specific: Sets audio DMA
131 static int _cx88_start_audio_dma(snd_cx88_card_t *chip)
133 struct cx88_buffer *buf = chip->buf;
134 struct cx88_core *core=chip->core;
135 struct sram_channel *audio_ch = &cx88_sram_channels[SRAM_CH25];
138 dprintk(1, "Starting audio DMA for %i bytes/line and %i (%i) lines at address %08x\n",buf->bpl, chip->num_periods, audio_ch->fifo_size / buf->bpl, audio_ch->fifo_start);
140 /* setup fifo + format - out channel */
141 cx88_sram_channel_setup(chip->core, &cx88_sram_channels[SRAM_CH25],
142 buf->bpl, buf->risc.dma);
145 cx_write(MO_AUDD_LNGTH, buf->bpl);
148 cx_write(MO_AUDD_GPCNTRL,GP_COUNT_CONTROL_RESET);
150 dprintk(1,"Enabling IRQ, setting mask from 0x%x to 0x%x\n",chip->core->pci_irqmask,(chip->core->pci_irqmask | 0x02));
152 cx_set(MO_PCI_INTMSK, chip->core->pci_irqmask | 0x02);
155 /* Enables corresponding bits at AUD_INT_STAT */
156 cx_write(MO_AUD_INTMSK,
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, &cx88_sram_channels[SRAM_CH25]);
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, 0x02);
186 cx_clear(MO_AUD_INTMSK,
194 cx88_sram_channel_dump(chip->core, &cx88_sram_channels[SRAM_CH25]);
199 #define MAX_IRQ_LOOP 10
202 * BOARD Specific: IRQ dma bits
204 static char *cx88_aud_irqs[32] = {
205 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
207 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
209 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
211 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
213 "opc_err", "par_err", "rip_err", /* 16-18 */
214 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
218 * BOARD Specific: Threats IRQ audio specific calls
220 static void cx8801_aud_irq(snd_cx88_card_t *chip)
222 struct cx88_core *core = chip->core;
226 status = cx_read(MO_AUD_INTSTAT);
227 mask = cx_read(MO_AUD_INTMSK);
228 if (0 == (status & mask)) {
229 spin_unlock(&chip->reg_lock);
232 cx_write(MO_AUD_INTSTAT, status);
233 if (debug > 1 || (status & mask & ~0xff))
234 cx88_print_irqbits(core->name, "irq aud",
235 cx88_aud_irqs, status, mask);
236 /* risc op code error */
237 if (status & (1 << 16)) {
238 printk(KERN_WARNING "%s/0: audio risc op code error\n",core->name);
239 cx_clear(MO_AUD_DMACNTRL, 0x11);
240 cx88_sram_channel_dump(core, &cx88_sram_channels[SRAM_CH25]);
243 /* risc1 downstream */
245 spin_lock(&chip->reg_lock);
246 count = cx_read(MO_AUDD_GPCNT);
247 spin_unlock(&chip->reg_lock);
248 if (chip->read_count == 0)
249 chip->read_count += chip->dma_size;
252 if (chip->read_count >= chip->period_size) {
253 dprintk(2, "Elapsing period\n");
254 snd_pcm_period_elapsed(chip->substream);
257 dprintk(3,"Leaving audio IRQ handler...\n");
259 /* FIXME: Any other status should deserve a special handling? */
263 * BOARD Specific: Handles IRQ calls
265 static irqreturn_t cx8801_irq(int irq, void *dev_id, struct pt_regs *regs)
267 snd_cx88_card_t *chip = dev_id;
268 struct cx88_core *core = chip->core;
270 int loop, handled = 0;
272 for (loop = 0; loop < MAX_IRQ_LOOP; loop++) {
273 status = cx_read(MO_PCI_INTSTAT) & (core->pci_irqmask | 0x02);
276 dprintk( 3, "cx8801_irq\n" );
277 dprintk( 3, " loop: %d/%d\n", loop, MAX_IRQ_LOOP );
278 dprintk( 3, " status: %d\n", status );
280 cx_write(MO_PCI_INTSTAT, status);
284 dprintk( 2, " ALSA IRQ handling\n" );
285 cx8801_aud_irq(chip);
289 if (MAX_IRQ_LOOP == loop) {
290 dprintk( 0, "clearing mask\n" );
291 dprintk(1,"%s/0: irq loop -- clearing mask\n",
293 cx_clear(MO_PCI_INTMSK,0x02);
297 return IRQ_RETVAL(handled);
301 static int dsp_buffer_free(snd_cx88_card_t *chip)
303 BUG_ON(!chip->dma_size);
305 dprintk(2,"Freeing buffer\n");
306 videobuf_pci_dma_unmap(chip->pci, &chip->dma_risc);
307 videobuf_dma_free(&chip->dma_risc);
308 btcx_riscmem_free(chip->pci,&chip->buf->risc);
316 /****************************************************************************
318 ****************************************************************************/
321 * Digital hardware definition
323 static struct snd_pcm_hardware snd_cx88_digital_hw = {
324 .info = SNDRV_PCM_INFO_MMAP |
325 SNDRV_PCM_INFO_INTERLEAVED |
326 SNDRV_PCM_INFO_BLOCK_TRANSFER |
327 SNDRV_PCM_INFO_MMAP_VALID,
328 .formats = SNDRV_PCM_FMTBIT_S16_LE,
330 .rates = SNDRV_PCM_RATE_48000,
335 .buffer_bytes_max = (2*2048),
336 .period_bytes_min = 2048,
337 .period_bytes_max = 2048,
343 * audio pcm capture runtime free
345 static void snd_card_cx88_runtime_free(struct snd_pcm_runtime *runtime)
349 * audio pcm capture open callback
351 static int snd_cx88_pcm_open(struct snd_pcm_substream *substream)
353 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
354 struct snd_pcm_runtime *runtime = substream->runtime;
357 if (test_and_set_bit(0, &chip->opened))
360 err = snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
364 chip->substream = substream;
366 chip->read_count = 0;
367 chip->read_offset = 0;
369 runtime->private_free = snd_card_cx88_runtime_free;
370 runtime->hw = snd_cx88_digital_hw;
374 dprintk(1,"Error opening PCM!\n");
375 clear_bit(0, &chip->opened);
376 smp_mb__after_clear_bit();
381 * audio close callback
383 static int snd_cx88_close(struct snd_pcm_substream *substream)
385 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
387 clear_bit(0, &chip->opened);
388 smp_mb__after_clear_bit();
396 static int snd_cx88_hw_params(struct snd_pcm_substream * substream,
397 struct snd_pcm_hw_params * hw_params)
399 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
400 struct cx88_buffer *buf;
402 if (substream->runtime->dma_area) {
403 dsp_buffer_free(chip);
404 substream->runtime->dma_area = NULL;
408 chip->period_size = params_period_bytes(hw_params);
409 chip->num_periods = params_periods(hw_params);
410 chip->dma_size = chip->period_size * params_periods(hw_params);
412 BUG_ON(!chip->dma_size);
414 dprintk(1,"Setting buffer\n");
416 buf = kmalloc(sizeof(*buf),GFP_KERNEL);
419 memset(buf,0,sizeof(*buf));
422 buf->vb.memory = V4L2_MEMORY_MMAP;
423 buf->vb.width = chip->period_size;
424 buf->vb.height = chip->num_periods;
425 buf->vb.size = chip->dma_size;
426 buf->vb.field = V4L2_FIELD_NONE;
428 videobuf_dma_init(&buf->vb.dma);
429 videobuf_dma_init_kernel(&buf->vb.dma,PCI_DMA_FROMDEVICE,
430 (PAGE_ALIGN(buf->vb.size) >> PAGE_SHIFT));
432 videobuf_pci_dma_map(chip->pci,&buf->vb.dma);
435 cx88_risc_databuffer(chip->pci, &buf->risc,
437 buf->vb.width, buf->vb.height);
439 buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP | RISC_IRQ1 | RISC_CNT_INC);
440 buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
442 buf->vb.state = STATE_PREPARED;
444 buf->bpl = chip->period_size;
446 chip->dma_risc = buf->vb.dma;
448 dprintk(1,"Buffer ready at %u\n",chip->dma_risc.nr_pages);
449 substream->runtime->dma_area = chip->dma_risc.vmalloc;
456 static int snd_cx88_hw_free(struct snd_pcm_substream * substream)
459 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
461 if (substream->runtime->dma_area) {
462 dsp_buffer_free(chip);
463 substream->runtime->dma_area = NULL;
472 static int snd_cx88_prepare(struct snd_pcm_substream *substream)
481 static int snd_cx88_card_trigger(struct snd_pcm_substream *substream, int cmd)
483 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
486 spin_lock(&chip->reg_lock);
489 case SNDRV_PCM_TRIGGER_START:
490 err=_cx88_start_audio_dma(chip);
492 case SNDRV_PCM_TRIGGER_STOP:
493 err=_cx88_stop_audio_dma(chip);
500 spin_unlock(&chip->reg_lock);
508 static snd_pcm_uframes_t snd_cx88_pointer(struct snd_pcm_substream *substream)
510 snd_cx88_card_t *chip = snd_pcm_substream_chip(substream);
511 struct snd_pcm_runtime *runtime = substream->runtime;
513 if (chip->read_count) {
514 chip->read_count -= snd_pcm_lib_period_bytes(substream);
515 chip->read_offset += snd_pcm_lib_period_bytes(substream);
516 if (chip->read_offset == chip->dma_size)
517 chip->read_offset = 0;
520 dprintk(2, "Pointer time, will return %li, read %li\n",chip->read_offset,chip->read_count);
521 return bytes_to_frames(runtime, chip->read_offset);
528 static struct snd_pcm_ops snd_cx88_pcm_ops = {
529 .open = snd_cx88_pcm_open,
530 .close = snd_cx88_close,
531 .ioctl = snd_pcm_lib_ioctl,
532 .hw_params = snd_cx88_hw_params,
533 .hw_free = snd_cx88_hw_free,
534 .prepare = snd_cx88_prepare,
535 .trigger = snd_cx88_card_trigger,
536 .pointer = snd_cx88_pointer,
540 * create a PCM device
542 static int __devinit snd_cx88_pcm(snd_cx88_card_t *chip, int device, char *name)
547 err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
550 pcm->private_data = chip;
551 strcpy(pcm->name, name);
552 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx88_pcm_ops);
557 /****************************************************************************
559 ****************************************************************************/
560 static int snd_cx88_capture_volume_info(struct snd_kcontrol *kcontrol,
561 struct snd_ctl_elem_info *info)
563 info->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
565 info->value.integer.min = 0;
566 info->value.integer.max = 0x3f;
571 /* OK - TODO: test it */
572 static int snd_cx88_capture_volume_get(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;
578 value->value.integer.value[0] = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f);
583 /* OK - TODO: test it */
584 static int snd_cx88_capture_volume_put(struct snd_kcontrol *kcontrol,
585 struct snd_ctl_elem_value *value)
587 snd_cx88_card_t *chip = snd_kcontrol_chip(kcontrol);
588 struct cx88_core *core=chip->core;
592 spin_lock_irq(&chip->reg_lock);
593 old_control = 0x3f - (cx_read(AUD_VOL_CTL) & 0x3f);
594 v = 0x3f - (value->value.integer.value[0] & 0x3f);
595 cx_andor(AUD_VOL_CTL, 0x3f, v);
596 spin_unlock_irq(&chip->reg_lock);
598 return v != old_control;
601 static struct snd_kcontrol_new snd_cx88_capture_volume = {
602 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
603 .name = "Capture Volume",
604 .info = snd_cx88_capture_volume_info,
605 .get = snd_cx88_capture_volume_get,
606 .put = snd_cx88_capture_volume_put,
610 /****************************************************************************
611 Basic Flow for Sound Devices
612 ****************************************************************************/
615 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
616 * Only boards with eeprom and byte 1 at eeprom=1 have it
619 static struct pci_device_id cx88_audio_pci_tbl[] __devinitdata = {
620 {0x14f1,0x8801,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
621 {0x14f1,0x8811,PCI_ANY_ID,PCI_ANY_ID,0,0,0},
624 MODULE_DEVICE_TABLE(pci, cx88_audio_pci_tbl);
627 * Chip-specific destructor
630 static int snd_cx88_free(snd_cx88_card_t *chip)
634 synchronize_irq(chip->irq);
635 free_irq(chip->irq, chip);
638 cx88_core_put(chip->core,chip->pci);
640 pci_disable_device(chip->pci);
645 * Component Destructor
647 static void snd_cx88_dev_free(struct snd_card * card)
649 snd_cx88_card_t *chip = card->private_data;
656 * Alsa Constructor - Component probe
660 static int __devinit snd_cx88_create(struct snd_card *card,
662 snd_cx88_card_t **rchip)
664 snd_cx88_card_t *chip;
665 struct cx88_core *core;
670 err = pci_enable_device(pci);
676 chip = (snd_cx88_card_t *) card->private_data;
678 core = cx88_core_get(pci);
685 if (!pci_dma_supported(pci,0xffffffff)) {
686 dprintk(0, "%s/1: Oops: no 32bit PCI DMA ???\n",core->name);
688 cx88_core_put(core,pci);
697 spin_lock_init(&chip->reg_lock);
703 err = request_irq(chip->pci->irq, cx8801_irq,
704 SA_SHIRQ | SA_INTERRUPT, chip->core->name, chip);
706 dprintk(0, "%s: can't get IRQ %d\n",
707 chip->core->name, chip->pci->irq);
712 pci_read_config_byte(pci, PCI_CLASS_REVISION, &chip->pci_rev);
713 pci_read_config_byte(pci, PCI_LATENCY_TIMER, &chip->pci_lat);
715 dprintk(1,"ALSA %s/%i: found at %s, rev: %d, irq: %d, "
716 "latency: %d, mmio: 0x%lx\n", core->name, devno,
717 pci_name(pci), chip->pci_rev, pci->irq,
718 chip->pci_lat,pci_resource_start(pci,0));
720 chip->irq = pci->irq;
721 synchronize_irq(chip->irq);
723 snd_card_set_dev(card, &pci->dev);
730 static int __devinit cx88_audio_initdev(struct pci_dev *pci,
731 const struct pci_device_id *pci_id)
733 struct snd_card *card;
734 snd_cx88_card_t *chip;
737 if (devno >= SNDRV_CARDS)
740 if (!enable[devno]) {
745 card = snd_card_new(index[devno], id[devno], THIS_MODULE, sizeof(snd_cx88_card_t));
749 card->private_free = snd_cx88_dev_free;
751 err = snd_cx88_create(card, pci, &chip);
755 err = snd_cx88_pcm(chip, 0, "CX88 Digital");
762 err = snd_ctl_add(card, snd_ctl_new1(&snd_cx88_capture_volume, chip));
768 strcpy (card->driver, "CX88x");
769 sprintf(card->shortname, "Conexant CX%x", pci->device);
770 sprintf(card->longname, "%s at %#lx",
771 card->shortname, pci_resource_start(pci, 0));
772 strcpy (card->mixername, "CX88");
774 dprintk (0, "%s/%i: ALSA support for cx2388x boards\n",
777 err = snd_card_register(card);
782 snd_cx88_cards[devno] = card;
784 pci_set_drvdata(pci,card);
792 static void __devexit cx88_audio_finidev(struct pci_dev *pci)
794 struct cx88_audio_dev *card = pci_get_drvdata(pci);
796 snd_card_free((void *)card);
798 pci_set_drvdata(pci, NULL);
804 * PCI driver definition
807 static struct pci_driver cx88_audio_pci_driver = {
808 .name = "cx88_audio",
809 .id_table = cx88_audio_pci_tbl,
810 .probe = cx88_audio_initdev,
811 .remove = cx88_audio_finidev,
814 /****************************************************************************
816 ****************************************************************************/
821 static int cx88_audio_init(void)
823 printk(KERN_INFO "cx2388x alsa driver version %d.%d.%d loaded\n",
824 (CX88_VERSION_CODE >> 16) & 0xff,
825 (CX88_VERSION_CODE >> 8) & 0xff,
826 CX88_VERSION_CODE & 0xff);
828 printk(KERN_INFO "cx2388x: snapshot date %04d-%02d-%02d\n",
829 SNAPSHOT/10000, (SNAPSHOT/100)%100, SNAPSHOT%100);
831 return pci_register_driver(&cx88_audio_pci_driver);
837 static void cx88_audio_fini(void)
840 pci_unregister_driver(&cx88_audio_pci_driver);
843 module_init(cx88_audio_init);
844 module_exit(cx88_audio_fini);
846 /* ----------------------------------------------------------- */