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 SNDRV_CTL_TLVD_DECLARE_DB_RANGE(max98088_micboost_tlv
,
42 0, 1, TLV_DB_SCALE_ITEM(0, 2000, 0),
43 2, 2, TLV_DB_SCALE_ITEM(3000, 0, 0),
46 static const struct snd_kcontrol_new max9867_snd_controls
[] = {
47 SOC_DOUBLE_R("Master Playback Volume", MAX9867_LEFTVOL
,
48 MAX9867_RIGHTVOL
, 0, 63, 1),
49 SOC_DOUBLE_R_TLV("Capture Volume", MAX9867_LEFTMICGAIN
,
51 0, 15, 1, max9860_capture_tlv
),
52 SOC_DOUBLE_R_TLV("Mic Volume", MAX9867_LEFTMICGAIN
,
53 MAX9867_RIGHTMICGAIN
, 0, 31, 1, max9860_mic_tlv
),
54 SOC_DOUBLE_R_TLV("Mic Boost Volume", MAX9867_LEFTMICGAIN
,
55 MAX9867_RIGHTMICGAIN
, 5, 3, 0, max98088_micboost_tlv
),
56 SOC_ENUM("Digital Sidetone Src", max9867_sidetone
),
57 SOC_SINGLE("Sidetone Volume", MAX9867_DACGAIN
, 0, 31, 1),
58 SOC_SINGLE("DAC Volume", MAX9867_DACLEVEL
, 4, 3, 0),
59 SOC_SINGLE("DAC Attenuation", MAX9867_DACLEVEL
, 0, 15, 1),
60 SOC_SINGLE_TLV("ADC Left Volume", MAX9867_ADCLEVEL
,
61 4, 15, 1, max9860_adc_left_tlv
),
62 SOC_SINGLE_TLV("ADC Right Volume", MAX9867_ADCLEVEL
,
63 0, 15, 1, max9860_adc_right_tlv
),
64 SOC_ENUM("Speaker Mode", max9867_spkmode
),
65 SOC_SINGLE("Volume Smoothing Switch", MAX9867_MODECONFIG
, 6, 1, 0),
66 SOC_SINGLE("ZCD Switch", MAX9867_MODECONFIG
, 5, 1, 0),
67 SOC_ENUM("DSP Filter", max9867_filter
),
70 static const char *const max9867_mux
[] = {"None", "Mic", "Line", "Mic_Line"};
72 static SOC_ENUM_SINGLE_DECL(max9867_mux_enum
,
73 MAX9867_INPUTCONFIG
, MAX9867_INPUT_SHIFT
,
76 static const struct snd_kcontrol_new max9867_dapm_mux_controls
=
77 SOC_DAPM_ENUM("Route", max9867_mux_enum
);
79 static const struct snd_kcontrol_new max9867_left_dapm_control
=
80 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN
, 6, 1, 0);
81 static const struct snd_kcontrol_new max9867_right_dapm_control
=
82 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN
, 5, 1, 0);
83 static const struct snd_kcontrol_new max9867_line_dapm_control
=
84 SOC_DAPM_SINGLE("Switch", MAX9867_LEFTLINELVL
, 6, 1, 1);
86 static const struct snd_soc_dapm_widget max9867_dapm_widgets
[] = {
87 SND_SOC_DAPM_AIF_IN("DAI_OUT", "HiFi Playback", 0, SND_SOC_NOPM
, 0, 0),
88 SND_SOC_DAPM_DAC("Left DAC", NULL
, MAX9867_PWRMAN
, 3, 0),
89 SND_SOC_DAPM_DAC("Right DAC", NULL
, MAX9867_PWRMAN
, 2, 0),
90 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM
, 0, 0, NULL
, 0),
91 SND_SOC_DAPM_OUTPUT("HPOUT"),
93 SND_SOC_DAPM_AIF_IN("DAI_IN", "HiFi Capture", 0, SND_SOC_NOPM
, 0, 0),
94 SND_SOC_DAPM_ADC("Left ADC", "HiFi Capture", MAX9867_PWRMAN
, 1, 0),
95 SND_SOC_DAPM_ADC("Right ADC", "HiFi Capture", MAX9867_PWRMAN
, 0, 0),
96 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM
, 0, 0,
97 &max9867_dapm_mux_controls
),
99 SND_SOC_DAPM_MIXER("Input Mixer", SND_SOC_NOPM
, 0, 0, NULL
, 0),
100 SND_SOC_DAPM_SWITCH("Left Line", MAX9867_LEFTLINELVL
, 6, 1,
101 &max9867_left_dapm_control
),
102 SND_SOC_DAPM_SWITCH("Right Line", MAX9867_RIGTHLINELVL
, 6, 1,
103 &max9867_right_dapm_control
),
104 SND_SOC_DAPM_SWITCH("Line Mixer", SND_SOC_NOPM
, 0, 0,
105 &max9867_line_dapm_control
),
106 SND_SOC_DAPM_INPUT("LINE_IN"),
109 static const struct snd_soc_dapm_route max9867_audio_map
[] = {
110 {"Left DAC", NULL
, "DAI_OUT"},
111 {"Right DAC", NULL
, "DAI_OUT"},
112 {"Output Mixer", NULL
, "Left DAC"},
113 {"Output Mixer", NULL
, "Right DAC"},
114 {"HPOUT", NULL
, "Output Mixer"},
116 {"Left ADC", NULL
, "DAI_IN"},
117 {"Right ADC", NULL
, "DAI_IN"},
118 {"Input Mixer", NULL
, "Left ADC"},
119 {"Input Mixer", NULL
, "Right ADC"},
120 {"Input Mux", "Line", "Input Mixer"},
121 {"Input Mux", "Mic", "Input Mixer"},
122 {"Input Mux", "Mic_Line", "Input Mixer"},
123 {"Right Line", "Switch", "Input Mux"},
124 {"Left Line", "Switch", "Input Mux"},
125 {"LINE_IN", NULL
, "Left Line"},
126 {"LINE_IN", NULL
, "Right Line"},
130 pcm_rate_8
, pcm_rate_16
, pcm_rate_24
,
131 pcm_rate_32
, pcm_rate_44
,
132 pcm_rate_48
, max_pcm_rate
,
135 static const struct ni_div_rates
{
137 u16 ni
[max_pcm_rate
];
139 {11289600, {0x116A, 0x22D4, 0x343F, 0x45A9, 0x6000, 0x687D} },
140 {12000000, {0x1062, 0x20C5, 0x3127, 0x4189, 0x5A51, 0x624E} },
141 {12288000, {0x1000, 0x2000, 0x3000, 0x4000, 0x5833, 0x6000} },
142 {13000000, {0x0F20, 0x1E3F, 0x2D5F, 0x3C7F, 0x535F, 0x5ABE} },
143 {19200000, {0x0A3D, 0x147B, 0x1EB8, 0x28F6, 0x3873, 0x3D71} },
144 {24000000, {0x1062, 0x20C5, 0x1893, 0x4189, 0x5A51, 0x624E} },
145 {26000000, {0x0F20, 0x1E3F, 0x16AF, 0x3C7F, 0x535F, 0x5ABE} },
146 {27000000, {0x0E90, 0x1D21, 0x15D8, 0x3A41, 0x5048, 0x5762} },
149 static inline int get_ni_value(int mclk
, int rate
)
153 /* find the closest rate index*/
154 for (i
= 0; i
< ARRAY_SIZE(ni_div
); i
++) {
155 if (ni_div
[i
].mclk
>= mclk
)
158 if (i
== ARRAY_SIZE(ni_div
))
163 return ni_div
[i
].ni
[pcm_rate_8
];
165 return ni_div
[i
].ni
[pcm_rate_16
];
167 return ni_div
[i
].ni
[pcm_rate_32
];
169 return ni_div
[i
].ni
[pcm_rate_44
];
171 return ni_div
[i
].ni
[pcm_rate_48
];
173 pr_err("%s wrong rate %d\n", __func__
, rate
);
179 static int max9867_dai_hw_params(struct snd_pcm_substream
*substream
,
180 struct snd_pcm_hw_params
*params
, struct snd_soc_dai
*dai
)
182 struct snd_soc_codec
*codec
= dai
->codec
;
183 struct max9867_priv
*max9867
= snd_soc_codec_get_drvdata(codec
);
184 unsigned int ni_h
, ni_l
;
187 value
= get_ni_value(max9867
->sysclk
, params_rate(params
));
191 ni_h
= (0xFF00 & value
) >> 8;
192 ni_l
= 0x00FF & value
;
193 /* set up the ni value */
194 regmap_update_bits(max9867
->regmap
, MAX9867_AUDIOCLKHIGH
,
195 MAX9867_NI_HIGH_MASK
, ni_h
);
196 regmap_update_bits(max9867
->regmap
, MAX9867_AUDIOCLKLOW
,
197 MAX9867_NI_LOW_MASK
, ni_l
);
198 if (!max9867
->master
) {
200 * digital pll locks on to any externally supplied LRCLK signal
201 * and also enable rapid lock mode.
203 regmap_update_bits(max9867
->regmap
, MAX9867_AUDIOCLKLOW
,
204 MAX9867_RAPID_LOCK
, MAX9867_RAPID_LOCK
);
205 regmap_update_bits(max9867
->regmap
, MAX9867_AUDIOCLKHIGH
,
206 MAX9867_PLL
, MAX9867_PLL
);
208 unsigned long int bclk_rate
, pclk_bclk_ratio
;
211 bclk_rate
= params_rate(params
) * 2 * params_width(params
);
212 pclk_bclk_ratio
= max9867
->pclk
/bclk_rate
;
213 switch (params_width(params
)) {
216 switch (pclk_bclk_ratio
) {
218 bclk_value
= MAX9867_IFC1B_PCLK_2
;
221 bclk_value
= MAX9867_IFC1B_PCLK_4
;
224 bclk_value
= MAX9867_IFC1B_PCLK_8
;
227 bclk_value
= MAX9867_IFC1B_PCLK_16
;
231 "unsupported sampling rate\n");
236 bclk_value
= MAX9867_IFC1B_24BIT
;
239 bclk_value
= MAX9867_IFC1B_32BIT
;
242 dev_err(codec
->dev
, "unsupported sampling rate\n");
245 regmap_update_bits(max9867
->regmap
, MAX9867_IFC1B
,
246 MAX9867_IFC1B_BCLK_MASK
, bclk_value
);
251 static int max9867_prepare(struct snd_pcm_substream
*substream
,
252 struct snd_soc_dai
*dai
)
254 struct snd_soc_codec
*codec
= dai
->codec
;
255 struct max9867_priv
*max9867
= snd_soc_codec_get_drvdata(codec
);
257 regmap_update_bits(max9867
->regmap
, MAX9867_PWRMAN
,
258 MAX9867_SHTDOWN_MASK
, MAX9867_SHTDOWN_MASK
);
262 static int max9867_mute(struct snd_soc_dai
*dai
, int mute
)
264 struct snd_soc_codec
*codec
= dai
->codec
;
265 struct max9867_priv
*max9867
= snd_soc_codec_get_drvdata(codec
);
268 regmap_update_bits(max9867
->regmap
, MAX9867_DACLEVEL
,
269 MAX9867_DAC_MUTE_MASK
, MAX9867_DAC_MUTE_MASK
);
271 regmap_update_bits(max9867
->regmap
, MAX9867_DACLEVEL
,
272 MAX9867_DAC_MUTE_MASK
, 0);
276 static int max9867_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
277 int clk_id
, unsigned int freq
, int dir
)
279 struct snd_soc_codec
*codec
= codec_dai
->codec
;
280 struct max9867_priv
*max9867
= snd_soc_codec_get_drvdata(codec
);
283 /* Set the prescaler based on the master clock frequency*/
284 if (freq
>= 10000000 && freq
<= 20000000) {
285 value
|= MAX9867_PSCLK_10_20
;
286 max9867
->pclk
= freq
;
287 } else if (freq
>= 20000000 && freq
<= 40000000) {
288 value
|= MAX9867_PSCLK_20_40
;
289 max9867
->pclk
= freq
/2;
290 } else if (freq
>= 40000000 && freq
<= 60000000) {
291 value
|= MAX9867_PSCLK_40_60
;
292 max9867
->pclk
= freq
/4;
294 pr_err("bad clock frequency %d", freq
);
297 value
= value
<< MAX9867_PSCLK_SHIFT
;
298 max9867
->sysclk
= freq
;
299 /* exact integer mode is not supported */
300 value
&= ~MAX9867_FREQ_MASK
;
301 regmap_update_bits(max9867
->regmap
, MAX9867_SYSCLK
,
302 MAX9867_PSCLK_MASK
, value
);
306 static int max9867_dai_set_fmt(struct snd_soc_dai
*codec_dai
,
309 struct snd_soc_codec
*codec
= codec_dai
->codec
;
310 struct max9867_priv
*max9867
= snd_soc_codec_get_drvdata(codec
);
311 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 regmap_write(max9867
->regmap
, MAX9867_IFC1A
, iface1A
);
349 regmap_write(max9867
->regmap
, MAX9867_IFC1B
, iface1B
);
353 static const 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 const struct snd_soc_codec_driver max9867_codec
= {
417 .probe
= max9867_probe
,
418 .component_driver
= {
419 .controls
= max9867_snd_controls
,
420 .num_controls
= ARRAY_SIZE(max9867_snd_controls
),
421 .dapm_routes
= max9867_audio_map
,
422 .num_dapm_routes
= ARRAY_SIZE(max9867_audio_map
),
423 .dapm_widgets
= max9867_dapm_widgets
,
424 .num_dapm_widgets
= ARRAY_SIZE(max9867_dapm_widgets
),
428 static bool max9867_volatile_register(struct device
*dev
, unsigned int reg
)
432 case MAX9867_JACKSTATUS
:
433 case MAX9867_AUXHIGH
:
441 static const struct reg_default max9867_reg
[] = {
464 static const struct regmap_config max9867_regmap
= {
467 .max_register
= MAX9867_REVISION
,
468 .reg_defaults
= max9867_reg
,
469 .num_reg_defaults
= ARRAY_SIZE(max9867_reg
),
470 .volatile_reg
= max9867_volatile_register
,
471 .cache_type
= REGCACHE_RBTREE
,
474 static int max9867_i2c_probe(struct i2c_client
*i2c
,
475 const struct i2c_device_id
*id
)
477 struct max9867_priv
*max9867
;
480 max9867
= devm_kzalloc(&i2c
->dev
,
481 sizeof(*max9867
), GFP_KERNEL
);
485 i2c_set_clientdata(i2c
, max9867
);
486 max9867
->regmap
= devm_regmap_init_i2c(i2c
, &max9867_regmap
);
487 if (IS_ERR(max9867
->regmap
)) {
488 ret
= PTR_ERR(max9867
->regmap
);
490 "Failed to allocate regmap: %d\n", ret
);
493 ret
= regmap_read(max9867
->regmap
,
494 MAX9867_REVISION
, ®
);
496 dev_err(&i2c
->dev
, "Failed to read: %d\n", ret
);
499 dev_info(&i2c
->dev
, "device revision: %x\n", reg
);
500 ret
= snd_soc_register_codec(&i2c
->dev
, &max9867_codec
,
501 max9867_dai
, ARRAY_SIZE(max9867_dai
));
503 dev_err(&i2c
->dev
, "Failed to register codec: %d\n", ret
);
509 static int max9867_i2c_remove(struct i2c_client
*client
)
511 snd_soc_unregister_codec(&client
->dev
);
515 static const struct i2c_device_id max9867_i2c_id
[] = {
519 MODULE_DEVICE_TABLE(i2c
, max9867_i2c_id
);
521 static const struct of_device_id max9867_of_match
[] = {
522 { .compatible
= "maxim,max9867", },
525 MODULE_DEVICE_TABLE(of
, max9867_of_match
);
527 static const struct dev_pm_ops max9867_pm_ops
= {
528 SET_SYSTEM_SLEEP_PM_OPS(max9867_suspend
, max9867_resume
)
531 static struct i2c_driver max9867_i2c_driver
= {
534 .of_match_table
= of_match_ptr(max9867_of_match
),
535 .pm
= &max9867_pm_ops
,
537 .probe
= max9867_i2c_probe
,
538 .remove
= max9867_i2c_remove
,
539 .id_table
= max9867_i2c_id
,
542 module_i2c_driver(max9867_i2c_driver
);
544 MODULE_AUTHOR("anish kumar <yesanishhere@gmail.com>");
545 MODULE_DESCRIPTION("ALSA SoC MAX9867 driver");
546 MODULE_LICENSE("GPL");