2 * imx-ssi.c -- ALSA Soc Audio Layer
4 * Copyright 2009 Sascha Hauer <s.hauer@pengutronix.de>
6 * This code is based on code copyrighted by Freescale,
7 * Liam Girdwood, Javier Martin and probably others.
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
15 * The i.MX SSI core has some nasty limitations in AC97 mode. While most
16 * sane processor vendors have a FIFO per AC97 slot, the i.MX has only
17 * one FIFO which combines all valid receive slots. We cannot even select
18 * which slots we want to receive. The WM9712 with which this driver
19 * was developped with always sends GPIO status data in slot 12 which
20 * we receive in our (PCM-) data stream. The only chance we have is to
21 * manually skip this data in the FIQ handler. With sampling rates different
22 * from 48000Hz not every frame has valid receive data, so the ratio
23 * between pcm data and GPIO status data changes. Our FIQ handler is not
24 * able to handle this, hence this driver only works with 48000Hz sampling
26 * Reading and writing AC97 registers is another challange. The core
27 * provides us status bits when the read register is updated with *another*
28 * value. When we read the same register two times (and the register still
29 * contains the same value) these status bits are not set. We work
30 * around this by not polling these bits but only wait a fixed delay.
34 #include <linux/clk.h>
35 #include <linux/delay.h>
36 #include <linux/device.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/init.h>
39 #include <linux/interrupt.h>
40 #include <linux/module.h>
41 #include <linux/platform_device.h>
42 #include <linux/slab.h>
44 #include <sound/core.h>
45 #include <sound/initval.h>
46 #include <sound/pcm.h>
47 #include <sound/pcm_params.h>
48 #include <sound/soc.h>
51 #include <mach/hardware.h>
55 #define SSI_SACNT_DEFAULT (SSI_SACNT_AC97EN | SSI_SACNT_FV)
58 * SSI Network Mode or TDM slots configuration.
59 * Should only be called when port is inactive (i.e. SSIEN = 0).
61 static int imx_ssi_set_dai_tdm_slot(struct snd_soc_dai
*cpu_dai
,
62 unsigned int tx_mask
, unsigned int rx_mask
, int slots
, int slot_width
)
64 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
67 sccr
= readl(ssi
->base
+ SSI_STCCR
);
68 sccr
&= ~SSI_STCCR_DC_MASK
;
69 sccr
|= SSI_STCCR_DC(slots
- 1);
70 writel(sccr
, ssi
->base
+ SSI_STCCR
);
72 sccr
= readl(ssi
->base
+ SSI_SRCCR
);
73 sccr
&= ~SSI_STCCR_DC_MASK
;
74 sccr
|= SSI_STCCR_DC(slots
- 1);
75 writel(sccr
, ssi
->base
+ SSI_SRCCR
);
77 writel(tx_mask
, ssi
->base
+ SSI_STMSK
);
78 writel(rx_mask
, ssi
->base
+ SSI_SRMSK
);
84 * SSI DAI format configuration.
85 * Should only be called when port is inactive (i.e. SSIEN = 0).
86 * Note: We don't use the I2S modes but instead manually configure the
87 * SSI for I2S because the I2S mode is only a register preset.
89 static int imx_ssi_set_dai_fmt(struct snd_soc_dai
*cpu_dai
, unsigned int fmt
)
91 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
94 scr
= readl(ssi
->base
+ SSI_SCR
) & ~(SSI_SCR_SYN
| SSI_SCR_NET
);
97 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
98 case SND_SOC_DAIFMT_I2S
:
99 /* data on rising edge of bclk, frame low 1clk before data */
100 strcr
|= SSI_STCR_TFSI
| SSI_STCR_TEFS
| SSI_STCR_TXBIT0
;
103 case SND_SOC_DAIFMT_LEFT_J
:
104 /* data on rising edge of bclk, frame high with data */
105 strcr
|= SSI_STCR_TXBIT0
;
107 case SND_SOC_DAIFMT_DSP_B
:
108 /* data on rising edge of bclk, frame high with data */
109 strcr
|= SSI_STCR_TFSL
;
111 case SND_SOC_DAIFMT_DSP_A
:
112 /* data on rising edge of bclk, frame high 1clk before data */
113 strcr
|= SSI_STCR_TFSL
| SSI_STCR_TEFS
;
117 /* DAI clock inversion */
118 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
119 case SND_SOC_DAIFMT_IB_IF
:
120 strcr
|= SSI_STCR_TFSI
;
121 strcr
&= ~SSI_STCR_TSCKP
;
123 case SND_SOC_DAIFMT_IB_NF
:
124 strcr
&= ~(SSI_STCR_TSCKP
| SSI_STCR_TFSI
);
126 case SND_SOC_DAIFMT_NB_IF
:
127 strcr
|= SSI_STCR_TFSI
| SSI_STCR_TSCKP
;
129 case SND_SOC_DAIFMT_NB_NF
:
130 strcr
&= ~SSI_STCR_TFSI
;
131 strcr
|= SSI_STCR_TSCKP
;
135 /* DAI clock master masks */
136 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
137 case SND_SOC_DAIFMT_CBM_CFM
:
140 /* Master mode not implemented, needs handling of clocks. */
144 strcr
|= SSI_STCR_TFEN0
;
146 writel(strcr
, ssi
->base
+ SSI_STCR
);
147 writel(strcr
, ssi
->base
+ SSI_SRCR
);
148 writel(scr
, ssi
->base
+ SSI_SCR
);
154 * SSI system clock configuration.
155 * Should only be called when port is inactive (i.e. SSIEN = 0).
157 static int imx_ssi_set_dai_sysclk(struct snd_soc_dai
*cpu_dai
,
158 int clk_id
, unsigned int freq
, int dir
)
160 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
163 scr
= readl(ssi
->base
+ SSI_SCR
);
166 case IMX_SSP_SYS_CLK
:
167 if (dir
== SND_SOC_CLOCK_OUT
)
168 scr
|= SSI_SCR_SYS_CLK_EN
;
170 scr
&= ~SSI_SCR_SYS_CLK_EN
;
176 writel(scr
, ssi
->base
+ SSI_SCR
);
183 * Should only be called when port is inactive (i.e. SSIEN = 0).
185 static int imx_ssi_set_dai_clkdiv(struct snd_soc_dai
*cpu_dai
,
188 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
191 stccr
= readl(ssi
->base
+ SSI_STCCR
);
192 srccr
= readl(ssi
->base
+ SSI_SRCCR
);
195 case IMX_SSI_TX_DIV_2
:
196 stccr
&= ~SSI_STCCR_DIV2
;
199 case IMX_SSI_TX_DIV_PSR
:
200 stccr
&= ~SSI_STCCR_PSR
;
203 case IMX_SSI_TX_DIV_PM
:
205 stccr
|= SSI_STCCR_PM(div
);
207 case IMX_SSI_RX_DIV_2
:
208 stccr
&= ~SSI_STCCR_DIV2
;
211 case IMX_SSI_RX_DIV_PSR
:
212 stccr
&= ~SSI_STCCR_PSR
;
215 case IMX_SSI_RX_DIV_PM
:
217 stccr
|= SSI_STCCR_PM(div
);
223 writel(stccr
, ssi
->base
+ SSI_STCCR
);
224 writel(srccr
, ssi
->base
+ SSI_SRCCR
);
230 * Should only be called when port is inactive (i.e. SSIEN = 0),
231 * although can be called multiple times by upper layers.
233 static int imx_ssi_hw_params(struct snd_pcm_substream
*substream
,
234 struct snd_pcm_hw_params
*params
,
235 struct snd_soc_dai
*cpu_dai
)
237 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
241 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
) {
243 cpu_dai
->dma_data
= &ssi
->dma_params_tx
;
246 cpu_dai
->dma_data
= &ssi
->dma_params_rx
;
249 sccr
= readl(ssi
->base
+ reg
) & ~SSI_STCCR_WL_MASK
;
251 /* DAI data (word) size */
252 switch (params_format(params
)) {
253 case SNDRV_PCM_FORMAT_S16_LE
:
254 sccr
|= SSI_SRCCR_WL(16);
256 case SNDRV_PCM_FORMAT_S20_3LE
:
257 sccr
|= SSI_SRCCR_WL(20);
259 case SNDRV_PCM_FORMAT_S24_LE
:
260 sccr
|= SSI_SRCCR_WL(24);
264 writel(sccr
, ssi
->base
+ reg
);
269 static int imx_ssi_trigger(struct snd_pcm_substream
*substream
, int cmd
,
270 struct snd_soc_dai
*dai
)
272 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
273 struct snd_soc_dai
*cpu_dai
= rtd
->dai
->cpu_dai
;
274 struct imx_ssi
*ssi
= cpu_dai
->private_data
;
275 unsigned int sier_bits
, sier
;
278 scr
= readl(ssi
->base
+ SSI_SCR
);
279 sier
= readl(ssi
->base
+ SSI_SIER
);
281 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
) {
282 if (ssi
->flags
& IMX_SSI_DMA
)
283 sier_bits
= SSI_SIER_TDMAE
;
285 sier_bits
= SSI_SIER_TIE
| SSI_SIER_TFE0_EN
;
287 if (ssi
->flags
& IMX_SSI_DMA
)
288 sier_bits
= SSI_SIER_RDMAE
;
290 sier_bits
= SSI_SIER_RIE
| SSI_SIER_RFF0_EN
;
294 case SNDRV_PCM_TRIGGER_START
:
295 case SNDRV_PCM_TRIGGER_RESUME
:
296 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
297 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
)
303 if (++ssi
->enabled
== 1)
304 scr
|= SSI_SCR_SSIEN
;
308 case SNDRV_PCM_TRIGGER_STOP
:
309 case SNDRV_PCM_TRIGGER_SUSPEND
:
310 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
311 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
)
317 if (--ssi
->enabled
== 0)
318 scr
&= ~SSI_SCR_SSIEN
;
325 if (!(ssi
->flags
& IMX_SSI_USE_AC97
))
326 /* rx/tx are always enabled to access ac97 registers */
327 writel(scr
, ssi
->base
+ SSI_SCR
);
329 writel(sier
, ssi
->base
+ SSI_SIER
);
334 static struct snd_soc_dai_ops imx_ssi_pcm_dai_ops
= {
335 .hw_params
= imx_ssi_hw_params
,
336 .set_fmt
= imx_ssi_set_dai_fmt
,
337 .set_clkdiv
= imx_ssi_set_dai_clkdiv
,
338 .set_sysclk
= imx_ssi_set_dai_sysclk
,
339 .set_tdm_slot
= imx_ssi_set_dai_tdm_slot
,
340 .trigger
= imx_ssi_trigger
,
343 static struct snd_soc_dai imx_ssi_dai
= {
347 .rates
= SNDRV_PCM_RATE_8000_96000
,
348 .formats
= SNDRV_PCM_FMTBIT_S16_LE
,
353 .rates
= SNDRV_PCM_RATE_8000_96000
,
354 .formats
= SNDRV_PCM_FMTBIT_S16_LE
,
356 .ops
= &imx_ssi_pcm_dai_ops
,
359 int snd_imx_pcm_mmap(struct snd_pcm_substream
*substream
,
360 struct vm_area_struct
*vma
)
362 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
365 ret
= dma_mmap_coherent(NULL
, vma
, runtime
->dma_area
,
366 runtime
->dma_addr
, runtime
->dma_bytes
);
368 pr_debug("%s: ret: %d %p 0x%08x 0x%08x\n", __func__
, ret
,
375 static int imx_pcm_preallocate_dma_buffer(struct snd_pcm
*pcm
, int stream
)
377 struct snd_pcm_substream
*substream
= pcm
->streams
[stream
].substream
;
378 struct snd_dma_buffer
*buf
= &substream
->dma_buffer
;
379 size_t size
= IMX_SSI_DMABUF_SIZE
;
381 buf
->dev
.type
= SNDRV_DMA_TYPE_DEV
;
382 buf
->dev
.dev
= pcm
->card
->dev
;
383 buf
->private_data
= NULL
;
384 buf
->area
= dma_alloc_writecombine(pcm
->card
->dev
, size
,
385 &buf
->addr
, GFP_KERNEL
);
393 static u64 imx_pcm_dmamask
= DMA_BIT_MASK(32);
395 int imx_pcm_new(struct snd_card
*card
, struct snd_soc_dai
*dai
,
401 if (!card
->dev
->dma_mask
)
402 card
->dev
->dma_mask
= &imx_pcm_dmamask
;
403 if (!card
->dev
->coherent_dma_mask
)
404 card
->dev
->coherent_dma_mask
= DMA_BIT_MASK(32);
405 if (dai
->playback
.channels_min
) {
406 ret
= imx_pcm_preallocate_dma_buffer(pcm
,
407 SNDRV_PCM_STREAM_PLAYBACK
);
412 if (dai
->capture
.channels_min
) {
413 ret
= imx_pcm_preallocate_dma_buffer(pcm
,
414 SNDRV_PCM_STREAM_CAPTURE
);
423 void imx_pcm_free(struct snd_pcm
*pcm
)
425 struct snd_pcm_substream
*substream
;
426 struct snd_dma_buffer
*buf
;
429 for (stream
= 0; stream
< 2; stream
++) {
430 substream
= pcm
->streams
[stream
].substream
;
434 buf
= &substream
->dma_buffer
;
438 dma_free_writecombine(pcm
->card
->dev
, buf
->bytes
,
439 buf
->area
, buf
->addr
);
444 struct snd_soc_platform imx_soc_platform
= {
447 EXPORT_SYMBOL_GPL(imx_soc_platform
);
449 static struct snd_soc_dai imx_ac97_dai
= {
453 .stream_name
= "AC97 Playback",
456 .rates
= SNDRV_PCM_RATE_48000
,
457 .formats
= SNDRV_PCM_FMTBIT_S16_LE
,
460 .stream_name
= "AC97 Capture",
463 .rates
= SNDRV_PCM_RATE_48000
,
464 .formats
= SNDRV_PCM_FMTBIT_S16_LE
,
466 .ops
= &imx_ssi_pcm_dai_ops
,
469 static void setup_channel_to_ac97(struct imx_ssi
*imx_ssi
)
471 void __iomem
*base
= imx_ssi
->base
;
473 writel(0x0, base
+ SSI_SCR
);
474 writel(0x0, base
+ SSI_STCR
);
475 writel(0x0, base
+ SSI_SRCR
);
477 writel(SSI_SCR_SYN
| SSI_SCR_NET
, base
+ SSI_SCR
);
479 writel(SSI_SFCSR_RFWM0(8) |
482 SSI_SFCSR_TFWM1(8), base
+ SSI_SFCSR
);
484 writel(SSI_STCCR_WL(16) | SSI_STCCR_DC(12), base
+ SSI_STCCR
);
485 writel(SSI_STCCR_WL(16) | SSI_STCCR_DC(12), base
+ SSI_SRCCR
);
487 writel(SSI_SCR_SYN
| SSI_SCR_NET
| SSI_SCR_SSIEN
, base
+ SSI_SCR
);
488 writel(SSI_SOR_WAIT(3), base
+ SSI_SOR
);
490 writel(SSI_SCR_SYN
| SSI_SCR_NET
| SSI_SCR_SSIEN
|
491 SSI_SCR_TE
| SSI_SCR_RE
,
494 writel(SSI_SACNT_DEFAULT
, base
+ SSI_SACNT
);
495 writel(0xff, base
+ SSI_SACCDIS
);
496 writel(0x300, base
+ SSI_SACCEN
);
499 static struct imx_ssi
*ac97_ssi
;
501 static void imx_ssi_ac97_write(struct snd_ac97
*ac97
, unsigned short reg
,
504 struct imx_ssi
*imx_ssi
= ac97_ssi
;
505 void __iomem
*base
= imx_ssi
->base
;
512 pr_debug("%s: 0x%02x 0x%04x\n", __func__
, reg
, val
);
515 writel(lreg
, base
+ SSI_SACADD
);
518 writel(lval
, base
+ SSI_SACDAT
);
520 writel(SSI_SACNT_DEFAULT
| SSI_SACNT_WR
, base
+ SSI_SACNT
);
524 static unsigned short imx_ssi_ac97_read(struct snd_ac97
*ac97
,
527 struct imx_ssi
*imx_ssi
= ac97_ssi
;
528 void __iomem
*base
= imx_ssi
->base
;
530 unsigned short val
= -1;
533 lreg
= (reg
& 0x7f) << 12 ;
534 writel(lreg
, base
+ SSI_SACADD
);
535 writel(SSI_SACNT_DEFAULT
| SSI_SACNT_RD
, base
+ SSI_SACNT
);
539 val
= (readl(base
+ SSI_SACDAT
) >> 4) & 0xffff;
541 pr_debug("%s: 0x%02x 0x%04x\n", __func__
, reg
, val
);
546 static void imx_ssi_ac97_reset(struct snd_ac97
*ac97
)
548 struct imx_ssi
*imx_ssi
= ac97_ssi
;
550 if (imx_ssi
->ac97_reset
)
551 imx_ssi
->ac97_reset(ac97
);
554 static void imx_ssi_ac97_warm_reset(struct snd_ac97
*ac97
)
556 struct imx_ssi
*imx_ssi
= ac97_ssi
;
558 if (imx_ssi
->ac97_warm_reset
)
559 imx_ssi
->ac97_warm_reset(ac97
);
562 struct snd_ac97_bus_ops soc_ac97_ops
= {
563 .read
= imx_ssi_ac97_read
,
564 .write
= imx_ssi_ac97_write
,
565 .reset
= imx_ssi_ac97_reset
,
566 .warm_reset
= imx_ssi_ac97_warm_reset
568 EXPORT_SYMBOL_GPL(soc_ac97_ops
);
570 struct snd_soc_dai imx_ssi_pcm_dai
[2];
571 EXPORT_SYMBOL_GPL(imx_ssi_pcm_dai
);
573 static int imx_ssi_probe(struct platform_device
*pdev
)
575 struct resource
*res
;
577 struct imx_ssi_platform_data
*pdata
= pdev
->dev
.platform_data
;
578 struct snd_soc_platform
*platform
;
581 struct snd_soc_dai
*dai
= &imx_ssi_pcm_dai
[pdev
->id
];
583 if (dai
->id
>= ARRAY_SIZE(imx_ssi_pcm_dai
))
586 ssi
= kzalloc(sizeof(*ssi
), GFP_KERNEL
);
591 ssi
->ac97_reset
= pdata
->ac97_reset
;
592 ssi
->ac97_warm_reset
= pdata
->ac97_warm_reset
;
593 ssi
->flags
= pdata
->flags
;
596 ssi
->irq
= platform_get_irq(pdev
, 0);
598 ssi
->clk
= clk_get(&pdev
->dev
, NULL
);
599 if (IS_ERR(ssi
->clk
)) {
600 ret
= PTR_ERR(ssi
->clk
);
601 dev_err(&pdev
->dev
, "Cannot get the clock: %d\n",
605 clk_enable(ssi
->clk
);
607 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
610 goto failed_get_resource
;
613 if (!request_mem_region(res
->start
, resource_size(res
), DRV_NAME
)) {
614 dev_err(&pdev
->dev
, "request_mem_region failed\n");
616 goto failed_get_resource
;
619 ssi
->base
= ioremap(res
->start
, resource_size(res
));
621 dev_err(&pdev
->dev
, "ioremap failed\n");
626 if (ssi
->flags
& IMX_SSI_USE_AC97
) {
632 setup_channel_to_ac97(ssi
);
633 memcpy(dai
, &imx_ac97_dai
, sizeof(imx_ac97_dai
));
635 memcpy(dai
, &imx_ssi_dai
, sizeof(imx_ssi_dai
));
637 writel(0x0, ssi
->base
+ SSI_SIER
);
639 ssi
->dma_params_rx
.dma_addr
= res
->start
+ SSI_SRX0
;
640 ssi
->dma_params_tx
.dma_addr
= res
->start
+ SSI_STX0
;
642 res
= platform_get_resource_byname(pdev
, IORESOURCE_DMA
, "tx0");
644 ssi
->dma_params_tx
.dma
= res
->start
;
646 res
= platform_get_resource_byname(pdev
, IORESOURCE_DMA
, "rx0");
648 ssi
->dma_params_rx
.dma
= res
->start
;
651 dai
->dev
= &pdev
->dev
;
652 dai
->name
= kasprintf(GFP_KERNEL
, "imx-ssi.%d", pdev
->id
);
653 dai
->private_data
= ssi
;
655 if ((cpu_is_mx27() || cpu_is_mx21()) &&
656 !(ssi
->flags
& IMX_SSI_USE_AC97
)) {
657 ssi
->flags
|= IMX_SSI_DMA
;
658 platform
= imx_ssi_dma_mx2_init(pdev
, ssi
);
660 platform
= imx_ssi_fiq_init(pdev
, ssi
);
662 imx_soc_platform
.pcm_ops
= platform
->pcm_ops
;
663 imx_soc_platform
.pcm_new
= platform
->pcm_new
;
664 imx_soc_platform
.pcm_free
= platform
->pcm_free
;
666 val
= SSI_SFCSR_TFWM0(ssi
->dma_params_tx
.burstsize
) |
667 SSI_SFCSR_RFWM0(ssi
->dma_params_rx
.burstsize
);
668 writel(val
, ssi
->base
+ SSI_SFCSR
);
670 ret
= snd_soc_register_dai(dai
);
672 dev_err(&pdev
->dev
, "register DAI failed\n");
673 goto failed_register
;
676 platform_set_drvdata(pdev
, ssi
);
684 release_mem_region(res
->start
, resource_size(res
));
686 clk_disable(ssi
->clk
);
694 static int __devexit
imx_ssi_remove(struct platform_device
*pdev
)
696 struct resource
*res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
697 struct imx_ssi
*ssi
= platform_get_drvdata(pdev
);
698 struct snd_soc_dai
*dai
= &imx_ssi_pcm_dai
[pdev
->id
];
700 snd_soc_unregister_dai(dai
);
702 if (ssi
->flags
& IMX_SSI_USE_AC97
)
705 if (!(ssi
->flags
& IMX_SSI_DMA
))
706 imx_ssi_fiq_exit(pdev
, ssi
);
709 release_mem_region(res
->start
, resource_size(res
));
710 clk_disable(ssi
->clk
);
717 static struct platform_driver imx_ssi_driver
= {
718 .probe
= imx_ssi_probe
,
719 .remove
= __devexit_p(imx_ssi_remove
),
723 .owner
= THIS_MODULE
,
727 static int __init
imx_ssi_init(void)
731 ret
= snd_soc_register_platform(&imx_soc_platform
);
733 pr_err("failed to register soc platform: %d\n", ret
);
737 ret
= platform_driver_register(&imx_ssi_driver
);
739 snd_soc_unregister_platform(&imx_soc_platform
);
746 static void __exit
imx_ssi_exit(void)
748 platform_driver_unregister(&imx_ssi_driver
);
749 snd_soc_unregister_platform(&imx_soc_platform
);
752 module_init(imx_ssi_init
);
753 module_exit(imx_ssi_exit
);
755 /* Module information */
756 MODULE_AUTHOR("Sascha Hauer, <s.hauer@pengutronix.de>");
757 MODULE_DESCRIPTION("i.MX I2S/ac97 SoC Interface");
758 MODULE_LICENSE("GPL");