2
* twl4030_gpio.c -- access to GPIOs on TWL4030/TPS659x0 chips
4
* Copyright (C) 2006-2007 Texas Instruments, Inc.
5
* Copyright (C) 2006 MontaVista Software, Inc.
7
* Code re-arranged and cleaned up by:
8
* Syed Mohammed Khasim <x0khasim@ti.com>
11
* Andy Lowe / Nishanth Menon
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.
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.
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
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>
36
#include <linux/i2c/twl.h>
40
* The GPIO "subchip" supports 18 GPIOs which can be configured as
41
* inputs or outputs, with pullups or pulldowns on each pin. Each
42
* GPIO can trigger interrupts on either or both edges.
44
* GPIO interrupts can be fed to either of two IRQ lines; this is
45
* intended to support multiple hosts.
47
* There are also two LED pins used sometimes as output-only GPIOs.
51
static struct gpio_chip twl_gpiochip;
52
static int twl4030_gpio_irq_base;
54
/* genirq interfaces are not available to modules */
56
#define is_module() true
58
#define is_module() false
61
/* GPIO_CTRL Fields */
62
#define MASK_GPIO_CTRL_GPIO0CD1 BIT(0)
63
#define MASK_GPIO_CTRL_GPIO1CD2 BIT(1)
64
#define MASK_GPIO_CTRL_GPIO_ON BIT(2)
66
/* Mask for GPIO registers when aggregated into a 32-bit integer */
67
#define GPIO_32_MASK 0x0003ffff
70
static DEFINE_MUTEX(gpio_lock);
72
/* store usage of each GPIO. - each bit represents one GPIO */
73
static unsigned int gpio_usage_count;
75
/*----------------------------------------------------------------------*/
78
* To configure TWL4030 GPIO module registers
80
static inline int gpio_twl4030_write(u8 address, u8 data)
82
return twl_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
85
/*----------------------------------------------------------------------*/
88
* LED register offsets (use TWL4030_MODULE_{LED,PWMA,PWMB}))
89
* PWMs A and B are dedicated to LEDs A and B, respectively.
92
#define TWL4030_LED_LEDEN 0x0
95
#define LEDEN_LEDAON BIT(0)
96
#define LEDEN_LEDBON BIT(1)
97
#define LEDEN_LEDAEXT BIT(2)
98
#define LEDEN_LEDBEXT BIT(3)
99
#define LEDEN_LEDAPWM BIT(4)
100
#define LEDEN_LEDBPWM BIT(5)
101
#define LEDEN_PWM_LENGTHA BIT(6)
102
#define LEDEN_PWM_LENGTHB BIT(7)
104
#define TWL4030_PWMx_PWMxON 0x0
105
#define TWL4030_PWMx_PWMxOFF 0x1
107
#define PWMxON_LENGTH BIT(7)
109
/*----------------------------------------------------------------------*/
112
* To read a TWL4030 GPIO module register
114
static inline int gpio_twl4030_read(u8 address)
119
ret = twl_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
120
return (ret < 0) ? ret : data;
123
/*----------------------------------------------------------------------*/
125
static u8 cached_leden; /* protected by gpio_lock */
127
/* The LED lines are open drain outputs ... a FET pulls to GND, so an
128
* external pullup is needed. We could also expose the integrated PWM
129
* as a LED brightness control; we initialize it as "always on".
131
static void twl4030_led_set_value(int led, int value)
133
u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;
139
mutex_lock(&gpio_lock);
141
cached_leden &= ~mask;
143
cached_leden |= mask;
144
status = twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
146
mutex_unlock(&gpio_lock);
149
static int twl4030_set_gpio_direction(int gpio, int is_input)
151
u8 d_bnk = gpio >> 3;
152
u8 d_msk = BIT(gpio & 0x7);
154
u8 base = REG_GPIODATADIR1 + d_bnk;
157
mutex_lock(&gpio_lock);
158
ret = gpio_twl4030_read(base);
165
ret = gpio_twl4030_write(base, reg);
167
mutex_unlock(&gpio_lock);
171
static int twl4030_set_gpio_dataout(int gpio, int enable)
173
u8 d_bnk = gpio >> 3;
174
u8 d_msk = BIT(gpio & 0x7);
178
base = REG_SETGPIODATAOUT1 + d_bnk;
180
base = REG_CLEARGPIODATAOUT1 + d_bnk;
182
return gpio_twl4030_write(base, d_msk);
185
static int twl4030_get_gpio_datain(int gpio)
187
u8 d_bnk = gpio >> 3;
188
u8 d_off = gpio & 0x7;
192
if (unlikely((gpio >= TWL4030_GPIO_MAX)
193
|| !(gpio_usage_count & BIT(gpio))))
196
base = REG_GPIODATAIN1 + d_bnk;
197
ret = gpio_twl4030_read(base);
199
ret = (ret >> d_off) & 0x1;
204
/*----------------------------------------------------------------------*/
206
static int twl_request(struct gpio_chip *chip, unsigned offset)
210
mutex_lock(&gpio_lock);
212
/* Support the two LED outputs as output-only GPIOs. */
213
if (offset >= TWL4030_GPIO_MAX) {
214
u8 ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
215
| LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
216
u8 module = TWL4030_MODULE_PWMA;
218
offset -= TWL4030_GPIO_MAX;
221
module = TWL4030_MODULE_PWMB;
224
/* initialize PWM to always-drive */
225
status = twl_i2c_write_u8(module, 0x7f,
226
TWL4030_PWMx_PWMxOFF);
229
status = twl_i2c_write_u8(module, 0x7f,
230
TWL4030_PWMx_PWMxON);
234
/* init LED to not-driven (high) */
235
module = TWL4030_MODULE_LED;
236
status = twl_i2c_read_u8(module, &cached_leden,
240
cached_leden &= ~ledclr_mask;
241
status = twl_i2c_write_u8(module, cached_leden,
250
/* on first use, turn GPIO module "on" */
251
if (!gpio_usage_count) {
252
struct twl4030_gpio_platform_data *pdata;
253
u8 value = MASK_GPIO_CTRL_GPIO_ON;
255
/* optionally have the first two GPIOs switch vMMC1
256
* and vMMC2 power supplies based on card presence.
258
pdata = chip->dev->platform_data;
259
value |= pdata->mmc_cd & 0x03;
261
status = gpio_twl4030_write(REG_GPIO_CTRL, value);
265
gpio_usage_count |= (0x1 << offset);
268
mutex_unlock(&gpio_lock);
272
static void twl_free(struct gpio_chip *chip, unsigned offset)
274
if (offset >= TWL4030_GPIO_MAX) {
275
twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
279
mutex_lock(&gpio_lock);
281
gpio_usage_count &= ~BIT(offset);
283
/* on last use, switch off GPIO module */
284
if (!gpio_usage_count)
285
gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
287
mutex_unlock(&gpio_lock);
290
static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
292
return (offset < TWL4030_GPIO_MAX)
293
? twl4030_set_gpio_direction(offset, 1)
297
static int twl_get(struct gpio_chip *chip, unsigned offset)
301
if (offset < TWL4030_GPIO_MAX)
302
status = twl4030_get_gpio_datain(offset);
303
else if (offset == TWL4030_GPIO_MAX)
304
status = cached_leden & LEDEN_LEDAON;
306
status = cached_leden & LEDEN_LEDBON;
307
return (status < 0) ? 0 : status;
310
static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
312
if (offset < TWL4030_GPIO_MAX) {
313
twl4030_set_gpio_dataout(offset, value);
314
return twl4030_set_gpio_direction(offset, 0);
316
twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
321
static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
323
if (offset < TWL4030_GPIO_MAX)
324
twl4030_set_gpio_dataout(offset, value);
326
twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
329
static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
331
return (twl4030_gpio_irq_base && (offset < TWL4030_GPIO_MAX))
332
? (twl4030_gpio_irq_base + offset)
336
static struct gpio_chip twl_gpiochip = {
338
.owner = THIS_MODULE,
339
.request = twl_request,
341
.direction_input = twl_direction_in,
343
.direction_output = twl_direction_out,
345
.to_irq = twl_to_irq,
349
/*----------------------------------------------------------------------*/
351
static int __devinit gpio_twl4030_pulls(u32 ups, u32 downs)
354
unsigned i, gpio_bit;
356
/* For most pins, a pulldown was enabled by default.
357
* We should have data that's specific to this board.
359
for (gpio_bit = 1, i = 1; i < 6; i++) {
363
for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
365
bit_mask |= 1 << (j + 1);
366
else if (downs & gpio_bit)
367
bit_mask |= 1 << (j + 0);
369
message[i] = bit_mask;
372
return twl_i2c_write(TWL4030_MODULE_GPIO, message,
373
REG_GPIOPUPDCTR1, 5);
376
static int __devinit gpio_twl4030_debounce(u32 debounce, u8 mmc_cd)
380
/* 30 msec of debouncing is always used for MMC card detect,
381
* and is optional for everything else.
383
message[1] = (debounce & 0xff) | (mmc_cd & 0x03);
385
message[2] = (debounce & 0xff);
387
message[3] = (debounce & 0x03);
389
return twl_i2c_write(TWL4030_MODULE_GPIO, message,
393
static int gpio_twl4030_remove(struct platform_device *pdev);
395
static int __devinit gpio_twl4030_probe(struct platform_device *pdev)
397
struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
400
/* maybe setup IRQs */
401
if (pdata->irq_base) {
404
"can't dispatch IRQs from modules\n");
407
ret = twl4030_sih_setup(TWL4030_MODULE_GPIO);
410
WARN_ON(ret != pdata->irq_base);
411
twl4030_gpio_irq_base = ret;
416
* NOTE: boards may waste power if they don't set pullups
417
* and pulldowns correctly ... default for non-ULPI pins is
418
* pulldown, and some other pins may have external pullups
419
* or pulldowns. Careful!
421
ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
423
dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
424
pdata->pullups, pdata->pulldowns,
427
ret = gpio_twl4030_debounce(pdata->debounce, pdata->mmc_cd);
429
dev_dbg(&pdev->dev, "debounce %.03x %.01x --> %d\n",
430
pdata->debounce, pdata->mmc_cd,
433
twl_gpiochip.base = pdata->gpio_base;
434
twl_gpiochip.ngpio = TWL4030_GPIO_MAX;
435
twl_gpiochip.dev = &pdev->dev;
437
/* NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
438
* is (still) clear if use_leds is set.
441
twl_gpiochip.ngpio += 2;
443
ret = gpiochip_add(&twl_gpiochip);
446
"could not register gpiochip, %d\n",
448
twl_gpiochip.ngpio = 0;
449
gpio_twl4030_remove(pdev);
450
} else if (pdata->setup) {
453
status = pdata->setup(&pdev->dev,
454
pdata->gpio_base, TWL4030_GPIO_MAX);
456
dev_dbg(&pdev->dev, "setup --> %d\n", status);
462
/* Cannot use __devexit as gpio_twl4030_probe() calls us */
463
static int gpio_twl4030_remove(struct platform_device *pdev)
465
struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
468
if (pdata->teardown) {
469
status = pdata->teardown(&pdev->dev,
470
pdata->gpio_base, TWL4030_GPIO_MAX);
472
dev_dbg(&pdev->dev, "teardown --> %d\n", status);
477
status = gpiochip_remove(&twl_gpiochip);
484
/* REVISIT no support yet for deregistering all the IRQs */
489
/* Note: this hardware lives inside an I2C-based multi-function device. */
490
MODULE_ALIAS("platform:twl4030_gpio");
492
static struct platform_driver gpio_twl4030_driver = {
493
.driver.name = "twl4030_gpio",
494
.driver.owner = THIS_MODULE,
495
.probe = gpio_twl4030_probe,
496
.remove = gpio_twl4030_remove,
499
static int __init gpio_twl4030_init(void)
501
return platform_driver_register(&gpio_twl4030_driver);
503
subsys_initcall(gpio_twl4030_init);
505
static void __exit gpio_twl4030_exit(void)
507
platform_driver_unregister(&gpio_twl4030_driver);
509
module_exit(gpio_twl4030_exit);
511
MODULE_AUTHOR("Texas Instruments, Inc.");
512
MODULE_DESCRIPTION("GPIO interface for TWL4030");
513
MODULE_LICENSE("GPL");