1 // SPDX-License-Identifier: GPL-2.0-only
3 * cs35l32.c -- CS35L32 ALSA SoC audio driver
5 * Copyright 2014 CirrusLogic, Inc.
10 #include <linux/module.h>
11 #include <linux/moduleparam.h>
12 #include <linux/kernel.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/i2c.h>
16 #include <linux/gpio.h>
17 #include <linux/regmap.h>
18 #include <linux/slab.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/of_device.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/soc-dapm.h>
28 #include <sound/initval.h>
29 #include <sound/tlv.h>
30 #include <dt-bindings/sound/cs35l32.h>
33 #include "cirrus_legacy.h"
35 #define CS35L32_NUM_SUPPLIES 2
36 static const char *const cs35l32_supply_names[CS35L32_NUM_SUPPLIES] = {
41 struct cs35l32_private {
42 struct regmap *regmap;
43 struct snd_soc_component *component;
44 struct regulator_bulk_data supplies[CS35L32_NUM_SUPPLIES];
45 struct cs35l32_platform_data pdata;
46 struct gpio_desc *reset_gpio;
49 static const struct reg_default cs35l32_reg_defaults[] = {
51 { 0x06, 0x04 }, /* Power Ctl 1 */
52 { 0x07, 0xE8 }, /* Power Ctl 2 */
53 { 0x08, 0x40 }, /* Clock Ctl */
54 { 0x09, 0x20 }, /* Low Battery Threshold */
55 { 0x0A, 0x00 }, /* Voltage Monitor [RO] */
56 { 0x0B, 0x40 }, /* Conv Peak Curr Protection CTL */
57 { 0x0C, 0x07 }, /* IMON Scaling */
58 { 0x0D, 0x03 }, /* Audio/LED Pwr Manager */
59 { 0x0F, 0x20 }, /* Serial Port Control */
60 { 0x10, 0x14 }, /* Class D Amp CTL */
61 { 0x11, 0x00 }, /* Protection Release CTL */
62 { 0x12, 0xFF }, /* Interrupt Mask 1 */
63 { 0x13, 0xFF }, /* Interrupt Mask 2 */
64 { 0x14, 0xFF }, /* Interrupt Mask 3 */
65 { 0x19, 0x00 }, /* LED Flash Mode Current */
66 { 0x1A, 0x00 }, /* LED Movie Mode Current */
67 { 0x1B, 0x20 }, /* LED Flash Timer */
68 { 0x1C, 0x00 }, /* LED Flash Inhibit Current */
71 static bool cs35l32_readable_register(struct device *dev, unsigned int reg)
74 case CS35L32_DEVID_AB ... CS35L32_AUDIO_LED_MNGR:
75 case CS35L32_ADSP_CTL ... CS35L32_FLASH_INHIBIT:
82 static bool cs35l32_volatile_register(struct device *dev, unsigned int reg)
85 case CS35L32_DEVID_AB ... CS35L32_REV_ID:
86 case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
93 static bool cs35l32_precious_register(struct device *dev, unsigned int reg)
96 case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
103 static DECLARE_TLV_DB_SCALE(classd_ctl_tlv, 900, 300, 0);
105 static const struct snd_kcontrol_new imon_ctl =
106 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 6, 1, 1);
108 static const struct snd_kcontrol_new vmon_ctl =
109 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 7, 1, 1);
111 static const struct snd_kcontrol_new vpmon_ctl =
112 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 5, 1, 1);
114 static const struct snd_kcontrol_new cs35l32_snd_controls[] = {
115 SOC_SINGLE_TLV("Speaker Volume", CS35L32_CLASSD_CTL,
116 3, 0x04, 1, classd_ctl_tlv),
117 SOC_SINGLE("Zero Cross Switch", CS35L32_CLASSD_CTL, 2, 1, 0),
118 SOC_SINGLE("Gain Manager Switch", CS35L32_AUDIO_LED_MNGR, 3, 1, 0),
121 static const struct snd_soc_dapm_widget cs35l32_dapm_widgets[] = {
123 SND_SOC_DAPM_SUPPLY("BOOST", CS35L32_PWRCTL1, 2, 1, NULL, 0),
124 SND_SOC_DAPM_OUT_DRV("Speaker", CS35L32_PWRCTL1, 7, 1, NULL, 0),
126 SND_SOC_DAPM_AIF_OUT("SDOUT", NULL, 0, CS35L32_PWRCTL2, 3, 1),
128 SND_SOC_DAPM_INPUT("VP"),
129 SND_SOC_DAPM_INPUT("ISENSE"),
130 SND_SOC_DAPM_INPUT("VSENSE"),
132 SND_SOC_DAPM_SWITCH("VMON ADC", CS35L32_PWRCTL2, 7, 1, &vmon_ctl),
133 SND_SOC_DAPM_SWITCH("IMON ADC", CS35L32_PWRCTL2, 6, 1, &imon_ctl),
134 SND_SOC_DAPM_SWITCH("VPMON ADC", CS35L32_PWRCTL2, 5, 1, &vpmon_ctl),
137 static const struct snd_soc_dapm_route cs35l32_audio_map[] = {
139 {"Speaker", NULL, "BOOST"},
141 {"VMON ADC", NULL, "VSENSE"},
142 {"IMON ADC", NULL, "ISENSE"},
143 {"VPMON ADC", NULL, "VP"},
145 {"SDOUT", "Switch", "VMON ADC"},
146 {"SDOUT", "Switch", "IMON ADC"},
147 {"SDOUT", "Switch", "VPMON ADC"},
149 {"Capture", NULL, "SDOUT"},
152 static int cs35l32_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
154 struct snd_soc_component *component = codec_dai->component;
156 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
157 case SND_SOC_DAIFMT_CBM_CFM:
158 snd_soc_component_update_bits(component, CS35L32_ADSP_CTL,
159 CS35L32_ADSP_MASTER_MASK,
160 CS35L32_ADSP_MASTER_MASK);
162 case SND_SOC_DAIFMT_CBS_CFS:
163 snd_soc_component_update_bits(component, CS35L32_ADSP_CTL,
164 CS35L32_ADSP_MASTER_MASK, 0);
173 static int cs35l32_set_tristate(struct snd_soc_dai *dai, int tristate)
175 struct snd_soc_component *component = dai->component;
177 return snd_soc_component_update_bits(component, CS35L32_PWRCTL2,
178 CS35L32_SDOUT_3ST, tristate << 3);
181 static const struct snd_soc_dai_ops cs35l32_ops = {
182 .set_fmt = cs35l32_set_dai_fmt,
183 .set_tristate = cs35l32_set_tristate,
186 static struct snd_soc_dai_driver cs35l32_dai[] = {
188 .name = "cs35l32-monitor",
191 .stream_name = "Capture",
194 .rates = CS35L32_RATES,
195 .formats = CS35L32_FORMATS,
202 static int cs35l32_component_set_sysclk(struct snd_soc_component *component,
203 int clk_id, int source, unsigned int freq, int dir)
209 val = CS35L32_MCLK_RATIO;
212 val = CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO;
218 val = CS35L32_MCLK_DIV2_MASK;
224 return snd_soc_component_update_bits(component, CS35L32_CLK_CTL,
225 CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO_MASK, val);
228 static const struct snd_soc_component_driver soc_component_dev_cs35l32 = {
229 .set_sysclk = cs35l32_component_set_sysclk,
230 .controls = cs35l32_snd_controls,
231 .num_controls = ARRAY_SIZE(cs35l32_snd_controls),
232 .dapm_widgets = cs35l32_dapm_widgets,
233 .num_dapm_widgets = ARRAY_SIZE(cs35l32_dapm_widgets),
234 .dapm_routes = cs35l32_audio_map,
235 .num_dapm_routes = ARRAY_SIZE(cs35l32_audio_map),
237 .use_pmdown_time = 1,
239 .non_legacy_dai_naming = 1,
242 /* Current and threshold powerup sequence Pg37 in datasheet */
243 static const struct reg_sequence cs35l32_monitor_patch[] = {
254 static const struct regmap_config cs35l32_regmap = {
258 .max_register = CS35L32_MAX_REGISTER,
259 .reg_defaults = cs35l32_reg_defaults,
260 .num_reg_defaults = ARRAY_SIZE(cs35l32_reg_defaults),
261 .volatile_reg = cs35l32_volatile_register,
262 .readable_reg = cs35l32_readable_register,
263 .precious_reg = cs35l32_precious_register,
264 .cache_type = REGCACHE_RBTREE,
266 .use_single_read = true,
267 .use_single_write = true,
270 static int cs35l32_handle_of_data(struct i2c_client *i2c_client,
271 struct cs35l32_platform_data *pdata)
273 struct device_node *np = i2c_client->dev.of_node;
276 if (of_property_read_u32(np, "cirrus,sdout-share", &val) >= 0)
277 pdata->sdout_share = val;
279 if (of_property_read_u32(np, "cirrus,boost-manager", &val))
283 case CS35L32_BOOST_MGR_AUTO:
284 case CS35L32_BOOST_MGR_AUTO_AUDIO:
285 case CS35L32_BOOST_MGR_BYPASS:
286 case CS35L32_BOOST_MGR_FIXED:
287 pdata->boost_mng = val;
291 dev_err(&i2c_client->dev,
292 "Wrong cirrus,boost-manager DT value %d\n", val);
293 pdata->boost_mng = CS35L32_BOOST_MGR_BYPASS;
296 if (of_property_read_u32(np, "cirrus,sdout-datacfg", &val))
299 case CS35L32_DATA_CFG_LR_VP:
300 case CS35L32_DATA_CFG_LR_STAT:
301 case CS35L32_DATA_CFG_LR:
302 case CS35L32_DATA_CFG_LR_VPSTAT:
303 pdata->sdout_datacfg = val;
307 dev_err(&i2c_client->dev,
308 "Wrong cirrus,sdout-datacfg DT value %d\n", val);
309 pdata->sdout_datacfg = CS35L32_DATA_CFG_LR;
312 if (of_property_read_u32(np, "cirrus,battery-threshold", &val))
315 case CS35L32_BATT_THRESH_3_1V:
316 case CS35L32_BATT_THRESH_3_2V:
317 case CS35L32_BATT_THRESH_3_3V:
318 case CS35L32_BATT_THRESH_3_4V:
319 pdata->batt_thresh = val;
323 dev_err(&i2c_client->dev,
324 "Wrong cirrus,battery-threshold DT value %d\n", val);
325 pdata->batt_thresh = CS35L32_BATT_THRESH_3_3V;
328 if (of_property_read_u32(np, "cirrus,battery-recovery", &val))
331 case CS35L32_BATT_RECOV_3_1V:
332 case CS35L32_BATT_RECOV_3_2V:
333 case CS35L32_BATT_RECOV_3_3V:
334 case CS35L32_BATT_RECOV_3_4V:
335 case CS35L32_BATT_RECOV_3_5V:
336 case CS35L32_BATT_RECOV_3_6V:
337 pdata->batt_recov = val;
341 dev_err(&i2c_client->dev,
342 "Wrong cirrus,battery-recovery DT value %d\n", val);
343 pdata->batt_recov = CS35L32_BATT_RECOV_3_4V;
349 static int cs35l32_i2c_probe(struct i2c_client *i2c_client)
351 struct cs35l32_private *cs35l32;
352 struct cs35l32_platform_data *pdata =
353 dev_get_platdata(&i2c_client->dev);
357 cs35l32 = devm_kzalloc(&i2c_client->dev, sizeof(*cs35l32), GFP_KERNEL);
361 i2c_set_clientdata(i2c_client, cs35l32);
363 cs35l32->regmap = devm_regmap_init_i2c(i2c_client, &cs35l32_regmap);
364 if (IS_ERR(cs35l32->regmap)) {
365 ret = PTR_ERR(cs35l32->regmap);
366 dev_err(&i2c_client->dev, "regmap_init() failed: %d\n", ret);
371 cs35l32->pdata = *pdata;
373 pdata = devm_kzalloc(&i2c_client->dev, sizeof(*pdata),
378 if (i2c_client->dev.of_node) {
379 ret = cs35l32_handle_of_data(i2c_client,
386 for (i = 0; i < ARRAY_SIZE(cs35l32->supplies); i++)
387 cs35l32->supplies[i].supply = cs35l32_supply_names[i];
389 ret = devm_regulator_bulk_get(&i2c_client->dev,
390 ARRAY_SIZE(cs35l32->supplies),
393 dev_err(&i2c_client->dev,
394 "Failed to request supplies: %d\n", ret);
398 ret = regulator_bulk_enable(ARRAY_SIZE(cs35l32->supplies),
401 dev_err(&i2c_client->dev,
402 "Failed to enable supplies: %d\n", ret);
406 /* Reset the Device */
407 cs35l32->reset_gpio = devm_gpiod_get_optional(&i2c_client->dev,
408 "reset", GPIOD_OUT_LOW);
409 if (IS_ERR(cs35l32->reset_gpio)) {
410 ret = PTR_ERR(cs35l32->reset_gpio);
414 gpiod_set_value_cansleep(cs35l32->reset_gpio, 1);
416 /* initialize codec */
417 devid = cirrus_read_device_id(cs35l32->regmap, CS35L32_DEVID_AB);
420 dev_err(&i2c_client->dev, "Failed to read device ID: %d\n", ret);
424 if (devid != CS35L32_CHIP_ID) {
426 dev_err(&i2c_client->dev,
427 "CS35L32 Device ID (%X). Expected %X\n",
428 devid, CS35L32_CHIP_ID);
432 ret = regmap_read(cs35l32->regmap, CS35L32_REV_ID, ®);
434 dev_err(&i2c_client->dev, "Get Revision ID failed\n");
438 ret = regmap_register_patch(cs35l32->regmap, cs35l32_monitor_patch,
439 ARRAY_SIZE(cs35l32_monitor_patch));
441 dev_err(&i2c_client->dev, "Failed to apply errata patch\n");
445 dev_info(&i2c_client->dev,
446 "Cirrus Logic CS35L32, Revision: %02X\n", reg & 0xFF);
448 /* Setup VBOOST Management */
449 if (cs35l32->pdata.boost_mng)
450 regmap_update_bits(cs35l32->regmap, CS35L32_AUDIO_LED_MNGR,
452 cs35l32->pdata.boost_mng);
454 /* Setup ADSP Format Config */
455 if (cs35l32->pdata.sdout_share)
456 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
457 CS35L32_ADSP_SHARE_MASK,
458 cs35l32->pdata.sdout_share << 3);
460 /* Setup ADSP Data Configuration */
461 if (cs35l32->pdata.sdout_datacfg)
462 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
463 CS35L32_ADSP_DATACFG_MASK,
464 cs35l32->pdata.sdout_datacfg << 4);
466 /* Setup Low Battery Recovery */
467 if (cs35l32->pdata.batt_recov)
468 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
469 CS35L32_BATT_REC_MASK,
470 cs35l32->pdata.batt_recov << 1);
472 /* Setup Low Battery Threshold */
473 if (cs35l32->pdata.batt_thresh)
474 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
475 CS35L32_BATT_THRESH_MASK,
476 cs35l32->pdata.batt_thresh << 4);
478 /* Power down the AMP */
479 regmap_update_bits(cs35l32->regmap, CS35L32_PWRCTL1, CS35L32_PDN_AMP,
482 /* Clear MCLK Error Bit since we don't have the clock yet */
483 regmap_read(cs35l32->regmap, CS35L32_INT_STATUS_1, ®);
485 ret = devm_snd_soc_register_component(&i2c_client->dev,
486 &soc_component_dev_cs35l32, cs35l32_dai,
487 ARRAY_SIZE(cs35l32_dai));
494 gpiod_set_value_cansleep(cs35l32->reset_gpio, 0);
496 regulator_bulk_disable(ARRAY_SIZE(cs35l32->supplies),
501 static int cs35l32_i2c_remove(struct i2c_client *i2c_client)
503 struct cs35l32_private *cs35l32 = i2c_get_clientdata(i2c_client);
505 /* Hold down reset */
506 gpiod_set_value_cansleep(cs35l32->reset_gpio, 0);
512 static int cs35l32_runtime_suspend(struct device *dev)
514 struct cs35l32_private *cs35l32 = dev_get_drvdata(dev);
516 regcache_cache_only(cs35l32->regmap, true);
517 regcache_mark_dirty(cs35l32->regmap);
519 /* Hold down reset */
520 gpiod_set_value_cansleep(cs35l32->reset_gpio, 0);
523 regulator_bulk_disable(ARRAY_SIZE(cs35l32->supplies),
529 static int cs35l32_runtime_resume(struct device *dev)
531 struct cs35l32_private *cs35l32 = dev_get_drvdata(dev);
535 ret = regulator_bulk_enable(ARRAY_SIZE(cs35l32->supplies),
538 dev_err(dev, "Failed to enable supplies: %d\n",
543 gpiod_set_value_cansleep(cs35l32->reset_gpio, 1);
545 regcache_cache_only(cs35l32->regmap, false);
546 regcache_sync(cs35l32->regmap);
552 static const struct dev_pm_ops cs35l32_runtime_pm = {
553 SET_RUNTIME_PM_OPS(cs35l32_runtime_suspend, cs35l32_runtime_resume,
557 static const struct of_device_id cs35l32_of_match[] = {
558 { .compatible = "cirrus,cs35l32", },
561 MODULE_DEVICE_TABLE(of, cs35l32_of_match);
564 static const struct i2c_device_id cs35l32_id[] = {
569 MODULE_DEVICE_TABLE(i2c, cs35l32_id);
571 static struct i2c_driver cs35l32_i2c_driver = {
574 .pm = &cs35l32_runtime_pm,
575 .of_match_table = cs35l32_of_match,
577 .id_table = cs35l32_id,
578 .probe_new = cs35l32_i2c_probe,
579 .remove = cs35l32_i2c_remove,
582 module_i2c_driver(cs35l32_i2c_driver);
584 MODULE_DESCRIPTION("ASoC CS35L32 driver");
586 MODULE_LICENSE("GPL");