1 /*
2  * Marvell 37xx SoC pinctrl driver
3  *
4  * Copyright (C) 2017 Marvell
5  *
6  * Gregory CLEMENT <gregory.clement@free-electrons.com>
7  *
8  * This file is licensed under the terms of the GNU General Public
9  * License version 2 or later. This program is licensed "as is"
10  * without any warranty of any kind, whether express or implied.
11  */
12 
13 #include <linux/gpio/driver.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/of.h>
16 #include <linux/of_address.h>
17 #include <linux/of_device.h>
18 #include <linux/of_irq.h>
19 #include <linux/pinctrl/pinconf-generic.h>
20 #include <linux/pinctrl/pinconf.h>
21 #include <linux/pinctrl/pinctrl.h>
22 #include <linux/pinctrl/pinmux.h>
23 #include <linux/platform_device.h>
24 #include <linux/regmap.h>
25 #include <linux/slab.h>
26 #include <linux/string_helpers.h>
27 
28 #include "../pinctrl-utils.h"
29 
30 #define OUTPUT_EN	0x0
31 #define INPUT_VAL	0x10
32 #define OUTPUT_VAL	0x18
33 #define OUTPUT_CTL	0x20
34 #define SELECTION	0x30
35 
36 #define IRQ_EN		0x0
37 #define IRQ_POL		0x08
38 #define IRQ_STATUS	0x10
39 #define IRQ_WKUP	0x18
40 
41 #define NB_FUNCS 3
42 #define GPIO_PER_REG	32
43 
44 /**
45  * struct armada_37xx_pin_group: represents group of pins of a pinmux function.
46  * The pins of a pinmux groups are composed of one or two groups of contiguous
47  * pins.
48  * @name:	Name of the pin group, used to lookup the group.
49  * @start_pin:	Index of the first pin of the main range of pins belonging to
50  *		the group
51  * @npins:	Number of pins included in the first range
52  * @reg_mask:	Bit mask matching the group in the selection register
53  * @val:	Value to write to the registers for a given function
54  * @extra_pin:	Index of the first pin of the optional second range of pins
55  *		belonging to the group
56  * @extra_npins:Number of pins included in the second optional range
57  * @funcs:	A list of pinmux functions that can be selected for this group.
58  * @pins:	List of the pins included in the group
59  */
60 struct armada_37xx_pin_group {
61 	const char	*name;
62 	unsigned int	start_pin;
63 	unsigned int	npins;
64 	u32		reg_mask;
65 	u32		val[NB_FUNCS];
66 	unsigned int	extra_pin;
67 	unsigned int	extra_npins;
68 	const char	*funcs[NB_FUNCS];
69 	unsigned int	*pins;
70 };
71 
72 struct armada_37xx_pin_data {
73 	u8				nr_pins;
74 	char				*name;
75 	struct armada_37xx_pin_group	*groups;
76 	int				ngroups;
77 };
78 
79 struct armada_37xx_pmx_func {
80 	const char		*name;
81 	const char		**groups;
82 	unsigned int		ngroups;
83 };
84 
85 struct armada_37xx_pm_state {
86 	u32 out_en_l;
87 	u32 out_en_h;
88 	u32 out_val_l;
89 	u32 out_val_h;
90 	u32 irq_en_l;
91 	u32 irq_en_h;
92 	u32 irq_pol_l;
93 	u32 irq_pol_h;
94 	u32 selection;
95 };
96 
97 struct armada_37xx_pinctrl {
98 	struct regmap			*regmap;
99 	void __iomem			*base;
100 	const struct armada_37xx_pin_data	*data;
101 	struct device			*dev;
102 	struct gpio_chip		gpio_chip;
103 	struct irq_chip			irq_chip;
104 	spinlock_t			irq_lock;
105 	struct pinctrl_desc		pctl;
106 	struct pinctrl_dev		*pctl_dev;
107 	struct armada_37xx_pin_group	*groups;
108 	unsigned int			ngroups;
109 	struct armada_37xx_pmx_func	*funcs;
110 	unsigned int			nfuncs;
111 	struct armada_37xx_pm_state	pm;
112 };
113 
114 #define PIN_GRP(_name, _start, _nr, _mask, _func1, _func2)	\
115 	{					\
116 		.name = _name,			\
117 		.start_pin = _start,		\
118 		.npins = _nr,			\
119 		.reg_mask = _mask,		\
120 		.val = {0, _mask},		\
121 		.funcs = {_func1, _func2}	\
122 	}
123 
124 #define PIN_GRP_GPIO(_name, _start, _nr, _mask, _func1)	\
125 	{					\
126 		.name = _name,			\
127 		.start_pin = _start,		\
128 		.npins = _nr,			\
129 		.reg_mask = _mask,		\
130 		.val = {0, _mask},		\
131 		.funcs = {_func1, "gpio"}	\
132 	}
133 
134 #define PIN_GRP_GPIO_2(_name, _start, _nr, _mask, _val1, _val2, _func1)   \
135 	{					\
136 		.name = _name,			\
137 		.start_pin = _start,		\
138 		.npins = _nr,			\
139 		.reg_mask = _mask,		\
140 		.val = {_val1, _val2},		\
141 		.funcs = {_func1, "gpio"}	\
142 	}
143 
144 #define PIN_GRP_GPIO_3(_name, _start, _nr, _mask, _v1, _v2, _v3, _f1, _f2) \
145 	{					\
146 		.name = _name,			\
147 		.start_pin = _start,		\
148 		.npins = _nr,			\
149 		.reg_mask = _mask,		\
150 		.val = {_v1, _v2, _v3},	\
151 		.funcs = {_f1, _f2, "gpio"}	\
152 	}
153 
154 #define PIN_GRP_EXTRA(_name, _start, _nr, _mask, _v1, _v2, _start2, _nr2, \
155 		      _f1, _f2)				\
156 	{						\
157 		.name = _name,				\
158 		.start_pin = _start,			\
159 		.npins = _nr,				\
160 		.reg_mask = _mask,			\
161 		.val = {_v1, _v2},			\
162 		.extra_pin = _start2,			\
163 		.extra_npins = _nr2,			\
164 		.funcs = {_f1, _f2}			\
165 	}
166 
167 static struct armada_37xx_pin_group armada_37xx_nb_groups[] = {
168 	PIN_GRP_GPIO("jtag", 20, 5, BIT(0), "jtag"),
169 	PIN_GRP_GPIO("sdio0", 8, 3, BIT(1), "sdio"),
170 	PIN_GRP_GPIO("emmc_nb", 27, 9, BIT(2), "emmc"),
171 	PIN_GRP_GPIO_3("pwm0", 11, 1, BIT(3) | BIT(20), 0, BIT(20), BIT(3),
172 		       "pwm", "led"),
173 	PIN_GRP_GPIO_3("pwm1", 12, 1, BIT(4) | BIT(21), 0, BIT(21), BIT(4),
174 		       "pwm", "led"),
175 	PIN_GRP_GPIO_3("pwm2", 13, 1, BIT(5) | BIT(22), 0, BIT(22), BIT(5),
176 		       "pwm", "led"),
177 	PIN_GRP_GPIO_3("pwm3", 14, 1, BIT(6) | BIT(23), 0, BIT(23), BIT(6),
178 		       "pwm", "led"),
179 	PIN_GRP_GPIO("pmic1", 7, 1, BIT(7), "pmic"),
180 	PIN_GRP_GPIO("pmic0", 6, 1, BIT(8), "pmic"),
181 	PIN_GRP_GPIO("i2c2", 2, 2, BIT(9), "i2c"),
182 	PIN_GRP_GPIO("i2c1", 0, 2, BIT(10), "i2c"),
183 	PIN_GRP_GPIO("spi_cs1", 17, 1, BIT(12), "spi"),
184 	PIN_GRP_GPIO_2("spi_cs2", 18, 1, BIT(13) | BIT(19), 0, BIT(13), "spi"),
185 	PIN_GRP_GPIO_2("spi_cs3", 19, 1, BIT(14) | BIT(19), 0, BIT(14), "spi"),
186 	PIN_GRP_GPIO("onewire", 4, 1, BIT(16), "onewire"),
187 	PIN_GRP_GPIO("uart1", 25, 2, BIT(17), "uart"),
188 	PIN_GRP_GPIO("spi_quad", 15, 2, BIT(18), "spi"),
189 	PIN_GRP_EXTRA("uart2", 9, 2, BIT(1) | BIT(13) | BIT(14) | BIT(19),
190 		      BIT(1) | BIT(13) | BIT(14), BIT(1) | BIT(19),
191 		      18, 2, "gpio", "uart"),
192 };
193 
194 static struct armada_37xx_pin_group armada_37xx_sb_groups[] = {
195 	PIN_GRP_GPIO("usb32_drvvbus0", 0, 1, BIT(0), "drvbus"),
196 	PIN_GRP_GPIO("usb2_drvvbus1", 1, 1, BIT(1), "drvbus"),
197 	PIN_GRP_GPIO("sdio_sb", 24, 6, BIT(2), "sdio"),
198 	PIN_GRP_GPIO("rgmii", 6, 12, BIT(3), "mii"),
199 	PIN_GRP_GPIO("smi", 18, 2, BIT(4), "smi"),
200 	PIN_GRP_GPIO("pcie1", 3, 1, BIT(5), "pcie"), /* this actually controls "pcie1_reset" */
201 	PIN_GRP_GPIO("pcie1_clkreq", 4, 1, BIT(9), "pcie"),
202 	PIN_GRP_GPIO("pcie1_wakeup", 5, 1, BIT(10), "pcie"),
203 	PIN_GRP_GPIO("ptp", 20, 3, BIT(11) | BIT(12) | BIT(13), "ptp"),
204 	PIN_GRP("ptp_clk", 21, 1, BIT(6), "ptp", "mii"),
205 	PIN_GRP("ptp_trig", 22, 1, BIT(7), "ptp", "mii"),
206 	PIN_GRP_GPIO_3("mii_col", 23, 1, BIT(8) | BIT(14), 0, BIT(8), BIT(14),
207 		       "mii", "mii_err"),
208 };
209 
210 static const struct armada_37xx_pin_data armada_37xx_pin_nb = {
211 	.nr_pins = 36,
212 	.name = "GPIO1",
213 	.groups = armada_37xx_nb_groups,
214 	.ngroups = ARRAY_SIZE(armada_37xx_nb_groups),
215 };
216 
217 static const struct armada_37xx_pin_data armada_37xx_pin_sb = {
218 	.nr_pins = 30,
219 	.name = "GPIO2",
220 	.groups = armada_37xx_sb_groups,
221 	.ngroups = ARRAY_SIZE(armada_37xx_sb_groups),
222 };
223 
224 static inline void armada_37xx_update_reg(unsigned int *reg,
225 					  unsigned int *offset)
226 {
227 	/* We never have more than 2 registers */
228 	if (*offset >= GPIO_PER_REG) {
229 		*offset -= GPIO_PER_REG;
230 		*reg += sizeof(u32);
231 	}
232 }
233 
234 static struct armada_37xx_pin_group *armada_37xx_find_next_grp_by_pin(
235 	struct armada_37xx_pinctrl *info, int pin, int *grp)
236 {
237 	while (*grp < info->ngroups) {
238 		struct armada_37xx_pin_group *group = &info->groups[*grp];
239 		int j;
240 
241 		*grp = *grp + 1;
242 		for (j = 0; j < (group->npins + group->extra_npins); j++)
243 			if (group->pins[j] == pin)
244 				return group;
245 	}
246 	return NULL;
247 }
248 
249 static int armada_37xx_pin_config_group_get(struct pinctrl_dev *pctldev,
250 			    unsigned int selector, unsigned long *config)
251 {
252 	return -ENOTSUPP;
253 }
254 
255 static int armada_37xx_pin_config_group_set(struct pinctrl_dev *pctldev,
256 			    unsigned int selector, unsigned long *configs,
257 			    unsigned int num_configs)
258 {
259 	return -ENOTSUPP;
260 }
261 
262 static const struct pinconf_ops armada_37xx_pinconf_ops = {
263 	.is_generic = true,
264 	.pin_config_group_get = armada_37xx_pin_config_group_get,
265 	.pin_config_group_set = armada_37xx_pin_config_group_set,
266 };
267 
268 static int armada_37xx_get_groups_count(struct pinctrl_dev *pctldev)
269 {
270 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
271 
272 	return info->ngroups;
273 }
274 
275 static const char *armada_37xx_get_group_name(struct pinctrl_dev *pctldev,
276 					      unsigned int group)
277 {
278 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
279 
280 	return info->groups[group].name;
281 }
282 
283 static int armada_37xx_get_group_pins(struct pinctrl_dev *pctldev,
284 				      unsigned int selector,
285 				      const unsigned int **pins,
286 				      unsigned int *npins)
287 {
288 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
289 
290 	if (selector >= info->ngroups)
291 		return -EINVAL;
292 
293 	*pins = info->groups[selector].pins;
294 	*npins = info->groups[selector].npins +
295 		info->groups[selector].extra_npins;
296 
297 	return 0;
298 }
299 
300 static const struct pinctrl_ops armada_37xx_pctrl_ops = {
301 	.get_groups_count	= armada_37xx_get_groups_count,
302 	.get_group_name		= armada_37xx_get_group_name,
303 	.get_group_pins		= armada_37xx_get_group_pins,
304 	.dt_node_to_map		= pinconf_generic_dt_node_to_map_group,
305 	.dt_free_map		= pinctrl_utils_free_map,
306 };
307 
308 /*
309  * Pinmux_ops handling
310  */
311 
312 static int armada_37xx_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
313 {
314 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
315 
316 	return info->nfuncs;
317 }
318 
319 static const char *armada_37xx_pmx_get_func_name(struct pinctrl_dev *pctldev,
320 						 unsigned int selector)
321 {
322 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
323 
324 	return info->funcs[selector].name;
325 }
326 
327 static int armada_37xx_pmx_get_groups(struct pinctrl_dev *pctldev,
328 				      unsigned int selector,
329 				      const char * const **groups,
330 				      unsigned int * const num_groups)
331 {
332 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
333 
334 	*groups = info->funcs[selector].groups;
335 	*num_groups = info->funcs[selector].ngroups;
336 
337 	return 0;
338 }
339 
340 static int armada_37xx_pmx_set_by_name(struct pinctrl_dev *pctldev,
341 				       const char *name,
342 				       struct armada_37xx_pin_group *grp)
343 {
344 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
345 	struct device *dev = info->dev;
346 	unsigned int reg = SELECTION;
347 	unsigned int mask = grp->reg_mask;
348 	int func, val;
349 
350 	dev_dbg(dev, "enable function %s group %s\n", name, grp->name);
351 
352 	func = match_string(grp->funcs, NB_FUNCS, name);
353 	if (func < 0)
354 		return -ENOTSUPP;
355 
356 	val = grp->val[func];
357 
358 	regmap_update_bits(info->regmap, reg, mask, val);
359 
360 	return 0;
361 }
362 
363 static int armada_37xx_pmx_set(struct pinctrl_dev *pctldev,
364 			       unsigned int selector,
365 			       unsigned int group)
366 {
367 
368 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
369 	struct armada_37xx_pin_group *grp = &info->groups[group];
370 	const char *name = info->funcs[selector].name;
371 
372 	return armada_37xx_pmx_set_by_name(pctldev, name, grp);
373 }
374 
375 static inline void armada_37xx_irq_update_reg(unsigned int *reg,
376 					  struct irq_data *d)
377 {
378 	int offset = irqd_to_hwirq(d);
379 
380 	armada_37xx_update_reg(reg, &offset);
381 }
382 
383 static int armada_37xx_gpio_direction_input(struct gpio_chip *chip,
384 					    unsigned int offset)
385 {
386 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
387 	unsigned int reg = OUTPUT_EN;
388 	unsigned int mask;
389 
390 	armada_37xx_update_reg(&reg, &offset);
391 	mask = BIT(offset);
392 
393 	return regmap_update_bits(info->regmap, reg, mask, 0);
394 }
395 
396 static int armada_37xx_gpio_get_direction(struct gpio_chip *chip,
397 					  unsigned int offset)
398 {
399 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
400 	unsigned int reg = OUTPUT_EN;
401 	unsigned int val, mask;
402 
403 	armada_37xx_update_reg(&reg, &offset);
404 	mask = BIT(offset);
405 	regmap_read(info->regmap, reg, &val);
406 
407 	if (val & mask)
408 		return GPIO_LINE_DIRECTION_OUT;
409 
410 	return GPIO_LINE_DIRECTION_IN;
411 }
412 
413 static int armada_37xx_gpio_direction_output(struct gpio_chip *chip,
414 					     unsigned int offset, int value)
415 {
416 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
417 	unsigned int reg = OUTPUT_EN;
418 	unsigned int mask, val, ret;
419 
420 	armada_37xx_update_reg(&reg, &offset);
421 	mask = BIT(offset);
422 
423 	ret = regmap_update_bits(info->regmap, reg, mask, mask);
424 
425 	if (ret)
426 		return ret;
427 
428 	reg = OUTPUT_VAL;
429 	val = value ? mask : 0;
430 	regmap_update_bits(info->regmap, reg, mask, val);
431 
432 	return 0;
433 }
434 
435 static int armada_37xx_gpio_get(struct gpio_chip *chip, unsigned int offset)
436 {
437 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
438 	unsigned int reg = INPUT_VAL;
439 	unsigned int val, mask;
440 
441 	armada_37xx_update_reg(&reg, &offset);
442 	mask = BIT(offset);
443 
444 	regmap_read(info->regmap, reg, &val);
445 
446 	return (val & mask) != 0;
447 }
448 
449 static void armada_37xx_gpio_set(struct gpio_chip *chip, unsigned int offset,
450 				 int value)
451 {
452 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
453 	unsigned int reg = OUTPUT_VAL;
454 	unsigned int mask, val;
455 
456 	armada_37xx_update_reg(&reg, &offset);
457 	mask = BIT(offset);
458 	val = value ? mask : 0;
459 
460 	regmap_update_bits(info->regmap, reg, mask, val);
461 }
462 
463 static int armada_37xx_pmx_gpio_set_direction(struct pinctrl_dev *pctldev,
464 					      struct pinctrl_gpio_range *range,
465 					      unsigned int offset, bool input)
466 {
467 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
468 	struct gpio_chip *chip = range->gc;
469 
470 	dev_dbg(info->dev, "gpio_direction for pin %u as %s-%d to %s\n",
471 		offset, range->name, offset, input ? "input" : "output");
472 
473 	if (input)
474 		armada_37xx_gpio_direction_input(chip, offset);
475 	else
476 		armada_37xx_gpio_direction_output(chip, offset, 0);
477 
478 	return 0;
479 }
480 
481 static int armada_37xx_gpio_request_enable(struct pinctrl_dev *pctldev,
482 					   struct pinctrl_gpio_range *range,
483 					   unsigned int offset)
484 {
485 	struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
486 	struct armada_37xx_pin_group *group;
487 	int grp = 0;
488 
489 	dev_dbg(info->dev, "requesting gpio %d\n", offset);
490 
491 	while ((group = armada_37xx_find_next_grp_by_pin(info, offset, &grp)))
492 		armada_37xx_pmx_set_by_name(pctldev, "gpio", group);
493 
494 	return 0;
495 }
496 
497 static const struct pinmux_ops armada_37xx_pmx_ops = {
498 	.get_functions_count	= armada_37xx_pmx_get_funcs_count,
499 	.get_function_name	= armada_37xx_pmx_get_func_name,
500 	.get_function_groups	= armada_37xx_pmx_get_groups,
501 	.set_mux		= armada_37xx_pmx_set,
502 	.gpio_request_enable	= armada_37xx_gpio_request_enable,
503 	.gpio_set_direction	= armada_37xx_pmx_gpio_set_direction,
504 };
505 
506 static const struct gpio_chip armada_37xx_gpiolib_chip = {
507 	.request = gpiochip_generic_request,
508 	.free = gpiochip_generic_free,
509 	.set = armada_37xx_gpio_set,
510 	.get = armada_37xx_gpio_get,
511 	.get_direction	= armada_37xx_gpio_get_direction,
512 	.direction_input = armada_37xx_gpio_direction_input,
513 	.direction_output = armada_37xx_gpio_direction_output,
514 	.owner = THIS_MODULE,
515 };
516 
517 static void armada_37xx_irq_ack(struct irq_data *d)
518 {
519 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
520 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
521 	u32 reg = IRQ_STATUS;
522 	unsigned long flags;
523 
524 	armada_37xx_irq_update_reg(&reg, d);
525 	spin_lock_irqsave(&info->irq_lock, flags);
526 	writel(d->mask, info->base + reg);
527 	spin_unlock_irqrestore(&info->irq_lock, flags);
528 }
529 
530 static void armada_37xx_irq_mask(struct irq_data *d)
531 {
532 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
533 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
534 	u32 val, reg = IRQ_EN;
535 	unsigned long flags;
536 
537 	armada_37xx_irq_update_reg(&reg, d);
538 	spin_lock_irqsave(&info->irq_lock, flags);
539 	val = readl(info->base + reg);
540 	writel(val & ~d->mask, info->base + reg);
541 	spin_unlock_irqrestore(&info->irq_lock, flags);
542 }
543 
544 static void armada_37xx_irq_unmask(struct irq_data *d)
545 {
546 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
547 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
548 	u32 val, reg = IRQ_EN;
549 	unsigned long flags;
550 
551 	armada_37xx_irq_update_reg(&reg, d);
552 	spin_lock_irqsave(&info->irq_lock, flags);
553 	val = readl(info->base + reg);
554 	writel(val | d->mask, info->base + reg);
555 	spin_unlock_irqrestore(&info->irq_lock, flags);
556 }
557 
558 static int armada_37xx_irq_set_wake(struct irq_data *d, unsigned int on)
559 {
560 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
561 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
562 	u32 val, reg = IRQ_WKUP;
563 	unsigned long flags;
564 
565 	armada_37xx_irq_update_reg(&reg, d);
566 	spin_lock_irqsave(&info->irq_lock, flags);
567 	val = readl(info->base + reg);
568 	if (on)
569 		val |= (BIT(d->hwirq % GPIO_PER_REG));
570 	else
571 		val &= ~(BIT(d->hwirq % GPIO_PER_REG));
572 	writel(val, info->base + reg);
573 	spin_unlock_irqrestore(&info->irq_lock, flags);
574 
575 	return 0;
576 }
577 
578 static int armada_37xx_irq_set_type(struct irq_data *d, unsigned int type)
579 {
580 	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
581 	struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
582 	u32 val, reg = IRQ_POL;
583 	unsigned long flags;
584 
585 	spin_lock_irqsave(&info->irq_lock, flags);
586 	armada_37xx_irq_update_reg(&reg, d);
587 	val = readl(info->base + reg);
588 	switch (type) {
589 	case IRQ_TYPE_EDGE_RISING:
590 		val &= ~(BIT(d->hwirq % GPIO_PER_REG));
591 		break;
592 	case IRQ_TYPE_EDGE_FALLING:
593 		val |= (BIT(d->hwirq % GPIO_PER_REG));
594 		break;
595 	case IRQ_TYPE_EDGE_BOTH: {
596 		u32 in_val, in_reg = INPUT_VAL;
597 
598 		armada_37xx_irq_update_reg(&in_reg, d);
599 		regmap_read(info->regmap, in_reg, &in_val);
600 
601 		/* Set initial polarity based on current input level. */
602 		if (in_val & BIT(d->hwirq % GPIO_PER_REG))
603 			val |= BIT(d->hwirq % GPIO_PER_REG);	/* falling */
604 		else
605 			val &= ~(BIT(d->hwirq % GPIO_PER_REG));	/* rising */
606 		break;
607 	}
608 	default:
609 		spin_unlock_irqrestore(&info->irq_lock, flags);
610 		return -EINVAL;
611 	}
612 	writel(val, info->base + reg);
613 	spin_unlock_irqrestore(&info->irq_lock, flags);
614 
615 	return 0;
616 }
617 
618 static int armada_37xx_edge_both_irq_swap_pol(struct armada_37xx_pinctrl *info,
619 					     u32 pin_idx)
620 {
621 	u32 reg_idx = pin_idx / GPIO_PER_REG;
622 	u32 bit_num = pin_idx % GPIO_PER_REG;
623 	u32 p, l, ret;
624 	unsigned long flags;
625 
626 	regmap_read(info->regmap, INPUT_VAL + 4*reg_idx, &l);
627 
628 	spin_lock_irqsave(&info->irq_lock, flags);
629 	p = readl(info->base + IRQ_POL + 4 * reg_idx);
630 	if ((p ^ l) & (1 << bit_num)) {
631 		/*
632 		 * For the gpios which are used for both-edge irqs, when their
633 		 * interrupts happen, their input levels are changed,
634 		 * yet their interrupt polarities are kept in old values, we
635 		 * should synchronize their interrupt polarities; for example,
636 		 * at first a gpio's input level is low and its interrupt
637 		 * polarity control is "Detect rising edge", then the gpio has
638 		 * a interrupt , its level turns to high, we should change its
639 		 * polarity control to "Detect falling edge" correspondingly.
640 		 */
641 		p ^= 1 << bit_num;
642 		writel(p, info->base + IRQ_POL + 4 * reg_idx);
643 		ret = 0;
644 	} else {
645 		/* Spurious irq */
646 		ret = -1;
647 	}
648 
649 	spin_unlock_irqrestore(&info->irq_lock, flags);
650 	return ret;
651 }
652 
653 static void armada_37xx_irq_handler(struct irq_desc *desc)
654 {
655 	struct gpio_chip *gc = irq_desc_get_handler_data(desc);
656 	struct irq_chip *chip = irq_desc_get_chip(desc);
657 	struct armada_37xx_pinctrl *info = gpiochip_get_data(gc);
658 	struct irq_domain *d = gc->irq.domain;
659 	int i;
660 
661 	chained_irq_enter(chip, desc);
662 	for (i = 0; i <= d->revmap_size / GPIO_PER_REG; i++) {
663 		u32 status;
664 		unsigned long flags;
665 
666 		spin_lock_irqsave(&info->irq_lock, flags);
667 		status = readl_relaxed(info->base + IRQ_STATUS + 4 * i);
668 		/* Manage only the interrupt that was enabled */
669 		status &= readl_relaxed(info->base + IRQ_EN + 4 * i);
670 		spin_unlock_irqrestore(&info->irq_lock, flags);
671 		while (status) {
672 			u32 hwirq = ffs(status) - 1;
673 			u32 virq = irq_find_mapping(d, hwirq +
674 						     i * GPIO_PER_REG);
675 			u32 t = irq_get_trigger_type(virq);
676 
677 			if ((t & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH) {
678 				/* Swap polarity (race with GPIO line) */
679 				if (armada_37xx_edge_both_irq_swap_pol(info,
680 					hwirq + i * GPIO_PER_REG)) {
681 					/*
682 					 * For spurious irq, which gpio level
683 					 * is not as expected after incoming
684 					 * edge, just ack the gpio irq.
685 					 */
686 					writel(1 << hwirq,
687 					       info->base +
688 					       IRQ_STATUS + 4 * i);
689 					goto update_status;
690 				}
691 			}
692 
693 			generic_handle_irq(virq);
694 
695 update_status:
696 			/* Update status in case a new IRQ appears */
697 			spin_lock_irqsave(&info->irq_lock, flags);
698 			status = readl_relaxed(info->base +
699 					       IRQ_STATUS + 4 * i);
700 			/* Manage only the interrupt that was enabled */
701 			status &= readl_relaxed(info->base + IRQ_EN + 4 * i);
702 			spin_unlock_irqrestore(&info->irq_lock, flags);
703 		}
704 	}
705 	chained_irq_exit(chip, desc);
706 }
707 
708 static unsigned int armada_37xx_irq_startup(struct irq_data *d)
709 {
710 	/*
711 	 * The mask field is a "precomputed bitmask for accessing the
712 	 * chip registers" which was introduced for the generic
713 	 * irqchip framework. As we don't use this framework, we can
714 	 * reuse this field for our own usage.
715 	 */
716 	d->mask = BIT(d->hwirq % GPIO_PER_REG);
717 
718 	armada_37xx_irq_unmask(d);
719 
720 	return 0;
721 }
722 
723 static int armada_37xx_irqchip_register(struct platform_device *pdev,
724 					struct armada_37xx_pinctrl *info)
725 {
726 	struct gpio_chip *gc = &info->gpio_chip;
727 	struct irq_chip *irqchip = &info->irq_chip;
728 	struct gpio_irq_chip *girq = &gc->irq;
729 	struct device *dev = &pdev->dev;
730 	struct device_node *np;
731 	int ret = -ENODEV, i, nr_irq_parent;
732 
733 	/* Check if we have at least one gpio-controller child node */
734 	for_each_child_of_node(dev->of_node, np) {
735 		if (of_property_read_bool(np, "gpio-controller")) {
736 			ret = 0;
737 			break;
738 		}
739 	}
740 	if (ret)
741 		return dev_err_probe(dev, ret, "no gpio-controller child node\n");
742 
743 	nr_irq_parent = of_irq_count(np);
744 	spin_lock_init(&info->irq_lock);
745 
746 	if (!nr_irq_parent) {
747 		dev_err(dev, "invalid or no IRQ\n");
748 		return 0;
749 	}
750 
751 	info->base = devm_platform_ioremap_resource(pdev, 1);
752 	if (IS_ERR(info->base))
753 		return PTR_ERR(info->base);
754 
755 	irqchip->irq_ack = armada_37xx_irq_ack;
756 	irqchip->irq_mask = armada_37xx_irq_mask;
757 	irqchip->irq_unmask = armada_37xx_irq_unmask;
758 	irqchip->irq_set_wake = armada_37xx_irq_set_wake;
759 	irqchip->irq_set_type = armada_37xx_irq_set_type;
760 	irqchip->irq_startup = armada_37xx_irq_startup;
761 	irqchip->name = info->data->name;
762 	girq->chip = irqchip;
763 	girq->parent_handler = armada_37xx_irq_handler;
764 	/*
765 	 * Many interrupts are connected to the parent interrupt
766 	 * controller. But we do not take advantage of this and use
767 	 * the chained irq with all of them.
768 	 */
769 	girq->num_parents = nr_irq_parent;
770 	girq->parents = devm_kcalloc(dev, nr_irq_parent, sizeof(*girq->parents), GFP_KERNEL);
771 	if (!girq->parents)
772 		return -ENOMEM;
773 	for (i = 0; i < nr_irq_parent; i++) {
774 		int irq = irq_of_parse_and_map(np, i);
775 
776 		if (irq < 0)
777 			continue;
778 		girq->parents[i] = irq;
779 	}
780 	girq->default_type = IRQ_TYPE_NONE;
781 	girq->handler = handle_edge_irq;
782 
783 	return 0;
784 }
785 
786 static int armada_37xx_gpiochip_register(struct platform_device *pdev,
787 					struct armada_37xx_pinctrl *info)
788 {
789 	struct device *dev = &pdev->dev;
790 	struct device_node *np;
791 	struct gpio_chip *gc;
792 	int ret = -ENODEV;
793 
794 	for_each_child_of_node(dev->of_node, np) {
795 		if (of_find_property(np, "gpio-controller", NULL)) {
796 			ret = 0;
797 			break;
798 		}
799 	}
800 	if (ret)
801 		return ret;
802 
803 	info->gpio_chip = armada_37xx_gpiolib_chip;
804 
805 	gc = &info->gpio_chip;
806 	gc->ngpio = info->data->nr_pins;
807 	gc->parent = dev;
808 	gc->base = -1;
809 	gc->of_node = np;
810 	gc->label = info->data->name;
811 
812 	ret = armada_37xx_irqchip_register(pdev, info);
813 	if (ret)
814 		return ret;
815 
816 	return devm_gpiochip_add_data(dev, gc, info);
817 }
818 
819 /**
820  * armada_37xx_add_function() - Add a new function to the list
821  * @funcs: array of function to add the new one
822  * @funcsize: size of the remaining space for the function
823  * @name: name of the function to add
824  *
825  * If it is a new function then create it by adding its name else
826  * increment the number of group associated to this function.
827  */
828 static int armada_37xx_add_function(struct armada_37xx_pmx_func *funcs,
829 				    int *funcsize, const char *name)
830 {
831 	int i = 0;
832 
833 	if (*funcsize <= 0)
834 		return -EOVERFLOW;
835 
836 	while (funcs->ngroups) {
837 		/* function already there */
838 		if (strcmp(funcs->name, name) == 0) {
839 			funcs->ngroups++;
840 
841 			return -EEXIST;
842 		}
843 		funcs++;
844 		i++;
845 	}
846 
847 	/* append new unique function */
848 	funcs->name = name;
849 	funcs->ngroups = 1;
850 	(*funcsize)--;
851 
852 	return 0;
853 }
854 
855 /**
856  * armada_37xx_fill_group() - complete the group array
857  * @info: info driver instance
858  *
859  * Based on the data available from the armada_37xx_pin_group array
860  * completes the last member of the struct for each function: the list
861  * of the groups associated to this function.
862  *
863  */
864 static int armada_37xx_fill_group(struct armada_37xx_pinctrl *info)
865 {
866 	int n, num = 0, funcsize = info->data->nr_pins;
867 	struct device *dev = info->dev;
868 
869 	for (n = 0; n < info->ngroups; n++) {
870 		struct armada_37xx_pin_group *grp = &info->groups[n];
871 		int i, j, f;
872 
873 		grp->pins = devm_kcalloc(dev, grp->npins + grp->extra_npins,
874 					 sizeof(*grp->pins),
875 					 GFP_KERNEL);
876 		if (!grp->pins)
877 			return -ENOMEM;
878 
879 		for (i = 0; i < grp->npins; i++)
880 			grp->pins[i] = grp->start_pin + i;
881 
882 		for (j = 0; j < grp->extra_npins; j++)
883 			grp->pins[i+j] = grp->extra_pin + j;
884 
885 		for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++) {
886 			int ret;
887 			/* check for unique functions and count groups */
888 			ret = armada_37xx_add_function(info->funcs, &funcsize,
889 					    grp->funcs[f]);
890 			if (ret == -EOVERFLOW)
891 				dev_err(dev, "More functions than pins(%d)\n",
892 					info->data->nr_pins);
893 			if (ret < 0)
894 				continue;
895 			num++;
896 		}
897 	}
898 
899 	info->nfuncs = num;
900 
901 	return 0;
902 }
903 
904 /**
905  * armada_37xx_fill_func() - complete the funcs array
906  * @info: info driver instance
907  *
908  * Based on the data available from the armada_37xx_pin_group array
909  * completes the last two member of the struct for each group:
910  * - the list of the pins included in the group
911  * - the list of pinmux functions that can be selected for this group
912  *
913  */
914 static int armada_37xx_fill_func(struct armada_37xx_pinctrl *info)
915 {
916 	struct armada_37xx_pmx_func *funcs = info->funcs;
917 	struct device *dev = info->dev;
918 	int n;
919 
920 	for (n = 0; n < info->nfuncs; n++) {
921 		const char *name = funcs[n].name;
922 		const char **groups;
923 		int g;
924 
925 		funcs[n].groups = devm_kcalloc(dev, funcs[n].ngroups,
926 					       sizeof(*(funcs[n].groups)),
927 					       GFP_KERNEL);
928 		if (!funcs[n].groups)
929 			return -ENOMEM;
930 
931 		groups = funcs[n].groups;
932 
933 		for (g = 0; g < info->ngroups; g++) {
934 			struct armada_37xx_pin_group *gp = &info->groups[g];
935 			int f;
936 
937 			f = match_string(gp->funcs, NB_FUNCS, name);
938 			if (f < 0)
939 				continue;
940 
941 			*groups = gp->name;
942 			groups++;
943 		}
944 	}
945 	return 0;
946 }
947 
948 static int armada_37xx_pinctrl_register(struct platform_device *pdev,
949 					struct armada_37xx_pinctrl *info)
950 {
951 	const struct armada_37xx_pin_data *pin_data = info->data;
952 	struct pinctrl_desc *ctrldesc = &info->pctl;
953 	struct pinctrl_pin_desc *pindesc, *pdesc;
954 	struct device *dev = &pdev->dev;
955 	char **pin_names;
956 	int pin, ret;
957 
958 	info->groups = pin_data->groups;
959 	info->ngroups = pin_data->ngroups;
960 
961 	ctrldesc->name = "armada_37xx-pinctrl";
962 	ctrldesc->owner = THIS_MODULE;
963 	ctrldesc->pctlops = &armada_37xx_pctrl_ops;
964 	ctrldesc->pmxops = &armada_37xx_pmx_ops;
965 	ctrldesc->confops = &armada_37xx_pinconf_ops;
966 
967 	pindesc = devm_kcalloc(dev, pin_data->nr_pins, sizeof(*pindesc), GFP_KERNEL);
968 	if (!pindesc)
969 		return -ENOMEM;
970 
971 	ctrldesc->pins = pindesc;
972 	ctrldesc->npins = pin_data->nr_pins;
973 
974 	pin_names = devm_kasprintf_strarray(dev, pin_data->name, pin_data->nr_pins);
975 	if (IS_ERR(pin_names))
976 		return PTR_ERR(pin_names);
977 
978 	pdesc = pindesc;
979 	for (pin = 0; pin < pin_data->nr_pins; pin++) {
980 		pdesc->number = pin;
981 		pdesc->name = pin_names[pin];
982 		pdesc++;
983 	}
984 
985 	/*
986 	 * we allocate functions for number of pins and hope there are
987 	 * fewer unique functions than pins available
988 	 */
989 	info->funcs = devm_kcalloc(dev, pin_data->nr_pins, sizeof(*info->funcs), GFP_KERNEL);
990 	if (!info->funcs)
991 		return -ENOMEM;
992 
993 	ret = armada_37xx_fill_group(info);
994 	if (ret)
995 		return ret;
996 
997 	ret = armada_37xx_fill_func(info);
998 	if (ret)
999 		return ret;
1000 
1001 	info->pctl_dev = devm_pinctrl_register(dev, ctrldesc, info);
1002 	if (IS_ERR(info->pctl_dev))
1003 		return dev_err_probe(dev, PTR_ERR(info->pctl_dev), "could not register pinctrl driver\n");
1004 
1005 	return 0;
1006 }
1007 
1008 #if defined(CONFIG_PM)
1009 static int armada_3700_pinctrl_suspend(struct device *dev)
1010 {
1011 	struct armada_37xx_pinctrl *info = dev_get_drvdata(dev);
1012 
1013 	/* Save GPIO state */
1014 	regmap_read(info->regmap, OUTPUT_EN, &info->pm.out_en_l);
1015 	regmap_read(info->regmap, OUTPUT_EN + sizeof(u32), &info->pm.out_en_h);
1016 	regmap_read(info->regmap, OUTPUT_VAL, &info->pm.out_val_l);
1017 	regmap_read(info->regmap, OUTPUT_VAL + sizeof(u32),
1018 		    &info->pm.out_val_h);
1019 
1020 	info->pm.irq_en_l = readl(info->base + IRQ_EN);
1021 	info->pm.irq_en_h = readl(info->base + IRQ_EN + sizeof(u32));
1022 	info->pm.irq_pol_l = readl(info->base + IRQ_POL);
1023 	info->pm.irq_pol_h = readl(info->base + IRQ_POL + sizeof(u32));
1024 
1025 	/* Save pinctrl state */
1026 	regmap_read(info->regmap, SELECTION, &info->pm.selection);
1027 
1028 	return 0;
1029 }
1030 
1031 static int armada_3700_pinctrl_resume(struct device *dev)
1032 {
1033 	struct armada_37xx_pinctrl *info = dev_get_drvdata(dev);
1034 	struct gpio_chip *gc;
1035 	struct irq_domain *d;
1036 	int i;
1037 
1038 	/* Restore GPIO state */
1039 	regmap_write(info->regmap, OUTPUT_EN, info->pm.out_en_l);
1040 	regmap_write(info->regmap, OUTPUT_EN + sizeof(u32),
1041 		     info->pm.out_en_h);
1042 	regmap_write(info->regmap, OUTPUT_VAL, info->pm.out_val_l);
1043 	regmap_write(info->regmap, OUTPUT_VAL + sizeof(u32),
1044 		     info->pm.out_val_h);
1045 
1046 	/*
1047 	 * Input levels may change during suspend, which is not monitored at
1048 	 * that time. GPIOs used for both-edge IRQs may not be synchronized
1049 	 * anymore with their polarities (rising/falling edge) and must be
1050 	 * re-configured manually.
1051 	 */
1052 	gc = &info->gpio_chip;
1053 	d = gc->irq.domain;
1054 	for (i = 0; i < gc->ngpio; i++) {
1055 		u32 irq_bit = BIT(i % GPIO_PER_REG);
1056 		u32 mask, *irq_pol, input_reg, virq, type, level;
1057 
1058 		if (i < GPIO_PER_REG) {
1059 			mask = info->pm.irq_en_l;
1060 			irq_pol = &info->pm.irq_pol_l;
1061 			input_reg = INPUT_VAL;
1062 		} else {
1063 			mask = info->pm.irq_en_h;
1064 			irq_pol = &info->pm.irq_pol_h;
1065 			input_reg = INPUT_VAL + sizeof(u32);
1066 		}
1067 
1068 		if (!(mask & irq_bit))
1069 			continue;
1070 
1071 		virq = irq_find_mapping(d, i);
1072 		type = irq_get_trigger_type(virq);
1073 
1074 		/*
1075 		 * Synchronize level and polarity for both-edge irqs:
1076 		 *     - a high input level expects a falling edge,
1077 		 *     - a low input level exepects a rising edge.
1078 		 */
1079 		if ((type & IRQ_TYPE_SENSE_MASK) ==
1080 		    IRQ_TYPE_EDGE_BOTH) {
1081 			regmap_read(info->regmap, input_reg, &level);
1082 			if ((*irq_pol ^ level) & irq_bit)
1083 				*irq_pol ^= irq_bit;
1084 		}
1085 	}
1086 
1087 	writel(info->pm.irq_en_l, info->base + IRQ_EN);
1088 	writel(info->pm.irq_en_h, info->base + IRQ_EN + sizeof(u32));
1089 	writel(info->pm.irq_pol_l, info->base + IRQ_POL);
1090 	writel(info->pm.irq_pol_h, info->base + IRQ_POL + sizeof(u32));
1091 
1092 	/* Restore pinctrl state */
1093 	regmap_write(info->regmap, SELECTION, info->pm.selection);
1094 
1095 	return 0;
1096 }
1097 
1098 /*
1099  * Since pinctrl is an infrastructure module, its resume should be issued prior
1100  * to other IO drivers.
1101  */
1102 static const struct dev_pm_ops armada_3700_pinctrl_pm_ops = {
1103 	.suspend_noirq = armada_3700_pinctrl_suspend,
1104 	.resume_noirq = armada_3700_pinctrl_resume,
1105 };
1106 
1107 #define PINCTRL_ARMADA_37XX_DEV_PM_OPS (&armada_3700_pinctrl_pm_ops)
1108 #else
1109 #define PINCTRL_ARMADA_37XX_DEV_PM_OPS NULL
1110 #endif /* CONFIG_PM */
1111 
1112 static const struct of_device_id armada_37xx_pinctrl_of_match[] = {
1113 	{
1114 		.compatible = "marvell,armada3710-sb-pinctrl",
1115 		.data = &armada_37xx_pin_sb,
1116 	},
1117 	{
1118 		.compatible = "marvell,armada3710-nb-pinctrl",
1119 		.data = &armada_37xx_pin_nb,
1120 	},
1121 	{ },
1122 };
1123 
1124 static int __init armada_37xx_pinctrl_probe(struct platform_device *pdev)
1125 {
1126 	struct armada_37xx_pinctrl *info;
1127 	struct device *dev = &pdev->dev;
1128 	struct device_node *np = dev->of_node;
1129 	struct regmap *regmap;
1130 	int ret;
1131 
1132 	info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
1133 	if (!info)
1134 		return -ENOMEM;
1135 
1136 	info->dev = dev;
1137 
1138 	regmap = syscon_node_to_regmap(np);
1139 	if (IS_ERR(regmap))
1140 		return dev_err_probe(dev, PTR_ERR(regmap), "cannot get regmap\n");
1141 	info->regmap = regmap;
1142 
1143 	info->data = of_device_get_match_data(dev);
1144 
1145 	ret = armada_37xx_pinctrl_register(pdev, info);
1146 	if (ret)
1147 		return ret;
1148 
1149 	ret = armada_37xx_gpiochip_register(pdev, info);
1150 	if (ret)
1151 		return ret;
1152 
1153 	platform_set_drvdata(pdev, info);
1154 
1155 	return 0;
1156 }
1157 
1158 static struct platform_driver armada_37xx_pinctrl_driver = {
1159 	.driver = {
1160 		.name = "armada-37xx-pinctrl",
1161 		.of_match_table = armada_37xx_pinctrl_of_match,
1162 		.pm = PINCTRL_ARMADA_37XX_DEV_PM_OPS,
1163 	},
1164 };
1165 
1166 builtin_platform_driver_probe(armada_37xx_pinctrl_driver,
1167 			      armada_37xx_pinctrl_probe);
1168