1 // SPDX-License-Identifier: GPL-2.0-only
2 /* sound/soc/rockchip/rockchip_i2s.c
4 * ALSA SoC Audio Layer - Rockchip I2S Controller driver
6 * Copyright (c) 2014 Rockchip Electronics Co. Ltd.
7 * Author: Jianqun <jay.xu@rock-chips.com>
10 #include <linux/module.h>
11 #include <linux/mfd/syscon.h>
12 #include <linux/delay.h>
13 #include <linux/of_gpio.h>
14 #include <linux/of_device.h>
15 #include <linux/clk.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/regmap.h>
18 #include <sound/pcm_params.h>
19 #include <sound/dmaengine_pcm.h>
21 #include "rockchip_i2s.h"
22 #include "rockchip_pcm.h"
24 #define DRV_NAME "rockchip-i2s"
37 struct snd_dmaengine_dai_dma_data capture_dma_data;
38 struct snd_dmaengine_dai_dma_data playback_dma_data;
40 struct regmap *regmap;
44 * Used to indicate the tx/rx status.
45 * I2S controller hopes to start the tx and rx together,
46 * also to stop them when they are both try to stop.
51 const struct rk_i2s_pins *pins;
54 static int i2s_runtime_suspend(struct device *dev)
56 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
58 regcache_cache_only(i2s->regmap, true);
59 clk_disable_unprepare(i2s->mclk);
64 static int i2s_runtime_resume(struct device *dev)
66 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
69 ret = clk_prepare_enable(i2s->mclk);
71 dev_err(i2s->dev, "clock enable failed %d\n", ret);
75 regcache_cache_only(i2s->regmap, false);
76 regcache_mark_dirty(i2s->regmap);
78 ret = regcache_sync(i2s->regmap);
80 clk_disable_unprepare(i2s->mclk);
85 static inline struct rk_i2s_dev *to_info(struct snd_soc_dai *dai)
87 return snd_soc_dai_get_drvdata(dai);
90 static void rockchip_snd_txctrl(struct rk_i2s_dev *i2s, int on)
96 regmap_update_bits(i2s->regmap, I2S_DMACR,
97 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_ENABLE);
99 regmap_update_bits(i2s->regmap, I2S_XFER,
100 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
101 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
103 i2s->tx_start = true;
105 i2s->tx_start = false;
107 regmap_update_bits(i2s->regmap, I2S_DMACR,
108 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_DISABLE);
110 if (!i2s->rx_start) {
111 regmap_update_bits(i2s->regmap, I2S_XFER,
118 regmap_update_bits(i2s->regmap, I2S_CLR,
119 I2S_CLR_TXC | I2S_CLR_RXC,
120 I2S_CLR_TXC | I2S_CLR_RXC);
122 regmap_read(i2s->regmap, I2S_CLR, &val);
124 /* Should wait for clear operation to finish */
126 regmap_read(i2s->regmap, I2S_CLR, &val);
129 dev_warn(i2s->dev, "fail to clear\n");
137 static void rockchip_snd_rxctrl(struct rk_i2s_dev *i2s, int on)
139 unsigned int val = 0;
143 regmap_update_bits(i2s->regmap, I2S_DMACR,
144 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_ENABLE);
146 regmap_update_bits(i2s->regmap, I2S_XFER,
147 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
148 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
150 i2s->rx_start = true;
152 i2s->rx_start = false;
154 regmap_update_bits(i2s->regmap, I2S_DMACR,
155 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_DISABLE);
157 if (!i2s->tx_start) {
158 regmap_update_bits(i2s->regmap, I2S_XFER,
165 regmap_update_bits(i2s->regmap, I2S_CLR,
166 I2S_CLR_TXC | I2S_CLR_RXC,
167 I2S_CLR_TXC | I2S_CLR_RXC);
169 regmap_read(i2s->regmap, I2S_CLR, &val);
171 /* Should wait for clear operation to finish */
173 regmap_read(i2s->regmap, I2S_CLR, &val);
176 dev_warn(i2s->dev, "fail to clear\n");
184 static int rockchip_i2s_set_fmt(struct snd_soc_dai *cpu_dai,
187 struct rk_i2s_dev *i2s = to_info(cpu_dai);
188 unsigned int mask = 0, val = 0;
191 pm_runtime_get_sync(cpu_dai->dev);
192 mask = I2S_CKR_MSS_MASK;
193 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
194 case SND_SOC_DAIFMT_CBS_CFS:
195 /* Set source clock in Master mode */
196 val = I2S_CKR_MSS_MASTER;
197 i2s->is_master_mode = true;
199 case SND_SOC_DAIFMT_CBM_CFM:
200 val = I2S_CKR_MSS_SLAVE;
201 i2s->is_master_mode = false;
208 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
210 mask = I2S_CKR_CKP_MASK;
211 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
212 case SND_SOC_DAIFMT_NB_NF:
213 val = I2S_CKR_CKP_NEG;
215 case SND_SOC_DAIFMT_IB_NF:
216 val = I2S_CKR_CKP_POS;
223 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
225 mask = I2S_TXCR_IBM_MASK | I2S_TXCR_TFS_MASK | I2S_TXCR_PBM_MASK;
226 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
227 case SND_SOC_DAIFMT_RIGHT_J:
228 val = I2S_TXCR_IBM_RSJM;
230 case SND_SOC_DAIFMT_LEFT_J:
231 val = I2S_TXCR_IBM_LSJM;
233 case SND_SOC_DAIFMT_I2S:
234 val = I2S_TXCR_IBM_NORMAL;
236 case SND_SOC_DAIFMT_DSP_A: /* PCM delay 1 bit mode */
237 val = I2S_TXCR_TFS_PCM | I2S_TXCR_PBM_MODE(1);
239 case SND_SOC_DAIFMT_DSP_B: /* PCM no delay mode */
240 val = I2S_TXCR_TFS_PCM;
247 regmap_update_bits(i2s->regmap, I2S_TXCR, mask, val);
249 mask = I2S_RXCR_IBM_MASK | I2S_RXCR_TFS_MASK | I2S_RXCR_PBM_MASK;
250 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
251 case SND_SOC_DAIFMT_RIGHT_J:
252 val = I2S_RXCR_IBM_RSJM;
254 case SND_SOC_DAIFMT_LEFT_J:
255 val = I2S_RXCR_IBM_LSJM;
257 case SND_SOC_DAIFMT_I2S:
258 val = I2S_RXCR_IBM_NORMAL;
260 case SND_SOC_DAIFMT_DSP_A: /* PCM delay 1 bit mode */
261 val = I2S_RXCR_TFS_PCM | I2S_RXCR_PBM_MODE(1);
263 case SND_SOC_DAIFMT_DSP_B: /* PCM no delay mode */
264 val = I2S_RXCR_TFS_PCM;
271 regmap_update_bits(i2s->regmap, I2S_RXCR, mask, val);
274 pm_runtime_put(cpu_dai->dev);
279 static int rockchip_i2s_hw_params(struct snd_pcm_substream *substream,
280 struct snd_pcm_hw_params *params,
281 struct snd_soc_dai *dai)
283 struct rk_i2s_dev *i2s = to_info(dai);
284 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
285 unsigned int val = 0;
286 unsigned int mclk_rate, bclk_rate, div_bclk, div_lrck;
288 if (i2s->is_master_mode) {
289 mclk_rate = clk_get_rate(i2s->mclk);
290 bclk_rate = 2 * 32 * params_rate(params);
291 if (bclk_rate == 0 || mclk_rate % bclk_rate)
294 div_bclk = mclk_rate / bclk_rate;
295 div_lrck = bclk_rate / params_rate(params);
296 regmap_update_bits(i2s->regmap, I2S_CKR,
298 I2S_CKR_MDIV(div_bclk));
300 regmap_update_bits(i2s->regmap, I2S_CKR,
303 I2S_CKR_TSD(div_lrck) |
304 I2S_CKR_RSD(div_lrck));
307 switch (params_format(params)) {
308 case SNDRV_PCM_FORMAT_S8:
309 val |= I2S_TXCR_VDW(8);
311 case SNDRV_PCM_FORMAT_S16_LE:
312 val |= I2S_TXCR_VDW(16);
314 case SNDRV_PCM_FORMAT_S20_3LE:
315 val |= I2S_TXCR_VDW(20);
317 case SNDRV_PCM_FORMAT_S24_LE:
318 val |= I2S_TXCR_VDW(24);
320 case SNDRV_PCM_FORMAT_S32_LE:
321 val |= I2S_TXCR_VDW(32);
327 switch (params_channels(params)) {
341 dev_err(i2s->dev, "invalid channel: %d\n",
342 params_channels(params));
346 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
347 regmap_update_bits(i2s->regmap, I2S_RXCR,
348 I2S_RXCR_VDW_MASK | I2S_RXCR_CSR_MASK,
351 regmap_update_bits(i2s->regmap, I2S_TXCR,
352 I2S_TXCR_VDW_MASK | I2S_TXCR_CSR_MASK,
355 if (!IS_ERR(i2s->grf) && i2s->pins) {
356 regmap_read(i2s->regmap, I2S_TXCR, &val);
357 val &= I2S_TXCR_CSR_MASK;
361 val = I2S_IO_4CH_OUT_6CH_IN;
364 val = I2S_IO_6CH_OUT_4CH_IN;
367 val = I2S_IO_8CH_OUT_2CH_IN;
370 val = I2S_IO_2CH_OUT_8CH_IN;
374 val <<= i2s->pins->shift;
375 val |= (I2S_IO_DIRECTION_MASK << i2s->pins->shift) << 16;
376 regmap_write(i2s->grf, i2s->pins->reg_offset, val);
379 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_TDL_MASK,
381 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_RDL_MASK,
384 val = I2S_CKR_TRCM_TXRX;
385 if (dai->driver->symmetric_rates && rtd->dai_link->symmetric_rates)
386 val = I2S_CKR_TRCM_TXONLY;
388 regmap_update_bits(i2s->regmap, I2S_CKR,
394 static int rockchip_i2s_trigger(struct snd_pcm_substream *substream,
395 int cmd, struct snd_soc_dai *dai)
397 struct rk_i2s_dev *i2s = to_info(dai);
401 case SNDRV_PCM_TRIGGER_START:
402 case SNDRV_PCM_TRIGGER_RESUME:
403 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
404 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
405 rockchip_snd_rxctrl(i2s, 1);
407 rockchip_snd_txctrl(i2s, 1);
409 case SNDRV_PCM_TRIGGER_SUSPEND:
410 case SNDRV_PCM_TRIGGER_STOP:
411 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
412 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
413 rockchip_snd_rxctrl(i2s, 0);
415 rockchip_snd_txctrl(i2s, 0);
425 static int rockchip_i2s_set_sysclk(struct snd_soc_dai *cpu_dai, int clk_id,
426 unsigned int freq, int dir)
428 struct rk_i2s_dev *i2s = to_info(cpu_dai);
434 ret = clk_set_rate(i2s->mclk, freq);
436 dev_err(i2s->dev, "Fail to set mclk %d\n", ret);
441 static int rockchip_i2s_dai_probe(struct snd_soc_dai *dai)
443 struct rk_i2s_dev *i2s = snd_soc_dai_get_drvdata(dai);
445 dai->capture_dma_data = &i2s->capture_dma_data;
446 dai->playback_dma_data = &i2s->playback_dma_data;
451 static const struct snd_soc_dai_ops rockchip_i2s_dai_ops = {
452 .hw_params = rockchip_i2s_hw_params,
453 .set_sysclk = rockchip_i2s_set_sysclk,
454 .set_fmt = rockchip_i2s_set_fmt,
455 .trigger = rockchip_i2s_trigger,
458 static struct snd_soc_dai_driver rockchip_i2s_dai = {
459 .probe = rockchip_i2s_dai_probe,
461 .stream_name = "Playback",
464 .rates = SNDRV_PCM_RATE_8000_192000,
465 .formats = (SNDRV_PCM_FMTBIT_S8 |
466 SNDRV_PCM_FMTBIT_S16_LE |
467 SNDRV_PCM_FMTBIT_S20_3LE |
468 SNDRV_PCM_FMTBIT_S24_LE |
469 SNDRV_PCM_FMTBIT_S32_LE),
472 .stream_name = "Capture",
475 .rates = SNDRV_PCM_RATE_8000_192000,
476 .formats = (SNDRV_PCM_FMTBIT_S8 |
477 SNDRV_PCM_FMTBIT_S16_LE |
478 SNDRV_PCM_FMTBIT_S20_3LE |
479 SNDRV_PCM_FMTBIT_S24_LE |
480 SNDRV_PCM_FMTBIT_S32_LE),
482 .ops = &rockchip_i2s_dai_ops,
483 .symmetric_rates = 1,
486 static const struct snd_soc_component_driver rockchip_i2s_component = {
490 static bool rockchip_i2s_wr_reg(struct device *dev, unsigned int reg)
507 static bool rockchip_i2s_rd_reg(struct device *dev, unsigned int reg)
527 static bool rockchip_i2s_volatile_reg(struct device *dev, unsigned int reg)
541 static bool rockchip_i2s_precious_reg(struct device *dev, unsigned int reg)
551 static const struct reg_default rockchip_i2s_reg_defaults[] = {
559 static const struct regmap_config rockchip_i2s_regmap_config = {
563 .max_register = I2S_RXDR,
564 .reg_defaults = rockchip_i2s_reg_defaults,
565 .num_reg_defaults = ARRAY_SIZE(rockchip_i2s_reg_defaults),
566 .writeable_reg = rockchip_i2s_wr_reg,
567 .readable_reg = rockchip_i2s_rd_reg,
568 .volatile_reg = rockchip_i2s_volatile_reg,
569 .precious_reg = rockchip_i2s_precious_reg,
570 .cache_type = REGCACHE_FLAT,
573 static const struct rk_i2s_pins rk3399_i2s_pins = {
574 .reg_offset = 0xe220,
578 static const struct of_device_id rockchip_i2s_match[] = {
579 { .compatible = "rockchip,rk3066-i2s", },
580 { .compatible = "rockchip,rk3188-i2s", },
581 { .compatible = "rockchip,rk3288-i2s", },
582 { .compatible = "rockchip,rk3399-i2s", .data = &rk3399_i2s_pins },
586 static int rockchip_i2s_probe(struct platform_device *pdev)
588 struct device_node *node = pdev->dev.of_node;
589 const struct of_device_id *of_id;
590 struct rk_i2s_dev *i2s;
591 struct snd_soc_dai_driver *soc_dai;
592 struct resource *res;
597 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
601 i2s->dev = &pdev->dev;
603 i2s->grf = syscon_regmap_lookup_by_phandle(node, "rockchip,grf");
604 if (!IS_ERR(i2s->grf)) {
605 of_id = of_match_device(rockchip_i2s_match, &pdev->dev);
606 if (!of_id || !of_id->data)
609 i2s->pins = of_id->data;
612 /* try to prepare related clocks */
613 i2s->hclk = devm_clk_get(&pdev->dev, "i2s_hclk");
614 if (IS_ERR(i2s->hclk)) {
615 dev_err(&pdev->dev, "Can't retrieve i2s bus clock\n");
616 return PTR_ERR(i2s->hclk);
618 ret = clk_prepare_enable(i2s->hclk);
620 dev_err(i2s->dev, "hclock enable failed %d\n", ret);
624 i2s->mclk = devm_clk_get(&pdev->dev, "i2s_clk");
625 if (IS_ERR(i2s->mclk)) {
626 dev_err(&pdev->dev, "Can't retrieve i2s master clock\n");
627 return PTR_ERR(i2s->mclk);
630 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
631 regs = devm_ioremap_resource(&pdev->dev, res);
633 return PTR_ERR(regs);
635 i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
636 &rockchip_i2s_regmap_config);
637 if (IS_ERR(i2s->regmap)) {
639 "Failed to initialise managed register map\n");
640 return PTR_ERR(i2s->regmap);
643 i2s->playback_dma_data.addr = res->start + I2S_TXDR;
644 i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
645 i2s->playback_dma_data.maxburst = 4;
647 i2s->capture_dma_data.addr = res->start + I2S_RXDR;
648 i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
649 i2s->capture_dma_data.maxburst = 4;
651 dev_set_drvdata(&pdev->dev, i2s);
653 pm_runtime_enable(&pdev->dev);
654 if (!pm_runtime_enabled(&pdev->dev)) {
655 ret = i2s_runtime_resume(&pdev->dev);
660 soc_dai = devm_kmemdup(&pdev->dev, &rockchip_i2s_dai,
661 sizeof(*soc_dai), GFP_KERNEL);
667 if (!of_property_read_u32(node, "rockchip,playback-channels", &val)) {
668 if (val >= 2 && val <= 8)
669 soc_dai->playback.channels_max = val;
672 if (!of_property_read_u32(node, "rockchip,capture-channels", &val)) {
673 if (val >= 2 && val <= 8)
674 soc_dai->capture.channels_max = val;
677 ret = devm_snd_soc_register_component(&pdev->dev,
678 &rockchip_i2s_component,
682 dev_err(&pdev->dev, "Could not register DAI\n");
686 ret = rockchip_pcm_platform_register(&pdev->dev);
688 dev_err(&pdev->dev, "Could not register PCM\n");
695 if (!pm_runtime_status_suspended(&pdev->dev))
696 i2s_runtime_suspend(&pdev->dev);
698 pm_runtime_disable(&pdev->dev);
703 static int rockchip_i2s_remove(struct platform_device *pdev)
705 struct rk_i2s_dev *i2s = dev_get_drvdata(&pdev->dev);
707 pm_runtime_disable(&pdev->dev);
708 if (!pm_runtime_status_suspended(&pdev->dev))
709 i2s_runtime_suspend(&pdev->dev);
711 clk_disable_unprepare(i2s->hclk);
716 static const struct dev_pm_ops rockchip_i2s_pm_ops = {
717 SET_RUNTIME_PM_OPS(i2s_runtime_suspend, i2s_runtime_resume,
721 static struct platform_driver rockchip_i2s_driver = {
722 .probe = rockchip_i2s_probe,
723 .remove = rockchip_i2s_remove,
726 .of_match_table = of_match_ptr(rockchip_i2s_match),
727 .pm = &rockchip_i2s_pm_ops,
730 module_platform_driver(rockchip_i2s_driver);
732 MODULE_DESCRIPTION("ROCKCHIP IIS ASoC Interface");
733 MODULE_AUTHOR("jianqun <jay.xu@rock-chips.com>");
734 MODULE_LICENSE("GPL v2");
735 MODULE_ALIAS("platform:" DRV_NAME);
736 MODULE_DEVICE_TABLE(of, rockchip_i2s_match);