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