2 * cs35l32.c -- CS35L32 ALSA SoC audio driver
4 * Copyright 2014 CirrusLogic, Inc.
6 * Author: Brian Austin <brian.austin@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.
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/i2c.h>
20 #include <linux/gpio.h>
21 #include <linux/regmap.h>
22 #include <linux/slab.h>
23 #include <linux/platform_device.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/gpio/consumer.h>
26 #include <linux/of_device.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/soc-dapm.h>
32 #include <sound/initval.h>
33 #include <sound/tlv.h>
34 #include <dt-bindings/sound/cs35l32.h>
38 #define CS35L32_NUM_SUPPLIES 2
39 static const char *const cs35l32_supply_names[CS35L32_NUM_SUPPLIES] = {
44 struct cs35l32_private {
45 struct regmap *regmap;
46 struct snd_soc_component *component;
47 struct regulator_bulk_data supplies[CS35L32_NUM_SUPPLIES];
48 struct cs35l32_platform_data pdata;
49 struct gpio_desc *reset_gpio;
52 static const struct reg_default cs35l32_reg_defaults[] = {
54 { 0x06, 0x04 }, /* Power Ctl 1 */
55 { 0x07, 0xE8 }, /* Power Ctl 2 */
56 { 0x08, 0x40 }, /* Clock Ctl */
57 { 0x09, 0x20 }, /* Low Battery Threshold */
58 { 0x0A, 0x00 }, /* Voltage Monitor [RO] */
59 { 0x0B, 0x40 }, /* Conv Peak Curr Protection CTL */
60 { 0x0C, 0x07 }, /* IMON Scaling */
61 { 0x0D, 0x03 }, /* Audio/LED Pwr Manager */
62 { 0x0F, 0x20 }, /* Serial Port Control */
63 { 0x10, 0x14 }, /* Class D Amp CTL */
64 { 0x11, 0x00 }, /* Protection Release CTL */
65 { 0x12, 0xFF }, /* Interrupt Mask 1 */
66 { 0x13, 0xFF }, /* Interrupt Mask 2 */
67 { 0x14, 0xFF }, /* Interrupt Mask 3 */
68 { 0x19, 0x00 }, /* LED Flash Mode Current */
69 { 0x1A, 0x00 }, /* LED Movie Mode Current */
70 { 0x1B, 0x20 }, /* LED Flash Timer */
71 { 0x1C, 0x00 }, /* LED Flash Inhibit Current */
74 static bool cs35l32_readable_register(struct device *dev, unsigned int reg)
77 case CS35L32_DEVID_AB ... CS35L32_AUDIO_LED_MNGR:
78 case CS35L32_ADSP_CTL ... CS35L32_FLASH_INHIBIT:
85 static bool cs35l32_volatile_register(struct device *dev, unsigned int reg)
88 case CS35L32_DEVID_AB ... CS35L32_REV_ID:
89 case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
96 static bool cs35l32_precious_register(struct device *dev, unsigned int reg)
99 case CS35L32_INT_STATUS_1 ... CS35L32_LED_STATUS:
106 static DECLARE_TLV_DB_SCALE(classd_ctl_tlv, 900, 300, 0);
108 static const struct snd_kcontrol_new imon_ctl =
109 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 6, 1, 1);
111 static const struct snd_kcontrol_new vmon_ctl =
112 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 7, 1, 1);
114 static const struct snd_kcontrol_new vpmon_ctl =
115 SOC_DAPM_SINGLE("Switch", CS35L32_PWRCTL2, 5, 1, 1);
117 static const struct snd_kcontrol_new cs35l32_snd_controls[] = {
118 SOC_SINGLE_TLV("Speaker Volume", CS35L32_CLASSD_CTL,
119 3, 0x04, 1, classd_ctl_tlv),
120 SOC_SINGLE("Zero Cross Switch", CS35L32_CLASSD_CTL, 2, 1, 0),
121 SOC_SINGLE("Gain Manager Switch", CS35L32_AUDIO_LED_MNGR, 3, 1, 0),
124 static const struct snd_soc_dapm_widget cs35l32_dapm_widgets[] = {
126 SND_SOC_DAPM_SUPPLY("BOOST", CS35L32_PWRCTL1, 2, 1, NULL, 0),
127 SND_SOC_DAPM_OUT_DRV("Speaker", CS35L32_PWRCTL1, 7, 1, NULL, 0),
129 SND_SOC_DAPM_AIF_OUT("SDOUT", NULL, 0, CS35L32_PWRCTL2, 3, 1),
131 SND_SOC_DAPM_INPUT("VP"),
132 SND_SOC_DAPM_INPUT("ISENSE"),
133 SND_SOC_DAPM_INPUT("VSENSE"),
135 SND_SOC_DAPM_SWITCH("VMON ADC", CS35L32_PWRCTL2, 7, 1, &vmon_ctl),
136 SND_SOC_DAPM_SWITCH("IMON ADC", CS35L32_PWRCTL2, 6, 1, &imon_ctl),
137 SND_SOC_DAPM_SWITCH("VPMON ADC", CS35L32_PWRCTL2, 5, 1, &vpmon_ctl),
140 static const struct snd_soc_dapm_route cs35l32_audio_map[] = {
142 {"Speaker", NULL, "BOOST"},
144 {"VMON ADC", NULL, "VSENSE"},
145 {"IMON ADC", NULL, "ISENSE"},
146 {"VPMON ADC", NULL, "VP"},
148 {"SDOUT", "Switch", "VMON ADC"},
149 {"SDOUT", "Switch", "IMON ADC"},
150 {"SDOUT", "Switch", "VPMON ADC"},
152 {"Capture", NULL, "SDOUT"},
155 static int cs35l32_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
157 struct snd_soc_component *component = codec_dai->component;
159 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
160 case SND_SOC_DAIFMT_CBM_CFM:
161 snd_soc_component_update_bits(component, CS35L32_ADSP_CTL,
162 CS35L32_ADSP_MASTER_MASK,
163 CS35L32_ADSP_MASTER_MASK);
165 case SND_SOC_DAIFMT_CBS_CFS:
166 snd_soc_component_update_bits(component, CS35L32_ADSP_CTL,
167 CS35L32_ADSP_MASTER_MASK, 0);
176 static int cs35l32_set_tristate(struct snd_soc_dai *dai, int tristate)
178 struct snd_soc_component *component = dai->component;
180 return snd_soc_component_update_bits(component, CS35L32_PWRCTL2,
181 CS35L32_SDOUT_3ST, tristate << 3);
184 static const struct snd_soc_dai_ops cs35l32_ops = {
185 .set_fmt = cs35l32_set_dai_fmt,
186 .set_tristate = cs35l32_set_tristate,
189 static struct snd_soc_dai_driver cs35l32_dai[] = {
191 .name = "cs35l32-monitor",
194 .stream_name = "Capture",
197 .rates = CS35L32_RATES,
198 .formats = CS35L32_FORMATS,
201 .symmetric_rates = 1,
205 static int cs35l32_component_set_sysclk(struct snd_soc_component *component,
206 int clk_id, int source, unsigned int freq, int dir)
212 val = CS35L32_MCLK_RATIO;
215 val = CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO;
221 val = CS35L32_MCLK_DIV2_MASK;
227 return snd_soc_component_update_bits(component, CS35L32_CLK_CTL,
228 CS35L32_MCLK_DIV2_MASK | CS35L32_MCLK_RATIO_MASK, val);
231 static const struct snd_soc_component_driver soc_component_dev_cs35l32 = {
232 .set_sysclk = cs35l32_component_set_sysclk,
233 .controls = cs35l32_snd_controls,
234 .num_controls = ARRAY_SIZE(cs35l32_snd_controls),
235 .dapm_widgets = cs35l32_dapm_widgets,
236 .num_dapm_widgets = ARRAY_SIZE(cs35l32_dapm_widgets),
237 .dapm_routes = cs35l32_audio_map,
238 .num_dapm_routes = ARRAY_SIZE(cs35l32_audio_map),
240 .use_pmdown_time = 1,
242 .non_legacy_dai_naming = 1,
245 /* Current and threshold powerup sequence Pg37 in datasheet */
246 static const struct reg_sequence cs35l32_monitor_patch[] = {
257 static const struct regmap_config cs35l32_regmap = {
261 .max_register = CS35L32_MAX_REGISTER,
262 .reg_defaults = cs35l32_reg_defaults,
263 .num_reg_defaults = ARRAY_SIZE(cs35l32_reg_defaults),
264 .volatile_reg = cs35l32_volatile_register,
265 .readable_reg = cs35l32_readable_register,
266 .precious_reg = cs35l32_precious_register,
267 .cache_type = REGCACHE_RBTREE,
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,
350 const struct i2c_device_id *id)
352 struct cs35l32_private *cs35l32;
353 struct cs35l32_platform_data *pdata =
354 dev_get_platdata(&i2c_client->dev);
356 unsigned int devid = 0;
359 cs35l32 = devm_kzalloc(&i2c_client->dev, sizeof(*cs35l32), GFP_KERNEL);
363 i2c_set_clientdata(i2c_client, cs35l32);
365 cs35l32->regmap = devm_regmap_init_i2c(i2c_client, &cs35l32_regmap);
366 if (IS_ERR(cs35l32->regmap)) {
367 ret = PTR_ERR(cs35l32->regmap);
368 dev_err(&i2c_client->dev, "regmap_init() failed: %d\n", ret);
373 cs35l32->pdata = *pdata;
375 pdata = devm_kzalloc(&i2c_client->dev, sizeof(*pdata),
380 if (i2c_client->dev.of_node) {
381 ret = cs35l32_handle_of_data(i2c_client,
388 for (i = 0; i < ARRAY_SIZE(cs35l32->supplies); i++)
389 cs35l32->supplies[i].supply = cs35l32_supply_names[i];
391 ret = devm_regulator_bulk_get(&i2c_client->dev,
392 ARRAY_SIZE(cs35l32->supplies),
395 dev_err(&i2c_client->dev,
396 "Failed to request supplies: %d\n", ret);
400 ret = regulator_bulk_enable(ARRAY_SIZE(cs35l32->supplies),
403 dev_err(&i2c_client->dev,
404 "Failed to enable supplies: %d\n", ret);
408 /* Reset the Device */
409 cs35l32->reset_gpio = devm_gpiod_get_optional(&i2c_client->dev,
410 "reset", GPIOD_OUT_LOW);
411 if (IS_ERR(cs35l32->reset_gpio))
412 return PTR_ERR(cs35l32->reset_gpio);
414 gpiod_set_value_cansleep(cs35l32->reset_gpio, 1);
416 /* initialize codec */
417 ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_AB, ®);
418 devid = (reg & 0xFF) << 12;
420 ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_CD, ®);
421 devid |= (reg & 0xFF) << 4;
423 ret = regmap_read(cs35l32->regmap, CS35L32_DEVID_E, ®);
424 devid |= (reg & 0xF0) >> 4;
426 if (devid != CS35L32_CHIP_ID) {
428 dev_err(&i2c_client->dev,
429 "CS35L32 Device ID (%X). Expected %X\n",
430 devid, CS35L32_CHIP_ID);
434 ret = regmap_read(cs35l32->regmap, CS35L32_REV_ID, ®);
436 dev_err(&i2c_client->dev, "Get Revision ID failed\n");
440 ret = regmap_register_patch(cs35l32->regmap, cs35l32_monitor_patch,
441 ARRAY_SIZE(cs35l32_monitor_patch));
443 dev_err(&i2c_client->dev, "Failed to apply errata patch\n");
447 dev_info(&i2c_client->dev,
448 "Cirrus Logic CS35L32, Revision: %02X\n", reg & 0xFF);
450 /* Setup VBOOST Management */
451 if (cs35l32->pdata.boost_mng)
452 regmap_update_bits(cs35l32->regmap, CS35L32_AUDIO_LED_MNGR,
454 cs35l32->pdata.boost_mng);
456 /* Setup ADSP Format Config */
457 if (cs35l32->pdata.sdout_share)
458 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
459 CS35L32_ADSP_SHARE_MASK,
460 cs35l32->pdata.sdout_share << 3);
462 /* Setup ADSP Data Configuration */
463 if (cs35l32->pdata.sdout_datacfg)
464 regmap_update_bits(cs35l32->regmap, CS35L32_ADSP_CTL,
465 CS35L32_ADSP_DATACFG_MASK,
466 cs35l32->pdata.sdout_datacfg << 4);
468 /* Setup Low Battery Recovery */
469 if (cs35l32->pdata.batt_recov)
470 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
471 CS35L32_BATT_REC_MASK,
472 cs35l32->pdata.batt_recov << 1);
474 /* Setup Low Battery Threshold */
475 if (cs35l32->pdata.batt_thresh)
476 regmap_update_bits(cs35l32->regmap, CS35L32_BATT_THRESHOLD,
477 CS35L32_BATT_THRESH_MASK,
478 cs35l32->pdata.batt_thresh << 4);
480 /* Power down the AMP */
481 regmap_update_bits(cs35l32->regmap, CS35L32_PWRCTL1, CS35L32_PDN_AMP,
484 /* Clear MCLK Error Bit since we don't have the clock yet */
485 ret = regmap_read(cs35l32->regmap, CS35L32_INT_STATUS_1, ®);
487 ret = devm_snd_soc_register_component(&i2c_client->dev,
488 &soc_component_dev_cs35l32, cs35l32_dai,
489 ARRAY_SIZE(cs35l32_dai));
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 = cs35l32_i2c_probe,
579 .remove = cs35l32_i2c_remove,
582 module_i2c_driver(cs35l32_i2c_driver);
584 MODULE_DESCRIPTION("ASoC CS35L32 driver");
585 MODULE_AUTHOR("Brian Austin, Cirrus Logic Inc, <brian.austin@cirrus.com>");
586 MODULE_LICENSE("GPL");