1 /* sound/soc/samsung/pcm.c
3 * ALSA SoC Audio Layer - S3C PCM-Controller driver
5 * Copyright (c) 2009 Samsung Electronics Co. Ltd
6 * Author: Jaswinder Singh <jassisinghbrar@gmail.com>
7 * based upon I2S drivers by Ben Dooks.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/clk.h>
16 #include <linux/module.h>
17 #include <linux/pm_runtime.h>
19 #include <sound/soc.h>
20 #include <sound/pcm_params.h>
22 #include <linux/platform_data/asoc-s3c.h>
28 #define S3C_PCM_CTL 0x00
29 #define S3C_PCM_CLKCTL 0x04
30 #define S3C_PCM_TXFIFO 0x08
31 #define S3C_PCM_RXFIFO 0x0C
32 #define S3C_PCM_IRQCTL 0x10
33 #define S3C_PCM_IRQSTAT 0x14
34 #define S3C_PCM_FIFOSTAT 0x18
35 #define S3C_PCM_CLRINT 0x20
37 /* PCM_CTL Bit-Fields */
38 #define S3C_PCM_CTL_TXDIPSTICK_MASK 0x3f
39 #define S3C_PCM_CTL_TXDIPSTICK_SHIFT 13
40 #define S3C_PCM_CTL_RXDIPSTICK_MASK 0x3f
41 #define S3C_PCM_CTL_RXDIPSTICK_SHIFT 7
42 #define S3C_PCM_CTL_TXDMA_EN (0x1 << 6)
43 #define S3C_PCM_CTL_RXDMA_EN (0x1 << 5)
44 #define S3C_PCM_CTL_TXMSB_AFTER_FSYNC (0x1 << 4)
45 #define S3C_PCM_CTL_RXMSB_AFTER_FSYNC (0x1 << 3)
46 #define S3C_PCM_CTL_TXFIFO_EN (0x1 << 2)
47 #define S3C_PCM_CTL_RXFIFO_EN (0x1 << 1)
48 #define S3C_PCM_CTL_ENABLE (0x1 << 0)
50 /* PCM_CLKCTL Bit-Fields */
51 #define S3C_PCM_CLKCTL_SERCLK_EN (0x1 << 19)
52 #define S3C_PCM_CLKCTL_SERCLKSEL_PCLK (0x1 << 18)
53 #define S3C_PCM_CLKCTL_SCLKDIV_MASK 0x1ff
54 #define S3C_PCM_CLKCTL_SYNCDIV_MASK 0x1ff
55 #define S3C_PCM_CLKCTL_SCLKDIV_SHIFT 9
56 #define S3C_PCM_CLKCTL_SYNCDIV_SHIFT 0
58 /* PCM_TXFIFO Bit-Fields */
59 #define S3C_PCM_TXFIFO_DVALID (0x1 << 16)
60 #define S3C_PCM_TXFIFO_DATA_MSK (0xffff << 0)
62 /* PCM_RXFIFO Bit-Fields */
63 #define S3C_PCM_RXFIFO_DVALID (0x1 << 16)
64 #define S3C_PCM_RXFIFO_DATA_MSK (0xffff << 0)
66 /* PCM_IRQCTL Bit-Fields */
67 #define S3C_PCM_IRQCTL_IRQEN (0x1 << 14)
68 #define S3C_PCM_IRQCTL_WRDEN (0x1 << 12)
69 #define S3C_PCM_IRQCTL_TXEMPTYEN (0x1 << 11)
70 #define S3C_PCM_IRQCTL_TXALMSTEMPTYEN (0x1 << 10)
71 #define S3C_PCM_IRQCTL_TXFULLEN (0x1 << 9)
72 #define S3C_PCM_IRQCTL_TXALMSTFULLEN (0x1 << 8)
73 #define S3C_PCM_IRQCTL_TXSTARVEN (0x1 << 7)
74 #define S3C_PCM_IRQCTL_TXERROVRFLEN (0x1 << 6)
75 #define S3C_PCM_IRQCTL_RXEMPTEN (0x1 << 5)
76 #define S3C_PCM_IRQCTL_RXALMSTEMPTEN (0x1 << 4)
77 #define S3C_PCM_IRQCTL_RXFULLEN (0x1 << 3)
78 #define S3C_PCM_IRQCTL_RXALMSTFULLEN (0x1 << 2)
79 #define S3C_PCM_IRQCTL_RXSTARVEN (0x1 << 1)
80 #define S3C_PCM_IRQCTL_RXERROVRFLEN (0x1 << 0)
82 /* PCM_IRQSTAT Bit-Fields */
83 #define S3C_PCM_IRQSTAT_IRQPND (0x1 << 13)
84 #define S3C_PCM_IRQSTAT_WRD_XFER (0x1 << 12)
85 #define S3C_PCM_IRQSTAT_TXEMPTY (0x1 << 11)
86 #define S3C_PCM_IRQSTAT_TXALMSTEMPTY (0x1 << 10)
87 #define S3C_PCM_IRQSTAT_TXFULL (0x1 << 9)
88 #define S3C_PCM_IRQSTAT_TXALMSTFULL (0x1 << 8)
89 #define S3C_PCM_IRQSTAT_TXSTARV (0x1 << 7)
90 #define S3C_PCM_IRQSTAT_TXERROVRFL (0x1 << 6)
91 #define S3C_PCM_IRQSTAT_RXEMPT (0x1 << 5)
92 #define S3C_PCM_IRQSTAT_RXALMSTEMPT (0x1 << 4)
93 #define S3C_PCM_IRQSTAT_RXFULL (0x1 << 3)
94 #define S3C_PCM_IRQSTAT_RXALMSTFULL (0x1 << 2)
95 #define S3C_PCM_IRQSTAT_RXSTARV (0x1 << 1)
96 #define S3C_PCM_IRQSTAT_RXERROVRFL (0x1 << 0)
98 /* PCM_FIFOSTAT Bit-Fields */
99 #define S3C_PCM_FIFOSTAT_TXCNT_MSK (0x3f << 14)
100 #define S3C_PCM_FIFOSTAT_TXFIFOEMPTY (0x1 << 13)
101 #define S3C_PCM_FIFOSTAT_TXFIFOALMSTEMPTY (0x1 << 12)
102 #define S3C_PCM_FIFOSTAT_TXFIFOFULL (0x1 << 11)
103 #define S3C_PCM_FIFOSTAT_TXFIFOALMSTFULL (0x1 << 10)
104 #define S3C_PCM_FIFOSTAT_RXCNT_MSK (0x3f << 4)
105 #define S3C_PCM_FIFOSTAT_RXFIFOEMPTY (0x1 << 3)
106 #define S3C_PCM_FIFOSTAT_RXFIFOALMSTEMPTY (0x1 << 2)
107 #define S3C_PCM_FIFOSTAT_RXFIFOFULL (0x1 << 1)
108 #define S3C_PCM_FIFOSTAT_RXFIFOALMSTFULL (0x1 << 0)
111 * struct s3c_pcm_info - S3C PCM Controller information
112 * @dev: The parent device passed to use from the probe.
113 * @regs: The pointer to the device register block.
114 * @dma_playback: DMA information for playback channel.
115 * @dma_capture: DMA information for capture channel.
117 struct s3c_pcm_info
{
122 unsigned int sclk_per_fs
;
124 /* Whether to keep PCMSCLK enabled even when idle(no active xfer) */
125 unsigned int idleclk
;
130 struct snd_dmaengine_dai_dma_data
*dma_playback
;
131 struct snd_dmaengine_dai_dma_data
*dma_capture
;
134 static struct snd_dmaengine_dai_dma_data s3c_pcm_stereo_out
[] = {
143 static struct snd_dmaengine_dai_dma_data s3c_pcm_stereo_in
[] = {
152 static struct s3c_pcm_info s3c_pcm
[2];
154 static void s3c_pcm_snd_txctrl(struct s3c_pcm_info
*pcm
, int on
)
156 void __iomem
*regs
= pcm
->regs
;
159 clkctl
= readl(regs
+ S3C_PCM_CLKCTL
);
160 ctl
= readl(regs
+ S3C_PCM_CTL
);
161 ctl
&= ~(S3C_PCM_CTL_TXDIPSTICK_MASK
162 << S3C_PCM_CTL_TXDIPSTICK_SHIFT
);
165 ctl
|= S3C_PCM_CTL_TXDMA_EN
;
166 ctl
|= S3C_PCM_CTL_TXFIFO_EN
;
167 ctl
|= S3C_PCM_CTL_ENABLE
;
168 ctl
|= (0x4<<S3C_PCM_CTL_TXDIPSTICK_SHIFT
);
169 clkctl
|= S3C_PCM_CLKCTL_SERCLK_EN
;
171 ctl
&= ~S3C_PCM_CTL_TXDMA_EN
;
172 ctl
&= ~S3C_PCM_CTL_TXFIFO_EN
;
174 if (!(ctl
& S3C_PCM_CTL_RXFIFO_EN
)) {
175 ctl
&= ~S3C_PCM_CTL_ENABLE
;
177 clkctl
|= S3C_PCM_CLKCTL_SERCLK_EN
;
181 writel(clkctl
, regs
+ S3C_PCM_CLKCTL
);
182 writel(ctl
, regs
+ S3C_PCM_CTL
);
185 static void s3c_pcm_snd_rxctrl(struct s3c_pcm_info
*pcm
, int on
)
187 void __iomem
*regs
= pcm
->regs
;
190 ctl
= readl(regs
+ S3C_PCM_CTL
);
191 clkctl
= readl(regs
+ S3C_PCM_CLKCTL
);
192 ctl
&= ~(S3C_PCM_CTL_RXDIPSTICK_MASK
193 << S3C_PCM_CTL_RXDIPSTICK_SHIFT
);
196 ctl
|= S3C_PCM_CTL_RXDMA_EN
;
197 ctl
|= S3C_PCM_CTL_RXFIFO_EN
;
198 ctl
|= S3C_PCM_CTL_ENABLE
;
199 ctl
|= (0x20<<S3C_PCM_CTL_RXDIPSTICK_SHIFT
);
200 clkctl
|= S3C_PCM_CLKCTL_SERCLK_EN
;
202 ctl
&= ~S3C_PCM_CTL_RXDMA_EN
;
203 ctl
&= ~S3C_PCM_CTL_RXFIFO_EN
;
205 if (!(ctl
& S3C_PCM_CTL_TXFIFO_EN
)) {
206 ctl
&= ~S3C_PCM_CTL_ENABLE
;
208 clkctl
|= S3C_PCM_CLKCTL_SERCLK_EN
;
212 writel(clkctl
, regs
+ S3C_PCM_CLKCTL
);
213 writel(ctl
, regs
+ S3C_PCM_CTL
);
216 static int s3c_pcm_trigger(struct snd_pcm_substream
*substream
, int cmd
,
217 struct snd_soc_dai
*dai
)
219 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
220 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(rtd
->cpu_dai
);
223 dev_dbg(pcm
->dev
, "Entered %s\n", __func__
);
226 case SNDRV_PCM_TRIGGER_START
:
227 case SNDRV_PCM_TRIGGER_RESUME
:
228 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
229 spin_lock_irqsave(&pcm
->lock
, flags
);
231 if (substream
->stream
== SNDRV_PCM_STREAM_CAPTURE
)
232 s3c_pcm_snd_rxctrl(pcm
, 1);
234 s3c_pcm_snd_txctrl(pcm
, 1);
236 spin_unlock_irqrestore(&pcm
->lock
, flags
);
239 case SNDRV_PCM_TRIGGER_STOP
:
240 case SNDRV_PCM_TRIGGER_SUSPEND
:
241 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
242 spin_lock_irqsave(&pcm
->lock
, flags
);
244 if (substream
->stream
== SNDRV_PCM_STREAM_CAPTURE
)
245 s3c_pcm_snd_rxctrl(pcm
, 0);
247 s3c_pcm_snd_txctrl(pcm
, 0);
249 spin_unlock_irqrestore(&pcm
->lock
, flags
);
259 static int s3c_pcm_hw_params(struct snd_pcm_substream
*substream
,
260 struct snd_pcm_hw_params
*params
,
261 struct snd_soc_dai
*socdai
)
263 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
264 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(rtd
->cpu_dai
);
265 void __iomem
*regs
= pcm
->regs
;
267 int sclk_div
, sync_div
;
271 dev_dbg(pcm
->dev
, "Entered %s\n", __func__
);
273 /* Strictly check for sample size */
274 switch (params_width(params
)) {
281 spin_lock_irqsave(&pcm
->lock
, flags
);
283 /* Get hold of the PCMSOURCE_CLK */
284 clkctl
= readl(regs
+ S3C_PCM_CLKCTL
);
285 if (clkctl
& S3C_PCM_CLKCTL_SERCLKSEL_PCLK
)
290 /* Set the SCLK divider */
291 sclk_div
= clk_get_rate(clk
) / pcm
->sclk_per_fs
/
292 params_rate(params
) / 2 - 1;
294 clkctl
&= ~(S3C_PCM_CLKCTL_SCLKDIV_MASK
295 << S3C_PCM_CLKCTL_SCLKDIV_SHIFT
);
296 clkctl
|= ((sclk_div
& S3C_PCM_CLKCTL_SCLKDIV_MASK
)
297 << S3C_PCM_CLKCTL_SCLKDIV_SHIFT
);
299 /* Set the SYNC divider */
300 sync_div
= pcm
->sclk_per_fs
- 1;
302 clkctl
&= ~(S3C_PCM_CLKCTL_SYNCDIV_MASK
303 << S3C_PCM_CLKCTL_SYNCDIV_SHIFT
);
304 clkctl
|= ((sync_div
& S3C_PCM_CLKCTL_SYNCDIV_MASK
)
305 << S3C_PCM_CLKCTL_SYNCDIV_SHIFT
);
307 writel(clkctl
, regs
+ S3C_PCM_CLKCTL
);
309 spin_unlock_irqrestore(&pcm
->lock
, flags
);
311 dev_dbg(pcm
->dev
, "PCMSOURCE_CLK-%lu SCLK=%ufs SCLK_DIV=%d SYNC_DIV=%d\n",
312 clk_get_rate(clk
), pcm
->sclk_per_fs
,
318 static int s3c_pcm_set_fmt(struct snd_soc_dai
*cpu_dai
,
321 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(cpu_dai
);
322 void __iomem
*regs
= pcm
->regs
;
327 dev_dbg(pcm
->dev
, "Entered %s\n", __func__
);
329 spin_lock_irqsave(&pcm
->lock
, flags
);
331 ctl
= readl(regs
+ S3C_PCM_CTL
);
333 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
334 case SND_SOC_DAIFMT_IB_NF
:
335 /* Nothing to do, IB_NF by default */
338 dev_err(pcm
->dev
, "Unsupported clock inversion!\n");
343 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
344 case SND_SOC_DAIFMT_CBS_CFS
:
345 /* Nothing to do, Master by default */
348 dev_err(pcm
->dev
, "Unsupported master/slave format!\n");
353 switch (fmt
& SND_SOC_DAIFMT_CLOCK_MASK
) {
354 case SND_SOC_DAIFMT_CONT
:
357 case SND_SOC_DAIFMT_GATED
:
361 dev_err(pcm
->dev
, "Invalid Clock gating request!\n");
366 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
367 case SND_SOC_DAIFMT_DSP_A
:
368 ctl
|= S3C_PCM_CTL_TXMSB_AFTER_FSYNC
;
369 ctl
|= S3C_PCM_CTL_RXMSB_AFTER_FSYNC
;
371 case SND_SOC_DAIFMT_DSP_B
:
372 ctl
&= ~S3C_PCM_CTL_TXMSB_AFTER_FSYNC
;
373 ctl
&= ~S3C_PCM_CTL_RXMSB_AFTER_FSYNC
;
376 dev_err(pcm
->dev
, "Unsupported data format!\n");
381 writel(ctl
, regs
+ S3C_PCM_CTL
);
384 spin_unlock_irqrestore(&pcm
->lock
, flags
);
389 static int s3c_pcm_set_clkdiv(struct snd_soc_dai
*cpu_dai
,
392 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(cpu_dai
);
395 case S3C_PCM_SCLK_PER_FS
:
396 pcm
->sclk_per_fs
= div
;
406 static int s3c_pcm_set_sysclk(struct snd_soc_dai
*cpu_dai
,
407 int clk_id
, unsigned int freq
, int dir
)
409 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(cpu_dai
);
410 void __iomem
*regs
= pcm
->regs
;
411 u32 clkctl
= readl(regs
+ S3C_PCM_CLKCTL
);
414 case S3C_PCM_CLKSRC_PCLK
:
415 clkctl
|= S3C_PCM_CLKCTL_SERCLKSEL_PCLK
;
418 case S3C_PCM_CLKSRC_MUX
:
419 clkctl
&= ~S3C_PCM_CLKCTL_SERCLKSEL_PCLK
;
421 if (clk_get_rate(pcm
->cclk
) != freq
)
422 clk_set_rate(pcm
->cclk
, freq
);
430 writel(clkctl
, regs
+ S3C_PCM_CLKCTL
);
435 static const struct snd_soc_dai_ops s3c_pcm_dai_ops
= {
436 .set_sysclk
= s3c_pcm_set_sysclk
,
437 .set_clkdiv
= s3c_pcm_set_clkdiv
,
438 .trigger
= s3c_pcm_trigger
,
439 .hw_params
= s3c_pcm_hw_params
,
440 .set_fmt
= s3c_pcm_set_fmt
,
443 static int s3c_pcm_dai_probe(struct snd_soc_dai
*dai
)
445 struct s3c_pcm_info
*pcm
= snd_soc_dai_get_drvdata(dai
);
447 snd_soc_dai_init_dma_data(dai
, pcm
->dma_playback
, pcm
->dma_capture
);
452 #define S3C_PCM_RATES SNDRV_PCM_RATE_8000_96000
454 #define S3C_PCM_DAI_DECLARE \
455 .symmetric_rates = 1, \
456 .probe = s3c_pcm_dai_probe, \
457 .ops = &s3c_pcm_dai_ops, \
461 .rates = S3C_PCM_RATES, \
462 .formats = SNDRV_PCM_FMTBIT_S16_LE, \
467 .rates = S3C_PCM_RATES, \
468 .formats = SNDRV_PCM_FMTBIT_S16_LE, \
471 static struct snd_soc_dai_driver s3c_pcm_dai
[] = {
473 .name
= "samsung-pcm.0",
477 .name
= "samsung-pcm.1",
482 static const struct snd_soc_component_driver s3c_pcm_component
= {
486 static int s3c_pcm_dev_probe(struct platform_device
*pdev
)
488 struct s3c_pcm_info
*pcm
;
489 struct resource
*mem_res
;
490 struct s3c_audio_pdata
*pcm_pdata
;
491 dma_filter_fn filter
;
494 /* Check for valid device index */
495 if ((pdev
->id
< 0) || pdev
->id
>= ARRAY_SIZE(s3c_pcm
)) {
496 dev_err(&pdev
->dev
, "id %d out of range\n", pdev
->id
);
500 pcm_pdata
= pdev
->dev
.platform_data
;
502 /* Check for availability of necessary resource */
503 mem_res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
505 dev_err(&pdev
->dev
, "Unable to get register resource\n");
509 if (pcm_pdata
&& pcm_pdata
->cfg_gpio
&& pcm_pdata
->cfg_gpio(pdev
)) {
510 dev_err(&pdev
->dev
, "Unable to configure gpio\n");
514 pcm
= &s3c_pcm
[pdev
->id
];
515 pcm
->dev
= &pdev
->dev
;
517 spin_lock_init(&pcm
->lock
);
519 /* Default is 128fs */
520 pcm
->sclk_per_fs
= 128;
522 pcm
->cclk
= devm_clk_get(&pdev
->dev
, "audio-bus");
523 if (IS_ERR(pcm
->cclk
)) {
524 dev_err(&pdev
->dev
, "failed to get audio-bus\n");
525 ret
= PTR_ERR(pcm
->cclk
);
528 clk_prepare_enable(pcm
->cclk
);
530 /* record our pcm structure for later use in the callbacks */
531 dev_set_drvdata(&pdev
->dev
, pcm
);
533 if (!request_mem_region(mem_res
->start
,
534 resource_size(mem_res
), "samsung-pcm")) {
535 dev_err(&pdev
->dev
, "Unable to request register region\n");
540 pcm
->regs
= ioremap(mem_res
->start
, 0x100);
541 if (pcm
->regs
== NULL
) {
542 dev_err(&pdev
->dev
, "cannot ioremap registers\n");
547 pcm
->pclk
= devm_clk_get(&pdev
->dev
, "pcm");
548 if (IS_ERR(pcm
->pclk
)) {
549 dev_err(&pdev
->dev
, "failed to get pcm_clock\n");
553 clk_prepare_enable(pcm
->pclk
);
555 s3c_pcm_stereo_in
[pdev
->id
].addr
= mem_res
->start
+ S3C_PCM_RXFIFO
;
556 s3c_pcm_stereo_out
[pdev
->id
].addr
= mem_res
->start
+ S3C_PCM_TXFIFO
;
560 s3c_pcm_stereo_in
[pdev
->id
].filter_data
= pcm_pdata
->dma_capture
;
561 s3c_pcm_stereo_out
[pdev
->id
].filter_data
= pcm_pdata
->dma_playback
;
562 filter
= pcm_pdata
->dma_filter
;
565 pcm
->dma_capture
= &s3c_pcm_stereo_in
[pdev
->id
];
566 pcm
->dma_playback
= &s3c_pcm_stereo_out
[pdev
->id
];
568 ret
= samsung_asoc_dma_platform_register(&pdev
->dev
, filter
,
571 dev_err(&pdev
->dev
, "failed to get register DMA: %d\n", ret
);
575 pm_runtime_enable(&pdev
->dev
);
577 ret
= devm_snd_soc_register_component(&pdev
->dev
, &s3c_pcm_component
,
578 &s3c_pcm_dai
[pdev
->id
], 1);
580 dev_err(&pdev
->dev
, "failed to get register DAI: %d\n", ret
);
586 pm_runtime_disable(&pdev
->dev
);
588 clk_disable_unprepare(pcm
->pclk
);
592 release_mem_region(mem_res
->start
, resource_size(mem_res
));
594 clk_disable_unprepare(pcm
->cclk
);
599 static int s3c_pcm_dev_remove(struct platform_device
*pdev
)
601 struct s3c_pcm_info
*pcm
= &s3c_pcm
[pdev
->id
];
602 struct resource
*mem_res
;
604 pm_runtime_disable(&pdev
->dev
);
608 mem_res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
609 release_mem_region(mem_res
->start
, resource_size(mem_res
));
611 clk_disable_unprepare(pcm
->cclk
);
612 clk_disable_unprepare(pcm
->pclk
);
617 static struct platform_driver s3c_pcm_driver
= {
618 .probe
= s3c_pcm_dev_probe
,
619 .remove
= s3c_pcm_dev_remove
,
621 .name
= "samsung-pcm",
625 module_platform_driver(s3c_pcm_driver
);
627 /* Module information */
628 MODULE_AUTHOR("Jaswinder Singh, <jassisinghbrar@gmail.com>");
629 MODULE_DESCRIPTION("S3C PCM Controller Driver");
630 MODULE_LICENSE("GPL");
631 MODULE_ALIAS("platform:samsung-pcm");