Loading...
1/*
2 * 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/of.h>
36#include <linux/irqdomain.h>
37
38#include <linux/i2c/twl.h>
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/* genirq interfaces are not available to modules */
52#ifdef MODULE
53#define is_module() true
54#else
55#define is_module() false
56#endif
57
58/* GPIO_CTRL Fields */
59#define MASK_GPIO_CTRL_GPIO0CD1 BIT(0)
60#define MASK_GPIO_CTRL_GPIO1CD2 BIT(1)
61#define MASK_GPIO_CTRL_GPIO_ON BIT(2)
62
63/* Mask for GPIO registers when aggregated into a 32-bit integer */
64#define GPIO_32_MASK 0x0003ffff
65
66struct gpio_twl4030_priv {
67 struct gpio_chip gpio_chip;
68 struct mutex mutex;
69 int irq_base;
70
71 /* Bitfields for state caching */
72 unsigned int usage_count;
73 unsigned int direction;
74 unsigned int out_state;
75};
76
77/*----------------------------------------------------------------------*/
78
79static inline struct gpio_twl4030_priv *to_gpio_twl4030(struct gpio_chip *chip)
80{
81 return container_of(chip, struct gpio_twl4030_priv, gpio_chip);
82}
83
84/*
85 * To configure TWL4030 GPIO module registers
86 */
87static inline int gpio_twl4030_write(u8 address, u8 data)
88{
89 return twl_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
90}
91
92/*----------------------------------------------------------------------*/
93
94/*
95 * LED register offsets from TWL_MODULE_LED base
96 * PWMs A and B are dedicated to LEDs A and B, respectively.
97 */
98
99#define TWL4030_LED_LEDEN_REG 0x00
100#define TWL4030_PWMAON_REG 0x01
101#define TWL4030_PWMAOFF_REG 0x02
102#define TWL4030_PWMBON_REG 0x03
103#define TWL4030_PWMBOFF_REG 0x04
104
105/* LEDEN bits */
106#define LEDEN_LEDAON BIT(0)
107#define LEDEN_LEDBON BIT(1)
108#define LEDEN_LEDAEXT BIT(2)
109#define LEDEN_LEDBEXT BIT(3)
110#define LEDEN_LEDAPWM BIT(4)
111#define LEDEN_LEDBPWM BIT(5)
112#define LEDEN_PWM_LENGTHA BIT(6)
113#define LEDEN_PWM_LENGTHB BIT(7)
114
115#define PWMxON_LENGTH BIT(7)
116
117/*----------------------------------------------------------------------*/
118
119/*
120 * To read a TWL4030 GPIO module register
121 */
122static inline int gpio_twl4030_read(u8 address)
123{
124 u8 data;
125 int ret = 0;
126
127 ret = twl_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
128 return (ret < 0) ? ret : data;
129}
130
131/*----------------------------------------------------------------------*/
132
133static u8 cached_leden;
134
135/* The LED lines are open drain outputs ... a FET pulls to GND, so an
136 * external pullup is needed. We could also expose the integrated PWM
137 * as a LED brightness control; we initialize it as "always on".
138 */
139static void twl4030_led_set_value(int led, int value)
140{
141 u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;
142
143 if (led)
144 mask <<= 1;
145
146 if (value)
147 cached_leden &= ~mask;
148 else
149 cached_leden |= mask;
150
151 WARN_ON_ONCE(twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
152 TWL4030_LED_LEDEN_REG));
153}
154
155static int twl4030_set_gpio_direction(int gpio, int is_input)
156{
157 u8 d_bnk = gpio >> 3;
158 u8 d_msk = BIT(gpio & 0x7);
159 u8 reg = 0;
160 u8 base = REG_GPIODATADIR1 + d_bnk;
161 int ret = 0;
162
163 ret = gpio_twl4030_read(base);
164 if (ret >= 0) {
165 if (is_input)
166 reg = ret & ~d_msk;
167 else
168 reg = ret | d_msk;
169
170 ret = gpio_twl4030_write(base, reg);
171 }
172 return ret;
173}
174
175static int twl4030_set_gpio_dataout(int gpio, int enable)
176{
177 u8 d_bnk = gpio >> 3;
178 u8 d_msk = BIT(gpio & 0x7);
179 u8 base = 0;
180
181 if (enable)
182 base = REG_SETGPIODATAOUT1 + d_bnk;
183 else
184 base = REG_CLEARGPIODATAOUT1 + d_bnk;
185
186 return gpio_twl4030_write(base, d_msk);
187}
188
189static int twl4030_get_gpio_datain(int gpio)
190{
191 u8 d_bnk = gpio >> 3;
192 u8 d_off = gpio & 0x7;
193 u8 base = 0;
194 int ret = 0;
195
196 base = REG_GPIODATAIN1 + d_bnk;
197 ret = gpio_twl4030_read(base);
198 if (ret > 0)
199 ret = (ret >> d_off) & 0x1;
200
201 return ret;
202}
203
204/*----------------------------------------------------------------------*/
205
206static int twl_request(struct gpio_chip *chip, unsigned offset)
207{
208 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
209 int status = 0;
210
211 mutex_lock(&priv->mutex);
212
213 /* Support the two LED outputs as output-only GPIOs. */
214 if (offset >= TWL4030_GPIO_MAX) {
215 u8 ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
216 | LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
217 u8 reg = TWL4030_PWMAON_REG;
218
219 offset -= TWL4030_GPIO_MAX;
220 if (offset) {
221 ledclr_mask <<= 1;
222 reg = TWL4030_PWMBON_REG;
223 }
224
225 /* initialize PWM to always-drive */
226 /* Configure PWM OFF register first */
227 status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg + 1);
228 if (status < 0)
229 goto done;
230
231 /* Followed by PWM ON register */
232 status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg);
233 if (status < 0)
234 goto done;
235
236 /* init LED to not-driven (high) */
237 status = twl_i2c_read_u8(TWL4030_MODULE_LED, &cached_leden,
238 TWL4030_LED_LEDEN_REG);
239 if (status < 0)
240 goto done;
241 cached_leden &= ~ledclr_mask;
242 status = twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
243 TWL4030_LED_LEDEN_REG);
244 if (status < 0)
245 goto done;
246
247 status = 0;
248 goto done;
249 }
250
251 /* on first use, turn GPIO module "on" */
252 if (!priv->usage_count) {
253 struct twl4030_gpio_platform_data *pdata;
254 u8 value = MASK_GPIO_CTRL_GPIO_ON;
255
256 /* optionally have the first two GPIOs switch vMMC1
257 * and vMMC2 power supplies based on card presence.
258 */
259 pdata = dev_get_platdata(chip->dev);
260 if (pdata)
261 value |= pdata->mmc_cd & 0x03;
262
263 status = gpio_twl4030_write(REG_GPIO_CTRL, value);
264 }
265
266done:
267 if (!status)
268 priv->usage_count |= BIT(offset);
269
270 mutex_unlock(&priv->mutex);
271 return status;
272}
273
274static void twl_free(struct gpio_chip *chip, unsigned offset)
275{
276 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
277
278 mutex_lock(&priv->mutex);
279 if (offset >= TWL4030_GPIO_MAX) {
280 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
281 goto out;
282 }
283
284 priv->usage_count &= ~BIT(offset);
285
286 /* on last use, switch off GPIO module */
287 if (!priv->usage_count)
288 gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
289
290out:
291 mutex_unlock(&priv->mutex);
292}
293
294static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
295{
296 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
297 int ret;
298
299 mutex_lock(&priv->mutex);
300 if (offset < TWL4030_GPIO_MAX)
301 ret = twl4030_set_gpio_direction(offset, 1);
302 else
303 ret = -EINVAL; /* LED outputs can't be set as input */
304
305 if (!ret)
306 priv->direction &= ~BIT(offset);
307
308 mutex_unlock(&priv->mutex);
309
310 return ret;
311}
312
313static int twl_get(struct gpio_chip *chip, unsigned offset)
314{
315 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
316 int ret;
317 int status = 0;
318
319 mutex_lock(&priv->mutex);
320 if (!(priv->usage_count & BIT(offset))) {
321 ret = -EPERM;
322 goto out;
323 }
324
325 if (priv->direction & BIT(offset))
326 status = priv->out_state & BIT(offset);
327 else
328 status = twl4030_get_gpio_datain(offset);
329
330 ret = (status <= 0) ? 0 : 1;
331out:
332 mutex_unlock(&priv->mutex);
333 return ret;
334}
335
336static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
337{
338 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
339
340 mutex_lock(&priv->mutex);
341 if (offset < TWL4030_GPIO_MAX)
342 twl4030_set_gpio_dataout(offset, value);
343 else
344 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
345
346 if (value)
347 priv->out_state |= BIT(offset);
348 else
349 priv->out_state &= ~BIT(offset);
350
351 mutex_unlock(&priv->mutex);
352}
353
354static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
355{
356 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
357 int ret = 0;
358
359 mutex_lock(&priv->mutex);
360 if (offset < TWL4030_GPIO_MAX) {
361 ret = twl4030_set_gpio_direction(offset, 0);
362 if (ret) {
363 mutex_unlock(&priv->mutex);
364 return ret;
365 }
366 }
367
368 /*
369 * LED gpios i.e. offset >= TWL4030_GPIO_MAX are always output
370 */
371
372 priv->direction |= BIT(offset);
373 mutex_unlock(&priv->mutex);
374
375 twl_set(chip, offset, value);
376
377 return ret;
378}
379
380static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
381{
382 struct gpio_twl4030_priv *priv = to_gpio_twl4030(chip);
383
384 return (priv->irq_base && (offset < TWL4030_GPIO_MAX))
385 ? (priv->irq_base + offset)
386 : -EINVAL;
387}
388
389static struct gpio_chip template_chip = {
390 .label = "twl4030",
391 .owner = THIS_MODULE,
392 .request = twl_request,
393 .free = twl_free,
394 .direction_input = twl_direction_in,
395 .get = twl_get,
396 .direction_output = twl_direction_out,
397 .set = twl_set,
398 .to_irq = twl_to_irq,
399 .can_sleep = true,
400};
401
402/*----------------------------------------------------------------------*/
403
404static int gpio_twl4030_pulls(u32 ups, u32 downs)
405{
406 u8 message[5];
407 unsigned i, gpio_bit;
408
409 /* For most pins, a pulldown was enabled by default.
410 * We should have data that's specific to this board.
411 */
412 for (gpio_bit = 1, i = 0; i < 5; i++) {
413 u8 bit_mask;
414 unsigned j;
415
416 for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
417 if (ups & gpio_bit)
418 bit_mask |= 1 << (j + 1);
419 else if (downs & gpio_bit)
420 bit_mask |= 1 << (j + 0);
421 }
422 message[i] = bit_mask;
423 }
424
425 return twl_i2c_write(TWL4030_MODULE_GPIO, message,
426 REG_GPIOPUPDCTR1, 5);
427}
428
429static int gpio_twl4030_debounce(u32 debounce, u8 mmc_cd)
430{
431 u8 message[3];
432
433 /* 30 msec of debouncing is always used for MMC card detect,
434 * and is optional for everything else.
435 */
436 message[0] = (debounce & 0xff) | (mmc_cd & 0x03);
437 debounce >>= 8;
438 message[1] = (debounce & 0xff);
439 debounce >>= 8;
440 message[2] = (debounce & 0x03);
441
442 return twl_i2c_write(TWL4030_MODULE_GPIO, message,
443 REG_GPIO_DEBEN1, 3);
444}
445
446static int gpio_twl4030_remove(struct platform_device *pdev);
447
448static struct twl4030_gpio_platform_data *of_gpio_twl4030(struct device *dev,
449 struct twl4030_gpio_platform_data *pdata)
450{
451 struct twl4030_gpio_platform_data *omap_twl_info;
452
453 omap_twl_info = devm_kzalloc(dev, sizeof(*omap_twl_info), GFP_KERNEL);
454 if (!omap_twl_info)
455 return NULL;
456
457 if (pdata)
458 *omap_twl_info = *pdata;
459
460 omap_twl_info->use_leds = of_property_read_bool(dev->of_node,
461 "ti,use-leds");
462
463 of_property_read_u32(dev->of_node, "ti,debounce",
464 &omap_twl_info->debounce);
465 of_property_read_u32(dev->of_node, "ti,mmc-cd",
466 (u32 *)&omap_twl_info->mmc_cd);
467 of_property_read_u32(dev->of_node, "ti,pullups",
468 &omap_twl_info->pullups);
469 of_property_read_u32(dev->of_node, "ti,pulldowns",
470 &omap_twl_info->pulldowns);
471
472 return omap_twl_info;
473}
474
475static int gpio_twl4030_probe(struct platform_device *pdev)
476{
477 struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
478 struct device_node *node = pdev->dev.of_node;
479 struct gpio_twl4030_priv *priv;
480 int ret, irq_base;
481
482 priv = devm_kzalloc(&pdev->dev, sizeof(struct gpio_twl4030_priv),
483 GFP_KERNEL);
484 if (!priv)
485 return -ENOMEM;
486
487 /* maybe setup IRQs */
488 if (is_module()) {
489 dev_err(&pdev->dev, "can't dispatch IRQs from modules\n");
490 goto no_irqs;
491 }
492
493 irq_base = irq_alloc_descs(-1, 0, TWL4030_GPIO_MAX, 0);
494 if (irq_base < 0) {
495 dev_err(&pdev->dev, "Failed to alloc irq_descs\n");
496 return irq_base;
497 }
498
499 irq_domain_add_legacy(node, TWL4030_GPIO_MAX, irq_base, 0,
500 &irq_domain_simple_ops, NULL);
501
502 ret = twl4030_sih_setup(&pdev->dev, TWL4030_MODULE_GPIO, irq_base);
503 if (ret < 0)
504 return ret;
505
506 priv->irq_base = irq_base;
507
508no_irqs:
509 priv->gpio_chip = template_chip;
510 priv->gpio_chip.base = -1;
511 priv->gpio_chip.ngpio = TWL4030_GPIO_MAX;
512 priv->gpio_chip.dev = &pdev->dev;
513
514 mutex_init(&priv->mutex);
515
516 if (node)
517 pdata = of_gpio_twl4030(&pdev->dev, pdata);
518
519 if (pdata == NULL) {
520 dev_err(&pdev->dev, "Platform data is missing\n");
521 return -ENXIO;
522 }
523
524 /*
525 * NOTE: boards may waste power if they don't set pullups
526 * and pulldowns correctly ... default for non-ULPI pins is
527 * pulldown, and some other pins may have external pullups
528 * or pulldowns. Careful!
529 */
530 ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
531 if (ret)
532 dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
533 pdata->pullups, pdata->pulldowns, ret);
534
535 ret = gpio_twl4030_debounce(pdata->debounce, pdata->mmc_cd);
536 if (ret)
537 dev_dbg(&pdev->dev, "debounce %.03x %.01x --> %d\n",
538 pdata->debounce, pdata->mmc_cd, ret);
539
540 /*
541 * NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
542 * is (still) clear if use_leds is set.
543 */
544 if (pdata->use_leds)
545 priv->gpio_chip.ngpio += 2;
546
547 ret = gpiochip_add(&priv->gpio_chip);
548 if (ret < 0) {
549 dev_err(&pdev->dev, "could not register gpiochip, %d\n", ret);
550 priv->gpio_chip.ngpio = 0;
551 gpio_twl4030_remove(pdev);
552 goto out;
553 }
554
555 platform_set_drvdata(pdev, priv);
556
557 if (pdata && pdata->setup) {
558 int status;
559
560 status = pdata->setup(&pdev->dev, priv->gpio_chip.base,
561 TWL4030_GPIO_MAX);
562 if (status)
563 dev_dbg(&pdev->dev, "setup --> %d\n", status);
564 }
565
566out:
567 return ret;
568}
569
570/* Cannot use as gpio_twl4030_probe() calls us */
571static int gpio_twl4030_remove(struct platform_device *pdev)
572{
573 struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
574 struct gpio_twl4030_priv *priv = platform_get_drvdata(pdev);
575 int status;
576
577 if (pdata && pdata->teardown) {
578 status = pdata->teardown(&pdev->dev, priv->gpio_chip.base,
579 TWL4030_GPIO_MAX);
580 if (status) {
581 dev_dbg(&pdev->dev, "teardown --> %d\n", status);
582 return status;
583 }
584 }
585
586 status = gpiochip_remove(&priv->gpio_chip);
587 if (status < 0)
588 return status;
589
590 if (is_module())
591 return 0;
592
593 /* REVISIT no support yet for deregistering all the IRQs */
594 WARN_ON(1);
595 return -EIO;
596}
597
598static const struct of_device_id twl_gpio_match[] = {
599 { .compatible = "ti,twl4030-gpio", },
600 { },
601};
602MODULE_DEVICE_TABLE(of, twl_gpio_match);
603
604/* Note: this hardware lives inside an I2C-based multi-function device. */
605MODULE_ALIAS("platform:twl4030_gpio");
606
607static struct platform_driver gpio_twl4030_driver = {
608 .driver = {
609 .name = "twl4030_gpio",
610 .owner = THIS_MODULE,
611 .of_match_table = twl_gpio_match,
612 },
613 .probe = gpio_twl4030_probe,
614 .remove = gpio_twl4030_remove,
615};
616
617static int __init gpio_twl4030_init(void)
618{
619 return platform_driver_register(&gpio_twl4030_driver);
620}
621subsys_initcall(gpio_twl4030_init);
622
623static void __exit gpio_twl4030_exit(void)
624{
625 platform_driver_unregister(&gpio_twl4030_driver);
626}
627module_exit(gpio_twl4030_exit);
628
629MODULE_AUTHOR("Texas Instruments, Inc.");
630MODULE_DESCRIPTION("GPIO interface for TWL4030");
631MODULE_LICENSE("GPL");
1/*
2 * 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/of.h>
36#include <linux/irqdomain.h>
37
38#include <linux/i2c/twl.h>
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/* genirq interfaces are not available to modules */
52#ifdef MODULE
53#define is_module() true
54#else
55#define is_module() false
56#endif
57
58/* GPIO_CTRL Fields */
59#define MASK_GPIO_CTRL_GPIO0CD1 BIT(0)
60#define MASK_GPIO_CTRL_GPIO1CD2 BIT(1)
61#define MASK_GPIO_CTRL_GPIO_ON BIT(2)
62
63/* Mask for GPIO registers when aggregated into a 32-bit integer */
64#define GPIO_32_MASK 0x0003ffff
65
66struct gpio_twl4030_priv {
67 struct gpio_chip gpio_chip;
68 struct mutex mutex;
69 int irq_base;
70
71 /* Bitfields for state caching */
72 unsigned int usage_count;
73 unsigned int direction;
74 unsigned int out_state;
75};
76
77/*----------------------------------------------------------------------*/
78
79/*
80 * To configure TWL4030 GPIO module registers
81 */
82static inline int gpio_twl4030_write(u8 address, u8 data)
83{
84 return twl_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
85}
86
87/*----------------------------------------------------------------------*/
88
89/*
90 * LED register offsets from TWL_MODULE_LED base
91 * PWMs A and B are dedicated to LEDs A and B, respectively.
92 */
93
94#define TWL4030_LED_LEDEN_REG 0x00
95#define TWL4030_PWMAON_REG 0x01
96#define TWL4030_PWMAOFF_REG 0x02
97#define TWL4030_PWMBON_REG 0x03
98#define TWL4030_PWMBOFF_REG 0x04
99
100/* LEDEN bits */
101#define LEDEN_LEDAON BIT(0)
102#define LEDEN_LEDBON BIT(1)
103#define LEDEN_LEDAEXT BIT(2)
104#define LEDEN_LEDBEXT BIT(3)
105#define LEDEN_LEDAPWM BIT(4)
106#define LEDEN_LEDBPWM BIT(5)
107#define LEDEN_PWM_LENGTHA BIT(6)
108#define LEDEN_PWM_LENGTHB BIT(7)
109
110#define PWMxON_LENGTH BIT(7)
111
112/*----------------------------------------------------------------------*/
113
114/*
115 * To read a TWL4030 GPIO module register
116 */
117static inline int gpio_twl4030_read(u8 address)
118{
119 u8 data;
120 int ret = 0;
121
122 ret = twl_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
123 return (ret < 0) ? ret : data;
124}
125
126/*----------------------------------------------------------------------*/
127
128static u8 cached_leden;
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 */
134static void twl4030_led_set_value(int led, int value)
135{
136 u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;
137
138 if (led)
139 mask <<= 1;
140
141 if (value)
142 cached_leden &= ~mask;
143 else
144 cached_leden |= mask;
145
146 WARN_ON_ONCE(twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
147 TWL4030_LED_LEDEN_REG));
148}
149
150static 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 ret = gpio_twl4030_read(base);
159 if (ret >= 0) {
160 if (is_input)
161 reg = ret & ~d_msk;
162 else
163 reg = ret | d_msk;
164
165 ret = gpio_twl4030_write(base, reg);
166 }
167 return ret;
168}
169
170static int twl4030_set_gpio_dataout(int gpio, int enable)
171{
172 u8 d_bnk = gpio >> 3;
173 u8 d_msk = BIT(gpio & 0x7);
174 u8 base = 0;
175
176 if (enable)
177 base = REG_SETGPIODATAOUT1 + d_bnk;
178 else
179 base = REG_CLEARGPIODATAOUT1 + d_bnk;
180
181 return gpio_twl4030_write(base, d_msk);
182}
183
184static int twl4030_get_gpio_datain(int gpio)
185{
186 u8 d_bnk = gpio >> 3;
187 u8 d_off = gpio & 0x7;
188 u8 base = 0;
189 int ret = 0;
190
191 base = REG_GPIODATAIN1 + d_bnk;
192 ret = gpio_twl4030_read(base);
193 if (ret > 0)
194 ret = (ret >> d_off) & 0x1;
195
196 return ret;
197}
198
199/*----------------------------------------------------------------------*/
200
201static int twl_request(struct gpio_chip *chip, unsigned offset)
202{
203 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
204 int status = 0;
205
206 mutex_lock(&priv->mutex);
207
208 /* Support the two LED outputs as output-only GPIOs. */
209 if (offset >= TWL4030_GPIO_MAX) {
210 u8 ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
211 | LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
212 u8 reg = TWL4030_PWMAON_REG;
213
214 offset -= TWL4030_GPIO_MAX;
215 if (offset) {
216 ledclr_mask <<= 1;
217 reg = TWL4030_PWMBON_REG;
218 }
219
220 /* initialize PWM to always-drive */
221 /* Configure PWM OFF register first */
222 status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg + 1);
223 if (status < 0)
224 goto done;
225
226 /* Followed by PWM ON register */
227 status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg);
228 if (status < 0)
229 goto done;
230
231 /* init LED to not-driven (high) */
232 status = twl_i2c_read_u8(TWL4030_MODULE_LED, &cached_leden,
233 TWL4030_LED_LEDEN_REG);
234 if (status < 0)
235 goto done;
236 cached_leden &= ~ledclr_mask;
237 status = twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
238 TWL4030_LED_LEDEN_REG);
239 if (status < 0)
240 goto done;
241
242 status = 0;
243 goto done;
244 }
245
246 /* on first use, turn GPIO module "on" */
247 if (!priv->usage_count) {
248 struct twl4030_gpio_platform_data *pdata;
249 u8 value = MASK_GPIO_CTRL_GPIO_ON;
250
251 /* optionally have the first two GPIOs switch vMMC1
252 * and vMMC2 power supplies based on card presence.
253 */
254 pdata = dev_get_platdata(chip->parent);
255 if (pdata)
256 value |= pdata->mmc_cd & 0x03;
257
258 status = gpio_twl4030_write(REG_GPIO_CTRL, value);
259 }
260
261done:
262 if (!status)
263 priv->usage_count |= BIT(offset);
264
265 mutex_unlock(&priv->mutex);
266 return status;
267}
268
269static void twl_free(struct gpio_chip *chip, unsigned offset)
270{
271 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
272
273 mutex_lock(&priv->mutex);
274 if (offset >= TWL4030_GPIO_MAX) {
275 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
276 goto out;
277 }
278
279 priv->usage_count &= ~BIT(offset);
280
281 /* on last use, switch off GPIO module */
282 if (!priv->usage_count)
283 gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
284
285out:
286 mutex_unlock(&priv->mutex);
287}
288
289static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
290{
291 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
292 int ret;
293
294 mutex_lock(&priv->mutex);
295 if (offset < TWL4030_GPIO_MAX)
296 ret = twl4030_set_gpio_direction(offset, 1);
297 else
298 ret = -EINVAL; /* LED outputs can't be set as input */
299
300 if (!ret)
301 priv->direction &= ~BIT(offset);
302
303 mutex_unlock(&priv->mutex);
304
305 return ret;
306}
307
308static int twl_get(struct gpio_chip *chip, unsigned offset)
309{
310 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
311 int ret;
312 int status = 0;
313
314 mutex_lock(&priv->mutex);
315 if (!(priv->usage_count & BIT(offset))) {
316 ret = -EPERM;
317 goto out;
318 }
319
320 if (priv->direction & BIT(offset))
321 status = priv->out_state & BIT(offset);
322 else
323 status = twl4030_get_gpio_datain(offset);
324
325 ret = (status < 0) ? status : !!status;
326out:
327 mutex_unlock(&priv->mutex);
328 return ret;
329}
330
331static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
332{
333 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
334
335 mutex_lock(&priv->mutex);
336 if (offset < TWL4030_GPIO_MAX)
337 twl4030_set_gpio_dataout(offset, value);
338 else
339 twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
340
341 if (value)
342 priv->out_state |= BIT(offset);
343 else
344 priv->out_state &= ~BIT(offset);
345
346 mutex_unlock(&priv->mutex);
347}
348
349static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
350{
351 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
352 int ret = 0;
353
354 mutex_lock(&priv->mutex);
355 if (offset < TWL4030_GPIO_MAX) {
356 ret = twl4030_set_gpio_direction(offset, 0);
357 if (ret) {
358 mutex_unlock(&priv->mutex);
359 return ret;
360 }
361 }
362
363 /*
364 * LED gpios i.e. offset >= TWL4030_GPIO_MAX are always output
365 */
366
367 priv->direction |= BIT(offset);
368 mutex_unlock(&priv->mutex);
369
370 twl_set(chip, offset, value);
371
372 return ret;
373}
374
375static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
376{
377 struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
378
379 return (priv->irq_base && (offset < TWL4030_GPIO_MAX))
380 ? (priv->irq_base + offset)
381 : -EINVAL;
382}
383
384static struct gpio_chip template_chip = {
385 .label = "twl4030",
386 .owner = THIS_MODULE,
387 .request = twl_request,
388 .free = twl_free,
389 .direction_input = twl_direction_in,
390 .get = twl_get,
391 .direction_output = twl_direction_out,
392 .set = twl_set,
393 .to_irq = twl_to_irq,
394 .can_sleep = true,
395};
396
397/*----------------------------------------------------------------------*/
398
399static int gpio_twl4030_pulls(u32 ups, u32 downs)
400{
401 u8 message[5];
402 unsigned i, gpio_bit;
403
404 /* For most pins, a pulldown was enabled by default.
405 * We should have data that's specific to this board.
406 */
407 for (gpio_bit = 1, i = 0; i < 5; i++) {
408 u8 bit_mask;
409 unsigned j;
410
411 for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
412 if (ups & gpio_bit)
413 bit_mask |= 1 << (j + 1);
414 else if (downs & gpio_bit)
415 bit_mask |= 1 << (j + 0);
416 }
417 message[i] = bit_mask;
418 }
419
420 return twl_i2c_write(TWL4030_MODULE_GPIO, message,
421 REG_GPIOPUPDCTR1, 5);
422}
423
424static int gpio_twl4030_debounce(u32 debounce, u8 mmc_cd)
425{
426 u8 message[3];
427
428 /* 30 msec of debouncing is always used for MMC card detect,
429 * and is optional for everything else.
430 */
431 message[0] = (debounce & 0xff) | (mmc_cd & 0x03);
432 debounce >>= 8;
433 message[1] = (debounce & 0xff);
434 debounce >>= 8;
435 message[2] = (debounce & 0x03);
436
437 return twl_i2c_write(TWL4030_MODULE_GPIO, message,
438 REG_GPIO_DEBEN1, 3);
439}
440
441static int gpio_twl4030_remove(struct platform_device *pdev);
442
443static struct twl4030_gpio_platform_data *of_gpio_twl4030(struct device *dev,
444 struct twl4030_gpio_platform_data *pdata)
445{
446 struct twl4030_gpio_platform_data *omap_twl_info;
447
448 omap_twl_info = devm_kzalloc(dev, sizeof(*omap_twl_info), GFP_KERNEL);
449 if (!omap_twl_info)
450 return NULL;
451
452 if (pdata)
453 *omap_twl_info = *pdata;
454
455 omap_twl_info->use_leds = of_property_read_bool(dev->of_node,
456 "ti,use-leds");
457
458 of_property_read_u32(dev->of_node, "ti,debounce",
459 &omap_twl_info->debounce);
460 of_property_read_u32(dev->of_node, "ti,mmc-cd",
461 (u32 *)&omap_twl_info->mmc_cd);
462 of_property_read_u32(dev->of_node, "ti,pullups",
463 &omap_twl_info->pullups);
464 of_property_read_u32(dev->of_node, "ti,pulldowns",
465 &omap_twl_info->pulldowns);
466
467 return omap_twl_info;
468}
469
470static int gpio_twl4030_probe(struct platform_device *pdev)
471{
472 struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
473 struct device_node *node = pdev->dev.of_node;
474 struct gpio_twl4030_priv *priv;
475 int ret, irq_base;
476
477 priv = devm_kzalloc(&pdev->dev, sizeof(struct gpio_twl4030_priv),
478 GFP_KERNEL);
479 if (!priv)
480 return -ENOMEM;
481
482 /* maybe setup IRQs */
483 if (is_module()) {
484 dev_err(&pdev->dev, "can't dispatch IRQs from modules\n");
485 goto no_irqs;
486 }
487
488 irq_base = irq_alloc_descs(-1, 0, TWL4030_GPIO_MAX, 0);
489 if (irq_base < 0) {
490 dev_err(&pdev->dev, "Failed to alloc irq_descs\n");
491 return irq_base;
492 }
493
494 irq_domain_add_legacy(node, TWL4030_GPIO_MAX, irq_base, 0,
495 &irq_domain_simple_ops, NULL);
496
497 ret = twl4030_sih_setup(&pdev->dev, TWL4030_MODULE_GPIO, irq_base);
498 if (ret < 0)
499 return ret;
500
501 priv->irq_base = irq_base;
502
503no_irqs:
504 priv->gpio_chip = template_chip;
505 priv->gpio_chip.base = -1;
506 priv->gpio_chip.ngpio = TWL4030_GPIO_MAX;
507 priv->gpio_chip.parent = &pdev->dev;
508
509 mutex_init(&priv->mutex);
510
511 if (node)
512 pdata = of_gpio_twl4030(&pdev->dev, pdata);
513
514 if (pdata == NULL) {
515 dev_err(&pdev->dev, "Platform data is missing\n");
516 return -ENXIO;
517 }
518
519 /*
520 * NOTE: boards may waste power if they don't set pullups
521 * and pulldowns correctly ... default for non-ULPI pins is
522 * pulldown, and some other pins may have external pullups
523 * or pulldowns. Careful!
524 */
525 ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
526 if (ret)
527 dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
528 pdata->pullups, pdata->pulldowns, ret);
529
530 ret = gpio_twl4030_debounce(pdata->debounce, pdata->mmc_cd);
531 if (ret)
532 dev_dbg(&pdev->dev, "debounce %.03x %.01x --> %d\n",
533 pdata->debounce, pdata->mmc_cd, ret);
534
535 /*
536 * NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
537 * is (still) clear if use_leds is set.
538 */
539 if (pdata->use_leds)
540 priv->gpio_chip.ngpio += 2;
541
542 ret = gpiochip_add_data(&priv->gpio_chip, priv);
543 if (ret < 0) {
544 dev_err(&pdev->dev, "could not register gpiochip, %d\n", ret);
545 priv->gpio_chip.ngpio = 0;
546 gpio_twl4030_remove(pdev);
547 goto out;
548 }
549
550 platform_set_drvdata(pdev, priv);
551
552 if (pdata->setup) {
553 int status;
554
555 status = pdata->setup(&pdev->dev, priv->gpio_chip.base,
556 TWL4030_GPIO_MAX);
557 if (status)
558 dev_dbg(&pdev->dev, "setup --> %d\n", status);
559 }
560
561out:
562 return ret;
563}
564
565/* Cannot use as gpio_twl4030_probe() calls us */
566static int gpio_twl4030_remove(struct platform_device *pdev)
567{
568 struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
569 struct gpio_twl4030_priv *priv = platform_get_drvdata(pdev);
570 int status;
571
572 if (pdata && pdata->teardown) {
573 status = pdata->teardown(&pdev->dev, priv->gpio_chip.base,
574 TWL4030_GPIO_MAX);
575 if (status) {
576 dev_dbg(&pdev->dev, "teardown --> %d\n", status);
577 return status;
578 }
579 }
580
581 gpiochip_remove(&priv->gpio_chip);
582
583 if (is_module())
584 return 0;
585
586 /* REVISIT no support yet for deregistering all the IRQs */
587 WARN_ON(1);
588 return -EIO;
589}
590
591static const struct of_device_id twl_gpio_match[] = {
592 { .compatible = "ti,twl4030-gpio", },
593 { },
594};
595MODULE_DEVICE_TABLE(of, twl_gpio_match);
596
597/* Note: this hardware lives inside an I2C-based multi-function device. */
598MODULE_ALIAS("platform:twl4030_gpio");
599
600static struct platform_driver gpio_twl4030_driver = {
601 .driver = {
602 .name = "twl4030_gpio",
603 .of_match_table = twl_gpio_match,
604 },
605 .probe = gpio_twl4030_probe,
606 .remove = gpio_twl4030_remove,
607};
608
609static int __init gpio_twl4030_init(void)
610{
611 return platform_driver_register(&gpio_twl4030_driver);
612}
613subsys_initcall(gpio_twl4030_init);
614
615static void __exit gpio_twl4030_exit(void)
616{
617 platform_driver_unregister(&gpio_twl4030_driver);
618}
619module_exit(gpio_twl4030_exit);
620
621MODULE_AUTHOR("Texas Instruments, Inc.");
622MODULE_DESCRIPTION("GPIO interface for TWL4030");
623MODULE_LICENSE("GPL");