2 * 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/irqdomain.h>
38 #include <linux/i2c/twl.h>
42 * The GPIO "subchip" supports 18 GPIOs which can be configured as
43 * inputs or outputs, with pullups or pulldowns on each pin. Each
44 * GPIO can trigger interrupts on either or both edges.
46 * GPIO interrupts can be fed to either of two IRQ lines; this is
47 * intended to support multiple hosts.
49 * There are also two LED pins used sometimes as output-only GPIOs.
53 static struct gpio_chip twl_gpiochip
;
54 static int twl4030_gpio_base
;
55 static int twl4030_gpio_irq_base
;
57 /* genirq interfaces are not available to modules */
59 #define is_module() true
61 #define is_module() false
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)
69 /* Mask for GPIO registers when aggregated into a 32-bit integer */
70 #define GPIO_32_MASK 0x0003ffff
73 static DEFINE_MUTEX(gpio_lock
);
75 /* store usage of each GPIO. - each bit represents one GPIO */
76 static unsigned int gpio_usage_count
;
78 /*----------------------------------------------------------------------*/
81 * To configure TWL4030 GPIO module registers
83 static inline int gpio_twl4030_write(u8 address
, u8 data
)
85 return twl_i2c_write_u8(TWL4030_MODULE_GPIO
, data
, address
);
88 /*----------------------------------------------------------------------*/
91 * LED register offsets from TWL_MODULE_LED base
92 * PWMs A and B are dedicated to LEDs A and B, respectively.
95 #define TWL4030_LED_LEDEN_REG 0x00
96 #define TWL4030_PWMAON_REG 0x01
97 #define TWL4030_PWMAOFF_REG 0x02
98 #define TWL4030_PWMBON_REG 0x03
99 #define TWL4030_PWMBOFF_REG 0x04
102 #define LEDEN_LEDAON BIT(0)
103 #define LEDEN_LEDBON BIT(1)
104 #define LEDEN_LEDAEXT BIT(2)
105 #define LEDEN_LEDBEXT BIT(3)
106 #define LEDEN_LEDAPWM BIT(4)
107 #define LEDEN_LEDBPWM BIT(5)
108 #define LEDEN_PWM_LENGTHA BIT(6)
109 #define LEDEN_PWM_LENGTHB BIT(7)
111 #define PWMxON_LENGTH BIT(7)
113 /*----------------------------------------------------------------------*/
116 * To read a TWL4030 GPIO module register
118 static inline int gpio_twl4030_read(u8 address
)
123 ret
= twl_i2c_read_u8(TWL4030_MODULE_GPIO
, &data
, address
);
124 return (ret
< 0) ? ret
: data
;
127 /*----------------------------------------------------------------------*/
129 static u8 cached_leden
; /* protected by gpio_lock */
131 /* The LED lines are open drain outputs ... a FET pulls to GND, so an
132 * external pullup is needed. We could also expose the integrated PWM
133 * as a LED brightness control; we initialize it as "always on".
135 static void twl4030_led_set_value(int led
, int value
)
137 u8 mask
= LEDEN_LEDAON
| LEDEN_LEDAPWM
;
143 mutex_lock(&gpio_lock
);
145 cached_leden
&= ~mask
;
147 cached_leden
|= mask
;
148 status
= twl_i2c_write_u8(TWL4030_MODULE_LED
, cached_leden
,
149 TWL4030_LED_LEDEN_REG
);
150 mutex_unlock(&gpio_lock
);
153 static int twl4030_set_gpio_direction(int gpio
, int is_input
)
155 u8 d_bnk
= gpio
>> 3;
156 u8 d_msk
= BIT(gpio
& 0x7);
158 u8 base
= REG_GPIODATADIR1
+ d_bnk
;
161 mutex_lock(&gpio_lock
);
162 ret
= gpio_twl4030_read(base
);
169 ret
= gpio_twl4030_write(base
, reg
);
171 mutex_unlock(&gpio_lock
);
175 static int twl4030_set_gpio_dataout(int gpio
, int enable
)
177 u8 d_bnk
= gpio
>> 3;
178 u8 d_msk
= BIT(gpio
& 0x7);
182 base
= REG_SETGPIODATAOUT1
+ d_bnk
;
184 base
= REG_CLEARGPIODATAOUT1
+ d_bnk
;
186 return gpio_twl4030_write(base
, d_msk
);
189 static int twl4030_get_gpio_datain(int gpio
)
191 u8 d_bnk
= gpio
>> 3;
192 u8 d_off
= gpio
& 0x7;
196 if (unlikely((gpio
>= TWL4030_GPIO_MAX
)
197 || !(gpio_usage_count
& BIT(gpio
))))
200 base
= REG_GPIODATAIN1
+ d_bnk
;
201 ret
= gpio_twl4030_read(base
);
203 ret
= (ret
>> d_off
) & 0x1;
208 /*----------------------------------------------------------------------*/
210 static int twl_request(struct gpio_chip
*chip
, unsigned offset
)
214 mutex_lock(&gpio_lock
);
216 /* Support the two LED outputs as output-only GPIOs. */
217 if (offset
>= TWL4030_GPIO_MAX
) {
218 u8 ledclr_mask
= LEDEN_LEDAON
| LEDEN_LEDAEXT
219 | LEDEN_LEDAPWM
| LEDEN_PWM_LENGTHA
;
220 u8 reg
= TWL4030_PWMAON_REG
;
222 offset
-= TWL4030_GPIO_MAX
;
225 reg
= TWL4030_PWMBON_REG
;
228 /* initialize PWM to always-drive */
229 /* Configure PWM OFF register first */
230 status
= twl_i2c_write_u8(TWL4030_MODULE_LED
, 0x7f, reg
+ 1);
234 /* Followed by PWM ON register */
235 status
= twl_i2c_write_u8(TWL4030_MODULE_LED
, 0x7f, reg
);
239 /* init LED to not-driven (high) */
240 status
= twl_i2c_read_u8(TWL4030_MODULE_LED
, &cached_leden
,
241 TWL4030_LED_LEDEN_REG
);
244 cached_leden
&= ~ledclr_mask
;
245 status
= twl_i2c_write_u8(TWL4030_MODULE_LED
, cached_leden
,
246 TWL4030_LED_LEDEN_REG
);
254 /* on first use, turn GPIO module "on" */
255 if (!gpio_usage_count
) {
256 struct twl4030_gpio_platform_data
*pdata
;
257 u8 value
= MASK_GPIO_CTRL_GPIO_ON
;
259 /* optionally have the first two GPIOs switch vMMC1
260 * and vMMC2 power supplies based on card presence.
262 pdata
= chip
->dev
->platform_data
;
264 value
|= pdata
->mmc_cd
& 0x03;
266 status
= gpio_twl4030_write(REG_GPIO_CTRL
, value
);
270 gpio_usage_count
|= (0x1 << offset
);
273 mutex_unlock(&gpio_lock
);
277 static void twl_free(struct gpio_chip
*chip
, unsigned offset
)
279 if (offset
>= TWL4030_GPIO_MAX
) {
280 twl4030_led_set_value(offset
- TWL4030_GPIO_MAX
, 1);
284 mutex_lock(&gpio_lock
);
286 gpio_usage_count
&= ~BIT(offset
);
288 /* on last use, switch off GPIO module */
289 if (!gpio_usage_count
)
290 gpio_twl4030_write(REG_GPIO_CTRL
, 0x0);
292 mutex_unlock(&gpio_lock
);
295 static int twl_direction_in(struct gpio_chip
*chip
, unsigned offset
)
297 return (offset
< TWL4030_GPIO_MAX
)
298 ? twl4030_set_gpio_direction(offset
, 1)
302 static int twl_get(struct gpio_chip
*chip
, unsigned offset
)
306 if (offset
< TWL4030_GPIO_MAX
)
307 status
= twl4030_get_gpio_datain(offset
);
308 else if (offset
== TWL4030_GPIO_MAX
)
309 status
= cached_leden
& LEDEN_LEDAON
;
311 status
= cached_leden
& LEDEN_LEDBON
;
312 return (status
< 0) ? 0 : status
;
315 static int twl_direction_out(struct gpio_chip
*chip
, unsigned offset
, int value
)
317 if (offset
< TWL4030_GPIO_MAX
) {
318 twl4030_set_gpio_dataout(offset
, value
);
319 return twl4030_set_gpio_direction(offset
, 0);
321 twl4030_led_set_value(offset
- TWL4030_GPIO_MAX
, value
);
326 static void twl_set(struct gpio_chip
*chip
, unsigned offset
, int value
)
328 if (offset
< TWL4030_GPIO_MAX
)
329 twl4030_set_gpio_dataout(offset
, value
);
331 twl4030_led_set_value(offset
- TWL4030_GPIO_MAX
, value
);
334 static int twl_to_irq(struct gpio_chip
*chip
, unsigned offset
)
336 return (twl4030_gpio_irq_base
&& (offset
< TWL4030_GPIO_MAX
))
337 ? (twl4030_gpio_irq_base
+ offset
)
341 static struct gpio_chip twl_gpiochip
= {
343 .owner
= THIS_MODULE
,
344 .request
= twl_request
,
346 .direction_input
= twl_direction_in
,
348 .direction_output
= twl_direction_out
,
350 .to_irq
= twl_to_irq
,
354 /*----------------------------------------------------------------------*/
356 static int gpio_twl4030_pulls(u32 ups
, u32 downs
)
359 unsigned i
, gpio_bit
;
361 /* For most pins, a pulldown was enabled by default.
362 * We should have data that's specific to this board.
364 for (gpio_bit
= 1, i
= 0; i
< 5; i
++) {
368 for (bit_mask
= 0, j
= 0; j
< 8; j
+= 2, gpio_bit
<<= 1) {
370 bit_mask
|= 1 << (j
+ 1);
371 else if (downs
& gpio_bit
)
372 bit_mask
|= 1 << (j
+ 0);
374 message
[i
] = bit_mask
;
377 return twl_i2c_write(TWL4030_MODULE_GPIO
, message
,
378 REG_GPIOPUPDCTR1
, 5);
381 static int gpio_twl4030_debounce(u32 debounce
, u8 mmc_cd
)
385 /* 30 msec of debouncing is always used for MMC card detect,
386 * and is optional for everything else.
388 message
[0] = (debounce
& 0xff) | (mmc_cd
& 0x03);
390 message
[1] = (debounce
& 0xff);
392 message
[2] = (debounce
& 0x03);
394 return twl_i2c_write(TWL4030_MODULE_GPIO
, message
,
398 static int gpio_twl4030_remove(struct platform_device
*pdev
);
400 static struct twl4030_gpio_platform_data
*of_gpio_twl4030(struct device
*dev
)
402 struct twl4030_gpio_platform_data
*omap_twl_info
;
404 omap_twl_info
= devm_kzalloc(dev
, sizeof(*omap_twl_info
), GFP_KERNEL
);
408 omap_twl_info
->use_leds
= of_property_read_bool(dev
->of_node
,
411 of_property_read_u32(dev
->of_node
, "ti,debounce",
412 &omap_twl_info
->debounce
);
413 of_property_read_u32(dev
->of_node
, "ti,mmc-cd",
414 (u32
*)&omap_twl_info
->mmc_cd
);
415 of_property_read_u32(dev
->of_node
, "ti,pullups",
416 &omap_twl_info
->pullups
);
417 of_property_read_u32(dev
->of_node
, "ti,pulldowns",
418 &omap_twl_info
->pulldowns
);
420 return omap_twl_info
;
423 static int gpio_twl4030_probe(struct platform_device
*pdev
)
425 struct twl4030_gpio_platform_data
*pdata
= pdev
->dev
.platform_data
;
426 struct device_node
*node
= pdev
->dev
.of_node
;
429 /* maybe setup IRQs */
431 dev_err(&pdev
->dev
, "can't dispatch IRQs from modules\n");
435 irq_base
= irq_alloc_descs(-1, 0, TWL4030_GPIO_MAX
, 0);
437 dev_err(&pdev
->dev
, "Failed to alloc irq_descs\n");
441 irq_domain_add_legacy(node
, TWL4030_GPIO_MAX
, irq_base
, 0,
442 &irq_domain_simple_ops
, NULL
);
444 ret
= twl4030_sih_setup(&pdev
->dev
, TWL4030_MODULE_GPIO
, irq_base
);
448 twl4030_gpio_irq_base
= irq_base
;
451 twl_gpiochip
.base
= -1;
452 twl_gpiochip
.ngpio
= TWL4030_GPIO_MAX
;
453 twl_gpiochip
.dev
= &pdev
->dev
;
456 pdata
= of_gpio_twl4030(&pdev
->dev
);
459 dev_err(&pdev
->dev
, "Platform data is missing\n");
464 * NOTE: boards may waste power if they don't set pullups
465 * and pulldowns correctly ... default for non-ULPI pins is
466 * pulldown, and some other pins may have external pullups
467 * or pulldowns. Careful!
469 ret
= gpio_twl4030_pulls(pdata
->pullups
, pdata
->pulldowns
);
471 dev_dbg(&pdev
->dev
, "pullups %.05x %.05x --> %d\n",
472 pdata
->pullups
, pdata
->pulldowns
, ret
);
474 ret
= gpio_twl4030_debounce(pdata
->debounce
, pdata
->mmc_cd
);
476 dev_dbg(&pdev
->dev
, "debounce %.03x %.01x --> %d\n",
477 pdata
->debounce
, pdata
->mmc_cd
, ret
);
480 * NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
481 * is (still) clear if use_leds is set.
484 twl_gpiochip
.ngpio
+= 2;
486 ret
= gpiochip_add(&twl_gpiochip
);
488 dev_err(&pdev
->dev
, "could not register gpiochip, %d\n", ret
);
489 twl_gpiochip
.ngpio
= 0;
490 gpio_twl4030_remove(pdev
);
494 twl4030_gpio_base
= twl_gpiochip
.base
;
496 if (pdata
&& pdata
->setup
) {
499 status
= pdata
->setup(&pdev
->dev
,
500 twl4030_gpio_base
, TWL4030_GPIO_MAX
);
502 dev_dbg(&pdev
->dev
, "setup --> %d\n", status
);
509 /* Cannot use as gpio_twl4030_probe() calls us */
510 static int gpio_twl4030_remove(struct platform_device
*pdev
)
512 struct twl4030_gpio_platform_data
*pdata
= pdev
->dev
.platform_data
;
515 if (pdata
&& pdata
->teardown
) {
516 status
= pdata
->teardown(&pdev
->dev
,
517 twl4030_gpio_base
, TWL4030_GPIO_MAX
);
519 dev_dbg(&pdev
->dev
, "teardown --> %d\n", status
);
524 status
= gpiochip_remove(&twl_gpiochip
);
531 /* REVISIT no support yet for deregistering all the IRQs */
536 static const struct of_device_id twl_gpio_match
[] = {
537 { .compatible
= "ti,twl4030-gpio", },
540 MODULE_DEVICE_TABLE(of
, twl_gpio_match
);
542 /* Note: this hardware lives inside an I2C-based multi-function device. */
543 MODULE_ALIAS("platform:twl4030_gpio");
545 static struct platform_driver gpio_twl4030_driver
= {
547 .name
= "twl4030_gpio",
548 .owner
= THIS_MODULE
,
549 .of_match_table
= of_match_ptr(twl_gpio_match
),
551 .probe
= gpio_twl4030_probe
,
552 .remove
= gpio_twl4030_remove
,
555 static int __init
gpio_twl4030_init(void)
557 return platform_driver_register(&gpio_twl4030_driver
);
559 subsys_initcall(gpio_twl4030_init
);
561 static void __exit
gpio_twl4030_exit(void)
563 platform_driver_unregister(&gpio_twl4030_driver
);
565 module_exit(gpio_twl4030_exit
);
567 MODULE_AUTHOR("Texas Instruments, Inc.");
568 MODULE_DESCRIPTION("GPIO interface for TWL4030");
569 MODULE_LICENSE("GPL");