sound/soc/codecs/tas2781-comlib.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 //
   3 // tas2781-lib.c -- TAS2781 Common functions for HDA and ASoC Audio drivers
   4 //
   5 // Copyright 2023 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_RBTREE,
  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 tas2781_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                                 TAS2781_REG_SWRESET,
 258                                 TAS2781_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(tas2781_reset);
 268
 269 int tascodec_init(struct tasdevice_priv *tas_priv, void *codec,
 270         void (*cont)(const struct firmware *fw, void *context))
 271 {
 272         int ret = 0;
 273
 274         /* Codec Lock Hold to ensure that codec_probe and firmware parsing and
 275          * loading do not simultaneously execute.
 276          */
 277         mutex_lock(&tas_priv->codec_lock);
 278
 279         scnprintf(tas_priv->rca_binaryname, 64, "/*(DEBLOBBED)*/",
 280                 tas_priv->dev_name, tas_priv->ndev);
 281         crc8_populate_msb(tas_priv->crc8_lkp_tbl, TASDEVICE_CRC8_POLYNOMIAL);
 282         tas_priv->codec = codec;
 283         ret = reject_firmware_nowait(THIS_MODULE, FW_ACTION_UEVENT,
 284                 tas_priv->rca_binaryname, tas_priv->dev, GFP_KERNEL, tas_priv,
 285                 cont);
 286         if (ret)
 287                 dev_err(tas_priv->dev, "request_firmware_nowait err:0x%08x\n",
 288                         ret);
 289
 290         /* Codec Lock Release*/
 291         mutex_unlock(&tas_priv->codec_lock);
 292         return ret;
 293 }
 294 EXPORT_SYMBOL_GPL(tascodec_init);
 295
 296 int tasdevice_init(struct tasdevice_priv *tas_priv)
 297 {
 298         int ret = 0;
 299         int i;
 300
 301         tas_priv->regmap = devm_regmap_init_i2c(tas_priv->client,
 302                 &tasdevice_regmap);
 303         if (IS_ERR(tas_priv->regmap)) {
 304                 ret = PTR_ERR(tas_priv->regmap);
 305                 dev_err(tas_priv->dev, "Failed to allocate register map: %d\n",
 306                         ret);
 307                 goto out;
 308         }
 309
 310         tas_priv->cur_prog = -1;
 311         tas_priv->cur_conf = -1;
 312
 313         for (i = 0; i < tas_priv->ndev; i++) {
 314                 tas_priv->tasdevice[i].cur_book = -1;
 315                 tas_priv->tasdevice[i].cur_prog = -1;
 316                 tas_priv->tasdevice[i].cur_conf = -1;
 317         }
 318
 319         dev_set_drvdata(tas_priv->dev, tas_priv);
 320
 321         mutex_init(&tas_priv->codec_lock);
 322
 323 out:
 324         return ret;
 325 }
 326 EXPORT_SYMBOL_GPL(tasdevice_init);
 327
 328 static void tasdev_dsp_prog_blk_remove(struct tasdevice_prog *prog)
 329 {
 330         struct tasdevice_data *tas_dt;
 331         struct tasdev_blk *blk;
 332         unsigned int i;
 333
 334         if (!prog)
 335                 return;
 336
 337         tas_dt = &(prog->dev_data);
 338
 339         if (!tas_dt->dev_blks)
 340                 return;
 341
 342         for (i = 0; i < tas_dt->nr_blk; i++) {
 343                 blk = &(tas_dt->dev_blks[i]);
 344                 kfree(blk->data);
 345         }
 346         kfree(tas_dt->dev_blks);
 347 }
 348
 349 static void tasdev_dsp_prog_remove(struct tasdevice_prog *prog,
 350         unsigned short nr)
 351 {
 352         int i;
 353
 354         for (i = 0; i < nr; i++)
 355                 tasdev_dsp_prog_blk_remove(&prog[i]);
 356         kfree(prog);
 357 }
 358
 359 static void tasdev_dsp_cfg_blk_remove(struct tasdevice_config *cfg)
 360 {
 361         struct tasdevice_data *tas_dt;
 362         struct tasdev_blk *blk;
 363         unsigned int i;
 364
 365         if (cfg) {
 366                 tas_dt = &(cfg->dev_data);
 367
 368                 if (!tas_dt->dev_blks)
 369                         return;
 370
 371                 for (i = 0; i < tas_dt->nr_blk; i++) {
 372                         blk = &(tas_dt->dev_blks[i]);
 373                         kfree(blk->data);
 374                 }
 375                 kfree(tas_dt->dev_blks);
 376         }
 377 }
 378
 379 static void tasdev_dsp_cfg_remove(struct tasdevice_config *config,
 380         unsigned short nr)
 381 {
 382         int i;
 383
 384         for (i = 0; i < nr; i++)
 385                 tasdev_dsp_cfg_blk_remove(&config[i]);
 386         kfree(config);
 387 }
 388
 389 void tasdevice_dsp_remove(void *context)
 390 {
 391         struct tasdevice_priv *tas_dev = (struct tasdevice_priv *) context;
 392         struct tasdevice_fw *tas_fmw = tas_dev->fmw;
 393
 394         if (!tas_dev->fmw)
 395                 return;
 396
 397         if (tas_fmw->programs)
 398                 tasdev_dsp_prog_remove(tas_fmw->programs,
 399                         tas_fmw->nr_programs);
 400         if (tas_fmw->configs)
 401                 tasdev_dsp_cfg_remove(tas_fmw->configs,
 402                         tas_fmw->nr_configurations);
 403         kfree(tas_fmw);
 404         tas_dev->fmw = NULL;
 405 }
 406 EXPORT_SYMBOL_GPL(tasdevice_dsp_remove);
 407
 408 void tasdevice_remove(struct tasdevice_priv *tas_priv)
 409 {
 410         if (gpio_is_valid(tas_priv->irq_info.irq_gpio))
 411                 gpio_free(tas_priv->irq_info.irq_gpio);
 412         kfree(tas_priv->acpi_subsystem_id);
 413         mutex_destroy(&tas_priv->codec_lock);
 414 }
 415 EXPORT_SYMBOL_GPL(tasdevice_remove);
 416
 417 static int tasdevice_clamp(int val, int max, unsigned int invert)
 418 {
 419         if (val > max)
 420                 val = max;
 421         if (invert)
 422                 val = max - val;
 423         if (val < 0)
 424                 val = 0;
 425         return val;
 426 }
 427
 428 int tasdevice_amp_putvol(struct tasdevice_priv *tas_priv,
 429         struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc)
 430 {
 431         unsigned int invert = mc->invert;
 432         unsigned char mask;
 433         int max = mc->max;
 434         int err_cnt = 0;
 435         int val, i, ret;
 436
 437         mask = (1 << fls(max)) - 1;
 438         mask <<= mc->shift;
 439         val = tasdevice_clamp(ucontrol->value.integer.value[0], max, invert);
 440         for (i = 0; i < tas_priv->ndev; i++) {
 441                 ret = tasdevice_dev_update_bits(tas_priv, i,
 442                         mc->reg, mask, (unsigned int)(val << mc->shift));
 443                 if (!ret)
 444                         continue;
 445                 err_cnt++;
 446                 dev_err(tas_priv->dev, "set AMP vol error in dev %d\n", i);
 447         }
 448
 449         /* All the devices set error, return 0 */
 450         return (err_cnt == tas_priv->ndev) ? 0 : 1;
 451 }
 452 EXPORT_SYMBOL_GPL(tasdevice_amp_putvol);
 453
 454 int tasdevice_amp_getvol(struct tasdevice_priv *tas_priv,
 455         struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc)
 456 {
 457         unsigned int invert = mc->invert;
 458         unsigned char mask = 0;
 459         int max = mc->max;
 460         int ret = 0;
 461         int val;
 462
 463         /* Read the primary device */
 464         ret = tasdevice_dev_read(tas_priv, 0, mc->reg, &val);
 465         if (ret) {
 466                 dev_err(tas_priv->dev, "%s, get AMP vol error\n", __func__);
 467                 goto out;
 468         }
 469
 470         mask = (1 << fls(max)) - 1;
 471         mask <<= mc->shift;
 472         val = (val & mask) >> mc->shift;
 473         val = tasdevice_clamp(val, max, invert);
 474         ucontrol->value.integer.value[0] = val;
 475
 476 out:
 477         return ret;
 478
 479 }
 480 EXPORT_SYMBOL_GPL(tasdevice_amp_getvol);
 481
 482 int tasdevice_digital_putvol(struct tasdevice_priv *tas_priv,
 483         struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc)
 484 {
 485         unsigned int invert = mc->invert;
 486         int max = mc->max;
 487         int err_cnt = 0;
 488         int ret;
 489         int val, i;
 490
 491         val = tasdevice_clamp(ucontrol->value.integer.value[0], max, invert);
 492
 493         for (i = 0; i < tas_priv->ndev; i++) {
 494                 ret = tasdevice_dev_write(tas_priv, i, mc->reg,
 495                         (unsigned int)val);
 496                 if (!ret)
 497                         continue;
 498                 err_cnt++;
 499                 dev_err(tas_priv->dev,
 500                         "set digital vol err in dev %d\n", i);
 501         }
 502
 503         /* All the devices set error, return 0 */
 504         return (err_cnt == tas_priv->ndev) ? 0 : 1;
 505
 506 }
 507 EXPORT_SYMBOL_GPL(tasdevice_digital_putvol);
 508
 509 int tasdevice_digital_getvol(struct tasdevice_priv *tas_priv,
 510         struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc)
 511 {
 512         unsigned int invert = mc->invert;
 513         int max = mc->max;
 514         int ret, val;
 515
 516         /* Read the primary device as the whole */
 517         ret = tasdevice_dev_read(tas_priv, 0, mc->reg, &val);
 518         if (ret) {
 519                 dev_err(tas_priv->dev, "%s, get digital vol error\n",
 520                         __func__);
 521                 goto out;
 522         }
 523
 524         val = tasdevice_clamp(val, max, invert);
 525         ucontrol->value.integer.value[0] = val;
 526
 527 out:
 528         return ret;
 529
 530 }
 531 EXPORT_SYMBOL_GPL(tasdevice_digital_getvol);
 532
 533 MODULE_DESCRIPTION("TAS2781 common library");
 534 MODULE_AUTHOR("Shenghao Ding, TI, <shenghao-ding@ti.com>");
 535 MODULE_LICENSE("GPL");