Linux Audio

Check our new training course

Loading...
Note: File does not exist in v6.13.7.
  1/*
  2 * omap-dmic.c  --  OMAP ASoC DMIC DAI driver
  3 *
  4 * Copyright (C) 2010 - 2011 Texas Instruments
  5 *
  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>
 10 *
 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.
 14 *
 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.
 19 *
 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
 23 * 02110-1301 USA
 24 *
 25 */
 26
 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>
 32#include <linux/io.h>
 33#include <linux/slab.h>
 34#include <linux/pm_runtime.h>
 35#include <linux/of_device.h>
 36
 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>
 42#include <sound/dmaengine_pcm.h>
 43#include <sound/omap-pcm.h>
 44
 45#include "omap-dmic.h"
 46
 47struct omap_dmic {
 48	struct device *dev;
 49	void __iomem *io_base;
 50	struct clk *fclk;
 51	int fclk_freq;
 52	int out_freq;
 53	int clk_div;
 54	int sysclk;
 55	int threshold;
 56	u32 ch_enabled;
 57	bool active;
 58	struct mutex mutex;
 59
 60	struct snd_dmaengine_dai_dma_data dma_data;
 61};
 62
 63static inline void omap_dmic_write(struct omap_dmic *dmic, u16 reg, u32 val)
 64{
 65	writel_relaxed(val, dmic->io_base + reg);
 66}
 67
 68static inline int omap_dmic_read(struct omap_dmic *dmic, u16 reg)
 69{
 70	return readl_relaxed(dmic->io_base + reg);
 71}
 72
 73static inline void omap_dmic_start(struct omap_dmic *dmic)
 74{
 75	u32 ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
 76
 77	/* Configure DMA controller */
 78	omap_dmic_write(dmic, OMAP_DMIC_DMAENABLE_SET_REG,
 79			OMAP_DMIC_DMA_ENABLE);
 80
 81	omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, ctrl | dmic->ch_enabled);
 82}
 83
 84static inline void omap_dmic_stop(struct omap_dmic *dmic)
 85{
 86	u32 ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
 87	omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG,
 88			ctrl & ~OMAP_DMIC_UP_ENABLE_MASK);
 89
 90	/* Disable DMA request generation */
 91	omap_dmic_write(dmic, OMAP_DMIC_DMAENABLE_CLR_REG,
 92			OMAP_DMIC_DMA_ENABLE);
 93
 94}
 95
 96static inline int dmic_is_enabled(struct omap_dmic *dmic)
 97{
 98	return omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG) &
 99						OMAP_DMIC_UP_ENABLE_MASK;
100}
101
102static int omap_dmic_dai_startup(struct snd_pcm_substream *substream,
103				  struct snd_soc_dai *dai)
104{
105	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
106	int ret = 0;
107
108	mutex_lock(&dmic->mutex);
109
110	if (!dai->active)
111		dmic->active = 1;
112	else
113		ret = -EBUSY;
114
115	mutex_unlock(&dmic->mutex);
116
117	return ret;
118}
119
120static void omap_dmic_dai_shutdown(struct snd_pcm_substream *substream,
121				    struct snd_soc_dai *dai)
122{
123	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
124
125	mutex_lock(&dmic->mutex);
126
127	if (!dai->active)
128		dmic->active = 0;
129
130	mutex_unlock(&dmic->mutex);
131}
132
133static int omap_dmic_select_divider(struct omap_dmic *dmic, int sample_rate)
134{
135	int divider = -EINVAL;
136
137	/*
138	 * 192KHz rate is only supported with 19.2MHz/3.84MHz clock
139	 * configuration.
140	 */
141	if (sample_rate == 192000) {
142		if (dmic->fclk_freq == 19200000 && dmic->out_freq == 3840000)
143			divider = 0x6; /* Divider: 5 (192KHz sampling rate) */
144		else
145			dev_err(dmic->dev,
146				"invalid clock configuration for 192KHz\n");
147
148		return divider;
149	}
150
151	switch (dmic->out_freq) {
152	case 1536000:
153		if (dmic->fclk_freq != 24576000)
154			goto div_err;
155		divider = 0x4; /* Divider: 16 */
156		break;
157	case 2400000:
158		switch (dmic->fclk_freq) {
159		case 12000000:
160			divider = 0x5; /* Divider: 5 */
161			break;
162		case 19200000:
163			divider = 0x0; /* Divider: 8 */
164			break;
165		case 24000000:
166			divider = 0x2; /* Divider: 10 */
167			break;
168		default:
169			goto div_err;
170		}
171		break;
172	case 3072000:
173		if (dmic->fclk_freq != 24576000)
174			goto div_err;
175		divider = 0x3; /* Divider: 8 */
176		break;
177	case 3840000:
178		if (dmic->fclk_freq != 19200000)
179			goto div_err;
180		divider = 0x1; /* Divider: 5 (96KHz sampling rate) */
181		break;
182	default:
183		dev_err(dmic->dev, "invalid out frequency: %dHz\n",
184			dmic->out_freq);
185		break;
186	}
187
188	return divider;
189
190div_err:
191	dev_err(dmic->dev, "invalid out frequency %dHz for %dHz input\n",
192		dmic->out_freq, dmic->fclk_freq);
193	return -EINVAL;
194}
195
196static int omap_dmic_dai_hw_params(struct snd_pcm_substream *substream,
197				    struct snd_pcm_hw_params *params,
198				    struct snd_soc_dai *dai)
199{
200	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
201	struct snd_dmaengine_dai_dma_data *dma_data;
202	int channels;
203
204	dmic->clk_div = omap_dmic_select_divider(dmic, params_rate(params));
205	if (dmic->clk_div < 0) {
206		dev_err(dmic->dev, "no valid divider for %dHz from %dHz\n",
207			dmic->out_freq, dmic->fclk_freq);
208		return -EINVAL;
209	}
210
211	dmic->ch_enabled = 0;
212	channels = params_channels(params);
213	switch (channels) {
214	case 6:
215		dmic->ch_enabled |= OMAP_DMIC_UP3_ENABLE;
216	case 4:
217		dmic->ch_enabled |= OMAP_DMIC_UP2_ENABLE;
218	case 2:
219		dmic->ch_enabled |= OMAP_DMIC_UP1_ENABLE;
220		break;
221	default:
222		dev_err(dmic->dev, "invalid number of legacy channels\n");
223		return -EINVAL;
224	}
225
226	/* packet size is threshold * channels */
227	dma_data = snd_soc_dai_get_dma_data(dai, substream);
228	dma_data->maxburst = dmic->threshold * channels;
229
230	return 0;
231}
232
233static int omap_dmic_dai_prepare(struct snd_pcm_substream *substream,
234				  struct snd_soc_dai *dai)
235{
236	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
237	u32 ctrl;
238
239	/* Configure uplink threshold */
240	omap_dmic_write(dmic, OMAP_DMIC_FIFO_CTRL_REG, dmic->threshold);
241
242	ctrl = omap_dmic_read(dmic, OMAP_DMIC_CTRL_REG);
243
244	/* Set dmic out format */
245	ctrl &= ~(OMAP_DMIC_FORMAT | OMAP_DMIC_POLAR_MASK);
246	ctrl |= (OMAP_DMICOUTFORMAT_LJUST | OMAP_DMIC_POLAR1 |
247		 OMAP_DMIC_POLAR2 | OMAP_DMIC_POLAR3);
248
249	/* Configure dmic clock divider */
250	ctrl &= ~OMAP_DMIC_CLK_DIV_MASK;
251	ctrl |= OMAP_DMIC_CLK_DIV(dmic->clk_div);
252
253	omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, ctrl);
254
255	omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG,
256			ctrl | OMAP_DMICOUTFORMAT_LJUST | OMAP_DMIC_POLAR1 |
257			OMAP_DMIC_POLAR2 | OMAP_DMIC_POLAR3);
258
259	return 0;
260}
261
262static int omap_dmic_dai_trigger(struct snd_pcm_substream *substream,
263				  int cmd, struct snd_soc_dai *dai)
264{
265	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
266
267	switch (cmd) {
268	case SNDRV_PCM_TRIGGER_START:
269		omap_dmic_start(dmic);
270		break;
271	case SNDRV_PCM_TRIGGER_STOP:
272		omap_dmic_stop(dmic);
273		break;
274	default:
275		break;
276	}
277
278	return 0;
279}
280
281static int omap_dmic_select_fclk(struct omap_dmic *dmic, int clk_id,
282				 unsigned int freq)
283{
284	struct clk *parent_clk, *mux;
285	char *parent_clk_name;
286	int ret = 0;
287
288	switch (freq) {
289	case 12000000:
290	case 19200000:
291	case 24000000:
292	case 24576000:
293		break;
294	default:
295		dev_err(dmic->dev, "invalid input frequency: %dHz\n", freq);
296		dmic->fclk_freq = 0;
297		return -EINVAL;
298	}
299
300	if (dmic->sysclk == clk_id) {
301		dmic->fclk_freq = freq;
302		return 0;
303	}
304
305	/* re-parent not allowed if a stream is ongoing */
306	if (dmic->active && dmic_is_enabled(dmic)) {
307		dev_err(dmic->dev, "can't re-parent when DMIC active\n");
308		return -EBUSY;
309	}
310
311	switch (clk_id) {
312	case OMAP_DMIC_SYSCLK_PAD_CLKS:
313		parent_clk_name = "pad_clks_ck";
314		break;
315	case OMAP_DMIC_SYSCLK_SLIMBLUS_CLKS:
316		parent_clk_name = "slimbus_clk";
317		break;
318	case OMAP_DMIC_SYSCLK_SYNC_MUX_CLKS:
319		parent_clk_name = "dmic_sync_mux_ck";
320		break;
321	default:
322		dev_err(dmic->dev, "fclk clk_id (%d) not supported\n", clk_id);
323		return -EINVAL;
324	}
325
326	parent_clk = clk_get(dmic->dev, parent_clk_name);
327	if (IS_ERR(parent_clk)) {
328		dev_err(dmic->dev, "can't get %s\n", parent_clk_name);
329		return -ENODEV;
330	}
331
332	mux = clk_get_parent(dmic->fclk);
333	if (IS_ERR(mux)) {
334		dev_err(dmic->dev, "can't get fck mux parent\n");
335		clk_put(parent_clk);
336		return -ENODEV;
337	}
338
339	mutex_lock(&dmic->mutex);
340	if (dmic->active) {
341		/* disable clock while reparenting */
342		pm_runtime_put_sync(dmic->dev);
343		ret = clk_set_parent(mux, parent_clk);
344		pm_runtime_get_sync(dmic->dev);
345	} else {
346		ret = clk_set_parent(mux, parent_clk);
347	}
348	mutex_unlock(&dmic->mutex);
349
350	if (ret < 0) {
351		dev_err(dmic->dev, "re-parent failed\n");
352		goto err_busy;
353	}
354
355	dmic->sysclk = clk_id;
356	dmic->fclk_freq = freq;
357
358err_busy:
359	clk_put(mux);
360	clk_put(parent_clk);
361
362	return ret;
363}
364
365static int omap_dmic_select_outclk(struct omap_dmic *dmic, int clk_id,
366				    unsigned int freq)
367{
368	int ret = 0;
369
370	if (clk_id != OMAP_DMIC_ABE_DMIC_CLK) {
371		dev_err(dmic->dev, "output clk_id (%d) not supported\n",
372			clk_id);
373		return -EINVAL;
374	}
375
376	switch (freq) {
377	case 1536000:
378	case 2400000:
379	case 3072000:
380	case 3840000:
381		dmic->out_freq = freq;
382		break;
383	default:
384		dev_err(dmic->dev, "invalid out frequency: %dHz\n", freq);
385		dmic->out_freq = 0;
386		ret = -EINVAL;
387	}
388
389	return ret;
390}
391
392static int omap_dmic_set_dai_sysclk(struct snd_soc_dai *dai, int clk_id,
393				    unsigned int freq, int dir)
394{
395	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
396
397	if (dir == SND_SOC_CLOCK_IN)
398		return omap_dmic_select_fclk(dmic, clk_id, freq);
399	else if (dir == SND_SOC_CLOCK_OUT)
400		return omap_dmic_select_outclk(dmic, clk_id, freq);
401
402	dev_err(dmic->dev, "invalid clock direction (%d)\n", dir);
403	return -EINVAL;
404}
405
406static const struct snd_soc_dai_ops omap_dmic_dai_ops = {
407	.startup	= omap_dmic_dai_startup,
408	.shutdown	= omap_dmic_dai_shutdown,
409	.hw_params	= omap_dmic_dai_hw_params,
410	.prepare	= omap_dmic_dai_prepare,
411	.trigger	= omap_dmic_dai_trigger,
412	.set_sysclk	= omap_dmic_set_dai_sysclk,
413};
414
415static int omap_dmic_probe(struct snd_soc_dai *dai)
416{
417	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
418
419	pm_runtime_enable(dmic->dev);
420
421	/* Disable lines while request is ongoing */
422	pm_runtime_get_sync(dmic->dev);
423	omap_dmic_write(dmic, OMAP_DMIC_CTRL_REG, 0x00);
424	pm_runtime_put_sync(dmic->dev);
425
426	/* Configure DMIC threshold value */
427	dmic->threshold = OMAP_DMIC_THRES_MAX - 3;
428
429	snd_soc_dai_init_dma_data(dai, NULL, &dmic->dma_data);
430
431	return 0;
432}
433
434static int omap_dmic_remove(struct snd_soc_dai *dai)
435{
436	struct omap_dmic *dmic = snd_soc_dai_get_drvdata(dai);
437
438	pm_runtime_disable(dmic->dev);
439
440	return 0;
441}
442
443static struct snd_soc_dai_driver omap_dmic_dai = {
444	.name = "omap-dmic",
445	.probe = omap_dmic_probe,
446	.remove = omap_dmic_remove,
447	.capture = {
448		.channels_min = 2,
449		.channels_max = 6,
450		.rates = SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_192000,
451		.formats = SNDRV_PCM_FMTBIT_S32_LE,
452		.sig_bits = 24,
453	},
454	.ops = &omap_dmic_dai_ops,
455};
456
457static const struct snd_soc_component_driver omap_dmic_component = {
458	.name		= "omap-dmic",
459};
460
461static int asoc_dmic_probe(struct platform_device *pdev)
462{
463	struct omap_dmic *dmic;
464	struct resource *res;
465	int ret;
466
467	dmic = devm_kzalloc(&pdev->dev, sizeof(struct omap_dmic), GFP_KERNEL);
468	if (!dmic)
469		return -ENOMEM;
470
471	platform_set_drvdata(pdev, dmic);
472	dmic->dev = &pdev->dev;
473	dmic->sysclk = OMAP_DMIC_SYSCLK_SYNC_MUX_CLKS;
474
475	mutex_init(&dmic->mutex);
476
477	dmic->fclk = devm_clk_get(dmic->dev, "fck");
478	if (IS_ERR(dmic->fclk)) {
479		dev_err(dmic->dev, "cant get fck\n");
480		return -ENODEV;
481	}
482
483	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dma");
484	if (!res) {
485		dev_err(dmic->dev, "invalid dma memory resource\n");
486		return -ENODEV;
487	}
488	dmic->dma_data.addr = res->start + OMAP_DMIC_DATA_REG;
489
490	dmic->dma_data.filter_data = "up_link";
491
492	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mpu");
493	dmic->io_base = devm_ioremap_resource(&pdev->dev, res);
494	if (IS_ERR(dmic->io_base))
495		return PTR_ERR(dmic->io_base);
496
497
498	ret = devm_snd_soc_register_component(&pdev->dev,
499					      &omap_dmic_component,
500					      &omap_dmic_dai, 1);
501	if (ret)
502		return ret;
503
504	ret = omap_pcm_platform_register(&pdev->dev);
505	if (ret)
506		return ret;
507
508	return 0;
509}
510
511static const struct of_device_id omap_dmic_of_match[] = {
512	{ .compatible = "ti,omap4-dmic", },
513	{ }
514};
515MODULE_DEVICE_TABLE(of, omap_dmic_of_match);
516
517static struct platform_driver asoc_dmic_driver = {
518	.driver = {
519		.name = "omap-dmic",
520		.of_match_table = omap_dmic_of_match,
521	},
522	.probe = asoc_dmic_probe,
523};
524
525module_platform_driver(asoc_dmic_driver);
526
527MODULE_ALIAS("platform:omap-dmic");
528MODULE_AUTHOR("Peter Ujfalusi <peter.ujfalusi@ti.com>");
529MODULE_DESCRIPTION("OMAP DMIC ASoC Interface");
530MODULE_LICENSE("GPL");