2 * Generic GPIO driver for logic cells found in the Nomadik SoC
4 * Copyright (C) 2008,2009 STMicroelectronics
5 * Copyright (C) 2009 Alessandro Rubini <rubini@unipv.it>
6 * Rewritten based on work by Prafulla WADASKAR <prafulla.wadaskar@st.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/device.h>
16 #include <linux/platform_device.h>
18 #include <linux/clk.h>
19 #include <linux/err.h>
20 #include <linux/gpio.h>
21 #include <linux/spinlock.h>
22 #include <linux/interrupt.h>
23 #include <linux/irq.h>
24 #include <linux/slab.h>
26 #include <plat/pincfg.h>
27 #include <mach/hardware.h>
28 #include <mach/gpio.h>
31 * The GPIO module in the Nomadik family of Systems-on-Chip is an
32 * AMBA device, managing 32 pins and alternate functions. The logic block
33 * is currently only used in the Nomadik.
35 * Symbols in this file are called "nmk_gpio" for "nomadik gpio"
38 #define NMK_GPIO_PER_CHIP 32
39 struct nmk_gpio_chip
{
40 struct gpio_chip chip
;
43 unsigned int parent_irq
;
45 /* Keep track of configured edges */
50 static void __nmk_gpio_set_mode(struct nmk_gpio_chip
*nmk_chip
,
51 unsigned offset
, int gpio_mode
)
53 u32 bit
= 1 << offset
;
56 afunc
= readl(nmk_chip
->addr
+ NMK_GPIO_AFSLA
) & ~bit
;
57 bfunc
= readl(nmk_chip
->addr
+ NMK_GPIO_AFSLB
) & ~bit
;
58 if (gpio_mode
& NMK_GPIO_ALT_A
)
60 if (gpio_mode
& NMK_GPIO_ALT_B
)
62 writel(afunc
, nmk_chip
->addr
+ NMK_GPIO_AFSLA
);
63 writel(bfunc
, nmk_chip
->addr
+ NMK_GPIO_AFSLB
);
66 static void __nmk_gpio_set_slpm(struct nmk_gpio_chip
*nmk_chip
,
67 unsigned offset
, enum nmk_gpio_slpm mode
)
69 u32 bit
= 1 << offset
;
72 slpm
= readl(nmk_chip
->addr
+ NMK_GPIO_SLPC
);
73 if (mode
== NMK_GPIO_SLPM_NOCHANGE
)
77 writel(slpm
, nmk_chip
->addr
+ NMK_GPIO_SLPC
);
80 static void __nmk_gpio_set_pull(struct nmk_gpio_chip
*nmk_chip
,
81 unsigned offset
, enum nmk_gpio_pull pull
)
83 u32 bit
= 1 << offset
;
86 pdis
= readl(nmk_chip
->addr
+ NMK_GPIO_PDIS
);
87 if (pull
== NMK_GPIO_PULL_NONE
)
91 writel(pdis
, nmk_chip
->addr
+ NMK_GPIO_PDIS
);
93 if (pull
== NMK_GPIO_PULL_UP
)
94 writel(bit
, nmk_chip
->addr
+ NMK_GPIO_DATS
);
95 else if (pull
== NMK_GPIO_PULL_DOWN
)
96 writel(bit
, nmk_chip
->addr
+ NMK_GPIO_DATC
);
99 static void __nmk_gpio_make_input(struct nmk_gpio_chip
*nmk_chip
,
102 writel(1 << offset
, nmk_chip
->addr
+ NMK_GPIO_DIRC
);
105 static void __nmk_gpio_set_output(struct nmk_gpio_chip
*nmk_chip
,
106 unsigned offset
, int val
)
109 writel(1 << offset
, nmk_chip
->addr
+ NMK_GPIO_DATS
);
111 writel(1 << offset
, nmk_chip
->addr
+ NMK_GPIO_DATC
);
114 static void __nmk_gpio_make_output(struct nmk_gpio_chip
*nmk_chip
,
115 unsigned offset
, int val
)
117 writel(1 << offset
, nmk_chip
->addr
+ NMK_GPIO_DIRS
);
118 __nmk_gpio_set_output(nmk_chip
, offset
, val
);
121 static void __nmk_config_pin(struct nmk_gpio_chip
*nmk_chip
, unsigned offset
,
124 static const char *afnames
[] = {
125 [NMK_GPIO_ALT_GPIO
] = "GPIO",
126 [NMK_GPIO_ALT_A
] = "A",
127 [NMK_GPIO_ALT_B
] = "B",
128 [NMK_GPIO_ALT_C
] = "C"
130 static const char *pullnames
[] = {
131 [NMK_GPIO_PULL_NONE
] = "none",
132 [NMK_GPIO_PULL_UP
] = "up",
133 [NMK_GPIO_PULL_DOWN
] = "down",
134 [3] /* illegal */ = "??"
136 static const char *slpmnames
[] = {
137 [NMK_GPIO_SLPM_INPUT
] = "input/wakeup",
138 [NMK_GPIO_SLPM_NOCHANGE
] = "no-change/no-wakeup",
141 int pin
= PIN_NUM(cfg
);
142 int pull
= PIN_PULL(cfg
);
143 int af
= PIN_ALT(cfg
);
144 int slpm
= PIN_SLPM(cfg
);
145 int output
= PIN_DIR(cfg
);
146 int val
= PIN_VAL(cfg
);
148 dev_dbg(nmk_chip
->chip
.dev
, "pin %d: af %s, pull %s, slpm %s (%s%s)\n",
149 pin
, afnames
[af
], pullnames
[pull
], slpmnames
[slpm
],
150 output
? "output " : "input",
151 output
? (val
? "high" : "low") : "");
154 __nmk_gpio_make_output(nmk_chip
, offset
, val
);
156 __nmk_gpio_make_input(nmk_chip
, offset
);
157 __nmk_gpio_set_pull(nmk_chip
, offset
, pull
);
160 __nmk_gpio_set_slpm(nmk_chip
, offset
, slpm
);
161 __nmk_gpio_set_mode(nmk_chip
, offset
, af
);
165 * nmk_config_pin - configure a pin's mux attributes
166 * @cfg: pin confguration
168 * Configures a pin's mode (alternate function or GPIO), its pull up status,
169 * and its sleep mode based on the specified configuration. The @cfg is
170 * usually one of the SoC specific macros defined in mach/<soc>-pins.h. These
171 * are constructed using, and can be further enhanced with, the macros in
174 * If a pin's mode is set to GPIO, it is configured as an input to avoid
175 * side-effects. The gpio can be manipulated later using standard GPIO API
178 int nmk_config_pin(pin_cfg_t cfg
)
180 struct nmk_gpio_chip
*nmk_chip
;
181 int gpio
= PIN_NUM(cfg
);
184 nmk_chip
= get_irq_chip_data(NOMADIK_GPIO_TO_IRQ(gpio
));
188 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
189 __nmk_config_pin(nmk_chip
, gpio
- nmk_chip
->chip
.base
, cfg
);
190 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
194 EXPORT_SYMBOL(nmk_config_pin
);
197 * nmk_config_pins - configure several pins at once
198 * @cfgs: array of pin configurations
199 * @num: number of elments in the array
201 * Configures several pins using nmk_config_pin(). Refer to that function for
202 * further information.
204 int nmk_config_pins(pin_cfg_t
*cfgs
, int num
)
209 for (i
= 0; i
< num
; i
++) {
210 int ret
= nmk_config_pin(cfgs
[i
]);
217 EXPORT_SYMBOL(nmk_config_pins
);
220 * nmk_gpio_set_slpm() - configure the sleep mode of a pin
222 * @mode: NMK_GPIO_SLPM_INPUT or NMK_GPIO_SLPM_NOCHANGE,
224 * Sets the sleep mode of a pin. If @mode is NMK_GPIO_SLPM_INPUT, the pin is
225 * changed to an input (with pullup/down enabled) in sleep and deep sleep. If
226 * @mode is NMK_GPIO_SLPM_NOCHANGE, the pin remains in the state it was
227 * configured even when in sleep and deep sleep.
229 * On DB8500v2 onwards, this setting loses the previous meaning and instead
230 * indicates if wakeup detection is enabled on the pin. Note that
231 * enable_irq_wake() will automatically enable wakeup detection.
233 int nmk_gpio_set_slpm(int gpio
, enum nmk_gpio_slpm mode
)
235 struct nmk_gpio_chip
*nmk_chip
;
238 nmk_chip
= get_irq_chip_data(NOMADIK_GPIO_TO_IRQ(gpio
));
242 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
243 __nmk_gpio_set_slpm(nmk_chip
, gpio
- nmk_chip
->chip
.base
, mode
);
244 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
250 * nmk_gpio_set_pull() - enable/disable pull up/down on a gpio
252 * @pull: one of NMK_GPIO_PULL_DOWN, NMK_GPIO_PULL_UP, and NMK_GPIO_PULL_NONE
254 * Enables/disables pull up/down on a specified pin. This only takes effect if
255 * the pin is configured as an input (either explicitly or by the alternate
258 * NOTE: If enabling the pull up/down, the caller must ensure that the GPIO is
259 * configured as an input. Otherwise, due to the way the controller registers
260 * work, this function will change the value output on the pin.
262 int nmk_gpio_set_pull(int gpio
, enum nmk_gpio_pull pull
)
264 struct nmk_gpio_chip
*nmk_chip
;
267 nmk_chip
= get_irq_chip_data(NOMADIK_GPIO_TO_IRQ(gpio
));
271 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
272 __nmk_gpio_set_pull(nmk_chip
, gpio
- nmk_chip
->chip
.base
, pull
);
273 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
279 int nmk_gpio_set_mode(int gpio
, int gpio_mode
)
281 struct nmk_gpio_chip
*nmk_chip
;
284 nmk_chip
= get_irq_chip_data(NOMADIK_GPIO_TO_IRQ(gpio
));
288 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
289 __nmk_gpio_set_mode(nmk_chip
, gpio
- nmk_chip
->chip
.base
, gpio_mode
);
290 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
294 EXPORT_SYMBOL(nmk_gpio_set_mode
);
296 int nmk_gpio_get_mode(int gpio
)
298 struct nmk_gpio_chip
*nmk_chip
;
299 u32 afunc
, bfunc
, bit
;
301 nmk_chip
= get_irq_chip_data(NOMADIK_GPIO_TO_IRQ(gpio
));
305 bit
= 1 << (gpio
- nmk_chip
->chip
.base
);
307 afunc
= readl(nmk_chip
->addr
+ NMK_GPIO_AFSLA
) & bit
;
308 bfunc
= readl(nmk_chip
->addr
+ NMK_GPIO_AFSLB
) & bit
;
310 return (afunc
? NMK_GPIO_ALT_A
: 0) | (bfunc
? NMK_GPIO_ALT_B
: 0);
312 EXPORT_SYMBOL(nmk_gpio_get_mode
);
316 static inline int nmk_gpio_get_bitmask(int gpio
)
318 return 1 << (gpio
% 32);
321 static void nmk_gpio_irq_ack(unsigned int irq
)
324 struct nmk_gpio_chip
*nmk_chip
;
326 gpio
= NOMADIK_IRQ_TO_GPIO(irq
);
327 nmk_chip
= get_irq_chip_data(irq
);
330 writel(nmk_gpio_get_bitmask(gpio
), nmk_chip
->addr
+ NMK_GPIO_IC
);
333 enum nmk_gpio_irq_type
{
338 static void __nmk_gpio_irq_modify(struct nmk_gpio_chip
*nmk_chip
,
339 int gpio
, enum nmk_gpio_irq_type which
,
342 u32 rimsc
= which
== WAKE
? NMK_GPIO_RWIMSC
: NMK_GPIO_RIMSC
;
343 u32 fimsc
= which
== WAKE
? NMK_GPIO_FWIMSC
: NMK_GPIO_FIMSC
;
344 u32 bitmask
= nmk_gpio_get_bitmask(gpio
);
347 /* we must individually set/clear the two edges */
348 if (nmk_chip
->edge_rising
& bitmask
) {
349 reg
= readl(nmk_chip
->addr
+ rimsc
);
354 writel(reg
, nmk_chip
->addr
+ rimsc
);
356 if (nmk_chip
->edge_falling
& bitmask
) {
357 reg
= readl(nmk_chip
->addr
+ fimsc
);
362 writel(reg
, nmk_chip
->addr
+ fimsc
);
366 static int nmk_gpio_irq_modify(unsigned int irq
, enum nmk_gpio_irq_type which
,
370 struct nmk_gpio_chip
*nmk_chip
;
374 gpio
= NOMADIK_IRQ_TO_GPIO(irq
);
375 nmk_chip
= get_irq_chip_data(irq
);
376 bitmask
= nmk_gpio_get_bitmask(gpio
);
380 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
381 __nmk_gpio_irq_modify(nmk_chip
, gpio
, which
, enable
);
382 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
387 static void nmk_gpio_irq_mask(unsigned int irq
)
389 nmk_gpio_irq_modify(irq
, NORMAL
, false);
392 static void nmk_gpio_irq_unmask(unsigned int irq
)
394 nmk_gpio_irq_modify(irq
, NORMAL
, true);
397 static int nmk_gpio_irq_set_wake(unsigned int irq
, unsigned int on
)
399 struct nmk_gpio_chip
*nmk_chip
;
403 gpio
= NOMADIK_IRQ_TO_GPIO(irq
);
404 nmk_chip
= get_irq_chip_data(irq
);
408 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
409 #ifdef CONFIG_ARCH_U8500
410 if (cpu_is_u8500v2()) {
411 __nmk_gpio_set_slpm(nmk_chip
, gpio
,
412 on
? NMK_GPIO_SLPM_WAKEUP_ENABLE
413 : NMK_GPIO_SLPM_WAKEUP_DISABLE
);
416 __nmk_gpio_irq_modify(nmk_chip
, gpio
, WAKE
, on
);
417 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
422 static int nmk_gpio_irq_set_type(unsigned int irq
, unsigned int type
)
424 struct irq_desc
*desc
= irq_to_desc(irq
);
425 bool enabled
= !(desc
->status
& IRQ_DISABLED
);
426 bool wake
= desc
->wake_depth
;
428 struct nmk_gpio_chip
*nmk_chip
;
432 gpio
= NOMADIK_IRQ_TO_GPIO(irq
);
433 nmk_chip
= get_irq_chip_data(irq
);
434 bitmask
= nmk_gpio_get_bitmask(gpio
);
438 if (type
& IRQ_TYPE_LEVEL_HIGH
)
440 if (type
& IRQ_TYPE_LEVEL_LOW
)
443 spin_lock_irqsave(&nmk_chip
->lock
, flags
);
446 __nmk_gpio_irq_modify(nmk_chip
, gpio
, NORMAL
, false);
449 __nmk_gpio_irq_modify(nmk_chip
, gpio
, WAKE
, false);
451 nmk_chip
->edge_rising
&= ~bitmask
;
452 if (type
& IRQ_TYPE_EDGE_RISING
)
453 nmk_chip
->edge_rising
|= bitmask
;
455 nmk_chip
->edge_falling
&= ~bitmask
;
456 if (type
& IRQ_TYPE_EDGE_FALLING
)
457 nmk_chip
->edge_falling
|= bitmask
;
460 __nmk_gpio_irq_modify(nmk_chip
, gpio
, NORMAL
, true);
463 __nmk_gpio_irq_modify(nmk_chip
, gpio
, WAKE
, true);
465 spin_unlock_irqrestore(&nmk_chip
->lock
, flags
);
470 static struct irq_chip nmk_gpio_irq_chip
= {
471 .name
= "Nomadik-GPIO",
472 .ack
= nmk_gpio_irq_ack
,
473 .mask
= nmk_gpio_irq_mask
,
474 .unmask
= nmk_gpio_irq_unmask
,
475 .set_type
= nmk_gpio_irq_set_type
,
476 .set_wake
= nmk_gpio_irq_set_wake
,
479 static void nmk_gpio_irq_handler(unsigned int irq
, struct irq_desc
*desc
)
481 struct nmk_gpio_chip
*nmk_chip
;
482 struct irq_chip
*host_chip
= get_irq_chip(irq
);
483 unsigned int gpio_irq
;
485 unsigned int first_irq
;
487 if (host_chip
->mask_ack
)
488 host_chip
->mask_ack(irq
);
490 host_chip
->mask(irq
);
495 nmk_chip
= get_irq_data(irq
);
496 first_irq
= NOMADIK_GPIO_TO_IRQ(nmk_chip
->chip
.base
);
497 while ( (pending
= readl(nmk_chip
->addr
+ NMK_GPIO_IS
)) ) {
498 gpio_irq
= first_irq
+ __ffs(pending
);
499 generic_handle_irq(gpio_irq
);
502 host_chip
->unmask(irq
);
505 static int nmk_gpio_init_irq(struct nmk_gpio_chip
*nmk_chip
)
507 unsigned int first_irq
;
510 first_irq
= NOMADIK_GPIO_TO_IRQ(nmk_chip
->chip
.base
);
511 for (i
= first_irq
; i
< first_irq
+ NMK_GPIO_PER_CHIP
; i
++) {
512 set_irq_chip(i
, &nmk_gpio_irq_chip
);
513 set_irq_handler(i
, handle_edge_irq
);
514 set_irq_flags(i
, IRQF_VALID
);
515 set_irq_chip_data(i
, nmk_chip
);
516 set_irq_type(i
, IRQ_TYPE_EDGE_FALLING
);
518 set_irq_chained_handler(nmk_chip
->parent_irq
, nmk_gpio_irq_handler
);
519 set_irq_data(nmk_chip
->parent_irq
, nmk_chip
);
524 static int nmk_gpio_make_input(struct gpio_chip
*chip
, unsigned offset
)
526 struct nmk_gpio_chip
*nmk_chip
=
527 container_of(chip
, struct nmk_gpio_chip
, chip
);
529 writel(1 << offset
, nmk_chip
->addr
+ NMK_GPIO_DIRC
);
533 static int nmk_gpio_get_input(struct gpio_chip
*chip
, unsigned offset
)
535 struct nmk_gpio_chip
*nmk_chip
=
536 container_of(chip
, struct nmk_gpio_chip
, chip
);
537 u32 bit
= 1 << offset
;
539 return (readl(nmk_chip
->addr
+ NMK_GPIO_DAT
) & bit
) != 0;
542 static void nmk_gpio_set_output(struct gpio_chip
*chip
, unsigned offset
,
545 struct nmk_gpio_chip
*nmk_chip
=
546 container_of(chip
, struct nmk_gpio_chip
, chip
);
548 __nmk_gpio_set_output(nmk_chip
, offset
, val
);
551 static int nmk_gpio_make_output(struct gpio_chip
*chip
, unsigned offset
,
554 struct nmk_gpio_chip
*nmk_chip
=
555 container_of(chip
, struct nmk_gpio_chip
, chip
);
557 __nmk_gpio_make_output(nmk_chip
, offset
, val
);
562 static int nmk_gpio_to_irq(struct gpio_chip
*chip
, unsigned offset
)
564 struct nmk_gpio_chip
*nmk_chip
=
565 container_of(chip
, struct nmk_gpio_chip
, chip
);
567 return NOMADIK_GPIO_TO_IRQ(nmk_chip
->chip
.base
) + offset
;
570 /* This structure is replicated for each GPIO block allocated at probe time */
571 static struct gpio_chip nmk_gpio_template
= {
572 .direction_input
= nmk_gpio_make_input
,
573 .get
= nmk_gpio_get_input
,
574 .direction_output
= nmk_gpio_make_output
,
575 .set
= nmk_gpio_set_output
,
576 .to_irq
= nmk_gpio_to_irq
,
577 .ngpio
= NMK_GPIO_PER_CHIP
,
581 static int __devinit
nmk_gpio_probe(struct platform_device
*dev
)
583 struct nmk_gpio_platform_data
*pdata
= dev
->dev
.platform_data
;
584 struct nmk_gpio_chip
*nmk_chip
;
585 struct gpio_chip
*chip
;
586 struct resource
*res
;
594 res
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
600 irq
= platform_get_irq(dev
, 0);
606 if (request_mem_region(res
->start
, resource_size(res
),
607 dev_name(&dev
->dev
)) == NULL
) {
612 clk
= clk_get(&dev
->dev
, NULL
);
620 nmk_chip
= kzalloc(sizeof(*nmk_chip
), GFP_KERNEL
);
626 * The virt address in nmk_chip->addr is in the nomadik register space,
627 * so we can simply convert the resource address, without remapping
630 nmk_chip
->addr
= io_p2v(res
->start
);
631 nmk_chip
->chip
= nmk_gpio_template
;
632 nmk_chip
->parent_irq
= irq
;
633 spin_lock_init(&nmk_chip
->lock
);
635 chip
= &nmk_chip
->chip
;
636 chip
->base
= pdata
->first_gpio
;
637 chip
->label
= pdata
->name
;
638 chip
->dev
= &dev
->dev
;
639 chip
->owner
= THIS_MODULE
;
641 ret
= gpiochip_add(&nmk_chip
->chip
);
645 platform_set_drvdata(dev
, nmk_chip
);
647 nmk_gpio_init_irq(nmk_chip
);
649 dev_info(&dev
->dev
, "Bits %i-%i at address %p\n",
650 nmk_chip
->chip
.base
, nmk_chip
->chip
.base
+31, nmk_chip
->addr
);
659 release_mem_region(res
->start
, resource_size(res
));
661 dev_err(&dev
->dev
, "Failure %i for GPIO %i-%i\n", ret
,
662 pdata
->first_gpio
, pdata
->first_gpio
+31);
666 static struct platform_driver nmk_gpio_driver
= {
668 .owner
= THIS_MODULE
,
671 .probe
= nmk_gpio_probe
,
672 .suspend
= NULL
, /* to be done */
676 static int __init
nmk_gpio_init(void)
678 return platform_driver_register(&nmk_gpio_driver
);
681 core_initcall(nmk_gpio_init
);
683 MODULE_AUTHOR("Prafulla WADASKAR and Alessandro Rubini");
684 MODULE_DESCRIPTION("Nomadik GPIO Driver");
685 MODULE_LICENSE("GPL");