2 * ALSA SoC Synopsys I2S Audio Layer
4 * sound/soc/dwc/designware_i2s.c
6 * Copyright (C) 2010 ST Microelectronics
7 * Rajeev Kumar <rajeevkumar.linux@gmail.com>
9 * This file is licensed under the terms of the GNU General Public
10 * License version 2. This program is licensed "as is" without any
11 * warranty of any kind, whether express or implied.
14 #include <linux/clk.h>
15 #include <linux/device.h>
16 #include <linux/init.h>
18 #include <linux/interrupt.h>
19 #include <linux/module.h>
20 #include <linux/slab.h>
21 #include <linux/pm_runtime.h>
22 #include <sound/designware_i2s.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/dmaengine_pcm.h>
29 static inline void i2s_write_reg(void __iomem *io_base, int reg, u32 val)
31 writel(val, io_base + reg);
34 static inline u32 i2s_read_reg(void __iomem *io_base, int reg)
36 return readl(io_base + reg);
39 static inline void i2s_disable_channels(struct dw_i2s_dev *dev, u32 stream)
43 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
44 for (i = 0; i < 4; i++)
45 i2s_write_reg(dev->i2s_base, TER(i), 0);
47 for (i = 0; i < 4; i++)
48 i2s_write_reg(dev->i2s_base, RER(i), 0);
52 static inline void i2s_clear_irqs(struct dw_i2s_dev *dev, u32 stream)
56 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
57 for (i = 0; i < 4; i++)
58 i2s_read_reg(dev->i2s_base, TOR(i));
60 for (i = 0; i < 4; i++)
61 i2s_read_reg(dev->i2s_base, ROR(i));
65 static inline void i2s_disable_irqs(struct dw_i2s_dev *dev, u32 stream,
70 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
71 for (i = 0; i < (chan_nr / 2); i++) {
72 irq = i2s_read_reg(dev->i2s_base, IMR(i));
73 i2s_write_reg(dev->i2s_base, IMR(i), irq | 0x30);
76 for (i = 0; i < (chan_nr / 2); i++) {
77 irq = i2s_read_reg(dev->i2s_base, IMR(i));
78 i2s_write_reg(dev->i2s_base, IMR(i), irq | 0x03);
83 static inline void i2s_enable_irqs(struct dw_i2s_dev *dev, u32 stream,
88 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
89 for (i = 0; i < (chan_nr / 2); i++) {
90 irq = i2s_read_reg(dev->i2s_base, IMR(i));
91 i2s_write_reg(dev->i2s_base, IMR(i), irq & ~0x30);
94 for (i = 0; i < (chan_nr / 2); i++) {
95 irq = i2s_read_reg(dev->i2s_base, IMR(i));
96 i2s_write_reg(dev->i2s_base, IMR(i), irq & ~0x03);
101 static irqreturn_t i2s_irq_handler(int irq, void *dev_id)
103 struct dw_i2s_dev *dev = dev_id;
104 bool irq_valid = false;
108 for (i = 0; i < 4; i++)
109 isr[i] = i2s_read_reg(dev->i2s_base, ISR(i));
111 i2s_clear_irqs(dev, SNDRV_PCM_STREAM_PLAYBACK);
112 i2s_clear_irqs(dev, SNDRV_PCM_STREAM_CAPTURE);
114 for (i = 0; i < 4; i++) {
116 * Check if TX fifo is empty. If empty fill FIFO with samples
117 * NOTE: Only two channels supported
119 if ((isr[i] & ISR_TXFE) && (i == 0) && dev->use_pio) {
125 * Data available. Retrieve samples from FIFO
126 * NOTE: Only two channels supported
128 if ((isr[i] & ISR_RXDA) && (i == 0) && dev->use_pio) {
133 /* Error Handling: TX */
134 if (isr[i] & ISR_TXFO) {
135 dev_err_ratelimited(dev->dev, "TX overrun (ch_id=%d)\n", i);
139 /* Error Handling: TX */
140 if (isr[i] & ISR_RXFO) {
141 dev_err_ratelimited(dev->dev, "RX overrun (ch_id=%d)\n", i);
152 static void i2s_start(struct dw_i2s_dev *dev,
153 struct snd_pcm_substream *substream)
155 struct i2s_clk_config_data *config = &dev->config;
157 i2s_write_reg(dev->i2s_base, IER, 1);
158 i2s_enable_irqs(dev, substream->stream, config->chan_nr);
160 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
161 i2s_write_reg(dev->i2s_base, ITER, 1);
163 i2s_write_reg(dev->i2s_base, IRER, 1);
165 i2s_write_reg(dev->i2s_base, CER, 1);
168 static void i2s_stop(struct dw_i2s_dev *dev,
169 struct snd_pcm_substream *substream)
172 i2s_clear_irqs(dev, substream->stream);
173 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
174 i2s_write_reg(dev->i2s_base, ITER, 0);
176 i2s_write_reg(dev->i2s_base, IRER, 0);
178 i2s_disable_irqs(dev, substream->stream, 8);
181 i2s_write_reg(dev->i2s_base, CER, 0);
182 i2s_write_reg(dev->i2s_base, IER, 0);
186 static void dw_i2s_config(struct dw_i2s_dev *dev, int stream)
189 struct i2s_clk_config_data *config = &dev->config;
192 i2s_disable_channels(dev, stream);
194 for (ch_reg = 0; ch_reg < (config->chan_nr / 2); ch_reg++) {
195 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
196 i2s_write_reg(dev->i2s_base, TCR(ch_reg),
197 dev->xfer_resolution);
198 i2s_write_reg(dev->i2s_base, TFCR(ch_reg),
200 i2s_write_reg(dev->i2s_base, TER(ch_reg), 1);
202 i2s_write_reg(dev->i2s_base, RCR(ch_reg),
203 dev->xfer_resolution);
204 i2s_write_reg(dev->i2s_base, RFCR(ch_reg),
206 i2s_write_reg(dev->i2s_base, RER(ch_reg), 1);
212 static int dw_i2s_hw_params(struct snd_pcm_substream *substream,
213 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
215 struct dw_i2s_dev *dev = snd_soc_dai_get_drvdata(dai);
216 struct i2s_clk_config_data *config = &dev->config;
219 switch (params_format(params)) {
220 case SNDRV_PCM_FORMAT_S16_LE:
221 config->data_width = 16;
223 dev->xfer_resolution = 0x02;
226 case SNDRV_PCM_FORMAT_S24_LE:
227 config->data_width = 24;
229 dev->xfer_resolution = 0x04;
232 case SNDRV_PCM_FORMAT_S32_LE:
233 config->data_width = 32;
235 dev->xfer_resolution = 0x05;
239 dev_err(dev->dev, "designware-i2s: unsupported PCM fmt");
243 config->chan_nr = params_channels(params);
245 switch (config->chan_nr) {
246 case EIGHT_CHANNEL_SUPPORT:
247 case SIX_CHANNEL_SUPPORT:
248 case FOUR_CHANNEL_SUPPORT:
249 case TWO_CHANNEL_SUPPORT:
252 dev_err(dev->dev, "channel not supported\n");
256 dw_i2s_config(dev, substream->stream);
258 i2s_write_reg(dev->i2s_base, CCR, dev->ccr);
260 config->sample_rate = params_rate(params);
262 if (dev->capability & DW_I2S_MASTER) {
263 if (dev->i2s_clk_cfg) {
264 ret = dev->i2s_clk_cfg(config);
266 dev_err(dev->dev, "runtime audio clk config fail\n");
270 u32 bitclk = config->sample_rate *
271 config->data_width * 2;
273 ret = clk_set_rate(dev->clk, bitclk);
275 dev_err(dev->dev, "Can't set I2S clock rate: %d\n",
284 static int dw_i2s_prepare(struct snd_pcm_substream *substream,
285 struct snd_soc_dai *dai)
287 struct dw_i2s_dev *dev = snd_soc_dai_get_drvdata(dai);
289 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
290 i2s_write_reg(dev->i2s_base, TXFFR, 1);
292 i2s_write_reg(dev->i2s_base, RXFFR, 1);
297 static int dw_i2s_trigger(struct snd_pcm_substream *substream,
298 int cmd, struct snd_soc_dai *dai)
300 struct dw_i2s_dev *dev = snd_soc_dai_get_drvdata(dai);
304 case SNDRV_PCM_TRIGGER_START:
305 case SNDRV_PCM_TRIGGER_RESUME:
306 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
308 i2s_start(dev, substream);
311 case SNDRV_PCM_TRIGGER_STOP:
312 case SNDRV_PCM_TRIGGER_SUSPEND:
313 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
315 i2s_stop(dev, substream);
324 static int dw_i2s_set_fmt(struct snd_soc_dai *cpu_dai, unsigned int fmt)
326 struct dw_i2s_dev *dev = snd_soc_dai_get_drvdata(cpu_dai);
329 switch (fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
330 case SND_SOC_DAIFMT_BC_FC:
331 if (dev->capability & DW_I2S_SLAVE)
336 case SND_SOC_DAIFMT_BP_FP:
337 if (dev->capability & DW_I2S_MASTER)
342 case SND_SOC_DAIFMT_BC_FP:
343 case SND_SOC_DAIFMT_BP_FC:
347 dev_dbg(dev->dev, "dwc : Invalid clock provider format\n");
354 static const struct snd_soc_dai_ops dw_i2s_dai_ops = {
355 .hw_params = dw_i2s_hw_params,
356 .prepare = dw_i2s_prepare,
357 .trigger = dw_i2s_trigger,
358 .set_fmt = dw_i2s_set_fmt,
362 static int dw_i2s_runtime_suspend(struct device *dev)
364 struct dw_i2s_dev *dw_dev = dev_get_drvdata(dev);
366 if (dw_dev->capability & DW_I2S_MASTER)
367 clk_disable(dw_dev->clk);
371 static int dw_i2s_runtime_resume(struct device *dev)
373 struct dw_i2s_dev *dw_dev = dev_get_drvdata(dev);
376 if (dw_dev->capability & DW_I2S_MASTER) {
377 ret = clk_enable(dw_dev->clk);
384 static int dw_i2s_suspend(struct snd_soc_component *component)
386 struct dw_i2s_dev *dev = snd_soc_component_get_drvdata(component);
388 if (dev->capability & DW_I2S_MASTER)
389 clk_disable(dev->clk);
393 static int dw_i2s_resume(struct snd_soc_component *component)
395 struct dw_i2s_dev *dev = snd_soc_component_get_drvdata(component);
396 struct snd_soc_dai *dai;
399 if (dev->capability & DW_I2S_MASTER) {
400 ret = clk_enable(dev->clk);
405 for_each_component_dais(component, dai) {
406 for_each_pcm_streams(stream)
407 if (snd_soc_dai_stream_active(dai, stream))
408 dw_i2s_config(dev, stream);
415 #define dw_i2s_suspend NULL
416 #define dw_i2s_resume NULL
419 static const struct snd_soc_component_driver dw_i2s_component = {
421 .suspend = dw_i2s_suspend,
422 .resume = dw_i2s_resume,
423 .legacy_dai_naming = 1,
427 * The following tables allow a direct lookup of various parameters
428 * defined in the I2S block's configuration in terms of sound system
429 * parameters. Each table is sized to the number of entries possible
430 * according to the number of configuration bits describing an I2S
434 /* Maximum bit resolution of a channel - not uniformly spaced */
435 static const u32 fifo_width[COMP_MAX_WORDSIZE] = {
436 12, 16, 20, 24, 32, 0, 0, 0
439 /* Width of (DMA) bus */
440 static const u32 bus_widths[COMP_MAX_DATA_WIDTH] = {
441 DMA_SLAVE_BUSWIDTH_1_BYTE,
442 DMA_SLAVE_BUSWIDTH_2_BYTES,
443 DMA_SLAVE_BUSWIDTH_4_BYTES,
444 DMA_SLAVE_BUSWIDTH_UNDEFINED
447 /* PCM format to support channel resolution */
448 static const u32 formats[COMP_MAX_WORDSIZE] = {
449 SNDRV_PCM_FMTBIT_S16_LE,
450 SNDRV_PCM_FMTBIT_S16_LE,
451 SNDRV_PCM_FMTBIT_S24_LE,
452 SNDRV_PCM_FMTBIT_S24_LE,
453 SNDRV_PCM_FMTBIT_S32_LE,
459 static int dw_configure_dai(struct dw_i2s_dev *dev,
460 struct snd_soc_dai_driver *dw_i2s_dai,
464 * Read component parameter registers to extract
465 * the I2S block's configuration.
467 u32 comp1 = i2s_read_reg(dev->i2s_base, dev->i2s_reg_comp1);
468 u32 comp2 = i2s_read_reg(dev->i2s_base, dev->i2s_reg_comp2);
469 u32 fifo_depth = 1 << (1 + COMP1_FIFO_DEPTH_GLOBAL(comp1));
472 if (dev->capability & DWC_I2S_RECORD &&
473 dev->quirks & DW_I2S_QUIRK_COMP_PARAM1)
474 comp1 = comp1 & ~BIT(5);
476 if (dev->capability & DWC_I2S_PLAY &&
477 dev->quirks & DW_I2S_QUIRK_COMP_PARAM1)
478 comp1 = comp1 & ~BIT(6);
480 if (COMP1_TX_ENABLED(comp1)) {
481 dev_dbg(dev->dev, " designware: play supported\n");
482 idx = COMP1_TX_WORDSIZE_0(comp1);
483 if (WARN_ON(idx >= ARRAY_SIZE(formats)))
485 if (dev->quirks & DW_I2S_QUIRK_16BIT_IDX_OVERRIDE)
487 dw_i2s_dai->playback.channels_min = MIN_CHANNEL_NUM;
488 dw_i2s_dai->playback.channels_max =
489 1 << (COMP1_TX_CHANNELS(comp1) + 1);
490 dw_i2s_dai->playback.formats = formats[idx];
491 dw_i2s_dai->playback.rates = rates;
494 if (COMP1_RX_ENABLED(comp1)) {
495 dev_dbg(dev->dev, "designware: record supported\n");
496 idx = COMP2_RX_WORDSIZE_0(comp2);
497 if (WARN_ON(idx >= ARRAY_SIZE(formats)))
499 if (dev->quirks & DW_I2S_QUIRK_16BIT_IDX_OVERRIDE)
501 dw_i2s_dai->capture.channels_min = MIN_CHANNEL_NUM;
502 dw_i2s_dai->capture.channels_max =
503 1 << (COMP1_RX_CHANNELS(comp1) + 1);
504 dw_i2s_dai->capture.formats = formats[idx];
505 dw_i2s_dai->capture.rates = rates;
508 if (COMP1_MODE_EN(comp1)) {
509 dev_dbg(dev->dev, "designware: i2s master mode supported\n");
510 dev->capability |= DW_I2S_MASTER;
512 dev_dbg(dev->dev, "designware: i2s slave mode supported\n");
513 dev->capability |= DW_I2S_SLAVE;
516 dev->fifo_th = fifo_depth / 2;
520 static int dw_configure_dai_by_pd(struct dw_i2s_dev *dev,
521 struct snd_soc_dai_driver *dw_i2s_dai,
522 struct resource *res,
523 const struct i2s_platform_data *pdata)
525 u32 comp1 = i2s_read_reg(dev->i2s_base, dev->i2s_reg_comp1);
526 u32 idx = COMP1_APB_DATA_WIDTH(comp1);
529 if (WARN_ON(idx >= ARRAY_SIZE(bus_widths)))
532 ret = dw_configure_dai(dev, dw_i2s_dai, pdata->snd_rates);
536 if (dev->quirks & DW_I2S_QUIRK_16BIT_IDX_OVERRIDE)
538 /* Set DMA slaves info */
539 dev->play_dma_data.pd.data = pdata->play_dma_data;
540 dev->capture_dma_data.pd.data = pdata->capture_dma_data;
541 dev->play_dma_data.pd.addr = res->start + I2S_TXDMA;
542 dev->capture_dma_data.pd.addr = res->start + I2S_RXDMA;
543 dev->play_dma_data.pd.max_burst = 16;
544 dev->capture_dma_data.pd.max_burst = 16;
545 dev->play_dma_data.pd.addr_width = bus_widths[idx];
546 dev->capture_dma_data.pd.addr_width = bus_widths[idx];
547 dev->play_dma_data.pd.filter = pdata->filter;
548 dev->capture_dma_data.pd.filter = pdata->filter;
553 static int dw_configure_dai_by_dt(struct dw_i2s_dev *dev,
554 struct snd_soc_dai_driver *dw_i2s_dai,
555 struct resource *res)
557 u32 comp1 = i2s_read_reg(dev->i2s_base, I2S_COMP_PARAM_1);
558 u32 comp2 = i2s_read_reg(dev->i2s_base, I2S_COMP_PARAM_2);
559 u32 fifo_depth = 1 << (1 + COMP1_FIFO_DEPTH_GLOBAL(comp1));
560 u32 idx = COMP1_APB_DATA_WIDTH(comp1);
564 if (WARN_ON(idx >= ARRAY_SIZE(bus_widths)))
567 ret = dw_configure_dai(dev, dw_i2s_dai, SNDRV_PCM_RATE_8000_192000);
571 if (COMP1_TX_ENABLED(comp1)) {
572 idx2 = COMP1_TX_WORDSIZE_0(comp1);
574 dev->capability |= DWC_I2S_PLAY;
575 dev->play_dma_data.dt.addr = res->start + I2S_TXDMA;
576 dev->play_dma_data.dt.addr_width = bus_widths[idx];
577 dev->play_dma_data.dt.fifo_size = fifo_depth *
578 (fifo_width[idx2]) >> 8;
579 dev->play_dma_data.dt.maxburst = 16;
581 if (COMP1_RX_ENABLED(comp1)) {
582 idx2 = COMP2_RX_WORDSIZE_0(comp2);
584 dev->capability |= DWC_I2S_RECORD;
585 dev->capture_dma_data.dt.addr = res->start + I2S_RXDMA;
586 dev->capture_dma_data.dt.addr_width = bus_widths[idx];
587 dev->capture_dma_data.dt.fifo_size = fifo_depth *
588 (fifo_width[idx2] >> 8);
589 dev->capture_dma_data.dt.maxburst = 16;
596 static int dw_i2s_dai_probe(struct snd_soc_dai *dai)
598 struct dw_i2s_dev *dev = snd_soc_dai_get_drvdata(dai);
600 snd_soc_dai_init_dma_data(dai, &dev->play_dma_data, &dev->capture_dma_data);
604 static int dw_i2s_probe(struct platform_device *pdev)
606 const struct i2s_platform_data *pdata = pdev->dev.platform_data;
607 struct dw_i2s_dev *dev;
608 struct resource *res;
610 struct snd_soc_dai_driver *dw_i2s_dai;
613 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
617 dw_i2s_dai = devm_kzalloc(&pdev->dev, sizeof(*dw_i2s_dai), GFP_KERNEL);
621 dw_i2s_dai->ops = &dw_i2s_dai_ops;
622 dw_i2s_dai->probe = dw_i2s_dai_probe;
624 dev->i2s_base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
625 if (IS_ERR(dev->i2s_base))
626 return PTR_ERR(dev->i2s_base);
628 dev->dev = &pdev->dev;
630 irq = platform_get_irq_optional(pdev, 0);
632 ret = devm_request_irq(&pdev->dev, irq, i2s_irq_handler, 0,
635 dev_err(&pdev->dev, "failed to request irq\n");
640 dev->i2s_reg_comp1 = I2S_COMP_PARAM_1;
641 dev->i2s_reg_comp2 = I2S_COMP_PARAM_2;
643 dev->capability = pdata->cap;
645 dev->quirks = pdata->quirks;
646 if (dev->quirks & DW_I2S_QUIRK_COMP_REG_OFFSET) {
647 dev->i2s_reg_comp1 = pdata->i2s_reg_comp1;
648 dev->i2s_reg_comp2 = pdata->i2s_reg_comp2;
650 ret = dw_configure_dai_by_pd(dev, dw_i2s_dai, res, pdata);
653 ret = dw_configure_dai_by_dt(dev, dw_i2s_dai, res);
658 if (dev->capability & DW_I2S_MASTER) {
660 dev->i2s_clk_cfg = pdata->i2s_clk_cfg;
661 if (!dev->i2s_clk_cfg) {
662 dev_err(&pdev->dev, "no clock configure method\n");
666 dev->clk = devm_clk_get(&pdev->dev, clk_id);
668 if (IS_ERR(dev->clk))
669 return PTR_ERR(dev->clk);
671 ret = clk_prepare_enable(dev->clk);
676 dev_set_drvdata(&pdev->dev, dev);
677 ret = devm_snd_soc_register_component(&pdev->dev, &dw_i2s_component,
680 dev_err(&pdev->dev, "not able to register dai\n");
681 goto err_clk_disable;
686 ret = dw_pcm_register(pdev);
689 ret = devm_snd_dmaengine_pcm_register(&pdev->dev, NULL,
691 dev->use_pio = false;
695 dev_err(&pdev->dev, "could not register pcm: %d\n",
697 goto err_clk_disable;
701 pm_runtime_enable(&pdev->dev);
705 if (dev->capability & DW_I2S_MASTER)
706 clk_disable_unprepare(dev->clk);
710 static int dw_i2s_remove(struct platform_device *pdev)
712 struct dw_i2s_dev *dev = dev_get_drvdata(&pdev->dev);
714 if (dev->capability & DW_I2S_MASTER)
715 clk_disable_unprepare(dev->clk);
717 pm_runtime_disable(&pdev->dev);
722 static const struct of_device_id dw_i2s_of_match[] = {
723 { .compatible = "snps,designware-i2s", },
727 MODULE_DEVICE_TABLE(of, dw_i2s_of_match);
730 static const struct dev_pm_ops dwc_pm_ops = {
731 SET_RUNTIME_PM_OPS(dw_i2s_runtime_suspend, dw_i2s_runtime_resume, NULL)
734 static struct platform_driver dw_i2s_driver = {
735 .probe = dw_i2s_probe,
736 .remove = dw_i2s_remove,
738 .name = "designware-i2s",
739 .of_match_table = of_match_ptr(dw_i2s_of_match),
744 module_platform_driver(dw_i2s_driver);
746 MODULE_AUTHOR("Rajeev Kumar <rajeevkumar.linux@gmail.com>");
747 MODULE_DESCRIPTION("DESIGNWARE I2S SoC Interface");
748 MODULE_LICENSE("GPL");
749 MODULE_ALIAS("platform:designware_i2s");