xref: /openbmc/linux/sound/spi/at73c213.c (revision f42b3800)
1 /*
2  * Driver for AT73C213 16-bit stereo DAC connected to Atmel SSC
3  *
4  * Copyright (C) 2006-2007 Atmel Norway
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License version 2 as published by
8  * the Free Software Foundation.
9  */
10 
11 /*#define DEBUG*/
12 
13 #include <linux/clk.h>
14 #include <linux/err.h>
15 #include <linux/delay.h>
16 #include <linux/device.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/mutex.h>
22 #include <linux/platform_device.h>
23 #include <linux/io.h>
24 
25 #include <sound/initval.h>
26 #include <sound/control.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 
30 #include <linux/atmel-ssc.h>
31 
32 #include <linux/spi/spi.h>
33 #include <linux/spi/at73c213.h>
34 
35 #include "at73c213.h"
36 
37 #define BITRATE_MIN	 8000 /* Hardware limit? */
38 #define BITRATE_TARGET	CONFIG_SND_AT73C213_TARGET_BITRATE
39 #define BITRATE_MAX	50000 /* Hardware limit. */
40 
41 /* Initial (hardware reset) AT73C213 register values. */
42 static u8 snd_at73c213_original_image[18] =
43 {
44 	0x00,	/* 00 - CTRL    */
45 	0x05,	/* 01 - LLIG    */
46 	0x05,	/* 02 - RLIG    */
47 	0x08,	/* 03 - LPMG    */
48 	0x08,	/* 04 - RPMG    */
49 	0x00,	/* 05 - LLOG    */
50 	0x00,	/* 06 - RLOG    */
51 	0x22,	/* 07 - OLC     */
52 	0x09,	/* 08 - MC      */
53 	0x00,	/* 09 - CSFC    */
54 	0x00,	/* 0A - MISC    */
55 	0x00,	/* 0B -         */
56 	0x00,	/* 0C - PRECH   */
57 	0x05,	/* 0D - AUXG    */
58 	0x00,	/* 0E -         */
59 	0x00,	/* 0F -         */
60 	0x00,	/* 10 - RST     */
61 	0x00,	/* 11 - PA_CTRL */
62 };
63 
64 struct snd_at73c213 {
65 	struct snd_card			*card;
66 	struct snd_pcm			*pcm;
67 	struct snd_pcm_substream	*substream;
68 	struct at73c213_board_info	*board;
69 	int				irq;
70 	int				period;
71 	unsigned long			bitrate;
72 	struct clk			*bitclk;
73 	struct ssc_device		*ssc;
74 	struct spi_device		*spi;
75 	u8				spi_wbuffer[2];
76 	u8				spi_rbuffer[2];
77 	/* Image of the SPI registers in AT73C213. */
78 	u8				reg_image[18];
79 	/* Protect SSC registers against concurrent access. */
80 	spinlock_t			lock;
81 	/* Protect mixer registers against concurrent access. */
82 	struct mutex			mixer_lock;
83 };
84 
85 #define get_chip(card) ((struct snd_at73c213 *)card->private_data)
86 
87 static int
88 snd_at73c213_write_reg(struct snd_at73c213 *chip, u8 reg, u8 val)
89 {
90 	struct spi_message msg;
91 	struct spi_transfer msg_xfer = {
92 		.len		= 2,
93 		.cs_change	= 0,
94 	};
95 	int retval;
96 
97 	spi_message_init(&msg);
98 
99 	chip->spi_wbuffer[0] = reg;
100 	chip->spi_wbuffer[1] = val;
101 
102 	msg_xfer.tx_buf = chip->spi_wbuffer;
103 	msg_xfer.rx_buf = chip->spi_rbuffer;
104 	spi_message_add_tail(&msg_xfer, &msg);
105 
106 	retval = spi_sync(chip->spi, &msg);
107 
108 	if (!retval)
109 		chip->reg_image[reg] = val;
110 
111 	return retval;
112 }
113 
114 static struct snd_pcm_hardware snd_at73c213_playback_hw = {
115 	.info		= SNDRV_PCM_INFO_INTERLEAVED |
116 			  SNDRV_PCM_INFO_BLOCK_TRANSFER,
117 	.formats	= SNDRV_PCM_FMTBIT_S16_BE,
118 	.rates		= SNDRV_PCM_RATE_CONTINUOUS,
119 	.rate_min	= 8000,  /* Replaced by chip->bitrate later. */
120 	.rate_max	= 50000, /* Replaced by chip->bitrate later. */
121 	.channels_min	= 2,
122 	.channels_max	= 2,
123 	.buffer_bytes_max = 64 * 1024 - 1,
124 	.period_bytes_min = 512,
125 	.period_bytes_max = 64 * 1024 - 1,
126 	.periods_min	= 4,
127 	.periods_max	= 1024,
128 };
129 
130 /*
131  * Calculate and set bitrate and divisions.
132  */
133 static int snd_at73c213_set_bitrate(struct snd_at73c213 *chip)
134 {
135 	unsigned long ssc_rate = clk_get_rate(chip->ssc->clk);
136 	unsigned long dac_rate_new, ssc_div, status;
137 	unsigned long ssc_div_max, ssc_div_min;
138 	int max_tries;
139 
140 	/*
141 	 * We connect two clocks here, picking divisors so the I2S clocks
142 	 * out data at the same rate the DAC clocks it in ... and as close
143 	 * as practical to the desired target rate.
144 	 *
145 	 * The DAC master clock (MCLK) is programmable, and is either 256
146 	 * or (not here) 384 times the I2S output clock (BCLK).
147 	 */
148 
149 	/* SSC clock / (bitrate * stereo * 16-bit). */
150 	ssc_div = ssc_rate / (BITRATE_TARGET * 2 * 16);
151 	ssc_div_min = ssc_rate / (BITRATE_MAX * 2 * 16);
152 	ssc_div_max = ssc_rate / (BITRATE_MIN * 2 * 16);
153 	max_tries = (ssc_div_max - ssc_div_min) / 2;
154 
155 	if (max_tries < 1)
156 		max_tries = 1;
157 
158 	/* ssc_div must be a power of 2. */
159 	ssc_div = (ssc_div + 1) & ~1UL;
160 
161 	if ((ssc_rate / (ssc_div * 2 * 16)) < BITRATE_MIN) {
162 		ssc_div -= 2;
163 		if ((ssc_rate / (ssc_div * 2 * 16)) > BITRATE_MAX)
164 			return -ENXIO;
165 	}
166 
167 	/* Search for a possible bitrate. */
168 	do {
169 		/* SSC clock / (ssc divider * 16-bit * stereo). */
170 		if ((ssc_rate / (ssc_div * 2 * 16)) < BITRATE_MIN)
171 			return -ENXIO;
172 
173 		/* 256 / (2 * 16) = 8 */
174 		dac_rate_new = 8 * (ssc_rate / ssc_div);
175 
176 		status = clk_round_rate(chip->board->dac_clk, dac_rate_new);
177 		if (status < 0)
178 			return status;
179 
180 		/* Ignore difference smaller than 256 Hz. */
181 		if ((status/256) == (dac_rate_new/256))
182 			goto set_rate;
183 
184 		ssc_div += 2;
185 	} while (--max_tries);
186 
187 	/* Not able to find a valid bitrate. */
188 	return -ENXIO;
189 
190 set_rate:
191 	status = clk_set_rate(chip->board->dac_clk, status);
192 	if (status < 0)
193 		return status;
194 
195 	/* Set divider in SSC device. */
196 	ssc_writel(chip->ssc->regs, CMR, ssc_div/2);
197 
198 	/* SSC clock / (ssc divider * 16-bit * stereo). */
199 	chip->bitrate = ssc_rate / (ssc_div * 16 * 2);
200 
201 	dev_info(&chip->spi->dev,
202 			"at73c213: supported bitrate is %lu (%lu divider)\n",
203 			chip->bitrate, ssc_div);
204 
205 	return 0;
206 }
207 
208 static int snd_at73c213_pcm_open(struct snd_pcm_substream *substream)
209 {
210 	struct snd_at73c213 *chip = snd_pcm_substream_chip(substream);
211 	struct snd_pcm_runtime *runtime = substream->runtime;
212 
213 	snd_at73c213_playback_hw.rate_min = chip->bitrate;
214 	snd_at73c213_playback_hw.rate_max = chip->bitrate;
215 	runtime->hw = snd_at73c213_playback_hw;
216 	chip->substream = substream;
217 
218 	return 0;
219 }
220 
221 static int snd_at73c213_pcm_close(struct snd_pcm_substream *substream)
222 {
223 	struct snd_at73c213 *chip = snd_pcm_substream_chip(substream);
224 	chip->substream = NULL;
225 	return 0;
226 }
227 
228 static int snd_at73c213_pcm_hw_params(struct snd_pcm_substream *substream,
229 				 struct snd_pcm_hw_params *hw_params)
230 {
231 	return snd_pcm_lib_malloc_pages(substream,
232 					params_buffer_bytes(hw_params));
233 }
234 
235 static int snd_at73c213_pcm_hw_free(struct snd_pcm_substream *substream)
236 {
237 	return snd_pcm_lib_free_pages(substream);
238 }
239 
240 static int snd_at73c213_pcm_prepare(struct snd_pcm_substream *substream)
241 {
242 	struct snd_at73c213 *chip = snd_pcm_substream_chip(substream);
243 	struct snd_pcm_runtime *runtime = substream->runtime;
244 	int block_size;
245 
246 	block_size = frames_to_bytes(runtime, runtime->period_size);
247 
248 	chip->period = 0;
249 
250 	ssc_writel(chip->ssc->regs, PDC_TPR,
251 			(long)runtime->dma_addr);
252 	ssc_writel(chip->ssc->regs, PDC_TCR, runtime->period_size * 2);
253 	ssc_writel(chip->ssc->regs, PDC_TNPR,
254 			(long)runtime->dma_addr + block_size);
255 	ssc_writel(chip->ssc->regs, PDC_TNCR, runtime->period_size * 2);
256 
257 	return 0;
258 }
259 
260 static int snd_at73c213_pcm_trigger(struct snd_pcm_substream *substream,
261 				   int cmd)
262 {
263 	struct snd_at73c213 *chip = snd_pcm_substream_chip(substream);
264 	int retval = 0;
265 
266 	spin_lock(&chip->lock);
267 
268 	switch (cmd) {
269 	case SNDRV_PCM_TRIGGER_START:
270 		ssc_writel(chip->ssc->regs, IER, SSC_BIT(IER_ENDTX));
271 		ssc_writel(chip->ssc->regs, PDC_PTCR, SSC_BIT(PDC_PTCR_TXTEN));
272 		break;
273 	case SNDRV_PCM_TRIGGER_STOP:
274 		ssc_writel(chip->ssc->regs, PDC_PTCR, SSC_BIT(PDC_PTCR_TXTDIS));
275 		ssc_writel(chip->ssc->regs, IDR, SSC_BIT(IDR_ENDTX));
276 		break;
277 	default:
278 		dev_dbg(&chip->spi->dev, "spurious command %x\n", cmd);
279 		retval = -EINVAL;
280 		break;
281 	}
282 
283 	spin_unlock(&chip->lock);
284 
285 	return retval;
286 }
287 
288 static snd_pcm_uframes_t
289 snd_at73c213_pcm_pointer(struct snd_pcm_substream *substream)
290 {
291 	struct snd_at73c213 *chip = snd_pcm_substream_chip(substream);
292 	struct snd_pcm_runtime *runtime = substream->runtime;
293 	snd_pcm_uframes_t pos;
294 	unsigned long bytes;
295 
296 	bytes = ssc_readl(chip->ssc->regs, PDC_TPR)
297 		- (unsigned long)runtime->dma_addr;
298 
299 	pos = bytes_to_frames(runtime, bytes);
300 	if (pos >= runtime->buffer_size)
301 		pos -= runtime->buffer_size;
302 
303 	return pos;
304 }
305 
306 static struct snd_pcm_ops at73c213_playback_ops = {
307 	.open		= snd_at73c213_pcm_open,
308 	.close		= snd_at73c213_pcm_close,
309 	.ioctl		= snd_pcm_lib_ioctl,
310 	.hw_params	= snd_at73c213_pcm_hw_params,
311 	.hw_free	= snd_at73c213_pcm_hw_free,
312 	.prepare	= snd_at73c213_pcm_prepare,
313 	.trigger	= snd_at73c213_pcm_trigger,
314 	.pointer	= snd_at73c213_pcm_pointer,
315 };
316 
317 static void snd_at73c213_pcm_free(struct snd_pcm *pcm)
318 {
319 	struct snd_at73c213 *chip = snd_pcm_chip(pcm);
320 	if (chip->pcm) {
321 		snd_pcm_lib_preallocate_free_for_all(chip->pcm);
322 		chip->pcm = NULL;
323 	}
324 }
325 
326 static int __devinit snd_at73c213_pcm_new(struct snd_at73c213 *chip, int device)
327 {
328 	struct snd_pcm *pcm;
329 	int retval;
330 
331 	retval = snd_pcm_new(chip->card, chip->card->shortname,
332 			device, 1, 0, &pcm);
333 	if (retval < 0)
334 		goto out;
335 
336 	pcm->private_data = chip;
337 	pcm->private_free = snd_at73c213_pcm_free;
338 	pcm->info_flags = SNDRV_PCM_INFO_BLOCK_TRANSFER;
339 	strcpy(pcm->name, "at73c213");
340 	chip->pcm = pcm;
341 
342 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &at73c213_playback_ops);
343 
344 	retval = snd_pcm_lib_preallocate_pages_for_all(chip->pcm,
345 			SNDRV_DMA_TYPE_DEV, &chip->ssc->pdev->dev,
346 			64 * 1024, 64 * 1024);
347 out:
348 	return retval;
349 }
350 
351 static irqreturn_t snd_at73c213_interrupt(int irq, void *dev_id)
352 {
353 	struct snd_at73c213 *chip = dev_id;
354 	struct snd_pcm_runtime *runtime = chip->substream->runtime;
355 	u32 status;
356 	int offset;
357 	int block_size;
358 	int next_period;
359 	int retval = IRQ_NONE;
360 
361 	spin_lock(&chip->lock);
362 
363 	block_size = frames_to_bytes(runtime, runtime->period_size);
364 	status = ssc_readl(chip->ssc->regs, IMR);
365 
366 	if (status & SSC_BIT(IMR_ENDTX)) {
367 		chip->period++;
368 		if (chip->period == runtime->periods)
369 			chip->period = 0;
370 		next_period = chip->period + 1;
371 		if (next_period == runtime->periods)
372 			next_period = 0;
373 
374 		offset = block_size * next_period;
375 
376 		ssc_writel(chip->ssc->regs, PDC_TNPR,
377 				(long)runtime->dma_addr + offset);
378 		ssc_writel(chip->ssc->regs, PDC_TNCR, runtime->period_size * 2);
379 		retval = IRQ_HANDLED;
380 	}
381 
382 	ssc_readl(chip->ssc->regs, IMR);
383 	spin_unlock(&chip->lock);
384 
385 	if (status & SSC_BIT(IMR_ENDTX))
386 		snd_pcm_period_elapsed(chip->substream);
387 
388 	return retval;
389 }
390 
391 /*
392  * Mixer functions.
393  */
394 static int snd_at73c213_mono_get(struct snd_kcontrol *kcontrol,
395 				 struct snd_ctl_elem_value *ucontrol)
396 {
397 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
398 	int reg = kcontrol->private_value & 0xff;
399 	int shift = (kcontrol->private_value >> 8) & 0xff;
400 	int mask = (kcontrol->private_value >> 16) & 0xff;
401 	int invert = (kcontrol->private_value >> 24) & 0xff;
402 
403 	mutex_lock(&chip->mixer_lock);
404 
405 	ucontrol->value.integer.value[0] =
406 		(chip->reg_image[reg] >> shift) & mask;
407 
408 	if (invert)
409 		ucontrol->value.integer.value[0] =
410 			mask - ucontrol->value.integer.value[0];
411 
412 	mutex_unlock(&chip->mixer_lock);
413 
414 	return 0;
415 }
416 
417 static int snd_at73c213_mono_put(struct snd_kcontrol *kcontrol,
418 				 struct snd_ctl_elem_value *ucontrol)
419 {
420 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
421 	int reg = kcontrol->private_value & 0xff;
422 	int shift = (kcontrol->private_value >> 8) & 0xff;
423 	int mask = (kcontrol->private_value >> 16) & 0xff;
424 	int invert = (kcontrol->private_value >> 24) & 0xff;
425 	int change, retval;
426 	unsigned short val;
427 
428 	val = (ucontrol->value.integer.value[0] & mask);
429 	if (invert)
430 		val = mask - val;
431 	val <<= shift;
432 
433 	mutex_lock(&chip->mixer_lock);
434 
435 	val = (chip->reg_image[reg] & ~(mask << shift)) | val;
436 	change = val != chip->reg_image[reg];
437 	retval = snd_at73c213_write_reg(chip, reg, val);
438 
439 	mutex_unlock(&chip->mixer_lock);
440 
441 	if (retval)
442 		return retval;
443 
444 	return change;
445 }
446 
447 static int snd_at73c213_stereo_info(struct snd_kcontrol *kcontrol,
448 				  struct snd_ctl_elem_info *uinfo)
449 {
450 	int mask = (kcontrol->private_value >> 24) & 0xff;
451 
452 	if (mask == 1)
453 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
454 	else
455 		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
456 
457 	uinfo->count = 2;
458 	uinfo->value.integer.min = 0;
459 	uinfo->value.integer.max = mask;
460 
461 	return 0;
462 }
463 
464 static int snd_at73c213_stereo_get(struct snd_kcontrol *kcontrol,
465 				 struct snd_ctl_elem_value *ucontrol)
466 {
467 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
468 	int left_reg = kcontrol->private_value & 0xff;
469 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
470 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
471 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
472 	int mask = (kcontrol->private_value >> 24) & 0xff;
473 	int invert = (kcontrol->private_value >> 22) & 1;
474 
475 	mutex_lock(&chip->mixer_lock);
476 
477 	ucontrol->value.integer.value[0] =
478 		(chip->reg_image[left_reg] >> shift_left) & mask;
479 	ucontrol->value.integer.value[1] =
480 		(chip->reg_image[right_reg] >> shift_right) & mask;
481 
482 	if (invert) {
483 		ucontrol->value.integer.value[0] =
484 			mask - ucontrol->value.integer.value[0];
485 		ucontrol->value.integer.value[1] =
486 			mask - ucontrol->value.integer.value[1];
487 	}
488 
489 	mutex_unlock(&chip->mixer_lock);
490 
491 	return 0;
492 }
493 
494 static int snd_at73c213_stereo_put(struct snd_kcontrol *kcontrol,
495 				 struct snd_ctl_elem_value *ucontrol)
496 {
497 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
498 	int left_reg = kcontrol->private_value & 0xff;
499 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
500 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
501 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
502 	int mask = (kcontrol->private_value >> 24) & 0xff;
503 	int invert = (kcontrol->private_value >> 22) & 1;
504 	int change, retval;
505 	unsigned short val1, val2;
506 
507 	val1 = ucontrol->value.integer.value[0] & mask;
508 	val2 = ucontrol->value.integer.value[1] & mask;
509 	if (invert) {
510 		val1 = mask - val1;
511 		val2 = mask - val2;
512 	}
513 	val1 <<= shift_left;
514 	val2 <<= shift_right;
515 
516 	mutex_lock(&chip->mixer_lock);
517 
518 	val1 = (chip->reg_image[left_reg] & ~(mask << shift_left)) | val1;
519 	val2 = (chip->reg_image[right_reg] & ~(mask << shift_right)) | val2;
520 	change = val1 != chip->reg_image[left_reg]
521 		|| val2 != chip->reg_image[right_reg];
522 	retval = snd_at73c213_write_reg(chip, left_reg, val1);
523 	if (retval) {
524 		mutex_unlock(&chip->mixer_lock);
525 		goto out;
526 	}
527 	retval = snd_at73c213_write_reg(chip, right_reg, val2);
528 	if (retval) {
529 		mutex_unlock(&chip->mixer_lock);
530 		goto out;
531 	}
532 
533 	mutex_unlock(&chip->mixer_lock);
534 
535 	return change;
536 
537 out:
538 	return retval;
539 }
540 
541 #define snd_at73c213_mono_switch_info	snd_ctl_boolean_mono_info
542 
543 static int snd_at73c213_mono_switch_get(struct snd_kcontrol *kcontrol,
544 				 struct snd_ctl_elem_value *ucontrol)
545 {
546 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
547 	int reg = kcontrol->private_value & 0xff;
548 	int shift = (kcontrol->private_value >> 8) & 0xff;
549 	int invert = (kcontrol->private_value >> 24) & 0xff;
550 
551 	mutex_lock(&chip->mixer_lock);
552 
553 	ucontrol->value.integer.value[0] =
554 		(chip->reg_image[reg] >> shift) & 0x01;
555 
556 	if (invert)
557 		ucontrol->value.integer.value[0] =
558 			0x01 - ucontrol->value.integer.value[0];
559 
560 	mutex_unlock(&chip->mixer_lock);
561 
562 	return 0;
563 }
564 
565 static int snd_at73c213_mono_switch_put(struct snd_kcontrol *kcontrol,
566 				 struct snd_ctl_elem_value *ucontrol)
567 {
568 	struct snd_at73c213 *chip = snd_kcontrol_chip(kcontrol);
569 	int reg = kcontrol->private_value & 0xff;
570 	int shift = (kcontrol->private_value >> 8) & 0xff;
571 	int mask = (kcontrol->private_value >> 16) & 0xff;
572 	int invert = (kcontrol->private_value >> 24) & 0xff;
573 	int change, retval;
574 	unsigned short val;
575 
576 	if (ucontrol->value.integer.value[0])
577 		val = mask;
578 	else
579 		val = 0;
580 
581 	if (invert)
582 		val = mask - val;
583 	val <<= shift;
584 
585 	mutex_lock(&chip->mixer_lock);
586 
587 	val |= (chip->reg_image[reg] & ~(mask << shift));
588 	change = val != chip->reg_image[reg];
589 
590 	retval = snd_at73c213_write_reg(chip, reg, val);
591 
592 	mutex_unlock(&chip->mixer_lock);
593 
594 	if (retval)
595 		return retval;
596 
597 	return change;
598 }
599 
600 static int snd_at73c213_pa_volume_info(struct snd_kcontrol *kcontrol,
601 				  struct snd_ctl_elem_info *uinfo)
602 {
603 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
604 	uinfo->count = 1;
605 	uinfo->value.integer.min = 0;
606 	uinfo->value.integer.max = ((kcontrol->private_value >> 16) & 0xff) - 1;
607 
608 	return 0;
609 }
610 
611 static int snd_at73c213_line_capture_volume_info(
612 		struct snd_kcontrol *kcontrol,
613 		struct snd_ctl_elem_info *uinfo)
614 {
615 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
616 	uinfo->count = 2;
617 	/* When inverted will give values 0x10001 => 0. */
618 	uinfo->value.integer.min = 14;
619 	uinfo->value.integer.max = 31;
620 
621 	return 0;
622 }
623 
624 static int snd_at73c213_aux_capture_volume_info(
625 		struct snd_kcontrol *kcontrol,
626 		struct snd_ctl_elem_info *uinfo)
627 {
628 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
629 	uinfo->count = 1;
630 	/* When inverted will give values 0x10001 => 0. */
631 	uinfo->value.integer.min = 14;
632 	uinfo->value.integer.max = 31;
633 
634 	return 0;
635 }
636 
637 #define AT73C213_MONO_SWITCH(xname, xindex, reg, shift, mask, invert)	\
638 {									\
639 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,				\
640 	.name = xname,							\
641 	.index = xindex,						\
642 	.info = snd_at73c213_mono_switch_info,				\
643 	.get = snd_at73c213_mono_switch_get,				\
644 	.put = snd_at73c213_mono_switch_put,				\
645 	.private_value = (reg | (shift << 8) | (mask << 16) | (invert << 24)) \
646 }
647 
648 #define AT73C213_STEREO(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
649 {									\
650 	.iface = SNDRV_CTL_ELEM_IFACE_MIXER,				\
651 	.name = xname,							\
652 	.index = xindex,						\
653 	.info = snd_at73c213_stereo_info,				\
654 	.get = snd_at73c213_stereo_get,					\
655 	.put = snd_at73c213_stereo_put,					\
656 	.private_value = (left_reg | (right_reg << 8)			\
657 			| (shift_left << 16) | (shift_right << 19)	\
658 			| (mask << 24) | (invert << 22))		\
659 }
660 
661 static struct snd_kcontrol_new snd_at73c213_controls[] __devinitdata = {
662 AT73C213_STEREO("Master Playback Volume", 0, DAC_LMPG, DAC_RMPG, 0, 0, 0x1f, 1),
663 AT73C213_STEREO("Master Playback Switch", 0, DAC_LMPG, DAC_RMPG, 5, 5, 1, 1),
664 AT73C213_STEREO("PCM Playback Volume", 0, DAC_LLOG, DAC_RLOG, 0, 0, 0x1f, 1),
665 AT73C213_STEREO("PCM Playback Switch", 0, DAC_LLOG, DAC_RLOG, 5, 5, 1, 1),
666 AT73C213_MONO_SWITCH("Mono PA Playback Switch", 0, DAC_CTRL, DAC_CTRL_ONPADRV,
667 		     0x01, 0),
668 {
669 	.iface	= SNDRV_CTL_ELEM_IFACE_MIXER,
670 	.name	= "PA Playback Volume",
671 	.index	= 0,
672 	.info	= snd_at73c213_pa_volume_info,
673 	.get	= snd_at73c213_mono_get,
674 	.put	= snd_at73c213_mono_put,
675 	.private_value	= PA_CTRL | (PA_CTRL_APAGAIN << 8) | \
676 		(0x0f << 16) | (1 << 24),
677 },
678 AT73C213_MONO_SWITCH("PA High Gain Playback Switch", 0, PA_CTRL, PA_CTRL_APALP,
679 		     0x01, 1),
680 AT73C213_MONO_SWITCH("PA Playback Switch", 0, PA_CTRL, PA_CTRL_APAON, 0x01, 0),
681 {
682 	.iface	= SNDRV_CTL_ELEM_IFACE_MIXER,
683 	.name	= "Aux Capture Volume",
684 	.index	= 0,
685 	.info	= snd_at73c213_aux_capture_volume_info,
686 	.get	= snd_at73c213_mono_get,
687 	.put	= snd_at73c213_mono_put,
688 	.private_value	= DAC_AUXG | (0 << 8) | (0x1f << 16) | (1 << 24),
689 },
690 AT73C213_MONO_SWITCH("Aux Capture Switch", 0, DAC_CTRL, DAC_CTRL_ONAUXIN,
691 		     0x01, 0),
692 {
693 	.iface	= SNDRV_CTL_ELEM_IFACE_MIXER,
694 	.name	= "Line Capture Volume",
695 	.index	= 0,
696 	.info	= snd_at73c213_line_capture_volume_info,
697 	.get	= snd_at73c213_stereo_get,
698 	.put	= snd_at73c213_stereo_put,
699 	.private_value	= DAC_LLIG | (DAC_RLIG << 8) | (0 << 16) | (0 << 19)
700 		| (0x1f << 24) | (1 << 22),
701 },
702 AT73C213_MONO_SWITCH("Line Capture Switch", 0, DAC_CTRL, 0, 0x03, 0),
703 };
704 
705 static int __devinit snd_at73c213_mixer(struct snd_at73c213 *chip)
706 {
707 	struct snd_card *card;
708 	int errval, idx;
709 
710 	if (chip == NULL || chip->pcm == NULL)
711 		return -EINVAL;
712 
713 	card = chip->card;
714 
715 	strcpy(card->mixername, chip->pcm->name);
716 
717 	for (idx = 0; idx < ARRAY_SIZE(snd_at73c213_controls); idx++) {
718 		errval = snd_ctl_add(card,
719 				snd_ctl_new1(&snd_at73c213_controls[idx],
720 					chip));
721 		if (errval < 0)
722 			goto cleanup;
723 	}
724 
725 	return 0;
726 
727 cleanup:
728 	for (idx = 1; idx < ARRAY_SIZE(snd_at73c213_controls) + 1; idx++) {
729 		struct snd_kcontrol *kctl;
730 		kctl = snd_ctl_find_numid(card, idx);
731 		if (kctl)
732 			snd_ctl_remove(card, kctl);
733 	}
734 	return errval;
735 }
736 
737 /*
738  * Device functions
739  */
740 static int snd_at73c213_ssc_init(struct snd_at73c213 *chip)
741 {
742 	/*
743 	 * Continuous clock output.
744 	 * Starts on falling TF.
745 	 * Delay 1 cycle (1 bit).
746 	 * Periode is 16 bit (16 - 1).
747 	 */
748 	ssc_writel(chip->ssc->regs, TCMR,
749 			SSC_BF(TCMR_CKO, 1)
750 			| SSC_BF(TCMR_START, 4)
751 			| SSC_BF(TCMR_STTDLY, 1)
752 			| SSC_BF(TCMR_PERIOD, 16 - 1));
753 	/*
754 	 * Data length is 16 bit (16 - 1).
755 	 * Transmit MSB first.
756 	 * Transmit 2 words each transfer.
757 	 * Frame sync length is 16 bit (16 - 1).
758 	 * Frame starts on negative pulse.
759 	 */
760 	ssc_writel(chip->ssc->regs, TFMR,
761 			SSC_BF(TFMR_DATLEN, 16 - 1)
762 			| SSC_BIT(TFMR_MSBF)
763 			| SSC_BF(TFMR_DATNB, 1)
764 			| SSC_BF(TFMR_FSLEN, 16 - 1)
765 			| SSC_BF(TFMR_FSOS, 1));
766 
767 	return 0;
768 }
769 
770 static int snd_at73c213_chip_init(struct snd_at73c213 *chip)
771 {
772 	int retval;
773 	unsigned char dac_ctrl = 0;
774 
775 	retval = snd_at73c213_set_bitrate(chip);
776 	if (retval)
777 		goto out;
778 
779 	/* Enable DAC master clock. */
780 	clk_enable(chip->board->dac_clk);
781 
782 	/* Initialize at73c213 on SPI bus. */
783 	retval = snd_at73c213_write_reg(chip, DAC_RST, 0x04);
784 	if (retval)
785 		goto out_clk;
786 	msleep(1);
787 	retval = snd_at73c213_write_reg(chip, DAC_RST, 0x03);
788 	if (retval)
789 		goto out_clk;
790 
791 	/* Precharge everything. */
792 	retval = snd_at73c213_write_reg(chip, DAC_PRECH, 0xff);
793 	if (retval)
794 		goto out_clk;
795 	retval = snd_at73c213_write_reg(chip, PA_CTRL, (1<<PA_CTRL_APAPRECH));
796 	if (retval)
797 		goto out_clk;
798 	retval = snd_at73c213_write_reg(chip, DAC_CTRL,
799 			(1<<DAC_CTRL_ONLNOL) | (1<<DAC_CTRL_ONLNOR));
800 	if (retval)
801 		goto out_clk;
802 
803 	msleep(50);
804 
805 	/* Stop precharging PA. */
806 	retval = snd_at73c213_write_reg(chip, PA_CTRL,
807 			(1<<PA_CTRL_APALP) | 0x0f);
808 	if (retval)
809 		goto out_clk;
810 
811 	msleep(450);
812 
813 	/* Stop precharging DAC, turn on master power. */
814 	retval = snd_at73c213_write_reg(chip, DAC_PRECH, (1<<DAC_PRECH_ONMSTR));
815 	if (retval)
816 		goto out_clk;
817 
818 	msleep(1);
819 
820 	/* Turn on DAC. */
821 	dac_ctrl = (1<<DAC_CTRL_ONDACL) | (1<<DAC_CTRL_ONDACR)
822 		| (1<<DAC_CTRL_ONLNOL) | (1<<DAC_CTRL_ONLNOR);
823 
824 	retval = snd_at73c213_write_reg(chip, DAC_CTRL, dac_ctrl);
825 	if (retval)
826 		goto out_clk;
827 
828 	/* Mute sound. */
829 	retval = snd_at73c213_write_reg(chip, DAC_LMPG, 0x3f);
830 	if (retval)
831 		goto out_clk;
832 	retval = snd_at73c213_write_reg(chip, DAC_RMPG, 0x3f);
833 	if (retval)
834 		goto out_clk;
835 	retval = snd_at73c213_write_reg(chip, DAC_LLOG, 0x3f);
836 	if (retval)
837 		goto out_clk;
838 	retval = snd_at73c213_write_reg(chip, DAC_RLOG, 0x3f);
839 	if (retval)
840 		goto out_clk;
841 	retval = snd_at73c213_write_reg(chip, DAC_LLIG, 0x11);
842 	if (retval)
843 		goto out_clk;
844 	retval = snd_at73c213_write_reg(chip, DAC_RLIG, 0x11);
845 	if (retval)
846 		goto out_clk;
847 	retval = snd_at73c213_write_reg(chip, DAC_AUXG, 0x11);
848 	if (retval)
849 		goto out_clk;
850 
851 	/* Enable I2S device, i.e. clock output. */
852 	ssc_writel(chip->ssc->regs, CR, SSC_BIT(CR_TXEN));
853 
854 	goto out;
855 
856 out_clk:
857 	clk_disable(chip->board->dac_clk);
858 out:
859 	return retval;
860 }
861 
862 static int snd_at73c213_dev_free(struct snd_device *device)
863 {
864 	struct snd_at73c213 *chip = device->device_data;
865 
866 	ssc_writel(chip->ssc->regs, CR, SSC_BIT(CR_TXDIS));
867 	if (chip->irq >= 0) {
868 		free_irq(chip->irq, chip);
869 		chip->irq = -1;
870 	}
871 
872 	return 0;
873 }
874 
875 static int __devinit snd_at73c213_dev_init(struct snd_card *card,
876 					 struct spi_device *spi)
877 {
878 	static struct snd_device_ops ops = {
879 		.dev_free	= snd_at73c213_dev_free,
880 	};
881 	struct snd_at73c213 *chip = get_chip(card);
882 	int irq, retval;
883 
884 	irq = chip->ssc->irq;
885 	if (irq < 0)
886 		return irq;
887 
888 	spin_lock_init(&chip->lock);
889 	mutex_init(&chip->mixer_lock);
890 	chip->card = card;
891 	chip->irq = -1;
892 
893 	retval = request_irq(irq, snd_at73c213_interrupt, 0, "at73c213", chip);
894 	if (retval) {
895 		dev_dbg(&chip->spi->dev, "unable to request irq %d\n", irq);
896 		goto out;
897 	}
898 	chip->irq = irq;
899 
900 	memcpy(&chip->reg_image, &snd_at73c213_original_image,
901 			sizeof(snd_at73c213_original_image));
902 
903 	retval = snd_at73c213_ssc_init(chip);
904 	if (retval)
905 		goto out_irq;
906 
907 	retval = snd_at73c213_chip_init(chip);
908 	if (retval)
909 		goto out_irq;
910 
911 	retval = snd_at73c213_pcm_new(chip, 0);
912 	if (retval)
913 		goto out_irq;
914 
915 	retval = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops);
916 	if (retval)
917 		goto out_irq;
918 
919 	retval = snd_at73c213_mixer(chip);
920 	if (retval)
921 		goto out_snd_dev;
922 
923 	snd_card_set_dev(card, &spi->dev);
924 
925 	goto out;
926 
927 out_snd_dev:
928 	snd_device_free(card, chip);
929 out_irq:
930 	free_irq(chip->irq, chip);
931 	chip->irq = -1;
932 out:
933 	return retval;
934 }
935 
936 static int snd_at73c213_probe(struct spi_device *spi)
937 {
938 	struct snd_card			*card;
939 	struct snd_at73c213		*chip;
940 	struct at73c213_board_info	*board;
941 	int				retval;
942 	char				id[16];
943 
944 	board = spi->dev.platform_data;
945 	if (!board) {
946 		dev_dbg(&spi->dev, "no platform_data\n");
947 		return -ENXIO;
948 	}
949 
950 	if (!board->dac_clk) {
951 		dev_dbg(&spi->dev, "no DAC clk\n");
952 		return -ENXIO;
953 	}
954 
955 	if (IS_ERR(board->dac_clk)) {
956 		dev_dbg(&spi->dev, "no DAC clk\n");
957 		return PTR_ERR(board->dac_clk);
958 	}
959 
960 	retval = -ENOMEM;
961 
962 	/* Allocate "card" using some unused identifiers. */
963 	snprintf(id, sizeof id, "at73c213_%d", board->ssc_id);
964 	card = snd_card_new(-1, id, THIS_MODULE, sizeof(struct snd_at73c213));
965 	if (!card)
966 		goto out;
967 
968 	chip = card->private_data;
969 	chip->spi = spi;
970 	chip->board = board;
971 
972 	chip->ssc = ssc_request(board->ssc_id);
973 	if (IS_ERR(chip->ssc)) {
974 		dev_dbg(&spi->dev, "could not get ssc%d device\n",
975 				board->ssc_id);
976 		retval = PTR_ERR(chip->ssc);
977 		goto out_card;
978 	}
979 
980 	retval = snd_at73c213_dev_init(card, spi);
981 	if (retval)
982 		goto out_ssc;
983 
984 	strcpy(card->driver, "at73c213");
985 	strcpy(card->shortname, board->shortname);
986 	sprintf(card->longname, "%s on irq %d", card->shortname, chip->irq);
987 
988 	retval = snd_card_register(card);
989 	if (retval)
990 		goto out_ssc;
991 
992 	dev_set_drvdata(&spi->dev, card);
993 
994 	goto out;
995 
996 out_ssc:
997 	ssc_free(chip->ssc);
998 out_card:
999 	snd_card_free(card);
1000 out:
1001 	return retval;
1002 }
1003 
1004 static int __devexit snd_at73c213_remove(struct spi_device *spi)
1005 {
1006 	struct snd_card *card = dev_get_drvdata(&spi->dev);
1007 	struct snd_at73c213 *chip = card->private_data;
1008 	int retval;
1009 
1010 	/* Stop playback. */
1011 	ssc_writel(chip->ssc->regs, CR, SSC_BIT(CR_TXDIS));
1012 
1013 	/* Mute sound. */
1014 	retval = snd_at73c213_write_reg(chip, DAC_LMPG, 0x3f);
1015 	if (retval)
1016 		goto out;
1017 	retval = snd_at73c213_write_reg(chip, DAC_RMPG, 0x3f);
1018 	if (retval)
1019 		goto out;
1020 	retval = snd_at73c213_write_reg(chip, DAC_LLOG, 0x3f);
1021 	if (retval)
1022 		goto out;
1023 	retval = snd_at73c213_write_reg(chip, DAC_RLOG, 0x3f);
1024 	if (retval)
1025 		goto out;
1026 	retval = snd_at73c213_write_reg(chip, DAC_LLIG, 0x11);
1027 	if (retval)
1028 		goto out;
1029 	retval = snd_at73c213_write_reg(chip, DAC_RLIG, 0x11);
1030 	if (retval)
1031 		goto out;
1032 	retval = snd_at73c213_write_reg(chip, DAC_AUXG, 0x11);
1033 	if (retval)
1034 		goto out;
1035 
1036 	/* Turn off PA. */
1037 	retval = snd_at73c213_write_reg(chip, PA_CTRL,
1038 					chip->reg_image[PA_CTRL] | 0x0f);
1039 	if (retval)
1040 		goto out;
1041 	msleep(10);
1042 	retval = snd_at73c213_write_reg(chip, PA_CTRL,
1043 					(1 << PA_CTRL_APALP) | 0x0f);
1044 	if (retval)
1045 		goto out;
1046 
1047 	/* Turn off external DAC. */
1048 	retval = snd_at73c213_write_reg(chip, DAC_CTRL, 0x0c);
1049 	if (retval)
1050 		goto out;
1051 	msleep(2);
1052 	retval = snd_at73c213_write_reg(chip, DAC_CTRL, 0x00);
1053 	if (retval)
1054 		goto out;
1055 
1056 	/* Turn off master power. */
1057 	retval = snd_at73c213_write_reg(chip, DAC_PRECH, 0x00);
1058 	if (retval)
1059 		goto out;
1060 
1061 out:
1062 	/* Stop DAC master clock. */
1063 	clk_disable(chip->board->dac_clk);
1064 
1065 	ssc_free(chip->ssc);
1066 	snd_card_free(card);
1067 	dev_set_drvdata(&spi->dev, NULL);
1068 
1069 	return 0;
1070 }
1071 
1072 #ifdef CONFIG_PM
1073 static int snd_at73c213_suspend(struct spi_device *spi, pm_message_t msg)
1074 {
1075 	struct snd_card *card = dev_get_drvdata(&spi->dev);
1076 	struct snd_at73c213 *chip = card->private_data;
1077 
1078 	ssc_writel(chip->ssc->regs, CR, SSC_BIT(CR_TXDIS));
1079 	clk_disable(chip->board->dac_clk);
1080 
1081 	return 0;
1082 }
1083 
1084 static int snd_at73c213_resume(struct spi_device *spi)
1085 {
1086 	struct snd_card *card = dev_get_drvdata(&spi->dev);
1087 	struct snd_at73c213 *chip = card->private_data;
1088 
1089 	clk_enable(chip->board->dac_clk);
1090 	ssc_writel(chip->ssc->regs, CR, SSC_BIT(CR_TXEN));
1091 
1092 	return 0;
1093 }
1094 #else
1095 #define snd_at73c213_suspend NULL
1096 #define snd_at73c213_resume NULL
1097 #endif
1098 
1099 static struct spi_driver at73c213_driver = {
1100 	.driver		= {
1101 		.name	= "at73c213",
1102 	},
1103 	.probe		= snd_at73c213_probe,
1104 	.suspend	= snd_at73c213_suspend,
1105 	.resume		= snd_at73c213_resume,
1106 	.remove		= __devexit_p(snd_at73c213_remove),
1107 };
1108 
1109 static int __init at73c213_init(void)
1110 {
1111 	return spi_register_driver(&at73c213_driver);
1112 }
1113 module_init(at73c213_init);
1114 
1115 static void __exit at73c213_exit(void)
1116 {
1117 	spi_unregister_driver(&at73c213_driver);
1118 }
1119 module_exit(at73c213_exit);
1120 
1121 MODULE_AUTHOR("Hans-Christian Egtvedt <hcegtvedt@atmel.com>");
1122 MODULE_DESCRIPTION("Sound driver for AT73C213 with Atmel SSC");
1123 MODULE_LICENSE("GPL");
1124