sound/soc/codecs/tpa6130a2.c

   1 /*
   2  * ALSA SoC Texas Instruments TPA6130A2 headset stereo amplifier driver
   3  *
   4  * Copyright (C) Nokia Corporation
   5  *
   6  * Author: Peter Ujfalusi <peter.ujfalusi@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/errno.h>
  25 #include <linux/device.h>
  26 #include <linux/i2c.h>
  27 #include <linux/gpio.h>
  28 #include <linux/regulator/consumer.h>
  29 #include <linux/slab.h>
  30 #include <sound/tpa6130a2-plat.h>
  31 #include <sound/soc.h>
  32 #include <sound/tlv.h>
  33
  34 #include "tpa6130a2.h"
  35
  36 static struct i2c_client *tpa6130a2_client;
  37
  38 /* This struct is used to save the context */
  39 struct tpa6130a2_data {
  40         struct mutex mutex;
  41         unsigned char regs[TPA6130A2_CACHEREGNUM];
  42         struct regulator *supply;
  43         int power_gpio;
  44         unsigned char power_state;
  45         enum tpa_model id;
  46 };
  47
  48 static int tpa6130a2_i2c_read(int reg)
  49 {
  50         struct tpa6130a2_data *data;
  51         int val;
  52
  53         BUG_ON(tpa6130a2_client == NULL);
  54         data = i2c_get_clientdata(tpa6130a2_client);
  55
  56         /* If powered off, return the cached value */
  57         if (data->power_state) {
  58                 val = i2c_smbus_read_byte_data(tpa6130a2_client, reg);
  59                 if (val < 0)
  60                         dev_err(&tpa6130a2_client->dev, "Read failed\n");
  61                 else
  62                         data->regs[reg] = val;
  63         } else {
  64                 val = data->regs[reg];
  65         }
  66
  67         return val;
  68 }
  69
  70 static int tpa6130a2_i2c_write(int reg, u8 value)
  71 {
  72         struct tpa6130a2_data *data;
  73         int val = 0;
  74
  75         BUG_ON(tpa6130a2_client == NULL);
  76         data = i2c_get_clientdata(tpa6130a2_client);
  77
  78         if (data->power_state) {
  79                 val = i2c_smbus_write_byte_data(tpa6130a2_client, reg, value);
  80                 if (val < 0) {
  81                         dev_err(&tpa6130a2_client->dev, "Write failed\n");
  82                         return val;
  83                 }
  84         }
  85
  86         /* Either powered on or off, we save the context */
  87         data->regs[reg] = value;
  88
  89         return val;
  90 }
  91
  92 static u8 tpa6130a2_read(int reg)
  93 {
  94         struct tpa6130a2_data *data;
  95
  96         BUG_ON(tpa6130a2_client == NULL);
  97         data = i2c_get_clientdata(tpa6130a2_client);
  98
  99         return data->regs[reg];
 100 }
 101
 102 static int tpa6130a2_initialize(void)
 103 {
 104         struct tpa6130a2_data *data;
 105         int i, ret = 0;
 106
 107         BUG_ON(tpa6130a2_client == NULL);
 108         data = i2c_get_clientdata(tpa6130a2_client);
 109
 110         for (i = 1; i < TPA6130A2_REG_VERSION; i++) {
 111                 ret = tpa6130a2_i2c_write(i, data->regs[i]);
 112                 if (ret < 0)
 113                         break;
 114         }
 115
 116         return ret;
 117 }
 118
 119 static int tpa6130a2_power(int power)
 120 {
 121         struct  tpa6130a2_data *data;
 122         u8      val;
 123         int     ret = 0;
 124
 125         BUG_ON(tpa6130a2_client == NULL);
 126         data = i2c_get_clientdata(tpa6130a2_client);
 127
 128         mutex_lock(&data->mutex);
 129         if (power && !data->power_state) {
 130
 131                 ret = regulator_enable(data->supply);
 132                 if (ret != 0) {
 133                         dev_err(&tpa6130a2_client->dev,
 134                                 "Failed to enable supply: %d\n", ret);
 135                         goto exit;
 136                 }
 137                 /* Power on */
 138                 if (data->power_gpio >= 0)
 139                         gpio_set_value(data->power_gpio, 1);
 140
 141                 data->power_state = 1;
 142                 ret = tpa6130a2_initialize();
 143                 if (ret < 0) {
 144                         dev_err(&tpa6130a2_client->dev,
 145                                 "Failed to initialize chip\n");
 146                         if (data->power_gpio >= 0)
 147                                 gpio_set_value(data->power_gpio, 0);
 148                         regulator_disable(data->supply);
 149                         data->power_state = 0;
 150                         goto exit;
 151                 }
 152
 153                 /* Clear SWS */
 154                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 155                 val &= ~TPA6130A2_SWS;
 156                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 157         } else if (!power && data->power_state) {
 158                 /* set SWS */
 159                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 160                 val |= TPA6130A2_SWS;
 161                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 162
 163                 /* Power off */
 164                 if (data->power_gpio >= 0)
 165                         gpio_set_value(data->power_gpio, 0);
 166
 167                 ret = regulator_disable(data->supply);
 168                 if (ret != 0) {
 169                         dev_err(&tpa6130a2_client->dev,
 170                                 "Failed to disable supply: %d\n", ret);
 171                         goto exit;
 172                 }
 173
 174                 data->power_state = 0;
 175         }
 176
 177 exit:
 178         mutex_unlock(&data->mutex);
 179         return ret;
 180 }
 181
 182 static int tpa6130a2_get_volsw(struct snd_kcontrol *kcontrol,
 183                 struct snd_ctl_elem_value *ucontrol)
 184 {
 185         struct soc_mixer_control *mc =
 186                 (struct soc_mixer_control *)kcontrol->private_value;
 187         struct tpa6130a2_data *data;
 188         unsigned int reg = mc->reg;
 189         unsigned int shift = mc->shift;
 190         int max = mc->max;
 191         unsigned int mask = (1 << fls(max)) - 1;
 192         unsigned int invert = mc->invert;
 193
 194         BUG_ON(tpa6130a2_client == NULL);
 195         data = i2c_get_clientdata(tpa6130a2_client);
 196
 197         mutex_lock(&data->mutex);
 198
 199         ucontrol->value.integer.value[0] =
 200                 (tpa6130a2_read(reg) >> shift) & mask;
 201
 202         if (invert)
 203                 ucontrol->value.integer.value[0] =
 204                         max - ucontrol->value.integer.value[0];
 205
 206         mutex_unlock(&data->mutex);
 207         return 0;
 208 }
 209
 210 static int tpa6130a2_put_volsw(struct snd_kcontrol *kcontrol,
 211                 struct snd_ctl_elem_value *ucontrol)
 212 {
 213         struct soc_mixer_control *mc =
 214                 (struct soc_mixer_control *)kcontrol->private_value;
 215         struct tpa6130a2_data *data;
 216         unsigned int reg = mc->reg;
 217         unsigned int shift = mc->shift;
 218         int max = mc->max;
 219         unsigned int mask = (1 << fls(max)) - 1;
 220         unsigned int invert = mc->invert;
 221         unsigned int val = (ucontrol->value.integer.value[0] & mask);
 222         unsigned int val_reg;
 223
 224         BUG_ON(tpa6130a2_client == NULL);
 225         data = i2c_get_clientdata(tpa6130a2_client);
 226
 227         if (invert)
 228                 val = max - val;
 229
 230         mutex_lock(&data->mutex);
 231
 232         val_reg = tpa6130a2_read(reg);
 233         if (((val_reg >> shift) & mask) == val) {
 234                 mutex_unlock(&data->mutex);
 235                 return 0;
 236         }
 237
 238         val_reg &= ~(mask << shift);
 239         val_reg |= val << shift;
 240         tpa6130a2_i2c_write(reg, val_reg);
 241
 242         mutex_unlock(&data->mutex);
 243
 244         return 1;
 245 }
 246
 247 /*
 248  * TPA6130 volume. From -59.5 to 4 dB with increasing step size when going
 249  * down in gain.
 250  */
 251 static const unsigned int tpa6130_tlv[] = {
 252         TLV_DB_RANGE_HEAD(10),
 253         0, 1, TLV_DB_SCALE_ITEM(-5950, 600, 0),
 254         2, 3, TLV_DB_SCALE_ITEM(-5000, 250, 0),
 255         4, 5, TLV_DB_SCALE_ITEM(-4550, 160, 0),
 256         6, 7, TLV_DB_SCALE_ITEM(-4140, 190, 0),
 257         8, 9, TLV_DB_SCALE_ITEM(-3650, 120, 0),
 258         10, 11, TLV_DB_SCALE_ITEM(-3330, 160, 0),
 259         12, 13, TLV_DB_SCALE_ITEM(-3040, 180, 0),
 260         14, 20, TLV_DB_SCALE_ITEM(-2710, 110, 0),
 261         21, 37, TLV_DB_SCALE_ITEM(-1960, 74, 0),
 262         38, 63, TLV_DB_SCALE_ITEM(-720, 45, 0),
 263 };
 264
 265 static const struct snd_kcontrol_new tpa6130a2_controls[] = {
 266         SOC_SINGLE_EXT_TLV("TPA6130A2 Headphone Playback Volume",
 267                        TPA6130A2_REG_VOL_MUTE, 0, 0x3f, 0,
 268                        tpa6130a2_get_volsw, tpa6130a2_put_volsw,
 269                        tpa6130_tlv),
 270 };
 271
 272 static const unsigned int tpa6140_tlv[] = {
 273         TLV_DB_RANGE_HEAD(3),
 274         0, 8, TLV_DB_SCALE_ITEM(-5900, 400, 0),
 275         9, 16, TLV_DB_SCALE_ITEM(-2500, 200, 0),
 276         17, 31, TLV_DB_SCALE_ITEM(-1000, 100, 0),
 277 };
 278
 279 static const struct snd_kcontrol_new tpa6140a2_controls[] = {
 280         SOC_SINGLE_EXT_TLV("TPA6140A2 Headphone Playback Volume",
 281                        TPA6130A2_REG_VOL_MUTE, 1, 0x1f, 0,
 282                        tpa6130a2_get_volsw, tpa6130a2_put_volsw,
 283                        tpa6140_tlv),
 284 };
 285
 286 /*
 287  * Enable or disable channel (left or right)
 288  * The bit number for mute and amplifier are the same per channel:
 289  * bit 6: Right channel
 290  * bit 7: Left channel
 291  * in both registers.
 292  */
 293 static void tpa6130a2_channel_enable(u8 channel, int enable)
 294 {
 295         u8      val;
 296
 297         if (enable) {
 298                 /* Enable channel */
 299                 /* Enable amplifier */
 300                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 301                 val |= channel;
 302                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 303
 304                 /* Unmute channel */
 305                 val = tpa6130a2_read(TPA6130A2_REG_VOL_MUTE);
 306                 val &= ~channel;
 307                 tpa6130a2_i2c_write(TPA6130A2_REG_VOL_MUTE, val);
 308         } else {
 309                 /* Disable channel */
 310                 /* Mute channel */
 311                 val = tpa6130a2_read(TPA6130A2_REG_VOL_MUTE);
 312                 val |= channel;
 313                 tpa6130a2_i2c_write(TPA6130A2_REG_VOL_MUTE, val);
 314
 315                 /* Disable amplifier */
 316                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 317                 val &= ~channel;
 318                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 319         }
 320 }
 321
 322 static int tpa6130a2_left_event(struct snd_soc_dapm_widget *w,
 323                 struct snd_kcontrol *kcontrol, int event)
 324 {
 325         switch (event) {
 326         case SND_SOC_DAPM_POST_PMU:
 327                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_L, 1);
 328                 break;
 329         case SND_SOC_DAPM_POST_PMD:
 330                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_L, 0);
 331                 break;
 332         }
 333         return 0;
 334 }
 335
 336 static int tpa6130a2_right_event(struct snd_soc_dapm_widget *w,
 337                 struct snd_kcontrol *kcontrol, int event)
 338 {
 339         switch (event) {
 340         case SND_SOC_DAPM_POST_PMU:
 341                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_R, 1);
 342                 break;
 343         case SND_SOC_DAPM_POST_PMD:
 344                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_R, 0);
 345                 break;
 346         }
 347         return 0;
 348 }
 349
 350 static int tpa6130a2_supply_event(struct snd_soc_dapm_widget *w,
 351                 struct snd_kcontrol *kcontrol, int event)
 352 {
 353         int ret = 0;
 354
 355         switch (event) {
 356         case SND_SOC_DAPM_POST_PMU:
 357                 ret = tpa6130a2_power(1);
 358                 break;
 359         case SND_SOC_DAPM_POST_PMD:
 360                 ret = tpa6130a2_power(0);
 361                 break;
 362         }
 363         return ret;
 364 }
 365
 366 static const struct snd_soc_dapm_widget tpa6130a2_dapm_widgets[] = {
 367         SND_SOC_DAPM_PGA_E("TPA6130A2 Left", SND_SOC_NOPM,
 368                         0, 0, NULL, 0, tpa6130a2_left_event,
 369                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 370         SND_SOC_DAPM_PGA_E("TPA6130A2 Right", SND_SOC_NOPM,
 371                         0, 0, NULL, 0, tpa6130a2_right_event,
 372                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 373         SND_SOC_DAPM_SUPPLY("TPA6130A2 Enable", SND_SOC_NOPM,
 374                         0, 0, tpa6130a2_supply_event,
 375                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 376         /* Outputs */
 377         SND_SOC_DAPM_OUTPUT("TPA6130A2 Headphone Left"),
 378         SND_SOC_DAPM_OUTPUT("TPA6130A2 Headphone Right"),
 379 };
 380
 381 static const struct snd_soc_dapm_route audio_map[] = {
 382         {"TPA6130A2 Headphone Left", NULL, "TPA6130A2 Left"},
 383         {"TPA6130A2 Headphone Right", NULL, "TPA6130A2 Right"},
 384
 385         {"TPA6130A2 Headphone Left", NULL, "TPA6130A2 Enable"},
 386         {"TPA6130A2 Headphone Right", NULL, "TPA6130A2 Enable"},
 387 };
 388
 389 int tpa6130a2_add_controls(struct snd_soc_codec *codec)
 390 {
 391         struct  tpa6130a2_data *data;
 392         struct snd_soc_dapm_context *dapm = &codec->dapm;
 393
 394         if (tpa6130a2_client == NULL)
 395                 return -ENODEV;
 396
 397         data = i2c_get_clientdata(tpa6130a2_client);
 398
 399         snd_soc_dapm_new_controls(dapm, tpa6130a2_dapm_widgets,
 400                                 ARRAY_SIZE(tpa6130a2_dapm_widgets));
 401
 402         snd_soc_dapm_add_routes(dapm, audio_map, ARRAY_SIZE(audio_map));
 403
 404         if (data->id == TPA6140A2)
 405                 return snd_soc_add_controls(codec, tpa6140a2_controls,
 406                                                 ARRAY_SIZE(tpa6140a2_controls));
 407         else
 408                 return snd_soc_add_controls(codec, tpa6130a2_controls,
 409                                                 ARRAY_SIZE(tpa6130a2_controls));
 410
 411 }
 412 EXPORT_SYMBOL_GPL(tpa6130a2_add_controls);
 413
 414 static int __devinit tpa6130a2_probe(struct i2c_client *client,
 415                                      const struct i2c_device_id *id)
 416 {
 417         struct device *dev;
 418         struct tpa6130a2_data *data;
 419         struct tpa6130a2_platform_data *pdata;
 420         const char *regulator;
 421         int ret;
 422
 423         dev = &client->dev;
 424
 425         if (client->dev.platform_data == NULL) {
 426                 dev_err(dev, "Platform data not set\n");
 427                 dump_stack();
 428                 return -ENODEV;
 429         }
 430
 431         data = kzalloc(sizeof(*data), GFP_KERNEL);
 432         if (data == NULL) {
 433                 dev_err(dev, "Can not allocate memory\n");
 434                 return -ENOMEM;
 435         }
 436
 437         tpa6130a2_client = client;
 438
 439         i2c_set_clientdata(tpa6130a2_client, data);
 440
 441         pdata = client->dev.platform_data;
 442         data->power_gpio = pdata->power_gpio;
 443         data->id = pdata->id;
 444
 445         mutex_init(&data->mutex);
 446
 447         /* Set default register values */
 448         data->regs[TPA6130A2_REG_CONTROL] =     TPA6130A2_SWS;
 449         data->regs[TPA6130A2_REG_VOL_MUTE] =    TPA6130A2_MUTE_R |
 450                                                 TPA6130A2_MUTE_L;
 451
 452         if (data->power_gpio >= 0) {
 453                 ret = gpio_request(data->power_gpio, "tpa6130a2 enable");
 454                 if (ret < 0) {
 455                         dev_err(dev, "Failed to request power GPIO (%d)\n",
 456                                 data->power_gpio);
 457                         goto err_gpio;
 458                 }
 459                 gpio_direction_output(data->power_gpio, 0);
 460         }
 461
 462         switch (data->id) {
 463         default:
 464                 dev_warn(dev, "Unknown TPA model (%d). Assuming 6130A2\n",
 465                          pdata->id);
 466         case TPA6130A2:
 467                 regulator = "Vdd";
 468                 break;
 469         case TPA6140A2:
 470                 regulator = "AVdd";
 471                 break;
 472         }
 473
 474         data->supply = regulator_get(dev, regulator);
 475         if (IS_ERR(data->supply)) {
 476                 ret = PTR_ERR(data->supply);
 477                 dev_err(dev, "Failed to request supply: %d\n", ret);
 478                 goto err_regulator;
 479         }
 480
 481         ret = tpa6130a2_power(1);
 482         if (ret != 0)
 483                 goto err_power;
 484
 485
 486         /* Read version */
 487         ret = tpa6130a2_i2c_read(TPA6130A2_REG_VERSION) &
 488                                  TPA6130A2_VERSION_MASK;
 489         if ((ret != 1) && (ret != 2))
 490                 dev_warn(dev, "UNTESTED version detected (%d)\n", ret);
 491
 492         /* Disable the chip */
 493         ret = tpa6130a2_power(0);
 494         if (ret != 0)
 495                 goto err_power;
 496
 497         return 0;
 498
 499 err_power:
 500         regulator_put(data->supply);
 501 err_regulator:
 502         if (data->power_gpio >= 0)
 503                 gpio_free(data->power_gpio);
 504 err_gpio:
 505         kfree(data);
 506         i2c_set_clientdata(tpa6130a2_client, NULL);
 507         tpa6130a2_client = NULL;
 508
 509         return ret;
 510 }
 511
 512 static int __devexit tpa6130a2_remove(struct i2c_client *client)
 513 {
 514         struct tpa6130a2_data *data = i2c_get_clientdata(client);
 515
 516         tpa6130a2_power(0);
 517
 518         if (data->power_gpio >= 0)
 519                 gpio_free(data->power_gpio);
 520
 521         regulator_put(data->supply);
 522
 523         kfree(data);
 524         tpa6130a2_client = NULL;
 525
 526         return 0;
 527 }
 528
 529 static const struct i2c_device_id tpa6130a2_id[] = {
 530         { "tpa6130a2", 0 },
 531         { }
 532 };
 533 MODULE_DEVICE_TABLE(i2c, tpa6130a2_id);
 534
 535 static struct i2c_driver tpa6130a2_i2c_driver = {
 536         .driver = {
 537                 .name = "tpa6130a2",
 538                 .owner = THIS_MODULE,
 539         },
 540         .probe = tpa6130a2_probe,
 541         .remove = __devexit_p(tpa6130a2_remove),
 542         .id_table = tpa6130a2_id,
 543 };
 544
 545 static int __init tpa6130a2_init(void)
 546 {
 547         return i2c_add_driver(&tpa6130a2_i2c_driver);
 548 }
 549
 550 static void __exit tpa6130a2_exit(void)
 551 {
 552         i2c_del_driver(&tpa6130a2_i2c_driver);
 553 }
 554
 555 MODULE_AUTHOR("Peter Ujfalusi");
 556 MODULE_DESCRIPTION("TPA6130A2 Headphone amplifier driver");
 557 MODULE_LICENSE("GPL");
 558
 559 module_init(tpa6130a2_init);
 560 module_exit(tpa6130a2_exit);