xref: /openbmc/linux/sound/soc/atmel/atmel-pdmic.c (revision 85250a24)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Atmel PDMIC driver
3  *
4  * Copyright (C) 2015 Atmel
5  *
6  * Author: Songjun Wu <songjun.wu@atmel.com>
7  */
8 
9 #include <linux/of.h>
10 #include <linux/clk.h>
11 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/regmap.h>
14 #include <sound/core.h>
15 #include <sound/dmaengine_pcm.h>
16 #include <sound/pcm_params.h>
17 #include <sound/tlv.h>
18 #include "atmel-pdmic.h"
19 
20 struct atmel_pdmic_pdata {
21 	u32 mic_min_freq;
22 	u32 mic_max_freq;
23 	s32 mic_offset;
24 	const char *card_name;
25 };
26 
27 struct atmel_pdmic {
28 	dma_addr_t phy_base;
29 	struct regmap *regmap;
30 	struct clk *pclk;
31 	struct clk *gclk;
32 	struct device *dev;
33 	int irq;
34 	struct snd_pcm_substream *substream;
35 	const struct atmel_pdmic_pdata *pdata;
36 };
37 
38 static const struct of_device_id atmel_pdmic_of_match[] = {
39 	{
40 		.compatible = "atmel,sama5d2-pdmic",
41 	}, {
42 		/* sentinel */
43 	}
44 };
45 MODULE_DEVICE_TABLE(of, atmel_pdmic_of_match);
46 
47 #define PDMIC_OFFSET_MAX_VAL	S16_MAX
48 #define PDMIC_OFFSET_MIN_VAL	S16_MIN
49 
50 static struct atmel_pdmic_pdata *atmel_pdmic_dt_init(struct device *dev)
51 {
52 	struct device_node *np = dev->of_node;
53 	struct atmel_pdmic_pdata *pdata;
54 
55 	if (!np) {
56 		dev_err(dev, "device node not found\n");
57 		return ERR_PTR(-EINVAL);
58 	}
59 
60 	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
61 	if (!pdata)
62 		return ERR_PTR(-ENOMEM);
63 
64 	if (of_property_read_string(np, "atmel,model", &pdata->card_name))
65 		pdata->card_name = "PDMIC";
66 
67 	if (of_property_read_u32(np, "atmel,mic-min-freq",
68 				 &pdata->mic_min_freq)) {
69 		dev_err(dev, "failed to get mic-min-freq\n");
70 		return ERR_PTR(-EINVAL);
71 	}
72 
73 	if (of_property_read_u32(np, "atmel,mic-max-freq",
74 				 &pdata->mic_max_freq)) {
75 		dev_err(dev, "failed to get mic-max-freq\n");
76 		return ERR_PTR(-EINVAL);
77 	}
78 
79 	if (pdata->mic_max_freq < pdata->mic_min_freq) {
80 		dev_err(dev,
81 			"mic-max-freq should not be less than mic-min-freq\n");
82 		return ERR_PTR(-EINVAL);
83 	}
84 
85 	if (of_property_read_s32(np, "atmel,mic-offset", &pdata->mic_offset))
86 		pdata->mic_offset = 0;
87 
88 	if (pdata->mic_offset > PDMIC_OFFSET_MAX_VAL) {
89 		dev_warn(dev,
90 			 "mic-offset value %d is larger than the max value %d, the max value is specified\n",
91 			 pdata->mic_offset, PDMIC_OFFSET_MAX_VAL);
92 		pdata->mic_offset = PDMIC_OFFSET_MAX_VAL;
93 	} else if (pdata->mic_offset < PDMIC_OFFSET_MIN_VAL) {
94 		dev_warn(dev,
95 			 "mic-offset value %d is less than the min value %d, the min value is specified\n",
96 			 pdata->mic_offset, PDMIC_OFFSET_MIN_VAL);
97 		pdata->mic_offset = PDMIC_OFFSET_MIN_VAL;
98 	}
99 
100 	return pdata;
101 }
102 
103 /* cpu dai component */
104 static int atmel_pdmic_cpu_dai_startup(struct snd_pcm_substream *substream,
105 					struct snd_soc_dai *cpu_dai)
106 {
107 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
108 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(rtd->card);
109 	int ret;
110 
111 	ret = clk_prepare_enable(dd->gclk);
112 	if (ret)
113 		return ret;
114 
115 	ret =  clk_prepare_enable(dd->pclk);
116 	if (ret) {
117 		clk_disable_unprepare(dd->gclk);
118 		return ret;
119 	}
120 
121 	/* Clear all bits in the Control Register(PDMIC_CR) */
122 	regmap_write(dd->regmap, PDMIC_CR, 0);
123 
124 	dd->substream = substream;
125 
126 	/* Enable the overrun error interrupt */
127 	regmap_write(dd->regmap, PDMIC_IER, PDMIC_IER_OVRE);
128 
129 	return 0;
130 }
131 
132 static void atmel_pdmic_cpu_dai_shutdown(struct snd_pcm_substream *substream,
133 					struct snd_soc_dai *cpu_dai)
134 {
135 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
136 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(rtd->card);
137 
138 	/* Disable the overrun error interrupt */
139 	regmap_write(dd->regmap, PDMIC_IDR, PDMIC_IDR_OVRE);
140 
141 	clk_disable_unprepare(dd->gclk);
142 	clk_disable_unprepare(dd->pclk);
143 }
144 
145 static int atmel_pdmic_cpu_dai_prepare(struct snd_pcm_substream *substream,
146 					struct snd_soc_dai *cpu_dai)
147 {
148 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
149 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(rtd->card);
150 	struct snd_soc_component *component = cpu_dai->component;
151 	u32 val;
152 	int ret;
153 
154 	/* Clean the PDMIC Converted Data Register */
155 	ret = regmap_read(dd->regmap, PDMIC_CDR, &val);
156 	if (ret < 0)
157 		return 0;
158 
159 	ret = snd_soc_component_update_bits(component, PDMIC_CR,
160 					    PDMIC_CR_ENPDM_MASK,
161 					    PDMIC_CR_ENPDM_DIS <<
162 					    PDMIC_CR_ENPDM_SHIFT);
163 	if (ret < 0)
164 		return ret;
165 
166 	return 0;
167 }
168 
169 #define ATMEL_PDMIC_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S32_LE)
170 
171 /* platform */
172 #define ATMEL_PDMIC_MAX_BUF_SIZE  (64 * 1024)
173 #define ATMEL_PDMIC_PREALLOC_BUF_SIZE  ATMEL_PDMIC_MAX_BUF_SIZE
174 
175 static const struct snd_pcm_hardware atmel_pdmic_hw = {
176 	.info			= SNDRV_PCM_INFO_MMAP
177 				| SNDRV_PCM_INFO_MMAP_VALID
178 				| SNDRV_PCM_INFO_INTERLEAVED
179 				| SNDRV_PCM_INFO_RESUME
180 				| SNDRV_PCM_INFO_PAUSE,
181 	.formats		= ATMEL_PDMIC_FORMATS,
182 	.buffer_bytes_max	= ATMEL_PDMIC_MAX_BUF_SIZE,
183 	.period_bytes_min	= 256,
184 	.period_bytes_max	= 32 * 1024,
185 	.periods_min		= 2,
186 	.periods_max		= 256,
187 };
188 
189 static int
190 atmel_pdmic_platform_configure_dma(struct snd_pcm_substream *substream,
191 				struct snd_pcm_hw_params *params,
192 				struct dma_slave_config *slave_config)
193 {
194 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
195 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(rtd->card);
196 	int ret;
197 
198 	ret = snd_hwparams_to_dma_slave_config(substream, params,
199 					       slave_config);
200 	if (ret) {
201 		dev_err(dd->dev,
202 			"hw params to dma slave configure failed\n");
203 		return ret;
204 	}
205 
206 	slave_config->src_addr		= dd->phy_base + PDMIC_CDR;
207 	slave_config->src_maxburst	= 1;
208 	slave_config->dst_maxburst	= 1;
209 
210 	return 0;
211 }
212 
213 static const struct snd_dmaengine_pcm_config
214 atmel_pdmic_dmaengine_pcm_config = {
215 	.prepare_slave_config	= atmel_pdmic_platform_configure_dma,
216 	.pcm_hardware		= &atmel_pdmic_hw,
217 	.prealloc_buffer_size	= ATMEL_PDMIC_PREALLOC_BUF_SIZE,
218 };
219 
220 /* codec */
221 /* Mic Gain = dgain * 2^(-scale) */
222 struct mic_gain {
223 	unsigned int dgain;
224 	unsigned int scale;
225 };
226 
227 /* range from -90 dB to 90 dB */
228 static const struct mic_gain mic_gain_table[] = {
229 {    1, 15}, {    1, 14},                           /* -90, -84 dB */
230 {    3, 15}, {    1, 13}, {    3, 14}, {    1, 12}, /* -81, -78, -75, -72 dB */
231 {    5, 14}, {   13, 15},                           /* -70, -68 dB */
232 {    9, 14}, {   21, 15}, {   23, 15}, {   13, 14}, /* -65 ~ -62 dB */
233 {   29, 15}, {   33, 15}, {   37, 15}, {   41, 15}, /* -61 ~ -58 dB */
234 {   23, 14}, {   13, 13}, {   58, 15}, {   65, 15}, /* -57 ~ -54 dB */
235 {   73, 15}, {   41, 14}, {   23, 13}, {   13, 12}, /* -53 ~ -50 dB */
236 {   29, 13}, {   65, 14}, {   73, 14}, {   41, 13}, /* -49 ~ -46 dB */
237 {   23, 12}, {  207, 15}, {   29, 12}, {   65, 13}, /* -45 ~ -42 dB */
238 {   73, 13}, {   41, 12}, {   23, 11}, {  413, 15}, /* -41 ~ -38 dB */
239 {  463, 15}, {  519, 15}, {  583, 15}, {  327, 14}, /* -37 ~ -34 dB */
240 {  367, 14}, {  823, 15}, {  231, 13}, { 1036, 15}, /* -33 ~ -30 dB */
241 { 1163, 15}, { 1305, 15}, {  183, 12}, { 1642, 15}, /* -29 ~ -26 dB */
242 { 1843, 15}, { 2068, 15}, {  145, 11}, { 2603, 15}, /* -25 ~ -22 dB */
243 {  365, 12}, { 3277, 15}, { 3677, 15}, { 4125, 15}, /* -21 ~ -18 dB */
244 { 4629, 15}, { 5193, 15}, { 5827, 15}, { 3269, 14}, /* -17 ~ -14 dB */
245 {  917, 12}, { 8231, 15}, { 9235, 15}, { 5181, 14}, /* -13 ~ -10 dB */
246 {11627, 15}, {13045, 15}, {14637, 15}, {16423, 15}, /*  -9 ~ -6 dB */
247 {18427, 15}, {20675, 15}, { 5799, 13}, {26029, 15}, /*  -5 ~ -2 dB */
248 { 7301, 13}, {    1,  0}, {18383, 14}, {10313, 13}, /*  -1 ~ 2 dB */
249 {23143, 14}, {25967, 14}, {29135, 14}, {16345, 13}, /*   3 ~ 6 dB */
250 { 4585, 11}, {20577, 13}, { 1443,  9}, {25905, 13}, /*   7 ~ 10 dB */
251 {14533, 12}, { 8153, 11}, { 2287,  9}, {20529, 12}, /*  11 ~ 14 dB */
252 {11517, 11}, { 6461, 10}, {28997, 12}, { 4067,  9}, /*  15 ~ 18 dB */
253 {18253, 11}, {   10,  0}, {22979, 11}, {25783, 11}, /*  19 ~ 22 dB */
254 {28929, 11}, {32459, 11}, { 9105,  9}, {20431, 10}, /*  23 ~ 26 dB */
255 {22925, 10}, {12861,  9}, { 7215,  8}, {16191,  9}, /*  27 ~ 30 dB */
256 { 9083,  8}, {20383,  9}, {11435,  8}, { 6145,  7}, /*  31 ~ 34 dB */
257 { 3599,  6}, {32305,  9}, {18123,  8}, {20335,  8}, /*  35 ~ 38 dB */
258 {  713,  3}, {  100,  0}, { 7181,  6}, { 8057,  6}, /*  39 ~ 42 dB */
259 {  565,  2}, {20287,  7}, {11381,  6}, {25539,  7}, /*  43 ~ 46 dB */
260 { 1791,  3}, { 4019,  4}, { 9019,  5}, {20239,  6}, /*  47 ~ 50 dB */
261 { 5677,  4}, {25479,  6}, { 7147,  4}, { 8019,  4}, /*  51 ~ 54 dB */
262 {17995,  5}, {20191,  5}, {11327,  4}, {12709,  4}, /*  55 ~ 58 dB */
263 { 3565,  2}, { 1000,  0}, { 1122,  0}, { 1259,  0}, /*  59 ~ 62 dB */
264 { 2825,  1}, {12679,  3}, { 7113,  2}, { 7981,  2}, /*  63 ~ 66 dB */
265 { 8955,  2}, {20095,  3}, {22547,  3}, {12649,  2}, /*  67 ~ 70 dB */
266 {28385,  3}, { 3981,  0}, {17867,  2}, {20047,  2}, /*  71 ~ 74 dB */
267 {11247,  1}, {12619,  1}, {14159,  1}, {31773,  2}, /*  75 ~ 78 dB */
268 {17825,  1}, {10000,  0}, {11220,  0}, {12589,  0}, /*  79 ~ 82 dB */
269 {28251,  1}, {15849,  0}, {17783,  0}, {19953,  0}, /*  83 ~ 86 dB */
270 {22387,  0}, {25119,  0}, {28184,  0}, {31623,  0}, /*  87 ~ 90 dB */
271 };
272 
273 static const DECLARE_TLV_DB_RANGE(mic_gain_tlv,
274 	0, 1, TLV_DB_SCALE_ITEM(-9000, 600, 0),
275 	2, 5, TLV_DB_SCALE_ITEM(-8100, 300, 0),
276 	6, 7, TLV_DB_SCALE_ITEM(-7000, 200, 0),
277 	8, ARRAY_SIZE(mic_gain_table)-1, TLV_DB_SCALE_ITEM(-6500, 100, 0),
278 );
279 
280 static int pdmic_get_mic_volsw(struct snd_kcontrol *kcontrol,
281 	struct snd_ctl_elem_value *ucontrol)
282 {
283 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
284 	unsigned int dgain_val, scale_val;
285 	int i;
286 
287 	dgain_val = (snd_soc_component_read(component, PDMIC_DSPR1) & PDMIC_DSPR1_DGAIN_MASK)
288 		    >> PDMIC_DSPR1_DGAIN_SHIFT;
289 
290 	scale_val = (snd_soc_component_read(component, PDMIC_DSPR0) & PDMIC_DSPR0_SCALE_MASK)
291 		    >> PDMIC_DSPR0_SCALE_SHIFT;
292 
293 	for (i = 0; i < ARRAY_SIZE(mic_gain_table); i++) {
294 		if ((mic_gain_table[i].dgain == dgain_val) &&
295 		    (mic_gain_table[i].scale == scale_val))
296 			ucontrol->value.integer.value[0] = i;
297 	}
298 
299 	return 0;
300 }
301 
302 static int pdmic_put_mic_volsw(struct snd_kcontrol *kcontrol,
303 	struct snd_ctl_elem_value *ucontrol)
304 {
305 	struct soc_mixer_control *mc =
306 		(struct soc_mixer_control *)kcontrol->private_value;
307 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
308 	int max = mc->max;
309 	unsigned int val;
310 	int ret;
311 
312 	val = ucontrol->value.integer.value[0];
313 
314 	if (val > max)
315 		return -EINVAL;
316 
317 	ret = snd_soc_component_update_bits(component, PDMIC_DSPR1, PDMIC_DSPR1_DGAIN_MASK,
318 			 mic_gain_table[val].dgain << PDMIC_DSPR1_DGAIN_SHIFT);
319 	if (ret < 0)
320 		return ret;
321 
322 	ret = snd_soc_component_update_bits(component, PDMIC_DSPR0, PDMIC_DSPR0_SCALE_MASK,
323 			 mic_gain_table[val].scale << PDMIC_DSPR0_SCALE_SHIFT);
324 	if (ret < 0)
325 		return ret;
326 
327 	return 0;
328 }
329 
330 static const struct snd_kcontrol_new atmel_pdmic_snd_controls[] = {
331 SOC_SINGLE_EXT_TLV("Mic Capture Volume", PDMIC_DSPR1, PDMIC_DSPR1_DGAIN_SHIFT,
332 		   ARRAY_SIZE(mic_gain_table)-1, 0,
333 		   pdmic_get_mic_volsw, pdmic_put_mic_volsw, mic_gain_tlv),
334 
335 SOC_SINGLE("High Pass Filter Switch", PDMIC_DSPR0,
336 	   PDMIC_DSPR0_HPFBYP_SHIFT, 1, 1),
337 
338 SOC_SINGLE("SINCC Filter Switch", PDMIC_DSPR0, PDMIC_DSPR0_SINBYP_SHIFT, 1, 1),
339 };
340 
341 static int atmel_pdmic_component_probe(struct snd_soc_component *component)
342 {
343 	struct snd_soc_card *card = snd_soc_component_get_drvdata(component);
344 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(card);
345 
346 	snd_soc_component_update_bits(component, PDMIC_DSPR1, PDMIC_DSPR1_OFFSET_MASK,
347 		     (u32)(dd->pdata->mic_offset << PDMIC_DSPR1_OFFSET_SHIFT));
348 
349 	return 0;
350 }
351 
352 #define PDMIC_MR_PRESCAL_MAX_VAL 127
353 
354 static int
355 atmel_pdmic_cpu_dai_hw_params(struct snd_pcm_substream *substream,
356 			      struct snd_pcm_hw_params *params,
357 			      struct snd_soc_dai *cpu_dai)
358 {
359 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
360 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(rtd->card);
361 	struct snd_soc_component *component = cpu_dai->component;
362 	unsigned int rate_min = substream->runtime->hw.rate_min;
363 	unsigned int rate_max = substream->runtime->hw.rate_max;
364 	int fs = params_rate(params);
365 	int bits = params_width(params);
366 	unsigned long pclk_rate, gclk_rate;
367 	unsigned int f_pdmic;
368 	u32 mr_val, dspr0_val, pclk_prescal, gclk_prescal;
369 
370 	if (params_channels(params) != 1) {
371 		dev_err(component->dev,
372 			"only supports one channel\n");
373 		return -EINVAL;
374 	}
375 
376 	if ((fs < rate_min) || (fs > rate_max)) {
377 		dev_err(component->dev,
378 			"sample rate is %dHz, min rate is %dHz, max rate is %dHz\n",
379 			fs, rate_min, rate_max);
380 
381 		return -EINVAL;
382 	}
383 
384 	switch (bits) {
385 	case 16:
386 		dspr0_val = (PDMIC_DSPR0_SIZE_16_BITS
387 			     << PDMIC_DSPR0_SIZE_SHIFT);
388 		break;
389 	case 32:
390 		dspr0_val = (PDMIC_DSPR0_SIZE_32_BITS
391 			     << PDMIC_DSPR0_SIZE_SHIFT);
392 		break;
393 	default:
394 		return -EINVAL;
395 	}
396 
397 	if ((fs << 7) > (rate_max << 6)) {
398 		f_pdmic = fs << 6;
399 		dspr0_val |= PDMIC_DSPR0_OSR_64 << PDMIC_DSPR0_OSR_SHIFT;
400 	} else {
401 		f_pdmic = fs << 7;
402 		dspr0_val |= PDMIC_DSPR0_OSR_128 << PDMIC_DSPR0_OSR_SHIFT;
403 	}
404 
405 	pclk_rate = clk_get_rate(dd->pclk);
406 	gclk_rate = clk_get_rate(dd->gclk);
407 
408 	/* PRESCAL = SELCK/(2*f_pdmic) - 1*/
409 	pclk_prescal = (u32)(pclk_rate/(f_pdmic << 1)) - 1;
410 	gclk_prescal = (u32)(gclk_rate/(f_pdmic << 1)) - 1;
411 
412 	if ((pclk_prescal > PDMIC_MR_PRESCAL_MAX_VAL) ||
413 	    (gclk_rate/((gclk_prescal + 1) << 1) <
414 	     pclk_rate/((pclk_prescal + 1) << 1))) {
415 		mr_val = gclk_prescal << PDMIC_MR_PRESCAL_SHIFT;
416 		mr_val |= PDMIC_MR_CLKS_GCK << PDMIC_MR_CLKS_SHIFT;
417 	} else {
418 		mr_val = pclk_prescal << PDMIC_MR_PRESCAL_SHIFT;
419 		mr_val |= PDMIC_MR_CLKS_PCK << PDMIC_MR_CLKS_SHIFT;
420 	}
421 
422 	snd_soc_component_update_bits(component, PDMIC_MR,
423 		PDMIC_MR_PRESCAL_MASK | PDMIC_MR_CLKS_MASK, mr_val);
424 
425 	snd_soc_component_update_bits(component, PDMIC_DSPR0,
426 		PDMIC_DSPR0_OSR_MASK | PDMIC_DSPR0_SIZE_MASK, dspr0_val);
427 
428 	return 0;
429 }
430 
431 static int atmel_pdmic_cpu_dai_trigger(struct snd_pcm_substream *substream,
432 				       int cmd, struct snd_soc_dai *cpu_dai)
433 {
434 	struct snd_soc_component *component = cpu_dai->component;
435 	u32 val;
436 
437 	switch (cmd) {
438 	case SNDRV_PCM_TRIGGER_START:
439 	case SNDRV_PCM_TRIGGER_RESUME:
440 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
441 		val = PDMIC_CR_ENPDM_EN << PDMIC_CR_ENPDM_SHIFT;
442 		break;
443 	case SNDRV_PCM_TRIGGER_STOP:
444 	case SNDRV_PCM_TRIGGER_SUSPEND:
445 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
446 		val = PDMIC_CR_ENPDM_DIS << PDMIC_CR_ENPDM_SHIFT;
447 		break;
448 	default:
449 		return -EINVAL;
450 	}
451 
452 	snd_soc_component_update_bits(component, PDMIC_CR, PDMIC_CR_ENPDM_MASK, val);
453 
454 	return 0;
455 }
456 
457 static const struct snd_soc_dai_ops atmel_pdmic_cpu_dai_ops = {
458 	.startup	= atmel_pdmic_cpu_dai_startup,
459 	.shutdown	= atmel_pdmic_cpu_dai_shutdown,
460 	.prepare	= atmel_pdmic_cpu_dai_prepare,
461 	.hw_params	= atmel_pdmic_cpu_dai_hw_params,
462 	.trigger	= atmel_pdmic_cpu_dai_trigger,
463 };
464 
465 
466 static struct snd_soc_dai_driver atmel_pdmic_cpu_dai = {
467 	.capture = {
468 		.stream_name	= "Capture",
469 		.channels_min	= 1,
470 		.channels_max	= 1,
471 		.rates		= SNDRV_PCM_RATE_KNOT,
472 		.formats	= ATMEL_PDMIC_FORMATS,
473 	},
474 	.ops = &atmel_pdmic_cpu_dai_ops,
475 };
476 
477 static const struct snd_soc_component_driver atmel_pdmic_cpu_dai_component = {
478 	.name			= "atmel-pdmic",
479 	.probe			= atmel_pdmic_component_probe,
480 	.controls		= atmel_pdmic_snd_controls,
481 	.num_controls		= ARRAY_SIZE(atmel_pdmic_snd_controls),
482 	.idle_bias_on		= 1,
483 	.use_pmdown_time	= 1,
484 	.legacy_dai_naming	= 1,
485 };
486 
487 /* ASoC sound card */
488 static int atmel_pdmic_asoc_card_init(struct device *dev,
489 				struct snd_soc_card *card)
490 {
491 	struct snd_soc_dai_link *dai_link;
492 	struct atmel_pdmic *dd = snd_soc_card_get_drvdata(card);
493 	struct snd_soc_dai_link_component *comp;
494 
495 	dai_link = devm_kzalloc(dev, sizeof(*dai_link), GFP_KERNEL);
496 	if (!dai_link)
497 		return -ENOMEM;
498 
499 	comp = devm_kzalloc(dev, 3 * sizeof(*comp), GFP_KERNEL);
500 	if (!comp)
501 		return -ENOMEM;
502 
503 	dai_link->cpus		= &comp[0];
504 	dai_link->codecs	= &comp[1];
505 	dai_link->platforms	= &comp[2];
506 
507 	dai_link->num_cpus	= 1;
508 	dai_link->num_codecs	= 1;
509 	dai_link->num_platforms	= 1;
510 
511 	dai_link->name			= "PDMIC";
512 	dai_link->stream_name		= "PDMIC PCM";
513 	dai_link->codecs->dai_name	= "snd-soc-dummy-dai";
514 	dai_link->cpus->dai_name	= dev_name(dev);
515 	dai_link->codecs->name		= "snd-soc-dummy";
516 	dai_link->platforms->name	= dev_name(dev);
517 
518 	card->dai_link	= dai_link;
519 	card->num_links	= 1;
520 	card->name	= dd->pdata->card_name;
521 	card->dev	= dev;
522 
523 	return 0;
524 }
525 
526 static void atmel_pdmic_get_sample_rate(struct atmel_pdmic *dd,
527 	unsigned int *rate_min, unsigned int *rate_max)
528 {
529 	u32 mic_min_freq = dd->pdata->mic_min_freq;
530 	u32 mic_max_freq = dd->pdata->mic_max_freq;
531 	u32 clk_max_rate = (u32)(clk_get_rate(dd->pclk) >> 1);
532 	u32 clk_min_rate = (u32)(clk_get_rate(dd->gclk) >> 8);
533 
534 	if (mic_max_freq > clk_max_rate)
535 		mic_max_freq = clk_max_rate;
536 
537 	if (mic_min_freq < clk_min_rate)
538 		mic_min_freq = clk_min_rate;
539 
540 	*rate_min = DIV_ROUND_CLOSEST(mic_min_freq, 128);
541 	*rate_max = mic_max_freq >> 6;
542 }
543 
544 /* PDMIC interrupt handler */
545 static irqreturn_t atmel_pdmic_interrupt(int irq, void *dev_id)
546 {
547 	struct atmel_pdmic *dd = (struct atmel_pdmic *)dev_id;
548 	u32 pdmic_isr;
549 	irqreturn_t ret = IRQ_NONE;
550 
551 	regmap_read(dd->regmap, PDMIC_ISR, &pdmic_isr);
552 
553 	if (pdmic_isr & PDMIC_ISR_OVRE) {
554 		regmap_update_bits(dd->regmap, PDMIC_CR, PDMIC_CR_ENPDM_MASK,
555 				   PDMIC_CR_ENPDM_DIS << PDMIC_CR_ENPDM_SHIFT);
556 
557 		snd_pcm_stop_xrun(dd->substream);
558 
559 		ret = IRQ_HANDLED;
560 	}
561 
562 	return ret;
563 }
564 
565 /* regmap configuration */
566 #define ATMEL_PDMIC_REG_MAX    0x124
567 static const struct regmap_config atmel_pdmic_regmap_config = {
568 	.reg_bits	= 32,
569 	.reg_stride	= 4,
570 	.val_bits	= 32,
571 	.max_register	= ATMEL_PDMIC_REG_MAX,
572 };
573 
574 static int atmel_pdmic_probe(struct platform_device *pdev)
575 {
576 	struct device *dev = &pdev->dev;
577 	struct atmel_pdmic *dd;
578 	struct resource *res;
579 	void __iomem *io_base;
580 	const struct atmel_pdmic_pdata *pdata;
581 	struct snd_soc_card *card;
582 	unsigned int rate_min, rate_max;
583 	int ret;
584 
585 	pdata = atmel_pdmic_dt_init(dev);
586 	if (IS_ERR(pdata))
587 		return PTR_ERR(pdata);
588 
589 	dd = devm_kzalloc(dev, sizeof(*dd), GFP_KERNEL);
590 	if (!dd)
591 		return -ENOMEM;
592 
593 	dd->pdata = pdata;
594 	dd->dev = dev;
595 
596 	dd->irq = platform_get_irq(pdev, 0);
597 	if (dd->irq < 0)
598 		return dd->irq;
599 
600 	dd->pclk = devm_clk_get(dev, "pclk");
601 	if (IS_ERR(dd->pclk)) {
602 		ret = PTR_ERR(dd->pclk);
603 		dev_err(dev, "failed to get peripheral clock: %d\n", ret);
604 		return ret;
605 	}
606 
607 	dd->gclk = devm_clk_get(dev, "gclk");
608 	if (IS_ERR(dd->gclk)) {
609 		ret = PTR_ERR(dd->gclk);
610 		dev_err(dev, "failed to get GCK: %d\n", ret);
611 		return ret;
612 	}
613 
614 	/* The gclk clock frequency must always be three times
615 	 * lower than the pclk clock frequency
616 	 */
617 	ret = clk_set_rate(dd->gclk, clk_get_rate(dd->pclk)/3);
618 	if (ret) {
619 		dev_err(dev, "failed to set GCK clock rate: %d\n", ret);
620 		return ret;
621 	}
622 
623 	io_base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
624 	if (IS_ERR(io_base))
625 		return PTR_ERR(io_base);
626 
627 	dd->phy_base = res->start;
628 
629 	dd->regmap = devm_regmap_init_mmio(dev, io_base,
630 					   &atmel_pdmic_regmap_config);
631 	if (IS_ERR(dd->regmap)) {
632 		ret = PTR_ERR(dd->regmap);
633 		dev_err(dev, "failed to init register map: %d\n", ret);
634 		return ret;
635 	}
636 
637 	ret =  devm_request_irq(dev, dd->irq, atmel_pdmic_interrupt, 0,
638 				"PDMIC", (void *)dd);
639 	if (ret < 0) {
640 		dev_err(dev, "can't register ISR for IRQ %u (ret=%i)\n",
641 			dd->irq, ret);
642 		return ret;
643 	}
644 
645 	/* Get the minimal and maximal sample rate that the microphone supports */
646 	atmel_pdmic_get_sample_rate(dd, &rate_min, &rate_max);
647 
648 	/* register cpu dai */
649 	atmel_pdmic_cpu_dai.capture.rate_min = rate_min;
650 	atmel_pdmic_cpu_dai.capture.rate_max = rate_max;
651 	ret = devm_snd_soc_register_component(dev,
652 					      &atmel_pdmic_cpu_dai_component,
653 					      &atmel_pdmic_cpu_dai, 1);
654 	if (ret) {
655 		dev_err(dev, "could not register CPU DAI: %d\n", ret);
656 		return ret;
657 	}
658 
659 	/* register platform */
660 	ret = devm_snd_dmaengine_pcm_register(dev,
661 					     &atmel_pdmic_dmaengine_pcm_config,
662 					     0);
663 	if (ret) {
664 		dev_err(dev, "could not register platform: %d\n", ret);
665 		return ret;
666 	}
667 
668 	/* register sound card */
669 	card = devm_kzalloc(dev, sizeof(*card), GFP_KERNEL);
670 	if (!card) {
671 		ret = -ENOMEM;
672 		goto unregister_codec;
673 	}
674 
675 	snd_soc_card_set_drvdata(card, dd);
676 
677 	ret = atmel_pdmic_asoc_card_init(dev, card);
678 	if (ret) {
679 		dev_err(dev, "failed to init sound card: %d\n", ret);
680 		goto unregister_codec;
681 	}
682 
683 	ret = devm_snd_soc_register_card(dev, card);
684 	if (ret) {
685 		dev_err(dev, "failed to register sound card: %d\n", ret);
686 		goto unregister_codec;
687 	}
688 
689 	return 0;
690 
691 unregister_codec:
692 	return ret;
693 }
694 
695 static int atmel_pdmic_remove(struct platform_device *pdev)
696 {
697 	return 0;
698 }
699 
700 static struct platform_driver atmel_pdmic_driver = {
701 	.driver	= {
702 		.name		= "atmel-pdmic",
703 		.of_match_table	= of_match_ptr(atmel_pdmic_of_match),
704 		.pm		= &snd_soc_pm_ops,
705 	},
706 	.probe	= atmel_pdmic_probe,
707 	.remove	= atmel_pdmic_remove,
708 };
709 module_platform_driver(atmel_pdmic_driver);
710 
711 MODULE_DESCRIPTION("Atmel PDMIC driver under ALSA SoC architecture");
712 MODULE_AUTHOR("Songjun Wu <songjun.wu@atmel.com>");
713 MODULE_LICENSE("GPL v2");
714