2 * Rockchip I2S ALSA SoC Digital Audio Interface(DAI) driver
4 * Copyright (C) 2015 Fuzhou Rockchip Electronics Co., Ltd
6 * This software is licensed under the terms of the GNU General Public
7 * License version 2, as published by the Free Software Foundation, and
8 * may be copied, distributed, and modified under those terms.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/init.h>
18 #include <linux/module.h>
19 #include <linux/interrupt.h>
20 #include <linux/device.h>
21 #include <linux/delay.h>
22 #include <linux/clk.h>
23 #include <linux/version.h>
25 #include <linux/of_gpio.h>
27 #include <linux/platform_device.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/regmap.h>
30 #include <linux/rockchip/cpu.h>
31 #include <linux/rockchip/cru.h>
32 #include <linux/rockchip/grf.h>
33 #include <linux/slab.h>
35 #include <sound/core.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/initval.h>
39 #include <sound/soc.h>
40 #include <sound/dmaengine_pcm.h>
41 #include <linux/spinlock.h>
42 #include <linux/workqueue.h>
48 #define I2S_DEFAULT_FREQ (11289600)
49 #define I2S_DMA_BURST_SIZE (16) /* size * width: 16*4 = 64 bytes */
50 static DEFINE_SPINLOCK(lock);
52 #if defined(CONFIG_RK_HDMI) && defined(CONFIG_SND_RK_SOC_HDMI_I2S)
53 extern int snd_config_hdmi_audio(struct snd_pcm_hw_params *params);
58 struct clk *clk; /* bclk */
59 struct clk *mclk; /*mclk output only */
60 struct clk *hclk; /*ahb clk */
61 struct snd_dmaengine_dai_dma_data capture_dma_data;
62 struct snd_dmaengine_dai_dma_data playback_dma_data;
63 struct regmap *regmap;
66 int xfer_mode; /* 0: i2s, 1: pcm */
68 struct delayed_work clk_delayed_work;
72 static inline struct rk_i2s_dev *to_info(struct snd_soc_dai *dai)
74 return snd_soc_dai_get_drvdata(dai);
77 static void rockchip_snd_txctrl(struct rk_i2s_dev *i2s, int on)
83 spin_lock_irqsave(&lock, flags);
85 dev_dbg(i2s->dev, "%s: %d: on: %d\n", __func__, __LINE__, on);
88 regmap_update_bits(i2s->regmap, I2S_DMACR,
89 I2S_DMACR_TDE_MASK, I2S_DMACR_TDE_ENABLE);
91 regmap_update_bits(i2s->regmap, I2S_XFER,
92 I2S_XFER_TXS_MASK | I2S_XFER_RXS_MASK,
93 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
97 i2s->tx_start = false;
99 regmap_update_bits(i2s->regmap, I2S_DMACR,
100 I2S_DMACR_TDE_MASK, I2S_DMACR_TDE_DISABLE);
103 if (!i2s->rx_start) {
104 regmap_update_bits(i2s->regmap, I2S_XFER,
110 regmap_update_bits(i2s->regmap, I2S_CLR,
111 I2S_CLR_TXC_MASK | I2S_CLR_RXC_MASK,
112 I2S_CLR_TXC | I2S_CLR_RXC);
114 regmap_read(i2s->regmap, I2S_CLR, &val);
116 /* Should wait for clear operation to finish */
118 regmap_read(i2s->regmap, I2S_CLR, &val);
121 dev_warn(i2s->dev, "fail to clear\n");
125 dev_dbg(i2s->dev, "%s: %d: stop xfer\n",
130 spin_unlock_irqrestore(&lock, flags);
133 static void rockchip_snd_rxctrl(struct rk_i2s_dev *i2s, int on)
136 unsigned int val = 0;
139 spin_lock_irqsave(&lock, flags);
141 dev_dbg(i2s->dev, "%s: %d: on: %d\n", __func__, __LINE__, on);
144 regmap_update_bits(i2s->regmap, I2S_DMACR,
145 I2S_DMACR_RDE_MASK, I2S_DMACR_RDE_ENABLE);
147 regmap_update_bits(i2s->regmap, I2S_XFER,
148 I2S_XFER_TXS_MASK | I2S_XFER_RXS_MASK,
149 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
151 i2s->rx_start = true;
153 i2s->rx_start = false;
155 regmap_update_bits(i2s->regmap, I2S_DMACR,
156 I2S_DMACR_RDE_MASK, I2S_DMACR_RDE_DISABLE);
158 if (!i2s->tx_start) {
159 regmap_update_bits(i2s->regmap, I2S_XFER,
165 regmap_update_bits(i2s->regmap, I2S_CLR,
166 I2S_CLR_TXC_MASK | I2S_CLR_RXC_MASK,
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");
180 dev_dbg(i2s->dev, "%s: %d: stop xfer\n",
185 spin_unlock_irqrestore(&lock, flags);
188 static int rockchip_i2s_set_fmt(struct snd_soc_dai *cpu_dai,
191 struct rk_i2s_dev *i2s = to_info(cpu_dai);
192 unsigned int mask = 0, val = 0;
196 spin_lock_irqsave(&lock, flags);
198 mask = I2S_CKR_MSS_MASK;
199 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
200 case SND_SOC_DAIFMT_CBS_CFS:
201 /* Codec is slave, so set cpu master */
202 val = I2S_CKR_MSS_MASTER;
204 case SND_SOC_DAIFMT_CBM_CFM:
205 /* Codec is master, so set cpu slave */
206 val = I2S_CKR_MSS_SLAVE;
213 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
215 mask = I2S_TXCR_IBM_MASK;
216 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
217 case SND_SOC_DAIFMT_RIGHT_J:
218 val = I2S_TXCR_IBM_RSJM;
220 case SND_SOC_DAIFMT_LEFT_J:
221 val = I2S_TXCR_IBM_LSJM;
223 case SND_SOC_DAIFMT_I2S:
224 val = I2S_TXCR_IBM_NORMAL;
231 regmap_update_bits(i2s->regmap, I2S_TXCR, mask, val);
233 mask = I2S_RXCR_IBM_MASK;
234 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
235 case SND_SOC_DAIFMT_RIGHT_J:
236 val = I2S_RXCR_IBM_RSJM;
238 case SND_SOC_DAIFMT_LEFT_J:
239 val = I2S_RXCR_IBM_LSJM;
241 case SND_SOC_DAIFMT_I2S:
242 val = I2S_RXCR_IBM_NORMAL;
249 regmap_update_bits(i2s->regmap, I2S_RXCR, mask, val);
253 spin_unlock_irqrestore(&lock, flags);
257 static int rockchip_i2s_hw_params(struct snd_pcm_substream *substream,
258 struct snd_pcm_hw_params *params,
259 struct snd_soc_dai *dai)
261 struct rk_i2s_dev *i2s = to_info(dai);
262 unsigned int val = 0;
265 spin_lock_irqsave(&lock, flags);
267 dev_dbg(i2s->dev, "%s: %d\n", __func__, __LINE__);
269 switch (params_format(params)) {
270 case SNDRV_PCM_FORMAT_S8:
271 val |= I2S_TXCR_VDW(8);
273 case SNDRV_PCM_FORMAT_S16_LE:
274 val |= I2S_TXCR_VDW(16);
276 case SNDRV_PCM_FORMAT_S20_3LE:
277 val |= I2S_TXCR_VDW(20);
279 case SNDRV_PCM_FORMAT_S24_LE:
280 case SNDRV_PCM_FORMAT_S24_3LE:
281 val |= I2S_TXCR_VDW(24);
283 case SNDRV_PCM_FORMAT_S32_LE:
284 val |= I2S_TXCR_VDW(32);
287 dev_err(i2s->dev, "invalid fmt: %d\n", params_format(params));
288 spin_unlock_irqrestore(&lock, flags);
292 switch (params_channels(params)) {
294 val |= I2S_TXCR_CHN_8;
297 val |= I2S_TXCR_CHN_6;
300 val |= I2S_TXCR_CHN_4;
303 val |= I2S_TXCR_CHN_2;
306 dev_err(i2s->dev, "invalid channel: %d\n",
307 params_channels(params));
308 spin_unlock_irqrestore(&lock, flags);
312 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
313 regmap_update_bits(i2s->regmap, I2S_TXCR,
318 regmap_update_bits(i2s->regmap, I2S_RXCR,
319 I2S_RXCR_VDW_MASK, val);
322 regmap_update_bits(i2s->regmap, I2S_DMACR,
323 I2S_DMACR_TDL_MASK | I2S_DMACR_RDL_MASK,
324 I2S_DMACR_TDL(16) | I2S_DMACR_RDL(16));
326 #if defined(CONFIG_RK_HDMI) && defined(CONFIG_SND_RK_SOC_HDMI_I2S)
327 snd_config_hdmi_audio(params);
329 spin_unlock_irqrestore(&lock, flags);
334 static int rockchip_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
335 struct snd_soc_dai *dai)
337 struct rk_i2s_dev *i2s = to_info(dai);
341 case SNDRV_PCM_TRIGGER_START:
342 case SNDRV_PCM_TRIGGER_RESUME:
343 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
344 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
345 rockchip_snd_rxctrl(i2s, 1);
347 rockchip_snd_txctrl(i2s, 1);
349 case SNDRV_PCM_TRIGGER_SUSPEND:
350 case SNDRV_PCM_TRIGGER_STOP:
351 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
352 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
353 rockchip_snd_rxctrl(i2s, 0);
355 rockchip_snd_txctrl(i2s, 0);
365 static int rockchip_i2s_set_sysclk(struct snd_soc_dai *cpu_dai,
366 int clk_id, unsigned int freq, int dir)
368 struct rk_i2s_dev *i2s = to_info(cpu_dai);
371 ret = clk_set_rate(i2s->clk, freq);
373 dev_err(i2s->dev, "fail set clk: freq: %d\n", freq);
378 static int rockchip_i2s_set_clkdiv(struct snd_soc_dai *cpu_dai,
381 struct rk_i2s_dev *i2s = to_info(cpu_dai);
382 unsigned int val = 0;
385 spin_lock_irqsave(&lock, flags);
387 dev_dbg(i2s->dev, "%s: div_id=%d, div=%d\n", __func__, div_id, div);
390 case ROCKCHIP_DIV_BCLK:
391 val |= I2S_CKR_TSD(div);
392 val |= I2S_CKR_RSD(div);
393 regmap_update_bits(i2s->regmap, I2S_CKR,
394 I2S_CKR_TSD_MASK | I2S_CKR_RSD_MASK,
397 case ROCKCHIP_DIV_MCLK:
398 val |= I2S_CKR_MDIV(div);
399 regmap_update_bits(i2s->regmap, I2S_CKR,
400 I2S_CKR_MDIV_MASK, val);
403 spin_unlock_irqrestore(&lock, flags);
407 spin_unlock_irqrestore(&lock, flags);
412 static int rockchip_i2s_dai_probe(struct snd_soc_dai *dai)
414 struct rk_i2s_dev *i2s = to_info(dai);
416 dai->capture_dma_data = &i2s->capture_dma_data;
417 dai->playback_dma_data = &i2s->playback_dma_data;
422 static struct snd_soc_dai_ops rockchip_i2s_dai_ops = {
423 .trigger = rockchip_i2s_trigger,
424 .hw_params = rockchip_i2s_hw_params,
425 .set_fmt = rockchip_i2s_set_fmt,
426 .set_clkdiv = rockchip_i2s_set_clkdiv,
427 .set_sysclk = rockchip_i2s_set_sysclk,
430 #define ROCKCHIP_I2S_RATES SNDRV_PCM_RATE_8000_192000
431 #define ROCKCHIP_I2S_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | \
432 SNDRV_PCM_FMTBIT_S20_3LE | \
433 SNDRV_PCM_FMTBIT_S24_LE | \
434 SNDRV_PCM_FORMAT_S32_LE)
436 struct snd_soc_dai_driver rockchip_i2s_dai[] = {
438 .probe = rockchip_i2s_dai_probe,
439 .name = "rockchip-i2s.0",
444 .rates = ROCKCHIP_I2S_RATES,
445 .formats = ROCKCHIP_I2S_FORMATS,
450 .rates = ROCKCHIP_I2S_RATES,
451 .formats = ROCKCHIP_I2S_FORMATS,
453 .ops = &rockchip_i2s_dai_ops,
454 .symmetric_rates = 1,
457 .probe = rockchip_i2s_dai_probe,
458 .name = "rockchip-i2s.1",
463 .rates = ROCKCHIP_I2S_RATES,
464 .formats = ROCKCHIP_I2S_FORMATS,
469 .rates = ROCKCHIP_I2S_RATES,
470 .formats = ROCKCHIP_I2S_FORMATS,
472 .ops = &rockchip_i2s_dai_ops,
473 .symmetric_rates = 1,
477 static const struct snd_soc_component_driver rockchip_i2s_component = {
478 .name = "rockchip-i2s",
482 static int rockchip_i2s_runtime_suspend(struct device *dev)
484 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
486 dev_dbg(i2s->dev, "%s\n", __func__);
490 static int rockchip_i2s_runtime_resume(struct device *dev)
492 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
494 dev_dbg(i2s->dev, "%s\n", __func__);
498 #define i2s_runtime_suspend NULL
499 #define i2s_runtime_resume NULL
503 static void set_clk_later_work(struct work_struct *work)
505 struct rk_i2s_dev *i2s = container_of(work, struct rk_i2s_dev,
506 clk_delayed_work.work);
508 clk_set_rate(i2s->clk, I2S_DEFAULT_FREQ);
509 if (!IS_ERR(i2s->mclk))
510 clk_set_rate(i2s->mclk, I2S_DEFAULT_FREQ);
514 static bool rockchip_i2s_wr_reg(struct device *dev, unsigned int reg)
531 static bool rockchip_i2s_rd_reg(struct device *dev, unsigned int reg)
550 static bool rockchip_i2s_volatile_reg(struct device *dev, unsigned int reg)
561 static bool rockchip_i2s_precious_reg(struct device *dev, unsigned int reg)
569 static const struct regmap_config rockchip_i2s_regmap_config = {
573 .max_register = I2S_RXDR,
574 .writeable_reg = rockchip_i2s_wr_reg,
575 .readable_reg = rockchip_i2s_rd_reg,
576 .volatile_reg = rockchip_i2s_volatile_reg,
577 .precious_reg = rockchip_i2s_precious_reg,
578 .cache_type = REGCACHE_FLAT,
581 static int rockchip_i2s_probe(struct platform_device *pdev)
583 struct device_node *node = pdev->dev.of_node;
584 struct rk_i2s_dev *i2s;
585 struct resource *res;
589 ret = of_property_read_u32(node, "i2s-id", &pdev->id);
591 dev_err(&pdev->dev, "Property 'i2s-id' missing or invalid\n");
596 if (soc_is_rk3126b()) {
599 /* rk3126b has no i2s1 controller(i2s_8ch) */
601 pr_info("rk3126b has no i2s1 controller\n");
606 ret = of_property_read_u32(node, "sdi_source",
615 val = readl_relaxed(RK_GRF_VIRT + 0x0140);
616 val = val | 0x04000400;
617 writel_relaxed(val, RK_GRF_VIRT + 0x0140);
621 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
623 dev_err(&pdev->dev, "Can't allocate rk_i2s_dev\n");
628 i2s->hclk = devm_clk_get(&pdev->dev, "i2s_hclk");
629 if (IS_ERR(i2s->hclk)) {
630 dev_err(&pdev->dev, "Can't retrieve i2s bus clock\n");
631 ret = PTR_ERR(i2s->hclk);
634 clk_prepare_enable(i2s->hclk);
637 i2s->clk = devm_clk_get(&pdev->dev, "i2s_clk");
638 if (IS_ERR(i2s->clk)) {
639 dev_err(&pdev->dev, "Can't retrieve i2s clock\n");
640 ret = PTR_ERR(i2s->clk);
644 INIT_DELAYED_WORK(&i2s->clk_delayed_work, set_clk_later_work);
645 schedule_delayed_work(&i2s->clk_delayed_work, msecs_to_jiffies(10));
647 clk_set_rate(i2s->clk, I2S_DEFAULT_FREQ);
649 clk_prepare_enable(i2s->clk);
651 i2s->mclk = devm_clk_get(&pdev->dev, "i2s_mclk");
652 if (IS_ERR(i2s->mclk)) {
653 dev_info(&pdev->dev, "i2s%d has no mclk\n", pdev->id);
655 #ifndef CLK_SET_LATER
656 clk_set_rate(i2s->mclk, I2S_DEFAULT_FREQ);
658 clk_prepare_enable(i2s->mclk);
661 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
662 regs = devm_ioremap_resource(&pdev->dev, res);
668 i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
669 &rockchip_i2s_regmap_config);
670 if (IS_ERR(i2s->regmap)) {
672 "Failed to initialise managed register map\n");
673 ret = PTR_ERR(i2s->regmap);
677 i2s->playback_dma_data.addr = res->start + I2S_TXDR;
678 i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
679 i2s->playback_dma_data.maxburst = I2S_DMA_BURST_SIZE;
681 i2s->capture_dma_data.addr = res->start + I2S_RXDR;
682 i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
683 i2s->capture_dma_data.maxburst = I2S_DMA_BURST_SIZE;
685 i2s->tx_start = false;
686 i2s->rx_start = false;
688 i2s->dev = &pdev->dev;
689 dev_set_drvdata(&pdev->dev, i2s);
691 pm_runtime_enable(&pdev->dev);
692 if (!pm_runtime_enabled(&pdev->dev)) {
693 ret = rockchip_i2s_runtime_resume(&pdev->dev);
698 ret = snd_soc_register_component(&pdev->dev, &rockchip_i2s_component,
699 &rockchip_i2s_dai[pdev->id], 1);
702 dev_err(&pdev->dev, "Could not register DAI: %d\n", ret);
707 ret = rockchip_pcm_platform_register(&pdev->dev);
709 dev_err(&pdev->dev, "Could not register PCM: %d\n", ret);
710 goto err_unregister_component;
713 ret = of_property_read_u32(node, "rockchip,xfer-mode", &i2s->xfer_mode);
715 i2s->xfer_mode = I2S_XFER_MODE;
717 if (PCM_XFER_MODE == i2s->xfer_mode) {
718 regmap_update_bits(i2s->regmap, I2S_TXCR,
721 regmap_update_bits(i2s->regmap, I2S_RXCR,
726 rockchip_snd_txctrl(i2s, 0);
727 rockchip_snd_rxctrl(i2s, 0);
731 err_unregister_component:
732 snd_soc_unregister_component(&pdev->dev);
734 if (!pm_runtime_status_suspended(&pdev->dev))
735 rockchip_i2s_runtime_suspend(&pdev->dev);
737 pm_runtime_disable(&pdev->dev);
742 static int rockchip_i2s_remove(struct platform_device *pdev)
744 struct rk_i2s_dev *i2s = dev_get_drvdata(&pdev->dev);
746 pm_runtime_disable(&pdev->dev);
747 if (!pm_runtime_status_suspended(&pdev->dev))
748 rockchip_i2s_runtime_suspend(&pdev->dev);
750 if (!IS_ERR(i2s->mclk))
751 clk_disable_unprepare(i2s->mclk);
753 clk_disable_unprepare(i2s->clk);
754 clk_disable_unprepare(i2s->hclk);
755 rockchip_pcm_platform_unregister(&pdev->dev);
756 snd_soc_unregister_component(&pdev->dev);
762 static const struct of_device_id rockchip_i2s_match[] = {
763 { .compatible = "rockchip-i2s", },
766 MODULE_DEVICE_TABLE(of, rockchip_i2s_match);
769 #ifdef CONFIG_PM_SLEEP
770 static int rockchip_i2s_suspend(struct device *dev)
772 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
774 dev_dbg(i2s->dev, "%s\n", __func__);
775 return pinctrl_pm_select_sleep_state(dev);
778 static int rockchip_i2s_resume(struct device *dev)
780 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
783 ret = pm_runtime_get_sync(dev);
786 ret = pinctrl_pm_select_default_state(dev);
789 ret = regmap_reinit_cache(i2s->regmap, &rockchip_i2s_regmap_config);
791 if (PCM_XFER_MODE == i2s->xfer_mode) {
792 regmap_update_bits(i2s->regmap, I2S_TXCR,
795 regmap_update_bits(i2s->regmap, I2S_RXCR,
802 dev_dbg(i2s->dev, "%s\n", __func__);
807 static const struct dev_pm_ops rockchip_i2s_pm_ops = {
808 SET_RUNTIME_PM_OPS(rockchip_i2s_runtime_suspend, rockchip_i2s_runtime_resume,
810 SET_SYSTEM_SLEEP_PM_OPS(rockchip_i2s_suspend, rockchip_i2s_resume)
813 static struct platform_driver rockchip_i2s_driver = {
814 .probe = rockchip_i2s_probe,
815 .remove = rockchip_i2s_remove,
817 .name = "rockchip-i2s",
818 .owner = THIS_MODULE,
819 .of_match_table = of_match_ptr(rockchip_i2s_match),
820 .pm = &rockchip_i2s_pm_ops,
824 static int __init rockchip_i2s_init(void)
826 return platform_driver_register(&rockchip_i2s_driver);
828 subsys_initcall_sync(rockchip_i2s_init);
830 static void __exit rockchip_i2s_exit(void)
832 platform_driver_unregister(&rockchip_i2s_driver);
834 module_exit(rockchip_i2s_exit);
836 MODULE_AUTHOR("Sugar <sugar.zhang@rock-chips.com>");
837 MODULE_DESCRIPTION("Rockchip I2S Controller Driver");
838 MODULE_LICENSE("GPL v2");