drivers/mfd/twl6040-core.c

   1 /*
   2  * MFD driver for TWL6040 audio device
   3  *
   4  * Authors:     Misael Lopez Cruz <misael.lopez@ti.com>
   5  *              Jorge Eduardo Candelaria <jorge.candelaria@ti.com>
   6  *              Peter Ujfalusi <peter.ujfalusi@ti.com>
   7  *
   8  * Copyright:   (C) 2011 Texas Instruments, Inc.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  *
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/types.h>
  28 #include <linux/slab.h>
  29 #include <linux/kernel.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/gpio.h>
  32 #include <linux/delay.h>
  33 #include <linux/i2c/twl.h>
  34 #include <linux/mfd/core.h>
  35 #include <linux/mfd/twl6040.h>
  36
  37 static struct platform_device *twl6040_dev;
  38
  39 int twl6040_reg_read(struct twl6040 *twl6040, unsigned int reg)
  40 {
  41         int ret;
  42         u8 val = 0;
  43
  44         mutex_lock(&twl6040->io_mutex);
  45         ret = twl_i2c_read_u8(TWL_MODULE_AUDIO_VOICE, &val, reg);
  46         if (ret < 0) {
  47                 mutex_unlock(&twl6040->io_mutex);
  48                 return ret;
  49         }
  50         mutex_unlock(&twl6040->io_mutex);
  51
  52         return val;
  53 }
  54 EXPORT_SYMBOL(twl6040_reg_read);
  55
  56 int twl6040_reg_write(struct twl6040 *twl6040, unsigned int reg, u8 val)
  57 {
  58         int ret;
  59
  60         mutex_lock(&twl6040->io_mutex);
  61         ret = twl_i2c_write_u8(TWL_MODULE_AUDIO_VOICE, val, reg);
  62         mutex_unlock(&twl6040->io_mutex);
  63
  64         return ret;
  65 }
  66 EXPORT_SYMBOL(twl6040_reg_write);
  67
  68 int twl6040_set_bits(struct twl6040 *twl6040, unsigned int reg, u8 mask)
  69 {
  70         int ret;
  71         u8 val;
  72
  73         mutex_lock(&twl6040->io_mutex);
  74         ret = twl_i2c_read_u8(TWL_MODULE_AUDIO_VOICE, &val, reg);
  75         if (ret)
  76                 goto out;
  77
  78         val |= mask;
  79         ret = twl_i2c_write_u8(TWL_MODULE_AUDIO_VOICE, val, reg);
  80 out:
  81         mutex_unlock(&twl6040->io_mutex);
  82         return ret;
  83 }
  84 EXPORT_SYMBOL(twl6040_set_bits);
  85
  86 int twl6040_clear_bits(struct twl6040 *twl6040, unsigned int reg, u8 mask)
  87 {
  88         int ret;
  89         u8 val;
  90
  91         mutex_lock(&twl6040->io_mutex);
  92         ret = twl_i2c_read_u8(TWL_MODULE_AUDIO_VOICE, &val, reg);
  93         if (ret)
  94                 goto out;
  95
  96         val &= ~mask;
  97         ret = twl_i2c_write_u8(TWL_MODULE_AUDIO_VOICE, val, reg);
  98 out:
  99         mutex_unlock(&twl6040->io_mutex);
 100         return ret;
 101 }
 102 EXPORT_SYMBOL(twl6040_clear_bits);
 103
 104 /* twl6040 codec manual power-up sequence */
 105 static int twl6040_power_up(struct twl6040 *twl6040)
 106 {
 107         u8 ldoctl, ncpctl, lppllctl;
 108         int ret;
 109
 110         /* enable high-side LDO, reference system and internal oscillator */
 111         ldoctl = TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA;
 112         ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 113         if (ret)
 114                 return ret;
 115         usleep_range(10000, 10500);
 116
 117         /* enable negative charge pump */
 118         ncpctl = TWL6040_NCPENA;
 119         ret = twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
 120         if (ret)
 121                 goto ncp_err;
 122         usleep_range(1000, 1500);
 123
 124         /* enable low-side LDO */
 125         ldoctl |= TWL6040_LSLDOENA;
 126         ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 127         if (ret)
 128                 goto lsldo_err;
 129         usleep_range(1000, 1500);
 130
 131         /* enable low-power PLL */
 132         lppllctl = TWL6040_LPLLENA;
 133         ret = twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 134         if (ret)
 135                 goto lppll_err;
 136         usleep_range(5000, 5500);
 137
 138         /* disable internal oscillator */
 139         ldoctl &= ~TWL6040_OSCENA;
 140         ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 141         if (ret)
 142                 goto osc_err;
 143
 144         return 0;
 145
 146 osc_err:
 147         lppllctl &= ~TWL6040_LPLLENA;
 148         twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 149 lppll_err:
 150         ldoctl &= ~TWL6040_LSLDOENA;
 151         twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 152 lsldo_err:
 153         ncpctl &= ~TWL6040_NCPENA;
 154         twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
 155 ncp_err:
 156         ldoctl &= ~(TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA);
 157         twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 158
 159         return ret;
 160 }
 161
 162 /* twl6040 manual power-down sequence */
 163 static void twl6040_power_down(struct twl6040 *twl6040)
 164 {
 165         u8 ncpctl, ldoctl, lppllctl;
 166
 167         ncpctl = twl6040_reg_read(twl6040, TWL6040_REG_NCPCTL);
 168         ldoctl = twl6040_reg_read(twl6040, TWL6040_REG_LDOCTL);
 169         lppllctl = twl6040_reg_read(twl6040, TWL6040_REG_LPPLLCTL);
 170
 171         /* enable internal oscillator */
 172         ldoctl |= TWL6040_OSCENA;
 173         twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 174         usleep_range(1000, 1500);
 175
 176         /* disable low-power PLL */
 177         lppllctl &= ~TWL6040_LPLLENA;
 178         twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 179
 180         /* disable low-side LDO */
 181         ldoctl &= ~TWL6040_LSLDOENA;
 182         twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 183
 184         /* disable negative charge pump */
 185         ncpctl &= ~TWL6040_NCPENA;
 186         twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
 187
 188         /* disable high-side LDO, reference system and internal oscillator */
 189         ldoctl &= ~(TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA);
 190         twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
 191 }
 192
 193 static irqreturn_t twl6040_naudint_handler(int irq, void *data)
 194 {
 195         struct twl6040 *twl6040 = data;
 196         u8 intid, status;
 197
 198         intid = twl6040_reg_read(twl6040, TWL6040_REG_INTID);
 199
 200         if (intid & TWL6040_READYINT)
 201                 complete(&twl6040->ready);
 202
 203         if (intid & TWL6040_THINT) {
 204                 status = twl6040_reg_read(twl6040, TWL6040_REG_STATUS);
 205                 if (status & TWL6040_TSHUTDET) {
 206                         dev_warn(&twl6040_dev->dev,
 207                                  "Thermal shutdown, powering-off");
 208                         twl6040_power(twl6040, 0);
 209                 } else {
 210                         dev_warn(&twl6040_dev->dev,
 211                                  "Leaving thermal shutdown, powering-on");
 212                         twl6040_power(twl6040, 1);
 213                 }
 214         }
 215
 216         return IRQ_HANDLED;
 217 }
 218
 219 static int twl6040_power_up_completion(struct twl6040 *twl6040,
 220                                        int naudint)
 221 {
 222         int time_left;
 223         u8 intid;
 224
 225         time_left = wait_for_completion_timeout(&twl6040->ready,
 226                                                 msecs_to_jiffies(144));
 227         if (!time_left) {
 228                 intid = twl6040_reg_read(twl6040, TWL6040_REG_INTID);
 229                 if (!(intid & TWL6040_READYINT)) {
 230                         dev_err(&twl6040_dev->dev,
 231                                 "timeout waiting for READYINT\n");
 232                         return -ETIMEDOUT;
 233                 }
 234         }
 235
 236         return 0;
 237 }
 238
 239 int twl6040_power(struct twl6040 *twl6040, int on)
 240 {
 241         int audpwron = twl6040->audpwron;
 242         int naudint = twl6040->irq;
 243         int ret = 0;
 244
 245         mutex_lock(&twl6040->mutex);
 246
 247         if (on) {
 248                 /* already powered-up */
 249                 if (twl6040->power_count++)
 250                         goto out;
 251
 252                 if (gpio_is_valid(audpwron)) {
 253                         /* use AUDPWRON line */
 254                         gpio_set_value(audpwron, 1);
 255                         /* wait for power-up completion */
 256                         ret = twl6040_power_up_completion(twl6040, naudint);
 257                         if (ret) {
 258                                 dev_err(&twl6040_dev->dev,
 259                                         "automatic power-down failed\n");
 260                                 twl6040->power_count = 0;
 261                                 goto out;
 262                         }
 263                 } else {
 264                         /* use manual power-up sequence */
 265                         ret = twl6040_power_up(twl6040);
 266                         if (ret) {
 267                                 dev_err(&twl6040_dev->dev,
 268                                         "manual power-up failed\n");
 269                                 twl6040->power_count = 0;
 270                                 goto out;
 271                         }
 272                 }
 273                 twl6040->pll = TWL6040_LPPLL_ID;
 274                 twl6040->sysclk = 19200000;
 275         } else {
 276                 /* already powered-down */
 277                 if (!twl6040->power_count) {
 278                         dev_err(&twl6040_dev->dev,
 279                                 "device is already powered-off\n");
 280                         ret = -EPERM;
 281                         goto out;
 282                 }
 283
 284                 if (--twl6040->power_count)
 285                         goto out;
 286
 287                 if (gpio_is_valid(audpwron)) {
 288                         /* use AUDPWRON line */
 289                         gpio_set_value(audpwron, 0);
 290
 291                         /* power-down sequence latency */
 292                         usleep_range(500, 700);
 293                 } else {
 294                         /* use manual power-down sequence */
 295                         twl6040_power_down(twl6040);
 296                 }
 297                 twl6040->pll = TWL6040_NOPLL_ID;
 298                 twl6040->sysclk = 0;
 299         }
 300
 301 out:
 302         mutex_unlock(&twl6040->mutex);
 303         return ret;
 304 }
 305 EXPORT_SYMBOL(twl6040_power);
 306
 307 int twl6040_set_pll(struct twl6040 *twl6040, enum twl6040_pll_id id,
 308                     unsigned int freq_in, unsigned int freq_out)
 309 {
 310         u8 hppllctl, lppllctl;
 311         int ret = 0;
 312
 313         mutex_lock(&twl6040->mutex);
 314
 315         hppllctl = twl6040_reg_read(twl6040, TWL6040_REG_HPPLLCTL);
 316         lppllctl = twl6040_reg_read(twl6040, TWL6040_REG_LPPLLCTL);
 317
 318         switch (id) {
 319         case TWL6040_LPPLL_ID:
 320                 /* low-power PLL divider */
 321                 switch (freq_out) {
 322                 case 17640000:
 323                         lppllctl |= TWL6040_LPLLFIN;
 324                         break;
 325                 case 19200000:
 326                         lppllctl &= ~TWL6040_LPLLFIN;
 327                         break;
 328                 default:
 329                         dev_err(&twl6040_dev->dev,
 330                                 "freq_out %d not supported\n", freq_out);
 331                         ret = -EINVAL;
 332                         goto pll_out;
 333                 }
 334                 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 335
 336                 switch (freq_in) {
 337                 case 32768:
 338                         lppllctl |= TWL6040_LPLLENA;
 339                         twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
 340                                           lppllctl);
 341                         mdelay(5);
 342                         lppllctl &= ~TWL6040_HPLLSEL;
 343                         twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
 344                                           lppllctl);
 345                         hppllctl &= ~TWL6040_HPLLENA;
 346                         twl6040_reg_write(twl6040, TWL6040_REG_HPPLLCTL,
 347                                           hppllctl);
 348                         break;
 349                 default:
 350                         dev_err(&twl6040_dev->dev,
 351                                 "freq_in %d not supported\n", freq_in);
 352                         ret = -EINVAL;
 353                         goto pll_out;
 354                 }
 355
 356                 twl6040->pll = TWL6040_LPPLL_ID;
 357                 break;
 358         case TWL6040_HPPLL_ID:
 359                 /* high-performance PLL can provide only 19.2 MHz */
 360                 if (freq_out != 19200000) {
 361                         dev_err(&twl6040_dev->dev,
 362                                 "freq_out %d not supported\n", freq_out);
 363                         ret = -EINVAL;
 364                         goto pll_out;
 365                 }
 366
 367                 hppllctl &= ~TWL6040_MCLK_MSK;
 368
 369                 switch (freq_in) {
 370                 case 12000000:
 371                         /* PLL enabled, active mode */
 372                         hppllctl |= TWL6040_MCLK_12000KHZ |
 373                                     TWL6040_HPLLENA;
 374                         break;
 375                 case 19200000:
 376                         /*
 377                          * PLL disabled
 378                          * (enable PLL if MCLK jitter quality
 379                          *  doesn't meet specification)
 380                          */
 381                         hppllctl |= TWL6040_MCLK_19200KHZ;
 382                         break;
 383                 case 26000000:
 384                         /* PLL enabled, active mode */
 385                         hppllctl |= TWL6040_MCLK_26000KHZ |
 386                                     TWL6040_HPLLENA;
 387                         break;
 388                 case 38400000:
 389                         /* PLL enabled, active mode */
 390                         hppllctl |= TWL6040_MCLK_38400KHZ |
 391                                     TWL6040_HPLLENA;
 392                         break;
 393                 default:
 394                         dev_err(&twl6040_dev->dev,
 395                                 "freq_in %d not supported\n", freq_in);
 396                         ret = -EINVAL;
 397                         goto pll_out;
 398                 }
 399
 400                 /* enable clock slicer to ensure input waveform is square */
 401                 hppllctl |= TWL6040_HPLLSQRENA;
 402
 403                 twl6040_reg_write(twl6040, TWL6040_REG_HPPLLCTL, hppllctl);
 404                 usleep_range(500, 700);
 405                 lppllctl |= TWL6040_HPLLSEL;
 406                 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 407                 lppllctl &= ~TWL6040_LPLLENA;
 408                 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
 409
 410                 twl6040->pll = TWL6040_HPPLL_ID;
 411                 break;
 412         default:
 413                 dev_err(&twl6040_dev->dev, "unknown pll id %d\n", id);
 414                 ret = -EINVAL;
 415                 goto pll_out;
 416         }
 417
 418         twl6040->sysclk = freq_out;
 419
 420 pll_out:
 421         mutex_unlock(&twl6040->mutex);
 422         return ret;
 423 }
 424 EXPORT_SYMBOL(twl6040_set_pll);
 425
 426 enum twl6040_pll_id twl6040_get_pll(struct twl6040 *twl6040)
 427 {
 428         return twl6040->pll;
 429 }
 430 EXPORT_SYMBOL(twl6040_get_pll);
 431
 432 unsigned int twl6040_get_sysclk(struct twl6040 *twl6040)
 433 {
 434         return twl6040->sysclk;
 435 }
 436 EXPORT_SYMBOL(twl6040_get_sysclk);
 437
 438 static int __devinit twl6040_probe(struct platform_device *pdev)
 439 {
 440         struct twl4030_audio_data *pdata = pdev->dev.platform_data;
 441         struct twl6040 *twl6040;
 442         struct mfd_cell *cell = NULL;
 443         int ret, children = 0;
 444
 445         if (!pdata) {
 446                 dev_err(&pdev->dev, "Platform data is missing\n");
 447                 return -EINVAL;
 448         }
 449
 450         twl6040 = kzalloc(sizeof(struct twl6040), GFP_KERNEL);
 451         if (!twl6040)
 452                 return -ENOMEM;
 453
 454         platform_set_drvdata(pdev, twl6040);
 455
 456         twl6040_dev = pdev;
 457         twl6040->dev = &pdev->dev;
 458         twl6040->audpwron = pdata->audpwron_gpio;
 459         twl6040->irq = pdata->naudint_irq;
 460         twl6040->irq_base = pdata->irq_base;
 461
 462         mutex_init(&twl6040->mutex);
 463         mutex_init(&twl6040->io_mutex);
 464         init_completion(&twl6040->ready);
 465
 466         twl6040->rev = twl6040_reg_read(twl6040, TWL6040_REG_ASICREV);
 467
 468         if (gpio_is_valid(twl6040->audpwron)) {
 469                 ret = gpio_request(twl6040->audpwron, "audpwron");
 470                 if (ret)
 471                         goto gpio1_err;
 472
 473                 ret = gpio_direction_output(twl6040->audpwron, 0);
 474                 if (ret)
 475                         goto gpio2_err;
 476         }
 477
 478         /* ERRATA: Automatic power-up is not possible in ES1.0 */
 479         if (twl6040->rev == TWL6040_REV_ES1_0)
 480                 twl6040->audpwron = -EINVAL;
 481
 482         if (twl6040->irq) {
 483                 /* codec interrupt */
 484                 ret = twl6040_irq_init(twl6040);
 485                 if (ret)
 486                         goto gpio2_err;
 487
 488                 ret = twl6040_request_irq(twl6040, TWL6040_IRQ_READY,
 489                                           twl6040_naudint_handler, 0,
 490                                           "twl6040_irq_ready", twl6040);
 491                 if (ret) {
 492                         dev_err(twl6040->dev, "READY IRQ request failed: %d\n",
 493                                 ret);
 494                         goto irq_err;
 495                 }
 496         }
 497
 498         /* dual-access registers controlled by I2C only */
 499         twl6040_set_bits(twl6040, TWL6040_REG_ACCCTL, TWL6040_I2CSEL);
 500
 501         if (pdata->codec) {
 502                 cell = &twl6040->cells[children];
 503                 cell->name = "twl6040-codec";
 504                 cell->platform_data = pdata->codec;
 505                 cell->pdata_size = sizeof(*pdata->codec);
 506                 children++;
 507         }
 508
 509         if (pdata->vibra) {
 510                 cell = &twl6040->cells[children];
 511                 cell->name = "twl6040-vibra";
 512                 cell->platform_data = pdata->vibra;
 513                 cell->pdata_size = sizeof(*pdata->vibra);
 514                 children++;
 515         }
 516
 517         if (children) {
 518                 ret = mfd_add_devices(&pdev->dev, pdev->id, twl6040->cells,
 519                                       children, NULL, 0);
 520                 if (ret)
 521                         goto mfd_err;
 522         } else {
 523                 dev_err(&pdev->dev, "No platform data found for children\n");
 524                 ret = -ENODEV;
 525                 goto mfd_err;
 526         }
 527
 528         return 0;
 529
 530 mfd_err:
 531         if (twl6040->irq)
 532                 twl6040_free_irq(twl6040, TWL6040_IRQ_READY, twl6040);
 533 irq_err:
 534         if (twl6040->irq)
 535                 twl6040_irq_exit(twl6040);
 536 gpio2_err:
 537         if (gpio_is_valid(twl6040->audpwron))
 538                 gpio_free(twl6040->audpwron);
 539 gpio1_err:
 540         platform_set_drvdata(pdev, NULL);
 541         kfree(twl6040);
 542         twl6040_dev = NULL;
 543         return ret;
 544 }
 545
 546 static int __devexit twl6040_remove(struct platform_device *pdev)
 547 {
 548         struct twl6040 *twl6040 = platform_get_drvdata(pdev);
 549
 550         if (twl6040->power_count)
 551                 twl6040_power(twl6040, 0);
 552
 553         if (gpio_is_valid(twl6040->audpwron))
 554                 gpio_free(twl6040->audpwron);
 555
 556         twl6040_free_irq(twl6040, TWL6040_IRQ_READY, twl6040);
 557
 558         if (twl6040->irq)
 559                 twl6040_irq_exit(twl6040);
 560
 561         mfd_remove_devices(&pdev->dev);
 562         platform_set_drvdata(pdev, NULL);
 563         kfree(twl6040);
 564         twl6040_dev = NULL;
 565
 566         return 0;
 567 }
 568
 569 static struct platform_driver twl6040_driver = {
 570         .probe          = twl6040_probe,
 571         .remove         = __devexit_p(twl6040_remove),
 572         .driver         = {
 573                 .owner  = THIS_MODULE,
 574                 .name   = "twl6040",
 575         },
 576 };
 577
 578 static int __devinit twl6040_init(void)
 579 {
 580         return platform_driver_register(&twl6040_driver);
 581 }
 582 module_init(twl6040_init);
 583
 584 static void __devexit twl6040_exit(void)
 585 {
 586         platform_driver_unregister(&twl6040_driver);
 587 }
 588
 589 module_exit(twl6040_exit);
 590
 591 MODULE_DESCRIPTION("TWL6040 MFD");
 592 MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");
 593 MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
 594 MODULE_LICENSE("GPL");
 595 MODULE_ALIAS("platform:twl6040");