2 * Driver for the Conexant CX25821 PCIe bridge
4 * Copyright (C) 2009 Conexant Systems Inc.
5 * Authors <shu.lin@conexant.com>, <hiep.huynh@conexant.com>
6 * Based on SAA713x ALSA driver and CX88 driver
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, version 2
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/device.h>
26 #include <linux/interrupt.h>
27 #include <linux/vmalloc.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/pci.h>
30 #include <linux/slab.h>
32 #include <linux/delay.h>
33 #include <sound/core.h>
34 #include <sound/pcm.h>
35 #include <sound/pcm_params.h>
36 #include <sound/control.h>
37 #include <sound/initval.h>
38 #include <sound/tlv.h>
41 #include "cx25821-reg.h"
43 #define AUDIO_SRAM_CHANNEL SRAM_CH08
45 #define dprintk(level, fmt, arg...) if (debug >= level) \
46 printk(KERN_INFO "%s/1: " fmt, chip->dev->name , ## arg)
48 #define dprintk_core(level, fmt, arg...) if (debug >= level) \
49 printk(KERN_DEBUG "%s/1: " fmt, chip->dev->name , ## arg)
51 /****************************************************************************
52 Data type declarations - Can be moded to a header file later
53 ****************************************************************************/
55 static struct snd_card *snd_cx25821_cards[SNDRV_CARDS];
58 struct cx25821_audio_dev {
59 struct cx25821_dev *dev;
60 struct cx25821_dmaqueue q;
68 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 struct cx25821_buffer *buf;
82 struct snd_pcm_substream *substream;
86 /****************************************************************************
87 Module global static vars
88 ****************************************************************************/
90 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
91 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
92 static int enable[SNDRV_CARDS] = { 1, [1 ... (SNDRV_CARDS - 1)] = 1 };
94 module_param_array(enable, bool, NULL, 0444);
95 MODULE_PARM_DESC(enable, "Enable cx25821 soundcard. default enabled.");
97 module_param_array(index, int, NULL, 0444);
98 MODULE_PARM_DESC(index, "Index value for cx25821 capture interface(s).");
100 /****************************************************************************
102 ****************************************************************************/
104 MODULE_DESCRIPTION("ALSA driver module for cx25821 based capture cards");
105 MODULE_AUTHOR("Hiep Huynh");
106 MODULE_LICENSE("GPL");
107 MODULE_SUPPORTED_DEVICE("{{Conexant,25821}"); /* "{{Conexant,23881}," */
109 static unsigned int debug;
110 module_param(debug, int, 0644);
111 MODULE_PARM_DESC(debug, "enable debug messages");
113 /****************************************************************************
114 Module specific funtions
115 ****************************************************************************/
116 /* Constants taken from cx88-reg.h */
117 #define AUD_INT_DN_RISCI1 (1 << 0)
118 #define AUD_INT_UP_RISCI1 (1 << 1)
119 #define AUD_INT_RDS_DN_RISCI1 (1 << 2)
120 #define AUD_INT_DN_RISCI2 (1 << 4) /* yes, 3 is skipped */
121 #define AUD_INT_UP_RISCI2 (1 << 5)
122 #define AUD_INT_RDS_DN_RISCI2 (1 << 6)
123 #define AUD_INT_DN_SYNC (1 << 12)
124 #define AUD_INT_UP_SYNC (1 << 13)
125 #define AUD_INT_RDS_DN_SYNC (1 << 14)
126 #define AUD_INT_OPC_ERR (1 << 16)
127 #define AUD_INT_BER_IRQ (1 << 20)
128 #define AUD_INT_MCHG_IRQ (1 << 21)
129 #define GP_COUNT_CONTROL_RESET 0x3
131 #define PCI_MSK_AUD_EXT (1 << 4)
132 #define PCI_MSK_AUD_INT (1 << 3)
134 * BOARD Specific: Sets audio DMA
137 static int _cx25821_start_audio_dma(struct cx25821_audio_dev *chip)
139 struct cx25821_buffer *buf = chip->buf;
140 struct cx25821_dev *dev = chip->dev;
141 struct sram_channel *audio_ch =
142 &cx25821_sram_channels[AUDIO_SRAM_CHANNEL];
145 /* enable output on the GPIO 0 for the MCLK ADC (Audio) */
146 cx25821_set_gpiopin_direction(chip->dev, 0, 0);
148 /* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
149 cx_clear(AUD_INT_DMA_CTL,
150 FLD_AUD_DST_A_RISC_EN | FLD_AUD_DST_A_FIFO_EN);
152 /* setup fifo + format - out channel */
153 cx25821_sram_channel_setup_audio(chip->dev, audio_ch, buf->bpl,
157 cx_write(AUD_A_LNGTH, buf->bpl);
160 /* GP_COUNT_CONTROL_RESET = 0x3 */
161 cx_write(AUD_A_GPCNT_CTL, GP_COUNT_CONTROL_RESET);
162 atomic_set(&chip->count, 0);
164 /* Set the input mode to 16-bit */
165 tmp = cx_read(AUD_A_CFG);
167 tmp | FLD_AUD_DST_PK_MODE | FLD_AUD_DST_ENABLE |
170 /* printk(KERN_INFO "DEBUG: Start audio DMA, %d B/line,"
171 "cmds_start(0x%x)= %d lines/FIFO, %d periods, "
172 "%d byte buffer\n", buf->bpl,
173 audio_ch->cmds_start,
174 cx_read(audio_ch->cmds_start + 12)>>1,
175 chip->num_periods, buf->bpl *chip->num_periods);
178 /* Enables corresponding bits at AUD_INT_STAT */
179 cx_write(AUD_A_INT_MSK,
180 FLD_AUD_DST_RISCI1 | FLD_AUD_DST_OF | FLD_AUD_DST_SYNC |
181 FLD_AUD_DST_OPC_ERR);
183 /* Clean any pending interrupt bits already set */
184 cx_write(AUD_A_INT_STAT, ~0);
186 /* enable audio irqs */
187 cx_set(PCI_INT_MSK, chip->dev->pci_irqmask | PCI_MSK_AUD_INT);
189 /* Turn on audio downstream fifo and risc enable 0x101 */
190 tmp = cx_read(AUD_INT_DMA_CTL);
191 cx_set(AUD_INT_DMA_CTL,
192 tmp | (FLD_AUD_DST_A_RISC_EN | FLD_AUD_DST_A_FIFO_EN));
199 * BOARD Specific: Resets audio DMA
201 static int _cx25821_stop_audio_dma(struct cx25821_audio_dev *chip)
203 struct cx25821_dev *dev = chip->dev;
206 cx_clear(AUD_INT_DMA_CTL,
207 FLD_AUD_DST_A_RISC_EN | FLD_AUD_DST_A_FIFO_EN);
210 cx_clear(PCI_INT_MSK, PCI_MSK_AUD_INT);
211 cx_clear(AUD_A_INT_MSK,
212 AUD_INT_OPC_ERR | AUD_INT_DN_SYNC | AUD_INT_DN_RISCI2 |
218 #define MAX_IRQ_LOOP 50
221 * BOARD Specific: IRQ dma bits
223 static char *cx25821_aud_irqs[32] = {
224 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
226 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
228 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
230 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
232 "opc_err", "par_err", "rip_err", /* 16-18 */
233 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
237 * BOARD Specific: Threats IRQ audio specific calls
239 static void cx25821_aud_irq(struct cx25821_audio_dev *chip, u32 status,
242 struct cx25821_dev *dev = chip->dev;
244 if (0 == (status & mask))
247 cx_write(AUD_A_INT_STAT, status);
248 if (debug > 1 || (status & mask & ~0xff))
249 cx25821_print_irqbits(dev->name, "irq aud",
251 ARRAY_SIZE(cx25821_aud_irqs), status,
254 /* risc op code error */
255 if (status & AUD_INT_OPC_ERR) {
256 printk(KERN_WARNING "WARNING %s/1: Audio risc op code error\n",
259 cx_clear(AUD_INT_DMA_CTL,
260 FLD_AUD_DST_A_RISC_EN | FLD_AUD_DST_A_FIFO_EN);
261 cx25821_sram_channel_dump_audio(dev,
262 &cx25821_sram_channels
263 [AUDIO_SRAM_CHANNEL]);
265 if (status & AUD_INT_DN_SYNC) {
266 printk(KERN_WARNING "WARNING %s: Downstream sync error!\n",
268 cx_write(AUD_A_GPCNT_CTL, GP_COUNT_CONTROL_RESET);
272 /* risc1 downstream */
273 if (status & AUD_INT_DN_RISCI1) {
274 atomic_set(&chip->count, cx_read(AUD_A_GPCNT));
275 snd_pcm_period_elapsed(chip->substream);
280 * BOARD Specific: Handles IRQ calls
282 static irqreturn_t cx25821_irq(int irq, void *dev_id)
284 struct cx25821_audio_dev *chip = dev_id;
285 struct cx25821_dev *dev = chip->dev;
286 u32 status, pci_status;
287 u32 audint_status, audint_mask;
288 int loop, handled = 0;
289 int audint_count = 0;
291 audint_status = cx_read(AUD_A_INT_STAT);
292 audint_mask = cx_read(AUD_A_INT_MSK);
293 audint_count = cx_read(AUD_A_GPCNT);
294 status = cx_read(PCI_INT_STAT);
296 for (loop = 0; loop < 1; loop++) {
297 status = cx_read(PCI_INT_STAT);
299 status = cx_read(PCI_INT_STAT);
300 audint_status = cx_read(AUD_A_INT_STAT);
301 audint_mask = cx_read(AUD_A_INT_MSK);
305 cx_write(PCI_INT_STAT, status);
307 cx25821_aud_irq(chip, audint_status,
315 cx_write(PCI_INT_STAT, status);
317 cx25821_aud_irq(chip, audint_status, audint_mask);
320 pci_status = cx_read(PCI_INT_STAT);
323 cx_write(PCI_INT_STAT, pci_status);
326 return IRQ_RETVAL(handled);
329 static int dsp_buffer_free(struct cx25821_audio_dev *chip)
331 BUG_ON(!chip->dma_size);
333 dprintk(2, "Freeing buffer\n");
334 videobuf_sg_dma_unmap(&chip->pci->dev, chip->dma_risc);
335 videobuf_dma_free(chip->dma_risc);
336 btcx_riscmem_free(chip->pci, &chip->buf->risc);
339 chip->dma_risc = NULL;
345 /****************************************************************************
347 ****************************************************************************/
350 * Digital hardware definition
352 #define DEFAULT_FIFO_SIZE 384
353 static struct snd_pcm_hardware snd_cx25821_digital_hw = {
354 .info = SNDRV_PCM_INFO_MMAP |
355 SNDRV_PCM_INFO_INTERLEAVED |
356 SNDRV_PCM_INFO_BLOCK_TRANSFER | SNDRV_PCM_INFO_MMAP_VALID,
357 .formats = SNDRV_PCM_FMTBIT_S16_LE,
359 .rates = SNDRV_PCM_RATE_48000,
364 /* Analog audio output will be full of clicks and pops if there
365 are not exactly four lines in the SRAM FIFO buffer. */
366 .period_bytes_min = DEFAULT_FIFO_SIZE / 3,
367 .period_bytes_max = DEFAULT_FIFO_SIZE / 3,
369 .periods_max = AUDIO_LINE_SIZE,
370 /* 128 * 128 = 16384 = 1024 * 16 */
371 .buffer_bytes_max = (AUDIO_LINE_SIZE * AUDIO_LINE_SIZE),
375 * audio pcm capture open callback
377 static int snd_cx25821_pcm_open(struct snd_pcm_substream *substream)
379 struct cx25821_audio_dev *chip = snd_pcm_substream_chip(substream);
380 struct snd_pcm_runtime *runtime = substream->runtime;
382 unsigned int bpl = 0;
385 printk(KERN_ERR "DEBUG: cx25821 can't find device struct."
386 " Can't proceed with open\n");
391 snd_pcm_hw_constraint_pow2(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS);
395 chip->substream = substream;
397 runtime->hw = snd_cx25821_digital_hw;
399 if (cx25821_sram_channels[AUDIO_SRAM_CHANNEL].fifo_size !=
401 /* since there are 3 audio Clusters */
402 bpl = cx25821_sram_channels[AUDIO_SRAM_CHANNEL].fifo_size / 3;
403 bpl &= ~7; /* must be multiple of 8 */
405 if (bpl > AUDIO_LINE_SIZE)
406 bpl = AUDIO_LINE_SIZE;
408 runtime->hw.period_bytes_min = bpl;
409 runtime->hw.period_bytes_max = bpl;
414 dprintk(1, "Error opening PCM!\n");
419 * audio close callback
421 static int snd_cx25821_close(struct snd_pcm_substream *substream)
429 static int snd_cx25821_hw_params(struct snd_pcm_substream *substream,
430 struct snd_pcm_hw_params *hw_params)
432 struct cx25821_audio_dev *chip = snd_pcm_substream_chip(substream);
433 struct videobuf_dmabuf *dma;
435 struct cx25821_buffer *buf;
438 if (substream->runtime->dma_area) {
439 dsp_buffer_free(chip);
440 substream->runtime->dma_area = NULL;
443 chip->period_size = params_period_bytes(hw_params);
444 chip->num_periods = params_periods(hw_params);
445 chip->dma_size = chip->period_size * params_periods(hw_params);
447 BUG_ON(!chip->dma_size);
448 BUG_ON(chip->num_periods & (chip->num_periods - 1));
450 buf = videobuf_sg_alloc(sizeof(*buf));
454 if (chip->period_size > AUDIO_LINE_SIZE)
455 chip->period_size = AUDIO_LINE_SIZE;
457 buf->vb.memory = V4L2_MEMORY_MMAP;
458 buf->vb.field = V4L2_FIELD_NONE;
459 buf->vb.width = chip->period_size;
460 buf->bpl = chip->period_size;
461 buf->vb.height = chip->num_periods;
462 buf->vb.size = chip->dma_size;
464 dma = videobuf_to_dma(&buf->vb);
465 videobuf_dma_init(dma);
467 ret = videobuf_dma_init_kernel(dma, PCI_DMA_FROMDEVICE,
468 (PAGE_ALIGN(buf->vb.size) >>
473 ret = videobuf_sg_dma_map(&chip->pci->dev, dma);
478 cx25821_risc_databuffer_audio(chip->pci, &buf->risc, dma->sglist,
479 buf->vb.width, buf->vb.height, 1);
482 "DEBUG: ERROR after cx25821_risc_databuffer_audio()\n");
486 /* Loop back to start of program */
487 buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP | RISC_IRQ1 | RISC_CNT_INC);
488 buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
489 buf->risc.jmp[2] = cpu_to_le32(0); /* bits 63-32 */
491 buf->vb.state = VIDEOBUF_PREPARED;
494 chip->dma_risc = dma;
496 substream->runtime->dma_area = chip->dma_risc->vmalloc;
497 substream->runtime->dma_bytes = chip->dma_size;
498 substream->runtime->dma_addr = 0;
510 static int snd_cx25821_hw_free(struct snd_pcm_substream *substream)
512 struct cx25821_audio_dev *chip = snd_pcm_substream_chip(substream);
514 if (substream->runtime->dma_area) {
515 dsp_buffer_free(chip);
516 substream->runtime->dma_area = NULL;
525 static int snd_cx25821_prepare(struct snd_pcm_substream *substream)
533 static int snd_cx25821_card_trigger(struct snd_pcm_substream *substream,
536 struct cx25821_audio_dev *chip = snd_pcm_substream_chip(substream);
539 /* Local interrupts are already disabled by ALSA */
540 spin_lock(&chip->reg_lock);
543 case SNDRV_PCM_TRIGGER_START:
544 err = _cx25821_start_audio_dma(chip);
546 case SNDRV_PCM_TRIGGER_STOP:
547 err = _cx25821_stop_audio_dma(chip);
554 spin_unlock(&chip->reg_lock);
562 static snd_pcm_uframes_t snd_cx25821_pointer(struct snd_pcm_substream
565 struct cx25821_audio_dev *chip = snd_pcm_substream_chip(substream);
566 struct snd_pcm_runtime *runtime = substream->runtime;
569 count = atomic_read(&chip->count);
571 return runtime->period_size * (count & (runtime->periods - 1));
575 * page callback (needed for mmap)
577 static struct page *snd_cx25821_page(struct snd_pcm_substream *substream,
578 unsigned long offset)
580 void *pageptr = substream->runtime->dma_area + offset;
582 return vmalloc_to_page(pageptr);
588 static struct snd_pcm_ops snd_cx25821_pcm_ops = {
589 .open = snd_cx25821_pcm_open,
590 .close = snd_cx25821_close,
591 .ioctl = snd_pcm_lib_ioctl,
592 .hw_params = snd_cx25821_hw_params,
593 .hw_free = snd_cx25821_hw_free,
594 .prepare = snd_cx25821_prepare,
595 .trigger = snd_cx25821_card_trigger,
596 .pointer = snd_cx25821_pointer,
597 .page = snd_cx25821_page,
601 * ALSA create a PCM device: Called when initializing the board.
602 * Sets up the name and hooks up the callbacks
604 static int snd_cx25821_pcm(struct cx25821_audio_dev *chip, int device,
610 err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
612 printk(KERN_INFO "ERROR: FAILED snd_pcm_new() in %s\n",
616 pcm->private_data = chip;
618 strcpy(pcm->name, name);
619 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx25821_pcm_ops);
624 /****************************************************************************
625 Basic Flow for Sound Devices
626 ****************************************************************************/
629 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
630 * Only boards with eeprom and byte 1 at eeprom=1 have it
633 static struct pci_device_id cx25821_audio_pci_tbl[] __devinitdata = {
634 {0x14f1, 0x0920, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
638 MODULE_DEVICE_TABLE(pci, cx25821_audio_pci_tbl);
641 * Not used in the function snd_cx25821_dev_free so removing
645 static int snd_cx25821_free(struct cx25821_audio_dev *chip)
648 free_irq(chip->irq, chip);
650 cx25821_dev_unregister(chip->dev);
651 pci_disable_device(chip->pci);
658 * Component Destructor
660 static void snd_cx25821_dev_free(struct snd_card *card)
662 struct cx25821_audio_dev *chip = card->private_data;
664 /* snd_cx25821_free(chip); */
665 snd_card_free(chip->card);
669 * Alsa Constructor - Component probe
671 static int cx25821_audio_initdev(struct cx25821_dev *dev)
673 struct snd_card *card;
674 struct cx25821_audio_dev *chip;
677 if (devno >= SNDRV_CARDS) {
678 printk(KERN_INFO "DEBUG ERROR: devno >= SNDRV_CARDS %s\n",
683 if (!enable[devno]) {
685 printk(KERN_INFO "DEBUG ERROR: !enable[devno] %s\n", __func__);
689 err = snd_card_create(index[devno], id[devno], THIS_MODULE,
690 sizeof(struct cx25821_audio_dev), &card);
693 "DEBUG ERROR: cannot create snd_card_new in %s\n",
698 strcpy(card->driver, "cx25821");
700 /* Card "creation" */
701 card->private_free = snd_cx25821_dev_free;
702 chip = (struct cx25821_audio_dev *) card->private_data;
703 spin_lock_init(&chip->reg_lock);
707 chip->pci = dev->pci;
708 chip->iobase = pci_resource_start(dev->pci, 0);
710 chip->irq = dev->pci->irq;
712 err = request_irq(dev->pci->irq, cx25821_irq,
713 IRQF_SHARED | IRQF_DISABLED, chip->dev->name, chip);
716 printk(KERN_ERR "ERROR %s: can't get IRQ %d for ALSA\n",
717 chip->dev->name, dev->pci->irq);
721 err = snd_cx25821_pcm(chip, 0, "cx25821 Digital");
724 "DEBUG ERROR: cannot create snd_cx25821_pcm %s\n",
729 snd_card_set_dev(card, &chip->pci->dev);
731 strcpy(card->shortname, "cx25821");
732 sprintf(card->longname, "%s at 0x%lx irq %d", chip->dev->name,
733 chip->iobase, chip->irq);
734 strcpy(card->mixername, "CX25821");
736 printk(KERN_INFO "%s/%i: ALSA support for cx25821 boards\n",
737 card->driver, devno);
739 err = snd_card_register(card);
741 printk(KERN_INFO "DEBUG ERROR: cannot register sound card %s\n",
746 snd_cx25821_cards[devno] = card;
756 /****************************************************************************
758 ****************************************************************************/
759 static void cx25821_audio_fini(void)
761 snd_card_free(snd_cx25821_cards[0]);
767 * Loops through present saa7134 cards, and assigns an ALSA device
771 static int cx25821_alsa_init(void)
773 struct cx25821_dev *dev = NULL;
774 struct list_head *list;
776 list_for_each(list, &cx25821_devlist) {
777 dev = list_entry(list, struct cx25821_dev, devlist);
778 cx25821_audio_initdev(dev);
783 "cx25821 ERROR ALSA: no cx25821 cards found\n");
789 late_initcall(cx25821_alsa_init);
790 module_exit(cx25821_audio_fini);
792 /* ----------------------------------------------------------- */