1 /* sound/soc/rockchip/rockchip_i2s.c
3 * ALSA SoC Audio Layer - Rockchip I2S Controller driver
5 * Copyright (c) 2014 Rockchip Electronics Co. Ltd.
6 * Author: Jianqun <jay.xu@rock-chips.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/delay.h>
16 #include <linux/of_gpio.h>
17 #include <linux/of_device.h>
18 #include <linux/clk.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/regmap.h>
21 #include <sound/pcm_params.h>
22 #include <sound/dmaengine_pcm.h>
24 #include "rockchip_i2s.h"
26 #define DRV_NAME "rockchip-i2s"
39 struct snd_dmaengine_dai_dma_data capture_dma_data;
40 struct snd_dmaengine_dai_dma_data playback_dma_data;
42 struct regmap *regmap;
46 * Used to indicate the tx/rx status.
47 * I2S controller hopes to start the tx and rx together,
48 * also to stop them when they are both try to stop.
53 const struct rk_i2s_pins *pins;
57 static int i2s_runtime_suspend(struct device *dev)
59 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
61 regcache_cache_only(i2s->regmap, true);
62 clk_disable_unprepare(i2s->mclk);
67 static int i2s_runtime_resume(struct device *dev)
69 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
72 ret = clk_prepare_enable(i2s->mclk);
74 dev_err(i2s->dev, "clock enable failed %d\n", ret);
78 regcache_cache_only(i2s->regmap, false);
79 regcache_mark_dirty(i2s->regmap);
81 ret = regcache_sync(i2s->regmap);
83 clk_disable_unprepare(i2s->mclk);
88 static inline struct rk_i2s_dev *to_info(struct snd_soc_dai *dai)
90 return snd_soc_dai_get_drvdata(dai);
93 static void rockchip_snd_txctrl(struct rk_i2s_dev *i2s, int on)
99 regmap_update_bits(i2s->regmap, I2S_DMACR,
100 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_ENABLE);
102 regmap_update_bits(i2s->regmap, I2S_XFER,
103 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
104 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
106 i2s->tx_start = true;
108 i2s->tx_start = false;
110 regmap_update_bits(i2s->regmap, I2S_DMACR,
111 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_DISABLE);
113 if (!i2s->rx_start) {
114 regmap_update_bits(i2s->regmap, I2S_XFER,
121 regmap_update_bits(i2s->regmap, I2S_CLR,
122 I2S_CLR_TXC | I2S_CLR_RXC,
123 I2S_CLR_TXC | I2S_CLR_RXC);
125 regmap_read(i2s->regmap, I2S_CLR, &val);
127 /* Should wait for clear operation to finish */
129 regmap_read(i2s->regmap, I2S_CLR, &val);
132 dev_warn(i2s->dev, "fail to clear\n");
140 static void rockchip_snd_rxctrl(struct rk_i2s_dev *i2s, int on)
142 unsigned int val = 0;
146 regmap_update_bits(i2s->regmap, I2S_DMACR,
147 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_ENABLE);
149 regmap_update_bits(i2s->regmap, I2S_XFER,
150 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
151 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
153 i2s->rx_start = true;
155 i2s->rx_start = false;
157 regmap_update_bits(i2s->regmap, I2S_DMACR,
158 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_DISABLE);
160 if (!i2s->tx_start) {
161 regmap_update_bits(i2s->regmap, I2S_XFER,
168 regmap_update_bits(i2s->regmap, I2S_CLR,
169 I2S_CLR_TXC | I2S_CLR_RXC,
170 I2S_CLR_TXC | I2S_CLR_RXC);
172 regmap_read(i2s->regmap, I2S_CLR, &val);
174 /* Should wait for clear operation to finish */
176 regmap_read(i2s->regmap, I2S_CLR, &val);
179 dev_warn(i2s->dev, "fail to clear\n");
187 static int rockchip_i2s_set_fmt(struct snd_soc_dai *cpu_dai,
190 struct rk_i2s_dev *i2s = to_info(cpu_dai);
191 unsigned int mask = 0, val = 0;
193 mask = I2S_CKR_MSS_MASK;
194 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
195 case SND_SOC_DAIFMT_CBS_CFS:
196 /* Set source clock in Master mode */
197 val = I2S_CKR_MSS_MASTER;
198 i2s->is_master_mode = true;
200 case SND_SOC_DAIFMT_CBM_CFM:
201 val = I2S_CKR_MSS_SLAVE;
202 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;
222 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
224 mask = I2S_TXCR_IBM_MASK | I2S_TXCR_TFS_MASK | I2S_TXCR_PBM_MASK;
225 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
226 case SND_SOC_DAIFMT_RIGHT_J:
227 val = I2S_TXCR_IBM_RSJM;
229 case SND_SOC_DAIFMT_LEFT_J:
230 val = I2S_TXCR_IBM_LSJM;
232 case SND_SOC_DAIFMT_I2S:
233 val = I2S_TXCR_IBM_NORMAL;
235 case SND_SOC_DAIFMT_DSP_A: /* PCM no delay mode */
236 val = I2S_TXCR_TFS_PCM;
238 case SND_SOC_DAIFMT_DSP_B: /* PCM delay 1 mode */
239 val = I2S_TXCR_TFS_PCM | I2S_TXCR_PBM_MODE(1);
245 regmap_update_bits(i2s->regmap, I2S_TXCR, mask, val);
247 mask = I2S_RXCR_IBM_MASK | I2S_RXCR_TFS_MASK | I2S_RXCR_PBM_MASK;
248 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
249 case SND_SOC_DAIFMT_RIGHT_J:
250 val = I2S_RXCR_IBM_RSJM;
252 case SND_SOC_DAIFMT_LEFT_J:
253 val = I2S_RXCR_IBM_LSJM;
255 case SND_SOC_DAIFMT_I2S:
256 val = I2S_RXCR_IBM_NORMAL;
258 case SND_SOC_DAIFMT_DSP_A: /* PCM no delay mode */
259 val = I2S_RXCR_TFS_PCM;
261 case SND_SOC_DAIFMT_DSP_B: /* PCM delay 1 mode */
262 val = I2S_RXCR_TFS_PCM | I2S_RXCR_PBM_MODE(1);
268 regmap_update_bits(i2s->regmap, I2S_RXCR, mask, val);
273 static int rockchip_i2s_hw_params(struct snd_pcm_substream *substream,
274 struct snd_pcm_hw_params *params,
275 struct snd_soc_dai *dai)
277 struct rk_i2s_dev *i2s = to_info(dai);
278 struct snd_soc_pcm_runtime *rtd = substream->private_data;
279 unsigned int val = 0;
280 unsigned int mclk_rate, bclk_rate, div_bclk, div_lrck;
282 if (i2s->is_master_mode) {
283 mclk_rate = clk_get_rate(i2s->mclk);
284 bclk_rate = i2s->bclk_fs * params_rate(params);
285 if (bclk_rate && mclk_rate % bclk_rate)
288 div_bclk = mclk_rate / bclk_rate;
289 div_lrck = bclk_rate / params_rate(params);
290 regmap_update_bits(i2s->regmap, I2S_CKR,
292 I2S_CKR_MDIV(div_bclk));
294 regmap_update_bits(i2s->regmap, I2S_CKR,
297 I2S_CKR_TSD(div_lrck) |
298 I2S_CKR_RSD(div_lrck));
301 switch (params_format(params)) {
302 case SNDRV_PCM_FORMAT_S8:
303 val |= I2S_TXCR_VDW(8);
305 case SNDRV_PCM_FORMAT_S16_LE:
306 val |= I2S_TXCR_VDW(16);
308 case SNDRV_PCM_FORMAT_S20_3LE:
309 val |= I2S_TXCR_VDW(20);
311 case SNDRV_PCM_FORMAT_S24_LE:
312 val |= I2S_TXCR_VDW(24);
314 case SNDRV_PCM_FORMAT_S32_LE:
315 val |= I2S_TXCR_VDW(32);
321 switch (params_channels(params)) {
335 dev_err(i2s->dev, "invalid channel: %d\n",
336 params_channels(params));
340 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
341 regmap_update_bits(i2s->regmap, I2S_RXCR,
342 I2S_RXCR_VDW_MASK | I2S_RXCR_CSR_MASK,
345 regmap_update_bits(i2s->regmap, I2S_TXCR,
346 I2S_TXCR_VDW_MASK | I2S_TXCR_CSR_MASK,
349 if (!IS_ERR(i2s->grf) && i2s->pins) {
350 regmap_read(i2s->regmap, I2S_TXCR, &val);
351 val &= I2S_TXCR_CSR_MASK;
355 val = I2S_IO_4CH_OUT_6CH_IN;
358 val = I2S_IO_6CH_OUT_4CH_IN;
361 val = I2S_IO_8CH_OUT_2CH_IN;
364 val = I2S_IO_2CH_OUT_8CH_IN;
368 val <<= i2s->pins->shift;
369 val |= (I2S_IO_DIRECTION_MASK << i2s->pins->shift) << 16;
370 regmap_write(i2s->grf, i2s->pins->reg_offset, val);
373 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_TDL_MASK,
375 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_RDL_MASK,
378 val = I2S_CKR_TRCM_TXRX;
379 if (dai->driver->symmetric_rates && rtd->dai_link->symmetric_rates)
380 val = I2S_CKR_TRCM_TXONLY;
382 regmap_update_bits(i2s->regmap, I2S_CKR,
388 static int rockchip_i2s_trigger(struct snd_pcm_substream *substream,
389 int cmd, struct snd_soc_dai *dai)
391 struct rk_i2s_dev *i2s = to_info(dai);
395 case SNDRV_PCM_TRIGGER_START:
396 case SNDRV_PCM_TRIGGER_RESUME:
397 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
398 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
399 rockchip_snd_rxctrl(i2s, 1);
401 rockchip_snd_txctrl(i2s, 1);
403 case SNDRV_PCM_TRIGGER_SUSPEND:
404 case SNDRV_PCM_TRIGGER_STOP:
405 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
406 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
407 rockchip_snd_rxctrl(i2s, 0);
409 rockchip_snd_txctrl(i2s, 0);
419 static int rockchip_i2s_set_sysclk(struct snd_soc_dai *cpu_dai, int clk_id,
420 unsigned int freq, int dir)
422 struct rk_i2s_dev *i2s = to_info(cpu_dai);
425 ret = clk_set_rate(i2s->mclk, freq);
427 dev_err(i2s->dev, "Fail to set mclk %d\n", ret);
432 static int rockchip_i2s_dai_probe(struct snd_soc_dai *dai)
434 struct rk_i2s_dev *i2s = snd_soc_dai_get_drvdata(dai);
436 dai->capture_dma_data = &i2s->capture_dma_data;
437 dai->playback_dma_data = &i2s->playback_dma_data;
442 static const struct snd_soc_dai_ops rockchip_i2s_dai_ops = {
443 .hw_params = rockchip_i2s_hw_params,
444 .set_sysclk = rockchip_i2s_set_sysclk,
445 .set_fmt = rockchip_i2s_set_fmt,
446 .trigger = rockchip_i2s_trigger,
449 static struct snd_soc_dai_driver rockchip_i2s_dai = {
450 .probe = rockchip_i2s_dai_probe,
452 .stream_name = "Playback",
455 .rates = SNDRV_PCM_RATE_8000_192000,
456 .formats = (SNDRV_PCM_FMTBIT_S8 |
457 SNDRV_PCM_FMTBIT_S16_LE |
458 SNDRV_PCM_FMTBIT_S20_3LE |
459 SNDRV_PCM_FMTBIT_S24_LE |
460 SNDRV_PCM_FMTBIT_S32_LE),
463 .stream_name = "Capture",
466 .rates = SNDRV_PCM_RATE_8000_192000,
467 .formats = (SNDRV_PCM_FMTBIT_S8 |
468 SNDRV_PCM_FMTBIT_S16_LE |
469 SNDRV_PCM_FMTBIT_S20_3LE |
470 SNDRV_PCM_FMTBIT_S24_LE |
471 SNDRV_PCM_FMTBIT_S32_LE),
473 .ops = &rockchip_i2s_dai_ops,
474 .symmetric_rates = 1,
477 static const struct snd_soc_component_driver rockchip_i2s_component = {
481 static bool rockchip_i2s_wr_reg(struct device *dev, unsigned int reg)
498 static bool rockchip_i2s_rd_reg(struct device *dev, unsigned int reg)
517 static bool rockchip_i2s_volatile_reg(struct device *dev, unsigned int reg)
528 static bool rockchip_i2s_precious_reg(struct device *dev, unsigned int reg)
536 static const struct reg_default rockchip_i2s_reg_defaults[] = {
544 static const struct regmap_config rockchip_i2s_regmap_config = {
548 .max_register = I2S_RXDR,
549 .reg_defaults = rockchip_i2s_reg_defaults,
550 .num_reg_defaults = ARRAY_SIZE(rockchip_i2s_reg_defaults),
551 .writeable_reg = rockchip_i2s_wr_reg,
552 .readable_reg = rockchip_i2s_rd_reg,
553 .volatile_reg = rockchip_i2s_volatile_reg,
554 .precious_reg = rockchip_i2s_precious_reg,
555 .cache_type = REGCACHE_FLAT,
558 static const struct rk_i2s_pins rk3399_i2s_pins = {
559 .reg_offset = 0xe220,
563 static const struct of_device_id rockchip_i2s_match[] = {
564 { .compatible = "rockchip,rk3066-i2s", },
565 { .compatible = "rockchip,rk3188-i2s", },
566 { .compatible = "rockchip,rk3288-i2s", },
567 { .compatible = "rockchip,rk3399-i2s", .data = &rk3399_i2s_pins },
571 static int rockchip_i2s_probe(struct platform_device *pdev)
573 struct device_node *node = pdev->dev.of_node;
574 const struct of_device_id *of_id;
575 struct rk_i2s_dev *i2s;
576 struct snd_soc_dai_driver *soc_dai;
577 struct resource *res;
582 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
584 dev_err(&pdev->dev, "Can't allocate rk_i2s_dev\n");
588 i2s->dev = &pdev->dev;
590 i2s->grf = syscon_regmap_lookup_by_phandle(node, "rockchip,grf");
591 if (!IS_ERR(i2s->grf)) {
592 of_id = of_match_device(rockchip_i2s_match, &pdev->dev);
593 if (!of_id || !of_id->data)
596 i2s->pins = of_id->data;
599 /* try to prepare related clocks */
600 i2s->hclk = devm_clk_get(&pdev->dev, "i2s_hclk");
601 if (IS_ERR(i2s->hclk)) {
602 dev_err(&pdev->dev, "Can't retrieve i2s bus clock\n");
603 return PTR_ERR(i2s->hclk);
605 ret = clk_prepare_enable(i2s->hclk);
607 dev_err(i2s->dev, "hclock enable failed %d\n", ret);
611 i2s->mclk = devm_clk_get(&pdev->dev, "i2s_clk");
612 if (IS_ERR(i2s->mclk)) {
613 dev_err(&pdev->dev, "Can't retrieve i2s master clock\n");
614 return PTR_ERR(i2s->mclk);
617 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
618 regs = devm_ioremap_resource(&pdev->dev, res);
620 return PTR_ERR(regs);
622 i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
623 &rockchip_i2s_regmap_config);
624 if (IS_ERR(i2s->regmap)) {
626 "Failed to initialise managed register map\n");
627 return PTR_ERR(i2s->regmap);
630 i2s->playback_dma_data.addr = res->start + I2S_TXDR;
631 i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
632 i2s->playback_dma_data.maxburst = 16;
634 i2s->capture_dma_data.addr = res->start + I2S_RXDR;
635 i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
636 i2s->capture_dma_data.maxburst = 16;
638 dev_set_drvdata(&pdev->dev, i2s);
640 pm_runtime_enable(&pdev->dev);
641 if (!pm_runtime_enabled(&pdev->dev)) {
642 ret = i2s_runtime_resume(&pdev->dev);
647 soc_dai = devm_kzalloc(&pdev->dev,
648 sizeof(*soc_dai), GFP_KERNEL);
652 memcpy(soc_dai, &rockchip_i2s_dai, sizeof(*soc_dai));
653 if (!of_property_read_u32(node, "rockchip,playback-channels", &val)) {
654 if (val >= 2 && val <= 8)
655 soc_dai->playback.channels_max = val;
658 if (!of_property_read_u32(node, "rockchip,capture-channels", &val)) {
659 if (val >= 2 && val <= 8)
660 soc_dai->capture.channels_max = val;
664 if (!of_property_read_u32(node, "rockchip,bclk-fs", &val)) {
665 if ((val >= 32) && (val % 2 == 0))
669 ret = devm_snd_soc_register_component(&pdev->dev,
670 &rockchip_i2s_component,
674 dev_err(&pdev->dev, "Could not register DAI\n");
678 ret = devm_snd_dmaengine_pcm_register(&pdev->dev, NULL, 0);
680 dev_err(&pdev->dev, "Could not register PCM\n");
687 if (!pm_runtime_status_suspended(&pdev->dev))
688 i2s_runtime_suspend(&pdev->dev);
690 pm_runtime_disable(&pdev->dev);
695 static int rockchip_i2s_remove(struct platform_device *pdev)
697 struct rk_i2s_dev *i2s = dev_get_drvdata(&pdev->dev);
699 pm_runtime_disable(&pdev->dev);
700 if (!pm_runtime_status_suspended(&pdev->dev))
701 i2s_runtime_suspend(&pdev->dev);
703 clk_disable_unprepare(i2s->mclk);
704 clk_disable_unprepare(i2s->hclk);
709 #ifdef CONFIG_PM_SLEEP
710 static int rockchip_i2s_suspend(struct device *dev)
712 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
714 regcache_mark_dirty(i2s->regmap);
719 static int rockchip_i2s_resume(struct device *dev)
721 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
724 ret = pm_runtime_get_sync(dev);
727 ret = regcache_sync(i2s->regmap);
734 static const struct dev_pm_ops rockchip_i2s_pm_ops = {
735 SET_RUNTIME_PM_OPS(i2s_runtime_suspend, i2s_runtime_resume,
737 SET_SYSTEM_SLEEP_PM_OPS(rockchip_i2s_suspend, rockchip_i2s_resume)
740 static struct platform_driver rockchip_i2s_driver = {
741 .probe = rockchip_i2s_probe,
742 .remove = rockchip_i2s_remove,
745 .of_match_table = of_match_ptr(rockchip_i2s_match),
746 .pm = &rockchip_i2s_pm_ops,
749 module_platform_driver(rockchip_i2s_driver);
751 MODULE_DESCRIPTION("ROCKCHIP IIS ASoC Interface");
752 MODULE_AUTHOR("jianqun <jay.xu@rock-chips.com>");
753 MODULE_LICENSE("GPL v2");
754 MODULE_ALIAS("platform:" DRV_NAME);
755 MODULE_DEVICE_TABLE(of, rockchip_i2s_match);