2 * omap-mcpdm.c -- OMAP ALSA SoC DAI driver using McPDM port
4 * Copyright (C) 2009 - 2011 Texas Instruments
6 * Author: Misael Lopez Cruz <misael.lopez@ti.com>
7 * Contact: Jorge Eduardo Candelaria <x0107209@ti.com>
8 * Margarita Olaya <magi.olaya@ti.com>
9 * Peter Ujfalusi <peter.ujfalusi@ti.com>
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * version 2 as published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
27 #include <linux/init.h>
28 #include <linux/module.h>
29 #include <linux/platform_device.h>
30 #include <linux/interrupt.h>
31 #include <linux/err.h>
33 #include <linux/irq.h>
34 #include <linux/slab.h>
35 #include <linux/pm_runtime.h>
36 #include <linux/of_device.h>
38 #include <sound/core.h>
39 #include <sound/pcm.h>
40 #include <sound/pcm_params.h>
41 #include <sound/soc.h>
42 #include <sound/dmaengine_pcm.h>
43 #include <sound/omap-pcm.h>
45 #include "omap-mcpdm.h"
47 struct mcpdm_link_config
{
48 u32 link_mask
; /* channel mask for the direction */
49 u32 threshold
; /* FIFO threshold */
54 unsigned long phys_base
;
55 void __iomem
*io_base
;
60 /* Playback/Capture configuration */
61 struct mcpdm_link_config config
[2];
63 /* McPDM dn offsets for rx1, and 2 channels */
66 /* McPDM needs to be restarted due to runtime reconfiguration */
69 /* pm state for suspend/resume handling */
72 struct snd_dmaengine_dai_dma_data dma_data
[2];
76 * Stream DMA parameters
79 static inline void omap_mcpdm_write(struct omap_mcpdm
*mcpdm
, u16 reg
, u32 val
)
81 writel_relaxed(val
, mcpdm
->io_base
+ reg
);
84 static inline int omap_mcpdm_read(struct omap_mcpdm
*mcpdm
, u16 reg
)
86 return readl_relaxed(mcpdm
->io_base
+ reg
);
90 static void omap_mcpdm_reg_dump(struct omap_mcpdm
*mcpdm
)
92 dev_dbg(mcpdm
->dev
, "***********************\n");
93 dev_dbg(mcpdm
->dev
, "IRQSTATUS_RAW: 0x%04x\n",
94 omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQSTATUS_RAW
));
95 dev_dbg(mcpdm
->dev
, "IRQSTATUS: 0x%04x\n",
96 omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQSTATUS
));
97 dev_dbg(mcpdm
->dev
, "IRQENABLE_SET: 0x%04x\n",
98 omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQENABLE_SET
));
99 dev_dbg(mcpdm
->dev
, "IRQENABLE_CLR: 0x%04x\n",
100 omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQENABLE_CLR
));
101 dev_dbg(mcpdm
->dev
, "IRQWAKE_EN: 0x%04x\n",
102 omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQWAKE_EN
));
103 dev_dbg(mcpdm
->dev
, "DMAENABLE_SET: 0x%04x\n",
104 omap_mcpdm_read(mcpdm
, MCPDM_REG_DMAENABLE_SET
));
105 dev_dbg(mcpdm
->dev
, "DMAENABLE_CLR: 0x%04x\n",
106 omap_mcpdm_read(mcpdm
, MCPDM_REG_DMAENABLE_CLR
));
107 dev_dbg(mcpdm
->dev
, "DMAWAKEEN: 0x%04x\n",
108 omap_mcpdm_read(mcpdm
, MCPDM_REG_DMAWAKEEN
));
109 dev_dbg(mcpdm
->dev
, "CTRL: 0x%04x\n",
110 omap_mcpdm_read(mcpdm
, MCPDM_REG_CTRL
));
111 dev_dbg(mcpdm
->dev
, "DN_DATA: 0x%04x\n",
112 omap_mcpdm_read(mcpdm
, MCPDM_REG_DN_DATA
));
113 dev_dbg(mcpdm
->dev
, "UP_DATA: 0x%04x\n",
114 omap_mcpdm_read(mcpdm
, MCPDM_REG_UP_DATA
));
115 dev_dbg(mcpdm
->dev
, "FIFO_CTRL_DN: 0x%04x\n",
116 omap_mcpdm_read(mcpdm
, MCPDM_REG_FIFO_CTRL_DN
));
117 dev_dbg(mcpdm
->dev
, "FIFO_CTRL_UP: 0x%04x\n",
118 omap_mcpdm_read(mcpdm
, MCPDM_REG_FIFO_CTRL_UP
));
119 dev_dbg(mcpdm
->dev
, "***********************\n");
122 static void omap_mcpdm_reg_dump(struct omap_mcpdm
*mcpdm
) {}
126 * Enables the transfer through the PDM interface to/from the Phoenix
127 * codec by enabling the corresponding UP or DN channels.
129 static void omap_mcpdm_start(struct omap_mcpdm
*mcpdm
)
131 u32 ctrl
= omap_mcpdm_read(mcpdm
, MCPDM_REG_CTRL
);
132 u32 link_mask
= mcpdm
->config
[0].link_mask
| mcpdm
->config
[1].link_mask
;
134 ctrl
|= (MCPDM_SW_DN_RST
| MCPDM_SW_UP_RST
);
135 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
138 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
140 ctrl
&= ~(MCPDM_SW_DN_RST
| MCPDM_SW_UP_RST
);
141 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
145 * Disables the transfer through the PDM interface to/from the Phoenix
146 * codec by disabling the corresponding UP or DN channels.
148 static void omap_mcpdm_stop(struct omap_mcpdm
*mcpdm
)
150 u32 ctrl
= omap_mcpdm_read(mcpdm
, MCPDM_REG_CTRL
);
151 u32 link_mask
= MCPDM_PDM_DN_MASK
| MCPDM_PDM_UP_MASK
;
153 ctrl
|= (MCPDM_SW_DN_RST
| MCPDM_SW_UP_RST
);
154 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
156 ctrl
&= ~(link_mask
);
157 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
159 ctrl
&= ~(MCPDM_SW_DN_RST
| MCPDM_SW_UP_RST
);
160 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
);
165 * Is the physical McPDM interface active.
167 static inline int omap_mcpdm_active(struct omap_mcpdm
*mcpdm
)
169 return omap_mcpdm_read(mcpdm
, MCPDM_REG_CTRL
) &
170 (MCPDM_PDM_DN_MASK
| MCPDM_PDM_UP_MASK
);
174 * Configures McPDM uplink, and downlink for audio.
175 * This function should be called before omap_mcpdm_start.
177 static void omap_mcpdm_open_streams(struct omap_mcpdm
*mcpdm
)
179 u32 ctrl
= omap_mcpdm_read(mcpdm
, MCPDM_REG_CTRL
);
181 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, ctrl
| MCPDM_WD_EN
);
183 omap_mcpdm_write(mcpdm
, MCPDM_REG_IRQENABLE_SET
,
184 MCPDM_DN_IRQ_EMPTY
| MCPDM_DN_IRQ_FULL
|
185 MCPDM_UP_IRQ_EMPTY
| MCPDM_UP_IRQ_FULL
);
187 /* Enable DN RX1/2 offset cancellation feature, if configured */
188 if (mcpdm
->dn_rx_offset
) {
189 u32 dn_offset
= mcpdm
->dn_rx_offset
;
191 omap_mcpdm_write(mcpdm
, MCPDM_REG_DN_OFFSET
, dn_offset
);
192 dn_offset
|= (MCPDM_DN_OFST_RX1_EN
| MCPDM_DN_OFST_RX2_EN
);
193 omap_mcpdm_write(mcpdm
, MCPDM_REG_DN_OFFSET
, dn_offset
);
196 omap_mcpdm_write(mcpdm
, MCPDM_REG_FIFO_CTRL_DN
,
197 mcpdm
->config
[SNDRV_PCM_STREAM_PLAYBACK
].threshold
);
198 omap_mcpdm_write(mcpdm
, MCPDM_REG_FIFO_CTRL_UP
,
199 mcpdm
->config
[SNDRV_PCM_STREAM_CAPTURE
].threshold
);
201 omap_mcpdm_write(mcpdm
, MCPDM_REG_DMAENABLE_SET
,
202 MCPDM_DMA_DN_ENABLE
| MCPDM_DMA_UP_ENABLE
);
206 * Cleans McPDM uplink, and downlink configuration.
207 * This function should be called when the stream is closed.
209 static void omap_mcpdm_close_streams(struct omap_mcpdm
*mcpdm
)
211 /* Disable irq request generation for downlink */
212 omap_mcpdm_write(mcpdm
, MCPDM_REG_IRQENABLE_CLR
,
213 MCPDM_DN_IRQ_EMPTY
| MCPDM_DN_IRQ_FULL
);
215 /* Disable DMA request generation for downlink */
216 omap_mcpdm_write(mcpdm
, MCPDM_REG_DMAENABLE_CLR
, MCPDM_DMA_DN_ENABLE
);
218 /* Disable irq request generation for uplink */
219 omap_mcpdm_write(mcpdm
, MCPDM_REG_IRQENABLE_CLR
,
220 MCPDM_UP_IRQ_EMPTY
| MCPDM_UP_IRQ_FULL
);
222 /* Disable DMA request generation for uplink */
223 omap_mcpdm_write(mcpdm
, MCPDM_REG_DMAENABLE_CLR
, MCPDM_DMA_UP_ENABLE
);
225 /* Disable RX1/2 offset cancellation */
226 if (mcpdm
->dn_rx_offset
)
227 omap_mcpdm_write(mcpdm
, MCPDM_REG_DN_OFFSET
, 0);
230 static irqreturn_t
omap_mcpdm_irq_handler(int irq
, void *dev_id
)
232 struct omap_mcpdm
*mcpdm
= dev_id
;
235 irq_status
= omap_mcpdm_read(mcpdm
, MCPDM_REG_IRQSTATUS
);
237 /* Acknowledge irq event */
238 omap_mcpdm_write(mcpdm
, MCPDM_REG_IRQSTATUS
, irq_status
);
240 if (irq_status
& MCPDM_DN_IRQ_FULL
)
241 dev_dbg(mcpdm
->dev
, "DN (playback) FIFO Full\n");
243 if (irq_status
& MCPDM_DN_IRQ_EMPTY
)
244 dev_dbg(mcpdm
->dev
, "DN (playback) FIFO Empty\n");
246 if (irq_status
& MCPDM_DN_IRQ
)
247 dev_dbg(mcpdm
->dev
, "DN (playback) write request\n");
249 if (irq_status
& MCPDM_UP_IRQ_FULL
)
250 dev_dbg(mcpdm
->dev
, "UP (capture) FIFO Full\n");
252 if (irq_status
& MCPDM_UP_IRQ_EMPTY
)
253 dev_dbg(mcpdm
->dev
, "UP (capture) FIFO Empty\n");
255 if (irq_status
& MCPDM_UP_IRQ
)
256 dev_dbg(mcpdm
->dev
, "UP (capture) write request\n");
261 static int omap_mcpdm_dai_startup(struct snd_pcm_substream
*substream
,
262 struct snd_soc_dai
*dai
)
264 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
266 mutex_lock(&mcpdm
->mutex
);
269 omap_mcpdm_open_streams(mcpdm
);
271 mutex_unlock(&mcpdm
->mutex
);
276 static void omap_mcpdm_dai_shutdown(struct snd_pcm_substream
*substream
,
277 struct snd_soc_dai
*dai
)
279 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
281 mutex_lock(&mcpdm
->mutex
);
284 if (omap_mcpdm_active(mcpdm
)) {
285 omap_mcpdm_stop(mcpdm
);
286 omap_mcpdm_close_streams(mcpdm
);
287 mcpdm
->config
[0].link_mask
= 0;
288 mcpdm
->config
[1].link_mask
= 0;
292 mutex_unlock(&mcpdm
->mutex
);
295 static int omap_mcpdm_dai_hw_params(struct snd_pcm_substream
*substream
,
296 struct snd_pcm_hw_params
*params
,
297 struct snd_soc_dai
*dai
)
299 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
300 int stream
= substream
->stream
;
301 struct snd_dmaengine_dai_dma_data
*dma_data
;
306 channels
= params_channels(params
);
309 if (stream
== SNDRV_PCM_STREAM_CAPTURE
)
310 /* up to 3 channels for capture */
314 if (stream
== SNDRV_PCM_STREAM_CAPTURE
)
315 /* up to 3 channels for capture */
326 /* unsupported number of channels */
330 dma_data
= snd_soc_dai_get_dma_data(dai
, substream
);
332 threshold
= mcpdm
->config
[stream
].threshold
;
333 /* Configure McPDM channels, and DMA packet size */
334 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
) {
337 /* If capture is not running assume a stereo stream to come */
338 if (!mcpdm
->config
[!stream
].link_mask
)
339 mcpdm
->config
[!stream
].link_mask
= 0x3;
342 (MCPDM_DN_THRES_MAX
- threshold
) * channels
;
344 /* If playback is not running assume a stereo stream to come */
345 if (!mcpdm
->config
[!stream
].link_mask
)
346 mcpdm
->config
[!stream
].link_mask
= (0x3 << 3);
348 dma_data
->maxburst
= threshold
* channels
;
351 /* Check if we need to restart McPDM with this stream */
352 if (mcpdm
->config
[stream
].link_mask
&&
353 mcpdm
->config
[stream
].link_mask
!= link_mask
)
354 mcpdm
->restart
= true;
356 mcpdm
->config
[stream
].link_mask
= link_mask
;
361 static int omap_mcpdm_prepare(struct snd_pcm_substream
*substream
,
362 struct snd_soc_dai
*dai
)
364 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
366 if (!omap_mcpdm_active(mcpdm
)) {
367 omap_mcpdm_start(mcpdm
);
368 omap_mcpdm_reg_dump(mcpdm
);
369 } else if (mcpdm
->restart
) {
370 omap_mcpdm_stop(mcpdm
);
371 omap_mcpdm_start(mcpdm
);
372 mcpdm
->restart
= false;
373 omap_mcpdm_reg_dump(mcpdm
);
379 static const struct snd_soc_dai_ops omap_mcpdm_dai_ops
= {
380 .startup
= omap_mcpdm_dai_startup
,
381 .shutdown
= omap_mcpdm_dai_shutdown
,
382 .hw_params
= omap_mcpdm_dai_hw_params
,
383 .prepare
= omap_mcpdm_prepare
,
386 static int omap_mcpdm_probe(struct snd_soc_dai
*dai
)
388 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
391 pm_runtime_enable(mcpdm
->dev
);
393 /* Disable lines while request is ongoing */
394 pm_runtime_get_sync(mcpdm
->dev
);
395 omap_mcpdm_write(mcpdm
, MCPDM_REG_CTRL
, 0x00);
397 ret
= request_irq(mcpdm
->irq
, omap_mcpdm_irq_handler
, 0, "McPDM",
400 pm_runtime_put_sync(mcpdm
->dev
);
403 dev_err(mcpdm
->dev
, "Request for IRQ failed\n");
404 pm_runtime_disable(mcpdm
->dev
);
407 /* Configure McPDM threshold values */
408 mcpdm
->config
[SNDRV_PCM_STREAM_PLAYBACK
].threshold
= 2;
409 mcpdm
->config
[SNDRV_PCM_STREAM_CAPTURE
].threshold
=
410 MCPDM_UP_THRES_MAX
- 3;
412 snd_soc_dai_init_dma_data(dai
,
413 &mcpdm
->dma_data
[SNDRV_PCM_STREAM_PLAYBACK
],
414 &mcpdm
->dma_data
[SNDRV_PCM_STREAM_CAPTURE
]);
419 static int omap_mcpdm_remove(struct snd_soc_dai
*dai
)
421 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
423 free_irq(mcpdm
->irq
, (void *)mcpdm
);
424 pm_runtime_disable(mcpdm
->dev
);
429 #ifdef CONFIG_PM_SLEEP
430 static int omap_mcpdm_suspend(struct snd_soc_dai
*dai
)
432 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
435 omap_mcpdm_stop(mcpdm
);
436 omap_mcpdm_close_streams(mcpdm
);
439 mcpdm
->pm_active_count
= 0;
440 while (pm_runtime_active(mcpdm
->dev
)) {
441 pm_runtime_put_sync(mcpdm
->dev
);
442 mcpdm
->pm_active_count
++;
448 static int omap_mcpdm_resume(struct snd_soc_dai
*dai
)
450 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(dai
);
452 if (mcpdm
->pm_active_count
) {
453 while (mcpdm
->pm_active_count
--)
454 pm_runtime_get_sync(mcpdm
->dev
);
457 omap_mcpdm_open_streams(mcpdm
);
458 omap_mcpdm_start(mcpdm
);
466 #define omap_mcpdm_suspend NULL
467 #define omap_mcpdm_resume NULL
470 #define OMAP_MCPDM_RATES (SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000)
471 #define OMAP_MCPDM_FORMATS SNDRV_PCM_FMTBIT_S32_LE
473 static struct snd_soc_dai_driver omap_mcpdm_dai
= {
474 .probe
= omap_mcpdm_probe
,
475 .remove
= omap_mcpdm_remove
,
476 .suspend
= omap_mcpdm_suspend
,
477 .resume
= omap_mcpdm_resume
,
478 .probe_order
= SND_SOC_COMP_ORDER_LATE
,
479 .remove_order
= SND_SOC_COMP_ORDER_EARLY
,
483 .rates
= OMAP_MCPDM_RATES
,
484 .formats
= OMAP_MCPDM_FORMATS
,
490 .rates
= OMAP_MCPDM_RATES
,
491 .formats
= OMAP_MCPDM_FORMATS
,
494 .ops
= &omap_mcpdm_dai_ops
,
497 static const struct snd_soc_component_driver omap_mcpdm_component
= {
498 .name
= "omap-mcpdm",
501 void omap_mcpdm_configure_dn_offsets(struct snd_soc_pcm_runtime
*rtd
,
504 struct omap_mcpdm
*mcpdm
= snd_soc_dai_get_drvdata(rtd
->cpu_dai
);
506 mcpdm
->dn_rx_offset
= MCPDM_DNOFST_RX1(rx1
) | MCPDM_DNOFST_RX2(rx2
);
508 EXPORT_SYMBOL_GPL(omap_mcpdm_configure_dn_offsets
);
510 static int asoc_mcpdm_probe(struct platform_device
*pdev
)
512 struct omap_mcpdm
*mcpdm
;
513 struct resource
*res
;
516 mcpdm
= devm_kzalloc(&pdev
->dev
, sizeof(struct omap_mcpdm
), GFP_KERNEL
);
520 platform_set_drvdata(pdev
, mcpdm
);
522 mutex_init(&mcpdm
->mutex
);
524 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "dma");
528 mcpdm
->dma_data
[0].addr
= res
->start
+ MCPDM_REG_DN_DATA
;
529 mcpdm
->dma_data
[1].addr
= res
->start
+ MCPDM_REG_UP_DATA
;
531 mcpdm
->dma_data
[0].filter_data
= "dn_link";
532 mcpdm
->dma_data
[1].filter_data
= "up_link";
534 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "mpu");
535 mcpdm
->io_base
= devm_ioremap_resource(&pdev
->dev
, res
);
536 if (IS_ERR(mcpdm
->io_base
))
537 return PTR_ERR(mcpdm
->io_base
);
539 mcpdm
->irq
= platform_get_irq(pdev
, 0);
543 mcpdm
->dev
= &pdev
->dev
;
545 ret
= devm_snd_soc_register_component(&pdev
->dev
,
546 &omap_mcpdm_component
,
551 return omap_pcm_platform_register(&pdev
->dev
);
554 static const struct of_device_id omap_mcpdm_of_match
[] = {
555 { .compatible
= "ti,omap4-mcpdm", },
558 MODULE_DEVICE_TABLE(of
, omap_mcpdm_of_match
);
560 static struct platform_driver asoc_mcpdm_driver
= {
562 .name
= "omap-mcpdm",
563 .of_match_table
= omap_mcpdm_of_match
,
566 .probe
= asoc_mcpdm_probe
,
569 module_platform_driver(asoc_mcpdm_driver
);
571 MODULE_ALIAS("platform:omap-mcpdm");
572 MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");
573 MODULE_DESCRIPTION("OMAP PDM SoC Interface");
574 MODULE_LICENSE("GPL");