1 /* Atmel ALSA SoC Audio Class D Amplifier (CLASSD) driver
3 * Copyright (C) 2015 Atmel
5 * Author: Songjun Wu <songjun.wu@atmel.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 or later
9 * as published by the Free Software Foundation.
13 #include <linux/clk.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/regmap.h>
17 #include <sound/core.h>
18 #include <sound/dmaengine_pcm.h>
19 #include <sound/pcm_params.h>
20 #include <sound/tlv.h>
21 #include "atmel-classd.h"
23 struct atmel_classd_pdata {
24 bool non_overlap_enable;
27 const char *card_name;
32 struct regmap *regmap;
37 const struct atmel_classd_pdata *pdata;
41 static const struct of_device_id atmel_classd_of_match[] = {
43 .compatible = "atmel,sama5d2-classd",
48 MODULE_DEVICE_TABLE(of, atmel_classd_of_match);
50 static struct atmel_classd_pdata *atmel_classd_dt_init(struct device *dev)
52 struct device_node *np = dev->of_node;
53 struct atmel_classd_pdata *pdata;
58 dev_err(dev, "device node not found\n");
59 return ERR_PTR(-EINVAL);
62 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
64 return ERR_PTR(-ENOMEM);
66 ret = of_property_read_string(np, "atmel,pwm-type", &pwm_type);
67 if ((ret == 0) && (strcmp(pwm_type, "diff") == 0))
68 pdata->pwm_type = CLASSD_MR_PWMTYP_DIFF;
70 pdata->pwm_type = CLASSD_MR_PWMTYP_SINGLE;
72 ret = of_property_read_u32(np,
73 "atmel,non-overlap-time", &pdata->non_overlap_time);
75 pdata->non_overlap_enable = false;
77 pdata->non_overlap_enable = true;
79 ret = of_property_read_string(np, "atmel,model", &pdata->card_name);
81 pdata->card_name = "CLASSD";
86 static inline struct atmel_classd_pdata *
87 atmel_classd_dt_init(struct device *dev)
89 return ERR_PTR(-EINVAL);
93 #define ATMEL_CLASSD_RATES (SNDRV_PCM_RATE_8000 \
94 | SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 \
95 | SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 \
96 | SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 \
97 | SNDRV_PCM_RATE_96000)
99 static const struct snd_pcm_hardware atmel_classd_hw = {
100 .info = SNDRV_PCM_INFO_MMAP
101 | SNDRV_PCM_INFO_MMAP_VALID
102 | SNDRV_PCM_INFO_INTERLEAVED
103 | SNDRV_PCM_INFO_RESUME
104 | SNDRV_PCM_INFO_PAUSE,
105 .formats = (SNDRV_PCM_FMTBIT_S16_LE),
106 .rates = ATMEL_CLASSD_RATES,
111 .buffer_bytes_max = 64 * 1024,
112 .period_bytes_min = 256,
113 .period_bytes_max = 32 * 1024,
118 #define ATMEL_CLASSD_PREALLOC_BUF_SIZE (64 * 1024)
120 /* cpu dai component */
121 static int atmel_classd_cpu_dai_startup(struct snd_pcm_substream *substream,
122 struct snd_soc_dai *cpu_dai)
124 struct snd_soc_pcm_runtime *rtd = substream->private_data;
125 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
127 regmap_write(dd->regmap, CLASSD_THR, 0x0);
129 return clk_prepare_enable(dd->pclk);
132 static void atmel_classd_cpu_dai_shutdown(struct snd_pcm_substream *substream,
133 struct snd_soc_dai *cpu_dai)
135 struct snd_soc_pcm_runtime *rtd = substream->private_data;
136 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
138 clk_disable_unprepare(dd->pclk);
141 static const struct snd_soc_dai_ops atmel_classd_cpu_dai_ops = {
142 .startup = atmel_classd_cpu_dai_startup,
143 .shutdown = atmel_classd_cpu_dai_shutdown,
146 static struct snd_soc_dai_driver atmel_classd_cpu_dai = {
150 .rates = ATMEL_CLASSD_RATES,
151 .formats = SNDRV_PCM_FMTBIT_S16_LE,},
152 .ops = &atmel_classd_cpu_dai_ops,
155 static const struct snd_soc_component_driver atmel_classd_cpu_dai_component = {
156 .name = "atmel-classd",
161 atmel_classd_platform_configure_dma(struct snd_pcm_substream *substream,
162 struct snd_pcm_hw_params *params,
163 struct dma_slave_config *slave_config)
165 struct snd_soc_pcm_runtime *rtd = substream->private_data;
166 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
168 if (params_physical_width(params) != 16) {
169 dev_err(rtd->platform->dev,
170 "only supports 16-bit audio data\n");
174 if (params_channels(params) == 1)
175 slave_config->dst_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES;
177 slave_config->dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
179 slave_config->direction = DMA_MEM_TO_DEV;
180 slave_config->dst_addr = dd->phy_base + CLASSD_THR;
181 slave_config->dst_maxburst = 1;
182 slave_config->src_maxburst = 1;
183 slave_config->device_fc = false;
188 static const struct snd_dmaengine_pcm_config
189 atmel_classd_dmaengine_pcm_config = {
190 .prepare_slave_config = atmel_classd_platform_configure_dma,
191 .pcm_hardware = &atmel_classd_hw,
192 .prealloc_buffer_size = ATMEL_CLASSD_PREALLOC_BUF_SIZE,
196 static const char * const mono_mode_text[] = {
197 "mix", "sat", "left", "right"
200 static SOC_ENUM_SINGLE_DECL(classd_mono_mode_enum,
201 CLASSD_INTPMR, CLASSD_INTPMR_MONO_MODE_SHIFT,
204 static const char * const eqcfg_text[] = {
205 "Treble-12dB", "Treble-6dB",
206 "Medium-8dB", "Medium-3dB",
207 "Bass-12dB", "Bass-6dB",
209 "Bass+6dB", "Bass+12dB",
210 "Medium+3dB", "Medium+8dB",
211 "Treble+6dB", "Treble+12dB",
214 static const unsigned int eqcfg_value[] = {
215 CLASSD_INTPMR_EQCFG_T_CUT_12, CLASSD_INTPMR_EQCFG_T_CUT_6,
216 CLASSD_INTPMR_EQCFG_M_CUT_8, CLASSD_INTPMR_EQCFG_M_CUT_3,
217 CLASSD_INTPMR_EQCFG_B_CUT_12, CLASSD_INTPMR_EQCFG_B_CUT_6,
218 CLASSD_INTPMR_EQCFG_FLAT,
219 CLASSD_INTPMR_EQCFG_B_BOOST_6, CLASSD_INTPMR_EQCFG_B_BOOST_12,
220 CLASSD_INTPMR_EQCFG_M_BOOST_3, CLASSD_INTPMR_EQCFG_M_BOOST_8,
221 CLASSD_INTPMR_EQCFG_T_BOOST_6, CLASSD_INTPMR_EQCFG_T_BOOST_12,
224 static SOC_VALUE_ENUM_SINGLE_DECL(classd_eqcfg_enum,
225 CLASSD_INTPMR, CLASSD_INTPMR_EQCFG_SHIFT, 0xf,
226 eqcfg_text, eqcfg_value);
228 static const DECLARE_TLV_DB_SCALE(classd_digital_tlv, -7800, 100, 1);
230 static const struct snd_kcontrol_new atmel_classd_snd_controls[] = {
231 SOC_DOUBLE_TLV("Playback Volume", CLASSD_INTPMR,
232 CLASSD_INTPMR_ATTL_SHIFT, CLASSD_INTPMR_ATTR_SHIFT,
233 78, 1, classd_digital_tlv),
235 SOC_SINGLE("Deemphasis Switch", CLASSD_INTPMR,
236 CLASSD_INTPMR_DEEMP_SHIFT, 1, 0),
238 SOC_SINGLE("Mono Switch", CLASSD_INTPMR, CLASSD_INTPMR_MONO_SHIFT, 1, 0),
240 SOC_SINGLE("Swap Switch", CLASSD_INTPMR, CLASSD_INTPMR_SWAP_SHIFT, 1, 0),
242 SOC_ENUM("Mono Mode", classd_mono_mode_enum),
244 SOC_ENUM("EQ", classd_eqcfg_enum),
247 static const char * const pwm_type[] = {
248 "Single ended", "Differential"
251 static int atmel_classd_codec_probe(struct snd_soc_codec *codec)
253 struct snd_soc_card *card = snd_soc_codec_get_drvdata(codec);
254 struct atmel_classd *dd = snd_soc_card_get_drvdata(card);
255 const struct atmel_classd_pdata *pdata = dd->pdata;
258 mask = CLASSD_MR_PWMTYP_MASK;
259 val = pdata->pwm_type << CLASSD_MR_PWMTYP_SHIFT;
261 mask |= CLASSD_MR_NON_OVERLAP_MASK;
262 if (pdata->non_overlap_enable) {
263 val |= (CLASSD_MR_NON_OVERLAP_EN
264 << CLASSD_MR_NON_OVERLAP_SHIFT);
266 mask |= CLASSD_MR_NOVR_VAL_MASK;
267 switch (pdata->non_overlap_time) {
269 val |= (CLASSD_MR_NOVR_VAL_5NS
270 << CLASSD_MR_NOVR_VAL_SHIFT);
273 val |= (CLASSD_MR_NOVR_VAL_10NS
274 << CLASSD_MR_NOVR_VAL_SHIFT);
277 val |= (CLASSD_MR_NOVR_VAL_15NS
278 << CLASSD_MR_NOVR_VAL_SHIFT);
281 val |= (CLASSD_MR_NOVR_VAL_20NS
282 << CLASSD_MR_NOVR_VAL_SHIFT);
285 val |= (CLASSD_MR_NOVR_VAL_10NS
286 << CLASSD_MR_NOVR_VAL_SHIFT);
288 "non-overlapping value %d is invalid, the default value 10 is specified\n",
289 pdata->non_overlap_time);
294 snd_soc_update_bits(codec, CLASSD_MR, mask, val);
297 "PWM modulation type is %s, non-overlapping is %s\n",
298 pwm_type[pdata->pwm_type],
299 pdata->non_overlap_enable?"enabled":"disabled");
304 static int atmel_classd_codec_resume(struct snd_soc_codec *codec)
306 struct snd_soc_card *card = snd_soc_codec_get_drvdata(codec);
307 struct atmel_classd *dd = snd_soc_card_get_drvdata(card);
309 return regcache_sync(dd->regmap);
312 static struct regmap *atmel_classd_codec_get_remap(struct device *dev)
314 return dev_get_regmap(dev, NULL);
317 static struct snd_soc_codec_driver soc_codec_dev_classd = {
318 .probe = atmel_classd_codec_probe,
319 .resume = atmel_classd_codec_resume,
320 .get_regmap = atmel_classd_codec_get_remap,
321 .component_driver = {
322 .controls = atmel_classd_snd_controls,
323 .num_controls = ARRAY_SIZE(atmel_classd_snd_controls),
327 /* codec dai component */
328 static int atmel_classd_codec_dai_startup(struct snd_pcm_substream *substream,
329 struct snd_soc_dai *codec_dai)
331 struct snd_soc_pcm_runtime *rtd = substream->private_data;
332 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
335 ret = clk_prepare_enable(dd->aclk);
339 return clk_prepare_enable(dd->gclk);
342 static int atmel_classd_codec_dai_digital_mute(struct snd_soc_dai *codec_dai,
345 struct snd_soc_codec *codec = codec_dai->codec;
348 mask = CLASSD_MR_LMUTE_MASK | CLASSD_MR_RMUTE_MASK;
355 snd_soc_update_bits(codec, CLASSD_MR, mask, val);
360 #define CLASSD_ACLK_RATE_11M2896_MPY_8 (112896 * 100 * 8)
361 #define CLASSD_ACLK_RATE_12M288_MPY_8 (12288 * 1000 * 8)
367 unsigned long aclk_rate;
368 } const sample_rates[] = {
369 { 8000, CLASSD_INTPMR_FRAME_8K,
370 CLASSD_INTPMR_DSP_CLK_FREQ_12M288, CLASSD_ACLK_RATE_12M288_MPY_8 },
371 { 16000, CLASSD_INTPMR_FRAME_16K,
372 CLASSD_INTPMR_DSP_CLK_FREQ_12M288, CLASSD_ACLK_RATE_12M288_MPY_8 },
373 { 32000, CLASSD_INTPMR_FRAME_32K,
374 CLASSD_INTPMR_DSP_CLK_FREQ_12M288, CLASSD_ACLK_RATE_12M288_MPY_8 },
375 { 48000, CLASSD_INTPMR_FRAME_48K,
376 CLASSD_INTPMR_DSP_CLK_FREQ_12M288, CLASSD_ACLK_RATE_12M288_MPY_8 },
377 { 96000, CLASSD_INTPMR_FRAME_96K,
378 CLASSD_INTPMR_DSP_CLK_FREQ_12M288, CLASSD_ACLK_RATE_12M288_MPY_8 },
379 { 22050, CLASSD_INTPMR_FRAME_22K,
380 CLASSD_INTPMR_DSP_CLK_FREQ_11M2896, CLASSD_ACLK_RATE_11M2896_MPY_8 },
381 { 44100, CLASSD_INTPMR_FRAME_44K,
382 CLASSD_INTPMR_DSP_CLK_FREQ_11M2896, CLASSD_ACLK_RATE_11M2896_MPY_8 },
383 { 88200, CLASSD_INTPMR_FRAME_88K,
384 CLASSD_INTPMR_DSP_CLK_FREQ_11M2896, CLASSD_ACLK_RATE_11M2896_MPY_8 },
388 atmel_classd_codec_dai_hw_params(struct snd_pcm_substream *substream,
389 struct snd_pcm_hw_params *params,
390 struct snd_soc_dai *codec_dai)
392 struct snd_soc_pcm_runtime *rtd = substream->private_data;
393 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
394 struct snd_soc_codec *codec = codec_dai->codec;
396 int i, best, best_val, cur_val, ret;
399 fs = params_rate(params);
402 best_val = abs(fs - sample_rates[0].rate);
403 for (i = 1; i < ARRAY_SIZE(sample_rates); i++) {
405 cur_val = abs(fs - sample_rates[i].rate);
406 if (cur_val < best_val) {
413 "Selected SAMPLE_RATE of %dHz, ACLK_RATE of %ldHz\n",
414 sample_rates[best].rate, sample_rates[best].aclk_rate);
416 clk_disable_unprepare(dd->gclk);
417 clk_disable_unprepare(dd->aclk);
419 ret = clk_set_rate(dd->aclk, sample_rates[best].aclk_rate);
423 mask = CLASSD_INTPMR_DSP_CLK_FREQ_MASK | CLASSD_INTPMR_FRAME_MASK;
424 val = (sample_rates[best].dsp_clk << CLASSD_INTPMR_DSP_CLK_FREQ_SHIFT)
425 | (sample_rates[best].sample_rate << CLASSD_INTPMR_FRAME_SHIFT);
427 snd_soc_update_bits(codec, CLASSD_INTPMR, mask, val);
429 ret = clk_prepare_enable(dd->aclk);
433 return clk_prepare_enable(dd->gclk);
437 atmel_classd_codec_dai_shutdown(struct snd_pcm_substream *substream,
438 struct snd_soc_dai *codec_dai)
440 struct snd_soc_pcm_runtime *rtd = substream->private_data;
441 struct atmel_classd *dd = snd_soc_card_get_drvdata(rtd->card);
443 clk_disable_unprepare(dd->gclk);
444 clk_disable_unprepare(dd->aclk);
447 static int atmel_classd_codec_dai_prepare(struct snd_pcm_substream *substream,
448 struct snd_soc_dai *codec_dai)
450 struct snd_soc_codec *codec = codec_dai->codec;
452 snd_soc_update_bits(codec, CLASSD_MR,
453 CLASSD_MR_LEN_MASK | CLASSD_MR_REN_MASK,
454 (CLASSD_MR_LEN_DIS << CLASSD_MR_LEN_SHIFT)
455 |(CLASSD_MR_REN_DIS << CLASSD_MR_REN_SHIFT));
460 static int atmel_classd_codec_dai_trigger(struct snd_pcm_substream *substream,
461 int cmd, struct snd_soc_dai *codec_dai)
463 struct snd_soc_codec *codec = codec_dai->codec;
466 mask = CLASSD_MR_LEN_MASK | CLASSD_MR_REN_MASK;
469 case SNDRV_PCM_TRIGGER_START:
470 case SNDRV_PCM_TRIGGER_RESUME:
471 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
474 case SNDRV_PCM_TRIGGER_STOP:
475 case SNDRV_PCM_TRIGGER_SUSPEND:
476 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
477 val = (CLASSD_MR_LEN_DIS << CLASSD_MR_LEN_SHIFT)
478 | (CLASSD_MR_REN_DIS << CLASSD_MR_REN_SHIFT);
484 snd_soc_update_bits(codec, CLASSD_MR, mask, val);
489 static const struct snd_soc_dai_ops atmel_classd_codec_dai_ops = {
490 .digital_mute = atmel_classd_codec_dai_digital_mute,
491 .startup = atmel_classd_codec_dai_startup,
492 .shutdown = atmel_classd_codec_dai_shutdown,
493 .hw_params = atmel_classd_codec_dai_hw_params,
494 .prepare = atmel_classd_codec_dai_prepare,
495 .trigger = atmel_classd_codec_dai_trigger,
498 #define ATMEL_CLASSD_CODEC_DAI_NAME "atmel-classd-hifi"
500 static struct snd_soc_dai_driver atmel_classd_codec_dai = {
501 .name = ATMEL_CLASSD_CODEC_DAI_NAME,
503 .stream_name = "Playback",
506 .rates = ATMEL_CLASSD_RATES,
507 .formats = SNDRV_PCM_FMTBIT_S16_LE,
509 .ops = &atmel_classd_codec_dai_ops,
512 /* ASoC sound card */
513 static int atmel_classd_asoc_card_init(struct device *dev,
514 struct snd_soc_card *card)
516 struct snd_soc_dai_link *dai_link;
517 struct atmel_classd *dd = snd_soc_card_get_drvdata(card);
519 dai_link = devm_kzalloc(dev, sizeof(*dai_link), GFP_KERNEL);
523 dai_link->name = "CLASSD";
524 dai_link->stream_name = "CLASSD PCM";
525 dai_link->codec_dai_name = ATMEL_CLASSD_CODEC_DAI_NAME;
526 dai_link->cpu_dai_name = dev_name(dev);
527 dai_link->codec_name = dev_name(dev);
528 dai_link->platform_name = dev_name(dev);
530 card->dai_link = dai_link;
532 card->name = dd->pdata->card_name;
538 /* regmap configuration */
539 static const struct reg_default atmel_classd_reg_defaults[] = {
540 { CLASSD_INTPMR, 0x00301212 },
543 #define ATMEL_CLASSD_REG_MAX 0xE4
544 static const struct regmap_config atmel_classd_regmap_config = {
548 .max_register = ATMEL_CLASSD_REG_MAX,
550 .cache_type = REGCACHE_FLAT,
551 .reg_defaults = atmel_classd_reg_defaults,
552 .num_reg_defaults = ARRAY_SIZE(atmel_classd_reg_defaults),
555 static int atmel_classd_probe(struct platform_device *pdev)
557 struct device *dev = &pdev->dev;
558 struct atmel_classd *dd;
559 struct resource *res;
560 void __iomem *io_base;
561 const struct atmel_classd_pdata *pdata;
562 struct snd_soc_card *card;
565 pdata = dev_get_platdata(dev);
567 pdata = atmel_classd_dt_init(dev);
569 return PTR_ERR(pdata);
572 dd = devm_kzalloc(dev, sizeof(*dd), GFP_KERNEL);
578 dd->irq = platform_get_irq(pdev, 0);
581 dev_err(dev, "failed to could not get irq: %d\n", ret);
585 dd->pclk = devm_clk_get(dev, "pclk");
586 if (IS_ERR(dd->pclk)) {
587 ret = PTR_ERR(dd->pclk);
588 dev_err(dev, "failed to get peripheral clock: %d\n", ret);
592 dd->gclk = devm_clk_get(dev, "gclk");
593 if (IS_ERR(dd->gclk)) {
594 ret = PTR_ERR(dd->gclk);
595 dev_err(dev, "failed to get GCK clock: %d\n", ret);
599 dd->aclk = devm_clk_get(dev, "aclk");
600 if (IS_ERR(dd->aclk)) {
601 ret = PTR_ERR(dd->aclk);
602 dev_err(dev, "failed to get audio clock: %d\n", ret);
606 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
607 io_base = devm_ioremap_resource(dev, res);
608 if (IS_ERR(io_base)) {
609 ret = PTR_ERR(io_base);
610 dev_err(dev, "failed to remap register memory: %d\n", ret);
614 dd->phy_base = res->start;
616 dd->regmap = devm_regmap_init_mmio(dev, io_base,
617 &atmel_classd_regmap_config);
618 if (IS_ERR(dd->regmap)) {
619 ret = PTR_ERR(dd->regmap);
620 dev_err(dev, "failed to init register map: %d\n", ret);
624 ret = devm_snd_soc_register_component(dev,
625 &atmel_classd_cpu_dai_component,
626 &atmel_classd_cpu_dai, 1);
628 dev_err(dev, "could not register CPU DAI: %d\n", ret);
632 ret = devm_snd_dmaengine_pcm_register(dev,
633 &atmel_classd_dmaengine_pcm_config,
636 dev_err(dev, "could not register platform: %d\n", ret);
640 ret = snd_soc_register_codec(dev, &soc_codec_dev_classd,
641 &atmel_classd_codec_dai, 1);
643 dev_err(dev, "could not register codec: %d\n", ret);
647 /* register sound card */
648 card = devm_kzalloc(dev, sizeof(*card), GFP_KERNEL);
651 goto unregister_codec;
654 snd_soc_card_set_drvdata(card, dd);
656 ret = atmel_classd_asoc_card_init(dev, card);
658 dev_err(dev, "failed to init sound card\n");
659 goto unregister_codec;
662 ret = devm_snd_soc_register_card(dev, card);
664 dev_err(dev, "failed to register sound card: %d\n", ret);
665 goto unregister_codec;
671 snd_soc_unregister_codec(dev);
675 static int atmel_classd_remove(struct platform_device *pdev)
677 snd_soc_unregister_codec(&pdev->dev);
681 static struct platform_driver atmel_classd_driver = {
683 .name = "atmel-classd",
684 .of_match_table = of_match_ptr(atmel_classd_of_match),
685 .pm = &snd_soc_pm_ops,
687 .probe = atmel_classd_probe,
688 .remove = atmel_classd_remove,
690 module_platform_driver(atmel_classd_driver);
692 MODULE_DESCRIPTION("Atmel ClassD driver under ALSA SoC architecture");
693 MODULE_AUTHOR("Songjun Wu <songjun.wu@atmel.com>");
694 MODULE_LICENSE("GPL");