2 * Driver for the PCM512x CODECs
4 * Author: Mark Brown <broonie@linaro.org>
5 * Copyright 2014 Linaro Ltd
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
18 #include <linux/init.h>
19 #include <linux/module.h>
20 #include <linux/clk.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/regmap.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/gcd.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/tlv.h>
32 #define DIV_ROUND_DOWN_ULL(ll, d) \
33 ({ unsigned long long _tmp = (ll); do_div(_tmp, d); _tmp; })
34 #define DIV_ROUND_CLOSEST_ULL(ll, d) \
35 ({ unsigned long long _tmp = (ll)+(d)/2; do_div(_tmp, d); _tmp; })
37 #define PCM512x_NUM_SUPPLIES 3
38 static const char * const pcm512x_supply_names[PCM512x_NUM_SUPPLIES] = {
45 struct regmap *regmap;
47 struct regulator_bulk_data supplies[PCM512x_NUM_SUPPLIES];
48 struct notifier_block supply_nb[PCM512x_NUM_SUPPLIES];
56 unsigned long real_pll;
60 * We can't use the same notifier block for more than one supply and
61 * there's no way I can see to get from a callback to the caller
62 * except container_of().
64 #define PCM512x_REGULATOR_EVENT(n) \
65 static int pcm512x_regulator_event_##n(struct notifier_block *nb, \
66 unsigned long event, void *data) \
68 struct pcm512x_priv *pcm512x = container_of(nb, struct pcm512x_priv, \
70 if (event & REGULATOR_EVENT_DISABLE) { \
71 regcache_mark_dirty(pcm512x->regmap); \
72 regcache_cache_only(pcm512x->regmap, true); \
77 PCM512x_REGULATOR_EVENT(0)
78 PCM512x_REGULATOR_EVENT(1)
79 PCM512x_REGULATOR_EVENT(2)
81 static const struct reg_default pcm512x_reg_defaults[] = {
82 { PCM512x_RESET, 0x00 },
83 { PCM512x_POWER, 0x00 },
84 { PCM512x_MUTE, 0x00 },
85 { PCM512x_DSP, 0x00 },
86 { PCM512x_PLL_REF, 0x00 },
87 { PCM512x_DAC_REF, 0x00 },
88 { PCM512x_DAC_ROUTING, 0x11 },
89 { PCM512x_DSP_PROGRAM, 0x01 },
90 { PCM512x_CLKDET, 0x00 },
91 { PCM512x_AUTO_MUTE, 0x00 },
92 { PCM512x_ERROR_DETECT, 0x00 },
93 { PCM512x_DIGITAL_VOLUME_1, 0x00 },
94 { PCM512x_DIGITAL_VOLUME_2, 0x30 },
95 { PCM512x_DIGITAL_VOLUME_3, 0x30 },
96 { PCM512x_DIGITAL_MUTE_1, 0x22 },
97 { PCM512x_DIGITAL_MUTE_2, 0x00 },
98 { PCM512x_DIGITAL_MUTE_3, 0x07 },
99 { PCM512x_OUTPUT_AMPLITUDE, 0x00 },
100 { PCM512x_ANALOG_GAIN_CTRL, 0x00 },
101 { PCM512x_UNDERVOLTAGE_PROT, 0x00 },
102 { PCM512x_ANALOG_MUTE_CTRL, 0x00 },
103 { PCM512x_ANALOG_GAIN_BOOST, 0x00 },
104 { PCM512x_VCOM_CTRL_1, 0x00 },
105 { PCM512x_VCOM_CTRL_2, 0x01 },
106 { PCM512x_BCLK_LRCLK_CFG, 0x00 },
107 { PCM512x_MASTER_MODE, 0x7c },
108 { PCM512x_GPIO_PLLIN, 0x00 },
109 { PCM512x_SYNCHRONIZE, 0x10 },
110 { PCM512x_PLL_COEFF_0, 0x00 },
111 { PCM512x_PLL_COEFF_1, 0x00 },
112 { PCM512x_PLL_COEFF_2, 0x00 },
113 { PCM512x_PLL_COEFF_3, 0x00 },
114 { PCM512x_PLL_COEFF_4, 0x00 },
115 { PCM512x_DSP_CLKDIV, 0x00 },
116 { PCM512x_DAC_CLKDIV, 0x00 },
117 { PCM512x_NCP_CLKDIV, 0x00 },
118 { PCM512x_OSR_CLKDIV, 0x00 },
119 { PCM512x_MASTER_CLKDIV_1, 0x00 },
120 { PCM512x_MASTER_CLKDIV_2, 0x00 },
121 { PCM512x_FS_SPEED_MODE, 0x00 },
122 { PCM512x_IDAC_1, 0x01 },
123 { PCM512x_IDAC_2, 0x00 },
126 static bool pcm512x_readable(struct device *dev, unsigned int reg)
133 case PCM512x_SPI_MISO_FUNCTION:
135 case PCM512x_GPIO_EN:
136 case PCM512x_BCLK_LRCLK_CFG:
137 case PCM512x_DSP_GPIO_INPUT:
138 case PCM512x_MASTER_MODE:
139 case PCM512x_PLL_REF:
140 case PCM512x_DAC_REF:
141 case PCM512x_GPIO_PLLIN:
142 case PCM512x_SYNCHRONIZE:
143 case PCM512x_PLL_COEFF_0:
144 case PCM512x_PLL_COEFF_1:
145 case PCM512x_PLL_COEFF_2:
146 case PCM512x_PLL_COEFF_3:
147 case PCM512x_PLL_COEFF_4:
148 case PCM512x_DSP_CLKDIV:
149 case PCM512x_DAC_CLKDIV:
150 case PCM512x_NCP_CLKDIV:
151 case PCM512x_OSR_CLKDIV:
152 case PCM512x_MASTER_CLKDIV_1:
153 case PCM512x_MASTER_CLKDIV_2:
154 case PCM512x_FS_SPEED_MODE:
157 case PCM512x_ERROR_DETECT:
160 case PCM512x_DAC_ROUTING:
161 case PCM512x_DSP_PROGRAM:
163 case PCM512x_AUTO_MUTE:
164 case PCM512x_DIGITAL_VOLUME_1:
165 case PCM512x_DIGITAL_VOLUME_2:
166 case PCM512x_DIGITAL_VOLUME_3:
167 case PCM512x_DIGITAL_MUTE_1:
168 case PCM512x_DIGITAL_MUTE_2:
169 case PCM512x_DIGITAL_MUTE_3:
170 case PCM512x_GPIO_OUTPUT_1:
171 case PCM512x_GPIO_OUTPUT_2:
172 case PCM512x_GPIO_OUTPUT_3:
173 case PCM512x_GPIO_OUTPUT_4:
174 case PCM512x_GPIO_OUTPUT_5:
175 case PCM512x_GPIO_OUTPUT_6:
176 case PCM512x_GPIO_CONTROL_1:
177 case PCM512x_GPIO_CONTROL_2:
178 case PCM512x_OVERFLOW:
179 case PCM512x_RATE_DET_1:
180 case PCM512x_RATE_DET_2:
181 case PCM512x_RATE_DET_3:
182 case PCM512x_RATE_DET_4:
183 case PCM512x_CLOCK_STATUS:
184 case PCM512x_ANALOG_MUTE_DET:
186 case PCM512x_DIGITAL_MUTE_DET:
187 case PCM512x_OUTPUT_AMPLITUDE:
188 case PCM512x_ANALOG_GAIN_CTRL:
189 case PCM512x_UNDERVOLTAGE_PROT:
190 case PCM512x_ANALOG_MUTE_CTRL:
191 case PCM512x_ANALOG_GAIN_BOOST:
192 case PCM512x_VCOM_CTRL_1:
193 case PCM512x_VCOM_CTRL_2:
194 case PCM512x_CRAM_CTRL:
199 /* There are 256 raw register addresses */
204 static bool pcm512x_volatile(struct device *dev, unsigned int reg)
208 case PCM512x_OVERFLOW:
209 case PCM512x_RATE_DET_1:
210 case PCM512x_RATE_DET_2:
211 case PCM512x_RATE_DET_3:
212 case PCM512x_RATE_DET_4:
213 case PCM512x_CLOCK_STATUS:
214 case PCM512x_ANALOG_MUTE_DET:
216 case PCM512x_DIGITAL_MUTE_DET:
217 case PCM512x_CRAM_CTRL:
220 /* There are 256 raw register addresses */
225 static const DECLARE_TLV_DB_SCALE(digital_tlv, -10350, 50, 1);
226 static const DECLARE_TLV_DB_SCALE(analog_tlv, -600, 600, 0);
227 static const DECLARE_TLV_DB_SCALE(boost_tlv, 0, 80, 0);
229 static const char * const pcm512x_dsp_program_texts[] = {
230 "FIR interpolation with de-emphasis",
231 "Low latency IIR with de-emphasis",
232 "Fixed process flow",
233 "High attenuation with de-emphasis",
234 "Ringing-less low latency FIR",
237 static const unsigned int pcm512x_dsp_program_values[] = {
245 static SOC_VALUE_ENUM_SINGLE_DECL(pcm512x_dsp_program,
246 PCM512x_DSP_PROGRAM, 0, 0x1f,
247 pcm512x_dsp_program_texts,
248 pcm512x_dsp_program_values);
250 static const char * const pcm512x_clk_missing_text[] = {
251 "1s", "2s", "3s", "4s", "5s", "6s", "7s", "8s"
254 static const struct soc_enum pcm512x_clk_missing =
255 SOC_ENUM_SINGLE(PCM512x_CLKDET, 0, 8, pcm512x_clk_missing_text);
257 static const char * const pcm512x_autom_text[] = {
258 "21ms", "106ms", "213ms", "533ms", "1.07s", "2.13s", "5.33s", "10.66s"
261 static const struct soc_enum pcm512x_autom_l =
262 SOC_ENUM_SINGLE(PCM512x_AUTO_MUTE, PCM512x_ATML_SHIFT, 8,
265 static const struct soc_enum pcm512x_autom_r =
266 SOC_ENUM_SINGLE(PCM512x_AUTO_MUTE, PCM512x_ATMR_SHIFT, 8,
269 static const char * const pcm512x_ramp_rate_text[] = {
270 "1 sample/update", "2 samples/update", "4 samples/update",
274 static const struct soc_enum pcm512x_vndf =
275 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_1, PCM512x_VNDF_SHIFT, 4,
276 pcm512x_ramp_rate_text);
278 static const struct soc_enum pcm512x_vnuf =
279 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_1, PCM512x_VNUF_SHIFT, 4,
280 pcm512x_ramp_rate_text);
282 static const struct soc_enum pcm512x_vedf =
283 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_2, PCM512x_VEDF_SHIFT, 4,
284 pcm512x_ramp_rate_text);
286 static const char * const pcm512x_ramp_step_text[] = {
287 "4dB/step", "2dB/step", "1dB/step", "0.5dB/step"
290 static const struct soc_enum pcm512x_vnds =
291 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_1, PCM512x_VNDS_SHIFT, 4,
292 pcm512x_ramp_step_text);
294 static const struct soc_enum pcm512x_vnus =
295 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_1, PCM512x_VNUS_SHIFT, 4,
296 pcm512x_ramp_step_text);
298 static const struct soc_enum pcm512x_veds =
299 SOC_ENUM_SINGLE(PCM512x_DIGITAL_MUTE_2, PCM512x_VEDS_SHIFT, 4,
300 pcm512x_ramp_step_text);
302 static const struct snd_kcontrol_new pcm512x_controls[] = {
303 SOC_DOUBLE_R_TLV("Digital Playback Volume", PCM512x_DIGITAL_VOLUME_2,
304 PCM512x_DIGITAL_VOLUME_3, 0, 255, 1, digital_tlv),
305 SOC_DOUBLE_TLV("Playback Volume", PCM512x_ANALOG_GAIN_CTRL,
306 PCM512x_LAGN_SHIFT, PCM512x_RAGN_SHIFT, 1, 1, analog_tlv),
307 SOC_DOUBLE_TLV("Playback Boost Volume", PCM512x_ANALOG_GAIN_BOOST,
308 PCM512x_AGBL_SHIFT, PCM512x_AGBR_SHIFT, 1, 0, boost_tlv),
309 SOC_DOUBLE("Digital Playback Switch", PCM512x_MUTE, PCM512x_RQML_SHIFT,
310 PCM512x_RQMR_SHIFT, 1, 1),
312 SOC_SINGLE("Deemphasis Switch", PCM512x_DSP, PCM512x_DEMP_SHIFT, 1, 1),
313 SOC_ENUM("DSP Program", pcm512x_dsp_program),
315 SOC_ENUM("Clock Missing Period", pcm512x_clk_missing),
316 SOC_ENUM("Auto Mute Time Left", pcm512x_autom_l),
317 SOC_ENUM("Auto Mute Time Right", pcm512x_autom_r),
318 SOC_SINGLE("Auto Mute Mono Switch", PCM512x_DIGITAL_MUTE_3,
319 PCM512x_ACTL_SHIFT, 1, 0),
320 SOC_DOUBLE("Auto Mute Switch", PCM512x_DIGITAL_MUTE_3, PCM512x_AMLE_SHIFT,
321 PCM512x_AMRE_SHIFT, 1, 0),
323 SOC_ENUM("Volume Ramp Down Rate", pcm512x_vndf),
324 SOC_ENUM("Volume Ramp Down Step", pcm512x_vnds),
325 SOC_ENUM("Volume Ramp Up Rate", pcm512x_vnuf),
326 SOC_ENUM("Volume Ramp Up Step", pcm512x_vnus),
327 SOC_ENUM("Volume Ramp Down Emergency Rate", pcm512x_vedf),
328 SOC_ENUM("Volume Ramp Down Emergency Step", pcm512x_veds),
331 static const struct snd_soc_dapm_widget pcm512x_dapm_widgets[] = {
332 SND_SOC_DAPM_DAC("DACL", NULL, SND_SOC_NOPM, 0, 0),
333 SND_SOC_DAPM_DAC("DACR", NULL, SND_SOC_NOPM, 0, 0),
335 SND_SOC_DAPM_OUTPUT("OUTL"),
336 SND_SOC_DAPM_OUTPUT("OUTR"),
339 static const struct snd_soc_dapm_route pcm512x_dapm_routes[] = {
340 { "DACL", NULL, "Playback" },
341 { "DACR", NULL, "Playback" },
343 { "OUTL", NULL, "DACL" },
344 { "OUTR", NULL, "DACR" },
347 static const u32 pcm512x_dai_rates[] = {
348 8000, 11025, 16000, 22050, 32000, 44100, 48000, 64000,
349 88200, 96000, 176400, 192000, 384000,
352 static const struct snd_pcm_hw_constraint_list constraints_slave = {
353 .count = ARRAY_SIZE(pcm512x_dai_rates),
354 .list = pcm512x_dai_rates,
357 static const struct snd_interval pcm512x_dai_ranges_64bpf[] = {
367 static struct snd_pcm_hw_constraint_ranges constraints_64bpf = {
368 .count = ARRAY_SIZE(pcm512x_dai_ranges_64bpf),
369 .ranges = pcm512x_dai_ranges_64bpf,
372 static int pcm512x_hw_rule_rate(struct snd_pcm_hw_params *params,
373 struct snd_pcm_hw_rule *rule)
375 struct snd_pcm_hw_constraint_ranges *r = rule->private;
378 frame_size = snd_soc_params_to_frame_size(params);
382 if (frame_size != 64)
385 return snd_interval_ranges(hw_param_interval(params, rule->var),
386 r->count, r->ranges, r->mask);
389 static int pcm512x_dai_startup_master(struct snd_pcm_substream *substream,
390 struct snd_soc_dai *dai)
392 struct snd_soc_codec *codec = dai->codec;
393 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
394 struct device *dev = dai->dev;
395 struct snd_pcm_hw_constraint_ratnums *constraints_no_pll;
396 struct snd_ratnum *rats_no_pll;
398 if (IS_ERR(pcm512x->sclk)) {
399 dev_err(dev, "Need SCLK for master mode: %ld\n",
400 PTR_ERR(pcm512x->sclk));
401 return PTR_ERR(pcm512x->sclk);
404 if (pcm512x->pll_out)
405 return snd_pcm_hw_rule_add(substream->runtime, 0,
406 SNDRV_PCM_HW_PARAM_RATE,
407 pcm512x_hw_rule_rate,
408 (void *)&constraints_64bpf,
409 SNDRV_PCM_HW_PARAM_FRAME_BITS,
410 SNDRV_PCM_HW_PARAM_CHANNELS, -1);
412 constraints_no_pll = devm_kzalloc(dev, sizeof(*constraints_no_pll),
414 if (!constraints_no_pll)
416 constraints_no_pll->nrats = 1;
417 rats_no_pll = devm_kzalloc(dev, sizeof(*rats_no_pll), GFP_KERNEL);
420 constraints_no_pll->rats = rats_no_pll;
421 rats_no_pll->num = clk_get_rate(pcm512x->sclk) / 64;
422 rats_no_pll->den_min = 1;
423 rats_no_pll->den_max = 128;
424 rats_no_pll->den_step = 1;
426 return snd_pcm_hw_constraint_ratnums(substream->runtime, 0,
427 SNDRV_PCM_HW_PARAM_RATE,
431 static int pcm512x_dai_startup_slave(struct snd_pcm_substream *substream,
432 struct snd_soc_dai *dai)
434 struct snd_soc_codec *codec = dai->codec;
435 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
436 struct device *dev = dai->dev;
437 struct regmap *regmap = pcm512x->regmap;
439 if (IS_ERR(pcm512x->sclk)) {
440 dev_info(dev, "No SCLK, using BCLK: %ld\n",
441 PTR_ERR(pcm512x->sclk));
443 /* Disable reporting of missing SCLK as an error */
444 regmap_update_bits(regmap, PCM512x_ERROR_DETECT,
445 PCM512x_IDCH, PCM512x_IDCH);
447 /* Switch PLL input to BCLK */
448 regmap_update_bits(regmap, PCM512x_PLL_REF,
449 PCM512x_SREF, PCM512x_SREF_BCK);
452 return snd_pcm_hw_constraint_list(substream->runtime, 0,
453 SNDRV_PCM_HW_PARAM_RATE,
457 static int pcm512x_dai_startup(struct snd_pcm_substream *substream,
458 struct snd_soc_dai *dai)
460 struct snd_soc_codec *codec = dai->codec;
461 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
463 switch (pcm512x->fmt & SND_SOC_DAIFMT_MASTER_MASK) {
464 case SND_SOC_DAIFMT_CBM_CFM:
465 return pcm512x_dai_startup_master(substream, dai);
467 case SND_SOC_DAIFMT_CBS_CFS:
468 return pcm512x_dai_startup_slave(substream, dai);
475 static int pcm512x_set_bias_level(struct snd_soc_codec *codec,
476 enum snd_soc_bias_level level)
478 struct pcm512x_priv *pcm512x = dev_get_drvdata(codec->dev);
482 case SND_SOC_BIAS_ON:
483 case SND_SOC_BIAS_PREPARE:
486 case SND_SOC_BIAS_STANDBY:
487 ret = regmap_update_bits(pcm512x->regmap, PCM512x_POWER,
490 dev_err(codec->dev, "Failed to remove standby: %d\n",
496 case SND_SOC_BIAS_OFF:
497 ret = regmap_update_bits(pcm512x->regmap, PCM512x_POWER,
498 PCM512x_RQST, PCM512x_RQST);
500 dev_err(codec->dev, "Failed to request standby: %d\n",
507 codec->dapm.bias_level = level;
512 static unsigned long pcm512x_find_sck(struct snd_soc_dai *dai,
513 unsigned long bclk_rate)
515 struct device *dev = dai->dev;
516 unsigned long sck_rate;
519 /* 64 MHz <= pll_rate <= 100 MHz, VREF mode */
520 /* 16 MHz <= sck_rate <= 25 MHz, VREF mode */
522 /* select sck_rate as a multiple of bclk_rate but still with
523 * as many factors of 2 as possible, as that makes it easier
524 * to find a fast DAC rate
526 pow2 = 1 << fls((25000000 - 16000000) / bclk_rate);
527 for (; pow2; pow2 >>= 1) {
528 sck_rate = rounddown(25000000, bclk_rate * pow2);
529 if (sck_rate >= 16000000)
533 dev_err(dev, "Impossible to generate a suitable SCK\n");
537 dev_dbg(dev, "sck_rate %lu\n", sck_rate);
541 /* pll_rate = pllin_rate * R * J.D / P
546 * 64 MHz <= pll_rate <= 100 MHz
548 * 1 MHz <= pllin_rate / P <= 20 MHz
550 * 6.667 MHz <= pllin_rate / P <= 20 MHz
554 static int pcm512x_find_pll_coeff(struct snd_soc_dai *dai,
555 unsigned long pllin_rate,
556 unsigned long pll_rate)
558 struct device *dev = dai->dev;
559 struct snd_soc_codec *codec = dai->codec;
560 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
561 unsigned long common;
563 unsigned long K; /* 10000 * J.D */
567 common = gcd(pll_rate, pllin_rate);
568 dev_dbg(dev, "pll %lu pllin %lu common %lu\n",
569 pll_rate, pllin_rate, common);
570 num = pll_rate / common;
571 den = pllin_rate / common;
573 /* pllin_rate / P (or here, den) cannot be greater than 20 MHz */
574 if (pllin_rate / den > 20000000 && num < 8) {
575 num *= 20000000 / (pllin_rate / den);
576 den *= 20000000 / (pllin_rate / den);
578 dev_dbg(dev, "num / den = %lu / %lu\n", num, den);
581 if (den <= 15 && num <= 16 * 63
582 && 1000000 <= pllin_rate / P && pllin_rate / P <= 20000000) {
583 /* Try the case with D = 0 */
585 /* factor 'num' into J and R, such that R <= 16 and J <= 63 */
586 for (R = 16; R; R--) {
590 if (J == 0 || J > 63)
593 dev_dbg(dev, "R * J / P = %d * %d / %d\n", R, J, P);
594 pcm512x->real_pll = pll_rate;
602 if (num > 0xffffffffUL / 10000)
605 /* Try to find an exact pll_rate using the D > 0 case */
606 common = gcd(10000 * num, den);
607 num = 10000 * num / common;
609 dev_dbg(dev, "num %lu den %lu common %lu\n", num, den, common);
611 for (P = den; P <= 15; P++) {
612 if (pllin_rate / P < 6667000 || 200000000 < pllin_rate / P)
617 /* J == 12 is ok if D == 0 */
618 if (K < 40000 || K > 120000)
623 dev_dbg(dev, "J.D / P = %d.%04d / %d\n", J, D, P);
624 pcm512x->real_pll = pll_rate;
628 /* Fall back to an approximate pll_rate */
631 /* find smallest possible P */
632 P = DIV_ROUND_UP(pllin_rate, 20000000);
636 dev_err(dev, "Need a slower clock as pll-input\n");
639 if (pllin_rate / P < 6667000) {
640 dev_err(dev, "Need a faster clock as pll-input\n");
643 K = DIV_ROUND_CLOSEST_ULL(10000ULL * pll_rate * P, pllin_rate);
646 /* J == 12 is ok if D == 0 */
651 dev_dbg(dev, "J.D / P ~ %d.%04d / %d\n", J, D, P);
652 pcm512x->real_pll = DIV_ROUND_DOWN_ULL((u64)K * pllin_rate, 10000 * P);
662 static int pcm512x_set_dividers(struct snd_soc_dai *dai,
663 struct snd_pcm_hw_params *params)
665 struct device *dev = dai->dev;
666 struct snd_soc_codec *codec = dai->codec;
667 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
668 unsigned long pllin_rate = 0;
669 unsigned long pll_rate;
670 unsigned long sck_rate;
671 unsigned long mck_rate;
672 unsigned long bclk_rate;
673 unsigned long sample_rate;
674 unsigned long osr_rate;
679 unsigned long dac_rate;
682 unsigned long dac_mul;
683 unsigned long sck_mul;
688 lrclk_div = snd_soc_params_to_frame_size(params);
689 if (lrclk_div == 0) {
690 dev_err(dev, "No LRCLK?\n");
694 if (!pcm512x->pll_out) {
695 sck_rate = clk_get_rate(pcm512x->sclk);
696 bclk_div = params->rate_den * 64 / lrclk_div;
697 bclk_rate = DIV_ROUND_CLOSEST(sck_rate, bclk_div);
701 ret = snd_soc_params_to_bclk(params);
703 dev_err(dev, "Failed to find suitable BCLK: %d\n", ret);
707 dev_err(dev, "No BCLK?\n");
712 pllin_rate = clk_get_rate(pcm512x->sclk);
714 sck_rate = pcm512x_find_sck(dai, bclk_rate);
717 pll_rate = 4 * sck_rate;
719 ret = pcm512x_find_pll_coeff(dai, pllin_rate, pll_rate);
723 ret = regmap_write(pcm512x->regmap,
724 PCM512x_PLL_COEFF_0, pcm512x->pll_p - 1);
726 dev_err(dev, "Failed to write PLL P: %d\n", ret);
730 ret = regmap_write(pcm512x->regmap,
731 PCM512x_PLL_COEFF_1, pcm512x->pll_j);
733 dev_err(dev, "Failed to write PLL J: %d\n", ret);
737 ret = regmap_write(pcm512x->regmap,
738 PCM512x_PLL_COEFF_2, pcm512x->pll_d >> 8);
740 dev_err(dev, "Failed to write PLL D msb: %d\n", ret);
744 ret = regmap_write(pcm512x->regmap,
745 PCM512x_PLL_COEFF_3, pcm512x->pll_d & 0xff);
747 dev_err(dev, "Failed to write PLL D lsb: %d\n", ret);
751 ret = regmap_write(pcm512x->regmap,
752 PCM512x_PLL_COEFF_4, pcm512x->pll_r - 1);
754 dev_err(dev, "Failed to write PLL R: %d\n", ret);
758 mck_rate = pcm512x->real_pll;
760 bclk_div = DIV_ROUND_CLOSEST(sck_rate, bclk_rate);
763 if (bclk_div > 128) {
764 dev_err(dev, "Failed to find BCLK divider\n");
768 /* the actual rate */
769 sample_rate = sck_rate / bclk_div / lrclk_div;
770 osr_rate = 16 * sample_rate;
772 /* run DSP no faster than 50 MHz */
773 dsp_div = mck_rate > 50000000 ? 2 : 1;
775 /* run DAC no faster than 6144000 Hz */
776 dac_mul = 6144000 / osr_rate;
777 sck_mul = sck_rate / osr_rate;
778 for (; dac_mul; dac_mul--) {
779 if (!(sck_mul % dac_mul))
783 dev_err(dev, "Failed to find DAC rate\n");
787 dac_rate = dac_mul * osr_rate;
788 dev_dbg(dev, "dac_rate %lu sample_rate %lu\n", dac_rate, sample_rate);
790 dac_div = DIV_ROUND_CLOSEST(sck_rate, dac_rate);
792 dev_err(dev, "Failed to find DAC divider\n");
796 ncp_div = DIV_ROUND_CLOSEST(sck_rate / dac_div, 1536000);
797 if (ncp_div > 128 || sck_rate / dac_div / ncp_div > 2048000) {
798 /* run NCP no faster than 2048000 Hz, but why? */
799 ncp_div = DIV_ROUND_UP(sck_rate / dac_div, 2048000);
801 dev_err(dev, "Failed to find NCP divider\n");
806 osr_div = DIV_ROUND_CLOSEST(dac_rate, osr_rate);
808 dev_err(dev, "Failed to find OSR divider\n");
812 idac = mck_rate / (dsp_div * sample_rate);
814 ret = regmap_write(pcm512x->regmap, PCM512x_DSP_CLKDIV, dsp_div - 1);
816 dev_err(dev, "Failed to write DSP divider: %d\n", ret);
820 ret = regmap_write(pcm512x->regmap, PCM512x_DAC_CLKDIV, dac_div - 1);
822 dev_err(dev, "Failed to write DAC divider: %d\n", ret);
826 ret = regmap_write(pcm512x->regmap, PCM512x_NCP_CLKDIV, ncp_div - 1);
828 dev_err(dev, "Failed to write NCP divider: %d\n", ret);
832 ret = regmap_write(pcm512x->regmap, PCM512x_OSR_CLKDIV, osr_div - 1);
834 dev_err(dev, "Failed to write OSR divider: %d\n", ret);
838 ret = regmap_write(pcm512x->regmap,
839 PCM512x_MASTER_CLKDIV_1, bclk_div - 1);
841 dev_err(dev, "Failed to write BCLK divider: %d\n", ret);
845 ret = regmap_write(pcm512x->regmap,
846 PCM512x_MASTER_CLKDIV_2, lrclk_div - 1);
848 dev_err(dev, "Failed to write LRCLK divider: %d\n", ret);
852 ret = regmap_write(pcm512x->regmap, PCM512x_IDAC_1, idac >> 8);
854 dev_err(dev, "Failed to write IDAC msb divider: %d\n", ret);
858 ret = regmap_write(pcm512x->regmap, PCM512x_IDAC_2, idac & 0xff);
860 dev_err(dev, "Failed to write IDAC lsb divider: %d\n", ret);
864 if (sample_rate <= 48000)
865 fssp = PCM512x_FSSP_48KHZ;
866 else if (sample_rate <= 96000)
867 fssp = PCM512x_FSSP_96KHZ;
868 else if (sample_rate <= 192000)
869 fssp = PCM512x_FSSP_192KHZ;
871 fssp = PCM512x_FSSP_384KHZ;
872 ret = regmap_update_bits(pcm512x->regmap, PCM512x_FS_SPEED_MODE,
875 dev_err(codec->dev, "Failed to set fs speed: %d\n", ret);
879 dev_dbg(codec->dev, "DSP divider %d\n", dsp_div);
880 dev_dbg(codec->dev, "DAC divider %d\n", dac_div);
881 dev_dbg(codec->dev, "NCP divider %d\n", ncp_div);
882 dev_dbg(codec->dev, "OSR divider %d\n", osr_div);
883 dev_dbg(codec->dev, "BCK divider %d\n", bclk_div);
884 dev_dbg(codec->dev, "LRCK divider %d\n", lrclk_div);
885 dev_dbg(codec->dev, "IDAC %d\n", idac);
886 dev_dbg(codec->dev, "1<<FSSP %d\n", 1 << fssp);
891 static int pcm512x_hw_params(struct snd_pcm_substream *substream,
892 struct snd_pcm_hw_params *params,
893 struct snd_soc_dai *dai)
895 struct snd_soc_codec *codec = dai->codec;
896 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
901 dev_dbg(codec->dev, "hw_params %u Hz, %u channels\n",
903 params_channels(params));
905 switch (snd_pcm_format_width(params_format(params))) {
907 alen = PCM512x_ALEN_16;
910 alen = PCM512x_ALEN_20;
913 alen = PCM512x_ALEN_24;
916 alen = PCM512x_ALEN_32;
919 dev_err(codec->dev, "Bad frame size: %d\n",
920 snd_pcm_format_width(params_format(params)));
924 switch (pcm512x->fmt & SND_SOC_DAIFMT_MASTER_MASK) {
925 case SND_SOC_DAIFMT_CBS_CFS:
926 ret = regmap_update_bits(pcm512x->regmap,
927 PCM512x_BCLK_LRCLK_CFG,
929 | PCM512x_BCKO | PCM512x_LRKO,
933 "Failed to enable slave mode: %d\n", ret);
937 ret = regmap_update_bits(pcm512x->regmap, PCM512x_ERROR_DETECT,
941 "Failed to enable clock divider autoset: %d\n",
946 case SND_SOC_DAIFMT_CBM_CFM:
952 ret = regmap_update_bits(pcm512x->regmap, PCM512x_I2S_1,
955 dev_err(codec->dev, "Failed to set frame size: %d\n", ret);
959 if (pcm512x->pll_out) {
960 ret = regmap_write(pcm512x->regmap, PCM512x_FLEX_A, 0x11);
962 dev_err(codec->dev, "Failed to set FLEX_A: %d\n", ret);
966 ret = regmap_write(pcm512x->regmap, PCM512x_FLEX_B, 0xff);
968 dev_err(codec->dev, "Failed to set FLEX_B: %d\n", ret);
972 ret = regmap_update_bits(pcm512x->regmap, PCM512x_ERROR_DETECT,
973 PCM512x_IDFS | PCM512x_IDBK
974 | PCM512x_IDSK | PCM512x_IDCH
975 | PCM512x_IDCM | PCM512x_DCAS
977 PCM512x_IDFS | PCM512x_IDBK
978 | PCM512x_IDSK | PCM512x_IDCH
982 "Failed to ignore auto-clock failures: %d\n",
987 ret = regmap_update_bits(pcm512x->regmap, PCM512x_ERROR_DETECT,
988 PCM512x_IDFS | PCM512x_IDBK
989 | PCM512x_IDSK | PCM512x_IDCH
990 | PCM512x_IDCM | PCM512x_DCAS
992 PCM512x_IDFS | PCM512x_IDBK
993 | PCM512x_IDSK | PCM512x_IDCH
994 | PCM512x_DCAS | PCM512x_IPLK);
997 "Failed to ignore auto-clock failures: %d\n",
1002 ret = regmap_update_bits(pcm512x->regmap, PCM512x_PLL_EN,
1005 dev_err(codec->dev, "Failed to disable pll: %d\n", ret);
1010 ret = pcm512x_set_dividers(dai, params);
1014 ret = regmap_update_bits(pcm512x->regmap, PCM512x_DAC_REF,
1015 PCM512x_SDAC, PCM512x_SDAC_SCK);
1017 dev_err(codec->dev, "Failed to set sck as dacref: %d\n", ret);
1021 if (pcm512x->pll_out) {
1022 ret = regmap_update_bits(pcm512x->regmap, PCM512x_PLL_REF,
1023 PCM512x_SREF, PCM512x_SREF_GPIO);
1026 "Failed to set gpio as pllref: %d\n", ret);
1030 gpio = PCM512x_GREF_GPIO1 + pcm512x->pll_in - 1;
1031 ret = regmap_update_bits(pcm512x->regmap, PCM512x_GPIO_PLLIN,
1032 PCM512x_GREF, gpio);
1035 "Failed to set gpio %d as pllin: %d\n",
1036 pcm512x->pll_in, ret);
1040 ret = regmap_update_bits(pcm512x->regmap, PCM512x_PLL_EN,
1041 PCM512x_PLLE, PCM512x_PLLE);
1043 dev_err(codec->dev, "Failed to enable pll: %d\n", ret);
1048 ret = regmap_update_bits(pcm512x->regmap, PCM512x_BCLK_LRCLK_CFG,
1049 PCM512x_BCKP | PCM512x_BCKO | PCM512x_LRKO,
1050 PCM512x_BCKO | PCM512x_LRKO);
1052 dev_err(codec->dev, "Failed to enable clock output: %d\n", ret);
1056 ret = regmap_update_bits(pcm512x->regmap, PCM512x_MASTER_MODE,
1057 PCM512x_RLRK | PCM512x_RBCK,
1058 PCM512x_RLRK | PCM512x_RBCK);
1060 dev_err(codec->dev, "Failed to enable master mode: %d\n", ret);
1064 if (pcm512x->pll_out) {
1065 gpio = PCM512x_G1OE << (pcm512x->pll_out - 1);
1066 ret = regmap_update_bits(pcm512x->regmap, PCM512x_GPIO_EN,
1069 dev_err(codec->dev, "Failed to enable gpio %d: %d\n",
1070 pcm512x->pll_out, ret);
1074 gpio = PCM512x_GPIO_OUTPUT_1 + pcm512x->pll_out - 1;
1075 ret = regmap_update_bits(pcm512x->regmap, gpio,
1076 PCM512x_GxSL, PCM512x_GxSL_PLLCK);
1078 dev_err(codec->dev, "Failed to output pll on %d: %d\n",
1079 ret, pcm512x->pll_out);
1083 gpio = PCM512x_G1OE << (4 - 1);
1084 ret = regmap_update_bits(pcm512x->regmap, PCM512x_GPIO_EN,
1087 dev_err(codec->dev, "Failed to enable gpio %d: %d\n",
1092 gpio = PCM512x_GPIO_OUTPUT_1 + 4 - 1;
1093 ret = regmap_update_bits(pcm512x->regmap, gpio,
1094 PCM512x_GxSL, PCM512x_GxSL_PLLLK);
1097 "Failed to output pll lock on %d: %d\n",
1103 ret = regmap_update_bits(pcm512x->regmap, PCM512x_SYNCHRONIZE,
1104 PCM512x_RQSY, PCM512x_RQSY_HALT);
1106 dev_err(codec->dev, "Failed to halt clocks: %d\n", ret);
1110 ret = regmap_update_bits(pcm512x->regmap, PCM512x_SYNCHRONIZE,
1111 PCM512x_RQSY, PCM512x_RQSY_RESUME);
1113 dev_err(codec->dev, "Failed to resume clocks: %d\n", ret);
1120 static int pcm512x_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
1122 struct snd_soc_codec *codec = dai->codec;
1123 struct pcm512x_priv *pcm512x = snd_soc_codec_get_drvdata(codec);
1130 static const struct snd_soc_dai_ops pcm512x_dai_ops = {
1131 .startup = pcm512x_dai_startup,
1132 .hw_params = pcm512x_hw_params,
1133 .set_fmt = pcm512x_set_fmt,
1136 static struct snd_soc_dai_driver pcm512x_dai = {
1137 .name = "pcm512x-hifi",
1139 .stream_name = "Playback",
1142 .rates = SNDRV_PCM_RATE_CONTINUOUS,
1145 .formats = SNDRV_PCM_FMTBIT_S16_LE |
1146 SNDRV_PCM_FMTBIT_S24_LE |
1147 SNDRV_PCM_FMTBIT_S32_LE
1149 .ops = &pcm512x_dai_ops,
1152 static struct snd_soc_codec_driver pcm512x_codec_driver = {
1153 .set_bias_level = pcm512x_set_bias_level,
1154 .idle_bias_off = true,
1156 .controls = pcm512x_controls,
1157 .num_controls = ARRAY_SIZE(pcm512x_controls),
1158 .dapm_widgets = pcm512x_dapm_widgets,
1159 .num_dapm_widgets = ARRAY_SIZE(pcm512x_dapm_widgets),
1160 .dapm_routes = pcm512x_dapm_routes,
1161 .num_dapm_routes = ARRAY_SIZE(pcm512x_dapm_routes),
1164 static const struct regmap_range_cfg pcm512x_range = {
1165 .name = "Pages", .range_min = PCM512x_VIRT_BASE,
1166 .range_max = PCM512x_MAX_REGISTER,
1167 .selector_reg = PCM512x_PAGE,
1168 .selector_mask = 0xff,
1169 .window_start = 0, .window_len = 0x100,
1172 const struct regmap_config pcm512x_regmap = {
1176 .readable_reg = pcm512x_readable,
1177 .volatile_reg = pcm512x_volatile,
1179 .ranges = &pcm512x_range,
1182 .max_register = PCM512x_MAX_REGISTER,
1183 .reg_defaults = pcm512x_reg_defaults,
1184 .num_reg_defaults = ARRAY_SIZE(pcm512x_reg_defaults),
1185 .cache_type = REGCACHE_RBTREE,
1187 EXPORT_SYMBOL_GPL(pcm512x_regmap);
1189 int pcm512x_probe(struct device *dev, struct regmap *regmap)
1191 struct pcm512x_priv *pcm512x;
1195 pcm512x = devm_kzalloc(dev, sizeof(struct pcm512x_priv), GFP_KERNEL);
1199 dev_set_drvdata(dev, pcm512x);
1200 pcm512x->regmap = regmap;
1202 for (i = 0; i < ARRAY_SIZE(pcm512x->supplies); i++)
1203 pcm512x->supplies[i].supply = pcm512x_supply_names[i];
1205 ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(pcm512x->supplies),
1208 dev_err(dev, "Failed to get supplies: %d\n", ret);
1212 pcm512x->supply_nb[0].notifier_call = pcm512x_regulator_event_0;
1213 pcm512x->supply_nb[1].notifier_call = pcm512x_regulator_event_1;
1214 pcm512x->supply_nb[2].notifier_call = pcm512x_regulator_event_2;
1216 for (i = 0; i < ARRAY_SIZE(pcm512x->supplies); i++) {
1217 ret = regulator_register_notifier(pcm512x->supplies[i].consumer,
1218 &pcm512x->supply_nb[i]);
1221 "Failed to register regulator notifier: %d\n",
1226 ret = regulator_bulk_enable(ARRAY_SIZE(pcm512x->supplies),
1229 dev_err(dev, "Failed to enable supplies: %d\n", ret);
1233 /* Reset the device, verifying I/O in the process for I2C */
1234 ret = regmap_write(regmap, PCM512x_RESET,
1235 PCM512x_RSTM | PCM512x_RSTR);
1237 dev_err(dev, "Failed to reset device: %d\n", ret);
1241 ret = regmap_write(regmap, PCM512x_RESET, 0);
1243 dev_err(dev, "Failed to reset device: %d\n", ret);
1247 pcm512x->sclk = devm_clk_get(dev, NULL);
1248 if (PTR_ERR(pcm512x->sclk) == -EPROBE_DEFER)
1249 return -EPROBE_DEFER;
1250 if (!IS_ERR(pcm512x->sclk)) {
1251 ret = clk_prepare_enable(pcm512x->sclk);
1253 dev_err(dev, "Failed to enable SCLK: %d\n", ret);
1258 /* Default to standby mode */
1259 ret = regmap_update_bits(pcm512x->regmap, PCM512x_POWER,
1260 PCM512x_RQST, PCM512x_RQST);
1262 dev_err(dev, "Failed to request standby: %d\n",
1267 pm_runtime_set_active(dev);
1268 pm_runtime_enable(dev);
1269 pm_runtime_idle(dev);
1273 const struct device_node *np = dev->of_node;
1275 if (of_property_read_u32(np, "pll-in", &val) >= 0) {
1277 dev_err(dev, "Invalid pll-in\n");
1281 pcm512x->pll_in = val;
1284 if (of_property_read_u32(np, "pll-out", &val) >= 0) {
1286 dev_err(dev, "Invalid pll-out\n");
1290 pcm512x->pll_out = val;
1293 if (!pcm512x->pll_in != !pcm512x->pll_out) {
1295 "Error: both pll-in and pll-out, or none\n");
1299 if (pcm512x->pll_in && pcm512x->pll_in == pcm512x->pll_out) {
1300 dev_err(dev, "Error: pll-in == pll-out\n");
1307 ret = snd_soc_register_codec(dev, &pcm512x_codec_driver,
1310 dev_err(dev, "Failed to register CODEC: %d\n", ret);
1317 pm_runtime_disable(dev);
1319 if (!IS_ERR(pcm512x->sclk))
1320 clk_disable_unprepare(pcm512x->sclk);
1322 regulator_bulk_disable(ARRAY_SIZE(pcm512x->supplies),
1326 EXPORT_SYMBOL_GPL(pcm512x_probe);
1328 void pcm512x_remove(struct device *dev)
1330 struct pcm512x_priv *pcm512x = dev_get_drvdata(dev);
1332 snd_soc_unregister_codec(dev);
1333 pm_runtime_disable(dev);
1334 if (!IS_ERR(pcm512x->sclk))
1335 clk_disable_unprepare(pcm512x->sclk);
1336 regulator_bulk_disable(ARRAY_SIZE(pcm512x->supplies),
1339 EXPORT_SYMBOL_GPL(pcm512x_remove);
1342 static int pcm512x_suspend(struct device *dev)
1344 struct pcm512x_priv *pcm512x = dev_get_drvdata(dev);
1347 ret = regmap_update_bits(pcm512x->regmap, PCM512x_POWER,
1348 PCM512x_RQPD, PCM512x_RQPD);
1350 dev_err(dev, "Failed to request power down: %d\n", ret);
1354 ret = regulator_bulk_disable(ARRAY_SIZE(pcm512x->supplies),
1357 dev_err(dev, "Failed to disable supplies: %d\n", ret);
1361 if (!IS_ERR(pcm512x->sclk))
1362 clk_disable_unprepare(pcm512x->sclk);
1367 static int pcm512x_resume(struct device *dev)
1369 struct pcm512x_priv *pcm512x = dev_get_drvdata(dev);
1372 if (!IS_ERR(pcm512x->sclk)) {
1373 ret = clk_prepare_enable(pcm512x->sclk);
1375 dev_err(dev, "Failed to enable SCLK: %d\n", ret);
1380 ret = regulator_bulk_enable(ARRAY_SIZE(pcm512x->supplies),
1383 dev_err(dev, "Failed to enable supplies: %d\n", ret);
1387 regcache_cache_only(pcm512x->regmap, false);
1388 ret = regcache_sync(pcm512x->regmap);
1390 dev_err(dev, "Failed to sync cache: %d\n", ret);
1394 ret = regmap_update_bits(pcm512x->regmap, PCM512x_POWER,
1397 dev_err(dev, "Failed to remove power down: %d\n", ret);
1405 const struct dev_pm_ops pcm512x_pm_ops = {
1406 SET_RUNTIME_PM_OPS(pcm512x_suspend, pcm512x_resume, NULL)
1408 EXPORT_SYMBOL_GPL(pcm512x_pm_ops);
1410 MODULE_DESCRIPTION("ASoC PCM512x codec driver");
1411 MODULE_AUTHOR("Mark Brown <broonie@linaro.org>");
1412 MODULE_LICENSE("GPL v2");