1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2013 MundoReader S.L.
4 * Author: Heiko Stuebner <heiko@sntech.de>
6 * Copyright (c) 2021 Rockchip Electronics Co. Ltd.
9 #include <linux/bitops.h>
10 #include <linux/clk.h>
11 #include <linux/device.h>
12 #include <linux/err.h>
13 #include <linux/gpio/driver.h>
14 #include <linux/init.h>
15 #include <linux/interrupt.h>
17 #include <linux/module.h>
19 #include <linux/of_address.h>
20 #include <linux/of_device.h>
21 #include <linux/of_irq.h>
22 #include <linux/pinctrl/consumer.h>
23 #include <linux/pinctrl/pinconf-generic.h>
24 #include <linux/regmap.h>
26 #include "../pinctrl/core.h"
27 #include "../pinctrl/pinctrl-rockchip.h"
29 #define GPIO_TYPE_V1 (0) /* GPIO Version ID reserved */
30 #define GPIO_TYPE_V2 (0x01000C2B) /* GPIO Version ID 0x01000C2B */
32 static const struct rockchip_gpio_regs gpio_regs_v1 = {
40 .int_rawstatus = 0x44,
46 static const struct rockchip_gpio_regs gpio_regs_v2 = {
55 .int_rawstatus = 0x58,
58 .dbclk_div_con = 0x48,
64 static inline void gpio_writel_v2(u32 val, void __iomem *reg)
66 writel((val & 0xffff) | 0xffff0000, reg);
67 writel((val >> 16) | 0xffff0000, reg + 0x4);
70 static inline u32 gpio_readl_v2(void __iomem *reg)
72 return readl(reg + 0x4) << 16 | readl(reg);
75 static inline void rockchip_gpio_writel(struct rockchip_pin_bank *bank,
76 u32 value, unsigned int offset)
78 void __iomem *reg = bank->reg_base + offset;
80 if (bank->gpio_type == GPIO_TYPE_V2)
81 gpio_writel_v2(value, reg);
86 static inline u32 rockchip_gpio_readl(struct rockchip_pin_bank *bank,
89 void __iomem *reg = bank->reg_base + offset;
92 if (bank->gpio_type == GPIO_TYPE_V2)
93 value = gpio_readl_v2(reg);
100 static inline void rockchip_gpio_writel_bit(struct rockchip_pin_bank *bank,
104 void __iomem *reg = bank->reg_base + offset;
107 if (bank->gpio_type == GPIO_TYPE_V2) {
109 data = BIT(bit % 16) | BIT(bit % 16 + 16);
111 data = BIT(bit % 16 + 16);
112 writel(data, bit >= 16 ? reg + 0x4 : reg);
122 static inline u32 rockchip_gpio_readl_bit(struct rockchip_pin_bank *bank,
123 u32 bit, unsigned int offset)
125 void __iomem *reg = bank->reg_base + offset;
128 if (bank->gpio_type == GPIO_TYPE_V2) {
129 data = readl(bit >= 16 ? reg + 0x4 : reg);
139 static int rockchip_gpio_get_direction(struct gpio_chip *chip,
142 struct rockchip_pin_bank *bank = gpiochip_get_data(chip);
145 data = rockchip_gpio_readl_bit(bank, offset, bank->gpio_regs->port_ddr);
147 return GPIO_LINE_DIRECTION_OUT;
149 return GPIO_LINE_DIRECTION_IN;
152 static int rockchip_gpio_set_direction(struct gpio_chip *chip,
153 unsigned int offset, bool input)
155 struct rockchip_pin_bank *bank = gpiochip_get_data(chip);
157 u32 data = input ? 0 : 1;
161 pinctrl_gpio_direction_input(bank->pin_base + offset);
163 pinctrl_gpio_direction_output(bank->pin_base + offset);
165 raw_spin_lock_irqsave(&bank->slock, flags);
166 rockchip_gpio_writel_bit(bank, offset, data, bank->gpio_regs->port_ddr);
167 raw_spin_unlock_irqrestore(&bank->slock, flags);
172 static void rockchip_gpio_set(struct gpio_chip *gc, unsigned int offset,
175 struct rockchip_pin_bank *bank = gpiochip_get_data(gc);
178 raw_spin_lock_irqsave(&bank->slock, flags);
179 rockchip_gpio_writel_bit(bank, offset, value, bank->gpio_regs->port_dr);
180 raw_spin_unlock_irqrestore(&bank->slock, flags);
183 static int rockchip_gpio_get(struct gpio_chip *gc, unsigned int offset)
185 struct rockchip_pin_bank *bank = gpiochip_get_data(gc);
188 data = readl(bank->reg_base + bank->gpio_regs->ext_port);
195 static int rockchip_gpio_set_debounce(struct gpio_chip *gc,
197 unsigned int debounce)
199 struct rockchip_pin_bank *bank = gpiochip_get_data(gc);
200 const struct rockchip_gpio_regs *reg = bank->gpio_regs;
201 unsigned long flags, div_reg, freq, max_debounce;
202 bool div_debounce_support;
203 unsigned int cur_div_reg;
206 if (bank->gpio_type == GPIO_TYPE_V2 && !IS_ERR(bank->db_clk)) {
207 div_debounce_support = true;
208 freq = clk_get_rate(bank->db_clk);
209 max_debounce = (GENMASK(23, 0) + 1) * 2 * 1000000 / freq;
210 if (debounce > max_debounce)
213 div = debounce * freq;
214 div_reg = DIV_ROUND_CLOSEST_ULL(div, 2 * USEC_PER_SEC) - 1;
216 div_debounce_support = false;
219 raw_spin_lock_irqsave(&bank->slock, flags);
221 /* Only the v1 needs to configure div_en and div_con for dbclk */
223 if (div_debounce_support) {
224 /* Configure the max debounce from consumers */
225 cur_div_reg = readl(bank->reg_base +
227 if (cur_div_reg < div_reg)
228 writel(div_reg, bank->reg_base +
230 rockchip_gpio_writel_bit(bank, offset, 1,
234 rockchip_gpio_writel_bit(bank, offset, 1, reg->debounce);
236 if (div_debounce_support)
237 rockchip_gpio_writel_bit(bank, offset, 0,
240 rockchip_gpio_writel_bit(bank, offset, 0, reg->debounce);
243 raw_spin_unlock_irqrestore(&bank->slock, flags);
245 /* Enable or disable dbclk at last */
246 if (div_debounce_support) {
248 clk_prepare_enable(bank->db_clk);
250 clk_disable_unprepare(bank->db_clk);
256 static int rockchip_gpio_direction_input(struct gpio_chip *gc,
259 return rockchip_gpio_set_direction(gc, offset, true);
262 static int rockchip_gpio_direction_output(struct gpio_chip *gc,
263 unsigned int offset, int value)
265 rockchip_gpio_set(gc, offset, value);
267 return rockchip_gpio_set_direction(gc, offset, false);
271 * gpiolib set_config callback function. The setting of the pin
272 * mux function as 'gpio output' will be handled by the pinctrl subsystem
275 static int rockchip_gpio_set_config(struct gpio_chip *gc, unsigned int offset,
276 unsigned long config)
278 enum pin_config_param param = pinconf_to_config_param(config);
281 case PIN_CONFIG_INPUT_DEBOUNCE:
282 rockchip_gpio_set_debounce(gc, offset, true);
284 * Rockchip's gpio could only support up to one period
285 * of the debounce clock(pclk), which is far away from
286 * satisftying the requirement, as pclk is usually near
287 * 100MHz shared by all peripherals. So the fact is it
288 * has crippled debounce capability could only be useful
289 * to prevent any spurious glitches from waking up the system
290 * if the gpio is conguired as wakeup interrupt source. Let's
291 * still return -ENOTSUPP as before, to make sure the caller
292 * of gpiod_set_debounce won't change its behaviour.
301 * gpiolib gpio_to_irq callback function. Creates a mapping between a GPIO pin
302 * and a virtual IRQ, if not already present.
304 static int rockchip_gpio_to_irq(struct gpio_chip *gc, unsigned int offset)
306 struct rockchip_pin_bank *bank = gpiochip_get_data(gc);
312 virq = irq_create_mapping(bank->domain, offset);
314 return (virq) ? : -ENXIO;
317 static const struct gpio_chip rockchip_gpiolib_chip = {
318 .request = gpiochip_generic_request,
319 .free = gpiochip_generic_free,
320 .set = rockchip_gpio_set,
321 .get = rockchip_gpio_get,
322 .get_direction = rockchip_gpio_get_direction,
323 .direction_input = rockchip_gpio_direction_input,
324 .direction_output = rockchip_gpio_direction_output,
325 .set_config = rockchip_gpio_set_config,
326 .to_irq = rockchip_gpio_to_irq,
327 .owner = THIS_MODULE,
330 static void rockchip_irq_demux(struct irq_desc *desc)
332 struct irq_chip *chip = irq_desc_get_chip(desc);
333 struct rockchip_pin_bank *bank = irq_desc_get_handler_data(desc);
336 dev_dbg(bank->dev, "got irq for bank %s\n", bank->name);
338 chained_irq_enter(chip, desc);
340 pend = readl_relaxed(bank->reg_base + bank->gpio_regs->int_status);
343 unsigned int irq, virq;
347 virq = irq_find_mapping(bank->domain, irq);
350 dev_err(bank->dev, "unmapped irq %d\n", irq);
354 dev_dbg(bank->dev, "handling irq %d\n", irq);
357 * Triggering IRQ on both rising and falling edge
358 * needs manual intervention.
360 if (bank->toggle_edge_mode & BIT(irq)) {
361 u32 data, data_old, polarity;
364 data = readl_relaxed(bank->reg_base +
365 bank->gpio_regs->ext_port);
367 raw_spin_lock_irqsave(&bank->slock, flags);
369 polarity = readl_relaxed(bank->reg_base +
370 bank->gpio_regs->int_polarity);
372 polarity &= ~BIT(irq);
374 polarity |= BIT(irq);
377 bank->gpio_regs->int_polarity);
379 raw_spin_unlock_irqrestore(&bank->slock, flags);
382 data = readl_relaxed(bank->reg_base +
383 bank->gpio_regs->ext_port);
384 } while ((data & BIT(irq)) != (data_old & BIT(irq)));
387 generic_handle_irq(virq);
390 chained_irq_exit(chip, desc);
393 static int rockchip_irq_set_type(struct irq_data *d, unsigned int type)
395 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
396 struct rockchip_pin_bank *bank = gc->private;
397 u32 mask = BIT(d->hwirq);
404 raw_spin_lock_irqsave(&bank->slock, flags);
406 rockchip_gpio_writel_bit(bank, d->hwirq, 0,
407 bank->gpio_regs->port_ddr);
409 raw_spin_unlock_irqrestore(&bank->slock, flags);
411 if (type & IRQ_TYPE_EDGE_BOTH)
412 irq_set_handler_locked(d, handle_edge_irq);
414 irq_set_handler_locked(d, handle_level_irq);
416 raw_spin_lock_irqsave(&bank->slock, flags);
418 level = rockchip_gpio_readl(bank, bank->gpio_regs->int_type);
419 polarity = rockchip_gpio_readl(bank, bank->gpio_regs->int_polarity);
421 if (type == IRQ_TYPE_EDGE_BOTH) {
422 if (bank->gpio_type == GPIO_TYPE_V2) {
423 rockchip_gpio_writel_bit(bank, d->hwirq, 1,
424 bank->gpio_regs->int_bothedge);
427 bank->toggle_edge_mode |= mask;
431 * Determine gpio state. If 1 next interrupt should be
432 * low otherwise high.
434 data = readl(bank->reg_base + bank->gpio_regs->ext_port);
441 if (bank->gpio_type == GPIO_TYPE_V2) {
442 rockchip_gpio_writel_bit(bank, d->hwirq, 0,
443 bank->gpio_regs->int_bothedge);
445 bank->toggle_edge_mode &= ~mask;
448 case IRQ_TYPE_EDGE_RISING:
452 case IRQ_TYPE_EDGE_FALLING:
456 case IRQ_TYPE_LEVEL_HIGH:
460 case IRQ_TYPE_LEVEL_LOW:
470 rockchip_gpio_writel(bank, level, bank->gpio_regs->int_type);
471 rockchip_gpio_writel(bank, polarity, bank->gpio_regs->int_polarity);
473 raw_spin_unlock_irqrestore(&bank->slock, flags);
478 static void rockchip_irq_suspend(struct irq_data *d)
480 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
481 struct rockchip_pin_bank *bank = gc->private;
483 bank->saved_masks = irq_reg_readl(gc, bank->gpio_regs->int_mask);
484 irq_reg_writel(gc, ~gc->wake_active, bank->gpio_regs->int_mask);
487 static void rockchip_irq_resume(struct irq_data *d)
489 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
490 struct rockchip_pin_bank *bank = gc->private;
492 irq_reg_writel(gc, bank->saved_masks, bank->gpio_regs->int_mask);
495 static void rockchip_irq_enable(struct irq_data *d)
497 irq_gc_mask_clr_bit(d);
500 static void rockchip_irq_disable(struct irq_data *d)
502 irq_gc_mask_set_bit(d);
505 static int rockchip_interrupts_register(struct rockchip_pin_bank *bank)
507 unsigned int clr = IRQ_NOREQUEST | IRQ_NOPROBE | IRQ_NOAUTOEN;
508 struct irq_chip_generic *gc;
511 bank->domain = irq_domain_add_linear(bank->of_node, 32,
512 &irq_generic_chip_ops, NULL);
514 dev_warn(bank->dev, "could not init irq domain for bank %s\n",
519 ret = irq_alloc_domain_generic_chips(bank->domain, 32, 1,
524 dev_err(bank->dev, "could not alloc generic chips for bank %s\n",
526 irq_domain_remove(bank->domain);
530 gc = irq_get_domain_generic_chip(bank->domain, 0);
531 if (bank->gpio_type == GPIO_TYPE_V2) {
532 gc->reg_writel = gpio_writel_v2;
533 gc->reg_readl = gpio_readl_v2;
536 gc->reg_base = bank->reg_base;
538 gc->chip_types[0].regs.mask = bank->gpio_regs->int_mask;
539 gc->chip_types[0].regs.ack = bank->gpio_regs->port_eoi;
540 gc->chip_types[0].chip.irq_ack = irq_gc_ack_set_bit;
541 gc->chip_types[0].chip.irq_mask = irq_gc_mask_set_bit;
542 gc->chip_types[0].chip.irq_unmask = irq_gc_mask_clr_bit;
543 gc->chip_types[0].chip.irq_enable = rockchip_irq_enable;
544 gc->chip_types[0].chip.irq_disable = rockchip_irq_disable;
545 gc->chip_types[0].chip.irq_set_wake = irq_gc_set_wake;
546 gc->chip_types[0].chip.irq_suspend = rockchip_irq_suspend;
547 gc->chip_types[0].chip.irq_resume = rockchip_irq_resume;
548 gc->chip_types[0].chip.irq_set_type = rockchip_irq_set_type;
549 gc->wake_enabled = IRQ_MSK(bank->nr_pins);
552 * Linux assumes that all interrupts start out disabled/masked.
553 * Our driver only uses the concept of masked and always keeps
554 * things enabled, so for us that's all masked and all enabled.
556 rockchip_gpio_writel(bank, 0xffffffff, bank->gpio_regs->int_mask);
557 rockchip_gpio_writel(bank, 0xffffffff, bank->gpio_regs->port_eoi);
558 rockchip_gpio_writel(bank, 0xffffffff, bank->gpio_regs->int_en);
559 gc->mask_cache = 0xffffffff;
561 irq_set_chained_handler_and_data(bank->irq,
562 rockchip_irq_demux, bank);
567 static int rockchip_gpiolib_register(struct rockchip_pin_bank *bank)
569 struct gpio_chip *gc;
572 bank->gpio_chip = rockchip_gpiolib_chip;
574 gc = &bank->gpio_chip;
575 gc->base = bank->pin_base;
576 gc->ngpio = bank->nr_pins;
577 gc->label = bank->name;
578 gc->parent = bank->dev;
579 #ifdef CONFIG_OF_GPIO
580 gc->of_node = of_node_get(bank->of_node);
583 ret = gpiochip_add_data(gc, bank);
585 dev_err(bank->dev, "failed to add gpiochip %s, %d\n",
591 * For DeviceTree-supported systems, the gpio core checks the
592 * pinctrl's device node for the "gpio-ranges" property.
593 * If it is present, it takes care of adding the pin ranges
594 * for the driver. In this case the driver can skip ahead.
596 * In order to remain compatible with older, existing DeviceTree
597 * files which don't set the "gpio-ranges" property or systems that
598 * utilize ACPI the driver has to call gpiochip_add_pin_range().
600 if (!of_property_read_bool(bank->of_node, "gpio-ranges")) {
601 struct device_node *pctlnp = of_get_parent(bank->of_node);
602 struct pinctrl_dev *pctldev = NULL;
607 pctldev = of_pinctrl_get(pctlnp);
612 ret = gpiochip_add_pin_range(gc, dev_name(pctldev->dev), 0,
613 gc->base, gc->ngpio);
615 dev_err(bank->dev, "Failed to add pin range\n");
620 ret = rockchip_interrupts_register(bank);
622 dev_err(bank->dev, "failed to register interrupt, %d\n", ret);
629 gpiochip_remove(&bank->gpio_chip);
634 static int rockchip_get_bank_data(struct rockchip_pin_bank *bank)
639 if (of_address_to_resource(bank->of_node, 0, &res)) {
640 dev_err(bank->dev, "cannot find IO resource for bank\n");
644 bank->reg_base = devm_ioremap_resource(bank->dev, &res);
645 if (IS_ERR(bank->reg_base))
646 return PTR_ERR(bank->reg_base);
648 bank->irq = irq_of_parse_and_map(bank->of_node, 0);
652 bank->clk = of_clk_get(bank->of_node, 0);
653 if (IS_ERR(bank->clk))
654 return PTR_ERR(bank->clk);
656 clk_prepare_enable(bank->clk);
657 id = readl(bank->reg_base + gpio_regs_v2.version_id);
659 /* If not gpio v2, that is default to v1. */
660 if (id == GPIO_TYPE_V2) {
661 bank->gpio_regs = &gpio_regs_v2;
662 bank->gpio_type = GPIO_TYPE_V2;
663 bank->db_clk = of_clk_get(bank->of_node, 1);
664 if (IS_ERR(bank->db_clk)) {
665 dev_err(bank->dev, "cannot find debounce clk\n");
666 clk_disable_unprepare(bank->clk);
670 bank->gpio_regs = &gpio_regs_v1;
671 bank->gpio_type = GPIO_TYPE_V1;
677 static struct rockchip_pin_bank *
678 rockchip_gpio_find_bank(struct pinctrl_dev *pctldev, int id)
680 struct rockchip_pinctrl *info;
681 struct rockchip_pin_bank *bank;
684 info = pinctrl_dev_get_drvdata(pctldev);
685 bank = info->ctrl->pin_banks;
686 for (i = 0; i < info->ctrl->nr_banks; i++, bank++) {
687 if (bank->bank_num == id) {
693 return found ? bank : NULL;
696 static int rockchip_gpio_probe(struct platform_device *pdev)
698 struct device *dev = &pdev->dev;
699 struct device_node *np = dev->of_node;
700 struct device_node *pctlnp = of_get_parent(np);
701 struct pinctrl_dev *pctldev = NULL;
702 struct rockchip_pin_bank *bank = NULL;
703 struct rockchip_pin_deferred *cfg;
710 pctldev = of_pinctrl_get(pctlnp);
712 return -EPROBE_DEFER;
714 id = of_alias_get_id(np, "gpio");
718 bank = rockchip_gpio_find_bank(pctldev, id);
725 raw_spin_lock_init(&bank->slock);
727 ret = rockchip_get_bank_data(bank);
732 * Prevent clashes with a deferred output setting
733 * being added right at this moment.
735 mutex_lock(&bank->deferred_lock);
737 ret = rockchip_gpiolib_register(bank);
739 clk_disable_unprepare(bank->clk);
740 mutex_unlock(&bank->deferred_lock);
744 while (!list_empty(&bank->deferred_pins)) {
745 cfg = list_first_entry(&bank->deferred_pins,
746 struct rockchip_pin_deferred, head);
747 list_del(&cfg->head);
749 switch (cfg->param) {
750 case PIN_CONFIG_OUTPUT:
751 ret = rockchip_gpio_direction_output(&bank->gpio_chip, cfg->pin, cfg->arg);
753 dev_warn(dev, "setting output pin %u to %u failed\n", cfg->pin,
757 dev_warn(dev, "unknown deferred config param %d\n", cfg->param);
763 mutex_unlock(&bank->deferred_lock);
765 platform_set_drvdata(pdev, bank);
766 dev_info(dev, "probed %pOF\n", np);
771 static int rockchip_gpio_remove(struct platform_device *pdev)
773 struct rockchip_pin_bank *bank = platform_get_drvdata(pdev);
775 clk_disable_unprepare(bank->clk);
776 gpiochip_remove(&bank->gpio_chip);
781 static const struct of_device_id rockchip_gpio_match[] = {
782 { .compatible = "rockchip,gpio-bank", },
783 { .compatible = "rockchip,rk3188-gpio-bank0" },
787 static struct platform_driver rockchip_gpio_driver = {
788 .probe = rockchip_gpio_probe,
789 .remove = rockchip_gpio_remove,
791 .name = "rockchip-gpio",
792 .of_match_table = rockchip_gpio_match,
796 static int __init rockchip_gpio_init(void)
798 return platform_driver_register(&rockchip_gpio_driver);
800 postcore_initcall(rockchip_gpio_init);
802 static void __exit rockchip_gpio_exit(void)
804 platform_driver_unregister(&rockchip_gpio_driver);
806 module_exit(rockchip_gpio_exit);
808 MODULE_DESCRIPTION("Rockchip gpio driver");
809 MODULE_ALIAS("platform:rockchip-gpio");
810 MODULE_LICENSE("GPL v2");
811 MODULE_DEVICE_TABLE(of, rockchip_gpio_match);