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;
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;
207 regmap_update_bits(i2s->regmap, I2S_CKR, mask, val);
209 mask = I2S_TXCR_IBM_MASK;
210 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
211 case SND_SOC_DAIFMT_RIGHT_J:
212 val = I2S_TXCR_IBM_RSJM;
214 case SND_SOC_DAIFMT_LEFT_J:
215 val = I2S_TXCR_IBM_LSJM;
217 case SND_SOC_DAIFMT_I2S:
218 val = I2S_TXCR_IBM_NORMAL;
224 regmap_update_bits(i2s->regmap, I2S_TXCR, mask, val);
226 mask = I2S_RXCR_IBM_MASK;
227 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
228 case SND_SOC_DAIFMT_RIGHT_J:
229 val = I2S_RXCR_IBM_RSJM;
231 case SND_SOC_DAIFMT_LEFT_J:
232 val = I2S_RXCR_IBM_LSJM;
234 case SND_SOC_DAIFMT_I2S:
235 val = I2S_RXCR_IBM_NORMAL;
241 regmap_update_bits(i2s->regmap, I2S_RXCR, mask, val);
246 static int rockchip_i2s_hw_params(struct snd_pcm_substream *substream,
247 struct snd_pcm_hw_params *params,
248 struct snd_soc_dai *dai)
250 struct rk_i2s_dev *i2s = to_info(dai);
251 struct snd_soc_pcm_runtime *rtd = substream->private_data;
252 unsigned int val = 0;
253 unsigned int mclk_rate, bclk_rate, div_bclk, div_lrck;
255 if (i2s->is_master_mode) {
256 mclk_rate = clk_get_rate(i2s->mclk);
257 bclk_rate = 2 * 32 * params_rate(params);
258 if (bclk_rate && mclk_rate % bclk_rate)
261 div_bclk = mclk_rate / bclk_rate;
262 div_lrck = bclk_rate / params_rate(params);
263 regmap_update_bits(i2s->regmap, I2S_CKR,
265 I2S_CKR_MDIV(div_bclk));
267 regmap_update_bits(i2s->regmap, I2S_CKR,
270 I2S_CKR_TSD(div_lrck) |
271 I2S_CKR_RSD(div_lrck));
274 switch (params_format(params)) {
275 case SNDRV_PCM_FORMAT_S8:
276 val |= I2S_TXCR_VDW(8);
278 case SNDRV_PCM_FORMAT_S16_LE:
279 val |= I2S_TXCR_VDW(16);
281 case SNDRV_PCM_FORMAT_S20_3LE:
282 val |= I2S_TXCR_VDW(20);
284 case SNDRV_PCM_FORMAT_S24_LE:
285 val |= I2S_TXCR_VDW(24);
287 case SNDRV_PCM_FORMAT_S32_LE:
288 val |= I2S_TXCR_VDW(32);
294 switch (params_channels(params)) {
308 dev_err(i2s->dev, "invalid channel: %d\n",
309 params_channels(params));
313 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
314 regmap_update_bits(i2s->regmap, I2S_RXCR,
315 I2S_RXCR_VDW_MASK | I2S_RXCR_CSR_MASK,
318 regmap_update_bits(i2s->regmap, I2S_TXCR,
319 I2S_TXCR_VDW_MASK | I2S_TXCR_CSR_MASK,
322 if (!IS_ERR(i2s->grf) && i2s->pins) {
323 regmap_read(i2s->regmap, I2S_TXCR, &val);
324 val &= I2S_TXCR_CSR_MASK;
328 val = I2S_IO_4CH_OUT_6CH_IN;
331 val = I2S_IO_6CH_OUT_4CH_IN;
334 val = I2S_IO_8CH_OUT_2CH_IN;
337 val = I2S_IO_2CH_OUT_8CH_IN;
341 val <<= i2s->pins->shift;
342 val |= (I2S_IO_DIRECTION_MASK << i2s->pins->shift) << 16;
343 regmap_write(i2s->grf, i2s->pins->reg_offset, val);
346 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_TDL_MASK,
348 regmap_update_bits(i2s->regmap, I2S_DMACR, I2S_DMACR_RDL_MASK,
351 val = I2S_CKR_TRCM_TXRX;
352 if (dai->driver->symmetric_rates && rtd->dai_link->symmetric_rates)
353 val = I2S_CKR_TRCM_TXONLY;
355 regmap_update_bits(i2s->regmap, I2S_CKR,
361 static int rockchip_i2s_trigger(struct snd_pcm_substream *substream,
362 int cmd, struct snd_soc_dai *dai)
364 struct rk_i2s_dev *i2s = to_info(dai);
368 case SNDRV_PCM_TRIGGER_START:
369 case SNDRV_PCM_TRIGGER_RESUME:
370 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
371 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
372 rockchip_snd_rxctrl(i2s, 1);
374 rockchip_snd_txctrl(i2s, 1);
376 case SNDRV_PCM_TRIGGER_SUSPEND:
377 case SNDRV_PCM_TRIGGER_STOP:
378 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
379 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
380 rockchip_snd_rxctrl(i2s, 0);
382 rockchip_snd_txctrl(i2s, 0);
392 static int rockchip_i2s_set_sysclk(struct snd_soc_dai *cpu_dai, int clk_id,
393 unsigned int freq, int dir)
395 struct rk_i2s_dev *i2s = to_info(cpu_dai);
398 ret = clk_set_rate(i2s->mclk, freq);
400 dev_err(i2s->dev, "Fail to set mclk %d\n", ret);
405 static int rockchip_i2s_dai_probe(struct snd_soc_dai *dai)
407 struct rk_i2s_dev *i2s = snd_soc_dai_get_drvdata(dai);
409 dai->capture_dma_data = &i2s->capture_dma_data;
410 dai->playback_dma_data = &i2s->playback_dma_data;
415 static const struct snd_soc_dai_ops rockchip_i2s_dai_ops = {
416 .hw_params = rockchip_i2s_hw_params,
417 .set_sysclk = rockchip_i2s_set_sysclk,
418 .set_fmt = rockchip_i2s_set_fmt,
419 .trigger = rockchip_i2s_trigger,
422 static struct snd_soc_dai_driver rockchip_i2s_dai = {
423 .probe = rockchip_i2s_dai_probe,
425 .stream_name = "Playback",
428 .rates = SNDRV_PCM_RATE_8000_192000,
429 .formats = (SNDRV_PCM_FMTBIT_S8 |
430 SNDRV_PCM_FMTBIT_S16_LE |
431 SNDRV_PCM_FMTBIT_S20_3LE |
432 SNDRV_PCM_FMTBIT_S24_LE |
433 SNDRV_PCM_FMTBIT_S32_LE),
436 .stream_name = "Capture",
439 .rates = SNDRV_PCM_RATE_8000_192000,
440 .formats = (SNDRV_PCM_FMTBIT_S8 |
441 SNDRV_PCM_FMTBIT_S16_LE |
442 SNDRV_PCM_FMTBIT_S20_3LE |
443 SNDRV_PCM_FMTBIT_S24_LE |
444 SNDRV_PCM_FMTBIT_S32_LE),
446 .ops = &rockchip_i2s_dai_ops,
447 .symmetric_rates = 1,
450 static const struct snd_soc_component_driver rockchip_i2s_component = {
454 static bool rockchip_i2s_wr_reg(struct device *dev, unsigned int reg)
471 static bool rockchip_i2s_rd_reg(struct device *dev, unsigned int reg)
490 static bool rockchip_i2s_volatile_reg(struct device *dev, unsigned int reg)
501 static bool rockchip_i2s_precious_reg(struct device *dev, unsigned int reg)
509 static const struct reg_default rockchip_i2s_reg_defaults[] = {
517 static const struct regmap_config rockchip_i2s_regmap_config = {
521 .max_register = I2S_RXDR,
522 .reg_defaults = rockchip_i2s_reg_defaults,
523 .num_reg_defaults = ARRAY_SIZE(rockchip_i2s_reg_defaults),
524 .writeable_reg = rockchip_i2s_wr_reg,
525 .readable_reg = rockchip_i2s_rd_reg,
526 .volatile_reg = rockchip_i2s_volatile_reg,
527 .precious_reg = rockchip_i2s_precious_reg,
528 .cache_type = REGCACHE_FLAT,
531 static const struct rk_i2s_pins rk3399_i2s_pins = {
532 .reg_offset = 0xe220,
536 static const struct of_device_id rockchip_i2s_match[] = {
537 { .compatible = "rockchip,rk3066-i2s", },
538 { .compatible = "rockchip,rk3188-i2s", },
539 { .compatible = "rockchip,rk3288-i2s", },
540 { .compatible = "rockchip,rk3399-i2s", .data = &rk3399_i2s_pins },
544 static int rockchip_i2s_probe(struct platform_device *pdev)
546 struct device_node *node = pdev->dev.of_node;
547 const struct of_device_id *of_id;
548 struct rk_i2s_dev *i2s;
549 struct snd_soc_dai_driver *soc_dai;
550 struct resource *res;
555 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
557 dev_err(&pdev->dev, "Can't allocate rk_i2s_dev\n");
561 i2s->dev = &pdev->dev;
563 i2s->grf = syscon_regmap_lookup_by_phandle(node, "rockchip,grf");
564 if (!IS_ERR(i2s->grf)) {
565 of_id = of_match_device(rockchip_i2s_match, &pdev->dev);
566 if (!of_id || !of_id->data)
569 i2s->pins = of_id->data;
572 /* try to prepare related clocks */
573 i2s->hclk = devm_clk_get(&pdev->dev, "i2s_hclk");
574 if (IS_ERR(i2s->hclk)) {
575 dev_err(&pdev->dev, "Can't retrieve i2s bus clock\n");
576 return PTR_ERR(i2s->hclk);
578 ret = clk_prepare_enable(i2s->hclk);
580 dev_err(i2s->dev, "hclock enable failed %d\n", ret);
584 i2s->mclk = devm_clk_get(&pdev->dev, "i2s_clk");
585 if (IS_ERR(i2s->mclk)) {
586 dev_err(&pdev->dev, "Can't retrieve i2s master clock\n");
587 return PTR_ERR(i2s->mclk);
590 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
591 regs = devm_ioremap_resource(&pdev->dev, res);
593 return PTR_ERR(regs);
595 i2s->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
596 &rockchip_i2s_regmap_config);
597 if (IS_ERR(i2s->regmap)) {
599 "Failed to initialise managed register map\n");
600 return PTR_ERR(i2s->regmap);
603 i2s->playback_dma_data.addr = res->start + I2S_TXDR;
604 i2s->playback_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
605 i2s->playback_dma_data.maxburst = 4;
607 i2s->capture_dma_data.addr = res->start + I2S_RXDR;
608 i2s->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
609 i2s->capture_dma_data.maxburst = 4;
611 dev_set_drvdata(&pdev->dev, i2s);
613 pm_runtime_enable(&pdev->dev);
614 if (!pm_runtime_enabled(&pdev->dev)) {
615 ret = i2s_runtime_resume(&pdev->dev);
620 soc_dai = devm_kzalloc(&pdev->dev,
621 sizeof(*soc_dai), GFP_KERNEL);
625 memcpy(soc_dai, &rockchip_i2s_dai, sizeof(*soc_dai));
626 if (!of_property_read_u32(node, "rockchip,playback-channels", &val)) {
627 if (val >= 2 && val <= 8)
628 soc_dai->playback.channels_max = val;
631 if (!of_property_read_u32(node, "rockchip,capture-channels", &val)) {
632 if (val >= 2 && val <= 8)
633 soc_dai->capture.channels_max = val;
636 ret = devm_snd_soc_register_component(&pdev->dev,
637 &rockchip_i2s_component,
641 dev_err(&pdev->dev, "Could not register DAI\n");
645 ret = devm_snd_dmaengine_pcm_register(&pdev->dev, NULL, 0);
647 dev_err(&pdev->dev, "Could not register PCM\n");
654 if (!pm_runtime_status_suspended(&pdev->dev))
655 i2s_runtime_suspend(&pdev->dev);
657 pm_runtime_disable(&pdev->dev);
662 static int rockchip_i2s_remove(struct platform_device *pdev)
664 struct rk_i2s_dev *i2s = dev_get_drvdata(&pdev->dev);
666 pm_runtime_disable(&pdev->dev);
667 if (!pm_runtime_status_suspended(&pdev->dev))
668 i2s_runtime_suspend(&pdev->dev);
670 clk_disable_unprepare(i2s->mclk);
671 clk_disable_unprepare(i2s->hclk);
676 static const struct dev_pm_ops rockchip_i2s_pm_ops = {
677 SET_RUNTIME_PM_OPS(i2s_runtime_suspend, i2s_runtime_resume,
681 static struct platform_driver rockchip_i2s_driver = {
682 .probe = rockchip_i2s_probe,
683 .remove = rockchip_i2s_remove,
686 .of_match_table = of_match_ptr(rockchip_i2s_match),
687 .pm = &rockchip_i2s_pm_ops,
690 module_platform_driver(rockchip_i2s_driver);
692 MODULE_DESCRIPTION("ROCKCHIP IIS ASoC Interface");
693 MODULE_AUTHOR("jianqun <jay.xu@rock-chips.com>");
694 MODULE_LICENSE("GPL v2");
695 MODULE_ALIAS("platform:" DRV_NAME);
696 MODULE_DEVICE_TABLE(of, rockchip_i2s_match);