2 * Generic GPIO driver for logic cells found in the Nomadik SoC
4 * Copyright (C) 2008,2009 STMicroelectronics
5 * Copyright (C) 2009 Alessandro Rubini <rubini@unipv.it>
6 * Rewritten based on work by Prafulla WADASKAR <prafulla.wadaskar@st.com>
7 * Copyright (C) 2011-2013 Linus Walleij <linus.walleij@linaro.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/device.h>
17 #include <linux/platform_device.h>
19 #include <linux/clk.h>
20 #include <linux/err.h>
21 #include <linux/gpio.h>
22 #include <linux/spinlock.h>
23 #include <linux/interrupt.h>
24 #include <linux/slab.h>
25 #include <linux/of_device.h>
26 #include <linux/of_address.h>
27 #include <linux/pinctrl/machine.h>
28 #include <linux/pinctrl/pinctrl.h>
29 #include <linux/pinctrl/pinmux.h>
30 #include <linux/pinctrl/pinconf.h>
31 /* Since we request GPIOs from ourself */
32 #include <linux/pinctrl/consumer.h>
33 #include "pinctrl-nomadik.h"
35 #include "../pinctrl-utils.h"
38 * The GPIO module in the Nomadik family of Systems-on-Chip is an
39 * AMBA device, managing 32 pins and alternate functions. The logic block
40 * is currently used in the Nomadik and ux500.
42 * Symbols in this file are called "nmk_gpio" for "nomadik gpio"
46 * pin configurations are represented by 32-bit integers:
48 * bit 0.. 8 - Pin Number (512 Pins Maximum)
49 * bit 9..10 - Alternate Function Selection
50 * bit 11..12 - Pull up/down state
51 * bit 13 - Sleep mode behaviour
53 * bit 15 - Value (if output)
54 * bit 16..18 - SLPM pull up/down state
55 * bit 19..20 - SLPM direction
56 * bit 21..22 - SLPM Value (if output)
57 * bit 23..25 - PDIS value (if input)
61 * to facilitate the definition, the following macros are provided
63 * PIN_CFG_DEFAULT - default config (0):
64 * pull up/down = disabled
65 * sleep mode = input/wakeup
68 * SLPM direction = same as normal
69 * SLPM pull = same as normal
70 * SLPM value = same as normal
72 * PIN_CFG - default config with alternate function
75 typedef unsigned long pin_cfg_t;
77 #define PIN_NUM_MASK 0x1ff
78 #define PIN_NUM(x) ((x) & PIN_NUM_MASK)
80 #define PIN_ALT_SHIFT 9
81 #define PIN_ALT_MASK (0x3 << PIN_ALT_SHIFT)
82 #define PIN_ALT(x) (((x) & PIN_ALT_MASK) >> PIN_ALT_SHIFT)
83 #define PIN_GPIO (NMK_GPIO_ALT_GPIO << PIN_ALT_SHIFT)
84 #define PIN_ALT_A (NMK_GPIO_ALT_A << PIN_ALT_SHIFT)
85 #define PIN_ALT_B (NMK_GPIO_ALT_B << PIN_ALT_SHIFT)
86 #define PIN_ALT_C (NMK_GPIO_ALT_C << PIN_ALT_SHIFT)
88 #define PIN_PULL_SHIFT 11
89 #define PIN_PULL_MASK (0x3 << PIN_PULL_SHIFT)
90 #define PIN_PULL(x) (((x) & PIN_PULL_MASK) >> PIN_PULL_SHIFT)
91 #define PIN_PULL_NONE (NMK_GPIO_PULL_NONE << PIN_PULL_SHIFT)
92 #define PIN_PULL_UP (NMK_GPIO_PULL_UP << PIN_PULL_SHIFT)
93 #define PIN_PULL_DOWN (NMK_GPIO_PULL_DOWN << PIN_PULL_SHIFT)
95 #define PIN_SLPM_SHIFT 13
96 #define PIN_SLPM_MASK (0x1 << PIN_SLPM_SHIFT)
97 #define PIN_SLPM(x) (((x) & PIN_SLPM_MASK) >> PIN_SLPM_SHIFT)
98 #define PIN_SLPM_MAKE_INPUT (NMK_GPIO_SLPM_INPUT << PIN_SLPM_SHIFT)
99 #define PIN_SLPM_NOCHANGE (NMK_GPIO_SLPM_NOCHANGE << PIN_SLPM_SHIFT)
100 /* These two replace the above in DB8500v2+ */
101 #define PIN_SLPM_WAKEUP_ENABLE (NMK_GPIO_SLPM_WAKEUP_ENABLE << PIN_SLPM_SHIFT)
102 #define PIN_SLPM_WAKEUP_DISABLE (NMK_GPIO_SLPM_WAKEUP_DISABLE << PIN_SLPM_SHIFT)
103 #define PIN_SLPM_USE_MUX_SETTINGS_IN_SLEEP PIN_SLPM_WAKEUP_DISABLE
105 #define PIN_SLPM_GPIO PIN_SLPM_WAKEUP_ENABLE /* In SLPM, pin is a gpio */
106 #define PIN_SLPM_ALTFUNC PIN_SLPM_WAKEUP_DISABLE /* In SLPM, pin is altfunc */
108 #define PIN_DIR_SHIFT 14
109 #define PIN_DIR_MASK (0x1 << PIN_DIR_SHIFT)
110 #define PIN_DIR(x) (((x) & PIN_DIR_MASK) >> PIN_DIR_SHIFT)
111 #define PIN_DIR_INPUT (0 << PIN_DIR_SHIFT)
112 #define PIN_DIR_OUTPUT (1 << PIN_DIR_SHIFT)
114 #define PIN_VAL_SHIFT 15
115 #define PIN_VAL_MASK (0x1 << PIN_VAL_SHIFT)
116 #define PIN_VAL(x) (((x) & PIN_VAL_MASK) >> PIN_VAL_SHIFT)
117 #define PIN_VAL_LOW (0 << PIN_VAL_SHIFT)
118 #define PIN_VAL_HIGH (1 << PIN_VAL_SHIFT)
120 #define PIN_SLPM_PULL_SHIFT 16
121 #define PIN_SLPM_PULL_MASK (0x7 << PIN_SLPM_PULL_SHIFT)
122 #define PIN_SLPM_PULL(x) \
123 (((x) & PIN_SLPM_PULL_MASK) >> PIN_SLPM_PULL_SHIFT)
124 #define PIN_SLPM_PULL_NONE \
125 ((1 + NMK_GPIO_PULL_NONE) << PIN_SLPM_PULL_SHIFT)
126 #define PIN_SLPM_PULL_UP \
127 ((1 + NMK_GPIO_PULL_UP) << PIN_SLPM_PULL_SHIFT)
128 #define PIN_SLPM_PULL_DOWN \
129 ((1 + NMK_GPIO_PULL_DOWN) << PIN_SLPM_PULL_SHIFT)
131 #define PIN_SLPM_DIR_SHIFT 19
132 #define PIN_SLPM_DIR_MASK (0x3 << PIN_SLPM_DIR_SHIFT)
133 #define PIN_SLPM_DIR(x) \
134 (((x) & PIN_SLPM_DIR_MASK) >> PIN_SLPM_DIR_SHIFT)
135 #define PIN_SLPM_DIR_INPUT ((1 + 0) << PIN_SLPM_DIR_SHIFT)
136 #define PIN_SLPM_DIR_OUTPUT ((1 + 1) << PIN_SLPM_DIR_SHIFT)
138 #define PIN_SLPM_VAL_SHIFT 21
139 #define PIN_SLPM_VAL_MASK (0x3 << PIN_SLPM_VAL_SHIFT)
140 #define PIN_SLPM_VAL(x) \
141 (((x) & PIN_SLPM_VAL_MASK) >> PIN_SLPM_VAL_SHIFT)
142 #define PIN_SLPM_VAL_LOW ((1 + 0) << PIN_SLPM_VAL_SHIFT)
143 #define PIN_SLPM_VAL_HIGH ((1 + 1) << PIN_SLPM_VAL_SHIFT)
145 #define PIN_SLPM_PDIS_SHIFT 23
146 #define PIN_SLPM_PDIS_MASK (0x3 << PIN_SLPM_PDIS_SHIFT)
147 #define PIN_SLPM_PDIS(x) \
148 (((x) & PIN_SLPM_PDIS_MASK) >> PIN_SLPM_PDIS_SHIFT)
149 #define PIN_SLPM_PDIS_NO_CHANGE (0 << PIN_SLPM_PDIS_SHIFT)
150 #define PIN_SLPM_PDIS_DISABLED (1 << PIN_SLPM_PDIS_SHIFT)
151 #define PIN_SLPM_PDIS_ENABLED (2 << PIN_SLPM_PDIS_SHIFT)
153 #define PIN_LOWEMI_SHIFT 25
154 #define PIN_LOWEMI_MASK (0x1 << PIN_LOWEMI_SHIFT)
155 #define PIN_LOWEMI(x) (((x) & PIN_LOWEMI_MASK) >> PIN_LOWEMI_SHIFT)
156 #define PIN_LOWEMI_DISABLED (0 << PIN_LOWEMI_SHIFT)
157 #define PIN_LOWEMI_ENABLED (1 << PIN_LOWEMI_SHIFT)
159 #define PIN_GPIOMODE_SHIFT 26
160 #define PIN_GPIOMODE_MASK (0x1 << PIN_GPIOMODE_SHIFT)
161 #define PIN_GPIOMODE(x) (((x) & PIN_GPIOMODE_MASK) >> PIN_GPIOMODE_SHIFT)
162 #define PIN_GPIOMODE_DISABLED (0 << PIN_GPIOMODE_SHIFT)
163 #define PIN_GPIOMODE_ENABLED (1 << PIN_GPIOMODE_SHIFT)
165 #define PIN_SLEEPMODE_SHIFT 27
166 #define PIN_SLEEPMODE_MASK (0x1 << PIN_SLEEPMODE_SHIFT)
167 #define PIN_SLEEPMODE(x) (((x) & PIN_SLEEPMODE_MASK) >> PIN_SLEEPMODE_SHIFT)
168 #define PIN_SLEEPMODE_DISABLED (0 << PIN_SLEEPMODE_SHIFT)
169 #define PIN_SLEEPMODE_ENABLED (1 << PIN_SLEEPMODE_SHIFT)
172 /* Shortcuts. Use these instead of separate DIR, PULL, and VAL. */
173 #define PIN_INPUT_PULLDOWN (PIN_DIR_INPUT | PIN_PULL_DOWN)
174 #define PIN_INPUT_PULLUP (PIN_DIR_INPUT | PIN_PULL_UP)
175 #define PIN_INPUT_NOPULL (PIN_DIR_INPUT | PIN_PULL_NONE)
176 #define PIN_OUTPUT_LOW (PIN_DIR_OUTPUT | PIN_VAL_LOW)
177 #define PIN_OUTPUT_HIGH (PIN_DIR_OUTPUT | PIN_VAL_HIGH)
179 #define PIN_SLPM_INPUT_PULLDOWN (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_DOWN)
180 #define PIN_SLPM_INPUT_PULLUP (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_UP)
181 #define PIN_SLPM_INPUT_NOPULL (PIN_SLPM_DIR_INPUT | PIN_SLPM_PULL_NONE)
182 #define PIN_SLPM_OUTPUT_LOW (PIN_SLPM_DIR_OUTPUT | PIN_SLPM_VAL_LOW)
183 #define PIN_SLPM_OUTPUT_HIGH (PIN_SLPM_DIR_OUTPUT | PIN_SLPM_VAL_HIGH)
185 #define PIN_CFG_DEFAULT (0)
187 #define PIN_CFG(num, alt) \
189 (PIN_NUM(num) | PIN_##alt))
191 #define PIN_CFG_INPUT(num, alt, pull) \
193 (PIN_NUM(num) | PIN_##alt | PIN_INPUT_##pull))
195 #define PIN_CFG_OUTPUT(num, alt, val) \
197 (PIN_NUM(num) | PIN_##alt | PIN_OUTPUT_##val))
200 * "nmk_gpio" and "NMK_GPIO" stand for "Nomadik GPIO", leaving
201 * the "gpio" namespace for generic and cross-machine functions
204 #define GPIO_BLOCK_SHIFT 5
205 #define NMK_GPIO_PER_CHIP (1 << GPIO_BLOCK_SHIFT)
207 /* Register in the logic block */
208 #define NMK_GPIO_DAT 0x00
209 #define NMK_GPIO_DATS 0x04
210 #define NMK_GPIO_DATC 0x08
211 #define NMK_GPIO_PDIS 0x0c
212 #define NMK_GPIO_DIR 0x10
213 #define NMK_GPIO_DIRS 0x14
214 #define NMK_GPIO_DIRC 0x18
215 #define NMK_GPIO_SLPC 0x1c
216 #define NMK_GPIO_AFSLA 0x20
217 #define NMK_GPIO_AFSLB 0x24
218 #define NMK_GPIO_LOWEMI 0x28
220 #define NMK_GPIO_RIMSC 0x40
221 #define NMK_GPIO_FIMSC 0x44
222 #define NMK_GPIO_IS 0x48
223 #define NMK_GPIO_IC 0x4c
224 #define NMK_GPIO_RWIMSC 0x50
225 #define NMK_GPIO_FWIMSC 0x54
226 #define NMK_GPIO_WKS 0x58
227 /* These appear in DB8540 and later ASICs */
228 #define NMK_GPIO_EDGELEVEL 0x5C
229 #define NMK_GPIO_LEVEL 0x60
232 /* Pull up/down values */
242 NMK_GPIO_SLPM_WAKEUP_ENABLE = NMK_GPIO_SLPM_INPUT,
243 NMK_GPIO_SLPM_NOCHANGE,
244 NMK_GPIO_SLPM_WAKEUP_DISABLE = NMK_GPIO_SLPM_NOCHANGE,
247 struct nmk_gpio_chip {
248 struct gpio_chip chip;
252 unsigned int parent_irq;
253 int latent_parent_irq;
254 u32 (*get_latent_status)(unsigned int bank);
255 void (*set_ioforce)(bool enable);
258 /* Keep track of configured edges */
271 * struct nmk_pinctrl - state container for the Nomadik pin controller
272 * @dev: containing device pointer
273 * @pctl: corresponding pin controller device
274 * @soc: SoC data for this specific chip
275 * @prcm_base: PRCM register range virtual base
279 struct pinctrl_dev *pctl;
280 const struct nmk_pinctrl_soc_data *soc;
281 void __iomem *prcm_base;
284 static struct nmk_gpio_chip *
285 nmk_gpio_chips[DIV_ROUND_UP(ARCH_NR_GPIOS, NMK_GPIO_PER_CHIP)];
287 static DEFINE_SPINLOCK(nmk_gpio_slpm_lock);
289 #define NUM_BANKS ARRAY_SIZE(nmk_gpio_chips)
291 static void __nmk_gpio_set_mode(struct nmk_gpio_chip *nmk_chip,
292 unsigned offset, int gpio_mode)
294 u32 bit = 1 << offset;
297 afunc = readl(nmk_chip->addr + NMK_GPIO_AFSLA) & ~bit;
298 bfunc = readl(nmk_chip->addr + NMK_GPIO_AFSLB) & ~bit;
299 if (gpio_mode & NMK_GPIO_ALT_A)
301 if (gpio_mode & NMK_GPIO_ALT_B)
303 writel(afunc, nmk_chip->addr + NMK_GPIO_AFSLA);
304 writel(bfunc, nmk_chip->addr + NMK_GPIO_AFSLB);
307 static void __nmk_gpio_set_slpm(struct nmk_gpio_chip *nmk_chip,
308 unsigned offset, enum nmk_gpio_slpm mode)
310 u32 bit = 1 << offset;
313 slpm = readl(nmk_chip->addr + NMK_GPIO_SLPC);
314 if (mode == NMK_GPIO_SLPM_NOCHANGE)
318 writel(slpm, nmk_chip->addr + NMK_GPIO_SLPC);
321 static void __nmk_gpio_set_pull(struct nmk_gpio_chip *nmk_chip,
322 unsigned offset, enum nmk_gpio_pull pull)
324 u32 bit = 1 << offset;
327 pdis = readl(nmk_chip->addr + NMK_GPIO_PDIS);
328 if (pull == NMK_GPIO_PULL_NONE) {
330 nmk_chip->pull_up &= ~bit;
335 writel(pdis, nmk_chip->addr + NMK_GPIO_PDIS);
337 if (pull == NMK_GPIO_PULL_UP) {
338 nmk_chip->pull_up |= bit;
339 writel(bit, nmk_chip->addr + NMK_GPIO_DATS);
340 } else if (pull == NMK_GPIO_PULL_DOWN) {
341 nmk_chip->pull_up &= ~bit;
342 writel(bit, nmk_chip->addr + NMK_GPIO_DATC);
346 static void __nmk_gpio_set_lowemi(struct nmk_gpio_chip *nmk_chip,
347 unsigned offset, bool lowemi)
349 u32 bit = BIT(offset);
350 bool enabled = nmk_chip->lowemi & bit;
352 if (lowemi == enabled)
356 nmk_chip->lowemi |= bit;
358 nmk_chip->lowemi &= ~bit;
360 writel_relaxed(nmk_chip->lowemi,
361 nmk_chip->addr + NMK_GPIO_LOWEMI);
364 static void __nmk_gpio_make_input(struct nmk_gpio_chip *nmk_chip,
367 writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRC);
370 static void __nmk_gpio_set_output(struct nmk_gpio_chip *nmk_chip,
371 unsigned offset, int val)
374 writel(1 << offset, nmk_chip->addr + NMK_GPIO_DATS);
376 writel(1 << offset, nmk_chip->addr + NMK_GPIO_DATC);
379 static void __nmk_gpio_make_output(struct nmk_gpio_chip *nmk_chip,
380 unsigned offset, int val)
382 writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRS);
383 __nmk_gpio_set_output(nmk_chip, offset, val);
386 static void __nmk_gpio_set_mode_safe(struct nmk_gpio_chip *nmk_chip,
387 unsigned offset, int gpio_mode,
390 u32 rwimsc = nmk_chip->rwimsc;
391 u32 fwimsc = nmk_chip->fwimsc;
393 if (glitch && nmk_chip->set_ioforce) {
394 u32 bit = BIT(offset);
396 /* Prevent spurious wakeups */
397 writel(rwimsc & ~bit, nmk_chip->addr + NMK_GPIO_RWIMSC);
398 writel(fwimsc & ~bit, nmk_chip->addr + NMK_GPIO_FWIMSC);
400 nmk_chip->set_ioforce(true);
403 __nmk_gpio_set_mode(nmk_chip, offset, gpio_mode);
405 if (glitch && nmk_chip->set_ioforce) {
406 nmk_chip->set_ioforce(false);
408 writel(rwimsc, nmk_chip->addr + NMK_GPIO_RWIMSC);
409 writel(fwimsc, nmk_chip->addr + NMK_GPIO_FWIMSC);
414 nmk_gpio_disable_lazy_irq(struct nmk_gpio_chip *nmk_chip, unsigned offset)
416 u32 falling = nmk_chip->fimsc & BIT(offset);
417 u32 rising = nmk_chip->rimsc & BIT(offset);
418 int gpio = nmk_chip->chip.base + offset;
419 int irq = irq_find_mapping(nmk_chip->chip.irqdomain, offset);
420 struct irq_data *d = irq_get_irq_data(irq);
422 if (!rising && !falling)
425 if (!d || !irqd_irq_disabled(d))
429 nmk_chip->rimsc &= ~BIT(offset);
430 writel_relaxed(nmk_chip->rimsc,
431 nmk_chip->addr + NMK_GPIO_RIMSC);
435 nmk_chip->fimsc &= ~BIT(offset);
436 writel_relaxed(nmk_chip->fimsc,
437 nmk_chip->addr + NMK_GPIO_FIMSC);
440 dev_dbg(nmk_chip->chip.dev, "%d: clearing interrupt mask\n", gpio);
443 static void nmk_write_masked(void __iomem *reg, u32 mask, u32 value)
448 val = ((val & ~mask) | (value & mask));
452 static void nmk_prcm_altcx_set_mode(struct nmk_pinctrl *npct,
453 unsigned offset, unsigned alt_num)
459 const struct prcm_gpiocr_altcx_pin_desc *pin_desc;
460 const u16 *gpiocr_regs;
462 if (!npct->prcm_base)
465 if (alt_num > PRCM_IDX_GPIOCR_ALTC_MAX) {
466 dev_err(npct->dev, "PRCM GPIOCR: alternate-C%i is invalid\n",
471 for (i = 0 ; i < npct->soc->npins_altcx ; i++) {
472 if (npct->soc->altcx_pins[i].pin == offset)
475 if (i == npct->soc->npins_altcx) {
476 dev_dbg(npct->dev, "PRCM GPIOCR: pin %i is not found\n",
481 pin_desc = npct->soc->altcx_pins + i;
482 gpiocr_regs = npct->soc->prcm_gpiocr_registers;
485 * If alt_num is NULL, just clear current ALTCx selection
486 * to make sure we come back to a pure ALTC selection
489 for (i = 0 ; i < PRCM_IDX_GPIOCR_ALTC_MAX ; i++) {
490 if (pin_desc->altcx[i].used == true) {
491 reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
492 bit = pin_desc->altcx[i].control_bit;
493 if (readl(npct->prcm_base + reg) & BIT(bit)) {
494 nmk_write_masked(npct->prcm_base + reg, BIT(bit), 0);
496 "PRCM GPIOCR: pin %i: alternate-C%i has been disabled\n",
504 alt_index = alt_num - 1;
505 if (pin_desc->altcx[alt_index].used == false) {
507 "PRCM GPIOCR: pin %i: alternate-C%i does not exist\n",
513 * Check if any other ALTCx functions are activated on this pin
514 * and disable it first.
516 for (i = 0 ; i < PRCM_IDX_GPIOCR_ALTC_MAX ; i++) {
519 if (pin_desc->altcx[i].used == true) {
520 reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
521 bit = pin_desc->altcx[i].control_bit;
522 if (readl(npct->prcm_base + reg) & BIT(bit)) {
523 nmk_write_masked(npct->prcm_base + reg, BIT(bit), 0);
525 "PRCM GPIOCR: pin %i: alternate-C%i has been disabled\n",
531 reg = gpiocr_regs[pin_desc->altcx[alt_index].reg_index];
532 bit = pin_desc->altcx[alt_index].control_bit;
533 dev_dbg(npct->dev, "PRCM GPIOCR: pin %i: alternate-C%i has been selected\n",
534 offset, alt_index+1);
535 nmk_write_masked(npct->prcm_base + reg, BIT(bit), BIT(bit));
539 * Safe sequence used to switch IOs between GPIO and Alternate-C mode:
540 * - Save SLPM registers
541 * - Set SLPM=0 for the IOs you want to switch and others to 1
542 * - Configure the GPIO registers for the IOs that are being switched
544 * - Modify the AFLSA/B registers for the IOs that are being switched
546 * - Restore SLPM registers
547 * - Any spurious wake up event during switch sequence to be ignored and
550 static void nmk_gpio_glitch_slpm_init(unsigned int *slpm)
554 for (i = 0; i < NUM_BANKS; i++) {
555 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
556 unsigned int temp = slpm[i];
561 clk_enable(chip->clk);
563 slpm[i] = readl(chip->addr + NMK_GPIO_SLPC);
564 writel(temp, chip->addr + NMK_GPIO_SLPC);
568 static void nmk_gpio_glitch_slpm_restore(unsigned int *slpm)
572 for (i = 0; i < NUM_BANKS; i++) {
573 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
578 writel(slpm[i], chip->addr + NMK_GPIO_SLPC);
580 clk_disable(chip->clk);
584 static int __maybe_unused nmk_prcm_gpiocr_get_mode(struct pinctrl_dev *pctldev, int gpio)
589 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
590 const struct prcm_gpiocr_altcx_pin_desc *pin_desc;
591 const u16 *gpiocr_regs;
593 if (!npct->prcm_base)
594 return NMK_GPIO_ALT_C;
596 for (i = 0; i < npct->soc->npins_altcx; i++) {
597 if (npct->soc->altcx_pins[i].pin == gpio)
600 if (i == npct->soc->npins_altcx)
601 return NMK_GPIO_ALT_C;
603 pin_desc = npct->soc->altcx_pins + i;
604 gpiocr_regs = npct->soc->prcm_gpiocr_registers;
605 for (i = 0; i < PRCM_IDX_GPIOCR_ALTC_MAX; i++) {
606 if (pin_desc->altcx[i].used == true) {
607 reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
608 bit = pin_desc->altcx[i].control_bit;
609 if (readl(npct->prcm_base + reg) & BIT(bit))
610 return NMK_GPIO_ALT_C+i+1;
613 return NMK_GPIO_ALT_C;
616 int nmk_gpio_get_mode(int gpio)
618 struct nmk_gpio_chip *nmk_chip;
619 u32 afunc, bfunc, bit;
621 nmk_chip = nmk_gpio_chips[gpio / NMK_GPIO_PER_CHIP];
625 bit = 1 << (gpio % NMK_GPIO_PER_CHIP);
627 clk_enable(nmk_chip->clk);
629 afunc = readl(nmk_chip->addr + NMK_GPIO_AFSLA) & bit;
630 bfunc = readl(nmk_chip->addr + NMK_GPIO_AFSLB) & bit;
632 clk_disable(nmk_chip->clk);
634 return (afunc ? NMK_GPIO_ALT_A : 0) | (bfunc ? NMK_GPIO_ALT_B : 0);
636 EXPORT_SYMBOL(nmk_gpio_get_mode);
640 static inline int nmk_gpio_get_bitmask(int gpio)
642 return 1 << (gpio % NMK_GPIO_PER_CHIP);
645 static void nmk_gpio_irq_ack(struct irq_data *d)
647 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
648 struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
650 clk_enable(nmk_chip->clk);
651 writel(nmk_gpio_get_bitmask(d->hwirq), nmk_chip->addr + NMK_GPIO_IC);
652 clk_disable(nmk_chip->clk);
655 enum nmk_gpio_irq_type {
660 static void __nmk_gpio_irq_modify(struct nmk_gpio_chip *nmk_chip,
661 int gpio, enum nmk_gpio_irq_type which,
664 u32 bitmask = nmk_gpio_get_bitmask(gpio);
670 if (which == NORMAL) {
671 rimscreg = NMK_GPIO_RIMSC;
672 fimscreg = NMK_GPIO_FIMSC;
673 rimscval = &nmk_chip->rimsc;
674 fimscval = &nmk_chip->fimsc;
676 rimscreg = NMK_GPIO_RWIMSC;
677 fimscreg = NMK_GPIO_FWIMSC;
678 rimscval = &nmk_chip->rwimsc;
679 fimscval = &nmk_chip->fwimsc;
682 /* we must individually set/clear the two edges */
683 if (nmk_chip->edge_rising & bitmask) {
685 *rimscval |= bitmask;
687 *rimscval &= ~bitmask;
688 writel(*rimscval, nmk_chip->addr + rimscreg);
690 if (nmk_chip->edge_falling & bitmask) {
692 *fimscval |= bitmask;
694 *fimscval &= ~bitmask;
695 writel(*fimscval, nmk_chip->addr + fimscreg);
699 static void __nmk_gpio_set_wake(struct nmk_gpio_chip *nmk_chip,
703 * Ensure WAKEUP_ENABLE is on. No need to disable it if wakeup is
704 * disabled, since setting SLPM to 1 increases power consumption, and
705 * wakeup is anyhow controlled by the RIMSC and FIMSC registers.
707 if (nmk_chip->sleepmode && on) {
708 __nmk_gpio_set_slpm(nmk_chip, gpio % NMK_GPIO_PER_CHIP,
709 NMK_GPIO_SLPM_WAKEUP_ENABLE);
712 __nmk_gpio_irq_modify(nmk_chip, gpio, WAKE, on);
715 static int nmk_gpio_irq_maskunmask(struct irq_data *d, bool enable)
717 struct nmk_gpio_chip *nmk_chip;
721 nmk_chip = irq_data_get_irq_chip_data(d);
722 bitmask = nmk_gpio_get_bitmask(d->hwirq);
726 clk_enable(nmk_chip->clk);
727 spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
728 spin_lock(&nmk_chip->lock);
730 __nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, enable);
732 if (!(nmk_chip->real_wake & bitmask))
733 __nmk_gpio_set_wake(nmk_chip, d->hwirq, enable);
735 spin_unlock(&nmk_chip->lock);
736 spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
737 clk_disable(nmk_chip->clk);
742 static void nmk_gpio_irq_mask(struct irq_data *d)
744 nmk_gpio_irq_maskunmask(d, false);
747 static void nmk_gpio_irq_unmask(struct irq_data *d)
749 nmk_gpio_irq_maskunmask(d, true);
752 static int nmk_gpio_irq_set_wake(struct irq_data *d, unsigned int on)
754 struct nmk_gpio_chip *nmk_chip;
758 nmk_chip = irq_data_get_irq_chip_data(d);
761 bitmask = nmk_gpio_get_bitmask(d->hwirq);
763 clk_enable(nmk_chip->clk);
764 spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
765 spin_lock(&nmk_chip->lock);
767 if (irqd_irq_disabled(d))
768 __nmk_gpio_set_wake(nmk_chip, d->hwirq, on);
771 nmk_chip->real_wake |= bitmask;
773 nmk_chip->real_wake &= ~bitmask;
775 spin_unlock(&nmk_chip->lock);
776 spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
777 clk_disable(nmk_chip->clk);
782 static int nmk_gpio_irq_set_type(struct irq_data *d, unsigned int type)
784 bool enabled = !irqd_irq_disabled(d);
785 bool wake = irqd_is_wakeup_set(d);
786 struct nmk_gpio_chip *nmk_chip;
790 nmk_chip = irq_data_get_irq_chip_data(d);
791 bitmask = nmk_gpio_get_bitmask(d->hwirq);
794 if (type & IRQ_TYPE_LEVEL_HIGH)
796 if (type & IRQ_TYPE_LEVEL_LOW)
799 clk_enable(nmk_chip->clk);
800 spin_lock_irqsave(&nmk_chip->lock, flags);
803 __nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, false);
806 __nmk_gpio_irq_modify(nmk_chip, d->hwirq, WAKE, false);
808 nmk_chip->edge_rising &= ~bitmask;
809 if (type & IRQ_TYPE_EDGE_RISING)
810 nmk_chip->edge_rising |= bitmask;
812 nmk_chip->edge_falling &= ~bitmask;
813 if (type & IRQ_TYPE_EDGE_FALLING)
814 nmk_chip->edge_falling |= bitmask;
817 __nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, true);
820 __nmk_gpio_irq_modify(nmk_chip, d->hwirq, WAKE, true);
822 spin_unlock_irqrestore(&nmk_chip->lock, flags);
823 clk_disable(nmk_chip->clk);
828 static unsigned int nmk_gpio_irq_startup(struct irq_data *d)
830 struct nmk_gpio_chip *nmk_chip = irq_data_get_irq_chip_data(d);
832 clk_enable(nmk_chip->clk);
833 nmk_gpio_irq_unmask(d);
837 static void nmk_gpio_irq_shutdown(struct irq_data *d)
839 struct nmk_gpio_chip *nmk_chip = irq_data_get_irq_chip_data(d);
841 nmk_gpio_irq_mask(d);
842 clk_disable(nmk_chip->clk);
845 static struct irq_chip nmk_gpio_irq_chip = {
846 .name = "Nomadik-GPIO",
847 .irq_ack = nmk_gpio_irq_ack,
848 .irq_mask = nmk_gpio_irq_mask,
849 .irq_unmask = nmk_gpio_irq_unmask,
850 .irq_set_type = nmk_gpio_irq_set_type,
851 .irq_set_wake = nmk_gpio_irq_set_wake,
852 .irq_startup = nmk_gpio_irq_startup,
853 .irq_shutdown = nmk_gpio_irq_shutdown,
854 .flags = IRQCHIP_MASK_ON_SUSPEND,
857 static void __nmk_gpio_irq_handler(unsigned int irq, struct irq_desc *desc,
860 struct irq_chip *host_chip = irq_get_chip(irq);
861 struct gpio_chip *chip = irq_desc_get_handler_data(desc);
863 chained_irq_enter(host_chip, desc);
866 int bit = __ffs(status);
868 generic_handle_irq(irq_find_mapping(chip->irqdomain, bit));
872 chained_irq_exit(host_chip, desc);
875 static void nmk_gpio_irq_handler(unsigned int irq, struct irq_desc *desc)
877 struct gpio_chip *chip = irq_desc_get_handler_data(desc);
878 struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
881 clk_enable(nmk_chip->clk);
882 status = readl(nmk_chip->addr + NMK_GPIO_IS);
883 clk_disable(nmk_chip->clk);
885 __nmk_gpio_irq_handler(irq, desc, status);
888 static void nmk_gpio_latent_irq_handler(unsigned int irq,
889 struct irq_desc *desc)
891 struct gpio_chip *chip = irq_desc_get_handler_data(desc);
892 struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
893 u32 status = nmk_chip->get_latent_status(nmk_chip->bank);
895 __nmk_gpio_irq_handler(irq, desc, status);
900 static int nmk_gpio_request(struct gpio_chip *chip, unsigned offset)
903 * Map back to global GPIO space and request muxing, the direction
904 * parameter does not matter for this controller.
906 int gpio = chip->base + offset;
908 return pinctrl_request_gpio(gpio);
911 static void nmk_gpio_free(struct gpio_chip *chip, unsigned offset)
913 int gpio = chip->base + offset;
915 pinctrl_free_gpio(gpio);
918 static int nmk_gpio_make_input(struct gpio_chip *chip, unsigned offset)
920 struct nmk_gpio_chip *nmk_chip =
921 container_of(chip, struct nmk_gpio_chip, chip);
923 clk_enable(nmk_chip->clk);
925 writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRC);
927 clk_disable(nmk_chip->clk);
932 static int nmk_gpio_get_input(struct gpio_chip *chip, unsigned offset)
934 struct nmk_gpio_chip *nmk_chip =
935 container_of(chip, struct nmk_gpio_chip, chip);
936 u32 bit = 1 << offset;
939 clk_enable(nmk_chip->clk);
941 value = (readl(nmk_chip->addr + NMK_GPIO_DAT) & bit) != 0;
943 clk_disable(nmk_chip->clk);
948 static void nmk_gpio_set_output(struct gpio_chip *chip, unsigned offset,
951 struct nmk_gpio_chip *nmk_chip =
952 container_of(chip, struct nmk_gpio_chip, chip);
954 clk_enable(nmk_chip->clk);
956 __nmk_gpio_set_output(nmk_chip, offset, val);
958 clk_disable(nmk_chip->clk);
961 static int nmk_gpio_make_output(struct gpio_chip *chip, unsigned offset,
964 struct nmk_gpio_chip *nmk_chip =
965 container_of(chip, struct nmk_gpio_chip, chip);
967 clk_enable(nmk_chip->clk);
969 __nmk_gpio_make_output(nmk_chip, offset, val);
971 clk_disable(nmk_chip->clk);
976 #ifdef CONFIG_DEBUG_FS
978 #include <linux/seq_file.h>
980 static void nmk_gpio_dbg_show_one(struct seq_file *s,
981 struct pinctrl_dev *pctldev, struct gpio_chip *chip,
982 unsigned offset, unsigned gpio)
984 const char *label = gpiochip_is_requested(chip, offset);
985 struct nmk_gpio_chip *nmk_chip =
986 container_of(chip, struct nmk_gpio_chip, chip);
991 u32 bit = 1 << offset;
992 const char *modes[] = {
993 [NMK_GPIO_ALT_GPIO] = "gpio",
994 [NMK_GPIO_ALT_A] = "altA",
995 [NMK_GPIO_ALT_B] = "altB",
996 [NMK_GPIO_ALT_C] = "altC",
997 [NMK_GPIO_ALT_C+1] = "altC1",
998 [NMK_GPIO_ALT_C+2] = "altC2",
999 [NMK_GPIO_ALT_C+3] = "altC3",
1000 [NMK_GPIO_ALT_C+4] = "altC4",
1002 const char *pulls[] = {
1008 clk_enable(nmk_chip->clk);
1009 is_out = !!(readl(nmk_chip->addr + NMK_GPIO_DIR) & bit);
1010 pull = !(readl(nmk_chip->addr + NMK_GPIO_PDIS) & bit);
1011 data_out = !!(readl(nmk_chip->addr + NMK_GPIO_DAT) & bit);
1012 mode = nmk_gpio_get_mode(gpio);
1013 if ((mode == NMK_GPIO_ALT_C) && pctldev)
1014 mode = nmk_prcm_gpiocr_get_mode(pctldev, gpio);
1017 seq_printf(s, " gpio-%-3d (%-20.20s) out %s %s",
1020 data_out ? "hi" : "lo",
1021 (mode < 0) ? "unknown" : modes[mode]);
1023 int irq = gpio_to_irq(gpio);
1024 struct irq_desc *desc = irq_to_desc(irq);
1028 pullidx = data_out ? 1 : 2;
1030 seq_printf(s, " gpio-%-3d (%-20.20s) in %s %s",
1034 (mode < 0) ? "unknown" : modes[mode]);
1036 * This races with request_irq(), set_irq_type(),
1037 * and set_irq_wake() ... but those are "rare".
1039 if (irq > 0 && desc && desc->action) {
1041 u32 bitmask = nmk_gpio_get_bitmask(gpio);
1043 if (nmk_chip->edge_rising & bitmask)
1044 trigger = "edge-rising";
1045 else if (nmk_chip->edge_falling & bitmask)
1046 trigger = "edge-falling";
1048 trigger = "edge-undefined";
1050 seq_printf(s, " irq-%d %s%s",
1052 irqd_is_wakeup_set(&desc->irq_data)
1056 clk_disable(nmk_chip->clk);
1059 static void nmk_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1062 unsigned gpio = chip->base;
1064 for (i = 0; i < chip->ngpio; i++, gpio++) {
1065 nmk_gpio_dbg_show_one(s, NULL, chip, i, gpio);
1066 seq_printf(s, "\n");
1071 static inline void nmk_gpio_dbg_show_one(struct seq_file *s,
1072 struct pinctrl_dev *pctldev,
1073 struct gpio_chip *chip,
1074 unsigned offset, unsigned gpio)
1077 #define nmk_gpio_dbg_show NULL
1080 /* This structure is replicated for each GPIO block allocated at probe time */
1081 static struct gpio_chip nmk_gpio_template = {
1082 .request = nmk_gpio_request,
1083 .free = nmk_gpio_free,
1084 .direction_input = nmk_gpio_make_input,
1085 .get = nmk_gpio_get_input,
1086 .direction_output = nmk_gpio_make_output,
1087 .set = nmk_gpio_set_output,
1088 .dbg_show = nmk_gpio_dbg_show,
1092 void nmk_gpio_clocks_enable(void)
1096 for (i = 0; i < NUM_BANKS; i++) {
1097 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1102 clk_enable(chip->clk);
1106 void nmk_gpio_clocks_disable(void)
1110 for (i = 0; i < NUM_BANKS; i++) {
1111 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1116 clk_disable(chip->clk);
1121 * Called from the suspend/resume path to only keep the real wakeup interrupts
1122 * (those that have had set_irq_wake() called on them) as wakeup interrupts,
1123 * and not the rest of the interrupts which we needed to have as wakeups for
1126 * PM ops are not used since this needs to be done at the end, after all the
1127 * other drivers are done with their suspend callbacks.
1129 void nmk_gpio_wakeups_suspend(void)
1133 for (i = 0; i < NUM_BANKS; i++) {
1134 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1139 clk_enable(chip->clk);
1141 writel(chip->rwimsc & chip->real_wake,
1142 chip->addr + NMK_GPIO_RWIMSC);
1143 writel(chip->fwimsc & chip->real_wake,
1144 chip->addr + NMK_GPIO_FWIMSC);
1146 clk_disable(chip->clk);
1150 void nmk_gpio_wakeups_resume(void)
1154 for (i = 0; i < NUM_BANKS; i++) {
1155 struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1160 clk_enable(chip->clk);
1162 writel(chip->rwimsc, chip->addr + NMK_GPIO_RWIMSC);
1163 writel(chip->fwimsc, chip->addr + NMK_GPIO_FWIMSC);
1165 clk_disable(chip->clk);
1170 * Read the pull up/pull down status.
1171 * A bit set in 'pull_up' means that pull up
1172 * is selected if pull is enabled in PDIS register.
1173 * Note: only pull up/down set via this driver can
1174 * be detected due to HW limitations.
1176 void nmk_gpio_read_pull(int gpio_bank, u32 *pull_up)
1178 if (gpio_bank < NUM_BANKS) {
1179 struct nmk_gpio_chip *chip = nmk_gpio_chips[gpio_bank];
1184 *pull_up = chip->pull_up;
1188 static int nmk_gpio_probe(struct platform_device *dev)
1190 struct device_node *np = dev->dev.of_node;
1191 struct nmk_gpio_chip *nmk_chip;
1192 struct gpio_chip *chip;
1193 struct resource *res;
1196 bool supports_sleepmode;
1201 if (of_get_property(np, "st,supports-sleepmode", NULL))
1202 supports_sleepmode = true;
1204 supports_sleepmode = false;
1206 if (of_property_read_u32(np, "gpio-bank", &dev->id)) {
1207 dev_err(&dev->dev, "gpio-bank property not found\n");
1211 irq = platform_get_irq(dev, 0);
1215 /* It's OK for this IRQ not to be present */
1216 latent_irq = platform_get_irq(dev, 1);
1218 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
1219 base = devm_ioremap_resource(&dev->dev, res);
1221 return PTR_ERR(base);
1223 clk = devm_clk_get(&dev->dev, NULL);
1225 return PTR_ERR(clk);
1228 nmk_chip = devm_kzalloc(&dev->dev, sizeof(*nmk_chip), GFP_KERNEL);
1233 * The virt address in nmk_chip->addr is in the nomadik register space,
1234 * so we can simply convert the resource address, without remapping
1236 nmk_chip->bank = dev->id;
1237 nmk_chip->clk = clk;
1238 nmk_chip->addr = base;
1239 nmk_chip->chip = nmk_gpio_template;
1240 nmk_chip->parent_irq = irq;
1241 nmk_chip->latent_parent_irq = latent_irq;
1242 nmk_chip->sleepmode = supports_sleepmode;
1243 spin_lock_init(&nmk_chip->lock);
1245 chip = &nmk_chip->chip;
1246 chip->base = dev->id * NMK_GPIO_PER_CHIP;
1247 chip->ngpio = NMK_GPIO_PER_CHIP;
1248 chip->label = dev_name(&dev->dev);
1249 chip->dev = &dev->dev;
1250 chip->owner = THIS_MODULE;
1252 clk_enable(nmk_chip->clk);
1253 nmk_chip->lowemi = readl_relaxed(nmk_chip->addr + NMK_GPIO_LOWEMI);
1254 clk_disable(nmk_chip->clk);
1257 ret = gpiochip_add(&nmk_chip->chip);
1261 BUG_ON(nmk_chip->bank >= ARRAY_SIZE(nmk_gpio_chips));
1263 nmk_gpio_chips[nmk_chip->bank] = nmk_chip;
1265 platform_set_drvdata(dev, nmk_chip);
1268 * Let the generic code handle this edge IRQ, the the chained
1269 * handler will perform the actual work of handling the parent
1272 ret = gpiochip_irqchip_add(&nmk_chip->chip,
1276 IRQ_TYPE_EDGE_FALLING);
1278 dev_err(&dev->dev, "could not add irqchip\n");
1279 gpiochip_remove(&nmk_chip->chip);
1282 /* Then register the chain on the parent IRQ */
1283 gpiochip_set_chained_irqchip(&nmk_chip->chip,
1285 nmk_chip->parent_irq,
1286 nmk_gpio_irq_handler);
1287 if (nmk_chip->latent_parent_irq > 0)
1288 gpiochip_set_chained_irqchip(&nmk_chip->chip,
1290 nmk_chip->latent_parent_irq,
1291 nmk_gpio_latent_irq_handler);
1293 dev_info(&dev->dev, "at address %p\n", nmk_chip->addr);
1298 static int nmk_get_groups_cnt(struct pinctrl_dev *pctldev)
1300 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1302 return npct->soc->ngroups;
1305 static const char *nmk_get_group_name(struct pinctrl_dev *pctldev,
1308 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1310 return npct->soc->groups[selector].name;
1313 static int nmk_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector,
1314 const unsigned **pins,
1317 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1319 *pins = npct->soc->groups[selector].pins;
1320 *num_pins = npct->soc->groups[selector].npins;
1324 static struct pinctrl_gpio_range *
1325 nmk_match_gpio_range(struct pinctrl_dev *pctldev, unsigned offset)
1327 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1330 for (i = 0; i < npct->soc->gpio_num_ranges; i++) {
1331 struct pinctrl_gpio_range *range;
1333 range = &npct->soc->gpio_ranges[i];
1334 if (offset >= range->pin_base &&
1335 offset <= (range->pin_base + range->npins - 1))
1341 static void nmk_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
1344 struct pinctrl_gpio_range *range;
1345 struct gpio_chip *chip;
1347 range = nmk_match_gpio_range(pctldev, offset);
1348 if (!range || !range->gc) {
1349 seq_printf(s, "invalid pin offset");
1353 nmk_gpio_dbg_show_one(s, pctldev, chip, offset - chip->base, offset);
1356 static int nmk_dt_add_map_mux(struct pinctrl_map **map, unsigned *reserved_maps,
1357 unsigned *num_maps, const char *group,
1358 const char *function)
1360 if (*num_maps == *reserved_maps)
1363 (*map)[*num_maps].type = PIN_MAP_TYPE_MUX_GROUP;
1364 (*map)[*num_maps].data.mux.group = group;
1365 (*map)[*num_maps].data.mux.function = function;
1371 static int nmk_dt_add_map_configs(struct pinctrl_map **map,
1372 unsigned *reserved_maps,
1373 unsigned *num_maps, const char *group,
1374 unsigned long *configs, unsigned num_configs)
1376 unsigned long *dup_configs;
1378 if (*num_maps == *reserved_maps)
1381 dup_configs = kmemdup(configs, num_configs * sizeof(*dup_configs),
1386 (*map)[*num_maps].type = PIN_MAP_TYPE_CONFIGS_PIN;
1388 (*map)[*num_maps].data.configs.group_or_pin = group;
1389 (*map)[*num_maps].data.configs.configs = dup_configs;
1390 (*map)[*num_maps].data.configs.num_configs = num_configs;
1396 #define NMK_CONFIG_PIN(x, y) { .property = x, .config = y, }
1397 #define NMK_CONFIG_PIN_ARRAY(x, y) { .property = x, .choice = y, \
1398 .size = ARRAY_SIZE(y), }
1400 static const unsigned long nmk_pin_input_modes[] = {
1406 static const unsigned long nmk_pin_output_modes[] = {
1412 static const unsigned long nmk_pin_sleep_modes[] = {
1413 PIN_SLEEPMODE_DISABLED,
1414 PIN_SLEEPMODE_ENABLED,
1417 static const unsigned long nmk_pin_sleep_input_modes[] = {
1418 PIN_SLPM_INPUT_NOPULL,
1419 PIN_SLPM_INPUT_PULLUP,
1420 PIN_SLPM_INPUT_PULLDOWN,
1424 static const unsigned long nmk_pin_sleep_output_modes[] = {
1425 PIN_SLPM_OUTPUT_LOW,
1426 PIN_SLPM_OUTPUT_HIGH,
1427 PIN_SLPM_DIR_OUTPUT,
1430 static const unsigned long nmk_pin_sleep_wakeup_modes[] = {
1431 PIN_SLPM_WAKEUP_DISABLE,
1432 PIN_SLPM_WAKEUP_ENABLE,
1435 static const unsigned long nmk_pin_gpio_modes[] = {
1436 PIN_GPIOMODE_DISABLED,
1437 PIN_GPIOMODE_ENABLED,
1440 static const unsigned long nmk_pin_sleep_pdis_modes[] = {
1441 PIN_SLPM_PDIS_DISABLED,
1442 PIN_SLPM_PDIS_ENABLED,
1445 struct nmk_cfg_param {
1446 const char *property;
1447 unsigned long config;
1448 const unsigned long *choice;
1452 static const struct nmk_cfg_param nmk_cfg_params[] = {
1453 NMK_CONFIG_PIN_ARRAY("ste,input", nmk_pin_input_modes),
1454 NMK_CONFIG_PIN_ARRAY("ste,output", nmk_pin_output_modes),
1455 NMK_CONFIG_PIN_ARRAY("ste,sleep", nmk_pin_sleep_modes),
1456 NMK_CONFIG_PIN_ARRAY("ste,sleep-input", nmk_pin_sleep_input_modes),
1457 NMK_CONFIG_PIN_ARRAY("ste,sleep-output", nmk_pin_sleep_output_modes),
1458 NMK_CONFIG_PIN_ARRAY("ste,sleep-wakeup", nmk_pin_sleep_wakeup_modes),
1459 NMK_CONFIG_PIN_ARRAY("ste,gpio", nmk_pin_gpio_modes),
1460 NMK_CONFIG_PIN_ARRAY("ste,sleep-pull-disable", nmk_pin_sleep_pdis_modes),
1463 static int nmk_dt_pin_config(int index, int val, unsigned long *config)
1467 if (nmk_cfg_params[index].choice == NULL)
1468 *config = nmk_cfg_params[index].config;
1470 /* test if out of range */
1471 if (val < nmk_cfg_params[index].size) {
1472 *config = nmk_cfg_params[index].config |
1473 nmk_cfg_params[index].choice[val];
1479 static const char *nmk_find_pin_name(struct pinctrl_dev *pctldev, const char *pin_name)
1482 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1484 if (sscanf((char *)pin_name, "GPIO%d", &pin_number) == 1)
1485 for (i = 0; i < npct->soc->npins; i++)
1486 if (npct->soc->pins[i].number == pin_number)
1487 return npct->soc->pins[i].name;
1491 static bool nmk_pinctrl_dt_get_config(struct device_node *np,
1492 unsigned long *configs)
1494 bool has_config = 0;
1495 unsigned long cfg = 0;
1498 for (i = 0; i < ARRAY_SIZE(nmk_cfg_params); i++) {
1499 ret = of_property_read_u32(np,
1500 nmk_cfg_params[i].property, &val);
1501 if (ret != -EINVAL) {
1502 if (nmk_dt_pin_config(i, val, &cfg) == 0) {
1512 static int nmk_pinctrl_dt_subnode_to_map(struct pinctrl_dev *pctldev,
1513 struct device_node *np,
1514 struct pinctrl_map **map,
1515 unsigned *reserved_maps,
1519 const char *function = NULL;
1520 unsigned long configs = 0;
1521 bool has_config = 0;
1522 struct property *prop;
1523 struct device_node *np_config;
1525 ret = of_property_read_string(np, "function", &function);
1529 ret = of_property_count_strings(np, "groups");
1533 ret = pinctrl_utils_reserve_map(pctldev, map,
1539 of_property_for_each_string(np, "groups", prop, group) {
1540 ret = nmk_dt_add_map_mux(map, reserved_maps, num_maps,
1547 has_config = nmk_pinctrl_dt_get_config(np, &configs);
1548 np_config = of_parse_phandle(np, "ste,config", 0);
1550 has_config |= nmk_pinctrl_dt_get_config(np_config, &configs);
1552 const char *gpio_name;
1555 ret = of_property_count_strings(np, "pins");
1558 ret = pinctrl_utils_reserve_map(pctldev, map,
1564 of_property_for_each_string(np, "pins", prop, pin) {
1565 gpio_name = nmk_find_pin_name(pctldev, pin);
1567 ret = nmk_dt_add_map_configs(map, reserved_maps,
1569 gpio_name, &configs, 1);
1579 static int nmk_pinctrl_dt_node_to_map(struct pinctrl_dev *pctldev,
1580 struct device_node *np_config,
1581 struct pinctrl_map **map, unsigned *num_maps)
1583 unsigned reserved_maps;
1584 struct device_node *np;
1591 for_each_child_of_node(np_config, np) {
1592 ret = nmk_pinctrl_dt_subnode_to_map(pctldev, np, map,
1593 &reserved_maps, num_maps);
1595 pinctrl_utils_dt_free_map(pctldev, *map, *num_maps);
1603 static const struct pinctrl_ops nmk_pinctrl_ops = {
1604 .get_groups_count = nmk_get_groups_cnt,
1605 .get_group_name = nmk_get_group_name,
1606 .get_group_pins = nmk_get_group_pins,
1607 .pin_dbg_show = nmk_pin_dbg_show,
1608 .dt_node_to_map = nmk_pinctrl_dt_node_to_map,
1609 .dt_free_map = pinctrl_utils_dt_free_map,
1612 static int nmk_pmx_get_funcs_cnt(struct pinctrl_dev *pctldev)
1614 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1616 return npct->soc->nfunctions;
1619 static const char *nmk_pmx_get_func_name(struct pinctrl_dev *pctldev,
1622 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1624 return npct->soc->functions[function].name;
1627 static int nmk_pmx_get_func_groups(struct pinctrl_dev *pctldev,
1629 const char * const **groups,
1630 unsigned * const num_groups)
1632 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1634 *groups = npct->soc->functions[function].groups;
1635 *num_groups = npct->soc->functions[function].ngroups;
1640 static int nmk_pmx_set(struct pinctrl_dev *pctldev, unsigned function,
1643 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1644 const struct nmk_pingroup *g;
1645 static unsigned int slpm[NUM_BANKS];
1646 unsigned long flags = 0;
1651 g = &npct->soc->groups[group];
1653 if (g->altsetting < 0)
1656 dev_dbg(npct->dev, "enable group %s, %u pins\n", g->name, g->npins);
1659 * If we're setting altfunc C by setting both AFSLA and AFSLB to 1,
1660 * we may pass through an undesired state. In this case we take
1663 * Safe sequence used to switch IOs between GPIO and Alternate-C mode:
1664 * - Save SLPM registers (since we have a shadow register in the
1665 * nmk_chip we're using that as backup)
1666 * - Set SLPM=0 for the IOs you want to switch and others to 1
1667 * - Configure the GPIO registers for the IOs that are being switched
1669 * - Modify the AFLSA/B registers for the IOs that are being switched
1671 * - Restore SLPM registers
1672 * - Any spurious wake up event during switch sequence to be ignored
1675 * We REALLY need to save ALL slpm registers, because the external
1676 * IOFORCE will switch *all* ports to their sleepmode setting to as
1677 * to avoid glitches. (Not just one port!)
1679 glitch = ((g->altsetting & NMK_GPIO_ALT_C) == NMK_GPIO_ALT_C);
1682 spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
1684 /* Initially don't put any pins to sleep when switching */
1685 memset(slpm, 0xff, sizeof(slpm));
1688 * Then mask the pins that need to be sleeping now when we're
1689 * switching to the ALT C function.
1691 for (i = 0; i < g->npins; i++)
1692 slpm[g->pins[i] / NMK_GPIO_PER_CHIP] &= ~BIT(g->pins[i]);
1693 nmk_gpio_glitch_slpm_init(slpm);
1696 for (i = 0; i < g->npins; i++) {
1697 struct pinctrl_gpio_range *range;
1698 struct nmk_gpio_chip *nmk_chip;
1699 struct gpio_chip *chip;
1702 range = nmk_match_gpio_range(pctldev, g->pins[i]);
1705 "invalid pin offset %d in group %s at index %d\n",
1706 g->pins[i], g->name, i);
1710 dev_err(npct->dev, "GPIO chip missing in range for pin offset %d in group %s at index %d\n",
1711 g->pins[i], g->name, i);
1715 nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
1716 dev_dbg(npct->dev, "setting pin %d to altsetting %d\n", g->pins[i], g->altsetting);
1718 clk_enable(nmk_chip->clk);
1719 bit = g->pins[i] % NMK_GPIO_PER_CHIP;
1721 * If the pin is switching to altfunc, and there was an
1722 * interrupt installed on it which has been lazy disabled,
1723 * actually mask the interrupt to prevent spurious interrupts
1724 * that would occur while the pin is under control of the
1725 * peripheral. Only SKE does this.
1727 nmk_gpio_disable_lazy_irq(nmk_chip, bit);
1729 __nmk_gpio_set_mode_safe(nmk_chip, bit,
1730 (g->altsetting & NMK_GPIO_ALT_C), glitch);
1731 clk_disable(nmk_chip->clk);
1734 * Call PRCM GPIOCR config function in case ALTC
1735 * has been selected:
1736 * - If selection is a ALTCx, some bits in PRCM GPIOCR registers
1738 * - If selection is pure ALTC and previous selection was ALTCx,
1739 * then some bits in PRCM GPIOCR registers must be cleared.
1741 if ((g->altsetting & NMK_GPIO_ALT_C) == NMK_GPIO_ALT_C)
1742 nmk_prcm_altcx_set_mode(npct, g->pins[i],
1743 g->altsetting >> NMK_GPIO_ALT_CX_SHIFT);
1746 /* When all pins are successfully reconfigured we get here */
1751 nmk_gpio_glitch_slpm_restore(slpm);
1752 spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
1758 static int nmk_gpio_request_enable(struct pinctrl_dev *pctldev,
1759 struct pinctrl_gpio_range *range,
1762 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1763 struct nmk_gpio_chip *nmk_chip;
1764 struct gpio_chip *chip;
1768 dev_err(npct->dev, "invalid range\n");
1772 dev_err(npct->dev, "missing GPIO chip in range\n");
1776 nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
1778 dev_dbg(npct->dev, "enable pin %u as GPIO\n", offset);
1780 clk_enable(nmk_chip->clk);
1781 bit = offset % NMK_GPIO_PER_CHIP;
1782 /* There is no glitch when converting any pin to GPIO */
1783 __nmk_gpio_set_mode(nmk_chip, bit, NMK_GPIO_ALT_GPIO);
1784 clk_disable(nmk_chip->clk);
1789 static void nmk_gpio_disable_free(struct pinctrl_dev *pctldev,
1790 struct pinctrl_gpio_range *range,
1793 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1795 dev_dbg(npct->dev, "disable pin %u as GPIO\n", offset);
1796 /* Set the pin to some default state, GPIO is usually default */
1799 static const struct pinmux_ops nmk_pinmux_ops = {
1800 .get_functions_count = nmk_pmx_get_funcs_cnt,
1801 .get_function_name = nmk_pmx_get_func_name,
1802 .get_function_groups = nmk_pmx_get_func_groups,
1803 .set_mux = nmk_pmx_set,
1804 .gpio_request_enable = nmk_gpio_request_enable,
1805 .gpio_disable_free = nmk_gpio_disable_free,
1808 static int nmk_pin_config_get(struct pinctrl_dev *pctldev, unsigned pin,
1809 unsigned long *config)
1811 /* Not implemented */
1815 static int nmk_pin_config_set(struct pinctrl_dev *pctldev, unsigned pin,
1816 unsigned long *configs, unsigned num_configs)
1818 static const char *pullnames[] = {
1819 [NMK_GPIO_PULL_NONE] = "none",
1820 [NMK_GPIO_PULL_UP] = "up",
1821 [NMK_GPIO_PULL_DOWN] = "down",
1822 [3] /* illegal */ = "??"
1824 static const char *slpmnames[] = {
1825 [NMK_GPIO_SLPM_INPUT] = "input/wakeup",
1826 [NMK_GPIO_SLPM_NOCHANGE] = "no-change/no-wakeup",
1828 struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1829 struct nmk_gpio_chip *nmk_chip;
1830 struct pinctrl_gpio_range *range;
1831 struct gpio_chip *chip;
1834 int pull, slpm, output, val, i;
1835 bool lowemi, gpiomode, sleep;
1837 range = nmk_match_gpio_range(pctldev, pin);
1839 dev_err(npct->dev, "invalid pin offset %d\n", pin);
1843 dev_err(npct->dev, "GPIO chip missing in range for pin %d\n",
1848 nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
1850 for (i = 0; i < num_configs; i++) {
1852 * The pin config contains pin number and altfunction fields,
1853 * here we just ignore that part. It's being handled by the
1854 * framework and pinmux callback respectively.
1856 cfg = (pin_cfg_t) configs[i];
1857 pull = PIN_PULL(cfg);
1858 slpm = PIN_SLPM(cfg);
1859 output = PIN_DIR(cfg);
1861 lowemi = PIN_LOWEMI(cfg);
1862 gpiomode = PIN_GPIOMODE(cfg);
1863 sleep = PIN_SLEEPMODE(cfg);
1866 int slpm_pull = PIN_SLPM_PULL(cfg);
1867 int slpm_output = PIN_SLPM_DIR(cfg);
1868 int slpm_val = PIN_SLPM_VAL(cfg);
1870 /* All pins go into GPIO mode at sleep */
1874 * The SLPM_* values are normal values + 1 to allow zero
1875 * to mean "same as normal".
1878 pull = slpm_pull - 1;
1880 output = slpm_output - 1;
1884 dev_dbg(nmk_chip->chip.dev,
1885 "pin %d: sleep pull %s, dir %s, val %s\n",
1887 slpm_pull ? pullnames[pull] : "same",
1888 slpm_output ? (output ? "output" : "input")
1890 slpm_val ? (val ? "high" : "low") : "same");
1893 dev_dbg(nmk_chip->chip.dev,
1894 "pin %d [%#lx]: pull %s, slpm %s (%s%s), lowemi %s\n",
1895 pin, cfg, pullnames[pull], slpmnames[slpm],
1896 output ? "output " : "input",
1897 output ? (val ? "high" : "low") : "",
1898 lowemi ? "on" : "off");
1900 clk_enable(nmk_chip->clk);
1901 bit = pin % NMK_GPIO_PER_CHIP;
1903 /* No glitch when going to GPIO mode */
1904 __nmk_gpio_set_mode(nmk_chip, bit, NMK_GPIO_ALT_GPIO);
1906 __nmk_gpio_make_output(nmk_chip, bit, val);
1908 __nmk_gpio_make_input(nmk_chip, bit);
1909 __nmk_gpio_set_pull(nmk_chip, bit, pull);
1911 /* TODO: isn't this only applicable on output pins? */
1912 __nmk_gpio_set_lowemi(nmk_chip, bit, lowemi);
1914 __nmk_gpio_set_slpm(nmk_chip, bit, slpm);
1915 clk_disable(nmk_chip->clk);
1916 } /* for each config */
1921 static const struct pinconf_ops nmk_pinconf_ops = {
1922 .pin_config_get = nmk_pin_config_get,
1923 .pin_config_set = nmk_pin_config_set,
1926 static struct pinctrl_desc nmk_pinctrl_desc = {
1927 .name = "pinctrl-nomadik",
1928 .pctlops = &nmk_pinctrl_ops,
1929 .pmxops = &nmk_pinmux_ops,
1930 .confops = &nmk_pinconf_ops,
1931 .owner = THIS_MODULE,
1934 static const struct of_device_id nmk_pinctrl_match[] = {
1936 .compatible = "stericsson,stn8815-pinctrl",
1937 .data = (void *)PINCTRL_NMK_STN8815,
1940 .compatible = "stericsson,db8500-pinctrl",
1941 .data = (void *)PINCTRL_NMK_DB8500,
1944 .compatible = "stericsson,db8540-pinctrl",
1945 .data = (void *)PINCTRL_NMK_DB8540,
1950 #ifdef CONFIG_PM_SLEEP
1951 static int nmk_pinctrl_suspend(struct device *dev)
1953 struct nmk_pinctrl *npct;
1955 npct = dev_get_drvdata(dev);
1959 return pinctrl_force_sleep(npct->pctl);
1962 static int nmk_pinctrl_resume(struct device *dev)
1964 struct nmk_pinctrl *npct;
1966 npct = dev_get_drvdata(dev);
1970 return pinctrl_force_default(npct->pctl);
1974 static int nmk_pinctrl_probe(struct platform_device *pdev)
1976 const struct of_device_id *match;
1977 struct device_node *np = pdev->dev.of_node;
1978 struct device_node *prcm_np;
1979 struct nmk_pinctrl *npct;
1980 unsigned int version = 0;
1983 npct = devm_kzalloc(&pdev->dev, sizeof(*npct), GFP_KERNEL);
1987 match = of_match_device(nmk_pinctrl_match, &pdev->dev);
1990 version = (unsigned int) match->data;
1992 /* Poke in other ASIC variants here */
1993 if (version == PINCTRL_NMK_STN8815)
1994 nmk_pinctrl_stn8815_init(&npct->soc);
1995 if (version == PINCTRL_NMK_DB8500)
1996 nmk_pinctrl_db8500_init(&npct->soc);
1997 if (version == PINCTRL_NMK_DB8540)
1998 nmk_pinctrl_db8540_init(&npct->soc);
2000 prcm_np = of_parse_phandle(np, "prcm", 0);
2002 npct->prcm_base = of_iomap(prcm_np, 0);
2003 if (!npct->prcm_base) {
2004 if (version == PINCTRL_NMK_STN8815) {
2005 dev_info(&pdev->dev,
2007 "assuming no ALT-Cx control is available\n");
2009 dev_err(&pdev->dev, "missing PRCM base address\n");
2015 * We need all the GPIO drivers to probe FIRST, or we will not be able
2016 * to obtain references to the struct gpio_chip * for them, and we
2017 * need this to proceed.
2019 for (i = 0; i < npct->soc->gpio_num_ranges; i++) {
2020 if (!nmk_gpio_chips[npct->soc->gpio_ranges[i].id]) {
2021 dev_warn(&pdev->dev, "GPIO chip %d not registered yet\n", i);
2022 return -EPROBE_DEFER;
2024 npct->soc->gpio_ranges[i].gc = &nmk_gpio_chips[npct->soc->gpio_ranges[i].id]->chip;
2027 nmk_pinctrl_desc.pins = npct->soc->pins;
2028 nmk_pinctrl_desc.npins = npct->soc->npins;
2029 npct->dev = &pdev->dev;
2031 npct->pctl = pinctrl_register(&nmk_pinctrl_desc, &pdev->dev, npct);
2033 dev_err(&pdev->dev, "could not register Nomadik pinctrl driver\n");
2037 /* We will handle a range of GPIO pins */
2038 for (i = 0; i < npct->soc->gpio_num_ranges; i++)
2039 pinctrl_add_gpio_range(npct->pctl, &npct->soc->gpio_ranges[i]);
2041 platform_set_drvdata(pdev, npct);
2042 dev_info(&pdev->dev, "initialized Nomadik pin control driver\n");
2047 static const struct of_device_id nmk_gpio_match[] = {
2048 { .compatible = "st,nomadik-gpio", },
2052 static struct platform_driver nmk_gpio_driver = {
2055 .of_match_table = nmk_gpio_match,
2057 .probe = nmk_gpio_probe,
2060 static SIMPLE_DEV_PM_OPS(nmk_pinctrl_pm_ops,
2061 nmk_pinctrl_suspend,
2062 nmk_pinctrl_resume);
2064 static struct platform_driver nmk_pinctrl_driver = {
2066 .name = "pinctrl-nomadik",
2067 .of_match_table = nmk_pinctrl_match,
2068 .pm = &nmk_pinctrl_pm_ops,
2070 .probe = nmk_pinctrl_probe,
2073 static int __init nmk_gpio_init(void)
2077 ret = platform_driver_register(&nmk_gpio_driver);
2080 return platform_driver_register(&nmk_pinctrl_driver);
2083 core_initcall(nmk_gpio_init);
2085 MODULE_AUTHOR("Prafulla WADASKAR and Alessandro Rubini");
2086 MODULE_DESCRIPTION("Nomadik GPIO Driver");
2087 MODULE_LICENSE("GPL");