1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
6 #include <linux/init.h>
9 #include <linux/of_device.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/slab.h>
15 #include <linux/clk.h>
16 #include <linux/delay.h>
18 #include <linux/dma-mapping.h>
20 #include <sound/core.h>
21 #include <sound/pcm.h>
22 #include <sound/pcm_params.h>
23 #include <sound/soc.h>
24 #include <sound/initval.h>
25 #include <sound/dmaengine_pcm.h>
27 #include "jz4740-i2s.h"
29 #define JZ4740_DMA_TYPE_AIC_TRANSMIT 24
30 #define JZ4740_DMA_TYPE_AIC_RECEIVE 25
32 #define JZ_REG_AIC_CONF 0x00
33 #define JZ_REG_AIC_CTRL 0x04
34 #define JZ_REG_AIC_I2S_FMT 0x10
35 #define JZ_REG_AIC_FIFO_STATUS 0x14
36 #define JZ_REG_AIC_I2S_STATUS 0x1c
37 #define JZ_REG_AIC_CLK_DIV 0x30
38 #define JZ_REG_AIC_FIFO 0x34
40 #define JZ_AIC_CONF_FIFO_RX_THRESHOLD_MASK (0xf << 12)
41 #define JZ_AIC_CONF_FIFO_TX_THRESHOLD_MASK (0xf << 8)
42 #define JZ_AIC_CONF_OVERFLOW_PLAY_LAST BIT(6)
43 #define JZ_AIC_CONF_INTERNAL_CODEC BIT(5)
44 #define JZ_AIC_CONF_I2S BIT(4)
45 #define JZ_AIC_CONF_RESET BIT(3)
46 #define JZ_AIC_CONF_BIT_CLK_MASTER BIT(2)
47 #define JZ_AIC_CONF_SYNC_CLK_MASTER BIT(1)
48 #define JZ_AIC_CONF_ENABLE BIT(0)
50 #define JZ_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET 12
51 #define JZ_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET 8
52 #define JZ4760_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET 24
53 #define JZ4760_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET 16
55 #define JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_MASK (0x7 << 19)
56 #define JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_MASK (0x7 << 16)
57 #define JZ_AIC_CTRL_ENABLE_RX_DMA BIT(15)
58 #define JZ_AIC_CTRL_ENABLE_TX_DMA BIT(14)
59 #define JZ_AIC_CTRL_MONO_TO_STEREO BIT(11)
60 #define JZ_AIC_CTRL_SWITCH_ENDIANNESS BIT(10)
61 #define JZ_AIC_CTRL_SIGNED_TO_UNSIGNED BIT(9)
62 #define JZ_AIC_CTRL_TFLUSH BIT(8)
63 #define JZ_AIC_CTRL_RFLUSH BIT(7)
64 #define JZ_AIC_CTRL_ENABLE_ROR_INT BIT(6)
65 #define JZ_AIC_CTRL_ENABLE_TUR_INT BIT(5)
66 #define JZ_AIC_CTRL_ENABLE_RFS_INT BIT(4)
67 #define JZ_AIC_CTRL_ENABLE_TFS_INT BIT(3)
68 #define JZ_AIC_CTRL_ENABLE_LOOPBACK BIT(2)
69 #define JZ_AIC_CTRL_ENABLE_PLAYBACK BIT(1)
70 #define JZ_AIC_CTRL_ENABLE_CAPTURE BIT(0)
72 #define JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_OFFSET 19
73 #define JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_OFFSET 16
75 #define JZ_AIC_I2S_FMT_DISABLE_BIT_CLK BIT(12)
76 #define JZ_AIC_I2S_FMT_DISABLE_BIT_ICLK BIT(13)
77 #define JZ_AIC_I2S_FMT_ENABLE_SYS_CLK BIT(4)
78 #define JZ_AIC_I2S_FMT_MSB BIT(0)
80 #define JZ_AIC_I2S_STATUS_BUSY BIT(2)
82 #define JZ_AIC_CLK_DIV_MASK 0xf
83 #define I2SDIV_DV_SHIFT 0
84 #define I2SDIV_DV_MASK (0xf << I2SDIV_DV_SHIFT)
85 #define I2SDIV_IDV_SHIFT 8
86 #define I2SDIV_IDV_MASK (0xf << I2SDIV_IDV_SHIFT)
88 enum jz47xx_i2s_version {
96 enum jz47xx_i2s_version version;
97 struct snd_soc_dai_driver *dai;
99 bool shared_fifo_flush;
103 struct resource *mem;
105 dma_addr_t phys_base;
110 struct snd_dmaengine_dai_dma_data playback_dma_data;
111 struct snd_dmaengine_dai_dma_data capture_dma_data;
113 const struct i2s_soc_info *soc_info;
116 static inline uint32_t jz4740_i2s_read(const struct jz4740_i2s *i2s,
119 return readl(i2s->base + reg);
122 static inline void jz4740_i2s_write(const struct jz4740_i2s *i2s,
123 unsigned int reg, uint32_t value)
125 writel(value, i2s->base + reg);
128 static inline void jz4740_i2s_set_bits(const struct jz4740_i2s *i2s,
129 unsigned int reg, uint32_t bits)
131 uint32_t value = jz4740_i2s_read(i2s, reg);
133 jz4740_i2s_write(i2s, reg, value);
136 static int jz4740_i2s_startup(struct snd_pcm_substream *substream,
137 struct snd_soc_dai *dai)
139 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
144 * When we can flush FIFOs independently, only flush the FIFO
145 * that is starting up. We can do this when the DAI is active
146 * because it does not disturb other active substreams.
148 if (!i2s->soc_info->shared_fifo_flush) {
149 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
150 jz4740_i2s_set_bits(i2s, JZ_REG_AIC_CTRL, JZ_AIC_CTRL_TFLUSH);
152 jz4740_i2s_set_bits(i2s, JZ_REG_AIC_CTRL, JZ_AIC_CTRL_RFLUSH);
155 if (snd_soc_dai_active(dai))
159 * When there is a shared flush bit for both FIFOs, the TFLUSH
160 * bit flushes both FIFOs. Flushing while the DAI is active would
161 * cause FIFO underruns in other active substreams so we have to
162 * guard this behind the snd_soc_dai_active() check.
164 if (i2s->soc_info->shared_fifo_flush)
165 jz4740_i2s_set_bits(i2s, JZ_REG_AIC_CTRL, JZ_AIC_CTRL_TFLUSH);
167 ret = clk_prepare_enable(i2s->clk_i2s);
171 conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
172 conf |= JZ_AIC_CONF_ENABLE;
173 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
178 static void jz4740_i2s_shutdown(struct snd_pcm_substream *substream,
179 struct snd_soc_dai *dai)
181 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
184 if (snd_soc_dai_active(dai))
187 conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
188 conf &= ~JZ_AIC_CONF_ENABLE;
189 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
191 clk_disable_unprepare(i2s->clk_i2s);
194 static int jz4740_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
195 struct snd_soc_dai *dai)
197 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
202 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
203 mask = JZ_AIC_CTRL_ENABLE_PLAYBACK | JZ_AIC_CTRL_ENABLE_TX_DMA;
205 mask = JZ_AIC_CTRL_ENABLE_CAPTURE | JZ_AIC_CTRL_ENABLE_RX_DMA;
207 ctrl = jz4740_i2s_read(i2s, JZ_REG_AIC_CTRL);
210 case SNDRV_PCM_TRIGGER_START:
211 case SNDRV_PCM_TRIGGER_RESUME:
212 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
215 case SNDRV_PCM_TRIGGER_STOP:
216 case SNDRV_PCM_TRIGGER_SUSPEND:
217 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
224 jz4740_i2s_write(i2s, JZ_REG_AIC_CTRL, ctrl);
229 static int jz4740_i2s_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
231 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
236 conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
238 conf &= ~(JZ_AIC_CONF_BIT_CLK_MASTER | JZ_AIC_CONF_SYNC_CLK_MASTER);
240 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
241 case SND_SOC_DAIFMT_CBS_CFS:
242 conf |= JZ_AIC_CONF_BIT_CLK_MASTER | JZ_AIC_CONF_SYNC_CLK_MASTER;
243 format |= JZ_AIC_I2S_FMT_ENABLE_SYS_CLK;
245 case SND_SOC_DAIFMT_CBM_CFS:
246 conf |= JZ_AIC_CONF_SYNC_CLK_MASTER;
248 case SND_SOC_DAIFMT_CBS_CFM:
249 conf |= JZ_AIC_CONF_BIT_CLK_MASTER;
251 case SND_SOC_DAIFMT_CBM_CFM:
257 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
258 case SND_SOC_DAIFMT_MSB:
259 format |= JZ_AIC_I2S_FMT_MSB;
261 case SND_SOC_DAIFMT_I2S:
267 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
268 case SND_SOC_DAIFMT_NB_NF:
274 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
275 jz4740_i2s_write(i2s, JZ_REG_AIC_I2S_FMT, format);
280 static int jz4740_i2s_hw_params(struct snd_pcm_substream *substream,
281 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
283 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
284 unsigned int sample_size;
285 uint32_t ctrl, div_reg;
288 ctrl = jz4740_i2s_read(i2s, JZ_REG_AIC_CTRL);
290 div_reg = jz4740_i2s_read(i2s, JZ_REG_AIC_CLK_DIV);
291 div = clk_get_rate(i2s->clk_i2s) / (64 * params_rate(params));
293 switch (params_format(params)) {
294 case SNDRV_PCM_FORMAT_S8:
297 case SNDRV_PCM_FORMAT_S16:
304 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
305 ctrl &= ~JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_MASK;
306 ctrl |= sample_size << JZ_AIC_CTRL_OUTPUT_SAMPLE_SIZE_OFFSET;
307 if (params_channels(params) == 1)
308 ctrl |= JZ_AIC_CTRL_MONO_TO_STEREO;
310 ctrl &= ~JZ_AIC_CTRL_MONO_TO_STEREO;
312 div_reg &= ~I2SDIV_DV_MASK;
313 div_reg |= (div - 1) << I2SDIV_DV_SHIFT;
315 ctrl &= ~JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_MASK;
316 ctrl |= sample_size << JZ_AIC_CTRL_INPUT_SAMPLE_SIZE_OFFSET;
318 if (i2s->soc_info->version >= JZ_I2S_JZ4770) {
319 div_reg &= ~I2SDIV_IDV_MASK;
320 div_reg |= (div - 1) << I2SDIV_IDV_SHIFT;
322 div_reg &= ~I2SDIV_DV_MASK;
323 div_reg |= (div - 1) << I2SDIV_DV_SHIFT;
327 jz4740_i2s_write(i2s, JZ_REG_AIC_CTRL, ctrl);
328 jz4740_i2s_write(i2s, JZ_REG_AIC_CLK_DIV, div_reg);
333 static int jz4740_i2s_set_sysclk(struct snd_soc_dai *dai, int clk_id,
334 unsigned int freq, int dir)
336 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
341 case JZ4740_I2S_CLKSRC_EXT:
342 parent = clk_get(NULL, "ext");
344 return PTR_ERR(parent);
345 clk_set_parent(i2s->clk_i2s, parent);
347 case JZ4740_I2S_CLKSRC_PLL:
348 parent = clk_get(NULL, "pll half");
350 return PTR_ERR(parent);
351 clk_set_parent(i2s->clk_i2s, parent);
352 ret = clk_set_rate(i2s->clk_i2s, freq);
362 static int jz4740_i2s_suspend(struct snd_soc_component *component)
364 struct jz4740_i2s *i2s = snd_soc_component_get_drvdata(component);
367 if (snd_soc_component_active(component)) {
368 conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
369 conf &= ~JZ_AIC_CONF_ENABLE;
370 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
372 clk_disable_unprepare(i2s->clk_i2s);
375 clk_disable_unprepare(i2s->clk_aic);
380 static int jz4740_i2s_resume(struct snd_soc_component *component)
382 struct jz4740_i2s *i2s = snd_soc_component_get_drvdata(component);
386 ret = clk_prepare_enable(i2s->clk_aic);
390 if (snd_soc_component_active(component)) {
391 ret = clk_prepare_enable(i2s->clk_i2s);
393 clk_disable_unprepare(i2s->clk_aic);
397 conf = jz4740_i2s_read(i2s, JZ_REG_AIC_CONF);
398 conf |= JZ_AIC_CONF_ENABLE;
399 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
405 static void jz4740_i2c_init_pcm_config(struct jz4740_i2s *i2s)
407 struct snd_dmaengine_dai_dma_data *dma_data;
410 dma_data = &i2s->playback_dma_data;
411 dma_data->maxburst = 16;
412 dma_data->slave_id = JZ4740_DMA_TYPE_AIC_TRANSMIT;
413 dma_data->addr = i2s->phys_base + JZ_REG_AIC_FIFO;
416 dma_data = &i2s->capture_dma_data;
417 dma_data->maxburst = 16;
418 dma_data->slave_id = JZ4740_DMA_TYPE_AIC_RECEIVE;
419 dma_data->addr = i2s->phys_base + JZ_REG_AIC_FIFO;
422 static int jz4740_i2s_dai_probe(struct snd_soc_dai *dai)
424 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
428 ret = clk_prepare_enable(i2s->clk_aic);
432 jz4740_i2c_init_pcm_config(i2s);
433 snd_soc_dai_init_dma_data(dai, &i2s->playback_dma_data,
434 &i2s->capture_dma_data);
436 if (i2s->soc_info->version >= JZ_I2S_JZ4760) {
437 conf = (7 << JZ4760_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET) |
438 (8 << JZ4760_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET) |
439 JZ_AIC_CONF_OVERFLOW_PLAY_LAST |
441 JZ_AIC_CONF_INTERNAL_CODEC;
443 conf = (7 << JZ_AIC_CONF_FIFO_RX_THRESHOLD_OFFSET) |
444 (8 << JZ_AIC_CONF_FIFO_TX_THRESHOLD_OFFSET) |
445 JZ_AIC_CONF_OVERFLOW_PLAY_LAST |
447 JZ_AIC_CONF_INTERNAL_CODEC;
450 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, JZ_AIC_CONF_RESET);
451 jz4740_i2s_write(i2s, JZ_REG_AIC_CONF, conf);
456 static int jz4740_i2s_dai_remove(struct snd_soc_dai *dai)
458 struct jz4740_i2s *i2s = snd_soc_dai_get_drvdata(dai);
460 clk_disable_unprepare(i2s->clk_aic);
464 static const struct snd_soc_dai_ops jz4740_i2s_dai_ops = {
465 .startup = jz4740_i2s_startup,
466 .shutdown = jz4740_i2s_shutdown,
467 .trigger = jz4740_i2s_trigger,
468 .hw_params = jz4740_i2s_hw_params,
469 .set_fmt = jz4740_i2s_set_fmt,
470 .set_sysclk = jz4740_i2s_set_sysclk,
473 #define JZ4740_I2S_FMTS (SNDRV_PCM_FMTBIT_S8 | \
474 SNDRV_PCM_FMTBIT_S16_LE)
476 static struct snd_soc_dai_driver jz4740_i2s_dai = {
477 .probe = jz4740_i2s_dai_probe,
478 .remove = jz4740_i2s_dai_remove,
482 .rates = SNDRV_PCM_RATE_8000_48000,
483 .formats = JZ4740_I2S_FMTS,
488 .rates = SNDRV_PCM_RATE_8000_48000,
489 .formats = JZ4740_I2S_FMTS,
491 .symmetric_rates = 1,
492 .ops = &jz4740_i2s_dai_ops,
495 static const struct i2s_soc_info jz4740_i2s_soc_info = {
496 .version = JZ_I2S_JZ4740,
497 .dai = &jz4740_i2s_dai,
498 .shared_fifo_flush = true,
501 static const struct i2s_soc_info jz4760_i2s_soc_info = {
502 .version = JZ_I2S_JZ4760,
503 .dai = &jz4740_i2s_dai,
506 static struct snd_soc_dai_driver jz4770_i2s_dai = {
507 .probe = jz4740_i2s_dai_probe,
508 .remove = jz4740_i2s_dai_remove,
512 .rates = SNDRV_PCM_RATE_8000_48000,
513 .formats = JZ4740_I2S_FMTS,
518 .rates = SNDRV_PCM_RATE_8000_48000,
519 .formats = JZ4740_I2S_FMTS,
521 .ops = &jz4740_i2s_dai_ops,
524 static const struct i2s_soc_info jz4770_i2s_soc_info = {
525 .version = JZ_I2S_JZ4770,
526 .dai = &jz4770_i2s_dai,
529 static const struct i2s_soc_info jz4780_i2s_soc_info = {
530 .version = JZ_I2S_JZ4780,
531 .dai = &jz4770_i2s_dai,
534 static const struct snd_soc_component_driver jz4740_i2s_component = {
535 .name = "jz4740-i2s",
536 .suspend = jz4740_i2s_suspend,
537 .resume = jz4740_i2s_resume,
540 static const struct of_device_id jz4740_of_matches[] = {
541 { .compatible = "ingenic,jz4740-i2s", .data = &jz4740_i2s_soc_info },
542 { .compatible = "ingenic,jz4760-i2s", .data = &jz4760_i2s_soc_info },
543 { .compatible = "ingenic,jz4770-i2s", .data = &jz4770_i2s_soc_info },
544 { .compatible = "ingenic,jz4780-i2s", .data = &jz4780_i2s_soc_info },
547 MODULE_DEVICE_TABLE(of, jz4740_of_matches);
549 static int jz4740_i2s_dev_probe(struct platform_device *pdev)
551 struct device *dev = &pdev->dev;
552 struct jz4740_i2s *i2s;
553 struct resource *mem;
556 i2s = devm_kzalloc(dev, sizeof(*i2s), GFP_KERNEL);
560 i2s->soc_info = device_get_match_data(dev);
562 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
563 i2s->base = devm_ioremap_resource(dev, mem);
564 if (IS_ERR(i2s->base))
565 return PTR_ERR(i2s->base);
567 i2s->phys_base = mem->start;
569 i2s->clk_aic = devm_clk_get(dev, "aic");
570 if (IS_ERR(i2s->clk_aic))
571 return PTR_ERR(i2s->clk_aic);
573 i2s->clk_i2s = devm_clk_get(dev, "i2s");
574 if (IS_ERR(i2s->clk_i2s))
575 return PTR_ERR(i2s->clk_i2s);
577 platform_set_drvdata(pdev, i2s);
579 ret = devm_snd_soc_register_component(dev, &jz4740_i2s_component,
580 i2s->soc_info->dai, 1);
584 return devm_snd_dmaengine_pcm_register(dev, NULL,
585 SND_DMAENGINE_PCM_FLAG_COMPAT);
588 static struct platform_driver jz4740_i2s_driver = {
589 .probe = jz4740_i2s_dev_probe,
591 .name = "jz4740-i2s",
592 .of_match_table = jz4740_of_matches,
596 module_platform_driver(jz4740_i2s_driver);
598 MODULE_AUTHOR("Lars-Peter Clausen, <lars@metafoo.de>");
599 MODULE_DESCRIPTION("Ingenic JZ4740 SoC I2S driver");
600 MODULE_LICENSE("GPL");
601 MODULE_ALIAS("platform:jz4740-i2s");