1 // SPDX-License-Identifier: GPL-2.0-only
3 * cs35l32.c -- CS35L32 ALSA SoC audio driver
5 * Copyright 2014 CirrusLogic, Inc.
7 * Author: Brian Austin <brian.austin@cirrus.com>
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
,
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
);
358 cs35l32
= devm_kzalloc(&i2c_client
->dev
, sizeof(*cs35l32
), GFP_KERNEL
);
362 i2c_set_clientdata(i2c_client
, cs35l32
);
364 cs35l32
->regmap
= devm_regmap_init_i2c(i2c_client
, &cs35l32_regmap
);
365 if (IS_ERR(cs35l32
->regmap
)) {
366 ret
= PTR_ERR(cs35l32
->regmap
);
367 dev_err(&i2c_client
->dev
, "regmap_init() failed: %d\n", ret
);
372 cs35l32
->pdata
= *pdata
;
374 pdata
= devm_kzalloc(&i2c_client
->dev
, sizeof(*pdata
),
379 if (i2c_client
->dev
.of_node
) {
380 ret
= cs35l32_handle_of_data(i2c_client
,
387 for (i
= 0; i
< ARRAY_SIZE(cs35l32
->supplies
); i
++)
388 cs35l32
->supplies
[i
].supply
= cs35l32_supply_names
[i
];
390 ret
= devm_regulator_bulk_get(&i2c_client
->dev
,
391 ARRAY_SIZE(cs35l32
->supplies
),
394 dev_err(&i2c_client
->dev
,
395 "Failed to request supplies: %d\n", ret
);
399 ret
= regulator_bulk_enable(ARRAY_SIZE(cs35l32
->supplies
),
402 dev_err(&i2c_client
->dev
,
403 "Failed to enable supplies: %d\n", ret
);
407 /* Reset the Device */
408 cs35l32
->reset_gpio
= devm_gpiod_get_optional(&i2c_client
->dev
,
409 "reset", GPIOD_OUT_LOW
);
410 if (IS_ERR(cs35l32
->reset_gpio
)) {
411 ret
= PTR_ERR(cs35l32
->reset_gpio
);
415 gpiod_set_value_cansleep(cs35l32
->reset_gpio
, 1);
417 /* initialize codec */
418 devid
= cirrus_read_device_id(cs35l32
->regmap
, CS35L32_DEVID_AB
);
421 dev_err(&i2c_client
->dev
, "Failed to read device ID: %d\n", ret
);
425 if (devid
!= CS35L32_CHIP_ID
) {
427 dev_err(&i2c_client
->dev
,
428 "CS35L32 Device ID (%X). Expected %X\n",
429 devid
, CS35L32_CHIP_ID
);
433 ret
= regmap_read(cs35l32
->regmap
, CS35L32_REV_ID
, ®
);
435 dev_err(&i2c_client
->dev
, "Get Revision ID failed\n");
439 ret
= regmap_register_patch(cs35l32
->regmap
, cs35l32_monitor_patch
,
440 ARRAY_SIZE(cs35l32_monitor_patch
));
442 dev_err(&i2c_client
->dev
, "Failed to apply errata patch\n");
446 dev_info(&i2c_client
->dev
,
447 "Cirrus Logic CS35L32, Revision: %02X\n", reg
& 0xFF);
449 /* Setup VBOOST Management */
450 if (cs35l32
->pdata
.boost_mng
)
451 regmap_update_bits(cs35l32
->regmap
, CS35L32_AUDIO_LED_MNGR
,
453 cs35l32
->pdata
.boost_mng
);
455 /* Setup ADSP Format Config */
456 if (cs35l32
->pdata
.sdout_share
)
457 regmap_update_bits(cs35l32
->regmap
, CS35L32_ADSP_CTL
,
458 CS35L32_ADSP_SHARE_MASK
,
459 cs35l32
->pdata
.sdout_share
<< 3);
461 /* Setup ADSP Data Configuration */
462 if (cs35l32
->pdata
.sdout_datacfg
)
463 regmap_update_bits(cs35l32
->regmap
, CS35L32_ADSP_CTL
,
464 CS35L32_ADSP_DATACFG_MASK
,
465 cs35l32
->pdata
.sdout_datacfg
<< 4);
467 /* Setup Low Battery Recovery */
468 if (cs35l32
->pdata
.batt_recov
)
469 regmap_update_bits(cs35l32
->regmap
, CS35L32_BATT_THRESHOLD
,
470 CS35L32_BATT_REC_MASK
,
471 cs35l32
->pdata
.batt_recov
<< 1);
473 /* Setup Low Battery Threshold */
474 if (cs35l32
->pdata
.batt_thresh
)
475 regmap_update_bits(cs35l32
->regmap
, CS35L32_BATT_THRESHOLD
,
476 CS35L32_BATT_THRESH_MASK
,
477 cs35l32
->pdata
.batt_thresh
<< 4);
479 /* Power down the AMP */
480 regmap_update_bits(cs35l32
->regmap
, CS35L32_PWRCTL1
, CS35L32_PDN_AMP
,
483 /* Clear MCLK Error Bit since we don't have the clock yet */
484 regmap_read(cs35l32
->regmap
, CS35L32_INT_STATUS_1
, ®
);
486 ret
= devm_snd_soc_register_component(&i2c_client
->dev
,
487 &soc_component_dev_cs35l32
, cs35l32_dai
,
488 ARRAY_SIZE(cs35l32_dai
));
495 gpiod_set_value_cansleep(cs35l32
->reset_gpio
, 0);
497 regulator_bulk_disable(ARRAY_SIZE(cs35l32
->supplies
),
502 static int cs35l32_i2c_remove(struct i2c_client
*i2c_client
)
504 struct cs35l32_private
*cs35l32
= i2c_get_clientdata(i2c_client
);
506 /* Hold down reset */
507 gpiod_set_value_cansleep(cs35l32
->reset_gpio
, 0);
513 static int cs35l32_runtime_suspend(struct device
*dev
)
515 struct cs35l32_private
*cs35l32
= dev_get_drvdata(dev
);
517 regcache_cache_only(cs35l32
->regmap
, true);
518 regcache_mark_dirty(cs35l32
->regmap
);
520 /* Hold down reset */
521 gpiod_set_value_cansleep(cs35l32
->reset_gpio
, 0);
524 regulator_bulk_disable(ARRAY_SIZE(cs35l32
->supplies
),
530 static int cs35l32_runtime_resume(struct device
*dev
)
532 struct cs35l32_private
*cs35l32
= dev_get_drvdata(dev
);
536 ret
= regulator_bulk_enable(ARRAY_SIZE(cs35l32
->supplies
),
539 dev_err(dev
, "Failed to enable supplies: %d\n",
544 gpiod_set_value_cansleep(cs35l32
->reset_gpio
, 1);
546 regcache_cache_only(cs35l32
->regmap
, false);
547 regcache_sync(cs35l32
->regmap
);
553 static const struct dev_pm_ops cs35l32_runtime_pm
= {
554 SET_RUNTIME_PM_OPS(cs35l32_runtime_suspend
, cs35l32_runtime_resume
,
558 static const struct of_device_id cs35l32_of_match
[] = {
559 { .compatible
= "cirrus,cs35l32", },
562 MODULE_DEVICE_TABLE(of
, cs35l32_of_match
);
565 static const struct i2c_device_id cs35l32_id
[] = {
570 MODULE_DEVICE_TABLE(i2c
, cs35l32_id
);
572 static struct i2c_driver cs35l32_i2c_driver
= {
575 .pm
= &cs35l32_runtime_pm
,
576 .of_match_table
= cs35l32_of_match
,
578 .id_table
= cs35l32_id
,
579 .probe
= cs35l32_i2c_probe
,
580 .remove
= cs35l32_i2c_remove
,
583 module_i2c_driver(cs35l32_i2c_driver
);
585 MODULE_DESCRIPTION("ASoC CS35L32 driver");
586 MODULE_AUTHOR("Brian Austin, Cirrus Logic Inc, <brian.austin@cirrus.com>");
587 MODULE_LICENSE("GPL");