1 // SPDX-License-Identifier: GPL-2.0 2 // 3 // TAS2781 Common functions for HDA and ASoC Audio drivers 4 // 5 // Copyright 2023 - 2024 Texas Instruments, Inc. 6 // 7 // Author: Shenghao Ding <shenghao-ding@ti.com> 8 9 #include <linux/crc8.h> 10 #include <linux/firmware.h> 11 #include <linux/gpio/consumer.h> 12 #include <linux/i2c.h> 13 #include <linux/init.h> 14 #include <linux/interrupt.h> 15 #include <linux/module.h> 16 #include <linux/of.h> 17 #include <linux/of_gpio.h> 18 #include <linux/of_irq.h> 19 #include <linux/regmap.h> 20 #include <linux/slab.h> 21 #include <sound/pcm_params.h> 22 #include <sound/soc.h> 23 #include <sound/tas2781.h> 24 25 #define TASDEVICE_CRC8_POLYNOMIAL 0x4d 26 27 static const struct regmap_range_cfg tasdevice_ranges[] = { 28 { 29 .range_min = 0, 30 .range_max = 256 * 128, 31 .selector_reg = TASDEVICE_PAGE_SELECT, 32 .selector_mask = 0xff, 33 .selector_shift = 0, 34 .window_start = 0, 35 .window_len = 128, 36 }, 37 }; 38 39 static const struct regmap_config tasdevice_regmap = { 40 .reg_bits = 8, 41 .val_bits = 8, 42 .cache_type = REGCACHE_NONE, 43 .ranges = tasdevice_ranges, 44 .num_ranges = ARRAY_SIZE(tasdevice_ranges), 45 .max_register = 256 * 128, 46 }; 47 48 static int tasdevice_change_chn_book(struct tasdevice_priv *tas_priv, 49 unsigned short chn, int book) 50 { 51 struct i2c_client *client = (struct i2c_client *)tas_priv->client; 52 int ret = 0; 53 54 if (chn < tas_priv->ndev) { 55 struct tasdevice *tasdev = &tas_priv->tasdevice[chn]; 56 struct regmap *map = tas_priv->regmap; 57 58 if (client->addr != tasdev->dev_addr) { 59 client->addr = tasdev->dev_addr; 60 /* All tas2781s share the same regmap, clear the page 61 * inside regmap once switching to another tas2781. 62 * Register 0 at any pages and any books inside tas2781 63 * is the same one for page-switching. 64 */ 65 ret = regmap_write(map, TASDEVICE_PAGE_SELECT, 0); 66 if (ret < 0) { 67 dev_err(tas_priv->dev, "%s, E=%d\n", 68 __func__, ret); 69 goto out; 70 } 71 } 72 73 if (tasdev->cur_book != book) { 74 ret = regmap_write(map, TASDEVICE_BOOKCTL_REG, book); 75 if (ret < 0) { 76 dev_err(tas_priv->dev, "%s, E=%d\n", 77 __func__, ret); 78 goto out; 79 } 80 tasdev->cur_book = book; 81 } 82 } else { 83 ret = -EINVAL; 84 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 85 chn); 86 } 87 88 out: 89 return ret; 90 } 91 92 int tasdevice_dev_read(struct tasdevice_priv *tas_priv, 93 unsigned short chn, unsigned int reg, unsigned int *val) 94 { 95 int ret = 0; 96 97 if (chn < tas_priv->ndev) { 98 struct regmap *map = tas_priv->regmap; 99 100 ret = tasdevice_change_chn_book(tas_priv, chn, 101 TASDEVICE_BOOK_ID(reg)); 102 if (ret < 0) 103 goto out; 104 105 ret = regmap_read(map, TASDEVICE_PGRG(reg), val); 106 if (ret < 0) 107 dev_err(tas_priv->dev, "%s, E=%d\n", __func__, ret); 108 } else { 109 ret = -EINVAL; 110 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 111 chn); 112 } 113 114 out: 115 return ret; 116 } 117 EXPORT_SYMBOL_GPL(tasdevice_dev_read); 118 119 int tasdevice_dev_write(struct tasdevice_priv *tas_priv, 120 unsigned short chn, unsigned int reg, unsigned int value) 121 { 122 int ret = 0; 123 124 if (chn < tas_priv->ndev) { 125 struct regmap *map = tas_priv->regmap; 126 127 ret = tasdevice_change_chn_book(tas_priv, chn, 128 TASDEVICE_BOOK_ID(reg)); 129 if (ret < 0) 130 goto out; 131 132 ret = regmap_write(map, TASDEVICE_PGRG(reg), 133 value); 134 if (ret < 0) 135 dev_err(tas_priv->dev, "%s, E=%d\n", __func__, ret); 136 } else { 137 ret = -EINVAL; 138 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 139 chn); 140 } 141 142 out: 143 return ret; 144 } 145 EXPORT_SYMBOL_GPL(tasdevice_dev_write); 146 147 int tasdevice_dev_bulk_write( 148 struct tasdevice_priv *tas_priv, unsigned short chn, 149 unsigned int reg, unsigned char *data, 150 unsigned int len) 151 { 152 int ret = 0; 153 154 if (chn < tas_priv->ndev) { 155 struct regmap *map = tas_priv->regmap; 156 157 ret = tasdevice_change_chn_book(tas_priv, chn, 158 TASDEVICE_BOOK_ID(reg)); 159 if (ret < 0) 160 goto out; 161 162 ret = regmap_bulk_write(map, TASDEVICE_PGRG(reg), 163 data, len); 164 if (ret < 0) 165 dev_err(tas_priv->dev, "%s, E=%d\n", __func__, ret); 166 } else { 167 ret = -EINVAL; 168 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 169 chn); 170 } 171 172 out: 173 return ret; 174 } 175 EXPORT_SYMBOL_GPL(tasdevice_dev_bulk_write); 176 177 int tasdevice_dev_bulk_read(struct tasdevice_priv *tas_priv, 178 unsigned short chn, unsigned int reg, unsigned char *data, 179 unsigned int len) 180 { 181 int ret = 0; 182 183 if (chn < tas_priv->ndev) { 184 struct regmap *map = tas_priv->regmap; 185 186 ret = tasdevice_change_chn_book(tas_priv, chn, 187 TASDEVICE_BOOK_ID(reg)); 188 if (ret < 0) 189 goto out; 190 191 ret = regmap_bulk_read(map, TASDEVICE_PGRG(reg), data, len); 192 if (ret < 0) 193 dev_err(tas_priv->dev, "%s, E=%d\n", __func__, ret); 194 } else 195 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 196 chn); 197 198 out: 199 return ret; 200 } 201 EXPORT_SYMBOL_GPL(tasdevice_dev_bulk_read); 202 203 int tasdevice_dev_update_bits( 204 struct tasdevice_priv *tas_priv, unsigned short chn, 205 unsigned int reg, unsigned int mask, unsigned int value) 206 { 207 int ret = 0; 208 209 if (chn < tas_priv->ndev) { 210 struct regmap *map = tas_priv->regmap; 211 212 ret = tasdevice_change_chn_book(tas_priv, chn, 213 TASDEVICE_BOOK_ID(reg)); 214 if (ret < 0) 215 goto out; 216 217 ret = regmap_update_bits(map, TASDEVICE_PGRG(reg), 218 mask, value); 219 if (ret < 0) 220 dev_err(tas_priv->dev, "%s, E=%d\n", __func__, ret); 221 } else { 222 dev_err(tas_priv->dev, "%s, no such channel(%d)\n", __func__, 223 chn); 224 ret = -EINVAL; 225 } 226 227 out: 228 return ret; 229 } 230 EXPORT_SYMBOL_GPL(tasdevice_dev_update_bits); 231 232 struct tasdevice_priv *tasdevice_kzalloc(struct i2c_client *i2c) 233 { 234 struct tasdevice_priv *tas_priv; 235 236 tas_priv = devm_kzalloc(&i2c->dev, sizeof(*tas_priv), GFP_KERNEL); 237 if (!tas_priv) 238 return NULL; 239 tas_priv->dev = &i2c->dev; 240 tas_priv->client = (void *)i2c; 241 242 return tas_priv; 243 } 244 EXPORT_SYMBOL_GPL(tasdevice_kzalloc); 245 246 void tasdevice_reset(struct tasdevice_priv *tas_dev) 247 { 248 int ret, i; 249 250 if (tas_dev->reset) { 251 gpiod_set_value_cansleep(tas_dev->reset, 0); 252 usleep_range(500, 1000); 253 gpiod_set_value_cansleep(tas_dev->reset, 1); 254 } else { 255 for (i = 0; i < tas_dev->ndev; i++) { 256 ret = tasdevice_dev_write(tas_dev, i, 257 TASDEVICE_REG_SWRESET, 258 TASDEVICE_REG_SWRESET_RESET); 259 if (ret < 0) 260 dev_err(tas_dev->dev, 261 "dev %d swreset fail, %d\n", 262 i, ret); 263 } 264 } 265 usleep_range(1000, 1050); 266 } 267 EXPORT_SYMBOL_GPL(tasdevice_reset); 268 269 int tascodec_init(struct tasdevice_priv *tas_priv, void *codec, 270 struct module *module, 271 void (*cont)(const struct firmware *fw, void *context)) 272 { 273 int ret = 0; 274 275 /* Codec Lock Hold to ensure that codec_probe and firmware parsing and 276 * loading do not simultaneously execute. 277 */ 278 mutex_lock(&tas_priv->codec_lock); 279 280 if (tas_priv->name_prefix) 281 scnprintf(tas_priv->rca_binaryname, 64, "%s-%sRCA%d.bin", 282 tas_priv->name_prefix, tas_priv->dev_name, 283 tas_priv->ndev); 284 else 285 scnprintf(tas_priv->rca_binaryname, 64, "%sRCA%d.bin", 286 tas_priv->dev_name, tas_priv->ndev); 287 crc8_populate_msb(tas_priv->crc8_lkp_tbl, TASDEVICE_CRC8_POLYNOMIAL); 288 tas_priv->codec = codec; 289 ret = request_firmware_nowait(module, FW_ACTION_UEVENT, 290 tas_priv->rca_binaryname, tas_priv->dev, GFP_KERNEL, tas_priv, 291 cont); 292 if (ret) 293 dev_err(tas_priv->dev, "request_firmware_nowait err:0x%08x\n", 294 ret); 295 296 /* Codec Lock Release*/ 297 mutex_unlock(&tas_priv->codec_lock); 298 return ret; 299 } 300 EXPORT_SYMBOL_GPL(tascodec_init); 301 302 int tasdevice_init(struct tasdevice_priv *tas_priv) 303 { 304 int ret = 0; 305 int i; 306 307 tas_priv->regmap = devm_regmap_init_i2c(tas_priv->client, 308 &tasdevice_regmap); 309 if (IS_ERR(tas_priv->regmap)) { 310 ret = PTR_ERR(tas_priv->regmap); 311 dev_err(tas_priv->dev, "Failed to allocate register map: %d\n", 312 ret); 313 goto out; 314 } 315 316 tas_priv->cur_prog = -1; 317 tas_priv->cur_conf = -1; 318 319 for (i = 0; i < tas_priv->ndev; i++) { 320 tas_priv->tasdevice[i].cur_book = -1; 321 tas_priv->tasdevice[i].cur_prog = -1; 322 tas_priv->tasdevice[i].cur_conf = -1; 323 } 324 325 mutex_init(&tas_priv->codec_lock); 326 327 out: 328 return ret; 329 } 330 EXPORT_SYMBOL_GPL(tasdevice_init); 331 332 static void tasdev_dsp_prog_blk_remove(struct tasdevice_prog *prog) 333 { 334 struct tasdevice_data *tas_dt; 335 struct tasdev_blk *blk; 336 unsigned int i; 337 338 if (!prog) 339 return; 340 341 tas_dt = &(prog->dev_data); 342 343 if (!tas_dt->dev_blks) 344 return; 345 346 for (i = 0; i < tas_dt->nr_blk; i++) { 347 blk = &(tas_dt->dev_blks[i]); 348 kfree(blk->data); 349 } 350 kfree(tas_dt->dev_blks); 351 } 352 353 static void tasdev_dsp_prog_remove(struct tasdevice_prog *prog, 354 unsigned short nr) 355 { 356 int i; 357 358 for (i = 0; i < nr; i++) 359 tasdev_dsp_prog_blk_remove(&prog[i]); 360 kfree(prog); 361 } 362 363 static void tasdev_dsp_cfg_blk_remove(struct tasdevice_config *cfg) 364 { 365 struct tasdevice_data *tas_dt; 366 struct tasdev_blk *blk; 367 unsigned int i; 368 369 if (cfg) { 370 tas_dt = &(cfg->dev_data); 371 372 if (!tas_dt->dev_blks) 373 return; 374 375 for (i = 0; i < tas_dt->nr_blk; i++) { 376 blk = &(tas_dt->dev_blks[i]); 377 kfree(blk->data); 378 } 379 kfree(tas_dt->dev_blks); 380 } 381 } 382 383 static void tasdev_dsp_cfg_remove(struct tasdevice_config *config, 384 unsigned short nr) 385 { 386 int i; 387 388 for (i = 0; i < nr; i++) 389 tasdev_dsp_cfg_blk_remove(&config[i]); 390 kfree(config); 391 } 392 393 void tasdevice_dsp_remove(void *context) 394 { 395 struct tasdevice_priv *tas_dev = (struct tasdevice_priv *) context; 396 struct tasdevice_fw *tas_fmw = tas_dev->fmw; 397 398 if (!tas_dev->fmw) 399 return; 400 401 if (tas_fmw->programs) 402 tasdev_dsp_prog_remove(tas_fmw->programs, 403 tas_fmw->nr_programs); 404 if (tas_fmw->configs) 405 tasdev_dsp_cfg_remove(tas_fmw->configs, 406 tas_fmw->nr_configurations); 407 kfree(tas_fmw); 408 tas_dev->fmw = NULL; 409 } 410 EXPORT_SYMBOL_GPL(tasdevice_dsp_remove); 411 412 void tasdevice_remove(struct tasdevice_priv *tas_priv) 413 { 414 if (gpio_is_valid(tas_priv->irq_info.irq_gpio)) 415 gpio_free(tas_priv->irq_info.irq_gpio); 416 mutex_destroy(&tas_priv->codec_lock); 417 } 418 EXPORT_SYMBOL_GPL(tasdevice_remove); 419 420 int tasdevice_save_calibration(struct tasdevice_priv *tas_priv) 421 { 422 if (tas_priv->save_calibration) 423 return tas_priv->save_calibration(tas_priv); 424 return -EINVAL; 425 } 426 EXPORT_SYMBOL_GPL(tasdevice_save_calibration); 427 428 void tasdevice_apply_calibration(struct tasdevice_priv *tas_priv) 429 { 430 if (tas_priv->apply_calibration && tas_priv->cali_data.total_sz) 431 tas_priv->apply_calibration(tas_priv); 432 } 433 EXPORT_SYMBOL_GPL(tasdevice_apply_calibration); 434 435 static int tasdevice_clamp(int val, int max, unsigned int invert) 436 { 437 if (val > max) 438 val = max; 439 if (invert) 440 val = max - val; 441 if (val < 0) 442 val = 0; 443 return val; 444 } 445 446 int tasdevice_amp_putvol(struct tasdevice_priv *tas_priv, 447 struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc) 448 { 449 unsigned int invert = mc->invert; 450 unsigned char mask; 451 int max = mc->max; 452 int err_cnt = 0; 453 int val, i, ret; 454 455 mask = (1 << fls(max)) - 1; 456 mask <<= mc->shift; 457 val = tasdevice_clamp(ucontrol->value.integer.value[0], max, invert); 458 for (i = 0; i < tas_priv->ndev; i++) { 459 ret = tasdevice_dev_update_bits(tas_priv, i, 460 mc->reg, mask, (unsigned int)(val << mc->shift)); 461 if (!ret) 462 continue; 463 err_cnt++; 464 dev_err(tas_priv->dev, "set AMP vol error in dev %d\n", i); 465 } 466 467 /* All the devices set error, return 0 */ 468 return (err_cnt == tas_priv->ndev) ? 0 : 1; 469 } 470 EXPORT_SYMBOL_GPL(tasdevice_amp_putvol); 471 472 int tasdevice_amp_getvol(struct tasdevice_priv *tas_priv, 473 struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc) 474 { 475 unsigned int invert = mc->invert; 476 unsigned char mask = 0; 477 int max = mc->max; 478 int ret = 0; 479 int val; 480 481 /* Read the primary device */ 482 ret = tasdevice_dev_read(tas_priv, 0, mc->reg, &val); 483 if (ret) { 484 dev_err(tas_priv->dev, "%s, get AMP vol error\n", __func__); 485 goto out; 486 } 487 488 mask = (1 << fls(max)) - 1; 489 mask <<= mc->shift; 490 val = (val & mask) >> mc->shift; 491 val = tasdevice_clamp(val, max, invert); 492 ucontrol->value.integer.value[0] = val; 493 494 out: 495 return ret; 496 497 } 498 EXPORT_SYMBOL_GPL(tasdevice_amp_getvol); 499 500 int tasdevice_digital_putvol(struct tasdevice_priv *tas_priv, 501 struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc) 502 { 503 unsigned int invert = mc->invert; 504 int max = mc->max; 505 int err_cnt = 0; 506 int ret; 507 int val, i; 508 509 val = tasdevice_clamp(ucontrol->value.integer.value[0], max, invert); 510 511 for (i = 0; i < tas_priv->ndev; i++) { 512 ret = tasdevice_dev_write(tas_priv, i, mc->reg, 513 (unsigned int)val); 514 if (!ret) 515 continue; 516 err_cnt++; 517 dev_err(tas_priv->dev, 518 "set digital vol err in dev %d\n", i); 519 } 520 521 /* All the devices set error, return 0 */ 522 return (err_cnt == tas_priv->ndev) ? 0 : 1; 523 524 } 525 EXPORT_SYMBOL_GPL(tasdevice_digital_putvol); 526 527 int tasdevice_digital_getvol(struct tasdevice_priv *tas_priv, 528 struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc) 529 { 530 unsigned int invert = mc->invert; 531 int max = mc->max; 532 int ret, val; 533 534 /* Read the primary device as the whole */ 535 ret = tasdevice_dev_read(tas_priv, 0, mc->reg, &val); 536 if (ret) { 537 dev_err(tas_priv->dev, "%s, get digital vol error\n", 538 __func__); 539 goto out; 540 } 541 542 val = tasdevice_clamp(val, max, invert); 543 ucontrol->value.integer.value[0] = val; 544 545 out: 546 return ret; 547 548 } 549 EXPORT_SYMBOL_GPL(tasdevice_digital_getvol); 550 551 MODULE_DESCRIPTION("TAS2781 common library"); 552 MODULE_AUTHOR("Shenghao Ding, TI, <shenghao-ding@ti.com>"); 553 MODULE_LICENSE("GPL"); 554