SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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_volsw(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         int max = mc->max;
 188         unsigned int mask = (1 << fls(max)) - 1;
 189         unsigned int invert = mc->invert;
 190
 191         BUG_ON(tpa6130a2_client == NULL);
 192         data = i2c_get_clientdata(tpa6130a2_client);
 193
 194         mutex_lock(&data->mutex);
 195
 196         ucontrol->value.integer.value[0] =
 197                 (tpa6130a2_read(reg) >> shift) & mask;
 198
 199         if (invert)
 200                 ucontrol->value.integer.value[0] =
 201                         max - ucontrol->value.integer.value[0];
 202
 203         mutex_unlock(&data->mutex);
 204         return 0;
 205 }
 206
 207 static int tpa6130a2_put_volsw(struct snd_kcontrol *kcontrol,
 208                 struct snd_ctl_elem_value *ucontrol)
 209 {
 210         struct soc_mixer_control *mc =
 211                 (struct soc_mixer_control *)kcontrol->private_value;
 212         struct tpa6130a2_data *data;
 213         unsigned int reg = mc->reg;
 214         unsigned int shift = mc->shift;
 215         int max = mc->max;
 216         unsigned int mask = (1 << fls(max)) - 1;
 217         unsigned int invert = mc->invert;
 218         unsigned int val = (ucontrol->value.integer.value[0] & mask);
 219         unsigned int val_reg;
 220
 221         BUG_ON(tpa6130a2_client == NULL);
 222         data = i2c_get_clientdata(tpa6130a2_client);
 223
 224         if (invert)
 225                 val = max - val;
 226
 227         mutex_lock(&data->mutex);
 228
 229         val_reg = tpa6130a2_read(reg);
 230         if (((val_reg >> shift) & mask) == val) {
 231                 mutex_unlock(&data->mutex);
 232                 return 0;
 233         }
 234
 235         val_reg &= ~(mask << shift);
 236         val_reg |= val << shift;
 237         tpa6130a2_i2c_write(reg, val_reg);
 238
 239         mutex_unlock(&data->mutex);
 240
 241         return 1;
 242 }
 243
 244 /*
 245  * TPA6130 volume. From -59.5 to 4 dB with increasing step size when going
 246  * down in gain.
 247  */
 248 static const unsigned int tpa6130_tlv[] = {
 249         TLV_DB_RANGE_HEAD(10),
 250         0, 1, TLV_DB_SCALE_ITEM(-5950, 600, 0),
 251         2, 3, TLV_DB_SCALE_ITEM(-5000, 250, 0),
 252         4, 5, TLV_DB_SCALE_ITEM(-4550, 160, 0),
 253         6, 7, TLV_DB_SCALE_ITEM(-4140, 190, 0),
 254         8, 9, TLV_DB_SCALE_ITEM(-3650, 120, 0),
 255         10, 11, TLV_DB_SCALE_ITEM(-3330, 160, 0),
 256         12, 13, TLV_DB_SCALE_ITEM(-3040, 180, 0),
 257         14, 20, TLV_DB_SCALE_ITEM(-2710, 110, 0),
 258         21, 37, TLV_DB_SCALE_ITEM(-1960, 74, 0),
 259         38, 63, TLV_DB_SCALE_ITEM(-720, 45, 0),
 260 };
 261
 262 static const struct snd_kcontrol_new tpa6130a2_controls[] = {
 263         SOC_SINGLE_EXT_TLV("TPA6130A2 Headphone Playback Volume",
 264                        TPA6130A2_REG_VOL_MUTE, 0, 0x3f, 0,
 265                        tpa6130a2_get_volsw, tpa6130a2_put_volsw,
 266                        tpa6130_tlv),
 267 };
 268
 269 static const unsigned int tpa6140_tlv[] = {
 270         TLV_DB_RANGE_HEAD(3),
 271         0, 8, TLV_DB_SCALE_ITEM(-5900, 400, 0),
 272         9, 16, TLV_DB_SCALE_ITEM(-2500, 200, 0),
 273         17, 31, TLV_DB_SCALE_ITEM(-1000, 100, 0),
 274 };
 275
 276 static const struct snd_kcontrol_new tpa6140a2_controls[] = {
 277         SOC_SINGLE_EXT_TLV("TPA6140A2 Headphone Playback Volume",
 278                        TPA6130A2_REG_VOL_MUTE, 1, 0x1f, 0,
 279                        tpa6130a2_get_volsw, tpa6130a2_put_volsw,
 280                        tpa6140_tlv),
 281 };
 282
 283 /*
 284  * Enable or disable channel (left or right)
 285  * The bit number for mute and amplifier are the same per channel:
 286  * bit 6: Right channel
 287  * bit 7: Left channel
 288  * in both registers.
 289  */
 290 static void tpa6130a2_channel_enable(u8 channel, int enable)
 291 {
 292         u8      val;
 293
 294         if (enable) {
 295                 /* Enable channel */
 296                 /* Enable amplifier */
 297                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 298                 val |= channel;
 299                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 300
 301                 /* Unmute channel */
 302                 val = tpa6130a2_read(TPA6130A2_REG_VOL_MUTE);
 303                 val &= ~channel;
 304                 tpa6130a2_i2c_write(TPA6130A2_REG_VOL_MUTE, val);
 305         } else {
 306                 /* Disable channel */
 307                 /* Mute channel */
 308                 val = tpa6130a2_read(TPA6130A2_REG_VOL_MUTE);
 309                 val |= channel;
 310                 tpa6130a2_i2c_write(TPA6130A2_REG_VOL_MUTE, val);
 311
 312                 /* Disable amplifier */
 313                 val = tpa6130a2_read(TPA6130A2_REG_CONTROL);
 314                 val &= ~channel;
 315                 tpa6130a2_i2c_write(TPA6130A2_REG_CONTROL, val);
 316         }
 317 }
 318
 319 static int tpa6130a2_left_event(struct snd_soc_dapm_widget *w,
 320                 struct snd_kcontrol *kcontrol, int event)
 321 {
 322         switch (event) {
 323         case SND_SOC_DAPM_POST_PMU:
 324                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_L, 1);
 325                 break;
 326         case SND_SOC_DAPM_POST_PMD:
 327                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_L, 0);
 328                 break;
 329         }
 330         return 0;
 331 }
 332
 333 static int tpa6130a2_right_event(struct snd_soc_dapm_widget *w,
 334                 struct snd_kcontrol *kcontrol, int event)
 335 {
 336         switch (event) {
 337         case SND_SOC_DAPM_POST_PMU:
 338                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_R, 1);
 339                 break;
 340         case SND_SOC_DAPM_POST_PMD:
 341                 tpa6130a2_channel_enable(TPA6130A2_HP_EN_R, 0);
 342                 break;
 343         }
 344         return 0;
 345 }
 346
 347 static int tpa6130a2_supply_event(struct snd_soc_dapm_widget *w,
 348                 struct snd_kcontrol *kcontrol, int event)
 349 {
 350         int ret = 0;
 351
 352         switch (event) {
 353         case SND_SOC_DAPM_POST_PMU:
 354                 ret = tpa6130a2_power(1);
 355                 break;
 356         case SND_SOC_DAPM_POST_PMD:
 357                 ret = tpa6130a2_power(0);
 358                 break;
 359         }
 360         return ret;
 361 }
 362
 363 static const struct snd_soc_dapm_widget tpa6130a2_dapm_widgets[] = {
 364         SND_SOC_DAPM_PGA_E("TPA6130A2 Left", SND_SOC_NOPM,
 365                         0, 0, NULL, 0, tpa6130a2_left_event,
 366                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 367         SND_SOC_DAPM_PGA_E("TPA6130A2 Right", SND_SOC_NOPM,
 368                         0, 0, NULL, 0, tpa6130a2_right_event,
 369                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 370         SND_SOC_DAPM_SUPPLY("TPA6130A2 Enable", SND_SOC_NOPM,
 371                         0, 0, tpa6130a2_supply_event,
 372                         SND_SOC_DAPM_POST_PMU|SND_SOC_DAPM_POST_PMD),
 373         /* Outputs */
 374         SND_SOC_DAPM_OUTPUT("TPA6130A2 Headphone Left"),
 375         SND_SOC_DAPM_OUTPUT("TPA6130A2 Headphone Right"),
 376 };
 377
 378 static const struct snd_soc_dapm_route audio_map[] = {
 379         {"TPA6130A2 Headphone Left", NULL, "TPA6130A2 Left"},
 380         {"TPA6130A2 Headphone Right", NULL, "TPA6130A2 Right"},
 381
 382         {"TPA6130A2 Headphone Left", NULL, "TPA6130A2 Enable"},
 383         {"TPA6130A2 Headphone Right", NULL, "TPA6130A2 Enable"},
 384 };
 385
 386 int tpa6130a2_add_controls(struct snd_soc_codec *codec)
 387 {
 388         struct  tpa6130a2_data *data;
 389
 390         BUG_ON(tpa6130a2_client == NULL);
 391         data = i2c_get_clientdata(tpa6130a2_client);
 392
 393         snd_soc_dapm_new_controls(codec, tpa6130a2_dapm_widgets,
 394                                 ARRAY_SIZE(tpa6130a2_dapm_widgets));
 395
 396         snd_soc_dapm_add_routes(codec, audio_map, ARRAY_SIZE(audio_map));
 397
 398         if (data->id == TPA6140A2)
 399                 return snd_soc_add_controls(codec, tpa6140a2_controls,
 400                                                 ARRAY_SIZE(tpa6140a2_controls));
 401         else
 402                 return snd_soc_add_controls(codec, tpa6130a2_controls,
 403                                                 ARRAY_SIZE(tpa6130a2_controls));
 404
 405 }
 406 EXPORT_SYMBOL_GPL(tpa6130a2_add_controls);
 407
 408 static int __devinit tpa6130a2_probe(struct i2c_client *client,
 409                                      const struct i2c_device_id *id)
 410 {
 411         struct device *dev;
 412         struct tpa6130a2_data *data;
 413         struct tpa6130a2_platform_data *pdata;
 414         int i, ret;
 415
 416         dev = &client->dev;
 417
 418         if (client->dev.platform_data == NULL) {
 419                 dev_err(dev, "Platform data not set\n");
 420                 dump_stack();
 421                 return -ENODEV;
 422         }
 423
 424         data = kzalloc(sizeof(*data), GFP_KERNEL);
 425         if (data == NULL) {
 426                 dev_err(dev, "Can not allocate memory\n");
 427                 return -ENOMEM;
 428         }
 429
 430         tpa6130a2_client = client;
 431
 432         i2c_set_clientdata(tpa6130a2_client, data);
 433
 434         pdata = client->dev.platform_data;
 435         data->power_gpio = pdata->power_gpio;
 436         data->id = pdata->id;
 437
 438         mutex_init(&data->mutex);
 439
 440         /* Set default register values */
 441         data->regs[TPA6130A2_REG_CONTROL] =     TPA6130A2_SWS;
 442         data->regs[TPA6130A2_REG_VOL_MUTE] =    TPA6130A2_MUTE_R |
 443                                                 TPA6130A2_MUTE_L;
 444
 445         if (data->power_gpio >= 0) {
 446                 ret = gpio_request(data->power_gpio, "tpa6130a2 enable");
 447                 if (ret < 0) {
 448                         dev_err(dev, "Failed to request power GPIO (%d)\n",
 449                                 data->power_gpio);
 450                         goto err_gpio;
 451                 }
 452                 gpio_direction_output(data->power_gpio, 0);
 453         }
 454
 455         switch (data->id) {
 456         case TPA6130A2:
 457                 for (i = 0; i < ARRAY_SIZE(data->supplies); i++)
 458                         data->supplies[i].supply = tpa6130a2_supply_names[i];
 459                 break;
 460         case TPA6140A2:
 461                 for (i = 0; i < ARRAY_SIZE(data->supplies); i++)
 462                         data->supplies[i].supply = tpa6140a2_supply_names[i];;
 463                 break;
 464         default:
 465                 dev_warn(dev, "Unknown TPA model (%d). Assuming 6130A2\n",
 466                          pdata->id);
 467                 for (i = 0; i < ARRAY_SIZE(data->supplies); i++)
 468                         data->supplies[i].supply = tpa6130a2_supply_names[i];
 469         }
 470
 471         ret = regulator_bulk_get(dev, ARRAY_SIZE(data->supplies),
 472                                  data->supplies);
 473         if (ret != 0) {
 474                 dev_err(dev, "Failed to request supplies: %d\n", ret);
 475                 goto err_regulator;
 476         }
 477
 478         ret = tpa6130a2_power(1);
 479         if (ret != 0)
 480                 goto err_power;
 481
 482
 483         /* Read version */
 484         ret = tpa6130a2_i2c_read(TPA6130A2_REG_VERSION) &
 485                                  TPA6130A2_VERSION_MASK;
 486         if ((ret != 1) && (ret != 2))
 487                 dev_warn(dev, "UNTESTED version detected (%d)\n", ret);
 488
 489         /* Disable the chip */
 490         ret = tpa6130a2_power(0);
 491         if (ret != 0)
 492                 goto err_power;
 493
 494         return 0;
 495
 496 err_power:
 497         regulator_bulk_free(ARRAY_SIZE(data->supplies), data->supplies);
 498 err_regulator:
 499         if (data->power_gpio >= 0)
 500                 gpio_free(data->power_gpio);
 501 err_gpio:
 502         kfree(data);
 503         i2c_set_clientdata(tpa6130a2_client, NULL);
 504         tpa6130a2_client = NULL;
 505
 506         return ret;
 507 }
 508
 509 static int __devexit tpa6130a2_remove(struct i2c_client *client)
 510 {
 511         struct tpa6130a2_data *data = i2c_get_clientdata(client);
 512
 513         tpa6130a2_power(0);
 514
 515         if (data->power_gpio >= 0)
 516                 gpio_free(data->power_gpio);
 517
 518         regulator_bulk_free(ARRAY_SIZE(data->supplies), data->supplies);
 519
 520         kfree(data);
 521         tpa6130a2_client = NULL;
 522
 523         return 0;
 524 }
 525
 526 static const struct i2c_device_id tpa6130a2_id[] = {
 527         { "tpa6130a2", 0 },
 528         { }
 529 };
 530 MODULE_DEVICE_TABLE(i2c, tpa6130a2_id);
 531
 532 static struct i2c_driver tpa6130a2_i2c_driver = {
 533         .driver = {
 534                 .name = "tpa6130a2",
 535                 .owner = THIS_MODULE,
 536         },
 537         .probe = tpa6130a2_probe,
 538         .remove = __devexit_p(tpa6130a2_remove),
 539         .id_table = tpa6130a2_id,
 540 };
 541
 542 static int __init tpa6130a2_init(void)
 543 {
 544         return i2c_add_driver(&tpa6130a2_i2c_driver);
 545 }
 546
 547 static void __exit tpa6130a2_exit(void)
 548 {
 549         i2c_del_driver(&tpa6130a2_i2c_driver);
 550 }
 551
 552 MODULE_AUTHOR("Peter Ujfalusi");
 553 MODULE_DESCRIPTION("TPA6130A2 Headphone amplifier driver");
 554 MODULE_LICENSE("GPL");
 555
 556 module_init(tpa6130a2_init);
 557 module_exit(tpa6130a2_exit);