2 * ALSA SoC I2S Audio Layer for the Stretch S6000 family
4 * Author: Daniel Gloeckner, <dg@emlix.com>
5 * Copyright: (C) 2009 emlix GmbH <info@emlix.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/device.h>
15 #include <linux/delay.h>
16 #include <linux/clk.h>
17 #include <linux/interrupt.h>
20 #include <sound/core.h>
21 #include <sound/pcm.h>
22 #include <sound/pcm_params.h>
23 #include <sound/initval.h>
24 #include <sound/soc.h>
26 #include "s6000-i2s.h"
27 #include "s6000-pcm.h"
29 struct s6000_i2s_dev {
33 unsigned int channel_in;
34 unsigned int channel_out;
35 unsigned int lines_in;
36 unsigned int lines_out;
37 struct s6000_pcm_dma_params dma_params;
40 #define S6_I2S_INTERRUPT_STATUS 0x00
41 #define S6_I2S_INT_OVERRUN 1
42 #define S6_I2S_INT_UNDERRUN 2
43 #define S6_I2S_INT_ALIGNMENT 4
44 #define S6_I2S_INTERRUPT_ENABLE 0x04
45 #define S6_I2S_INTERRUPT_RAW 0x08
46 #define S6_I2S_INTERRUPT_CLEAR 0x0C
47 #define S6_I2S_INTERRUPT_SET 0x10
48 #define S6_I2S_MODE 0x20
51 #define S6_I2S_TX_DEFAULT 0x24
52 #define S6_I2S_DATA_CFG(c) (0x40 + 0x10 * (c))
55 #define S6_I2S_UNUSED 2
56 #define S6_I2S_INTERFACE_CFG(c) (0x44 + 0x10 * (c))
57 #define S6_I2S_DIV_MASK 0x001fff
58 #define S6_I2S_16BIT 0x000000
59 #define S6_I2S_20BIT 0x002000
60 #define S6_I2S_24BIT 0x004000
61 #define S6_I2S_32BIT 0x006000
62 #define S6_I2S_BITS_MASK 0x006000
63 #define S6_I2S_MEM_16BIT 0x000000
64 #define S6_I2S_MEM_32BIT 0x008000
65 #define S6_I2S_MEM_MASK 0x008000
66 #define S6_I2S_CHANNELS_SHIFT 16
67 #define S6_I2S_CHANNELS_MASK 0x030000
68 #define S6_I2S_SCK_IN 0x000000
69 #define S6_I2S_SCK_OUT 0x040000
70 #define S6_I2S_SCK_DIR 0x040000
71 #define S6_I2S_WS_IN 0x000000
72 #define S6_I2S_WS_OUT 0x080000
73 #define S6_I2S_WS_DIR 0x080000
74 #define S6_I2S_LEFT_FIRST 0x000000
75 #define S6_I2S_RIGHT_FIRST 0x100000
76 #define S6_I2S_FIRST 0x100000
77 #define S6_I2S_CUR_SCK 0x200000
78 #define S6_I2S_CUR_WS 0x400000
79 #define S6_I2S_ENABLE(c) (0x48 + 0x10 * (c))
80 #define S6_I2S_DISABLE_IF 0x02
81 #define S6_I2S_ENABLE_IF 0x03
82 #define S6_I2S_IS_BUSY 0x04
83 #define S6_I2S_DMA_ACTIVE 0x08
84 #define S6_I2S_IS_ENABLED 0x10
86 #define S6_I2S_NUM_LINES 4
88 #define S6_I2S_SIF_PORT0 0x0000000
89 #define S6_I2S_SIF_PORT1 0x0000080 /* docs say 0x0000010 */
91 static inline void s6_i2s_write_reg(struct s6000_i2s_dev *dev, int reg, u32 val)
93 writel(val, dev->scbbase + reg);
96 static inline u32 s6_i2s_read_reg(struct s6000_i2s_dev *dev, int reg)
98 return readl(dev->scbbase + reg);
101 static inline void s6_i2s_mod_reg(struct s6000_i2s_dev *dev, int reg,
104 val ^= s6_i2s_read_reg(dev, reg) & ~mask;
105 s6_i2s_write_reg(dev, reg, val);
108 static void s6000_i2s_start_channel(struct s6000_i2s_dev *dev, int channel)
113 * Wait for WCLK to toggle 5 times before enabling the channel
114 * s6000 Family Datasheet 3.6.4:
115 * "At least two cycles of WS must occur between commands
116 * to disable or enable the interface"
119 prev = ~S6_I2S_CUR_WS;
120 for (i = 1000000; --i && j < 6; ) {
121 cur = s6_i2s_read_reg(dev, S6_I2S_INTERFACE_CFG(channel))
129 printk(KERN_WARNING "s6000-i2s: timeout waiting for WCLK\n");
131 s6_i2s_write_reg(dev, S6_I2S_ENABLE(channel), S6_I2S_ENABLE_IF);
134 static void s6000_i2s_stop_channel(struct s6000_i2s_dev *dev, int channel)
136 s6_i2s_write_reg(dev, S6_I2S_ENABLE(channel), S6_I2S_DISABLE_IF);
139 static void s6000_i2s_start(struct snd_pcm_substream *substream)
141 struct snd_soc_pcm_runtime *rtd = substream->private_data;
142 struct s6000_i2s_dev *dev = rtd->dai->cpu_dai->private_data;
145 channel = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
146 dev->channel_out : dev->channel_in;
148 s6000_i2s_start_channel(dev, channel);
151 static void s6000_i2s_stop(struct snd_pcm_substream *substream)
153 struct snd_soc_pcm_runtime *rtd = substream->private_data;
154 struct s6000_i2s_dev *dev = rtd->dai->cpu_dai->private_data;
157 channel = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
158 dev->channel_out : dev->channel_in;
160 s6000_i2s_stop_channel(dev, channel);
163 static int s6000_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
167 case SNDRV_PCM_TRIGGER_START:
168 case SNDRV_PCM_TRIGGER_RESUME:
169 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
170 if ((substream->stream == SNDRV_PCM_STREAM_CAPTURE) ^ !after)
171 s6000_i2s_start(substream);
173 case SNDRV_PCM_TRIGGER_STOP:
174 case SNDRV_PCM_TRIGGER_SUSPEND:
175 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
177 s6000_i2s_stop(substream);
182 static unsigned int s6000_i2s_int_sources(struct s6000_i2s_dev *dev)
184 unsigned int pending;
185 pending = s6_i2s_read_reg(dev, S6_I2S_INTERRUPT_RAW);
186 pending &= S6_I2S_INT_ALIGNMENT |
187 S6_I2S_INT_UNDERRUN |
189 s6_i2s_write_reg(dev, S6_I2S_INTERRUPT_CLEAR, pending);
194 static unsigned int s6000_i2s_check_xrun(struct snd_soc_dai *cpu_dai)
196 struct s6000_i2s_dev *dev = cpu_dai->private_data;
200 errors = s6000_i2s_int_sources(dev);
205 if (errors & S6_I2S_INT_ALIGNMENT)
206 printk(KERN_ERR "s6000-i2s: WCLK misaligned\n");
207 if (errors & S6_I2S_INT_UNDERRUN)
208 ret |= 1 << SNDRV_PCM_STREAM_PLAYBACK;
209 if (errors & S6_I2S_INT_OVERRUN)
210 ret |= 1 << SNDRV_PCM_STREAM_CAPTURE;
214 static void s6000_i2s_wait_disabled(struct s6000_i2s_dev *dev)
218 for (channel = 0; channel < 2; channel++) {
220 int v = s6_i2s_read_reg(dev, S6_I2S_ENABLE(channel));
221 if ((v & S6_I2S_IS_ENABLED)
222 || !(v & (S6_I2S_DMA_ACTIVE | S6_I2S_IS_BUSY)))
228 printk(KERN_WARNING "s6000-i2s: timeout disabling interfaces");
231 static int s6000_i2s_set_dai_fmt(struct snd_soc_dai *cpu_dai,
234 struct s6000_i2s_dev *dev = cpu_dai->private_data;
237 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
238 case SND_SOC_DAIFMT_CBM_CFM:
239 w = S6_I2S_SCK_IN | S6_I2S_WS_IN;
241 case SND_SOC_DAIFMT_CBS_CFM:
242 w = S6_I2S_SCK_OUT | S6_I2S_WS_IN;
244 case SND_SOC_DAIFMT_CBM_CFS:
245 w = S6_I2S_SCK_IN | S6_I2S_WS_OUT;
247 case SND_SOC_DAIFMT_CBS_CFS:
248 w = S6_I2S_SCK_OUT | S6_I2S_WS_OUT;
254 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
255 case SND_SOC_DAIFMT_NB_NF:
256 w |= S6_I2S_LEFT_FIRST;
258 case SND_SOC_DAIFMT_NB_IF:
259 w |= S6_I2S_RIGHT_FIRST;
265 s6_i2s_mod_reg(dev, S6_I2S_INTERFACE_CFG(0),
266 S6_I2S_FIRST | S6_I2S_WS_DIR | S6_I2S_SCK_DIR, w);
267 s6_i2s_mod_reg(dev, S6_I2S_INTERFACE_CFG(1),
268 S6_I2S_FIRST | S6_I2S_WS_DIR | S6_I2S_SCK_DIR, w);
273 static int s6000_i2s_set_clkdiv(struct snd_soc_dai *dai, int div_id, int div)
275 struct s6000_i2s_dev *dev = dai->private_data;
277 if (!div || (div & 1) || div > (S6_I2S_DIV_MASK + 1) * 2)
280 s6_i2s_mod_reg(dev, S6_I2S_INTERFACE_CFG(div_id),
281 S6_I2S_DIV_MASK, div / 2 - 1);
285 static int s6000_i2s_hw_params(struct snd_pcm_substream *substream,
286 struct snd_pcm_hw_params *params,
287 struct snd_soc_dai *dai)
289 struct s6000_i2s_dev *dev = dai->private_data;
296 w |= (((params_channels(params) - 2) / 2)
297 << S6_I2S_CHANNELS_SHIFT) & S6_I2S_CHANNELS_MASK;
298 interf = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
299 ? dev->channel_out : dev->channel_in;
302 switch (params_format(params)) {
303 case SNDRV_PCM_FORMAT_S16_LE:
304 w |= S6_I2S_16BIT | S6_I2S_MEM_16BIT;
306 case SNDRV_PCM_FORMAT_S32_LE:
307 w |= S6_I2S_32BIT | S6_I2S_MEM_32BIT;
310 printk(KERN_WARNING "s6000-i2s: unsupported PCM format %x\n",
311 params_format(params));
315 if (s6_i2s_read_reg(dev, S6_I2S_INTERFACE_CFG(interf))
316 & S6_I2S_IS_ENABLED) {
317 printk(KERN_ERR "s6000-i2s: interface already enabled\n");
321 s6_i2s_mod_reg(dev, S6_I2S_INTERFACE_CFG(interf),
322 S6_I2S_CHANNELS_MASK|S6_I2S_MEM_MASK|S6_I2S_BITS_MASK,
328 static int s6000_i2s_dai_probe(struct platform_device *pdev,
329 struct snd_soc_dai *dai)
331 struct s6000_i2s_dev *dev = dai->private_data;
332 struct s6000_snd_platform_data *pdata = pdev->dev.platform_data;
337 dev->wide = pdata->wide;
338 dev->channel_in = pdata->channel_in;
339 dev->channel_out = pdata->channel_out;
340 dev->lines_in = pdata->lines_in;
341 dev->lines_out = pdata->lines_out;
343 s6_i2s_write_reg(dev, S6_I2S_MODE,
344 dev->wide ? S6_I2S_WIDE : S6_I2S_DUAL);
349 if (dev->lines_in + dev->lines_out > S6_I2S_NUM_LINES)
353 dev->channel_out = 1;
354 dai->capture.channels_min = 2 * dev->lines_in;
355 dai->capture.channels_max = dai->capture.channels_min;
356 dai->playback.channels_min = 2 * dev->lines_out;
357 dai->playback.channels_max = dai->playback.channels_min;
359 for (i = 0; i < dev->lines_out; i++)
360 s6_i2s_write_reg(dev, S6_I2S_DATA_CFG(i), S6_I2S_OUT);
362 for (; i < S6_I2S_NUM_LINES - dev->lines_in; i++)
363 s6_i2s_write_reg(dev, S6_I2S_DATA_CFG(i),
366 for (; i < S6_I2S_NUM_LINES; i++)
367 s6_i2s_write_reg(dev, S6_I2S_DATA_CFG(i), S6_I2S_IN);
369 unsigned int cfg[2] = {S6_I2S_UNUSED, S6_I2S_UNUSED};
371 if (dev->lines_in > 1 || dev->lines_out > 1)
374 dai->capture.channels_min = 2 * dev->lines_in;
375 dai->capture.channels_max = 8 * dev->lines_in;
376 dai->playback.channels_min = 2 * dev->lines_out;
377 dai->playback.channels_max = 8 * dev->lines_out;
380 cfg[dev->channel_in] = S6_I2S_IN;
382 cfg[dev->channel_out] = S6_I2S_OUT;
384 s6_i2s_write_reg(dev, S6_I2S_DATA_CFG(0), cfg[0]);
385 s6_i2s_write_reg(dev, S6_I2S_DATA_CFG(1), cfg[1]);
388 if (dev->lines_out) {
390 if (!dev->dma_params.dma_out)
393 dev->dma_params.dma_out = dev->dma_params.dma_in;
394 dev->dma_params.dma_in = 0;
397 dev->dma_params.sif_in = dev->sifbase + (dev->channel_in ?
398 S6_I2S_SIF_PORT1 : S6_I2S_SIF_PORT0);
399 dev->dma_params.sif_out = dev->sifbase + (dev->channel_out ?
400 S6_I2S_SIF_PORT1 : S6_I2S_SIF_PORT0);
401 dev->dma_params.same_rate = pdata->same_rate | pdata->wide;
405 #define S6000_I2S_RATES (SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_5512 | \
406 SNDRV_PCM_RATE_8000_192000)
407 #define S6000_I2S_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S32_LE)
409 static struct snd_soc_dai_ops s6000_i2s_dai_ops = {
410 .set_fmt = s6000_i2s_set_dai_fmt,
411 .set_clkdiv = s6000_i2s_set_clkdiv,
412 .hw_params = s6000_i2s_hw_params,
415 struct snd_soc_dai s6000_i2s_dai = {
418 .probe = s6000_i2s_dai_probe,
422 .formats = S6000_I2S_FORMATS,
423 .rates = S6000_I2S_RATES,
430 .formats = S6000_I2S_FORMATS,
431 .rates = S6000_I2S_RATES,
435 .ops = &s6000_i2s_dai_ops,
437 EXPORT_SYMBOL_GPL(s6000_i2s_dai);
439 static int __devinit s6000_i2s_probe(struct platform_device *pdev)
441 struct s6000_i2s_dev *dev;
442 struct resource *scbmem, *sifmem, *region, *dma1, *dma2;
446 scbmem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
448 dev_err(&pdev->dev, "no mem resource?\n");
450 goto err_release_none;
453 region = request_mem_region(scbmem->start,
454 scbmem->end - scbmem->start + 1,
457 dev_err(&pdev->dev, "I2S SCB region already claimed\n");
459 goto err_release_none;
462 mmio = ioremap(scbmem->start, scbmem->end - scbmem->start + 1);
464 dev_err(&pdev->dev, "can't ioremap SCB region\n");
466 goto err_release_scb;
469 sifmem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
471 dev_err(&pdev->dev, "no second mem resource?\n");
473 goto err_release_map;
476 region = request_mem_region(sifmem->start,
477 sifmem->end - sifmem->start + 1,
480 dev_err(&pdev->dev, "I2S SIF region already claimed\n");
482 goto err_release_map;
485 dma1 = platform_get_resource(pdev, IORESOURCE_DMA, 0);
487 dev_err(&pdev->dev, "no dma resource?\n");
489 goto err_release_sif;
492 region = request_mem_region(dma1->start, dma1->end - dma1->start + 1,
495 dev_err(&pdev->dev, "I2S DMA region already claimed\n");
497 goto err_release_sif;
500 dma2 = platform_get_resource(pdev, IORESOURCE_DMA, 1);
502 region = request_mem_region(dma2->start,
503 dma2->end - dma2->start + 1,
507 "I2S DMA region already claimed\n");
509 goto err_release_dma1;
513 dev = kzalloc(sizeof(struct s6000_i2s_dev), GFP_KERNEL);
516 goto err_release_dma2;
519 s6000_i2s_dai.dev = &pdev->dev;
520 s6000_i2s_dai.private_data = dev;
521 s6000_i2s_dai.dma_data = &dev->dma_params;
523 dev->sifbase = sifmem->start;
526 s6_i2s_write_reg(dev, S6_I2S_INTERRUPT_ENABLE, 0);
527 s6_i2s_write_reg(dev, S6_I2S_INTERRUPT_CLEAR,
528 S6_I2S_INT_ALIGNMENT |
529 S6_I2S_INT_UNDERRUN |
532 s6000_i2s_stop_channel(dev, 0);
533 s6000_i2s_stop_channel(dev, 1);
534 s6000_i2s_wait_disabled(dev);
536 dev->dma_params.check_xrun = s6000_i2s_check_xrun;
537 dev->dma_params.trigger = s6000_i2s_trigger;
538 dev->dma_params.dma_in = dma1->start;
539 dev->dma_params.dma_out = dma2 ? dma2->start : 0;
540 dev->dma_params.irq = platform_get_irq(pdev, 0);
541 if (dev->dma_params.irq < 0) {
542 dev_err(&pdev->dev, "no irq resource?\n");
544 goto err_release_dev;
547 s6_i2s_write_reg(dev, S6_I2S_INTERRUPT_ENABLE,
548 S6_I2S_INT_ALIGNMENT |
549 S6_I2S_INT_UNDERRUN |
552 ret = snd_soc_register_dai(&s6000_i2s_dai);
554 goto err_release_dev;
562 release_mem_region(dma2->start, dma2->end - dma2->start + 1);
564 release_mem_region(dma1->start, dma1->end - dma1->start + 1);
566 release_mem_region(sifmem->start, (sifmem->end - sifmem->start) + 1);
570 release_mem_region(scbmem->start, (scbmem->end - scbmem->start) + 1);
575 static void __devexit s6000_i2s_remove(struct platform_device *pdev)
577 struct s6000_i2s_dev *dev = s6000_i2s_dai.private_data;
578 struct resource *region;
579 void __iomem *mmio = dev->scbbase;
581 snd_soc_unregister_dai(&s6000_i2s_dai);
583 s6000_i2s_stop_channel(dev, 0);
584 s6000_i2s_stop_channel(dev, 1);
586 s6_i2s_write_reg(dev, S6_I2S_INTERRUPT_ENABLE, 0);
587 s6000_i2s_dai.private_data = 0;
590 region = platform_get_resource(pdev, IORESOURCE_DMA, 0);
591 release_mem_region(region->start, region->end - region->start + 1);
593 region = platform_get_resource(pdev, IORESOURCE_DMA, 1);
595 release_mem_region(region->start,
596 region->end - region->start + 1);
598 region = platform_get_resource(pdev, IORESOURCE_MEM, 0);
599 release_mem_region(region->start, (region->end - region->start) + 1);
602 region = platform_get_resource(pdev, IORESOURCE_IO, 0);
603 release_mem_region(region->start, (region->end - region->start) + 1);
606 static struct platform_driver s6000_i2s_driver = {
607 .probe = s6000_i2s_probe,
608 .remove = __devexit_p(s6000_i2s_remove),
611 .owner = THIS_MODULE,
615 static int __init s6000_i2s_init(void)
617 return platform_driver_register(&s6000_i2s_driver);
619 module_init(s6000_i2s_init);
621 static void __exit s6000_i2s_exit(void)
623 platform_driver_unregister(&s6000_i2s_driver);
625 module_exit(s6000_i2s_exit);
627 MODULE_AUTHOR("Daniel Gloeckner");
628 MODULE_DESCRIPTION("Stretch s6000 family I2S SoC Interface");
629 MODULE_LICENSE("GPL");