1 // SPDX-License-Identifier: GPL-2.0-only
3 * arch/arm/mach-tegra/gpio.c
5 * Copyright (c) 2010 Google, Inc
6 * Copyright (c) 2011-2016, NVIDIA CORPORATION. All rights reserved.
12 #include <linux/err.h>
13 #include <linux/init.h>
14 #include <linux/irq.h>
15 #include <linux/interrupt.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/of_device.h>
19 #include <linux/platform_device.h>
20 #include <linux/module.h>
21 #include <linux/irqdomain.h>
22 #include <linux/irqchip/chained_irq.h>
23 #include <linux/pinctrl/consumer.h>
26 #define GPIO_BANK(x) ((x) >> 5)
27 #define GPIO_PORT(x) (((x) >> 3) & 0x3)
28 #define GPIO_BIT(x) ((x) & 0x7)
30 #define GPIO_REG(tgi, x) (GPIO_BANK(x) * tgi->soc->bank_stride + \
33 #define GPIO_CNF(t, x) (GPIO_REG(t, x) + 0x00)
34 #define GPIO_OE(t, x) (GPIO_REG(t, x) + 0x10)
35 #define GPIO_OUT(t, x) (GPIO_REG(t, x) + 0X20)
36 #define GPIO_IN(t, x) (GPIO_REG(t, x) + 0x30)
37 #define GPIO_INT_STA(t, x) (GPIO_REG(t, x) + 0x40)
38 #define GPIO_INT_ENB(t, x) (GPIO_REG(t, x) + 0x50)
39 #define GPIO_INT_LVL(t, x) (GPIO_REG(t, x) + 0x60)
40 #define GPIO_INT_CLR(t, x) (GPIO_REG(t, x) + 0x70)
41 #define GPIO_DBC_CNT(t, x) (GPIO_REG(t, x) + 0xF0)
44 #define GPIO_MSK_CNF(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x00)
45 #define GPIO_MSK_OE(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x10)
46 #define GPIO_MSK_OUT(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0X20)
47 #define GPIO_MSK_DBC_EN(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x30)
48 #define GPIO_MSK_INT_STA(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x40)
49 #define GPIO_MSK_INT_ENB(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x50)
50 #define GPIO_MSK_INT_LVL(t, x) (GPIO_REG(t, x) + t->soc->upper_offset + 0x60)
52 #define GPIO_INT_LVL_MASK 0x010101
53 #define GPIO_INT_LVL_EDGE_RISING 0x000101
54 #define GPIO_INT_LVL_EDGE_FALLING 0x000100
55 #define GPIO_INT_LVL_EDGE_BOTH 0x010100
56 #define GPIO_INT_LVL_LEVEL_HIGH 0x000001
57 #define GPIO_INT_LVL_LEVEL_LOW 0x000000
59 struct tegra_gpio_info;
61 struct tegra_gpio_bank {
64 spinlock_t lvl_lock[4];
65 spinlock_t dbc_lock[4]; /* Lock for updating debounce count register */
66 #ifdef CONFIG_PM_SLEEP
76 struct tegra_gpio_info *tgi;
79 struct tegra_gpio_soc_config {
80 bool debounce_supported;
85 struct tegra_gpio_info {
88 struct irq_domain *irq_domain;
89 struct tegra_gpio_bank *bank_info;
90 const struct tegra_gpio_soc_config *soc;
96 static inline void tegra_gpio_writel(struct tegra_gpio_info *tgi,
99 writel_relaxed(val, tgi->regs + reg);
102 static inline u32 tegra_gpio_readl(struct tegra_gpio_info *tgi, u32 reg)
104 return readl_relaxed(tgi->regs + reg);
107 static unsigned int tegra_gpio_compose(unsigned int bank, unsigned int port,
110 return (bank << 5) | ((port & 0x3) << 3) | (bit & 0x7);
113 static void tegra_gpio_mask_write(struct tegra_gpio_info *tgi, u32 reg,
114 unsigned int gpio, u32 value)
118 val = 0x100 << GPIO_BIT(gpio);
120 val |= 1 << GPIO_BIT(gpio);
121 tegra_gpio_writel(tgi, val, reg);
124 static void tegra_gpio_enable(struct tegra_gpio_info *tgi, unsigned int gpio)
126 tegra_gpio_mask_write(tgi, GPIO_MSK_CNF(tgi, gpio), gpio, 1);
129 static void tegra_gpio_disable(struct tegra_gpio_info *tgi, unsigned int gpio)
131 tegra_gpio_mask_write(tgi, GPIO_MSK_CNF(tgi, gpio), gpio, 0);
134 static int tegra_gpio_request(struct gpio_chip *chip, unsigned int offset)
136 return pinctrl_gpio_request(chip->base + offset);
139 static void tegra_gpio_free(struct gpio_chip *chip, unsigned int offset)
141 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
143 pinctrl_gpio_free(chip->base + offset);
144 tegra_gpio_disable(tgi, offset);
147 static void tegra_gpio_set(struct gpio_chip *chip, unsigned int offset,
150 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
152 tegra_gpio_mask_write(tgi, GPIO_MSK_OUT(tgi, offset), offset, value);
155 static int tegra_gpio_get(struct gpio_chip *chip, unsigned int offset)
157 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
158 unsigned int bval = BIT(GPIO_BIT(offset));
160 /* If gpio is in output mode then read from the out value */
161 if (tegra_gpio_readl(tgi, GPIO_OE(tgi, offset)) & bval)
162 return !!(tegra_gpio_readl(tgi, GPIO_OUT(tgi, offset)) & bval);
164 return !!(tegra_gpio_readl(tgi, GPIO_IN(tgi, offset)) & bval);
167 static int tegra_gpio_direction_input(struct gpio_chip *chip,
170 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
173 tegra_gpio_mask_write(tgi, GPIO_MSK_OE(tgi, offset), offset, 0);
174 tegra_gpio_enable(tgi, offset);
176 ret = pinctrl_gpio_direction_input(chip->base + offset);
179 "Failed to set pinctrl input direction of GPIO %d: %d",
180 chip->base + offset, ret);
185 static int tegra_gpio_direction_output(struct gpio_chip *chip,
189 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
192 tegra_gpio_set(chip, offset, value);
193 tegra_gpio_mask_write(tgi, GPIO_MSK_OE(tgi, offset), offset, 1);
194 tegra_gpio_enable(tgi, offset);
196 ret = pinctrl_gpio_direction_output(chip->base + offset);
199 "Failed to set pinctrl output direction of GPIO %d: %d",
200 chip->base + offset, ret);
205 static int tegra_gpio_get_direction(struct gpio_chip *chip,
208 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
209 u32 pin_mask = BIT(GPIO_BIT(offset));
212 cnf = tegra_gpio_readl(tgi, GPIO_CNF(tgi, offset));
213 if (!(cnf & pin_mask))
216 oe = tegra_gpio_readl(tgi, GPIO_OE(tgi, offset));
219 return GPIO_LINE_DIRECTION_OUT;
221 return GPIO_LINE_DIRECTION_IN;
224 static int tegra_gpio_set_debounce(struct gpio_chip *chip, unsigned int offset,
225 unsigned int debounce)
227 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
228 struct tegra_gpio_bank *bank = &tgi->bank_info[GPIO_BANK(offset)];
229 unsigned int debounce_ms = DIV_ROUND_UP(debounce, 1000);
234 tegra_gpio_mask_write(tgi, GPIO_MSK_DBC_EN(tgi, offset),
239 debounce_ms = min(debounce_ms, 255U);
240 port = GPIO_PORT(offset);
242 /* There is only one debounce count register per port and hence
243 * set the maximum of current and requested debounce time.
245 spin_lock_irqsave(&bank->dbc_lock[port], flags);
246 if (bank->dbc_cnt[port] < debounce_ms) {
247 tegra_gpio_writel(tgi, debounce_ms, GPIO_DBC_CNT(tgi, offset));
248 bank->dbc_cnt[port] = debounce_ms;
250 spin_unlock_irqrestore(&bank->dbc_lock[port], flags);
252 tegra_gpio_mask_write(tgi, GPIO_MSK_DBC_EN(tgi, offset), offset, 1);
257 static int tegra_gpio_set_config(struct gpio_chip *chip, unsigned int offset,
258 unsigned long config)
262 if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE)
265 debounce = pinconf_to_config_argument(config);
266 return tegra_gpio_set_debounce(chip, offset, debounce);
269 static int tegra_gpio_to_irq(struct gpio_chip *chip, unsigned int offset)
271 struct tegra_gpio_info *tgi = gpiochip_get_data(chip);
273 return irq_find_mapping(tgi->irq_domain, offset);
276 static void tegra_gpio_irq_ack(struct irq_data *d)
278 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
279 struct tegra_gpio_info *tgi = bank->tgi;
280 unsigned int gpio = d->hwirq;
282 tegra_gpio_writel(tgi, 1 << GPIO_BIT(gpio), GPIO_INT_CLR(tgi, gpio));
285 static void tegra_gpio_irq_mask(struct irq_data *d)
287 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
288 struct tegra_gpio_info *tgi = bank->tgi;
289 unsigned int gpio = d->hwirq;
291 tegra_gpio_mask_write(tgi, GPIO_MSK_INT_ENB(tgi, gpio), gpio, 0);
294 static void tegra_gpio_irq_unmask(struct irq_data *d)
296 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
297 struct tegra_gpio_info *tgi = bank->tgi;
298 unsigned int gpio = d->hwirq;
300 tegra_gpio_mask_write(tgi, GPIO_MSK_INT_ENB(tgi, gpio), gpio, 1);
303 static int tegra_gpio_irq_set_type(struct irq_data *d, unsigned int type)
305 unsigned int gpio = d->hwirq, port = GPIO_PORT(gpio), lvl_type;
306 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
307 struct tegra_gpio_info *tgi = bank->tgi;
312 switch (type & IRQ_TYPE_SENSE_MASK) {
313 case IRQ_TYPE_EDGE_RISING:
314 lvl_type = GPIO_INT_LVL_EDGE_RISING;
317 case IRQ_TYPE_EDGE_FALLING:
318 lvl_type = GPIO_INT_LVL_EDGE_FALLING;
321 case IRQ_TYPE_EDGE_BOTH:
322 lvl_type = GPIO_INT_LVL_EDGE_BOTH;
325 case IRQ_TYPE_LEVEL_HIGH:
326 lvl_type = GPIO_INT_LVL_LEVEL_HIGH;
329 case IRQ_TYPE_LEVEL_LOW:
330 lvl_type = GPIO_INT_LVL_LEVEL_LOW;
337 spin_lock_irqsave(&bank->lvl_lock[port], flags);
339 val = tegra_gpio_readl(tgi, GPIO_INT_LVL(tgi, gpio));
340 val &= ~(GPIO_INT_LVL_MASK << GPIO_BIT(gpio));
341 val |= lvl_type << GPIO_BIT(gpio);
342 tegra_gpio_writel(tgi, val, GPIO_INT_LVL(tgi, gpio));
344 spin_unlock_irqrestore(&bank->lvl_lock[port], flags);
346 tegra_gpio_mask_write(tgi, GPIO_MSK_OE(tgi, gpio), gpio, 0);
347 tegra_gpio_enable(tgi, gpio);
349 ret = gpiochip_lock_as_irq(&tgi->gc, gpio);
352 "unable to lock Tegra GPIO %u as IRQ\n", gpio);
353 tegra_gpio_disable(tgi, gpio);
357 if (type & (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH))
358 irq_set_handler_locked(d, handle_level_irq);
359 else if (type & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
360 irq_set_handler_locked(d, handle_edge_irq);
365 static void tegra_gpio_irq_shutdown(struct irq_data *d)
367 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
368 struct tegra_gpio_info *tgi = bank->tgi;
369 unsigned int gpio = d->hwirq;
371 gpiochip_unlock_as_irq(&tgi->gc, gpio);
374 static void tegra_gpio_irq_handler(struct irq_desc *desc)
376 unsigned int port, pin, gpio;
377 bool unmasked = false;
380 struct irq_chip *chip = irq_desc_get_chip(desc);
381 struct tegra_gpio_bank *bank = irq_desc_get_handler_data(desc);
382 struct tegra_gpio_info *tgi = bank->tgi;
384 chained_irq_enter(chip, desc);
386 for (port = 0; port < 4; port++) {
387 gpio = tegra_gpio_compose(bank->bank, port, 0);
388 sta = tegra_gpio_readl(tgi, GPIO_INT_STA(tgi, gpio)) &
389 tegra_gpio_readl(tgi, GPIO_INT_ENB(tgi, gpio));
390 lvl = tegra_gpio_readl(tgi, GPIO_INT_LVL(tgi, gpio));
392 for_each_set_bit(pin, &sta, 8) {
393 tegra_gpio_writel(tgi, 1 << pin,
394 GPIO_INT_CLR(tgi, gpio));
396 /* if gpio is edge triggered, clear condition
397 * before executing the handler so that we don't
400 if (!unmasked && lvl & (0x100 << pin)) {
402 chained_irq_exit(chip, desc);
405 generic_handle_irq(irq_find_mapping(tgi->irq_domain,
411 chained_irq_exit(chip, desc);
415 #ifdef CONFIG_PM_SLEEP
416 static int tegra_gpio_resume(struct device *dev)
418 struct tegra_gpio_info *tgi = dev_get_drvdata(dev);
421 for (b = 0; b < tgi->bank_count; b++) {
422 struct tegra_gpio_bank *bank = &tgi->bank_info[b];
424 for (p = 0; p < ARRAY_SIZE(bank->oe); p++) {
425 unsigned int gpio = (b << 5) | (p << 3);
427 tegra_gpio_writel(tgi, bank->cnf[p],
428 GPIO_CNF(tgi, gpio));
430 if (tgi->soc->debounce_supported) {
431 tegra_gpio_writel(tgi, bank->dbc_cnt[p],
432 GPIO_DBC_CNT(tgi, gpio));
433 tegra_gpio_writel(tgi, bank->dbc_enb[p],
434 GPIO_MSK_DBC_EN(tgi, gpio));
437 tegra_gpio_writel(tgi, bank->out[p],
438 GPIO_OUT(tgi, gpio));
439 tegra_gpio_writel(tgi, bank->oe[p],
441 tegra_gpio_writel(tgi, bank->int_lvl[p],
442 GPIO_INT_LVL(tgi, gpio));
443 tegra_gpio_writel(tgi, bank->int_enb[p],
444 GPIO_INT_ENB(tgi, gpio));
451 static int tegra_gpio_suspend(struct device *dev)
453 struct tegra_gpio_info *tgi = dev_get_drvdata(dev);
456 for (b = 0; b < tgi->bank_count; b++) {
457 struct tegra_gpio_bank *bank = &tgi->bank_info[b];
459 for (p = 0; p < ARRAY_SIZE(bank->oe); p++) {
460 unsigned int gpio = (b << 5) | (p << 3);
462 bank->cnf[p] = tegra_gpio_readl(tgi,
463 GPIO_CNF(tgi, gpio));
464 bank->out[p] = tegra_gpio_readl(tgi,
465 GPIO_OUT(tgi, gpio));
466 bank->oe[p] = tegra_gpio_readl(tgi,
468 if (tgi->soc->debounce_supported) {
469 bank->dbc_enb[p] = tegra_gpio_readl(tgi,
470 GPIO_MSK_DBC_EN(tgi, gpio));
471 bank->dbc_enb[p] = (bank->dbc_enb[p] << 8) |
475 bank->int_enb[p] = tegra_gpio_readl(tgi,
476 GPIO_INT_ENB(tgi, gpio));
477 bank->int_lvl[p] = tegra_gpio_readl(tgi,
478 GPIO_INT_LVL(tgi, gpio));
480 /* Enable gpio irq for wake up source */
481 tegra_gpio_writel(tgi, bank->wake_enb[p],
482 GPIO_INT_ENB(tgi, gpio));
489 static int tegra_gpio_irq_set_wake(struct irq_data *d, unsigned int enable)
491 struct tegra_gpio_bank *bank = irq_data_get_irq_chip_data(d);
492 unsigned int gpio = d->hwirq;
496 err = irq_set_irq_wake(bank->irq, enable);
500 port = GPIO_PORT(gpio);
501 bit = GPIO_BIT(gpio);
505 bank->wake_enb[port] |= mask;
507 bank->wake_enb[port] &= ~mask;
513 #ifdef CONFIG_DEBUG_FS
515 #include <linux/debugfs.h>
516 #include <linux/seq_file.h>
518 static int tegra_dbg_gpio_show(struct seq_file *s, void *unused)
520 struct tegra_gpio_info *tgi = s->private;
523 for (i = 0; i < tgi->bank_count; i++) {
524 for (j = 0; j < 4; j++) {
525 unsigned int gpio = tegra_gpio_compose(i, j, 0);
528 "%u:%u %02x %02x %02x %02x %02x %02x %06x\n",
530 tegra_gpio_readl(tgi, GPIO_CNF(tgi, gpio)),
531 tegra_gpio_readl(tgi, GPIO_OE(tgi, gpio)),
532 tegra_gpio_readl(tgi, GPIO_OUT(tgi, gpio)),
533 tegra_gpio_readl(tgi, GPIO_IN(tgi, gpio)),
534 tegra_gpio_readl(tgi, GPIO_INT_STA(tgi, gpio)),
535 tegra_gpio_readl(tgi, GPIO_INT_ENB(tgi, gpio)),
536 tegra_gpio_readl(tgi, GPIO_INT_LVL(tgi, gpio)));
542 DEFINE_SHOW_ATTRIBUTE(tegra_dbg_gpio);
544 static void tegra_gpio_debuginit(struct tegra_gpio_info *tgi)
546 debugfs_create_file("tegra_gpio", 0444, NULL, tgi,
547 &tegra_dbg_gpio_fops);
552 static inline void tegra_gpio_debuginit(struct tegra_gpio_info *tgi)
558 static const struct dev_pm_ops tegra_gpio_pm_ops = {
559 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(tegra_gpio_suspend, tegra_gpio_resume)
562 static int tegra_gpio_probe(struct platform_device *pdev)
564 struct tegra_gpio_info *tgi;
565 struct tegra_gpio_bank *bank;
566 unsigned int gpio, i, j;
569 tgi = devm_kzalloc(&pdev->dev, sizeof(*tgi), GFP_KERNEL);
573 tgi->soc = of_device_get_match_data(&pdev->dev);
574 tgi->dev = &pdev->dev;
576 ret = platform_irq_count(pdev);
580 tgi->bank_count = ret;
582 if (!tgi->bank_count) {
583 dev_err(&pdev->dev, "Missing IRQ resource\n");
587 tgi->gc.label = "tegra-gpio";
588 tgi->gc.request = tegra_gpio_request;
589 tgi->gc.free = tegra_gpio_free;
590 tgi->gc.direction_input = tegra_gpio_direction_input;
591 tgi->gc.get = tegra_gpio_get;
592 tgi->gc.direction_output = tegra_gpio_direction_output;
593 tgi->gc.set = tegra_gpio_set;
594 tgi->gc.get_direction = tegra_gpio_get_direction;
595 tgi->gc.to_irq = tegra_gpio_to_irq;
597 tgi->gc.ngpio = tgi->bank_count * 32;
598 tgi->gc.parent = &pdev->dev;
599 tgi->gc.of_node = pdev->dev.of_node;
601 tgi->ic.name = "GPIO";
602 tgi->ic.irq_ack = tegra_gpio_irq_ack;
603 tgi->ic.irq_mask = tegra_gpio_irq_mask;
604 tgi->ic.irq_unmask = tegra_gpio_irq_unmask;
605 tgi->ic.irq_set_type = tegra_gpio_irq_set_type;
606 tgi->ic.irq_shutdown = tegra_gpio_irq_shutdown;
607 #ifdef CONFIG_PM_SLEEP
608 tgi->ic.irq_set_wake = tegra_gpio_irq_set_wake;
611 platform_set_drvdata(pdev, tgi);
613 if (tgi->soc->debounce_supported)
614 tgi->gc.set_config = tegra_gpio_set_config;
616 tgi->bank_info = devm_kcalloc(&pdev->dev, tgi->bank_count,
617 sizeof(*tgi->bank_info), GFP_KERNEL);
621 tgi->irq_domain = irq_domain_add_linear(pdev->dev.of_node,
623 &irq_domain_simple_ops, NULL);
624 if (!tgi->irq_domain)
627 for (i = 0; i < tgi->bank_count; i++) {
628 ret = platform_get_irq(pdev, i);
632 bank = &tgi->bank_info[i];
638 tgi->regs = devm_platform_ioremap_resource(pdev, 0);
639 if (IS_ERR(tgi->regs))
640 return PTR_ERR(tgi->regs);
642 for (i = 0; i < tgi->bank_count; i++) {
643 for (j = 0; j < 4; j++) {
644 int gpio = tegra_gpio_compose(i, j, 0);
646 tegra_gpio_writel(tgi, 0x00, GPIO_INT_ENB(tgi, gpio));
650 ret = devm_gpiochip_add_data(&pdev->dev, &tgi->gc, tgi);
652 irq_domain_remove(tgi->irq_domain);
656 for (gpio = 0; gpio < tgi->gc.ngpio; gpio++) {
657 int irq = irq_create_mapping(tgi->irq_domain, gpio);
658 /* No validity check; all Tegra GPIOs are valid IRQs */
660 bank = &tgi->bank_info[GPIO_BANK(gpio)];
662 irq_set_chip_data(irq, bank);
663 irq_set_chip_and_handler(irq, &tgi->ic, handle_simple_irq);
666 for (i = 0; i < tgi->bank_count; i++) {
667 bank = &tgi->bank_info[i];
669 irq_set_chained_handler_and_data(bank->irq,
670 tegra_gpio_irq_handler, bank);
672 for (j = 0; j < 4; j++) {
673 spin_lock_init(&bank->lvl_lock[j]);
674 spin_lock_init(&bank->dbc_lock[j]);
678 tegra_gpio_debuginit(tgi);
683 static const struct tegra_gpio_soc_config tegra20_gpio_config = {
685 .upper_offset = 0x800,
688 static const struct tegra_gpio_soc_config tegra30_gpio_config = {
689 .bank_stride = 0x100,
690 .upper_offset = 0x80,
693 static const struct tegra_gpio_soc_config tegra210_gpio_config = {
694 .debounce_supported = true,
695 .bank_stride = 0x100,
696 .upper_offset = 0x80,
699 static const struct of_device_id tegra_gpio_of_match[] = {
700 { .compatible = "nvidia,tegra210-gpio", .data = &tegra210_gpio_config },
701 { .compatible = "nvidia,tegra30-gpio", .data = &tegra30_gpio_config },
702 { .compatible = "nvidia,tegra20-gpio", .data = &tegra20_gpio_config },
706 static struct platform_driver tegra_gpio_driver = {
708 .name = "tegra-gpio",
709 .pm = &tegra_gpio_pm_ops,
710 .of_match_table = tegra_gpio_of_match,
712 .probe = tegra_gpio_probe,
715 static int __init tegra_gpio_init(void)
717 return platform_driver_register(&tegra_gpio_driver);
719 subsys_initcall(tegra_gpio_init);