gpio: rc5t583: use gpiochip data pointer
[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
GU
86 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
87 struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
88 gpio_chip);
119f5e44
MD
89
90 gpio_rcar_write(p, INTMSK, ~BIT(irqd_to_hwirq(d)));
91}
92
93static void gpio_rcar_irq_enable(struct irq_data *d)
94{
c7f3c5d3
GU
95 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
96 struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
97 gpio_chip);
119f5e44
MD
98
99 gpio_rcar_write(p, MSKCLR, BIT(irqd_to_hwirq(d)));
100}
101
102static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv *p,
103 unsigned int hwirq,
104 bool active_high_rising_edge,
7e1092b5
SH
105 bool level_trigger,
106 bool both)
119f5e44
MD
107{
108 unsigned long flags;
109
110 /* follow steps in the GPIO documentation for
111 * "Setting Edge-Sensitive Interrupt Input Mode" and
112 * "Setting Level-Sensitive Interrupt Input Mode"
113 */
114
115 spin_lock_irqsave(&p->lock, flags);
116
117 /* Configure postive or negative logic in POSNEG */
118 gpio_rcar_modify_bit(p, POSNEG, hwirq, !active_high_rising_edge);
119
120 /* Configure edge or level trigger in EDGLEVEL */
121 gpio_rcar_modify_bit(p, EDGLEVEL, hwirq, !level_trigger);
122
7e1092b5 123 /* Select one edge or both edges in BOTHEDGE */
8b092be9 124 if (p->has_both_edge_trigger)
7e1092b5
SH
125 gpio_rcar_modify_bit(p, BOTHEDGE, hwirq, both);
126
119f5e44
MD
127 /* Select "Interrupt Input Mode" in IOINTSEL */
128 gpio_rcar_modify_bit(p, IOINTSEL, hwirq, true);
129
130 /* Write INTCLR in case of edge trigger */
131 if (!level_trigger)
132 gpio_rcar_write(p, INTCLR, BIT(hwirq));
133
134 spin_unlock_irqrestore(&p->lock, flags);
135}
136
137static int gpio_rcar_irq_set_type(struct irq_data *d, unsigned int type)
138{
c7f3c5d3
GU
139 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
140 struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
141 gpio_chip);
119f5e44
MD
142 unsigned int hwirq = irqd_to_hwirq(d);
143
144 dev_dbg(&p->pdev->dev, "sense irq = %d, type = %d\n", hwirq, type);
145
146 switch (type & IRQ_TYPE_SENSE_MASK) {
147 case IRQ_TYPE_LEVEL_HIGH:
7e1092b5
SH
148 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, true,
149 false);
119f5e44
MD
150 break;
151 case IRQ_TYPE_LEVEL_LOW:
7e1092b5
SH
152 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, true,
153 false);
119f5e44
MD
154 break;
155 case IRQ_TYPE_EDGE_RISING:
7e1092b5
SH
156 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
157 false);
119f5e44
MD
158 break;
159 case IRQ_TYPE_EDGE_FALLING:
7e1092b5
SH
160 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, false,
161 false);
162 break;
163 case IRQ_TYPE_EDGE_BOTH:
8b092be9 164 if (!p->has_both_edge_trigger)
7e1092b5
SH
165 return -EINVAL;
166 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
167 true);
119f5e44
MD
168 break;
169 default:
170 return -EINVAL;
171 }
172 return 0;
173}
174
ab82fa7d
GU
175static int gpio_rcar_irq_set_wake(struct irq_data *d, unsigned int on)
176{
177 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
178 struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
179 gpio_chip);
501ef0f9
GU
180 int error;
181
182 if (p->irq_parent) {
183 error = irq_set_irq_wake(p->irq_parent, on);
184 if (error) {
185 dev_dbg(&p->pdev->dev,
186 "irq %u doesn't support irq_set_wake\n",
187 p->irq_parent);
188 p->irq_parent = 0;
189 }
190 }
ab82fa7d
GU
191
192 if (!p->clk)
193 return 0;
194
195 if (on)
196 clk_enable(p->clk);
197 else
198 clk_disable(p->clk);
199
200 return 0;
201}
202
119f5e44
MD
203static irqreturn_t gpio_rcar_irq_handler(int irq, void *dev_id)
204{
205 struct gpio_rcar_priv *p = dev_id;
206 u32 pending;
207 unsigned int offset, irqs_handled = 0;
208
8808b64d
VB
209 while ((pending = gpio_rcar_read(p, INTDT) &
210 gpio_rcar_read(p, INTMSK))) {
119f5e44
MD
211 offset = __ffs(pending);
212 gpio_rcar_write(p, INTCLR, BIT(offset));
c7f3c5d3
GU
213 generic_handle_irq(irq_find_mapping(p->gpio_chip.irqdomain,
214 offset));
119f5e44
MD
215 irqs_handled++;
216 }
217
218 return irqs_handled ? IRQ_HANDLED : IRQ_NONE;
219}
220
221static inline struct gpio_rcar_priv *gpio_to_priv(struct gpio_chip *chip)
222{
223 return container_of(chip, struct gpio_rcar_priv, gpio_chip);
224}
225
226static void gpio_rcar_config_general_input_output_mode(struct gpio_chip *chip,
227 unsigned int gpio,
228 bool output)
229{
230 struct gpio_rcar_priv *p = gpio_to_priv(chip);
231 unsigned long flags;
232
233 /* follow steps in the GPIO documentation for
234 * "Setting General Output Mode" and
235 * "Setting General Input Mode"
236 */
237
238 spin_lock_irqsave(&p->lock, flags);
239
240 /* Configure postive logic in POSNEG */
241 gpio_rcar_modify_bit(p, POSNEG, gpio, false);
242
243 /* Select "General Input/Output Mode" in IOINTSEL */
244 gpio_rcar_modify_bit(p, IOINTSEL, gpio, false);
245
246 /* Select Input Mode or Output Mode in INOUTSEL */
247 gpio_rcar_modify_bit(p, INOUTSEL, gpio, output);
248
249 spin_unlock_irqrestore(&p->lock, flags);
250}
251
dc3465a9
LP
252static int gpio_rcar_request(struct gpio_chip *chip, unsigned offset)
253{
65194cb1
GU
254 struct gpio_rcar_priv *p = gpio_to_priv(chip);
255 int error;
256
257 error = pm_runtime_get_sync(&p->pdev->dev);
258 if (error < 0)
259 return error;
260
261 error = pinctrl_request_gpio(chip->base + offset);
262 if (error)
263 pm_runtime_put(&p->pdev->dev);
264
265 return error;
dc3465a9
LP
266}
267
268static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset)
269{
65194cb1
GU
270 struct gpio_rcar_priv *p = gpio_to_priv(chip);
271
dc3465a9
LP
272 pinctrl_free_gpio(chip->base + offset);
273
274 /* Set the GPIO as an input to ensure that the next GPIO request won't
275 * drive the GPIO pin as an output.
276 */
277 gpio_rcar_config_general_input_output_mode(chip, offset, false);
65194cb1
GU
278
279 pm_runtime_put(&p->pdev->dev);
dc3465a9
LP
280}
281
119f5e44
MD
282static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset)
283{
284 gpio_rcar_config_general_input_output_mode(chip, offset, false);
285 return 0;
286}
287
288static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset)
289{
ae9550f6
MD
290 u32 bit = BIT(offset);
291
292 /* testing on r8a7790 shows that INDT does not show correct pin state
293 * when configured as output, so use OUTDT in case of output pins */
294 if (gpio_rcar_read(gpio_to_priv(chip), INOUTSEL) & bit)
7cb5409b 295 return !!(gpio_rcar_read(gpio_to_priv(chip), OUTDT) & bit);
ae9550f6 296 else
7cb5409b 297 return !!(gpio_rcar_read(gpio_to_priv(chip), INDT) & bit);
119f5e44
MD
298}
299
300static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value)
301{
302 struct gpio_rcar_priv *p = gpio_to_priv(chip);
303 unsigned long flags;
304
305 spin_lock_irqsave(&p->lock, flags);
306 gpio_rcar_modify_bit(p, OUTDT, offset, value);
307 spin_unlock_irqrestore(&p->lock, flags);
308}
309
310static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset,
311 int value)
312{
313 /* write GPIO value to output before selecting output mode of pin */
314 gpio_rcar_set(chip, offset, value);
315 gpio_rcar_config_general_input_output_mode(chip, offset, true);
316 return 0;
317}
318
850dfe17
LP
319struct gpio_rcar_info {
320 bool has_both_edge_trigger;
e1fef9e2 321 bool needs_clk;
850dfe17
LP
322};
323
1fd2b49d
HN
324static const struct gpio_rcar_info gpio_rcar_info_gen1 = {
325 .has_both_edge_trigger = false,
e1fef9e2 326 .needs_clk = false,
1fd2b49d
HN
327};
328
329static const struct gpio_rcar_info gpio_rcar_info_gen2 = {
330 .has_both_edge_trigger = true,
e1fef9e2 331 .needs_clk = true,
1fd2b49d
HN
332};
333
850dfe17
LP
334static const struct of_device_id gpio_rcar_of_table[] = {
335 {
336 .compatible = "renesas,gpio-r8a7790",
1fd2b49d 337 .data = &gpio_rcar_info_gen2,
850dfe17
LP
338 }, {
339 .compatible = "renesas,gpio-r8a7791",
1fd2b49d
HN
340 .data = &gpio_rcar_info_gen2,
341 }, {
342 .compatible = "renesas,gpio-r8a7793",
343 .data = &gpio_rcar_info_gen2,
344 }, {
345 .compatible = "renesas,gpio-r8a7794",
346 .data = &gpio_rcar_info_gen2,
8cd14702
UH
347 }, {
348 .compatible = "renesas,gpio-r8a7795",
349 /* Gen3 GPIO is identical to Gen2. */
350 .data = &gpio_rcar_info_gen2,
850dfe17
LP
351 }, {
352 .compatible = "renesas,gpio-rcar",
1fd2b49d 353 .data = &gpio_rcar_info_gen1,
850dfe17
LP
354 }, {
355 /* Terminator */
356 },
357};
358
359MODULE_DEVICE_TABLE(of, gpio_rcar_of_table);
360
8b092be9 361static int gpio_rcar_parse_dt(struct gpio_rcar_priv *p, unsigned int *npins)
159f8a02 362{
159f8a02 363 struct device_node *np = p->pdev->dev.of_node;
8b092be9
GU
364 const struct of_device_id *match;
365 const struct gpio_rcar_info *info;
159f8a02
LP
366 struct of_phandle_args args;
367 int ret;
159f8a02 368
8b092be9
GU
369 match = of_match_node(gpio_rcar_of_table, np);
370 if (!match)
371 return -EINVAL;
850dfe17 372
8b092be9 373 info = match->data;
850dfe17 374
8b092be9
GU
375 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0, &args);
376 *npins = ret == 0 ? args.args[2] : RCAR_MAX_GPIO_PER_BANK;
377 p->has_both_edge_trigger = info->has_both_edge_trigger;
e1fef9e2 378 p->needs_clk = info->needs_clk;
850dfe17 379
8b092be9 380 if (*npins == 0 || *npins > RCAR_MAX_GPIO_PER_BANK) {
159f8a02 381 dev_warn(&p->pdev->dev,
8b092be9
GU
382 "Invalid number of gpio lines %u, using %u\n", *npins,
383 RCAR_MAX_GPIO_PER_BANK);
384 *npins = RCAR_MAX_GPIO_PER_BANK;
159f8a02 385 }
850dfe17
LP
386
387 return 0;
159f8a02
LP
388}
389
119f5e44
MD
390static int gpio_rcar_probe(struct platform_device *pdev)
391{
119f5e44
MD
392 struct gpio_rcar_priv *p;
393 struct resource *io, *irq;
394 struct gpio_chip *gpio_chip;
395 struct irq_chip *irq_chip;
b22978fc
GU
396 struct device *dev = &pdev->dev;
397 const char *name = dev_name(dev);
8b092be9 398 unsigned int npins;
119f5e44
MD
399 int ret;
400
b22978fc 401 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
7d82bf34
GU
402 if (!p)
403 return -ENOMEM;
119f5e44 404
119f5e44 405 p->pdev = pdev;
119f5e44
MD
406 spin_lock_init(&p->lock);
407
8b092be9
GU
408 /* Get device configuration from DT node */
409 ret = gpio_rcar_parse_dt(p, &npins);
850dfe17
LP
410 if (ret < 0)
411 return ret;
159f8a02
LP
412
413 platform_set_drvdata(pdev, p);
414
ab82fa7d
GU
415 p->clk = devm_clk_get(dev, NULL);
416 if (IS_ERR(p->clk)) {
e1fef9e2
GU
417 if (p->needs_clk) {
418 dev_err(dev, "unable to get clock\n");
419 ret = PTR_ERR(p->clk);
420 goto err0;
421 }
ab82fa7d
GU
422 p->clk = NULL;
423 }
424
df0c6c80 425 pm_runtime_enable(dev);
df0c6c80 426
119f5e44
MD
427 io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
428 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
429
430 if (!io || !irq) {
b22978fc 431 dev_err(dev, "missing IRQ or IOMEM\n");
119f5e44
MD
432 ret = -EINVAL;
433 goto err0;
434 }
435
b22978fc 436 p->base = devm_ioremap_nocache(dev, io->start, resource_size(io));
119f5e44 437 if (!p->base) {
b22978fc 438 dev_err(dev, "failed to remap I/O memory\n");
119f5e44
MD
439 ret = -ENXIO;
440 goto err0;
441 }
442
443 gpio_chip = &p->gpio_chip;
dc3465a9
LP
444 gpio_chip->request = gpio_rcar_request;
445 gpio_chip->free = gpio_rcar_free;
119f5e44
MD
446 gpio_chip->direction_input = gpio_rcar_direction_input;
447 gpio_chip->get = gpio_rcar_get;
448 gpio_chip->direction_output = gpio_rcar_direction_output;
449 gpio_chip->set = gpio_rcar_set;
119f5e44 450 gpio_chip->label = name;
58383c78 451 gpio_chip->parent = dev;
119f5e44 452 gpio_chip->owner = THIS_MODULE;
8b092be9
GU
453 gpio_chip->base = -1;
454 gpio_chip->ngpio = npins;
119f5e44
MD
455
456 irq_chip = &p->irq_chip;
457 irq_chip->name = name;
458 irq_chip->irq_mask = gpio_rcar_irq_disable;
459 irq_chip->irq_unmask = gpio_rcar_irq_enable;
119f5e44 460 irq_chip->irq_set_type = gpio_rcar_irq_set_type;
ab82fa7d
GU
461 irq_chip->irq_set_wake = gpio_rcar_irq_set_wake;
462 irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND;
119f5e44 463
c7f3c5d3
GU
464 ret = gpiochip_add(gpio_chip);
465 if (ret) {
466 dev_err(dev, "failed to add GPIO controller\n");
0c8aab8e 467 goto err0;
119f5e44
MD
468 }
469
8b092be9
GU
470 ret = gpiochip_irqchip_add(gpio_chip, irq_chip, 0, handle_level_irq,
471 IRQ_TYPE_NONE);
c7f3c5d3
GU
472 if (ret) {
473 dev_err(dev, "cannot add irqchip\n");
474 goto err1;
475 }
476
ab82fa7d 477 p->irq_parent = irq->start;
b22978fc
GU
478 if (devm_request_irq(dev, irq->start, gpio_rcar_irq_handler,
479 IRQF_SHARED, name, p)) {
480 dev_err(dev, "failed to request IRQ\n");
119f5e44
MD
481 ret = -ENOENT;
482 goto err1;
483 }
484
8b092be9 485 dev_info(dev, "driving %d GPIOs\n", npins);
dc3465a9 486
119f5e44
MD
487 return 0;
488
489err1:
4d84b9e4 490 gpiochip_remove(gpio_chip);
119f5e44 491err0:
df0c6c80 492 pm_runtime_disable(dev);
119f5e44
MD
493 return ret;
494}
495
496static int gpio_rcar_remove(struct platform_device *pdev)
497{
498 struct gpio_rcar_priv *p = platform_get_drvdata(pdev);
119f5e44 499
9f5132ae 500 gpiochip_remove(&p->gpio_chip);
119f5e44 501
df0c6c80 502 pm_runtime_disable(&pdev->dev);
119f5e44
MD
503 return 0;
504}
505
506static struct platform_driver gpio_rcar_device_driver = {
507 .probe = gpio_rcar_probe,
508 .remove = gpio_rcar_remove,
509 .driver = {
510 .name = "gpio_rcar",
159f8a02 511 .of_match_table = of_match_ptr(gpio_rcar_of_table),
119f5e44
MD
512 }
513};
514
515module_platform_driver(gpio_rcar_device_driver);
516
517MODULE_AUTHOR("Magnus Damm");
518MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
519MODULE_LICENSE("GPL v2");