nfp: wire get_phys_port_name on representors
[linux-2.6-block.git] / drivers / gpio / gpio-rcar.c
CommitLineData
119f5e44
MD
1/*
2 * Renesas R-Car GPIO Support
3 *
1fd2b49d 4 * Copyright (C) 2014 Renesas Electronics Corporation
119f5e44
MD
5 * Copyright (C) 2013 Magnus Damm
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 */
16
ab82fa7d 17#include <linux/clk.h>
119f5e44
MD
18#include <linux/err.h>
19#include <linux/gpio.h>
20#include <linux/init.h>
21#include <linux/interrupt.h>
22#include <linux/io.h>
23#include <linux/ioport.h>
24#include <linux/irq.h>
119f5e44 25#include <linux/module.h>
bd0bf468 26#include <linux/of.h>
dc3465a9 27#include <linux/pinctrl/consumer.h>
119f5e44 28#include <linux/platform_device.h>
df0c6c80 29#include <linux/pm_runtime.h>
119f5e44
MD
30#include <linux/spinlock.h>
31#include <linux/slab.h>
32
33struct gpio_rcar_priv {
34 void __iomem *base;
35 spinlock_t lock;
119f5e44
MD
36 struct platform_device *pdev;
37 struct gpio_chip gpio_chip;
38 struct irq_chip irq_chip;
ab82fa7d 39 struct clk *clk;
8b092be9
GU
40 unsigned int irq_parent;
41 bool has_both_edge_trigger;
e1fef9e2 42 bool needs_clk;
119f5e44
MD
43};
44
3dc1e685
GU
45#define IOINTSEL 0x00 /* General IO/Interrupt Switching Register */
46#define INOUTSEL 0x04 /* General Input/Output Switching Register */
47#define OUTDT 0x08 /* General Output Register */
48#define INDT 0x0c /* General Input Register */
49#define INTDT 0x10 /* Interrupt Display Register */
50#define INTCLR 0x14 /* Interrupt Clear Register */
51#define INTMSK 0x18 /* Interrupt Mask Register */
52#define MSKCLR 0x1c /* Interrupt Mask Clear Register */
53#define POSNEG 0x20 /* Positive/Negative Logic Select Register */
54#define EDGLEVEL 0x24 /* Edge/level Select Register */
55#define FILONOFF 0x28 /* Chattering Prevention On/Off Register */
56#define BOTHEDGE 0x4c /* One Edge/Both Edge Select Register */
119f5e44 57
159f8a02
LP
58#define RCAR_MAX_GPIO_PER_BANK 32
59
119f5e44
MD
60static inline u32 gpio_rcar_read(struct gpio_rcar_priv *p, int offs)
61{
62 return ioread32(p->base + offs);
63}
64
65static inline void gpio_rcar_write(struct gpio_rcar_priv *p, int offs,
66 u32 value)
67{
68 iowrite32(value, p->base + offs);
69}
70
71static void gpio_rcar_modify_bit(struct gpio_rcar_priv *p, int offs,
72 int bit, bool value)
73{
74 u32 tmp = gpio_rcar_read(p, offs);
75
76 if (value)
77 tmp |= BIT(bit);
78 else
79 tmp &= ~BIT(bit);
80
81 gpio_rcar_write(p, offs, tmp);
82}
83
84static void gpio_rcar_irq_disable(struct irq_data *d)
85{
c7f3c5d3 86 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
c7b6f457 87 struct gpio_rcar_priv *p = gpiochip_get_data(gc);
119f5e44
MD
88
89 gpio_rcar_write(p, INTMSK, ~BIT(irqd_to_hwirq(d)));
90}
91
92static void gpio_rcar_irq_enable(struct irq_data *d)
93{
c7f3c5d3 94 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
c7b6f457 95 struct gpio_rcar_priv *p = gpiochip_get_data(gc);
119f5e44
MD
96
97 gpio_rcar_write(p, MSKCLR, BIT(irqd_to_hwirq(d)));
98}
99
100static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv *p,
101 unsigned int hwirq,
102 bool active_high_rising_edge,
7e1092b5
SH
103 bool level_trigger,
104 bool both)
119f5e44
MD
105{
106 unsigned long flags;
107
108 /* follow steps in the GPIO documentation for
109 * "Setting Edge-Sensitive Interrupt Input Mode" and
110 * "Setting Level-Sensitive Interrupt Input Mode"
111 */
112
113 spin_lock_irqsave(&p->lock, flags);
114
115 /* Configure postive or negative logic in POSNEG */
116 gpio_rcar_modify_bit(p, POSNEG, hwirq, !active_high_rising_edge);
117
118 /* Configure edge or level trigger in EDGLEVEL */
119 gpio_rcar_modify_bit(p, EDGLEVEL, hwirq, !level_trigger);
120
7e1092b5 121 /* Select one edge or both edges in BOTHEDGE */
8b092be9 122 if (p->has_both_edge_trigger)
7e1092b5
SH
123 gpio_rcar_modify_bit(p, BOTHEDGE, hwirq, both);
124
119f5e44
MD
125 /* Select "Interrupt Input Mode" in IOINTSEL */
126 gpio_rcar_modify_bit(p, IOINTSEL, hwirq, true);
127
128 /* Write INTCLR in case of edge trigger */
129 if (!level_trigger)
130 gpio_rcar_write(p, INTCLR, BIT(hwirq));
131
132 spin_unlock_irqrestore(&p->lock, flags);
133}
134
135static int gpio_rcar_irq_set_type(struct irq_data *d, unsigned int type)
136{
c7f3c5d3 137 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
c7b6f457 138 struct gpio_rcar_priv *p = gpiochip_get_data(gc);
119f5e44
MD
139 unsigned int hwirq = irqd_to_hwirq(d);
140
141 dev_dbg(&p->pdev->dev, "sense irq = %d, type = %d\n", hwirq, type);
142
143 switch (type & IRQ_TYPE_SENSE_MASK) {
144 case IRQ_TYPE_LEVEL_HIGH:
7e1092b5
SH
145 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, true,
146 false);
119f5e44
MD
147 break;
148 case IRQ_TYPE_LEVEL_LOW:
7e1092b5
SH
149 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, true,
150 false);
119f5e44
MD
151 break;
152 case IRQ_TYPE_EDGE_RISING:
7e1092b5
SH
153 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
154 false);
119f5e44
MD
155 break;
156 case IRQ_TYPE_EDGE_FALLING:
7e1092b5
SH
157 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, false,
158 false);
159 break;
160 case IRQ_TYPE_EDGE_BOTH:
8b092be9 161 if (!p->has_both_edge_trigger)
7e1092b5
SH
162 return -EINVAL;
163 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
164 true);
119f5e44
MD
165 break;
166 default:
167 return -EINVAL;
168 }
169 return 0;
170}
171
ab82fa7d
GU
172static int gpio_rcar_irq_set_wake(struct irq_data *d, unsigned int on)
173{
174 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
c7b6f457 175 struct gpio_rcar_priv *p = gpiochip_get_data(gc);
501ef0f9
GU
176 int error;
177
178 if (p->irq_parent) {
179 error = irq_set_irq_wake(p->irq_parent, on);
180 if (error) {
181 dev_dbg(&p->pdev->dev,
182 "irq %u doesn't support irq_set_wake\n",
183 p->irq_parent);
184 p->irq_parent = 0;
185 }
186 }
ab82fa7d
GU
187
188 if (!p->clk)
189 return 0;
190
191 if (on)
192 clk_enable(p->clk);
193 else
194 clk_disable(p->clk);
195
196 return 0;
197}
198
119f5e44
MD
199static irqreturn_t gpio_rcar_irq_handler(int irq, void *dev_id)
200{
201 struct gpio_rcar_priv *p = dev_id;
202 u32 pending;
203 unsigned int offset, irqs_handled = 0;
204
8808b64d
VB
205 while ((pending = gpio_rcar_read(p, INTDT) &
206 gpio_rcar_read(p, INTMSK))) {
119f5e44
MD
207 offset = __ffs(pending);
208 gpio_rcar_write(p, INTCLR, BIT(offset));
c7f3c5d3
GU
209 generic_handle_irq(irq_find_mapping(p->gpio_chip.irqdomain,
210 offset));
119f5e44
MD
211 irqs_handled++;
212 }
213
214 return irqs_handled ? IRQ_HANDLED : IRQ_NONE;
215}
216
119f5e44
MD
217static void gpio_rcar_config_general_input_output_mode(struct gpio_chip *chip,
218 unsigned int gpio,
219 bool output)
220{
c7b6f457 221 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
119f5e44
MD
222 unsigned long flags;
223
224 /* follow steps in the GPIO documentation for
225 * "Setting General Output Mode" and
226 * "Setting General Input Mode"
227 */
228
229 spin_lock_irqsave(&p->lock, flags);
230
231 /* Configure postive logic in POSNEG */
232 gpio_rcar_modify_bit(p, POSNEG, gpio, false);
233
234 /* Select "General Input/Output Mode" in IOINTSEL */
235 gpio_rcar_modify_bit(p, IOINTSEL, gpio, false);
236
237 /* Select Input Mode or Output Mode in INOUTSEL */
238 gpio_rcar_modify_bit(p, INOUTSEL, gpio, output);
239
240 spin_unlock_irqrestore(&p->lock, flags);
241}
242
dc3465a9
LP
243static int gpio_rcar_request(struct gpio_chip *chip, unsigned offset)
244{
2d65472b
GU
245 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
246 int error;
247
248 error = pm_runtime_get_sync(&p->pdev->dev);
249 if (error < 0)
250 return error;
251
252 error = pinctrl_request_gpio(chip->base + offset);
253 if (error)
254 pm_runtime_put(&p->pdev->dev);
255
256 return error;
dc3465a9
LP
257}
258
259static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset)
260{
2d65472b
GU
261 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
262
dc3465a9
LP
263 pinctrl_free_gpio(chip->base + offset);
264
ce0e2c60
LW
265 /*
266 * Set the GPIO as an input to ensure that the next GPIO request won't
dc3465a9
LP
267 * drive the GPIO pin as an output.
268 */
269 gpio_rcar_config_general_input_output_mode(chip, offset, false);
2d65472b
GU
270
271 pm_runtime_put(&p->pdev->dev);
dc3465a9
LP
272}
273
119f5e44
MD
274static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset)
275{
276 gpio_rcar_config_general_input_output_mode(chip, offset, false);
277 return 0;
278}
279
280static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset)
281{
ae9550f6
MD
282 u32 bit = BIT(offset);
283
284 /* testing on r8a7790 shows that INDT does not show correct pin state
285 * when configured as output, so use OUTDT in case of output pins */
c7b6f457
LW
286 if (gpio_rcar_read(gpiochip_get_data(chip), INOUTSEL) & bit)
287 return !!(gpio_rcar_read(gpiochip_get_data(chip), OUTDT) & bit);
ae9550f6 288 else
c7b6f457 289 return !!(gpio_rcar_read(gpiochip_get_data(chip), INDT) & bit);
119f5e44
MD
290}
291
292static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value)
293{
c7b6f457 294 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
119f5e44
MD
295 unsigned long flags;
296
297 spin_lock_irqsave(&p->lock, flags);
298 gpio_rcar_modify_bit(p, OUTDT, offset, value);
299 spin_unlock_irqrestore(&p->lock, flags);
300}
301
dbb763b8
GU
302static void gpio_rcar_set_multiple(struct gpio_chip *chip, unsigned long *mask,
303 unsigned long *bits)
304{
305 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
306 unsigned long flags;
307 u32 val, bankmask;
308
309 bankmask = mask[0] & GENMASK(chip->ngpio - 1, 0);
310 if (!bankmask)
311 return;
312
313 spin_lock_irqsave(&p->lock, flags);
314 val = gpio_rcar_read(p, OUTDT);
315 val &= ~bankmask;
316 val |= (bankmask & bits[0]);
317 gpio_rcar_write(p, OUTDT, val);
318 spin_unlock_irqrestore(&p->lock, flags);
319}
320
119f5e44
MD
321static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset,
322 int value)
323{
324 /* write GPIO value to output before selecting output mode of pin */
325 gpio_rcar_set(chip, offset, value);
326 gpio_rcar_config_general_input_output_mode(chip, offset, true);
327 return 0;
328}
329
850dfe17
LP
330struct gpio_rcar_info {
331 bool has_both_edge_trigger;
e1fef9e2 332 bool needs_clk;
850dfe17
LP
333};
334
1fd2b49d
HN
335static const struct gpio_rcar_info gpio_rcar_info_gen1 = {
336 .has_both_edge_trigger = false,
e1fef9e2 337 .needs_clk = false,
1fd2b49d
HN
338};
339
340static const struct gpio_rcar_info gpio_rcar_info_gen2 = {
341 .has_both_edge_trigger = true,
e1fef9e2 342 .needs_clk = true,
1fd2b49d
HN
343};
344
850dfe17
LP
345static const struct of_device_id gpio_rcar_of_table[] = {
346 {
347 .compatible = "renesas,gpio-r8a7790",
1fd2b49d 348 .data = &gpio_rcar_info_gen2,
850dfe17
LP
349 }, {
350 .compatible = "renesas,gpio-r8a7791",
1fd2b49d 351 .data = &gpio_rcar_info_gen2,
e79c5830
SS
352 }, {
353 .compatible = "renesas,gpio-r8a7792",
354 .data = &gpio_rcar_info_gen2,
1fd2b49d
HN
355 }, {
356 .compatible = "renesas,gpio-r8a7793",
357 .data = &gpio_rcar_info_gen2,
358 }, {
359 .compatible = "renesas,gpio-r8a7794",
360 .data = &gpio_rcar_info_gen2,
8cd14702
UH
361 }, {
362 .compatible = "renesas,gpio-r8a7795",
363 /* Gen3 GPIO is identical to Gen2. */
364 .data = &gpio_rcar_info_gen2,
5d2f1d6e
SH
365 }, {
366 .compatible = "renesas,gpio-r8a7796",
367 /* Gen3 GPIO is identical to Gen2. */
368 .data = &gpio_rcar_info_gen2,
850dfe17
LP
369 }, {
370 .compatible = "renesas,gpio-rcar",
1fd2b49d 371 .data = &gpio_rcar_info_gen1,
850dfe17
LP
372 }, {
373 /* Terminator */
374 },
375};
376
377MODULE_DEVICE_TABLE(of, gpio_rcar_of_table);
378
8b092be9 379static int gpio_rcar_parse_dt(struct gpio_rcar_priv *p, unsigned int *npins)
159f8a02 380{
159f8a02 381 struct device_node *np = p->pdev->dev.of_node;
8b092be9
GU
382 const struct of_device_id *match;
383 const struct gpio_rcar_info *info;
159f8a02
LP
384 struct of_phandle_args args;
385 int ret;
159f8a02 386
8b092be9
GU
387 match = of_match_node(gpio_rcar_of_table, np);
388 if (!match)
389 return -EINVAL;
850dfe17 390
8b092be9 391 info = match->data;
850dfe17 392
8b092be9
GU
393 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0, &args);
394 *npins = ret == 0 ? args.args[2] : RCAR_MAX_GPIO_PER_BANK;
395 p->has_both_edge_trigger = info->has_both_edge_trigger;
e1fef9e2 396 p->needs_clk = info->needs_clk;
850dfe17 397
8b092be9 398 if (*npins == 0 || *npins > RCAR_MAX_GPIO_PER_BANK) {
159f8a02 399 dev_warn(&p->pdev->dev,
8b092be9
GU
400 "Invalid number of gpio lines %u, using %u\n", *npins,
401 RCAR_MAX_GPIO_PER_BANK);
402 *npins = RCAR_MAX_GPIO_PER_BANK;
159f8a02 403 }
850dfe17
LP
404
405 return 0;
159f8a02
LP
406}
407
119f5e44
MD
408static int gpio_rcar_probe(struct platform_device *pdev)
409{
119f5e44
MD
410 struct gpio_rcar_priv *p;
411 struct resource *io, *irq;
412 struct gpio_chip *gpio_chip;
413 struct irq_chip *irq_chip;
b22978fc
GU
414 struct device *dev = &pdev->dev;
415 const char *name = dev_name(dev);
8b092be9 416 unsigned int npins;
119f5e44
MD
417 int ret;
418
b22978fc 419 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
7d82bf34
GU
420 if (!p)
421 return -ENOMEM;
119f5e44 422
119f5e44 423 p->pdev = pdev;
119f5e44
MD
424 spin_lock_init(&p->lock);
425
8b092be9
GU
426 /* Get device configuration from DT node */
427 ret = gpio_rcar_parse_dt(p, &npins);
850dfe17
LP
428 if (ret < 0)
429 return ret;
159f8a02
LP
430
431 platform_set_drvdata(pdev, p);
432
ab82fa7d
GU
433 p->clk = devm_clk_get(dev, NULL);
434 if (IS_ERR(p->clk)) {
e1fef9e2
GU
435 if (p->needs_clk) {
436 dev_err(dev, "unable to get clock\n");
437 ret = PTR_ERR(p->clk);
438 goto err0;
439 }
ab82fa7d
GU
440 p->clk = NULL;
441 }
442
df0c6c80 443 pm_runtime_enable(dev);
df0c6c80 444
119f5e44
MD
445 io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
446 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
447
448 if (!io || !irq) {
b22978fc 449 dev_err(dev, "missing IRQ or IOMEM\n");
119f5e44
MD
450 ret = -EINVAL;
451 goto err0;
452 }
453
b22978fc 454 p->base = devm_ioremap_nocache(dev, io->start, resource_size(io));
119f5e44 455 if (!p->base) {
b22978fc 456 dev_err(dev, "failed to remap I/O memory\n");
119f5e44
MD
457 ret = -ENXIO;
458 goto err0;
459 }
460
461 gpio_chip = &p->gpio_chip;
dc3465a9
LP
462 gpio_chip->request = gpio_rcar_request;
463 gpio_chip->free = gpio_rcar_free;
119f5e44
MD
464 gpio_chip->direction_input = gpio_rcar_direction_input;
465 gpio_chip->get = gpio_rcar_get;
466 gpio_chip->direction_output = gpio_rcar_direction_output;
467 gpio_chip->set = gpio_rcar_set;
dbb763b8 468 gpio_chip->set_multiple = gpio_rcar_set_multiple;
119f5e44 469 gpio_chip->label = name;
58383c78 470 gpio_chip->parent = dev;
119f5e44 471 gpio_chip->owner = THIS_MODULE;
8b092be9
GU
472 gpio_chip->base = -1;
473 gpio_chip->ngpio = npins;
119f5e44
MD
474
475 irq_chip = &p->irq_chip;
476 irq_chip->name = name;
47bd38a3 477 irq_chip->parent_device = dev;
119f5e44
MD
478 irq_chip->irq_mask = gpio_rcar_irq_disable;
479 irq_chip->irq_unmask = gpio_rcar_irq_enable;
119f5e44 480 irq_chip->irq_set_type = gpio_rcar_irq_set_type;
ab82fa7d
GU
481 irq_chip->irq_set_wake = gpio_rcar_irq_set_wake;
482 irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND;
119f5e44 483
c7b6f457 484 ret = gpiochip_add_data(gpio_chip, p);
c7f3c5d3
GU
485 if (ret) {
486 dev_err(dev, "failed to add GPIO controller\n");
0c8aab8e 487 goto err0;
119f5e44
MD
488 }
489
8b092be9
GU
490 ret = gpiochip_irqchip_add(gpio_chip, irq_chip, 0, handle_level_irq,
491 IRQ_TYPE_NONE);
c7f3c5d3
GU
492 if (ret) {
493 dev_err(dev, "cannot add irqchip\n");
494 goto err1;
495 }
496
ab82fa7d 497 p->irq_parent = irq->start;
b22978fc
GU
498 if (devm_request_irq(dev, irq->start, gpio_rcar_irq_handler,
499 IRQF_SHARED, name, p)) {
500 dev_err(dev, "failed to request IRQ\n");
119f5e44
MD
501 ret = -ENOENT;
502 goto err1;
503 }
504
8b092be9 505 dev_info(dev, "driving %d GPIOs\n", npins);
dc3465a9 506
119f5e44
MD
507 return 0;
508
509err1:
4d84b9e4 510 gpiochip_remove(gpio_chip);
119f5e44 511err0:
df0c6c80 512 pm_runtime_disable(dev);
119f5e44
MD
513 return ret;
514}
515
516static int gpio_rcar_remove(struct platform_device *pdev)
517{
518 struct gpio_rcar_priv *p = platform_get_drvdata(pdev);
119f5e44 519
9f5132ae 520 gpiochip_remove(&p->gpio_chip);
119f5e44 521
df0c6c80 522 pm_runtime_disable(&pdev->dev);
119f5e44
MD
523 return 0;
524}
525
526static struct platform_driver gpio_rcar_device_driver = {
527 .probe = gpio_rcar_probe,
528 .remove = gpio_rcar_remove,
529 .driver = {
530 .name = "gpio_rcar",
159f8a02 531 .of_match_table = of_match_ptr(gpio_rcar_of_table),
119f5e44
MD
532 }
533};
534
535module_platform_driver(gpio_rcar_device_driver);
536
537MODULE_AUTHOR("Magnus Damm");
538MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
539MODULE_LICENSE("GPL v2");