1 /*
2  *
3  *  Support for CX23885 analog audio capture
4  *
5  *    (c) 2008 Mijhail Moreyra <mijhail.moreyra@gmail.com>
6  *    Adapted from cx88-alsa.c
7  *    (c) 2009 Steven Toth <stoth@kernellabs.com>
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software
21  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  */
23 
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/device.h>
27 #include <linux/interrupt.h>
28 #include <linux/vmalloc.h>
29 #include <linux/dma-mapping.h>
30 #include <linux/pci.h>
31 
32 #include <asm/delay.h>
33 
34 #include <sound/core.h>
35 #include <sound/pcm.h>
36 #include <sound/pcm_params.h>
37 #include <sound/control.h>
38 #include <sound/initval.h>
39 
40 #include <sound/tlv.h>
41 
42 
43 #include "cx23885.h"
44 #include "cx23885-reg.h"
45 
46 #define AUDIO_SRAM_CHANNEL	SRAM_CH07
47 
48 #define dprintk(level, fmt, arg...)	if (audio_debug >= level) \
49 	printk(KERN_INFO "%s: " fmt, chip->dev->name , ## arg)
50 
51 #define dprintk_core(level, fmt, arg...)	if (audio_debug >= level) \
52 	printk(KERN_DEBUG "%s: " fmt, chip->dev->name , ## arg)
53 
54 /****************************************************************************
55 			Module global static vars
56  ****************************************************************************/
57 
58 static unsigned int disable_analog_audio;
59 module_param(disable_analog_audio, int, 0644);
60 MODULE_PARM_DESC(disable_analog_audio, "disable analog audio ALSA driver");
61 
62 static unsigned int audio_debug;
63 module_param(audio_debug, int, 0644);
64 MODULE_PARM_DESC(audio_debug, "enable debug messages [analog audio]");
65 
66 /****************************************************************************
67 			Board specific funtions
68  ****************************************************************************/
69 
70 /* Constants taken from cx88-reg.h */
71 #define AUD_INT_DN_RISCI1       (1 <<  0)
72 #define AUD_INT_UP_RISCI1       (1 <<  1)
73 #define AUD_INT_RDS_DN_RISCI1   (1 <<  2)
74 #define AUD_INT_DN_RISCI2       (1 <<  4) /* yes, 3 is skipped */
75 #define AUD_INT_UP_RISCI2       (1 <<  5)
76 #define AUD_INT_RDS_DN_RISCI2   (1 <<  6)
77 #define AUD_INT_DN_SYNC         (1 << 12)
78 #define AUD_INT_UP_SYNC         (1 << 13)
79 #define AUD_INT_RDS_DN_SYNC     (1 << 14)
80 #define AUD_INT_OPC_ERR         (1 << 16)
81 #define AUD_INT_BER_IRQ         (1 << 20)
82 #define AUD_INT_MCHG_IRQ        (1 << 21)
83 #define GP_COUNT_CONTROL_RESET	0x3
84 
85 /*
86  * BOARD Specific: Sets audio DMA
87  */
88 
89 static int cx23885_start_audio_dma(struct cx23885_audio_dev *chip)
90 {
91 	struct cx23885_audio_buffer *buf = chip->buf;
92 	struct cx23885_dev *dev  = chip->dev;
93 	struct sram_channel *audio_ch =
94 		&dev->sram_channels[AUDIO_SRAM_CHANNEL];
95 
96 	dprintk(1, "%s()\n", __func__);
97 
98 	/* Make sure RISC/FIFO are off before changing FIFO/RISC settings */
99 	cx_clear(AUD_INT_DMA_CTL, 0x11);
100 
101 	/* setup fifo + format - out channel */
102 	cx23885_sram_channel_setup(chip->dev, audio_ch, buf->bpl,
103 		buf->risc.dma);
104 
105 	/* sets bpl size */
106 	cx_write(AUD_INT_A_LNGTH, buf->bpl);
107 
108 	/* This is required to get good audio (1 seems to be ok) */
109 	cx_write(AUD_INT_A_MODE, 1);
110 
111 	/* reset counter */
112 	cx_write(AUD_INT_A_GPCNT_CTL, GP_COUNT_CONTROL_RESET);
113 	atomic_set(&chip->count, 0);
114 
115 	dprintk(1, "Start audio DMA, %d B/line, %d lines/FIFO, %d periods, %d "
116 		"byte buffer\n", buf->bpl, cx_read(audio_ch->cmds_start+12)>>1,
117 		chip->num_periods, buf->bpl * chip->num_periods);
118 
119 	/* Enables corresponding bits at AUD_INT_STAT */
120 	cx_write(AUDIO_INT_INT_MSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
121 				    AUD_INT_DN_RISCI1);
122 
123 	/* Clean any pending interrupt bits already set */
124 	cx_write(AUDIO_INT_INT_STAT, ~0);
125 
126 	/* enable audio irqs */
127 	cx_set(PCI_INT_MSK, chip->dev->pci_irqmask | PCI_MSK_AUD_INT);
128 
129 	/* start dma */
130 	cx_set(DEV_CNTRL2, (1<<5)); /* Enables Risc Processor */
131 	cx_set(AUD_INT_DMA_CTL, 0x11); /* audio downstream FIFO and
132 					  RISC enable */
133 	if (audio_debug)
134 		cx23885_sram_channel_dump(chip->dev, audio_ch);
135 
136 	return 0;
137 }
138 
139 /*
140  * BOARD Specific: Resets audio DMA
141  */
142 static int cx23885_stop_audio_dma(struct cx23885_audio_dev *chip)
143 {
144 	struct cx23885_dev *dev = chip->dev;
145 	dprintk(1, "Stopping audio DMA\n");
146 
147 	/* stop dma */
148 	cx_clear(AUD_INT_DMA_CTL, 0x11);
149 
150 	/* disable irqs */
151 	cx_clear(PCI_INT_MSK, PCI_MSK_AUD_INT);
152 	cx_clear(AUDIO_INT_INT_MSK, AUD_INT_OPC_ERR | AUD_INT_DN_SYNC |
153 				    AUD_INT_DN_RISCI1);
154 
155 	if (audio_debug)
156 		cx23885_sram_channel_dump(chip->dev,
157 			&dev->sram_channels[AUDIO_SRAM_CHANNEL]);
158 
159 	return 0;
160 }
161 
162 /*
163  * BOARD Specific: Handles audio IRQ
164  */
165 int cx23885_audio_irq(struct cx23885_dev *dev, u32 status, u32 mask)
166 {
167 	struct cx23885_audio_dev *chip = dev->audio_dev;
168 
169 	if (0 == (status & mask))
170 		return 0;
171 
172 	cx_write(AUDIO_INT_INT_STAT, status);
173 
174 	/* risc op code error */
175 	if (status & AUD_INT_OPC_ERR) {
176 		printk(KERN_WARNING "%s/1: Audio risc op code error\n",
177 			dev->name);
178 		cx_clear(AUD_INT_DMA_CTL, 0x11);
179 		cx23885_sram_channel_dump(dev,
180 			&dev->sram_channels[AUDIO_SRAM_CHANNEL]);
181 	}
182 	if (status & AUD_INT_DN_SYNC) {
183 		dprintk(1, "Downstream sync error\n");
184 		cx_write(AUD_INT_A_GPCNT_CTL, GP_COUNT_CONTROL_RESET);
185 		return 1;
186 	}
187 	/* risc1 downstream */
188 	if (status & AUD_INT_DN_RISCI1) {
189 		atomic_set(&chip->count, cx_read(AUD_INT_A_GPCNT));
190 		snd_pcm_period_elapsed(chip->substream);
191 	}
192 	/* FIXME: Any other status should deserve a special handling? */
193 
194 	return 1;
195 }
196 
197 static int dsp_buffer_free(struct cx23885_audio_dev *chip)
198 {
199 	BUG_ON(!chip->dma_size);
200 
201 	dprintk(2, "Freeing buffer\n");
202 	videobuf_dma_unmap(&chip->pci->dev, chip->dma_risc);
203 	videobuf_dma_free(chip->dma_risc);
204 	btcx_riscmem_free(chip->pci, &chip->buf->risc);
205 	kfree(chip->buf);
206 
207 	chip->dma_risc = NULL;
208 	chip->dma_size = 0;
209 
210 	return 0;
211 }
212 
213 /****************************************************************************
214 				ALSA PCM Interface
215  ****************************************************************************/
216 
217 /*
218  * Digital hardware definition
219  */
220 #define DEFAULT_FIFO_SIZE	4096
221 
222 static struct snd_pcm_hardware snd_cx23885_digital_hw = {
223 	.info = SNDRV_PCM_INFO_MMAP |
224 		SNDRV_PCM_INFO_INTERLEAVED |
225 		SNDRV_PCM_INFO_BLOCK_TRANSFER |
226 		SNDRV_PCM_INFO_MMAP_VALID,
227 	.formats = SNDRV_PCM_FMTBIT_S16_LE,
228 
229 	.rates =		SNDRV_PCM_RATE_48000,
230 	.rate_min =		48000,
231 	.rate_max =		48000,
232 	.channels_min = 2,
233 	.channels_max = 2,
234 	/* Analog audio output will be full of clicks and pops if there
235 	   are not exactly four lines in the SRAM FIFO buffer.  */
236 	.period_bytes_min = DEFAULT_FIFO_SIZE/4,
237 	.period_bytes_max = DEFAULT_FIFO_SIZE/4,
238 	.periods_min = 1,
239 	.periods_max = 1024,
240 	.buffer_bytes_max = (1024*1024),
241 };
242 
243 /*
244  * audio pcm capture open callback
245  */
246 static int snd_cx23885_pcm_open(struct snd_pcm_substream *substream)
247 {
248 	struct cx23885_audio_dev *chip = snd_pcm_substream_chip(substream);
249 	struct snd_pcm_runtime *runtime = substream->runtime;
250 	int err;
251 
252 	if (!chip) {
253 		printk(KERN_ERR "BUG: cx23885 can't find device struct."
254 				" Can't proceed with open\n");
255 		return -ENODEV;
256 	}
257 
258 	err = snd_pcm_hw_constraint_pow2(runtime, 0,
259 		SNDRV_PCM_HW_PARAM_PERIODS);
260 	if (err < 0)
261 		goto _error;
262 
263 	chip->substream = substream;
264 
265 	runtime->hw = snd_cx23885_digital_hw;
266 
267 	if (chip->dev->sram_channels[AUDIO_SRAM_CHANNEL].fifo_size !=
268 		DEFAULT_FIFO_SIZE) {
269 		unsigned int bpl = chip->dev->
270 			sram_channels[AUDIO_SRAM_CHANNEL].fifo_size / 4;
271 		bpl &= ~7; /* must be multiple of 8 */
272 		runtime->hw.period_bytes_min = bpl;
273 		runtime->hw.period_bytes_max = bpl;
274 	}
275 
276 	return 0;
277 _error:
278 	dprintk(1, "Error opening PCM!\n");
279 	return err;
280 }
281 
282 /*
283  * audio close callback
284  */
285 static int snd_cx23885_close(struct snd_pcm_substream *substream)
286 {
287 	return 0;
288 }
289 
290 /*
291  * hw_params callback
292  */
293 static int snd_cx23885_hw_params(struct snd_pcm_substream *substream,
294 			      struct snd_pcm_hw_params *hw_params)
295 {
296 	struct cx23885_audio_dev *chip = snd_pcm_substream_chip(substream);
297 	struct videobuf_dmabuf *dma;
298 
299 	struct cx23885_audio_buffer *buf;
300 	int ret;
301 
302 	if (substream->runtime->dma_area) {
303 		dsp_buffer_free(chip);
304 		substream->runtime->dma_area = NULL;
305 	}
306 
307 	chip->period_size = params_period_bytes(hw_params);
308 	chip->num_periods = params_periods(hw_params);
309 	chip->dma_size = chip->period_size * params_periods(hw_params);
310 
311 	BUG_ON(!chip->dma_size);
312 	BUG_ON(chip->num_periods & (chip->num_periods-1));
313 
314 	buf = kzalloc(sizeof(*buf), GFP_KERNEL);
315 	if (NULL == buf)
316 		return -ENOMEM;
317 
318 	buf->bpl = chip->period_size;
319 
320 	dma = &buf->dma;
321 	videobuf_dma_init(dma);
322 	ret = videobuf_dma_init_kernel(dma, PCI_DMA_FROMDEVICE,
323 			(PAGE_ALIGN(chip->dma_size) >> PAGE_SHIFT));
324 	if (ret < 0)
325 		goto error;
326 
327 	ret = videobuf_dma_map(&chip->pci->dev, dma);
328 	if (ret < 0)
329 		goto error;
330 
331 	ret = cx23885_risc_databuffer(chip->pci, &buf->risc, dma->sglist,
332 				   chip->period_size, chip->num_periods, 1);
333 	if (ret < 0)
334 		goto error;
335 
336 	/* Loop back to start of program */
337 	buf->risc.jmp[0] = cpu_to_le32(RISC_JUMP|RISC_IRQ1|RISC_CNT_INC);
338 	buf->risc.jmp[1] = cpu_to_le32(buf->risc.dma);
339 	buf->risc.jmp[2] = cpu_to_le32(0); /* bits 63-32 */
340 
341 	chip->buf = buf;
342 	chip->dma_risc = dma;
343 
344 	substream->runtime->dma_area = chip->dma_risc->vaddr;
345 	substream->runtime->dma_bytes = chip->dma_size;
346 	substream->runtime->dma_addr = 0;
347 
348 	return 0;
349 
350 error:
351 	kfree(buf);
352 	return ret;
353 }
354 
355 /*
356  * hw free callback
357  */
358 static int snd_cx23885_hw_free(struct snd_pcm_substream *substream)
359 {
360 
361 	struct cx23885_audio_dev *chip = snd_pcm_substream_chip(substream);
362 
363 	if (substream->runtime->dma_area) {
364 		dsp_buffer_free(chip);
365 		substream->runtime->dma_area = NULL;
366 	}
367 
368 	return 0;
369 }
370 
371 /*
372  * prepare callback
373  */
374 static int snd_cx23885_prepare(struct snd_pcm_substream *substream)
375 {
376 	return 0;
377 }
378 
379 /*
380  * trigger callback
381  */
382 static int snd_cx23885_card_trigger(struct snd_pcm_substream *substream,
383 	int cmd)
384 {
385 	struct cx23885_audio_dev *chip = snd_pcm_substream_chip(substream);
386 	int err;
387 
388 	/* Local interrupts are already disabled by ALSA */
389 	spin_lock(&chip->lock);
390 
391 	switch (cmd) {
392 	case SNDRV_PCM_TRIGGER_START:
393 		err = cx23885_start_audio_dma(chip);
394 		break;
395 	case SNDRV_PCM_TRIGGER_STOP:
396 		err = cx23885_stop_audio_dma(chip);
397 		break;
398 	default:
399 		err = -EINVAL;
400 		break;
401 	}
402 
403 	spin_unlock(&chip->lock);
404 
405 	return err;
406 }
407 
408 /*
409  * pointer callback
410  */
411 static snd_pcm_uframes_t snd_cx23885_pointer(
412 	struct snd_pcm_substream *substream)
413 {
414 	struct cx23885_audio_dev *chip = snd_pcm_substream_chip(substream);
415 	struct snd_pcm_runtime *runtime = substream->runtime;
416 	u16 count;
417 
418 	count = atomic_read(&chip->count);
419 
420 	return runtime->period_size * (count & (runtime->periods-1));
421 }
422 
423 /*
424  * page callback (needed for mmap)
425  */
426 static struct page *snd_cx23885_page(struct snd_pcm_substream *substream,
427 				unsigned long offset)
428 {
429 	void *pageptr = substream->runtime->dma_area + offset;
430 	return vmalloc_to_page(pageptr);
431 }
432 
433 /*
434  * operators
435  */
436 static struct snd_pcm_ops snd_cx23885_pcm_ops = {
437 	.open = snd_cx23885_pcm_open,
438 	.close = snd_cx23885_close,
439 	.ioctl = snd_pcm_lib_ioctl,
440 	.hw_params = snd_cx23885_hw_params,
441 	.hw_free = snd_cx23885_hw_free,
442 	.prepare = snd_cx23885_prepare,
443 	.trigger = snd_cx23885_card_trigger,
444 	.pointer = snd_cx23885_pointer,
445 	.page = snd_cx23885_page,
446 };
447 
448 /*
449  * create a PCM device
450  */
451 static int snd_cx23885_pcm(struct cx23885_audio_dev *chip, int device,
452 	char *name)
453 {
454 	int err;
455 	struct snd_pcm *pcm;
456 
457 	err = snd_pcm_new(chip->card, name, device, 0, 1, &pcm);
458 	if (err < 0)
459 		return err;
460 	pcm->private_data = chip;
461 	strcpy(pcm->name, name);
462 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_cx23885_pcm_ops);
463 
464 	return 0;
465 }
466 
467 /****************************************************************************
468 			Basic Flow for Sound Devices
469  ****************************************************************************/
470 
471 /*
472  * Alsa Constructor - Component probe
473  */
474 
475 struct cx23885_audio_dev *cx23885_audio_register(struct cx23885_dev *dev)
476 {
477 	struct snd_card *card;
478 	struct cx23885_audio_dev *chip;
479 	int err;
480 
481 	if (disable_analog_audio)
482 		return NULL;
483 
484 	if (dev->sram_channels[AUDIO_SRAM_CHANNEL].cmds_start == 0) {
485 		printk(KERN_WARNING "%s(): Missing SRAM channel configuration "
486 			"for analog TV Audio\n", __func__);
487 		return NULL;
488 	}
489 
490 	err = snd_card_create(SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
491 			THIS_MODULE, sizeof(struct cx23885_audio_dev), &card);
492 	if (err < 0)
493 		goto error;
494 
495 	chip = (struct cx23885_audio_dev *) card->private_data;
496 	chip->dev = dev;
497 	chip->pci = dev->pci;
498 	chip->card = card;
499 	spin_lock_init(&chip->lock);
500 
501 	snd_card_set_dev(card, &dev->pci->dev);
502 
503 	err = snd_cx23885_pcm(chip, 0, "CX23885 Digital");
504 	if (err < 0)
505 		goto error;
506 
507 	strcpy(card->driver, "CX23885");
508 	sprintf(card->shortname, "Conexant CX23885");
509 	sprintf(card->longname, "%s at %s", card->shortname, dev->name);
510 
511 	err = snd_card_register(card);
512 	if (err < 0)
513 		goto error;
514 
515 	dprintk(0, "registered ALSA audio device\n");
516 
517 	return chip;
518 
519 error:
520 	snd_card_free(card);
521 	printk(KERN_ERR "%s(): Failed to register analog "
522 			"audio adapter\n", __func__);
523 
524 	return NULL;
525 }
526 
527 /*
528  * ALSA destructor
529  */
530 void cx23885_audio_unregister(struct cx23885_dev *dev)
531 {
532 	struct cx23885_audio_dev *chip = dev->audio_dev;
533 
534 	snd_card_free(chip->card);
535 }
536