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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/device.h>
28 #include <linux/interrupt.h>
29 #include <linux/vmalloc.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/pci.h>
32 #include <linux/slab.h>
34 #include <linux/delay.h>
35 #include <sound/core.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/control.h>
39 #include <sound/initval.h>
40 #include <sound/tlv.h>
43 #include "cx25821-reg.h"
45 #define AUDIO_SRAM_CHANNEL SRAM_CH08
47 #define dprintk(level, fmt, arg...) \
50 pr_info("%s/1: " fmt, chip->dev->name, ##arg); \
52 #define dprintk_core(level, fmt, arg...) \
55 printk(KERN_DEBUG "%s/1: " fmt, chip->dev->name, ##arg); \
58 /****************************************************************************
59 Data type declarations - Can be moded to a header file later
60 ****************************************************************************/
62 static struct snd_card
*snd_cx25821_cards
[SNDRV_CARDS
];
65 struct cx25821_audio_buffer
{
67 struct btcx_riscmem risc
;
68 struct videobuf_dmabuf dma
;
71 struct cx25821_audio_dev
{
72 struct cx25821_dev
*dev
;
73 struct cx25821_dmaqueue q
;
81 struct snd_card
*card
;
87 unsigned int dma_size
;
88 unsigned int period_size
;
89 unsigned int num_periods
;
91 struct videobuf_dmabuf
*dma_risc
;
93 struct cx25821_audio_buffer
*buf
;
95 struct snd_pcm_substream
*substream
;
99 /****************************************************************************
100 Module global static vars
101 ****************************************************************************/
103 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
104 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
105 static bool enable
[SNDRV_CARDS
] = { 1, [1 ... (SNDRV_CARDS
- 1)] = 1 };
107 module_param_array(enable
, bool, NULL
, 0444);
108 MODULE_PARM_DESC(enable
, "Enable cx25821 soundcard. default enabled.");
110 module_param_array(index
, int, NULL
, 0444);
111 MODULE_PARM_DESC(index
, "Index value for cx25821 capture interface(s).");
113 /****************************************************************************
115 ****************************************************************************/
117 MODULE_DESCRIPTION("ALSA driver module for cx25821 based capture cards");
118 MODULE_AUTHOR("Hiep Huynh");
119 MODULE_LICENSE("GPL");
120 MODULE_SUPPORTED_DEVICE("{{Conexant,25821}"); /* "{{Conexant,23881}," */
122 static unsigned int debug
;
123 module_param(debug
, int, 0644);
124 MODULE_PARM_DESC(debug
, "enable debug messages");
126 /****************************************************************************
127 Module specific funtions
128 ****************************************************************************/
129 /* Constants taken from cx88-reg.h */
130 #define AUD_INT_DN_RISCI1 (1 << 0)
131 #define AUD_INT_UP_RISCI1 (1 << 1)
132 #define AUD_INT_RDS_DN_RISCI1 (1 << 2)
133 #define AUD_INT_DN_RISCI2 (1 << 4) /* yes, 3 is skipped */
134 #define AUD_INT_UP_RISCI2 (1 << 5)
135 #define AUD_INT_RDS_DN_RISCI2 (1 << 6)
136 #define AUD_INT_DN_SYNC (1 << 12)
137 #define AUD_INT_UP_SYNC (1 << 13)
138 #define AUD_INT_RDS_DN_SYNC (1 << 14)
139 #define AUD_INT_OPC_ERR (1 << 16)
140 #define AUD_INT_BER_IRQ (1 << 20)
141 #define AUD_INT_MCHG_IRQ (1 << 21)
142 #define GP_COUNT_CONTROL_RESET 0x3
144 #define PCI_MSK_AUD_EXT (1 << 4)
145 #define PCI_MSK_AUD_INT (1 << 3)
147 * BOARD Specific: Sets audio DMA
150 static int _cx25821_start_audio_dma(struct cx25821_audio_dev
*chip
)
152 struct cx25821_audio_buffer
*buf
= chip
->buf
;
153 struct cx25821_dev
*dev
= chip
->dev
;
154 struct sram_channel
*audio_ch
=
155 &cx25821_sram_channels
[AUDIO_SRAM_CHANNEL
];
158 /* enable output on the GPIO 0 for the MCLK ADC (Audio) */
159 cx25821_set_gpiopin_direction(chip
->dev
, 0, 0);
161 /* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
162 cx_clear(AUD_INT_DMA_CTL
,
163 FLD_AUD_DST_A_RISC_EN
| FLD_AUD_DST_A_FIFO_EN
);
165 /* setup fifo + format - out channel */
166 cx25821_sram_channel_setup_audio(chip
->dev
, audio_ch
, buf
->bpl
,
170 cx_write(AUD_A_LNGTH
, buf
->bpl
);
173 /* GP_COUNT_CONTROL_RESET = 0x3 */
174 cx_write(AUD_A_GPCNT_CTL
, GP_COUNT_CONTROL_RESET
);
175 atomic_set(&chip
->count
, 0);
177 /* Set the input mode to 16-bit */
178 tmp
= cx_read(AUD_A_CFG
);
179 cx_write(AUD_A_CFG
, tmp
| FLD_AUD_DST_PK_MODE
| FLD_AUD_DST_ENABLE
|
183 pr_info("DEBUG: Start audio DMA, %d B/line, cmds_start(0x%x)= %d lines/FIFO, %d periods, %d byte buffer\n",
184 buf->bpl, audio_ch->cmds_start,
185 cx_read(audio_ch->cmds_start + 12)>>1,
186 chip->num_periods, buf->bpl * chip->num_periods);
189 /* Enables corresponding bits at AUD_INT_STAT */
190 cx_write(AUD_A_INT_MSK
, FLD_AUD_DST_RISCI1
| FLD_AUD_DST_OF
|
191 FLD_AUD_DST_SYNC
| FLD_AUD_DST_OPC_ERR
);
193 /* Clean any pending interrupt bits already set */
194 cx_write(AUD_A_INT_STAT
, ~0);
196 /* enable audio irqs */
197 cx_set(PCI_INT_MSK
, chip
->dev
->pci_irqmask
| PCI_MSK_AUD_INT
);
199 /* Turn on audio downstream fifo and risc enable 0x101 */
200 tmp
= cx_read(AUD_INT_DMA_CTL
);
201 cx_set(AUD_INT_DMA_CTL
, tmp
|
202 (FLD_AUD_DST_A_RISC_EN
| FLD_AUD_DST_A_FIFO_EN
));
209 * BOARD Specific: Resets audio DMA
211 static int _cx25821_stop_audio_dma(struct cx25821_audio_dev
*chip
)
213 struct cx25821_dev
*dev
= chip
->dev
;
216 cx_clear(AUD_INT_DMA_CTL
,
217 FLD_AUD_DST_A_RISC_EN
| FLD_AUD_DST_A_FIFO_EN
);
220 cx_clear(PCI_INT_MSK
, PCI_MSK_AUD_INT
);
221 cx_clear(AUD_A_INT_MSK
, AUD_INT_OPC_ERR
| AUD_INT_DN_SYNC
|
222 AUD_INT_DN_RISCI2
| AUD_INT_DN_RISCI1
);
227 #define MAX_IRQ_LOOP 50
230 * BOARD Specific: IRQ dma bits
232 static char *cx25821_aud_irqs
[32] = {
233 "dn_risci1", "up_risci1", "rds_dn_risc1", /* 0-2 */
235 "dn_risci2", "up_risci2", "rds_dn_risc2", /* 4-6 */
237 "dnf_of", "upf_uf", "rds_dnf_uf", /* 8-10 */
239 "dn_sync", "up_sync", "rds_dn_sync", /* 12-14 */
241 "opc_err", "par_err", "rip_err", /* 16-18 */
242 "pci_abort", "ber_irq", "mchg_irq" /* 19-21 */
246 * BOARD Specific: Threats IRQ audio specific calls
248 static void cx25821_aud_irq(struct cx25821_audio_dev
*chip
, u32 status
,
251 struct cx25821_dev
*dev
= chip
->dev
;
253 if (0 == (status
& mask
))
256 cx_write(AUD_A_INT_STAT
, status
);
257 if (debug
> 1 || (status
& mask
& ~0xff))
258 cx25821_print_irqbits(dev
->name
, "irq aud", cx25821_aud_irqs
,
259 ARRAY_SIZE(cx25821_aud_irqs
), status
, mask
);
261 /* risc op code error */
262 if (status
& AUD_INT_OPC_ERR
) {
263 pr_warn("WARNING %s/1: Audio risc op code error\n", dev
->name
);
265 cx_clear(AUD_INT_DMA_CTL
,
266 FLD_AUD_DST_A_RISC_EN
| FLD_AUD_DST_A_FIFO_EN
);
267 cx25821_sram_channel_dump_audio(dev
,
268 &cx25821_sram_channels
[AUDIO_SRAM_CHANNEL
]);
270 if (status
& AUD_INT_DN_SYNC
) {
271 pr_warn("WARNING %s: Downstream sync error!\n", dev
->name
);
272 cx_write(AUD_A_GPCNT_CTL
, GP_COUNT_CONTROL_RESET
);
276 /* risc1 downstream */
277 if (status
& AUD_INT_DN_RISCI1
) {
278 atomic_set(&chip
->count
, cx_read(AUD_A_GPCNT
));
279 snd_pcm_period_elapsed(chip
->substream
);
284 * BOARD Specific: Handles IRQ calls
286 static irqreturn_t
cx25821_irq(int irq
, void *dev_id
)
288 struct cx25821_audio_dev
*chip
= dev_id
;
289 struct cx25821_dev
*dev
= chip
->dev
;
290 u32 status
, pci_status
;
291 u32 audint_status
, audint_mask
;
292 int loop
, handled
= 0;
293 int audint_count
= 0;
295 audint_status
= cx_read(AUD_A_INT_STAT
);
296 audint_mask
= cx_read(AUD_A_INT_MSK
);
297 audint_count
= cx_read(AUD_A_GPCNT
);
298 status
= cx_read(PCI_INT_STAT
);
300 for (loop
= 0; loop
< 1; loop
++) {
301 status
= cx_read(PCI_INT_STAT
);
303 status
= cx_read(PCI_INT_STAT
);
304 audint_status
= cx_read(AUD_A_INT_STAT
);
305 audint_mask
= cx_read(AUD_A_INT_MSK
);
309 cx_write(PCI_INT_STAT
, status
);
311 cx25821_aud_irq(chip
, audint_status
,
320 cx_write(PCI_INT_STAT
, status
);
322 cx25821_aud_irq(chip
, audint_status
, audint_mask
);
325 pci_status
= cx_read(PCI_INT_STAT
);
328 cx_write(PCI_INT_STAT
, pci_status
);
331 return IRQ_RETVAL(handled
);
334 static int dsp_buffer_free(struct cx25821_audio_dev
*chip
)
336 BUG_ON(!chip
->dma_size
);
338 dprintk(2, "Freeing buffer\n");
339 videobuf_dma_unmap(&chip
->pci
->dev
, chip
->dma_risc
);
340 videobuf_dma_free(chip
->dma_risc
);
341 btcx_riscmem_free(chip
->pci
, &chip
->buf
->risc
);
344 chip
->dma_risc
= NULL
;
350 /****************************************************************************
352 ****************************************************************************/
355 * Digital hardware definition
357 #define DEFAULT_FIFO_SIZE 384
358 static struct snd_pcm_hardware snd_cx25821_digital_hw
= {
359 .info
= SNDRV_PCM_INFO_MMAP
| SNDRV_PCM_INFO_INTERLEAVED
|
360 SNDRV_PCM_INFO_BLOCK_TRANSFER
| SNDRV_PCM_INFO_MMAP_VALID
,
361 .formats
= SNDRV_PCM_FMTBIT_S16_LE
,
363 .rates
= SNDRV_PCM_RATE_48000
,
368 /* Analog audio output will be full of clicks and pops if there
369 are not exactly four lines in the SRAM FIFO buffer. */
370 .period_bytes_min
= DEFAULT_FIFO_SIZE
/ 3,
371 .period_bytes_max
= DEFAULT_FIFO_SIZE
/ 3,
373 .periods_max
= AUDIO_LINE_SIZE
,
374 /* 128 * 128 = 16384 = 1024 * 16 */
375 .buffer_bytes_max
= (AUDIO_LINE_SIZE
* AUDIO_LINE_SIZE
),
379 * audio pcm capture open callback
381 static int snd_cx25821_pcm_open(struct snd_pcm_substream
*substream
)
383 struct cx25821_audio_dev
*chip
= snd_pcm_substream_chip(substream
);
384 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
386 unsigned int bpl
= 0;
389 pr_err("DEBUG: cx25821 can't find device struct. Can't proceed with open\n");
393 err
= snd_pcm_hw_constraint_pow2(runtime
, 0,
394 SNDRV_PCM_HW_PARAM_PERIODS
);
398 chip
->substream
= substream
;
400 runtime
->hw
= snd_cx25821_digital_hw
;
402 if (cx25821_sram_channels
[AUDIO_SRAM_CHANNEL
].fifo_size
!=
404 /* since there are 3 audio Clusters */
405 bpl
= cx25821_sram_channels
[AUDIO_SRAM_CHANNEL
].fifo_size
/ 3;
406 bpl
&= ~7; /* must be multiple of 8 */
408 if (bpl
> AUDIO_LINE_SIZE
)
409 bpl
= AUDIO_LINE_SIZE
;
411 runtime
->hw
.period_bytes_min
= bpl
;
412 runtime
->hw
.period_bytes_max
= bpl
;
417 dprintk(1, "Error opening PCM!\n");
422 * audio close callback
424 static int snd_cx25821_close(struct snd_pcm_substream
*substream
)
432 static int snd_cx25821_hw_params(struct snd_pcm_substream
*substream
,
433 struct snd_pcm_hw_params
*hw_params
)
435 struct cx25821_audio_dev
*chip
= snd_pcm_substream_chip(substream
);
436 struct videobuf_dmabuf
*dma
;
438 struct cx25821_audio_buffer
*buf
;
441 if (substream
->runtime
->dma_area
) {
442 dsp_buffer_free(chip
);
443 substream
->runtime
->dma_area
= NULL
;
446 chip
->period_size
= params_period_bytes(hw_params
);
447 chip
->num_periods
= params_periods(hw_params
);
448 chip
->dma_size
= chip
->period_size
* params_periods(hw_params
);
450 BUG_ON(!chip
->dma_size
);
451 BUG_ON(chip
->num_periods
& (chip
->num_periods
- 1));
453 buf
= kzalloc(sizeof(*buf
), GFP_KERNEL
);
457 if (chip
->period_size
> AUDIO_LINE_SIZE
)
458 chip
->period_size
= AUDIO_LINE_SIZE
;
460 buf
->bpl
= chip
->period_size
;
463 videobuf_dma_init(dma
);
464 ret
= videobuf_dma_init_kernel(dma
, PCI_DMA_FROMDEVICE
,
465 (PAGE_ALIGN(chip
->dma_size
) >> PAGE_SHIFT
));
469 ret
= videobuf_dma_map(&chip
->pci
->dev
, dma
);
473 ret
= cx25821_risc_databuffer_audio(chip
->pci
, &buf
->risc
, dma
->sglist
,
474 chip
->period_size
, chip
->num_periods
, 1);
476 pr_info("DEBUG: ERROR after cx25821_risc_databuffer_audio()\n");
480 /* Loop back to start of program */
481 buf
->risc
.jmp
[0] = cpu_to_le32(RISC_JUMP
| RISC_IRQ1
| RISC_CNT_INC
);
482 buf
->risc
.jmp
[1] = cpu_to_le32(buf
->risc
.dma
);
483 buf
->risc
.jmp
[2] = cpu_to_le32(0); /* bits 63-32 */
486 chip
->dma_risc
= dma
;
488 substream
->runtime
->dma_area
= chip
->dma_risc
->vaddr
;
489 substream
->runtime
->dma_bytes
= chip
->dma_size
;
490 substream
->runtime
->dma_addr
= 0;
502 static int snd_cx25821_hw_free(struct snd_pcm_substream
*substream
)
504 struct cx25821_audio_dev
*chip
= snd_pcm_substream_chip(substream
);
506 if (substream
->runtime
->dma_area
) {
507 dsp_buffer_free(chip
);
508 substream
->runtime
->dma_area
= NULL
;
517 static int snd_cx25821_prepare(struct snd_pcm_substream
*substream
)
525 static int snd_cx25821_card_trigger(struct snd_pcm_substream
*substream
,
528 struct cx25821_audio_dev
*chip
= snd_pcm_substream_chip(substream
);
531 /* Local interrupts are already disabled by ALSA */
532 spin_lock(&chip
->reg_lock
);
535 case SNDRV_PCM_TRIGGER_START
:
536 err
= _cx25821_start_audio_dma(chip
);
538 case SNDRV_PCM_TRIGGER_STOP
:
539 err
= _cx25821_stop_audio_dma(chip
);
546 spin_unlock(&chip
->reg_lock
);
554 static snd_pcm_uframes_t
snd_cx25821_pointer(struct snd_pcm_substream
557 struct cx25821_audio_dev
*chip
= snd_pcm_substream_chip(substream
);
558 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
561 count
= atomic_read(&chip
->count
);
563 return runtime
->period_size
* (count
& (runtime
->periods
- 1));
567 * page callback (needed for mmap)
569 static struct page
*snd_cx25821_page(struct snd_pcm_substream
*substream
,
570 unsigned long offset
)
572 void *pageptr
= substream
->runtime
->dma_area
+ offset
;
574 return vmalloc_to_page(pageptr
);
580 static struct snd_pcm_ops snd_cx25821_pcm_ops
= {
581 .open
= snd_cx25821_pcm_open
,
582 .close
= snd_cx25821_close
,
583 .ioctl
= snd_pcm_lib_ioctl
,
584 .hw_params
= snd_cx25821_hw_params
,
585 .hw_free
= snd_cx25821_hw_free
,
586 .prepare
= snd_cx25821_prepare
,
587 .trigger
= snd_cx25821_card_trigger
,
588 .pointer
= snd_cx25821_pointer
,
589 .page
= snd_cx25821_page
,
593 * ALSA create a PCM device: Called when initializing the board.
594 * Sets up the name and hooks up the callbacks
596 static int snd_cx25821_pcm(struct cx25821_audio_dev
*chip
, int device
,
602 err
= snd_pcm_new(chip
->card
, name
, device
, 0, 1, &pcm
);
604 pr_info("ERROR: FAILED snd_pcm_new() in %s\n", __func__
);
607 pcm
->private_data
= chip
;
609 strcpy(pcm
->name
, name
);
610 snd_pcm_set_ops(pcm
, SNDRV_PCM_STREAM_CAPTURE
, &snd_cx25821_pcm_ops
);
615 /****************************************************************************
616 Basic Flow for Sound Devices
617 ****************************************************************************/
620 * PCI ID Table - 14f1:8801 and 14f1:8811 means function 1: Audio
621 * Only boards with eeprom and byte 1 at eeprom=1 have it
624 static DEFINE_PCI_DEVICE_TABLE(cx25821_audio_pci_tbl
) = {
625 {0x14f1, 0x0920, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0, 0},
629 MODULE_DEVICE_TABLE(pci
, cx25821_audio_pci_tbl
);
632 * Not used in the function snd_cx25821_dev_free so removing
636 static int snd_cx25821_free(struct cx25821_audio_dev *chip)
639 free_irq(chip->irq, chip);
641 cx25821_dev_unregister(chip->dev);
642 pci_disable_device(chip->pci);
649 * Component Destructor
651 static void snd_cx25821_dev_free(struct snd_card
*card
)
653 struct cx25821_audio_dev
*chip
= card
->private_data
;
655 /* snd_cx25821_free(chip); */
656 snd_card_free(chip
->card
);
660 * Alsa Constructor - Component probe
662 static int cx25821_audio_initdev(struct cx25821_dev
*dev
)
664 struct snd_card
*card
;
665 struct cx25821_audio_dev
*chip
;
668 if (devno
>= SNDRV_CARDS
) {
669 pr_info("DEBUG ERROR: devno >= SNDRV_CARDS %s\n", __func__
);
673 if (!enable
[devno
]) {
675 pr_info("DEBUG ERROR: !enable[devno] %s\n", __func__
);
679 err
= snd_card_create(index
[devno
], id
[devno
], THIS_MODULE
,
680 sizeof(struct cx25821_audio_dev
), &card
);
682 pr_info("DEBUG ERROR: cannot create snd_card_new in %s\n",
687 strcpy(card
->driver
, "cx25821");
689 /* Card "creation" */
690 card
->private_free
= snd_cx25821_dev_free
;
691 chip
= card
->private_data
;
692 spin_lock_init(&chip
->reg_lock
);
696 chip
->pci
= dev
->pci
;
697 chip
->iobase
= pci_resource_start(dev
->pci
, 0);
699 chip
->irq
= dev
->pci
->irq
;
701 err
= request_irq(dev
->pci
->irq
, cx25821_irq
,
702 IRQF_SHARED
, chip
->dev
->name
, chip
);
705 pr_err("ERROR %s: can't get IRQ %d for ALSA\n", chip
->dev
->name
,
710 err
= snd_cx25821_pcm(chip
, 0, "cx25821 Digital");
712 pr_info("DEBUG ERROR: cannot create snd_cx25821_pcm %s\n",
717 snd_card_set_dev(card
, &chip
->pci
->dev
);
719 strcpy(card
->shortname
, "cx25821");
720 sprintf(card
->longname
, "%s at 0x%lx irq %d", chip
->dev
->name
,
721 chip
->iobase
, chip
->irq
);
722 strcpy(card
->mixername
, "CX25821");
724 pr_info("%s/%i: ALSA support for cx25821 boards\n", card
->driver
,
727 err
= snd_card_register(card
);
729 pr_info("DEBUG ERROR: cannot register sound card %s\n",
734 snd_cx25821_cards
[devno
] = card
;
744 /****************************************************************************
746 ****************************************************************************/
747 static void cx25821_audio_fini(void)
749 snd_card_free(snd_cx25821_cards
[0]);
755 * Loops through present saa7134 cards, and assigns an ALSA device
759 static int cx25821_alsa_init(void)
761 struct cx25821_dev
*dev
= NULL
;
762 struct list_head
*list
;
764 mutex_lock(&cx25821_devlist_mutex
);
765 list_for_each(list
, &cx25821_devlist
) {
766 dev
= list_entry(list
, struct cx25821_dev
, devlist
);
767 cx25821_audio_initdev(dev
);
769 mutex_unlock(&cx25821_devlist_mutex
);
772 pr_info("ERROR ALSA: no cx25821 cards found\n");
778 late_initcall(cx25821_alsa_init
);
779 module_exit(cx25821_audio_fini
);
781 /* ----------------------------------------------------------- */