2 * omap-dmic.c -- OMAP ASoC DMIC DAI driver
4 * Copyright (C) 2010 - 2011 Texas Instruments
6 * Author: David Lambert <dlambert@ti.com>
7 * Misael Lopez Cruz <misael.lopez@ti.com>
8 * Liam Girdwood <lrg@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/err.h>
31 #include <linux/clk.h>
33 #include <linux/slab.h>
34 #include <linux/pm_runtime.h>
37 #include <sound/core.h>
38 #include <sound/pcm.h>
39 #include <sound/pcm_params.h>
40 #include <sound/initval.h>
41 #include <sound/soc.h>
44 #include "omap-dmic.h"
48 void __iomem *io_base;
61 * Stream DMA parameters
63 static struct omap_pcm_dma_data omap_dmic_dai_dma_params = {
64 .name = "DMIC capture",
65 .data_type = OMAP_DMA_DATA_TYPE_S32,
66 .sync_mode = OMAP_DMA_SYNC_PACKET,
69 static inline void omap_dmic_write(struct omap_dmic *dmic, u16 reg, u32 val)
71 __raw_writel(val, dmic->io_base + reg);
74 static inline int omap_dmic_read(struct omap_dmic *dmic, u16 reg)
76 return __raw_readl(dmic->io_base + reg);
79 static inline void omap_dmic_start(struct omap_dmic *dmic)
81 u32 ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
83 /* Configure DMA controller */
84 omap_dmic_write(dmic, OMAP_DMIC_DMAENABLE_SET_REG,
85 OMAP_DMIC_DMA_ENABLE);
87 omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, ctrl | dmic->ch_enabled);
90 static inline void omap_dmic_stop(struct omap_dmic *dmic)
92 u32 ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
93 omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG,
94 ctrl & ~OMAP_DMIC_UP_ENABLE_MASK);
96 /* Disable DMA request generation */
97 omap_dmic_write(dmic, OMAP_DMIC_DMAENABLE_CLR_REG,
98 OMAP_DMIC_DMA_ENABLE);
102 static inline int dmic_is_enabled(struct omap_dmic *dmic)
104 return omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG) &
105 OMAP_DMIC_UP_ENABLE_MASK;
108 static int omap_dmic_dai_startup(struct snd_pcm_substream *substream,
109 struct snd_soc_dai *dai)
111 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
114 mutex_lock(&dmic->mutex);
117 snd_pcm_hw_constraint_msbits(substream->runtime, 0, 32, 24);
123 mutex_unlock(&dmic->mutex);
128 static void omap_dmic_dai_shutdown(struct snd_pcm_substream *substream,
129 struct snd_soc_dai *dai)
131 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
133 mutex_lock(&dmic->mutex);
138 mutex_unlock(&dmic->mutex);
141 static int omap_dmic_select_divider(struct omap_dmic *dmic, int sample_rate)
143 int divider = -EINVAL;
146 * 192KHz rate is only supported with 19.2MHz/3.84MHz clock
149 if (sample_rate == 192000) {
150 if (dmic->fclk_freq == 19200000 && dmic->out_freq == 3840000)
151 divider = 0x6; /* Divider: 5 (192KHz sampling rate) */
154 "invalid clock configuration for 192KHz\n");
159 switch (dmic->out_freq) {
161 if (dmic->fclk_freq != 24576000)
163 divider = 0x4; /* Divider: 16 */
166 switch (dmic->fclk_freq) {
168 divider = 0x5; /* Divider: 5 */
171 divider = 0x0; /* Divider: 8 */
174 divider = 0x2; /* Divider: 10 */
181 if (dmic->fclk_freq != 24576000)
183 divider = 0x3; /* Divider: 8 */
186 if (dmic->fclk_freq != 19200000)
188 divider = 0x1; /* Divider: 5 (96KHz sampling rate) */
191 dev_err(dmic->dev, "invalid out frequency: %dHz\n",
199 dev_err(dmic->dev, "invalid out frequency %dHz for %dHz input\n",
200 dmic->out_freq, dmic->fclk_freq);
204 static int omap_dmic_dai_hw_params(struct snd_pcm_substream *substream,
205 struct snd_pcm_hw_params *params,
206 struct snd_soc_dai *dai)
208 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
211 dmic->clk_div = omap_dmic_select_divider(dmic, params_rate(params));
212 if (dmic->clk_div < 0) {
213 dev_err(dmic->dev, "no valid divider for %dHz from %dHz\n",
214 dmic->out_freq, dmic->fclk_freq);
218 dmic->ch_enabled = 0;
219 channels = params_channels(params);
222 dmic->ch_enabled |= OMAP_DMIC_UP3_ENABLE;
224 dmic->ch_enabled |= OMAP_DMIC_UP2_ENABLE;
226 dmic->ch_enabled |= OMAP_DMIC_UP1_ENABLE;
229 dev_err(dmic->dev, "invalid number of legacy channels\n");
233 /* packet size is threshold * channels */
234 omap_dmic_dai_dma_params.packet_size = dmic->threshold * channels;
235 snd_soc_dai_set_dma_data(dai, substream, &omap_dmic_dai_dma_params);
240 static int omap_dmic_dai_prepare(struct snd_pcm_substream *substream,
241 struct snd_soc_dai *dai)
243 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
246 /* Configure uplink threshold */
247 omap_dmic_write(dmic, OMAP_DMIC_FIFO_CTRL_REG, dmic->threshold);
249 ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
251 /* Set dmic out format */
252 ctrl &= ~(OMAP_DMIC_FORMAT | OMAP_DMIC_POLAR_MASK);
253 ctrl |= (OMAP_DMICOUTFORMAT_LJUST | OMAP_DMIC_POLAR1 |
254 OMAP_DMIC_POLAR2 | OMAP_DMIC_POLAR3);
256 /* Configure dmic clock divider */
257 ctrl &= ~OMAP_DMIC_CLK_DIV_MASK;
258 ctrl |= OMAP_DMIC_CLK_DIV(dmic->clk_div);
260 omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, ctrl);
262 omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG,
263 ctrl | OMAP_DMICOUTFORMAT_LJUST | OMAP_DMIC_POLAR1 |
264 OMAP_DMIC_POLAR2 | OMAP_DMIC_POLAR3);
269 static int omap_dmic_dai_trigger(struct snd_pcm_substream *substream,
270 int cmd, struct snd_soc_dai *dai)
272 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
275 case SNDRV_PCM_TRIGGER_START:
276 omap_dmic_start(dmic);
278 case SNDRV_PCM_TRIGGER_STOP:
279 omap_dmic_stop(dmic);
288 static int omap_dmic_select_fclk(struct omap_dmic *dmic, int clk_id,
291 struct clk *parent_clk;
292 char *parent_clk_name;
302 dev_err(dmic->dev, "invalid input frequency: %dHz\n", freq);
307 if (dmic->sysclk == clk_id) {
308 dmic->fclk_freq = freq;
312 /* re-parent not allowed if a stream is ongoing */
313 if (dmic->active && dmic_is_enabled(dmic)) {
314 dev_err(dmic->dev, "can't re-parent when DMIC active\n");
319 case OMAP_DMIC_SYSCLK_PAD_CLKS:
320 parent_clk_name = "pad_clks_ck";
322 case OMAP_DMIC_SYSCLK_SLIMBLUS_CLKS:
323 parent_clk_name = "slimbus_clk";
325 case OMAP_DMIC_SYSCLK_SYNC_MUX_CLKS:
326 parent_clk_name = "dmic_sync_mux_ck";
329 dev_err(dmic->dev, "fclk clk_id (%d) not supported\n", clk_id);
333 parent_clk = clk_get(dmic->dev, parent_clk_name);
334 if (IS_ERR(parent_clk)) {
335 dev_err(dmic->dev, "can't get %s\n", parent_clk_name);
339 mutex_lock(&dmic->mutex);
341 /* disable clock while reparenting */
342 pm_runtime_put_sync(dmic->dev);
343 ret = clk_set_parent(dmic->fclk, parent_clk);
344 pm_runtime_get_sync(dmic->dev);
346 ret = clk_set_parent(dmic->fclk, parent_clk);
348 mutex_unlock(&dmic->mutex);
351 dev_err(dmic->dev, "re-parent failed\n");
355 dmic->sysclk = clk_id;
356 dmic->fclk_freq = freq;
364 static int omap_dmic_select_outclk(struct omap_dmic *dmic, int clk_id,
369 if (clk_id != OMAP_DMIC_ABE_DMIC_CLK) {
370 dev_err(dmic->dev, "output clk_id (%d) not supported\n",
380 dmic->out_freq = freq;
383 dev_err(dmic->dev, "invalid out frequency: %dHz\n", freq);
391 static int omap_dmic_set_dai_sysclk(struct snd_soc_dai *dai, int clk_id,
392 unsigned int freq, int dir)
394 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
396 if (dir == SND_SOC_CLOCK_IN)
397 return omap_dmic_select_fclk(dmic, clk_id, freq);
398 else if (dir == SND_SOC_CLOCK_OUT)
399 return omap_dmic_select_outclk(dmic, clk_id, freq);
401 dev_err(dmic->dev, "invalid clock direction (%d)\n", dir);
405 static const struct snd_soc_dai_ops omap_dmic_dai_ops = {
406 .startup = omap_dmic_dai_startup,
407 .shutdown = omap_dmic_dai_shutdown,
408 .hw_params = omap_dmic_dai_hw_params,
409 .prepare = omap_dmic_dai_prepare,
410 .trigger = omap_dmic_dai_trigger,
411 .set_sysclk = omap_dmic_set_dai_sysclk,
414 static int omap_dmic_probe(struct snd_soc_dai *dai)
416 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
418 pm_runtime_enable(dmic->dev);
420 /* Disable lines while request is ongoing */
421 pm_runtime_get_sync(dmic->dev);
422 omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, 0x00);
423 pm_runtime_put_sync(dmic->dev);
425 /* Configure DMIC threshold value */
426 dmic->threshold = OMAP_DMIC_THRES_MAX - 3;
430 static int omap_dmic_remove(struct snd_soc_dai *dai)
432 struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
434 pm_runtime_disable(dmic->dev);
439 static struct snd_soc_dai_driver omap_dmic_dai = {
441 .probe = omap_dmic_probe,
442 .remove = omap_dmic_remove,
446 .rates = SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_192000,
447 .formats = SNDRV_PCM_FMTBIT_S32_LE,
449 .ops = &omap_dmic_dai_ops,
452 static __devinit int asoc_dmic_probe(struct platform_device *pdev)
454 struct omap_dmic *dmic;
455 struct resource *res;
458 dmic = devm_kzalloc(&pdev->dev, sizeof(struct omap_dmic), GFP_KERNEL);
462 platform_set_drvdata(pdev, dmic);
463 dmic->dev = &pdev->dev;
464 dmic->sysclk = OMAP_DMIC_SYSCLK_SYNC_MUX_CLKS;
466 mutex_init(&dmic->mutex);
468 dmic->fclk = clk_get(dmic->dev, "dmic_fck");
469 if (IS_ERR(dmic->fclk)) {
470 dev_err(dmic->dev, "cant get dmic_fck\n");
474 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dma");
476 dev_err(dmic->dev, "invalid dma memory resource\n");
480 omap_dmic_dai_dma_params.port_addr = res->start + OMAP_DMIC_DATA_REG;
482 res = platform_get_resource(pdev, IORESOURCE_DMA, 0);
484 dev_err(dmic->dev, "invalid dma resource\n");
488 omap_dmic_dai_dma_params.dma_req = res->start;
490 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mpu");
492 dev_err(dmic->dev, "invalid memory resource\n");
497 if (!devm_request_mem_region(&pdev->dev, res->start,
498 resource_size(res), pdev->name)) {
499 dev_err(dmic->dev, "memory region already claimed\n");
504 dmic->io_base = devm_ioremap(&pdev->dev, res->start,
506 if (!dmic->io_base) {
511 ret = snd_soc_register_dai(&pdev->dev, &omap_dmic_dai);
522 static int __devexit asoc_dmic_remove(struct platform_device *pdev)
524 struct omap_dmic *dmic = platform_get_drvdata(pdev);
526 snd_soc_unregister_dai(&pdev->dev);
532 static struct platform_driver asoc_dmic_driver = {
535 .owner = THIS_MODULE,
537 .probe = asoc_dmic_probe,
538 .remove = __devexit_p(asoc_dmic_remove),
541 module_platform_driver(asoc_dmic_driver);
543 MODULE_ALIAS("platform:omap-dmic");
544 MODULE_AUTHOR("Peter Ujfalusi <peter.ujfalusi@ti.com>");
545 MODULE_DESCRIPTION("OMAP DMIC ASoC Interface");
546 MODULE_LICENSE("GPL");