drivers/gpio/twl4030-gpio.c

   1 /*
   2  * twl4030_gpio.c -- access to GPIOs on TWL4030/TPS659x0 chips
   3  *
   4  * Copyright (C) 2006-2007 Texas Instruments, Inc.
   5  * Copyright (C) 2006 MontaVista Software, Inc.
   6  *
   7  * Code re-arranged and cleaned up by:
   8  *      Syed Mohammed Khasim <x0khasim@ti.com>
   9  *
  10  * Initial Code:
  11  *      Andy Lowe / Nishanth Menon
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  26  */
  27
  28 #include <linux/module.h>
  29 #include <linux/init.h>
  30 #include <linux/interrupt.h>
  31 #include <linux/kthread.h>
  32 #include <linux/irq.h>
  33 #include <linux/gpio.h>
  34 #include <linux/platform_device.h>
  35 #include <linux/slab.h>
  36
  37 #include <linux/i2c/twl4030.h>
  38
  39
  40 /*
  41  * The GPIO "subchip" supports 18 GPIOs which can be configured as
  42  * inputs or outputs, with pullups or pulldowns on each pin.  Each
  43  * GPIO can trigger interrupts on either or both edges.
  44  *
  45  * GPIO interrupts can be fed to either of two IRQ lines; this is
  46  * intended to support multiple hosts.
  47  *
  48  * There are also two LED pins used sometimes as output-only GPIOs.
  49  *
  50  * FIXME code currently only handles the first IRQ line.
  51  */
  52
  53
  54 static struct gpio_chip twl_gpiochip;
  55 static int twl4030_gpio_irq_base;
  56
  57 /* genirq interfaces are not available to modules */
  58 #ifdef MODULE
  59 #define is_module()     true
  60 #else
  61 #define is_module()     false
  62 #endif
  63
  64 /* GPIO_CTRL Fields */
  65 #define MASK_GPIO_CTRL_GPIO0CD1         BIT(0)
  66 #define MASK_GPIO_CTRL_GPIO1CD2         BIT(1)
  67 #define MASK_GPIO_CTRL_GPIO_ON          BIT(2)
  68
  69 /* Mask for GPIO registers when aggregated into a 32-bit integer */
  70 #define GPIO_32_MASK                    0x0003ffff
  71
  72 /* Data structures */
  73 static DEFINE_MUTEX(gpio_lock);
  74
  75 /* store usage of each GPIO. - each bit represents one GPIO */
  76 static unsigned int gpio_usage_count;
  77
  78 /*----------------------------------------------------------------------*/
  79
  80 /*
  81  * To configure TWL4030 GPIO module registers
  82  */
  83 static inline int gpio_twl4030_write(u8 address, u8 data)
  84 {
  85         return twl4030_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
  86 }
  87
  88 /*----------------------------------------------------------------------*/
  89
  90 /*
  91  * LED register offsets (use TWL4030_MODULE_{LED,PWMA,PWMB}))
  92  * PWMs A and B are dedicated to LEDs A and B, respectively.
  93  */
  94
  95 #define TWL4030_LED_LEDEN       0x0
  96
  97 /* LEDEN bits */
  98 #define LEDEN_LEDAON            BIT(0)
  99 #define LEDEN_LEDBON            BIT(1)
 100 #define LEDEN_LEDAEXT           BIT(2)
 101 #define LEDEN_LEDBEXT           BIT(3)
 102 #define LEDEN_LEDAPWM           BIT(4)
 103 #define LEDEN_LEDBPWM           BIT(5)
 104 #define LEDEN_PWM_LENGTHA       BIT(6)
 105 #define LEDEN_PWM_LENGTHB       BIT(7)
 106
 107 #define TWL4030_PWMx_PWMxON     0x0
 108 #define TWL4030_PWMx_PWMxOFF    0x1
 109
 110 #define PWMxON_LENGTH           BIT(7)
 111
 112 /*----------------------------------------------------------------------*/
 113
 114 /*
 115  * To read a TWL4030 GPIO module register
 116  */
 117 static inline int gpio_twl4030_read(u8 address)
 118 {
 119         u8 data;
 120         int ret = 0;
 121
 122         ret = twl4030_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
 123         return (ret < 0) ? ret : data;
 124 }
 125
 126 /*----------------------------------------------------------------------*/
 127
 128 static u8 cached_leden;         /* protected by gpio_lock */
 129
 130 /* The LED lines are open drain outputs ... a FET pulls to GND, so an
 131  * external pullup is needed.  We could also expose the integrated PWM
 132  * as a LED brightness control; we initialize it as "always on".
 133  */
 134 static void twl4030_led_set_value(int led, int value)
 135 {
 136         u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;
 137         int status;
 138
 139         if (led)
 140                 mask <<= 1;
 141
 142         mutex_lock(&gpio_lock);
 143         if (value)
 144                 cached_leden &= ~mask;
 145         else
 146                 cached_leden |= mask;
 147         status = twl4030_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
 148                         TWL4030_LED_LEDEN);
 149         mutex_unlock(&gpio_lock);
 150 }
 151
 152 static int twl4030_set_gpio_direction(int gpio, int is_input)
 153 {
 154         u8 d_bnk = gpio >> 3;
 155         u8 d_msk = BIT(gpio & 0x7);
 156         u8 reg = 0;
 157         u8 base = REG_GPIODATADIR1 + d_bnk;
 158         int ret = 0;
 159
 160         mutex_lock(&gpio_lock);
 161         ret = gpio_twl4030_read(base);
 162         if (ret >= 0) {
 163                 if (is_input)
 164                         reg = ret & ~d_msk;
 165                 else
 166                         reg = ret | d_msk;
 167
 168                 ret = gpio_twl4030_write(base, reg);
 169         }
 170         mutex_unlock(&gpio_lock);
 171         return ret;
 172 }
 173
 174 static int twl4030_set_gpio_dataout(int gpio, int enable)
 175 {
 176         u8 d_bnk = gpio >> 3;
 177         u8 d_msk = BIT(gpio & 0x7);
 178         u8 base = 0;
 179
 180         if (enable)
 181                 base = REG_SETGPIODATAOUT1 + d_bnk;
 182         else
 183                 base = REG_CLEARGPIODATAOUT1 + d_bnk;
 184
 185         return gpio_twl4030_write(base, d_msk);
 186 }
 187
 188 static int twl4030_get_gpio_datain(int gpio)
 189 {
 190         u8 d_bnk = gpio >> 3;
 191         u8 d_off = gpio & 0x7;
 192         u8 base = 0;
 193         int ret = 0;
 194
 195         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 196                 || !(gpio_usage_count & BIT(gpio))))
 197                 return -EPERM;
 198
 199         base = REG_GPIODATAIN1 + d_bnk;
 200         ret = gpio_twl4030_read(base);
 201         if (ret > 0)
 202                 ret = (ret >> d_off) & 0x1;
 203
 204         return ret;
 205 }
 206
 207 /*
 208  * Configure debounce timing value for a GPIO pin on TWL4030
 209  */
 210 int twl4030_set_gpio_debounce(int gpio, int enable)
 211 {
 212         u8 d_bnk = gpio >> 3;
 213         u8 d_msk = BIT(gpio & 0x7);
 214         u8 reg = 0;
 215         u8 base = 0;
 216         int ret = 0;
 217
 218         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 219                 || !(gpio_usage_count & BIT(gpio))))
 220                 return -EPERM;
 221
 222         base = REG_GPIO_DEBEN1 + d_bnk;
 223         mutex_lock(&gpio_lock);
 224         ret = gpio_twl4030_read(base);
 225         if (ret >= 0) {
 226                 if (enable)
 227                         reg = ret | d_msk;
 228                 else
 229                         reg = ret & ~d_msk;
 230
 231                 ret = gpio_twl4030_write(base, reg);
 232         }
 233         mutex_unlock(&gpio_lock);
 234         return ret;
 235 }
 236 EXPORT_SYMBOL(twl4030_set_gpio_debounce);
 237
 238 #if 0
 239 /*
 240  * Configure Card detect for GPIO pin on TWL4030
 241  *
 242  * This means:  VMMC1 or VMMC2 is enabled or disabled based
 243  * on the status of GPIO-0 or GPIO-1 pins (respectively).
 244  */
 245 int twl4030_set_gpio_card_detect(int gpio, int enable)
 246 {
 247         u8 reg = 0;
 248         u8 msk = (1 << gpio);
 249         int ret = 0;
 250
 251         /* Only GPIO 0 or 1 can be used for CD feature.. */
 252         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 253                 || !(gpio_usage_count & BIT(gpio))
 254                 || (gpio >= TWL4030_GPIO_MAX_CD))) {
 255                 return -EPERM;
 256         }
 257
 258         mutex_lock(&gpio_lock);
 259         ret = gpio_twl4030_read(REG_GPIO_CTRL);
 260         if (ret >= 0) {
 261                 if (enable)
 262                         reg = (u8) (ret | msk);
 263                 else
 264                         reg = (u8) (ret & ~msk);
 265
 266                 ret = gpio_twl4030_write(REG_GPIO_CTRL, reg);
 267         }
 268         mutex_unlock(&gpio_lock);
 269         return ret;
 270 }
 271 #endif
 272
 273 /*----------------------------------------------------------------------*/
 274
 275 static int twl_request(struct gpio_chip *chip, unsigned offset)
 276 {
 277         int status = 0;
 278
 279         mutex_lock(&gpio_lock);
 280
 281         /* Support the two LED outputs as output-only GPIOs. */
 282         if (offset >= TWL4030_GPIO_MAX) {
 283                 u8      ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
 284                                 | LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
 285                 u8      module = TWL4030_MODULE_PWMA;
 286
 287                 offset -= TWL4030_GPIO_MAX;
 288                 if (offset) {
 289                         ledclr_mask <<= 1;
 290                         module = TWL4030_MODULE_PWMB;
 291                 }
 292
 293                 /* initialize PWM to always-drive */
 294                 status = twl4030_i2c_write_u8(module, 0x7f,
 295                                 TWL4030_PWMx_PWMxOFF);
 296                 if (status < 0)
 297                         goto done;
 298                 status = twl4030_i2c_write_u8(module, 0x7f,
 299                                 TWL4030_PWMx_PWMxON);
 300                 if (status < 0)
 301                         goto done;
 302
 303                 /* init LED to not-driven (high) */
 304                 module = TWL4030_MODULE_LED;
 305                 status = twl4030_i2c_read_u8(module, &cached_leden,
 306                                 TWL4030_LED_LEDEN);
 307                 if (status < 0)
 308                         goto done;
 309                 cached_leden &= ~ledclr_mask;
 310                 status = twl4030_i2c_write_u8(module, cached_leden,
 311                                 TWL4030_LED_LEDEN);
 312                 if (status < 0)
 313                         goto done;
 314
 315                 status = 0;
 316                 goto done;
 317         }
 318
 319         /* on first use, turn GPIO module "on" */
 320         if (!gpio_usage_count)
 321                 status = gpio_twl4030_write(REG_GPIO_CTRL,
 322                                 MASK_GPIO_CTRL_GPIO_ON);
 323
 324         if (!status)
 325                 gpio_usage_count |= (0x1 << offset);
 326
 327 done:
 328         mutex_unlock(&gpio_lock);
 329         return status;
 330 }
 331
 332 static void twl_free(struct gpio_chip *chip, unsigned offset)
 333 {
 334         if (offset >= TWL4030_GPIO_MAX) {
 335                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
 336                 return;
 337         }
 338
 339         mutex_lock(&gpio_lock);
 340
 341         gpio_usage_count &= ~BIT(offset);
 342
 343         /* on last use, switch off GPIO module */
 344         if (!gpio_usage_count)
 345                 gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
 346
 347         mutex_unlock(&gpio_lock);
 348 }
 349
 350 static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
 351 {
 352         return (offset < TWL4030_GPIO_MAX)
 353                 ? twl4030_set_gpio_direction(offset, 1)
 354                 : -EINVAL;
 355 }
 356
 357 static int twl_get(struct gpio_chip *chip, unsigned offset)
 358 {
 359         int status = 0;
 360
 361         if (offset < TWL4030_GPIO_MAX)
 362                 status = twl4030_get_gpio_datain(offset);
 363         else if (offset == TWL4030_GPIO_MAX)
 364                 status = cached_leden & LEDEN_LEDAON;
 365         else
 366                 status = cached_leden & LEDEN_LEDBON;
 367         return (status < 0) ? 0 : status;
 368 }
 369
 370 static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
 371 {
 372         if (offset < TWL4030_GPIO_MAX) {
 373                 twl4030_set_gpio_dataout(offset, value);
 374                 return twl4030_set_gpio_direction(offset, 0);
 375         } else {
 376                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
 377                 return 0;
 378         }
 379 }
 380
 381 static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
 382 {
 383         if (offset < TWL4030_GPIO_MAX)
 384                 twl4030_set_gpio_dataout(offset, value);
 385         else
 386                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
 387 }
 388
 389 static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
 390 {
 391         return (twl4030_gpio_irq_base && (offset < TWL4030_GPIO_MAX))
 392                 ? (twl4030_gpio_irq_base + offset)
 393                 : -EINVAL;
 394 }
 395
 396 static struct gpio_chip twl_gpiochip = {
 397         .label                  = "twl4030",
 398         .owner                  = THIS_MODULE,
 399         .request                = twl_request,
 400         .free                   = twl_free,
 401         .direction_input        = twl_direction_in,
 402         .get                    = twl_get,
 403         .direction_output       = twl_direction_out,
 404         .set                    = twl_set,
 405         .to_irq                 = twl_to_irq,
 406         .can_sleep              = 1,
 407 };
 408
 409 /*----------------------------------------------------------------------*/
 410
 411 static int __devinit gpio_twl4030_pulls(u32 ups, u32 downs)
 412 {
 413         u8              message[6];
 414         unsigned        i, gpio_bit;
 415
 416         /* For most pins, a pulldown was enabled by default.
 417          * We should have data that's specific to this board.
 418          */
 419         for (gpio_bit = 1, i = 1; i < 6; i++) {
 420                 u8              bit_mask;
 421                 unsigned        j;
 422
 423                 for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
 424                         if (ups & gpio_bit)
 425                                 bit_mask |= 1 << (j + 1);
 426                         else if (downs & gpio_bit)
 427                                 bit_mask |= 1 << (j + 0);
 428                 }
 429                 message[i] = bit_mask;
 430         }
 431
 432         return twl4030_i2c_write(TWL4030_MODULE_GPIO, message,
 433                                 REG_GPIOPUPDCTR1, 5);
 434 }
 435
 436 static int gpio_twl4030_remove(struct platform_device *pdev);
 437
 438 static int __devinit gpio_twl4030_probe(struct platform_device *pdev)
 439 {
 440         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
 441         int ret;
 442
 443         /* maybe setup IRQs */
 444         if (pdata->irq_base) {
 445                 if (is_module()) {
 446                         dev_err(&pdev->dev,
 447                                 "can't dispatch IRQs from modules\n");
 448                         goto no_irqs;
 449                 }
 450                 ret = twl4030_sih_setup(TWL4030_MODULE_GPIO);
 451                 if (ret < 0)
 452                         return ret;
 453                 WARN_ON(ret != pdata->irq_base);
 454                 twl4030_gpio_irq_base = ret;
 455         }
 456
 457 no_irqs:
 458         /*
 459          * NOTE:  boards may waste power if they don't set pullups
 460          * and pulldowns correctly ... default for non-ULPI pins is
 461          * pulldown, and some other pins may have external pullups
 462          * or pulldowns.  Careful!
 463          */
 464         ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
 465         if (ret)
 466                 dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
 467                                 pdata->pullups, pdata->pulldowns,
 468                                 ret);
 469
 470         twl_gpiochip.base = pdata->gpio_base;
 471         twl_gpiochip.ngpio = TWL4030_GPIO_MAX;
 472         twl_gpiochip.dev = &pdev->dev;
 473
 474         /* NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
 475          * is (still) clear if use_leds is set.
 476          */
 477         if (pdata->use_leds)
 478                 twl_gpiochip.ngpio += 2;
 479
 480         ret = gpiochip_add(&twl_gpiochip);
 481         if (ret < 0) {
 482                 dev_err(&pdev->dev,
 483                                 "could not register gpiochip, %d\n",
 484                                 ret);
 485                 twl_gpiochip.ngpio = 0;
 486                 gpio_twl4030_remove(pdev);
 487         } else if (pdata->setup) {
 488                 int status;
 489
 490                 status = pdata->setup(&pdev->dev,
 491                                 pdata->gpio_base, TWL4030_GPIO_MAX);
 492                 if (status)
 493                         dev_dbg(&pdev->dev, "setup --> %d\n", status);
 494         }
 495
 496         return ret;
 497 }
 498
 499 static int __devexit gpio_twl4030_remove(struct platform_device *pdev)
 500 {
 501         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
 502         int status;
 503
 504         if (pdata->teardown) {
 505                 status = pdata->teardown(&pdev->dev,
 506                                 pdata->gpio_base, TWL4030_GPIO_MAX);
 507                 if (status) {
 508                         dev_dbg(&pdev->dev, "teardown --> %d\n", status);
 509                         return status;
 510                 }
 511         }
 512
 513         status = gpiochip_remove(&twl_gpiochip);
 514         if (status < 0)
 515                 return status;
 516
 517         if (is_module())
 518                 return 0;
 519
 520         /* REVISIT no support yet for deregistering all the IRQs */
 521         WARN_ON(1);
 522         return -EIO;
 523 }
 524
 525 /* Note:  this hardware lives inside an I2C-based multi-function device. */
 526 MODULE_ALIAS("platform:twl4030_gpio");
 527
 528 static struct platform_driver gpio_twl4030_driver = {
 529         .driver.name    = "twl4030_gpio",
 530         .driver.owner   = THIS_MODULE,
 531         .probe          = gpio_twl4030_probe,
 532         .remove         = __devexit_p(gpio_twl4030_remove),
 533 };
 534
 535 static int __init gpio_twl4030_init(void)
 536 {
 537         return platform_driver_register(&gpio_twl4030_driver);
 538 }
 539 subsys_initcall(gpio_twl4030_init);
 540
 541 static void __exit gpio_twl4030_exit(void)
 542 {
 543         platform_driver_unregister(&gpio_twl4030_driver);
 544 }
 545 module_exit(gpio_twl4030_exit);
 546
 547 MODULE_AUTHOR("Texas Instruments, Inc.");
 548 MODULE_DESCRIPTION("GPIO interface for TWL4030");
 549 MODULE_LICENSE("GPL");