Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6] / 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
51
52 static struct gpio_chip twl_gpiochip;
53 static int twl4030_gpio_irq_base;
54
55 /* genirq interfaces are not available to modules */
56 #ifdef MODULE
57 #define is_module()     true
58 #else
59 #define is_module()     false
60 #endif
61
62 /* GPIO_CTRL Fields */
63 #define MASK_GPIO_CTRL_GPIO0CD1         BIT(0)
64 #define MASK_GPIO_CTRL_GPIO1CD2         BIT(1)
65 #define MASK_GPIO_CTRL_GPIO_ON          BIT(2)
66
67 /* Mask for GPIO registers when aggregated into a 32-bit integer */
68 #define GPIO_32_MASK                    0x0003ffff
69
70 /* Data structures */
71 static DEFINE_MUTEX(gpio_lock);
72
73 /* store usage of each GPIO. - each bit represents one GPIO */
74 static unsigned int gpio_usage_count;
75
76 /*----------------------------------------------------------------------*/
77
78 /*
79  * To configure TWL4030 GPIO module registers
80  */
81 static inline int gpio_twl4030_write(u8 address, u8 data)
82 {
83         return twl4030_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
84 }
85
86 /*----------------------------------------------------------------------*/
87
88 /*
89  * LED register offsets (use TWL4030_MODULE_{LED,PWMA,PWMB}))
90  * PWMs A and B are dedicated to LEDs A and B, respectively.
91  */
92
93 #define TWL4030_LED_LEDEN       0x0
94
95 /* LEDEN bits */
96 #define LEDEN_LEDAON            BIT(0)
97 #define LEDEN_LEDBON            BIT(1)
98 #define LEDEN_LEDAEXT           BIT(2)
99 #define LEDEN_LEDBEXT           BIT(3)
100 #define LEDEN_LEDAPWM           BIT(4)
101 #define LEDEN_LEDBPWM           BIT(5)
102 #define LEDEN_PWM_LENGTHA       BIT(6)
103 #define LEDEN_PWM_LENGTHB       BIT(7)
104
105 #define TWL4030_PWMx_PWMxON     0x0
106 #define TWL4030_PWMx_PWMxOFF    0x1
107
108 #define PWMxON_LENGTH           BIT(7)
109
110 /*----------------------------------------------------------------------*/
111
112 /*
113  * To read a TWL4030 GPIO module register
114  */
115 static inline int gpio_twl4030_read(u8 address)
116 {
117         u8 data;
118         int ret = 0;
119
120         ret = twl4030_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
121         return (ret < 0) ? ret : data;
122 }
123
124 /*----------------------------------------------------------------------*/
125
126 static u8 cached_leden;         /* protected by gpio_lock */
127
128 /* The LED lines are open drain outputs ... a FET pulls to GND, so an
129  * external pullup is needed.  We could also expose the integrated PWM
130  * as a LED brightness control; we initialize it as "always on".
131  */
132 static void twl4030_led_set_value(int led, int value)
133 {
134         u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;
135         int status;
136
137         if (led)
138                 mask <<= 1;
139
140         mutex_lock(&gpio_lock);
141         if (value)
142                 cached_leden &= ~mask;
143         else
144                 cached_leden |= mask;
145         status = twl4030_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
146                         TWL4030_LED_LEDEN);
147         mutex_unlock(&gpio_lock);
148 }
149
150 static int twl4030_set_gpio_direction(int gpio, int is_input)
151 {
152         u8 d_bnk = gpio >> 3;
153         u8 d_msk = BIT(gpio & 0x7);
154         u8 reg = 0;
155         u8 base = REG_GPIODATADIR1 + d_bnk;
156         int ret = 0;
157
158         mutex_lock(&gpio_lock);
159         ret = gpio_twl4030_read(base);
160         if (ret >= 0) {
161                 if (is_input)
162                         reg = ret & ~d_msk;
163                 else
164                         reg = ret | d_msk;
165
166                 ret = gpio_twl4030_write(base, reg);
167         }
168         mutex_unlock(&gpio_lock);
169         return ret;
170 }
171
172 static int twl4030_set_gpio_dataout(int gpio, int enable)
173 {
174         u8 d_bnk = gpio >> 3;
175         u8 d_msk = BIT(gpio & 0x7);
176         u8 base = 0;
177
178         if (enable)
179                 base = REG_SETGPIODATAOUT1 + d_bnk;
180         else
181                 base = REG_CLEARGPIODATAOUT1 + d_bnk;
182
183         return gpio_twl4030_write(base, d_msk);
184 }
185
186 static int twl4030_get_gpio_datain(int gpio)
187 {
188         u8 d_bnk = gpio >> 3;
189         u8 d_off = gpio & 0x7;
190         u8 base = 0;
191         int ret = 0;
192
193         if (unlikely((gpio >= TWL4030_GPIO_MAX)
194                 || !(gpio_usage_count & BIT(gpio))))
195                 return -EPERM;
196
197         base = REG_GPIODATAIN1 + d_bnk;
198         ret = gpio_twl4030_read(base);
199         if (ret > 0)
200                 ret = (ret >> d_off) & 0x1;
201
202         return ret;
203 }
204
205 /*
206  * Configure debounce timing value for a GPIO pin on TWL4030
207  */
208 int twl4030_set_gpio_debounce(int gpio, int enable)
209 {
210         u8 d_bnk = gpio >> 3;
211         u8 d_msk = BIT(gpio & 0x7);
212         u8 reg = 0;
213         u8 base = 0;
214         int ret = 0;
215
216         if (unlikely((gpio >= TWL4030_GPIO_MAX)
217                 || !(gpio_usage_count & BIT(gpio))))
218                 return -EPERM;
219
220         base = REG_GPIO_DEBEN1 + d_bnk;
221         mutex_lock(&gpio_lock);
222         ret = gpio_twl4030_read(base);
223         if (ret >= 0) {
224                 if (enable)
225                         reg = ret | d_msk;
226                 else
227                         reg = ret & ~d_msk;
228
229                 ret = gpio_twl4030_write(base, reg);
230         }
231         mutex_unlock(&gpio_lock);
232         return ret;
233 }
234 EXPORT_SYMBOL(twl4030_set_gpio_debounce);
235
236 /*----------------------------------------------------------------------*/
237
238 static int twl_request(struct gpio_chip *chip, unsigned offset)
239 {
240         int status = 0;
241
242         mutex_lock(&gpio_lock);
243
244         /* Support the two LED outputs as output-only GPIOs. */
245         if (offset >= TWL4030_GPIO_MAX) {
246                 u8      ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
247                                 | LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
248                 u8      module = TWL4030_MODULE_PWMA;
249
250                 offset -= TWL4030_GPIO_MAX;
251                 if (offset) {
252                         ledclr_mask <<= 1;
253                         module = TWL4030_MODULE_PWMB;
254                 }
255
256                 /* initialize PWM to always-drive */
257                 status = twl4030_i2c_write_u8(module, 0x7f,
258                                 TWL4030_PWMx_PWMxOFF);
259                 if (status < 0)
260                         goto done;
261                 status = twl4030_i2c_write_u8(module, 0x7f,
262                                 TWL4030_PWMx_PWMxON);
263                 if (status < 0)
264                         goto done;
265
266                 /* init LED to not-driven (high) */
267                 module = TWL4030_MODULE_LED;
268                 status = twl4030_i2c_read_u8(module, &cached_leden,
269                                 TWL4030_LED_LEDEN);
270                 if (status < 0)
271                         goto done;
272                 cached_leden &= ~ledclr_mask;
273                 status = twl4030_i2c_write_u8(module, cached_leden,
274                                 TWL4030_LED_LEDEN);
275                 if (status < 0)
276                         goto done;
277
278                 status = 0;
279                 goto done;
280         }
281
282         /* on first use, turn GPIO module "on" */
283         if (!gpio_usage_count) {
284                 struct twl4030_gpio_platform_data *pdata;
285                 u8 value = MASK_GPIO_CTRL_GPIO_ON;
286
287                 /* optionally have the first two GPIOs switch vMMC1
288                  * and vMMC2 power supplies based on card presence.
289                  */
290                 pdata = chip->dev->platform_data;
291                 value |= pdata->mmc_cd & 0x03;
292
293                 status = gpio_twl4030_write(REG_GPIO_CTRL, value);
294         }
295
296         if (!status)
297                 gpio_usage_count |= (0x1 << offset);
298
299 done:
300         mutex_unlock(&gpio_lock);
301         return status;
302 }
303
304 static void twl_free(struct gpio_chip *chip, unsigned offset)
305 {
306         if (offset >= TWL4030_GPIO_MAX) {
307                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
308                 return;
309         }
310
311         mutex_lock(&gpio_lock);
312
313         gpio_usage_count &= ~BIT(offset);
314
315         /* on last use, switch off GPIO module */
316         if (!gpio_usage_count)
317                 gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
318
319         mutex_unlock(&gpio_lock);
320 }
321
322 static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
323 {
324         return (offset < TWL4030_GPIO_MAX)
325                 ? twl4030_set_gpio_direction(offset, 1)
326                 : -EINVAL;
327 }
328
329 static int twl_get(struct gpio_chip *chip, unsigned offset)
330 {
331         int status = 0;
332
333         if (offset < TWL4030_GPIO_MAX)
334                 status = twl4030_get_gpio_datain(offset);
335         else if (offset == TWL4030_GPIO_MAX)
336                 status = cached_leden & LEDEN_LEDAON;
337         else
338                 status = cached_leden & LEDEN_LEDBON;
339         return (status < 0) ? 0 : status;
340 }
341
342 static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
343 {
344         if (offset < TWL4030_GPIO_MAX) {
345                 twl4030_set_gpio_dataout(offset, value);
346                 return twl4030_set_gpio_direction(offset, 0);
347         } else {
348                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
349                 return 0;
350         }
351 }
352
353 static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
354 {
355         if (offset < TWL4030_GPIO_MAX)
356                 twl4030_set_gpio_dataout(offset, value);
357         else
358                 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
359 }
360
361 static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
362 {
363         return (twl4030_gpio_irq_base && (offset < TWL4030_GPIO_MAX))
364                 ? (twl4030_gpio_irq_base + offset)
365                 : -EINVAL;
366 }
367
368 static struct gpio_chip twl_gpiochip = {
369         .label                  = "twl4030",
370         .owner                  = THIS_MODULE,
371         .request                = twl_request,
372         .free                   = twl_free,
373         .direction_input        = twl_direction_in,
374         .get                    = twl_get,
375         .direction_output       = twl_direction_out,
376         .set                    = twl_set,
377         .to_irq                 = twl_to_irq,
378         .can_sleep              = 1,
379 };
380
381 /*----------------------------------------------------------------------*/
382
383 static int __devinit gpio_twl4030_pulls(u32 ups, u32 downs)
384 {
385         u8              message[6];
386         unsigned        i, gpio_bit;
387
388         /* For most pins, a pulldown was enabled by default.
389          * We should have data that's specific to this board.
390          */
391         for (gpio_bit = 1, i = 1; i < 6; i++) {
392                 u8              bit_mask;
393                 unsigned        j;
394
395                 for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
396                         if (ups & gpio_bit)
397                                 bit_mask |= 1 << (j + 1);
398                         else if (downs & gpio_bit)
399                                 bit_mask |= 1 << (j + 0);
400                 }
401                 message[i] = bit_mask;
402         }
403
404         return twl4030_i2c_write(TWL4030_MODULE_GPIO, message,
405                                 REG_GPIOPUPDCTR1, 5);
406 }
407
408 static int gpio_twl4030_remove(struct platform_device *pdev);
409
410 static int __devinit gpio_twl4030_probe(struct platform_device *pdev)
411 {
412         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
413         int ret;
414
415         /* maybe setup IRQs */
416         if (pdata->irq_base) {
417                 if (is_module()) {
418                         dev_err(&pdev->dev,
419                                 "can't dispatch IRQs from modules\n");
420                         goto no_irqs;
421                 }
422                 ret = twl4030_sih_setup(TWL4030_MODULE_GPIO);
423                 if (ret < 0)
424                         return ret;
425                 WARN_ON(ret != pdata->irq_base);
426                 twl4030_gpio_irq_base = ret;
427         }
428
429 no_irqs:
430         /*
431          * NOTE:  boards may waste power if they don't set pullups
432          * and pulldowns correctly ... default for non-ULPI pins is
433          * pulldown, and some other pins may have external pullups
434          * or pulldowns.  Careful!
435          */
436         ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
437         if (ret)
438                 dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
439                                 pdata->pullups, pdata->pulldowns,
440                                 ret);
441
442         twl_gpiochip.base = pdata->gpio_base;
443         twl_gpiochip.ngpio = TWL4030_GPIO_MAX;
444         twl_gpiochip.dev = &pdev->dev;
445
446         /* NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
447          * is (still) clear if use_leds is set.
448          */
449         if (pdata->use_leds)
450                 twl_gpiochip.ngpio += 2;
451
452         ret = gpiochip_add(&twl_gpiochip);
453         if (ret < 0) {
454                 dev_err(&pdev->dev,
455                                 "could not register gpiochip, %d\n",
456                                 ret);
457                 twl_gpiochip.ngpio = 0;
458                 gpio_twl4030_remove(pdev);
459         } else if (pdata->setup) {
460                 int status;
461
462                 status = pdata->setup(&pdev->dev,
463                                 pdata->gpio_base, TWL4030_GPIO_MAX);
464                 if (status)
465                         dev_dbg(&pdev->dev, "setup --> %d\n", status);
466         }
467
468         return ret;
469 }
470
471 static int __devexit gpio_twl4030_remove(struct platform_device *pdev)
472 {
473         struct twl4030_gpio_platform_data *pdata = pdev->dev.platform_data;
474         int status;
475
476         if (pdata->teardown) {
477                 status = pdata->teardown(&pdev->dev,
478                                 pdata->gpio_base, TWL4030_GPIO_MAX);
479                 if (status) {
480                         dev_dbg(&pdev->dev, "teardown --> %d\n", status);
481                         return status;
482                 }
483         }
484
485         status = gpiochip_remove(&twl_gpiochip);
486         if (status < 0)
487                 return status;
488
489         if (is_module())
490                 return 0;
491
492         /* REVISIT no support yet for deregistering all the IRQs */
493         WARN_ON(1);
494         return -EIO;
495 }
496
497 /* Note:  this hardware lives inside an I2C-based multi-function device. */
498 MODULE_ALIAS("platform:twl4030_gpio");
499
500 static struct platform_driver gpio_twl4030_driver = {
501         .driver.name    = "twl4030_gpio",
502         .driver.owner   = THIS_MODULE,
503         .probe          = gpio_twl4030_probe,
504         .remove         = __devexit_p(gpio_twl4030_remove),
505 };
506
507 static int __init gpio_twl4030_init(void)
508 {
509         return platform_driver_register(&gpio_twl4030_driver);
510 }
511 subsys_initcall(gpio_twl4030_init);
512
513 static void __exit gpio_twl4030_exit(void)
514 {
515         platform_driver_unregister(&gpio_twl4030_driver);
516 }
517 module_exit(gpio_twl4030_exit);
518
519 MODULE_AUTHOR("Texas Instruments, Inc.");
520 MODULE_DESCRIPTION("GPIO interface for TWL4030");
521 MODULE_LICENSE("GPL");