1 // SPDX-License-Identifier: GPL-2.0
3 // ALSA SoC Audio Layer - Samsung S/PDIF Controller driver
5 // Copyright (c) 2010 Samsung Electronics Co. Ltd
6 // http://www.samsung.com/
10 #include <linux/module.h>
12 #include <sound/soc.h>
13 #include <sound/pcm_params.h>
15 #include <linux/platform_data/asoc-s3c.h>
25 #define DATA_OUTBUF 0x10
30 #define CLKCTL_MASK 0x7
31 #define CLKCTL_MCLK_EXT (0x1 << 2)
32 #define CLKCTL_PWR_ON (0x1 << 0)
34 #define CON_MASK 0x3ffffff
35 #define CON_FIFO_TH_SHIFT 19
36 #define CON_FIFO_TH_MASK (0x7 << 19)
37 #define CON_USERDATA_23RDBIT (0x1 << 12)
39 #define CON_SW_RESET (0x1 << 5)
41 #define CON_MCLKDIV_MASK (0x3 << 3)
42 #define CON_MCLKDIV_256FS (0x0 << 3)
43 #define CON_MCLKDIV_384FS (0x1 << 3)
44 #define CON_MCLKDIV_512FS (0x2 << 3)
46 #define CON_PCM_MASK (0x3 << 1)
47 #define CON_PCM_16BIT (0x0 << 1)
48 #define CON_PCM_20BIT (0x1 << 1)
49 #define CON_PCM_24BIT (0x2 << 1)
51 #define CON_PCM_DATA (0x1 << 0)
53 #define CSTAS_MASK 0x3fffffff
54 #define CSTAS_SAMP_FREQ_MASK (0xF << 24)
55 #define CSTAS_SAMP_FREQ_44 (0x0 << 24)
56 #define CSTAS_SAMP_FREQ_48 (0x2 << 24)
57 #define CSTAS_SAMP_FREQ_32 (0x3 << 24)
58 #define CSTAS_SAMP_FREQ_96 (0xA << 24)
60 #define CSTAS_CATEGORY_MASK (0xFF << 8)
61 #define CSTAS_CATEGORY_CODE_CDP (0x01 << 8)
63 #define CSTAS_NO_COPYRIGHT (0x1 << 2)
66 * struct samsung_spdif_info - Samsung S/PDIF Controller information
67 * @lock: Spin lock for S/PDIF.
68 * @dev: The parent device passed to use from the probe.
69 * @regs: The pointer to the device register block.
70 * @clk_rate: Current clock rate for calcurate ratio.
71 * @pclk: The peri-clock pointer for spdif master operation.
72 * @sclk: The source clock pointer for making sync signals.
73 * @save_clkcon: Backup clkcon reg. in suspend.
74 * @save_con: Backup con reg. in suspend.
75 * @save_cstas: Backup cstas reg. in suspend.
76 * @dma_playback: DMA information for playback channel.
78 struct samsung_spdif_info {
82 unsigned long clk_rate;
88 struct snd_dmaengine_dai_dma_data *dma_playback;
91 static struct snd_dmaengine_dai_dma_data spdif_stereo_out;
92 static struct samsung_spdif_info spdif_info;
94 static inline struct samsung_spdif_info *to_info(struct snd_soc_dai *cpu_dai)
96 return snd_soc_dai_get_drvdata(cpu_dai);
99 static void spdif_snd_txctrl(struct samsung_spdif_info *spdif, int on)
101 void __iomem *regs = spdif->regs;
104 dev_dbg(spdif->dev, "Entered %s\n", __func__);
106 clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
108 writel(clkcon | CLKCTL_PWR_ON, regs + CLKCON);
110 writel(clkcon & ~CLKCTL_PWR_ON, regs + CLKCON);
113 static int spdif_set_sysclk(struct snd_soc_dai *cpu_dai,
114 int clk_id, unsigned int freq, int dir)
116 struct samsung_spdif_info *spdif = to_info(cpu_dai);
119 dev_dbg(spdif->dev, "Entered %s\n", __func__);
121 clkcon = readl(spdif->regs + CLKCON);
123 if (clk_id == SND_SOC_SPDIF_INT_MCLK)
124 clkcon &= ~CLKCTL_MCLK_EXT;
126 clkcon |= CLKCTL_MCLK_EXT;
128 writel(clkcon, spdif->regs + CLKCON);
130 spdif->clk_rate = freq;
135 static int spdif_trigger(struct snd_pcm_substream *substream, int cmd,
136 struct snd_soc_dai *dai)
138 struct snd_soc_pcm_runtime *rtd = substream->private_data;
139 struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
142 dev_dbg(spdif->dev, "Entered %s\n", __func__);
145 case SNDRV_PCM_TRIGGER_START:
146 case SNDRV_PCM_TRIGGER_RESUME:
147 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
148 spin_lock_irqsave(&spdif->lock, flags);
149 spdif_snd_txctrl(spdif, 1);
150 spin_unlock_irqrestore(&spdif->lock, flags);
152 case SNDRV_PCM_TRIGGER_STOP:
153 case SNDRV_PCM_TRIGGER_SUSPEND:
154 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
155 spin_lock_irqsave(&spdif->lock, flags);
156 spdif_snd_txctrl(spdif, 0);
157 spin_unlock_irqrestore(&spdif->lock, flags);
166 static int spdif_sysclk_ratios[] = {
170 static int spdif_hw_params(struct snd_pcm_substream *substream,
171 struct snd_pcm_hw_params *params,
172 struct snd_soc_dai *socdai)
174 struct snd_soc_pcm_runtime *rtd = substream->private_data;
175 struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
176 void __iomem *regs = spdif->regs;
177 struct snd_dmaengine_dai_dma_data *dma_data;
178 u32 con, clkcon, cstas;
182 dev_dbg(spdif->dev, "Entered %s\n", __func__);
184 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
185 dma_data = spdif->dma_playback;
187 dev_err(spdif->dev, "Capture is not supported\n");
191 snd_soc_dai_set_dma_data(rtd->cpu_dai, substream, dma_data);
193 spin_lock_irqsave(&spdif->lock, flags);
195 con = readl(regs + CON) & CON_MASK;
196 cstas = readl(regs + CSTAS) & CSTAS_MASK;
197 clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
199 con &= ~CON_FIFO_TH_MASK;
200 con |= (0x7 << CON_FIFO_TH_SHIFT);
201 con |= CON_USERDATA_23RDBIT;
204 con &= ~CON_PCM_MASK;
205 switch (params_width(params)) {
207 con |= CON_PCM_16BIT;
210 dev_err(spdif->dev, "Unsupported data size.\n");
214 ratio = spdif->clk_rate / params_rate(params);
215 for (i = 0; i < ARRAY_SIZE(spdif_sysclk_ratios); i++)
216 if (ratio == spdif_sysclk_ratios[i])
218 if (i == ARRAY_SIZE(spdif_sysclk_ratios)) {
219 dev_err(spdif->dev, "Invalid clock ratio %ld/%d\n",
220 spdif->clk_rate, params_rate(params));
224 con &= ~CON_MCLKDIV_MASK;
227 con |= CON_MCLKDIV_256FS;
230 con |= CON_MCLKDIV_384FS;
233 con |= CON_MCLKDIV_512FS;
237 cstas &= ~CSTAS_SAMP_FREQ_MASK;
238 switch (params_rate(params)) {
240 cstas |= CSTAS_SAMP_FREQ_44;
243 cstas |= CSTAS_SAMP_FREQ_48;
246 cstas |= CSTAS_SAMP_FREQ_32;
249 cstas |= CSTAS_SAMP_FREQ_96;
252 dev_err(spdif->dev, "Invalid sampling rate %d\n",
253 params_rate(params));
257 cstas &= ~CSTAS_CATEGORY_MASK;
258 cstas |= CSTAS_CATEGORY_CODE_CDP;
259 cstas |= CSTAS_NO_COPYRIGHT;
261 writel(con, regs + CON);
262 writel(cstas, regs + CSTAS);
263 writel(clkcon, regs + CLKCON);
265 spin_unlock_irqrestore(&spdif->lock, flags);
269 spin_unlock_irqrestore(&spdif->lock, flags);
273 static void spdif_shutdown(struct snd_pcm_substream *substream,
274 struct snd_soc_dai *dai)
276 struct snd_soc_pcm_runtime *rtd = substream->private_data;
277 struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
278 void __iomem *regs = spdif->regs;
281 dev_dbg(spdif->dev, "Entered %s\n", __func__);
283 con = readl(regs + CON) & CON_MASK;
284 clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
286 writel(con | CON_SW_RESET, regs + CON);
289 writel(clkcon & ~CLKCTL_PWR_ON, regs + CLKCON);
293 static int spdif_suspend(struct snd_soc_dai *cpu_dai)
295 struct samsung_spdif_info *spdif = to_info(cpu_dai);
296 u32 con = spdif->saved_con;
298 dev_dbg(spdif->dev, "Entered %s\n", __func__);
300 spdif->saved_clkcon = readl(spdif->regs + CLKCON) & CLKCTL_MASK;
301 spdif->saved_con = readl(spdif->regs + CON) & CON_MASK;
302 spdif->saved_cstas = readl(spdif->regs + CSTAS) & CSTAS_MASK;
304 writel(con | CON_SW_RESET, spdif->regs + CON);
310 static int spdif_resume(struct snd_soc_dai *cpu_dai)
312 struct samsung_spdif_info *spdif = to_info(cpu_dai);
314 dev_dbg(spdif->dev, "Entered %s\n", __func__);
316 writel(spdif->saved_clkcon, spdif->regs + CLKCON);
317 writel(spdif->saved_con, spdif->regs + CON);
318 writel(spdif->saved_cstas, spdif->regs + CSTAS);
323 #define spdif_suspend NULL
324 #define spdif_resume NULL
327 static const struct snd_soc_dai_ops spdif_dai_ops = {
328 .set_sysclk = spdif_set_sysclk,
329 .trigger = spdif_trigger,
330 .hw_params = spdif_hw_params,
331 .shutdown = spdif_shutdown,
334 static struct snd_soc_dai_driver samsung_spdif_dai = {
335 .name = "samsung-spdif",
337 .stream_name = "S/PDIF Playback",
340 .rates = (SNDRV_PCM_RATE_32000 |
341 SNDRV_PCM_RATE_44100 |
342 SNDRV_PCM_RATE_48000 |
343 SNDRV_PCM_RATE_96000),
344 .formats = SNDRV_PCM_FMTBIT_S16_LE, },
345 .ops = &spdif_dai_ops,
346 .suspend = spdif_suspend,
347 .resume = spdif_resume,
350 static const struct snd_soc_component_driver samsung_spdif_component = {
351 .name = "samsung-spdif",
354 static int spdif_probe(struct platform_device *pdev)
356 struct s3c_audio_pdata *spdif_pdata;
357 struct resource *mem_res;
358 struct samsung_spdif_info *spdif;
359 dma_filter_fn filter;
362 spdif_pdata = pdev->dev.platform_data;
364 dev_dbg(&pdev->dev, "Entered %s\n", __func__);
366 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
368 dev_err(&pdev->dev, "Unable to get register resource.\n");
372 if (spdif_pdata && spdif_pdata->cfg_gpio
373 && spdif_pdata->cfg_gpio(pdev)) {
374 dev_err(&pdev->dev, "Unable to configure GPIO pins\n");
379 spdif->dev = &pdev->dev;
381 spin_lock_init(&spdif->lock);
383 spdif->pclk = devm_clk_get(&pdev->dev, "spdif");
384 if (IS_ERR(spdif->pclk)) {
385 dev_err(&pdev->dev, "failed to get peri-clock\n");
389 ret = clk_prepare_enable(spdif->pclk);
393 spdif->sclk = devm_clk_get(&pdev->dev, "sclk_spdif");
394 if (IS_ERR(spdif->sclk)) {
395 dev_err(&pdev->dev, "failed to get internal source clock\n");
399 ret = clk_prepare_enable(spdif->sclk);
403 /* Request S/PDIF Register's memory region */
404 if (!request_mem_region(mem_res->start,
405 resource_size(mem_res), "samsung-spdif")) {
406 dev_err(&pdev->dev, "Unable to request register region\n");
411 spdif->regs = ioremap(mem_res->start, 0x100);
412 if (spdif->regs == NULL) {
413 dev_err(&pdev->dev, "Cannot ioremap registers\n");
418 spdif_stereo_out.addr_width = 2;
419 spdif_stereo_out.addr = mem_res->start + DATA_OUTBUF;
422 spdif_stereo_out.filter_data = spdif_pdata->dma_playback;
423 filter = spdif_pdata->dma_filter;
425 spdif->dma_playback = &spdif_stereo_out;
427 ret = samsung_asoc_dma_platform_register(&pdev->dev, filter,
430 dev_err(&pdev->dev, "failed to register DMA: %d\n", ret);
434 dev_set_drvdata(&pdev->dev, spdif);
436 ret = devm_snd_soc_register_component(&pdev->dev,
437 &samsung_spdif_component, &samsung_spdif_dai, 1);
439 dev_err(&pdev->dev, "fail to register dai\n");
445 iounmap(spdif->regs);
447 release_mem_region(mem_res->start, resource_size(mem_res));
449 clk_disable_unprepare(spdif->sclk);
451 clk_disable_unprepare(spdif->pclk);
456 static int spdif_remove(struct platform_device *pdev)
458 struct samsung_spdif_info *spdif = &spdif_info;
459 struct resource *mem_res;
461 iounmap(spdif->regs);
463 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
465 release_mem_region(mem_res->start, resource_size(mem_res));
467 clk_disable_unprepare(spdif->sclk);
468 clk_disable_unprepare(spdif->pclk);
473 static struct platform_driver samsung_spdif_driver = {
474 .probe = spdif_probe,
475 .remove = spdif_remove,
477 .name = "samsung-spdif",
481 module_platform_driver(samsung_spdif_driver);
483 MODULE_AUTHOR("Seungwhan Youn, <sw.youn@samsung.com>");
484 MODULE_DESCRIPTION("Samsung S/PDIF Controller Driver");
485 MODULE_LICENSE("GPL");
486 MODULE_ALIAS("platform:samsung-spdif");