1 // SPDX-License-Identifier: GPL-2.0-only
3 * STM32 ALSA SoC Digital Audio Interface (I2S) driver.
5 * Copyright (C) 2017, STMicroelectronics - All Rights Reserved
6 * Author(s): Olivier Moysan <olivier.moysan@st.com> for STMicroelectronics.
9 #include <linux/bitfield.h>
10 #include <linux/clk.h>
11 #include <linux/clk-provider.h>
12 #include <linux/delay.h>
13 #include <linux/module.h>
14 #include <linux/of_irq.h>
15 #include <linux/of_platform.h>
16 #include <linux/regmap.h>
17 #include <linux/reset.h>
18 #include <linux/spinlock.h>
20 #include <sound/dmaengine_pcm.h>
21 #include <sound/pcm_params.h>
23 #define STM32_I2S_CR1_REG 0x0
24 #define STM32_I2S_CFG1_REG 0x08
25 #define STM32_I2S_CFG2_REG 0x0C
26 #define STM32_I2S_IER_REG 0x10
27 #define STM32_I2S_SR_REG 0x14
28 #define STM32_I2S_IFCR_REG 0x18
29 #define STM32_I2S_TXDR_REG 0X20
30 #define STM32_I2S_RXDR_REG 0x30
31 #define STM32_I2S_CGFR_REG 0X50
32 #define STM32_I2S_HWCFGR_REG 0x3F0
33 #define STM32_I2S_VERR_REG 0x3F4
34 #define STM32_I2S_IPIDR_REG 0x3F8
35 #define STM32_I2S_SIDR_REG 0x3FC
37 /* Bit definition for SPI2S_CR1 register */
38 #define I2S_CR1_SPE BIT(0)
39 #define I2S_CR1_CSTART BIT(9)
40 #define I2S_CR1_CSUSP BIT(10)
41 #define I2S_CR1_HDDIR BIT(11)
42 #define I2S_CR1_SSI BIT(12)
43 #define I2S_CR1_CRC33_17 BIT(13)
44 #define I2S_CR1_RCRCI BIT(14)
45 #define I2S_CR1_TCRCI BIT(15)
47 /* Bit definition for SPI_CFG2 register */
48 #define I2S_CFG2_IOSWP_SHIFT 15
49 #define I2S_CFG2_IOSWP BIT(I2S_CFG2_IOSWP_SHIFT)
50 #define I2S_CFG2_LSBFRST BIT(23)
51 #define I2S_CFG2_AFCNTR BIT(31)
53 /* Bit definition for SPI_CFG1 register */
54 #define I2S_CFG1_FTHVL_SHIFT 5
55 #define I2S_CFG1_FTHVL_MASK GENMASK(8, I2S_CFG1_FTHVL_SHIFT)
56 #define I2S_CFG1_FTHVL_SET(x) ((x) << I2S_CFG1_FTHVL_SHIFT)
58 #define I2S_CFG1_TXDMAEN BIT(15)
59 #define I2S_CFG1_RXDMAEN BIT(14)
61 /* Bit definition for SPI2S_IER register */
62 #define I2S_IER_RXPIE BIT(0)
63 #define I2S_IER_TXPIE BIT(1)
64 #define I2S_IER_DPXPIE BIT(2)
65 #define I2S_IER_EOTIE BIT(3)
66 #define I2S_IER_TXTFIE BIT(4)
67 #define I2S_IER_UDRIE BIT(5)
68 #define I2S_IER_OVRIE BIT(6)
69 #define I2S_IER_CRCEIE BIT(7)
70 #define I2S_IER_TIFREIE BIT(8)
71 #define I2S_IER_MODFIE BIT(9)
72 #define I2S_IER_TSERFIE BIT(10)
74 /* Bit definition for SPI2S_SR register */
75 #define I2S_SR_RXP BIT(0)
76 #define I2S_SR_TXP BIT(1)
77 #define I2S_SR_DPXP BIT(2)
78 #define I2S_SR_EOT BIT(3)
79 #define I2S_SR_TXTF BIT(4)
80 #define I2S_SR_UDR BIT(5)
81 #define I2S_SR_OVR BIT(6)
82 #define I2S_SR_CRCERR BIT(7)
83 #define I2S_SR_TIFRE BIT(8)
84 #define I2S_SR_MODF BIT(9)
85 #define I2S_SR_TSERF BIT(10)
86 #define I2S_SR_SUSP BIT(11)
87 #define I2S_SR_TXC BIT(12)
88 #define I2S_SR_RXPLVL GENMASK(14, 13)
89 #define I2S_SR_RXWNE BIT(15)
91 #define I2S_SR_MASK GENMASK(15, 0)
93 /* Bit definition for SPI_IFCR register */
94 #define I2S_IFCR_EOTC BIT(3)
95 #define I2S_IFCR_TXTFC BIT(4)
96 #define I2S_IFCR_UDRC BIT(5)
97 #define I2S_IFCR_OVRC BIT(6)
98 #define I2S_IFCR_CRCEC BIT(7)
99 #define I2S_IFCR_TIFREC BIT(8)
100 #define I2S_IFCR_MODFC BIT(9)
101 #define I2S_IFCR_TSERFC BIT(10)
102 #define I2S_IFCR_SUSPC BIT(11)
104 #define I2S_IFCR_MASK GENMASK(11, 3)
106 /* Bit definition for SPI_I2SCGFR register */
107 #define I2S_CGFR_I2SMOD BIT(0)
109 #define I2S_CGFR_I2SCFG_SHIFT 1
110 #define I2S_CGFR_I2SCFG_MASK GENMASK(3, I2S_CGFR_I2SCFG_SHIFT)
111 #define I2S_CGFR_I2SCFG_SET(x) ((x) << I2S_CGFR_I2SCFG_SHIFT)
113 #define I2S_CGFR_I2SSTD_SHIFT 4
114 #define I2S_CGFR_I2SSTD_MASK GENMASK(5, I2S_CGFR_I2SSTD_SHIFT)
115 #define I2S_CGFR_I2SSTD_SET(x) ((x) << I2S_CGFR_I2SSTD_SHIFT)
117 #define I2S_CGFR_PCMSYNC BIT(7)
119 #define I2S_CGFR_DATLEN_SHIFT 8
120 #define I2S_CGFR_DATLEN_MASK GENMASK(9, I2S_CGFR_DATLEN_SHIFT)
121 #define I2S_CGFR_DATLEN_SET(x) ((x) << I2S_CGFR_DATLEN_SHIFT)
123 #define I2S_CGFR_CHLEN_SHIFT 10
124 #define I2S_CGFR_CHLEN BIT(I2S_CGFR_CHLEN_SHIFT)
125 #define I2S_CGFR_CKPOL BIT(11)
126 #define I2S_CGFR_FIXCH BIT(12)
127 #define I2S_CGFR_WSINV BIT(13)
128 #define I2S_CGFR_DATFMT BIT(14)
130 #define I2S_CGFR_I2SDIV_SHIFT 16
131 #define I2S_CGFR_I2SDIV_BIT_H 23
132 #define I2S_CGFR_I2SDIV_MASK GENMASK(I2S_CGFR_I2SDIV_BIT_H,\
133 I2S_CGFR_I2SDIV_SHIFT)
134 #define I2S_CGFR_I2SDIV_SET(x) ((x) << I2S_CGFR_I2SDIV_SHIFT)
135 #define I2S_CGFR_I2SDIV_MAX ((1 << (I2S_CGFR_I2SDIV_BIT_H -\
136 I2S_CGFR_I2SDIV_SHIFT)) - 1)
138 #define I2S_CGFR_ODD_SHIFT 24
139 #define I2S_CGFR_ODD BIT(I2S_CGFR_ODD_SHIFT)
140 #define I2S_CGFR_MCKOE BIT(25)
142 /* Registers below apply to I2S version 1.1 and more */
144 /* Bit definition for SPI_HWCFGR register */
145 #define I2S_HWCFGR_I2S_SUPPORT_MASK GENMASK(15, 12)
147 /* Bit definition for SPI_VERR register */
148 #define I2S_VERR_MIN_MASK GENMASK(3, 0)
149 #define I2S_VERR_MAJ_MASK GENMASK(7, 4)
151 /* Bit definition for SPI_IPIDR register */
152 #define I2S_IPIDR_ID_MASK GENMASK(31, 0)
154 /* Bit definition for SPI_SIDR register */
155 #define I2S_SIDR_ID_MASK GENMASK(31, 0)
157 #define I2S_IPIDR_NUMBER 0x00130022
159 enum i2s_master_mode {
168 I2S_I2SMOD_TX_MASTER,
169 I2S_I2SMOD_RX_MASTER,
171 I2S_I2SMOD_FD_MASTER,
176 I2S_FIFO_TH_ONE_QUARTER,
178 I2S_FIFO_TH_THREE_QUARTER,
190 I2S_I2SMOD_DATLEN_16,
191 I2S_I2SMOD_DATLEN_24,
192 I2S_I2SMOD_DATLEN_32,
195 #define STM32_I2S_FIFO_SIZE 16
197 #define STM32_I2S_IS_MASTER(x) ((x)->ms_flg == I2S_MS_MASTER)
198 #define STM32_I2S_IS_SLAVE(x) ((x)->ms_flg == I2S_MS_SLAVE)
200 #define STM32_I2S_NAME_LEN 32
201 #define STM32_I2S_RATE_11K 11025
204 * struct stm32_i2s_data - private data of I2S
205 * @regmap_conf: I2S register map configuration pointer
206 * @regmap: I2S register map pointer
207 * @pdev: device data pointer
208 * @dai_drv: DAI driver pointer
209 * @dma_data_tx: dma configuration data for tx channel
210 * @dma_data_rx: dma configuration data for tx channel
211 * @substream: PCM substream data pointer
212 * @i2sclk: kernel clock feeding the I2S clock generator
213 * @i2smclk: master clock from I2S mclk provider
214 * @pclk: peripheral clock driving bus interface
215 * @x8kclk: I2S parent clock for sampling frequencies multiple of 8kHz
216 * @x11kclk: I2S parent clock for sampling frequencies multiple of 11kHz
217 * @base: mmio register base virtual address
218 * @phys_addr: I2S registers physical base address
219 * @lock_fd: lock to manage race conditions in full duplex mode
220 * @irq_lock: prevent race condition with IRQ
221 * @mclk_rate: master clock frequency (Hz)
223 * @divider: prescaler division ratio
224 * @div: prescaler div field
225 * @odd: prescaler odd field
226 * @refcount: keep count of opened streams on I2S
227 * @ms_flg: master mode flag.
229 struct stm32_i2s_data {
230 const struct regmap_config *regmap_conf;
231 struct regmap *regmap;
232 struct platform_device *pdev;
233 struct snd_soc_dai_driver *dai_drv;
234 struct snd_dmaengine_dai_dma_data dma_data_tx;
235 struct snd_dmaengine_dai_dma_data dma_data_rx;
236 struct snd_pcm_substream *substream;
243 dma_addr_t phys_addr;
244 spinlock_t lock_fd; /* Manage race conditions for full duplex */
245 spinlock_t irq_lock; /* used to prevent race condition with IRQ */
246 unsigned int mclk_rate;
248 unsigned int divider;
255 struct stm32_i2smclk_data {
258 struct stm32_i2s_data *i2s_data;
261 #define to_mclk_data(_hw) container_of(_hw, struct stm32_i2smclk_data, hw)
263 static int stm32_i2s_calc_clk_div(struct stm32_i2s_data *i2s,
264 unsigned long input_rate,
265 unsigned long output_rate)
267 unsigned int ratio, div, divider = 1;
270 ratio = DIV_ROUND_CLOSEST(input_rate, output_rate);
272 /* Check the parity of the divider */
275 /* Compute the div prescaler */
278 /* If div is 0 actual divider is 1 */
280 divider = ((2 * div) + odd);
281 dev_dbg(&i2s->pdev->dev, "Divider: 2*%d(div)+%d(odd) = %d\n",
285 /* Division by three is not allowed by I2S prescaler */
286 if ((div == 1 && odd) || div > I2S_CGFR_I2SDIV_MAX) {
287 dev_err(&i2s->pdev->dev, "Wrong divider setting\n");
291 if (input_rate % divider)
292 dev_dbg(&i2s->pdev->dev,
293 "Rate not accurate. requested (%ld), actual (%ld)\n",
294 output_rate, input_rate / divider);
298 i2s->divider = divider;
303 static int stm32_i2s_set_clk_div(struct stm32_i2s_data *i2s)
307 cgfr = I2S_CGFR_I2SDIV_SET(i2s->div) | (i2s->odd << I2S_CGFR_ODD_SHIFT);
308 cgfr_mask = I2S_CGFR_I2SDIV_MASK | I2S_CGFR_ODD;
310 return regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
314 static int stm32_i2s_set_parent_clock(struct stm32_i2s_data *i2s,
317 struct platform_device *pdev = i2s->pdev;
318 struct clk *parent_clk;
321 if (!(rate % STM32_I2S_RATE_11K))
322 parent_clk = i2s->x11kclk;
324 parent_clk = i2s->x8kclk;
326 ret = clk_set_parent(i2s->i2sclk, parent_clk);
329 "Error %d setting i2sclk parent clock\n", ret);
334 static long stm32_i2smclk_round_rate(struct clk_hw *hw, unsigned long rate,
335 unsigned long *prate)
337 struct stm32_i2smclk_data *mclk = to_mclk_data(hw);
338 struct stm32_i2s_data *i2s = mclk->i2s_data;
341 ret = stm32_i2s_calc_clk_div(i2s, *prate, rate);
345 mclk->freq = *prate / i2s->divider;
350 static unsigned long stm32_i2smclk_recalc_rate(struct clk_hw *hw,
351 unsigned long parent_rate)
353 struct stm32_i2smclk_data *mclk = to_mclk_data(hw);
358 static int stm32_i2smclk_set_rate(struct clk_hw *hw, unsigned long rate,
359 unsigned long parent_rate)
361 struct stm32_i2smclk_data *mclk = to_mclk_data(hw);
362 struct stm32_i2s_data *i2s = mclk->i2s_data;
365 ret = stm32_i2s_calc_clk_div(i2s, parent_rate, rate);
369 ret = stm32_i2s_set_clk_div(i2s);
378 static int stm32_i2smclk_enable(struct clk_hw *hw)
380 struct stm32_i2smclk_data *mclk = to_mclk_data(hw);
381 struct stm32_i2s_data *i2s = mclk->i2s_data;
383 dev_dbg(&i2s->pdev->dev, "Enable master clock\n");
385 return regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
386 I2S_CGFR_MCKOE, I2S_CGFR_MCKOE);
389 static void stm32_i2smclk_disable(struct clk_hw *hw)
391 struct stm32_i2smclk_data *mclk = to_mclk_data(hw);
392 struct stm32_i2s_data *i2s = mclk->i2s_data;
394 dev_dbg(&i2s->pdev->dev, "Disable master clock\n");
396 regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG, I2S_CGFR_MCKOE, 0);
399 static const struct clk_ops mclk_ops = {
400 .enable = stm32_i2smclk_enable,
401 .disable = stm32_i2smclk_disable,
402 .recalc_rate = stm32_i2smclk_recalc_rate,
403 .round_rate = stm32_i2smclk_round_rate,
404 .set_rate = stm32_i2smclk_set_rate,
407 static int stm32_i2s_add_mclk_provider(struct stm32_i2s_data *i2s)
410 struct stm32_i2smclk_data *mclk;
411 struct device *dev = &i2s->pdev->dev;
412 const char *pname = __clk_get_name(i2s->i2sclk);
413 char *mclk_name, *p, *s = (char *)pname;
416 mclk = devm_kzalloc(dev, sizeof(*mclk), GFP_KERNEL);
420 mclk_name = devm_kcalloc(dev, sizeof(char),
421 STM32_I2S_NAME_LEN, GFP_KERNEL);
426 * Forge mclk clock name from parent clock name and suffix.
427 * String after "_" char is stripped in parent name.
430 while (*s && *s != '_' && (i < (STM32_I2S_NAME_LEN - 7))) {
436 mclk->hw.init = CLK_HW_INIT(mclk_name, pname, &mclk_ops, 0);
437 mclk->i2s_data = i2s;
440 dev_dbg(dev, "Register master clock %s\n", mclk_name);
441 ret = devm_clk_hw_register(&i2s->pdev->dev, hw);
443 dev_err(dev, "mclk register fails with error %d\n", ret);
446 i2s->i2smclk = hw->clk;
448 /* register mclk provider */
449 return devm_of_clk_add_hw_provider(dev, of_clk_hw_simple_get, hw);
452 static irqreturn_t stm32_i2s_isr(int irq, void *devid)
454 struct stm32_i2s_data *i2s = (struct stm32_i2s_data *)devid;
455 struct platform_device *pdev = i2s->pdev;
460 regmap_read(i2s->regmap, STM32_I2S_SR_REG, &sr);
461 regmap_read(i2s->regmap, STM32_I2S_IER_REG, &ier);
465 dev_dbg(&pdev->dev, "Spurious IRQ sr=0x%08x, ier=0x%08x\n",
470 regmap_write_bits(i2s->regmap, STM32_I2S_IFCR_REG,
471 I2S_IFCR_MASK, flags);
473 if (flags & I2S_SR_OVR) {
474 dev_dbg(&pdev->dev, "Overrun\n");
478 if (flags & I2S_SR_UDR) {
479 dev_dbg(&pdev->dev, "Underrun\n");
483 if (flags & I2S_SR_TIFRE)
484 dev_dbg(&pdev->dev, "Frame error\n");
486 spin_lock(&i2s->irq_lock);
487 if (err && i2s->substream)
488 snd_pcm_stop_xrun(i2s->substream);
489 spin_unlock(&i2s->irq_lock);
494 static bool stm32_i2s_readable_reg(struct device *dev, unsigned int reg)
497 case STM32_I2S_CR1_REG:
498 case STM32_I2S_CFG1_REG:
499 case STM32_I2S_CFG2_REG:
500 case STM32_I2S_IER_REG:
501 case STM32_I2S_SR_REG:
502 case STM32_I2S_RXDR_REG:
503 case STM32_I2S_CGFR_REG:
504 case STM32_I2S_HWCFGR_REG:
505 case STM32_I2S_VERR_REG:
506 case STM32_I2S_IPIDR_REG:
507 case STM32_I2S_SIDR_REG:
514 static bool stm32_i2s_volatile_reg(struct device *dev, unsigned int reg)
517 case STM32_I2S_SR_REG:
518 case STM32_I2S_RXDR_REG:
525 static bool stm32_i2s_writeable_reg(struct device *dev, unsigned int reg)
528 case STM32_I2S_CR1_REG:
529 case STM32_I2S_CFG1_REG:
530 case STM32_I2S_CFG2_REG:
531 case STM32_I2S_IER_REG:
532 case STM32_I2S_IFCR_REG:
533 case STM32_I2S_TXDR_REG:
534 case STM32_I2S_CGFR_REG:
541 static int stm32_i2s_set_dai_fmt(struct snd_soc_dai *cpu_dai, unsigned int fmt)
543 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
545 u32 cgfr_mask = I2S_CGFR_I2SSTD_MASK | I2S_CGFR_CKPOL |
546 I2S_CGFR_WSINV | I2S_CGFR_I2SCFG_MASK;
548 dev_dbg(cpu_dai->dev, "fmt %x\n", fmt);
551 * winv = 0 : default behavior (high/low) for all standards
552 * ckpol = 0 for all standards.
554 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
555 case SND_SOC_DAIFMT_I2S:
556 cgfr = I2S_CGFR_I2SSTD_SET(I2S_STD_I2S);
558 case SND_SOC_DAIFMT_MSB:
559 cgfr = I2S_CGFR_I2SSTD_SET(I2S_STD_LEFT_J);
561 case SND_SOC_DAIFMT_LSB:
562 cgfr = I2S_CGFR_I2SSTD_SET(I2S_STD_RIGHT_J);
564 case SND_SOC_DAIFMT_DSP_A:
565 cgfr = I2S_CGFR_I2SSTD_SET(I2S_STD_DSP);
567 /* DSP_B not mapped on I2S PCM long format. 1 bit offset does not fit */
569 dev_err(cpu_dai->dev, "Unsupported protocol %#x\n",
570 fmt & SND_SOC_DAIFMT_FORMAT_MASK);
574 /* DAI clock strobing */
575 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
576 case SND_SOC_DAIFMT_NB_NF:
578 case SND_SOC_DAIFMT_IB_NF:
579 cgfr |= I2S_CGFR_CKPOL;
581 case SND_SOC_DAIFMT_NB_IF:
582 cgfr |= I2S_CGFR_WSINV;
584 case SND_SOC_DAIFMT_IB_IF:
585 cgfr |= I2S_CGFR_CKPOL;
586 cgfr |= I2S_CGFR_WSINV;
589 dev_err(cpu_dai->dev, "Unsupported strobing %#x\n",
590 fmt & SND_SOC_DAIFMT_INV_MASK);
594 /* DAI clock master masks */
595 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
596 case SND_SOC_DAIFMT_CBM_CFM:
597 i2s->ms_flg = I2S_MS_SLAVE;
599 case SND_SOC_DAIFMT_CBS_CFS:
600 i2s->ms_flg = I2S_MS_MASTER;
603 dev_err(cpu_dai->dev, "Unsupported mode %#x\n",
604 fmt & SND_SOC_DAIFMT_MASTER_MASK);
609 return regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
613 static int stm32_i2s_set_sysclk(struct snd_soc_dai *cpu_dai,
614 int clk_id, unsigned int freq, int dir)
616 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
619 dev_dbg(cpu_dai->dev, "I2S MCLK frequency is %uHz. mode: %s, dir: %s\n",
620 freq, STM32_I2S_IS_MASTER(i2s) ? "master" : "slave",
621 dir ? "output" : "input");
623 /* MCLK generation is available only in master mode */
624 if (dir == SND_SOC_CLOCK_OUT && STM32_I2S_IS_MASTER(i2s)) {
626 dev_dbg(cpu_dai->dev, "No MCLK registered\n");
630 /* Assume shutdown if requested frequency is 0Hz */
632 /* Release mclk rate only if rate was actually set */
633 if (i2s->mclk_rate) {
634 clk_rate_exclusive_put(i2s->i2smclk);
637 return regmap_update_bits(i2s->regmap,
641 /* If master clock is used, set parent clock now */
642 ret = stm32_i2s_set_parent_clock(i2s, freq);
645 ret = clk_set_rate_exclusive(i2s->i2smclk, freq);
647 dev_err(cpu_dai->dev, "Could not set mclk rate\n");
650 ret = regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
651 I2S_CGFR_MCKOE, I2S_CGFR_MCKOE);
653 i2s->mclk_rate = freq;
659 static int stm32_i2s_configure_clock(struct snd_soc_dai *cpu_dai,
660 struct snd_pcm_hw_params *params)
662 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
663 unsigned long i2s_clock_rate;
664 unsigned int nb_bits, frame_len;
665 unsigned int rate = params_rate(params);
670 clk_set_parent(i2s->i2sclk, i2s->x11kclk);
672 clk_set_parent(i2s->i2sclk, i2s->x8kclk);
673 i2s_clock_rate = clk_get_rate(i2s->i2sclk);
676 * mckl = mclk_ratio x ws
677 * i2s mode : mclk_ratio = 256
678 * dsp mode : mclk_ratio = 128
681 * i2s mode : div = i2s_clk / (mclk_ratio * ws)
682 * dsp mode : div = i2s_clk / (mclk_ratio * ws)
684 * i2s mode : div = i2s_clk / (nb_bits x ws)
685 * dsp mode : div = i2s_clk / (nb_bits x ws)
687 if (i2s->mclk_rate) {
688 ret = stm32_i2s_calc_clk_div(i2s, i2s_clock_rate,
694 if ((i2s->fmt & SND_SOC_DAIFMT_FORMAT_MASK) ==
695 SND_SOC_DAIFMT_DSP_A)
698 /* master clock not enabled */
699 ret = regmap_read(i2s->regmap, STM32_I2S_CGFR_REG, &cgfr);
703 nb_bits = frame_len * ((cgfr & I2S_CGFR_CHLEN) + 1);
704 ret = stm32_i2s_calc_clk_div(i2s, i2s_clock_rate,
710 ret = stm32_i2s_set_clk_div(i2s);
714 /* Set bitclock and frameclock to their inactive state */
715 return regmap_update_bits(i2s->regmap, STM32_I2S_CFG2_REG,
716 I2S_CFG2_AFCNTR, I2S_CFG2_AFCNTR);
719 static int stm32_i2s_configure(struct snd_soc_dai *cpu_dai,
720 struct snd_pcm_hw_params *params,
721 struct snd_pcm_substream *substream)
723 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
724 int format = params_width(params);
725 u32 cfgr, cfgr_mask, cfg1;
731 cfgr = I2S_CGFR_DATLEN_SET(I2S_I2SMOD_DATLEN_16);
732 cfgr_mask = I2S_CGFR_DATLEN_MASK | I2S_CGFR_CHLEN;
735 cfgr = I2S_CGFR_DATLEN_SET(I2S_I2SMOD_DATLEN_32) |
737 cfgr_mask = I2S_CGFR_DATLEN_MASK | I2S_CGFR_CHLEN;
740 dev_err(cpu_dai->dev, "Unexpected format %d", format);
744 if (STM32_I2S_IS_SLAVE(i2s)) {
745 cfgr |= I2S_CGFR_I2SCFG_SET(I2S_I2SMOD_FD_SLAVE);
747 /* As data length is either 16 or 32 bits, fixch always set */
748 cfgr |= I2S_CGFR_FIXCH;
749 cfgr_mask |= I2S_CGFR_FIXCH;
751 cfgr |= I2S_CGFR_I2SCFG_SET(I2S_I2SMOD_FD_MASTER);
753 cfgr_mask |= I2S_CGFR_I2SCFG_MASK;
755 ret = regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
760 fthlv = STM32_I2S_FIFO_SIZE * I2S_FIFO_TH_ONE_QUARTER / 4;
761 cfg1 = I2S_CFG1_FTHVL_SET(fthlv - 1);
763 return regmap_update_bits(i2s->regmap, STM32_I2S_CFG1_REG,
764 I2S_CFG1_FTHVL_MASK, cfg1);
767 static int stm32_i2s_startup(struct snd_pcm_substream *substream,
768 struct snd_soc_dai *cpu_dai)
770 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
774 spin_lock_irqsave(&i2s->irq_lock, flags);
775 i2s->substream = substream;
776 spin_unlock_irqrestore(&i2s->irq_lock, flags);
778 if ((i2s->fmt & SND_SOC_DAIFMT_FORMAT_MASK) != SND_SOC_DAIFMT_DSP_A)
779 snd_pcm_hw_constraint_single(substream->runtime,
780 SNDRV_PCM_HW_PARAM_CHANNELS, 2);
782 ret = clk_prepare_enable(i2s->i2sclk);
784 dev_err(cpu_dai->dev, "Failed to enable clock: %d\n", ret);
788 return regmap_write_bits(i2s->regmap, STM32_I2S_IFCR_REG,
789 I2S_IFCR_MASK, I2S_IFCR_MASK);
792 static int stm32_i2s_hw_params(struct snd_pcm_substream *substream,
793 struct snd_pcm_hw_params *params,
794 struct snd_soc_dai *cpu_dai)
796 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
799 ret = stm32_i2s_configure(cpu_dai, params, substream);
801 dev_err(cpu_dai->dev, "Configuration returned error %d\n", ret);
805 if (STM32_I2S_IS_MASTER(i2s))
806 ret = stm32_i2s_configure_clock(cpu_dai, params);
811 static int stm32_i2s_trigger(struct snd_pcm_substream *substream, int cmd,
812 struct snd_soc_dai *cpu_dai)
814 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
815 bool playback_flg = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK);
820 case SNDRV_PCM_TRIGGER_START:
821 case SNDRV_PCM_TRIGGER_RESUME:
822 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
824 dev_dbg(cpu_dai->dev, "start I2S %s\n",
825 playback_flg ? "playback" : "capture");
827 cfg1_mask = I2S_CFG1_RXDMAEN | I2S_CFG1_TXDMAEN;
828 regmap_update_bits(i2s->regmap, STM32_I2S_CFG1_REG,
829 cfg1_mask, cfg1_mask);
831 ret = regmap_update_bits(i2s->regmap, STM32_I2S_CR1_REG,
832 I2S_CR1_SPE, I2S_CR1_SPE);
834 dev_err(cpu_dai->dev, "Error %d enabling I2S\n", ret);
838 ret = regmap_write_bits(i2s->regmap, STM32_I2S_CR1_REG,
839 I2S_CR1_CSTART, I2S_CR1_CSTART);
841 dev_err(cpu_dai->dev, "Error %d starting I2S\n", ret);
845 regmap_write_bits(i2s->regmap, STM32_I2S_IFCR_REG,
846 I2S_IFCR_MASK, I2S_IFCR_MASK);
848 spin_lock(&i2s->lock_fd);
855 if (STM32_I2S_IS_MASTER(i2s) && i2s->refcount == 1)
856 /* dummy write to gate bus clocks */
857 regmap_write(i2s->regmap,
858 STM32_I2S_TXDR_REG, 0);
860 spin_unlock(&i2s->lock_fd);
862 if (STM32_I2S_IS_SLAVE(i2s))
863 ier |= I2S_IER_TIFREIE;
865 regmap_update_bits(i2s->regmap, STM32_I2S_IER_REG, ier, ier);
867 case SNDRV_PCM_TRIGGER_STOP:
868 case SNDRV_PCM_TRIGGER_SUSPEND:
869 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
870 dev_dbg(cpu_dai->dev, "stop I2S %s\n",
871 playback_flg ? "playback" : "capture");
874 regmap_update_bits(i2s->regmap, STM32_I2S_IER_REG,
876 (unsigned int)~I2S_IER_UDRIE);
878 regmap_update_bits(i2s->regmap, STM32_I2S_IER_REG,
880 (unsigned int)~I2S_IER_OVRIE);
882 spin_lock(&i2s->lock_fd);
885 spin_unlock(&i2s->lock_fd);
889 ret = regmap_update_bits(i2s->regmap, STM32_I2S_CR1_REG,
892 dev_err(cpu_dai->dev, "Error %d disabling I2S\n", ret);
893 spin_unlock(&i2s->lock_fd);
896 spin_unlock(&i2s->lock_fd);
898 cfg1_mask = I2S_CFG1_RXDMAEN | I2S_CFG1_TXDMAEN;
899 regmap_update_bits(i2s->regmap, STM32_I2S_CFG1_REG,
909 static void stm32_i2s_shutdown(struct snd_pcm_substream *substream,
910 struct snd_soc_dai *cpu_dai)
912 struct stm32_i2s_data *i2s = snd_soc_dai_get_drvdata(cpu_dai);
915 clk_disable_unprepare(i2s->i2sclk);
917 spin_lock_irqsave(&i2s->irq_lock, flags);
918 i2s->substream = NULL;
919 spin_unlock_irqrestore(&i2s->irq_lock, flags);
922 static int stm32_i2s_dai_probe(struct snd_soc_dai *cpu_dai)
924 struct stm32_i2s_data *i2s = dev_get_drvdata(cpu_dai->dev);
925 struct snd_dmaengine_dai_dma_data *dma_data_tx = &i2s->dma_data_tx;
926 struct snd_dmaengine_dai_dma_data *dma_data_rx = &i2s->dma_data_rx;
928 /* Buswidth will be set by framework */
929 dma_data_tx->addr_width = DMA_SLAVE_BUSWIDTH_UNDEFINED;
930 dma_data_tx->addr = (dma_addr_t)(i2s->phys_addr) + STM32_I2S_TXDR_REG;
931 dma_data_tx->maxburst = 1;
932 dma_data_rx->addr_width = DMA_SLAVE_BUSWIDTH_UNDEFINED;
933 dma_data_rx->addr = (dma_addr_t)(i2s->phys_addr) + STM32_I2S_RXDR_REG;
934 dma_data_rx->maxburst = 1;
936 snd_soc_dai_init_dma_data(cpu_dai, dma_data_tx, dma_data_rx);
941 static const struct regmap_config stm32_h7_i2s_regmap_conf = {
945 .max_register = STM32_I2S_SIDR_REG,
946 .readable_reg = stm32_i2s_readable_reg,
947 .volatile_reg = stm32_i2s_volatile_reg,
948 .writeable_reg = stm32_i2s_writeable_reg,
949 .num_reg_defaults_raw = STM32_I2S_SIDR_REG / sizeof(u32) + 1,
951 .cache_type = REGCACHE_FLAT,
954 static const struct snd_soc_dai_ops stm32_i2s_pcm_dai_ops = {
955 .set_sysclk = stm32_i2s_set_sysclk,
956 .set_fmt = stm32_i2s_set_dai_fmt,
957 .startup = stm32_i2s_startup,
958 .hw_params = stm32_i2s_hw_params,
959 .trigger = stm32_i2s_trigger,
960 .shutdown = stm32_i2s_shutdown,
963 static const struct snd_pcm_hardware stm32_i2s_pcm_hw = {
964 .info = SNDRV_PCM_INFO_INTERLEAVED | SNDRV_PCM_INFO_MMAP,
965 .buffer_bytes_max = 8 * PAGE_SIZE,
966 .period_bytes_min = 1024,
967 .period_bytes_max = 4 * PAGE_SIZE,
972 static const struct snd_dmaengine_pcm_config stm32_i2s_pcm_config = {
973 .pcm_hardware = &stm32_i2s_pcm_hw,
974 .prepare_slave_config = snd_dmaengine_pcm_prepare_slave_config,
975 .prealloc_buffer_size = PAGE_SIZE * 8,
978 static const struct snd_soc_component_driver stm32_i2s_component = {
982 static void stm32_i2s_dai_init(struct snd_soc_pcm_stream *stream,
985 stream->stream_name = stream_name;
986 stream->channels_min = 1;
987 stream->channels_max = 2;
988 stream->rates = SNDRV_PCM_RATE_8000_192000;
989 stream->formats = SNDRV_PCM_FMTBIT_S16_LE |
990 SNDRV_PCM_FMTBIT_S32_LE;
993 static int stm32_i2s_dais_init(struct platform_device *pdev,
994 struct stm32_i2s_data *i2s)
996 struct snd_soc_dai_driver *dai_ptr;
998 dai_ptr = devm_kzalloc(&pdev->dev, sizeof(struct snd_soc_dai_driver),
1003 dai_ptr->probe = stm32_i2s_dai_probe;
1004 dai_ptr->ops = &stm32_i2s_pcm_dai_ops;
1006 stm32_i2s_dai_init(&dai_ptr->playback, "playback");
1007 stm32_i2s_dai_init(&dai_ptr->capture, "capture");
1008 i2s->dai_drv = dai_ptr;
1013 static const struct of_device_id stm32_i2s_ids[] = {
1015 .compatible = "st,stm32h7-i2s",
1016 .data = &stm32_h7_i2s_regmap_conf
1021 static int stm32_i2s_parse_dt(struct platform_device *pdev,
1022 struct stm32_i2s_data *i2s)
1024 struct device_node *np = pdev->dev.of_node;
1025 const struct of_device_id *of_id;
1026 struct reset_control *rst;
1027 struct resource *res;
1033 of_id = of_match_device(stm32_i2s_ids, &pdev->dev);
1035 i2s->regmap_conf = (const struct regmap_config *)of_id->data;
1039 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1040 i2s->base = devm_ioremap_resource(&pdev->dev, res);
1041 if (IS_ERR(i2s->base))
1042 return PTR_ERR(i2s->base);
1044 i2s->phys_addr = res->start;
1047 i2s->pclk = devm_clk_get(&pdev->dev, "pclk");
1048 if (IS_ERR(i2s->pclk)) {
1049 if (PTR_ERR(i2s->pclk) != -EPROBE_DEFER)
1050 dev_err(&pdev->dev, "Could not get pclk: %ld\n",
1051 PTR_ERR(i2s->pclk));
1052 return PTR_ERR(i2s->pclk);
1055 i2s->i2sclk = devm_clk_get(&pdev->dev, "i2sclk");
1056 if (IS_ERR(i2s->i2sclk)) {
1057 if (PTR_ERR(i2s->i2sclk) != -EPROBE_DEFER)
1058 dev_err(&pdev->dev, "Could not get i2sclk: %ld\n",
1059 PTR_ERR(i2s->i2sclk));
1060 return PTR_ERR(i2s->i2sclk);
1063 i2s->x8kclk = devm_clk_get(&pdev->dev, "x8k");
1064 if (IS_ERR(i2s->x8kclk)) {
1065 if (PTR_ERR(i2s->x8kclk) != -EPROBE_DEFER)
1066 dev_err(&pdev->dev, "Could not get x8k parent clock: %ld\n",
1067 PTR_ERR(i2s->x8kclk));
1068 return PTR_ERR(i2s->x8kclk);
1071 i2s->x11kclk = devm_clk_get(&pdev->dev, "x11k");
1072 if (IS_ERR(i2s->x11kclk)) {
1073 if (PTR_ERR(i2s->x11kclk) != -EPROBE_DEFER)
1074 dev_err(&pdev->dev, "Could not get x11k parent clock: %ld\n",
1075 PTR_ERR(i2s->x11kclk));
1076 return PTR_ERR(i2s->x11kclk);
1079 /* Register mclk provider if requested */
1080 if (of_find_property(np, "#clock-cells", NULL)) {
1081 ret = stm32_i2s_add_mclk_provider(i2s);
1087 irq = platform_get_irq(pdev, 0);
1091 ret = devm_request_irq(&pdev->dev, irq, stm32_i2s_isr, IRQF_ONESHOT,
1092 dev_name(&pdev->dev), i2s);
1094 dev_err(&pdev->dev, "irq request returned %d\n", ret);
1099 rst = devm_reset_control_get_optional_exclusive(&pdev->dev, NULL);
1101 if (PTR_ERR(rst) != -EPROBE_DEFER)
1102 dev_err(&pdev->dev, "Reset controller error %ld\n",
1104 return PTR_ERR(rst);
1106 reset_control_assert(rst);
1108 reset_control_deassert(rst);
1113 static int stm32_i2s_remove(struct platform_device *pdev)
1115 snd_dmaengine_pcm_unregister(&pdev->dev);
1116 snd_soc_unregister_component(&pdev->dev);
1121 static int stm32_i2s_probe(struct platform_device *pdev)
1123 struct stm32_i2s_data *i2s;
1127 i2s = devm_kzalloc(&pdev->dev, sizeof(*i2s), GFP_KERNEL);
1132 i2s->ms_flg = I2S_MS_NOT_SET;
1133 spin_lock_init(&i2s->lock_fd);
1134 spin_lock_init(&i2s->irq_lock);
1135 platform_set_drvdata(pdev, i2s);
1137 ret = stm32_i2s_parse_dt(pdev, i2s);
1141 ret = stm32_i2s_dais_init(pdev, i2s);
1145 i2s->regmap = devm_regmap_init_mmio_clk(&pdev->dev, "pclk",
1146 i2s->base, i2s->regmap_conf);
1147 if (IS_ERR(i2s->regmap)) {
1148 if (PTR_ERR(i2s->regmap) != -EPROBE_DEFER)
1149 dev_err(&pdev->dev, "Regmap init error %ld\n",
1150 PTR_ERR(i2s->regmap));
1151 return PTR_ERR(i2s->regmap);
1154 ret = snd_dmaengine_pcm_register(&pdev->dev, &stm32_i2s_pcm_config, 0);
1156 if (ret != -EPROBE_DEFER)
1157 dev_err(&pdev->dev, "PCM DMA register error %d\n", ret);
1161 ret = snd_soc_register_component(&pdev->dev, &stm32_i2s_component,
1164 snd_dmaengine_pcm_unregister(&pdev->dev);
1168 /* Set SPI/I2S in i2s mode */
1169 ret = regmap_update_bits(i2s->regmap, STM32_I2S_CGFR_REG,
1170 I2S_CGFR_I2SMOD, I2S_CGFR_I2SMOD);
1174 ret = regmap_read(i2s->regmap, STM32_I2S_IPIDR_REG, &val);
1178 if (val == I2S_IPIDR_NUMBER) {
1179 ret = regmap_read(i2s->regmap, STM32_I2S_HWCFGR_REG, &val);
1183 if (!FIELD_GET(I2S_HWCFGR_I2S_SUPPORT_MASK, val)) {
1185 "Device does not support i2s mode\n");
1190 ret = regmap_read(i2s->regmap, STM32_I2S_VERR_REG, &val);
1194 dev_dbg(&pdev->dev, "I2S version: %lu.%lu registered\n",
1195 FIELD_GET(I2S_VERR_MAJ_MASK, val),
1196 FIELD_GET(I2S_VERR_MIN_MASK, val));
1202 stm32_i2s_remove(pdev);
1207 MODULE_DEVICE_TABLE(of, stm32_i2s_ids);
1209 #ifdef CONFIG_PM_SLEEP
1210 static int stm32_i2s_suspend(struct device *dev)
1212 struct stm32_i2s_data *i2s = dev_get_drvdata(dev);
1214 regcache_cache_only(i2s->regmap, true);
1215 regcache_mark_dirty(i2s->regmap);
1220 static int stm32_i2s_resume(struct device *dev)
1222 struct stm32_i2s_data *i2s = dev_get_drvdata(dev);
1224 regcache_cache_only(i2s->regmap, false);
1225 return regcache_sync(i2s->regmap);
1227 #endif /* CONFIG_PM_SLEEP */
1229 static const struct dev_pm_ops stm32_i2s_pm_ops = {
1230 SET_SYSTEM_SLEEP_PM_OPS(stm32_i2s_suspend, stm32_i2s_resume)
1233 static struct platform_driver stm32_i2s_driver = {
1235 .name = "st,stm32-i2s",
1236 .of_match_table = stm32_i2s_ids,
1237 .pm = &stm32_i2s_pm_ops,
1239 .probe = stm32_i2s_probe,
1240 .remove = stm32_i2s_remove,
1243 module_platform_driver(stm32_i2s_driver);
1245 MODULE_DESCRIPTION("STM32 Soc i2s Interface");
1246 MODULE_AUTHOR("Olivier Moysan, <olivier.moysan@st.com>");
1247 MODULE_ALIAS("platform:stm32-i2s");
1248 MODULE_LICENSE("GPL v2");