Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/j.anaszewski...
[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{
ce0e2c60 245 return pinctrl_request_gpio(chip->base + offset);
dc3465a9
LP
246}
247
248static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset)
249{
250 pinctrl_free_gpio(chip->base + offset);
251
ce0e2c60
LW
252 /*
253 * Set the GPIO as an input to ensure that the next GPIO request won't
dc3465a9
LP
254 * drive the GPIO pin as an output.
255 */
256 gpio_rcar_config_general_input_output_mode(chip, offset, false);
257}
258
119f5e44
MD
259static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset)
260{
261 gpio_rcar_config_general_input_output_mode(chip, offset, false);
262 return 0;
263}
264
265static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset)
266{
ae9550f6
MD
267 u32 bit = BIT(offset);
268
269 /* testing on r8a7790 shows that INDT does not show correct pin state
270 * when configured as output, so use OUTDT in case of output pins */
c7b6f457
LW
271 if (gpio_rcar_read(gpiochip_get_data(chip), INOUTSEL) & bit)
272 return !!(gpio_rcar_read(gpiochip_get_data(chip), OUTDT) & bit);
ae9550f6 273 else
c7b6f457 274 return !!(gpio_rcar_read(gpiochip_get_data(chip), INDT) & bit);
119f5e44
MD
275}
276
277static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value)
278{
c7b6f457 279 struct gpio_rcar_priv *p = gpiochip_get_data(chip);
119f5e44
MD
280 unsigned long flags;
281
282 spin_lock_irqsave(&p->lock, flags);
283 gpio_rcar_modify_bit(p, OUTDT, offset, value);
284 spin_unlock_irqrestore(&p->lock, flags);
285}
286
287static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset,
288 int value)
289{
290 /* write GPIO value to output before selecting output mode of pin */
291 gpio_rcar_set(chip, offset, value);
292 gpio_rcar_config_general_input_output_mode(chip, offset, true);
293 return 0;
294}
295
850dfe17
LP
296struct gpio_rcar_info {
297 bool has_both_edge_trigger;
e1fef9e2 298 bool needs_clk;
850dfe17
LP
299};
300
1fd2b49d
HN
301static const struct gpio_rcar_info gpio_rcar_info_gen1 = {
302 .has_both_edge_trigger = false,
e1fef9e2 303 .needs_clk = false,
1fd2b49d
HN
304};
305
306static const struct gpio_rcar_info gpio_rcar_info_gen2 = {
307 .has_both_edge_trigger = true,
e1fef9e2 308 .needs_clk = true,
1fd2b49d
HN
309};
310
850dfe17
LP
311static const struct of_device_id gpio_rcar_of_table[] = {
312 {
313 .compatible = "renesas,gpio-r8a7790",
1fd2b49d 314 .data = &gpio_rcar_info_gen2,
850dfe17
LP
315 }, {
316 .compatible = "renesas,gpio-r8a7791",
1fd2b49d
HN
317 .data = &gpio_rcar_info_gen2,
318 }, {
319 .compatible = "renesas,gpio-r8a7793",
320 .data = &gpio_rcar_info_gen2,
321 }, {
322 .compatible = "renesas,gpio-r8a7794",
323 .data = &gpio_rcar_info_gen2,
8cd14702
UH
324 }, {
325 .compatible = "renesas,gpio-r8a7795",
326 /* Gen3 GPIO is identical to Gen2. */
327 .data = &gpio_rcar_info_gen2,
850dfe17
LP
328 }, {
329 .compatible = "renesas,gpio-rcar",
1fd2b49d 330 .data = &gpio_rcar_info_gen1,
850dfe17
LP
331 }, {
332 /* Terminator */
333 },
334};
335
336MODULE_DEVICE_TABLE(of, gpio_rcar_of_table);
337
8b092be9 338static int gpio_rcar_parse_dt(struct gpio_rcar_priv *p, unsigned int *npins)
159f8a02 339{
159f8a02 340 struct device_node *np = p->pdev->dev.of_node;
8b092be9
GU
341 const struct of_device_id *match;
342 const struct gpio_rcar_info *info;
159f8a02
LP
343 struct of_phandle_args args;
344 int ret;
159f8a02 345
8b092be9
GU
346 match = of_match_node(gpio_rcar_of_table, np);
347 if (!match)
348 return -EINVAL;
850dfe17 349
8b092be9 350 info = match->data;
850dfe17 351
8b092be9
GU
352 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0, &args);
353 *npins = ret == 0 ? args.args[2] : RCAR_MAX_GPIO_PER_BANK;
354 p->has_both_edge_trigger = info->has_both_edge_trigger;
e1fef9e2 355 p->needs_clk = info->needs_clk;
850dfe17 356
8b092be9 357 if (*npins == 0 || *npins > RCAR_MAX_GPIO_PER_BANK) {
159f8a02 358 dev_warn(&p->pdev->dev,
8b092be9
GU
359 "Invalid number of gpio lines %u, using %u\n", *npins,
360 RCAR_MAX_GPIO_PER_BANK);
361 *npins = RCAR_MAX_GPIO_PER_BANK;
159f8a02 362 }
850dfe17
LP
363
364 return 0;
159f8a02
LP
365}
366
119f5e44
MD
367static int gpio_rcar_probe(struct platform_device *pdev)
368{
119f5e44
MD
369 struct gpio_rcar_priv *p;
370 struct resource *io, *irq;
371 struct gpio_chip *gpio_chip;
372 struct irq_chip *irq_chip;
b22978fc
GU
373 struct device *dev = &pdev->dev;
374 const char *name = dev_name(dev);
8b092be9 375 unsigned int npins;
119f5e44
MD
376 int ret;
377
b22978fc 378 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
7d82bf34
GU
379 if (!p)
380 return -ENOMEM;
119f5e44 381
119f5e44 382 p->pdev = pdev;
119f5e44
MD
383 spin_lock_init(&p->lock);
384
8b092be9
GU
385 /* Get device configuration from DT node */
386 ret = gpio_rcar_parse_dt(p, &npins);
850dfe17
LP
387 if (ret < 0)
388 return ret;
159f8a02
LP
389
390 platform_set_drvdata(pdev, p);
391
ab82fa7d
GU
392 p->clk = devm_clk_get(dev, NULL);
393 if (IS_ERR(p->clk)) {
e1fef9e2
GU
394 if (p->needs_clk) {
395 dev_err(dev, "unable to get clock\n");
396 ret = PTR_ERR(p->clk);
397 goto err0;
398 }
ab82fa7d
GU
399 p->clk = NULL;
400 }
401
df0c6c80 402 pm_runtime_enable(dev);
ce0e2c60 403 pm_runtime_get_sync(dev);
df0c6c80 404
119f5e44
MD
405 io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
406 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
407
408 if (!io || !irq) {
b22978fc 409 dev_err(dev, "missing IRQ or IOMEM\n");
119f5e44
MD
410 ret = -EINVAL;
411 goto err0;
412 }
413
b22978fc 414 p->base = devm_ioremap_nocache(dev, io->start, resource_size(io));
119f5e44 415 if (!p->base) {
b22978fc 416 dev_err(dev, "failed to remap I/O memory\n");
119f5e44
MD
417 ret = -ENXIO;
418 goto err0;
419 }
420
421 gpio_chip = &p->gpio_chip;
dc3465a9
LP
422 gpio_chip->request = gpio_rcar_request;
423 gpio_chip->free = gpio_rcar_free;
119f5e44
MD
424 gpio_chip->direction_input = gpio_rcar_direction_input;
425 gpio_chip->get = gpio_rcar_get;
426 gpio_chip->direction_output = gpio_rcar_direction_output;
427 gpio_chip->set = gpio_rcar_set;
119f5e44 428 gpio_chip->label = name;
58383c78 429 gpio_chip->parent = dev;
119f5e44 430 gpio_chip->owner = THIS_MODULE;
8b092be9
GU
431 gpio_chip->base = -1;
432 gpio_chip->ngpio = npins;
119f5e44
MD
433
434 irq_chip = &p->irq_chip;
435 irq_chip->name = name;
436 irq_chip->irq_mask = gpio_rcar_irq_disable;
437 irq_chip->irq_unmask = gpio_rcar_irq_enable;
119f5e44 438 irq_chip->irq_set_type = gpio_rcar_irq_set_type;
ab82fa7d
GU
439 irq_chip->irq_set_wake = gpio_rcar_irq_set_wake;
440 irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND;
119f5e44 441
c7b6f457 442 ret = gpiochip_add_data(gpio_chip, p);
c7f3c5d3
GU
443 if (ret) {
444 dev_err(dev, "failed to add GPIO controller\n");
0c8aab8e 445 goto err0;
119f5e44
MD
446 }
447
8b092be9
GU
448 ret = gpiochip_irqchip_add(gpio_chip, irq_chip, 0, handle_level_irq,
449 IRQ_TYPE_NONE);
c7f3c5d3
GU
450 if (ret) {
451 dev_err(dev, "cannot add irqchip\n");
452 goto err1;
453 }
454
ab82fa7d 455 p->irq_parent = irq->start;
b22978fc
GU
456 if (devm_request_irq(dev, irq->start, gpio_rcar_irq_handler,
457 IRQF_SHARED, name, p)) {
458 dev_err(dev, "failed to request IRQ\n");
119f5e44
MD
459 ret = -ENOENT;
460 goto err1;
461 }
462
8b092be9 463 dev_info(dev, "driving %d GPIOs\n", npins);
dc3465a9 464
119f5e44
MD
465 return 0;
466
467err1:
4d84b9e4 468 gpiochip_remove(gpio_chip);
119f5e44 469err0:
ce0e2c60 470 pm_runtime_put(dev);
df0c6c80 471 pm_runtime_disable(dev);
119f5e44
MD
472 return ret;
473}
474
475static int gpio_rcar_remove(struct platform_device *pdev)
476{
477 struct gpio_rcar_priv *p = platform_get_drvdata(pdev);
119f5e44 478
9f5132ae 479 gpiochip_remove(&p->gpio_chip);
119f5e44 480
ce0e2c60 481 pm_runtime_put(&pdev->dev);
df0c6c80 482 pm_runtime_disable(&pdev->dev);
119f5e44
MD
483 return 0;
484}
485
486static struct platform_driver gpio_rcar_device_driver = {
487 .probe = gpio_rcar_probe,
488 .remove = gpio_rcar_remove,
489 .driver = {
490 .name = "gpio_rcar",
159f8a02 491 .of_match_table = of_match_ptr(gpio_rcar_of_table),
119f5e44
MD
492 }
493};
494
495module_platform_driver(gpio_rcar_device_driver);
496
497MODULE_AUTHOR("Magnus Damm");
498MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
499MODULE_LICENSE("GPL v2");