2 * Codec driver for ST STA32x 2.1-channel high-efficiency digital audio system
4 * Copyright: 2011 Raumfeld GmbH
5 * Author: Johannes Stezenbach <js@sig21.net>
8 * Wolfson Microelectronics PLC.
9 * Mark Brown <broonie@opensource.wolfsonmicro.com>
10 * Freescale Semiconductor, Inc.
11 * Timur Tabi <timur@freescale.com>
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version.
19 #define pr_fmt(fmt) KBUILD_MODNAME ":%s:%d: " fmt, __func__, __LINE__
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/init.h>
24 #include <linux/clk.h>
25 #include <linux/delay.h>
27 #include <linux/i2c.h>
28 #include <linux/of_device.h>
29 #include <linux/of_gpio.h>
30 #include <linux/regmap.h>
31 #include <linux/regulator/consumer.h>
32 #include <linux/gpio/consumer.h>
33 #include <linux/slab.h>
34 #include <linux/workqueue.h>
35 #include <sound/core.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/soc.h>
39 #include <sound/soc-dapm.h>
40 #include <sound/initval.h>
41 #include <sound/tlv.h>
43 #include <sound/sta32x.h>
46 #define STA32X_RATES (SNDRV_PCM_RATE_32000 | \
47 SNDRV_PCM_RATE_44100 | \
48 SNDRV_PCM_RATE_48000 | \
49 SNDRV_PCM_RATE_88200 | \
50 SNDRV_PCM_RATE_96000 | \
51 SNDRV_PCM_RATE_176400 | \
52 SNDRV_PCM_RATE_192000)
54 #define STA32X_FORMATS \
55 (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE | \
56 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
57 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
58 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE | \
59 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE | \
60 SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S32_BE)
62 /* Power-up register defaults */
63 static const struct reg_default sta32x_regs[] = {
109 static const struct regmap_range sta32x_write_regs_range[] = {
110 regmap_reg_range(STA32X_CONFA, STA32X_FDRC2),
113 static const struct regmap_range sta32x_read_regs_range[] = {
114 regmap_reg_range(STA32X_CONFA, STA32X_FDRC2),
117 static const struct regmap_range sta32x_volatile_regs_range[] = {
118 regmap_reg_range(STA32X_CFADDR2, STA32X_CFUD),
121 static const struct regmap_access_table sta32x_write_regs = {
122 .yes_ranges = sta32x_write_regs_range,
123 .n_yes_ranges = ARRAY_SIZE(sta32x_write_regs_range),
126 static const struct regmap_access_table sta32x_read_regs = {
127 .yes_ranges = sta32x_read_regs_range,
128 .n_yes_ranges = ARRAY_SIZE(sta32x_read_regs_range),
131 static const struct regmap_access_table sta32x_volatile_regs = {
132 .yes_ranges = sta32x_volatile_regs_range,
133 .n_yes_ranges = ARRAY_SIZE(sta32x_volatile_regs_range),
136 /* regulator power supply names */
137 static const char *sta32x_supply_names[] = {
138 "Vdda", /* analog supply, 3.3VV */
139 "Vdd3", /* digital supply, 3.3V */
140 "Vcc" /* power amp spply, 10V - 36V */
143 /* codec private data */
145 struct regmap *regmap;
147 struct regulator_bulk_data supplies[ARRAY_SIZE(sta32x_supply_names)];
148 struct snd_soc_component *component;
149 struct sta32x_platform_data *pdata;
154 u32 coef_shadow[STA32X_COEF_COUNT];
155 struct delayed_work watchdog_work;
157 struct gpio_desc *gpiod_nreset;
158 struct mutex coeff_lock;
161 static const DECLARE_TLV_DB_SCALE(mvol_tlv, -12700, 50, 1);
162 static const DECLARE_TLV_DB_SCALE(chvol_tlv, -7950, 50, 1);
163 static const DECLARE_TLV_DB_SCALE(tone_tlv, -120, 200, 0);
165 static const char *sta32x_drc_ac[] = {
166 "Anti-Clipping", "Dynamic Range Compression" };
167 static const char *sta32x_auto_eq_mode[] = {
168 "User", "Preset", "Loudness" };
169 static const char *sta32x_auto_gc_mode[] = {
170 "User", "AC no clipping", "AC limited clipping (10%)",
171 "DRC nighttime listening mode" };
172 static const char *sta32x_auto_xo_mode[] = {
173 "User", "80Hz", "100Hz", "120Hz", "140Hz", "160Hz", "180Hz", "200Hz",
174 "220Hz", "240Hz", "260Hz", "280Hz", "300Hz", "320Hz", "340Hz", "360Hz" };
175 static const char *sta32x_preset_eq_mode[] = {
176 "Flat", "Rock", "Soft Rock", "Jazz", "Classical", "Dance", "Pop", "Soft",
177 "Hard", "Party", "Vocal", "Hip-Hop", "Dialog", "Bass-boost #1",
178 "Bass-boost #2", "Bass-boost #3", "Loudness 1", "Loudness 2",
179 "Loudness 3", "Loudness 4", "Loudness 5", "Loudness 6", "Loudness 7",
180 "Loudness 8", "Loudness 9", "Loudness 10", "Loudness 11", "Loudness 12",
181 "Loudness 13", "Loudness 14", "Loudness 15", "Loudness 16" };
182 static const char *sta32x_limiter_select[] = {
183 "Limiter Disabled", "Limiter #1", "Limiter #2" };
184 static const char *sta32x_limiter_attack_rate[] = {
185 "3.1584", "2.7072", "2.2560", "1.8048", "1.3536", "0.9024",
186 "0.4512", "0.2256", "0.1504", "0.1123", "0.0902", "0.0752",
187 "0.0645", "0.0564", "0.0501", "0.0451" };
188 static const char *sta32x_limiter_release_rate[] = {
189 "0.5116", "0.1370", "0.0744", "0.0499", "0.0360", "0.0299",
190 "0.0264", "0.0208", "0.0198", "0.0172", "0.0147", "0.0137",
191 "0.0134", "0.0117", "0.0110", "0.0104" };
192 static DECLARE_TLV_DB_RANGE(sta32x_limiter_ac_attack_tlv,
193 0, 7, TLV_DB_SCALE_ITEM(-1200, 200, 0),
194 8, 16, TLV_DB_SCALE_ITEM(300, 100, 0),
197 static DECLARE_TLV_DB_RANGE(sta32x_limiter_ac_release_tlv,
198 0, 0, TLV_DB_SCALE_ITEM(TLV_DB_GAIN_MUTE, 0, 0),
199 1, 1, TLV_DB_SCALE_ITEM(-2900, 0, 0),
200 2, 2, TLV_DB_SCALE_ITEM(-2000, 0, 0),
201 3, 8, TLV_DB_SCALE_ITEM(-1400, 200, 0),
202 8, 16, TLV_DB_SCALE_ITEM(-700, 100, 0),
205 static DECLARE_TLV_DB_RANGE(sta32x_limiter_drc_attack_tlv,
206 0, 7, TLV_DB_SCALE_ITEM(-3100, 200, 0),
207 8, 13, TLV_DB_SCALE_ITEM(-1600, 100, 0),
208 14, 16, TLV_DB_SCALE_ITEM(-1000, 300, 0),
211 static DECLARE_TLV_DB_RANGE(sta32x_limiter_drc_release_tlv,
212 0, 0, TLV_DB_SCALE_ITEM(TLV_DB_GAIN_MUTE, 0, 0),
213 1, 2, TLV_DB_SCALE_ITEM(-3800, 200, 0),
214 3, 4, TLV_DB_SCALE_ITEM(-3300, 200, 0),
215 5, 12, TLV_DB_SCALE_ITEM(-3000, 200, 0),
216 13, 16, TLV_DB_SCALE_ITEM(-1500, 300, 0),
219 static SOC_ENUM_SINGLE_DECL(sta32x_drc_ac_enum,
220 STA32X_CONFD, STA32X_CONFD_DRC_SHIFT,
222 static SOC_ENUM_SINGLE_DECL(sta32x_auto_eq_enum,
223 STA32X_AUTO1, STA32X_AUTO1_AMEQ_SHIFT,
224 sta32x_auto_eq_mode);
225 static SOC_ENUM_SINGLE_DECL(sta32x_auto_gc_enum,
226 STA32X_AUTO1, STA32X_AUTO1_AMGC_SHIFT,
227 sta32x_auto_gc_mode);
228 static SOC_ENUM_SINGLE_DECL(sta32x_auto_xo_enum,
229 STA32X_AUTO2, STA32X_AUTO2_XO_SHIFT,
230 sta32x_auto_xo_mode);
231 static SOC_ENUM_SINGLE_DECL(sta32x_preset_eq_enum,
232 STA32X_AUTO3, STA32X_AUTO3_PEQ_SHIFT,
233 sta32x_preset_eq_mode);
234 static SOC_ENUM_SINGLE_DECL(sta32x_limiter_ch1_enum,
235 STA32X_C1CFG, STA32X_CxCFG_LS_SHIFT,
236 sta32x_limiter_select);
237 static SOC_ENUM_SINGLE_DECL(sta32x_limiter_ch2_enum,
238 STA32X_C2CFG, STA32X_CxCFG_LS_SHIFT,
239 sta32x_limiter_select);
240 static SOC_ENUM_SINGLE_DECL(sta32x_limiter_ch3_enum,
241 STA32X_C3CFG, STA32X_CxCFG_LS_SHIFT,
242 sta32x_limiter_select);
243 static SOC_ENUM_SINGLE_DECL(sta32x_limiter1_attack_rate_enum,
244 STA32X_L1AR, STA32X_LxA_SHIFT,
245 sta32x_limiter_attack_rate);
246 static SOC_ENUM_SINGLE_DECL(sta32x_limiter2_attack_rate_enum,
247 STA32X_L2AR, STA32X_LxA_SHIFT,
248 sta32x_limiter_attack_rate);
249 static SOC_ENUM_SINGLE_DECL(sta32x_limiter1_release_rate_enum,
250 STA32X_L1AR, STA32X_LxR_SHIFT,
251 sta32x_limiter_release_rate);
252 static SOC_ENUM_SINGLE_DECL(sta32x_limiter2_release_rate_enum,
253 STA32X_L2AR, STA32X_LxR_SHIFT,
254 sta32x_limiter_release_rate);
256 /* byte array controls for setting biquad, mixer, scaling coefficients;
257 * for biquads all five coefficients need to be set in one go,
258 * mixer and pre/postscale coefs can be set individually;
259 * each coef is 24bit, the bytes are ordered in the same way
260 * as given in the STA32x data sheet (big endian; b1, b2, a1, a2, b0)
263 static int sta32x_coefficient_info(struct snd_kcontrol *kcontrol,
264 struct snd_ctl_elem_info *uinfo)
266 int numcoef = kcontrol->private_value >> 16;
267 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
268 uinfo->count = 3 * numcoef;
272 static int sta32x_coefficient_get(struct snd_kcontrol *kcontrol,
273 struct snd_ctl_elem_value *ucontrol)
275 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
276 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
277 int numcoef = kcontrol->private_value >> 16;
278 int index = kcontrol->private_value & 0xffff;
279 unsigned int cfud, val;
282 mutex_lock(&sta32x->coeff_lock);
284 /* preserve reserved bits in STA32X_CFUD */
285 regmap_read(sta32x->regmap, STA32X_CFUD, &cfud);
288 * chip documentation does not say if the bits are self clearing,
289 * so do it explicitly
291 regmap_write(sta32x->regmap, STA32X_CFUD, cfud);
293 regmap_write(sta32x->regmap, STA32X_CFADDR2, index);
295 regmap_write(sta32x->regmap, STA32X_CFUD, cfud | 0x04);
296 } else if (numcoef == 5) {
297 regmap_write(sta32x->regmap, STA32X_CFUD, cfud | 0x08);
303 for (i = 0; i < 3 * numcoef; i++) {
304 regmap_read(sta32x->regmap, STA32X_B1CF1 + i, &val);
305 ucontrol->value.bytes.data[i] = val;
309 mutex_unlock(&sta32x->coeff_lock);
314 static int sta32x_coefficient_put(struct snd_kcontrol *kcontrol,
315 struct snd_ctl_elem_value *ucontrol)
317 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
318 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
319 int numcoef = kcontrol->private_value >> 16;
320 int index = kcontrol->private_value & 0xffff;
324 /* preserve reserved bits in STA32X_CFUD */
325 regmap_read(sta32x->regmap, STA32X_CFUD, &cfud);
328 * chip documentation does not say if the bits are self clearing,
329 * so do it explicitly
331 regmap_write(sta32x->regmap, STA32X_CFUD, cfud);
333 regmap_write(sta32x->regmap, STA32X_CFADDR2, index);
334 for (i = 0; i < numcoef && (index + i < STA32X_COEF_COUNT); i++)
335 sta32x->coef_shadow[index + i] =
336 (ucontrol->value.bytes.data[3 * i] << 16)
337 | (ucontrol->value.bytes.data[3 * i + 1] << 8)
338 | (ucontrol->value.bytes.data[3 * i + 2]);
339 for (i = 0; i < 3 * numcoef; i++)
340 regmap_write(sta32x->regmap, STA32X_B1CF1 + i,
341 ucontrol->value.bytes.data[i]);
343 regmap_write(sta32x->regmap, STA32X_CFUD, cfud | 0x01);
344 else if (numcoef == 5)
345 regmap_write(sta32x->regmap, STA32X_CFUD, cfud | 0x02);
352 static int sta32x_sync_coef_shadow(struct snd_soc_component *component)
354 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
358 /* preserve reserved bits in STA32X_CFUD */
359 regmap_read(sta32x->regmap, STA32X_CFUD, &cfud);
362 for (i = 0; i < STA32X_COEF_COUNT; i++) {
363 regmap_write(sta32x->regmap, STA32X_CFADDR2, i);
364 regmap_write(sta32x->regmap, STA32X_B1CF1,
365 (sta32x->coef_shadow[i] >> 16) & 0xff);
366 regmap_write(sta32x->regmap, STA32X_B1CF2,
367 (sta32x->coef_shadow[i] >> 8) & 0xff);
368 regmap_write(sta32x->regmap, STA32X_B1CF3,
369 (sta32x->coef_shadow[i]) & 0xff);
371 * chip documentation does not say if the bits are
372 * self-clearing, so do it explicitly
374 regmap_write(sta32x->regmap, STA32X_CFUD, cfud);
375 regmap_write(sta32x->regmap, STA32X_CFUD, cfud | 0x01);
380 static int sta32x_cache_sync(struct snd_soc_component *component)
382 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
386 /* mute during register sync */
387 regmap_read(sta32x->regmap, STA32X_MMUTE, &mute);
388 regmap_write(sta32x->regmap, STA32X_MMUTE, mute | STA32X_MMUTE_MMUTE);
389 sta32x_sync_coef_shadow(component);
390 rc = regcache_sync(sta32x->regmap);
391 regmap_write(sta32x->regmap, STA32X_MMUTE, mute);
395 /* work around ESD issue where sta32x resets and loses all configuration */
396 static void sta32x_watchdog(struct work_struct *work)
398 struct sta32x_priv *sta32x = container_of(work, struct sta32x_priv,
400 struct snd_soc_component *component = sta32x->component;
401 unsigned int confa, confa_cached;
403 /* check if sta32x has reset itself */
404 confa_cached = snd_soc_component_read32(component, STA32X_CONFA);
405 regcache_cache_bypass(sta32x->regmap, true);
406 confa = snd_soc_component_read32(component, STA32X_CONFA);
407 regcache_cache_bypass(sta32x->regmap, false);
408 if (confa != confa_cached) {
409 regcache_mark_dirty(sta32x->regmap);
410 sta32x_cache_sync(component);
413 if (!sta32x->shutdown)
414 queue_delayed_work(system_power_efficient_wq,
415 &sta32x->watchdog_work,
416 round_jiffies_relative(HZ));
419 static void sta32x_watchdog_start(struct sta32x_priv *sta32x)
421 if (sta32x->pdata->needs_esd_watchdog) {
422 sta32x->shutdown = 0;
423 queue_delayed_work(system_power_efficient_wq,
424 &sta32x->watchdog_work,
425 round_jiffies_relative(HZ));
429 static void sta32x_watchdog_stop(struct sta32x_priv *sta32x)
431 if (sta32x->pdata->needs_esd_watchdog) {
432 sta32x->shutdown = 1;
433 cancel_delayed_work_sync(&sta32x->watchdog_work);
437 #define SINGLE_COEF(xname, index) \
438 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
439 .info = sta32x_coefficient_info, \
440 .get = sta32x_coefficient_get,\
441 .put = sta32x_coefficient_put, \
442 .private_value = index | (1 << 16) }
444 #define BIQUAD_COEFS(xname, index) \
445 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
446 .info = sta32x_coefficient_info, \
447 .get = sta32x_coefficient_get,\
448 .put = sta32x_coefficient_put, \
449 .private_value = index | (5 << 16) }
451 static const struct snd_kcontrol_new sta32x_snd_controls[] = {
452 SOC_SINGLE_TLV("Master Volume", STA32X_MVOL, 0, 0xff, 1, mvol_tlv),
453 SOC_SINGLE("Master Switch", STA32X_MMUTE, 0, 1, 1),
454 SOC_SINGLE("Ch1 Switch", STA32X_MMUTE, 1, 1, 1),
455 SOC_SINGLE("Ch2 Switch", STA32X_MMUTE, 2, 1, 1),
456 SOC_SINGLE("Ch3 Switch", STA32X_MMUTE, 3, 1, 1),
457 SOC_SINGLE_TLV("Ch1 Volume", STA32X_C1VOL, 0, 0xff, 1, chvol_tlv),
458 SOC_SINGLE_TLV("Ch2 Volume", STA32X_C2VOL, 0, 0xff, 1, chvol_tlv),
459 SOC_SINGLE_TLV("Ch3 Volume", STA32X_C3VOL, 0, 0xff, 1, chvol_tlv),
460 SOC_SINGLE("De-emphasis Filter Switch", STA32X_CONFD, STA32X_CONFD_DEMP_SHIFT, 1, 0),
461 SOC_ENUM("Compressor/Limiter Switch", sta32x_drc_ac_enum),
462 SOC_SINGLE("Miami Mode Switch", STA32X_CONFD, STA32X_CONFD_MME_SHIFT, 1, 0),
463 SOC_SINGLE("Zero Cross Switch", STA32X_CONFE, STA32X_CONFE_ZCE_SHIFT, 1, 0),
464 SOC_SINGLE("Soft Ramp Switch", STA32X_CONFE, STA32X_CONFE_SVE_SHIFT, 1, 0),
465 SOC_SINGLE("Auto-Mute Switch", STA32X_CONFF, STA32X_CONFF_IDE_SHIFT, 1, 0),
466 SOC_ENUM("Automode EQ", sta32x_auto_eq_enum),
467 SOC_ENUM("Automode GC", sta32x_auto_gc_enum),
468 SOC_ENUM("Automode XO", sta32x_auto_xo_enum),
469 SOC_ENUM("Preset EQ", sta32x_preset_eq_enum),
470 SOC_SINGLE("Ch1 Tone Control Bypass Switch", STA32X_C1CFG, STA32X_CxCFG_TCB_SHIFT, 1, 0),
471 SOC_SINGLE("Ch2 Tone Control Bypass Switch", STA32X_C2CFG, STA32X_CxCFG_TCB_SHIFT, 1, 0),
472 SOC_SINGLE("Ch1 EQ Bypass Switch", STA32X_C1CFG, STA32X_CxCFG_EQBP_SHIFT, 1, 0),
473 SOC_SINGLE("Ch2 EQ Bypass Switch", STA32X_C2CFG, STA32X_CxCFG_EQBP_SHIFT, 1, 0),
474 SOC_SINGLE("Ch1 Master Volume Bypass Switch", STA32X_C1CFG, STA32X_CxCFG_VBP_SHIFT, 1, 0),
475 SOC_SINGLE("Ch2 Master Volume Bypass Switch", STA32X_C1CFG, STA32X_CxCFG_VBP_SHIFT, 1, 0),
476 SOC_SINGLE("Ch3 Master Volume Bypass Switch", STA32X_C1CFG, STA32X_CxCFG_VBP_SHIFT, 1, 0),
477 SOC_ENUM("Ch1 Limiter Select", sta32x_limiter_ch1_enum),
478 SOC_ENUM("Ch2 Limiter Select", sta32x_limiter_ch2_enum),
479 SOC_ENUM("Ch3 Limiter Select", sta32x_limiter_ch3_enum),
480 SOC_SINGLE_TLV("Bass Tone Control", STA32X_TONE, STA32X_TONE_BTC_SHIFT, 15, 0, tone_tlv),
481 SOC_SINGLE_TLV("Treble Tone Control", STA32X_TONE, STA32X_TONE_TTC_SHIFT, 15, 0, tone_tlv),
482 SOC_ENUM("Limiter1 Attack Rate (dB/ms)", sta32x_limiter1_attack_rate_enum),
483 SOC_ENUM("Limiter2 Attack Rate (dB/ms)", sta32x_limiter2_attack_rate_enum),
484 SOC_ENUM("Limiter1 Release Rate (dB/ms)", sta32x_limiter1_release_rate_enum),
485 SOC_ENUM("Limiter2 Release Rate (dB/ms)", sta32x_limiter2_release_rate_enum),
487 /* depending on mode, the attack/release thresholds have
488 * two different enum definitions; provide both
490 SOC_SINGLE_TLV("Limiter1 Attack Threshold (AC Mode)", STA32X_L1ATRT, STA32X_LxA_SHIFT,
491 16, 0, sta32x_limiter_ac_attack_tlv),
492 SOC_SINGLE_TLV("Limiter2 Attack Threshold (AC Mode)", STA32X_L2ATRT, STA32X_LxA_SHIFT,
493 16, 0, sta32x_limiter_ac_attack_tlv),
494 SOC_SINGLE_TLV("Limiter1 Release Threshold (AC Mode)", STA32X_L1ATRT, STA32X_LxR_SHIFT,
495 16, 0, sta32x_limiter_ac_release_tlv),
496 SOC_SINGLE_TLV("Limiter2 Release Threshold (AC Mode)", STA32X_L2ATRT, STA32X_LxR_SHIFT,
497 16, 0, sta32x_limiter_ac_release_tlv),
498 SOC_SINGLE_TLV("Limiter1 Attack Threshold (DRC Mode)", STA32X_L1ATRT, STA32X_LxA_SHIFT,
499 16, 0, sta32x_limiter_drc_attack_tlv),
500 SOC_SINGLE_TLV("Limiter2 Attack Threshold (DRC Mode)", STA32X_L2ATRT, STA32X_LxA_SHIFT,
501 16, 0, sta32x_limiter_drc_attack_tlv),
502 SOC_SINGLE_TLV("Limiter1 Release Threshold (DRC Mode)", STA32X_L1ATRT, STA32X_LxR_SHIFT,
503 16, 0, sta32x_limiter_drc_release_tlv),
504 SOC_SINGLE_TLV("Limiter2 Release Threshold (DRC Mode)", STA32X_L2ATRT, STA32X_LxR_SHIFT,
505 16, 0, sta32x_limiter_drc_release_tlv),
507 BIQUAD_COEFS("Ch1 - Biquad 1", 0),
508 BIQUAD_COEFS("Ch1 - Biquad 2", 5),
509 BIQUAD_COEFS("Ch1 - Biquad 3", 10),
510 BIQUAD_COEFS("Ch1 - Biquad 4", 15),
511 BIQUAD_COEFS("Ch2 - Biquad 1", 20),
512 BIQUAD_COEFS("Ch2 - Biquad 2", 25),
513 BIQUAD_COEFS("Ch2 - Biquad 3", 30),
514 BIQUAD_COEFS("Ch2 - Biquad 4", 35),
515 BIQUAD_COEFS("High-pass", 40),
516 BIQUAD_COEFS("Low-pass", 45),
517 SINGLE_COEF("Ch1 - Prescale", 50),
518 SINGLE_COEF("Ch2 - Prescale", 51),
519 SINGLE_COEF("Ch1 - Postscale", 52),
520 SINGLE_COEF("Ch2 - Postscale", 53),
521 SINGLE_COEF("Ch3 - Postscale", 54),
522 SINGLE_COEF("Thermal warning - Postscale", 55),
523 SINGLE_COEF("Ch1 - Mix 1", 56),
524 SINGLE_COEF("Ch1 - Mix 2", 57),
525 SINGLE_COEF("Ch2 - Mix 1", 58),
526 SINGLE_COEF("Ch2 - Mix 2", 59),
527 SINGLE_COEF("Ch3 - Mix 1", 60),
528 SINGLE_COEF("Ch3 - Mix 2", 61),
531 static const struct snd_soc_dapm_widget sta32x_dapm_widgets[] = {
532 SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
533 SND_SOC_DAPM_OUTPUT("LEFT"),
534 SND_SOC_DAPM_OUTPUT("RIGHT"),
535 SND_SOC_DAPM_OUTPUT("SUB"),
538 static const struct snd_soc_dapm_route sta32x_dapm_routes[] = {
539 { "LEFT", NULL, "DAC" },
540 { "RIGHT", NULL, "DAC" },
541 { "SUB", NULL, "DAC" },
544 /* MCLK interpolation ratio per fs */
548 } interpolation_ratios[] = {
558 /* MCLK to fs clock ratios */
559 static int mcs_ratio_table[3][7] = {
560 { 768, 512, 384, 256, 128, 576, 0 },
561 { 384, 256, 192, 128, 64, 0 },
562 { 384, 256, 192, 128, 64, 0 },
566 * sta32x_set_dai_sysclk - configure MCLK
567 * @codec_dai: the codec DAI
568 * @clk_id: the clock ID (ignored)
569 * @freq: the MCLK input frequency
570 * @dir: the clock direction (ignored)
572 * The value of MCLK is used to determine which sample rates are supported
573 * by the STA32X, based on the mclk_ratios table.
575 * This function must be called by the machine driver's 'startup' function,
576 * otherwise the list of supported sample rates will not be available in
579 * For setups with variable MCLKs, pass 0 as 'freq' argument. This will cause
580 * theoretically possible sample rates to be enabled. Call it again with a
581 * proper value set one the external clock is set (most probably you would do
582 * that from a machine's driver 'hw_param' hook.
584 static int sta32x_set_dai_sysclk(struct snd_soc_dai *codec_dai,
585 int clk_id, unsigned int freq, int dir)
587 struct snd_soc_component *component = codec_dai->component;
588 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
590 dev_dbg(component->dev, "mclk=%u\n", freq);
597 * sta32x_set_dai_fmt - configure the codec for the selected audio format
598 * @codec_dai: the codec DAI
599 * @fmt: a SND_SOC_DAIFMT_x value indicating the data format
601 * This function takes a bitmask of SND_SOC_DAIFMT_x bits and programs the
604 static int sta32x_set_dai_fmt(struct snd_soc_dai *codec_dai,
607 struct snd_soc_component *component = codec_dai->component;
608 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
611 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
612 case SND_SOC_DAIFMT_CBS_CFS:
618 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
619 case SND_SOC_DAIFMT_I2S:
620 case SND_SOC_DAIFMT_RIGHT_J:
621 case SND_SOC_DAIFMT_LEFT_J:
622 sta32x->format = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
628 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
629 case SND_SOC_DAIFMT_NB_NF:
630 confb |= STA32X_CONFB_C2IM;
632 case SND_SOC_DAIFMT_NB_IF:
633 confb |= STA32X_CONFB_C1IM;
639 return regmap_update_bits(sta32x->regmap, STA32X_CONFB,
640 STA32X_CONFB_C1IM | STA32X_CONFB_C2IM, confb);
644 * sta32x_hw_params - program the STA32X with the given hardware parameters.
645 * @substream: the audio stream
646 * @params: the hardware parameters to set
647 * @dai: the SOC DAI (ignored)
649 * This function programs the hardware with the values provided.
650 * Specifically, the sample rate and the data format.
652 static int sta32x_hw_params(struct snd_pcm_substream *substream,
653 struct snd_pcm_hw_params *params,
654 struct snd_soc_dai *dai)
656 struct snd_soc_component *component = dai->component;
657 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
658 int i, mcs = -EINVAL, ir = -EINVAL;
659 unsigned int confa, confb;
660 unsigned int rate, ratio;
664 dev_err(component->dev,
665 "sta32x->mclk is unset. Unable to determine ratio\n");
669 rate = params_rate(params);
670 ratio = sta32x->mclk / rate;
671 dev_dbg(component->dev, "rate: %u, ratio: %u\n", rate, ratio);
673 for (i = 0; i < ARRAY_SIZE(interpolation_ratios); i++) {
674 if (interpolation_ratios[i].fs == rate) {
675 ir = interpolation_ratios[i].ir;
681 dev_err(component->dev, "Unsupported samplerate: %u\n", rate);
685 for (i = 0; i < 6; i++) {
686 if (mcs_ratio_table[ir][i] == ratio) {
693 dev_err(component->dev, "Unresolvable ratio: %u\n", ratio);
697 confa = (ir << STA32X_CONFA_IR_SHIFT) |
698 (mcs << STA32X_CONFA_MCS_SHIFT);
701 switch (params_width(params)) {
703 dev_dbg(component->dev, "24bit\n");
706 dev_dbg(component->dev, "24bit or 32bit\n");
707 switch (sta32x->format) {
708 case SND_SOC_DAIFMT_I2S:
711 case SND_SOC_DAIFMT_LEFT_J:
714 case SND_SOC_DAIFMT_RIGHT_J:
721 dev_dbg(component->dev, "20bit\n");
722 switch (sta32x->format) {
723 case SND_SOC_DAIFMT_I2S:
726 case SND_SOC_DAIFMT_LEFT_J:
729 case SND_SOC_DAIFMT_RIGHT_J:
736 dev_dbg(component->dev, "18bit\n");
737 switch (sta32x->format) {
738 case SND_SOC_DAIFMT_I2S:
741 case SND_SOC_DAIFMT_LEFT_J:
744 case SND_SOC_DAIFMT_RIGHT_J:
751 dev_dbg(component->dev, "16bit\n");
752 switch (sta32x->format) {
753 case SND_SOC_DAIFMT_I2S:
756 case SND_SOC_DAIFMT_LEFT_J:
759 case SND_SOC_DAIFMT_RIGHT_J:
769 ret = regmap_update_bits(sta32x->regmap, STA32X_CONFA,
770 STA32X_CONFA_MCS_MASK | STA32X_CONFA_IR_MASK,
775 ret = regmap_update_bits(sta32x->regmap, STA32X_CONFB,
776 STA32X_CONFB_SAI_MASK | STA32X_CONFB_SAIFB,
784 static int sta32x_startup_sequence(struct sta32x_priv *sta32x)
786 if (sta32x->gpiod_nreset) {
787 gpiod_set_value(sta32x->gpiod_nreset, 0);
789 gpiod_set_value(sta32x->gpiod_nreset, 1);
797 * sta32x_set_bias_level - DAPM callback
798 * @component: the component device
799 * @level: DAPM power level
801 * This is called by ALSA to put the component into low power mode
802 * or to wake it up. If the component is powered off completely
803 * all registers must be restored after power on.
805 static int sta32x_set_bias_level(struct snd_soc_component *component,
806 enum snd_soc_bias_level level)
809 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
811 dev_dbg(component->dev, "level = %d\n", level);
813 case SND_SOC_BIAS_ON:
816 case SND_SOC_BIAS_PREPARE:
818 regmap_update_bits(sta32x->regmap, STA32X_CONFF,
819 STA32X_CONFF_PWDN | STA32X_CONFF_EAPD,
820 STA32X_CONFF_PWDN | STA32X_CONFF_EAPD);
823 case SND_SOC_BIAS_STANDBY:
824 if (snd_soc_component_get_bias_level(component) == SND_SOC_BIAS_OFF) {
825 ret = regulator_bulk_enable(ARRAY_SIZE(sta32x->supplies),
828 dev_err(component->dev,
829 "Failed to enable supplies: %d\n", ret);
833 sta32x_startup_sequence(sta32x);
834 sta32x_cache_sync(component);
835 sta32x_watchdog_start(sta32x);
839 regmap_update_bits(sta32x->regmap, STA32X_CONFF,
840 STA32X_CONFF_PWDN | STA32X_CONFF_EAPD,
845 case SND_SOC_BIAS_OFF:
846 /* The chip runs through the power down sequence for us. */
847 regmap_update_bits(sta32x->regmap, STA32X_CONFF,
848 STA32X_CONFF_PWDN | STA32X_CONFF_EAPD, 0);
850 sta32x_watchdog_stop(sta32x);
852 gpiod_set_value(sta32x->gpiod_nreset, 0);
854 regulator_bulk_disable(ARRAY_SIZE(sta32x->supplies),
861 static const struct snd_soc_dai_ops sta32x_dai_ops = {
862 .hw_params = sta32x_hw_params,
863 .set_sysclk = sta32x_set_dai_sysclk,
864 .set_fmt = sta32x_set_dai_fmt,
867 static struct snd_soc_dai_driver sta32x_dai = {
868 .name = "sta32x-hifi",
870 .stream_name = "Playback",
873 .rates = STA32X_RATES,
874 .formats = STA32X_FORMATS,
876 .ops = &sta32x_dai_ops,
879 static int sta32x_probe(struct snd_soc_component *component)
881 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
882 struct sta32x_platform_data *pdata = sta32x->pdata;
883 int i, ret = 0, thermal = 0;
885 sta32x->component = component;
887 if (sta32x->xti_clk) {
888 ret = clk_prepare_enable(sta32x->xti_clk);
890 dev_err(component->dev,
891 "Failed to enable clock: %d\n", ret);
896 ret = regulator_bulk_enable(ARRAY_SIZE(sta32x->supplies),
899 dev_err(component->dev, "Failed to enable supplies: %d\n", ret);
903 ret = sta32x_startup_sequence(sta32x);
905 dev_err(component->dev, "Failed to startup device\n");
910 if (!pdata->thermal_warning_recovery)
911 thermal |= STA32X_CONFA_TWAB;
912 if (!pdata->thermal_warning_adjustment)
913 thermal |= STA32X_CONFA_TWRB;
914 if (!pdata->fault_detect_recovery)
915 thermal |= STA32X_CONFA_FDRB;
916 regmap_update_bits(sta32x->regmap, STA32X_CONFA,
917 STA32X_CONFA_TWAB | STA32X_CONFA_TWRB |
922 regmap_update_bits(sta32x->regmap, STA32X_CONFC,
923 STA32X_CONFC_CSZ_MASK,
924 pdata->drop_compensation_ns
925 << STA32X_CONFC_CSZ_SHIFT);
928 regmap_update_bits(sta32x->regmap, STA32X_CONFE,
930 pdata->max_power_use_mpcc ?
931 STA32X_CONFE_MPCV : 0);
932 regmap_update_bits(sta32x->regmap, STA32X_CONFE,
934 pdata->max_power_correction ?
935 STA32X_CONFE_MPC : 0);
936 regmap_update_bits(sta32x->regmap, STA32X_CONFE,
938 pdata->am_reduction_mode ?
939 STA32X_CONFE_AME : 0);
940 regmap_update_bits(sta32x->regmap, STA32X_CONFE,
942 pdata->odd_pwm_speed_mode ?
943 STA32X_CONFE_PWMS : 0);
946 regmap_update_bits(sta32x->regmap, STA32X_CONFF,
948 pdata->invalid_input_detect_mute ?
949 STA32X_CONFF_IDE : 0);
951 /* select output configuration */
952 regmap_update_bits(sta32x->regmap, STA32X_CONFF,
953 STA32X_CONFF_OCFG_MASK,
955 << STA32X_CONFF_OCFG_SHIFT);
957 /* channel to output mapping */
958 regmap_update_bits(sta32x->regmap, STA32X_C1CFG,
959 STA32X_CxCFG_OM_MASK,
960 pdata->ch1_output_mapping
961 << STA32X_CxCFG_OM_SHIFT);
962 regmap_update_bits(sta32x->regmap, STA32X_C2CFG,
963 STA32X_CxCFG_OM_MASK,
964 pdata->ch2_output_mapping
965 << STA32X_CxCFG_OM_SHIFT);
966 regmap_update_bits(sta32x->regmap, STA32X_C3CFG,
967 STA32X_CxCFG_OM_MASK,
968 pdata->ch3_output_mapping
969 << STA32X_CxCFG_OM_SHIFT);
971 /* initialize coefficient shadow RAM with reset values */
972 for (i = 4; i <= 49; i += 5)
973 sta32x->coef_shadow[i] = 0x400000;
974 for (i = 50; i <= 54; i++)
975 sta32x->coef_shadow[i] = 0x7fffff;
976 sta32x->coef_shadow[55] = 0x5a9df7;
977 sta32x->coef_shadow[56] = 0x7fffff;
978 sta32x->coef_shadow[59] = 0x7fffff;
979 sta32x->coef_shadow[60] = 0x400000;
980 sta32x->coef_shadow[61] = 0x400000;
982 if (sta32x->pdata->needs_esd_watchdog)
983 INIT_DELAYED_WORK(&sta32x->watchdog_work, sta32x_watchdog);
985 snd_soc_component_force_bias_level(component, SND_SOC_BIAS_STANDBY);
986 /* Bias level configuration will have done an extra enable */
987 regulator_bulk_disable(ARRAY_SIZE(sta32x->supplies), sta32x->supplies);
992 static void sta32x_remove(struct snd_soc_component *component)
994 struct sta32x_priv *sta32x = snd_soc_component_get_drvdata(component);
996 sta32x_watchdog_stop(sta32x);
997 regulator_bulk_disable(ARRAY_SIZE(sta32x->supplies), sta32x->supplies);
1000 clk_disable_unprepare(sta32x->xti_clk);
1003 static const struct snd_soc_component_driver sta32x_component = {
1004 .probe = sta32x_probe,
1005 .remove = sta32x_remove,
1006 .set_bias_level = sta32x_set_bias_level,
1007 .controls = sta32x_snd_controls,
1008 .num_controls = ARRAY_SIZE(sta32x_snd_controls),
1009 .dapm_widgets = sta32x_dapm_widgets,
1010 .num_dapm_widgets = ARRAY_SIZE(sta32x_dapm_widgets),
1011 .dapm_routes = sta32x_dapm_routes,
1012 .num_dapm_routes = ARRAY_SIZE(sta32x_dapm_routes),
1013 .suspend_bias_off = 1,
1015 .use_pmdown_time = 1,
1017 .non_legacy_dai_naming = 1,
1020 static const struct regmap_config sta32x_regmap = {
1023 .max_register = STA32X_FDRC2,
1024 .reg_defaults = sta32x_regs,
1025 .num_reg_defaults = ARRAY_SIZE(sta32x_regs),
1026 .cache_type = REGCACHE_RBTREE,
1027 .wr_table = &sta32x_write_regs,
1028 .rd_table = &sta32x_read_regs,
1029 .volatile_table = &sta32x_volatile_regs,
1033 static const struct of_device_id st32x_dt_ids[] = {
1034 { .compatible = "st,sta32x", },
1037 MODULE_DEVICE_TABLE(of, st32x_dt_ids);
1039 static int sta32x_probe_dt(struct device *dev, struct sta32x_priv *sta32x)
1041 struct device_node *np = dev->of_node;
1042 struct sta32x_platform_data *pdata;
1045 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
1049 of_property_read_u8(np, "st,output-conf",
1050 &pdata->output_conf);
1051 of_property_read_u8(np, "st,ch1-output-mapping",
1052 &pdata->ch1_output_mapping);
1053 of_property_read_u8(np, "st,ch2-output-mapping",
1054 &pdata->ch2_output_mapping);
1055 of_property_read_u8(np, "st,ch3-output-mapping",
1056 &pdata->ch3_output_mapping);
1058 if (of_get_property(np, "st,fault-detect-recovery", NULL))
1059 pdata->fault_detect_recovery = 1;
1060 if (of_get_property(np, "st,thermal-warning-recovery", NULL))
1061 pdata->thermal_warning_recovery = 1;
1062 if (of_get_property(np, "st,thermal-warning-adjustment", NULL))
1063 pdata->thermal_warning_adjustment = 1;
1064 if (of_get_property(np, "st,needs_esd_watchdog", NULL))
1065 pdata->needs_esd_watchdog = 1;
1068 of_property_read_u16(np, "st,drop-compensation-ns", &tmp);
1069 pdata->drop_compensation_ns = clamp_t(u16, tmp, 0, 300) / 20;
1072 if (of_get_property(np, "st,max-power-use-mpcc", NULL))
1073 pdata->max_power_use_mpcc = 1;
1075 if (of_get_property(np, "st,max-power-correction", NULL))
1076 pdata->max_power_correction = 1;
1078 if (of_get_property(np, "st,am-reduction-mode", NULL))
1079 pdata->am_reduction_mode = 1;
1081 if (of_get_property(np, "st,odd-pwm-speed-mode", NULL))
1082 pdata->odd_pwm_speed_mode = 1;
1085 if (of_get_property(np, "st,invalid-input-detect-mute", NULL))
1086 pdata->invalid_input_detect_mute = 1;
1088 sta32x->pdata = pdata;
1094 static int sta32x_i2c_probe(struct i2c_client *i2c,
1095 const struct i2c_device_id *id)
1097 struct device *dev = &i2c->dev;
1098 struct sta32x_priv *sta32x;
1101 sta32x = devm_kzalloc(&i2c->dev, sizeof(struct sta32x_priv),
1106 mutex_init(&sta32x->coeff_lock);
1107 sta32x->pdata = dev_get_platdata(dev);
1111 ret = sta32x_probe_dt(dev, sta32x);
1118 sta32x->xti_clk = devm_clk_get(dev, "xti");
1119 if (IS_ERR(sta32x->xti_clk)) {
1120 ret = PTR_ERR(sta32x->xti_clk);
1122 if (ret == -EPROBE_DEFER)
1125 sta32x->xti_clk = NULL;
1129 sta32x->gpiod_nreset = devm_gpiod_get_optional(dev, "reset",
1131 if (IS_ERR(sta32x->gpiod_nreset))
1132 return PTR_ERR(sta32x->gpiod_nreset);
1135 for (i = 0; i < ARRAY_SIZE(sta32x->supplies); i++)
1136 sta32x->supplies[i].supply = sta32x_supply_names[i];
1138 ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(sta32x->supplies),
1141 dev_err(&i2c->dev, "Failed to request supplies: %d\n", ret);
1145 sta32x->regmap = devm_regmap_init_i2c(i2c, &sta32x_regmap);
1146 if (IS_ERR(sta32x->regmap)) {
1147 ret = PTR_ERR(sta32x->regmap);
1148 dev_err(dev, "Failed to init regmap: %d\n", ret);
1152 i2c_set_clientdata(i2c, sta32x);
1154 ret = devm_snd_soc_register_component(dev, &sta32x_component,
1157 dev_err(dev, "Failed to register component (%d)\n", ret);
1162 static const struct i2c_device_id sta32x_i2c_id[] = {
1168 MODULE_DEVICE_TABLE(i2c, sta32x_i2c_id);
1170 static struct i2c_driver sta32x_i2c_driver = {
1173 .of_match_table = of_match_ptr(st32x_dt_ids),
1175 .probe = sta32x_i2c_probe,
1176 .id_table = sta32x_i2c_id,
1179 module_i2c_driver(sta32x_i2c_driver);
1181 MODULE_DESCRIPTION("ASoC STA32X driver");
1182 MODULE_AUTHOR("Johannes Stezenbach <js@sig21.net>");
1183 MODULE_LICENSE("GPL");