xref: /linux/drivers/pinctrl/nomadik/pinctrl-nomadik.c (revision b85d45947951d23cb22d90caecf4c1eb81342c96)
1 /*
2  * Generic GPIO driver for logic cells found in the Nomadik SoC
3  *
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>
8  *
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.
12  */
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>
18 #include <linux/io.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"
34 #include "../core.h"
35 #include "../pinctrl-utils.h"
36 
37 /*
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.
41  *
42  * Symbols in this file are called "nmk_gpio" for "nomadik gpio"
43  */
44 
45 /*
46  * pin configurations are represented by 32-bit integers:
47  *
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
52  *	bit     14 - Direction
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)
58  *	bit	26 - Gpio mode
59  *	bit	27 - Sleep mode
60  *
61  * to facilitate the definition, the following macros are provided
62  *
63  * PIN_CFG_DEFAULT - default config (0):
64  *		     pull up/down = disabled
65  *		     sleep mode = input/wakeup
66  *		     direction = input
67  *		     value = low
68  *		     SLPM direction = same as normal
69  *		     SLPM pull = same as normal
70  *		     SLPM value = same as normal
71  *
72  * PIN_CFG	   - default config with alternate function
73  */
74 
75 typedef unsigned long pin_cfg_t;
76 
77 #define PIN_NUM_MASK		0x1ff
78 #define PIN_NUM(x)		((x) & PIN_NUM_MASK)
79 
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)
87 
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)
94 
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
104 
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 */
107 
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)
113 
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)
119 
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)
130 
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)
137 
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)
144 
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)
152 
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)
158 
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)
164 
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)
170 
171 
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)
178 
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)
184 
185 #define PIN_CFG_DEFAULT		(0)
186 
187 #define PIN_CFG(num, alt)		\
188 	(PIN_CFG_DEFAULT |\
189 	 (PIN_NUM(num) | PIN_##alt))
190 
191 #define PIN_CFG_INPUT(num, alt, pull)		\
192 	(PIN_CFG_DEFAULT |\
193 	 (PIN_NUM(num) | PIN_##alt | PIN_INPUT_##pull))
194 
195 #define PIN_CFG_OUTPUT(num, alt, val)		\
196 	(PIN_CFG_DEFAULT |\
197 	 (PIN_NUM(num) | PIN_##alt | PIN_OUTPUT_##val))
198 
199 /*
200  * "nmk_gpio" and "NMK_GPIO" stand for "Nomadik GPIO", leaving
201  * the "gpio" namespace for generic and cross-machine functions
202  */
203 
204 #define GPIO_BLOCK_SHIFT 5
205 #define NMK_GPIO_PER_CHIP (1 << GPIO_BLOCK_SHIFT)
206 #define NMK_MAX_BANKS DIV_ROUND_UP(ARCH_NR_GPIOS, NMK_GPIO_PER_CHIP)
207 
208 /* Register in the logic block */
209 #define NMK_GPIO_DAT	0x00
210 #define NMK_GPIO_DATS	0x04
211 #define NMK_GPIO_DATC	0x08
212 #define NMK_GPIO_PDIS	0x0c
213 #define NMK_GPIO_DIR	0x10
214 #define NMK_GPIO_DIRS	0x14
215 #define NMK_GPIO_DIRC	0x18
216 #define NMK_GPIO_SLPC	0x1c
217 #define NMK_GPIO_AFSLA	0x20
218 #define NMK_GPIO_AFSLB	0x24
219 #define NMK_GPIO_LOWEMI	0x28
220 
221 #define NMK_GPIO_RIMSC	0x40
222 #define NMK_GPIO_FIMSC	0x44
223 #define NMK_GPIO_IS	0x48
224 #define NMK_GPIO_IC	0x4c
225 #define NMK_GPIO_RWIMSC	0x50
226 #define NMK_GPIO_FWIMSC	0x54
227 #define NMK_GPIO_WKS	0x58
228 /* These appear in DB8540 and later ASICs */
229 #define NMK_GPIO_EDGELEVEL 0x5C
230 #define NMK_GPIO_LEVEL	0x60
231 
232 
233 /* Pull up/down values */
234 enum nmk_gpio_pull {
235 	NMK_GPIO_PULL_NONE,
236 	NMK_GPIO_PULL_UP,
237 	NMK_GPIO_PULL_DOWN,
238 };
239 
240 /* Sleep mode */
241 enum nmk_gpio_slpm {
242 	NMK_GPIO_SLPM_INPUT,
243 	NMK_GPIO_SLPM_WAKEUP_ENABLE = NMK_GPIO_SLPM_INPUT,
244 	NMK_GPIO_SLPM_NOCHANGE,
245 	NMK_GPIO_SLPM_WAKEUP_DISABLE = NMK_GPIO_SLPM_NOCHANGE,
246 };
247 
248 struct nmk_gpio_chip {
249 	struct gpio_chip chip;
250 	struct irq_chip irqchip;
251 	void __iomem *addr;
252 	struct clk *clk;
253 	unsigned int bank;
254 	unsigned int parent_irq;
255 	int latent_parent_irq;
256 	u32 (*get_latent_status)(unsigned int bank);
257 	void (*set_ioforce)(bool enable);
258 	spinlock_t lock;
259 	bool sleepmode;
260 	/* Keep track of configured edges */
261 	u32 edge_rising;
262 	u32 edge_falling;
263 	u32 real_wake;
264 	u32 rwimsc;
265 	u32 fwimsc;
266 	u32 rimsc;
267 	u32 fimsc;
268 	u32 pull_up;
269 	u32 lowemi;
270 };
271 
272 /**
273  * struct nmk_pinctrl - state container for the Nomadik pin controller
274  * @dev: containing device pointer
275  * @pctl: corresponding pin controller device
276  * @soc: SoC data for this specific chip
277  * @prcm_base: PRCM register range virtual base
278  */
279 struct nmk_pinctrl {
280 	struct device *dev;
281 	struct pinctrl_dev *pctl;
282 	const struct nmk_pinctrl_soc_data *soc;
283 	void __iomem *prcm_base;
284 };
285 
286 static struct nmk_gpio_chip *nmk_gpio_chips[NMK_MAX_BANKS];
287 
288 static DEFINE_SPINLOCK(nmk_gpio_slpm_lock);
289 
290 #define NUM_BANKS ARRAY_SIZE(nmk_gpio_chips)
291 
292 static void __nmk_gpio_set_mode(struct nmk_gpio_chip *nmk_chip,
293 				unsigned offset, int gpio_mode)
294 {
295 	u32 bit = 1 << offset;
296 	u32 afunc, bfunc;
297 
298 	afunc = readl(nmk_chip->addr + NMK_GPIO_AFSLA) & ~bit;
299 	bfunc = readl(nmk_chip->addr + NMK_GPIO_AFSLB) & ~bit;
300 	if (gpio_mode & NMK_GPIO_ALT_A)
301 		afunc |= bit;
302 	if (gpio_mode & NMK_GPIO_ALT_B)
303 		bfunc |= bit;
304 	writel(afunc, nmk_chip->addr + NMK_GPIO_AFSLA);
305 	writel(bfunc, nmk_chip->addr + NMK_GPIO_AFSLB);
306 }
307 
308 static void __nmk_gpio_set_slpm(struct nmk_gpio_chip *nmk_chip,
309 				unsigned offset, enum nmk_gpio_slpm mode)
310 {
311 	u32 bit = 1 << offset;
312 	u32 slpm;
313 
314 	slpm = readl(nmk_chip->addr + NMK_GPIO_SLPC);
315 	if (mode == NMK_GPIO_SLPM_NOCHANGE)
316 		slpm |= bit;
317 	else
318 		slpm &= ~bit;
319 	writel(slpm, nmk_chip->addr + NMK_GPIO_SLPC);
320 }
321 
322 static void __nmk_gpio_set_pull(struct nmk_gpio_chip *nmk_chip,
323 				unsigned offset, enum nmk_gpio_pull pull)
324 {
325 	u32 bit = 1 << offset;
326 	u32 pdis;
327 
328 	pdis = readl(nmk_chip->addr + NMK_GPIO_PDIS);
329 	if (pull == NMK_GPIO_PULL_NONE) {
330 		pdis |= bit;
331 		nmk_chip->pull_up &= ~bit;
332 	} else {
333 		pdis &= ~bit;
334 	}
335 
336 	writel(pdis, nmk_chip->addr + NMK_GPIO_PDIS);
337 
338 	if (pull == NMK_GPIO_PULL_UP) {
339 		nmk_chip->pull_up |= bit;
340 		writel(bit, nmk_chip->addr + NMK_GPIO_DATS);
341 	} else if (pull == NMK_GPIO_PULL_DOWN) {
342 		nmk_chip->pull_up &= ~bit;
343 		writel(bit, nmk_chip->addr + NMK_GPIO_DATC);
344 	}
345 }
346 
347 static void __nmk_gpio_set_lowemi(struct nmk_gpio_chip *nmk_chip,
348 				  unsigned offset, bool lowemi)
349 {
350 	u32 bit = BIT(offset);
351 	bool enabled = nmk_chip->lowemi & bit;
352 
353 	if (lowemi == enabled)
354 		return;
355 
356 	if (lowemi)
357 		nmk_chip->lowemi |= bit;
358 	else
359 		nmk_chip->lowemi &= ~bit;
360 
361 	writel_relaxed(nmk_chip->lowemi,
362 		       nmk_chip->addr + NMK_GPIO_LOWEMI);
363 }
364 
365 static void __nmk_gpio_make_input(struct nmk_gpio_chip *nmk_chip,
366 				  unsigned offset)
367 {
368 	writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRC);
369 }
370 
371 static void __nmk_gpio_set_output(struct nmk_gpio_chip *nmk_chip,
372 				  unsigned offset, int val)
373 {
374 	if (val)
375 		writel(1 << offset, nmk_chip->addr + NMK_GPIO_DATS);
376 	else
377 		writel(1 << offset, nmk_chip->addr + NMK_GPIO_DATC);
378 }
379 
380 static void __nmk_gpio_make_output(struct nmk_gpio_chip *nmk_chip,
381 				  unsigned offset, int val)
382 {
383 	writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRS);
384 	__nmk_gpio_set_output(nmk_chip, offset, val);
385 }
386 
387 static void __nmk_gpio_set_mode_safe(struct nmk_gpio_chip *nmk_chip,
388 				     unsigned offset, int gpio_mode,
389 				     bool glitch)
390 {
391 	u32 rwimsc = nmk_chip->rwimsc;
392 	u32 fwimsc = nmk_chip->fwimsc;
393 
394 	if (glitch && nmk_chip->set_ioforce) {
395 		u32 bit = BIT(offset);
396 
397 		/* Prevent spurious wakeups */
398 		writel(rwimsc & ~bit, nmk_chip->addr + NMK_GPIO_RWIMSC);
399 		writel(fwimsc & ~bit, nmk_chip->addr + NMK_GPIO_FWIMSC);
400 
401 		nmk_chip->set_ioforce(true);
402 	}
403 
404 	__nmk_gpio_set_mode(nmk_chip, offset, gpio_mode);
405 
406 	if (glitch && nmk_chip->set_ioforce) {
407 		nmk_chip->set_ioforce(false);
408 
409 		writel(rwimsc, nmk_chip->addr + NMK_GPIO_RWIMSC);
410 		writel(fwimsc, nmk_chip->addr + NMK_GPIO_FWIMSC);
411 	}
412 }
413 
414 static void
415 nmk_gpio_disable_lazy_irq(struct nmk_gpio_chip *nmk_chip, unsigned offset)
416 {
417 	u32 falling = nmk_chip->fimsc & BIT(offset);
418 	u32 rising = nmk_chip->rimsc & BIT(offset);
419 	int gpio = nmk_chip->chip.base + offset;
420 	int irq = irq_find_mapping(nmk_chip->chip.irqdomain, offset);
421 	struct irq_data *d = irq_get_irq_data(irq);
422 
423 	if (!rising && !falling)
424 		return;
425 
426 	if (!d || !irqd_irq_disabled(d))
427 		return;
428 
429 	if (rising) {
430 		nmk_chip->rimsc &= ~BIT(offset);
431 		writel_relaxed(nmk_chip->rimsc,
432 			       nmk_chip->addr + NMK_GPIO_RIMSC);
433 	}
434 
435 	if (falling) {
436 		nmk_chip->fimsc &= ~BIT(offset);
437 		writel_relaxed(nmk_chip->fimsc,
438 			       nmk_chip->addr + NMK_GPIO_FIMSC);
439 	}
440 
441 	dev_dbg(nmk_chip->chip.dev, "%d: clearing interrupt mask\n", gpio);
442 }
443 
444 static void nmk_write_masked(void __iomem *reg, u32 mask, u32 value)
445 {
446 	u32 val;
447 
448 	val = readl(reg);
449 	val = ((val & ~mask) | (value & mask));
450 	writel(val, reg);
451 }
452 
453 static void nmk_prcm_altcx_set_mode(struct nmk_pinctrl *npct,
454 	unsigned offset, unsigned alt_num)
455 {
456 	int i;
457 	u16 reg;
458 	u8 bit;
459 	u8 alt_index;
460 	const struct prcm_gpiocr_altcx_pin_desc *pin_desc;
461 	const u16 *gpiocr_regs;
462 
463 	if (!npct->prcm_base)
464 		return;
465 
466 	if (alt_num > PRCM_IDX_GPIOCR_ALTC_MAX) {
467 		dev_err(npct->dev, "PRCM GPIOCR: alternate-C%i is invalid\n",
468 			alt_num);
469 		return;
470 	}
471 
472 	for (i = 0 ; i < npct->soc->npins_altcx ; i++) {
473 		if (npct->soc->altcx_pins[i].pin == offset)
474 			break;
475 	}
476 	if (i == npct->soc->npins_altcx) {
477 		dev_dbg(npct->dev, "PRCM GPIOCR: pin %i is not found\n",
478 			offset);
479 		return;
480 	}
481 
482 	pin_desc = npct->soc->altcx_pins + i;
483 	gpiocr_regs = npct->soc->prcm_gpiocr_registers;
484 
485 	/*
486 	 * If alt_num is NULL, just clear current ALTCx selection
487 	 * to make sure we come back to a pure ALTC selection
488 	 */
489 	if (!alt_num) {
490 		for (i = 0 ; i < PRCM_IDX_GPIOCR_ALTC_MAX ; i++) {
491 			if (pin_desc->altcx[i].used == true) {
492 				reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
493 				bit = pin_desc->altcx[i].control_bit;
494 				if (readl(npct->prcm_base + reg) & BIT(bit)) {
495 					nmk_write_masked(npct->prcm_base + reg, BIT(bit), 0);
496 					dev_dbg(npct->dev,
497 						"PRCM GPIOCR: pin %i: alternate-C%i has been disabled\n",
498 						offset, i+1);
499 				}
500 			}
501 		}
502 		return;
503 	}
504 
505 	alt_index = alt_num - 1;
506 	if (pin_desc->altcx[alt_index].used == false) {
507 		dev_warn(npct->dev,
508 			"PRCM GPIOCR: pin %i: alternate-C%i does not exist\n",
509 			offset, alt_num);
510 		return;
511 	}
512 
513 	/*
514 	 * Check if any other ALTCx functions are activated on this pin
515 	 * and disable it first.
516 	 */
517 	for (i = 0 ; i < PRCM_IDX_GPIOCR_ALTC_MAX ; i++) {
518 		if (i == alt_index)
519 			continue;
520 		if (pin_desc->altcx[i].used == true) {
521 			reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
522 			bit = pin_desc->altcx[i].control_bit;
523 			if (readl(npct->prcm_base + reg) & BIT(bit)) {
524 				nmk_write_masked(npct->prcm_base + reg, BIT(bit), 0);
525 				dev_dbg(npct->dev,
526 					"PRCM GPIOCR: pin %i: alternate-C%i has been disabled\n",
527 					offset, i+1);
528 			}
529 		}
530 	}
531 
532 	reg = gpiocr_regs[pin_desc->altcx[alt_index].reg_index];
533 	bit = pin_desc->altcx[alt_index].control_bit;
534 	dev_dbg(npct->dev, "PRCM GPIOCR: pin %i: alternate-C%i has been selected\n",
535 		offset, alt_index+1);
536 	nmk_write_masked(npct->prcm_base + reg, BIT(bit), BIT(bit));
537 }
538 
539 /*
540  * Safe sequence used to switch IOs between GPIO and Alternate-C mode:
541  *  - Save SLPM registers
542  *  - Set SLPM=0 for the IOs you want to switch and others to 1
543  *  - Configure the GPIO registers for the IOs that are being switched
544  *  - Set IOFORCE=1
545  *  - Modify the AFLSA/B registers for the IOs that are being switched
546  *  - Set IOFORCE=0
547  *  - Restore SLPM registers
548  *  - Any spurious wake up event during switch sequence to be ignored and
549  *    cleared
550  */
551 static void nmk_gpio_glitch_slpm_init(unsigned int *slpm)
552 {
553 	int i;
554 
555 	for (i = 0; i < NUM_BANKS; i++) {
556 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
557 		unsigned int temp = slpm[i];
558 
559 		if (!chip)
560 			break;
561 
562 		clk_enable(chip->clk);
563 
564 		slpm[i] = readl(chip->addr + NMK_GPIO_SLPC);
565 		writel(temp, chip->addr + NMK_GPIO_SLPC);
566 	}
567 }
568 
569 static void nmk_gpio_glitch_slpm_restore(unsigned int *slpm)
570 {
571 	int i;
572 
573 	for (i = 0; i < NUM_BANKS; i++) {
574 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
575 
576 		if (!chip)
577 			break;
578 
579 		writel(slpm[i], chip->addr + NMK_GPIO_SLPC);
580 
581 		clk_disable(chip->clk);
582 	}
583 }
584 
585 static int __maybe_unused nmk_prcm_gpiocr_get_mode(struct pinctrl_dev *pctldev, int gpio)
586 {
587 	int i;
588 	u16 reg;
589 	u8 bit;
590 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
591 	const struct prcm_gpiocr_altcx_pin_desc *pin_desc;
592 	const u16 *gpiocr_regs;
593 
594 	if (!npct->prcm_base)
595 		return NMK_GPIO_ALT_C;
596 
597 	for (i = 0; i < npct->soc->npins_altcx; i++) {
598 		if (npct->soc->altcx_pins[i].pin == gpio)
599 			break;
600 	}
601 	if (i == npct->soc->npins_altcx)
602 		return NMK_GPIO_ALT_C;
603 
604 	pin_desc = npct->soc->altcx_pins + i;
605 	gpiocr_regs = npct->soc->prcm_gpiocr_registers;
606 	for (i = 0; i < PRCM_IDX_GPIOCR_ALTC_MAX; i++) {
607 		if (pin_desc->altcx[i].used == true) {
608 			reg = gpiocr_regs[pin_desc->altcx[i].reg_index];
609 			bit = pin_desc->altcx[i].control_bit;
610 			if (readl(npct->prcm_base + reg) & BIT(bit))
611 				return NMK_GPIO_ALT_C+i+1;
612 		}
613 	}
614 	return NMK_GPIO_ALT_C;
615 }
616 
617 int nmk_gpio_get_mode(int gpio)
618 {
619 	struct nmk_gpio_chip *nmk_chip;
620 	u32 afunc, bfunc, bit;
621 
622 	nmk_chip = nmk_gpio_chips[gpio / NMK_GPIO_PER_CHIP];
623 	if (!nmk_chip)
624 		return -EINVAL;
625 
626 	bit = 1 << (gpio % NMK_GPIO_PER_CHIP);
627 
628 	clk_enable(nmk_chip->clk);
629 
630 	afunc = readl(nmk_chip->addr + NMK_GPIO_AFSLA) & bit;
631 	bfunc = readl(nmk_chip->addr + NMK_GPIO_AFSLB) & bit;
632 
633 	clk_disable(nmk_chip->clk);
634 
635 	return (afunc ? NMK_GPIO_ALT_A : 0) | (bfunc ? NMK_GPIO_ALT_B : 0);
636 }
637 EXPORT_SYMBOL(nmk_gpio_get_mode);
638 
639 
640 /* IRQ functions */
641 static inline int nmk_gpio_get_bitmask(int gpio)
642 {
643 	return 1 << (gpio % NMK_GPIO_PER_CHIP);
644 }
645 
646 static void nmk_gpio_irq_ack(struct irq_data *d)
647 {
648 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
649 	struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
650 
651 	clk_enable(nmk_chip->clk);
652 	writel(nmk_gpio_get_bitmask(d->hwirq), nmk_chip->addr + NMK_GPIO_IC);
653 	clk_disable(nmk_chip->clk);
654 }
655 
656 enum nmk_gpio_irq_type {
657 	NORMAL,
658 	WAKE,
659 };
660 
661 static void __nmk_gpio_irq_modify(struct nmk_gpio_chip *nmk_chip,
662 				  int gpio, enum nmk_gpio_irq_type which,
663 				  bool enable)
664 {
665 	u32 bitmask = nmk_gpio_get_bitmask(gpio);
666 	u32 *rimscval;
667 	u32 *fimscval;
668 	u32 rimscreg;
669 	u32 fimscreg;
670 
671 	if (which == NORMAL) {
672 		rimscreg = NMK_GPIO_RIMSC;
673 		fimscreg = NMK_GPIO_FIMSC;
674 		rimscval = &nmk_chip->rimsc;
675 		fimscval = &nmk_chip->fimsc;
676 	} else  {
677 		rimscreg = NMK_GPIO_RWIMSC;
678 		fimscreg = NMK_GPIO_FWIMSC;
679 		rimscval = &nmk_chip->rwimsc;
680 		fimscval = &nmk_chip->fwimsc;
681 	}
682 
683 	/* we must individually set/clear the two edges */
684 	if (nmk_chip->edge_rising & bitmask) {
685 		if (enable)
686 			*rimscval |= bitmask;
687 		else
688 			*rimscval &= ~bitmask;
689 		writel(*rimscval, nmk_chip->addr + rimscreg);
690 	}
691 	if (nmk_chip->edge_falling & bitmask) {
692 		if (enable)
693 			*fimscval |= bitmask;
694 		else
695 			*fimscval &= ~bitmask;
696 		writel(*fimscval, nmk_chip->addr + fimscreg);
697 	}
698 }
699 
700 static void __nmk_gpio_set_wake(struct nmk_gpio_chip *nmk_chip,
701 				int gpio, bool on)
702 {
703 	/*
704 	 * Ensure WAKEUP_ENABLE is on.  No need to disable it if wakeup is
705 	 * disabled, since setting SLPM to 1 increases power consumption, and
706 	 * wakeup is anyhow controlled by the RIMSC and FIMSC registers.
707 	 */
708 	if (nmk_chip->sleepmode && on) {
709 		__nmk_gpio_set_slpm(nmk_chip, gpio % NMK_GPIO_PER_CHIP,
710 				    NMK_GPIO_SLPM_WAKEUP_ENABLE);
711 	}
712 
713 	__nmk_gpio_irq_modify(nmk_chip, gpio, WAKE, on);
714 }
715 
716 static int nmk_gpio_irq_maskunmask(struct irq_data *d, bool enable)
717 {
718 	struct nmk_gpio_chip *nmk_chip;
719 	unsigned long flags;
720 	u32 bitmask;
721 
722 	nmk_chip = irq_data_get_irq_chip_data(d);
723 	bitmask = nmk_gpio_get_bitmask(d->hwirq);
724 	if (!nmk_chip)
725 		return -EINVAL;
726 
727 	clk_enable(nmk_chip->clk);
728 	spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
729 	spin_lock(&nmk_chip->lock);
730 
731 	__nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, enable);
732 
733 	if (!(nmk_chip->real_wake & bitmask))
734 		__nmk_gpio_set_wake(nmk_chip, d->hwirq, enable);
735 
736 	spin_unlock(&nmk_chip->lock);
737 	spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
738 	clk_disable(nmk_chip->clk);
739 
740 	return 0;
741 }
742 
743 static void nmk_gpio_irq_mask(struct irq_data *d)
744 {
745 	nmk_gpio_irq_maskunmask(d, false);
746 }
747 
748 static void nmk_gpio_irq_unmask(struct irq_data *d)
749 {
750 	nmk_gpio_irq_maskunmask(d, true);
751 }
752 
753 static int nmk_gpio_irq_set_wake(struct irq_data *d, unsigned int on)
754 {
755 	struct nmk_gpio_chip *nmk_chip;
756 	unsigned long flags;
757 	u32 bitmask;
758 
759 	nmk_chip = irq_data_get_irq_chip_data(d);
760 	if (!nmk_chip)
761 		return -EINVAL;
762 	bitmask = nmk_gpio_get_bitmask(d->hwirq);
763 
764 	clk_enable(nmk_chip->clk);
765 	spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
766 	spin_lock(&nmk_chip->lock);
767 
768 	if (irqd_irq_disabled(d))
769 		__nmk_gpio_set_wake(nmk_chip, d->hwirq, on);
770 
771 	if (on)
772 		nmk_chip->real_wake |= bitmask;
773 	else
774 		nmk_chip->real_wake &= ~bitmask;
775 
776 	spin_unlock(&nmk_chip->lock);
777 	spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
778 	clk_disable(nmk_chip->clk);
779 
780 	return 0;
781 }
782 
783 static int nmk_gpio_irq_set_type(struct irq_data *d, unsigned int type)
784 {
785 	bool enabled = !irqd_irq_disabled(d);
786 	bool wake = irqd_is_wakeup_set(d);
787 	struct nmk_gpio_chip *nmk_chip;
788 	unsigned long flags;
789 	u32 bitmask;
790 
791 	nmk_chip = irq_data_get_irq_chip_data(d);
792 	bitmask = nmk_gpio_get_bitmask(d->hwirq);
793 	if (!nmk_chip)
794 		return -EINVAL;
795 	if (type & IRQ_TYPE_LEVEL_HIGH)
796 		return -EINVAL;
797 	if (type & IRQ_TYPE_LEVEL_LOW)
798 		return -EINVAL;
799 
800 	clk_enable(nmk_chip->clk);
801 	spin_lock_irqsave(&nmk_chip->lock, flags);
802 
803 	if (enabled)
804 		__nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, false);
805 
806 	if (enabled || wake)
807 		__nmk_gpio_irq_modify(nmk_chip, d->hwirq, WAKE, false);
808 
809 	nmk_chip->edge_rising &= ~bitmask;
810 	if (type & IRQ_TYPE_EDGE_RISING)
811 		nmk_chip->edge_rising |= bitmask;
812 
813 	nmk_chip->edge_falling &= ~bitmask;
814 	if (type & IRQ_TYPE_EDGE_FALLING)
815 		nmk_chip->edge_falling |= bitmask;
816 
817 	if (enabled)
818 		__nmk_gpio_irq_modify(nmk_chip, d->hwirq, NORMAL, true);
819 
820 	if (enabled || wake)
821 		__nmk_gpio_irq_modify(nmk_chip, d->hwirq, WAKE, true);
822 
823 	spin_unlock_irqrestore(&nmk_chip->lock, flags);
824 	clk_disable(nmk_chip->clk);
825 
826 	return 0;
827 }
828 
829 static unsigned int nmk_gpio_irq_startup(struct irq_data *d)
830 {
831 	struct nmk_gpio_chip *nmk_chip = irq_data_get_irq_chip_data(d);
832 
833 	clk_enable(nmk_chip->clk);
834 	nmk_gpio_irq_unmask(d);
835 	return 0;
836 }
837 
838 static void nmk_gpio_irq_shutdown(struct irq_data *d)
839 {
840 	struct nmk_gpio_chip *nmk_chip = irq_data_get_irq_chip_data(d);
841 
842 	nmk_gpio_irq_mask(d);
843 	clk_disable(nmk_chip->clk);
844 }
845 
846 static void __nmk_gpio_irq_handler(struct irq_desc *desc, u32 status)
847 {
848 	struct irq_chip *host_chip = irq_desc_get_chip(desc);
849 	struct gpio_chip *chip = irq_desc_get_handler_data(desc);
850 
851 	chained_irq_enter(host_chip, desc);
852 
853 	while (status) {
854 		int bit = __ffs(status);
855 
856 		generic_handle_irq(irq_find_mapping(chip->irqdomain, bit));
857 		status &= ~BIT(bit);
858 	}
859 
860 	chained_irq_exit(host_chip, desc);
861 }
862 
863 static void nmk_gpio_irq_handler(struct irq_desc *desc)
864 {
865 	struct gpio_chip *chip = irq_desc_get_handler_data(desc);
866 	struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
867 	u32 status;
868 
869 	clk_enable(nmk_chip->clk);
870 	status = readl(nmk_chip->addr + NMK_GPIO_IS);
871 	clk_disable(nmk_chip->clk);
872 
873 	__nmk_gpio_irq_handler(desc, status);
874 }
875 
876 static void nmk_gpio_latent_irq_handler(struct irq_desc *desc)
877 {
878 	struct gpio_chip *chip = irq_desc_get_handler_data(desc);
879 	struct nmk_gpio_chip *nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
880 	u32 status = nmk_chip->get_latent_status(nmk_chip->bank);
881 
882 	__nmk_gpio_irq_handler(desc, status);
883 }
884 
885 /* I/O Functions */
886 
887 static int nmk_gpio_request(struct gpio_chip *chip, unsigned offset)
888 {
889 	/*
890 	 * Map back to global GPIO space and request muxing, the direction
891 	 * parameter does not matter for this controller.
892 	 */
893 	int gpio = chip->base + offset;
894 
895 	return pinctrl_request_gpio(gpio);
896 }
897 
898 static void nmk_gpio_free(struct gpio_chip *chip, unsigned offset)
899 {
900 	int gpio = chip->base + offset;
901 
902 	pinctrl_free_gpio(gpio);
903 }
904 
905 static int nmk_gpio_make_input(struct gpio_chip *chip, unsigned offset)
906 {
907 	struct nmk_gpio_chip *nmk_chip =
908 		container_of(chip, struct nmk_gpio_chip, chip);
909 
910 	clk_enable(nmk_chip->clk);
911 
912 	writel(1 << offset, nmk_chip->addr + NMK_GPIO_DIRC);
913 
914 	clk_disable(nmk_chip->clk);
915 
916 	return 0;
917 }
918 
919 static int nmk_gpio_get_input(struct gpio_chip *chip, unsigned offset)
920 {
921 	struct nmk_gpio_chip *nmk_chip =
922 		container_of(chip, struct nmk_gpio_chip, chip);
923 	u32 bit = 1 << offset;
924 	int value;
925 
926 	clk_enable(nmk_chip->clk);
927 
928 	value = (readl(nmk_chip->addr + NMK_GPIO_DAT) & bit) != 0;
929 
930 	clk_disable(nmk_chip->clk);
931 
932 	return value;
933 }
934 
935 static void nmk_gpio_set_output(struct gpio_chip *chip, unsigned offset,
936 				int val)
937 {
938 	struct nmk_gpio_chip *nmk_chip =
939 		container_of(chip, struct nmk_gpio_chip, chip);
940 
941 	clk_enable(nmk_chip->clk);
942 
943 	__nmk_gpio_set_output(nmk_chip, offset, val);
944 
945 	clk_disable(nmk_chip->clk);
946 }
947 
948 static int nmk_gpio_make_output(struct gpio_chip *chip, unsigned offset,
949 				int val)
950 {
951 	struct nmk_gpio_chip *nmk_chip =
952 		container_of(chip, struct nmk_gpio_chip, chip);
953 
954 	clk_enable(nmk_chip->clk);
955 
956 	__nmk_gpio_make_output(nmk_chip, offset, val);
957 
958 	clk_disable(nmk_chip->clk);
959 
960 	return 0;
961 }
962 
963 #ifdef CONFIG_DEBUG_FS
964 
965 #include <linux/seq_file.h>
966 
967 static void nmk_gpio_dbg_show_one(struct seq_file *s,
968 	struct pinctrl_dev *pctldev, struct gpio_chip *chip,
969 	unsigned offset, unsigned gpio)
970 {
971 	const char *label = gpiochip_is_requested(chip, offset);
972 	struct nmk_gpio_chip *nmk_chip =
973 		container_of(chip, struct nmk_gpio_chip, chip);
974 	int mode;
975 	bool is_out;
976 	bool data_out;
977 	bool pull;
978 	u32 bit = 1 << offset;
979 	const char *modes[] = {
980 		[NMK_GPIO_ALT_GPIO]	= "gpio",
981 		[NMK_GPIO_ALT_A]	= "altA",
982 		[NMK_GPIO_ALT_B]	= "altB",
983 		[NMK_GPIO_ALT_C]	= "altC",
984 		[NMK_GPIO_ALT_C+1]	= "altC1",
985 		[NMK_GPIO_ALT_C+2]	= "altC2",
986 		[NMK_GPIO_ALT_C+3]	= "altC3",
987 		[NMK_GPIO_ALT_C+4]	= "altC4",
988 	};
989 	const char *pulls[] = {
990 		"none     ",
991 		"pull down",
992 		"pull up  ",
993 	};
994 
995 	clk_enable(nmk_chip->clk);
996 	is_out = !!(readl(nmk_chip->addr + NMK_GPIO_DIR) & bit);
997 	pull = !(readl(nmk_chip->addr + NMK_GPIO_PDIS) & bit);
998 	data_out = !!(readl(nmk_chip->addr + NMK_GPIO_DAT) & bit);
999 	mode = nmk_gpio_get_mode(gpio);
1000 	if ((mode == NMK_GPIO_ALT_C) && pctldev)
1001 		mode = nmk_prcm_gpiocr_get_mode(pctldev, gpio);
1002 
1003 	if (is_out) {
1004 		seq_printf(s, " gpio-%-3d (%-20.20s) out %s        %s",
1005 			   gpio,
1006 			   label ?: "(none)",
1007 			   data_out ? "hi" : "lo",
1008 			   (mode < 0) ? "unknown" : modes[mode]);
1009 	} else {
1010 		int irq = gpio_to_irq(gpio);
1011 		struct irq_desc	*desc = irq_to_desc(irq);
1012 		int pullidx = 0;
1013 		int val;
1014 
1015 		if (pull)
1016 			pullidx = data_out ? 1 : 2;
1017 
1018 		seq_printf(s, " gpio-%-3d (%-20.20s) in  %s %s",
1019 			   gpio,
1020 			   label ?: "(none)",
1021 			   pulls[pullidx],
1022 			   (mode < 0) ? "unknown" : modes[mode]);
1023 
1024 		val = nmk_gpio_get_input(chip, offset);
1025 		seq_printf(s, " VAL %d", val);
1026 
1027 		/*
1028 		 * This races with request_irq(), set_irq_type(),
1029 		 * and set_irq_wake() ... but those are "rare".
1030 		 */
1031 		if (irq > 0 && desc && desc->action) {
1032 			char *trigger;
1033 			u32 bitmask = nmk_gpio_get_bitmask(gpio);
1034 
1035 			if (nmk_chip->edge_rising & bitmask)
1036 				trigger = "edge-rising";
1037 			else if (nmk_chip->edge_falling & bitmask)
1038 				trigger = "edge-falling";
1039 			else
1040 				trigger = "edge-undefined";
1041 
1042 			seq_printf(s, " irq-%d %s%s",
1043 				   irq, trigger,
1044 				   irqd_is_wakeup_set(&desc->irq_data)
1045 				   ? " wakeup" : "");
1046 		}
1047 	}
1048 	clk_disable(nmk_chip->clk);
1049 }
1050 
1051 static void nmk_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1052 {
1053 	unsigned		i;
1054 	unsigned		gpio = chip->base;
1055 
1056 	for (i = 0; i < chip->ngpio; i++, gpio++) {
1057 		nmk_gpio_dbg_show_one(s, NULL, chip, i, gpio);
1058 		seq_printf(s, "\n");
1059 	}
1060 }
1061 
1062 #else
1063 static inline void nmk_gpio_dbg_show_one(struct seq_file *s,
1064 					 struct pinctrl_dev *pctldev,
1065 					 struct gpio_chip *chip,
1066 					 unsigned offset, unsigned gpio)
1067 {
1068 }
1069 #define nmk_gpio_dbg_show	NULL
1070 #endif
1071 
1072 void nmk_gpio_clocks_enable(void)
1073 {
1074 	int i;
1075 
1076 	for (i = 0; i < NUM_BANKS; i++) {
1077 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1078 
1079 		if (!chip)
1080 			continue;
1081 
1082 		clk_enable(chip->clk);
1083 	}
1084 }
1085 
1086 void nmk_gpio_clocks_disable(void)
1087 {
1088 	int i;
1089 
1090 	for (i = 0; i < NUM_BANKS; i++) {
1091 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1092 
1093 		if (!chip)
1094 			continue;
1095 
1096 		clk_disable(chip->clk);
1097 	}
1098 }
1099 
1100 /*
1101  * Called from the suspend/resume path to only keep the real wakeup interrupts
1102  * (those that have had set_irq_wake() called on them) as wakeup interrupts,
1103  * and not the rest of the interrupts which we needed to have as wakeups for
1104  * cpuidle.
1105  *
1106  * PM ops are not used since this needs to be done at the end, after all the
1107  * other drivers are done with their suspend callbacks.
1108  */
1109 void nmk_gpio_wakeups_suspend(void)
1110 {
1111 	int i;
1112 
1113 	for (i = 0; i < NUM_BANKS; i++) {
1114 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1115 
1116 		if (!chip)
1117 			break;
1118 
1119 		clk_enable(chip->clk);
1120 
1121 		writel(chip->rwimsc & chip->real_wake,
1122 		       chip->addr + NMK_GPIO_RWIMSC);
1123 		writel(chip->fwimsc & chip->real_wake,
1124 		       chip->addr + NMK_GPIO_FWIMSC);
1125 
1126 		clk_disable(chip->clk);
1127 	}
1128 }
1129 
1130 void nmk_gpio_wakeups_resume(void)
1131 {
1132 	int i;
1133 
1134 	for (i = 0; i < NUM_BANKS; i++) {
1135 		struct nmk_gpio_chip *chip = nmk_gpio_chips[i];
1136 
1137 		if (!chip)
1138 			break;
1139 
1140 		clk_enable(chip->clk);
1141 
1142 		writel(chip->rwimsc, chip->addr + NMK_GPIO_RWIMSC);
1143 		writel(chip->fwimsc, chip->addr + NMK_GPIO_FWIMSC);
1144 
1145 		clk_disable(chip->clk);
1146 	}
1147 }
1148 
1149 /*
1150  * Read the pull up/pull down status.
1151  * A bit set in 'pull_up' means that pull up
1152  * is selected if pull is enabled in PDIS register.
1153  * Note: only pull up/down set via this driver can
1154  * be detected due to HW limitations.
1155  */
1156 void nmk_gpio_read_pull(int gpio_bank, u32 *pull_up)
1157 {
1158 	if (gpio_bank < NUM_BANKS) {
1159 		struct nmk_gpio_chip *chip = nmk_gpio_chips[gpio_bank];
1160 
1161 		if (!chip)
1162 			return;
1163 
1164 		*pull_up = chip->pull_up;
1165 	}
1166 }
1167 
1168 /*
1169  * We will allocate memory for the state container using devm* allocators
1170  * binding to the first device reaching this point, it doesn't matter if
1171  * it is the pin controller or GPIO driver. However we need to use the right
1172  * platform device when looking up resources so pay attention to pdev.
1173  */
1174 static struct nmk_gpio_chip *nmk_gpio_populate_chip(struct device_node *np,
1175 						struct platform_device *pdev)
1176 {
1177 	struct nmk_gpio_chip *nmk_chip;
1178 	struct platform_device *gpio_pdev;
1179 	struct gpio_chip *chip;
1180 	struct resource *res;
1181 	struct clk *clk;
1182 	void __iomem *base;
1183 	u32 id;
1184 
1185 	gpio_pdev = of_find_device_by_node(np);
1186 	if (!gpio_pdev) {
1187 		pr_err("populate \"%s\": device not found\n", np->name);
1188 		return ERR_PTR(-ENODEV);
1189 	}
1190 	if (of_property_read_u32(np, "gpio-bank", &id)) {
1191 		dev_err(&pdev->dev, "populate: gpio-bank property not found\n");
1192 		return ERR_PTR(-EINVAL);
1193 	}
1194 
1195 	/* Already populated? */
1196 	nmk_chip = nmk_gpio_chips[id];
1197 	if (nmk_chip)
1198 		return nmk_chip;
1199 
1200 	nmk_chip = devm_kzalloc(&pdev->dev, sizeof(*nmk_chip), GFP_KERNEL);
1201 	if (!nmk_chip)
1202 		return ERR_PTR(-ENOMEM);
1203 
1204 	nmk_chip->bank = id;
1205 	chip = &nmk_chip->chip;
1206 	chip->base = id * NMK_GPIO_PER_CHIP;
1207 	chip->ngpio = NMK_GPIO_PER_CHIP;
1208 	chip->label = dev_name(&gpio_pdev->dev);
1209 	chip->dev = &gpio_pdev->dev;
1210 
1211 	res = platform_get_resource(gpio_pdev, IORESOURCE_MEM, 0);
1212 	base = devm_ioremap_resource(&pdev->dev, res);
1213 	if (IS_ERR(base))
1214 		return base;
1215 	nmk_chip->addr = base;
1216 
1217 	clk = clk_get(&gpio_pdev->dev, NULL);
1218 	if (IS_ERR(clk))
1219 		return (void *) clk;
1220 	clk_prepare(clk);
1221 	nmk_chip->clk = clk;
1222 
1223 	BUG_ON(nmk_chip->bank >= ARRAY_SIZE(nmk_gpio_chips));
1224 	nmk_gpio_chips[id] = nmk_chip;
1225 	return nmk_chip;
1226 }
1227 
1228 static int nmk_gpio_probe(struct platform_device *dev)
1229 {
1230 	struct device_node *np = dev->dev.of_node;
1231 	struct nmk_gpio_chip *nmk_chip;
1232 	struct gpio_chip *chip;
1233 	struct irq_chip *irqchip;
1234 	int latent_irq;
1235 	bool supports_sleepmode;
1236 	int irq;
1237 	int ret;
1238 
1239 	nmk_chip = nmk_gpio_populate_chip(np, dev);
1240 	if (IS_ERR(nmk_chip)) {
1241 		dev_err(&dev->dev, "could not populate nmk chip struct\n");
1242 		return PTR_ERR(nmk_chip);
1243 	}
1244 
1245 	if (of_get_property(np, "st,supports-sleepmode", NULL))
1246 		supports_sleepmode = true;
1247 	else
1248 		supports_sleepmode = false;
1249 
1250 	/* Correct platform device ID */
1251 	dev->id = nmk_chip->bank;
1252 
1253 	irq = platform_get_irq(dev, 0);
1254 	if (irq < 0)
1255 		return irq;
1256 
1257 	/* It's OK for this IRQ not to be present */
1258 	latent_irq = platform_get_irq(dev, 1);
1259 
1260 	/*
1261 	 * The virt address in nmk_chip->addr is in the nomadik register space,
1262 	 * so we can simply convert the resource address, without remapping
1263 	 */
1264 	nmk_chip->parent_irq = irq;
1265 	nmk_chip->latent_parent_irq = latent_irq;
1266 	nmk_chip->sleepmode = supports_sleepmode;
1267 	spin_lock_init(&nmk_chip->lock);
1268 
1269 	chip = &nmk_chip->chip;
1270 	chip->request = nmk_gpio_request;
1271 	chip->free = nmk_gpio_free;
1272 	chip->direction_input = nmk_gpio_make_input;
1273 	chip->get = nmk_gpio_get_input;
1274 	chip->direction_output = nmk_gpio_make_output;
1275 	chip->set = nmk_gpio_set_output;
1276 	chip->dbg_show = nmk_gpio_dbg_show;
1277 	chip->can_sleep = false;
1278 	chip->owner = THIS_MODULE;
1279 
1280 	irqchip = &nmk_chip->irqchip;
1281 	irqchip->irq_ack = nmk_gpio_irq_ack;
1282 	irqchip->irq_mask = nmk_gpio_irq_mask;
1283 	irqchip->irq_unmask = nmk_gpio_irq_unmask;
1284 	irqchip->irq_set_type = nmk_gpio_irq_set_type;
1285 	irqchip->irq_set_wake = nmk_gpio_irq_set_wake;
1286 	irqchip->irq_startup = nmk_gpio_irq_startup;
1287 	irqchip->irq_shutdown = nmk_gpio_irq_shutdown;
1288 	irqchip->flags = IRQCHIP_MASK_ON_SUSPEND;
1289 	irqchip->name = kasprintf(GFP_KERNEL, "nmk%u-%u-%u",
1290 				  dev->id,
1291 				  chip->base,
1292 				  chip->base + chip->ngpio - 1);
1293 
1294 	clk_enable(nmk_chip->clk);
1295 	nmk_chip->lowemi = readl_relaxed(nmk_chip->addr + NMK_GPIO_LOWEMI);
1296 	clk_disable(nmk_chip->clk);
1297 	chip->of_node = np;
1298 
1299 	ret = gpiochip_add(chip);
1300 	if (ret)
1301 		return ret;
1302 
1303 	platform_set_drvdata(dev, nmk_chip);
1304 
1305 	/*
1306 	 * Let the generic code handle this edge IRQ, the the chained
1307 	 * handler will perform the actual work of handling the parent
1308 	 * interrupt.
1309 	 */
1310 	ret = gpiochip_irqchip_add(chip,
1311 				   irqchip,
1312 				   0,
1313 				   handle_edge_irq,
1314 				   IRQ_TYPE_EDGE_FALLING);
1315 	if (ret) {
1316 		dev_err(&dev->dev, "could not add irqchip\n");
1317 		gpiochip_remove(&nmk_chip->chip);
1318 		return -ENODEV;
1319 	}
1320 	/* Then register the chain on the parent IRQ */
1321 	gpiochip_set_chained_irqchip(chip,
1322 				     irqchip,
1323 				     nmk_chip->parent_irq,
1324 				     nmk_gpio_irq_handler);
1325 	if (nmk_chip->latent_parent_irq > 0)
1326 		gpiochip_set_chained_irqchip(chip,
1327 					     irqchip,
1328 					     nmk_chip->latent_parent_irq,
1329 					     nmk_gpio_latent_irq_handler);
1330 
1331 	dev_info(&dev->dev, "at address %p\n", nmk_chip->addr);
1332 
1333 	return 0;
1334 }
1335 
1336 static int nmk_get_groups_cnt(struct pinctrl_dev *pctldev)
1337 {
1338 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1339 
1340 	return npct->soc->ngroups;
1341 }
1342 
1343 static const char *nmk_get_group_name(struct pinctrl_dev *pctldev,
1344 				       unsigned selector)
1345 {
1346 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1347 
1348 	return npct->soc->groups[selector].name;
1349 }
1350 
1351 static int nmk_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector,
1352 			      const unsigned **pins,
1353 			      unsigned *num_pins)
1354 {
1355 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1356 
1357 	*pins = npct->soc->groups[selector].pins;
1358 	*num_pins = npct->soc->groups[selector].npins;
1359 	return 0;
1360 }
1361 
1362 static struct nmk_gpio_chip *find_nmk_gpio_from_pin(unsigned pin)
1363 {
1364 	int i;
1365 	struct nmk_gpio_chip *nmk_gpio;
1366 
1367 	for(i = 0; i < NMK_MAX_BANKS; i++) {
1368 		nmk_gpio = nmk_gpio_chips[i];
1369 		if (!nmk_gpio)
1370 			continue;
1371 		if (pin >= nmk_gpio->chip.base &&
1372 			pin < nmk_gpio->chip.base + nmk_gpio->chip.ngpio)
1373 			return nmk_gpio;
1374 	}
1375 	return NULL;
1376 }
1377 
1378 static struct gpio_chip *find_gc_from_pin(unsigned pin)
1379 {
1380 	struct nmk_gpio_chip *nmk_gpio = find_nmk_gpio_from_pin(pin);
1381 
1382 	if (nmk_gpio)
1383 		return &nmk_gpio->chip;
1384 	return NULL;
1385 }
1386 
1387 static void nmk_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
1388 		   unsigned offset)
1389 {
1390 	struct gpio_chip *chip = find_gc_from_pin(offset);
1391 
1392 	if (!chip) {
1393 		seq_printf(s, "invalid pin offset");
1394 		return;
1395 	}
1396 	nmk_gpio_dbg_show_one(s, pctldev, chip, offset - chip->base, offset);
1397 }
1398 
1399 static int nmk_dt_add_map_mux(struct pinctrl_map **map, unsigned *reserved_maps,
1400 		unsigned *num_maps, const char *group,
1401 		const char *function)
1402 {
1403 	if (*num_maps == *reserved_maps)
1404 		return -ENOSPC;
1405 
1406 	(*map)[*num_maps].type = PIN_MAP_TYPE_MUX_GROUP;
1407 	(*map)[*num_maps].data.mux.group = group;
1408 	(*map)[*num_maps].data.mux.function = function;
1409 	(*num_maps)++;
1410 
1411 	return 0;
1412 }
1413 
1414 static int nmk_dt_add_map_configs(struct pinctrl_map **map,
1415 		unsigned *reserved_maps,
1416 		unsigned *num_maps, const char *group,
1417 		unsigned long *configs, unsigned num_configs)
1418 {
1419 	unsigned long *dup_configs;
1420 
1421 	if (*num_maps == *reserved_maps)
1422 		return -ENOSPC;
1423 
1424 	dup_configs = kmemdup(configs, num_configs * sizeof(*dup_configs),
1425 			      GFP_KERNEL);
1426 	if (!dup_configs)
1427 		return -ENOMEM;
1428 
1429 	(*map)[*num_maps].type = PIN_MAP_TYPE_CONFIGS_PIN;
1430 
1431 	(*map)[*num_maps].data.configs.group_or_pin = group;
1432 	(*map)[*num_maps].data.configs.configs = dup_configs;
1433 	(*map)[*num_maps].data.configs.num_configs = num_configs;
1434 	(*num_maps)++;
1435 
1436 	return 0;
1437 }
1438 
1439 #define NMK_CONFIG_PIN(x, y) { .property = x, .config = y, }
1440 #define NMK_CONFIG_PIN_ARRAY(x, y) { .property = x, .choice = y, \
1441 	.size = ARRAY_SIZE(y), }
1442 
1443 static const unsigned long nmk_pin_input_modes[] = {
1444 	PIN_INPUT_NOPULL,
1445 	PIN_INPUT_PULLUP,
1446 	PIN_INPUT_PULLDOWN,
1447 };
1448 
1449 static const unsigned long nmk_pin_output_modes[] = {
1450 	PIN_OUTPUT_LOW,
1451 	PIN_OUTPUT_HIGH,
1452 	PIN_DIR_OUTPUT,
1453 };
1454 
1455 static const unsigned long nmk_pin_sleep_modes[] = {
1456 	PIN_SLEEPMODE_DISABLED,
1457 	PIN_SLEEPMODE_ENABLED,
1458 };
1459 
1460 static const unsigned long nmk_pin_sleep_input_modes[] = {
1461 	PIN_SLPM_INPUT_NOPULL,
1462 	PIN_SLPM_INPUT_PULLUP,
1463 	PIN_SLPM_INPUT_PULLDOWN,
1464 	PIN_SLPM_DIR_INPUT,
1465 };
1466 
1467 static const unsigned long nmk_pin_sleep_output_modes[] = {
1468 	PIN_SLPM_OUTPUT_LOW,
1469 	PIN_SLPM_OUTPUT_HIGH,
1470 	PIN_SLPM_DIR_OUTPUT,
1471 };
1472 
1473 static const unsigned long nmk_pin_sleep_wakeup_modes[] = {
1474 	PIN_SLPM_WAKEUP_DISABLE,
1475 	PIN_SLPM_WAKEUP_ENABLE,
1476 };
1477 
1478 static const unsigned long nmk_pin_gpio_modes[] = {
1479 	PIN_GPIOMODE_DISABLED,
1480 	PIN_GPIOMODE_ENABLED,
1481 };
1482 
1483 static const unsigned long nmk_pin_sleep_pdis_modes[] = {
1484 	PIN_SLPM_PDIS_DISABLED,
1485 	PIN_SLPM_PDIS_ENABLED,
1486 };
1487 
1488 struct nmk_cfg_param {
1489 	const char *property;
1490 	unsigned long config;
1491 	const unsigned long *choice;
1492 	int size;
1493 };
1494 
1495 static const struct nmk_cfg_param nmk_cfg_params[] = {
1496 	NMK_CONFIG_PIN_ARRAY("ste,input",		nmk_pin_input_modes),
1497 	NMK_CONFIG_PIN_ARRAY("ste,output",		nmk_pin_output_modes),
1498 	NMK_CONFIG_PIN_ARRAY("ste,sleep",		nmk_pin_sleep_modes),
1499 	NMK_CONFIG_PIN_ARRAY("ste,sleep-input",		nmk_pin_sleep_input_modes),
1500 	NMK_CONFIG_PIN_ARRAY("ste,sleep-output",	nmk_pin_sleep_output_modes),
1501 	NMK_CONFIG_PIN_ARRAY("ste,sleep-wakeup",	nmk_pin_sleep_wakeup_modes),
1502 	NMK_CONFIG_PIN_ARRAY("ste,gpio",		nmk_pin_gpio_modes),
1503 	NMK_CONFIG_PIN_ARRAY("ste,sleep-pull-disable",	nmk_pin_sleep_pdis_modes),
1504 };
1505 
1506 static int nmk_dt_pin_config(int index, int val, unsigned long *config)
1507 {
1508 	int ret = 0;
1509 
1510 	if (nmk_cfg_params[index].choice == NULL)
1511 		*config = nmk_cfg_params[index].config;
1512 	else {
1513 		/* test if out of range */
1514 		if  (val < nmk_cfg_params[index].size) {
1515 			*config = nmk_cfg_params[index].config |
1516 				nmk_cfg_params[index].choice[val];
1517 		}
1518 	}
1519 	return ret;
1520 }
1521 
1522 static const char *nmk_find_pin_name(struct pinctrl_dev *pctldev, const char *pin_name)
1523 {
1524 	int i, pin_number;
1525 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1526 
1527 	if (sscanf((char *)pin_name, "GPIO%d", &pin_number) == 1)
1528 		for (i = 0; i < npct->soc->npins; i++)
1529 			if (npct->soc->pins[i].number == pin_number)
1530 				return npct->soc->pins[i].name;
1531 	return NULL;
1532 }
1533 
1534 static bool nmk_pinctrl_dt_get_config(struct device_node *np,
1535 		unsigned long *configs)
1536 {
1537 	bool has_config = 0;
1538 	unsigned long cfg = 0;
1539 	int i, val, ret;
1540 
1541 	for (i = 0; i < ARRAY_SIZE(nmk_cfg_params); i++) {
1542 		ret = of_property_read_u32(np,
1543 				nmk_cfg_params[i].property, &val);
1544 		if (ret != -EINVAL) {
1545 			if (nmk_dt_pin_config(i, val, &cfg) == 0) {
1546 				*configs |= cfg;
1547 				has_config = 1;
1548 			}
1549 		}
1550 	}
1551 
1552 	return has_config;
1553 }
1554 
1555 static int nmk_pinctrl_dt_subnode_to_map(struct pinctrl_dev *pctldev,
1556 		struct device_node *np,
1557 		struct pinctrl_map **map,
1558 		unsigned *reserved_maps,
1559 		unsigned *num_maps)
1560 {
1561 	int ret;
1562 	const char *function = NULL;
1563 	unsigned long configs = 0;
1564 	bool has_config = 0;
1565 	struct property *prop;
1566 	struct device_node *np_config;
1567 
1568 	ret = of_property_read_string(np, "function", &function);
1569 	if (ret >= 0) {
1570 		const char *group;
1571 
1572 		ret = of_property_count_strings(np, "groups");
1573 		if (ret < 0)
1574 			goto exit;
1575 
1576 		ret = pinctrl_utils_reserve_map(pctldev, map,
1577 						reserved_maps,
1578 						num_maps, ret);
1579 		if (ret < 0)
1580 			goto exit;
1581 
1582 		of_property_for_each_string(np, "groups", prop, group) {
1583 			ret = nmk_dt_add_map_mux(map, reserved_maps, num_maps,
1584 					  group, function);
1585 			if (ret < 0)
1586 				goto exit;
1587 		}
1588 	}
1589 
1590 	has_config = nmk_pinctrl_dt_get_config(np, &configs);
1591 	np_config = of_parse_phandle(np, "ste,config", 0);
1592 	if (np_config)
1593 		has_config |= nmk_pinctrl_dt_get_config(np_config, &configs);
1594 	if (has_config) {
1595 		const char *gpio_name;
1596 		const char *pin;
1597 
1598 		ret = of_property_count_strings(np, "pins");
1599 		if (ret < 0)
1600 			goto exit;
1601 		ret = pinctrl_utils_reserve_map(pctldev, map,
1602 						reserved_maps,
1603 						num_maps, ret);
1604 		if (ret < 0)
1605 			goto exit;
1606 
1607 		of_property_for_each_string(np, "pins", prop, pin) {
1608 			gpio_name = nmk_find_pin_name(pctldev, pin);
1609 
1610 			ret = nmk_dt_add_map_configs(map, reserved_maps,
1611 						     num_maps,
1612 						     gpio_name, &configs, 1);
1613 			if (ret < 0)
1614 				goto exit;
1615 		}
1616 	}
1617 
1618 exit:
1619 	return ret;
1620 }
1621 
1622 static int nmk_pinctrl_dt_node_to_map(struct pinctrl_dev *pctldev,
1623 				 struct device_node *np_config,
1624 				 struct pinctrl_map **map, unsigned *num_maps)
1625 {
1626 	unsigned reserved_maps;
1627 	struct device_node *np;
1628 	int ret;
1629 
1630 	reserved_maps = 0;
1631 	*map = NULL;
1632 	*num_maps = 0;
1633 
1634 	for_each_child_of_node(np_config, np) {
1635 		ret = nmk_pinctrl_dt_subnode_to_map(pctldev, np, map,
1636 				&reserved_maps, num_maps);
1637 		if (ret < 0) {
1638 			pinctrl_utils_dt_free_map(pctldev, *map, *num_maps);
1639 			return ret;
1640 		}
1641 	}
1642 
1643 	return 0;
1644 }
1645 
1646 static const struct pinctrl_ops nmk_pinctrl_ops = {
1647 	.get_groups_count = nmk_get_groups_cnt,
1648 	.get_group_name = nmk_get_group_name,
1649 	.get_group_pins = nmk_get_group_pins,
1650 	.pin_dbg_show = nmk_pin_dbg_show,
1651 	.dt_node_to_map = nmk_pinctrl_dt_node_to_map,
1652 	.dt_free_map = pinctrl_utils_dt_free_map,
1653 };
1654 
1655 static int nmk_pmx_get_funcs_cnt(struct pinctrl_dev *pctldev)
1656 {
1657 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1658 
1659 	return npct->soc->nfunctions;
1660 }
1661 
1662 static const char *nmk_pmx_get_func_name(struct pinctrl_dev *pctldev,
1663 					 unsigned function)
1664 {
1665 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1666 
1667 	return npct->soc->functions[function].name;
1668 }
1669 
1670 static int nmk_pmx_get_func_groups(struct pinctrl_dev *pctldev,
1671 				   unsigned function,
1672 				   const char * const **groups,
1673 				   unsigned * const num_groups)
1674 {
1675 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1676 
1677 	*groups = npct->soc->functions[function].groups;
1678 	*num_groups = npct->soc->functions[function].ngroups;
1679 
1680 	return 0;
1681 }
1682 
1683 static int nmk_pmx_set(struct pinctrl_dev *pctldev, unsigned function,
1684 		       unsigned group)
1685 {
1686 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1687 	const struct nmk_pingroup *g;
1688 	static unsigned int slpm[NUM_BANKS];
1689 	unsigned long flags = 0;
1690 	bool glitch;
1691 	int ret = -EINVAL;
1692 	int i;
1693 
1694 	g = &npct->soc->groups[group];
1695 
1696 	if (g->altsetting < 0)
1697 		return -EINVAL;
1698 
1699 	dev_dbg(npct->dev, "enable group %s, %u pins\n", g->name, g->npins);
1700 
1701 	/*
1702 	 * If we're setting altfunc C by setting both AFSLA and AFSLB to 1,
1703 	 * we may pass through an undesired state. In this case we take
1704 	 * some extra care.
1705 	 *
1706 	 * Safe sequence used to switch IOs between GPIO and Alternate-C mode:
1707 	 *  - Save SLPM registers (since we have a shadow register in the
1708 	 *    nmk_chip we're using that as backup)
1709 	 *  - Set SLPM=0 for the IOs you want to switch and others to 1
1710 	 *  - Configure the GPIO registers for the IOs that are being switched
1711 	 *  - Set IOFORCE=1
1712 	 *  - Modify the AFLSA/B registers for the IOs that are being switched
1713 	 *  - Set IOFORCE=0
1714 	 *  - Restore SLPM registers
1715 	 *  - Any spurious wake up event during switch sequence to be ignored
1716 	 *    and cleared
1717 	 *
1718 	 * We REALLY need to save ALL slpm registers, because the external
1719 	 * IOFORCE will switch *all* ports to their sleepmode setting to as
1720 	 * to avoid glitches. (Not just one port!)
1721 	 */
1722 	glitch = ((g->altsetting & NMK_GPIO_ALT_C) == NMK_GPIO_ALT_C);
1723 
1724 	if (glitch) {
1725 		spin_lock_irqsave(&nmk_gpio_slpm_lock, flags);
1726 
1727 		/* Initially don't put any pins to sleep when switching */
1728 		memset(slpm, 0xff, sizeof(slpm));
1729 
1730 		/*
1731 		 * Then mask the pins that need to be sleeping now when we're
1732 		 * switching to the ALT C function.
1733 		 */
1734 		for (i = 0; i < g->npins; i++)
1735 			slpm[g->pins[i] / NMK_GPIO_PER_CHIP] &= ~BIT(g->pins[i]);
1736 		nmk_gpio_glitch_slpm_init(slpm);
1737 	}
1738 
1739 	for (i = 0; i < g->npins; i++) {
1740 		struct nmk_gpio_chip *nmk_chip;
1741 		unsigned bit;
1742 
1743 		nmk_chip = find_nmk_gpio_from_pin(g->pins[i]);
1744 		if (!nmk_chip) {
1745 			dev_err(npct->dev,
1746 				"invalid pin offset %d in group %s at index %d\n",
1747 				g->pins[i], g->name, i);
1748 			goto out_glitch;
1749 		}
1750 		dev_dbg(npct->dev, "setting pin %d to altsetting %d\n", g->pins[i], g->altsetting);
1751 
1752 		clk_enable(nmk_chip->clk);
1753 		bit = g->pins[i] % NMK_GPIO_PER_CHIP;
1754 		/*
1755 		 * If the pin is switching to altfunc, and there was an
1756 		 * interrupt installed on it which has been lazy disabled,
1757 		 * actually mask the interrupt to prevent spurious interrupts
1758 		 * that would occur while the pin is under control of the
1759 		 * peripheral. Only SKE does this.
1760 		 */
1761 		nmk_gpio_disable_lazy_irq(nmk_chip, bit);
1762 
1763 		__nmk_gpio_set_mode_safe(nmk_chip, bit,
1764 			(g->altsetting & NMK_GPIO_ALT_C), glitch);
1765 		clk_disable(nmk_chip->clk);
1766 
1767 		/*
1768 		 * Call PRCM GPIOCR config function in case ALTC
1769 		 * has been selected:
1770 		 * - If selection is a ALTCx, some bits in PRCM GPIOCR registers
1771 		 *   must be set.
1772 		 * - If selection is pure ALTC and previous selection was ALTCx,
1773 		 *   then some bits in PRCM GPIOCR registers must be cleared.
1774 		 */
1775 		if ((g->altsetting & NMK_GPIO_ALT_C) == NMK_GPIO_ALT_C)
1776 			nmk_prcm_altcx_set_mode(npct, g->pins[i],
1777 				g->altsetting >> NMK_GPIO_ALT_CX_SHIFT);
1778 	}
1779 
1780 	/* When all pins are successfully reconfigured we get here */
1781 	ret = 0;
1782 
1783 out_glitch:
1784 	if (glitch) {
1785 		nmk_gpio_glitch_slpm_restore(slpm);
1786 		spin_unlock_irqrestore(&nmk_gpio_slpm_lock, flags);
1787 	}
1788 
1789 	return ret;
1790 }
1791 
1792 static int nmk_gpio_request_enable(struct pinctrl_dev *pctldev,
1793 				   struct pinctrl_gpio_range *range,
1794 				   unsigned offset)
1795 {
1796 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1797 	struct nmk_gpio_chip *nmk_chip;
1798 	struct gpio_chip *chip;
1799 	unsigned bit;
1800 
1801 	if (!range) {
1802 		dev_err(npct->dev, "invalid range\n");
1803 		return -EINVAL;
1804 	}
1805 	if (!range->gc) {
1806 		dev_err(npct->dev, "missing GPIO chip in range\n");
1807 		return -EINVAL;
1808 	}
1809 	chip = range->gc;
1810 	nmk_chip = container_of(chip, struct nmk_gpio_chip, chip);
1811 
1812 	dev_dbg(npct->dev, "enable pin %u as GPIO\n", offset);
1813 
1814 	clk_enable(nmk_chip->clk);
1815 	bit = offset % NMK_GPIO_PER_CHIP;
1816 	/* There is no glitch when converting any pin to GPIO */
1817 	__nmk_gpio_set_mode(nmk_chip, bit, NMK_GPIO_ALT_GPIO);
1818 	clk_disable(nmk_chip->clk);
1819 
1820 	return 0;
1821 }
1822 
1823 static void nmk_gpio_disable_free(struct pinctrl_dev *pctldev,
1824 				  struct pinctrl_gpio_range *range,
1825 				  unsigned offset)
1826 {
1827 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1828 
1829 	dev_dbg(npct->dev, "disable pin %u as GPIO\n", offset);
1830 	/* Set the pin to some default state, GPIO is usually default */
1831 }
1832 
1833 static const struct pinmux_ops nmk_pinmux_ops = {
1834 	.get_functions_count = nmk_pmx_get_funcs_cnt,
1835 	.get_function_name = nmk_pmx_get_func_name,
1836 	.get_function_groups = nmk_pmx_get_func_groups,
1837 	.set_mux = nmk_pmx_set,
1838 	.gpio_request_enable = nmk_gpio_request_enable,
1839 	.gpio_disable_free = nmk_gpio_disable_free,
1840 	.strict = true,
1841 };
1842 
1843 static int nmk_pin_config_get(struct pinctrl_dev *pctldev, unsigned pin,
1844 			      unsigned long *config)
1845 {
1846 	/* Not implemented */
1847 	return -EINVAL;
1848 }
1849 
1850 static int nmk_pin_config_set(struct pinctrl_dev *pctldev, unsigned pin,
1851 			      unsigned long *configs, unsigned num_configs)
1852 {
1853 	static const char *pullnames[] = {
1854 		[NMK_GPIO_PULL_NONE]	= "none",
1855 		[NMK_GPIO_PULL_UP]	= "up",
1856 		[NMK_GPIO_PULL_DOWN]	= "down",
1857 		[3] /* illegal */	= "??"
1858 	};
1859 	static const char *slpmnames[] = {
1860 		[NMK_GPIO_SLPM_INPUT]		= "input/wakeup",
1861 		[NMK_GPIO_SLPM_NOCHANGE]	= "no-change/no-wakeup",
1862 	};
1863 	struct nmk_pinctrl *npct = pinctrl_dev_get_drvdata(pctldev);
1864 	struct nmk_gpio_chip *nmk_chip;
1865 	unsigned bit;
1866 	pin_cfg_t cfg;
1867 	int pull, slpm, output, val, i;
1868 	bool lowemi, gpiomode, sleep;
1869 
1870 	nmk_chip = find_nmk_gpio_from_pin(pin);
1871 	if (!nmk_chip) {
1872 		dev_err(npct->dev,
1873 			"invalid pin offset %d\n", pin);
1874 		return -EINVAL;
1875 	}
1876 
1877 	for (i = 0; i < num_configs; i++) {
1878 		/*
1879 		 * The pin config contains pin number and altfunction fields,
1880 		 * here we just ignore that part. It's being handled by the
1881 		 * framework and pinmux callback respectively.
1882 		 */
1883 		cfg = (pin_cfg_t) configs[i];
1884 		pull = PIN_PULL(cfg);
1885 		slpm = PIN_SLPM(cfg);
1886 		output = PIN_DIR(cfg);
1887 		val = PIN_VAL(cfg);
1888 		lowemi = PIN_LOWEMI(cfg);
1889 		gpiomode = PIN_GPIOMODE(cfg);
1890 		sleep = PIN_SLEEPMODE(cfg);
1891 
1892 		if (sleep) {
1893 			int slpm_pull = PIN_SLPM_PULL(cfg);
1894 			int slpm_output = PIN_SLPM_DIR(cfg);
1895 			int slpm_val = PIN_SLPM_VAL(cfg);
1896 
1897 			/* All pins go into GPIO mode at sleep */
1898 			gpiomode = true;
1899 
1900 			/*
1901 			 * The SLPM_* values are normal values + 1 to allow zero
1902 			 * to mean "same as normal".
1903 			 */
1904 			if (slpm_pull)
1905 				pull = slpm_pull - 1;
1906 			if (slpm_output)
1907 				output = slpm_output - 1;
1908 			if (slpm_val)
1909 				val = slpm_val - 1;
1910 
1911 			dev_dbg(nmk_chip->chip.dev,
1912 				"pin %d: sleep pull %s, dir %s, val %s\n",
1913 				pin,
1914 				slpm_pull ? pullnames[pull] : "same",
1915 				slpm_output ? (output ? "output" : "input")
1916 				: "same",
1917 				slpm_val ? (val ? "high" : "low") : "same");
1918 		}
1919 
1920 		dev_dbg(nmk_chip->chip.dev,
1921 			"pin %d [%#lx]: pull %s, slpm %s (%s%s), lowemi %s\n",
1922 			pin, cfg, pullnames[pull], slpmnames[slpm],
1923 			output ? "output " : "input",
1924 			output ? (val ? "high" : "low") : "",
1925 			lowemi ? "on" : "off");
1926 
1927 		clk_enable(nmk_chip->clk);
1928 		bit = pin % NMK_GPIO_PER_CHIP;
1929 		if (gpiomode)
1930 			/* No glitch when going to GPIO mode */
1931 			__nmk_gpio_set_mode(nmk_chip, bit, NMK_GPIO_ALT_GPIO);
1932 		if (output)
1933 			__nmk_gpio_make_output(nmk_chip, bit, val);
1934 		else {
1935 			__nmk_gpio_make_input(nmk_chip, bit);
1936 			__nmk_gpio_set_pull(nmk_chip, bit, pull);
1937 		}
1938 		/* TODO: isn't this only applicable on output pins? */
1939 		__nmk_gpio_set_lowemi(nmk_chip, bit, lowemi);
1940 
1941 		__nmk_gpio_set_slpm(nmk_chip, bit, slpm);
1942 		clk_disable(nmk_chip->clk);
1943 	} /* for each config */
1944 
1945 	return 0;
1946 }
1947 
1948 static const struct pinconf_ops nmk_pinconf_ops = {
1949 	.pin_config_get = nmk_pin_config_get,
1950 	.pin_config_set = nmk_pin_config_set,
1951 };
1952 
1953 static struct pinctrl_desc nmk_pinctrl_desc = {
1954 	.name = "pinctrl-nomadik",
1955 	.pctlops = &nmk_pinctrl_ops,
1956 	.pmxops = &nmk_pinmux_ops,
1957 	.confops = &nmk_pinconf_ops,
1958 	.owner = THIS_MODULE,
1959 };
1960 
1961 static const struct of_device_id nmk_pinctrl_match[] = {
1962 	{
1963 		.compatible = "stericsson,stn8815-pinctrl",
1964 		.data = (void *)PINCTRL_NMK_STN8815,
1965 	},
1966 	{
1967 		.compatible = "stericsson,db8500-pinctrl",
1968 		.data = (void *)PINCTRL_NMK_DB8500,
1969 	},
1970 	{
1971 		.compatible = "stericsson,db8540-pinctrl",
1972 		.data = (void *)PINCTRL_NMK_DB8540,
1973 	},
1974 	{},
1975 };
1976 
1977 #ifdef CONFIG_PM_SLEEP
1978 static int nmk_pinctrl_suspend(struct device *dev)
1979 {
1980 	struct nmk_pinctrl *npct;
1981 
1982 	npct = dev_get_drvdata(dev);
1983 	if (!npct)
1984 		return -EINVAL;
1985 
1986 	return pinctrl_force_sleep(npct->pctl);
1987 }
1988 
1989 static int nmk_pinctrl_resume(struct device *dev)
1990 {
1991 	struct nmk_pinctrl *npct;
1992 
1993 	npct = dev_get_drvdata(dev);
1994 	if (!npct)
1995 		return -EINVAL;
1996 
1997 	return pinctrl_force_default(npct->pctl);
1998 }
1999 #endif
2000 
2001 static int nmk_pinctrl_probe(struct platform_device *pdev)
2002 {
2003 	const struct of_device_id *match;
2004 	struct device_node *np = pdev->dev.of_node;
2005 	struct device_node *prcm_np;
2006 	struct nmk_pinctrl *npct;
2007 	unsigned int version = 0;
2008 	int i;
2009 
2010 	npct = devm_kzalloc(&pdev->dev, sizeof(*npct), GFP_KERNEL);
2011 	if (!npct)
2012 		return -ENOMEM;
2013 
2014 	match = of_match_device(nmk_pinctrl_match, &pdev->dev);
2015 	if (!match)
2016 		return -ENODEV;
2017 	version = (unsigned int) match->data;
2018 
2019 	/* Poke in other ASIC variants here */
2020 	if (version == PINCTRL_NMK_STN8815)
2021 		nmk_pinctrl_stn8815_init(&npct->soc);
2022 	if (version == PINCTRL_NMK_DB8500)
2023 		nmk_pinctrl_db8500_init(&npct->soc);
2024 	if (version == PINCTRL_NMK_DB8540)
2025 		nmk_pinctrl_db8540_init(&npct->soc);
2026 
2027 	/*
2028 	 * Since we depend on the GPIO chips to provide clock and register base
2029 	 * for the pin control operations, make sure that we have these
2030 	 * populated before we continue. Follow the phandles to instantiate
2031 	 * them. The GPIO portion of the actual hardware may be probed before
2032 	 * or after this point: it shouldn't matter as the APIs are orthogonal.
2033 	 */
2034 	for (i = 0; i < NMK_MAX_BANKS; i++) {
2035 		struct device_node *gpio_np;
2036 		struct nmk_gpio_chip *nmk_chip;
2037 
2038 		gpio_np = of_parse_phandle(np, "nomadik-gpio-chips", i);
2039 		if (gpio_np) {
2040 			dev_info(&pdev->dev,
2041 				 "populate NMK GPIO %d \"%s\"\n",
2042 				 i, gpio_np->name);
2043 			nmk_chip = nmk_gpio_populate_chip(gpio_np, pdev);
2044 			if (IS_ERR(nmk_chip))
2045 				dev_err(&pdev->dev,
2046 					"could not populate nmk chip struct "
2047 					"- continue anyway\n");
2048 			of_node_put(gpio_np);
2049 		}
2050 	}
2051 
2052 	prcm_np = of_parse_phandle(np, "prcm", 0);
2053 	if (prcm_np)
2054 		npct->prcm_base = of_iomap(prcm_np, 0);
2055 	if (!npct->prcm_base) {
2056 		if (version == PINCTRL_NMK_STN8815) {
2057 			dev_info(&pdev->dev,
2058 				 "No PRCM base, "
2059 				 "assuming no ALT-Cx control is available\n");
2060 		} else {
2061 			dev_err(&pdev->dev, "missing PRCM base address\n");
2062 			return -EINVAL;
2063 		}
2064 	}
2065 
2066 	nmk_pinctrl_desc.pins = npct->soc->pins;
2067 	nmk_pinctrl_desc.npins = npct->soc->npins;
2068 	npct->dev = &pdev->dev;
2069 
2070 	npct->pctl = pinctrl_register(&nmk_pinctrl_desc, &pdev->dev, npct);
2071 	if (IS_ERR(npct->pctl)) {
2072 		dev_err(&pdev->dev, "could not register Nomadik pinctrl driver\n");
2073 		return PTR_ERR(npct->pctl);
2074 	}
2075 
2076 	platform_set_drvdata(pdev, npct);
2077 	dev_info(&pdev->dev, "initialized Nomadik pin control driver\n");
2078 
2079 	return 0;
2080 }
2081 
2082 static const struct of_device_id nmk_gpio_match[] = {
2083 	{ .compatible = "st,nomadik-gpio", },
2084 	{}
2085 };
2086 
2087 static struct platform_driver nmk_gpio_driver = {
2088 	.driver = {
2089 		.name = "gpio",
2090 		.of_match_table = nmk_gpio_match,
2091 	},
2092 	.probe = nmk_gpio_probe,
2093 };
2094 
2095 static SIMPLE_DEV_PM_OPS(nmk_pinctrl_pm_ops,
2096 			nmk_pinctrl_suspend,
2097 			nmk_pinctrl_resume);
2098 
2099 static struct platform_driver nmk_pinctrl_driver = {
2100 	.driver = {
2101 		.name = "pinctrl-nomadik",
2102 		.of_match_table = nmk_pinctrl_match,
2103 		.pm = &nmk_pinctrl_pm_ops,
2104 	},
2105 	.probe = nmk_pinctrl_probe,
2106 };
2107 
2108 static int __init nmk_gpio_init(void)
2109 {
2110 	return platform_driver_register(&nmk_gpio_driver);
2111 }
2112 subsys_initcall(nmk_gpio_init);
2113 
2114 static int __init nmk_pinctrl_init(void)
2115 {
2116 	return platform_driver_register(&nmk_pinctrl_driver);
2117 }
2118 core_initcall(nmk_pinctrl_init);
2119 
2120 MODULE_AUTHOR("Prafulla WADASKAR and Alessandro Rubini");
2121 MODULE_DESCRIPTION("Nomadik GPIO Driver");
2122 MODULE_LICENSE("GPL");
2123