1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 2021 Stephan Gerhold 4 * 5 * Register definitions/sequences taken from various tfa98xx kernel drivers: 6 * Copyright (C) 2014-2020 NXP Semiconductors, All Rights Reserved. 7 * Copyright (C) 2013 Sony Mobile Communications Inc. 8 */ 9 10 #include <linux/gpio/consumer.h> 11 #include <linux/i2c.h> 12 #include <linux/module.h> 13 #include <linux/regmap.h> 14 #include <linux/regulator/consumer.h> 15 #include <sound/soc.h> 16 17 #define TFA989X_STATUSREG 0x00 18 #define TFA989X_BATTERYVOLTAGE 0x01 19 #define TFA989X_TEMPERATURE 0x02 20 #define TFA989X_REVISIONNUMBER 0x03 21 #define TFA989X_REVISIONNUMBER_REV_MSK GENMASK(7, 0) /* device revision */ 22 #define TFA989X_I2SREG 0x04 23 #define TFA989X_I2SREG_RCV 2 /* receiver mode */ 24 #define TFA989X_I2SREG_CHSA 6 /* amplifier input select */ 25 #define TFA989X_I2SREG_CHSA_MSK GENMASK(7, 6) 26 #define TFA989X_I2SREG_I2SSR 12 /* sample rate */ 27 #define TFA989X_I2SREG_I2SSR_MSK GENMASK(15, 12) 28 #define TFA989X_BAT_PROT 0x05 29 #define TFA989X_AUDIO_CTR 0x06 30 #define TFA989X_DCDCBOOST 0x07 31 #define TFA989X_SPKR_CALIBRATION 0x08 32 #define TFA989X_SYS_CTRL 0x09 33 #define TFA989X_SYS_CTRL_PWDN 0 /* power down */ 34 #define TFA989X_SYS_CTRL_I2CR 1 /* I2C reset */ 35 #define TFA989X_SYS_CTRL_CFE 2 /* enable CoolFlux DSP */ 36 #define TFA989X_SYS_CTRL_AMPE 3 /* enable amplifier */ 37 #define TFA989X_SYS_CTRL_DCA 4 /* enable boost */ 38 #define TFA989X_SYS_CTRL_SBSL 5 /* DSP configured */ 39 #define TFA989X_SYS_CTRL_AMPC 6 /* amplifier enabled by DSP */ 40 #define TFA989X_I2S_SEL_REG 0x0a 41 #define TFA989X_I2S_SEL_REG_SPKR_MSK GENMASK(10, 9) /* speaker impedance */ 42 #define TFA989X_I2S_SEL_REG_DCFG_MSK GENMASK(14, 11) /* DCDC compensation */ 43 #define TFA989X_HIDE_UNHIDE_KEY 0x40 44 #define TFA989X_PWM_CONTROL 0x41 45 #define TFA989X_CURRENTSENSE1 0x46 46 #define TFA989X_CURRENTSENSE2 0x47 47 #define TFA989X_CURRENTSENSE3 0x48 48 #define TFA989X_CURRENTSENSE4 0x49 49 50 #define TFA9890_REVISION 0x80 51 #define TFA9895_REVISION 0x12 52 #define TFA9897_REVISION 0x97 53 54 struct tfa989x_rev { 55 unsigned int rev; 56 int (*init)(struct regmap *regmap); 57 }; 58 59 struct tfa989x { 60 const struct tfa989x_rev *rev; 61 struct regulator *vddd_supply; 62 struct gpio_desc *rcv_gpiod; 63 }; 64 65 static bool tfa989x_writeable_reg(struct device *dev, unsigned int reg) 66 { 67 return reg > TFA989X_REVISIONNUMBER; 68 } 69 70 static bool tfa989x_volatile_reg(struct device *dev, unsigned int reg) 71 { 72 return reg < TFA989X_REVISIONNUMBER; 73 } 74 75 static const struct regmap_config tfa989x_regmap = { 76 .reg_bits = 8, 77 .val_bits = 16, 78 79 .writeable_reg = tfa989x_writeable_reg, 80 .volatile_reg = tfa989x_volatile_reg, 81 .cache_type = REGCACHE_RBTREE, 82 }; 83 84 static const char * const chsa_text[] = { "Left", "Right", /* "DSP" */ }; 85 static SOC_ENUM_SINGLE_DECL(chsa_enum, TFA989X_I2SREG, TFA989X_I2SREG_CHSA, chsa_text); 86 static const struct snd_kcontrol_new chsa_mux = SOC_DAPM_ENUM("Amp Input", chsa_enum); 87 88 static const struct snd_soc_dapm_widget tfa989x_dapm_widgets[] = { 89 SND_SOC_DAPM_OUTPUT("OUT"), 90 SND_SOC_DAPM_SUPPLY("POWER", TFA989X_SYS_CTRL, TFA989X_SYS_CTRL_PWDN, 1, NULL, 0), 91 SND_SOC_DAPM_OUT_DRV("AMPE", TFA989X_SYS_CTRL, TFA989X_SYS_CTRL_AMPE, 0, NULL, 0), 92 93 SND_SOC_DAPM_MUX("Amp Input", SND_SOC_NOPM, 0, 0, &chsa_mux), 94 SND_SOC_DAPM_AIF_IN("AIFINL", "HiFi Playback", 0, SND_SOC_NOPM, 0, 0), 95 SND_SOC_DAPM_AIF_IN("AIFINR", "HiFi Playback", 1, SND_SOC_NOPM, 0, 0), 96 }; 97 98 static const struct snd_soc_dapm_route tfa989x_dapm_routes[] = { 99 {"OUT", NULL, "AMPE"}, 100 {"AMPE", NULL, "POWER"}, 101 {"AMPE", NULL, "Amp Input"}, 102 {"Amp Input", "Left", "AIFINL"}, 103 {"Amp Input", "Right", "AIFINR"}, 104 }; 105 106 static int tfa989x_put_mode(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) 107 { 108 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol); 109 struct tfa989x *tfa989x = snd_soc_component_get_drvdata(component); 110 111 gpiod_set_value_cansleep(tfa989x->rcv_gpiod, ucontrol->value.enumerated.item[0]); 112 113 return snd_soc_put_enum_double(kcontrol, ucontrol); 114 } 115 116 static const char * const mode_text[] = { "Speaker", "Receiver" }; 117 static SOC_ENUM_SINGLE_DECL(mode_enum, TFA989X_I2SREG, TFA989X_I2SREG_RCV, mode_text); 118 static const struct snd_kcontrol_new tfa989x_mode_controls[] = { 119 SOC_ENUM_EXT("Mode", mode_enum, snd_soc_get_enum_double, tfa989x_put_mode), 120 }; 121 122 static int tfa989x_probe(struct snd_soc_component *component) 123 { 124 struct tfa989x *tfa989x = snd_soc_component_get_drvdata(component); 125 126 if (tfa989x->rev->rev == TFA9897_REVISION) 127 return snd_soc_add_component_controls(component, tfa989x_mode_controls, 128 ARRAY_SIZE(tfa989x_mode_controls)); 129 130 return 0; 131 } 132 133 static const struct snd_soc_component_driver tfa989x_component = { 134 .probe = tfa989x_probe, 135 .dapm_widgets = tfa989x_dapm_widgets, 136 .num_dapm_widgets = ARRAY_SIZE(tfa989x_dapm_widgets), 137 .dapm_routes = tfa989x_dapm_routes, 138 .num_dapm_routes = ARRAY_SIZE(tfa989x_dapm_routes), 139 .use_pmdown_time = 1, 140 .endianness = 1, 141 .non_legacy_dai_naming = 1, 142 }; 143 144 static const unsigned int tfa989x_rates[] = { 145 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 146 }; 147 148 static int tfa989x_find_sample_rate(unsigned int rate) 149 { 150 int i; 151 152 for (i = 0; i < ARRAY_SIZE(tfa989x_rates); ++i) 153 if (tfa989x_rates[i] == rate) 154 return i; 155 156 return -EINVAL; 157 } 158 159 static int tfa989x_hw_params(struct snd_pcm_substream *substream, 160 struct snd_pcm_hw_params *params, 161 struct snd_soc_dai *dai) 162 { 163 struct snd_soc_component *component = dai->component; 164 int sr; 165 166 sr = tfa989x_find_sample_rate(params_rate(params)); 167 if (sr < 0) 168 return sr; 169 170 return snd_soc_component_update_bits(component, TFA989X_I2SREG, 171 TFA989X_I2SREG_I2SSR_MSK, 172 sr << TFA989X_I2SREG_I2SSR); 173 } 174 175 static const struct snd_soc_dai_ops tfa989x_dai_ops = { 176 .hw_params = tfa989x_hw_params, 177 }; 178 179 static struct snd_soc_dai_driver tfa989x_dai = { 180 .name = "tfa989x-hifi", 181 .playback = { 182 .stream_name = "HiFi Playback", 183 .formats = SNDRV_PCM_FMTBIT_S16_LE, 184 .rates = SNDRV_PCM_RATE_8000_48000, 185 .rate_min = 8000, 186 .rate_max = 48000, 187 .channels_min = 1, 188 .channels_max = 2, 189 }, 190 .ops = &tfa989x_dai_ops, 191 }; 192 193 static int tfa9890_init(struct regmap *regmap) 194 { 195 int ret; 196 197 /* unhide keys to allow updating them */ 198 ret = regmap_write(regmap, TFA989X_HIDE_UNHIDE_KEY, 0x5a6b); 199 if (ret) 200 return ret; 201 202 /* update PLL registers */ 203 ret = regmap_set_bits(regmap, 0x59, 0x3); 204 if (ret) 205 return ret; 206 207 /* hide keys again */ 208 ret = regmap_write(regmap, TFA989X_HIDE_UNHIDE_KEY, 0x0000); 209 if (ret) 210 return ret; 211 212 return regmap_write(regmap, TFA989X_CURRENTSENSE2, 0x7BE1); 213 } 214 215 static const struct tfa989x_rev tfa9890_rev = { 216 .rev = TFA9890_REVISION, 217 .init = tfa9890_init, 218 }; 219 220 static const struct reg_sequence tfa9895_reg_init[] = { 221 /* some other registers must be set for optimal amplifier behaviour */ 222 { TFA989X_BAT_PROT, 0x13ab }, 223 { TFA989X_AUDIO_CTR, 0x001f }, 224 225 /* peak voltage protection is always on, but may be written */ 226 { TFA989X_SPKR_CALIBRATION, 0x3c4e }, 227 228 /* TFA989X_SYSCTRL_DCA = 0 */ 229 { TFA989X_SYS_CTRL, 0x024d }, 230 { TFA989X_PWM_CONTROL, 0x0308 }, 231 { TFA989X_CURRENTSENSE4, 0x0e82 }, 232 }; 233 234 static int tfa9895_init(struct regmap *regmap) 235 { 236 return regmap_multi_reg_write(regmap, tfa9895_reg_init, 237 ARRAY_SIZE(tfa9895_reg_init)); 238 } 239 240 static const struct tfa989x_rev tfa9895_rev = { 241 .rev = TFA9895_REVISION, 242 .init = tfa9895_init, 243 }; 244 245 static int tfa9897_init(struct regmap *regmap) 246 { 247 int ret; 248 249 /* Reduce slewrate by clearing iddqtestbst to avoid booster damage */ 250 ret = regmap_write(regmap, TFA989X_CURRENTSENSE3, 0x0300); 251 if (ret) 252 return ret; 253 254 /* Enable clipping */ 255 ret = regmap_clear_bits(regmap, TFA989X_CURRENTSENSE4, 0x1); 256 if (ret) 257 return ret; 258 259 /* Set required TDM configuration */ 260 return regmap_write(regmap, 0x14, 0x0); 261 } 262 263 static const struct tfa989x_rev tfa9897_rev = { 264 .rev = TFA9897_REVISION, 265 .init = tfa9897_init, 266 }; 267 268 /* 269 * Note: At the moment this driver bypasses the "CoolFlux DSP" built into the 270 * TFA989X amplifiers. Unfortunately, there seems to be absolutely 271 * no documentation for it - the public "short datasheets" do not provide 272 * any information about the DSP or available registers. 273 * 274 * Usually the TFA989X amplifiers are configured through proprietary userspace 275 * libraries. There are also some (rather complex) kernel drivers but even those 276 * rely on obscure firmware blobs for configuration (so-called "containers"). 277 * They seem to contain different "profiles" with tuned speaker settings, sample 278 * rates and volume steps (which would be better exposed as separate ALSA mixers). 279 * 280 * Bypassing the DSP disables volume control (and perhaps some speaker 281 * optimization?), but at least allows using the speaker without obscure 282 * kernel drivers and firmware. 283 * 284 * Ideally NXP (or now Goodix) should release proper documentation for these 285 * amplifiers so that support for the "CoolFlux DSP" can be implemented properly. 286 */ 287 static int tfa989x_dsp_bypass(struct regmap *regmap) 288 { 289 int ret; 290 291 /* Clear CHSA to bypass DSP and take input from I2S 1 left channel */ 292 ret = regmap_clear_bits(regmap, TFA989X_I2SREG, TFA989X_I2SREG_CHSA_MSK); 293 if (ret) 294 return ret; 295 296 /* Set DCDC compensation to off and speaker impedance to 8 ohm */ 297 ret = regmap_update_bits(regmap, TFA989X_I2S_SEL_REG, 298 TFA989X_I2S_SEL_REG_DCFG_MSK | 299 TFA989X_I2S_SEL_REG_SPKR_MSK, 300 TFA989X_I2S_SEL_REG_SPKR_MSK); 301 if (ret) 302 return ret; 303 304 /* Set DCDC to follower mode and disable CoolFlux DSP */ 305 return regmap_clear_bits(regmap, TFA989X_SYS_CTRL, 306 BIT(TFA989X_SYS_CTRL_DCA) | 307 BIT(TFA989X_SYS_CTRL_CFE) | 308 BIT(TFA989X_SYS_CTRL_AMPC)); 309 } 310 311 static void tfa989x_regulator_disable(void *data) 312 { 313 struct tfa989x *tfa989x = data; 314 315 regulator_disable(tfa989x->vddd_supply); 316 } 317 318 static int tfa989x_i2c_probe(struct i2c_client *i2c) 319 { 320 struct device *dev = &i2c->dev; 321 const struct tfa989x_rev *rev; 322 struct tfa989x *tfa989x; 323 struct regmap *regmap; 324 unsigned int val; 325 int ret; 326 327 rev = device_get_match_data(dev); 328 if (!rev) { 329 dev_err(dev, "unknown device revision\n"); 330 return -ENODEV; 331 } 332 333 tfa989x = devm_kzalloc(dev, sizeof(*tfa989x), GFP_KERNEL); 334 if (!tfa989x) 335 return -ENOMEM; 336 337 tfa989x->rev = rev; 338 i2c_set_clientdata(i2c, tfa989x); 339 340 tfa989x->vddd_supply = devm_regulator_get(dev, "vddd"); 341 if (IS_ERR(tfa989x->vddd_supply)) 342 return dev_err_probe(dev, PTR_ERR(tfa989x->vddd_supply), 343 "Failed to get vddd regulator\n"); 344 345 if (tfa989x->rev->rev == TFA9897_REVISION) { 346 tfa989x->rcv_gpiod = devm_gpiod_get_optional(dev, "rcv", GPIOD_OUT_LOW); 347 if (IS_ERR(tfa989x->rcv_gpiod)) 348 return PTR_ERR(tfa989x->rcv_gpiod); 349 } 350 351 regmap = devm_regmap_init_i2c(i2c, &tfa989x_regmap); 352 if (IS_ERR(regmap)) 353 return PTR_ERR(regmap); 354 355 ret = regulator_enable(tfa989x->vddd_supply); 356 if (ret) { 357 dev_err(dev, "Failed to enable vddd regulator: %d\n", ret); 358 return ret; 359 } 360 361 ret = devm_add_action_or_reset(dev, tfa989x_regulator_disable, tfa989x); 362 if (ret) 363 return ret; 364 365 /* Bypass regcache for reset and init sequence */ 366 regcache_cache_bypass(regmap, true); 367 368 /* Dummy read to generate i2c clocks, required on some devices */ 369 regmap_read(regmap, TFA989X_REVISIONNUMBER, &val); 370 371 ret = regmap_read(regmap, TFA989X_REVISIONNUMBER, &val); 372 if (ret) { 373 dev_err(dev, "failed to read revision number: %d\n", ret); 374 return ret; 375 } 376 377 val &= TFA989X_REVISIONNUMBER_REV_MSK; 378 if (val != rev->rev) { 379 dev_err(dev, "invalid revision number, expected %#x, got %#x\n", 380 rev->rev, val); 381 return -ENODEV; 382 } 383 384 ret = regmap_write(regmap, TFA989X_SYS_CTRL, BIT(TFA989X_SYS_CTRL_I2CR)); 385 if (ret) { 386 dev_err(dev, "failed to reset I2C registers: %d\n", ret); 387 return ret; 388 } 389 390 ret = rev->init(regmap); 391 if (ret) { 392 dev_err(dev, "failed to initialize registers: %d\n", ret); 393 return ret; 394 } 395 396 ret = tfa989x_dsp_bypass(regmap); 397 if (ret) { 398 dev_err(dev, "failed to enable DSP bypass: %d\n", ret); 399 return ret; 400 } 401 regcache_cache_bypass(regmap, false); 402 403 return devm_snd_soc_register_component(dev, &tfa989x_component, 404 &tfa989x_dai, 1); 405 } 406 407 static const struct of_device_id tfa989x_of_match[] = { 408 { .compatible = "nxp,tfa9890", .data = &tfa9890_rev }, 409 { .compatible = "nxp,tfa9895", .data = &tfa9895_rev }, 410 { .compatible = "nxp,tfa9897", .data = &tfa9897_rev }, 411 { } 412 }; 413 MODULE_DEVICE_TABLE(of, tfa989x_of_match); 414 415 static struct i2c_driver tfa989x_i2c_driver = { 416 .driver = { 417 .name = "tfa989x", 418 .of_match_table = tfa989x_of_match, 419 }, 420 .probe_new = tfa989x_i2c_probe, 421 }; 422 module_i2c_driver(tfa989x_i2c_driver); 423 424 MODULE_DESCRIPTION("ASoC NXP/Goodix TFA989X (TFA1) driver"); 425 MODULE_AUTHOR("Stephan Gerhold <stephan@gerhold.net>"); 426 MODULE_LICENSE("GPL"); 427