1 // SPDX-License-Identifier: GPL-2.0
3 * Renesas R-Car GPIO Support
5 * Copyright (C) 2014 Renesas Electronics Corporation
6 * Copyright (C) 2013 Magnus Damm
10 #include <linux/gpio/driver.h>
11 #include <linux/init.h>
12 #include <linux/interrupt.h>
14 #include <linux/ioport.h>
15 #include <linux/irq.h>
16 #include <linux/module.h>
18 #include <linux/pinctrl/consumer.h>
19 #include <linux/platform_device.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/spinlock.h>
22 #include <linux/slab.h>
24 struct gpio_rcar_bank_info
{
34 struct gpio_rcar_info
{
36 bool has_both_edge_trigger
;
41 struct gpio_rcar_priv
{
45 struct gpio_chip gpio_chip
;
46 unsigned int irq_parent
;
48 struct gpio_rcar_info info
;
49 struct gpio_rcar_bank_info bank_info
;
52 #define IOINTSEL 0x00 /* General IO/Interrupt Switching Register */
53 #define INOUTSEL 0x04 /* General Input/Output Switching Register */
54 #define OUTDT 0x08 /* General Output Register */
55 #define INDT 0x0c /* General Input Register */
56 #define INTDT 0x10 /* Interrupt Display Register */
57 #define INTCLR 0x14 /* Interrupt Clear Register */
58 #define INTMSK 0x18 /* Interrupt Mask Register */
59 #define MSKCLR 0x1c /* Interrupt Mask Clear Register */
60 #define POSNEG 0x20 /* Positive/Negative Logic Select Register */
61 #define EDGLEVEL 0x24 /* Edge/level Select Register */
62 #define FILONOFF 0x28 /* Chattering Prevention On/Off Register */
63 #define OUTDTSEL 0x40 /* Output Data Select Register */
64 #define BOTHEDGE 0x4c /* One Edge/Both Edge Select Register */
65 #define INEN 0x50 /* General Input Enable Register */
67 #define RCAR_MAX_GPIO_PER_BANK 32
69 static inline u32
gpio_rcar_read(struct gpio_rcar_priv
*p
, int offs
)
71 return ioread32(p
->base
+ offs
);
74 static inline void gpio_rcar_write(struct gpio_rcar_priv
*p
, int offs
,
77 iowrite32(value
, p
->base
+ offs
);
80 static void gpio_rcar_modify_bit(struct gpio_rcar_priv
*p
, int offs
,
83 u32 tmp
= gpio_rcar_read(p
, offs
);
90 gpio_rcar_write(p
, offs
, tmp
);
93 static void gpio_rcar_irq_disable(struct irq_data
*d
)
95 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
96 struct gpio_rcar_priv
*p
= gpiochip_get_data(gc
);
97 irq_hw_number_t hwirq
= irqd_to_hwirq(d
);
99 gpio_rcar_write(p
, INTMSK
, ~BIT(hwirq
));
100 gpiochip_disable_irq(gc
, hwirq
);
103 static void gpio_rcar_irq_enable(struct irq_data
*d
)
105 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
106 struct gpio_rcar_priv
*p
= gpiochip_get_data(gc
);
107 irq_hw_number_t hwirq
= irqd_to_hwirq(d
);
109 gpiochip_enable_irq(gc
, hwirq
);
110 gpio_rcar_write(p
, MSKCLR
, BIT(hwirq
));
113 static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv
*p
,
115 bool active_high_rising_edge
,
121 /* follow steps in the GPIO documentation for
122 * "Setting Edge-Sensitive Interrupt Input Mode" and
123 * "Setting Level-Sensitive Interrupt Input Mode"
126 spin_lock_irqsave(&p
->lock
, flags
);
128 /* Configure positive or negative logic in POSNEG */
129 gpio_rcar_modify_bit(p
, POSNEG
, hwirq
, !active_high_rising_edge
);
131 /* Configure edge or level trigger in EDGLEVEL */
132 gpio_rcar_modify_bit(p
, EDGLEVEL
, hwirq
, !level_trigger
);
134 /* Select one edge or both edges in BOTHEDGE */
135 if (p
->info
.has_both_edge_trigger
)
136 gpio_rcar_modify_bit(p
, BOTHEDGE
, hwirq
, both
);
138 /* Select "Interrupt Input Mode" in IOINTSEL */
139 gpio_rcar_modify_bit(p
, IOINTSEL
, hwirq
, true);
141 /* Write INTCLR in case of edge trigger */
143 gpio_rcar_write(p
, INTCLR
, BIT(hwirq
));
145 spin_unlock_irqrestore(&p
->lock
, flags
);
148 static int gpio_rcar_irq_set_type(struct irq_data
*d
, unsigned int type
)
150 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
151 struct gpio_rcar_priv
*p
= gpiochip_get_data(gc
);
152 unsigned int hwirq
= irqd_to_hwirq(d
);
154 dev_dbg(p
->dev
, "sense irq = %d, type = %d\n", hwirq
, type
);
156 switch (type
& IRQ_TYPE_SENSE_MASK
) {
157 case IRQ_TYPE_LEVEL_HIGH
:
158 gpio_rcar_config_interrupt_input_mode(p
, hwirq
, true, true,
161 case IRQ_TYPE_LEVEL_LOW
:
162 gpio_rcar_config_interrupt_input_mode(p
, hwirq
, false, true,
165 case IRQ_TYPE_EDGE_RISING
:
166 gpio_rcar_config_interrupt_input_mode(p
, hwirq
, true, false,
169 case IRQ_TYPE_EDGE_FALLING
:
170 gpio_rcar_config_interrupt_input_mode(p
, hwirq
, false, false,
173 case IRQ_TYPE_EDGE_BOTH
:
174 if (!p
->info
.has_both_edge_trigger
)
176 gpio_rcar_config_interrupt_input_mode(p
, hwirq
, true, false,
185 static int gpio_rcar_irq_set_wake(struct irq_data
*d
, unsigned int on
)
187 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
188 struct gpio_rcar_priv
*p
= gpiochip_get_data(gc
);
192 error
= irq_set_irq_wake(p
->irq_parent
, on
);
194 dev_dbg(p
->dev
, "irq %u doesn't support irq_set_wake\n",
201 atomic_inc(&p
->wakeup_path
);
203 atomic_dec(&p
->wakeup_path
);
208 static const struct irq_chip gpio_rcar_irq_chip
= {
210 .irq_mask
= gpio_rcar_irq_disable
,
211 .irq_unmask
= gpio_rcar_irq_enable
,
212 .irq_set_type
= gpio_rcar_irq_set_type
,
213 .irq_set_wake
= gpio_rcar_irq_set_wake
,
214 .flags
= IRQCHIP_IMMUTABLE
| IRQCHIP_SET_TYPE_MASKED
|
215 IRQCHIP_MASK_ON_SUSPEND
,
216 GPIOCHIP_IRQ_RESOURCE_HELPERS
,
219 static irqreturn_t
gpio_rcar_irq_handler(int irq
, void *dev_id
)
221 struct gpio_rcar_priv
*p
= dev_id
;
223 unsigned int offset
, irqs_handled
= 0;
225 while ((pending
= gpio_rcar_read(p
, INTDT
) &
226 gpio_rcar_read(p
, INTMSK
))) {
227 offset
= __ffs(pending
);
228 gpio_rcar_write(p
, INTCLR
, BIT(offset
));
229 generic_handle_domain_irq(p
->gpio_chip
.irq
.domain
,
234 return irqs_handled
? IRQ_HANDLED
: IRQ_NONE
;
237 static void gpio_rcar_config_general_input_output_mode(struct gpio_chip
*chip
,
241 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
244 /* follow steps in the GPIO documentation for
245 * "Setting General Output Mode" and
246 * "Setting General Input Mode"
249 spin_lock_irqsave(&p
->lock
, flags
);
251 /* Configure positive logic in POSNEG */
252 gpio_rcar_modify_bit(p
, POSNEG
, gpio
, false);
254 /* Select "General Input/Output Mode" in IOINTSEL */
255 gpio_rcar_modify_bit(p
, IOINTSEL
, gpio
, false);
257 /* Select Input Mode or Output Mode in INOUTSEL */
258 gpio_rcar_modify_bit(p
, INOUTSEL
, gpio
, output
);
260 /* Select General Output Register to output data in OUTDTSEL */
261 if (p
->info
.has_outdtsel
&& output
)
262 gpio_rcar_modify_bit(p
, OUTDTSEL
, gpio
, false);
264 spin_unlock_irqrestore(&p
->lock
, flags
);
267 static int gpio_rcar_request(struct gpio_chip
*chip
, unsigned offset
)
269 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
272 error
= pm_runtime_get_sync(p
->dev
);
274 pm_runtime_put(p
->dev
);
278 error
= pinctrl_gpio_request(chip
, offset
);
280 pm_runtime_put(p
->dev
);
285 static void gpio_rcar_free(struct gpio_chip
*chip
, unsigned offset
)
287 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
289 pinctrl_gpio_free(chip
, offset
);
292 * Set the GPIO as an input to ensure that the next GPIO request won't
293 * drive the GPIO pin as an output.
295 gpio_rcar_config_general_input_output_mode(chip
, offset
, false);
297 pm_runtime_put(p
->dev
);
300 static int gpio_rcar_get_direction(struct gpio_chip
*chip
, unsigned int offset
)
302 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
304 if (gpio_rcar_read(p
, INOUTSEL
) & BIT(offset
))
305 return GPIO_LINE_DIRECTION_OUT
;
307 return GPIO_LINE_DIRECTION_IN
;
310 static int gpio_rcar_direction_input(struct gpio_chip
*chip
, unsigned offset
)
312 gpio_rcar_config_general_input_output_mode(chip
, offset
, false);
316 static int gpio_rcar_get(struct gpio_chip
*chip
, unsigned offset
)
318 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
319 u32 bit
= BIT(offset
);
322 * Before R-Car Gen3, INDT does not show correct pin state when
323 * configured as output, so use OUTDT in case of output pins
325 if (!p
->info
.has_always_in
&& (gpio_rcar_read(p
, INOUTSEL
) & bit
))
326 return !!(gpio_rcar_read(p
, OUTDT
) & bit
);
328 return !!(gpio_rcar_read(p
, INDT
) & bit
);
331 static int gpio_rcar_get_multiple(struct gpio_chip
*chip
, unsigned long *mask
,
334 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
335 u32 bankmask
, outputs
, m
, val
= 0;
338 bankmask
= mask
[0] & GENMASK(chip
->ngpio
- 1, 0);
339 if (chip
->valid_mask
)
340 bankmask
&= chip
->valid_mask
[0];
345 if (p
->info
.has_always_in
) {
346 bits
[0] = gpio_rcar_read(p
, INDT
) & bankmask
;
350 spin_lock_irqsave(&p
->lock
, flags
);
351 outputs
= gpio_rcar_read(p
, INOUTSEL
);
352 m
= outputs
& bankmask
;
354 val
|= gpio_rcar_read(p
, OUTDT
) & m
;
356 m
= ~outputs
& bankmask
;
358 val
|= gpio_rcar_read(p
, INDT
) & m
;
359 spin_unlock_irqrestore(&p
->lock
, flags
);
365 static void gpio_rcar_set(struct gpio_chip
*chip
, unsigned offset
, int value
)
367 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
370 spin_lock_irqsave(&p
->lock
, flags
);
371 gpio_rcar_modify_bit(p
, OUTDT
, offset
, value
);
372 spin_unlock_irqrestore(&p
->lock
, flags
);
375 static void gpio_rcar_set_multiple(struct gpio_chip
*chip
, unsigned long *mask
,
378 struct gpio_rcar_priv
*p
= gpiochip_get_data(chip
);
382 bankmask
= mask
[0] & GENMASK(chip
->ngpio
- 1, 0);
383 if (chip
->valid_mask
)
384 bankmask
&= chip
->valid_mask
[0];
389 spin_lock_irqsave(&p
->lock
, flags
);
390 val
= gpio_rcar_read(p
, OUTDT
);
392 val
|= (bankmask
& bits
[0]);
393 gpio_rcar_write(p
, OUTDT
, val
);
394 spin_unlock_irqrestore(&p
->lock
, flags
);
397 static int gpio_rcar_direction_output(struct gpio_chip
*chip
, unsigned offset
,
400 /* write GPIO value to output before selecting output mode of pin */
401 gpio_rcar_set(chip
, offset
, value
);
402 gpio_rcar_config_general_input_output_mode(chip
, offset
, true);
406 static const struct gpio_rcar_info gpio_rcar_info_gen1
= {
407 .has_outdtsel
= false,
408 .has_both_edge_trigger
= false,
409 .has_always_in
= false,
413 static const struct gpio_rcar_info gpio_rcar_info_gen2
= {
414 .has_outdtsel
= true,
415 .has_both_edge_trigger
= true,
416 .has_always_in
= false,
420 static const struct gpio_rcar_info gpio_rcar_info_gen3
= {
421 .has_outdtsel
= true,
422 .has_both_edge_trigger
= true,
423 .has_always_in
= true,
427 static const struct gpio_rcar_info gpio_rcar_info_gen4
= {
428 .has_outdtsel
= true,
429 .has_both_edge_trigger
= true,
430 .has_always_in
= true,
434 static const struct of_device_id gpio_rcar_of_table
[] = {
436 .compatible
= "renesas,gpio-r8a779a0",
437 .data
= &gpio_rcar_info_gen4
,
439 .compatible
= "renesas,rcar-gen1-gpio",
440 .data
= &gpio_rcar_info_gen1
,
442 .compatible
= "renesas,rcar-gen2-gpio",
443 .data
= &gpio_rcar_info_gen2
,
445 .compatible
= "renesas,rcar-gen3-gpio",
446 .data
= &gpio_rcar_info_gen3
,
448 .compatible
= "renesas,rcar-gen4-gpio",
449 .data
= &gpio_rcar_info_gen4
,
451 .compatible
= "renesas,gpio-rcar",
452 .data
= &gpio_rcar_info_gen1
,
458 MODULE_DEVICE_TABLE(of
, gpio_rcar_of_table
);
460 static int gpio_rcar_parse_dt(struct gpio_rcar_priv
*p
, unsigned int *npins
)
462 struct device_node
*np
= p
->dev
->of_node
;
463 const struct gpio_rcar_info
*info
;
464 struct of_phandle_args args
;
467 info
= of_device_get_match_data(p
->dev
);
470 ret
= of_parse_phandle_with_fixed_args(np
, "gpio-ranges", 3, 0, &args
);
471 *npins
= ret
== 0 ? args
.args
[2] : RCAR_MAX_GPIO_PER_BANK
;
473 if (*npins
== 0 || *npins
> RCAR_MAX_GPIO_PER_BANK
) {
474 dev_warn(p
->dev
, "Invalid number of gpio lines %u, using %u\n",
475 *npins
, RCAR_MAX_GPIO_PER_BANK
);
476 *npins
= RCAR_MAX_GPIO_PER_BANK
;
482 static void gpio_rcar_enable_inputs(struct gpio_rcar_priv
*p
)
484 u32 mask
= GENMASK(p
->gpio_chip
.ngpio
- 1, 0);
486 /* Select "Input Enable" in INEN */
487 if (p
->gpio_chip
.valid_mask
)
488 mask
&= p
->gpio_chip
.valid_mask
[0];
490 gpio_rcar_write(p
, INEN
, gpio_rcar_read(p
, INEN
) | mask
);
493 static int gpio_rcar_probe(struct platform_device
*pdev
)
495 struct gpio_rcar_priv
*p
;
496 struct gpio_chip
*gpio_chip
;
497 struct gpio_irq_chip
*girq
;
498 struct device
*dev
= &pdev
->dev
;
499 const char *name
= dev_name(dev
);
503 p
= devm_kzalloc(dev
, sizeof(*p
), GFP_KERNEL
);
508 spin_lock_init(&p
->lock
);
510 /* Get device configuration from DT node */
511 ret
= gpio_rcar_parse_dt(p
, &npins
);
515 platform_set_drvdata(pdev
, p
);
517 pm_runtime_enable(dev
);
519 ret
= platform_get_irq(pdev
, 0);
524 p
->base
= devm_platform_ioremap_resource(pdev
, 0);
525 if (IS_ERR(p
->base
)) {
526 ret
= PTR_ERR(p
->base
);
530 gpio_chip
= &p
->gpio_chip
;
531 gpio_chip
->request
= gpio_rcar_request
;
532 gpio_chip
->free
= gpio_rcar_free
;
533 gpio_chip
->get_direction
= gpio_rcar_get_direction
;
534 gpio_chip
->direction_input
= gpio_rcar_direction_input
;
535 gpio_chip
->get
= gpio_rcar_get
;
536 gpio_chip
->get_multiple
= gpio_rcar_get_multiple
;
537 gpio_chip
->direction_output
= gpio_rcar_direction_output
;
538 gpio_chip
->set
= gpio_rcar_set
;
539 gpio_chip
->set_multiple
= gpio_rcar_set_multiple
;
540 gpio_chip
->label
= name
;
541 gpio_chip
->parent
= dev
;
542 gpio_chip
->owner
= THIS_MODULE
;
543 gpio_chip
->base
= -1;
544 gpio_chip
->ngpio
= npins
;
546 girq
= &gpio_chip
->irq
;
547 gpio_irq_chip_set_chip(girq
, &gpio_rcar_irq_chip
);
548 /* This will let us handle the parent IRQ in the driver */
549 girq
->parent_handler
= NULL
;
550 girq
->num_parents
= 0;
551 girq
->parents
= NULL
;
552 girq
->default_type
= IRQ_TYPE_NONE
;
553 girq
->handler
= handle_level_irq
;
555 ret
= gpiochip_add_data(gpio_chip
, p
);
557 dev_err(dev
, "failed to add GPIO controller\n");
561 irq_domain_set_pm_device(gpio_chip
->irq
.domain
, dev
);
562 ret
= devm_request_irq(dev
, p
->irq_parent
, gpio_rcar_irq_handler
,
563 IRQF_SHARED
, name
, p
);
565 dev_err(dev
, "failed to request IRQ\n");
569 if (p
->info
.has_inen
) {
570 pm_runtime_get_sync(dev
);
571 gpio_rcar_enable_inputs(p
);
575 dev_info(dev
, "driving %d GPIOs\n", npins
);
580 gpiochip_remove(gpio_chip
);
582 pm_runtime_disable(dev
);
586 static void gpio_rcar_remove(struct platform_device
*pdev
)
588 struct gpio_rcar_priv
*p
= platform_get_drvdata(pdev
);
590 gpiochip_remove(&p
->gpio_chip
);
592 pm_runtime_disable(&pdev
->dev
);
595 #ifdef CONFIG_PM_SLEEP
596 static int gpio_rcar_suspend(struct device
*dev
)
598 struct gpio_rcar_priv
*p
= dev_get_drvdata(dev
);
600 p
->bank_info
.iointsel
= gpio_rcar_read(p
, IOINTSEL
);
601 p
->bank_info
.inoutsel
= gpio_rcar_read(p
, INOUTSEL
);
602 p
->bank_info
.outdt
= gpio_rcar_read(p
, OUTDT
);
603 p
->bank_info
.intmsk
= gpio_rcar_read(p
, INTMSK
);
604 p
->bank_info
.posneg
= gpio_rcar_read(p
, POSNEG
);
605 p
->bank_info
.edglevel
= gpio_rcar_read(p
, EDGLEVEL
);
606 if (p
->info
.has_both_edge_trigger
)
607 p
->bank_info
.bothedge
= gpio_rcar_read(p
, BOTHEDGE
);
609 if (atomic_read(&p
->wakeup_path
))
610 device_set_wakeup_path(dev
);
615 static int gpio_rcar_resume(struct device
*dev
)
617 struct gpio_rcar_priv
*p
= dev_get_drvdata(dev
);
621 for (offset
= 0; offset
< p
->gpio_chip
.ngpio
; offset
++) {
622 if (!gpiochip_line_is_valid(&p
->gpio_chip
, offset
))
627 if (!(p
->bank_info
.iointsel
& mask
)) {
628 if (p
->bank_info
.inoutsel
& mask
)
629 gpio_rcar_direction_output(
630 &p
->gpio_chip
, offset
,
631 !!(p
->bank_info
.outdt
& mask
));
633 gpio_rcar_direction_input(&p
->gpio_chip
,
637 gpio_rcar_config_interrupt_input_mode(
640 !(p
->bank_info
.posneg
& mask
),
641 !(p
->bank_info
.edglevel
& mask
),
642 !!(p
->bank_info
.bothedge
& mask
));
644 if (p
->bank_info
.intmsk
& mask
)
645 gpio_rcar_write(p
, MSKCLR
, mask
);
649 if (p
->info
.has_inen
)
650 gpio_rcar_enable_inputs(p
);
654 #endif /* CONFIG_PM_SLEEP*/
656 static SIMPLE_DEV_PM_OPS(gpio_rcar_pm_ops
, gpio_rcar_suspend
, gpio_rcar_resume
);
658 static struct platform_driver gpio_rcar_device_driver
= {
659 .probe
= gpio_rcar_probe
,
660 .remove
= gpio_rcar_remove
,
663 .pm
= &gpio_rcar_pm_ops
,
664 .of_match_table
= gpio_rcar_of_table
,
668 module_platform_driver(gpio_rcar_device_driver
);
670 MODULE_AUTHOR("Magnus Damm");
671 MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
672 MODULE_LICENSE("GPL v2");