1 // SPDX-License-Identifier: GPL-2.0-only
3 * Rockchip PDM ALSA SoC Digital Audio Interface(DAI) driver
5 * Copyright (C) 2017 Fuzhou Rockchip Electronics Co., Ltd
8 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/rational.h>
14 #include <linux/regmap.h>
15 #include <linux/reset.h>
16 #include <sound/dmaengine_pcm.h>
17 #include <sound/pcm_params.h>
19 #include "rockchip_pdm.h"
21 #define PDM_DMA_BURST_SIZE (8) /* size * width: 8*4 = 32 bytes */
22 #define PDM_SIGNOFF_CLK_RATE (100000000)
23 #define PDM_PATH_MAX (4)
35 struct regmap *regmap;
36 struct snd_dmaengine_dai_dma_data capture_dma_data;
37 struct reset_control *reset;
38 enum rk_pdm_version version;
41 struct rk_pdm_clkref {
47 struct rk_pdm_ds_ratio {
52 static struct rk_pdm_clkref clkref[] = {
53 { 8000, 40960000, 2048000 },
54 { 11025, 56448000, 2822400 },
55 { 12000, 61440000, 3072000 },
56 { 8000, 98304000, 2048000 },
57 { 12000, 98304000, 3072000 },
60 static struct rk_pdm_ds_ratio ds_ratio[] = {
78 static unsigned int get_pdm_clk(struct rk_pdm_dev *pdm, unsigned int sr,
79 unsigned int *clk_src, unsigned int *clk_out)
81 unsigned int i, count, clk, div, rate;
87 count = ARRAY_SIZE(clkref);
88 for (i = 0; i < count; i++) {
89 if (sr % clkref[i].sr)
91 div = sr / clkref[i].sr;
92 if ((div & (div - 1)) == 0) {
93 *clk_out = clkref[i].clk_out;
94 rate = clk_round_rate(pdm->clk, clkref[i].clk);
95 if (rate != clkref[i].clk)
98 *clk_src = clkref[i].clk;
104 clk = clk_round_rate(pdm->clk, PDM_SIGNOFF_CLK_RATE);
110 static unsigned int get_pdm_ds_ratio(unsigned int sr)
112 unsigned int i, count, ratio;
118 count = ARRAY_SIZE(ds_ratio);
119 for (i = 0; i < count; i++) {
120 if (sr == ds_ratio[i].sr)
121 ratio = ds_ratio[i].ratio;
126 static unsigned int get_pdm_cic_ratio(unsigned int clk)
146 static unsigned int samplerate_to_bit(unsigned int samplerate)
148 switch (samplerate) {
175 static inline struct rk_pdm_dev *to_info(struct snd_soc_dai *dai)
177 return snd_soc_dai_get_drvdata(dai);
180 static void rockchip_pdm_rxctrl(struct rk_pdm_dev *pdm, int on)
183 regmap_update_bits(pdm->regmap, PDM_DMA_CTRL,
184 PDM_DMA_RD_MSK, PDM_DMA_RD_EN);
185 regmap_update_bits(pdm->regmap, PDM_SYSCONFIG,
186 PDM_RX_MASK, PDM_RX_START);
188 regmap_update_bits(pdm->regmap, PDM_DMA_CTRL,
189 PDM_DMA_RD_MSK, PDM_DMA_RD_DIS);
190 regmap_update_bits(pdm->regmap, PDM_SYSCONFIG,
191 PDM_RX_MASK | PDM_RX_CLR_MASK,
192 PDM_RX_STOP | PDM_RX_CLR_WR);
196 static int rockchip_pdm_hw_params(struct snd_pcm_substream *substream,
197 struct snd_pcm_hw_params *params,
198 struct snd_soc_dai *dai)
200 struct rk_pdm_dev *pdm = to_info(dai);
201 unsigned int val = 0;
202 unsigned int clk_rate, clk_div, samplerate;
203 unsigned int clk_src, clk_out = 0;
208 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
211 samplerate = params_rate(params);
212 clk_rate = get_pdm_clk(pdm, samplerate, &clk_src, &clk_out);
216 ret = clk_set_rate(pdm->clk, clk_src);
220 if (pdm->version == RK_PDM_RK3308 ||
221 pdm->version == RK_PDM_RV1126) {
222 rational_best_approximation(clk_out, clk_src,
227 val = (m << PDM_FD_NUMERATOR_SFT) |
228 (n << PDM_FD_DENOMINATOR_SFT);
229 regmap_update_bits_check(pdm->regmap, PDM_CTRL1,
230 PDM_FD_NUMERATOR_MSK |
231 PDM_FD_DENOMINATOR_MSK,
234 reset_control_assert(pdm->reset);
235 reset_control_deassert(pdm->reset);
236 rockchip_pdm_rxctrl(pdm, 0);
240 val = PDM_CLK_FD_RATIO_40;
241 else if (clk_div <= 35)
242 val = PDM_CLK_FD_RATIO_35;
245 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL,
246 PDM_CLK_FD_RATIO_MSK,
250 if (pdm->version == RK_PDM_RV1126) {
251 val = get_pdm_cic_ratio(clk_out);
252 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL, PDM_CIC_RATIO_MSK, val);
253 val = samplerate_to_bit(samplerate);
254 regmap_update_bits(pdm->regmap, PDM_CTRL0,
255 PDM_SAMPLERATE_MSK, PDM_SAMPLERATE(val));
257 val = get_pdm_ds_ratio(samplerate);
258 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL, PDM_DS_RATIO_MSK, val);
261 regmap_update_bits(pdm->regmap, PDM_HPF_CTRL,
262 PDM_HPF_CF_MSK, PDM_HPF_60HZ);
263 regmap_update_bits(pdm->regmap, PDM_HPF_CTRL,
264 PDM_HPF_LE | PDM_HPF_RE, PDM_HPF_LE | PDM_HPF_RE);
265 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL, PDM_CLK_EN, PDM_CLK_EN);
266 if (pdm->version != RK_PDM_RK3229)
267 regmap_update_bits(pdm->regmap, PDM_CTRL0,
268 PDM_MODE_MSK, PDM_MODE_LJ);
271 switch (params_format(params)) {
272 case SNDRV_PCM_FORMAT_S8:
275 case SNDRV_PCM_FORMAT_S16_LE:
278 case SNDRV_PCM_FORMAT_S20_3LE:
281 case SNDRV_PCM_FORMAT_S24_LE:
284 case SNDRV_PCM_FORMAT_S32_LE:
291 switch (params_channels(params)) {
305 dev_err(pdm->dev, "invalid channel: %d\n",
306 params_channels(params));
310 regmap_update_bits(pdm->regmap, PDM_CTRL0,
311 PDM_PATH_MSK | PDM_VDW_MSK,
313 /* all channels share the single FIFO */
314 regmap_update_bits(pdm->regmap, PDM_DMA_CTRL, PDM_DMA_RDL_MSK,
315 PDM_DMA_RDL(8 * params_channels(params)));
320 static int rockchip_pdm_set_fmt(struct snd_soc_dai *cpu_dai,
323 struct rk_pdm_dev *pdm = to_info(cpu_dai);
324 unsigned int mask = 0, val = 0;
327 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
328 case SND_SOC_DAIFMT_NB_NF:
329 val = PDM_CKP_NORMAL;
331 case SND_SOC_DAIFMT_IB_NF:
332 val = PDM_CKP_INVERTED;
338 pm_runtime_get_sync(cpu_dai->dev);
339 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL, mask, val);
340 pm_runtime_put(cpu_dai->dev);
345 static int rockchip_pdm_trigger(struct snd_pcm_substream *substream, int cmd,
346 struct snd_soc_dai *dai)
348 struct rk_pdm_dev *pdm = to_info(dai);
352 case SNDRV_PCM_TRIGGER_START:
353 case SNDRV_PCM_TRIGGER_RESUME:
354 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
355 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
356 rockchip_pdm_rxctrl(pdm, 1);
358 case SNDRV_PCM_TRIGGER_SUSPEND:
359 case SNDRV_PCM_TRIGGER_STOP:
360 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
361 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
362 rockchip_pdm_rxctrl(pdm, 0);
372 static int rockchip_pdm_dai_probe(struct snd_soc_dai *dai)
374 struct rk_pdm_dev *pdm = to_info(dai);
376 dai->capture_dma_data = &pdm->capture_dma_data;
381 static const struct snd_soc_dai_ops rockchip_pdm_dai_ops = {
382 .set_fmt = rockchip_pdm_set_fmt,
383 .trigger = rockchip_pdm_trigger,
384 .hw_params = rockchip_pdm_hw_params,
387 #define ROCKCHIP_PDM_RATES SNDRV_PCM_RATE_8000_192000
388 #define ROCKCHIP_PDM_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | \
389 SNDRV_PCM_FMTBIT_S20_3LE | \
390 SNDRV_PCM_FMTBIT_S24_LE | \
391 SNDRV_PCM_FMTBIT_S32_LE)
393 static struct snd_soc_dai_driver rockchip_pdm_dai = {
394 .probe = rockchip_pdm_dai_probe,
396 .stream_name = "Capture",
399 .rates = ROCKCHIP_PDM_RATES,
400 .formats = ROCKCHIP_PDM_FORMATS,
402 .ops = &rockchip_pdm_dai_ops,
406 static const struct snd_soc_component_driver rockchip_pdm_component = {
407 .name = "rockchip-pdm",
410 static int rockchip_pdm_runtime_suspend(struct device *dev)
412 struct rk_pdm_dev *pdm = dev_get_drvdata(dev);
414 clk_disable_unprepare(pdm->clk);
415 clk_disable_unprepare(pdm->hclk);
420 static int rockchip_pdm_runtime_resume(struct device *dev)
422 struct rk_pdm_dev *pdm = dev_get_drvdata(dev);
425 ret = clk_prepare_enable(pdm->clk);
427 dev_err(pdm->dev, "clock enable failed %d\n", ret);
431 ret = clk_prepare_enable(pdm->hclk);
433 dev_err(pdm->dev, "hclock enable failed %d\n", ret);
440 static bool rockchip_pdm_wr_reg(struct device *dev, unsigned int reg)
459 static bool rockchip_pdm_rd_reg(struct device *dev, unsigned int reg)
473 case PDM_RXFIFO_DATA:
481 static bool rockchip_pdm_volatile_reg(struct device *dev, unsigned int reg)
488 case PDM_RXFIFO_DATA:
495 static bool rockchip_pdm_precious_reg(struct device *dev, unsigned int reg)
498 case PDM_RXFIFO_DATA:
505 static const struct reg_default rockchip_pdm_reg_defaults[] = {
506 { PDM_CTRL0, 0x78000017 },
507 { PDM_CTRL1, 0x0bb8ea60 },
508 { PDM_CLK_CTRL, 0x0000e401 },
509 { PDM_DMA_CTRL, 0x0000001f },
512 static const struct regmap_config rockchip_pdm_regmap_config = {
516 .max_register = PDM_VERSION,
517 .reg_defaults = rockchip_pdm_reg_defaults,
518 .num_reg_defaults = ARRAY_SIZE(rockchip_pdm_reg_defaults),
519 .writeable_reg = rockchip_pdm_wr_reg,
520 .readable_reg = rockchip_pdm_rd_reg,
521 .volatile_reg = rockchip_pdm_volatile_reg,
522 .precious_reg = rockchip_pdm_precious_reg,
523 .cache_type = REGCACHE_FLAT,
526 static const struct of_device_id rockchip_pdm_match[] __maybe_unused = {
527 { .compatible = "rockchip,pdm",
528 .data = (void *)RK_PDM_RK3229 },
529 { .compatible = "rockchip,px30-pdm",
530 .data = (void *)RK_PDM_RK3308 },
531 { .compatible = "rockchip,rk1808-pdm",
532 .data = (void *)RK_PDM_RK3308 },
533 { .compatible = "rockchip,rk3308-pdm",
534 .data = (void *)RK_PDM_RK3308 },
535 { .compatible = "rockchip,rk3568-pdm",
536 .data = (void *)RK_PDM_RV1126 },
537 { .compatible = "rockchip,rv1126-pdm",
538 .data = (void *)RK_PDM_RV1126 },
541 MODULE_DEVICE_TABLE(of, rockchip_pdm_match);
543 static int rockchip_pdm_path_parse(struct rk_pdm_dev *pdm, struct device_node *node)
545 unsigned int path[PDM_PATH_MAX];
546 int cnt = 0, ret = 0, i = 0, val = 0, msk = 0;
548 cnt = of_count_phandle_with_args(node, "rockchip,path-map",
550 if (cnt != PDM_PATH_MAX)
553 ret = of_property_read_u32_array(node, "rockchip,path-map",
558 for (i = 0; i < cnt; i++) {
559 if (path[i] >= PDM_PATH_MAX)
561 msk |= PDM_PATH_MASK(i);
562 val |= PDM_PATH(i, path[i]);
565 regmap_update_bits(pdm->regmap, PDM_CLK_CTRL, msk, val);
570 static int rockchip_pdm_probe(struct platform_device *pdev)
572 struct device_node *node = pdev->dev.of_node;
573 const struct of_device_id *match;
574 struct rk_pdm_dev *pdm;
575 struct resource *res;
579 pdm = devm_kzalloc(&pdev->dev, sizeof(*pdm), GFP_KERNEL);
583 match = of_match_device(rockchip_pdm_match, &pdev->dev);
585 pdm->version = (enum rk_pdm_version)match->data;
587 if (pdm->version == RK_PDM_RK3308) {
588 pdm->reset = devm_reset_control_get(&pdev->dev, "pdm-m");
589 if (IS_ERR(pdm->reset))
590 return PTR_ERR(pdm->reset);
593 regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
595 return PTR_ERR(regs);
597 pdm->regmap = devm_regmap_init_mmio(&pdev->dev, regs,
598 &rockchip_pdm_regmap_config);
599 if (IS_ERR(pdm->regmap))
600 return PTR_ERR(pdm->regmap);
602 pdm->capture_dma_data.addr = res->start + PDM_RXFIFO_DATA;
603 pdm->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
604 pdm->capture_dma_data.maxburst = PDM_DMA_BURST_SIZE;
606 pdm->dev = &pdev->dev;
607 dev_set_drvdata(&pdev->dev, pdm);
609 pdm->clk = devm_clk_get(&pdev->dev, "pdm_clk");
610 if (IS_ERR(pdm->clk))
611 return PTR_ERR(pdm->clk);
613 pdm->hclk = devm_clk_get(&pdev->dev, "pdm_hclk");
614 if (IS_ERR(pdm->hclk))
615 return PTR_ERR(pdm->hclk);
617 ret = clk_prepare_enable(pdm->hclk);
621 pm_runtime_enable(&pdev->dev);
622 if (!pm_runtime_enabled(&pdev->dev)) {
623 ret = rockchip_pdm_runtime_resume(&pdev->dev);
628 ret = devm_snd_soc_register_component(&pdev->dev,
629 &rockchip_pdm_component,
630 &rockchip_pdm_dai, 1);
633 dev_err(&pdev->dev, "could not register dai: %d\n", ret);
637 rockchip_pdm_rxctrl(pdm, 0);
639 ret = rockchip_pdm_path_parse(pdm, node);
640 if (ret != 0 && ret != -ENOENT)
643 ret = devm_snd_dmaengine_pcm_register(&pdev->dev, NULL, 0);
645 dev_err(&pdev->dev, "could not register pcm: %d\n", ret);
652 if (!pm_runtime_status_suspended(&pdev->dev))
653 rockchip_pdm_runtime_suspend(&pdev->dev);
655 pm_runtime_disable(&pdev->dev);
657 clk_disable_unprepare(pdm->hclk);
662 static int rockchip_pdm_remove(struct platform_device *pdev)
664 struct rk_pdm_dev *pdm = dev_get_drvdata(&pdev->dev);
666 pm_runtime_disable(&pdev->dev);
667 if (!pm_runtime_status_suspended(&pdev->dev))
668 rockchip_pdm_runtime_suspend(&pdev->dev);
670 clk_disable_unprepare(pdm->clk);
671 clk_disable_unprepare(pdm->hclk);
676 #ifdef CONFIG_PM_SLEEP
677 static int rockchip_pdm_suspend(struct device *dev)
679 struct rk_pdm_dev *pdm = dev_get_drvdata(dev);
681 regcache_mark_dirty(pdm->regmap);
686 static int rockchip_pdm_resume(struct device *dev)
688 struct rk_pdm_dev *pdm = dev_get_drvdata(dev);
691 ret = pm_runtime_resume_and_get(dev);
695 ret = regcache_sync(pdm->regmap);
703 static const struct dev_pm_ops rockchip_pdm_pm_ops = {
704 SET_RUNTIME_PM_OPS(rockchip_pdm_runtime_suspend,
705 rockchip_pdm_runtime_resume, NULL)
706 SET_SYSTEM_SLEEP_PM_OPS(rockchip_pdm_suspend, rockchip_pdm_resume)
709 static struct platform_driver rockchip_pdm_driver = {
710 .probe = rockchip_pdm_probe,
711 .remove = rockchip_pdm_remove,
713 .name = "rockchip-pdm",
714 .of_match_table = of_match_ptr(rockchip_pdm_match),
715 .pm = &rockchip_pdm_pm_ops,
719 module_platform_driver(rockchip_pdm_driver);
721 MODULE_AUTHOR("Sugar <sugar.zhang@rock-chips.com>");
722 MODULE_DESCRIPTION("Rockchip PDM Controller Driver");
723 MODULE_LICENSE("GPL v2");