2 * cs35l33.c -- CS35L33 ALSA SoC audio driver
4 * Copyright 2016 Cirrus Logic, Inc.
6 * Author: Paul Handrigan <paul.handrigan@cirrus.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/kernel.h>
16 #include <linux/init.h>
17 #include <linux/delay.h>
18 #include <linux/i2c.h>
19 #include <linux/slab.h>
20 #include <linux/workqueue.h>
21 #include <linux/platform_device.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
28 #include <sound/tlv.h>
29 #include <linux/gpio.h>
30 #include <linux/gpio/consumer.h>
31 #include <sound/cs35l33.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/regulator/consumer.h>
34 #include <linux/regulator/machine.h>
35 #include <linux/of_gpio.h>
37 #include <linux/of_device.h>
38 #include <linux/of_irq.h>
42 #define CS35L33_BOOT_DELAY 50
44 struct cs35l33_private {
45 struct snd_soc_component *component;
46 struct cs35l33_pdata pdata;
47 struct regmap *regmap;
48 struct gpio_desc *reset_gpio;
51 struct regulator_bulk_data core_supplies[2];
52 int num_core_supplies;
54 bool enable_soft_ramp;
57 static const struct reg_default cs35l33_reg[] = {
58 {CS35L33_PWRCTL1, 0x85},
59 {CS35L33_PWRCTL2, 0xFE},
60 {CS35L33_CLK_CTL, 0x0C},
61 {CS35L33_BST_PEAK_CTL, 0x90},
62 {CS35L33_PROTECT_CTL, 0x55},
63 {CS35L33_BST_CTL1, 0x00},
64 {CS35L33_BST_CTL2, 0x01},
65 {CS35L33_ADSP_CTL, 0x00},
66 {CS35L33_ADC_CTL, 0xC8},
67 {CS35L33_DAC_CTL, 0x14},
68 {CS35L33_DIG_VOL_CTL, 0x00},
69 {CS35L33_CLASSD_CTL, 0x04},
70 {CS35L33_AMP_CTL, 0x90},
71 {CS35L33_INT_MASK_1, 0xFF},
72 {CS35L33_INT_MASK_2, 0xFF},
73 {CS35L33_DIAG_LOCK, 0x00},
74 {CS35L33_DIAG_CTRL_1, 0x40},
75 {CS35L33_DIAG_CTRL_2, 0x00},
76 {CS35L33_HG_MEMLDO_CTL, 0x62},
77 {CS35L33_HG_REL_RATE, 0x03},
78 {CS35L33_LDO_DEL, 0x12},
79 {CS35L33_HG_HEAD, 0x0A},
80 {CS35L33_HG_EN, 0x05},
81 {CS35L33_TX_VMON, 0x00},
82 {CS35L33_TX_IMON, 0x03},
83 {CS35L33_TX_VPMON, 0x02},
84 {CS35L33_TX_VBSTMON, 0x05},
85 {CS35L33_TX_FLAG, 0x06},
86 {CS35L33_TX_EN1, 0x00},
87 {CS35L33_TX_EN2, 0x00},
88 {CS35L33_TX_EN3, 0x00},
89 {CS35L33_TX_EN4, 0x00},
90 {CS35L33_RX_AUD, 0x40},
91 {CS35L33_RX_SPLY, 0x03},
92 {CS35L33_RX_ALIVE, 0x04},
93 {CS35L33_BST_CTL4, 0x63},
96 static const struct reg_sequence cs35l33_patch[] = {
106 static bool cs35l33_volatile_register(struct device *dev, unsigned int reg)
109 case CS35L33_DEVID_AB:
110 case CS35L33_DEVID_CD:
111 case CS35L33_DEVID_E:
113 case CS35L33_INT_STATUS_1:
114 case CS35L33_INT_STATUS_2:
115 case CS35L33_HG_STATUS:
122 static bool cs35l33_writeable_register(struct device *dev, unsigned int reg)
125 /* these are read only registers */
126 case CS35L33_DEVID_AB:
127 case CS35L33_DEVID_CD:
128 case CS35L33_DEVID_E:
130 case CS35L33_INT_STATUS_1:
131 case CS35L33_INT_STATUS_2:
132 case CS35L33_HG_STATUS:
139 static bool cs35l33_readable_register(struct device *dev, unsigned int reg)
142 case CS35L33_DEVID_AB:
143 case CS35L33_DEVID_CD:
144 case CS35L33_DEVID_E:
146 case CS35L33_PWRCTL1:
147 case CS35L33_PWRCTL2:
148 case CS35L33_CLK_CTL:
149 case CS35L33_BST_PEAK_CTL:
150 case CS35L33_PROTECT_CTL:
151 case CS35L33_BST_CTL1:
152 case CS35L33_BST_CTL2:
153 case CS35L33_ADSP_CTL:
154 case CS35L33_ADC_CTL:
155 case CS35L33_DAC_CTL:
156 case CS35L33_DIG_VOL_CTL:
157 case CS35L33_CLASSD_CTL:
158 case CS35L33_AMP_CTL:
159 case CS35L33_INT_MASK_1:
160 case CS35L33_INT_MASK_2:
161 case CS35L33_INT_STATUS_1:
162 case CS35L33_INT_STATUS_2:
163 case CS35L33_DIAG_LOCK:
164 case CS35L33_DIAG_CTRL_1:
165 case CS35L33_DIAG_CTRL_2:
166 case CS35L33_HG_MEMLDO_CTL:
167 case CS35L33_HG_REL_RATE:
168 case CS35L33_LDO_DEL:
169 case CS35L33_HG_HEAD:
171 case CS35L33_TX_VMON:
172 case CS35L33_TX_IMON:
173 case CS35L33_TX_VPMON:
174 case CS35L33_TX_VBSTMON:
175 case CS35L33_TX_FLAG:
181 case CS35L33_RX_SPLY:
182 case CS35L33_RX_ALIVE:
183 case CS35L33_BST_CTL4:
190 static DECLARE_TLV_DB_SCALE(classd_ctl_tlv, 900, 100, 0);
191 static DECLARE_TLV_DB_SCALE(dac_tlv, -10200, 50, 0);
193 static const struct snd_kcontrol_new cs35l33_snd_controls[] = {
195 SOC_SINGLE_TLV("SPK Amp Volume", CS35L33_AMP_CTL,
196 4, 0x09, 0, classd_ctl_tlv),
197 SOC_SINGLE_SX_TLV("DAC Volume", CS35L33_DIG_VOL_CTL,
198 0, 0x34, 0xE4, dac_tlv),
201 static int cs35l33_spkrdrv_event(struct snd_soc_dapm_widget *w,
202 struct snd_kcontrol *kcontrol, int event)
204 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
205 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
208 case SND_SOC_DAPM_POST_PMU:
209 if (!priv->amp_cal) {
210 usleep_range(8000, 9000);
211 priv->amp_cal = true;
212 regmap_update_bits(priv->regmap, CS35L33_CLASSD_CTL,
214 dev_dbg(component->dev, "Amp calibration done\n");
216 dev_dbg(component->dev, "Amp turned on\n");
218 case SND_SOC_DAPM_POST_PMD:
219 dev_dbg(component->dev, "Amp turned off\n");
222 dev_err(component->dev, "Invalid event = 0x%x\n", event);
229 static int cs35l33_sdin_event(struct snd_soc_dapm_widget *w,
230 struct snd_kcontrol *kcontrol, int event)
232 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
233 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
237 case SND_SOC_DAPM_PRE_PMU:
238 regmap_update_bits(priv->regmap, CS35L33_PWRCTL1,
240 val = priv->is_tdm_mode ? 0 : CS35L33_PDN_TDM;
241 regmap_update_bits(priv->regmap, CS35L33_PWRCTL2,
242 CS35L33_PDN_TDM, val);
243 dev_dbg(component->dev, "BST turned on\n");
245 case SND_SOC_DAPM_POST_PMU:
246 dev_dbg(component->dev, "SDIN turned on\n");
247 if (!priv->amp_cal) {
248 regmap_update_bits(priv->regmap, CS35L33_CLASSD_CTL,
249 CS35L33_AMP_CAL, CS35L33_AMP_CAL);
250 dev_dbg(component->dev, "Amp calibration started\n");
251 usleep_range(10000, 11000);
254 case SND_SOC_DAPM_POST_PMD:
255 regmap_update_bits(priv->regmap, CS35L33_PWRCTL2,
256 CS35L33_PDN_TDM, CS35L33_PDN_TDM);
257 usleep_range(4000, 4100);
258 regmap_update_bits(priv->regmap, CS35L33_PWRCTL1,
259 CS35L33_PDN_BST, CS35L33_PDN_BST);
260 dev_dbg(component->dev, "BST and SDIN turned off\n");
263 dev_err(component->dev, "Invalid event = 0x%x\n", event);
270 static int cs35l33_sdout_event(struct snd_soc_dapm_widget *w,
271 struct snd_kcontrol *kcontrol, int event)
273 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
274 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
275 unsigned int mask = CS35L33_SDOUT_3ST_I2S | CS35L33_PDN_TDM;
276 unsigned int mask2 = CS35L33_SDOUT_3ST_TDM;
277 unsigned int val, val2;
280 case SND_SOC_DAPM_PRE_PMU:
281 if (priv->is_tdm_mode) {
282 /* set sdout_3st_i2s and reset pdn_tdm */
283 val = CS35L33_SDOUT_3ST_I2S;
284 /* reset sdout_3st_tdm */
287 /* reset sdout_3st_i2s and set pdn_tdm */
288 val = CS35L33_PDN_TDM;
289 /* set sdout_3st_tdm */
290 val2 = CS35L33_SDOUT_3ST_TDM;
292 dev_dbg(component->dev, "SDOUT turned on\n");
294 case SND_SOC_DAPM_PRE_PMD:
295 val = CS35L33_SDOUT_3ST_I2S | CS35L33_PDN_TDM;
296 val2 = CS35L33_SDOUT_3ST_TDM;
297 dev_dbg(component->dev, "SDOUT turned off\n");
300 dev_err(component->dev, "Invalid event = 0x%x\n", event);
304 regmap_update_bits(priv->regmap, CS35L33_PWRCTL2,
306 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
312 static const struct snd_soc_dapm_widget cs35l33_dapm_widgets[] = {
314 SND_SOC_DAPM_OUTPUT("SPK"),
315 SND_SOC_DAPM_OUT_DRV_E("SPKDRV", CS35L33_PWRCTL1, 7, 1, NULL, 0,
316 cs35l33_spkrdrv_event,
317 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
318 SND_SOC_DAPM_AIF_IN_E("SDIN", NULL, 0, CS35L33_PWRCTL2,
319 2, 1, cs35l33_sdin_event, SND_SOC_DAPM_PRE_PMU |
320 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
322 SND_SOC_DAPM_INPUT("MON"),
324 SND_SOC_DAPM_ADC("VMON", NULL,
325 CS35L33_PWRCTL2, CS35L33_PDN_VMON_SHIFT, 1),
326 SND_SOC_DAPM_ADC("IMON", NULL,
327 CS35L33_PWRCTL2, CS35L33_PDN_IMON_SHIFT, 1),
328 SND_SOC_DAPM_ADC("VPMON", NULL,
329 CS35L33_PWRCTL2, CS35L33_PDN_VPMON_SHIFT, 1),
330 SND_SOC_DAPM_ADC("VBSTMON", NULL,
331 CS35L33_PWRCTL2, CS35L33_PDN_VBSTMON_SHIFT, 1),
333 SND_SOC_DAPM_AIF_OUT_E("SDOUT", NULL, 0, SND_SOC_NOPM, 0, 0,
334 cs35l33_sdout_event, SND_SOC_DAPM_PRE_PMU |
335 SND_SOC_DAPM_PRE_PMD),
338 static const struct snd_soc_dapm_route cs35l33_audio_map[] = {
339 {"SDIN", NULL, "CS35L33 Playback"},
340 {"SPKDRV", NULL, "SDIN"},
341 {"SPK", NULL, "SPKDRV"},
343 {"VMON", NULL, "MON"},
344 {"IMON", NULL, "MON"},
346 {"SDOUT", NULL, "VMON"},
347 {"SDOUT", NULL, "IMON"},
348 {"CS35L33 Capture", NULL, "SDOUT"},
351 static const struct snd_soc_dapm_route cs35l33_vphg_auto_route[] = {
352 {"SPKDRV", NULL, "VPMON"},
353 {"VPMON", NULL, "CS35L33 Playback"},
356 static const struct snd_soc_dapm_route cs35l33_vp_vbst_mon_route[] = {
357 {"SDOUT", NULL, "VPMON"},
358 {"VPMON", NULL, "MON"},
359 {"SDOUT", NULL, "VBSTMON"},
360 {"VBSTMON", NULL, "MON"},
363 static int cs35l33_set_bias_level(struct snd_soc_component *component,
364 enum snd_soc_bias_level level)
367 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
370 case SND_SOC_BIAS_ON:
372 case SND_SOC_BIAS_PREPARE:
373 regmap_update_bits(priv->regmap, CS35L33_PWRCTL1,
375 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
378 case SND_SOC_BIAS_STANDBY:
379 regmap_update_bits(priv->regmap, CS35L33_PWRCTL1,
380 CS35L33_PDN_ALL, CS35L33_PDN_ALL);
381 regmap_read(priv->regmap, CS35L33_INT_STATUS_2, &val);
382 usleep_range(1000, 1100);
383 if (val & CS35L33_PDN_DONE)
384 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
385 CS35L33_MCLKDIS, CS35L33_MCLKDIS);
387 case SND_SOC_BIAS_OFF:
396 struct cs35l33_mclk_div {
403 static const struct cs35l33_mclk_div cs35l33_mclk_coeffs[] = {
404 /* MCLK, Sample Rate, adsp_rate, int_fs_ratio */
405 {5644800, 11025, 0x4, CS35L33_INT_FS_RATE},
406 {5644800, 22050, 0x8, CS35L33_INT_FS_RATE},
407 {5644800, 44100, 0xC, CS35L33_INT_FS_RATE},
409 {6000000, 8000, 0x1, 0},
410 {6000000, 11025, 0x2, 0},
411 {6000000, 11029, 0x3, 0},
412 {6000000, 12000, 0x4, 0},
413 {6000000, 16000, 0x5, 0},
414 {6000000, 22050, 0x6, 0},
415 {6000000, 22059, 0x7, 0},
416 {6000000, 24000, 0x8, 0},
417 {6000000, 32000, 0x9, 0},
418 {6000000, 44100, 0xA, 0},
419 {6000000, 44118, 0xB, 0},
420 {6000000, 48000, 0xC, 0},
422 {6144000, 8000, 0x1, CS35L33_INT_FS_RATE},
423 {6144000, 12000, 0x4, CS35L33_INT_FS_RATE},
424 {6144000, 16000, 0x5, CS35L33_INT_FS_RATE},
425 {6144000, 24000, 0x8, CS35L33_INT_FS_RATE},
426 {6144000, 32000, 0x9, CS35L33_INT_FS_RATE},
427 {6144000, 48000, 0xC, CS35L33_INT_FS_RATE},
430 static int cs35l33_get_mclk_coeff(int mclk, int srate)
434 for (i = 0; i < ARRAY_SIZE(cs35l33_mclk_coeffs); i++) {
435 if (cs35l33_mclk_coeffs[i].mclk == mclk &&
436 cs35l33_mclk_coeffs[i].srate == srate)
442 static int cs35l33_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
444 struct snd_soc_component *component = codec_dai->component;
445 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
447 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
448 case SND_SOC_DAIFMT_CBM_CFM:
449 regmap_update_bits(priv->regmap, CS35L33_ADSP_CTL,
450 CS35L33_MS_MASK, CS35L33_MS_MASK);
451 dev_dbg(component->dev, "Audio port in master mode\n");
453 case SND_SOC_DAIFMT_CBS_CFS:
454 regmap_update_bits(priv->regmap, CS35L33_ADSP_CTL,
456 dev_dbg(component->dev, "Audio port in slave mode\n");
462 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
463 case SND_SOC_DAIFMT_DSP_A:
465 * tdm mode in cs35l33 resembles dsp-a mode very
466 * closely, it is dsp-a with fsync shifted left by half bclk
468 priv->is_tdm_mode = true;
469 dev_dbg(component->dev, "Audio port in TDM mode\n");
471 case SND_SOC_DAIFMT_I2S:
472 priv->is_tdm_mode = false;
473 dev_dbg(component->dev, "Audio port in I2S mode\n");
482 static int cs35l33_pcm_hw_params(struct snd_pcm_substream *substream,
483 struct snd_pcm_hw_params *params,
484 struct snd_soc_dai *dai)
486 struct snd_soc_component *component = dai->component;
487 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
488 int sample_size = params_width(params);
489 int coeff = cs35l33_get_mclk_coeff(priv->mclk_int, params_rate(params));
494 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
495 CS35L33_ADSP_FS | CS35L33_INT_FS_RATE,
496 cs35l33_mclk_coeffs[coeff].int_fs_ratio
497 | cs35l33_mclk_coeffs[coeff].adsp_rate);
499 if (priv->is_tdm_mode) {
500 sample_size = (sample_size / 8) - 1;
503 regmap_update_bits(priv->regmap, CS35L33_RX_AUD,
504 CS35L33_AUDIN_RX_DEPTH,
505 sample_size << CS35L33_AUDIN_RX_DEPTH_SHIFT);
508 dev_dbg(component->dev, "sample rate=%d, bits per sample=%d\n",
509 params_rate(params), params_width(params));
514 static const unsigned int cs35l33_src_rates[] = {
515 8000, 11025, 11029, 12000, 16000, 22050,
516 22059, 24000, 32000, 44100, 44118, 48000
519 static const struct snd_pcm_hw_constraint_list cs35l33_constraints = {
520 .count = ARRAY_SIZE(cs35l33_src_rates),
521 .list = cs35l33_src_rates,
524 static int cs35l33_pcm_startup(struct snd_pcm_substream *substream,
525 struct snd_soc_dai *dai)
527 snd_pcm_hw_constraint_list(substream->runtime, 0,
528 SNDRV_PCM_HW_PARAM_RATE,
529 &cs35l33_constraints);
533 static int cs35l33_set_tristate(struct snd_soc_dai *dai, int tristate)
535 struct snd_soc_component *component = dai->component;
536 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
539 regmap_update_bits(priv->regmap, CS35L33_PWRCTL2,
540 CS35L33_SDOUT_3ST_I2S, CS35L33_SDOUT_3ST_I2S);
541 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
542 CS35L33_SDOUT_3ST_TDM, CS35L33_SDOUT_3ST_TDM);
544 regmap_update_bits(priv->regmap, CS35L33_PWRCTL2,
545 CS35L33_SDOUT_3ST_I2S, 0);
546 regmap_update_bits(priv->regmap, CS35L33_CLK_CTL,
547 CS35L33_SDOUT_3ST_TDM, 0);
553 static int cs35l33_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
554 unsigned int rx_mask, int slots, int slot_width)
556 struct snd_soc_component *component = dai->component;
557 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
558 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
559 unsigned int reg, bit_pos, i;
565 /* scan rx_mask for aud slot */
566 slot = ffs(rx_mask) - 1;
568 regmap_update_bits(priv->regmap, CS35L33_RX_AUD,
569 CS35L33_X_LOC, slot);
570 dev_dbg(component->dev, "Audio starts from slots %d", slot);
574 * scan tx_mask: vmon(2 slots); imon (2 slots);
575 * vpmon (1 slot) vbstmon (1 slot)
577 slot = ffs(tx_mask) - 1;
580 for (i = 0; i < 2 ; i++) {
581 /* disable vpmon/vbstmon: enable later if set in tx_mask */
582 regmap_update_bits(priv->regmap, CS35L33_TX_VPMON + i,
583 CS35L33_X_STATE | CS35L33_X_LOC, CS35L33_X_STATE
587 /* disconnect {vp,vbst}_mon routes: eanble later if set in tx_mask*/
588 snd_soc_dapm_del_routes(dapm, cs35l33_vp_vbst_mon_route,
589 ARRAY_SIZE(cs35l33_vp_vbst_mon_route));
592 /* configure VMON_TX_LOC */
594 regmap_update_bits(priv->regmap, CS35L33_TX_VMON,
595 CS35L33_X_STATE | CS35L33_X_LOC, slot);
596 dev_dbg(component->dev, "VMON enabled in slots %d-%d",
600 /* configure IMON_TX_LOC */
602 regmap_update_bits(priv->regmap, CS35L33_TX_IMON,
603 CS35L33_X_STATE | CS35L33_X_LOC, slot);
604 dev_dbg(component->dev, "IMON enabled in slots %d-%d",
608 /* configure VPMON_TX_LOC */
610 regmap_update_bits(priv->regmap, CS35L33_TX_VPMON,
611 CS35L33_X_STATE | CS35L33_X_LOC, slot);
612 snd_soc_dapm_add_routes(dapm,
613 &cs35l33_vp_vbst_mon_route[0], 2);
614 dev_dbg(component->dev, "VPMON enabled in slots %d", slot);
617 /* configure VBSTMON_TX_LOC */
619 regmap_update_bits(priv->regmap, CS35L33_TX_VBSTMON,
620 CS35L33_X_STATE | CS35L33_X_LOC, slot);
621 snd_soc_dapm_add_routes(dapm,
622 &cs35l33_vp_vbst_mon_route[2], 2);
623 dev_dbg(component->dev,
624 "VBSTMON enabled in slots %d", slot);
627 /* Enable the relevant tx slot */
628 reg = CS35L33_TX_EN4 - (slot/8);
629 bit_pos = slot - ((slot / 8) * (8));
630 regmap_update_bits(priv->regmap, reg,
631 1 << bit_pos, 1 << bit_pos);
633 tx_mask &= ~(1 << slot);
634 slot = ffs(tx_mask) - 1;
641 static int cs35l33_component_set_sysclk(struct snd_soc_component *component,
642 int clk_id, int source, unsigned int freq, int dir)
644 struct cs35l33_private *cs35l33 = snd_soc_component_get_drvdata(component);
647 case CS35L33_MCLK_5644:
649 case CS35L33_MCLK_6144:
650 regmap_update_bits(cs35l33->regmap, CS35L33_CLK_CTL,
651 CS35L33_MCLKDIV2, 0);
652 cs35l33->mclk_int = freq;
654 case CS35L33_MCLK_11289:
655 case CS35L33_MCLK_12:
656 case CS35L33_MCLK_12288:
657 regmap_update_bits(cs35l33->regmap, CS35L33_CLK_CTL,
658 CS35L33_MCLKDIV2, CS35L33_MCLKDIV2);
659 cs35l33->mclk_int = freq/2;
662 cs35l33->mclk_int = 0;
666 dev_dbg(component->dev, "external mclk freq=%d, internal mclk freq=%d\n",
667 freq, cs35l33->mclk_int);
672 static const struct snd_soc_dai_ops cs35l33_ops = {
673 .startup = cs35l33_pcm_startup,
674 .set_tristate = cs35l33_set_tristate,
675 .set_fmt = cs35l33_set_dai_fmt,
676 .hw_params = cs35l33_pcm_hw_params,
677 .set_tdm_slot = cs35l33_set_tdm_slot,
680 static struct snd_soc_dai_driver cs35l33_dai = {
681 .name = "cs35l33-dai",
684 .stream_name = "CS35L33 Playback",
687 .rates = CS35L33_RATES,
688 .formats = CS35L33_FORMATS,
691 .stream_name = "CS35L33 Capture",
694 .rates = CS35L33_RATES,
695 .formats = CS35L33_FORMATS,
698 .symmetric_rates = 1,
701 static int cs35l33_set_hg_data(struct snd_soc_component *component,
702 struct cs35l33_pdata *pdata)
704 struct cs35l33_hg *hg_config = &pdata->hg_config;
705 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
706 struct cs35l33_private *priv = snd_soc_component_get_drvdata(component);
708 if (hg_config->enable_hg_algo) {
709 regmap_update_bits(priv->regmap, CS35L33_HG_MEMLDO_CTL,
710 CS35L33_MEM_DEPTH_MASK,
711 hg_config->mem_depth << CS35L33_MEM_DEPTH_SHIFT);
712 regmap_write(priv->regmap, CS35L33_HG_REL_RATE,
713 hg_config->release_rate);
714 regmap_update_bits(priv->regmap, CS35L33_HG_HEAD,
716 hg_config->hd_rm << CS35L33_HD_RM_SHIFT);
717 regmap_update_bits(priv->regmap, CS35L33_HG_MEMLDO_CTL,
718 CS35L33_LDO_THLD_MASK,
719 hg_config->ldo_thld << CS35L33_LDO_THLD_SHIFT);
720 regmap_update_bits(priv->regmap, CS35L33_HG_MEMLDO_CTL,
721 CS35L33_LDO_DISABLE_MASK,
722 hg_config->ldo_path_disable <<
723 CS35L33_LDO_DISABLE_SHIFT);
724 regmap_update_bits(priv->regmap, CS35L33_LDO_DEL,
725 CS35L33_LDO_ENTRY_DELAY_MASK,
726 hg_config->ldo_entry_delay <<
727 CS35L33_LDO_ENTRY_DELAY_SHIFT);
728 if (hg_config->vp_hg_auto) {
729 regmap_update_bits(priv->regmap, CS35L33_HG_EN,
730 CS35L33_VP_HG_AUTO_MASK,
731 CS35L33_VP_HG_AUTO_MASK);
732 snd_soc_dapm_add_routes(dapm, cs35l33_vphg_auto_route,
733 ARRAY_SIZE(cs35l33_vphg_auto_route));
735 regmap_update_bits(priv->regmap, CS35L33_HG_EN,
737 hg_config->vp_hg << CS35L33_VP_HG_SHIFT);
738 regmap_update_bits(priv->regmap, CS35L33_LDO_DEL,
739 CS35L33_VP_HG_RATE_MASK,
740 hg_config->vp_hg_rate << CS35L33_VP_HG_RATE_SHIFT);
741 regmap_update_bits(priv->regmap, CS35L33_LDO_DEL,
742 CS35L33_VP_HG_VA_MASK,
743 hg_config->vp_hg_va << CS35L33_VP_HG_VA_SHIFT);
744 regmap_update_bits(priv->regmap, CS35L33_HG_EN,
745 CS35L33_CLASS_HG_EN_MASK, CS35L33_CLASS_HG_EN_MASK);
750 static int cs35l33_set_bst_ipk(struct snd_soc_component *component, unsigned int bst)
752 struct cs35l33_private *cs35l33 = snd_soc_component_get_drvdata(component);
753 int ret = 0, steps = 0;
755 /* Boost current in uA */
756 if (bst > 3600000 || bst < 1850000) {
757 dev_err(component->dev, "Invalid boost current %d\n", bst);
763 dev_err(component->dev, "Current not a multiple of 15625uA (%d)\n",
769 while (bst > 1850000) {
774 regmap_write(cs35l33->regmap, CS35L33_BST_PEAK_CTL,
781 static int cs35l33_probe(struct snd_soc_component *component)
783 struct cs35l33_private *cs35l33 = snd_soc_component_get_drvdata(component);
785 cs35l33->component = component;
786 pm_runtime_get_sync(component->dev);
788 regmap_update_bits(cs35l33->regmap, CS35L33_PROTECT_CTL,
789 CS35L33_ALIVE_WD_DIS, 0x8);
790 regmap_update_bits(cs35l33->regmap, CS35L33_BST_CTL2,
791 CS35L33_ALIVE_WD_DIS2,
792 CS35L33_ALIVE_WD_DIS2);
794 /* Set Platform Data */
795 regmap_update_bits(cs35l33->regmap, CS35L33_BST_CTL1,
796 CS35L33_BST_CTL_MASK, cs35l33->pdata.boost_ctl);
797 regmap_update_bits(cs35l33->regmap, CS35L33_CLASSD_CTL,
798 CS35L33_AMP_DRV_SEL_MASK,
799 cs35l33->pdata.amp_drv_sel << CS35L33_AMP_DRV_SEL_SHIFT);
801 if (cs35l33->pdata.boost_ipk)
802 cs35l33_set_bst_ipk(component, cs35l33->pdata.boost_ipk);
804 if (cs35l33->enable_soft_ramp) {
805 snd_soc_component_update_bits(component, CS35L33_DAC_CTL,
806 CS35L33_DIGSFT, CS35L33_DIGSFT);
807 snd_soc_component_update_bits(component, CS35L33_DAC_CTL,
808 CS35L33_DSR_RATE, cs35l33->pdata.ramp_rate);
810 snd_soc_component_update_bits(component, CS35L33_DAC_CTL,
814 /* update IMON scaling rate if different from default of 0x8 */
815 if (cs35l33->pdata.imon_adc_scale != 0x8)
816 snd_soc_component_update_bits(component, CS35L33_ADC_CTL,
817 CS35L33_IMON_SCALE, cs35l33->pdata.imon_adc_scale);
819 cs35l33_set_hg_data(component, &(cs35l33->pdata));
822 * unmask important interrupts that causes the chip to enter
823 * speaker safe mode and hence deserves user attention
825 regmap_update_bits(cs35l33->regmap, CS35L33_INT_MASK_1,
826 CS35L33_M_OTE | CS35L33_M_OTW | CS35L33_M_AMP_SHORT |
827 CS35L33_M_CAL_ERR, 0);
829 pm_runtime_put_sync(component->dev);
834 static const struct snd_soc_component_driver soc_component_dev_cs35l33 = {
835 .probe = cs35l33_probe,
836 .set_bias_level = cs35l33_set_bias_level,
837 .set_sysclk = cs35l33_component_set_sysclk,
838 .controls = cs35l33_snd_controls,
839 .num_controls = ARRAY_SIZE(cs35l33_snd_controls),
840 .dapm_widgets = cs35l33_dapm_widgets,
841 .num_dapm_widgets = ARRAY_SIZE(cs35l33_dapm_widgets),
842 .dapm_routes = cs35l33_audio_map,
843 .num_dapm_routes = ARRAY_SIZE(cs35l33_audio_map),
844 .use_pmdown_time = 1,
846 .non_legacy_dai_naming = 1,
849 static const struct regmap_config cs35l33_regmap = {
853 .max_register = CS35L33_MAX_REGISTER,
854 .reg_defaults = cs35l33_reg,
855 .num_reg_defaults = ARRAY_SIZE(cs35l33_reg),
856 .volatile_reg = cs35l33_volatile_register,
857 .readable_reg = cs35l33_readable_register,
858 .writeable_reg = cs35l33_writeable_register,
859 .cache_type = REGCACHE_RBTREE,
860 .use_single_rw = true,
863 static int __maybe_unused cs35l33_runtime_resume(struct device *dev)
865 struct cs35l33_private *cs35l33 = dev_get_drvdata(dev);
868 dev_dbg(dev, "%s\n", __func__);
870 gpiod_set_value_cansleep(cs35l33->reset_gpio, 0);
872 ret = regulator_bulk_enable(cs35l33->num_core_supplies,
873 cs35l33->core_supplies);
875 dev_err(dev, "Failed to enable core supplies: %d\n", ret);
879 regcache_cache_only(cs35l33->regmap, false);
881 gpiod_set_value_cansleep(cs35l33->reset_gpio, 1);
883 msleep(CS35L33_BOOT_DELAY);
885 ret = regcache_sync(cs35l33->regmap);
887 dev_err(dev, "Failed to restore register cache\n");
894 regcache_cache_only(cs35l33->regmap, true);
895 regulator_bulk_disable(cs35l33->num_core_supplies,
896 cs35l33->core_supplies);
901 static int __maybe_unused cs35l33_runtime_suspend(struct device *dev)
903 struct cs35l33_private *cs35l33 = dev_get_drvdata(dev);
905 dev_dbg(dev, "%s\n", __func__);
907 /* redo the calibration in next power up */
908 cs35l33->amp_cal = false;
910 regcache_cache_only(cs35l33->regmap, true);
911 regcache_mark_dirty(cs35l33->regmap);
912 regulator_bulk_disable(cs35l33->num_core_supplies,
913 cs35l33->core_supplies);
918 static const struct dev_pm_ops cs35l33_pm_ops = {
919 SET_RUNTIME_PM_OPS(cs35l33_runtime_suspend,
920 cs35l33_runtime_resume,
924 static int cs35l33_get_hg_data(const struct device_node *np,
925 struct cs35l33_pdata *pdata)
927 struct device_node *hg;
928 struct cs35l33_hg *hg_config = &pdata->hg_config;
931 hg = of_get_child_by_name(np, "cirrus,hg-algo");
932 hg_config->enable_hg_algo = hg ? true : false;
934 if (hg_config->enable_hg_algo) {
935 if (of_property_read_u32(hg, "cirrus,mem-depth", &val32) >= 0)
936 hg_config->mem_depth = val32;
937 if (of_property_read_u32(hg, "cirrus,release-rate",
939 hg_config->release_rate = val32;
940 if (of_property_read_u32(hg, "cirrus,ldo-thld", &val32) >= 0)
941 hg_config->ldo_thld = val32;
942 if (of_property_read_u32(hg, "cirrus,ldo-path-disable",
944 hg_config->ldo_path_disable = val32;
945 if (of_property_read_u32(hg, "cirrus,ldo-entry-delay",
947 hg_config->ldo_entry_delay = val32;
949 hg_config->vp_hg_auto = of_property_read_bool(hg,
950 "cirrus,vp-hg-auto");
952 if (of_property_read_u32(hg, "cirrus,vp-hg", &val32) >= 0)
953 hg_config->vp_hg = val32;
954 if (of_property_read_u32(hg, "cirrus,vp-hg-rate", &val32) >= 0)
955 hg_config->vp_hg_rate = val32;
956 if (of_property_read_u32(hg, "cirrus,vp-hg-va", &val32) >= 0)
957 hg_config->vp_hg_va = val32;
965 static irqreturn_t cs35l33_irq_thread(int irq, void *data)
967 struct cs35l33_private *cs35l33 = data;
968 struct snd_soc_component *component = cs35l33->component;
969 unsigned int sticky_val1, sticky_val2, current_val, mask1, mask2;
971 regmap_read(cs35l33->regmap, CS35L33_INT_STATUS_2,
973 regmap_read(cs35l33->regmap, CS35L33_INT_STATUS_1,
975 regmap_read(cs35l33->regmap, CS35L33_INT_MASK_2, &mask2);
976 regmap_read(cs35l33->regmap, CS35L33_INT_MASK_1, &mask1);
978 /* Check to see if the unmasked bits are active,
981 if (!(sticky_val1 & ~mask1) && !(sticky_val2 & ~mask2))
984 regmap_read(cs35l33->regmap, CS35L33_INT_STATUS_1,
987 /* handle the interrupts */
989 if (sticky_val1 & CS35L33_AMP_SHORT) {
990 dev_crit(component->dev, "Amp short error\n");
991 if (!(current_val & CS35L33_AMP_SHORT)) {
992 dev_dbg(component->dev,
993 "Amp short error release\n");
994 regmap_update_bits(cs35l33->regmap,
996 CS35L33_AMP_SHORT_RLS, 0);
997 regmap_update_bits(cs35l33->regmap,
999 CS35L33_AMP_SHORT_RLS,
1000 CS35L33_AMP_SHORT_RLS);
1001 regmap_update_bits(cs35l33->regmap,
1002 CS35L33_AMP_CTL, CS35L33_AMP_SHORT_RLS,
1007 if (sticky_val1 & CS35L33_CAL_ERR) {
1008 dev_err(component->dev, "Cal error\n");
1010 /* redo the calibration in next power up */
1011 cs35l33->amp_cal = false;
1013 if (!(current_val & CS35L33_CAL_ERR)) {
1014 dev_dbg(component->dev, "Cal error release\n");
1015 regmap_update_bits(cs35l33->regmap,
1016 CS35L33_AMP_CTL, CS35L33_CAL_ERR_RLS,
1018 regmap_update_bits(cs35l33->regmap,
1019 CS35L33_AMP_CTL, CS35L33_CAL_ERR_RLS,
1020 CS35L33_CAL_ERR_RLS);
1021 regmap_update_bits(cs35l33->regmap,
1022 CS35L33_AMP_CTL, CS35L33_CAL_ERR_RLS,
1027 if (sticky_val1 & CS35L33_OTE) {
1028 dev_crit(component->dev, "Over temperature error\n");
1029 if (!(current_val & CS35L33_OTE)) {
1030 dev_dbg(component->dev,
1031 "Over temperature error release\n");
1032 regmap_update_bits(cs35l33->regmap,
1033 CS35L33_AMP_CTL, CS35L33_OTE_RLS, 0);
1034 regmap_update_bits(cs35l33->regmap,
1035 CS35L33_AMP_CTL, CS35L33_OTE_RLS,
1037 regmap_update_bits(cs35l33->regmap,
1038 CS35L33_AMP_CTL, CS35L33_OTE_RLS, 0);
1042 if (sticky_val1 & CS35L33_OTW) {
1043 dev_err(component->dev, "Over temperature warning\n");
1044 if (!(current_val & CS35L33_OTW)) {
1045 dev_dbg(component->dev,
1046 "Over temperature warning release\n");
1047 regmap_update_bits(cs35l33->regmap,
1048 CS35L33_AMP_CTL, CS35L33_OTW_RLS, 0);
1049 regmap_update_bits(cs35l33->regmap,
1050 CS35L33_AMP_CTL, CS35L33_OTW_RLS,
1052 regmap_update_bits(cs35l33->regmap,
1053 CS35L33_AMP_CTL, CS35L33_OTW_RLS, 0);
1056 if (CS35L33_ALIVE_ERR & sticky_val1)
1057 dev_err(component->dev, "ERROR: ADSPCLK Interrupt\n");
1059 if (CS35L33_MCLK_ERR & sticky_val1)
1060 dev_err(component->dev, "ERROR: MCLK Interrupt\n");
1062 if (CS35L33_VMON_OVFL & sticky_val2)
1063 dev_err(component->dev,
1064 "ERROR: VMON Overflow Interrupt\n");
1066 if (CS35L33_IMON_OVFL & sticky_val2)
1067 dev_err(component->dev,
1068 "ERROR: IMON Overflow Interrupt\n");
1070 if (CS35L33_VPMON_OVFL & sticky_val2)
1071 dev_err(component->dev,
1072 "ERROR: VPMON Overflow Interrupt\n");
1077 static const char * const cs35l33_core_supplies[] = {
1082 static int cs35l33_of_get_pdata(struct device *dev,
1083 struct cs35l33_private *cs35l33)
1085 struct device_node *np = dev->of_node;
1086 struct cs35l33_pdata *pdata = &cs35l33->pdata;
1092 if (of_property_read_u32(np, "cirrus,boost-ctl", &val32) >= 0) {
1093 pdata->boost_ctl = val32;
1094 pdata->amp_drv_sel = 1;
1097 if (of_property_read_u32(np, "cirrus,ramp-rate", &val32) >= 0) {
1098 pdata->ramp_rate = val32;
1099 cs35l33->enable_soft_ramp = true;
1102 if (of_property_read_u32(np, "cirrus,boost-ipk", &val32) >= 0)
1103 pdata->boost_ipk = val32;
1105 if (of_property_read_u32(np, "cirrus,imon-adc-scale", &val32) >= 0) {
1106 if ((val32 == 0x0) || (val32 == 0x7) || (val32 == 0x6))
1107 pdata->imon_adc_scale = val32;
1109 /* use default value */
1110 pdata->imon_adc_scale = 0x8;
1112 /* use default value */
1113 pdata->imon_adc_scale = 0x8;
1116 cs35l33_get_hg_data(np, pdata);
1121 static int cs35l33_i2c_probe(struct i2c_client *i2c_client,
1122 const struct i2c_device_id *id)
1124 struct cs35l33_private *cs35l33;
1125 struct cs35l33_pdata *pdata = dev_get_platdata(&i2c_client->dev);
1129 cs35l33 = devm_kzalloc(&i2c_client->dev, sizeof(struct cs35l33_private),
1134 i2c_set_clientdata(i2c_client, cs35l33);
1135 cs35l33->regmap = devm_regmap_init_i2c(i2c_client, &cs35l33_regmap);
1136 if (IS_ERR(cs35l33->regmap)) {
1137 ret = PTR_ERR(cs35l33->regmap);
1138 dev_err(&i2c_client->dev, "regmap_init() failed: %d\n", ret);
1142 regcache_cache_only(cs35l33->regmap, true);
1144 for (i = 0; i < ARRAY_SIZE(cs35l33_core_supplies); i++)
1145 cs35l33->core_supplies[i].supply
1146 = cs35l33_core_supplies[i];
1147 cs35l33->num_core_supplies = ARRAY_SIZE(cs35l33_core_supplies);
1149 ret = devm_regulator_bulk_get(&i2c_client->dev,
1150 cs35l33->num_core_supplies,
1151 cs35l33->core_supplies);
1153 dev_err(&i2c_client->dev,
1154 "Failed to request core supplies: %d\n",
1160 cs35l33->pdata = *pdata;
1162 cs35l33_of_get_pdata(&i2c_client->dev, cs35l33);
1163 pdata = &cs35l33->pdata;
1166 ret = devm_request_threaded_irq(&i2c_client->dev, i2c_client->irq, NULL,
1167 cs35l33_irq_thread, IRQF_ONESHOT | IRQF_TRIGGER_LOW,
1168 "cs35l33", cs35l33);
1170 dev_warn(&i2c_client->dev, "Failed to request IRQ: %d\n", ret);
1172 /* We could issue !RST or skip it based on AMP topology */
1173 cs35l33->reset_gpio = devm_gpiod_get_optional(&i2c_client->dev,
1174 "reset-gpios", GPIOD_OUT_HIGH);
1175 if (IS_ERR(cs35l33->reset_gpio)) {
1176 dev_err(&i2c_client->dev, "%s ERROR: Can't get reset GPIO\n",
1178 return PTR_ERR(cs35l33->reset_gpio);
1181 ret = regulator_bulk_enable(cs35l33->num_core_supplies,
1182 cs35l33->core_supplies);
1184 dev_err(&i2c_client->dev,
1185 "Failed to enable core supplies: %d\n",
1190 gpiod_set_value_cansleep(cs35l33->reset_gpio, 1);
1192 msleep(CS35L33_BOOT_DELAY);
1193 regcache_cache_only(cs35l33->regmap, false);
1195 /* initialize codec */
1196 ret = regmap_read(cs35l33->regmap, CS35L33_DEVID_AB, ®);
1197 devid = (reg & 0xFF) << 12;
1198 ret = regmap_read(cs35l33->regmap, CS35L33_DEVID_CD, ®);
1199 devid |= (reg & 0xFF) << 4;
1200 ret = regmap_read(cs35l33->regmap, CS35L33_DEVID_E, ®);
1201 devid |= (reg & 0xF0) >> 4;
1203 if (devid != CS35L33_CHIP_ID) {
1204 dev_err(&i2c_client->dev,
1205 "CS35L33 Device ID (%X). Expected ID %X\n",
1206 devid, CS35L33_CHIP_ID);
1211 ret = regmap_read(cs35l33->regmap, CS35L33_REV_ID, ®);
1213 dev_err(&i2c_client->dev, "Get Revision ID failed\n");
1217 dev_info(&i2c_client->dev,
1218 "Cirrus Logic CS35L33, Revision: %02X\n", reg & 0xFF);
1220 ret = regmap_register_patch(cs35l33->regmap,
1221 cs35l33_patch, ARRAY_SIZE(cs35l33_patch));
1223 dev_err(&i2c_client->dev,
1224 "Error in applying regmap patch: %d\n", ret);
1228 /* disable mclk and tdm */
1229 regmap_update_bits(cs35l33->regmap, CS35L33_CLK_CTL,
1230 CS35L33_MCLKDIS | CS35L33_SDOUT_3ST_TDM,
1231 CS35L33_MCLKDIS | CS35L33_SDOUT_3ST_TDM);
1233 pm_runtime_set_autosuspend_delay(&i2c_client->dev, 100);
1234 pm_runtime_use_autosuspend(&i2c_client->dev);
1235 pm_runtime_set_active(&i2c_client->dev);
1236 pm_runtime_enable(&i2c_client->dev);
1238 ret = devm_snd_soc_register_component(&i2c_client->dev,
1239 &soc_component_dev_cs35l33, &cs35l33_dai, 1);
1241 dev_err(&i2c_client->dev, "%s: Register component failed\n",
1249 regulator_bulk_disable(cs35l33->num_core_supplies,
1250 cs35l33->core_supplies);
1255 static int cs35l33_i2c_remove(struct i2c_client *client)
1257 struct cs35l33_private *cs35l33 = i2c_get_clientdata(client);
1259 gpiod_set_value_cansleep(cs35l33->reset_gpio, 0);
1261 pm_runtime_disable(&client->dev);
1262 regulator_bulk_disable(cs35l33->num_core_supplies,
1263 cs35l33->core_supplies);
1268 static const struct of_device_id cs35l33_of_match[] = {
1269 { .compatible = "cirrus,cs35l33", },
1272 MODULE_DEVICE_TABLE(of, cs35l33_of_match);
1274 static const struct i2c_device_id cs35l33_id[] = {
1279 MODULE_DEVICE_TABLE(i2c, cs35l33_id);
1281 static struct i2c_driver cs35l33_i2c_driver = {
1284 .pm = &cs35l33_pm_ops,
1285 .of_match_table = cs35l33_of_match,
1288 .id_table = cs35l33_id,
1289 .probe = cs35l33_i2c_probe,
1290 .remove = cs35l33_i2c_remove,
1293 module_i2c_driver(cs35l33_i2c_driver);
1295 MODULE_DESCRIPTION("ASoC CS35L33 driver");
1296 MODULE_AUTHOR("Paul Handrigan, Cirrus Logic Inc, <paul.handrigan@cirrus.com>");
1297 MODULE_LICENSE("GPL");