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/kernel_stat.h>
  30 #include <linux/init.h>
  31 #include <linux/time.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/device.h>
  34 #include <linux/kthread.h>
  35 #include <linux/irq.h>
  36 #include <linux/gpio.h>
  37 #include <linux/platform_device.h>
  38 #include <linux/slab.h>
  39
  40 #include <linux/i2c/twl4030.h>
  41 #include <linux/i2c/twl4030-gpio.h>
  42
  43 #include <mach/irqs.h>
  44 #include <asm/mach/irq.h>
  45 #include <mach/gpio.h>
  46 #include <mach/mux.h>
  47
  48
  49 /* REVISIT when these symbols vanish elsewhere, remove them here too */
  50 /* #undef TWL4030_GPIO_IRQ_BASE */
  51 /* #undef TWL4030_GPIO_IRQ_END */
  52
  53 static struct gpio_chip twl_gpiochip;
  54 static int twl4030_gpio_irq_base;
  55 static int twl4030_gpio_irq_end;
  56
  57 #ifdef MODULE
  58 #define is_module()     true
  59 #else
  60 #define is_module()     false
  61 #endif
  62
  63 /* BitField Definitions */
  64
  65 /* Data banks : 3 banks for 8 gpios each */
  66 #define DATA_BANK_MAX                           8
  67 #define GET_GPIO_DATA_BANK(x)                   ((x)/DATA_BANK_MAX)
  68 #define GET_GPIO_DATA_OFF(x)                    ((x)%DATA_BANK_MAX)
  69
  70 /* GPIODATADIR Fields each block 0-7 */
  71 #define BIT_GPIODATADIR_GPIOxDIR(x)             (x)
  72 #define MASK_GPIODATADIR_GPIOxDIR(x)            (0x01 << (x))
  73
  74 /* GPIODATAIN Fields each block 0-7 */
  75 #define BIT_GPIODATAIN_GPIOxIN(x)               (x)
  76 #define MASK_GPIODATAIN_GPIOxIN(x)              (0x01 << (x))
  77
  78 /* GPIODATAOUT Fields each block 0-7 */
  79 #define BIT_GPIODATAOUT_GPIOxOUT(x)             (x)
  80 #define MASK_GPIODATAOUT_GPIOxOUT(x)            (0x01 << (x))
  81
  82 /* CLEARGPIODATAOUT Fields */
  83 #define BIT_CLEARGPIODATAOUT_GPIOxOUT(x)        (x)
  84 #define MASK_CLEARGPIODATAOUT_GPIOxOUT(x)       (0x01 << (x))
  85
  86 /* SETGPIODATAOUT Fields */
  87 #define BIT_SETGPIODATAOUT_GPIOxOUT(x)          (x)
  88 #define MASK_SETGPIODATAOUT_GPIOxOUT(x)         (0x01 << (x))
  89
  90 /* GPIO_DEBEN Fields */
  91 #define BIT_GPIO_DEBEN_GPIOxDEB(x)              (x)
  92 #define MASK_GPIO_DEBEN_GPIOxDEB(x)             (0x01 << (x))
  93
  94 /* GPIO_ISR1A Fields */
  95 #define BIT_GPIO_ISR_GPIOxISR(x)                (x)
  96 #define MASK_GPIO_ISR_GPIOxISR(x)               (0x01 << (x))
  97
  98 /* GPIO_IMR1A Fields */
  99 #define BIT_GPIO_IMR1A_GPIOxIMR(x)              (x)
 100 #define MASK_GPIO_IMR1A_GPIOxIMR(x)             (0x01 << (x))
 101
 102 /* GPIO_SIR1 Fields */
 103 #define BIT_GPIO_SIR1_GPIOxSIR(x)               (x)
 104 #define MASK_GPIO_SIR1_GPIO0SIR                 (0x01 << (x))
 105
 106
 107 /* Control banks : 5 banks for 4 gpios each */
 108 #define DATA_CTL_MAX                    4
 109 #define GET_GPIO_CTL_BANK(x)            ((x)/DATA_CTL_MAX)
 110 #define GET_GPIO_CTL_OFF(x)             ((x)%DATA_CTL_MAX)
 111 #define GPIO_BANK_MAX                   GET_GPIO_CTL_BANK(TWL4030_GPIO_MAX)
 112
 113 /* GPIOPUPDCTRx Fields 5 banks of 4 gpios each */
 114 #define BIT_GPIOPUPDCTR1_GPIOxPD(x)     (2 * (x))
 115 #define MASK_GPIOPUPDCTR1_GPIOxPD(x)    (0x01 << (2 * (x)))
 116 #define BIT_GPIOPUPDCTR1_GPIOxPU(x)     ((x) + 1)
 117 #define MASK_GPIOPUPDCTR1_GPIOxPU(x)    (0x01 << (((2 * (x)) + 1)))
 118
 119 /* GPIO_EDR1 Fields */
 120 #define BIT_GPIO_EDR1_GPIOxFALLING(x)   (2 * (x))
 121 #define MASK_GPIO_EDR1_GPIOxFALLING(x)  (0x01 << (2 * (x)))
 122 #define BIT_GPIO_EDR1_GPIOxRISING(x)    ((x) + 1)
 123 #define MASK_GPIO_EDR1_GPIOxRISING(x)   (0x01 << (((2 * (x)) + 1)))
 124
 125 /* GPIO_SIH_CTRL Fields */
 126 #define BIT_GPIO_SIH_CTRL_EXCLEN        (0x000)
 127 #define MASK_GPIO_SIH_CTRL_EXCLEN       (0x00000001)
 128 #define BIT_GPIO_SIH_CTRL_PENDDIS       (0x001)
 129 #define MASK_GPIO_SIH_CTRL_PENDDIS      (0x00000002)
 130 #define BIT_GPIO_SIH_CTRL_COR           (0x002)
 131 #define MASK_GPIO_SIH_CTRL_COR          (0x00000004)
 132
 133 /* GPIO_CTRL Fields */
 134 #define BIT_GPIO_CTRL_GPIO0CD1          (0x000)
 135 #define MASK_GPIO_CTRL_GPIO0CD1         (0x00000001)
 136 #define BIT_GPIO_CTRL_GPIO1CD2          (0x001)
 137 #define MASK_GPIO_CTRL_GPIO1CD2         (0x00000002)
 138 #define BIT_GPIO_CTRL_GPIO_ON           (0x002)
 139 #define MASK_GPIO_CTRL_GPIO_ON          (0x00000004)
 140
 141 /* Mask for GPIO registers when aggregated into a 32-bit integer */
 142 #define GPIO_32_MASK                    0x0003ffff
 143
 144 /* Data structures */
 145 static DEFINE_MUTEX(gpio_lock);
 146
 147 /* store usage of each GPIO. - each bit represents one GPIO */
 148 static unsigned int gpio_usage_count;
 149
 150 /* shadow the imr register */
 151 static unsigned int gpio_imr_shadow;
 152
 153 /* bitmask of pending requests to unmask gpio interrupts */
 154 static unsigned int gpio_pending_unmask;
 155
 156 /* bitmask of requests to set gpio irq trigger type */
 157 static unsigned int gpio_pending_trigger;
 158
 159 /* pointer to gpio unmask thread struct */
 160 static struct task_struct *gpio_unmask_thread;
 161
 162 /*
 163  * Helper functions to read and write the GPIO ISR and IMR registers as
 164  * 32-bit integers. Functions return 0 on success, non-zero otherwise.
 165  * The caller must hold gpio_lock.
 166  */
 167
 168 static int gpio_read_isr(unsigned int *isr)
 169 {
 170         int ret;
 171
 172         *isr = 0;
 173         ret = twl4030_i2c_read(TWL4030_MODULE_GPIO, (u8 *) isr,
 174                         REG_GPIO_ISR1A, 3);
 175         le32_to_cpup(isr);
 176         *isr &= GPIO_32_MASK;
 177
 178         return ret;
 179 }
 180
 181 static int gpio_write_isr(unsigned int isr)
 182 {
 183         isr &= GPIO_32_MASK;
 184         /*
 185          * The buffer passed to the twl4030_i2c_write() routine must have an
 186          * extra byte at the beginning reserved for its internal use.
 187          */
 188         isr <<= 8;
 189         isr = cpu_to_le32(isr);
 190         return twl4030_i2c_write(TWL4030_MODULE_GPIO, (u8 *) &isr,
 191                                 REG_GPIO_ISR1A, 3);
 192 }
 193
 194 static int gpio_write_imr(unsigned int imr)
 195 {
 196         imr &= GPIO_32_MASK;
 197         /*
 198          * The buffer passed to the twl4030_i2c_write() routine must have an
 199          * extra byte at the beginning reserved for its internal use.
 200          */
 201         imr <<= 8;
 202         imr = cpu_to_le32(imr);
 203         return twl4030_i2c_write(TWL4030_MODULE_GPIO, (u8 *) &imr,
 204                                 REG_GPIO_IMR1A, 3);
 205 }
 206
 207 /*
 208  * These routines are analagous to the irqchip methods, but they are designed
 209  * to be called from thread context with cpu interrupts enabled and with no
 210  * locked spinlocks.  We call these routines from our custom IRQ handler
 211  * instead of the usual irqchip methods.
 212  */
 213 static void twl4030_gpio_mask_and_ack(unsigned int irq)
 214 {
 215         int gpio = irq - twl4030_gpio_irq_base;
 216
 217         mutex_lock(&gpio_lock);
 218         /* mask */
 219         gpio_imr_shadow |= (1 << gpio);
 220         gpio_write_imr(gpio_imr_shadow);
 221         /* ack */
 222         gpio_write_isr(1 << gpio);
 223         mutex_unlock(&gpio_lock);
 224 }
 225
 226 static void twl4030_gpio_unmask(unsigned int irq)
 227 {
 228         int gpio = irq - twl4030_gpio_irq_base;
 229
 230         mutex_lock(&gpio_lock);
 231         gpio_imr_shadow &= ~(1 << gpio);
 232         gpio_write_imr(gpio_imr_shadow);
 233         mutex_unlock(&gpio_lock);
 234 }
 235
 236 /*
 237  * These are the irqchip methods for the TWL4030 GPIO interrupts.
 238  * Our IRQ handle method doesn't call these, but they will be called by
 239  * other routines such as setup_irq() and enable_irq().  They are called
 240  * with cpu interrupts disabled and with a lock on the irq_controller_lock
 241  * spinlock.  This complicates matters, because accessing the TWL4030 GPIO
 242  * interrupt controller requires I2C bus transactions that can't be initiated
 243  * in this context.  Our solution is to defer accessing the interrupt
 244  * controller to a kernel thread.  We only need to support the unmask method.
 245  */
 246
 247 static void twl4030_gpio_irq_mask_and_ack(unsigned int irq)
 248 {
 249 }
 250
 251 static void twl4030_gpio_irq_mask(unsigned int irq)
 252 {
 253 }
 254
 255 static void twl4030_gpio_irq_unmask(unsigned int irq)
 256 {
 257         int gpio = irq - twl4030_gpio_irq_base;
 258
 259         gpio_pending_unmask |= (1 << gpio);
 260         if (gpio_unmask_thread && gpio_unmask_thread->state != TASK_RUNNING)
 261                 wake_up_process(gpio_unmask_thread);
 262 }
 263
 264 static int twl4030_gpio_irq_set_type(unsigned int irq, unsigned trigger)
 265 {
 266         struct irq_desc *desc = irq_desc + irq;
 267         int gpio = irq - twl4030_gpio_irq_base;
 268
 269         trigger &= IRQ_TYPE_SENSE_MASK;
 270         if (trigger & ~IRQ_TYPE_EDGE_BOTH)
 271                 return -EINVAL;
 272         if ((desc->status & IRQ_TYPE_SENSE_MASK) == trigger)
 273                 return 0;
 274
 275         desc->status &= ~IRQ_TYPE_SENSE_MASK;
 276         desc->status |= trigger;
 277
 278         /* REVISIT This makes the "unmask" thread do double duty,
 279          * updating IRQ trigger modes too.  Rename appropriately...
 280          */
 281         gpio_pending_trigger |= (1 << gpio);
 282         if (gpio_unmask_thread && gpio_unmask_thread->state != TASK_RUNNING)
 283                 wake_up_process(gpio_unmask_thread);
 284
 285         return 0;
 286 }
 287
 288 static struct irq_chip twl4030_gpio_irq_chip = {
 289         .name           = "twl4030",
 290         .ack            = twl4030_gpio_irq_mask_and_ack,
 291         .mask           = twl4030_gpio_irq_mask,
 292         .unmask         = twl4030_gpio_irq_unmask,
 293         .set_type       = twl4030_gpio_irq_set_type,
 294 };
 295
 296 /*
 297  * These are the irqchip methods for the TWL4030 PIH GPIO module interrupt.
 298  * The PIH module doesn't have interrupt masking capability, so these
 299  * methods are NULL.
 300  */
 301 static void twl4030_gpio_module_ack(unsigned int irq) {}
 302 static void twl4030_gpio_module_mask(unsigned int irq) {}
 303 static void twl4030_gpio_module_unmask(unsigned int irq) {}
 304 static struct irq_chip twl4030_gpio_module_irq_chip = {
 305         .ack    = twl4030_gpio_module_ack,
 306         .mask   = twl4030_gpio_module_mask,
 307         .unmask = twl4030_gpio_module_unmask,
 308 };
 309
 310 /*
 311  * To configure TWL4030 GPIO module registers
 312  */
 313 static inline int gpio_twl4030_write(u8 address, u8 data)
 314 {
 315         int ret = 0;
 316
 317         ret = twl4030_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
 318         return ret;
 319 }
 320
 321 /*
 322  * To read a TWL4030 GPIO module register
 323  */
 324 static inline int gpio_twl4030_read(u8 address)
 325 {
 326         u8 data;
 327         int ret = 0;
 328
 329         ret = twl4030_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
 330         if (ret >= 0)
 331                 ret = data;
 332         return ret;
 333 }
 334
 335 /*
 336  * twl4030 GPIO request function
 337  */
 338 int twl4030_request_gpio(int gpio)
 339 {
 340         int ret = 0;
 341
 342         if (unlikely(gpio >= TWL4030_GPIO_MAX))
 343                 return -EPERM;
 344
 345         ret = gpio_request(twl_gpiochip.base + gpio, NULL);
 346         if (ret < 0)
 347                 return ret;
 348
 349         mutex_lock(&gpio_lock);
 350         if (gpio_usage_count & (0x1 << gpio)) {
 351                 ret = -EBUSY;
 352         } else {
 353                 /* First time usage? - switch on GPIO module */
 354                 if (!gpio_usage_count) {
 355                         ret = gpio_twl4030_write(REG_GPIO_CTRL,
 356                                         MASK_GPIO_CTRL_GPIO_ON);
 357                         ret = gpio_twl4030_write(REG_GPIO_SIH_CTRL, 0x00);
 358                 }
 359                 if (!ret)
 360                         gpio_usage_count |= (0x1 << gpio);
 361                 else
 362                         gpio_free(twl_gpiochip.base + gpio);
 363         }
 364         mutex_unlock(&gpio_lock);
 365         return ret;
 366 }
 367 EXPORT_SYMBOL(twl4030_request_gpio);
 368
 369 /*
 370  * TWL4030 GPIO free module
 371  */
 372 int twl4030_free_gpio(int gpio)
 373 {
 374         int ret = 0;
 375
 376         if (unlikely(gpio >= TWL4030_GPIO_MAX))
 377                 return -EPERM;
 378
 379         mutex_lock(&gpio_lock);
 380
 381         if ((gpio_usage_count & (0x1 << gpio)) == 0) {
 382                 ret = -EPERM;
 383         } else {
 384                 gpio_usage_count &= ~(0x1 << gpio);
 385                 gpio_free(twl_gpiochip.base + gpio);
 386         }
 387
 388         /* Last time usage? - switch off GPIO module */
 389         if (ret == 0 && !gpio_usage_count)
 390                 ret = gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
 391
 392         mutex_unlock(&gpio_lock);
 393         return ret;
 394 }
 395 EXPORT_SYMBOL(twl4030_free_gpio);
 396
 397 /*
 398  * Set direction for TWL4030 GPIO
 399  */
 400 static int twl4030_set_gpio_direction(int gpio, int is_input)
 401 {
 402         u8 d_bnk = GET_GPIO_DATA_BANK(gpio);
 403         u8 d_msk = MASK_GPIODATADIR_GPIOxDIR(GET_GPIO_DATA_OFF(gpio));
 404         u8 reg = 0;
 405         u8 base = REG_GPIODATADIR1 + d_bnk;
 406         int ret = 0;
 407
 408         if (unlikely(!(gpio_usage_count & (0x1 << gpio))))
 409                 return -EPERM;
 410
 411         mutex_lock(&gpio_lock);
 412         ret = gpio_twl4030_read(base);
 413         if (ret >= 0) {
 414                 if (is_input)
 415                         reg = (u8) ((ret) & ~(d_msk));
 416                 else
 417                         reg = (u8) ((ret) | (d_msk));
 418
 419                 ret = gpio_twl4030_write(base, reg);
 420         }
 421         mutex_unlock(&gpio_lock);
 422         return ret;
 423 }
 424
 425 /*
 426  * To enable/disable GPIO pin on TWL4030
 427  */
 428 static int twl4030_set_gpio_dataout(int gpio, int enable)
 429 {
 430         u8 d_bnk = GET_GPIO_DATA_BANK(gpio);
 431         u8 d_msk = MASK_GPIODATAOUT_GPIOxOUT(GET_GPIO_DATA_OFF(gpio));
 432         u8 base = 0;
 433         int ret = 0;
 434
 435         if (unlikely(!(gpio_usage_count & (0x1 << gpio))))
 436                 return -EPERM;
 437
 438         if (enable)
 439                 base = REG_SETGPIODATAOUT1 + d_bnk;
 440         else
 441                 base = REG_CLEARGPIODATAOUT1 + d_bnk;
 442
 443         mutex_lock(&gpio_lock);
 444         ret = gpio_twl4030_write(base, d_msk);
 445         mutex_unlock(&gpio_lock);
 446         return ret;
 447 }
 448
 449 /*
 450  * To get the status of a GPIO pin on TWL4030
 451  */
 452 int twl4030_get_gpio_datain(int gpio)
 453 {
 454         u8 d_bnk = GET_GPIO_DATA_BANK(gpio);
 455         u8 d_off = BIT_GPIODATAIN_GPIOxIN(GET_GPIO_DATA_OFF(gpio));
 456         u8 base = 0;
 457         int ret = 0;
 458
 459         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 460                 || !(gpio_usage_count & (0x1 << gpio))))
 461                 return -EPERM;
 462
 463         base = REG_GPIODATAIN1 + d_bnk;
 464         mutex_lock(&gpio_lock);
 465         ret = gpio_twl4030_read(base);
 466         mutex_unlock(&gpio_lock);
 467         if (ret > 0)
 468                 ret = (ret >> d_off) & 0x1;
 469
 470         return ret;
 471 }
 472 EXPORT_SYMBOL(twl4030_get_gpio_datain);
 473
 474 #if 0
 475 /*
 476  * Configure PULL type for a GPIO pin on TWL4030
 477  */
 478 int twl4030_set_gpio_pull(int gpio, int pull_dircn)
 479 {
 480         u8 c_bnk = GET_GPIO_CTL_BANK(gpio);
 481         u8 c_off = GET_GPIO_CTL_OFF(gpio);
 482         u8 c_msk = 0;
 483         u8 reg = 0;
 484         u8 base = 0;
 485         int ret = 0;
 486
 487         if (unlikely((gpio >= TWL4030_GPIO_MAX) ||
 488                 !(gpio_usage_count & (0x1 << gpio))))
 489                 return -EPERM;
 490
 491         base = REG_GPIOPUPDCTR1 + c_bnk;
 492         if (pull_dircn == TWL4030_GPIO_PULL_DOWN)
 493                 c_msk = MASK_GPIOPUPDCTR1_GPIOxPD(c_off);
 494         else if (pull_dircn == TWL4030_GPIO_PULL_UP)
 495                 c_msk = MASK_GPIOPUPDCTR1_GPIOxPU(c_off);
 496
 497         mutex_lock(&gpio_lock);
 498         ret = gpio_twl4030_read(base);
 499         if (ret >= 0) {
 500                 /* clear the previous up/down values */
 501                 reg = (u8) (ret);
 502                 reg &= ~(MASK_GPIOPUPDCTR1_GPIOxPU(c_off) |
 503                         MASK_GPIOPUPDCTR1_GPIOxPD(c_off));
 504                 reg |= c_msk;
 505                 ret = gpio_twl4030_write(base, reg);
 506         }
 507         mutex_unlock(&gpio_lock);
 508         return ret;
 509 }
 510 #endif
 511
 512 static int twl4030_set_gpio_edge_ctrl(int gpio, int edge)
 513 {
 514         u8 c_bnk = GET_GPIO_CTL_BANK(gpio);
 515         u8 c_off = GET_GPIO_CTL_OFF(gpio);
 516         u8 c_msk = 0;
 517         u8 reg = 0;
 518         u8 base = 0;
 519         int ret = 0;
 520
 521         base = REG_GPIO_EDR1 + c_bnk;
 522
 523         if (edge & IRQ_TYPE_EDGE_RISING)
 524                 c_msk |= MASK_GPIO_EDR1_GPIOxRISING(c_off);
 525         if (edge & IRQ_TYPE_EDGE_FALLING)
 526                 c_msk |= MASK_GPIO_EDR1_GPIOxFALLING(c_off);
 527
 528         mutex_lock(&gpio_lock);
 529         ret = gpio_twl4030_read(base);
 530         if (ret >= 0) {
 531                 /* clear the previous rising/falling values */
 532                 reg = (u8) ret;
 533                 reg &= ~( MASK_GPIO_EDR1_GPIOxFALLING(c_off)
 534                         | MASK_GPIO_EDR1_GPIOxRISING(c_off));
 535                 reg |= c_msk;
 536                 ret = gpio_twl4030_write(base, reg);
 537         }
 538         mutex_unlock(&gpio_lock);
 539         return ret;
 540 }
 541
 542 /*
 543  * Configure debounce timing value for a GPIO pin on TWL4030
 544  */
 545 int twl4030_set_gpio_debounce(int gpio, int enable)
 546 {
 547         u8 d_bnk = GET_GPIO_DATA_BANK(gpio);
 548         u8 d_msk = MASK_GPIO_DEBEN_GPIOxDEB(GET_GPIO_DATA_OFF(gpio));
 549         u8 reg = 0;
 550         u8 base = 0;
 551         int ret = 0;
 552
 553         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 554                 || !(gpio_usage_count & (0x1 << gpio))))
 555                 return -EPERM;
 556
 557         base = REG_GPIO_DEBEN1 + d_bnk;
 558         mutex_lock(&gpio_lock);
 559         ret = gpio_twl4030_read(base);
 560         if (ret >= 0) {
 561                 if (enable)
 562                         reg = (u8) ((ret) | (d_msk));
 563                 else
 564                         reg = (u8) ((ret) & ~(d_msk));
 565
 566                 ret = gpio_twl4030_write(base, reg);
 567         }
 568         mutex_unlock(&gpio_lock);
 569         return ret;
 570 }
 571 EXPORT_SYMBOL(twl4030_set_gpio_debounce);
 572
 573 #if 0
 574 /*
 575  * Configure Card detect for GPIO pin on TWL4030
 576  */
 577 int twl4030_set_gpio_card_detect(int gpio, int enable)
 578 {
 579         u8 reg = 0;
 580         u8 msk = (1 << gpio);
 581         int ret = 0;
 582
 583         /* Only GPIO 0 or 1 can be used for CD feature.. */
 584         if (unlikely((gpio >= TWL4030_GPIO_MAX)
 585                 || !(gpio_usage_count & (0x1 << gpio))
 586                 || (gpio >= TWL4030_GPIO_MAX_CD))) {
 587                 return -EPERM;
 588         }
 589
 590         mutex_lock(&gpio_lock);
 591         ret = gpio_twl4030_read(REG_GPIO_CTRL);
 592         if (ret >= 0) {
 593                 if (enable)
 594                         reg = (u8) (ret | msk);
 595                 else
 596                         reg = (u8) (ret & ~msk);
 597
 598                 ret = gpio_twl4030_write(REG_GPIO_CTRL, reg);
 599         }
 600         mutex_unlock(&gpio_lock);
 601         return (ret);
 602 }
 603 #endif
 604
 605 /* MODULE FUNCTIONS */
 606
 607 /*
 608  * gpio_unmask_thread() runs as a kernel thread.  It is awakened by the unmask
 609  * method for the GPIO interrupts.  It unmasks all of the GPIO interrupts
 610  * specified in the gpio_pending_unmask bitmask.  We have to do the unmasking
 611  * in a kernel thread rather than directly in the unmask method because of the
 612  * need to access the TWL4030 via the I2C bus.  Note that we don't need to be
 613  * concerned about race conditions where the request to unmask a GPIO interrupt
 614  * has already been cancelled before this thread does the unmasking.  If a GPIO
 615  * interrupt is improperly unmasked, then the IRQ handler for it will mask it
 616  * when an interrupt occurs.
 617  */
 618 static int twl4030_gpio_unmask_thread(void *data)
 619 {
 620         current->flags |= PF_NOFREEZE;
 621
 622         while (!kthread_should_stop()) {
 623                 int irq;
 624                 unsigned int gpio_unmask;
 625                 unsigned int gpio_trigger;
 626
 627                 local_irq_disable();
 628                 gpio_unmask = gpio_pending_unmask;
 629                 gpio_pending_unmask = 0;
 630
 631                 gpio_trigger = gpio_pending_trigger;
 632                 gpio_pending_trigger = 0;
 633                 local_irq_enable();
 634
 635                 for (irq = twl4030_gpio_irq_base; 0 != gpio_unmask;
 636                                 gpio_unmask >>= 1, irq++) {
 637                         if (gpio_unmask & 0x1)
 638                                 twl4030_gpio_unmask(irq);
 639                 }
 640
 641                 for (irq = twl4030_gpio_irq_base;
 642                                 gpio_trigger;
 643                                 gpio_trigger >>= 1, irq++) {
 644                         struct irq_desc *desc;
 645                         unsigned type;
 646
 647                         if (!(gpio_trigger & 0x1))
 648                                 continue;
 649
 650                         desc = irq_desc + irq;
 651                         spin_lock_irq(&desc->lock);
 652                         type = desc->status & IRQ_TYPE_SENSE_MASK;
 653                         spin_unlock_irq(&desc->lock);
 654
 655                         twl4030_set_gpio_edge_ctrl(irq - twl4030_gpio_irq_base,
 656                                         type);
 657                 }
 658
 659                 local_irq_disable();
 660                 if (!gpio_pending_unmask && !gpio_pending_trigger)
 661                         set_current_state(TASK_INTERRUPTIBLE);
 662                 local_irq_enable();
 663
 664                 schedule();
 665         }
 666         set_current_state(TASK_RUNNING);
 667         return 0;
 668 }
 669
 670 /*
 671  * do_twl4030_gpio_irq() is the desc->handle method for each of the twl4030
 672  * gpio interrupts.  It executes in kernel thread context.
 673  * On entry, cpu interrupts are enabled.
 674  */
 675 static void do_twl4030_gpio_irq(unsigned int irq, irq_desc_t *desc)
 676 {
 677         struct irqaction *action;
 678         const unsigned int cpu = smp_processor_id();
 679
 680         desc->status |= IRQ_LEVEL;
 681
 682         /*
 683          * Acknowledge, clear _AND_ disable the interrupt.
 684          */
 685         twl4030_gpio_mask_and_ack(irq);
 686
 687         if (!desc->depth) {
 688                 kstat_cpu(cpu).irqs[irq]++;
 689
 690                 action = desc->action;
 691                 if (action) {
 692                         int ret;
 693                         int status = 0;
 694                         int retval = 0;
 695                         do {
 696                                 /* Call the ISR with cpu interrupts enabled. */
 697                                 ret = action->handler(irq, action->dev_id);
 698                                 if (ret == IRQ_HANDLED)
 699                                         status |= action->flags;
 700                                 retval |= ret;
 701                                 action = action->next;
 702                         } while (action);
 703
 704                         if (retval != IRQ_HANDLED)
 705                                 printk(KERN_ERR "ISR for TWL4030 GPIO"
 706                                         " irq %d can't handle interrupt\n",
 707                                         irq);
 708
 709                         if (!desc->depth)
 710                                 twl4030_gpio_unmask(irq);
 711                 }
 712         }
 713 }
 714
 715 /*
 716  * do_twl4030_gpio_module_irq() is the desc->handle method for the twl4030 gpio
 717  * module interrupt.  It executes in kernel thread context.
 718  * This is a chained interrupt, so there is no desc->action method for it.
 719  * We query the gpio module interrupt controller in the twl4030 to determine
 720  * which gpio lines are generating interrupt requests, and then call the
 721  * desc->handle method for each gpio that needs service.
 722  * On entry, cpu interrupts are disabled.
 723  */
 724 static void do_twl4030_gpio_module_irq(unsigned int irq, irq_desc_t *desc)
 725 {
 726         const unsigned int cpu = smp_processor_id();
 727
 728         desc->status |= IRQ_LEVEL;
 729         /*
 730         * The desc->handle method would normally call the desc->chip->ack
 731         * method here, but we won't bother since our ack method is NULL.
 732         */
 733         if (!desc->depth) {
 734                 int gpio_irq;
 735                 unsigned int gpio_isr;
 736
 737                 kstat_cpu(cpu).irqs[irq]++;
 738                 local_irq_enable();
 739
 740                 mutex_lock(&gpio_lock);
 741                 if (gpio_read_isr(&gpio_isr))
 742                         gpio_isr = 0;
 743                 mutex_unlock(&gpio_lock);
 744
 745                 for (gpio_irq = twl4030_gpio_irq_base; 0 != gpio_isr;
 746                         gpio_isr >>= 1, gpio_irq++) {
 747                         if (gpio_isr & 0x1) {
 748                                 irq_desc_t *d = irq_desc + gpio_irq;
 749                                 d->handle_irq(gpio_irq, d);
 750                         }
 751                 }
 752
 753                 local_irq_disable();
 754                 /*
 755                  * Here is where we should call the unmask method, but again we
 756                  * won't bother since it is NULL.
 757                  */
 758         }
 759 }
 760
 761 /*----------------------------------------------------------------------*/
 762
 763 static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
 764 {
 765         return twl4030_set_gpio_direction(offset, 1);
 766 }
 767
 768 static int twl_get(struct gpio_chip *chip, unsigned offset)
 769 {
 770         int status = twl4030_get_gpio_datain(offset);
 771
 772         return (status < 0) ? 0 : status;
 773 }
 774
 775 static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
 776 {
 777         twl4030_set_gpio_dataout(offset, value);
 778         return twl4030_set_gpio_direction(offset, 0);
 779 }
 780
 781 static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
 782 {
 783         twl4030_set_gpio_dataout(offset, value);
 784 }
 785
 786 static struct gpio_chip twl_gpiochip = {
 787         .label                  = "twl4030",
 788         .owner                  = THIS_MODULE,
 789         .direction_input        = twl_direction_in,
 790         .get                    = twl_get,
 791         .direction_output       = twl_direction_out,
 792         .set                    = twl_set,
 793         .can_sleep              = 1,
 794 };
 795
 796 /*----------------------------------------------------------------------*/
 797
 798 static int gpio_twl4030_remove(struct platform_device *pdev);
 799
 800 static int __devinit gpio_twl4030_probe(struct platform_device *pdev)
 801 {
 802         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
 803         int ret;
 804         int irq = 0;
 805
 806         /* All GPIO interrupts are initially masked */
 807         gpio_pending_unmask = 0;
 808         gpio_imr_shadow = GPIO_32_MASK;
 809         ret = gpio_write_imr(gpio_imr_shadow);
 810
 811         twl4030_gpio_irq_base = pdata->irq_base;
 812         twl4030_gpio_irq_end = pdata->irq_end;
 813
 814         if ((twl4030_gpio_irq_end - twl4030_gpio_irq_base) > 0) {
 815                 if (is_module()) {
 816                         dev_err(&pdev->dev,
 817                                 "can't dispatch IRQs from modules\n");
 818                         goto no_irqs;
 819                 }
 820                 if (twl4030_gpio_irq_end > NR_IRQS) {
 821                         dev_err(&pdev->dev,
 822                                 "last IRQ is too large: %d\n",
 823                                 twl4030_gpio_irq_end);
 824                         return -EINVAL;
 825                 }
 826         } else {
 827                 dev_notice(&pdev->dev,
 828                         "no IRQs being dispatched\n");
 829                 goto no_irqs;
 830         }
 831
 832         if (!ret) {
 833                 /*
 834                  * Create a kernel thread to handle deferred unmasking of gpio
 835                  * interrupts.
 836                  */
 837                 gpio_unmask_thread = kthread_create(twl4030_gpio_unmask_thread,
 838                         NULL, "twl4030 gpio");
 839                 if (!gpio_unmask_thread) {
 840                         dev_err(&pdev->dev,
 841                                 "could not create twl4030 gpio unmask"
 842                                 " thread!\n");
 843                         ret = -ENOMEM;
 844                 }
 845         }
 846
 847         if (!ret) {
 848                 /* install an irq handler for each of the gpio interrupts */
 849                 for (irq = twl4030_gpio_irq_base; irq < twl4030_gpio_irq_end;
 850                                 irq++) {
 851                         set_irq_chip(irq, &twl4030_gpio_irq_chip);
 852                         set_irq_handler(irq, do_twl4030_gpio_irq);
 853                         set_irq_flags(irq, IRQF_VALID);
 854                 }
 855
 856                 /* gpio module IRQ */
 857                 irq = platform_get_irq(pdev, 0);
 858
 859                 /*
 860                  * Install an irq handler to demultiplex the gpio module
 861                  * interrupt.
 862                  */
 863                 set_irq_chip(irq, &twl4030_gpio_module_irq_chip);
 864                 set_irq_chained_handler(irq, do_twl4030_gpio_module_irq);
 865                 wake_up_process(gpio_unmask_thread);
 866
 867                 dev_info(&pdev->dev, "IRQ %d chains IRQs %d..%d\n", irq,
 868                         twl4030_gpio_irq_base, twl4030_gpio_irq_end - 1);
 869         }
 870
 871 no_irqs:
 872         if (!ret) {
 873                 twl_gpiochip.base = pdata->gpio_base;
 874                 twl_gpiochip.ngpio = TWL4030_GPIO_MAX;
 875                 twl_gpiochip.dev = &pdev->dev;
 876
 877                 ret = gpiochip_add(&twl_gpiochip);
 878                 if (ret < 0) {
 879                         dev_err(&pdev->dev,
 880                                         "could not register gpiochip, %d\n",
 881                                         ret);
 882                         twl_gpiochip.ngpio = 0;
 883                         gpio_twl4030_remove(pdev);
 884                 } else if (pdata->setup) {
 885                         int status;
 886
 887                         status = pdata->setup(&pdev->dev,
 888                                         pdata->gpio_base, TWL4030_GPIO_MAX);
 889                         if (status)
 890                                 dev_dbg(&pdev->dev, "setup --> %d\n", status);
 891                 }
 892         }
 893
 894         return ret;
 895 }
 896
 897 static int __devexit gpio_twl4030_remove(struct platform_device *pdev)
 898 {
 899         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
 900         int status;
 901         int irq;
 902
 903         if (pdata->teardown) {
 904                 status = pdata->teardown(&pdev->dev,
 905                                 pdata->gpio_base, TWL4030_GPIO_MAX);
 906                 if (status) {
 907                         dev_dbg(&pdev->dev, "teardown --> %d\n", status);
 908                         return status;
 909                 }
 910         }
 911
 912         status = gpiochip_remove(&twl_gpiochip);
 913         if (status < 0)
 914                 return status;
 915
 916         if (is_module() || (twl4030_gpio_irq_end - twl4030_gpio_irq_base) <= 0)
 917                 return 0;
 918
 919         /* uninstall the gpio demultiplexing interrupt handler */
 920         irq = platform_get_irq(pdev, 0);
 921         set_irq_handler(irq, NULL);
 922         set_irq_flags(irq, 0);
 923
 924         /* uninstall the irq handler for each of the gpio interrupts */
 925         for (irq = twl4030_gpio_irq_base; irq < twl4030_gpio_irq_end; irq++) {
 926                 set_irq_handler(irq, NULL);
 927                 set_irq_flags(irq, 0);
 928         }
 929
 930         /* stop the gpio unmask kernel thread */
 931         if (gpio_unmask_thread) {
 932                 kthread_stop(gpio_unmask_thread);
 933                 gpio_unmask_thread = NULL;
 934         }
 935
 936         return 0;
 937 }
 938
 939 /* Note:  this hardware lives inside an I2C-based multi-function device. */
 940 MODULE_ALIAS("platform:twl4030_gpio");
 941
 942 static struct platform_driver gpio_twl4030_driver = {
 943         .driver.name    = "twl4030_gpio",
 944         .driver.owner   = THIS_MODULE,
 945         .probe          = gpio_twl4030_probe,
 946         .remove         = __devexit_p(gpio_twl4030_remove),
 947 };
 948
 949 static int __init gpio_twl4030_init(void)
 950 {
 951         return platform_driver_register(&gpio_twl4030_driver);
 952 }
 953 subsys_initcall(gpio_twl4030_init);
 954
 955 static void __exit gpio_twl4030_exit(void)
 956 {
 957         platform_driver_unregister(&gpio_twl4030_driver);
 958 }
 959 module_exit(gpio_twl4030_exit);
 960
 961 MODULE_AUTHOR("Texas Instruments, Inc.");
 962 MODULE_DESCRIPTION("GPIO interface for TWL4030");
 963 MODULE_LICENSE("GPL");