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 challenge. 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 = snd_soc_dai_get_drvdata(cpu_dai);
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).
87 static int imx_ssi_set_dai_fmt(struct snd_soc_dai *cpu_dai, unsigned int fmt)
89 struct imx_ssi *ssi = snd_soc_dai_get_drvdata(cpu_dai);
92 scr = readl(ssi->base + SSI_SCR) & ~(SSI_SCR_SYN | SSI_SCR_NET);
95 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
96 case SND_SOC_DAIFMT_I2S:
97 /* data on rising edge of bclk, frame low 1clk before data */
98 strcr |= SSI_STCR_TFSI | SSI_STCR_TEFS | SSI_STCR_TXBIT0;
100 if (ssi->flags & IMX_SSI_USE_I2S_SLAVE) {
101 scr &= ~SSI_I2S_MODE_MASK;
102 scr |= SSI_SCR_I2S_MODE_SLAVE;
105 case SND_SOC_DAIFMT_LEFT_J:
106 /* data on rising edge of bclk, frame high with data */
107 strcr |= SSI_STCR_TXBIT0;
109 case SND_SOC_DAIFMT_DSP_B:
110 /* data on rising edge of bclk, frame high with data */
111 strcr |= SSI_STCR_TFSL;
113 case SND_SOC_DAIFMT_DSP_A:
114 /* data on rising edge of bclk, frame high 1clk before data */
115 strcr |= SSI_STCR_TFSL | SSI_STCR_TEFS;
119 /* DAI clock inversion */
120 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
121 case SND_SOC_DAIFMT_IB_IF:
122 strcr |= SSI_STCR_TFSI;
123 strcr &= ~SSI_STCR_TSCKP;
125 case SND_SOC_DAIFMT_IB_NF:
126 strcr &= ~(SSI_STCR_TSCKP | SSI_STCR_TFSI);
128 case SND_SOC_DAIFMT_NB_IF:
129 strcr |= SSI_STCR_TFSI | SSI_STCR_TSCKP;
131 case SND_SOC_DAIFMT_NB_NF:
132 strcr &= ~SSI_STCR_TFSI;
133 strcr |= SSI_STCR_TSCKP;
137 /* DAI clock master masks */
138 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
139 case SND_SOC_DAIFMT_CBM_CFM:
142 /* Master mode not implemented, needs handling of clocks. */
146 strcr |= SSI_STCR_TFEN0;
148 if (ssi->flags & IMX_SSI_NET)
150 if (ssi->flags & IMX_SSI_SYN)
153 writel(strcr, ssi->base + SSI_STCR);
154 writel(strcr, ssi->base + SSI_SRCR);
155 writel(scr, ssi->base + SSI_SCR);
161 * SSI system clock configuration.
162 * Should only be called when port is inactive (i.e. SSIEN = 0).
164 static int imx_ssi_set_dai_sysclk(struct snd_soc_dai *cpu_dai,
165 int clk_id, unsigned int freq, int dir)
167 struct imx_ssi *ssi = snd_soc_dai_get_drvdata(cpu_dai);
170 scr = readl(ssi->base + SSI_SCR);
173 case IMX_SSP_SYS_CLK:
174 if (dir == SND_SOC_CLOCK_OUT)
175 scr |= SSI_SCR_SYS_CLK_EN;
177 scr &= ~SSI_SCR_SYS_CLK_EN;
183 writel(scr, ssi->base + SSI_SCR);
190 * Should only be called when port is inactive (i.e. SSIEN = 0).
192 static int imx_ssi_set_dai_clkdiv(struct snd_soc_dai *cpu_dai,
195 struct imx_ssi *ssi = snd_soc_dai_get_drvdata(cpu_dai);
198 stccr = readl(ssi->base + SSI_STCCR);
199 srccr = readl(ssi->base + SSI_SRCCR);
202 case IMX_SSI_TX_DIV_2:
203 stccr &= ~SSI_STCCR_DIV2;
206 case IMX_SSI_TX_DIV_PSR:
207 stccr &= ~SSI_STCCR_PSR;
210 case IMX_SSI_TX_DIV_PM:
212 stccr |= SSI_STCCR_PM(div);
214 case IMX_SSI_RX_DIV_2:
215 stccr &= ~SSI_STCCR_DIV2;
218 case IMX_SSI_RX_DIV_PSR:
219 stccr &= ~SSI_STCCR_PSR;
222 case IMX_SSI_RX_DIV_PM:
224 stccr |= SSI_STCCR_PM(div);
230 writel(stccr, ssi->base + SSI_STCCR);
231 writel(srccr, ssi->base + SSI_SRCCR);
237 * Should only be called when port is inactive (i.e. SSIEN = 0),
238 * although can be called multiple times by upper layers.
240 static int imx_ssi_hw_params(struct snd_pcm_substream *substream,
241 struct snd_pcm_hw_params *params,
242 struct snd_soc_dai *cpu_dai)
244 struct imx_ssi *ssi = snd_soc_dai_get_drvdata(cpu_dai);
245 struct imx_pcm_dma_params *dma_data;
249 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
251 dma_data = &ssi->dma_params_tx;
254 dma_data = &ssi->dma_params_rx;
257 if (ssi->flags & IMX_SSI_SYN)
260 snd_soc_dai_set_dma_data(cpu_dai, substream, dma_data);
262 sccr = readl(ssi->base + reg) & ~SSI_STCCR_WL_MASK;
264 /* DAI data (word) size */
265 switch (params_format(params)) {
266 case SNDRV_PCM_FORMAT_S16_LE:
267 sccr |= SSI_SRCCR_WL(16);
269 case SNDRV_PCM_FORMAT_S20_3LE:
270 sccr |= SSI_SRCCR_WL(20);
272 case SNDRV_PCM_FORMAT_S24_LE:
273 sccr |= SSI_SRCCR_WL(24);
277 writel(sccr, ssi->base + reg);
282 static int imx_ssi_trigger(struct snd_pcm_substream *substream, int cmd,
283 struct snd_soc_dai *dai)
285 struct imx_ssi *ssi = snd_soc_dai_get_drvdata(dai);
286 unsigned int sier_bits, sier;
289 scr = readl(ssi->base + SSI_SCR);
290 sier = readl(ssi->base + SSI_SIER);
292 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
293 if (ssi->flags & IMX_SSI_DMA)
294 sier_bits = SSI_SIER_TDMAE;
296 sier_bits = SSI_SIER_TIE | SSI_SIER_TFE0_EN;
298 if (ssi->flags & IMX_SSI_DMA)
299 sier_bits = SSI_SIER_RDMAE;
301 sier_bits = SSI_SIER_RIE | SSI_SIER_RFF0_EN;
305 case SNDRV_PCM_TRIGGER_START:
306 case SNDRV_PCM_TRIGGER_RESUME:
307 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
308 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
314 if (++ssi->enabled == 1)
315 scr |= SSI_SCR_SSIEN;
319 case SNDRV_PCM_TRIGGER_STOP:
320 case SNDRV_PCM_TRIGGER_SUSPEND:
321 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
322 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
328 if (--ssi->enabled == 0)
329 scr &= ~SSI_SCR_SSIEN;
336 if (!(ssi->flags & IMX_SSI_USE_AC97))
337 /* rx/tx are always enabled to access ac97 registers */
338 writel(scr, ssi->base + SSI_SCR);
340 writel(sier, ssi->base + SSI_SIER);
345 static struct snd_soc_dai_ops imx_ssi_pcm_dai_ops = {
346 .hw_params = imx_ssi_hw_params,
347 .set_fmt = imx_ssi_set_dai_fmt,
348 .set_clkdiv = imx_ssi_set_dai_clkdiv,
349 .set_sysclk = imx_ssi_set_dai_sysclk,
350 .set_tdm_slot = imx_ssi_set_dai_tdm_slot,
351 .trigger = imx_ssi_trigger,
354 int snd_imx_pcm_mmap(struct snd_pcm_substream *substream,
355 struct vm_area_struct *vma)
357 struct snd_pcm_runtime *runtime = substream->runtime;
360 ret = dma_mmap_coherent(NULL, vma, runtime->dma_area,
361 runtime->dma_addr, runtime->dma_bytes);
363 pr_debug("%s: ret: %d %p 0x%08x 0x%08x\n", __func__, ret,
369 EXPORT_SYMBOL_GPL(snd_imx_pcm_mmap);
371 static int imx_pcm_preallocate_dma_buffer(struct snd_pcm *pcm, int stream)
373 struct snd_pcm_substream *substream = pcm->streams[stream].substream;
374 struct snd_dma_buffer *buf = &substream->dma_buffer;
375 size_t size = IMX_SSI_DMABUF_SIZE;
377 buf->dev.type = SNDRV_DMA_TYPE_DEV;
378 buf->dev.dev = pcm->card->dev;
379 buf->private_data = NULL;
380 buf->area = dma_alloc_writecombine(pcm->card->dev, size,
381 &buf->addr, GFP_KERNEL);
389 static u64 imx_pcm_dmamask = DMA_BIT_MASK(32);
391 int imx_pcm_new(struct snd_card *card, struct snd_soc_dai *dai,
397 if (!card->dev->dma_mask)
398 card->dev->dma_mask = &imx_pcm_dmamask;
399 if (!card->dev->coherent_dma_mask)
400 card->dev->coherent_dma_mask = DMA_BIT_MASK(32);
401 if (dai->driver->playback.channels_min) {
402 ret = imx_pcm_preallocate_dma_buffer(pcm,
403 SNDRV_PCM_STREAM_PLAYBACK);
408 if (dai->driver->capture.channels_min) {
409 ret = imx_pcm_preallocate_dma_buffer(pcm,
410 SNDRV_PCM_STREAM_CAPTURE);
418 EXPORT_SYMBOL_GPL(imx_pcm_new);
420 void imx_pcm_free(struct snd_pcm *pcm)
422 struct snd_pcm_substream *substream;
423 struct snd_dma_buffer *buf;
426 for (stream = 0; stream < 2; stream++) {
427 substream = pcm->streams[stream].substream;
431 buf = &substream->dma_buffer;
435 dma_free_writecombine(pcm->card->dev, buf->bytes,
436 buf->area, buf->addr);
440 EXPORT_SYMBOL_GPL(imx_pcm_free);
442 static int imx_ssi_dai_probe(struct snd_soc_dai *dai)
444 struct imx_ssi *ssi = dev_get_drvdata(dai->dev);
447 snd_soc_dai_set_drvdata(dai, ssi);
449 val = SSI_SFCSR_TFWM0(ssi->dma_params_tx.burstsize) |
450 SSI_SFCSR_RFWM0(ssi->dma_params_rx.burstsize);
451 writel(val, ssi->base + SSI_SFCSR);
456 static struct snd_soc_dai_driver imx_ssi_dai = {
457 .probe = imx_ssi_dai_probe,
461 .rates = SNDRV_PCM_RATE_8000_96000,
462 .formats = SNDRV_PCM_FMTBIT_S16_LE,
467 .rates = SNDRV_PCM_RATE_8000_96000,
468 .formats = SNDRV_PCM_FMTBIT_S16_LE,
470 .ops = &imx_ssi_pcm_dai_ops,
473 static struct snd_soc_dai_driver imx_ac97_dai = {
474 .probe = imx_ssi_dai_probe,
477 .stream_name = "AC97 Playback",
480 .rates = SNDRV_PCM_RATE_48000,
481 .formats = SNDRV_PCM_FMTBIT_S16_LE,
484 .stream_name = "AC97 Capture",
487 .rates = SNDRV_PCM_RATE_48000,
488 .formats = SNDRV_PCM_FMTBIT_S16_LE,
490 .ops = &imx_ssi_pcm_dai_ops,
493 static void setup_channel_to_ac97(struct imx_ssi *imx_ssi)
495 void __iomem *base = imx_ssi->base;
497 writel(0x0, base + SSI_SCR);
498 writel(0x0, base + SSI_STCR);
499 writel(0x0, base + SSI_SRCR);
501 writel(SSI_SCR_SYN | SSI_SCR_NET, base + SSI_SCR);
503 writel(SSI_SFCSR_RFWM0(8) |
506 SSI_SFCSR_TFWM1(8), base + SSI_SFCSR);
508 writel(SSI_STCCR_WL(16) | SSI_STCCR_DC(12), base + SSI_STCCR);
509 writel(SSI_STCCR_WL(16) | SSI_STCCR_DC(12), base + SSI_SRCCR);
511 writel(SSI_SCR_SYN | SSI_SCR_NET | SSI_SCR_SSIEN, base + SSI_SCR);
512 writel(SSI_SOR_WAIT(3), base + SSI_SOR);
514 writel(SSI_SCR_SYN | SSI_SCR_NET | SSI_SCR_SSIEN |
515 SSI_SCR_TE | SSI_SCR_RE,
518 writel(SSI_SACNT_DEFAULT, base + SSI_SACNT);
519 writel(0xff, base + SSI_SACCDIS);
520 writel(0x300, base + SSI_SACCEN);
523 static struct imx_ssi *ac97_ssi;
525 static void imx_ssi_ac97_write(struct snd_ac97 *ac97, unsigned short reg,
528 struct imx_ssi *imx_ssi = ac97_ssi;
529 void __iomem *base = imx_ssi->base;
536 pr_debug("%s: 0x%02x 0x%04x\n", __func__, reg, val);
539 writel(lreg, base + SSI_SACADD);
542 writel(lval , base + SSI_SACDAT);
544 writel(SSI_SACNT_DEFAULT | SSI_SACNT_WR, base + SSI_SACNT);
548 static unsigned short imx_ssi_ac97_read(struct snd_ac97 *ac97,
551 struct imx_ssi *imx_ssi = ac97_ssi;
552 void __iomem *base = imx_ssi->base;
554 unsigned short val = -1;
557 lreg = (reg & 0x7f) << 12 ;
558 writel(lreg, base + SSI_SACADD);
559 writel(SSI_SACNT_DEFAULT | SSI_SACNT_RD, base + SSI_SACNT);
563 val = (readl(base + SSI_SACDAT) >> 4) & 0xffff;
565 pr_debug("%s: 0x%02x 0x%04x\n", __func__, reg, val);
570 static void imx_ssi_ac97_reset(struct snd_ac97 *ac97)
572 struct imx_ssi *imx_ssi = ac97_ssi;
574 if (imx_ssi->ac97_reset)
575 imx_ssi->ac97_reset(ac97);
578 static void imx_ssi_ac97_warm_reset(struct snd_ac97 *ac97)
580 struct imx_ssi *imx_ssi = ac97_ssi;
582 if (imx_ssi->ac97_warm_reset)
583 imx_ssi->ac97_warm_reset(ac97);
586 struct snd_ac97_bus_ops soc_ac97_ops = {
587 .read = imx_ssi_ac97_read,
588 .write = imx_ssi_ac97_write,
589 .reset = imx_ssi_ac97_reset,
590 .warm_reset = imx_ssi_ac97_warm_reset
592 EXPORT_SYMBOL_GPL(soc_ac97_ops);
594 static int imx_ssi_probe(struct platform_device *pdev)
596 struct resource *res;
598 struct imx_ssi_platform_data *pdata = pdev->dev.platform_data;
600 struct snd_soc_dai_driver *dai;
602 ssi = kzalloc(sizeof(*ssi), GFP_KERNEL);
605 dev_set_drvdata(&pdev->dev, ssi);
608 ssi->ac97_reset = pdata->ac97_reset;
609 ssi->ac97_warm_reset = pdata->ac97_warm_reset;
610 ssi->flags = pdata->flags;
613 ssi->irq = platform_get_irq(pdev, 0);
615 ssi->clk = clk_get(&pdev->dev, NULL);
616 if (IS_ERR(ssi->clk)) {
617 ret = PTR_ERR(ssi->clk);
618 dev_err(&pdev->dev, "Cannot get the clock: %d\n",
622 clk_enable(ssi->clk);
624 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
627 goto failed_get_resource;
630 if (!request_mem_region(res->start, resource_size(res), DRV_NAME)) {
631 dev_err(&pdev->dev, "request_mem_region failed\n");
633 goto failed_get_resource;
636 ssi->base = ioremap(res->start, resource_size(res));
638 dev_err(&pdev->dev, "ioremap failed\n");
643 if (ssi->flags & IMX_SSI_USE_AC97) {
649 setup_channel_to_ac97(ssi);
654 writel(0x0, ssi->base + SSI_SIER);
656 ssi->dma_params_rx.dma_addr = res->start + SSI_SRX0;
657 ssi->dma_params_tx.dma_addr = res->start + SSI_STX0;
659 res = platform_get_resource_byname(pdev, IORESOURCE_DMA, "tx0");
661 ssi->dma_params_tx.dma = res->start;
663 res = platform_get_resource_byname(pdev, IORESOURCE_DMA, "rx0");
665 ssi->dma_params_rx.dma = res->start;
667 if ((cpu_is_mx27() || cpu_is_mx21()) &&
668 !(ssi->flags & IMX_SSI_USE_AC97) &&
669 (ssi->flags & IMX_SSI_DMA)) {
670 ssi->flags |= IMX_SSI_DMA;
673 platform_set_drvdata(pdev, ssi);
675 ret = snd_soc_register_dai(&pdev->dev, dai);
677 dev_err(&pdev->dev, "register DAI failed\n");
678 goto failed_register;
681 ssi->soc_platform_pdev_fiq = platform_device_alloc("imx-fiq-pcm-audio", pdev->id);
682 if (!ssi->soc_platform_pdev_fiq) {
684 goto failed_pdev_fiq_alloc;
687 platform_set_drvdata(ssi->soc_platform_pdev_fiq, ssi);
688 ret = platform_device_add(ssi->soc_platform_pdev_fiq);
690 dev_err(&pdev->dev, "failed to add platform device\n");
691 goto failed_pdev_fiq_add;
694 ssi->soc_platform_pdev = platform_device_alloc("imx-pcm-audio", pdev->id);
695 if (!ssi->soc_platform_pdev) {
697 goto failed_pdev_alloc;
700 platform_set_drvdata(ssi->soc_platform_pdev, ssi);
701 ret = platform_device_add(ssi->soc_platform_pdev);
703 dev_err(&pdev->dev, "failed to add platform device\n");
704 goto failed_pdev_add;
710 platform_device_put(ssi->soc_platform_pdev);
712 platform_device_del(ssi->soc_platform_pdev_fiq);
714 platform_device_put(ssi->soc_platform_pdev_fiq);
715 failed_pdev_fiq_alloc:
716 snd_soc_unregister_dai(&pdev->dev);
721 release_mem_region(res->start, resource_size(res));
723 clk_disable(ssi->clk);
731 static int __devexit imx_ssi_remove(struct platform_device *pdev)
733 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
734 struct imx_ssi *ssi = platform_get_drvdata(pdev);
736 platform_device_unregister(ssi->soc_platform_pdev);
737 platform_device_unregister(ssi->soc_platform_pdev_fiq);
739 snd_soc_unregister_dai(&pdev->dev);
741 if (ssi->flags & IMX_SSI_USE_AC97)
745 release_mem_region(res->start, resource_size(res));
746 clk_disable(ssi->clk);
753 static struct platform_driver imx_ssi_driver = {
754 .probe = imx_ssi_probe,
755 .remove = __devexit_p(imx_ssi_remove),
759 .owner = THIS_MODULE,
763 static int __init imx_ssi_init(void)
765 return platform_driver_register(&imx_ssi_driver);
768 static void __exit imx_ssi_exit(void)
770 platform_driver_unregister(&imx_ssi_driver);
773 module_init(imx_ssi_init);
774 module_exit(imx_ssi_exit);
776 /* Module information */
777 MODULE_AUTHOR("Sascha Hauer, <s.hauer@pengutronix.de>");
778 MODULE_DESCRIPTION("i.MX I2S/ac97 SoC Interface");
779 MODULE_LICENSE("GPL");