gpio: gpio-mxc: simplify getting .driver_data
[linux-block.git] / drivers / gpio / gpio-omap.c
... / ...
CommitLineData
1/*
2 * Support functions for OMAP GPIO
3 *
4 * Copyright (C) 2003-2005 Nokia Corporation
5 * Written by Juha Yrjölä <juha.yrjola@nokia.com>
6 *
7 * Copyright (C) 2009 Texas Instruments
8 * Added OMAP4 support - Santosh Shilimkar <santosh.shilimkar@ti.com>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 */
14
15#include <linux/init.h>
16#include <linux/module.h>
17#include <linux/interrupt.h>
18#include <linux/syscore_ops.h>
19#include <linux/err.h>
20#include <linux/clk.h>
21#include <linux/io.h>
22#include <linux/cpu_pm.h>
23#include <linux/device.h>
24#include <linux/pm_runtime.h>
25#include <linux/pm.h>
26#include <linux/of.h>
27#include <linux/of_device.h>
28#include <linux/gpio/driver.h>
29#include <linux/bitops.h>
30#include <linux/platform_data/gpio-omap.h>
31
32#define OMAP4_GPIO_DEBOUNCINGTIME_MASK 0xFF
33
34#define OMAP_GPIO_QUIRK_IDLE_REMOVE_TRIGGER BIT(2)
35#define OMAP_GPIO_QUIRK_DEFERRED_WKUP_EN BIT(1)
36
37struct gpio_regs {
38 u32 irqenable1;
39 u32 irqenable2;
40 u32 wake_en;
41 u32 ctrl;
42 u32 oe;
43 u32 leveldetect0;
44 u32 leveldetect1;
45 u32 risingdetect;
46 u32 fallingdetect;
47 u32 dataout;
48 u32 debounce;
49 u32 debounce_en;
50};
51
52struct gpio_bank;
53
54struct gpio_omap_funcs {
55 void (*idle_enable_level_quirk)(struct gpio_bank *bank);
56 void (*idle_disable_level_quirk)(struct gpio_bank *bank);
57};
58
59struct gpio_bank {
60 struct list_head node;
61 void __iomem *base;
62 int irq;
63 u32 non_wakeup_gpios;
64 u32 enabled_non_wakeup_gpios;
65 struct gpio_regs context;
66 struct gpio_omap_funcs funcs;
67 u32 saved_datain;
68 u32 level_mask;
69 u32 toggle_mask;
70 raw_spinlock_t lock;
71 raw_spinlock_t wa_lock;
72 struct gpio_chip chip;
73 struct clk *dbck;
74 struct notifier_block nb;
75 unsigned int is_suspended:1;
76 u32 mod_usage;
77 u32 irq_usage;
78 u32 dbck_enable_mask;
79 bool dbck_enabled;
80 bool is_mpuio;
81 bool dbck_flag;
82 bool loses_context;
83 bool context_valid;
84 int stride;
85 u32 width;
86 int context_loss_count;
87 bool workaround_enabled;
88 u32 quirks;
89
90 void (*set_dataout)(struct gpio_bank *bank, unsigned gpio, int enable);
91 void (*set_dataout_multiple)(struct gpio_bank *bank,
92 unsigned long *mask, unsigned long *bits);
93 int (*get_context_loss_count)(struct device *dev);
94
95 struct omap_gpio_reg_offs *regs;
96};
97
98#define GPIO_MOD_CTRL_BIT BIT(0)
99
100#define BANK_USED(bank) (bank->mod_usage || bank->irq_usage)
101#define LINE_USED(line, offset) (line & (BIT(offset)))
102
103static void omap_gpio_unmask_irq(struct irq_data *d);
104
105static inline struct gpio_bank *omap_irq_data_get_bank(struct irq_data *d)
106{
107 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
108 return gpiochip_get_data(chip);
109}
110
111static void omap_set_gpio_direction(struct gpio_bank *bank, int gpio,
112 int is_input)
113{
114 void __iomem *reg = bank->base;
115 u32 l;
116
117 reg += bank->regs->direction;
118 l = readl_relaxed(reg);
119 if (is_input)
120 l |= BIT(gpio);
121 else
122 l &= ~(BIT(gpio));
123 writel_relaxed(l, reg);
124 bank->context.oe = l;
125}
126
127
128/* set data out value using dedicate set/clear register */
129static void omap_set_gpio_dataout_reg(struct gpio_bank *bank, unsigned offset,
130 int enable)
131{
132 void __iomem *reg = bank->base;
133 u32 l = BIT(offset);
134
135 if (enable) {
136 reg += bank->regs->set_dataout;
137 bank->context.dataout |= l;
138 } else {
139 reg += bank->regs->clr_dataout;
140 bank->context.dataout &= ~l;
141 }
142
143 writel_relaxed(l, reg);
144}
145
146/* set data out value using mask register */
147static void omap_set_gpio_dataout_mask(struct gpio_bank *bank, unsigned offset,
148 int enable)
149{
150 void __iomem *reg = bank->base + bank->regs->dataout;
151 u32 gpio_bit = BIT(offset);
152 u32 l;
153
154 l = readl_relaxed(reg);
155 if (enable)
156 l |= gpio_bit;
157 else
158 l &= ~gpio_bit;
159 writel_relaxed(l, reg);
160 bank->context.dataout = l;
161}
162
163static int omap_get_gpio_datain(struct gpio_bank *bank, int offset)
164{
165 void __iomem *reg = bank->base + bank->regs->datain;
166
167 return (readl_relaxed(reg) & (BIT(offset))) != 0;
168}
169
170static int omap_get_gpio_dataout(struct gpio_bank *bank, int offset)
171{
172 void __iomem *reg = bank->base + bank->regs->dataout;
173
174 return (readl_relaxed(reg) & (BIT(offset))) != 0;
175}
176
177/* set multiple data out values using dedicate set/clear register */
178static void omap_set_gpio_dataout_reg_multiple(struct gpio_bank *bank,
179 unsigned long *mask,
180 unsigned long *bits)
181{
182 void __iomem *reg = bank->base;
183 u32 l;
184
185 l = *bits & *mask;
186 writel_relaxed(l, reg + bank->regs->set_dataout);
187 bank->context.dataout |= l;
188
189 l = ~*bits & *mask;
190 writel_relaxed(l, reg + bank->regs->clr_dataout);
191 bank->context.dataout &= ~l;
192}
193
194/* set multiple data out values using mask register */
195static void omap_set_gpio_dataout_mask_multiple(struct gpio_bank *bank,
196 unsigned long *mask,
197 unsigned long *bits)
198{
199 void __iomem *reg = bank->base + bank->regs->dataout;
200 u32 l = (readl_relaxed(reg) & ~*mask) | (*bits & *mask);
201
202 writel_relaxed(l, reg);
203 bank->context.dataout = l;
204}
205
206static unsigned long omap_get_gpio_datain_multiple(struct gpio_bank *bank,
207 unsigned long *mask)
208{
209 void __iomem *reg = bank->base + bank->regs->datain;
210
211 return readl_relaxed(reg) & *mask;
212}
213
214static unsigned long omap_get_gpio_dataout_multiple(struct gpio_bank *bank,
215 unsigned long *mask)
216{
217 void __iomem *reg = bank->base + bank->regs->dataout;
218
219 return readl_relaxed(reg) & *mask;
220}
221
222static inline void omap_gpio_rmw(void __iomem *base, u32 reg, u32 mask, bool set)
223{
224 int l = readl_relaxed(base + reg);
225
226 if (set)
227 l |= mask;
228 else
229 l &= ~mask;
230
231 writel_relaxed(l, base + reg);
232}
233
234static inline void omap_gpio_dbck_enable(struct gpio_bank *bank)
235{
236 if (bank->dbck_enable_mask && !bank->dbck_enabled) {
237 clk_enable(bank->dbck);
238 bank->dbck_enabled = true;
239
240 writel_relaxed(bank->dbck_enable_mask,
241 bank->base + bank->regs->debounce_en);
242 }
243}
244
245static inline void omap_gpio_dbck_disable(struct gpio_bank *bank)
246{
247 if (bank->dbck_enable_mask && bank->dbck_enabled) {
248 /*
249 * Disable debounce before cutting it's clock. If debounce is
250 * enabled but the clock is not, GPIO module seems to be unable
251 * to detect events and generate interrupts at least on OMAP3.
252 */
253 writel_relaxed(0, bank->base + bank->regs->debounce_en);
254
255 clk_disable(bank->dbck);
256 bank->dbck_enabled = false;
257 }
258}
259
260/**
261 * omap2_set_gpio_debounce - low level gpio debounce time
262 * @bank: the gpio bank we're acting upon
263 * @offset: the gpio number on this @bank
264 * @debounce: debounce time to use
265 *
266 * OMAP's debounce time is in 31us steps
267 * <debounce time> = (GPIO_DEBOUNCINGTIME[7:0].DEBOUNCETIME + 1) x 31
268 * so we need to convert and round up to the closest unit.
269 *
270 * Return: 0 on success, negative error otherwise.
271 */
272static int omap2_set_gpio_debounce(struct gpio_bank *bank, unsigned offset,
273 unsigned debounce)
274{
275 void __iomem *reg;
276 u32 val;
277 u32 l;
278 bool enable = !!debounce;
279
280 if (!bank->dbck_flag)
281 return -ENOTSUPP;
282
283 if (enable) {
284 debounce = DIV_ROUND_UP(debounce, 31) - 1;
285 if ((debounce & OMAP4_GPIO_DEBOUNCINGTIME_MASK) != debounce)
286 return -EINVAL;
287 }
288
289 l = BIT(offset);
290
291 clk_enable(bank->dbck);
292 reg = bank->base + bank->regs->debounce;
293 writel_relaxed(debounce, reg);
294
295 reg = bank->base + bank->regs->debounce_en;
296 val = readl_relaxed(reg);
297
298 if (enable)
299 val |= l;
300 else
301 val &= ~l;
302 bank->dbck_enable_mask = val;
303
304 writel_relaxed(val, reg);
305 clk_disable(bank->dbck);
306 /*
307 * Enable debounce clock per module.
308 * This call is mandatory because in omap_gpio_request() when
309 * *_runtime_get_sync() is called, _gpio_dbck_enable() within
310 * runtime callbck fails to turn on dbck because dbck_enable_mask
311 * used within _gpio_dbck_enable() is still not initialized at
312 * that point. Therefore we have to enable dbck here.
313 */
314 omap_gpio_dbck_enable(bank);
315 if (bank->dbck_enable_mask) {
316 bank->context.debounce = debounce;
317 bank->context.debounce_en = val;
318 }
319
320 return 0;
321}
322
323/**
324 * omap_clear_gpio_debounce - clear debounce settings for a gpio
325 * @bank: the gpio bank we're acting upon
326 * @offset: the gpio number on this @bank
327 *
328 * If a gpio is using debounce, then clear the debounce enable bit and if
329 * this is the only gpio in this bank using debounce, then clear the debounce
330 * time too. The debounce clock will also be disabled when calling this function
331 * if this is the only gpio in the bank using debounce.
332 */
333static void omap_clear_gpio_debounce(struct gpio_bank *bank, unsigned offset)
334{
335 u32 gpio_bit = BIT(offset);
336
337 if (!bank->dbck_flag)
338 return;
339
340 if (!(bank->dbck_enable_mask & gpio_bit))
341 return;
342
343 bank->dbck_enable_mask &= ~gpio_bit;
344 bank->context.debounce_en &= ~gpio_bit;
345 writel_relaxed(bank->context.debounce_en,
346 bank->base + bank->regs->debounce_en);
347
348 if (!bank->dbck_enable_mask) {
349 bank->context.debounce = 0;
350 writel_relaxed(bank->context.debounce, bank->base +
351 bank->regs->debounce);
352 clk_disable(bank->dbck);
353 bank->dbck_enabled = false;
354 }
355}
356
357static inline void omap_set_gpio_trigger(struct gpio_bank *bank, int gpio,
358 unsigned trigger)
359{
360 void __iomem *base = bank->base;
361 u32 gpio_bit = BIT(gpio);
362
363 omap_gpio_rmw(base, bank->regs->leveldetect0, gpio_bit,
364 trigger & IRQ_TYPE_LEVEL_LOW);
365 omap_gpio_rmw(base, bank->regs->leveldetect1, gpio_bit,
366 trigger & IRQ_TYPE_LEVEL_HIGH);
367 omap_gpio_rmw(base, bank->regs->risingdetect, gpio_bit,
368 trigger & IRQ_TYPE_EDGE_RISING);
369 omap_gpio_rmw(base, bank->regs->fallingdetect, gpio_bit,
370 trigger & IRQ_TYPE_EDGE_FALLING);
371
372 bank->context.leveldetect0 =
373 readl_relaxed(bank->base + bank->regs->leveldetect0);
374 bank->context.leveldetect1 =
375 readl_relaxed(bank->base + bank->regs->leveldetect1);
376 bank->context.risingdetect =
377 readl_relaxed(bank->base + bank->regs->risingdetect);
378 bank->context.fallingdetect =
379 readl_relaxed(bank->base + bank->regs->fallingdetect);
380
381 if (likely(!(bank->non_wakeup_gpios & gpio_bit))) {
382 /* Defer wkup_en register update until we idle? */
383 if (bank->quirks & OMAP_GPIO_QUIRK_DEFERRED_WKUP_EN) {
384 if (trigger)
385 bank->context.wake_en |= gpio_bit;
386 else
387 bank->context.wake_en &= ~gpio_bit;
388 } else {
389 omap_gpio_rmw(base, bank->regs->wkup_en, gpio_bit,
390 trigger != 0);
391 bank->context.wake_en =
392 readl_relaxed(bank->base + bank->regs->wkup_en);
393 }
394 }
395
396 /* This part needs to be executed always for OMAP{34xx, 44xx} */
397 if (!bank->regs->irqctrl) {
398 /* On omap24xx proceed only when valid GPIO bit is set */
399 if (bank->non_wakeup_gpios) {
400 if (!(bank->non_wakeup_gpios & gpio_bit))
401 goto exit;
402 }
403
404 /*
405 * Log the edge gpio and manually trigger the IRQ
406 * after resume if the input level changes
407 * to avoid irq lost during PER RET/OFF mode
408 * Applies for omap2 non-wakeup gpio and all omap3 gpios
409 */
410 if (trigger & IRQ_TYPE_EDGE_BOTH)
411 bank->enabled_non_wakeup_gpios |= gpio_bit;
412 else
413 bank->enabled_non_wakeup_gpios &= ~gpio_bit;
414 }
415
416exit:
417 bank->level_mask =
418 readl_relaxed(bank->base + bank->regs->leveldetect0) |
419 readl_relaxed(bank->base + bank->regs->leveldetect1);
420}
421
422#ifdef CONFIG_ARCH_OMAP1
423/*
424 * This only applies to chips that can't do both rising and falling edge
425 * detection at once. For all other chips, this function is a noop.
426 */
427static void omap_toggle_gpio_edge_triggering(struct gpio_bank *bank, int gpio)
428{
429 void __iomem *reg = bank->base;
430 u32 l = 0;
431
432 if (!bank->regs->irqctrl)
433 return;
434
435 reg += bank->regs->irqctrl;
436
437 l = readl_relaxed(reg);
438 if ((l >> gpio) & 1)
439 l &= ~(BIT(gpio));
440 else
441 l |= BIT(gpio);
442
443 writel_relaxed(l, reg);
444}
445#else
446static void omap_toggle_gpio_edge_triggering(struct gpio_bank *bank, int gpio) {}
447#endif
448
449static int omap_set_gpio_triggering(struct gpio_bank *bank, int gpio,
450 unsigned trigger)
451{
452 void __iomem *reg = bank->base;
453 void __iomem *base = bank->base;
454 u32 l = 0;
455
456 if (bank->regs->leveldetect0 && bank->regs->wkup_en) {
457 omap_set_gpio_trigger(bank, gpio, trigger);
458 } else if (bank->regs->irqctrl) {
459 reg += bank->regs->irqctrl;
460
461 l = readl_relaxed(reg);
462 if ((trigger & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH)
463 bank->toggle_mask |= BIT(gpio);
464 if (trigger & IRQ_TYPE_EDGE_RISING)
465 l |= BIT(gpio);
466 else if (trigger & IRQ_TYPE_EDGE_FALLING)
467 l &= ~(BIT(gpio));
468 else
469 return -EINVAL;
470
471 writel_relaxed(l, reg);
472 } else if (bank->regs->edgectrl1) {
473 if (gpio & 0x08)
474 reg += bank->regs->edgectrl2;
475 else
476 reg += bank->regs->edgectrl1;
477
478 gpio &= 0x07;
479 l = readl_relaxed(reg);
480 l &= ~(3 << (gpio << 1));
481 if (trigger & IRQ_TYPE_EDGE_RISING)
482 l |= 2 << (gpio << 1);
483 if (trigger & IRQ_TYPE_EDGE_FALLING)
484 l |= BIT(gpio << 1);
485
486 /* Enable wake-up during idle for dynamic tick */
487 omap_gpio_rmw(base, bank->regs->wkup_en, BIT(gpio), trigger);
488 bank->context.wake_en =
489 readl_relaxed(bank->base + bank->regs->wkup_en);
490 writel_relaxed(l, reg);
491 }
492 return 0;
493}
494
495static void omap_enable_gpio_module(struct gpio_bank *bank, unsigned offset)
496{
497 if (bank->regs->pinctrl) {
498 void __iomem *reg = bank->base + bank->regs->pinctrl;
499
500 /* Claim the pin for MPU */
501 writel_relaxed(readl_relaxed(reg) | (BIT(offset)), reg);
502 }
503
504 if (bank->regs->ctrl && !BANK_USED(bank)) {
505 void __iomem *reg = bank->base + bank->regs->ctrl;
506 u32 ctrl;
507
508 ctrl = readl_relaxed(reg);
509 /* Module is enabled, clocks are not gated */
510 ctrl &= ~GPIO_MOD_CTRL_BIT;
511 writel_relaxed(ctrl, reg);
512 bank->context.ctrl = ctrl;
513 }
514}
515
516static void omap_disable_gpio_module(struct gpio_bank *bank, unsigned offset)
517{
518 void __iomem *base = bank->base;
519
520 if (bank->regs->wkup_en &&
521 !LINE_USED(bank->mod_usage, offset) &&
522 !LINE_USED(bank->irq_usage, offset)) {
523 /* Disable wake-up during idle for dynamic tick */
524 omap_gpio_rmw(base, bank->regs->wkup_en, BIT(offset), 0);
525 bank->context.wake_en =
526 readl_relaxed(bank->base + bank->regs->wkup_en);
527 }
528
529 if (bank->regs->ctrl && !BANK_USED(bank)) {
530 void __iomem *reg = bank->base + bank->regs->ctrl;
531 u32 ctrl;
532
533 ctrl = readl_relaxed(reg);
534 /* Module is disabled, clocks are gated */
535 ctrl |= GPIO_MOD_CTRL_BIT;
536 writel_relaxed(ctrl, reg);
537 bank->context.ctrl = ctrl;
538 }
539}
540
541static int omap_gpio_is_input(struct gpio_bank *bank, unsigned offset)
542{
543 void __iomem *reg = bank->base + bank->regs->direction;
544
545 return readl_relaxed(reg) & BIT(offset);
546}
547
548static void omap_gpio_init_irq(struct gpio_bank *bank, unsigned offset)
549{
550 if (!LINE_USED(bank->mod_usage, offset)) {
551 omap_enable_gpio_module(bank, offset);
552 omap_set_gpio_direction(bank, offset, 1);
553 }
554 bank->irq_usage |= BIT(offset);
555}
556
557static int omap_gpio_irq_type(struct irq_data *d, unsigned type)
558{
559 struct gpio_bank *bank = omap_irq_data_get_bank(d);
560 int retval;
561 unsigned long flags;
562 unsigned offset = d->hwirq;
563
564 if (type & ~IRQ_TYPE_SENSE_MASK)
565 return -EINVAL;
566
567 if (!bank->regs->leveldetect0 &&
568 (type & (IRQ_TYPE_LEVEL_LOW|IRQ_TYPE_LEVEL_HIGH)))
569 return -EINVAL;
570
571 raw_spin_lock_irqsave(&bank->lock, flags);
572 retval = omap_set_gpio_triggering(bank, offset, type);
573 if (retval) {
574 raw_spin_unlock_irqrestore(&bank->lock, flags);
575 goto error;
576 }
577 omap_gpio_init_irq(bank, offset);
578 if (!omap_gpio_is_input(bank, offset)) {
579 raw_spin_unlock_irqrestore(&bank->lock, flags);
580 retval = -EINVAL;
581 goto error;
582 }
583 raw_spin_unlock_irqrestore(&bank->lock, flags);
584
585 if (type & (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH))
586 irq_set_handler_locked(d, handle_level_irq);
587 else if (type & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
588 /*
589 * Edge IRQs are already cleared/acked in irq_handler and
590 * not need to be masked, as result handle_edge_irq()
591 * logic is excessed here and may cause lose of interrupts.
592 * So just use handle_simple_irq.
593 */
594 irq_set_handler_locked(d, handle_simple_irq);
595
596 return 0;
597
598error:
599 return retval;
600}
601
602static void omap_clear_gpio_irqbank(struct gpio_bank *bank, int gpio_mask)
603{
604 void __iomem *reg = bank->base;
605
606 reg += bank->regs->irqstatus;
607 writel_relaxed(gpio_mask, reg);
608
609 /* Workaround for clearing DSP GPIO interrupts to allow retention */
610 if (bank->regs->irqstatus2) {
611 reg = bank->base + bank->regs->irqstatus2;
612 writel_relaxed(gpio_mask, reg);
613 }
614
615 /* Flush posted write for the irq status to avoid spurious interrupts */
616 readl_relaxed(reg);
617}
618
619static inline void omap_clear_gpio_irqstatus(struct gpio_bank *bank,
620 unsigned offset)
621{
622 omap_clear_gpio_irqbank(bank, BIT(offset));
623}
624
625static u32 omap_get_gpio_irqbank_mask(struct gpio_bank *bank)
626{
627 void __iomem *reg = bank->base;
628 u32 l;
629 u32 mask = (BIT(bank->width)) - 1;
630
631 reg += bank->regs->irqenable;
632 l = readl_relaxed(reg);
633 if (bank->regs->irqenable_inv)
634 l = ~l;
635 l &= mask;
636 return l;
637}
638
639static void omap_enable_gpio_irqbank(struct gpio_bank *bank, int gpio_mask)
640{
641 void __iomem *reg = bank->base;
642 u32 l;
643
644 if (bank->regs->set_irqenable) {
645 reg += bank->regs->set_irqenable;
646 l = gpio_mask;
647 bank->context.irqenable1 |= gpio_mask;
648 } else {
649 reg += bank->regs->irqenable;
650 l = readl_relaxed(reg);
651 if (bank->regs->irqenable_inv)
652 l &= ~gpio_mask;
653 else
654 l |= gpio_mask;
655 bank->context.irqenable1 = l;
656 }
657
658 writel_relaxed(l, reg);
659}
660
661static void omap_disable_gpio_irqbank(struct gpio_bank *bank, int gpio_mask)
662{
663 void __iomem *reg = bank->base;
664 u32 l;
665
666 if (bank->regs->clr_irqenable) {
667 reg += bank->regs->clr_irqenable;
668 l = gpio_mask;
669 bank->context.irqenable1 &= ~gpio_mask;
670 } else {
671 reg += bank->regs->irqenable;
672 l = readl_relaxed(reg);
673 if (bank->regs->irqenable_inv)
674 l |= gpio_mask;
675 else
676 l &= ~gpio_mask;
677 bank->context.irqenable1 = l;
678 }
679
680 writel_relaxed(l, reg);
681}
682
683static inline void omap_set_gpio_irqenable(struct gpio_bank *bank,
684 unsigned offset, int enable)
685{
686 if (enable)
687 omap_enable_gpio_irqbank(bank, BIT(offset));
688 else
689 omap_disable_gpio_irqbank(bank, BIT(offset));
690}
691
692/* Use disable_irq_wake() and enable_irq_wake() functions from drivers */
693static int omap_gpio_wake_enable(struct irq_data *d, unsigned int enable)
694{
695 struct gpio_bank *bank = omap_irq_data_get_bank(d);
696
697 return irq_set_irq_wake(bank->irq, enable);
698}
699
700static int omap_gpio_request(struct gpio_chip *chip, unsigned offset)
701{
702 struct gpio_bank *bank = gpiochip_get_data(chip);
703 unsigned long flags;
704
705 pm_runtime_get_sync(chip->parent);
706
707 raw_spin_lock_irqsave(&bank->lock, flags);
708 omap_enable_gpio_module(bank, offset);
709 bank->mod_usage |= BIT(offset);
710 raw_spin_unlock_irqrestore(&bank->lock, flags);
711
712 return 0;
713}
714
715static void omap_gpio_free(struct gpio_chip *chip, unsigned offset)
716{
717 struct gpio_bank *bank = gpiochip_get_data(chip);
718 unsigned long flags;
719
720 raw_spin_lock_irqsave(&bank->lock, flags);
721 bank->mod_usage &= ~(BIT(offset));
722 if (!LINE_USED(bank->irq_usage, offset)) {
723 omap_set_gpio_direction(bank, offset, 1);
724 omap_clear_gpio_debounce(bank, offset);
725 }
726 omap_disable_gpio_module(bank, offset);
727 raw_spin_unlock_irqrestore(&bank->lock, flags);
728
729 pm_runtime_put(chip->parent);
730}
731
732/*
733 * We need to unmask the GPIO bank interrupt as soon as possible to
734 * avoid missing GPIO interrupts for other lines in the bank.
735 * Then we need to mask-read-clear-unmask the triggered GPIO lines
736 * in the bank to avoid missing nested interrupts for a GPIO line.
737 * If we wait to unmask individual GPIO lines in the bank after the
738 * line's interrupt handler has been run, we may miss some nested
739 * interrupts.
740 */
741static irqreturn_t omap_gpio_irq_handler(int irq, void *gpiobank)
742{
743 void __iomem *isr_reg = NULL;
744 u32 enabled, isr, level_mask;
745 unsigned int bit;
746 struct gpio_bank *bank = gpiobank;
747 unsigned long wa_lock_flags;
748 unsigned long lock_flags;
749
750 isr_reg = bank->base + bank->regs->irqstatus;
751 if (WARN_ON(!isr_reg))
752 goto exit;
753
754 if (WARN_ONCE(!pm_runtime_active(bank->chip.parent),
755 "gpio irq%i while runtime suspended?\n", irq))
756 return IRQ_NONE;
757
758 while (1) {
759 raw_spin_lock_irqsave(&bank->lock, lock_flags);
760
761 enabled = omap_get_gpio_irqbank_mask(bank);
762 isr = readl_relaxed(isr_reg) & enabled;
763
764 if (bank->level_mask)
765 level_mask = bank->level_mask & enabled;
766 else
767 level_mask = 0;
768
769 /* clear edge sensitive interrupts before handler(s) are
770 called so that we don't miss any interrupt occurred while
771 executing them */
772 if (isr & ~level_mask)
773 omap_clear_gpio_irqbank(bank, isr & ~level_mask);
774
775 raw_spin_unlock_irqrestore(&bank->lock, lock_flags);
776
777 if (!isr)
778 break;
779
780 while (isr) {
781 bit = __ffs(isr);
782 isr &= ~(BIT(bit));
783
784 raw_spin_lock_irqsave(&bank->lock, lock_flags);
785 /*
786 * Some chips can't respond to both rising and falling
787 * at the same time. If this irq was requested with
788 * both flags, we need to flip the ICR data for the IRQ
789 * to respond to the IRQ for the opposite direction.
790 * This will be indicated in the bank toggle_mask.
791 */
792 if (bank->toggle_mask & (BIT(bit)))
793 omap_toggle_gpio_edge_triggering(bank, bit);
794
795 raw_spin_unlock_irqrestore(&bank->lock, lock_flags);
796
797 raw_spin_lock_irqsave(&bank->wa_lock, wa_lock_flags);
798
799 generic_handle_irq(irq_find_mapping(bank->chip.irq.domain,
800 bit));
801
802 raw_spin_unlock_irqrestore(&bank->wa_lock,
803 wa_lock_flags);
804 }
805 }
806exit:
807 return IRQ_HANDLED;
808}
809
810static unsigned int omap_gpio_irq_startup(struct irq_data *d)
811{
812 struct gpio_bank *bank = omap_irq_data_get_bank(d);
813 unsigned long flags;
814 unsigned offset = d->hwirq;
815
816 raw_spin_lock_irqsave(&bank->lock, flags);
817
818 if (!LINE_USED(bank->mod_usage, offset))
819 omap_set_gpio_direction(bank, offset, 1);
820 else if (!omap_gpio_is_input(bank, offset))
821 goto err;
822 omap_enable_gpio_module(bank, offset);
823 bank->irq_usage |= BIT(offset);
824
825 raw_spin_unlock_irqrestore(&bank->lock, flags);
826 omap_gpio_unmask_irq(d);
827
828 return 0;
829err:
830 raw_spin_unlock_irqrestore(&bank->lock, flags);
831 return -EINVAL;
832}
833
834static void omap_gpio_irq_shutdown(struct irq_data *d)
835{
836 struct gpio_bank *bank = omap_irq_data_get_bank(d);
837 unsigned long flags;
838 unsigned offset = d->hwirq;
839
840 raw_spin_lock_irqsave(&bank->lock, flags);
841 bank->irq_usage &= ~(BIT(offset));
842 omap_set_gpio_irqenable(bank, offset, 0);
843 omap_clear_gpio_irqstatus(bank, offset);
844 omap_set_gpio_triggering(bank, offset, IRQ_TYPE_NONE);
845 if (!LINE_USED(bank->mod_usage, offset))
846 omap_clear_gpio_debounce(bank, offset);
847 omap_disable_gpio_module(bank, offset);
848 raw_spin_unlock_irqrestore(&bank->lock, flags);
849}
850
851static void omap_gpio_irq_bus_lock(struct irq_data *data)
852{
853 struct gpio_bank *bank = omap_irq_data_get_bank(data);
854
855 pm_runtime_get_sync(bank->chip.parent);
856}
857
858static void gpio_irq_bus_sync_unlock(struct irq_data *data)
859{
860 struct gpio_bank *bank = omap_irq_data_get_bank(data);
861
862 pm_runtime_put(bank->chip.parent);
863}
864
865static void omap_gpio_ack_irq(struct irq_data *d)
866{
867 struct gpio_bank *bank = omap_irq_data_get_bank(d);
868 unsigned offset = d->hwirq;
869
870 omap_clear_gpio_irqstatus(bank, offset);
871}
872
873static void omap_gpio_mask_irq(struct irq_data *d)
874{
875 struct gpio_bank *bank = omap_irq_data_get_bank(d);
876 unsigned offset = d->hwirq;
877 unsigned long flags;
878
879 raw_spin_lock_irqsave(&bank->lock, flags);
880 omap_set_gpio_irqenable(bank, offset, 0);
881 omap_set_gpio_triggering(bank, offset, IRQ_TYPE_NONE);
882 raw_spin_unlock_irqrestore(&bank->lock, flags);
883}
884
885static void omap_gpio_unmask_irq(struct irq_data *d)
886{
887 struct gpio_bank *bank = omap_irq_data_get_bank(d);
888 unsigned offset = d->hwirq;
889 u32 trigger = irqd_get_trigger_type(d);
890 unsigned long flags;
891
892 raw_spin_lock_irqsave(&bank->lock, flags);
893 if (trigger)
894 omap_set_gpio_triggering(bank, offset, trigger);
895
896 /* For level-triggered GPIOs, the clearing must be done after
897 * the HW source is cleared, thus after the handler has run */
898 if (bank->level_mask & BIT(offset)) {
899 omap_set_gpio_irqenable(bank, offset, 0);
900 omap_clear_gpio_irqstatus(bank, offset);
901 }
902
903 omap_set_gpio_irqenable(bank, offset, 1);
904 raw_spin_unlock_irqrestore(&bank->lock, flags);
905}
906
907/*
908 * Only edges can generate a wakeup event to the PRCM.
909 *
910 * Therefore, ensure any wake-up capable GPIOs have
911 * edge-detection enabled before going idle to ensure a wakeup
912 * to the PRCM is generated on a GPIO transition. (c.f. 34xx
913 * NDA TRM 25.5.3.1)
914 *
915 * The normal values will be restored upon ->runtime_resume()
916 * by writing back the values saved in bank->context.
917 */
918static void __maybe_unused
919omap2_gpio_enable_level_quirk(struct gpio_bank *bank)
920{
921 u32 wake_low, wake_hi;
922
923 /* Enable additional edge detection for level gpios for idle */
924 wake_low = bank->context.leveldetect0 & bank->context.wake_en;
925 if (wake_low)
926 writel_relaxed(wake_low | bank->context.fallingdetect,
927 bank->base + bank->regs->fallingdetect);
928
929 wake_hi = bank->context.leveldetect1 & bank->context.wake_en;
930 if (wake_hi)
931 writel_relaxed(wake_hi | bank->context.risingdetect,
932 bank->base + bank->regs->risingdetect);
933}
934
935static void __maybe_unused
936omap2_gpio_disable_level_quirk(struct gpio_bank *bank)
937{
938 /* Disable edge detection for level gpios after idle */
939 writel_relaxed(bank->context.fallingdetect,
940 bank->base + bank->regs->fallingdetect);
941 writel_relaxed(bank->context.risingdetect,
942 bank->base + bank->regs->risingdetect);
943}
944
945/*
946 * On omap4 and later SoC variants a level interrupt with wkup_en
947 * enabled blocks the GPIO functional clock from idling until the GPIO
948 * instance has been reset. To avoid that, we must set wkup_en only for
949 * idle for level interrupts, and clear level registers for the duration
950 * of idle. The level interrupts will be still there on wakeup by their
951 * nature.
952 */
953static void __maybe_unused
954omap4_gpio_enable_level_quirk(struct gpio_bank *bank)
955{
956 /* Update wake register for idle, edge bits might be already set */
957 writel_relaxed(bank->context.wake_en,
958 bank->base + bank->regs->wkup_en);
959
960 /* Clear level registers for idle */
961 writel_relaxed(0, bank->base + bank->regs->leveldetect0);
962 writel_relaxed(0, bank->base + bank->regs->leveldetect1);
963}
964
965static void __maybe_unused
966omap4_gpio_disable_level_quirk(struct gpio_bank *bank)
967{
968 /* Restore level registers after idle */
969 writel_relaxed(bank->context.leveldetect0,
970 bank->base + bank->regs->leveldetect0);
971 writel_relaxed(bank->context.leveldetect1,
972 bank->base + bank->regs->leveldetect1);
973
974 /* Clear saved wkup_en for level, it will be set for next idle again */
975 bank->context.wake_en &= ~(bank->context.leveldetect0 |
976 bank->context.leveldetect1);
977
978 /* Update wake with only edge configuration */
979 writel_relaxed(bank->context.wake_en,
980 bank->base + bank->regs->wkup_en);
981}
982
983/*---------------------------------------------------------------------*/
984
985static int omap_mpuio_suspend_noirq(struct device *dev)
986{
987 struct platform_device *pdev = to_platform_device(dev);
988 struct gpio_bank *bank = platform_get_drvdata(pdev);
989 void __iomem *mask_reg = bank->base +
990 OMAP_MPUIO_GPIO_MASKIT / bank->stride;
991 unsigned long flags;
992
993 raw_spin_lock_irqsave(&bank->lock, flags);
994 writel_relaxed(0xffff & ~bank->context.wake_en, mask_reg);
995 raw_spin_unlock_irqrestore(&bank->lock, flags);
996
997 return 0;
998}
999
1000static int omap_mpuio_resume_noirq(struct device *dev)
1001{
1002 struct platform_device *pdev = to_platform_device(dev);
1003 struct gpio_bank *bank = platform_get_drvdata(pdev);
1004 void __iomem *mask_reg = bank->base +
1005 OMAP_MPUIO_GPIO_MASKIT / bank->stride;
1006 unsigned long flags;
1007
1008 raw_spin_lock_irqsave(&bank->lock, flags);
1009 writel_relaxed(bank->context.wake_en, mask_reg);
1010 raw_spin_unlock_irqrestore(&bank->lock, flags);
1011
1012 return 0;
1013}
1014
1015static const struct dev_pm_ops omap_mpuio_dev_pm_ops = {
1016 .suspend_noirq = omap_mpuio_suspend_noirq,
1017 .resume_noirq = omap_mpuio_resume_noirq,
1018};
1019
1020/* use platform_driver for this. */
1021static struct platform_driver omap_mpuio_driver = {
1022 .driver = {
1023 .name = "mpuio",
1024 .pm = &omap_mpuio_dev_pm_ops,
1025 },
1026};
1027
1028static struct platform_device omap_mpuio_device = {
1029 .name = "mpuio",
1030 .id = -1,
1031 .dev = {
1032 .driver = &omap_mpuio_driver.driver,
1033 }
1034 /* could list the /proc/iomem resources */
1035};
1036
1037static inline void omap_mpuio_init(struct gpio_bank *bank)
1038{
1039 platform_set_drvdata(&omap_mpuio_device, bank);
1040
1041 if (platform_driver_register(&omap_mpuio_driver) == 0)
1042 (void) platform_device_register(&omap_mpuio_device);
1043}
1044
1045/*---------------------------------------------------------------------*/
1046
1047static int omap_gpio_get_direction(struct gpio_chip *chip, unsigned offset)
1048{
1049 struct gpio_bank *bank;
1050 unsigned long flags;
1051 void __iomem *reg;
1052 int dir;
1053
1054 bank = gpiochip_get_data(chip);
1055 reg = bank->base + bank->regs->direction;
1056 raw_spin_lock_irqsave(&bank->lock, flags);
1057 dir = !!(readl_relaxed(reg) & BIT(offset));
1058 raw_spin_unlock_irqrestore(&bank->lock, flags);
1059 return dir;
1060}
1061
1062static int omap_gpio_input(struct gpio_chip *chip, unsigned offset)
1063{
1064 struct gpio_bank *bank;
1065 unsigned long flags;
1066
1067 bank = gpiochip_get_data(chip);
1068 raw_spin_lock_irqsave(&bank->lock, flags);
1069 omap_set_gpio_direction(bank, offset, 1);
1070 raw_spin_unlock_irqrestore(&bank->lock, flags);
1071 return 0;
1072}
1073
1074static int omap_gpio_get(struct gpio_chip *chip, unsigned offset)
1075{
1076 struct gpio_bank *bank;
1077
1078 bank = gpiochip_get_data(chip);
1079
1080 if (omap_gpio_is_input(bank, offset))
1081 return omap_get_gpio_datain(bank, offset);
1082 else
1083 return omap_get_gpio_dataout(bank, offset);
1084}
1085
1086static int omap_gpio_output(struct gpio_chip *chip, unsigned offset, int value)
1087{
1088 struct gpio_bank *bank;
1089 unsigned long flags;
1090
1091 bank = gpiochip_get_data(chip);
1092 raw_spin_lock_irqsave(&bank->lock, flags);
1093 bank->set_dataout(bank, offset, value);
1094 omap_set_gpio_direction(bank, offset, 0);
1095 raw_spin_unlock_irqrestore(&bank->lock, flags);
1096 return 0;
1097}
1098
1099static int omap_gpio_get_multiple(struct gpio_chip *chip, unsigned long *mask,
1100 unsigned long *bits)
1101{
1102 struct gpio_bank *bank = gpiochip_get_data(chip);
1103 void __iomem *reg = bank->base + bank->regs->direction;
1104 unsigned long in = readl_relaxed(reg), l;
1105
1106 *bits = 0;
1107
1108 l = in & *mask;
1109 if (l)
1110 *bits |= omap_get_gpio_datain_multiple(bank, &l);
1111
1112 l = ~in & *mask;
1113 if (l)
1114 *bits |= omap_get_gpio_dataout_multiple(bank, &l);
1115
1116 return 0;
1117}
1118
1119static int omap_gpio_debounce(struct gpio_chip *chip, unsigned offset,
1120 unsigned debounce)
1121{
1122 struct gpio_bank *bank;
1123 unsigned long flags;
1124 int ret;
1125
1126 bank = gpiochip_get_data(chip);
1127
1128 raw_spin_lock_irqsave(&bank->lock, flags);
1129 ret = omap2_set_gpio_debounce(bank, offset, debounce);
1130 raw_spin_unlock_irqrestore(&bank->lock, flags);
1131
1132 if (ret)
1133 dev_info(chip->parent,
1134 "Could not set line %u debounce to %u microseconds (%d)",
1135 offset, debounce, ret);
1136
1137 return ret;
1138}
1139
1140static int omap_gpio_set_config(struct gpio_chip *chip, unsigned offset,
1141 unsigned long config)
1142{
1143 u32 debounce;
1144
1145 if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE)
1146 return -ENOTSUPP;
1147
1148 debounce = pinconf_to_config_argument(config);
1149 return omap_gpio_debounce(chip, offset, debounce);
1150}
1151
1152static void omap_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
1153{
1154 struct gpio_bank *bank;
1155 unsigned long flags;
1156
1157 bank = gpiochip_get_data(chip);
1158 raw_spin_lock_irqsave(&bank->lock, flags);
1159 bank->set_dataout(bank, offset, value);
1160 raw_spin_unlock_irqrestore(&bank->lock, flags);
1161}
1162
1163static void omap_gpio_set_multiple(struct gpio_chip *chip, unsigned long *mask,
1164 unsigned long *bits)
1165{
1166 struct gpio_bank *bank = gpiochip_get_data(chip);
1167 unsigned long flags;
1168
1169 raw_spin_lock_irqsave(&bank->lock, flags);
1170 bank->set_dataout_multiple(bank, mask, bits);
1171 raw_spin_unlock_irqrestore(&bank->lock, flags);
1172}
1173
1174/*---------------------------------------------------------------------*/
1175
1176static void omap_gpio_show_rev(struct gpio_bank *bank)
1177{
1178 static bool called;
1179 u32 rev;
1180
1181 if (called || bank->regs->revision == USHRT_MAX)
1182 return;
1183
1184 rev = readw_relaxed(bank->base + bank->regs->revision);
1185 pr_info("OMAP GPIO hardware version %d.%d\n",
1186 (rev >> 4) & 0x0f, rev & 0x0f);
1187
1188 called = true;
1189}
1190
1191static void omap_gpio_mod_init(struct gpio_bank *bank)
1192{
1193 void __iomem *base = bank->base;
1194 u32 l = 0xffffffff;
1195
1196 if (bank->width == 16)
1197 l = 0xffff;
1198
1199 if (bank->is_mpuio) {
1200 writel_relaxed(l, bank->base + bank->regs->irqenable);
1201 return;
1202 }
1203
1204 omap_gpio_rmw(base, bank->regs->irqenable, l,
1205 bank->regs->irqenable_inv);
1206 omap_gpio_rmw(base, bank->regs->irqstatus, l,
1207 !bank->regs->irqenable_inv);
1208 if (bank->regs->debounce_en)
1209 writel_relaxed(0, base + bank->regs->debounce_en);
1210
1211 /* Save OE default value (0xffffffff) in the context */
1212 bank->context.oe = readl_relaxed(bank->base + bank->regs->direction);
1213 /* Initialize interface clk ungated, module enabled */
1214 if (bank->regs->ctrl)
1215 writel_relaxed(0, base + bank->regs->ctrl);
1216}
1217
1218static int omap_gpio_chip_init(struct gpio_bank *bank, struct irq_chip *irqc)
1219{
1220 struct gpio_irq_chip *irq;
1221 static int gpio;
1222 const char *label;
1223 int irq_base = 0;
1224 int ret;
1225
1226 /*
1227 * REVISIT eventually switch from OMAP-specific gpio structs
1228 * over to the generic ones
1229 */
1230 bank->chip.request = omap_gpio_request;
1231 bank->chip.free = omap_gpio_free;
1232 bank->chip.get_direction = omap_gpio_get_direction;
1233 bank->chip.direction_input = omap_gpio_input;
1234 bank->chip.get = omap_gpio_get;
1235 bank->chip.get_multiple = omap_gpio_get_multiple;
1236 bank->chip.direction_output = omap_gpio_output;
1237 bank->chip.set_config = omap_gpio_set_config;
1238 bank->chip.set = omap_gpio_set;
1239 bank->chip.set_multiple = omap_gpio_set_multiple;
1240 if (bank->is_mpuio) {
1241 bank->chip.label = "mpuio";
1242 if (bank->regs->wkup_en)
1243 bank->chip.parent = &omap_mpuio_device.dev;
1244 bank->chip.base = OMAP_MPUIO(0);
1245 } else {
1246 label = devm_kasprintf(bank->chip.parent, GFP_KERNEL, "gpio-%d-%d",
1247 gpio, gpio + bank->width - 1);
1248 if (!label)
1249 return -ENOMEM;
1250 bank->chip.label = label;
1251 bank->chip.base = gpio;
1252 }
1253 bank->chip.ngpio = bank->width;
1254
1255#ifdef CONFIG_ARCH_OMAP1
1256 /*
1257 * REVISIT: Once we have OMAP1 supporting SPARSE_IRQ, we can drop
1258 * irq_alloc_descs() since a base IRQ offset will no longer be needed.
1259 */
1260 irq_base = devm_irq_alloc_descs(bank->chip.parent,
1261 -1, 0, bank->width, 0);
1262 if (irq_base < 0) {
1263 dev_err(bank->chip.parent, "Couldn't allocate IRQ numbers\n");
1264 return -ENODEV;
1265 }
1266#endif
1267
1268 /* MPUIO is a bit different, reading IRQ status clears it */
1269 if (bank->is_mpuio) {
1270 irqc->irq_ack = dummy_irq_chip.irq_ack;
1271 if (!bank->regs->wkup_en)
1272 irqc->irq_set_wake = NULL;
1273 }
1274
1275 irq = &bank->chip.irq;
1276 irq->chip = irqc;
1277 irq->handler = handle_bad_irq;
1278 irq->default_type = IRQ_TYPE_NONE;
1279 irq->num_parents = 1;
1280 irq->parents = &bank->irq;
1281 irq->first = irq_base;
1282
1283 ret = gpiochip_add_data(&bank->chip, bank);
1284 if (ret) {
1285 dev_err(bank->chip.parent,
1286 "Could not register gpio chip %d\n", ret);
1287 return ret;
1288 }
1289
1290 ret = devm_request_irq(bank->chip.parent, bank->irq,
1291 omap_gpio_irq_handler,
1292 0, dev_name(bank->chip.parent), bank);
1293 if (ret)
1294 gpiochip_remove(&bank->chip);
1295
1296 if (!bank->is_mpuio)
1297 gpio += bank->width;
1298
1299 return ret;
1300}
1301
1302static void omap_gpio_idle(struct gpio_bank *bank, bool may_lose_context);
1303static void omap_gpio_unidle(struct gpio_bank *bank);
1304
1305static int gpio_omap_cpu_notifier(struct notifier_block *nb,
1306 unsigned long cmd, void *v)
1307{
1308 struct gpio_bank *bank;
1309 unsigned long flags;
1310
1311 bank = container_of(nb, struct gpio_bank, nb);
1312
1313 raw_spin_lock_irqsave(&bank->lock, flags);
1314 switch (cmd) {
1315 case CPU_CLUSTER_PM_ENTER:
1316 if (bank->is_suspended)
1317 break;
1318 omap_gpio_idle(bank, true);
1319 break;
1320 case CPU_CLUSTER_PM_ENTER_FAILED:
1321 case CPU_CLUSTER_PM_EXIT:
1322 if (bank->is_suspended)
1323 break;
1324 omap_gpio_unidle(bank);
1325 break;
1326 }
1327 raw_spin_unlock_irqrestore(&bank->lock, flags);
1328
1329 return NOTIFY_OK;
1330}
1331
1332static const struct of_device_id omap_gpio_match[];
1333
1334static int omap_gpio_probe(struct platform_device *pdev)
1335{
1336 struct device *dev = &pdev->dev;
1337 struct device_node *node = dev->of_node;
1338 const struct of_device_id *match;
1339 const struct omap_gpio_platform_data *pdata;
1340 struct resource *res;
1341 struct gpio_bank *bank;
1342 struct irq_chip *irqc;
1343 int ret;
1344
1345 match = of_match_device(of_match_ptr(omap_gpio_match), dev);
1346
1347 pdata = match ? match->data : dev_get_platdata(dev);
1348 if (!pdata)
1349 return -EINVAL;
1350
1351 bank = devm_kzalloc(dev, sizeof(*bank), GFP_KERNEL);
1352 if (!bank)
1353 return -ENOMEM;
1354
1355 irqc = devm_kzalloc(dev, sizeof(*irqc), GFP_KERNEL);
1356 if (!irqc)
1357 return -ENOMEM;
1358
1359 irqc->irq_startup = omap_gpio_irq_startup,
1360 irqc->irq_shutdown = omap_gpio_irq_shutdown,
1361 irqc->irq_ack = omap_gpio_ack_irq,
1362 irqc->irq_mask = omap_gpio_mask_irq,
1363 irqc->irq_unmask = omap_gpio_unmask_irq,
1364 irqc->irq_set_type = omap_gpio_irq_type,
1365 irqc->irq_set_wake = omap_gpio_wake_enable,
1366 irqc->irq_bus_lock = omap_gpio_irq_bus_lock,
1367 irqc->irq_bus_sync_unlock = gpio_irq_bus_sync_unlock,
1368 irqc->name = dev_name(&pdev->dev);
1369 irqc->flags = IRQCHIP_MASK_ON_SUSPEND;
1370 irqc->parent_device = dev;
1371
1372 bank->irq = platform_get_irq(pdev, 0);
1373 if (bank->irq <= 0) {
1374 if (!bank->irq)
1375 bank->irq = -ENXIO;
1376 if (bank->irq != -EPROBE_DEFER)
1377 dev_err(dev,
1378 "can't get irq resource ret=%d\n", bank->irq);
1379 return bank->irq;
1380 }
1381
1382 bank->chip.parent = dev;
1383 bank->chip.owner = THIS_MODULE;
1384 bank->dbck_flag = pdata->dbck_flag;
1385 bank->quirks = pdata->quirks;
1386 bank->stride = pdata->bank_stride;
1387 bank->width = pdata->bank_width;
1388 bank->is_mpuio = pdata->is_mpuio;
1389 bank->non_wakeup_gpios = pdata->non_wakeup_gpios;
1390 bank->regs = pdata->regs;
1391#ifdef CONFIG_OF_GPIO
1392 bank->chip.of_node = of_node_get(node);
1393#endif
1394
1395 if (node) {
1396 if (!of_property_read_bool(node, "ti,gpio-always-on"))
1397 bank->loses_context = true;
1398 } else {
1399 bank->loses_context = pdata->loses_context;
1400
1401 if (bank->loses_context)
1402 bank->get_context_loss_count =
1403 pdata->get_context_loss_count;
1404 }
1405
1406 if (bank->regs->set_dataout && bank->regs->clr_dataout) {
1407 bank->set_dataout = omap_set_gpio_dataout_reg;
1408 bank->set_dataout_multiple = omap_set_gpio_dataout_reg_multiple;
1409 } else {
1410 bank->set_dataout = omap_set_gpio_dataout_mask;
1411 bank->set_dataout_multiple =
1412 omap_set_gpio_dataout_mask_multiple;
1413 }
1414
1415 if (bank->quirks & OMAP_GPIO_QUIRK_DEFERRED_WKUP_EN) {
1416 bank->funcs.idle_enable_level_quirk =
1417 omap4_gpio_enable_level_quirk;
1418 bank->funcs.idle_disable_level_quirk =
1419 omap4_gpio_disable_level_quirk;
1420 } else if (bank->quirks & OMAP_GPIO_QUIRK_IDLE_REMOVE_TRIGGER) {
1421 bank->funcs.idle_enable_level_quirk =
1422 omap2_gpio_enable_level_quirk;
1423 bank->funcs.idle_disable_level_quirk =
1424 omap2_gpio_disable_level_quirk;
1425 }
1426
1427 raw_spin_lock_init(&bank->lock);
1428 raw_spin_lock_init(&bank->wa_lock);
1429
1430 /* Static mapping, never released */
1431 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1432 bank->base = devm_ioremap_resource(dev, res);
1433 if (IS_ERR(bank->base)) {
1434 return PTR_ERR(bank->base);
1435 }
1436
1437 if (bank->dbck_flag) {
1438 bank->dbck = devm_clk_get(dev, "dbclk");
1439 if (IS_ERR(bank->dbck)) {
1440 dev_err(dev,
1441 "Could not get gpio dbck. Disable debounce\n");
1442 bank->dbck_flag = false;
1443 } else {
1444 clk_prepare(bank->dbck);
1445 }
1446 }
1447
1448 platform_set_drvdata(pdev, bank);
1449
1450 pm_runtime_enable(dev);
1451 pm_runtime_get_sync(dev);
1452
1453 if (bank->is_mpuio)
1454 omap_mpuio_init(bank);
1455
1456 omap_gpio_mod_init(bank);
1457
1458 ret = omap_gpio_chip_init(bank, irqc);
1459 if (ret) {
1460 pm_runtime_put_sync(dev);
1461 pm_runtime_disable(dev);
1462 if (bank->dbck_flag)
1463 clk_unprepare(bank->dbck);
1464 return ret;
1465 }
1466
1467 omap_gpio_show_rev(bank);
1468
1469 if (bank->funcs.idle_enable_level_quirk &&
1470 bank->funcs.idle_disable_level_quirk) {
1471 bank->nb.notifier_call = gpio_omap_cpu_notifier;
1472 cpu_pm_register_notifier(&bank->nb);
1473 }
1474
1475 pm_runtime_put(dev);
1476
1477 return 0;
1478}
1479
1480static int omap_gpio_remove(struct platform_device *pdev)
1481{
1482 struct gpio_bank *bank = platform_get_drvdata(pdev);
1483
1484 if (bank->nb.notifier_call)
1485 cpu_pm_unregister_notifier(&bank->nb);
1486 list_del(&bank->node);
1487 gpiochip_remove(&bank->chip);
1488 pm_runtime_disable(&pdev->dev);
1489 if (bank->dbck_flag)
1490 clk_unprepare(bank->dbck);
1491
1492 return 0;
1493}
1494
1495static void omap_gpio_restore_context(struct gpio_bank *bank);
1496
1497static void omap_gpio_idle(struct gpio_bank *bank, bool may_lose_context)
1498{
1499 struct device *dev = bank->chip.parent;
1500 u32 l1 = 0, l2 = 0;
1501
1502 if (bank->funcs.idle_enable_level_quirk)
1503 bank->funcs.idle_enable_level_quirk(bank);
1504
1505 if (!bank->enabled_non_wakeup_gpios)
1506 goto update_gpio_context_count;
1507
1508 if (!may_lose_context)
1509 goto update_gpio_context_count;
1510
1511 /*
1512 * If going to OFF, remove triggering for all
1513 * non-wakeup GPIOs. Otherwise spurious IRQs will be
1514 * generated. See OMAP2420 Errata item 1.101.
1515 */
1516 bank->saved_datain = readl_relaxed(bank->base +
1517 bank->regs->datain);
1518 l1 = bank->context.fallingdetect;
1519 l2 = bank->context.risingdetect;
1520
1521 l1 &= ~bank->enabled_non_wakeup_gpios;
1522 l2 &= ~bank->enabled_non_wakeup_gpios;
1523
1524 writel_relaxed(l1, bank->base + bank->regs->fallingdetect);
1525 writel_relaxed(l2, bank->base + bank->regs->risingdetect);
1526
1527 bank->workaround_enabled = true;
1528
1529update_gpio_context_count:
1530 if (bank->get_context_loss_count)
1531 bank->context_loss_count =
1532 bank->get_context_loss_count(dev);
1533
1534 omap_gpio_dbck_disable(bank);
1535}
1536
1537static void omap_gpio_init_context(struct gpio_bank *p);
1538
1539static void omap_gpio_unidle(struct gpio_bank *bank)
1540{
1541 struct device *dev = bank->chip.parent;
1542 u32 l = 0, gen, gen0, gen1;
1543 int c;
1544
1545 /*
1546 * On the first resume during the probe, the context has not
1547 * been initialised and so initialise it now. Also initialise
1548 * the context loss count.
1549 */
1550 if (bank->loses_context && !bank->context_valid) {
1551 omap_gpio_init_context(bank);
1552
1553 if (bank->get_context_loss_count)
1554 bank->context_loss_count =
1555 bank->get_context_loss_count(dev);
1556 }
1557
1558 omap_gpio_dbck_enable(bank);
1559
1560 if (bank->funcs.idle_disable_level_quirk)
1561 bank->funcs.idle_disable_level_quirk(bank);
1562
1563 if (bank->loses_context) {
1564 if (!bank->get_context_loss_count) {
1565 omap_gpio_restore_context(bank);
1566 } else {
1567 c = bank->get_context_loss_count(dev);
1568 if (c != bank->context_loss_count) {
1569 omap_gpio_restore_context(bank);
1570 } else {
1571 return;
1572 }
1573 }
1574 }
1575
1576 if (!bank->workaround_enabled)
1577 return;
1578
1579 l = readl_relaxed(bank->base + bank->regs->datain);
1580
1581 /*
1582 * Check if any of the non-wakeup interrupt GPIOs have changed
1583 * state. If so, generate an IRQ by software. This is
1584 * horribly racy, but it's the best we can do to work around
1585 * this silicon bug.
1586 */
1587 l ^= bank->saved_datain;
1588 l &= bank->enabled_non_wakeup_gpios;
1589
1590 /*
1591 * No need to generate IRQs for the rising edge for gpio IRQs
1592 * configured with falling edge only; and vice versa.
1593 */
1594 gen0 = l & bank->context.fallingdetect;
1595 gen0 &= bank->saved_datain;
1596
1597 gen1 = l & bank->context.risingdetect;
1598 gen1 &= ~(bank->saved_datain);
1599
1600 /* FIXME: Consider GPIO IRQs with level detections properly! */
1601 gen = l & (~(bank->context.fallingdetect) &
1602 ~(bank->context.risingdetect));
1603 /* Consider all GPIO IRQs needed to be updated */
1604 gen |= gen0 | gen1;
1605
1606 if (gen) {
1607 u32 old0, old1;
1608
1609 old0 = readl_relaxed(bank->base + bank->regs->leveldetect0);
1610 old1 = readl_relaxed(bank->base + bank->regs->leveldetect1);
1611
1612 if (!bank->regs->irqstatus_raw0) {
1613 writel_relaxed(old0 | gen, bank->base +
1614 bank->regs->leveldetect0);
1615 writel_relaxed(old1 | gen, bank->base +
1616 bank->regs->leveldetect1);
1617 }
1618
1619 if (bank->regs->irqstatus_raw0) {
1620 writel_relaxed(old0 | l, bank->base +
1621 bank->regs->leveldetect0);
1622 writel_relaxed(old1 | l, bank->base +
1623 bank->regs->leveldetect1);
1624 }
1625 writel_relaxed(old0, bank->base + bank->regs->leveldetect0);
1626 writel_relaxed(old1, bank->base + bank->regs->leveldetect1);
1627 }
1628
1629 bank->workaround_enabled = false;
1630}
1631
1632static void omap_gpio_init_context(struct gpio_bank *p)
1633{
1634 struct omap_gpio_reg_offs *regs = p->regs;
1635 void __iomem *base = p->base;
1636
1637 p->context.ctrl = readl_relaxed(base + regs->ctrl);
1638 p->context.oe = readl_relaxed(base + regs->direction);
1639 p->context.wake_en = readl_relaxed(base + regs->wkup_en);
1640 p->context.leveldetect0 = readl_relaxed(base + regs->leveldetect0);
1641 p->context.leveldetect1 = readl_relaxed(base + regs->leveldetect1);
1642 p->context.risingdetect = readl_relaxed(base + regs->risingdetect);
1643 p->context.fallingdetect = readl_relaxed(base + regs->fallingdetect);
1644 p->context.irqenable1 = readl_relaxed(base + regs->irqenable);
1645 p->context.irqenable2 = readl_relaxed(base + regs->irqenable2);
1646
1647 if (regs->set_dataout && p->regs->clr_dataout)
1648 p->context.dataout = readl_relaxed(base + regs->set_dataout);
1649 else
1650 p->context.dataout = readl_relaxed(base + regs->dataout);
1651
1652 p->context_valid = true;
1653}
1654
1655static void omap_gpio_restore_context(struct gpio_bank *bank)
1656{
1657 writel_relaxed(bank->context.wake_en,
1658 bank->base + bank->regs->wkup_en);
1659 writel_relaxed(bank->context.ctrl, bank->base + bank->regs->ctrl);
1660 writel_relaxed(bank->context.leveldetect0,
1661 bank->base + bank->regs->leveldetect0);
1662 writel_relaxed(bank->context.leveldetect1,
1663 bank->base + bank->regs->leveldetect1);
1664 writel_relaxed(bank->context.risingdetect,
1665 bank->base + bank->regs->risingdetect);
1666 writel_relaxed(bank->context.fallingdetect,
1667 bank->base + bank->regs->fallingdetect);
1668 if (bank->regs->set_dataout && bank->regs->clr_dataout)
1669 writel_relaxed(bank->context.dataout,
1670 bank->base + bank->regs->set_dataout);
1671 else
1672 writel_relaxed(bank->context.dataout,
1673 bank->base + bank->regs->dataout);
1674 writel_relaxed(bank->context.oe, bank->base + bank->regs->direction);
1675
1676 if (bank->dbck_enable_mask) {
1677 writel_relaxed(bank->context.debounce, bank->base +
1678 bank->regs->debounce);
1679 writel_relaxed(bank->context.debounce_en,
1680 bank->base + bank->regs->debounce_en);
1681 }
1682
1683 writel_relaxed(bank->context.irqenable1,
1684 bank->base + bank->regs->irqenable);
1685 writel_relaxed(bank->context.irqenable2,
1686 bank->base + bank->regs->irqenable2);
1687}
1688
1689static int __maybe_unused omap_gpio_runtime_suspend(struct device *dev)
1690{
1691 struct platform_device *pdev = to_platform_device(dev);
1692 struct gpio_bank *bank = platform_get_drvdata(pdev);
1693 unsigned long flags;
1694 int error = 0;
1695
1696 raw_spin_lock_irqsave(&bank->lock, flags);
1697 /* Must be idled only by CPU_CLUSTER_PM_ENTER? */
1698 if (bank->irq_usage) {
1699 error = -EBUSY;
1700 goto unlock;
1701 }
1702 omap_gpio_idle(bank, true);
1703 bank->is_suspended = true;
1704unlock:
1705 raw_spin_unlock_irqrestore(&bank->lock, flags);
1706
1707 return error;
1708}
1709
1710static int __maybe_unused omap_gpio_runtime_resume(struct device *dev)
1711{
1712 struct platform_device *pdev = to_platform_device(dev);
1713 struct gpio_bank *bank = platform_get_drvdata(pdev);
1714 unsigned long flags;
1715 int error = 0;
1716
1717 raw_spin_lock_irqsave(&bank->lock, flags);
1718 /* Must be unidled only by CPU_CLUSTER_PM_ENTER? */
1719 if (bank->irq_usage) {
1720 error = -EBUSY;
1721 goto unlock;
1722 }
1723 omap_gpio_unidle(bank);
1724 bank->is_suspended = false;
1725unlock:
1726 raw_spin_unlock_irqrestore(&bank->lock, flags);
1727
1728 return error;
1729}
1730
1731#ifdef CONFIG_ARCH_OMAP2PLUS
1732static const struct dev_pm_ops gpio_pm_ops = {
1733 SET_RUNTIME_PM_OPS(omap_gpio_runtime_suspend, omap_gpio_runtime_resume,
1734 NULL)
1735};
1736#else
1737static const struct dev_pm_ops gpio_pm_ops;
1738#endif /* CONFIG_ARCH_OMAP2PLUS */
1739
1740#if defined(CONFIG_OF)
1741static struct omap_gpio_reg_offs omap2_gpio_regs = {
1742 .revision = OMAP24XX_GPIO_REVISION,
1743 .direction = OMAP24XX_GPIO_OE,
1744 .datain = OMAP24XX_GPIO_DATAIN,
1745 .dataout = OMAP24XX_GPIO_DATAOUT,
1746 .set_dataout = OMAP24XX_GPIO_SETDATAOUT,
1747 .clr_dataout = OMAP24XX_GPIO_CLEARDATAOUT,
1748 .irqstatus = OMAP24XX_GPIO_IRQSTATUS1,
1749 .irqstatus2 = OMAP24XX_GPIO_IRQSTATUS2,
1750 .irqenable = OMAP24XX_GPIO_IRQENABLE1,
1751 .irqenable2 = OMAP24XX_GPIO_IRQENABLE2,
1752 .set_irqenable = OMAP24XX_GPIO_SETIRQENABLE1,
1753 .clr_irqenable = OMAP24XX_GPIO_CLEARIRQENABLE1,
1754 .debounce = OMAP24XX_GPIO_DEBOUNCE_VAL,
1755 .debounce_en = OMAP24XX_GPIO_DEBOUNCE_EN,
1756 .ctrl = OMAP24XX_GPIO_CTRL,
1757 .wkup_en = OMAP24XX_GPIO_WAKE_EN,
1758 .leveldetect0 = OMAP24XX_GPIO_LEVELDETECT0,
1759 .leveldetect1 = OMAP24XX_GPIO_LEVELDETECT1,
1760 .risingdetect = OMAP24XX_GPIO_RISINGDETECT,
1761 .fallingdetect = OMAP24XX_GPIO_FALLINGDETECT,
1762};
1763
1764static struct omap_gpio_reg_offs omap4_gpio_regs = {
1765 .revision = OMAP4_GPIO_REVISION,
1766 .direction = OMAP4_GPIO_OE,
1767 .datain = OMAP4_GPIO_DATAIN,
1768 .dataout = OMAP4_GPIO_DATAOUT,
1769 .set_dataout = OMAP4_GPIO_SETDATAOUT,
1770 .clr_dataout = OMAP4_GPIO_CLEARDATAOUT,
1771 .irqstatus = OMAP4_GPIO_IRQSTATUS0,
1772 .irqstatus2 = OMAP4_GPIO_IRQSTATUS1,
1773 .irqenable = OMAP4_GPIO_IRQSTATUSSET0,
1774 .irqenable2 = OMAP4_GPIO_IRQSTATUSSET1,
1775 .set_irqenable = OMAP4_GPIO_IRQSTATUSSET0,
1776 .clr_irqenable = OMAP4_GPIO_IRQSTATUSCLR0,
1777 .debounce = OMAP4_GPIO_DEBOUNCINGTIME,
1778 .debounce_en = OMAP4_GPIO_DEBOUNCENABLE,
1779 .ctrl = OMAP4_GPIO_CTRL,
1780 .wkup_en = OMAP4_GPIO_IRQWAKEN0,
1781 .leveldetect0 = OMAP4_GPIO_LEVELDETECT0,
1782 .leveldetect1 = OMAP4_GPIO_LEVELDETECT1,
1783 .risingdetect = OMAP4_GPIO_RISINGDETECT,
1784 .fallingdetect = OMAP4_GPIO_FALLINGDETECT,
1785};
1786
1787/*
1788 * Note that omap2 does not currently support idle modes with context loss so
1789 * no need to add OMAP_GPIO_QUIRK_IDLE_REMOVE_TRIGGER quirk flag to save
1790 * and restore context.
1791 */
1792static const struct omap_gpio_platform_data omap2_pdata = {
1793 .regs = &omap2_gpio_regs,
1794 .bank_width = 32,
1795 .dbck_flag = false,
1796};
1797
1798static const struct omap_gpio_platform_data omap3_pdata = {
1799 .regs = &omap2_gpio_regs,
1800 .bank_width = 32,
1801 .dbck_flag = true,
1802 .quirks = OMAP_GPIO_QUIRK_IDLE_REMOVE_TRIGGER,
1803};
1804
1805static const struct omap_gpio_platform_data omap4_pdata = {
1806 .regs = &omap4_gpio_regs,
1807 .bank_width = 32,
1808 .dbck_flag = true,
1809 .quirks = OMAP_GPIO_QUIRK_IDLE_REMOVE_TRIGGER |
1810 OMAP_GPIO_QUIRK_DEFERRED_WKUP_EN,
1811};
1812
1813static const struct of_device_id omap_gpio_match[] = {
1814 {
1815 .compatible = "ti,omap4-gpio",
1816 .data = &omap4_pdata,
1817 },
1818 {
1819 .compatible = "ti,omap3-gpio",
1820 .data = &omap3_pdata,
1821 },
1822 {
1823 .compatible = "ti,omap2-gpio",
1824 .data = &omap2_pdata,
1825 },
1826 { },
1827};
1828MODULE_DEVICE_TABLE(of, omap_gpio_match);
1829#endif
1830
1831static struct platform_driver omap_gpio_driver = {
1832 .probe = omap_gpio_probe,
1833 .remove = omap_gpio_remove,
1834 .driver = {
1835 .name = "omap_gpio",
1836 .pm = &gpio_pm_ops,
1837 .of_match_table = of_match_ptr(omap_gpio_match),
1838 },
1839};
1840
1841/*
1842 * gpio driver register needs to be done before
1843 * machine_init functions access gpio APIs.
1844 * Hence omap_gpio_drv_reg() is a postcore_initcall.
1845 */
1846static int __init omap_gpio_drv_reg(void)
1847{
1848 return platform_driver_register(&omap_gpio_driver);
1849}
1850postcore_initcall(omap_gpio_drv_reg);
1851
1852static void __exit omap_gpio_exit(void)
1853{
1854 platform_driver_unregister(&omap_gpio_driver);
1855}
1856module_exit(omap_gpio_exit);
1857
1858MODULE_DESCRIPTION("omap gpio driver");
1859MODULE_ALIAS("platform:gpio-omap");
1860MODULE_LICENSE("GPL v2");