2 * max9867.c -- max9867 ALSA SoC Audio driver
4 * Copyright 2013-15 Maxim Integrated Products
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/delay.h>
12 #include <linux/i2c.h>
13 #include <linux/module.h>
14 #include <linux/regmap.h>
15 #include <sound/pcm_params.h>
16 #include <sound/soc.h>
17 #include <sound/tlv.h>
20 static const char *const max9867_spmode[] = {
21 "Stereo Diff", "Mono Diff",
22 "Stereo Cap", "Mono Cap",
23 "Stereo Single", "Mono Single",
24 "Stereo Single Fast", "Mono Single Fast"
26 static const char *const max9867_sidetone_text[] = {
27 "None", "Left", "Right", "LeftRight", "LeftRightDiv2",
29 static const char *const max9867_filter_text[] = {"IIR", "FIR"};
31 static SOC_ENUM_SINGLE_DECL(max9867_filter, MAX9867_CODECFLTR, 7,
33 static SOC_ENUM_SINGLE_DECL(max9867_spkmode, MAX9867_MODECONFIG, 0,
35 static SOC_ENUM_SINGLE_DECL(max9867_sidetone, MAX9867_DACGAIN, 6,
36 max9867_sidetone_text);
37 static DECLARE_TLV_DB_SCALE(max9860_capture_tlv, -600, 200, 0);
38 static DECLARE_TLV_DB_SCALE(max9860_mic_tlv, 2000, 100, 1);
39 static DECLARE_TLV_DB_SCALE(max9860_adc_left_tlv, -1200, 100, 1);
40 static DECLARE_TLV_DB_SCALE(max9860_adc_right_tlv, -1200, 100, 1);
41 static const unsigned int max98088_micboost_tlv[] = {
43 0, 1, TLV_DB_SCALE_ITEM(0, 2000, 0),
44 2, 2, TLV_DB_SCALE_ITEM(3000, 0, 0),
47 static const struct snd_kcontrol_new max9867_snd_controls[] = {
48 SOC_DOUBLE_R("Master Playback Volume", MAX9867_LEFTVOL,
49 MAX9867_RIGHTVOL, 0, 63, 1),
50 SOC_DOUBLE_R_TLV("Capture Volume", MAX9867_LEFTMICGAIN,
52 0, 15, 1, max9860_capture_tlv),
53 SOC_DOUBLE_R_TLV("Mic Volume", MAX9867_LEFTMICGAIN,
54 MAX9867_RIGHTMICGAIN, 0, 31, 1, max9860_mic_tlv),
55 SOC_DOUBLE_R_TLV("Mic Boost Volume", MAX9867_LEFTMICGAIN,
56 MAX9867_RIGHTMICGAIN, 5, 3, 0, max98088_micboost_tlv),
57 SOC_ENUM("Digital Sidetone Src", max9867_sidetone),
58 SOC_SINGLE("Sidetone Volume", MAX9867_DACGAIN, 0, 31, 1),
59 SOC_SINGLE("DAC Volume", MAX9867_DACLEVEL, 4, 3, 0),
60 SOC_SINGLE("DAC Attenuation", MAX9867_DACLEVEL, 0, 15, 1),
61 SOC_SINGLE_TLV("ADC Left Volume", MAX9867_ADCLEVEL,
62 4, 15, 1, max9860_adc_left_tlv),
63 SOC_SINGLE_TLV("ADC Right Volume", MAX9867_ADCLEVEL,
64 0, 15, 1, max9860_adc_right_tlv),
65 SOC_ENUM("Speaker Mode", max9867_spkmode),
66 SOC_SINGLE("Volume Smoothing Switch", MAX9867_MODECONFIG, 6, 1, 0),
67 SOC_SINGLE("ZCD Switch", MAX9867_MODECONFIG, 5, 1, 0),
68 SOC_ENUM("DSP Filter", max9867_filter),
71 static const char *const max9867_mux[] = {"None", "Mic", "Line", "Mic_Line"};
73 static SOC_ENUM_SINGLE_DECL(max9867_mux_enum,
74 MAX9867_INPUTCONFIG, MAX9867_INPUT_SHIFT,
77 static const struct snd_kcontrol_new max9867_dapm_mux_controls =
78 SOC_DAPM_ENUM("Route", max9867_mux_enum);
80 static const struct snd_kcontrol_new max9867_left_dapm_control =
81 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN, 6, 1, 0);
82 static const struct snd_kcontrol_new max9867_right_dapm_control =
83 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN, 5, 1, 0);
84 static const struct snd_kcontrol_new max9867_line_dapm_control =
85 SOC_DAPM_SINGLE("Switch", MAX9867_LEFTLINELVL, 6, 1, 1);
87 static const struct snd_soc_dapm_widget max9867_dapm_widgets[] = {
88 SND_SOC_DAPM_AIF_IN("DAI_OUT", "HiFi Playback", 0, SND_SOC_NOPM, 0, 0),
89 SND_SOC_DAPM_DAC("Left DAC", NULL, MAX9867_PWRMAN, 3, 0),
90 SND_SOC_DAPM_DAC("Right DAC", NULL, MAX9867_PWRMAN, 2, 0),
91 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
92 SND_SOC_DAPM_OUTPUT("HPOUT"),
94 SND_SOC_DAPM_AIF_IN("DAI_IN", "HiFi Capture", 0, SND_SOC_NOPM, 0, 0),
95 SND_SOC_DAPM_ADC("Left ADC", "HiFi Capture", MAX9867_PWRMAN, 1, 0),
96 SND_SOC_DAPM_ADC("Right ADC", "HiFi Capture", MAX9867_PWRMAN, 0, 0),
97 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0,
98 &max9867_dapm_mux_controls),
100 SND_SOC_DAPM_MIXER("Input Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
101 SND_SOC_DAPM_SWITCH("Left Line", MAX9867_LEFTLINELVL, 6, 1,
102 &max9867_left_dapm_control),
103 SND_SOC_DAPM_SWITCH("Right Line", MAX9867_RIGTHLINELVL, 6, 1,
104 &max9867_right_dapm_control),
105 SND_SOC_DAPM_SWITCH("Line Mixer", SND_SOC_NOPM, 0, 0,
106 &max9867_line_dapm_control),
107 SND_SOC_DAPM_INPUT("LINE_IN"),
110 static const struct snd_soc_dapm_route max9867_audio_map[] = {
111 {"Left DAC", NULL, "DAI_OUT"},
112 {"Right DAC", NULL, "DAI_OUT"},
113 {"Output Mixer", NULL, "Left DAC"},
114 {"Output Mixer", NULL, "Right DAC"},
115 {"HPOUT", NULL, "Output Mixer"},
117 {"Left ADC", NULL, "DAI_IN"},
118 {"Right ADC", NULL, "DAI_IN"},
119 {"Input Mixer", NULL, "Left ADC"},
120 {"Input Mixer", NULL, "Right ADC"},
121 {"Input Mux", "Line", "Input Mixer"},
122 {"Input Mux", "Mic", "Input Mixer"},
123 {"Input Mux", "Mic_Line", "Input Mixer"},
124 {"Right Line", "Switch", "Input Mux"},
125 {"Left Line", "Switch", "Input Mux"},
126 {"LINE_IN", NULL, "Left Line"},
127 {"LINE_IN", NULL, "Right Line"},
131 pcm_rate_8, pcm_rate_16, pcm_rate_24,
132 pcm_rate_32, pcm_rate_44,
133 pcm_rate_48, max_pcm_rate,
136 struct ni_div_rates {
138 u16 ni[max_pcm_rate];
140 {11289600, {0x116A, 0x22D4, 0x343F, 0x45A9, 0x6000, 0x687D} },
141 {12000000, {0x1062, 0x20C5, 0x3127, 0x4189, 0x5A51, 0x624E} },
142 {12288000, {0x1000, 0x2000, 0x3000, 0x4000, 0x5833, 0x6000} },
143 {13000000, {0x0F20, 0x1E3F, 0x2D5F, 0x3C7F, 0x535F, 0x5ABE} },
144 {19200000, {0x0A3D, 0x147B, 0x1EB8, 0x28F6, 0x3873, 0x3D71} },
145 {24000000, {0x1062, 0x20C5, 0x1893, 0x4189, 0x5A51, 0x624E} },
146 {26000000, {0x0F20, 0x1E3F, 0x16AF, 0x3C7F, 0x535F, 0x5ABE} },
147 {27000000, {0x0E90, 0x1D21, 0x15D8, 0x3A41, 0x5048, 0x5762} },
150 static inline int get_ni_value(int mclk, int rate)
154 /* find the closest rate index*/
155 for (i = 0; i < ARRAY_SIZE(ni_div); i++) {
156 if (ni_div[i].mclk >= mclk)
162 return ni_div[i].ni[pcm_rate_8];
164 return ni_div[i].ni[pcm_rate_16];
166 return ni_div[i].ni[pcm_rate_32];
168 return ni_div[i].ni[pcm_rate_44];
170 return ni_div[i].ni[pcm_rate_48];
172 pr_err("%s wrong rate %d\n", __func__, rate);
178 static int max9867_dai_hw_params(struct snd_pcm_substream *substream,
179 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
181 struct snd_soc_codec *codec = dai->codec;
182 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
183 unsigned int ni_h, ni_l;
186 value = get_ni_value(max9867->sysclk, params_rate(params));
190 ni_h = (0xFF00 & value) >> 8;
191 ni_l = 0x00FF & value;
192 /* set up the ni value */
193 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKHIGH,
194 MAX9867_NI_HIGH_MASK, ni_h);
195 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKLOW,
196 MAX9867_NI_LOW_MASK, ni_l);
197 if (!max9867->master) {
199 * digital pll locks on to any externally supplied LRCLK signal
200 * and also enable rapid lock mode.
202 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKLOW,
203 MAX9867_RAPID_LOCK, MAX9867_RAPID_LOCK);
204 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKHIGH,
205 MAX9867_PLL, MAX9867_PLL);
207 unsigned long int bclk_rate, pclk_bclk_ratio;
210 bclk_rate = params_rate(params) * 2 * params_width(params);
211 pclk_bclk_ratio = max9867->pclk/bclk_rate;
212 switch (params_width(params)) {
215 switch (pclk_bclk_ratio) {
217 bclk_value = MAX9867_IFC1B_PCLK_2;
220 bclk_value = MAX9867_IFC1B_PCLK_4;
223 bclk_value = MAX9867_IFC1B_PCLK_8;
226 bclk_value = MAX9867_IFC1B_PCLK_16;
230 "unsupported sampling rate\n");
235 bclk_value = MAX9867_IFC1B_24BIT;
238 bclk_value = MAX9867_IFC1B_32BIT;
241 dev_err(codec->dev, "unsupported sampling rate\n");
244 regmap_update_bits(max9867->regmap, MAX9867_IFC1B,
245 MAX9867_IFC1B_BCLK_MASK, bclk_value);
250 static int max9867_prepare(struct snd_pcm_substream *substream,
251 struct snd_soc_dai *dai)
253 struct snd_soc_codec *codec = dai->codec;
254 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
256 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
257 MAX9867_SHTDOWN_MASK, MAX9867_SHTDOWN_MASK);
261 static int max9867_mute(struct snd_soc_dai *dai, int mute)
263 struct snd_soc_codec *codec = dai->codec;
264 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
267 regmap_update_bits(max9867->regmap, MAX9867_DACLEVEL,
268 MAX9867_DAC_MUTE_MASK, MAX9867_DAC_MUTE_MASK);
270 regmap_update_bits(max9867->regmap, MAX9867_DACLEVEL,
271 MAX9867_DAC_MUTE_MASK, 0);
275 static int max9867_set_dai_sysclk(struct snd_soc_dai *codec_dai,
276 int clk_id, unsigned int freq, int dir)
278 struct snd_soc_codec *codec = codec_dai->codec;
279 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
282 /* Set the prescaler based on the master clock frequency*/
283 if (freq >= 10000000 && freq <= 20000000) {
284 value |= MAX9867_PSCLK_10_20;
285 max9867->pclk = freq;
286 } else if (freq >= 20000000 && freq <= 40000000) {
287 value |= MAX9867_PSCLK_20_40;
288 max9867->pclk = freq/2;
289 } else if (freq >= 40000000 && freq <= 60000000) {
290 value |= MAX9867_PSCLK_40_60;
291 max9867->pclk = freq/4;
293 pr_err("bad clock frequency %d", freq);
296 value = value << MAX9867_PSCLK_SHIFT;
297 max9867->sysclk = freq;
298 /* exact integer mode is not supported */
299 value &= ~MAX9867_FREQ_MASK;
300 regmap_update_bits(max9867->regmap, MAX9867_SYSCLK,
301 MAX9867_PSCLK_MASK, value);
305 static int max9867_dai_set_fmt(struct snd_soc_dai *codec_dai,
308 struct snd_soc_codec *codec = codec_dai->codec;
309 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
310 u8 iface1A = 0, iface1B = 0;
313 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
314 case SND_SOC_DAIFMT_CBM_CFM:
316 iface1A |= MAX9867_MASTER;
318 case SND_SOC_DAIFMT_CBS_CFS:
320 iface1A &= ~MAX9867_MASTER;
326 /* for i2s compatible mode */
327 iface1A |= MAX9867_I2S_DLY;
328 /* SDOUT goes to hiz state after all data is transferred */
329 iface1A |= MAX9867_SDOUT_HIZ;
331 /* Clock inversion bits, BCI and WCI */
332 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
333 case SND_SOC_DAIFMT_NB_NF:
335 case SND_SOC_DAIFMT_IB_IF:
336 iface1A |= MAX9867_WCI_MODE | MAX9867_BCI_MODE;
338 case SND_SOC_DAIFMT_IB_NF:
339 iface1A |= MAX9867_BCI_MODE;
341 case SND_SOC_DAIFMT_NB_IF:
342 iface1A |= MAX9867_WCI_MODE;
348 ret = regmap_write(max9867->regmap, MAX9867_IFC1A, iface1A);
349 ret = regmap_write(max9867->regmap, MAX9867_IFC1B, iface1B);
353 static struct snd_soc_dai_ops max9867_dai_ops = {
354 .set_fmt = max9867_dai_set_fmt,
355 .set_sysclk = max9867_set_dai_sysclk,
356 .prepare = max9867_prepare,
357 .digital_mute = max9867_mute,
358 .hw_params = max9867_dai_hw_params,
361 #define MAX9867_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_16000 |\
362 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
363 #define MAX9867_FORMATS (SNDRV_PCM_FMTBIT_S16_LE)
365 static struct snd_soc_dai_driver max9867_dai[] = {
367 .name = "max9867-aif1",
369 .stream_name = "HiFi Playback",
372 .rates = MAX9867_RATES,
373 .formats = MAX9867_FORMATS,
376 .stream_name = "HiFi Capture",
379 .rates = MAX9867_RATES,
380 .formats = MAX9867_FORMATS,
382 .ops = &max9867_dai_ops,
386 #ifdef CONFIG_PM_SLEEP
387 static int max9867_suspend(struct device *dev)
389 struct max9867_priv *max9867 = dev_get_drvdata(dev);
391 /* Drop down to power saving mode when system is suspended */
392 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
393 MAX9867_SHTDOWN_MASK, ~MAX9867_SHTDOWN_MASK);
397 static int max9867_resume(struct device *dev)
399 struct max9867_priv *max9867 = dev_get_drvdata(dev);
401 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
402 MAX9867_SHTDOWN_MASK, MAX9867_SHTDOWN_MASK);
407 static int max9867_probe(struct snd_soc_codec *codec)
409 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
411 dev_dbg(codec->dev, "max98090_probe\n");
412 max9867->codec = codec;
416 static struct snd_soc_codec_driver max9867_codec = {
417 .probe = max9867_probe,
418 .controls = max9867_snd_controls,
419 .num_controls = ARRAY_SIZE(max9867_snd_controls),
420 .dapm_routes = max9867_audio_map,
421 .num_dapm_routes = ARRAY_SIZE(max9867_audio_map),
422 .dapm_widgets = max9867_dapm_widgets,
423 .num_dapm_widgets = ARRAY_SIZE(max9867_dapm_widgets),
426 static bool max9867_volatile_register(struct device *dev, unsigned int reg)
430 case MAX9867_JACKSTATUS:
431 case MAX9867_AUXHIGH:
439 static const struct reg_default max9867_reg[] = {
462 static const struct regmap_config max9867_regmap = {
465 .max_register = MAX9867_REVISION,
466 .reg_defaults = max9867_reg,
467 .num_reg_defaults = ARRAY_SIZE(max9867_reg),
468 .volatile_reg = max9867_volatile_register,
469 .cache_type = REGCACHE_RBTREE,
472 static int max9867_i2c_probe(struct i2c_client *i2c,
473 const struct i2c_device_id *id)
475 struct max9867_priv *max9867;
478 max9867 = devm_kzalloc(&i2c->dev,
479 sizeof(*max9867), GFP_KERNEL);
483 i2c_set_clientdata(i2c, max9867);
484 max9867->regmap = devm_regmap_init_i2c(i2c, &max9867_regmap);
485 if (IS_ERR(max9867->regmap)) {
486 ret = PTR_ERR(max9867->regmap);
488 "Failed to allocate regmap: %d\n", ret);
491 ret = regmap_read(max9867->regmap,
492 MAX9867_REVISION, ®);
494 dev_err(&i2c->dev, "Failed to read: %d\n", ret);
497 dev_info(&i2c->dev, "device revision: %x\n", reg);
498 ret = snd_soc_register_codec(&i2c->dev, &max9867_codec,
499 max9867_dai, ARRAY_SIZE(max9867_dai));
501 dev_err(&i2c->dev, "Failed to register codec: %d\n", ret);
507 static int max9867_i2c_remove(struct i2c_client *client)
509 snd_soc_unregister_codec(&client->dev);
513 static const struct i2c_device_id max9867_i2c_id[] = {
518 static const struct of_device_id max9867_of_match[] = {
519 { .compatible = "maxim,max9867", },
523 MODULE_DEVICE_TABLE(i2c, max9867_i2c_id);
525 static const struct dev_pm_ops max9867_pm_ops = {
526 SET_SYSTEM_SLEEP_PM_OPS(max9867_suspend, max9867_resume)
529 static struct i2c_driver max9867_i2c_driver = {
532 .of_match_table = of_match_ptr(max9867_of_match),
533 .pm = &max9867_pm_ops,
535 .probe = max9867_i2c_probe,
536 .remove = max9867_i2c_remove,
537 .id_table = max9867_i2c_id,
540 module_i2c_driver(max9867_i2c_driver);
542 MODULE_AUTHOR("anish kumar <yesanishhere@gmail.com>");
543 MODULE_DESCRIPTION("ALSA SoC MAX9867 driver");
544 MODULE_LICENSE("GPL");