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