1 // SPDX-License-Identifier: GPL-2.0-only
3 * GPIO driver for Marvell SoCs
5 * Copyright (C) 2012 Marvell
11 * This driver is a fairly straightforward GPIO driver for the
12 * complete family of Marvell EBU SoC platforms (Orion, Dove,
13 * Kirkwood, Discovery, Armada 370/XP). The only complexity of this
14 * driver is the different register layout that exists between the
15 * non-SMP platforms (Orion, Dove, Kirkwood, Armada 370) and the SMP
16 * platforms (MV78200 from the Discovery family and the Armada
17 * XP). Therefore, this driver handles three variants of the GPIO
19 * - the basic variant, called "orion-gpio", with the simplest
20 * register set. Used on Orion, Dove, Kirkwoord, Armada 370 and
21 * non-SMP Discovery systems
22 * - the mv78200 variant for MV78200 Discovery systems. This variant
23 * turns the edge mask and level mask registers into CPU0 edge
24 * mask/level mask registers, and adds CPU1 edge mask/level mask
26 * - the armadaxp variant for Armada XP systems. This variant keeps
27 * the normal cause/edge mask/level mask registers when the global
28 * interrupts are used, but adds per-CPU cause/edge mask/level mask
29 * registers n a separate memory area for the per-CPU GPIO
33 #include <linux/bitops.h>
34 #include <linux/clk.h>
35 #include <linux/err.h>
36 #include <linux/gpio/driver.h>
37 #include <linux/gpio/consumer.h>
38 #include <linux/gpio/machine.h>
39 #include <linux/init.h>
41 #include <linux/irq.h>
42 #include <linux/irqchip/chained_irq.h>
43 #include <linux/irqdomain.h>
44 #include <linux/mfd/syscon.h>
45 #include <linux/of_device.h>
46 #include <linux/pinctrl/consumer.h>
47 #include <linux/platform_device.h>
48 #include <linux/pwm.h>
49 #include <linux/regmap.h>
50 #include <linux/slab.h>
53 * GPIO unit register offsets.
55 #define GPIO_OUT_OFF 0x0000
56 #define GPIO_IO_CONF_OFF 0x0004
57 #define GPIO_BLINK_EN_OFF 0x0008
58 #define GPIO_IN_POL_OFF 0x000c
59 #define GPIO_DATA_IN_OFF 0x0010
60 #define GPIO_EDGE_CAUSE_OFF 0x0014
61 #define GPIO_EDGE_MASK_OFF 0x0018
62 #define GPIO_LEVEL_MASK_OFF 0x001c
63 #define GPIO_BLINK_CNT_SELECT_OFF 0x0020
66 * PWM register offsets.
68 #define PWM_BLINK_ON_DURATION_OFF 0x0
69 #define PWM_BLINK_OFF_DURATION_OFF 0x4
70 #define PWM_BLINK_COUNTER_B_OFF 0x8
72 /* Armada 8k variant gpios register offsets */
73 #define AP80X_GPIO0_OFF_A8K 0x1040
74 #define CP11X_GPIO0_OFF_A8K 0x100
75 #define CP11X_GPIO1_OFF_A8K 0x140
77 /* The MV78200 has per-CPU registers for edge mask and level mask */
78 #define GPIO_EDGE_MASK_MV78200_OFF(cpu) ((cpu) ? 0x30 : 0x18)
79 #define GPIO_LEVEL_MASK_MV78200_OFF(cpu) ((cpu) ? 0x34 : 0x1C)
82 * The Armada XP has per-CPU registers for interrupt cause, interrupt
83 * mask and interrupt level mask. Those are in percpu_regs range.
85 #define GPIO_EDGE_CAUSE_ARMADAXP_OFF(cpu) ((cpu) * 0x4)
86 #define GPIO_EDGE_MASK_ARMADAXP_OFF(cpu) (0x10 + (cpu) * 0x4)
87 #define GPIO_LEVEL_MASK_ARMADAXP_OFF(cpu) (0x20 + (cpu) * 0x4)
89 #define MVEBU_GPIO_SOC_VARIANT_ORION 0x1
90 #define MVEBU_GPIO_SOC_VARIANT_MV78200 0x2
91 #define MVEBU_GPIO_SOC_VARIANT_ARMADAXP 0x3
92 #define MVEBU_GPIO_SOC_VARIANT_A8K 0x4
94 #define MVEBU_MAX_GPIO_PER_BANK 32
99 unsigned long clk_rate;
100 struct gpio_desc *gpiod;
101 struct pwm_chip chip;
103 struct mvebu_gpio_chip *mvchip;
105 /* Used to preserve GPIO/PWM registers across suspend/resume */
107 u32 blink_on_duration;
108 u32 blink_off_duration;
111 struct mvebu_gpio_chip {
112 struct gpio_chip chip;
115 struct regmap *percpu_regs;
117 struct irq_domain *domain;
120 /* Used for PWM support */
122 struct mvebu_pwm *mvpwm;
124 /* Used to preserve GPIO registers across suspend/resume */
129 u32 edge_mask_regs[4];
130 u32 level_mask_regs[4];
134 * Functions returning addresses of individual registers for a given
138 static void mvebu_gpioreg_edge_cause(struct mvebu_gpio_chip *mvchip,
139 struct regmap **map, unsigned int *offset)
143 switch (mvchip->soc_variant) {
144 case MVEBU_GPIO_SOC_VARIANT_ORION:
145 case MVEBU_GPIO_SOC_VARIANT_MV78200:
146 case MVEBU_GPIO_SOC_VARIANT_A8K:
148 *offset = GPIO_EDGE_CAUSE_OFF + mvchip->offset;
150 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
151 cpu = smp_processor_id();
152 *map = mvchip->percpu_regs;
153 *offset = GPIO_EDGE_CAUSE_ARMADAXP_OFF(cpu);
161 mvebu_gpio_read_edge_cause(struct mvebu_gpio_chip *mvchip)
167 mvebu_gpioreg_edge_cause(mvchip, &map, &offset);
168 regmap_read(map, offset, &val);
174 mvebu_gpio_write_edge_cause(struct mvebu_gpio_chip *mvchip, u32 val)
179 mvebu_gpioreg_edge_cause(mvchip, &map, &offset);
180 regmap_write(map, offset, val);
184 mvebu_gpioreg_edge_mask(struct mvebu_gpio_chip *mvchip,
185 struct regmap **map, unsigned int *offset)
189 switch (mvchip->soc_variant) {
190 case MVEBU_GPIO_SOC_VARIANT_ORION:
191 case MVEBU_GPIO_SOC_VARIANT_A8K:
193 *offset = GPIO_EDGE_MASK_OFF + mvchip->offset;
195 case MVEBU_GPIO_SOC_VARIANT_MV78200:
196 cpu = smp_processor_id();
198 *offset = GPIO_EDGE_MASK_MV78200_OFF(cpu);
200 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
201 cpu = smp_processor_id();
202 *map = mvchip->percpu_regs;
203 *offset = GPIO_EDGE_MASK_ARMADAXP_OFF(cpu);
211 mvebu_gpio_read_edge_mask(struct mvebu_gpio_chip *mvchip)
217 mvebu_gpioreg_edge_mask(mvchip, &map, &offset);
218 regmap_read(map, offset, &val);
224 mvebu_gpio_write_edge_mask(struct mvebu_gpio_chip *mvchip, u32 val)
229 mvebu_gpioreg_edge_mask(mvchip, &map, &offset);
230 regmap_write(map, offset, val);
234 mvebu_gpioreg_level_mask(struct mvebu_gpio_chip *mvchip,
235 struct regmap **map, unsigned int *offset)
239 switch (mvchip->soc_variant) {
240 case MVEBU_GPIO_SOC_VARIANT_ORION:
241 case MVEBU_GPIO_SOC_VARIANT_A8K:
243 *offset = GPIO_LEVEL_MASK_OFF + mvchip->offset;
245 case MVEBU_GPIO_SOC_VARIANT_MV78200:
246 cpu = smp_processor_id();
248 *offset = GPIO_LEVEL_MASK_MV78200_OFF(cpu);
250 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
251 cpu = smp_processor_id();
252 *map = mvchip->percpu_regs;
253 *offset = GPIO_LEVEL_MASK_ARMADAXP_OFF(cpu);
261 mvebu_gpio_read_level_mask(struct mvebu_gpio_chip *mvchip)
267 mvebu_gpioreg_level_mask(mvchip, &map, &offset);
268 regmap_read(map, offset, &val);
274 mvebu_gpio_write_level_mask(struct mvebu_gpio_chip *mvchip, u32 val)
279 mvebu_gpioreg_level_mask(mvchip, &map, &offset);
280 regmap_write(map, offset, val);
284 * Functions returning offsets of individual registers for a given
287 static unsigned int mvebu_pwmreg_blink_on_duration(struct mvebu_pwm *mvpwm)
289 return mvpwm->offset + PWM_BLINK_ON_DURATION_OFF;
292 static unsigned int mvebu_pwmreg_blink_off_duration(struct mvebu_pwm *mvpwm)
294 return mvpwm->offset + PWM_BLINK_OFF_DURATION_OFF;
298 * Functions implementing the gpio_chip methods
300 static void mvebu_gpio_set(struct gpio_chip *chip, unsigned int pin, int value)
302 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
304 regmap_update_bits(mvchip->regs, GPIO_OUT_OFF + mvchip->offset,
305 BIT(pin), value ? BIT(pin) : 0);
308 static int mvebu_gpio_get(struct gpio_chip *chip, unsigned int pin)
310 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
313 regmap_read(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset, &u);
318 regmap_read(mvchip->regs, GPIO_DATA_IN_OFF + mvchip->offset,
320 regmap_read(mvchip->regs, GPIO_IN_POL_OFF + mvchip->offset,
322 u = data_in ^ in_pol;
324 regmap_read(mvchip->regs, GPIO_OUT_OFF + mvchip->offset, &u);
327 return (u >> pin) & 1;
330 static void mvebu_gpio_blink(struct gpio_chip *chip, unsigned int pin,
333 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
335 regmap_update_bits(mvchip->regs, GPIO_BLINK_EN_OFF + mvchip->offset,
336 BIT(pin), value ? BIT(pin) : 0);
339 static int mvebu_gpio_direction_input(struct gpio_chip *chip, unsigned int pin)
341 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
345 * Check with the pinctrl driver whether this pin is usable as
348 ret = pinctrl_gpio_direction_input(chip->base + pin);
352 regmap_update_bits(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset,
358 static int mvebu_gpio_direction_output(struct gpio_chip *chip, unsigned int pin,
361 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
365 * Check with the pinctrl driver whether this pin is usable as
368 ret = pinctrl_gpio_direction_output(chip->base + pin);
372 mvebu_gpio_blink(chip, pin, 0);
373 mvebu_gpio_set(chip, pin, value);
375 regmap_update_bits(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset,
381 static int mvebu_gpio_get_direction(struct gpio_chip *chip, unsigned int pin)
383 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
386 regmap_read(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset, &u);
389 return GPIO_LINE_DIRECTION_IN;
391 return GPIO_LINE_DIRECTION_OUT;
394 static int mvebu_gpio_to_irq(struct gpio_chip *chip, unsigned int pin)
396 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
398 return irq_create_mapping(mvchip->domain, pin);
402 * Functions implementing the irq_chip methods
404 static void mvebu_gpio_irq_ack(struct irq_data *d)
406 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
407 struct mvebu_gpio_chip *mvchip = gc->private;
411 mvebu_gpio_write_edge_cause(mvchip, ~mask);
415 static void mvebu_gpio_edge_irq_mask(struct irq_data *d)
417 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
418 struct mvebu_gpio_chip *mvchip = gc->private;
419 struct irq_chip_type *ct = irq_data_get_chip_type(d);
423 ct->mask_cache_priv &= ~mask;
424 mvebu_gpio_write_edge_mask(mvchip, ct->mask_cache_priv);
428 static void mvebu_gpio_edge_irq_unmask(struct irq_data *d)
430 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
431 struct mvebu_gpio_chip *mvchip = gc->private;
432 struct irq_chip_type *ct = irq_data_get_chip_type(d);
436 mvebu_gpio_write_edge_cause(mvchip, ~mask);
437 ct->mask_cache_priv |= mask;
438 mvebu_gpio_write_edge_mask(mvchip, ct->mask_cache_priv);
442 static void mvebu_gpio_level_irq_mask(struct irq_data *d)
444 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
445 struct mvebu_gpio_chip *mvchip = gc->private;
446 struct irq_chip_type *ct = irq_data_get_chip_type(d);
450 ct->mask_cache_priv &= ~mask;
451 mvebu_gpio_write_level_mask(mvchip, ct->mask_cache_priv);
455 static void mvebu_gpio_level_irq_unmask(struct irq_data *d)
457 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
458 struct mvebu_gpio_chip *mvchip = gc->private;
459 struct irq_chip_type *ct = irq_data_get_chip_type(d);
463 ct->mask_cache_priv |= mask;
464 mvebu_gpio_write_level_mask(mvchip, ct->mask_cache_priv);
468 /*****************************************************************************
471 * GPIO_IN_POL register controls whether GPIO_DATA_IN will hold the same
472 * value of the line or the opposite value.
474 * Level IRQ handlers: DATA_IN is used directly as cause register.
475 * Interrupt are masked by LEVEL_MASK registers.
476 * Edge IRQ handlers: Change in DATA_IN are latched in EDGE_CAUSE.
477 * Interrupt are masked by EDGE_MASK registers.
478 * Both-edge handlers: Similar to regular Edge handlers, but also swaps
479 * the polarity to catch the next line transaction.
480 * This is a race condition that might not perfectly
481 * work on some use cases.
483 * Every eight GPIO lines are grouped (OR'ed) before going up to main
487 * data-in /--------| |-----| |----\
488 * -----| |----- ---- to main cause reg
489 * X \----------------| |----/
490 * polarity LEVEL mask
492 ****************************************************************************/
494 static int mvebu_gpio_irq_set_type(struct irq_data *d, unsigned int type)
496 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
497 struct irq_chip_type *ct = irq_data_get_chip_type(d);
498 struct mvebu_gpio_chip *mvchip = gc->private;
504 regmap_read(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset, &u);
505 if ((u & BIT(pin)) == 0)
508 type &= IRQ_TYPE_SENSE_MASK;
509 if (type == IRQ_TYPE_NONE)
512 /* Check if we need to change chip and handler */
513 if (!(ct->type & type))
514 if (irq_setup_alt_chip(d, type))
518 * Configure interrupt polarity.
521 case IRQ_TYPE_EDGE_RISING:
522 case IRQ_TYPE_LEVEL_HIGH:
523 regmap_update_bits(mvchip->regs,
524 GPIO_IN_POL_OFF + mvchip->offset,
527 case IRQ_TYPE_EDGE_FALLING:
528 case IRQ_TYPE_LEVEL_LOW:
529 regmap_update_bits(mvchip->regs,
530 GPIO_IN_POL_OFF + mvchip->offset,
533 case IRQ_TYPE_EDGE_BOTH: {
534 u32 data_in, in_pol, val;
536 regmap_read(mvchip->regs,
537 GPIO_IN_POL_OFF + mvchip->offset, &in_pol);
538 regmap_read(mvchip->regs,
539 GPIO_DATA_IN_OFF + mvchip->offset, &data_in);
542 * set initial polarity based on current input level
544 if ((data_in ^ in_pol) & BIT(pin))
545 val = BIT(pin); /* falling */
547 val = 0; /* raising */
549 regmap_update_bits(mvchip->regs,
550 GPIO_IN_POL_OFF + mvchip->offset,
558 static void mvebu_gpio_irq_handler(struct irq_desc *desc)
560 struct mvebu_gpio_chip *mvchip = irq_desc_get_handler_data(desc);
561 struct irq_chip *chip = irq_desc_get_chip(desc);
562 u32 cause, type, data_in, level_mask, edge_cause, edge_mask;
568 chained_irq_enter(chip, desc);
570 regmap_read(mvchip->regs, GPIO_DATA_IN_OFF + mvchip->offset, &data_in);
571 level_mask = mvebu_gpio_read_level_mask(mvchip);
572 edge_cause = mvebu_gpio_read_edge_cause(mvchip);
573 edge_mask = mvebu_gpio_read_edge_mask(mvchip);
575 cause = (data_in & level_mask) | (edge_cause & edge_mask);
577 for (i = 0; i < mvchip->chip.ngpio; i++) {
580 irq = irq_find_mapping(mvchip->domain, i);
582 if (!(cause & BIT(i)))
585 type = irq_get_trigger_type(irq);
586 if ((type & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH) {
587 /* Swap polarity (race with GPIO line) */
590 regmap_read(mvchip->regs,
591 GPIO_IN_POL_OFF + mvchip->offset,
594 regmap_write(mvchip->regs,
595 GPIO_IN_POL_OFF + mvchip->offset,
599 generic_handle_irq(irq);
602 chained_irq_exit(chip, desc);
605 static const struct regmap_config mvebu_gpio_regmap_config = {
613 * Functions implementing the pwm_chip methods
615 static struct mvebu_pwm *to_mvebu_pwm(struct pwm_chip *chip)
617 return container_of(chip, struct mvebu_pwm, chip);
620 static int mvebu_pwm_request(struct pwm_chip *chip, struct pwm_device *pwm)
622 struct mvebu_pwm *mvpwm = to_mvebu_pwm(chip);
623 struct mvebu_gpio_chip *mvchip = mvpwm->mvchip;
624 struct gpio_desc *desc;
628 spin_lock_irqsave(&mvpwm->lock, flags);
633 desc = gpiochip_request_own_desc(&mvchip->chip,
634 pwm->hwpwm, "mvebu-pwm",
645 spin_unlock_irqrestore(&mvpwm->lock, flags);
649 static void mvebu_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
651 struct mvebu_pwm *mvpwm = to_mvebu_pwm(chip);
654 spin_lock_irqsave(&mvpwm->lock, flags);
655 gpiochip_free_own_desc(mvpwm->gpiod);
657 spin_unlock_irqrestore(&mvpwm->lock, flags);
660 static int mvebu_pwm_get_state(struct pwm_chip *chip,
661 struct pwm_device *pwm,
662 struct pwm_state *state)
665 struct mvebu_pwm *mvpwm = to_mvebu_pwm(chip);
666 struct mvebu_gpio_chip *mvchip = mvpwm->mvchip;
667 unsigned long long val;
671 spin_lock_irqsave(&mvpwm->lock, flags);
673 regmap_read(mvpwm->regs, mvebu_pwmreg_blink_on_duration(mvpwm), &u);
674 /* Hardware treats zero as 2^32. See mvebu_pwm_apply(). */
678 val = UINT_MAX + 1ULL;
679 state->duty_cycle = DIV_ROUND_UP_ULL(val * NSEC_PER_SEC,
682 regmap_read(mvpwm->regs, mvebu_pwmreg_blink_off_duration(mvpwm), &u);
683 /* period = on + off duration */
687 val += UINT_MAX + 1ULL;
688 state->period = DIV_ROUND_UP_ULL(val * NSEC_PER_SEC, mvpwm->clk_rate);
690 regmap_read(mvchip->regs, GPIO_BLINK_EN_OFF + mvchip->offset, &u);
692 state->enabled = true;
694 state->enabled = false;
696 spin_unlock_irqrestore(&mvpwm->lock, flags);
701 static int mvebu_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
702 const struct pwm_state *state)
704 struct mvebu_pwm *mvpwm = to_mvebu_pwm(chip);
705 struct mvebu_gpio_chip *mvchip = mvpwm->mvchip;
706 unsigned long long val;
708 unsigned int on, off;
710 if (state->polarity != PWM_POLARITY_NORMAL)
713 val = (unsigned long long) mvpwm->clk_rate * state->duty_cycle;
714 do_div(val, NSEC_PER_SEC);
715 if (val > UINT_MAX + 1ULL)
718 * Zero on/off values don't work as expected. Experimentation shows
719 * that zero value is treated as 2^32. This behavior is not documented.
721 if (val == UINT_MAX + 1ULL)
728 val = (unsigned long long) mvpwm->clk_rate * state->period;
729 do_div(val, NSEC_PER_SEC);
731 if (val > UINT_MAX + 1ULL)
733 if (val == UINT_MAX + 1ULL)
740 spin_lock_irqsave(&mvpwm->lock, flags);
742 regmap_write(mvpwm->regs, mvebu_pwmreg_blink_on_duration(mvpwm), on);
743 regmap_write(mvpwm->regs, mvebu_pwmreg_blink_off_duration(mvpwm), off);
745 mvebu_gpio_blink(&mvchip->chip, pwm->hwpwm, 1);
747 mvebu_gpio_blink(&mvchip->chip, pwm->hwpwm, 0);
749 spin_unlock_irqrestore(&mvpwm->lock, flags);
754 static const struct pwm_ops mvebu_pwm_ops = {
755 .request = mvebu_pwm_request,
756 .free = mvebu_pwm_free,
757 .get_state = mvebu_pwm_get_state,
758 .apply = mvebu_pwm_apply,
759 .owner = THIS_MODULE,
762 static void __maybe_unused mvebu_pwm_suspend(struct mvebu_gpio_chip *mvchip)
764 struct mvebu_pwm *mvpwm = mvchip->mvpwm;
766 regmap_read(mvchip->regs, GPIO_BLINK_CNT_SELECT_OFF + mvchip->offset,
767 &mvpwm->blink_select);
768 regmap_read(mvpwm->regs, mvebu_pwmreg_blink_on_duration(mvpwm),
769 &mvpwm->blink_on_duration);
770 regmap_read(mvpwm->regs, mvebu_pwmreg_blink_off_duration(mvpwm),
771 &mvpwm->blink_off_duration);
774 static void __maybe_unused mvebu_pwm_resume(struct mvebu_gpio_chip *mvchip)
776 struct mvebu_pwm *mvpwm = mvchip->mvpwm;
778 regmap_write(mvchip->regs, GPIO_BLINK_CNT_SELECT_OFF + mvchip->offset,
779 mvpwm->blink_select);
780 regmap_write(mvpwm->regs, mvebu_pwmreg_blink_on_duration(mvpwm),
781 mvpwm->blink_on_duration);
782 regmap_write(mvpwm->regs, mvebu_pwmreg_blink_off_duration(mvpwm),
783 mvpwm->blink_off_duration);
786 static int mvebu_pwm_probe(struct platform_device *pdev,
787 struct mvebu_gpio_chip *mvchip,
790 struct device *dev = &pdev->dev;
791 struct mvebu_pwm *mvpwm;
796 if (mvchip->soc_variant == MVEBU_GPIO_SOC_VARIANT_A8K) {
797 int ret = of_property_read_u32(dev->of_node,
798 "marvell,pwm-offset", &offset);
803 * There are only two sets of PWM configuration registers for
804 * all the GPIO lines on those SoCs which this driver reserves
805 * for the first two GPIO chips. So if the resource is missing
806 * we can't treat it as an error.
808 if (!platform_get_resource_byname(pdev, IORESOURCE_MEM, "pwm"))
813 if (IS_ERR(mvchip->clk))
814 return PTR_ERR(mvchip->clk);
816 mvpwm = devm_kzalloc(dev, sizeof(struct mvebu_pwm), GFP_KERNEL);
819 mvchip->mvpwm = mvpwm;
820 mvpwm->mvchip = mvchip;
821 mvpwm->offset = offset;
823 if (mvchip->soc_variant == MVEBU_GPIO_SOC_VARIANT_A8K) {
824 mvpwm->regs = mvchip->regs;
826 switch (mvchip->offset) {
827 case AP80X_GPIO0_OFF_A8K:
828 case CP11X_GPIO0_OFF_A8K:
829 /* Blink counter A */
832 case CP11X_GPIO1_OFF_A8K:
833 /* Blink counter B */
835 mvpwm->offset += PWM_BLINK_COUNTER_B_OFF;
841 base = devm_platform_ioremap_resource_byname(pdev, "pwm");
843 return PTR_ERR(base);
845 mvpwm->regs = devm_regmap_init_mmio(&pdev->dev, base,
846 &mvebu_gpio_regmap_config);
847 if (IS_ERR(mvpwm->regs))
848 return PTR_ERR(mvpwm->regs);
851 * Use set A for lines of GPIO chip with id 0, B for GPIO chip
852 * with id 1. Don't allow further GPIO chips to be used for PWM.
862 regmap_write(mvchip->regs,
863 GPIO_BLINK_CNT_SELECT_OFF + mvchip->offset, set);
865 mvpwm->clk_rate = clk_get_rate(mvchip->clk);
866 if (!mvpwm->clk_rate) {
867 dev_err(dev, "failed to get clock rate\n");
871 mvpwm->chip.dev = dev;
872 mvpwm->chip.ops = &mvebu_pwm_ops;
873 mvpwm->chip.npwm = mvchip->chip.ngpio;
875 spin_lock_init(&mvpwm->lock);
877 return pwmchip_add(&mvpwm->chip);
880 #ifdef CONFIG_DEBUG_FS
881 #include <linux/seq_file.h>
883 static void mvebu_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)
885 struct mvebu_gpio_chip *mvchip = gpiochip_get_data(chip);
886 u32 out, io_conf, blink, in_pol, data_in, cause, edg_msk, lvl_msk;
890 regmap_read(mvchip->regs, GPIO_OUT_OFF + mvchip->offset, &out);
891 regmap_read(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset, &io_conf);
892 regmap_read(mvchip->regs, GPIO_BLINK_EN_OFF + mvchip->offset, &blink);
893 regmap_read(mvchip->regs, GPIO_IN_POL_OFF + mvchip->offset, &in_pol);
894 regmap_read(mvchip->regs, GPIO_DATA_IN_OFF + mvchip->offset, &data_in);
895 cause = mvebu_gpio_read_edge_cause(mvchip);
896 edg_msk = mvebu_gpio_read_edge_mask(mvchip);
897 lvl_msk = mvebu_gpio_read_level_mask(mvchip);
899 for_each_requested_gpio(chip, i, label) {
904 is_out = !(io_conf & msk);
906 seq_printf(s, " gpio-%-3d (%-20.20s)", chip->base + i, label);
909 seq_printf(s, " out %s %s\n",
910 out & msk ? "hi" : "lo",
911 blink & msk ? "(blink )" : "");
915 seq_printf(s, " in %s (act %s) - IRQ",
916 (data_in ^ in_pol) & msk ? "hi" : "lo",
917 in_pol & msk ? "lo" : "hi");
918 if (!((edg_msk | lvl_msk) & msk)) {
919 seq_puts(s, " disabled\n");
923 seq_puts(s, " edge ");
925 seq_puts(s, " level");
926 seq_printf(s, " (%s)\n", cause & msk ? "pending" : "clear ");
930 #define mvebu_gpio_dbg_show NULL
933 static const struct of_device_id mvebu_gpio_of_match[] = {
935 .compatible = "marvell,orion-gpio",
936 .data = (void *) MVEBU_GPIO_SOC_VARIANT_ORION,
939 .compatible = "marvell,mv78200-gpio",
940 .data = (void *) MVEBU_GPIO_SOC_VARIANT_MV78200,
943 .compatible = "marvell,armadaxp-gpio",
944 .data = (void *) MVEBU_GPIO_SOC_VARIANT_ARMADAXP,
947 .compatible = "marvell,armada-370-gpio",
948 .data = (void *) MVEBU_GPIO_SOC_VARIANT_ORION,
951 .compatible = "marvell,armada-8k-gpio",
952 .data = (void *) MVEBU_GPIO_SOC_VARIANT_A8K,
959 static int mvebu_gpio_suspend(struct platform_device *pdev, pm_message_t state)
961 struct mvebu_gpio_chip *mvchip = platform_get_drvdata(pdev);
964 regmap_read(mvchip->regs, GPIO_OUT_OFF + mvchip->offset,
966 regmap_read(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset,
967 &mvchip->io_conf_reg);
968 regmap_read(mvchip->regs, GPIO_BLINK_EN_OFF + mvchip->offset,
969 &mvchip->blink_en_reg);
970 regmap_read(mvchip->regs, GPIO_IN_POL_OFF + mvchip->offset,
971 &mvchip->in_pol_reg);
973 switch (mvchip->soc_variant) {
974 case MVEBU_GPIO_SOC_VARIANT_ORION:
975 case MVEBU_GPIO_SOC_VARIANT_A8K:
976 regmap_read(mvchip->regs, GPIO_EDGE_MASK_OFF + mvchip->offset,
977 &mvchip->edge_mask_regs[0]);
978 regmap_read(mvchip->regs, GPIO_LEVEL_MASK_OFF + mvchip->offset,
979 &mvchip->level_mask_regs[0]);
981 case MVEBU_GPIO_SOC_VARIANT_MV78200:
982 for (i = 0; i < 2; i++) {
983 regmap_read(mvchip->regs,
984 GPIO_EDGE_MASK_MV78200_OFF(i),
985 &mvchip->edge_mask_regs[i]);
986 regmap_read(mvchip->regs,
987 GPIO_LEVEL_MASK_MV78200_OFF(i),
988 &mvchip->level_mask_regs[i]);
991 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
992 for (i = 0; i < 4; i++) {
993 regmap_read(mvchip->regs,
994 GPIO_EDGE_MASK_ARMADAXP_OFF(i),
995 &mvchip->edge_mask_regs[i]);
996 regmap_read(mvchip->regs,
997 GPIO_LEVEL_MASK_ARMADAXP_OFF(i),
998 &mvchip->level_mask_regs[i]);
1005 if (IS_ENABLED(CONFIG_PWM))
1006 mvebu_pwm_suspend(mvchip);
1011 static int mvebu_gpio_resume(struct platform_device *pdev)
1013 struct mvebu_gpio_chip *mvchip = platform_get_drvdata(pdev);
1016 regmap_write(mvchip->regs, GPIO_OUT_OFF + mvchip->offset,
1018 regmap_write(mvchip->regs, GPIO_IO_CONF_OFF + mvchip->offset,
1019 mvchip->io_conf_reg);
1020 regmap_write(mvchip->regs, GPIO_BLINK_EN_OFF + mvchip->offset,
1021 mvchip->blink_en_reg);
1022 regmap_write(mvchip->regs, GPIO_IN_POL_OFF + mvchip->offset,
1023 mvchip->in_pol_reg);
1025 switch (mvchip->soc_variant) {
1026 case MVEBU_GPIO_SOC_VARIANT_ORION:
1027 case MVEBU_GPIO_SOC_VARIANT_A8K:
1028 regmap_write(mvchip->regs, GPIO_EDGE_MASK_OFF + mvchip->offset,
1029 mvchip->edge_mask_regs[0]);
1030 regmap_write(mvchip->regs, GPIO_LEVEL_MASK_OFF + mvchip->offset,
1031 mvchip->level_mask_regs[0]);
1033 case MVEBU_GPIO_SOC_VARIANT_MV78200:
1034 for (i = 0; i < 2; i++) {
1035 regmap_write(mvchip->regs,
1036 GPIO_EDGE_MASK_MV78200_OFF(i),
1037 mvchip->edge_mask_regs[i]);
1038 regmap_write(mvchip->regs,
1039 GPIO_LEVEL_MASK_MV78200_OFF(i),
1040 mvchip->level_mask_regs[i]);
1043 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
1044 for (i = 0; i < 4; i++) {
1045 regmap_write(mvchip->regs,
1046 GPIO_EDGE_MASK_ARMADAXP_OFF(i),
1047 mvchip->edge_mask_regs[i]);
1048 regmap_write(mvchip->regs,
1049 GPIO_LEVEL_MASK_ARMADAXP_OFF(i),
1050 mvchip->level_mask_regs[i]);
1057 if (IS_ENABLED(CONFIG_PWM))
1058 mvebu_pwm_resume(mvchip);
1063 static int mvebu_gpio_probe_raw(struct platform_device *pdev,
1064 struct mvebu_gpio_chip *mvchip)
1068 base = devm_platform_ioremap_resource(pdev, 0);
1070 return PTR_ERR(base);
1072 mvchip->regs = devm_regmap_init_mmio(&pdev->dev, base,
1073 &mvebu_gpio_regmap_config);
1074 if (IS_ERR(mvchip->regs))
1075 return PTR_ERR(mvchip->regs);
1078 * For the legacy SoCs, the regmap directly maps to the GPIO
1079 * registers, so no offset is needed.
1084 * The Armada XP has a second range of registers for the
1087 if (mvchip->soc_variant == MVEBU_GPIO_SOC_VARIANT_ARMADAXP) {
1088 base = devm_platform_ioremap_resource(pdev, 1);
1090 return PTR_ERR(base);
1092 mvchip->percpu_regs =
1093 devm_regmap_init_mmio(&pdev->dev, base,
1094 &mvebu_gpio_regmap_config);
1095 if (IS_ERR(mvchip->percpu_regs))
1096 return PTR_ERR(mvchip->percpu_regs);
1102 static int mvebu_gpio_probe_syscon(struct platform_device *pdev,
1103 struct mvebu_gpio_chip *mvchip)
1105 mvchip->regs = syscon_node_to_regmap(pdev->dev.parent->of_node);
1106 if (IS_ERR(mvchip->regs))
1107 return PTR_ERR(mvchip->regs);
1109 if (of_property_read_u32(pdev->dev.of_node, "offset", &mvchip->offset))
1115 static int mvebu_gpio_probe(struct platform_device *pdev)
1117 struct mvebu_gpio_chip *mvchip;
1118 const struct of_device_id *match;
1119 struct device_node *np = pdev->dev.of_node;
1120 struct irq_chip_generic *gc;
1121 struct irq_chip_type *ct;
1122 unsigned int ngpios;
1128 match = of_match_device(mvebu_gpio_of_match, &pdev->dev);
1130 soc_variant = (unsigned long) match->data;
1132 soc_variant = MVEBU_GPIO_SOC_VARIANT_ORION;
1134 /* Some gpio controllers do not provide irq support */
1135 err = platform_irq_count(pdev);
1139 have_irqs = err != 0;
1141 mvchip = devm_kzalloc(&pdev->dev, sizeof(struct mvebu_gpio_chip),
1146 platform_set_drvdata(pdev, mvchip);
1148 if (of_property_read_u32(pdev->dev.of_node, "ngpios", &ngpios)) {
1149 dev_err(&pdev->dev, "Missing ngpios OF property\n");
1153 id = of_alias_get_id(pdev->dev.of_node, "gpio");
1155 dev_err(&pdev->dev, "Couldn't get OF id\n");
1159 mvchip->clk = devm_clk_get(&pdev->dev, NULL);
1160 /* Not all SoCs require a clock.*/
1161 if (!IS_ERR(mvchip->clk))
1162 clk_prepare_enable(mvchip->clk);
1164 mvchip->soc_variant = soc_variant;
1165 mvchip->chip.label = dev_name(&pdev->dev);
1166 mvchip->chip.parent = &pdev->dev;
1167 mvchip->chip.request = gpiochip_generic_request;
1168 mvchip->chip.free = gpiochip_generic_free;
1169 mvchip->chip.get_direction = mvebu_gpio_get_direction;
1170 mvchip->chip.direction_input = mvebu_gpio_direction_input;
1171 mvchip->chip.get = mvebu_gpio_get;
1172 mvchip->chip.direction_output = mvebu_gpio_direction_output;
1173 mvchip->chip.set = mvebu_gpio_set;
1175 mvchip->chip.to_irq = mvebu_gpio_to_irq;
1176 mvchip->chip.base = id * MVEBU_MAX_GPIO_PER_BANK;
1177 mvchip->chip.ngpio = ngpios;
1178 mvchip->chip.can_sleep = false;
1179 mvchip->chip.dbg_show = mvebu_gpio_dbg_show;
1181 if (soc_variant == MVEBU_GPIO_SOC_VARIANT_A8K)
1182 err = mvebu_gpio_probe_syscon(pdev, mvchip);
1184 err = mvebu_gpio_probe_raw(pdev, mvchip);
1190 * Mask and clear GPIO interrupts.
1192 switch (soc_variant) {
1193 case MVEBU_GPIO_SOC_VARIANT_ORION:
1194 case MVEBU_GPIO_SOC_VARIANT_A8K:
1195 regmap_write(mvchip->regs,
1196 GPIO_EDGE_CAUSE_OFF + mvchip->offset, 0);
1197 regmap_write(mvchip->regs,
1198 GPIO_EDGE_MASK_OFF + mvchip->offset, 0);
1199 regmap_write(mvchip->regs,
1200 GPIO_LEVEL_MASK_OFF + mvchip->offset, 0);
1202 case MVEBU_GPIO_SOC_VARIANT_MV78200:
1203 regmap_write(mvchip->regs, GPIO_EDGE_CAUSE_OFF, 0);
1204 for (cpu = 0; cpu < 2; cpu++) {
1205 regmap_write(mvchip->regs,
1206 GPIO_EDGE_MASK_MV78200_OFF(cpu), 0);
1207 regmap_write(mvchip->regs,
1208 GPIO_LEVEL_MASK_MV78200_OFF(cpu), 0);
1211 case MVEBU_GPIO_SOC_VARIANT_ARMADAXP:
1212 regmap_write(mvchip->regs, GPIO_EDGE_CAUSE_OFF, 0);
1213 regmap_write(mvchip->regs, GPIO_EDGE_MASK_OFF, 0);
1214 regmap_write(mvchip->regs, GPIO_LEVEL_MASK_OFF, 0);
1215 for (cpu = 0; cpu < 4; cpu++) {
1216 regmap_write(mvchip->percpu_regs,
1217 GPIO_EDGE_CAUSE_ARMADAXP_OFF(cpu), 0);
1218 regmap_write(mvchip->percpu_regs,
1219 GPIO_EDGE_MASK_ARMADAXP_OFF(cpu), 0);
1220 regmap_write(mvchip->percpu_regs,
1221 GPIO_LEVEL_MASK_ARMADAXP_OFF(cpu), 0);
1228 devm_gpiochip_add_data(&pdev->dev, &mvchip->chip, mvchip);
1230 /* Some MVEBU SoCs have simple PWM support for GPIO lines */
1231 if (IS_ENABLED(CONFIG_PWM)) {
1232 err = mvebu_pwm_probe(pdev, mvchip, id);
1237 /* Some gpio controllers do not provide irq support */
1242 irq_domain_add_linear(np, ngpios, &irq_generic_chip_ops, NULL);
1243 if (!mvchip->domain) {
1244 dev_err(&pdev->dev, "couldn't allocate irq domain %s (DT).\n",
1245 mvchip->chip.label);
1250 err = irq_alloc_domain_generic_chips(
1251 mvchip->domain, ngpios, 2, np->name, handle_level_irq,
1252 IRQ_NOREQUEST | IRQ_NOPROBE | IRQ_LEVEL, 0, 0);
1254 dev_err(&pdev->dev, "couldn't allocate irq chips %s (DT).\n",
1255 mvchip->chip.label);
1260 * NOTE: The common accessors cannot be used because of the percpu
1261 * access to the mask registers
1263 gc = irq_get_domain_generic_chip(mvchip->domain, 0);
1264 gc->private = mvchip;
1265 ct = &gc->chip_types[0];
1266 ct->type = IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW;
1267 ct->chip.irq_mask = mvebu_gpio_level_irq_mask;
1268 ct->chip.irq_unmask = mvebu_gpio_level_irq_unmask;
1269 ct->chip.irq_set_type = mvebu_gpio_irq_set_type;
1270 ct->chip.name = mvchip->chip.label;
1272 ct = &gc->chip_types[1];
1273 ct->type = IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING;
1274 ct->chip.irq_ack = mvebu_gpio_irq_ack;
1275 ct->chip.irq_mask = mvebu_gpio_edge_irq_mask;
1276 ct->chip.irq_unmask = mvebu_gpio_edge_irq_unmask;
1277 ct->chip.irq_set_type = mvebu_gpio_irq_set_type;
1278 ct->handler = handle_edge_irq;
1279 ct->chip.name = mvchip->chip.label;
1282 * Setup the interrupt handlers. Each chip can have up to 4
1283 * interrupt handlers, with each handler dealing with 8 GPIO
1286 for (i = 0; i < 4; i++) {
1287 int irq = platform_get_irq_optional(pdev, i);
1291 irq_set_chained_handler_and_data(irq, mvebu_gpio_irq_handler,
1298 irq_domain_remove(mvchip->domain);
1300 pwmchip_remove(&mvchip->mvpwm->chip);
1305 static struct platform_driver mvebu_gpio_driver = {
1307 .name = "mvebu-gpio",
1308 .of_match_table = mvebu_gpio_of_match,
1310 .probe = mvebu_gpio_probe,
1311 .suspend = mvebu_gpio_suspend,
1312 .resume = mvebu_gpio_resume,
1314 builtin_platform_driver(mvebu_gpio_driver);