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;
56 static int i2s_runtime_suspend(struct device *dev)
58 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
60 regcache_cache_only(i2s->regmap, true);
61 clk_disable_unprepare(i2s->mclk);
66 static int i2s_runtime_resume(struct device *dev)
68 struct rk_i2s_dev *i2s = dev_get_drvdata(dev);
71 ret = clk_prepare_enable(i2s->mclk);
73 dev_err(i2s->dev, "clock enable failed %d\n", ret);
77 regcache_cache_only(i2s->regmap, false);
78 regcache_mark_dirty(i2s->regmap);
80 ret = regcache_sync(i2s->regmap);
82 clk_disable_unprepare(i2s->mclk);
87 static inline struct rk_i2s_dev *to_info(struct snd_soc_dai *dai)
89 return snd_soc_dai_get_drvdata(dai);
92 static void rockchip_snd_txctrl(struct rk_i2s_dev *i2s, int on)
98 regmap_update_bits(i2s->regmap, I2S_DMACR,
99 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_ENABLE);
101 regmap_update_bits(i2s->regmap, I2S_XFER,
102 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
103 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
105 i2s->tx_start = true;
107 i2s->tx_start = false;
109 regmap_update_bits(i2s->regmap, I2S_DMACR,
110 I2S_DMACR_TDE_ENABLE, I2S_DMACR_TDE_DISABLE);
112 if (!i2s->rx_start) {
113 regmap_update_bits(i2s->regmap, I2S_XFER,
120 regmap_update_bits(i2s->regmap, I2S_CLR,
121 I2S_CLR_TXC | I2S_CLR_RXC,
122 I2S_CLR_TXC | I2S_CLR_RXC);
124 regmap_read(i2s->regmap, I2S_CLR, &val);
126 /* Should wait for clear operation to finish */
128 regmap_read(i2s->regmap, I2S_CLR, &val);
131 dev_warn(i2s->dev, "fail to clear\n");
139 static void rockchip_snd_rxctrl(struct rk_i2s_dev *i2s, int on)
141 unsigned int val = 0;
145 regmap_update_bits(i2s->regmap, I2S_DMACR,
146 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_ENABLE);
148 regmap_update_bits(i2s->regmap, I2S_XFER,
149 I2S_XFER_TXS_START | I2S_XFER_RXS_START,
150 I2S_XFER_TXS_START | I2S_XFER_RXS_START);
152 i2s->rx_start = true;
154 i2s->rx_start = false;
156 regmap_update_bits(i2s->regmap, I2S_DMACR,
157 I2S_DMACR_RDE_ENABLE, I2S_DMACR_RDE_DISABLE);
159 if (!i2s->tx_start) {
160 regmap_update_bits(i2s->regmap, I2S_XFER,
167 regmap_update_bits(i2s->regmap, I2S_CLR,
168 I2S_CLR_TXC | I2S_CLR_RXC,
169 I2S_CLR_TXC | I2S_CLR_RXC);
171 regmap_read(i2s->regmap, I2S_CLR, &val);
173 /* Should wait for clear operation to finish */
175 regmap_read(i2s->regmap, I2S_CLR, &val);
178 dev_warn(i2s->dev, "fail to clear\n");
186 static int rockchip_i2s_set_fmt(struct snd_soc_dai *cpu_dai,
189 struct rk_i2s_dev *i2s = to_info(cpu_dai);
190 unsigned int mask = 0, val = 0;
193 pm_runtime_get_sync(cpu_dai->dev);
194 mask = I2S_CKR_MSS_MASK;
195 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
196 case SND_SOC_DAIFMT_CBS_CFS:
197 /* Set source clock in Master mode */
198 val = I2S_CKR_MSS_MASTER;
199 i2s->is_master_mode = true;
201 case SND_SOC_DAIFMT_CBM_CFM:
202 val = I2S_CKR_MSS_SLAVE;
203 i2s->is_master_mode = false;
210 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
212 mask = I2S_CKR_CKP_MASK;
213 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
214 case SND_SOC_DAIFMT_NB_NF:
215 val = I2S_CKR_CKP_NEG;
217 case SND_SOC_DAIFMT_IB_NF:
218 val = I2S_CKR_CKP_POS;
225 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
227 mask = I2S_TXCR_IBM_MASK | I2S_TXCR_TFS_MASK | I2S_TXCR_PBM_MASK;
228 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
229 case SND_SOC_DAIFMT_RIGHT_J:
230 val = I2S_TXCR_IBM_RSJM;
232 case SND_SOC_DAIFMT_LEFT_J:
233 val = I2S_TXCR_IBM_LSJM;
235 case SND_SOC_DAIFMT_I2S:
236 val = I2S_TXCR_IBM_NORMAL;
238 case SND_SOC_DAIFMT_DSP_A: /* PCM delay 1 bit mode */
239 val = I2S_TXCR_TFS_PCM | I2S_TXCR_PBM_MODE(1);
241 case SND_SOC_DAIFMT_DSP_B: /* PCM no delay mode */
242 val = I2S_TXCR_TFS_PCM;
249 regmap_update_bits(i2s->regmap, I2S_TXCR, mask, val);
251 mask = I2S_RXCR_IBM_MASK | I2S_RXCR_TFS_MASK | I2S_RXCR_PBM_MASK;
252 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
253 case SND_SOC_DAIFMT_RIGHT_J:
254 val = I2S_RXCR_IBM_RSJM;
256 case SND_SOC_DAIFMT_LEFT_J:
257 val = I2S_RXCR_IBM_LSJM;
259 case SND_SOC_DAIFMT_I2S:
260 val = I2S_RXCR_IBM_NORMAL;
262 case SND_SOC_DAIFMT_DSP_A: /* PCM delay 1 bit mode */
263 val = I2S_RXCR_TFS_PCM | I2S_RXCR_PBM_MODE(1);
265 case SND_SOC_DAIFMT_DSP_B: /* PCM no delay mode */
266 val = I2S_RXCR_TFS_PCM;
273 regmap_update_bits(i2s->regmap, I2S_RXCR, mask, val);
276 pm_runtime_put(cpu_dai->dev);
281 static int rockchip_i2s_hw_params(struct snd_pcm_substream *substream,
282 struct snd_pcm_hw_params *params,
283 struct snd_soc_dai *dai)
285 struct rk_i2s_dev *i2s = to_info(dai);
286 struct snd_soc_pcm_runtime *rtd = substream->private_data;
287 unsigned int val = 0;
288 unsigned int mclk_rate, bclk_rate, div_bclk, div_lrck;
290 if (i2s->is_master_mode) {
291 mclk_rate = clk_get_rate(i2s->mclk);
292 bclk_rate = 2 * 32 * params_rate(params);
293 if (bclk_rate && mclk_rate % bclk_rate)
296 div_bclk = mclk_rate / bclk_rate;
297 div_lrck = bclk_rate / params_rate(params);
298 regmap_update_bits(i2s->regmap, I2S_CKR,
300 I2S_CKR_MDIV(div_bclk));
302 regmap_update_bits(i2s->regmap, I2S_CKR,
305 I2S_CKR_TSD(div_lrck) |
306 I2S_CKR_RSD(div_lrck));
309 switch (params_format(params)) {
310 case SNDRV_PCM_FORMAT_S8:
311 val |= I2S_TXCR_VDW(8);
313 case SNDRV_PCM_FORMAT_S16_LE:
314 val |= I2S_TXCR_VDW(16);
316 case SNDRV_PCM_FORMAT_S20_3LE:
317 val |= I2S_TXCR_VDW(20);
319 case SNDRV_PCM_FORMAT_S24_LE:
320 val |= I2S_TXCR_VDW(24);
322 case SNDRV_PCM_FORMAT_S32_LE:
323 val |= I2S_TXCR_VDW(32);
329 switch (params_channels(params)) {
343 dev_err(i2s->dev, "invalid channel: %d\n",
344 params_channels(params));
348 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
349 regmap_update_bits(i2s->regmap, I2S_RXCR,
350 I2S_RXCR_VDW_MASK | I2S_RXCR_CSR_MASK,
353 regmap_update_bits(i2s->regmap, I2S_TXCR,
354 I2S_TXCR_VDW_MASK | I2S_TXCR_CSR_MASK,
357 if (!IS_ERR(i2s->grf) && i2s->pins) {
358 regmap_read(i2s->regmap, I2S_TXCR, &val);
359 val &= I2S_TXCR_CSR_MASK;
363 val = I2S_IO_4CH_OUT_6CH_IN;
366 val = I2S_IO_6CH_OUT_4CH_IN;
369 val = I2S_IO_8CH_OUT_2CH_IN;
372 val = I2S_IO_2CH_OUT_8CH_IN;
376 val <<= i2s->pins->shift;
377 val |= (I2S_IO_DIRECTION_MASK << i2s->pins->shift) << 16;
378 regmap_write(i2s->grf, i2s->pins->reg_offset, val);
381 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_TDL_MASK,
383 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_RDL_MASK,
386 val = I2S_CKR_TRCM_TXRX;
387 if (dai->driver->symmetric_rates && rtd->dai_link->symmetric_rates)
388 val = I2S_CKR_TRCM_TXONLY;
390 regmap_update_bits(i2s->regmap, I2S_CKR,
396 static int rockchip_i2s_trigger(struct snd_pcm_substream *substream,
397 int cmd, struct snd_soc_dai *dai)
399 struct rk_i2s_dev *i2s = to_info(dai);
403 case SNDRV_PCM_TRIGGER_START:
404 case SNDRV_PCM_TRIGGER_RESUME:
405 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
406 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
407 rockchip_snd_rxctrl(i2s, 1);
409 rockchip_snd_txctrl(i2s, 1);
411 case SNDRV_PCM_TRIGGER_SUSPEND:
412 case SNDRV_PCM_TRIGGER_STOP:
413 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
414 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
415 rockchip_snd_rxctrl(i2s, 0);
417 rockchip_snd_txctrl(i2s, 0);
427 static int rockchip_i2s_set_sysclk(struct snd_soc_dai *cpu_dai, int clk_id,
428 unsigned int freq, int dir)
430 struct rk_i2s_dev *i2s = to_info(cpu_dai);
433 ret = clk_set_rate(i2s->mclk, freq);
435 dev_err(i2s->dev, "Fail to set mclk %d\n", ret);
440 static int rockchip_i2s_dai_probe(struct snd_soc_dai *dai)
442 struct rk_i2s_dev *i2s = snd_soc_dai_get_drvdata(dai);
444 dai->capture_dma_data = &i2s->capture_dma_data;
445 dai->playback_dma_data = &i2s->playback_dma_data;
450 static const struct snd_soc_dai_ops rockchip_i2s_dai_ops = {
451 .hw_params = rockchip_i2s_hw_params,
452 .set_sysclk = rockchip_i2s_set_sysclk,
453 .set_fmt = rockchip_i2s_set_fmt,
454 .trigger = rockchip_i2s_trigger,
457 static struct snd_soc_dai_driver rockchip_i2s_dai = {
458 .probe = rockchip_i2s_dai_probe,
460 .stream_name = "Playback",
463 .rates = SNDRV_PCM_RATE_8000_192000,
464 .formats = (SNDRV_PCM_FMTBIT_S8 |
465 SNDRV_PCM_FMTBIT_S16_LE |
466 SNDRV_PCM_FMTBIT_S20_3LE |
467 SNDRV_PCM_FMTBIT_S24_LE |
468 SNDRV_PCM_FMTBIT_S32_LE),
471 .stream_name = "Capture",
474 .rates = SNDRV_PCM_RATE_8000_192000,
475 .formats = (SNDRV_PCM_FMTBIT_S8 |
476 SNDRV_PCM_FMTBIT_S16_LE |
477 SNDRV_PCM_FMTBIT_S20_3LE |
478 SNDRV_PCM_FMTBIT_S24_LE |
479 SNDRV_PCM_FMTBIT_S32_LE),
481 .ops = &rockchip_i2s_dai_ops,
482 .symmetric_rates = 1,
485 static const struct snd_soc_component_driver rockchip_i2s_component = {
489 static bool rockchip_i2s_wr_reg(struct device *dev, unsigned int reg)
506 static bool rockchip_i2s_rd_reg(struct device *dev, unsigned int reg)
526 static bool rockchip_i2s_volatile_reg(struct device *dev, unsigned int reg)
540 static bool rockchip_i2s_precious_reg(struct device *dev, unsigned int reg)
550 static const struct reg_default rockchip_i2s_reg_defaults[] = {
558 static const struct regmap_config rockchip_i2s_regmap_config = {
562 .max_register = I2S_RXDR,
563 .reg_defaults = rockchip_i2s_reg_defaults,
564 .num_reg_defaults = ARRAY_SIZE(rockchip_i2s_reg_defaults),
565 .writeable_reg = rockchip_i2s_wr_reg,
566 .readable_reg = rockchip_i2s_rd_reg,
567 .volatile_reg = rockchip_i2s_volatile_reg,
568 .precious_reg = rockchip_i2s_precious_reg,
569 .cache_type = REGCACHE_FLAT,
572 static const struct rk_i2s_pins rk3399_i2s_pins = {
573 .reg_offset = 0xe220,
577 static const struct of_device_id rockchip_i2s_match[] = {
578 { .compatible = "rockchip,rk3066-i2s", },
579 { .compatible = "rockchip,rk3188-i2s", },
580 { .compatible = "rockchip,rk3288-i2s", },
581 { .compatible = "rockchip,rk3399-i2s", .data = &rk3399_i2s_pins },
585 static int rockchip_i2s_probe(struct platform_device *pdev)
587 struct device_node *node = pdev->dev.of_node;
588 const struct of_device_id *of_id;
589 struct rk_i2s_dev *i2s;
590 struct snd_soc_dai_driver *soc_dai;
591 struct resource *res;
596 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
600 i2s->dev = &pdev->dev;
602 i2s->grf = syscon_regmap_lookup_by_phandle(node, "rockchip,grf");
603 if (!IS_ERR(i2s->grf)) {
604 of_id = of_match_device(rockchip_i2s_match, &pdev->dev);
605 if (!of_id || !of_id->data)
608 i2s->pins = of_id->data;
611 /* try to prepare related clocks */
612 i2s->hclk = devm_clk_get(&pdev->dev, "i2s_hclk");
613 if (IS_ERR(i2s->hclk)) {
614 dev_err(&pdev->dev, "Can't retrieve i2s bus clock\n");
615 return PTR_ERR(i2s->hclk);
617 ret = clk_prepare_enable(i2s->hclk);
619 dev_err(i2s->dev, "hclock enable failed %d\n", ret);
623 i2s->mclk = devm_clk_get(&pdev->dev, "i2s_clk");
624 if (IS_ERR(i2s->mclk)) {
625 dev_err(&pdev->dev, "Can't retrieve i2s master clock\n");
626 return PTR_ERR(i2s->mclk);
629 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
630 regs = devm_ioremap_resource(&pdev->dev, res);
632 return PTR_ERR(regs);
634 i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
635 &rockchip_i2s_regmap_config);
636 if (IS_ERR(i2s->regmap)) {
638 "Failed to initialise managed register map\n");
639 return PTR_ERR(i2s->regmap);
642 i2s->playback_dma_data.addr = res->start + I2S_TXDR;
643 i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
644 i2s->playback_dma_data.maxburst = 4;
646 i2s->capture_dma_data.addr = res->start + I2S_RXDR;
647 i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
648 i2s->capture_dma_data.maxburst = 4;
650 dev_set_drvdata(&pdev->dev, i2s);
652 pm_runtime_enable(&pdev->dev);
653 if (!pm_runtime_enabled(&pdev->dev)) {
654 ret = i2s_runtime_resume(&pdev->dev);
659 soc_dai = devm_kmemdup(&pdev->dev, &rockchip_i2s_dai,
660 sizeof(*soc_dai), GFP_KERNEL);
666 if (!of_property_read_u32(node, "rockchip,playback-channels", &val)) {
667 if (val >= 2 && val <= 8)
668 soc_dai->playback.channels_max = val;
671 if (!of_property_read_u32(node, "rockchip,capture-channels", &val)) {
672 if (val >= 2 && val <= 8)
673 soc_dai->capture.channels_max = val;
676 ret = devm_snd_soc_register_component(&pdev->dev,
677 &rockchip_i2s_component,
681 dev_err(&pdev->dev, "Could not register DAI\n");
685 ret = devm_snd_dmaengine_pcm_register(&pdev->dev, NULL, 0);
687 dev_err(&pdev->dev, "Could not register PCM\n");
694 if (!pm_runtime_status_suspended(&pdev->dev))
695 i2s_runtime_suspend(&pdev->dev);
697 pm_runtime_disable(&pdev->dev);
702 static int rockchip_i2s_remove(struct platform_device *pdev)
704 struct rk_i2s_dev *i2s = dev_get_drvdata(&pdev->dev);
706 pm_runtime_disable(&pdev->dev);
707 if (!pm_runtime_status_suspended(&pdev->dev))
708 i2s_runtime_suspend(&pdev->dev);
710 clk_disable_unprepare(i2s->mclk);
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);